Git development
 help / color / mirror / Atom feed
From: "Julia Evans" <julia@jvns.ca>
To: "Junio C Hamano" <gitster@pobox.com>,
	"D. Ben Knoble" <ben.knoble@gmail.com>
Cc: "Julia Evans" <gitgitgadget@gmail.com>,
	git@vger.kernel.org,
	"Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>
Subject: Re: [PATCH] [doc] Use `man git` to teach users how to navigate the docs
Date: Tue, 29 Sep 2026 07:29:24 -0400	[thread overview]
Message-ID: <064ec9c5-d539-4d21-96a7-6ad0ead5a061@app.fastmail.com> (raw)
In-Reply-To: <xmqqo6dgkead.fsf@gitster.g>

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

Viewing the HTML docs with `git help` does seem very useful, especially for
folks who aren't as comfortable in the terminal. I had no idea you could do
that.

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

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

  reply	other threads:[~2026-09-29 11:29 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-28 20:32 [PATCH] [doc] Use `man git` to teach users how to navigate the docs Julia Evans via GitGitGadget
2026-09-28 21:02 ` Ben Knoble
2026-09-29  2:00   ` Junio C Hamano
2026-09-29 11:29     ` Julia Evans [this message]
2026-09-29 19:51       ` Junio C Hamano
2026-09-29 21:00         ` Julia Evans
2026-09-29 21:20           ` Junio C Hamano
2026-10-06 20:06 ` [PATCH v2] doc: use " Julia Evans via GitGitGadget
2026-10-06 20:23   ` D. Ben Knoble
2026-10-07  6:06   ` Kristoffer Haugsbakk
2026-10-07 12:13     ` Julia Evans
2026-10-07 13:47       ` Junio C Hamano
2026-10-07 13:57         ` Julia Evans
2026-10-07 17:35           ` Junio C Hamano
2026-10-07 19:13   ` Junio C Hamano
2026-10-07 19:29     ` Julia Evans
2026-10-07 20:08       ` Junio C Hamano
2026-10-08 15:09         ` Julia Evans

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=064ec9c5-d539-4d21-96a7-6ad0ead5a061@app.fastmail.com \
    --to=julia@jvns.ca \
    --cc=ben.knoble@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=gitster@pobox.com \
    --cc=kristofferhaugsbakk@fastmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox