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

Re: git help -t <topic>: list the help of the commands in a given topic

From
Junio C Hamano <gitster@pobox.com>
Date
Dec 11, 2007, 01:07 UTC
Message-ID
<7v7ijmjayl.fsf@gitster.siamese.dyndns.org>
In-Reply-To
<1197299021-28463-1-git-send-email-sbejar@gmail.com>
Santi Béjar <sbejar@gmail.com> writes:
> With 'git help -t' lists the available topics.
>
> Show a hint to get a longer list when listing the common commands.

I like the idea of making the categorized command list in git(7) available, and agree with you that renaming common_cmds[] to cmd_list[] and place everything in there would be the way to go.

However, I doubt about your presentation. Who are the intended audience and what is the expected way this is used?

I highly suspect that it would be much easier to use if you add a mode to "git help" that runs the pager over the categoized command list part of git(7) manual page, without taking "show me list of topics" nor "show commands only in this topic" parameters. It is highly unlikely that a user knows which category an obscure command whose name he wants to recall is in, or can guess which category it would be classified in after seeing the "category list". It would be much more likely that he finds it easier to scan (perhaps with "/<string>") the command list with one line description in the pager.

Previous: Santi BéjarNext: Santi Béjar
Message 2 of 3 in “git help -t <topic>: list the help of the commands in a given topic”
  1. Santi BéjarDec 10, 2007
  2. Junio C HamanoDec 11, 2007
  3. Santi BéjarDec 11, 2007

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.