D1380: dirstate: document dirstatemap interface
mbthomas (Mark Thomas)
phabricator at mercurial-scm.org
Mon Nov 13 07:18:08 EST 2017
mbthomas created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.
diff --git a/mercurial/dirstate.py b/mercurial/dirstate.py
@@ -127,8 +127,7 @@
- '''Return the dirstate contents as a map from filename to
- (state, mode, size, time).'''
+ '''Return the dirstate contents (see documentation for dirstatemap).'''
self._map = dirstatemap(self._ui, self._opener, self._root)
@@ -1196,6 +1195,46 @@
+ Dirstate contents
+ The dirstate contains the following state:
+ - `identity` is the identity of the dirstate file, which can be used to
+ detect when changes have occurred to the dirstate file.
+ - `parents` is a pair containing the parents of the working copy. The
+ parents are updated by calling `setparents`.
+ - 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 accessed by treating the dirstate as a
+ - `copymap` is a dict mapping filenames to the filename they were copied
+ The dirstate also provides the following views onto the state:
+ - `nonnormalset` is a set of the filenames that have state other
+ than 'normal', or are normal but have an mtime of -1 ('normallookup').
+ - `otherparentset` is a set of the filenames that are marked as coming
+ from the second parent when the dirstate is currently being merged.
+ - `dirs` is a set-like object containing all the directories that contain
+ files in the dirstate, excluding any files that are marked as removed.
+ - `filefoldmap` is a dict mapping normalized filenames to the denormalized
+ form that they appear as in the dirstate.
+ - `dirfoldmap` is a dict mapping normalized directory names to the
+ denormalized form that they appear as in the dirstate.
+ Once instantiated, the nonnormalset, otherparentset, dirs, filefoldmap and
+ dirfoldmap views must be maintained by the caller.
def __init__(self, ui, opener, root):
self._ui = ui
self._opener = opener
To: mbthomas, #hg-reviewers
More information about the Mercurial-devel