Re: [PATCH] doc: Improve punctuation and grammar in -fdiagnostics-format docs

[David Malcolm <dmalcolm@redhat.com>]

On Fri, 2024-03-15 at 13:02 +0000, Jonathan Wakely wrote:
> OK for trunk?

LGTM, thanks

Dave

> 
> -- >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.