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

Re: [PATCH v2] doc: Add missing "-n" (dry-run) option to reflog man page

From
Junio C Hamano <gitster@pobox.com>
Date
Nov 22, 2017, 16:03 UTC
Message-ID
<xmqqine2s3m3.fsf@gitster.mtv.corp.google.com>
In-Reply-To
<alpine.LFD.2.21.1711220543450.10299@DESKTOP-1GPMCEJ>
"Robert P. J. Day" <rpjday@crashcourse.ca> writes:
>   i don't believe "git reflog" supports "-v", only "--verbose", or am
> i misreading the source?

Ah, then at least you are being (locally) consistent. Sorry for a remembo.

As to (global) consistency, in the oldest time we tried to list every options (but only in the fully spelled form, IIRC) in the synopsis section, but later with the proliferation of options, it became more common to use the generic "git subcmd <options>..." form in synopsis and leave not just the description but also the enumeration of the options to the description part of the docs, so we ended up with a mixture in the documentation set. Aiming for global consistency is a very good thing, and we need to decide what model to adhere to and stick to it to the end. If you want to carry the torch and declare that we would list every option and every short-hand (but not "--v", "--ve", "--ver", ..."--verbose" for obvious reasons), I personally am fine with that.

Previous: Robert P. J. Day
Message 6 of 6 in “doc: Add missing "-n" (dry-run) option to reflog man page”
  1. doc: Add missing "-n" (dry-run) option to reflog man pageRobert P. J. Day, Nov 21, 2017
  2. Junio C HamanoNov 22, 2017
  3. Robert P. J. DayNov 22, 2017
  4. Junio C HamanoNov 22, 2017
  5. Robert P. J. DayNov 22, 2017
  6. Junio C HamanoNov 22, 2017

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.