Re: [PATCH v2 1/5] doc: BreakingChanges: transform to a manpage

From: D. Ben Knoble <ben.knoble@gmail.com>
Date: Oct 8, 2026, 19:46 UTC
Message-ID: <CALnO6CB8yQy_dtnoTYerqfyY9mcM=rKSWtZkQPtrGuHShoL3VQ@mail.gmail.com>
In-Reply-To: <V2_BrCh_become_manpage.dc5@m5gid.xyz>

On Thu, Oct 8, 2026 at 3:38 PM <kristofferhaugsbakk@fastmail.com> wrote:

Show 19 quoted lines

>
> From: Kristoffer Haugsbakk <code@khaugsbakk.name>
>
> The breaking changes document is not a regular Git documentation page.
> That means that you cannot navigate to the doc with git(1), i.e. with:
>
>     git help BreakingChanges
>
> You instead have to download the Git project source. Or go to
> git-scm.com.[1] Then you get this disclaimer:[2]
>
>     This information is specific to the Git project
>
>     Please note that this information is only relevant to you if you
>     plan on contributing to the Git project itself. It is in no shape or
>     form required reading for regular Git users.
>
> But this document is relevant to *all* Git users. Everyone should have
> as easy access to it as the other doc and guide pages.

Sorry for not mentioning this earlier, but you can (depending on your distribution's package?) find the document under "git --html-path" for example

I agree that's drastically less discoverable, though, and I welcome making it a manual in the spirit of datamodel and others.

I don't think the message needs updated, so not worth a re-roll, just something to point out for folks that like interesting corners of Git ;) (cf. https://github.com/benknoble/Dotfiles/blob/master/links/bin/git-doc and accompanying completion https://github.com/benknoble/Dotfiles/blob/master/links/zshfns/_git_doc).

-- 
D. Ben Knoble