git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mark Lodato <lodatom@gmail.com>
To: Jakub Narebski <jnareb@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH 2/8] docs: use `...' instead of `*' for multiplicity
Date: Sat, 18 Dec 2010 11:32:02 -0500	[thread overview]
Message-ID: <AANLkTikKFSNC0MiZ0be6mUZFqR3atZspD9JfgKVyrrek@mail.gmail.com> (raw)
In-Reply-To: <m3hbebl7tv.fsf@localhost.localdomain>

On Sat, Dec 18, 2010 at 5:00 AM, Jakub Narebski <jnareb@gmail.com> wrote:
> Mark Lodato <lodatom@gmail.com> writes:
>
>> Finish the work of 0adda93 (Use parentheses and `...' where appropriate)
>> to follow the rules set forth in Documentation/CodingGuidelines.
>>
>> Signed-off-by: Mark Lodato <lodatom@gmail.com>
>
> [...]
>
>> -     "git describe [options] <committish>*",
>> +     "git describe [options] <committish>...",
>
> Isn't <sth>... one or more, while <sth>* is zero or more, i.e. shouldn't
> <sth>* be replaced by [<sth>...]?

Yes, I was confused by the * notation - one more reason to get rid of it!

> Hmmm... I see that <sth>* was actively wrong if it was to mean zero or
> more, so your change doesn't only make documentation more consistent,
> but fixes errorneous use of convention.

I think zero or more is correct, which is why I submitted patch 8/8 to
change from <commit>... to [<commit>...].  Now I understand that all
8/8 was doing was fixing a mistake I introduced in this patch.  I'll
correct it in the next version.

  reply	other threads:[~2010-12-18 16:32 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-12-18  5:38 [PATCHv2 0/8] docs: use metavariables consistently Mark Lodato
2010-12-18  5:38 ` [PATCH 1/8] fsck docs: remove outdated and useless diagnostic Mark Lodato
2010-12-18  5:38 ` [PATCH 2/8] docs: use `...' instead of `*' for multiplicity Mark Lodato
2010-12-18 10:00   ` Jakub Narebski
2010-12-18 16:32     ` Mark Lodato [this message]
2010-12-18  5:38 ` [PATCH 3/8] docs: use <sha1> to mean unabbreviated ID Mark Lodato
2010-12-18  7:47   ` Jonathan Nieder
2010-12-18 18:50     ` Junio C Hamano
2010-12-18  5:38 ` [PATCH 4/8] http-fetch docs: use <commit-id> consistently Mark Lodato
2010-12-18  7:51   ` Jonathan Nieder
2010-12-18  5:38 ` [PATCH 5/8] grep docs: grep accepts a <tree-ish>, not a <tree> Mark Lodato
2010-12-18  5:38 ` [PATCH 6/8] docs: use <tree> instead of <tree-ish> Mark Lodato
2010-12-18  8:35   ` Jonathan Nieder
2010-12-18  5:38 ` [PATCH 7/8] docs: use <commit> instead of <commit-ish> Mark Lodato
2010-12-18  8:39   ` Jonathan Nieder
2010-12-18  5:38 ` [PATCH 8/8] describe docs: note that <commit> is optional Mark Lodato
2010-12-18  8:49 ` [PATCHv2 0/8] docs: use metavariables consistently Jonathan Nieder
2010-12-18 16:45   ` Mark Lodato
2010-12-18 20:27   ` Junio C Hamano

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=AANLkTikKFSNC0MiZ0be6mUZFqR3atZspD9JfgKVyrrek@mail.gmail.com \
    --to=lodatom@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=jnareb@gmail.com \
    /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).