Mercurial > hg
view contrib/dirstatenonnormalcheck.py @ 29859:a1092e2d70a3
help: internals topic for wire protocol
The Mercurial wire protocol is under-documented. This includes a lack
of source docstrings and comments as well as pages on the official
wiki.
This patch adds the beginnings of "internals" documentation on the
wire protocol.
The documentation should have nearly complete coverage on the
lower-level parts of the protocol, such as the different transport
mechanims, how commands and arguments are sent, capabilities, and,
of course, the commands themselves.
As part of writing this documentation, I discovered a number of
deficiencies in the protocol and bugs in the implementation. I've
started sending patches for some of the issues. I hope to send a lot
more.
This patch starts with the scaffolding for a new internals page.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Mon, 22 Aug 2016 19:46:39 -0700 |
parents | 3fd94f603190 |
children | 60927b19ed65 |
line wrap: on
line source
# dirstatenonnormalcheck.py - extension to check the consistency of the # dirstate's non-normal map # # For most operations on dirstate, this extensions checks that the nonnormalset # contains the right entries. # It compares the nonnormal file to a nonnormalset built from the map of all # the files in the dirstate to check that they contain the same files. from __future__ import absolute_import from mercurial import ( dirstate, extensions, ) def nonnormalentries(dmap): """Compute nonnormal entries from dirstate's dmap""" res = set() for f, e in dmap.iteritems(): if e[0] != 'n' or e[3] == -1: res.add(f) return res def checkconsistency(ui, orig, dmap, _nonnormalset, label): """Compute nonnormalset from dmap, check that it matches _nonnormalset""" nonnormalcomputedmap = nonnormalentries(dmap) if _nonnormalset != nonnormalcomputedmap: ui.develwarn("%s call to %s\n" % (label, orig), config='dirstate') ui.develwarn("inconsistency in nonnormalset\n", config='dirstate') ui.develwarn("[nonnormalset] %s\n" % _nonnormalset, config='dirstate') ui.develwarn("[map] %s\n" % nonnormalcomputedmap, config='dirstate') def _checkdirstate(orig, self, arg): """Check nonnormal set consistency before and after the call to orig""" checkconsistency(self._ui, orig, self._map, self._nonnormalset, "before") r = orig(self, arg) checkconsistency(self._ui, orig, self._map, self._nonnormalset, "after") return r def extsetup(ui): """Wrap functions modifying dirstate to check nonnormalset consistency""" dirstatecl = dirstate.dirstate devel = ui.configbool('devel', 'all-warnings') paranoid = ui.configbool('experimental', 'nonnormalparanoidcheck') if devel: extensions.wrapfunction(dirstatecl, '_writedirstate', _checkdirstate) if paranoid: # We don't do all these checks when paranoid is disable as it would # make the extension run very slowly on large repos extensions.wrapfunction(dirstatecl, 'normallookup', _checkdirstate) extensions.wrapfunction(dirstatecl, 'otherparent', _checkdirstate) extensions.wrapfunction(dirstatecl, 'normal', _checkdirstate) extensions.wrapfunction(dirstatecl, 'write', _checkdirstate) extensions.wrapfunction(dirstatecl, 'add', _checkdirstate) extensions.wrapfunction(dirstatecl, 'remove', _checkdirstate) extensions.wrapfunction(dirstatecl, 'merge', _checkdirstate) extensions.wrapfunction(dirstatecl, 'drop', _checkdirstate)