From patchwork Wed Jun 5 20:18:40 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Wakely X-Patchwork-Id: 1944147 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=pass (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=EoCr93zx; dkim-atps=neutral Authentication-Results: legolas.ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=gcc.gnu.org (client-ip=2620:52:3:1:0:246e:9693:128c; helo=server2.sourceware.org; envelope-from=gcc-patches-bounces+incoming=patchwork.ozlabs.org@gcc.gnu.org; receiver=patchwork.ozlabs.org) Received: from server2.sourceware.org (server2.sourceware.org [IPv6:2620:52:3:1:0:246e:9693:128c]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (secp384r1) server-digest SHA384) (No client certificate requested) by legolas.ozlabs.org (Postfix) with ESMTPS id 4Vvf38536jz20Q5 for ; Thu, 6 Jun 2024 06:20:20 +1000 (AEST) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id BD49A39D9474 for ; Wed, 5 Jun 2024 20:20:18 +0000 (GMT) X-Original-To: gcc-patches@gcc.gnu.org Delivered-To: gcc-patches@gcc.gnu.org Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) by sourceware.org (Postfix) with ESMTPS id 6D90C39D945C for ; Wed, 5 Jun 2024 20:19:04 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 6D90C39D945C Authentication-Results: sourceware.org; dmarc=pass (p=none dis=none) header.from=redhat.com Authentication-Results: sourceware.org; spf=pass smtp.mailfrom=redhat.com ARC-Filter: OpenARC Filter v1.0.0 sourceware.org 6D90C39D945C Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.133.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1717618746; cv=none; b=VX/5ZZCnJuKRFUeSt8jOpageU7toiG8SVahw2VZvfbWWqb8dsl/HLFoFxUM2n4W2zZs7g8tynzPeityiLBgaIMf9SGpKeSYD1kSCHx33fxPdUTCQq3+YxfiF3m25Ac10+LneTKkGSKgUsePzkUDgliytwZcPWjdlqiOFBZj3GoE= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1717618746; c=relaxed/simple; bh=NsD5d56hrYgRHlX5TTOl+/gso5sjm8wifZIZI/1S1tM=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=PZRHh7ij4cwflP7VIL2fhSJwmXZG8Av4EUqym7cwwD9XjROdWSQmShqmrxdTK8gExuBiS0h4W0HeZnAvC+GFtvx8/bTp2zGKeFARUWCVaIsqYcs/BBIq+5ZI9u3PFqVhSGcXQnmM18Ey4BWLX8mDuKm0Q4heIIB6mJa5iGD2SbM= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1717618744; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=mEoQvdDQojX3Il+r9k1QaA8GK0eYYNtqlVfLPeSWg0o=; b=EoCr93zx4r7KMDHfiMP7QfWCiZlt6btYkq9efyoxUHZANGVauj+HZzYh8b0QosMM5f9DOq nv/6JdxQp9Lvp1oh5Ka3QJCvGcY6rox8UFpchPy0gSZYp4U797+Yb849f6553mFfP/lb7k 6wLsX0ZNF3DOtb1Q6MCR5RNqY9n7aH8= Received: from mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-498-JMTvxHMsNgyTuAAfpHFSzQ-1; Wed, 05 Jun 2024 16:19:00 -0400 X-MC-Unique: JMTvxHMsNgyTuAAfpHFSzQ-1 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id E193D194511B; Wed, 5 Jun 2024 20:18:59 +0000 (UTC) Received: from localhost (unknown [10.39.192.32]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 1A1F01956088; Wed, 5 Jun 2024 20:18:58 +0000 (UTC) From: Jonathan Wakely To: libstdc++@gcc.gnu.org, gcc-patches@gcc.gnu.org Subject: [committed] contrib: Fix spelling and capitalization in header-tools Date: Wed, 5 Jun 2024 21:18:40 +0100 Message-ID: <20240605201857.161489-1-jwakely@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-10.7 required=5.0 tests=BAYES_00, DKIMWL_WL_HIGH, DKIM_SIGNED, DKIM_VALID, DKIM_VALID_AU, DKIM_VALID_EF, GIT_PATCH_0, RCVD_IN_DNSWL_NONE, RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL, RCVD_IN_SBL_CSS, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on server2.sourceware.org X-BeenThere: gcc-patches@gcc.gnu.org X-Mailman-Version: 2.1.30 Precedence: list List-Id: Gcc-patches mailing list List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: gcc-patches-bounces+incoming=patchwork.ozlabs.org@gcc.gnu.org Pushed as obvious. -- >8 -- contrib/header-tools/ChangeLog: * README: Fix spelling and capitalization typos. * gcc-order-headers: Fix spelling typo. --- contrib/header-tools/README | 24 ++++++++++++------------ contrib/header-tools/gcc-order-headers | 2 +- 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/contrib/header-tools/README b/contrib/header-tools/README index 48381fe0ba4..906572e5059 100644 --- a/contrib/header-tools/README +++ b/contrib/header-tools/README @@ -1,8 +1,8 @@ Quick start documentation for the header file utilities. -This isn't a full breakdown of the tools, just they typical use scenarios. +This isn't a full breakdown of the tools, just the typical use scenarios. -- Each tool accepts -h to show it's usage. Usually no parameters will also +- Each tool accepts -h to show its usage. Usually no parameters will also trigger the help message. Help may specify additional functionality to what is listed here. @@ -37,7 +37,7 @@ gcc-order-headers command line. Any files which are changed are output, and the original is saved with a - .bak extention. + .bak extension. ex.: gcc-order-headers tree-ssa.cc c/c-decl.cc @@ -45,7 +45,7 @@ gcc-order-headers show which of those headers include other headers, just the final canonical ordering. - if any header files are included within a conditional code block, the tool + If any header files are included within a conditional code block, the tool will issue a message and not change the file. When this happens, you can manually inspect the file to determine if reordering it is actually OK. Then rerun the command with the -i option. This will ignore the conditional error @@ -162,11 +162,11 @@ reduce-headers a native build and sometimes target builds, depending on what you are trying to reduce. - it is good practice to run 'gcc-order-headers' on a source file before trying + It is good practice to run 'gcc-order-headers' on a source file before trying to reduce it. This removes duplicates and performs some simplifications which reduce the chances of the reduction tool missing things. - start with a completely bootstrapped native compiler. + Start with a completely bootstrapped native compiler. Any desired target builds should be built in one directory using a modified config-list.mk file which does not delete the build directory when it is done. @@ -198,7 +198,7 @@ reduce-headers A small subset of targets has been determined to provide excellent coverage, at least as of Aug 31/15 . They were found by reducing all the files - contained in libbackend.a oer a full set of targets(207). All conditions + contained in libbackend.a over a full set of targets(207). All conditions which disallowed removal of a header file were triggered by one or more of these targets. They are also known to the tool. When building targets it will check those targets before the rest. @@ -223,7 +223,7 @@ reduce-headers # This will attempt to remove all header files from tree-ssa-live.cc - the tool will generate a number of log files: + The tool will generate a number of log files: reduce-headers.log : All compilation failures from attempted reductions. reduce-headers.sum : One line summary of what happened to each source file. @@ -234,13 +234,13 @@ reduce-headers reduce-headers-kept.log: List of all the successful compiles that were ignored because of conditional macro dependencies - and why it thinks that is the case - $src.c.log : for each failed header removal, the compilation + and why it thinks that is the case. + $src.c.log : For each failed header removal, the compilation messages as to why it failed. $header.h.log: The same log is put into the relevant header log as well. -a sample output from ira.cc.log: +A sample output from ira.cc.log: Compilation failed: for shrink-wrap.h: @@ -253,7 +253,7 @@ Compilation failed: make: *** [ira.o] Error 1 -the same message would be put into shrink-wrap.h.log. +The same message would be put into shrink-wrap.h.log. diff --git a/contrib/header-tools/gcc-order-headers b/contrib/header-tools/gcc-order-headers index 68bcc93f609..87fdddf60ee 100755 --- a/contrib/header-tools/gcc-order-headers +++ b/contrib/header-tools/gcc-order-headers @@ -389,7 +389,7 @@ if didnt_do: print ("Safeness is determined by checking whether any of the reordered headers are") print ("within a conditional and could be hauled out of the conditional, thus changing") print ("what the compiler will see.") - print ("Multi-line comments after a #include can also cause failuer, they must be turned") + print ("Multi-line comments after a #include can also cause failure, they must be turned") print ("into single line comments or removed.")