From: Junio C Hamano <gitster@pobox.com>
To: "Robert P. J. Day" <rpjday@crashcourse.ca>
Cc: Git Mailing list <git@vger.kernel.org>
Subject: Re: [PATCH v2] Use proper syntax for replaceables in command docs
Date: Fri, 25 May 2018 17:16:04 +0900 [thread overview]
Message-ID: <xmqqlgc8noaj.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <alpine.LFD.2.21.1805241610030.7254@localhost.localdomain> (Robert P. J. Day's message of "Thu, 24 May 2018 16:11:39 -0400 (EDT)")
"Robert P. J. Day" <rpjday@crashcourse.ca> 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@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.
prev parent reply other threads:[~2018-05-25 8:16 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-24 20:11 [PATCH v2] Use proper syntax for replaceables in command docs Robert P. J. Day
2018-05-25 7:41 ` Simon Ruderich
2018-05-25 8:16 ` Junio C Hamano [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=xmqqlgc8noaj.fsf@gitster-ct.c.googlers.com \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=rpjday@crashcourse.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).