relnotes: document the change in the dirstate API
Differential Revision: https://phab.mercurial-scm.org/D11200
--- a/relnotes/next Mon Jul 19 08:56:56 2021 +0200
+++ b/relnotes/next Mon Jul 19 23:14:38 2021 +0200
@@ -21,4 +21,31 @@
== Internal API Changes ==
+The Dirstate API have been updated as the previous function leaked some
+internal details and did not distinct between two important cases: "We are
+changing parent and need to adjust the dirstate" and "some command is changing
+which file is tracked". To clarify the situation:
+* the following functions have been deprecated,
+
+ - dirstate.add,
+ - dirstate.normal,
+ - dirstate.normallookup,
+ - dirstate.merge,
+ - dirstate.otherparent,
+ - dirstate.remove,
+ - dirstate.drop,
+
+* these new functions are added for the "adjusting parents" use-case:
+
+ - dirstate.update_file,
+ - dirstate.update_file_p1,
+
+* these new function are added for the "adjusting wc file" use-case":
+
+ - dirstate.set_tracked,
+ - dirstate.set_untracked,
+ - dirstate.set_clean,
+ - dirstate.set_possibly_dirty,
+
+See inline documentation of the new functions for details.