From patchwork Fri Mar 15 13:02:41 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Wakely X-Patchwork-Id: 1912482 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@legolas.ozlabs.org Authentication-Results: legolas.ozlabs.org; dkim=fail reason="signature verification failed" (1024-bit key; unprotected) header.d=redhat.com header.i=@redhat.com header.a=rsa-sha256 header.s=mimecast20190719 header.b=AkXzCC+O; 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 4Tx4FG5158z1yWy for ; Sat, 16 Mar 2024 00:03:45 +1100 (AEDT) Received: from server2.sourceware.org (localhost [IPv6:::1]) by sourceware.org (Postfix) with ESMTP id 09A25385AE5D for ; Fri, 15 Mar 2024 13:03:42 +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.129.124]) by sourceware.org (Postfix) with ESMTPS id 3905C3857BA2 for ; Fri, 15 Mar 2024 13:03:14 +0000 (GMT) DMARC-Filter: OpenDMARC Filter v1.4.2 sourceware.org 3905C3857BA2 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 3905C3857BA2 Authentication-Results: server2.sourceware.org; arc=none smtp.remote-ip=170.10.129.124 ARC-Seal: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1710507798; cv=none; b=pOLKI/aEQWZO4DF8wrbz99RjjDYLLdWPuDsxeB/jN1x8er4Y1BealE+MXlpQ801GjYfAvGWQVEqPUUq6trAVo9PRb8NqcLlvUDuzOWpvJlxbKfMPfXpjhsT+PKfkR2CyItFlVBcuFvMNoPJ4iXxhEcch1e9nLZVN5CJbJaFPQZM= ARC-Message-Signature: i=1; a=rsa-sha256; d=sourceware.org; s=key; t=1710507798; c=relaxed/simple; bh=pEImHfDHBSYx2WHCbeDx6MxsQMrf7Ze8LEYuyXWE/iU=; h=DKIM-Signature:From:To:Subject:Date:Message-ID:MIME-Version; b=v3WidTXTXapOxomFfxGTNk6kcmu4pniOEJYHW4BpCkhrdGF1u9xe/2naOL0sSnGQ+TaojWHye8NbMjSjvALKNJuF6fqifRLIAc2XOG0Dp820wNI7lDuOBSwsELmpHY8ldjKiM+/C9vwwast28rkWcaOPkZVHkxFRhU+SeJ4Enww= ARC-Authentication-Results: i=1; server2.sourceware.org DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1710507793; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=tij2jCGRl++sOtzcdDwzGtZ5LV64E1fybgibf/WkQeM=; b=AkXzCC+OFg+LGZnM1S6lL0XUs/pKUli0PqisZ1HOtLtZEOVrAKaHzU7Lq4G1dvg5JwccxX JVSwSAWsyRo6/HNyaLjQPEcpKPKNR95TbhOs7WJnKeKbyNccS3j7jXOT1F+sklTd6Xn3p+ d04f1QmFGqR0keeJGKIabJik8nIb5qY= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-131-4NTkz-7yPwS28XL0SMvNHQ-1; Fri, 15 Mar 2024 09:03:11 -0400 X-MC-Unique: 4NTkz-7yPwS28XL0SMvNHQ-1 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 5A7458007B8 for ; Fri, 15 Mar 2024 13:03:11 +0000 (UTC) Received: from localhost (unknown [10.42.28.8]) by smtp.corp.redhat.com (Postfix) with ESMTP id 268162024517; Fri, 15 Mar 2024 13:03:11 +0000 (UTC) From: Jonathan Wakely To: gcc-patches@gcc.gnu.org Cc: dmalcolm@sourceware.org Subject: [PATCH] doc: Improve punctuation and grammar in -fdiagnostics-format docs Date: Fri, 15 Mar 2024 13:02:41 +0000 Message-ID: <20240315130309.2915229-1-jwakely@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.4 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com X-Spam-Status: No, score=-12.3 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, SPF_HELO_NONE, SPF_NONE, TXREP, T_SCC_BODY_TEXT_LINE autolearn=ham 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 OK for trunk? -- >8 -- The hyphen can be misunderstood to mean "emitted to -" i.e. stdout. Refer to both forms by name, rather than using "the former" for one and referring to the other by name. gcc/ChangeLog: * doc/invoke.texi (Diagnostic Message Formatting Options): Replace hyphen with a new sentence. Replace "the former" with the actual value. --- gcc/doc/invoke.texi | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi index 85c938d4a14..d850b5fcdcc 100644 --- a/gcc/doc/invoke.texi +++ b/gcc/doc/invoke.texi @@ -5737,8 +5737,9 @@ named @file{@var{source}.sarif}, respectively. The @samp{json} format is a synonym for @samp{json-stderr}. The @samp{json-stderr} and @samp{json-file} formats are identical, apart from -where the JSON is emitted to - with the former, the JSON is emitted to stderr, -whereas with @samp{json-file} it is written to @file{@var{source}.gcc.json}. +where the JSON is emitted to. With @samp{json-stderr}, the JSON is emitted +to stderr, whereas with @samp{json-file} it is written to +@file{@var{source}.gcc.json}. The emitted JSON consists of a top-level JSON array containing JSON objects representing the diagnostics.