From: Junio C Hamano <gitster@pobox.com>
Date: Mon, 11 Mar 2013 19:02:22 GMT
Subject: Re: [PATCH/RFC] Make help behaviour more consistent
Message-ID: <7vppz592v5.fsf@alter.siamese.dyndns.org>
In-Reply-To: <vpq620yfj6g.fsf@grenoble-inp.fr>

Matthieu Moy <Matthieu.Moy@grenoble-inp.fr> writes:

> 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.