Git development
 help / color / mirror / Atom feed
From: Ben Knoble <ben.knoble@gmail.com>
To: Julia Evans via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org,
	Kristoffer Haugsbakk <kristofferhaugsbakk@fastmail.com>,
	Julia Evans <julia@jvns.ca>
Subject: Re: [PATCH] [doc] Use `man git` to teach users how to navigate the docs
Date: Mon, 28 Sep 2026 17:02:24 -0400	[thread overview]
Message-ID: <CCB1855E-759F-4741-BE49-23FC6DD402A6@gmail.com> (raw)
In-Reply-To: <pull.2242.git.1790627574093.gitgitgadget@gmail.com>


> Le 28 sept. 2026 à 16:33, Julia Evans via GitGitGadget <gitgitgadget@gmail.com> a écrit :
> 
> From: Julia Evans <julia@jvns.ca>
> 
> Many existing users of Git don't know how Git's documentation is
> structured, and a lot of folks have expressed frustration that `man git`
> doesn't make it easy to find out how to get help with using Git.
> 
> Explain how Git's help system works in `man git`
> (`git push -h` gives a short help, `git push --help` is the full docs),
> since it's a slightly unusual approach.

[snip]

> 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. 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 don’t know how to fit that in with what you already proposed,
though; I doubt that mentioning bare “git help” will push anyone towards
its manual to discover “git help cmd”, although the bottom of the help
output mentions it as a possibility. 

[Unrelated]
One thing I think Git is really missing is easy access to the stuff
in “git --html-path”. I have a custom script for that, but AFAICT even
“git help” in web mode can’t open all of it. 

  reply	other threads:[~2026-09-28 21:02 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 [this message]
2026-09-29  2:00   ` Junio C Hamano
2026-09-29 11:29     ` Julia Evans
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=CCB1855E-759F-4741-BE49-23FC6DD402A6@gmail.com \
    --to=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