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

Re: Re* [PATCH 5/7] git-log.txt: rewrite note on why "--" may be required

From
Junio C Hamano <gitster@pobox.com>
Date
Apr 29, 2013, 16:33 UTC
Message-ID
<7va9ohl2k7.fsf@alter.siamese.dyndns.org>
In-Reply-To
<CALkWK0m2__SZmpyQqLjkJuMWtPuD4=Oo7QrYovq_Fw6fpHEXXQ@mail.gmail.com>
Ramkumar Ramachandra <artagnon@gmail.com> writes:
> I agree that the "confusion" paragraph after [--] [<path>] can be
> improved, but putting [--] in a paragraph of its own sounds like an
> overkill.  Apart from other things, it means that every single git
> command would need an identical [--] paragraph for consistency.

That is not a problem. We need to say what command line argument X (e.g. <path>, but not limited to it) does in all pages for commands that pay attention to X anyway.

A more important reason to have them as separate entries is to avoid giving a wrong impression that "--" is somehow related to <path>, which is where the mistake in the synopsis "[[--] <path>...]" that started this thread comes from.

Previous: Ramkumar RamachandraNext: Ramkumar Ramachandra
Message 9 of 13 in “Documentation/shortlog improvements”
  1. 0/7 Documentation/shortlog improvementsRamkumar Ramachandra, Apr 22, 2013
  2. 1/7 git-shortlog.txt: remove (-h|--help) from OPTIONSRamkumar Ramachandra, Apr 22, 2013
  3. 2/7 revisions.txt: clarify the .. and ... syntaxRamkumar Ramachandra, Apr 22, 2013
  4. 3/7 git-log.txt: order OPTIONS properly; move <since>..<until>Ramkumar Ramachandra, Apr 22, 2013
  5. 4/7 git-log.txt: generalize <since>..<until>Ramkumar Ramachandra, Apr 22, 2013
  6. 5/7 git-log.txt: rewrite note on why "--" may be requiredRamkumar Ramachandra, Apr 22, 2013
  7. Re* [PATCH 5/7] git-log.txt: rewrite note on why "--" may be requiredJunio C Hamano, Apr 25, 2013
  8. Ramkumar RamachandraApr 25, 2013
  9. Junio C HamanoApr 29, 2013
  10. Ramkumar RamachandraApr 29, 2013
  11. 6/7 git-shortlog.txt: make SYNOPSIS match log, update OPTIONSRamkumar Ramachandra, Apr 22, 2013
  12. 7/7 builtin/shortlog.c: make usage string consistent with logRamkumar Ramachandra, Apr 22, 2013
  13. 5/7 builtin/log.c: make usage string consistent with docRamkumar Ramachandra, Apr 22, 2013

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.