dirstate: add docstring for invalidate
authorSiddharth Agarwal <sid0@fb.com>
Sun, 04 Jun 2017 16:08:50 -0700
changeset 32682 e696f597d02f
parent 32681 d677bd21ee98
child 32683 9f840d99054c
dirstate: add docstring for invalidate This always confuses me, and we already have a docstring on localrepo.invalidatedirstate.
mercurial/dirstate.py
--- a/mercurial/dirstate.py	Fri Jun 02 23:05:03 2017 -0700
+++ b/mercurial/dirstate.py	Sun Jun 04 16:08:50 2017 -0700
@@ -470,6 +470,12 @@
             self._pl = p
 
     def invalidate(self):
+        '''Causes the next access to reread the dirstate.
+
+        This is different from localrepo.invalidatedirstate() because it always
+        rereads the dirstate. Use localrepo.invalidatedirstate() if you want to
+        check whether the dirstate has changed before rereading it.'''
+
         for a in ("_map", "_copymap", "_filefoldmap", "_dirfoldmap", "_branch",
                   "_pl", "_dirs", "_ignore", "_nonnormalset",
                   "_otherparentset"):