Re: [PATCH] [doc] Use `man git` to teach users how to navigate the docs

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 29, 2026, 02:00 UTC
Message-ID: <xmqqo6dgkead.fsf@gitster.g>
In-Reply-To: <CCB1855E-759F-4741-BE49-23FC6DD402A6@gmail.com>

Ben Knoble <ben.knoble@gmail.com> writes:

Show 11 quoted lines

>> Mention `git help` instead of `giteveryday` for now, which does a better
>> job of giving an overview of everyday commands.
>
> [snip]
>
>>    I thought about mentioning git help push and/or man git-push, but (from
>>    a Mastodon survey I did) git push --help is the one users are most
>>    familiar with, it's most similar to how other Unix tools work, and it
>>    makes the description really clear and concise (-h for short help,
>>    --help for long help).
> I appreciate the concision.

The survey result that says the users are more familiar with "git cmd --help" merely tells us that they are not taking full advantage of what they are offered ;-).

> I think “git help cmd” is quite a bit more
> useful than “git cmd --help” because the former supports
> aliases, HTML formats, and various other documents.

I agree that "git help cmd/concept/guide" is more useful for all these reasons, with "git help help".