diff mbox series

[v4,3/4] BreakingChanges: document removal of grafting

Message ID 91d78490c2358b417e32694d8dc125b93a4e389d.1717141598.git.ps@pks.im (mailing list archive)
State Superseded
Headers show
Series docs: document upcoming breaking changes | expand

Commit Message

Patrick Steinhardt May 31, 2024, 7:56 a.m. UTC 
The grafting mechanism for objects has been deprecated in e650d0643b
(docs: mark info/grafts as outdated, 2014-03-05), which is more than a
decade ago. The mechanism can lead to hard-to-debug issues and has a
superior replacement with replace refs.

Follow through with the deprecation and mark grafts for removal in Git
3.0.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
---
 Documentation/BreakingChanges.md | 8 ++++++++
 1 file changed, 8 insertions(+)
diff mbox series

Patch

diff --git a/Documentation/BreakingChanges.md b/Documentation/BreakingChanges.md
index 1b0a357e65..14c0972b08 100644
--- a/Documentation/BreakingChanges.md
+++ b/Documentation/BreakingChanges.md
@@ -85,6 +85,14 @@  be changed to or replaced in case the alternative was implemented already.
 
 ### Removals
 
+ - Support for grafting commits has long been superseded by git-replace(1).
+   Grafts are inferior to replacement refs as the mechanism can lead to
+   hard-to-diagnose problems when transferring objects between repositories.
+   They have been outdated since e650d0643b (docs: mark info/grafts as outdated,
+   2014-03-05) and will be removed.
+
+   Cf. <20140304174806.GA11561@sigill.intra.peff.net>.
+
 ## Superseded features that will not be deprecated
 
 Some features have gained newer replacements that aim to improve the design in