Mercurial > hg
changeset 47758:ec77f709495c
relnotes: document the change in the dirstate API
Differential Revision: https://phab.mercurial-scm.org/D11200
| author | Pierre-Yves David <pierre-yves.david@octobus.net> |
|---|---|
| date | Mon, 19 Jul 2021 23:14:38 +0200 |
| parents | 7375add1ca92 |
| children | d7515d29761d 460e479be66e |
| files | relnotes/next |
| diffstat | 1 files changed, 27 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- 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.