Re: [PATCH v2 3/9] doc: express grammar placeholders between angle brackets

From: Eric Sunshine <sunshine@sunshineco.com>
Date: Oct 28, 2021, 17:46 UTC
Message-ID: <CAPig+cR4j_jPLJs-sQAAuNQ5cEqbO0ibck-czOBy=difgi50VQ@mail.gmail.com>
In-Reply-To: <4d2d198f57294d8307453bda784bf5efe5905f45.1635438124.git.gitgitgadget@gmail.com>

On Thu, Oct 28, 2021 at 12:22 PM Jean-Noël Avila via GitGitGadget <gitgitgadget@gmail.com> wrote:

> doc: express grammar placeholders between angle brackets
>
> This rules discerns user inputs from verbatim options in the
> synopsis.

Maybe: s/rules//

Show 7 quoted lines

> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
> ---
> diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
> @@ -145,7 +145,7 @@ See also <<FILES>>.
> --f config-file::
> +-f <config-file>::
>  --file config-file::

You need to fix the `--file` item as well (mentioned in my v1 review):

    --file <config-file>::

Show 5 quoted lines

> @@ -281,7 +281,7 @@ Valid `<type>`'s include:
>  --default <value>::
>    When using `--get`, and the requested variable is not found, behave as if
> -  <value> were the value assigned to the that variable.
> +  `<value>` were the value assigned to the that variable.

This change seems out of place in this patch which claims only to be adding angle brackets.