dirstate: update the documentation of the dirstatemap API
authorPierre-Yves David <pierre-yves.david@octobus.net>
Wed, 15 Sep 2021 18:27:57 +0200
changeset 47996 aa442fde0ea5
parent 47995 e7d0a511965c
child 47997 70547a7d5930
dirstate: update the documentation of the dirstatemap API The API changed so should the documentation. Differential Revision: https://phab.mercurial-scm.org/D11436
mercurial/dirstatemap.py
--- a/mercurial/dirstatemap.py	Wed Sep 15 12:38:56 2021 +0200
+++ b/mercurial/dirstatemap.py	Wed Sep 15 18:27:57 2021 +0200
@@ -46,8 +46,14 @@
     - the state map maps filenames to tuples of (state, mode, size, mtime),
       where state is a single character representing 'normal', 'added',
       'removed', or 'merged'. It is read by treating the dirstate as a
-      dict.  File state is updated by calling the `addfile`, `removefile` and
-      `dropfile` methods.
+      dict.  File state is updated by calling various methods (see each
+      documentation for details):
+
+      - `reset_state`,
+      - `set_tracked`
+      - `set_untracked`
+      - `set_clean`
+      - `set_possibly_dirty`
 
     - `copymap` maps destination filenames to their source filename.