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, 19:51 UTC
Message-ID: <xmqqfqyrg7j7.fsf@gitster.g>
In-Reply-To: <064ec9c5-d539-4d21-96a7-6ad0ead5a061@app.fastmail.com>

"Julia Evans" <julia@jvns.ca> writes:

Show 6 quoted lines

> Perhaps we could mention `git help` like this:
>
>> `git push --help` or `git help push` for the full documentation
>
> and then advertise the superior features of `git help` like this
> (in the last sentence of the DESCRIPTION).

Amusingly

$ git help tutorial

begins with "man git-log" and "git help log". The first one is so old fashioned ;-) Perhaps a more modern version should be given at the very first part of the description section of

$ git help git

>> You can view an HTML version of the Git documentation at
>> https://git-scm.com/docs, or on your computer with `git help`,
>> for example `git help push --web`.

Please write it as "git help --web push".

The command line parser may be lenient at times, but we do not guarantee it. Please stick to published "git help cli" style in your insturction materials.