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
Ramkumar Ramachandra <artagnon@gmail.com>
Date
Apr 25, 2013, 05:17 UTC
Message-ID
<CALkWK0m2__SZmpyQqLjkJuMWtPuD4=Oo7QrYovq_Fw6fpHEXXQ@mail.gmail.com>
In-Reply-To
<7vmwsn8ok4.fsf_-_@alter.siamese.dyndns.org>
Junio C Hamano wrote:
> It should be more like this [*1*]:
>
>         'git log' [<options>] [<revision range>] [--] [<path>...]

Agreed. The backslash is unnecessary (I suspect it's something carried over from earlier versions of asciidoc requiring this escaping).

Show 7 quoted lines
> It may be better to split the item into two, keep the current
> description of <path> under "<path>...::" heading, and have another
> heading for "--::" that talks about the disambiguation.  The "--"
> disambiguator is not solely for "your path might be mistaken as a
> revision without it", but also for "your revision might be mistaken
> as a path", but both the old and the new text are fuzzy about the
> reason what "confusion" it is cautioning the reader.

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. We can just keep the footnote following [--] [<path>] in some commands, using discretion.

Previous: Junio C HamanoNext: Junio C Hamano
Message 8 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.