From: kristofferhaugsbakk@fastmail.com
To: git@vger.kernel.org
Cc: Kristoffer Haugsbakk <code@khaugsbakk.name>,
Junio C Hamano <gitster@pobox.com>,
Patrick Steinhardt <ps@pks.im>
Subject: [PATCH v2 1/5] doc: BreakingChanges: transform to a manpage
Date: Thu, 8 Oct 2026 21:27:16 +0200 [thread overview]
Message-ID: <V2_BrCh_become_manpage.dc5@m5gid.xyz> (raw)
In-Reply-To: <V2_CV_gitbrchanges7_please.dc4@m5gid.xyz>
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.
To that end, let’s move the text to a new manpage
gitbreaking-changes(7) in two steps:
1. Transform this document without renaming it (this step)
2. Rename it to gitbreaking-changes(7). But resurrect BreakingChanges in
order to add a line linking to the new manpage (We wouldn’t want to
break any readers)
Just do the minimal changes for the new format. Also demote the first
section to the second level, i.e. make “Introduction” the same level
as “Procedure’.
Step two is for the next commit.
† 1: https://git-scm.com/docs/BreakingChanges.html
† 2: Which I first mentioned in 098230f7 (you-still-use-that??: help the
user help themselves, 2025-09-17), footnote #1.
Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
Documentation/BreakingChanges.adoc | 21 ++++++++++++++++++++-
1 file changed, 20 insertions(+), 1 deletion(-)
diff --git a/Documentation/BreakingChanges.adoc b/Documentation/BreakingChanges.adoc
index 73bb939359c..c6b974b6d8c 100644
--- a/Documentation/BreakingChanges.adoc
+++ b/Documentation/BreakingChanges.adoc
@@ -1,4 +1,19 @@
-= Upcoming breaking changes
+gitbreaking-changes(7)
+======================
+
+NAME
+----
+gitbreaking-changes - Breaking changes for upcoming Git 3.0
+
+SYNOPSIS
+--------
+*
+
+DESCRIPTION
+-----------
+*
+
+== Introduction: Upcoming breaking changes
The Git project aims to ensure backwards compatibility to the best extent
possible. Minor releases will not break backwards compatibility unless there is
@@ -357,3 +372,7 @@ almost no users of any of the commands anymore.
Cf. <xmqqttjazwwa.fsf@gitster.g>,
<xmqqleeubork.fsf@gitster.g>,
<112b6568912a6de6672bf5592c3a718e@manjaro.org>.
+
+GIT
+---
+Part of the linkgit:git[1] suite
--
2.55.0.793.gc667de3f2c5
next prev parent reply other threads:[~2026-10-08 19:27 UTC|newest]
Thread overview: 25+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-28 10:41 [RFC PATCH 0/4] doc: move BreakingChanges to a manpage kristofferhaugsbakk
2026-09-28 10:41 ` [RFC PATCH 1/4] doc: transform breaking changes doc " kristofferhaugsbakk
2026-09-30 13:28 ` Patrick Steinhardt
2026-09-30 14:17 ` Kristoffer Haugsbakk
2026-09-30 14:28 ` Patrick Steinhardt
2026-09-28 10:41 ` [RFC PATCH 2/4] doc: gitbreaking-changes: replace msg-ids with URLs kristofferhaugsbakk
2026-09-30 13:28 ` Patrick Steinhardt
2026-09-30 14:09 ` Kristoffer Haugsbakk
2026-09-30 19:45 ` Junio C Hamano
2026-10-01 6:27 ` Patrick Steinhardt
2026-10-03 11:52 ` Kristoffer Haugsbakk
2026-10-03 14:10 ` Kristoffer Haugsbakk
2026-10-04 2:31 ` Junio C Hamano
2026-10-06 16:38 ` Kristoffer Haugsbakk
2026-10-06 20:33 ` Junio C Hamano
2026-09-28 10:41 ` [RFC PATCH 3/4] doc: gitbreaking-changes: add note about living document kristofferhaugsbakk
2026-09-28 10:41 ` [RFC PATCH 4/4] doc: git: mention gitbreaking-changes(7) kristofferhaugsbakk
2026-10-08 19:27 ` [PATCH v2 0/5] doc: move BreakingChanges to a manpage kristofferhaugsbakk
2026-10-08 19:27 ` kristofferhaugsbakk [this message]
2026-10-08 19:46 ` [PATCH v2 1/5] doc: BreakingChanges: transform " D. Ben Knoble
2026-10-09 8:24 ` Kristoffer Haugsbakk
2026-10-08 19:27 ` [PATCH v2 2/5] doc: gitbreaking-changes: create from BreakingChanges kristofferhaugsbakk
2026-10-08 19:27 ` [PATCH v2 3/5] doc: gitbreaking-changes: replace msg-ids with URLs kristofferhaugsbakk
2026-10-08 19:27 ` [PATCH v2 4/5] doc: gitbreaking-changes: add note about living document kristofferhaugsbakk
2026-10-08 19:27 ` [PATCH v2 5/5] doc: gitbreaking-changes: move new-items discussion to the end kristofferhaugsbakk
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=V2_BrCh_become_manpage.dc5@m5gid.xyz \
--to=kristofferhaugsbakk@fastmail.com \
--cc=code@khaugsbakk.name \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=ps@pks.im \
/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