[Updated] D11200: relnotes: document the change in the dirstate API
marmoute (Pierre-Yves David)
phabricator at mercurial-scm.org
Tue Jul 20 20:42:58 UTC 2021
Closed by commit rHGec77f709495c: relnotes: document the change in the dirstate API (authored by marmoute).
This revision was automatically updated to reflect the committed changes.
This revision was not accepted when it landed; it landed in state "Needs Review".
REPOSITORY
rHG Mercurial
CHANGES SINCE LAST UPDATE
https://phab.mercurial-scm.org/D11200?vs=29531&id=29701
CHANGES SINCE LAST ACTION
https://phab.mercurial-scm.org/D11200/new/
REVISION DETAIL
https://phab.mercurial-scm.org/D11200
AFFECTED FILES
relnotes/next
CHANGE DETAILS
diff --git a/relnotes/next b/relnotes/next
--- a/relnotes/next
+++ b/relnotes/next
@@ -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.
To: marmoute, #hg-reviewers, Alphare
Cc: Alphare, mercurial-patches
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mercurial-scm.org/pipermail/mercurial-patches/attachments/20210720/74a5a375/attachment-0002.html>
More information about the Mercurial-patches
mailing list