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

Re: [PATCH] git-rev-list.txt: prune options in synopsis

From
Junio C Hamano <gitster@pobox.com>
Date
Oct 5, 2019, 09:07 UTC
Message-ID
<xmqqmuef7e87.fsf@gitster-ct.c.googlers.com>
In-Reply-To
<645cc54c4c86493c855ec6b0b892a0bc8e999249.1570234118.git.liu.denton@gmail.com>
Denton Liu <liu.denton@gmail.com> writes:
Show 8 quoted lines
> The synopsis section in git-rev-list.txt has grown to be a huge list
> that probably needs its own synopsis. Since the list is huge, users may
> be given the false impression that the list is complete, however it is
> not. It is missing many of the available options.
>
> Since the list of options in the synopsis is not only annoying but
> actively harmful, replace it with `[<options>]` so users know to
> explicitly look through the documentation for further information.

I am not sure listing only the most often used ones is harmful. It indeed is annoying and it is a good idea to shrink it down like this patch does.

Thanks.
Previous: Denton LiuNext: Jeff King
Message 2 of 5 in “git-rev-list.txt: prune options in synopsis”
  1. git-rev-list.txt: prune options in synopsisDenton Liu, Oct 5, 2019
  2. Junio C HamanoOct 5, 2019
  3. Jeff KingOct 11, 2019
  4. Philip OakleyOct 11, 2019
  5. Jeff KingOct 11, 2019

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.