"Robert P. J. Day" <rpjday@xxxxxxxxxxxxxx> writes: > 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@xxxxxxxxxxxxxx> > > --- > > 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.
