[RFC PATCH 3/4] doc: gitbreaking-changes: add note about living document

From: kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
Date: Sep 28, 2026, 10:41 UTC
Message-ID: <gitbrchanges7_living_doc.d1f@m5gid.xyz>
In-Reply-To: <CV_gitbrchanges7_please.d1c@m5gid.xyz>

From: Kristoffer Haugsbakk <code@khaugsbakk.name>

This document has always stated that it is a “living document”, subject to change. With that in mind, we should be mindful of a potentially larger readerbase now that this is a more public-facing page. One could imagine that someone reads this document on a released version, disagrees with a point there, and posts feedback to the project—but this decision could have already been reverted in the live document.[1]

Let’s add a note (admonition) following the “live document” with such a reminder. Let’s keep it short and simple though and not go into how to fetch the source. They can figure that out themselves.

† 1: Let’s say that someone on Git for Debian Stable reads about the
     breaking changes for Git 3.0. They don’t like something about it
     so they post it to the mailing list. Then the mailing list informs
     them that Git 3.0 was released two years ago and that the current
     document is about Git 4.0.

Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name>
---
 Documentation/gitbreaking-changes.adoc | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/Documentation/gitbreaking-changes.adoc b/Documentation/gitbreaking-changes.adoc
index 9aba419efc9..410476c7993 100644
--- a/Documentation/gitbreaking-changes.adoc
+++ b/Documentation/gitbreaking-changes.adoc
@@ -73,6 +73,16 @@ over time. If circumstances change, an earlier decision to deprecate or change
 something may need to be revisited from time to time. So do not take items on
 this list to mean "it is settled, do not waste our time bringing it up again".
 
+[NOTE]
+--
+In case you are reading this document from a released version: this
+being a _living document_ means that you might want to consult what
+the current, development version of the document looks like in case
+anything here motivates you to post some feedback to the project.
+Because specific details you read here might have been changed in the
+development version.
+--
+
 == Procedure
 
 Discussing the desire to make breaking changes, declaring that breaking

-- 
2.55.0.793.gc667de3f2c5