git/list[1] front-page[2] threads[3] people[4] search[5] about
 

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

From
Kkristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
Date
Oct 8, 2026, 19:27 UTC
Message-ID
<V2_BrCh_become_manpage.dc5@m5gid.xyz>
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
Previous: kristofferhaugsbakk@fastmail.comNext: D. Ben Knoble
Message 19 of 25 in “doc: move BreakingChanges to a manpage”
  1. 0/4 doc: move BreakingChanges to a manpagekristofferhaugsbakk@fastmail.com, Sep 28, 2026
  2. 1/4 doc: transform breaking changes doc to a manpagekristofferhaugsbakk@fastmail.com, Sep 28, 2026
  3. Patrick SteinhardtSep 30, 2026
  4. Kristoffer HaugsbakkSep 30, 2026
  5. Patrick SteinhardtSep 30, 2026
  6. 2/4 doc: gitbreaking-changes: replace msg-ids with URLskristofferhaugsbakk@fastmail.com, Sep 28, 2026
  7. Patrick SteinhardtSep 30, 2026
  8. Kristoffer HaugsbakkSep 30, 2026
  9. Junio C HamanoSep 30, 2026
  10. Patrick SteinhardtOct 1, 2026
  11. Kristoffer HaugsbakkOct 3, 2026
  12. Kristoffer HaugsbakkOct 3, 2026
  13. Junio C HamanoOct 4, 2026
  14. Kristoffer HaugsbakkOct 6, 2026
  15. Junio C HamanoOct 6, 2026
  16. 3/4 doc: gitbreaking-changes: add note about living documentkristofferhaugsbakk@fastmail.com, Sep 28, 2026
  17. 4/4 doc: git: mention gitbreaking-changes(7)kristofferhaugsbakk@fastmail.com, Sep 28, 2026
  18. 0/5 doc: move BreakingChanges to a manpagekristofferhaugsbakk@fastmail.com, Oct 8, 2026
  19. 1/5 doc: BreakingChanges: transform to a manpagekristofferhaugsbakk@fastmail.com, Oct 8, 2026
  20. D. Ben KnobleOct 8, 2026
  21. Kristoffer HaugsbakkOct 9, 2026
  22. 2/5 doc: gitbreaking-changes: create from BreakingChangeskristofferhaugsbakk@fastmail.com, Oct 8, 2026
  23. 3/5 doc: gitbreaking-changes: replace msg-ids with URLskristofferhaugsbakk@fastmail.com, Oct 8, 2026
  24. 4/5 doc: gitbreaking-changes: add note about living documentkristofferhaugsbakk@fastmail.com, Oct 8, 2026
  25. 5/5 doc: gitbreaking-changes: move new-items discussion to the endkristofferhaugsbakk@fastmail.com, Oct 8, 2026

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.