Git development
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Julia Evans" <julia@jvns.ca>
Cc: "D. Ben Knoble" <ben.knoble@gmail.com>,
	 "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 12:51:56 -0700	[thread overview]
Message-ID: <xmqqfqyrg7j7.fsf@gitster.g> (raw)
In-Reply-To: <064ec9c5-d539-4d21-96a7-6ad0ead5a061@app.fastmail.com> (Julia Evans's message of "Tue, 29 Sep 2026 07:29:24 -0400")

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

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

  reply	other threads:[~2026-09-29 19:51 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
2026-09-29 19:51       ` Junio C Hamano [this message]
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=xmqqfqyrg7j7.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=ben.knoble@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    --cc=julia@jvns.ca \
    --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