[PATCH v2 5/5] doc: gitbreaking-changes: move new-items discussion to the end
- From
- kristofferhaugsbakk@fastmail.com <kristofferhaugsbakk@fastmail.com>
- Date
- Oct 8, 2026, 19:27 UTC
- Message-ID
- <V2_move_new-items_disc.dc9@m5gid.xyz>
- In-Reply-To
- <V2_CV_gitbrchanges7_please.dc4@m5gid.xyz>
From: Kristoffer Haugsbakk <code@khaugsbakk.name>
The target audience for this page is expanding. That means that this discussion about how to add new entries will not be as relevant to the average reader. Let’s move it to the end of the page.
Suggested-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Kristoffer Haugsbakk <code@khaugsbakk.name> ---
Notes (series):
v2:
• New: <ar0OltAkeTiCx81c@pks.im>Documentation/gitbreaking-changes.adoc | 30 ++++++++++++++------------ 1 file changed, 16 insertions(+), 14 deletions(-)
diff --git a/Documentation/gitbreaking-changes.adoc b/Documentation/gitbreaking-changes.adoc index b94759260d9..e984c2c8ca5 100644 --- a/Documentation/gitbreaking-changes.adoc +++ b/Documentation/gitbreaking-changes.adoc @@ -54,20 +54,6 @@ breaking releases. Furthermore, this document also tracks what will _not_ be deprecated. This is done such that the outcome of discussions document both when the discussion favors deprecation, but also when it rejects a deprecation. -Items should have a clear summary of the reasons why we do or do not want to -make the described change that can be easily understood without having to read -the mailing list discussions. If there are alternatives to the changed feature, -those alternatives should be pointed out to our users. - -All items should be accompanied by links to relevant mailing list threads -where the deprecation was discussed. These links use this format: - - https://lore.kernel.org/git/$message_id/ - -I.e. they link to the `Message-ID` of the email on the mailing -list. These references are there to make it easier for you to find how -the project reached consensus on the described item back then. - This is a living document as the environment surrounding the project changes 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 @@ -382,6 +368,22 @@ Cf. https://lore.kernel.org/git/xmqqttjazwwa.fsf@gitster.g, https://lore.kernel.org/git/xmqqleeubork.fsf@gitster.g, https://lore.kernel.org/git/112b6568912a6de6672bf5592c3a718e@manjaro.org. +== Adding new items + +Items should have a clear summary of the reasons why we do or do not want to +make the described change that can be easily understood without having to read +the mailing list discussions. If there are alternatives to the changed feature, +those alternatives should be pointed out to our users. + +All items should be accompanied by links to relevant mailing list threads +where the deprecation was discussed. These links use this format: + + https://lore.kernel.org/git/$message_id/ + +I.e. they link to the `Message-ID` of the email on the mailing +list. These references are there to make it easier for you to find how +the project reached consensus on the described item back then. + GIT --- Part of the linkgit:git[1] suite
-- 2.55.0.793.gc667de3f2c5