Re: [PATCH v2] Use proper syntax for replaceables in command docs

From: Junio C Hamano <gitster@pobox.com>
Date: May 25, 2018, 08:16 UTC
Message-ID: <xmqqlgc8noaj.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <alpine.LFD.2.21.1805241610030.7254@localhost.localdomain>

"Robert P. J. Day" <rpjday@crashcourse.ca> writes:

Show 26 quoted lines

> The standard for command documentation synopses appears to be:
>
>   [...] means optional
>   <...> means replaceable
>   [<...>] means both optional and replaceable
>
> So fix a number of doc pages that use incorrect variations of the
> above.
>
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
>
> ---
>
> diff --git a/Documentation/git-annotate.txt b/Documentation/git-annotate.txt
> index 05fd482b7..e44a83133 100644
> --- a/Documentation/git-annotate.txt
> +++ b/Documentation/git-annotate.txt
> @@ -8,7 +8,7 @@ git-annotate - Annotate file lines with commit information
>  SYNOPSIS
>  --------
>  [verse]
> -'git annotate' [options] file [revision]
> +'git annotate' [<options>] <file> [<revision>]
> ...
> -'git check-mailmap' [options] <contact>...
> +'git check-mailmap' [<options>] <contact>...

A pedant in me screams s/<options>/<option>.../ after seeing this line, but <options> appears _very_ _very_ often and extremely handy, compared to having to spell "<option>...". So let's standardise the way this patch does.

Thanks.