Patchwork D11200: relnotes: document the change in the dirstate API

login
register
mail settings
Submitter phabricator
Date July 19, 2021, 3:45 p.m.
Message ID <differential-rev-PHID-DREV-msvl6ptjmmptos4qin4x-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/49511/
State Superseded
Headers show

Comments

phabricator - July 19, 2021, 3:45 p.m.
marmoute created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D11200

AFFECTED FILES
  relnotes/next

CHANGE DETAILS




To: marmoute, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

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, the previous function leaked some internal
+details and did not distinct between two importan 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 function have been deprecated:
+
+- dirstate.add
+- dirstate.normal
+- dirstate.normallookup
+- dirstate.merge
+- dirstate.otherparent
+- dirstate.remove
+- dirstate.drop
+
+And theses new functions are added for the "adjusting parent" use-case:
+
+- dirstate.update_file
+- dirstate.update_file_p1
+
+And theses 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.