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

Re: [PATCH/RFC] Make help behaviour more consistent

From
Junio C Hamano <gitster@pobox.com>
Date
Mar 11, 2013, 19:02 UTC
Message-ID
<7vppz592v5.fsf@alter.siamese.dyndns.org>
In-Reply-To
<vpq620yfj6g.fsf@grenoble-inp.fr>
Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:
Show 16 quoted lines
> Kevin Bracey <kevin@bracey.fi> writes:
>
>> Two significant usability flaws here:
>>  - If using man, "man git" to side-step "git help" is obvious. But if
>>    trying to use help.format=web, how to get the root html page? My
>>    technique was "git help XXX" and click the "git(1) suite" link at the
>>    bottom. "git help git" is non-obvious and apparently undocumented
>>    (it's not mentioned by "git", "git help", or "git help help"...).
>
> Can't this be solved by adding something like
>
>   See 'git help git' for general help about Git.
>
> to the output of "git help"? I think the fact that "git help" provides a
> small amount of output (typically: fits on one screen) is a nice feature
> that avoids scaring people too early with the actual doc.
That sounds like a good direction to go in.
Previous: Matthieu MoyNext: Philip Oakley
Message 6 of 8 in “Make help behaviour more consistent”
  1. Make help behaviour more consistentKevin Bracey, Mar 10, 2013
  2. Philip OakleyMar 10, 2013
  3. Junio C HamanoMar 11, 2013
  4. Kevin BraceyMar 11, 2013
  5. Matthieu MoyMar 11, 2013
  6. Junio C HamanoMar 11, 2013
  7. Philip OakleyMar 11, 2013
  8. Junio C HamanoMar 11, 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.