Git development
 help / color / mirror / Atom feed
From: "Julia Evans" <julia@jvns.ca>
To: "Kristoffer Haugsbakk" <kristofferhaugsbakk@fastmail.com>,
	git@vger.kernel.org, "Julia Evans" <gitgitgadget@gmail.com>
Cc: "D. Ben Knoble" <ben.knoble@gmail.com>
Subject: Re: [PATCH v2] doc: use `man git` to teach users how to navigate the docs
Date: Wed, 07 Oct 2026 08:13:22 -0400	[thread overview]
Message-ID: <99bc9624-47a5-469d-bcae-8daa9b01581a@app.fastmail.com> (raw)
In-Reply-To: <ea29fe74-7f76-440c-9597-fdbc173be90f@app.fastmail.com>

> I recall only relatively recently learning that `-h` is not just a
> shorter way to type `--help`.

I just learned that recently too!

> Okay, so now we don’t have to list out every guide that might be of
> interest. That’s cool.
>
> I see that this would conflict with my topic
> kh/doc-gitbreaking-changes7.[1] Just would since my topic hasn’t
> been integrated yet (RFC). I use the old style of mentioning the
> new gitbreaking-changes(7) (“see <here> for ...”. I will remove
> that change in order to stay consistent with this topic.

> 🔗 1: https://lore.kernel.org/git/CV_gitbrchanges7_please.d1c@m5gid.xyz/

That makes sense to me, thanks! I saw that topic and funnily I've
been working on moving most of the content of `gitworkflows`
in the other direction (from the user facing manual pages to
the internal-only docs).

>>
>>      * mention the git help push form too
>>      * mention you can get HTML docs with git help --web push at the end to
>>        advertise git help's great features, and remove
>>        https://git.github.io/htmldocs/git.html since
>>        https://git-scm.com/docs has a nicer view and 3 different options is
>>        a lot.
>
> Nitpick: Okay, but with the current commit message I don’t really
> understand why the git.github.io link is gone. I have to guess that it
> is an effective duplicate of git-scm or something since git-scm does
> remain after this change.

Yep! It has the same content as https://git-scm.com as far as I know,
but without a lot of the nice features (a table of contents, an overview
of all the documentation, search, etc).

  reply	other threads:[~2026-10-07 12:13 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
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 [this message]
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=99bc9624-47a5-469d-bcae-8daa9b01581a@app.fastmail.com \
    --to=julia@jvns.ca \
    --cc=ben.knoble@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.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