aboutsummaryrefslogtreecommitdiff
path: root/gcc
diff options
context:
space:
mode:
authorJonathan Wakely <jwakely@redhat.com>2024-03-15 12:58:56 +0000
committerJonathan Wakely <redi@gcc.gnu.org>2024-07-29 20:37:15 +0100
commitdd2cc71e3898515a33970954d2bf7a4b67ea9790 (patch)
treea78ce55943509ab1229005809bddeb99153a0d8b /gcc
parent9d5d6e61500411ea9043258e300d5b0f57e5c391 (diff)
downloadgcc-dd2cc71e3898515a33970954d2bf7a4b67ea9790.zip
gcc-dd2cc71e3898515a33970954d2bf7a4b67ea9790.tar.gz
gcc-dd2cc71e3898515a33970954d2bf7a4b67ea9790.tar.bz2
doc: Improve punctuation and grammar in -fdiagnostics-format docs
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.
Diffstat (limited to 'gcc')
-rw-r--r--gcc/doc/invoke.texi5
1 files changed, 3 insertions, 2 deletions
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index e495b12..86f9b5d 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -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.