From: Eric Sunshine <sunshine@sunshineco.com>
To: "Robert P. J. Day" <rpjday@crashcourse.ca>
Cc: Git Mailing list <git@vger.kernel.org>
Subject: Re: [PATCH] Use proper syntax for replaceables in command docs
Date: Thu, 24 May 2018 16:05:57 -0400 [thread overview]
Message-ID: <CAPig+cR91cEj1EdA4JvQQED0HJ2Db-LyrWCB_8VdC6uwT47KbA@mail.gmail.com> (raw)
In-Reply-To: <alpine.LFD.2.21.1805241552080.6217@localhost.localdomain>
On Thu, May 24, 2018 at 3:54 PM, Robert P. J. Day <rpjday@crashcourse.ca> wrote:
> 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-check-attr.txt b/Documentation/git-check-attr.txt
> @@ -9,7 +9,7 @@ git-check-attr - Display gitattributes information
> -'git check-attr' [-a | --all | attr...] [--] pathname...
> +'git check-attr' [-a | --all | attr...] [--] <pathname>...
> 'git check-attr' --stdin [-z] [-a | --all | attr...]
Don't you also want "<attr>"?
> diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt
> @@ -9,8 +9,8 @@ git-check-ignore - Debug gitignore / exclude files
> -'git check-ignore' [options] pathname...
> +'git check-ignore' [<options>] <paths>...
Earlier in the patch, you changed "pathname" to "<pathname>", but here
you change "pathname" to "<paths>", which is inconsistent.
It's also inconsistent and odd to say "<paths>..." (with the "...").
Seems better just to say "<pathname>..." to match existing practice.
next prev parent reply other threads:[~2018-05-24 20:06 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-05-24 19:54 [PATCH] Use proper syntax for replaceables in command docs Robert P. J. Day
2018-05-24 20:05 ` Eric Sunshine [this message]
2018-05-24 20:07 ` Robert P. J. Day
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=CAPig+cR91cEj1EdA4JvQQED0HJ2Db-LyrWCB_8VdC6uwT47KbA@mail.gmail.com \
--to=sunshine@sunshineco.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).