]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
doc: Improve punctuation and grammar in -fdiagnostics-format docs
authorJonathan Wakely <jwakely@redhat.com>
Fri, 15 Mar 2024 12:58:56 +0000 (12:58 +0000)
committerJonathan Wakely <redi@gcc.gnu.org>
Mon, 29 Jul 2024 19:37:15 +0000 (20:37 +0100)
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

index e495b1271fa7097ac485d2dccf17df4fe0dd3173..86f9b5d1fe5eae2e9dc3ec8301c6f7b05d1947ca 100644 (file)
@@ -5865,8 +5865,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.