git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jakub Narebski <jnareb@gmail.com>
To: Junio C Hamano <gitster@pobox.com>
Cc: Paul Bolle <pebolle@tiscali.nl>,
	Nicolas Sebrecht <nicolas.s.dev@gmx.fr>,
	git@vger.kernel.org
Subject: Re: [PATCH] Re: [TRIVIAL] Documentation: merge: one <remote> is required
Date: Wed, 12 Aug 2009 03:19:30 -0700 (PDT)	[thread overview]
Message-ID: <m31vnhpc5v.fsf@localhost.localdomain> (raw)
In-Reply-To: <7vy6ppbvdf.fsf@alter.siamese.dyndns.org>

Junio C Hamano <gitster@pobox.com> writes:
> Paul Bolle <pebolle@tiscali.nl> writes:
> 
>>> Shoudn't be 
>>> 
>>>    [-m <msg>] <remote> [<remote>...]
>>
>> No, since "<remote>..." means one or more instances of the "<remote>"
>> option.  
> 
> Does it really?
> 
> After you brought up this "one or more", I re-read the docs your patches
> touched, thinking that the author might have meant 'zero or more of A'
> with these '<A>...'  notation.
> 
> And I realized that they made perfect sense.
> 
> In general, you can write:
> 
> 	<command> ...
> 
> and read this as "The <command> can be followed by nothing or something
> (zero or more) of unspecified kind".  If <command> takes only one type of
> zero or more things, you can _clarify the ellipses_ by prefixing them with
> what kind of "stuff" you are talking about:
> 
> 	<command> <remote>...
> 
> and read this as "The <command> can be followed by nothing or something
> (zero or more) of <remote>s".

I would have thought that it makes more sense to have

  <something>...

for one or more, and

  [<something>... ]

for zero or more (optional one or more).

Documentation/DocumentationLanguage, anyone? ;-))))

-- 
Jakub Narebski
Poland
ShadeHawk on #git

  reply	other threads:[~2009-08-12 10:19 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-08-11 13:03 [PATCH] [TRIVIAL] Documentation: merge: one <remote> is required Paul Bolle
2009-08-11 14:42 ` [PATCH] " Nicolas Sebrecht
2009-08-11 14:58   ` Paul Bolle
2009-08-12  2:48     ` Junio C Hamano
2009-08-12 10:19       ` Jakub Narebski [this message]
2009-08-12 13:29         ` Nicolas Sebrecht
2009-08-12 10:56       ` Paul Bolle
2009-08-12 20:31         ` Junio C Hamano
2009-08-12 20:47           ` Paul Bolle

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=m31vnhpc5v.fsf@localhost.localdomain \
    --to=jnareb@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=nicolas.s.dev@gmx.fr \
    --cc=pebolle@tiscali.nl \
    /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.
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 NNTP newsgroup(s).