git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 2/8] docs: use `...' instead of `*' for multiplicity

From
Jakub Narebski <jnareb@gmail.com>
Date
Dec 18, 2010, 10:00 UTC
Message-ID
<m3hbebl7tv.fsf@localhost.localdomain>
In-Reply-To
<1292650725-21149-3-git-send-email-lodatom@gmail.com>
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>...]?

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.

-- 
Jakub Narebski
Poland
ShadeHawk on #git
Previous: Mark LodatoNext: Mark Lodato
Message 4 of 19 in “[PATCHv2 0/8] docs: use metavariables consistently”
  1. Mark LodatoDec 18, 2010
  2. 1/8 fsck docs: remove outdated and useless diagnosticMark Lodato, Dec 18, 2010
  3. 2/8 docs: use `...' instead of `*' for multiplicityMark Lodato, Dec 18, 2010
  4. Jakub NarebskiDec 18, 2010
  5. Mark LodatoDec 18, 2010
  6. 3/8 docs: use <sha1> to mean unabbreviated IDMark Lodato, Dec 18, 2010
  7. Jonathan NiederDec 18, 2010
  8. Junio C HamanoDec 18, 2010
  9. 4/8 http-fetch docs: use <commit-id> consistentlyMark Lodato, Dec 18, 2010
  10. Jonathan NiederDec 18, 2010
  11. 5/8 grep docs: grep accepts a <tree-ish>, not a <tree>Mark Lodato, Dec 18, 2010
  12. 6/8 docs: use <tree> instead of <tree-ish>Mark Lodato, Dec 18, 2010
  13. Jonathan NiederDec 18, 2010
  14. 7/8 docs: use <commit> instead of <commit-ish>Mark Lodato, Dec 18, 2010
  15. Jonathan NiederDec 18, 2010
  16. 8/8 describe docs: note that <commit> is optionalMark Lodato, Dec 18, 2010
  17. Jonathan NiederDec 18, 2010
  18. Mark LodatoDec 18, 2010
  19. Junio C HamanoDec 18, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.