Mercurial > hg
view contrib/dirstatenonnormalcheck.py @ 31793:69d8fcf20014
help: document bundle specifications
I softly formalized the concept of a "bundle specification" a while
ago when I was working on clone bundles and stream clone bundles and
wanted a more robust way to define what exactly is in a bundle file.
The concept has existed for a while. Since it is part of the clone
bundles feature and exposed to the user via the "-t" argument to
`hg bundle`, it is something we need to support for the long haul.
After the 4.1 release, I heard a few people comment that they didn't
realize you could generate zstd bundles with `hg bundle`. I'm
partially to blame for not documenting it in bundle's docstring.
Additionally, I added a hacky, experimental feature for controlling
the compression level of bundles in 76104a4899ad. As the commit
message says, I went with a quick and dirty solution out of time
constraints. Furthermore, I wanted to eventually store this
configuration in the "bundlespec" so it could be made more flexible.
Given:
a) bundlespecs are here to stay
b) we don't have great documentation over what they are, despite being
a user-facing feature
c) the list of available compression engines and their behavior isn't
exposed
d) we need an extensible place to modify behavior of compression
engines
I want to move forward with formalizing bundlespecs as a user-facing
feature. This commit does that by introducing a "bundlespec" help
page. Leaning on the just-added compression engine documentation
and API, the topic also conveniently lists available compression
engines and details about them. This makes features like zstd
bundle compression more discoverable. e.g. you can now
`hg help -k zstd` and it lists the "bundlespec" topic.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Sat, 01 Apr 2017 13:42:06 -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)