This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1380

dirstate: document dirstatemap interface
ClosedPublic

Authored by mbthomas on Nov 13 2017, 7:18 AM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHGa052022639cc: dirstate: document dirstatemap interface
rHG74b8563e4f13: dirstate: document dirstatemap interface

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

mbthomas created this revision.Nov 13 2017, 7:18 AM
durin42 requested changes to this revision.Nov 13 2017, 5:41 PM
durin42 added a subscriber: durin42.
durin42 added inline comments.
mercurial/dirstate.py
1198

Nit: let's try and prefer """ to '''

Try and get a pithy one-line summary of the class on the first line of the docstring with the """

1214

copymap maps destination filenames to their source filename

perhaps? either way, optional.

This revision now requires changes to proceed.Nov 13 2017, 5:41 PM
mbthomas added inline comments.Nov 14 2017, 2:19 PM
mercurial/dirstate.py
1198

Sure. This file uses a mix of """ and ''' and I couldn't tell which was preferred.

mbthomas updated this revision to Diff 3513.Nov 15 2017, 4:08 AM
durin42 accepted this revision.Nov 17 2017, 5:22 PM
This revision is now accepted and ready to land.Nov 17 2017, 5:22 PM
Closed by commit rHG74b8563e4f13: dirstate: document dirstatemap interface (authored by mbthomas). · Explain WhyNov 17 2017, 5:28 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/dirstate.py (41 lines)

Diff 3612

mercurial/dirstate.py

def pendingparentchange(self): def pendingparentchange(self):
'''Returns true if the dirstate is in the middle of a set of changes '''Returns true if the dirstate is in the middle of a set of changes
that modify the dirstate parent. that modify the dirstate parent.
''' '''
return self._parentwriters > 0 return self._parentwriters > 0
@propertycache @propertycache
def _map(self): def _map(self):
'''Return the dirstate contents as a map from filename to """Return the dirstate contents (see documentation for dirstatemap)."""
(state, mode, size, time).'''
self._map = dirstatemap(self._ui, self._opener, self._root) self._map = dirstatemap(self._ui, self._opener, self._root)
return self._map return self._map
@property @property
def _sparsematcher(self): def _sparsematcher(self):
"""The matcher for the sparse checkout. """The matcher for the sparse checkout.
The working directory may not include every file from a manifest. The The working directory may not include every file from a manifest. The
else: else:
o.rename(backupname, filename, checkambig=True) o.rename(backupname, filename, checkambig=True)
def clearbackup(self, tr, backupname): def clearbackup(self, tr, backupname):
'''Clear backup file''' '''Clear backup file'''
self._opener.unlink(backupname) self._opener.unlink(backupname)
class dirstatemap(object): class dirstatemap(object):
"""Map encapsulating the dirstate's contents.
durin42Unsubmitted
Not Done

Nit: let's try and prefer """ to '''

Try and get a pithy one-line summary of the class on the first line of the docstring with the """

durin42: Nit: let's try and prefer """ to ''' Try and get a pithy one-line summary of the class on the…
mbthomasAuthorUnsubmitted
Not Done

Sure. This file uses a mix of """ and ''' and I couldn't tell which was preferred.

mbthomas: Sure. This file uses a mix of `"""` and `'''` and I couldn't tell which was preferred.
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
dict.
- `copymap` maps destination filenames to their source filename.
durin42Unsubmitted
Not Done

copymap maps destination filenames to their source filename

perhaps? either way, optional.

durin42: `copymap` maps destination filenames to their source filename perhaps? either way, optional.
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): def __init__(self, ui, opener, root):
self._ui = ui self._ui = ui
self._opener = opener self._opener = opener
self._root = root self._root = root
self._filename = 'dirstate' self._filename = 'dirstate'
self._parents = None self._parents = None
self._dirtyparents = False self._dirtyparents = False