delta-find: add a way to control the number of bases tested at the same time

See inline comment for details.

The feature is currently disabled, but should be enabled by default to mitigate
some existing pathological cases.

Also see the next changeset for details.

mercurial/configitems.py

@@ -1,2896 +1,2901 b''
 # configitems.py - centralized declaration of configuration option
 #
 #  Copyright 2017 Pierre-Yves David <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import functools
 import re
 
 from . import (
     encoding,
     error,
 )
 
 
 def loadconfigtable(ui, extname, configtable):
     """update config item known to the ui with the extension ones"""
     for section, items in sorted(configtable.items()):
         knownitems = ui._knownconfig.setdefault(section, itemregister())
         knownkeys = set(knownitems)
         newkeys = set(items)
         for key in sorted(knownkeys & newkeys):
             msg = b"extension '%s' overwrite config item '%s.%s'"
             msg %= (extname, section, key)
             ui.develwarn(msg, config=b'warn-config')
 
         knownitems.update(items)
 
 
 class configitem:
     """represent a known config item
 
     :section: the official config section where to find this item,
        :name: the official name within the section,
     :default: default value for this item,
     :alias: optional list of tuples as alternatives,
     :generic: this is a generic definition, match name using regular expression.
     """
 
     def __init__(
         self,
         section,
         name,
         default=None,
         alias=(),
         generic=False,
         priority=0,
         experimental=False,
     ):
         self.section = section
         self.name = name
         self.default = default
         self.alias = list(alias)
         self.generic = generic
         self.priority = priority
         self.experimental = experimental
         self._re = None
         if generic:
             self._re = re.compile(self.name)
 
 
 class itemregister(dict):
     """A specialized dictionary that can handle wild-card selection"""
 
     def __init__(self):
         super(itemregister, self).__init__()
         self._generics = set()
 
     def update(self, other):
         super(itemregister, self).update(other)
         self._generics.update(other._generics)
 
     def __setitem__(self, key, item):
         super(itemregister, self).__setitem__(key, item)
         if item.generic:
             self._generics.add(item)
 
     def get(self, key):
         baseitem = super(itemregister, self).get(key)
         if baseitem is not None and not baseitem.generic:
             return baseitem
 
         # search for a matching generic item
         generics = sorted(self._generics, key=(lambda x: (x.priority, x.name)))
         for item in generics:
             # we use 'match' instead of 'search' to make the matching simpler
             # for people unfamiliar with regular expression. Having the match
             # rooted to the start of the string will produce less surprising
             # result for user writing simple regex for sub-attribute.
             #
             # For example using "color\..*" match produces an unsurprising
             # result, while using search could suddenly match apparently
             # unrelated configuration that happens to contains "color."
             # anywhere. This is a tradeoff where we favor requiring ".*" on
             # some match to avoid the need to prefix most pattern with "^".
             # The "^" seems more error prone.
             if item._re.match(key):
                 return item
 
         return None
 
 
 coreitems = {}
 
 
 def _register(configtable, *args, **kwargs):
     item = configitem(*args, **kwargs)
     section = configtable.setdefault(item.section, itemregister())
     if item.name in section:
         msg = b"duplicated config item registration for '%s.%s'"
         raise error.ProgrammingError(msg % (item.section, item.name))
     section[item.name] = item
 
 
 # special value for case where the default is derived from other values
 dynamicdefault = object()
 
 # Registering actual config items
 
 
 def getitemregister(configtable):
     f = functools.partial(_register, configtable)
     # export pseudo enum as configitem.*
     f.dynamicdefault = dynamicdefault
     return f
 
 
 coreconfigitem = getitemregister(coreitems)
 
 
 def _registerdiffopts(section, configprefix=b''):
     coreconfigitem(
         section,
         configprefix + b'nodates',
         default=False,
     )
     coreconfigitem(
         section,
         configprefix + b'showfunc',
         default=False,
     )
     coreconfigitem(
         section,
         configprefix + b'unified',
         default=None,
     )
     coreconfigitem(
         section,
         configprefix + b'git',
         default=False,
     )
     coreconfigitem(
         section,
         configprefix + b'ignorews',
         default=False,
     )
     coreconfigitem(
         section,
         configprefix + b'ignorewsamount',
         default=False,
     )
     coreconfigitem(
         section,
         configprefix + b'ignoreblanklines',
         default=False,
     )
     coreconfigitem(
         section,
         configprefix + b'ignorewseol',
         default=False,
     )
     coreconfigitem(
         section,
         configprefix + b'nobinary',
         default=False,
     )
     coreconfigitem(
         section,
         configprefix + b'noprefix',
         default=False,
     )
     coreconfigitem(
         section,
         configprefix + b'word-diff',
         default=False,
     )
 
 
 coreconfigitem(
     b'alias',
     b'.*',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem(
     b'auth',
     b'cookiefile',
     default=None,
 )
 _registerdiffopts(section=b'annotate')
 # bookmarks.pushing: internal hack for discovery
 coreconfigitem(
     b'bookmarks',
     b'pushing',
     default=list,
 )
 # bundle.mainreporoot: internal hack for bundlerepo
 coreconfigitem(
     b'bundle',
     b'mainreporoot',
     default=b'',
 )
 coreconfigitem(
     b'censor',
     b'policy',
     default=b'abort',
     experimental=True,
 )
 coreconfigitem(
     b'chgserver',
     b'idletimeout',
     default=3600,
 )
 coreconfigitem(
     b'chgserver',
     b'skiphash',
     default=False,
 )
 coreconfigitem(
     b'cmdserver',
     b'log',
     default=None,
 )
 coreconfigitem(
     b'cmdserver',
     b'max-log-files',
     default=7,
 )
 coreconfigitem(
     b'cmdserver',
     b'max-log-size',
     default=b'1 MB',
 )
 coreconfigitem(
     b'cmdserver',
     b'max-repo-cache',
     default=0,
     experimental=True,
 )
 coreconfigitem(
     b'cmdserver',
     b'message-encodings',
     default=list,
 )
 coreconfigitem(
     b'cmdserver',
     b'track-log',
     default=lambda: [b'chgserver', b'cmdserver', b'repocache'],
 )
 coreconfigitem(
     b'cmdserver',
     b'shutdown-on-interrupt',
     default=True,
 )
 coreconfigitem(
     b'color',
     b'.*',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'color',
     b'mode',
     default=b'auto',
 )
 coreconfigitem(
     b'color',
     b'pagermode',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'command-templates',
     b'graphnode',
     default=None,
     alias=[(b'ui', b'graphnodetemplate')],
 )
 coreconfigitem(
     b'command-templates',
     b'log',
     default=None,
     alias=[(b'ui', b'logtemplate')],
 )
 coreconfigitem(
     b'command-templates',
     b'mergemarker',
     default=(
         b'{node|short} '
         b'{ifeq(tags, "tip", "", '
         b'ifeq(tags, "", "", "{tags} "))}'
         b'{if(bookmarks, "{bookmarks} ")}'
         b'{ifeq(branch, "default", "", "{branch} ")}'
         b'- {author|user}: {desc|firstline}'
     ),
     alias=[(b'ui', b'mergemarkertemplate')],
 )
 coreconfigitem(
     b'command-templates',
     b'pre-merge-tool-output',
     default=None,
     alias=[(b'ui', b'pre-merge-tool-output-template')],
 )
 coreconfigitem(
     b'command-templates',
     b'oneline-summary',
     default=None,
 )
 coreconfigitem(
     b'command-templates',
     b'oneline-summary.*',
     default=dynamicdefault,
     generic=True,
 )
 _registerdiffopts(section=b'commands', configprefix=b'commit.interactive.')
 coreconfigitem(
     b'commands',
     b'commit.post-status',
     default=False,
 )
 coreconfigitem(
     b'commands',
     b'grep.all-files',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'commands',
     b'merge.require-rev',
     default=False,
 )
 coreconfigitem(
     b'commands',
     b'push.require-revs',
     default=False,
 )
 coreconfigitem(
     b'commands',
     b'resolve.confirm',
     default=False,
 )
 coreconfigitem(
     b'commands',
     b'resolve.explicit-re-merge',
     default=False,
 )
 coreconfigitem(
     b'commands',
     b'resolve.mark-check',
     default=b'none',
 )
 _registerdiffopts(section=b'commands', configprefix=b'revert.interactive.')
 coreconfigitem(
     b'commands',
     b'show.aliasprefix',
     default=list,
 )
 coreconfigitem(
     b'commands',
     b'status.relative',
     default=False,
 )
 coreconfigitem(
     b'commands',
     b'status.skipstates',
     default=[],
     experimental=True,
 )
 coreconfigitem(
     b'commands',
     b'status.terse',
     default=b'',
 )
 coreconfigitem(
     b'commands',
     b'status.verbose',
     default=False,
 )
 coreconfigitem(
     b'commands',
     b'update.check',
     default=None,
 )
 coreconfigitem(
     b'commands',
     b'update.requiredest',
     default=False,
 )
 coreconfigitem(
     b'committemplate',
     b'.*',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'convert',
     b'bzr.saverev',
     default=True,
 )
 coreconfigitem(
     b'convert',
     b'cvsps.cache',
     default=True,
 )
 coreconfigitem(
     b'convert',
     b'cvsps.fuzz',
     default=60,
 )
 coreconfigitem(
     b'convert',
     b'cvsps.logencoding',
     default=None,
 )
 coreconfigitem(
     b'convert',
     b'cvsps.mergefrom',
     default=None,
 )
 coreconfigitem(
     b'convert',
     b'cvsps.mergeto',
     default=None,
 )
 coreconfigitem(
     b'convert',
     b'git.committeractions',
     default=lambda: [b'messagedifferent'],
 )
 coreconfigitem(
     b'convert',
     b'git.extrakeys',
     default=list,
 )
 coreconfigitem(
     b'convert',
     b'git.findcopiesharder',
     default=False,
 )
 coreconfigitem(
     b'convert',
     b'git.remoteprefix',
     default=b'remote',
 )
 coreconfigitem(
     b'convert',
     b'git.renamelimit',
     default=400,
 )
 coreconfigitem(
     b'convert',
     b'git.saverev',
     default=True,
 )
 coreconfigitem(
     b'convert',
     b'git.similarity',
     default=50,
 )
 coreconfigitem(
     b'convert',
     b'git.skipsubmodules',
     default=False,
 )
 coreconfigitem(
     b'convert',
     b'hg.clonebranches',
     default=False,
 )
 coreconfigitem(
     b'convert',
     b'hg.ignoreerrors',
     default=False,
 )
 coreconfigitem(
     b'convert',
     b'hg.preserve-hash',
     default=False,
 )
 coreconfigitem(
     b'convert',
     b'hg.revs',
     default=None,
 )
 coreconfigitem(
     b'convert',
     b'hg.saverev',
     default=False,
 )
 coreconfigitem(
     b'convert',
     b'hg.sourcename',
     default=None,
 )
 coreconfigitem(
     b'convert',
     b'hg.startrev',
     default=None,
 )
 coreconfigitem(
     b'convert',
     b'hg.tagsbranch',
     default=b'default',
 )
 coreconfigitem(
     b'convert',
     b'hg.usebranchnames',
     default=True,
 )
 coreconfigitem(
     b'convert',
     b'ignoreancestorcheck',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'convert',
     b'localtimezone',
     default=False,
 )
 coreconfigitem(
     b'convert',
     b'p4.encoding',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'convert',
     b'p4.startrev',
     default=0,
 )
 coreconfigitem(
     b'convert',
     b'skiptags',
     default=False,
 )
 coreconfigitem(
     b'convert',
     b'svn.debugsvnlog',
     default=True,
 )
 coreconfigitem(
     b'convert',
     b'svn.trunk',
     default=None,
 )
 coreconfigitem(
     b'convert',
     b'svn.tags',
     default=None,
 )
 coreconfigitem(
     b'convert',
     b'svn.branches',
     default=None,
 )
 coreconfigitem(
     b'convert',
     b'svn.startrev',
     default=0,
 )
 coreconfigitem(
     b'convert',
     b'svn.dangerous-set-commit-dates',
     default=False,
 )
 coreconfigitem(
     b'debug',
     b'dirstate.delaywrite',
     default=0,
 )
 coreconfigitem(
     b'debug',
     b'revlog.verifyposition.changelog',
     default=b'',
 )
 coreconfigitem(
     b'debug',
     b'revlog.debug-delta',
     default=False,
 )
 # display extra information about the bundling process
 coreconfigitem(
     b'debug',
     b'bundling-stats',
     default=False,
 )
 # display extra information about the unbundling process
 coreconfigitem(
     b'debug',
     b'unbundling-stats',
     default=False,
 )
 coreconfigitem(
     b'defaults',
     b'.*',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'devel',
     b'all-warnings',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'bundle2.debug',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'bundle.delta',
     default=b'',
 )
 coreconfigitem(
     b'devel',
     b'cache-vfs',
     default=None,
 )
 coreconfigitem(
     b'devel',
     b'check-locks',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'check-relroot',
     default=False,
 )
 # Track copy information for all file, not just "added" one (very slow)
 coreconfigitem(
     b'devel',
     b'copy-tracing.trace-all-files',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'default-date',
     default=None,
 )
 coreconfigitem(
     b'devel',
     b'deprec-warn',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'disableloaddefaultcerts',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'warn-empty-changegroup',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'legacy.exchange',
     default=list,
 )
 # When True, revlogs use a special reference version of the nodemap, that is not
 # performant but is "known" to behave properly.
 coreconfigitem(
     b'devel',
     b'persistent-nodemap',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'servercafile',
     default=b'',
 )
 coreconfigitem(
     b'devel',
     b'serverexactprotocol',
     default=b'',
 )
 coreconfigitem(
     b'devel',
     b'serverrequirecert',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'strip-obsmarkers',
     default=True,
 )
 coreconfigitem(
     b'devel',
     b'warn-config',
     default=None,
 )
 coreconfigitem(
     b'devel',
     b'warn-config-default',
     default=None,
 )
 coreconfigitem(
     b'devel',
     b'user.obsmarker',
     default=None,
 )
 coreconfigitem(
     b'devel',
     b'warn-config-unknown',
     default=None,
 )
 coreconfigitem(
     b'devel',
     b'debug.copies',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'copy-tracing.multi-thread',
     default=True,
 )
 coreconfigitem(
     b'devel',
     b'debug.extensions',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'debug.repo-filters',
     default=False,
 )
 coreconfigitem(
     b'devel',
     b'debug.peer-request',
     default=False,
 )
 # If discovery.exchange-heads is False, the discovery will not start with
 # remote head fetching and local head querying.
 coreconfigitem(
     b'devel',
     b'discovery.exchange-heads',
     default=True,
 )
 # If discovery.grow-sample is False, the sample size used in set discovery will
 # not be increased through the process
 coreconfigitem(
     b'devel',
     b'discovery.grow-sample',
     default=True,
 )
 # When discovery.grow-sample.dynamic is True, the default, the sample size is
 # adapted to the shape of the undecided set (it is set to the max of:
 # <target-size>, len(roots(undecided)), len(heads(undecided)
 coreconfigitem(
     b'devel',
     b'discovery.grow-sample.dynamic',
     default=True,
 )
 # discovery.grow-sample.rate control the rate at which the sample grow
 coreconfigitem(
     b'devel',
     b'discovery.grow-sample.rate',
     default=1.05,
 )
 # If discovery.randomize is False, random sampling during discovery are
 # deterministic. It is meant for integration tests.
 coreconfigitem(
     b'devel',
     b'discovery.randomize',
     default=True,
 )
 # Control the initial size of the discovery sample
 coreconfigitem(
     b'devel',
     b'discovery.sample-size',
     default=200,
 )
 # Control the initial size of the discovery for initial change
 coreconfigitem(
     b'devel',
     b'discovery.sample-size.initial',
     default=100,
 )
 _registerdiffopts(section=b'diff')
 coreconfigitem(
     b'diff',
     b'merge',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'email',
     b'bcc',
     default=None,
 )
 coreconfigitem(
     b'email',
     b'cc',
     default=None,
 )
 coreconfigitem(
     b'email',
     b'charsets',
     default=list,
 )
 coreconfigitem(
     b'email',
     b'from',
     default=None,
 )
 coreconfigitem(
     b'email',
     b'method',
     default=b'smtp',
 )
 coreconfigitem(
     b'email',
     b'reply-to',
     default=None,
 )
 coreconfigitem(
     b'email',
     b'to',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'archivemetatemplate',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'experimental',
     b'auto-publish',
     default=b'publish',
 )
 coreconfigitem(
     b'experimental',
     b'bundle-phases',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'bundle2-advertise',
     default=True,
 )
 coreconfigitem(
     b'experimental',
     b'bundle2-output-capture',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'bundle2.pushback',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'bundle2lazylocking',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecomplevel',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecomplevel.bzip2',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecomplevel.gzip',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecomplevel.none',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecomplevel.zstd',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecompthreads',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecompthreads.bzip2',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecompthreads.gzip',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecompthreads.none',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'bundlecompthreads.zstd',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'changegroup3',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'changegroup4',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'cleanup-as-archived',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'clientcompressionengines',
     default=list,
 )
 coreconfigitem(
     b'experimental',
     b'copytrace',
     default=b'on',
 )
 coreconfigitem(
     b'experimental',
     b'copytrace.movecandidateslimit',
     default=100,
 )
 coreconfigitem(
     b'experimental',
     b'copytrace.sourcecommitlimit',
     default=100,
 )
 coreconfigitem(
     b'experimental',
     b'copies.read-from',
     default=b"filelog-only",
 )
 coreconfigitem(
     b'experimental',
     b'copies.write-to',
     default=b'filelog-only',
 )
 coreconfigitem(
     b'experimental',
     b'crecordtest',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'directaccess',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'directaccess.revnums',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'editortmpinhg',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'evolution',
     default=list,
 )
 coreconfigitem(
     b'experimental',
     b'evolution.allowdivergence',
     default=False,
     alias=[(b'experimental', b'allowdivergence')],
 )
 coreconfigitem(
     b'experimental',
     b'evolution.allowunstable',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'evolution.createmarkers',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'evolution.effect-flags',
     default=True,
     alias=[(b'experimental', b'effect-flags')],
 )
 coreconfigitem(
     b'experimental',
     b'evolution.exchange',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'evolution.bundle-obsmarker',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'evolution.bundle-obsmarker:mandatory',
     default=True,
 )
 coreconfigitem(
     b'experimental',
     b'log.topo',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'evolution.report-instabilities',
     default=True,
 )
 coreconfigitem(
     b'experimental',
     b'evolution.track-operation',
     default=True,
 )
 # repo-level config to exclude a revset visibility
 #
 # The target use case is to use `share` to expose different subset of the same
 # repository, especially server side. See also `server.view`.
 coreconfigitem(
     b'experimental',
     b'extra-filter-revs',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'maxdeltachainspan',
     default=-1,
 )
 # tracks files which were undeleted (merge might delete them but we explicitly
 # kept/undeleted them) and creates new filenodes for them
 coreconfigitem(
     b'experimental',
     b'merge-track-salvaged',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'mmapindexthreshold',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'narrow',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'nonnormalparanoidcheck',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'exportableenviron',
     default=list,
 )
 coreconfigitem(
     b'experimental',
     b'extendedheader.index',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'extendedheader.similarity',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'graphshorten',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'graphstyle.parent',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'experimental',
     b'graphstyle.missing',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'experimental',
     b'graphstyle.grandparent',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'experimental',
     b'hook-track-tags',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'httppostargs',
     default=False,
 )
 coreconfigitem(b'experimental', b'nointerrupt', default=False)
 coreconfigitem(b'experimental', b'nointerrupt-interactiveonly', default=True)
 
 coreconfigitem(
     b'experimental',
     b'obsmarkers-exchange-debug',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'remotenames',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'removeemptydirs',
     default=True,
 )
 coreconfigitem(
     b'experimental',
     b'revert.interactive.select-to-keep',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'revisions.prefixhexnode',
     default=False,
 )
 # "out of experimental" todo list.
 #
 # * include management of a persistent nodemap in the main docket
 # * enforce a "no-truncate" policy for mmap safety
 #      - for censoring operation
 #      - for stripping operation
 #      - for rollback operation
 # * proper streaming (race free) of the docket file
 # * track garbage data to evemtually allow rewriting -existing- sidedata.
 # * Exchange-wise, we will also need to do something more efficient than
 #   keeping references to the affected revlogs, especially memory-wise when
 #   rewriting sidedata.
 # * introduce a proper solution to reduce the number of filelog related files.
 # * use caching for reading sidedata (similar to what we do for data).
 # * no longer set offset=0 if sidedata_size=0 (simplify cutoff computation).
 # * Improvement to consider
 #   - avoid compression header in chunk using the default compression?
 #   - forbid "inline" compression mode entirely?
 #   - split the data offset and flag field (the 2 bytes save are mostly trouble)
 #   - keep track of uncompressed -chunk- size (to preallocate memory better)
 #   - keep track of chain base or size (probably not that useful anymore)
 coreconfigitem(
     b'experimental',
     b'revlogv2',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'revisions.disambiguatewithin',
     default=None,
 )
 coreconfigitem(
     b'experimental',
     b'rust.index',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'server.filesdata.recommended-batch-size',
     default=50000,
 )
 coreconfigitem(
     b'experimental',
     b'server.manifestdata.recommended-batch-size',
     default=100000,
 )
 coreconfigitem(
     b'experimental',
     b'server.stream-narrow-clones',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'single-head-per-branch',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'single-head-per-branch:account-closed-heads',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'single-head-per-branch:public-changes-only',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'sparse-read',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'sparse-read.density-threshold',
     default=0.50,
 )
 coreconfigitem(
     b'experimental',
     b'sparse-read.min-gap-size',
     default=b'65K',
 )
 coreconfigitem(
     b'experimental',
     b'treemanifest',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'update.atomic-file',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'web.full-garbage-collection-rate',
     default=1,  # still forcing a full collection on each request
 )
 coreconfigitem(
     b'experimental',
     b'worker.wdir-get-thread-safe',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'worker.repository-upgrade',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'xdiff',
     default=False,
 )
 coreconfigitem(
     b'extensions',
     b'[^:]*',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'extensions',
     b'[^:]*:required',
     default=False,
     generic=True,
 )
 coreconfigitem(
     b'extdata',
     b'.*',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'format',
     b'bookmarks-in-store',
     default=False,
 )
 coreconfigitem(
     b'format',
     b'chunkcachesize',
     default=None,
     experimental=True,
 )
 coreconfigitem(
     # Enable this dirstate format *when creating a new repository*.
     # Which format to use for existing repos is controlled by .hg/requires
     b'format',
     b'use-dirstate-v2',
     default=False,
     experimental=True,
     alias=[(b'format', b'exp-rc-dirstate-v2')],
 )
 coreconfigitem(
     b'format',
     b'use-dirstate-v2.automatic-upgrade-of-mismatching-repositories',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'use-dirstate-v2.automatic-upgrade-of-mismatching-repositories:quiet',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'use-dirstate-tracked-hint',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'use-dirstate-tracked-hint.version',
     default=1,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories:quiet',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'dotencode',
     default=True,
 )
 coreconfigitem(
     b'format',
     b'generaldelta',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'manifestcachesize',
     default=None,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'maxchainlen',
     default=dynamicdefault,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'obsstore-version',
     default=None,
 )
 coreconfigitem(
     b'format',
     b'sparse-revlog',
     default=True,
 )
 coreconfigitem(
     b'format',
     b'revlog-compression',
     default=lambda: [b'zstd', b'zlib'],
     alias=[(b'experimental', b'format.compression')],
 )
 # Experimental TODOs:
 #
 # * Same as for revlogv2 (but for the reduction of the number of files)
 # * Actually computing the rank of changesets
 # * Improvement to investigate
 #   - storing .hgtags fnode
 #   - storing branch related identifier
 
 coreconfigitem(
     b'format',
     b'exp-use-changelog-v2',
     default=None,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'usefncache',
     default=True,
 )
 coreconfigitem(
     b'format',
     b'usegeneraldelta',
     default=True,
 )
 coreconfigitem(
     b'format',
     b'usestore',
     default=True,
 )
 
 
 def _persistent_nodemap_default():
     """compute `use-persistent-nodemap` default value
 
     The feature is disabled unless a fast implementation is available.
     """
     from . import policy
 
     return policy.importrust('revlog') is not None
 
 
 coreconfigitem(
     b'format',
     b'use-persistent-nodemap',
     default=_persistent_nodemap_default,
 )
 coreconfigitem(
     b'format',
     b'exp-use-copies-side-data-changeset',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'use-share-safe',
     default=True,
 )
 coreconfigitem(
     b'format',
     b'use-share-safe.automatic-upgrade-of-mismatching-repositories',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'format',
     b'use-share-safe.automatic-upgrade-of-mismatching-repositories:quiet',
     default=False,
     experimental=True,
 )
 
 # Moving this on by default means we are confident about the scaling of phases.
 # This is not garanteed to be the case at the time this message is written.
 coreconfigitem(
     b'format',
     b'use-internal-phase',
     default=False,
     experimental=True,
 )
 # The interaction between the archived phase and obsolescence markers needs to
 # be sorted out before wider usage of this are to be considered.
 #
 # At the time this message is written, behavior when archiving obsolete
 # changeset differ significantly from stripping. As part of stripping, we also
 # remove the obsolescence marker associated to the stripped changesets,
 # revealing the precedecessors changesets when applicable. When archiving, we
 # don't touch the obsolescence markers, keeping everything hidden. This can
 # result in quite confusing situation for people combining exchanging draft
 # with the archived phases. As some markers needed by others may be skipped
 # during exchange.
 coreconfigitem(
     b'format',
     b'exp-archived-phase',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'shelve',
     b'store',
     default=b'internal',
     experimental=True,
 )
 coreconfigitem(
     b'fsmonitor',
     b'warn_when_unused',
     default=True,
 )
 coreconfigitem(
     b'fsmonitor',
     b'warn_update_file_count',
     default=50000,
 )
 coreconfigitem(
     b'fsmonitor',
     b'warn_update_file_count_rust',
     default=400000,
 )
 coreconfigitem(
     b'help',
     br'hidden-command\..*',
     default=False,
     generic=True,
 )
 coreconfigitem(
     b'help',
     br'hidden-topic\..*',
     default=False,
     generic=True,
 )
 coreconfigitem(
     b'hooks',
     b'[^:]*',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem(
     b'hooks',
     b'.*:run-with-plain',
     default=True,
     generic=True,
 )
 coreconfigitem(
     b'hgweb-paths',
     b'.*',
     default=list,
     generic=True,
 )
 coreconfigitem(
     b'hostfingerprints',
     b'.*',
     default=list,
     generic=True,
 )
 coreconfigitem(
     b'hostsecurity',
     b'ciphers',
     default=None,
 )
 coreconfigitem(
     b'hostsecurity',
     b'minimumprotocol',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'hostsecurity',
     b'.*:minimumprotocol$',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem(
     b'hostsecurity',
     b'.*:ciphers$',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem(
     b'hostsecurity',
     b'.*:fingerprints$',
     default=list,
     generic=True,
 )
 coreconfigitem(
     b'hostsecurity',
     b'.*:verifycertsfile$',
     default=None,
     generic=True,
 )
 
 coreconfigitem(
     b'http_proxy',
     b'always',
     default=False,
 )
 coreconfigitem(
     b'http_proxy',
     b'host',
     default=None,
 )
 coreconfigitem(
     b'http_proxy',
     b'no',
     default=list,
 )
 coreconfigitem(
     b'http_proxy',
     b'passwd',
     default=None,
 )
 coreconfigitem(
     b'http_proxy',
     b'user',
     default=None,
 )
 
 coreconfigitem(
     b'http',
     b'timeout',
     default=None,
 )
 
 coreconfigitem(
     b'logtoprocess',
     b'commandexception',
     default=None,
 )
 coreconfigitem(
     b'logtoprocess',
     b'commandfinish',
     default=None,
 )
 coreconfigitem(
     b'logtoprocess',
     b'command',
     default=None,
 )
 coreconfigitem(
     b'logtoprocess',
     b'develwarn',
     default=None,
 )
 coreconfigitem(
     b'logtoprocess',
     b'uiblocked',
     default=None,
 )
 coreconfigitem(
     b'merge',
     b'checkunknown',
     default=b'abort',
 )
 coreconfigitem(
     b'merge',
     b'checkignored',
     default=b'abort',
 )
 coreconfigitem(
     b'experimental',
     b'merge.checkpathconflicts',
     default=False,
 )
 coreconfigitem(
     b'merge',
     b'followcopies',
     default=True,
 )
 coreconfigitem(
     b'merge',
     b'on-failure',
     default=b'continue',
 )
 coreconfigitem(
     b'merge',
     b'preferancestor',
     default=lambda: [b'*'],
     experimental=True,
 )
 coreconfigitem(
     b'merge',
     b'strict-capability-check',
     default=False,
 )
 coreconfigitem(
     b'merge',
     b'disable-partial-tools',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'partial-merge-tools',
     b'.*',
     default=None,
     generic=True,
     experimental=True,
 )
 coreconfigitem(
     b'partial-merge-tools',
     br'.*\.patterns',
     default=dynamicdefault,
     generic=True,
     priority=-1,
     experimental=True,
 )
 coreconfigitem(
     b'partial-merge-tools',
     br'.*\.executable$',
     default=dynamicdefault,
     generic=True,
     priority=-1,
     experimental=True,
 )
 coreconfigitem(
     b'partial-merge-tools',
     br'.*\.order',
     default=0,
     generic=True,
     priority=-1,
     experimental=True,
 )
 coreconfigitem(
     b'partial-merge-tools',
     br'.*\.args',
     default=b"$local $base $other",
     generic=True,
     priority=-1,
     experimental=True,
 )
 coreconfigitem(
     b'partial-merge-tools',
     br'.*\.disable',
     default=False,
     generic=True,
     priority=-1,
     experimental=True,
 )
 coreconfigitem(
     b'merge-tools',
     b'.*',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.args$',
     default=b"$local $base $other",
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.binary$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.check$',
     default=list,
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.checkchanged$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.executable$',
     default=dynamicdefault,
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.fixeol$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.gui$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.mergemarkers$',
     default=b'basic',
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.mergemarkertemplate$',
     default=dynamicdefault,  # take from command-templates.mergemarker
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.priority$',
     default=0,
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.premerge$',
     default=dynamicdefault,
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.regappend$',
     default=b"",
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'merge-tools',
     br'.*\.symlink$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem(
     b'pager',
     b'attend-.*',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem(
     b'pager',
     b'ignore',
     default=list,
 )
 coreconfigitem(
     b'pager',
     b'pager',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'patch',
     b'eol',
     default=b'strict',
 )
 coreconfigitem(
     b'patch',
     b'fuzz',
     default=2,
 )
 coreconfigitem(
     b'paths',
     b'default',
     default=None,
 )
 coreconfigitem(
     b'paths',
     b'default-push',
     default=None,
 )
 coreconfigitem(
     b'paths',
     b'.*',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'paths',
     b'.*:bookmarks.mode',
     default='default',
     generic=True,
 )
 coreconfigitem(
     b'paths',
     b'.*:multi-urls',
     default=False,
     generic=True,
 )
 coreconfigitem(
     b'paths',
     b'.*:pushrev',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'paths',
     b'.*:pushurl',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'phases',
     b'checksubrepos',
     default=b'follow',
 )
 coreconfigitem(
     b'phases',
     b'new-commit',
     default=b'draft',
 )
 coreconfigitem(
     b'phases',
     b'publish',
     default=True,
 )
 coreconfigitem(
     b'profiling',
     b'enabled',
     default=False,
 )
 coreconfigitem(
     b'profiling',
     b'format',
     default=b'text',
 )
 coreconfigitem(
     b'profiling',
     b'freq',
     default=1000,
 )
 coreconfigitem(
     b'profiling',
     b'limit',
     default=30,
 )
 coreconfigitem(
     b'profiling',
     b'nested',
     default=0,
 )
 coreconfigitem(
     b'profiling',
     b'output',
     default=None,
 )
 coreconfigitem(
     b'profiling',
     b'showmax',
     default=0.999,
 )
 coreconfigitem(
     b'profiling',
     b'showmin',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'profiling',
     b'showtime',
     default=True,
 )
 coreconfigitem(
     b'profiling',
     b'sort',
     default=b'inlinetime',
 )
 coreconfigitem(
     b'profiling',
     b'statformat',
     default=b'hotpath',
 )
 coreconfigitem(
     b'profiling',
     b'time-track',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'profiling',
     b'type',
     default=b'stat',
 )
 coreconfigitem(
     b'progress',
     b'assume-tty',
     default=False,
 )
 coreconfigitem(
     b'progress',
     b'changedelay',
     default=1,
 )
 coreconfigitem(
     b'progress',
     b'clear-complete',
     default=True,
 )
 coreconfigitem(
     b'progress',
     b'debug',
     default=False,
 )
 coreconfigitem(
     b'progress',
     b'delay',
     default=3,
 )
 coreconfigitem(
     b'progress',
     b'disable',
     default=False,
 )
 coreconfigitem(
     b'progress',
     b'estimateinterval',
     default=60.0,
 )
 coreconfigitem(
     b'progress',
     b'format',
     default=lambda: [b'topic', b'bar', b'number', b'estimate'],
 )
 coreconfigitem(
     b'progress',
     b'refresh',
     default=0.1,
 )
 coreconfigitem(
     b'progress',
     b'width',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'pull',
     b'confirm',
     default=False,
 )
 coreconfigitem(
     b'push',
     b'pushvars.server',
     default=False,
 )
 coreconfigitem(
     b'rewrite',
     b'backup-bundle',
     default=True,
     alias=[(b'ui', b'history-editing-backup')],
 )
 coreconfigitem(
     b'rewrite',
     b'update-timestamp',
     default=False,
 )
 coreconfigitem(
     b'rewrite',
     b'empty-successor',
     default=b'skip',
     experimental=True,
 )
 # experimental as long as format.use-dirstate-v2 is.
 coreconfigitem(
     b'storage',
     b'dirstate-v2.slow-path',
     default=b"abort",
     experimental=True,
 )
 coreconfigitem(
     b'storage',
     b'new-repo-backend',
     default=b'revlogv1',
     experimental=True,
 )
 coreconfigitem(
     b'storage',
     b'revlog.optimize-delta-parent-choice',
     default=True,
     alias=[(b'format', b'aggressivemergedeltas')],
 )
 coreconfigitem(
     b'storage',
+    b'revlog.delta-parent-search.candidate-group-chunk-size',
+    default=0,
+)
+coreconfigitem(
+    b'storage',
     b'revlog.issue6528.fix-incoming',
     default=True,
 )
 # experimental as long as rust is experimental (or a C version is implemented)
 coreconfigitem(
     b'storage',
     b'revlog.persistent-nodemap.mmap',
     default=True,
 )
 # experimental as long as format.use-persistent-nodemap is.
 coreconfigitem(
     b'storage',
     b'revlog.persistent-nodemap.slow-path',
     default=b"abort",
 )
 
 coreconfigitem(
     b'storage',
     b'revlog.reuse-external-delta',
     default=True,
 )
 coreconfigitem(
     b'storage',
     b'revlog.reuse-external-delta-parent',
     default=None,
 )
 coreconfigitem(
     b'storage',
     b'revlog.zlib.level',
     default=None,
 )
 coreconfigitem(
     b'storage',
     b'revlog.zstd.level',
     default=None,
 )
 coreconfigitem(
     b'server',
     b'bookmarks-pushkey-compat',
     default=True,
 )
 coreconfigitem(
     b'server',
     b'bundle1',
     default=True,
 )
 coreconfigitem(
     b'server',
     b'bundle1gd',
     default=None,
 )
 coreconfigitem(
     b'server',
     b'bundle1.pull',
     default=None,
 )
 coreconfigitem(
     b'server',
     b'bundle1gd.pull',
     default=None,
 )
 coreconfigitem(
     b'server',
     b'bundle1.push',
     default=None,
 )
 coreconfigitem(
     b'server',
     b'bundle1gd.push',
     default=None,
 )
 coreconfigitem(
     b'server',
     b'bundle2.stream',
     default=True,
     alias=[(b'experimental', b'bundle2.stream')],
 )
 coreconfigitem(
     b'server',
     b'compressionengines',
     default=list,
 )
 coreconfigitem(
     b'server',
     b'concurrent-push-mode',
     default=b'check-related',
 )
 coreconfigitem(
     b'server',
     b'disablefullbundle',
     default=False,
 )
 coreconfigitem(
     b'server',
     b'maxhttpheaderlen',
     default=1024,
 )
 coreconfigitem(
     b'server',
     b'pullbundle',
     default=True,
 )
 coreconfigitem(
     b'server',
     b'preferuncompressed',
     default=False,
 )
 coreconfigitem(
     b'server',
     b'streamunbundle',
     default=False,
 )
 coreconfigitem(
     b'server',
     b'uncompressed',
     default=True,
 )
 coreconfigitem(
     b'server',
     b'uncompressedallowsecret',
     default=False,
 )
 coreconfigitem(
     b'server',
     b'view',
     default=b'served',
 )
 coreconfigitem(
     b'server',
     b'validate',
     default=False,
 )
 coreconfigitem(
     b'server',
     b'zliblevel',
     default=-1,
 )
 coreconfigitem(
     b'server',
     b'zstdlevel',
     default=3,
 )
 coreconfigitem(
     b'share',
     b'pool',
     default=None,
 )
 coreconfigitem(
     b'share',
     b'poolnaming',
     default=b'identity',
 )
 coreconfigitem(
     b'share',
     b'safe-mismatch.source-not-safe',
     default=b'abort',
 )
 coreconfigitem(
     b'share',
     b'safe-mismatch.source-safe',
     default=b'abort',
 )
 coreconfigitem(
     b'share',
     b'safe-mismatch.source-not-safe.warn',
     default=True,
 )
 coreconfigitem(
     b'share',
     b'safe-mismatch.source-safe.warn',
     default=True,
 )
 coreconfigitem(
     b'share',
     b'safe-mismatch.source-not-safe:verbose-upgrade',
     default=True,
 )
 coreconfigitem(
     b'share',
     b'safe-mismatch.source-safe:verbose-upgrade',
     default=True,
 )
 coreconfigitem(
     b'shelve',
     b'maxbackups',
     default=10,
 )
 coreconfigitem(
     b'smtp',
     b'host',
     default=None,
 )
 coreconfigitem(
     b'smtp',
     b'local_hostname',
     default=None,
 )
 coreconfigitem(
     b'smtp',
     b'password',
     default=None,
 )
 coreconfigitem(
     b'smtp',
     b'port',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'smtp',
     b'tls',
     default=b'none',
 )
 coreconfigitem(
     b'smtp',
     b'username',
     default=None,
 )
 coreconfigitem(
     b'sparse',
     b'missingwarning',
     default=True,
     experimental=True,
 )
 coreconfigitem(
     b'subrepos',
     b'allowed',
     default=dynamicdefault,  # to make backporting simpler
 )
 coreconfigitem(
     b'subrepos',
     b'hg:allowed',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'subrepos',
     b'git:allowed',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'subrepos',
     b'svn:allowed',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'templates',
     b'.*',
     default=None,
     generic=True,
 )
 coreconfigitem(
     b'templateconfig',
     b'.*',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem(
     b'trusted',
     b'groups',
     default=list,
 )
 coreconfigitem(
     b'trusted',
     b'users',
     default=list,
 )
 coreconfigitem(
     b'ui',
     b'_usedassubrepo',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'allowemptycommit',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'archivemeta',
     default=True,
 )
 coreconfigitem(
     b'ui',
     b'askusername',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'available-memory',
     default=None,
 )
 
 coreconfigitem(
     b'ui',
     b'clonebundlefallback',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'clonebundleprefers',
     default=list,
 )
 coreconfigitem(
     b'ui',
     b'clonebundles',
     default=True,
 )
 coreconfigitem(
     b'ui',
     b'color',
     default=b'auto',
 )
 coreconfigitem(
     b'ui',
     b'commitsubrepos',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'debug',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'debugger',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'editor',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'ui',
     b'detailed-exit-code',
     default=False,
     experimental=True,
 )
 coreconfigitem(
     b'ui',
     b'fallbackencoding',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'forcecwd',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'forcemerge',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'formatdebug',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'formatjson',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'formatted',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'interactive',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'interface',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'interface.chunkselector',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'large-file-limit',
     default=10 * (2 ** 20),
 )
 coreconfigitem(
     b'ui',
     b'logblockedtimes',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'merge',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'mergemarkers',
     default=b'basic',
 )
 coreconfigitem(
     b'ui',
     b'message-output',
     default=b'stdio',
 )
 coreconfigitem(
     b'ui',
     b'nontty',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'origbackuppath',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'paginate',
     default=True,
 )
 coreconfigitem(
     b'ui',
     b'patch',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'portablefilenames',
     default=b'warn',
 )
 coreconfigitem(
     b'ui',
     b'promptecho',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'quiet',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'quietbookmarkmove',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'relative-paths',
     default=b'legacy',
 )
 coreconfigitem(
     b'ui',
     b'remotecmd',
     default=b'hg',
 )
 coreconfigitem(
     b'ui',
     b'report_untrusted',
     default=True,
 )
 coreconfigitem(
     b'ui',
     b'rollback',
     default=True,
 )
 coreconfigitem(
     b'ui',
     b'signal-safe-lock',
     default=True,
 )
 coreconfigitem(
     b'ui',
     b'slash',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'ssh',
     default=b'ssh',
 )
 coreconfigitem(
     b'ui',
     b'ssherrorhint',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'statuscopies',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'strict',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'style',
     default=b'',
 )
 coreconfigitem(
     b'ui',
     b'supportcontact',
     default=None,
 )
 coreconfigitem(
     b'ui',
     b'textwidth',
     default=78,
 )
 coreconfigitem(
     b'ui',
     b'timeout',
     default=b'600',
 )
 coreconfigitem(
     b'ui',
     b'timeout.warn',
     default=0,
 )
 coreconfigitem(
     b'ui',
     b'timestamp-output',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'traceback',
     default=False,
 )
 coreconfigitem(
     b'ui',
     b'tweakdefaults',
     default=False,
 )
 coreconfigitem(b'ui', b'username', alias=[(b'ui', b'user')])
 coreconfigitem(
     b'ui',
     b'verbose',
     default=False,
 )
 coreconfigitem(
     b'verify',
     b'skipflags',
     default=0,
 )
 coreconfigitem(
     b'web',
     b'allowbz2',
     default=False,
 )
 coreconfigitem(
     b'web',
     b'allowgz',
     default=False,
 )
 coreconfigitem(
     b'web',
     b'allow-pull',
     alias=[(b'web', b'allowpull')],
     default=True,
 )
 coreconfigitem(
     b'web',
     b'allow-push',
     alias=[(b'web', b'allow_push')],
     default=list,
 )
 coreconfigitem(
     b'web',
     b'allowzip',
     default=False,
 )
 coreconfigitem(
     b'web',
     b'archivesubrepos',
     default=False,
 )
 coreconfigitem(
     b'web',
     b'cache',
     default=True,
 )
 coreconfigitem(
     b'web',
     b'comparisoncontext',
     default=5,
 )
 coreconfigitem(
     b'web',
     b'contact',
     default=None,
 )
 coreconfigitem(
     b'web',
     b'deny_push',
     default=list,
 )
 coreconfigitem(
     b'web',
     b'guessmime',
     default=False,
 )
 coreconfigitem(
     b'web',
     b'hidden',
     default=False,
 )
 coreconfigitem(
     b'web',
     b'labels',
     default=list,
 )
 coreconfigitem(
     b'web',
     b'logoimg',
     default=b'hglogo.png',
 )
 coreconfigitem(
     b'web',
     b'logourl',
     default=b'https://mercurial-scm.org/',
 )
 coreconfigitem(
     b'web',
     b'accesslog',
     default=b'-',
 )
 coreconfigitem(
     b'web',
     b'address',
     default=b'',
 )
 coreconfigitem(
     b'web',
     b'allow-archive',
     alias=[(b'web', b'allow_archive')],
     default=list,
 )
 coreconfigitem(
     b'web',
     b'allow_read',
     default=list,
 )
 coreconfigitem(
     b'web',
     b'baseurl',
     default=None,
 )
 coreconfigitem(
     b'web',
     b'cacerts',
     default=None,
 )
 coreconfigitem(
     b'web',
     b'certificate',
     default=None,
 )
 coreconfigitem(
     b'web',
     b'collapse',
     default=False,
 )
 coreconfigitem(
     b'web',
     b'csp',
     default=None,
 )
 coreconfigitem(
     b'web',
     b'deny_read',
     default=list,
 )
 coreconfigitem(
     b'web',
     b'descend',
     default=True,
 )
 coreconfigitem(
     b'web',
     b'description',
     default=b"",
 )
 coreconfigitem(
     b'web',
     b'encoding',
     default=lambda: encoding.encoding,
 )
 coreconfigitem(
     b'web',
     b'errorlog',
     default=b'-',
 )
 coreconfigitem(
     b'web',
     b'ipv6',
     default=False,
 )
 coreconfigitem(
     b'web',
     b'maxchanges',
     default=10,
 )
 coreconfigitem(
     b'web',
     b'maxfiles',
     default=10,
 )
 coreconfigitem(
     b'web',
     b'maxshortchanges',
     default=60,
 )
 coreconfigitem(
     b'web',
     b'motd',
     default=b'',
 )
 coreconfigitem(
     b'web',
     b'name',
     default=dynamicdefault,
 )
 coreconfigitem(
     b'web',
     b'port',
     default=8000,
 )
 coreconfigitem(
     b'web',
     b'prefix',
     default=b'',
 )
 coreconfigitem(
     b'web',
     b'push_ssl',
     default=True,
 )
 coreconfigitem(
     b'web',
     b'refreshinterval',
     default=20,
 )
 coreconfigitem(
     b'web',
     b'server-header',
     default=None,
 )
 coreconfigitem(
     b'web',
     b'static',
     default=None,
 )
 coreconfigitem(
     b'web',
     b'staticurl',
     default=None,
 )
 coreconfigitem(
     b'web',
     b'stripes',
     default=1,
 )
 coreconfigitem(
     b'web',
     b'style',
     default=b'paper',
 )
 coreconfigitem(
     b'web',
     b'templates',
     default=None,
 )
 coreconfigitem(
     b'web',
     b'view',
     default=b'served',
     experimental=True,
 )
 coreconfigitem(
     b'worker',
     b'backgroundclose',
     default=dynamicdefault,
 )
 # Windows defaults to a limit of 512 open files. A buffer of 128
 # should give us enough headway.
 coreconfigitem(
     b'worker',
     b'backgroundclosemaxqueue',
     default=384,
 )
 coreconfigitem(
     b'worker',
     b'backgroundcloseminfilecount',
     default=2048,
 )
 coreconfigitem(
     b'worker',
     b'backgroundclosethreadcount',
     default=4,
 )
 coreconfigitem(
     b'worker',
     b'enabled',
     default=True,
 )
 coreconfigitem(
     b'worker',
     b'numcpus',
     default=None,
 )
 
 # Rebase related configuration moved to core because other extension are doing
 # strange things. For example, shelve import the extensions to reuse some bit
 # without formally loading it.
 coreconfigitem(
     b'commands',
     b'rebase.requiredest',
     default=False,
 )
 coreconfigitem(
     b'experimental',
     b'rebaseskipobsolete',
     default=True,
 )
 coreconfigitem(
     b'rebase',
     b'singletransaction',
     default=False,
 )
 coreconfigitem(
     b'rebase',
     b'experimental.inmemory',
     default=False,
 )
 
 # This setting controls creation of a rebase_source extra field
 # during rebase. When False, no such field is created. This is
 # useful eg for incrementally converting changesets and then
 # rebasing them onto an existing repo.
 # WARNING: this is an advanced setting reserved for people who know
 # exactly what they are doing. Misuse of this setting can easily
 # result in obsmarker cycles and a vivid headache.
 coreconfigitem(
     b'rebase',
     b'store-source',
     default=True,
     experimental=True,
 )

mercurial/helptext/config.txt

@@ -1,3332 +1,3347 b''
 The Mercurial system uses a set of configuration files to control
 aspects of its behavior.
 
 Troubleshooting
 ===============
 
 If you're having problems with your configuration,
 :hg:`config --source` can help you understand what is introducing
 a setting into your environment.
 
 See :hg:`help config.syntax` and :hg:`help config.files`
 for information about how and where to override things.
 
 Structure
 =========
 
 The configuration files use a simple ini-file format. A configuration
 file consists of sections, led by a ``[section]`` header and followed
 by ``name = value`` entries::
 
   [ui]
   username = Firstname Lastname <[e-mail]>
   verbose = True
 
 The above entries will be referred to as ``ui.username`` and
 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
 
 Files
 =====
 
 Mercurial reads configuration data from several files, if they exist.
 These files do not exist by default and you will have to create the
 appropriate configuration files yourself:
 
 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
 
 Global configuration like the username setting is typically put into:
 
 .. container:: windows
 
   - ``%USERPROFILE%\mercurial.ini`` (on Windows)
 
 .. container:: unix.plan9
 
   - ``$HOME/.hgrc`` (on Unix, Plan9)
 
 The names of these files depend on the system on which Mercurial is
 installed. ``*.rc`` files from a single directory are read in
 alphabetical order, later ones overriding earlier ones. Where multiple
 paths are given below, settings from earlier paths override later
 ones.
 
 .. container:: verbose.unix
 
   On Unix, the following files are consulted:
 
   - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
   - ``<repo>/.hg/hgrc`` (per-repository)
   - ``$HOME/.hgrc`` (per-user)
   - ``${XDG_CONFIG_HOME:-$HOME/.config}/hg/hgrc`` (per-user)
   - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
   - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
   - ``/etc/mercurial/hgrc`` (per-system)
   - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
   - ``<internal>/*.rc`` (defaults)
 
 .. container:: verbose.windows
 
   On Windows, the following files are consulted:
 
   - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
   - ``<repo>/.hg/hgrc`` (per-repository)
   - ``%USERPROFILE%\.hgrc`` (per-user)
   - ``%USERPROFILE%\Mercurial.ini`` (per-user)
   - ``%HOME%\.hgrc`` (per-user)
   - ``%HOME%\Mercurial.ini`` (per-user)
   - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-system)
   - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
   - ``<install-dir>\Mercurial.ini`` (per-installation)
   - ``%PROGRAMDATA%\Mercurial\hgrc`` (per-system)
   - ``%PROGRAMDATA%\Mercurial\Mercurial.ini`` (per-system)
   - ``%PROGRAMDATA%\Mercurial\hgrc.d\*.rc`` (per-system)
   - ``<internal>/*.rc`` (defaults)
 
   .. note::
 
    The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
    is used when running 32-bit Python on 64-bit Windows.
 
 .. container:: verbose.plan9
 
   On Plan9, the following files are consulted:
 
   - ``<repo>/.hg/hgrc-not-shared`` (per-repository)
   - ``<repo>/.hg/hgrc`` (per-repository)
   - ``$home/lib/hgrc`` (per-user)
   - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
   - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
   - ``/lib/mercurial/hgrc`` (per-system)
   - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
   - ``<internal>/*.rc`` (defaults)
 
 Per-repository configuration options only apply in a
 particular repository. This file is not version-controlled, and
 will not get transferred during a "clone" operation. Options in
 this file override options in all other configuration files.
 
 .. container:: unix.plan9
 
   On Plan 9 and Unix, most of this file will be ignored if it doesn't
   belong to a trusted user or to a trusted group. See
   :hg:`help config.trusted` for more details.
 
 Per-user configuration file(s) are for the user running Mercurial.  Options
 in these files apply to all Mercurial commands executed by this user in any
 directory. Options in these files override per-system and per-installation
 options.
 
 Per-installation configuration files are searched for in the
 directory where Mercurial is installed. ``<install-root>`` is the
 parent directory of the **hg** executable (or symlink) being run.
 
 .. container:: unix.plan9
 
   For example, if installed in ``/shared/tools/bin/hg``, Mercurial
   will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
   files apply to all Mercurial commands executed by any user in any
   directory.
 
 Per-installation configuration files are for the system on
 which Mercurial is running. Options in these files apply to all
 Mercurial commands executed by any user in any directory. Registry
 keys contain PATH-like strings, every part of which must reference
 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
 be read.  Mercurial checks each of these locations in the specified
 order until one or more configuration files are detected.
 
 Per-system configuration files are for the system on which Mercurial
 is running. Options in these files apply to all Mercurial commands
 executed by any user in any directory. Options in these files
 override per-installation options.
 
 Mercurial comes with some default configuration. The default configuration
 files are installed with Mercurial and will be overwritten on upgrades. Default
 configuration files should never be edited by users or administrators but can
 be overridden in other configuration files. So far the directory only contains
 merge tool configuration but packagers can also put other default configuration
 there.
 
 On versions 5.7 and later, if share-safe functionality is enabled,
 shares will read config file of share source too.
 `<share-source/.hg/hgrc>` is read before reading `<repo/.hg/hgrc>`.
 
 For configs which should not be shared, `<repo/.hg/hgrc-not-shared>`
 should be used.
 
 Syntax
 ======
 
 A configuration file consists of sections, led by a ``[section]`` header
 and followed by ``name = value`` entries (sometimes called
 ``configuration keys``)::
 
     [spam]
     eggs=ham
     green=
        eggs
 
 Each line contains one entry. If the lines that follow are indented,
 they are treated as continuations of that entry. Leading whitespace is
 removed from values. Empty lines are skipped. Lines beginning with
 ``#`` or ``;`` are ignored and may be used to provide comments.
 
 Configuration keys can be set multiple times, in which case Mercurial
 will use the value that was configured last. As an example::
 
     [spam]
     eggs=large
     ham=serrano
     eggs=small
 
 This would set the configuration key named ``eggs`` to ``small``.
 
 It is also possible to define a section multiple times. A section can
 be redefined on the same and/or on different configuration files. For
 example::
 
     [foo]
     eggs=large
     ham=serrano
     eggs=small
 
     [bar]
     eggs=ham
     green=
        eggs
 
     [foo]
     ham=prosciutto
     eggs=medium
     bread=toasted
 
 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
 respectively. As you can see there only thing that matters is the last
 value that was set for each of the configuration keys.
 
 If a configuration key is set multiple times in different
 configuration files the final value will depend on the order in which
 the different configuration files are read, with settings from earlier
 paths overriding later ones as described on the ``Files`` section
 above.
 
 A line of the form ``%include file`` will include ``file`` into the
 current configuration file. The inclusion is recursive, which means
 that included files can include other files. Filenames are relative to
 the configuration file in which the ``%include`` directive is found.
 Environment variables and ``~user`` constructs are expanded in
 ``file``. This lets you do something like::
 
   %include ~/.hgrc.d/$HOST.rc
 
 to include a different configuration file on each computer you use.
 
 A line with ``%unset name`` will remove ``name`` from the current
 section, if it has been set previously.
 
 The values are either free-form text strings, lists of text strings,
 or Boolean values. Boolean values can be set to true using any of "1",
 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
 (all case insensitive).
 
 List values are separated by whitespace or comma, except when values are
 placed in double quotation marks::
 
   allow_read = "John Doe, PhD", brian, betty
 
 Quotation marks can be escaped by prefixing them with a backslash. Only
 quotation marks at the beginning of a word is counted as a quotation
 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
 
 Sections
 ========
 
 This section describes the different sections that may appear in a
 Mercurial configuration file, the purpose of each section, its possible
 keys, and their possible values.
 
 ``alias``
 ---------
 
 Defines command aliases.
 
 Aliases allow you to define your own commands in terms of other
 commands (or aliases), optionally including arguments. Positional
 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
 are expanded by Mercurial before execution. Positional arguments not
 already used by ``$N`` in the definition are put at the end of the
 command to be executed.
 
 Alias definitions consist of lines of the form::
 
     <alias> = <command> [<argument>]...
 
 For example, this definition::
 
     latest = log --limit 5
 
 creates a new command ``latest`` that shows only the five most recent
 changesets. You can define subsequent aliases using earlier ones::
 
     stable5 = latest -b stable
 
 .. note::
 
    It is possible to create aliases with the same names as
    existing commands, which will then override the original
    definitions. This is almost always a bad idea!
 
 An alias can start with an exclamation point (``!``) to make it a
 shell alias. A shell alias is executed with the shell and will let you
 run arbitrary commands. As an example, ::
 
    echo = !echo $@
 
 will let you do ``hg echo foo`` to have ``foo`` printed in your
 terminal. A better example might be::
 
    purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm -f
 
 which will make ``hg purge`` delete all unknown files in the
 repository in the same manner as the purge extension.
 
 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
 expand to the command arguments. Unmatched arguments are
 removed. ``$0`` expands to the alias name and ``$@`` expands to all
 arguments separated by a space. ``"$@"`` (with quotes) expands to all
 arguments quoted individually and separated by a space. These expansions
 happen before the command is passed to the shell.
 
 Shell aliases are executed in an environment where ``$HG`` expands to
 the path of the Mercurial that was used to execute the alias. This is
 useful when you want to call further Mercurial commands in a shell
 alias, as was done above for the purge alias. In addition,
 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
 
 .. note::
 
    Some global configuration options such as ``-R`` are
    processed before shell aliases and will thus not be passed to
    aliases.
 
 
 ``annotate``
 ------------
 
 Settings used when displaying file annotations. All values are
 Booleans and default to False. See :hg:`help config.diff` for
 related options for the diff command.
 
 ``ignorews``
     Ignore white space when comparing lines.
 
 ``ignorewseol``
     Ignore white space at the end of a line when comparing lines.
 
 ``ignorewsamount``
     Ignore changes in the amount of white space.
 
 ``ignoreblanklines``
     Ignore changes whose lines are all blank.
 
 
 ``auth``
 --------
 
 Authentication credentials and other authentication-like configuration
 for HTTP connections. This section allows you to store usernames and
 passwords for use when logging *into* HTTP servers. See
 :hg:`help config.web` if you want to configure *who* can login to
 your HTTP server.
 
 The following options apply to all hosts.
 
 ``cookiefile``
     Path to a file containing HTTP cookie lines. Cookies matching a
     host will be sent automatically.
 
     The file format uses the Mozilla cookies.txt format, which defines cookies
     on their own lines. Each line contains 7 fields delimited by the tab
     character (domain, is_domain_cookie, path, is_secure, expires, name,
     value). For more info, do an Internet search for "Netscape cookies.txt
     format."
 
     Note: the cookies parser does not handle port numbers on domains. You
     will need to remove ports from the domain for the cookie to be recognized.
     This could result in a cookie being disclosed to an unwanted server.
 
     The cookies file is read-only.
 
 Other options in this section are grouped by name and have the following
 format::
 
     <name>.<argument> = <value>
 
 where ``<name>`` is used to group arguments into authentication
 entries. Example::
 
     foo.prefix = hg.intevation.de/mercurial
     foo.username = foo
     foo.password = bar
     foo.schemes = http https
 
     bar.prefix = secure.example.org
     bar.key = path/to/file.key
     bar.cert = path/to/file.cert
     bar.schemes = https
 
 Supported arguments:
 
 ``prefix``
     Either ``*`` or a URI prefix with or without the scheme part.
     The authentication entry with the longest matching prefix is used
     (where ``*`` matches everything and counts as a match of length
     1). If the prefix doesn't include a scheme, the match is performed
     against the URI with its scheme stripped as well, and the schemes
     argument, q.v., is then subsequently consulted.
 
 ``username``
     Optional. Username to authenticate with. If not given, and the
     remote site requires basic or digest authentication, the user will
     be prompted for it. Environment variables are expanded in the
     username letting you do ``foo.username = $USER``. If the URI
     includes a username, only ``[auth]`` entries with a matching
     username or without a username will be considered.
 
 ``password``
     Optional. Password to authenticate with. If not given, and the
     remote site requires basic or digest authentication, the user
     will be prompted for it.
 
 ``key``
     Optional. PEM encoded client certificate key file. Environment
     variables are expanded in the filename.
 
 ``cert``
     Optional. PEM encoded client certificate chain file. Environment
     variables are expanded in the filename.
 
 ``schemes``
     Optional. Space separated list of URI schemes to use this
     authentication entry with. Only used if the prefix doesn't include
     a scheme. Supported schemes are http and https. They will match
     static-http and static-https respectively, as well.
     (default: https)
 
 If no suitable authentication entry is found, the user is prompted
 for credentials as usual if required by the remote.
 
 ``cmdserver``
 -------------
 
 Controls command server settings. (ADVANCED)
 
 ``message-encodings``
     List of encodings for the ``m`` (message) channel. The first encoding
     supported by the server will be selected and advertised in the hello
     message. This is useful only when ``ui.message-output`` is set to
     ``channel``. Supported encodings are ``cbor``.
 
 ``shutdown-on-interrupt``
     If set to false, the server's main loop will continue running after
     SIGINT received. ``runcommand`` requests can still be interrupted by
     SIGINT. Close the write end of the pipe to shut down the server
     process gracefully.
     (default: True)
 
 ``color``
 ---------
 
 Configure the Mercurial color mode. For details about how to define your custom
 effect and style see :hg:`help color`.
 
 ``mode``
     String: control the method used to output color. One of ``auto``, ``ansi``,
     ``win32``, ``terminfo`` or ``debug``. In auto mode, Mercurial will
     use ANSI mode by default (or win32 mode prior to Windows 10) if it detects a
     terminal. Any invalid value will disable color.
 
 ``pagermode``
     String: optional override of ``color.mode`` used with pager.
 
     On some systems, terminfo mode may cause problems when using
     color with ``less -R`` as a pager program. less with the -R option
     will only display ECMA-48 color codes, and terminfo mode may sometimes
     emit codes that less doesn't understand. You can work around this by
     either using ansi mode (or auto mode), or by using less -r (which will
     pass through all terminal control codes, not just color control
     codes).
 
     On some systems (such as MSYS in Windows), the terminal may support
     a different color mode than the pager program.
 
 ``commands``
 ------------
 
 ``commit.post-status``
     Show status of files in the working directory after successful commit.
     (default: False)
 
 ``merge.require-rev``
     Require that the revision to merge the current commit with be specified on
     the command line. If this is enabled and a revision is not specified, the
     command aborts.
     (default: False)
 
 ``push.require-revs``
     Require revisions to push be specified using one or more mechanisms such as
     specifying them positionally on the command line, using ``-r``, ``-b``,
     and/or ``-B`` on the command line, or using ``paths.<path>:pushrev`` in the
     configuration. If this is enabled and revisions are not specified, the
     command aborts.
     (default: False)
 
 ``resolve.confirm``
     Confirm before performing action if no filename is passed.
     (default: False)
 
 ``resolve.explicit-re-merge``
     Require uses of ``hg resolve`` to specify which action it should perform,
     instead of re-merging files by default.
     (default: False)
 
 ``resolve.mark-check``
     Determines what level of checking :hg:`resolve --mark` will perform before
     marking files as resolved. Valid values are ``none`, ``warn``, and
     ``abort``. ``warn`` will output a warning listing the file(s) that still
     have conflict markers in them, but will still mark everything resolved.
     ``abort`` will output the same warning but will not mark things as resolved.
     If --all is passed and this is set to ``abort``, only a warning will be
     shown (an error will not be raised).
     (default: ``none``)
 
 ``status.relative``
     Make paths in :hg:`status` output relative to the current directory.
     (default: False)
 
 ``status.terse``
     Default value for the --terse flag, which condenses status output.
     (default: empty)
 
 ``update.check``
     Determines what level of checking :hg:`update` will perform before moving
     to a destination revision. Valid values are ``abort``, ``none``,
     ``linear``, and ``noconflict``.
 
     - ``abort`` always fails if the working directory has uncommitted changes.
 
     - ``none`` performs no checking, and may result in a merge with uncommitted changes.
 
     - ``linear`` allows any update as long as it follows a straight line in the
       revision history, and may trigger a merge with uncommitted changes.
 
     - ``noconflict`` will allow any update which would not trigger a merge with
       uncommitted changes, if any are present.
 
     (default: ``linear``)
 
 ``update.requiredest``
     Require that the user pass a destination when running :hg:`update`.
     For example, :hg:`update .::` will be allowed, but a plain :hg:`update`
     will be disallowed.
     (default: False)
 
 ``committemplate``
 ------------------
 
 ``changeset``
     String: configuration in this section is used as the template to
     customize the text shown in the editor when committing.
 
 In addition to pre-defined template keywords, commit log specific one
 below can be used for customization:
 
 ``extramsg``
     String: Extra message (typically 'Leave message empty to abort
     commit.'). This may be changed by some commands or extensions.
 
 For example, the template configuration below shows as same text as
 one shown by default::
 
     [committemplate]
     changeset = {desc}\n\n
         HG: Enter commit message.  Lines beginning with 'HG:' are removed.
         HG: {extramsg}
         HG: --
         HG: user: {author}\n{ifeq(p2rev, "-1", "",
        "HG: branch merge\n")
        }HG: branch '{branch}'\n{if(activebookmark,
        "HG: bookmark '{activebookmark}'\n")   }{subrepos %
        "HG: subrepo {subrepo}\n"              }{file_adds %
        "HG: added {file}\n"                   }{file_mods %
        "HG: changed {file}\n"                 }{file_dels %
        "HG: removed {file}\n"                 }{if(files, "",
        "HG: no files changed\n")}
 
 ``diff()``
     String: show the diff (see :hg:`help templates` for detail)
 
 Sometimes it is helpful to show the diff of the changeset in the editor without
 having to prefix 'HG: ' to each line so that highlighting works correctly. For
 this, Mercurial provides a special string which will ignore everything below
 it::
 
      HG: ------------------------ >8 ------------------------
 
 For example, the template configuration below will show the diff below the
 extra message::
 
     [committemplate]
     changeset = {desc}\n\n
         HG: Enter commit message.  Lines beginning with 'HG:' are removed.
         HG: {extramsg}
         HG: ------------------------ >8 ------------------------
         HG: Do not touch the line above.
         HG: Everything below will be removed.
         {diff()}
 
 .. note::
 
    For some problematic encodings (see :hg:`help win32mbcs` for
    detail), this customization should be configured carefully, to
    avoid showing broken characters.
 
    For example, if a multibyte character ending with backslash (0x5c) is
    followed by the ASCII character 'n' in the customized template,
    the sequence of backslash and 'n' is treated as line-feed unexpectedly
    (and the multibyte character is broken, too).
 
 Customized template is used for commands below (``--edit`` may be
 required):
 
 - :hg:`backout`
 - :hg:`commit`
 - :hg:`fetch` (for merge commit only)
 - :hg:`graft`
 - :hg:`histedit`
 - :hg:`import`
 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
 - :hg:`rebase`
 - :hg:`shelve`
 - :hg:`sign`
 - :hg:`tag`
 - :hg:`transplant`
 
 Configuring items below instead of ``changeset`` allows showing
 customized message only for specific actions, or showing different
 messages for each action.
 
 - ``changeset.backout`` for :hg:`backout`
 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
 - ``changeset.gpg.sign`` for :hg:`sign`
 - ``changeset.graft`` for :hg:`graft`
 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
 - ``changeset.import.bypass`` for :hg:`import --bypass`
 - ``changeset.import.normal.merge`` for :hg:`import` on merges
 - ``changeset.import.normal.normal`` for :hg:`import` on other
 - ``changeset.mq.qnew`` for :hg:`qnew`
 - ``changeset.mq.qfold`` for :hg:`qfold`
 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
 - ``changeset.rebase.normal`` for :hg:`rebase` on other
 - ``changeset.shelve.shelve`` for :hg:`shelve`
 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
 - ``changeset.tag.remove`` for :hg:`tag --remove`
 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
 - ``changeset.transplant.normal`` for :hg:`transplant` on other
 
 These dot-separated lists of names are treated as hierarchical ones.
 For example, ``changeset.tag.remove`` customizes the commit message
 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
 commit message for :hg:`tag` regardless of ``--remove`` option.
 
 When the external editor is invoked for a commit, the corresponding
 dot-separated list of names without the ``changeset.`` prefix
 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
 variable.
 
 In this section, items other than ``changeset`` can be referred from
 others. For example, the configuration to list committed files up
 below can be referred as ``{listupfiles}``::
 
     [committemplate]
     listupfiles = {file_adds %
        "HG: added {file}\n"     }{file_mods %
        "HG: changed {file}\n"   }{file_dels %
        "HG: removed {file}\n"   }{if(files, "",
        "HG: no files changed\n")}
 
 ``decode/encode``
 -----------------
 
 Filters for transforming files on checkout/checkin. This would
 typically be used for newline processing or other
 localization/canonicalization of files.
 
 Filters consist of a filter pattern followed by a filter command.
 Filter patterns are globs by default, rooted at the repository root.
 For example, to match any file ending in ``.txt`` in the root
 directory only, use the pattern ``*.txt``. To match any file ending
 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
 For each file only the first matching filter applies.
 
 The filter command can start with a specifier, either ``pipe:`` or
 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
 
 A ``pipe:`` command must accept data on stdin and return the transformed
 data on stdout.
 
 Pipe example::
 
   [encode]
   # uncompress gzip files on checkin to improve delta compression
   # note: not necessarily a good idea, just an example
   *.gz = pipe: gunzip
 
   [decode]
   # recompress gzip files when writing them to the working dir (we
   # can safely omit "pipe:", because it's the default)
   *.gz = gzip
 
 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
 with the name of a temporary file that contains the data to be
 filtered by the command. The string ``OUTFILE`` is replaced with the name
 of an empty temporary file, where the filtered data must be written by
 the command.
 
 .. container:: windows
 
    .. note::
 
      The tempfile mechanism is recommended for Windows systems,
      where the standard shell I/O redirection operators often have
      strange effects and may corrupt the contents of your files.
 
 This filter mechanism is used internally by the ``eol`` extension to
 translate line ending characters between Windows (CRLF) and Unix (LF)
 format. We suggest you use the ``eol`` extension for convenience.
 
 
 ``defaults``
 ------------
 
 (defaults are deprecated. Don't use them. Use aliases instead.)
 
 Use the ``[defaults]`` section to define command defaults, i.e. the
 default options/arguments to pass to the specified commands.
 
 The following example makes :hg:`log` run in verbose mode, and
 :hg:`status` show only the modified files, by default::
 
   [defaults]
   log = -v
   status = -m
 
 The actual commands, instead of their aliases, must be used when
 defining command defaults. The command defaults will also be applied
 to the aliases of the commands defined.
 
 
 ``diff``
 --------
 
 Settings used when displaying diffs. Everything except for ``unified``
 is a Boolean and defaults to False. See :hg:`help config.annotate`
 for related options for the annotate command.
 
 ``git``
     Use git extended diff format.
 
 ``nobinary``
     Omit git binary patches.
 
 ``nodates``
     Don't include dates in diff headers.
 
 ``noprefix``
     Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
 
 ``showfunc``
     Show which function each change is in.
 
 ``ignorews``
     Ignore white space when comparing lines.
 
 ``ignorewsamount``
     Ignore changes in the amount of white space.
 
 ``ignoreblanklines``
     Ignore changes whose lines are all blank.
 
 ``unified``
     Number of lines of context to show.
 
 ``word-diff``
     Highlight changed words.
 
 ``email``
 ---------
 
 Settings for extensions that send email messages.
 
 ``from``
     Optional. Email address to use in "From" header and SMTP envelope
     of outgoing messages.
 
 ``to``
     Optional. Comma-separated list of recipients' email addresses.
 
 ``cc``
     Optional. Comma-separated list of carbon copy recipients'
     email addresses.
 
 ``bcc``
     Optional. Comma-separated list of blind carbon copy recipients'
     email addresses.
 
 ``method``
     Optional. Method to use to send email messages. If value is ``smtp``
     (default), use SMTP (see the ``[smtp]`` section for configuration).
     Otherwise, use as name of program to run that acts like sendmail
     (takes ``-f`` option for sender, list of recipients on command line,
     message on stdin). Normally, setting this to ``sendmail`` or
     ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
 
 ``charsets``
     Optional. Comma-separated list of character sets considered
     convenient for recipients. Addresses, headers, and parts not
     containing patches of outgoing messages will be encoded in the
     first character set to which conversion from local encoding
     (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
     conversion fails, the text in question is sent as is.
     (default: '')
 
     Order of outgoing email character sets:
 
     1. ``us-ascii``: always first, regardless of settings
     2. ``email.charsets``: in order given by user
     3. ``ui.fallbackencoding``: if not in email.charsets
     4. ``$HGENCODING``: if not in email.charsets
     5. ``utf-8``: always last, regardless of settings
 
 Email example::
 
   [email]
   from = Joseph User <[e-mail]>
   method = /usr/sbin/sendmail
   # charsets for western Europeans
   # us-ascii, utf-8 omitted, as they are tried first and last
   charsets = iso-8859-1, iso-8859-15, windows-1252
 
 
 ``extensions``
 --------------
 
 Mercurial has an extension mechanism for adding new features. To
 enable an extension, create an entry for it in this section.
 
 If you know that the extension is already in Python's search path,
 you can give the name of the module, followed by ``=``, with nothing
 after the ``=``.
 
 Otherwise, give a name that you choose, followed by ``=``, followed by
 the path to the ``.py`` file (including the file name extension) that
 defines the extension.
 
 To explicitly disable an extension that is enabled in an hgrc of
 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
 or ``foo = !`` when path is not supplied.
 
 Example for ``~/.hgrc``::
 
   [extensions]
   # (the churn extension will get loaded from Mercurial's path)
   churn =
   # (this extension will get loaded from the file specified)
   myfeature = ~/.hgext/myfeature.py
 
 If an extension fails to load, a warning will be issued, and Mercurial will
 proceed. To enforce that an extension must be loaded, one can set the `required`
 suboption in the config::
 
   [extensions]
   myfeature = ~/.hgext/myfeature.py
   myfeature:required = yes
 
 To debug extension loading issue, one can add `--traceback` to their mercurial
 invocation.
 
 A default setting can we set using the special `*` extension key::
 
   [extensions]
   *:required = yes
   myfeature = ~/.hgext/myfeature.py
   rebase=
 
 
 ``format``
 ----------
 
 Configuration that controls the repository format. Newer format options are more
 powerful, but incompatible with some older versions of Mercurial. Format options
 are considered at repository initialization only. You need to make a new clone
 for config changes to be taken into account.
 
 For more details about repository format and version compatibility, see
 https://www.mercurial-scm.org/wiki/MissingRequirement
 
 ``usegeneraldelta``
     Enable or disable the "generaldelta" repository format which improves
     repository compression by allowing "revlog" to store deltas against
     arbitrary revisions instead of the previously stored one. This provides
     significant improvement for repositories with branches.
 
     Repositories with this on-disk format require Mercurial version 1.9.
 
     Enabled by default.
 
 ``dotencode``
     Enable or disable the "dotencode" repository format which enhances
     the "fncache" repository format (which has to be enabled to use
     dotencode) to avoid issues with filenames starting with "._" on
     Mac OS X and spaces on Windows.
 
     Repositories with this on-disk format require Mercurial version 1.7.
 
     Enabled by default.
 
 ``usefncache``
     Enable or disable the "fncache" repository format which enhances
     the "store" repository format (which has to be enabled to use
     fncache) to allow longer filenames and avoids using Windows
     reserved names, e.g. "nul".
 
     Repositories with this on-disk format require Mercurial version 1.1.
 
     Enabled by default.
 
 ``use-dirstate-v2``
     Enable or disable the experimental "dirstate-v2" feature. The dirstate
     functionality is shared by all commands interacting with the working copy.
     The new version is more robust, faster and stores more information.
 
     The performance-improving version of this feature is currently only
     implemented in Rust (see :hg:`help rust`), so people not using a version of
     Mercurial compiled with the Rust parts might actually suffer some slowdown.
     For this reason, such versions will by default refuse to access repositories
     with "dirstate-v2" enabled.
 
     This behavior can be adjusted via configuration: check
     :hg:`help config.storage.dirstate-v2.slow-path` for details.
 
     Repositories with this on-disk format require Mercurial 6.0 or above.
 
     By default this format variant is disabled if the fast implementation is not
     available, and enabled by default if the fast implementation is available.
 
     To accomodate installations of Mercurial without the fast implementation,
     you can downgrade your repository. To do so run the following command:
 
     $ hg debugupgraderepo \
           --run \
           --config format.use-dirstate-v2=False \
           --config storage.dirstate-v2.slow-path=allow
 
     For a more comprehensive guide, see :hg:`help internals.dirstate-v2`.
 
 ``use-dirstate-v2.automatic-upgrade-of-mismatching-repositories``
    When enabled, an automatic upgrade will be triggered when a repository format
    does not match its `use-dirstate-v2` config.
 
    This is an advanced behavior that most users will not need. We recommend you
    don't use this unless you are a seasoned administrator of a Mercurial install
    base.
 
    Automatic upgrade means that any process accessing the repository will
    upgrade the repository format to use `dirstate-v2`. This only triggers if a
    change is needed. This also applies to operations that would have been
    read-only (like hg status).
 
    If the repository cannot be locked, the automatic-upgrade operation will be
    skipped. The next operation will attempt it again.
 
    This configuration will apply for moves in any direction, either adding the
    `dirstate-v2` format if `format.use-dirstate-v2=yes` or removing the
    `dirstate-v2` requirement if `format.use-dirstate-v2=no`. So we recommend
    setting both this value and `format.use-dirstate-v2` at the same time.
 
 ``use-dirstate-v2.automatic-upgrade-of-mismatching-repositories:quiet``
     Hide message when performing such automatic upgrade.
 
 ``use-dirstate-tracked-hint``
     Enable or disable the writing of "tracked key" file alongside the dirstate.
     (default to disabled)
 
     That "tracked-hint" can help external automations to detect changes to the
     set of tracked files. (i.e the result of `hg files` or `hg status -macd`)
 
     The tracked-hint is written in a new `.hg/dirstate-tracked-hint`. That file
     contains two lines:
     - the first line is the file version (currently: 1),
     - the second line contains the "tracked-hint".
     That file is written right after the dirstate is written.
 
     The tracked-hint changes whenever the set of file tracked in the dirstate
     changes. The general idea is:
     - if the hint is identical, the set of tracked file SHOULD be identical,
     - if the hint is different, the set of tracked file MIGHT be different.
 
     The "hint is identical" case uses `SHOULD` as the dirstate and the hint file
     are two distinct files and therefore that cannot be read or written to in an
     atomic way. If the key is identical, nothing garantees that the dirstate is
     not updated right after the hint file. This is considered a negligible
     limitation for the intended usecase. It is actually possible to prevent this
     race by taking the repository lock during read operations.
 
     They are two "ways" to use this feature:
 
     1) monitoring changes to the `.hg/dirstate-tracked-hint`, if the file
     changes, the tracked set might have changed.
 
     2) storing the value and comparing it to a later value.
 
 
 ``use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories``
    When enabled, an automatic upgrade will be triggered when a repository format
    does not match its `use-dirstate-tracked-hint` config.
 
    This is an advanced behavior that most users will not need. We recommend you
    don't use this unless you are a seasoned administrator of a Mercurial install
    base.
 
    Automatic upgrade means that any process accessing the repository will
    upgrade the repository format to use `dirstate-tracked-hint`. This only
    triggers if a change is needed. This also applies to operations that would
    have been read-only (like hg status).
 
    If the repository cannot be locked, the automatic-upgrade operation will be
    skipped. The next operation will attempt it again.
 
    This configuration will apply for moves in any direction, either adding the
    `dirstate-tracked-hint` format if `format.use-dirstate-tracked-hint=yes` or
    removing the `dirstate-tracked-hint` requirement if
    `format.use-dirstate-tracked-hint=no`. So we recommend setting both this
    value and `format.use-dirstate-tracked-hint` at the same time.
 
 
 ``use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories:quiet``
     Hide message when performing such automatic upgrade.
 
 
 ``use-persistent-nodemap``
     Enable or disable the "persistent-nodemap" feature which improves
     performance if the Rust extensions are available.
 
     The "persistent-nodemap" persist the "node -> rev" on disk removing the
     need to dynamically build that mapping for each Mercurial invocation. This
     significantly reduces the startup cost of various local and server-side
     operation for larger repositories.
 
     The performance-improving version of this feature is currently only
     implemented in Rust (see :hg:`help rust`), so people not using a version of
     Mercurial compiled with the Rust parts might actually suffer some slowdown.
     For this reason, such versions will by default refuse to access repositories
     with "persistent-nodemap".
 
     This behavior can be adjusted via configuration: check
     :hg:`help config.storage.revlog.persistent-nodemap.slow-path` for details.
 
     Repositories with this on-disk format require Mercurial 5.4 or above.
 
     By default this format variant is disabled if the fast implementation is not
     available, and enabled by default if the fast implementation is available.
 
     To accomodate installations of Mercurial without the fast implementation,
     you can downgrade your repository. To do so run the following command:
 
     $ hg debugupgraderepo \
           --run \
           --config format.use-persistent-nodemap=False \
           --config storage.revlog.persistent-nodemap.slow-path=allow
 
 ``use-share-safe``
     Enforce "safe" behaviors for all "shares" that access this repository.
 
     With this feature, "shares" using this repository as a source will:
 
     * read the source repository's configuration (`<source>/.hg/hgrc`).
     * read and use the source repository's "requirements"
       (except the working copy specific one).
 
     Without this feature, "shares" using this repository as a source will:
 
     * keep tracking the repository "requirements" in the share only, ignoring
       the source "requirements", possibly diverging from them.
     * ignore source repository config. This can create problems, like silently
       ignoring important hooks.
 
     Beware that existing shares will not be upgraded/downgraded, and by
     default, Mercurial will refuse to interact with them until the mismatch
     is resolved. See :hg:`help config.share.safe-mismatch.source-safe` and
     :hg:`help config.share.safe-mismatch.source-not-safe` for details.
 
     Introduced in Mercurial 5.7.
 
     Enabled by default in Mercurial 6.1.
 
 ``use-share-safe.automatic-upgrade-of-mismatching-repositories``
    When enabled, an automatic upgrade will be triggered when a repository format
    does not match its `use-share-safe` config.
 
    This is an advanced behavior that most users will not need. We recommend you
    don't use this unless you are a seasoned administrator of a Mercurial install
    base.
 
    Automatic upgrade means that any process accessing the repository will
    upgrade the repository format to use `share-safe`. This only triggers if a
    change is needed. This also applies to operation that would have been
    read-only (like hg status).
 
    If the repository cannot be locked, the automatic-upgrade operation will be
    skipped. The next operation will attempt it again.
 
    This configuration will apply for moves in any direction, either adding the
    `share-safe` format if `format.use-share-safe=yes` or removing the
    `share-safe` requirement if `format.use-share-safe=no`. So we recommend
    setting both this value and `format.use-share-safe` at the same time.
 
 ``use-share-safe.automatic-upgrade-of-mismatching-repositories:quiet``
     Hide message when performing such automatic upgrade.
 
 ``usestore``
     Enable or disable the "store" repository format which improves
     compatibility with systems that fold case or otherwise mangle
     filenames. Disabling this option will allow you to store longer filenames
     in some situations at the expense of compatibility.
 
     Repositories with this on-disk format require Mercurial version 0.9.4.
 
     Enabled by default.
 
 ``sparse-revlog``
     Enable or disable the ``sparse-revlog`` delta strategy. This format improves
     delta re-use inside revlog. For very branchy repositories, it results in a
     smaller store. For repositories with many revisions, it also helps
     performance (by using shortened delta chains.)
 
     Repositories with this on-disk format require Mercurial version 4.7
 
     Enabled by default.
 
 ``revlog-compression``
     Compression algorithm used by revlog. Supported values are `zlib` and
     `zstd`. The `zlib` engine is the historical default of Mercurial. `zstd` is
     a newer format that is usually a net win over `zlib`, operating faster at
     better compression rates. Use `zstd` to reduce CPU usage. Multiple values
     can be specified, the first available one will be used.
 
     On some systems, the Mercurial installation may lack `zstd` support.
 
     Default is `zstd` if available, `zlib` otherwise.
 
 ``bookmarks-in-store``
     Store bookmarks in .hg/store/. This means that bookmarks are shared when
     using `hg share` regardless of the `-B` option.
 
     Repositories with this on-disk format require Mercurial version 5.1.
 
     Disabled by default.
 
 
 ``graph``
 ---------
 
 Web graph view configuration. This section let you change graph
 elements display properties by branches, for instance to make the
 ``default`` branch stand out.
 
 Each line has the following format::
 
     <branch>.<argument> = <value>
 
 where ``<branch>`` is the name of the branch being
 customized. Example::
 
     [graph]
     # 2px width
     default.width = 2
     # red color
     default.color = FF0000
 
 Supported arguments:
 
 ``width``
     Set branch edges width in pixels.
 
 ``color``
     Set branch edges color in hexadecimal RGB notation.
 
 ``hooks``
 ---------
 
 Commands or Python functions that get automatically executed by
 various actions such as starting or finishing a commit. Multiple
 hooks can be run for the same action by appending a suffix to the
 action. Overriding a site-wide hook can be done by changing its
 value or setting it to an empty string.  Hooks can be prioritized
 by adding a prefix of ``priority.`` to the hook name on a new line
 and setting the priority. The default priority is 0.
 
 Example ``.hg/hgrc``::
 
   [hooks]
   # update working directory after adding changesets
   changegroup.update = hg update
   # do not use the site-wide hook
   incoming =
   incoming.email = /my/email/hook
   incoming.autobuild = /my/build/hook
   # force autobuild hook to run before other incoming hooks
   priority.incoming.autobuild = 1
   ###  control HGPLAIN setting when running autobuild hook
   # HGPLAIN always set (default from Mercurial 5.7)
   incoming.autobuild:run-with-plain = yes
   # HGPLAIN never set
   incoming.autobuild:run-with-plain = no
   # HGPLAIN inherited from environment (default before Mercurial 5.7)
   incoming.autobuild:run-with-plain = auto
 
 Most hooks are run with environment variables set that give useful
 additional information. For each hook below, the environment variables
 it is passed are listed with names in the form ``$HG_foo``. The
 ``$HG_HOOKTYPE`` and ``$HG_HOOKNAME`` variables are set for all hooks.
 They contain the type of hook which triggered the run and the full name
 of the hook in the config, respectively. In the example above, this will
 be ``$HG_HOOKTYPE=incoming`` and ``$HG_HOOKNAME=incoming.email``.
 
 .. container:: windows
 
   Some basic Unix syntax can be enabled for portability, including ``$VAR``
   and ``${VAR}`` style variables.  A ``~`` followed by ``\`` or ``/`` will
   be expanded to ``%USERPROFILE%`` to simulate a subset of tilde expansion
   on Unix.  To use a literal ``$`` or ``~``, it must be escaped with a back
   slash or inside of a strong quote.  Strong quotes will be replaced by
   double quotes after processing.
 
   This feature is enabled by adding a prefix of ``tonative.`` to the hook
   name on a new line, and setting it to ``True``.  For example::
 
     [hooks]
     incoming.autobuild = /my/build/hook
     # enable translation to cmd.exe syntax for autobuild hook
     tonative.incoming.autobuild = True
 
 ``changegroup``
   Run after a changegroup has been added via push, pull or unbundle.  The ID of
   the first new changeset is in ``$HG_NODE`` and last is in ``$HG_NODE_LAST``.
   The URL from which changes came is in ``$HG_URL``.
 
 ``commit``
   Run after a changeset has been created in the local repository. The ID
   of the newly created changeset is in ``$HG_NODE``. Parent changeset
   IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
 
 ``incoming``
   Run after a changeset has been pulled, pushed, or unbundled into
   the local repository. The ID of the newly arrived changeset is in
   ``$HG_NODE``. The URL that was source of the changes is in ``$HG_URL``.
 
 ``outgoing``
   Run after sending changes from the local repository to another. The ID of
   first changeset sent is in ``$HG_NODE``. The source of operation is in
   ``$HG_SOURCE``. Also see :hg:`help config.hooks.preoutgoing`.
 
 ``post-<command>``
   Run after successful invocations of the associated command. The
   contents of the command line are passed as ``$HG_ARGS`` and the result
   code in ``$HG_RESULT``. Parsed command line arguments are passed as
   ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
   the python data internally passed to <command>. ``$HG_OPTS`` is a
   dictionary of options (with unspecified options set to their defaults).
   ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
 
 ``fail-<command>``
   Run after a failed invocation of an associated command. The contents
   of the command line are passed as ``$HG_ARGS``. Parsed command line
   arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
   string representations of the python data internally passed to
   <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
   options set to their defaults). ``$HG_PATS`` is a list of arguments.
   Hook failure is ignored.
 
 ``pre-<command>``
   Run before executing the associated command. The contents of the
   command line are passed as ``$HG_ARGS``. Parsed command line arguments
   are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
   representations of the data internally passed to <command>. ``$HG_OPTS``
   is a dictionary of options (with unspecified options set to their
   defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
   failure, the command doesn't execute and Mercurial returns the failure
   code.
 
 ``prechangegroup``
   Run before a changegroup is added via push, pull or unbundle. Exit
   status 0 allows the changegroup to proceed. A non-zero status will
   cause the push, pull or unbundle to fail. The URL from which changes
   will come is in ``$HG_URL``.
 
 ``precommit``
   Run before starting a local commit. Exit status 0 allows the
   commit to proceed. A non-zero status will cause the commit to fail.
   Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
 
 ``prelistkeys``
   Run before listing pushkeys (like bookmarks) in the
   repository. A non-zero status will cause failure. The key namespace is
   in ``$HG_NAMESPACE``.
 
 ``preoutgoing``
   Run before collecting changes to send from the local repository to
   another. A non-zero status will cause failure. This lets you prevent
   pull over HTTP or SSH. It can also prevent propagating commits (via
   local pull, push (outbound) or bundle commands), but not completely,
   since you can just copy files instead. The source of operation is in
   ``$HG_SOURCE``. If "serve", the operation is happening on behalf of a remote
   SSH or HTTP repository. If "push", "pull" or "bundle", the operation
   is happening on behalf of a repository on same system.
 
 ``prepushkey``
   Run before a pushkey (like a bookmark) is added to the
   repository. A non-zero status will cause the key to be rejected. The
   key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
   the old value (if any) is in ``$HG_OLD``, and the new value is in
   ``$HG_NEW``.
 
 ``pretag``
   Run before creating a tag. Exit status 0 allows the tag to be
   created. A non-zero status will cause the tag to fail. The ID of the
   changeset to tag is in ``$HG_NODE``. The name of tag is in ``$HG_TAG``. The
   tag is local if ``$HG_LOCAL=1``, or in the repository if ``$HG_LOCAL=0``.
 
 ``pretxnopen``
   Run before any new repository transaction is open. The reason for the
   transaction will be in ``$HG_TXNNAME``, and a unique identifier for the
   transaction will be in ``$HG_TXNID``. A non-zero status will prevent the
   transaction from being opened.
 
 ``pretxnclose``
   Run right before the transaction is actually finalized. Any repository change
   will be visible to the hook program. This lets you validate the transaction
   content or change it. Exit status 0 allows the commit to proceed. A non-zero
   status will cause the transaction to be rolled back. The reason for the
   transaction opening will be in ``$HG_TXNNAME``, and a unique identifier for
   the transaction will be in ``$HG_TXNID``. The rest of the available data will
   vary according the transaction type.  Changes unbundled to the repository will
   add ``$HG_URL`` and ``$HG_SOURCE``.  New changesets will add ``$HG_NODE`` (the
   ID of the first added changeset), ``$HG_NODE_LAST`` (the ID of the last added
   changeset).  Bookmark and phase changes will set ``$HG_BOOKMARK_MOVED`` and
   ``$HG_PHASES_MOVED`` to ``1`` respectively.  The number of new obsmarkers, if
   any, will be in ``$HG_NEW_OBSMARKERS``, etc.
 
 ``pretxnclose-bookmark``
   Run right before a bookmark change is actually finalized. Any repository
   change will be visible to the hook program. This lets you validate the
   transaction content or change it. Exit status 0 allows the commit to
   proceed. A non-zero status will cause the transaction to be rolled back.
   The name of the bookmark will be available in ``$HG_BOOKMARK``, the new
   bookmark location will be available in ``$HG_NODE`` while the previous
   location will be available in ``$HG_OLDNODE``. In case of a bookmark
   creation ``$HG_OLDNODE`` will be empty. In case of deletion ``$HG_NODE``
   will be empty.
   In addition, the reason for the transaction opening will be in
   ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
   ``$HG_TXNID``.
 
 ``pretxnclose-phase``
   Run right before a phase change is actually finalized. Any repository change
   will be visible to the hook program. This lets you validate the transaction
   content or change it. Exit status 0 allows the commit to proceed.  A non-zero
   status will cause the transaction to be rolled back. The hook is called
   multiple times, once for each revision affected by a phase change.
   The affected node is available in ``$HG_NODE``, the phase in ``$HG_PHASE``
   while the previous ``$HG_OLDPHASE``. In case of new node, ``$HG_OLDPHASE``
   will be empty.  In addition, the reason for the transaction opening will be in
   ``$HG_TXNNAME``, and a unique identifier for the transaction will be in
   ``$HG_TXNID``. The hook is also run for newly added revisions. In this case
   the ``$HG_OLDPHASE`` entry will be empty.
 
 ``txnclose``
   Run after any repository transaction has been committed. At this
   point, the transaction can no longer be rolled back. The hook will run
   after the lock is released. See :hg:`help config.hooks.pretxnclose` for
   details about available variables.
 
 ``txnclose-bookmark``
   Run after any bookmark change has been committed. At this point, the
   transaction can no longer be rolled back. The hook will run after the lock
   is released. See :hg:`help config.hooks.pretxnclose-bookmark` for details
   about available variables.
 
 ``txnclose-phase``
   Run after any phase change has been committed. At this point, the
   transaction can no longer be rolled back. The hook will run after the lock
   is released. See :hg:`help config.hooks.pretxnclose-phase` for details about
   available variables.
 
 ``txnabort``
   Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
   for details about available variables.
 
 ``pretxnchangegroup``
   Run after a changegroup has been added via push, pull or unbundle, but before
   the transaction has been committed. The changegroup is visible to the hook
   program. This allows validation of incoming changes before accepting them.
   The ID of the first new changeset is in ``$HG_NODE`` and last is in
   ``$HG_NODE_LAST``. Exit status 0 allows the transaction to commit. A non-zero
   status will cause the transaction to be rolled back, and the push, pull or
   unbundle will fail. The URL that was the source of changes is in ``$HG_URL``.
 
 ``pretxncommit``
   Run after a changeset has been created, but before the transaction is
   committed. The changeset is visible to the hook program. This allows
   validation of the commit message and changes. Exit status 0 allows the
   commit to proceed. A non-zero status will cause the transaction to
   be rolled back. The ID of the new changeset is in ``$HG_NODE``. The parent
   changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
 
 ``preupdate``
   Run before updating the working directory. Exit status 0 allows
   the update to proceed. A non-zero status will prevent the update.
   The changeset ID of first new parent is in ``$HG_PARENT1``. If updating to a
   merge, the ID of second new parent is in ``$HG_PARENT2``.
 
 ``listkeys``
   Run after listing pushkeys (like bookmarks) in the repository. The
   key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
   dictionary containing the keys and values.
 
 ``pushkey``
   Run after a pushkey (like a bookmark) is added to the
   repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
   ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
   value is in ``$HG_NEW``.
 
 ``tag``
   Run after a tag is created. The ID of the tagged changeset is in ``$HG_NODE``.
   The name of tag is in ``$HG_TAG``. The tag is local if ``$HG_LOCAL=1``, or in
   the repository if ``$HG_LOCAL=0``.
 
 ``update``
   Run after updating the working directory. The changeset ID of first
   new parent is in ``$HG_PARENT1``. If updating to a merge, the ID of second new
   parent is in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
   update failed (e.g. because conflicts were not resolved), ``$HG_ERROR=1``.
 
 .. note::
 
    It is generally better to use standard hooks rather than the
    generic pre- and post- command hooks, as they are guaranteed to be
    called in the appropriate contexts for influencing transactions.
    Also, hooks like "commit" will be called in all contexts that
    generate a commit (e.g. tag) and not just the commit command.
 
 .. note::
 
    Environment variables with empty values may not be passed to
    hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
    will have an empty value under Unix-like platforms for non-merge
    changesets, while it will not be available at all under Windows.
 
 The syntax for Python hooks is as follows::
 
   hookname = python:modulename.submodule.callable
   hookname = python:/path/to/python/module.py:callable
 
 Python hooks are run within the Mercurial process. Each hook is
 called with at least three keyword arguments: a ui object (keyword
 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
 keyword that tells what kind of hook is used. Arguments listed as
 environment variables above are passed as keyword arguments, with no
 ``HG_`` prefix, and names in lower case.
 
 If a Python hook returns a "true" value or raises an exception, this
 is treated as a failure.
 
 
 ``hostfingerprints``
 --------------------
 
 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
 
 Fingerprints of the certificates of known HTTPS servers.
 
 A HTTPS connection to a server with a fingerprint configured here will
 only succeed if the servers certificate matches the fingerprint.
 This is very similar to how ssh known hosts works.
 
 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
 Multiple values can be specified (separated by spaces or commas). This can
 be used to define both old and new fingerprints while a host transitions
 to a new certificate.
 
 The CA chain and web.cacerts is not used for servers with a fingerprint.
 
 For example::
 
     [hostfingerprints]
     hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
     hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
 
 ``hostsecurity``
 ----------------
 
 Used to specify global and per-host security settings for connecting to
 other machines.
 
 The following options control default behavior for all hosts.
 
 ``ciphers``
     Defines the cryptographic ciphers to use for connections.
 
     Value must be a valid OpenSSL Cipher List Format as documented at
     https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
 
     This setting is for advanced users only. Setting to incorrect values
     can significantly lower connection security or decrease performance.
     You have been warned.
 
     This option requires Python 2.7.
 
 ``minimumprotocol``
     Defines the minimum channel encryption protocol to use.
 
     By default, the highest version of TLS supported by both client and server
     is used.
 
     Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
 
     When running on an old Python version, only ``tls1.0`` is allowed since
     old versions of Python only support up to TLS 1.0.
 
     When running a Python that supports modern TLS versions, the default is
     ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
     weakens security and should only be used as a feature of last resort if
     a server does not support TLS 1.1+.
 
 Options in the ``[hostsecurity]`` section can have the form
 ``hostname``:``setting``. This allows multiple settings to be defined on a
 per-host basis.
 
 The following per-host settings can be defined.
 
 ``ciphers``
     This behaves like ``ciphers`` as described above except it only applies
     to the host on which it is defined.
 
 ``fingerprints``
     A list of hashes of the DER encoded peer/remote certificate. Values have
     the form ``algorithm``:``fingerprint``. e.g.
     ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
     In addition, colons (``:``) can appear in the fingerprint part.
 
     The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
     ``sha512``.
 
     Use of ``sha256`` or ``sha512`` is preferred.
 
     If a fingerprint is specified, the CA chain is not validated for this
     host and Mercurial will require the remote certificate to match one
     of the fingerprints specified. This means if the server updates its
     certificate, Mercurial will abort until a new fingerprint is defined.
     This can provide stronger security than traditional CA-based validation
     at the expense of convenience.
 
     This option takes precedence over ``verifycertsfile``.
 
 ``minimumprotocol``
     This behaves like ``minimumprotocol`` as described above except it
     only applies to the host on which it is defined.
 
 ``verifycertsfile``
     Path to file a containing a list of PEM encoded certificates used to
     verify the server certificate. Environment variables and ``~user``
     constructs are expanded in the filename.
 
     The server certificate or the certificate's certificate authority (CA)
     must match a certificate from this file or certificate verification
     will fail and connections to the server will be refused.
 
     If defined, only certificates provided by this file will be used:
     ``web.cacerts`` and any system/default certificates will not be
     used.
 
     This option has no effect if the per-host ``fingerprints`` option
     is set.
 
     The format of the file is as follows::
 
         -----BEGIN CERTIFICATE-----
         ... (certificate in base64 PEM encoding) ...
         -----END CERTIFICATE-----
         -----BEGIN CERTIFICATE-----
         ... (certificate in base64 PEM encoding) ...
         -----END CERTIFICATE-----
 
 For example::
 
     [hostsecurity]
     hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
     hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
     hg3.example.com:fingerprints = sha256:9a:b0:dc:e2:75:ad:8a:b7:84:58:e5:1f:07:32:f1:87:e6:bd:24:22:af:b7:ce:8e:9c:b4:10:cf:b9:f4:0e:d2
     foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
 
 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
 when connecting to ``hg.example.com``::
 
     [hostsecurity]
     minimumprotocol = tls1.2
     hg.example.com:minimumprotocol = tls1.1
 
 ``http_proxy``
 --------------
 
 Used to access web-based Mercurial repositories through a HTTP
 proxy.
 
 ``host``
     Host name and (optional) port of the proxy server, for example
     "myproxy:8000".
 
 ``no``
     Optional. Comma-separated list of host names that should bypass
     the proxy.
 
 ``passwd``
     Optional. Password to authenticate with at the proxy server.
 
 ``user``
     Optional. User name to authenticate with at the proxy server.
 
 ``always``
     Optional. Always use the proxy, even for localhost and any entries
     in ``http_proxy.no``. (default: False)
 
 ``http``
 ----------
 
 Used to configure access to Mercurial repositories via HTTP.
 
 ``timeout``
     If set, blocking operations will timeout after that many seconds.
     (default: None)
 
 ``merge``
 ---------
 
 This section specifies behavior during merges and updates.
 
 ``checkignored``
    Controls behavior when an ignored file on disk has the same name as a tracked
    file in the changeset being merged or updated to, and has different
    contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
    abort on such files. With ``warn``, warn on such files and back them up as
    ``.orig``. With ``ignore``, don't print a warning and back them up as
    ``.orig``. (default: ``abort``)
 
 ``checkunknown``
    Controls behavior when an unknown file that isn't ignored has the same name
    as a tracked file in the changeset being merged or updated to, and has
    different contents. Similar to ``merge.checkignored``, except for files that
    are not ignored. (default: ``abort``)
 
 ``on-failure``
    When set to ``continue`` (the default), the merge process attempts to
    merge all unresolved files using the merge chosen tool, regardless of
    whether previous file merge attempts during the process succeeded or not.
    Setting this to ``prompt`` will prompt after any merge failure continue
    or halt the merge process. Setting this to ``halt`` will automatically
    halt the merge process on any merge tool failure. The merge process
    can be restarted by using the ``resolve`` command. When a merge is
    halted, the repository is left in a normal ``unresolved`` merge state.
    (default: ``continue``)
 
 ``strict-capability-check``
    Whether capabilities of internal merge tools are checked strictly
    or not, while examining rules to decide merge tool to be used.
    (default: False)
 
 ``merge-patterns``
 ------------------
 
 This section specifies merge tools to associate with particular file
 patterns. Tools matched here will take precedence over the default
 merge tool. Patterns are globs by default, rooted at the repository
 root.
 
 Example::
 
   [merge-patterns]
   **.c = kdiff3
   **.jpg = myimgmerge
 
 ``merge-tools``
 ---------------
 
 This section configures external merge tools to use for file-level
 merges. This section has likely been preconfigured at install time.
 Use :hg:`config merge-tools` to check the existing configuration.
 Also see :hg:`help merge-tools` for more details.
 
 Example ``~/.hgrc``::
 
   [merge-tools]
   # Override stock tool location
   kdiff3.executable = ~/bin/kdiff3
   # Specify command line
   kdiff3.args = $base $local $other -o $output
   # Give higher priority
   kdiff3.priority = 1
 
   # Changing the priority of preconfigured tool
   meld.priority = 0
 
   # Disable a preconfigured tool
   vimdiff.disabled = yes
 
   # Define new tool
   myHtmlTool.args = -m $local $other $base $output
   myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
   myHtmlTool.priority = 1
 
 Supported arguments:
 
 ``priority``
   The priority in which to evaluate this tool.
   (default: 0)
 
 ``executable``
   Either just the name of the executable or its pathname.
 
   .. container:: windows
 
     On Windows, the path can use environment variables with ${ProgramFiles}
     syntax.
 
   (default: the tool name)
 
 ``args``
   The arguments to pass to the tool executable. You can refer to the
   files being merged as well as the output file through these
   variables: ``$base``, ``$local``, ``$other``, ``$output``.
 
   The meaning of ``$local`` and ``$other`` can vary depending on which action is
   being performed. During an update or merge, ``$local`` represents the original
   state of the file, while ``$other`` represents the commit you are updating to or
   the commit you are merging with. During a rebase, ``$local`` represents the
   destination of the rebase, and ``$other`` represents the commit being rebased.
 
   Some operations define custom labels to assist with identifying the revisions,
   accessible via ``$labellocal``, ``$labelother``, and ``$labelbase``. If custom
   labels are not available, these will be ``local``, ``other``, and ``base``,
   respectively.
   (default: ``$local $base $other``)
 
 ``premerge``
   Attempt to run internal non-interactive 3-way merge tool before
   launching external tool.  Options are ``true``, ``false``, ``keep``,
   ``keep-merge3``, or ``keep-mergediff`` (experimental). The ``keep`` option
   will leave markers in the file if the premerge fails. The ``keep-merge3``
   will do the same but include information about the base of the merge in the
   marker (see internal :merge3 in :hg:`help merge-tools`). The
   ``keep-mergediff`` option is similar but uses a different marker style
   (see internal :merge3 in :hg:`help merge-tools`). (default: True)
 
 ``binary``
   This tool can merge binary files. (default: False, unless tool
   was selected by file pattern match)
 
 ``symlink``
   This tool can merge symlinks. (default: False)
 
 ``check``
   A list of merge success-checking options:
 
   ``changed``
     Ask whether merge was successful when the merged file shows no changes.
   ``conflicts``
     Check whether there are conflicts even though the tool reported success.
   ``prompt``
     Always prompt for merge success, regardless of success reported by tool.
 
 ``fixeol``
   Attempt to fix up EOL changes caused by the merge tool.
   (default: False)
 
 ``gui``
   This tool requires a graphical interface to run. (default: False)
 
 ``mergemarkers``
   Controls whether the labels passed via ``$labellocal``, ``$labelother``, and
   ``$labelbase`` are ``detailed`` (respecting ``mergemarkertemplate``) or
   ``basic``. If ``premerge`` is ``keep`` or ``keep-merge3``, the conflict
   markers generated during premerge will be ``detailed`` if either this option or
   the corresponding option in the ``[ui]`` section is ``detailed``.
   (default: ``basic``)
 
 ``mergemarkertemplate``
   This setting can be used to override ``mergemarker`` from the
   ``[command-templates]`` section on a per-tool basis; this applies to the
   ``$label``-prefixed variables and to the conflict markers that are generated
   if ``premerge`` is ``keep` or ``keep-merge3``. See the corresponding variable
   in ``[ui]`` for more information.
 
 .. container:: windows
 
   ``regkey``
     Windows registry key which describes install location of this
     tool. Mercurial will search for this key first under
     ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
     (default: None)
 
   ``regkeyalt``
     An alternate Windows registry key to try if the first key is not
     found.  The alternate key uses the same ``regname`` and ``regappend``
     semantics of the primary key.  The most common use for this key
     is to search for 32bit applications on 64bit operating systems.
     (default: None)
 
   ``regname``
     Name of value to read from specified registry key.
     (default: the unnamed (default) value)
 
   ``regappend``
     String to append to the value read from the registry, typically
     the executable name of the tool.
     (default: None)
 
 ``pager``
 ---------
 
 Setting used to control when to paginate and with what external tool. See
 :hg:`help pager` for details.
 
 ``pager``
     Define the external tool used as pager.
 
     If no pager is set, Mercurial uses the environment variable $PAGER.
     If neither pager.pager, nor $PAGER is set, a default pager will be
     used, typically `less` on Unix and `more` on Windows. Example::
 
       [pager]
       pager = less -FRX
 
 ``ignore``
     List of commands to disable the pager for. Example::
 
       [pager]
       ignore = version, help, update
 
 ``patch``
 ---------
 
 Settings used when applying patches, for instance through the 'import'
 command or with Mercurial Queues extension.
 
 ``eol``
     When set to 'strict' patch content and patched files end of lines
     are preserved. When set to ``lf`` or ``crlf``, both files end of
     lines are ignored when patching and the result line endings are
     normalized to either LF (Unix) or CRLF (Windows). When set to
     ``auto``, end of lines are again ignored while patching but line
     endings in patched files are normalized to their original setting
     on a per-file basis. If target file does not exist or has no end
     of line, patch line endings are preserved.
     (default: strict)
 
 ``fuzz``
     The number of lines of 'fuzz' to allow when applying patches. This
     controls how much context the patcher is allowed to ignore when
     trying to apply a patch.
     (default: 2)
 
 ``paths``
 ---------
 
 Assigns symbolic names and behavior to repositories.
 
 Options are symbolic names defining the URL or directory that is the
 location of the repository. Example::
 
     [paths]
     my_server = https://example.com/my_repo
     local_path = /home/me/repo
 
 These symbolic names can be used from the command line. To pull
 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
 :hg:`push local_path`. You can check :hg:`help urls` for details about
 valid URLs.
 
 Options containing colons (``:``) denote sub-options that can influence
 behavior for that specific path. Example::
 
     [paths]
     my_server = https://example.com/my_path
     my_server:pushurl = ssh://example.com/my_path
 
 Paths using the `path://otherpath` scheme will inherit the sub-options value from
 the path they point to.
 
 The following sub-options can be defined:
 
 ``multi-urls``
    A boolean option. When enabled the value of the `[paths]` entry will be
    parsed as a list and the alias will resolve to multiple destination. If some
    of the list entry use the `path://` syntax, the suboption will be inherited
    individually.
 
 ``pushurl``
    The URL to use for push operations. If not defined, the location
    defined by the path's main entry is used.
 
 ``pushrev``
    A revset defining which revisions to push by default.
 
    When :hg:`push` is executed without a ``-r`` argument, the revset
    defined by this sub-option is evaluated to determine what to push.
 
    For example, a value of ``.`` will push the working directory's
    revision by default.
 
    Revsets specifying bookmarks will not result in the bookmark being
    pushed.
 
 ``bookmarks.mode``
   How bookmark will be dealt during the exchange. It support the following value
 
   - ``default``: the default behavior, local and remote bookmarks are "merged"
     on push/pull.
 
   - ``mirror``: when pulling, replace local bookmarks by remote bookmarks. This
     is useful to replicate a repository, or as an optimization.
 
   - ``ignore``: ignore bookmarks during exchange.
     (This currently only affect pulling)
 
 The following special named paths exist:
 
 ``default``
    The URL or directory to use when no source or remote is specified.
 
    :hg:`clone` will automatically define this path to the location the
    repository was cloned from.
 
 ``default-push``
    (deprecated) The URL or directory for the default :hg:`push` location.
    ``default:pushurl`` should be used instead.
 
 ``phases``
 ----------
 
 Specifies default handling of phases. See :hg:`help phases` for more
 information about working with phases.
 
 ``publish``
     Controls draft phase behavior when working as a server. When true,
     pushed changesets are set to public in both client and server and
     pulled or cloned changesets are set to public in the client.
     (default: True)
 
 ``new-commit``
     Phase of newly-created commits.
     (default: draft)
 
 ``checksubrepos``
     Check the phase of the current revision of each subrepository. Allowed
     values are "ignore", "follow" and "abort". For settings other than
     "ignore", the phase of the current revision of each subrepository is
     checked before committing the parent repository. If any of those phases is
     greater than the phase of the parent repository (e.g. if a subrepo is in a
     "secret" phase while the parent repo is in "draft" phase), the commit is
     either aborted (if checksubrepos is set to "abort") or the higher phase is
     used for the parent repository commit (if set to "follow").
     (default: follow)
 
 
 ``profiling``
 -------------
 
 Specifies profiling type, format, and file output. Two profilers are
 supported: an instrumenting profiler (named ``ls``), and a sampling
 profiler (named ``stat``).
 
 In this section description, 'profiling data' stands for the raw data
 collected during profiling, while 'profiling report' stands for a
 statistical text report generated from the profiling data.
 
 ``enabled``
     Enable the profiler.
     (default: false)
 
     This is equivalent to passing ``--profile`` on the command line.
 
 ``type``
     The type of profiler to use.
     (default: stat)
 
     ``ls``
       Use Python's built-in instrumenting profiler. This profiler
       works on all platforms, but each line number it reports is the
       first line of a function. This restriction makes it difficult to
       identify the expensive parts of a non-trivial function.
     ``stat``
       Use a statistical profiler, statprof. This profiler is most
       useful for profiling commands that run for longer than about 0.1
       seconds.
 
 ``format``
     Profiling format.  Specific to the ``ls`` instrumenting profiler.
     (default: text)
 
     ``text``
       Generate a profiling report. When saving to a file, it should be
       noted that only the report is saved, and the profiling data is
       not kept.
     ``kcachegrind``
       Format profiling data for kcachegrind use: when saving to a
       file, the generated file can directly be loaded into
       kcachegrind.
 
 ``statformat``
     Profiling format for the ``stat`` profiler.
     (default: hotpath)
 
     ``hotpath``
       Show a tree-based display containing the hot path of execution (where
       most time was spent).
     ``bymethod``
       Show a table of methods ordered by how frequently they are active.
     ``byline``
       Show a table of lines in files ordered by how frequently they are active.
     ``json``
       Render profiling data as JSON.
 
 ``freq``
     Sampling frequency.  Specific to the ``stat`` sampling profiler.
     (default: 1000)
 
 ``output``
     File path where profiling data or report should be saved. If the
     file exists, it is replaced. (default: None, data is printed on
     stderr)
 
 ``sort``
     Sort field.  Specific to the ``ls`` instrumenting profiler.
     One of ``callcount``, ``reccallcount``, ``totaltime`` and
     ``inlinetime``.
     (default: inlinetime)
 
 ``time-track``
     Control if the stat profiler track ``cpu`` or ``real`` time.
     (default: ``cpu`` on Windows, otherwise ``real``)
 
 ``limit``
     Number of lines to show. Specific to the ``ls`` instrumenting profiler.
     (default: 30)
 
 ``nested``
     Show at most this number of lines of drill-down info after each main entry.
     This can help explain the difference between Total and Inline.
     Specific to the ``ls`` instrumenting profiler.
     (default: 0)
 
 ``showmin``
     Minimum fraction of samples an entry must have for it to be displayed.
     Can be specified as a float between ``0.0`` and ``1.0`` or can have a
     ``%`` afterwards to allow values up to ``100``. e.g. ``5%``.
 
     Only used by the ``stat`` profiler.
 
     For the ``hotpath`` format, default is ``0.05``.
     For the ``chrome`` format, default is ``0.005``.
 
     The option is unused on other formats.
 
 ``showmax``
     Maximum fraction of samples an entry can have before it is ignored in
     display. Values format is the same as ``showmin``.
 
     Only used by the ``stat`` profiler.
 
     For the ``chrome`` format, default is ``0.999``.
 
     The option is unused on other formats.
 
 ``showtime``
     Show time taken as absolute durations, in addition to percentages.
     Only used by the ``hotpath`` format.
     (default: true)
 
 ``progress``
 ------------
 
 Mercurial commands can draw progress bars that are as informative as
 possible. Some progress bars only offer indeterminate information, while others
 have a definite end point.
 
 ``debug``
     Whether to print debug info when updating the progress bar. (default: False)
 
 ``delay``
     Number of seconds (float) before showing the progress bar. (default: 3)
 
 ``changedelay``
     Minimum delay before showing a new topic. When set to less than 3 * refresh,
     that value will be used instead. (default: 1)
 
 ``estimateinterval``
     Maximum sampling interval in seconds for speed and estimated time
     calculation. (default: 60)
 
 ``refresh``
     Time in seconds between refreshes of the progress bar. (default: 0.1)
 
 ``format``
     Format of the progress bar.
 
     Valid entries for the format field are ``topic``, ``bar``, ``number``,
     ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
     last 20 characters of the item, but this can be changed by adding either
     ``-<num>`` which would take the last num characters, or ``+<num>`` for the
     first num characters.
 
     (default: topic bar number estimate)
 
 ``width``
     If set, the maximum width of the progress information (that is, min(width,
     term width) will be used).
 
 ``clear-complete``
     Clear the progress bar after it's done. (default: True)
 
 ``disable``
     If true, don't show a progress bar.
 
 ``assume-tty``
     If true, ALWAYS show a progress bar, unless disable is given.
 
 ``rebase``
 ----------
 
 ``evolution.allowdivergence``
     Default to False, when True allow creating divergence when performing
     rebase of obsolete changesets.
 
 ``revsetalias``
 ---------------
 
 Alias definitions for revsets. See :hg:`help revsets` for details.
 
 ``rewrite``
 -----------
 
 ``backup-bundle``
     Whether to save stripped changesets to a bundle file. (default: True)
 
 ``update-timestamp``
     If true, updates the date and time of the changeset to current. It is only
     applicable for `hg amend`, `hg commit --amend` and `hg uncommit` in the
     current version.
 
 ``empty-successor``
 
     Control what happens with empty successors that are the result of rewrite
     operations. If set to ``skip``, the successor is not created. If set to
     ``keep``, the empty successor is created and kept.
 
     Currently, only the rebase and absorb commands consider this configuration.
     (EXPERIMENTAL)
 
 ``rhg``
 -------
 
 The pure Rust fast-path for Mercurial. See `rust/README.rst` in the Mercurial repository.
 
 ``fallback-executable``
     Path to the executable to run in a sub-process when falling back to
     another implementation of Mercurial.
 
 ``fallback-immediately``
     Fall back to ``fallback-executable`` as soon as possible, regardless of
     the `rhg.on-unsupported` configuration. Useful for debugging, for example to
     bypass `rhg` if the deault `hg` points to `rhg`.
 
     Note that because this requires loading the configuration, it is possible
     that `rhg` error out before being able to fall back.
 
 ``ignored-extensions``
     Controls which extensions should be ignored by `rhg`. By default, `rhg`
     triggers the `rhg.on-unsupported` behavior any unsupported extensions.
     Users can disable that behavior when they know that a given extension
     does not need support from `rhg`.
 
     Expects a list of extension names, or ``*`` to ignore all extensions.
 
     Note: ``*:<suboption>`` is also a valid extension name for this
     configuration option.
     As of this writing, the only valid "global" suboption is ``required``.
 
 ``on-unsupported``
     Controls the behavior of `rhg` when detecting unsupported features.
 
     Possible values are `abort` (default), `abort-silent` and `fallback`.
 
     ``abort``
         Print an error message describing what feature is not supported,
         and exit with code 252
 
     ``abort-silent``
         Silently exit with code 252
 
     ``fallback``
         Try running the fallback executable with the same parameters
         (and trace the fallback reason, use `RUST_LOG=trace` to see).
 
 ``share``
 ---------
 
 ``safe-mismatch.source-safe``
     Controls what happens when the shared repository does not use the
     share-safe mechanism but its source repository does.
 
     Possible values are `abort` (default), `allow`, `upgrade-abort` and
     `upgrade-allow`.
 
     ``abort``
         Disallows running any command and aborts
     ``allow``
         Respects the feature presence in the share source
     ``upgrade-abort``
         Tries to upgrade the share to use share-safe; if it fails, aborts
     ``upgrade-allow``
         Tries to upgrade the share; if it fails, continue by
         respecting the share source setting
 
     Check :hg:`help config.format.use-share-safe` for details about the
     share-safe feature.
 
 ``safe-mismatch.source-safe:verbose-upgrade``
     Display a message when upgrading, (default: True)
 
 ``safe-mismatch.source-safe.warn``
     Shows a warning on operations if the shared repository does not use
     share-safe, but the source repository does.
     (default: True)
 
 ``safe-mismatch.source-not-safe``
     Controls what happens when the shared repository uses the share-safe
     mechanism but its source does not.
 
     Possible values are `abort` (default), `allow`, `downgrade-abort` and
     `downgrade-allow`.
 
     ``abort``
         Disallows running any command and aborts
     ``allow``
         Respects the feature presence in the share source
     ``downgrade-abort``
         Tries to downgrade the share to not use share-safe; if it fails, aborts
     ``downgrade-allow``
         Tries to downgrade the share to not use share-safe;
         if it fails, continue by respecting the shared source setting
 
     Check :hg:`help config.format.use-share-safe` for details about the
     share-safe feature.
 
 ``safe-mismatch.source-not-safe:verbose-upgrade``
     Display a message when upgrading, (default: True)
 
 ``safe-mismatch.source-not-safe.warn``
     Shows a warning on operations if the shared repository uses share-safe,
     but the source repository does not.
     (default: True)
 
 ``storage``
 -----------
 
 Control the strategy Mercurial uses internally to store history. Options in this
 category impact performance and repository size.
 
 ``revlog.issue6528.fix-incoming``
     Version 5.8 of Mercurial had a bug leading to altering the parent of file
     revision with copy information (or any other metadata) on exchange. This
     leads to the copy metadata to be overlooked by various internal logic. The
     issue was fixed in Mercurial 5.8.1.
     (See https://bz.mercurial-scm.org/show_bug.cgi?id=6528 for details)
 
     As a result Mercurial is now checking and fixing incoming file revisions to
     make sure there parents are in the right order. This behavior can be
     disabled by setting this option to `no`. This apply to revisions added
     through push, pull, clone and unbundle.
 
     To fix affected revisions that already exist within the repository, one can
     use :hg:`debug-repair-issue-6528`.
 
+.. container:: verbose
+
+    ``revlog.delta-parent-search.candidate-group-chunk-size``
+        Tune the number of delta bases the storage will consider in the
+        same "round" of search. In some very rare cases, using a smaller value
+        might result in faster processing at the possible expense of storage
+        space, while using larger values might result in slower processing at the
+        possible benefit of storage space. A value of "0" means no limitation.
+
+        default: no limitation
+
+        This is unlikely that you'll have to tune this configuration. If you think
+        you do, consider talking with the mercurial developer community about your
+        repositories.
+
 ``revlog.optimize-delta-parent-choice``
     When storing a merge revision, both parents will be equally considered as
     a possible delta base. This results in better delta selection and improved
     revlog compression. This option is enabled by default.
 
     Turning this option off can result in large increase of repository size for
     repository with many merges.
 
 ``revlog.persistent-nodemap.mmap``
     Whether to use the Operating System "memory mapping" feature (when
     possible) to access the persistent nodemap data. This improve performance
     and reduce memory pressure.
 
     Default to True.
 
     For details on the "persistent-nodemap" feature, see:
     :hg:`help config.format.use-persistent-nodemap`.
 
 ``revlog.persistent-nodemap.slow-path``
     Control the behavior of Merucrial when using a repository with "persistent"
     nodemap with an installation of Mercurial without a fast implementation for
     the feature:
 
     ``allow``: Silently use the slower implementation to access the repository.
     ``warn``: Warn, but use the slower implementation to access the repository.
     ``abort``: Prevent access to such repositories. (This is the default)
 
     For details on the "persistent-nodemap" feature, see:
     :hg:`help config.format.use-persistent-nodemap`.
 
 ``revlog.reuse-external-delta-parent``
     Control the order in which delta parents are considered when adding new
     revisions from an external source.
     (typically: apply bundle from `hg pull` or `hg push`).
 
     New revisions are usually provided as a delta against other revisions. By
     default, Mercurial will try to reuse this delta first, therefore using the
     same "delta parent" as the source. Directly using delta's from the source
     reduces CPU usage and usually speeds up operation. However, in some case,
     the source might have sub-optimal delta bases and forcing their reevaluation
     is useful. For example, pushes from an old client could have sub-optimal
     delta's parent that the server want to optimize. (lack of general delta, bad
     parents, choice, lack of sparse-revlog, etc).
 
     This option is enabled by default. Turning it off will ensure bad delta
     parent choices from older client do not propagate to this repository, at
     the cost of a small increase in CPU consumption.
 
     Note: this option only control the order in which delta parents are
     considered.  Even when disabled, the existing delta from the source will be
     reused if the same delta parent is selected.
 
 ``revlog.reuse-external-delta``
     Control the reuse of delta from external source.
     (typically: apply bundle from `hg pull` or `hg push`).
 
     New revisions are usually provided as a delta against another revision. By
     default, Mercurial will not recompute the same delta again, trusting
     externally provided deltas. There have been rare cases of small adjustment
     to the diffing algorithm in the past. So in some rare case, recomputing
     delta provided by ancient clients can provides better results. Disabling
     this option means going through a full delta recomputation for all incoming
     revisions. It means a large increase in CPU usage and will slow operations
     down.
 
     This option is enabled by default. When disabled, it also disables the
     related ``storage.revlog.reuse-external-delta-parent`` option.
 
 ``revlog.zlib.level``
     Zlib compression level used when storing data into the repository. Accepted
     Value range from 1 (lowest compression) to 9 (highest compression). Zlib
     default value is 6.
 
 
 ``revlog.zstd.level``
     zstd compression level used when storing data into the repository. Accepted
     Value range from 1 (lowest compression) to 22 (highest compression).
     (default 3)
 
 ``server``
 ----------
 
 Controls generic server settings.
 
 ``bookmarks-pushkey-compat``
     Trigger pushkey hook when being pushed bookmark updates. This config exist
     for compatibility purpose (default to True)
 
     If you use ``pushkey`` and ``pre-pushkey`` hooks to control bookmark
     movement we recommend you migrate them to ``txnclose-bookmark`` and
     ``pretxnclose-bookmark``.
 
 ``compressionengines``
     List of compression engines and their relative priority to advertise
     to clients.
 
     The order of compression engines determines their priority, the first
     having the highest priority. If a compression engine is not listed
     here, it won't be advertised to clients.
 
     If not set (the default), built-in defaults are used. Run
     :hg:`debuginstall` to list available compression engines and their
     default wire protocol priority.
 
     Older Mercurial clients only support zlib compression and this setting
     has no effect for legacy clients.
 
 ``uncompressed``
     Whether to allow clients to clone a repository using the
     uncompressed streaming protocol. This transfers about 40% more
     data than a regular clone, but uses less memory and CPU on both
     server and client. Over a LAN (100 Mbps or better) or a very fast
     WAN, an uncompressed streaming clone is a lot faster (~10x) than a
     regular clone. Over most WAN connections (anything slower than
     about 6 Mbps), uncompressed streaming is slower, because of the
     extra data transfer overhead. This mode will also temporarily hold
     the write lock while determining what data to transfer.
     (default: True)
 
 ``uncompressedallowsecret``
     Whether to allow stream clones when the repository contains secret
     changesets. (default: False)
 
 ``preferuncompressed``
     When set, clients will try to use the uncompressed streaming
     protocol. (default: False)
 
 ``disablefullbundle``
     When set, servers will refuse attempts to do pull-based clones.
     If this option is set, ``preferuncompressed`` and/or clone bundles
     are highly recommended. Partial clones will still be allowed.
     (default: False)
 
 ``streamunbundle``
     When set, servers will apply data sent from the client directly,
     otherwise it will be written to a temporary file first. This option
     effectively prevents concurrent pushes.
 
 ``pullbundle``
     When set, the server will check pullbundles.manifest for bundles
     covering the requested heads and common nodes. The first matching
     entry will be streamed to the client.
 
     For HTTP transport, the stream will still use zlib compression
     for older clients.
 
 ``concurrent-push-mode``
     Level of allowed race condition between two pushing clients.
 
     - 'strict': push is abort if another client touched the repository
       while the push was preparing.
     - 'check-related': push is only aborted if it affects head that got also
       affected while the push was preparing. (default since 5.4)
 
     'check-related' only takes effect for compatible clients (version
     4.3 and later). Older clients will use 'strict'.
 
 ``validate``
     Whether to validate the completeness of pushed changesets by
     checking that all new file revisions specified in manifests are
     present. (default: False)
 
 ``maxhttpheaderlen``
     Instruct HTTP clients not to send request headers longer than this
     many bytes. (default: 1024)
 
 ``bundle1``
     Whether to allow clients to push and pull using the legacy bundle1
     exchange format. (default: True)
 
 ``bundle1gd``
     Like ``bundle1`` but only used if the repository is using the
     *generaldelta* storage format. (default: True)
 
 ``bundle1.push``
     Whether to allow clients to push using the legacy bundle1 exchange
     format. (default: True)
 
 ``bundle1gd.push``
     Like ``bundle1.push`` but only used if the repository is using the
     *generaldelta* storage format. (default: True)
 
 ``bundle1.pull``
     Whether to allow clients to pull using the legacy bundle1 exchange
     format. (default: True)
 
 ``bundle1gd.pull``
     Like ``bundle1.pull`` but only used if the repository is using the
     *generaldelta* storage format. (default: True)
 
     Large repositories using the *generaldelta* storage format should
     consider setting this option because converting *generaldelta*
     repositories to the exchange format required by the bundle1 data
     format can consume a lot of CPU.
 
 ``bundle2.stream``
     Whether to allow clients to pull using the bundle2 streaming protocol.
     (default: True)
 
 ``zliblevel``
     Integer between ``-1`` and ``9`` that controls the zlib compression level
     for wire protocol commands that send zlib compressed output (notably the
     commands that send repository history data).
 
     The default (``-1``) uses the default zlib compression level, which is
     likely equivalent to ``6``. ``0`` means no compression. ``9`` means
     maximum compression.
 
     Setting this option allows server operators to make trade-offs between
     bandwidth and CPU used. Lowering the compression lowers CPU utilization
     but sends more bytes to clients.
 
     This option only impacts the HTTP server.
 
 ``zstdlevel``
     Integer between ``1`` and ``22`` that controls the zstd compression level
     for wire protocol commands. ``1`` is the minimal amount of compression and
     ``22`` is the highest amount of compression.
 
     The default (``3``) should be significantly faster than zlib while likely
     delivering better compression ratios.
 
     This option only impacts the HTTP server.
 
     See also ``server.zliblevel``.
 
 ``view``
     Repository filter used when exchanging revisions with the peer.
 
     The default view (``served``) excludes secret and hidden changesets.
     Another useful value is ``immutable`` (no draft, secret or hidden
     changesets). (EXPERIMENTAL)
 
 ``smtp``
 --------
 
 Configuration for extensions that need to send email messages.
 
 ``host``
     Host name of mail server, e.g. "mail.example.com".
 
 ``port``
     Optional. Port to connect to on mail server. (default: 465 if
     ``tls`` is smtps; 25 otherwise)
 
 ``tls``
     Optional. Method to enable TLS when connecting to mail server: starttls,
     smtps or none. (default: none)
 
 ``username``
     Optional. User name for authenticating with the SMTP server.
     (default: None)
 
 ``password``
     Optional. Password for authenticating with the SMTP server. If not
     specified, interactive sessions will prompt the user for a
     password; non-interactive sessions will fail. (default: None)
 
 ``local_hostname``
     Optional. The hostname that the sender can use to identify
     itself to the MTA.
 
 
 ``subpaths``
 ------------
 
 Subrepository source URLs can go stale if a remote server changes name
 or becomes temporarily unavailable. This section lets you define
 rewrite rules of the form::
 
     <pattern> = <replacement>
 
 where ``pattern`` is a regular expression matching a subrepository
 source URL and ``replacement`` is the replacement string used to
 rewrite it. Groups can be matched in ``pattern`` and referenced in
 ``replacements``. For instance::
 
     http://server/(.*)-hg/ = http://hg.server/\1/
 
 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
 
 Relative subrepository paths are first made absolute, and the
 rewrite rules are then applied on the full (absolute) path. If ``pattern``
 doesn't match the full path, an attempt is made to apply it on the
 relative path alone. The rules are applied in definition order.
 
 ``subrepos``
 ------------
 
 This section contains options that control the behavior of the
 subrepositories feature. See also :hg:`help subrepos`.
 
 Security note: auditing in Mercurial is known to be insufficient to
 prevent clone-time code execution with carefully constructed Git
 subrepos. It is unknown if a similar detect is present in Subversion
 subrepos. Both Git and Subversion subrepos are disabled by default
 out of security concerns. These subrepo types can be enabled using
 the respective options below.
 
 ``allowed``
     Whether subrepositories are allowed in the working directory.
 
     When false, commands involving subrepositories (like :hg:`update`)
     will fail for all subrepository types.
     (default: true)
 
 ``hg:allowed``
     Whether Mercurial subrepositories are allowed in the working
     directory. This option only has an effect if ``subrepos.allowed``
     is true.
     (default: true)
 
 ``git:allowed``
     Whether Git subrepositories are allowed in the working directory.
     This option only has an effect if ``subrepos.allowed`` is true.
 
     See the security note above before enabling Git subrepos.
     (default: false)
 
 ``svn:allowed``
     Whether Subversion subrepositories are allowed in the working
     directory. This option only has an effect if ``subrepos.allowed``
     is true.
 
     See the security note above before enabling Subversion subrepos.
     (default: false)
 
 ``templatealias``
 -----------------
 
 Alias definitions for templates. See :hg:`help templates` for details.
 
 ``templates``
 -------------
 
 Use the ``[templates]`` section to define template strings.
 See :hg:`help templates` for details.
 
 ``trusted``
 -----------
 
 Mercurial will not use the settings in the
 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
 user or to a trusted group, as various hgrc features allow arbitrary
 commands to be run. This issue is often encountered when configuring
 hooks or extensions for shared repositories or servers. However,
 the web interface will use some safe settings from the ``[web]``
 section.
 
 This section specifies what users and groups are trusted. The
 current user is always trusted. To trust everybody, list a user or a
 group with name ``*``. These settings must be placed in an
 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
 user or service running Mercurial.
 
 ``users``
   Comma-separated list of trusted users.
 
 ``groups``
   Comma-separated list of trusted groups.
 
 
 ``ui``
 ------
 
 User interface controls.
 
 ``archivemeta``
     Whether to include the .hg_archival.txt file containing meta data
     (hashes for the repository base and for tip) in archives created
     by the :hg:`archive` command or downloaded via hgweb.
     (default: True)
 
 ``askusername``
     Whether to prompt for a username when committing. If True, and
     neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
     be prompted to enter a username. If no username is entered, the
     default ``USER@HOST`` is used instead.
     (default: False)
 
 ``clonebundles``
     Whether the "clone bundles" feature is enabled.
 
     When enabled, :hg:`clone` may download and apply a server-advertised
     bundle file from a URL instead of using the normal exchange mechanism.
 
     This can likely result in faster and more reliable clones.
 
     (default: True)
 
 ``clonebundlefallback``
     Whether failure to apply an advertised "clone bundle" from a server
     should result in fallback to a regular clone.
 
     This is disabled by default because servers advertising "clone
     bundles" often do so to reduce server load. If advertised bundles
     start mass failing and clients automatically fall back to a regular
     clone, this would add significant and unexpected load to the server
     since the server is expecting clone operations to be offloaded to
     pre-generated bundles. Failing fast (the default behavior) ensures
     clients don't overwhelm the server when "clone bundle" application
     fails.
 
     (default: False)
 
 ``clonebundleprefers``
     Defines preferences for which "clone bundles" to use.
 
     Servers advertising "clone bundles" may advertise multiple available
     bundles. Each bundle may have different attributes, such as the bundle
     type and compression format. This option is used to prefer a particular
     bundle over another.
 
     The following keys are defined by Mercurial:
 
     BUNDLESPEC
        A bundle type specifier. These are strings passed to :hg:`bundle -t`.
        e.g. ``gzip-v2`` or ``bzip2-v1``.
 
     COMPRESSION
        The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
 
     Server operators may define custom keys.
 
     Example values: ``COMPRESSION=bzip2``,
     ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
 
     By default, the first bundle advertised by the server is used.
 
 ``color``
     When to colorize output. Possible value are Boolean ("yes" or "no"), or
     "debug", or "always". (default: "yes"). "yes" will use color whenever it
     seems possible. See :hg:`help color` for details.
 
 ``commitsubrepos``
     Whether to commit modified subrepositories when committing the
     parent repository. If False and one subrepository has uncommitted
     changes, abort the commit.
     (default: False)
 
 ``debug``
     Print debugging information. (default: False)
 
 ``editor``
     The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
 
 ``fallbackencoding``
     Encoding to try if it's not possible to decode the changelog using
     UTF-8. (default: ISO-8859-1)
 
 ``graphnodetemplate``
     (DEPRECATED) Use ``command-templates.graphnode`` instead.
 
 ``ignore``
     A file to read per-user ignore patterns from. This file should be
     in the same format as a repository-wide .hgignore file. Filenames
     are relative to the repository root. This option supports hook syntax,
     so if you want to specify multiple ignore files, you can do so by
     setting something like ``ignore.other = ~/.hgignore2``. For details
     of the ignore file format, see the ``hgignore(5)`` man page.
 
 ``interactive``
     Allow to prompt the user. (default: True)
 
 ``interface``
     Select the default interface for interactive features (default: text).
     Possible values are 'text' and 'curses'.
 
 ``interface.chunkselector``
     Select the interface for change recording (e.g. :hg:`commit -i`).
     Possible values are 'text' and 'curses'.
     This config overrides the interface specified by ui.interface.
 
 ``large-file-limit``
     Largest file size that gives no memory use warning.
     Possible values are integers or 0 to disable the check.
     Value is expressed in bytes by default, one can use standard units for
     convenience (e.g. 10MB, 0.1GB, etc) (default: 10MB)
 
 ``logtemplate``
     (DEPRECATED) Use ``command-templates.log`` instead.
 
 ``merge``
     The conflict resolution program to use during a manual merge.
     For more information on merge tools see :hg:`help merge-tools`.
     For configuring merge tools see the ``[merge-tools]`` section.
 
 ``mergemarkers``
     Sets the merge conflict marker label styling. The ``detailed`` style
     uses the ``command-templates.mergemarker`` setting to style the labels.
     The ``basic`` style just uses 'local' and 'other' as the marker label.
     One of ``basic`` or ``detailed``.
     (default: ``basic``)
 
 ``mergemarkertemplate``
     (DEPRECATED) Use ``command-templates.mergemarker`` instead.
 
 ``message-output``
     Where to write status and error messages. (default: ``stdio``)
 
     ``channel``
       Use separate channel for structured output. (Command-server only)
     ``stderr``
       Everything to stderr.
     ``stdio``
       Status to stdout, and error to stderr.
 
 ``origbackuppath``
     The path to a directory used to store generated .orig files. If the path is
     not a directory, one will be created.  If set, files stored in this
     directory have the same name as the original file and do not have a .orig
     suffix.
 
 ``paginate``
   Control the pagination of command output (default: True). See :hg:`help pager`
   for details.
 
 ``patch``
     An optional external tool that ``hg import`` and some extensions
     will use for applying patches. By default Mercurial uses an
     internal patch utility. The external tool must work as the common
     Unix ``patch`` program. In particular, it must accept a ``-p``
     argument to strip patch headers, a ``-d`` argument to specify the
     current directory, a file name to patch, and a patch file to take
     from stdin.
 
     It is possible to specify a patch tool together with extra
     arguments. For example, setting this option to ``patch --merge``
     will use the ``patch`` program with its 2-way merge option.
 
 ``portablefilenames``
     Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
     (default: ``warn``)
 
     ``warn``
       Print a warning message on POSIX platforms, if a file with a non-portable
       filename is added (e.g. a file with a name that can't be created on
       Windows because it contains reserved parts like ``AUX``, reserved
       characters like ``:``, or would cause a case collision with an existing
       file).
 
     ``ignore``
       Don't print a warning.
 
     ``abort``
       The command is aborted.
 
     ``true``
       Alias for ``warn``.
 
     ``false``
       Alias for ``ignore``.
 
     .. container:: windows
 
       On Windows, this configuration option is ignored and the command aborted.
 
 ``pre-merge-tool-output-template``
     (DEPRECATED) Use ``command-template.pre-merge-tool-output`` instead.
 
 ``quiet``
     Reduce the amount of output printed.
     (default: False)
 
 ``relative-paths``
     Prefer relative paths in the UI.
 
 ``remotecmd``
     Remote command to use for clone/push/pull operations.
     (default: ``hg``)
 
 ``report_untrusted``
     Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
     trusted user or group.
     (default: True)
 
 ``slash``
     (Deprecated. Use ``slashpath`` template filter instead.)
 
     Display paths using a slash (``/``) as the path separator. This
     only makes a difference on systems where the default path
     separator is not the slash character (e.g. Windows uses the
     backslash character (``\``)).
     (default: False)
 
 ``statuscopies``
     Display copies in the status command.
 
 ``ssh``
     Command to use for SSH connections. (default: ``ssh``)
 
 ``ssherrorhint``
     A hint shown to the user in the case of SSH error (e.g.
     ``Please see http://company/internalwiki/ssh.html``)
 
 ``strict``
     Require exact command names, instead of allowing unambiguous
     abbreviations. (default: False)
 
 ``style``
     Name of style to use for command output.
 
 ``supportcontact``
     A URL where users should report a Mercurial traceback. Use this if you are a
     large organisation with its own Mercurial deployment process and crash
     reports should be addressed to your internal support.
 
 ``textwidth``
     Maximum width of help text. A longer line generated by ``hg help`` or
     ``hg subcommand --help`` will be broken after white space to get this
     width or the terminal width, whichever comes first.
     A non-positive value will disable this and the terminal width will be
     used. (default: 78)
 
 ``timeout``
     The timeout used when a lock is held (in seconds), a negative value
     means no timeout. (default: 600)
 
 ``timeout.warn``
     Time (in seconds) before a warning is printed about held lock. A negative
     value means no warning. (default: 0)
 
 ``traceback``
     Mercurial always prints a traceback when an unknown exception
     occurs. Setting this to True will make Mercurial print a traceback
     on all exceptions, even those recognized by Mercurial (such as
     IOError or MemoryError). (default: False)
 
 ``tweakdefaults``
 
     By default Mercurial's behavior changes very little from release
     to release, but over time the recommended config settings
     shift. Enable this config to opt in to get automatic tweaks to
     Mercurial's behavior over time. This config setting will have no
     effect if ``HGPLAIN`` is set or ``HGPLAINEXCEPT`` is set and does
     not include ``tweakdefaults``. (default: False)
 
     It currently means::
 
       .. tweakdefaultsmarker
 
 ``username``
     The committer of a changeset created when running "commit".
     Typically a person's name and email address, e.g. ``Fred Widget
     <[e-mail]>``. Environment variables in the
     username are expanded.
 
     (default: ``$EMAIL`` or ``username@hostname``. If the username in
     hgrc is empty, e.g. if the system admin set ``username =`` in the
     system hgrc, it has to be specified manually or in a different
     hgrc file)
 
 ``verbose``
     Increase the amount of output printed. (default: False)
 
 
 ``command-templates``
 ---------------------
 
 Templates used for customizing the output of commands.
 
 ``graphnode``
     The template used to print changeset nodes in an ASCII revision graph.
     (default: ``{graphnode}``)
 
 ``log``
     Template string for commands that print changesets.
 
 ``mergemarker``
     The template used to print the commit description next to each conflict
     marker during merge conflicts. See :hg:`help templates` for the template
     format.
 
     Defaults to showing the hash, tags, branches, bookmarks, author, and
     the first line of the commit description.
 
     If you use non-ASCII characters in names for tags, branches, bookmarks,
     authors, and/or commit descriptions, you must pay attention to encodings of
     managed files. At template expansion, non-ASCII characters use the encoding
     specified by the ``--encoding`` global option, ``HGENCODING`` or other
     environment variables that govern your locale. If the encoding of the merge
     markers is different from the encoding of the merged files,
     serious problems may occur.
 
     Can be overridden per-merge-tool, see the ``[merge-tools]`` section.
 
 ``oneline-summary``
     A template used by `hg rebase` and other commands for showing a one-line
     summary of a commit. If the template configured here is longer than one
     line, then only the first line is used.
 
     The template can be overridden per command by defining a template in
     `oneline-summary.<command>`, where `<command>` can be e.g. "rebase".
 
 ``pre-merge-tool-output``
     A template that is printed before executing an external merge tool. This can
     be used to print out additional context that might be useful to have during
     the conflict resolution, such as the description of the various commits
     involved or bookmarks/tags.
 
     Additional information is available in the ``local`, ``base``, and ``other``
     dicts. For example: ``{local.label}``, ``{base.name}``, or
     ``{other.islink}``.
 
 
 ``web``
 -------
 
 Web interface configuration. The settings in this section apply to
 both the builtin webserver (started by :hg:`serve`) and the script you
 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
 and WSGI).
 
 The Mercurial webserver does no authentication (it does not prompt for
 usernames and passwords to validate *who* users are), but it does do
 authorization (it grants or denies access for *authenticated users*
 based on settings in this section). You must either configure your
 webserver to do authentication for you, or disable the authorization
 checks.
 
 For a quick setup in a trusted environment, e.g., a private LAN, where
 you want it to accept pushes from anybody, you can use the following
 command line::
 
     $ hg --config web.allow-push=* --config web.push_ssl=False serve
 
 Note that this will allow anybody to push anything to the server and
 that this should not be used for public servers.
 
 The full set of options is:
 
 ``accesslog``
     Where to output the access log. (default: stdout)
 
 ``address``
     Interface address to bind to. (default: all)
 
 ``allow-archive``
     List of archive format (bz2, gz, zip) allowed for downloading.
     (default: empty)
 
 ``allowbz2``
     (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
     revisions.
     (default: False)
 
 ``allowgz``
     (DEPRECATED) Whether to allow .tar.gz downloading of repository
     revisions.
     (default: False)
 
 ``allow-pull``
     Whether to allow pulling from the repository. (default: True)
 
 ``allow-push``
     Whether to allow pushing to the repository. If empty or not set,
     pushing is not allowed. If the special value ``*``, any remote
     user can push, including unauthenticated users. Otherwise, the
     remote user must have been authenticated, and the authenticated
     user name must be present in this list. The contents of the
     allow-push list are examined after the deny_push list.
 
 ``allow_read``
     If the user has not already been denied repository access due to
     the contents of deny_read, this list determines whether to grant
     repository access to the user. If this list is not empty, and the
     user is unauthenticated or not present in the list, then access is
     denied for the user. If the list is empty or not set, then access
     is permitted to all users by default. Setting allow_read to the
     special value ``*`` is equivalent to it not being set (i.e. access
     is permitted to all users). The contents of the allow_read list are
     examined after the deny_read list.
 
 ``allowzip``
     (DEPRECATED) Whether to allow .zip downloading of repository
     revisions. This feature creates temporary files.
     (default: False)
 
 ``archivesubrepos``
     Whether to recurse into subrepositories when archiving.
     (default: False)
 
 ``baseurl``
     Base URL to use when publishing URLs in other locations, so
     third-party tools like email notification hooks can construct
     URLs. Example: ``http://hgserver/repos/``.
 
 ``cacerts``
     Path to file containing a list of PEM encoded certificate
     authority certificates. Environment variables and ``~user``
     constructs are expanded in the filename. If specified on the
     client, then it will verify the identity of remote HTTPS servers
     with these certificates.
 
     To disable SSL verification temporarily, specify ``--insecure`` from
     command line.
 
     You can use OpenSSL's CA certificate file if your platform has
     one. On most Linux systems this will be
     ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
     generate this file manually. The form must be as follows::
 
         -----BEGIN CERTIFICATE-----
         ... (certificate in base64 PEM encoding) ...
         -----END CERTIFICATE-----
         -----BEGIN CERTIFICATE-----
         ... (certificate in base64 PEM encoding) ...
         -----END CERTIFICATE-----
 
 ``cache``
     Whether to support caching in hgweb. (default: True)
 
 ``certificate``
     Certificate to use when running :hg:`serve`.
 
 ``collapse``
     With ``descend`` enabled, repositories in subdirectories are shown at
     a single level alongside repositories in the current path. With
     ``collapse`` also enabled, repositories residing at a deeper level than
     the current path are grouped behind navigable directory entries that
     lead to the locations of these repositories. In effect, this setting
     collapses each collection of repositories found within a subdirectory
     into a single entry for that subdirectory. (default: False)
 
 ``comparisoncontext``
     Number of lines of context to show in side-by-side file comparison. If
     negative or the value ``full``, whole files are shown. (default: 5)
 
     This setting can be overridden by a ``context`` request parameter to the
     ``comparison`` command, taking the same values.
 
 ``contact``
     Name or email address of the person in charge of the repository.
     (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
 
 ``csp``
     Send a ``Content-Security-Policy`` HTTP header with this value.
 
     The value may contain a special string ``%nonce%``, which will be replaced
     by a randomly-generated one-time use value. If the value contains
     ``%nonce%``, ``web.cache`` will be disabled, as caching undermines the
     one-time property of the nonce. This nonce will also be inserted into
     ``<script>`` elements containing inline JavaScript.
 
     Note: lots of HTML content sent by the server is derived from repository
     data. Please consider the potential for malicious repository data to
     "inject" itself into generated HTML content as part of your security
     threat model.
 
 ``deny_push``
     Whether to deny pushing to the repository. If empty or not set,
     push is not denied. If the special value ``*``, all remote users are
     denied push. Otherwise, unauthenticated users are all denied, and
     any authenticated user name present in this list is also denied. The
     contents of the deny_push list are examined before the allow-push list.
 
 ``deny_read``
     Whether to deny reading/viewing of the repository. If this list is
     not empty, unauthenticated users are all denied, and any
     authenticated user name present in this list is also denied access to
     the repository. If set to the special value ``*``, all remote users
     are denied access (rarely needed ;). If deny_read is empty or not set,
     the determination of repository access depends on the presence and
     content of the allow_read list (see description). If both
     deny_read and allow_read are empty or not set, then access is
     permitted to all users by default. If the repository is being
     served via hgwebdir, denied users will not be able to see it in
     the list of repositories. The contents of the deny_read list have
     priority over (are examined before) the contents of the allow_read
     list.
 
 ``descend``
     hgwebdir indexes will not descend into subdirectories. Only repositories
     directly in the current path will be shown (other repositories are still
     available from the index corresponding to their containing path).
 
 ``description``
     Textual description of the repository's purpose or contents.
     (default: "unknown")
 
 ``encoding``
     Character encoding name. (default: the current locale charset)
     Example: "UTF-8".
 
 ``errorlog``
     Where to output the error log. (default: stderr)
 
 ``guessmime``
     Control MIME types for raw download of file content.
     Set to True to let hgweb guess the content type from the file
     extension. This will serve HTML files as ``text/html`` and might
     allow cross-site scripting attacks when serving untrusted
     repositories. (default: False)
 
 ``hidden``
     Whether to hide the repository in the hgwebdir index.
     (default: False)
 
 ``ipv6``
     Whether to use IPv6. (default: False)
 
 ``labels``
     List of string *labels* associated with the repository.
 
     Labels are exposed as a template keyword and can be used to customize
     output. e.g. the ``index`` template can group or filter repositories
     by labels and the ``summary`` template can display additional content
     if a specific label is present.
 
 ``logoimg``
     File name of the logo image that some templates display on each page.
     The file name is relative to ``staticurl``. That is, the full path to
     the logo image is "staticurl/logoimg".
     If unset, ``hglogo.png`` will be used.
 
 ``logourl``
     Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
     will be used.
 
 ``maxchanges``
     Maximum number of changes to list on the changelog. (default: 10)
 
 ``maxfiles``
     Maximum number of files to list per changeset. (default: 10)
 
 ``maxshortchanges``
     Maximum number of changes to list on the shortlog, graph or filelog
     pages. (default: 60)
 
 ``name``
     Repository name to use in the web interface.
     (default: current working directory)
 
 ``port``
     Port to listen on. (default: 8000)
 
 ``prefix``
     Prefix path to serve from. (default: '' (server root))
 
 ``push_ssl``
     Whether to require that inbound pushes be transported over SSL to
     prevent password sniffing. (default: True)
 
 ``refreshinterval``
     How frequently directory listings re-scan the filesystem for new
     repositories, in seconds. This is relevant when wildcards are used
     to define paths. Depending on how much filesystem traversal is
     required, refreshing may negatively impact performance.
 
     Values less than or equal to 0 always refresh.
     (default: 20)
 
 ``server-header``
     Value for HTTP ``Server`` response header.
 
 ``static``
     Directory where static files are served from.
 
 ``staticurl``
     Base URL to use for static files. If unset, static files (e.g. the
     hgicon.png favicon) will be served by the CGI script itself. Use
     this setting to serve them directly with the HTTP server.
     Example: ``http://hgserver/static/``.
 
 ``stripes``
     How many lines a "zebra stripe" should span in multi-line output.
     Set to 0 to disable. (default: 1)
 
 ``style``
     Which template map style to use. The available options are the names of
     subdirectories in the HTML templates path. (default: ``paper``)
     Example: ``monoblue``.
 
 ``templates``
     Where to find the HTML templates. The default path to the HTML templates
     can be obtained from ``hg debuginstall``.
 
 ``websub``
 ----------
 
 Web substitution filter definition. You can use this section to
 define a set of regular expression substitution patterns which
 let you automatically modify the hgweb server output.
 
 The default hgweb templates only apply these substitution patterns
 on the revision description fields. You can apply them anywhere
 you want when you create your own templates by adding calls to the
 "websub" filter (usually after calling the "escape" filter).
 
 This can be used, for example, to convert issue references to links
 to your issue tracker, or to convert "markdown-like" syntax into
 HTML (see the examples below).
 
 Each entry in this section names a substitution filter.
 The value of each entry defines the substitution expression itself.
 The websub expressions follow the old interhg extension syntax,
 which in turn imitates the Unix sed replacement syntax::
 
     patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
 
 You can use any separator other than "/". The final "i" is optional
 and indicates that the search must be case insensitive.
 
 Examples::
 
     [websub]
     issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
     italic = s/\b_(\S+)_\b/<i>\1<\/i>/
     bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
 
 ``worker``
 ----------
 
 Parallel master/worker configuration. We currently perform working
 directory updates in parallel on Unix-like systems, which greatly
 helps performance.
 
 ``enabled``
     Whether to enable workers code to be used.
     (default: true)
 
 ``numcpus``
     Number of CPUs to use for parallel operations. A zero or
     negative value is treated as ``use the default``.
     (default: 4 or the number of CPUs on the system, whichever is larger)
 
 ``backgroundclose``
     Whether to enable closing file handles on background threads during certain
     operations. Some platforms aren't very efficient at closing file
     handles that have been written or appended to. By performing file closing
     on background threads, file write rate can increase substantially.
     (default: true on Windows, false elsewhere)
 
 ``backgroundcloseminfilecount``
     Minimum number of files required to trigger background file closing.
     Operations not writing this many files won't start background close
     threads.
     (default: 2048)
 
 ``backgroundclosemaxqueue``
     The maximum number of opened file handles waiting to be closed in the
     background. This option only has an effect if ``backgroundclose`` is
     enabled.
     (default: 384)
 
 ``backgroundclosethreadcount``
     Number of threads to process background file closes. Only relevant if
     ``backgroundclose`` is enabled.
     (default: 4)

mercurial/localrepo.py

@@ -1,3973 +1,3978 b''
 # localrepo.py - read/write repository class for mercurial
 # coding: utf-8
 #
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 import functools
 import os
 import random
 import sys
 import time
 import weakref
 
 from concurrent import futures
 from typing import (
     Optional,
 )
 
 from .i18n import _
 from .node import (
     bin,
     hex,
     nullrev,
     sha1nodeconstants,
     short,
 )
 from .pycompat import (
     delattr,
     getattr,
 )
 from . import (
     bookmarks,
     branchmap,
     bundle2,
     bundlecaches,
     changegroup,
     color,
     commit,
     context,
     dirstate,
     dirstateguard,
     discovery,
     encoding,
     error,
     exchange,
     extensions,
     filelog,
     hook,
     lock as lockmod,
     match as matchmod,
     mergestate as mergestatemod,
     mergeutil,
     namespaces,
     narrowspec,
     obsolete,
     pathutil,
     phases,
     pushkey,
     pycompat,
     rcutil,
     repoview,
     requirements as requirementsmod,
     revlog,
     revset,
     revsetlang,
     scmutil,
     sparse,
     store as storemod,
     subrepoutil,
     tags as tagsmod,
     transaction,
     txnutil,
     util,
     vfs as vfsmod,
     wireprototypes,
 )
 
 from .interfaces import (
     repository,
     util as interfaceutil,
 )
 
 from .utils import (
     hashutil,
     procutil,
     stringutil,
     urlutil,
 )
 
 from .revlogutils import (
     concurrency_checker as revlogchecker,
     constants as revlogconst,
     sidedata as sidedatamod,
 )
 
 release = lockmod.release
 urlerr = util.urlerr
 urlreq = util.urlreq
 
 # set of (path, vfs-location) tuples. vfs-location is:
 # - 'plain for vfs relative paths
 # - '' for svfs relative paths
 _cachedfiles = set()
 
 
 class _basefilecache(scmutil.filecache):
     """All filecache usage on repo are done for logic that should be unfiltered"""
 
     def __get__(self, repo, type=None):
         if repo is None:
             return self
         # proxy to unfiltered __dict__ since filtered repo has no entry
         unfi = repo.unfiltered()
         try:
             return unfi.__dict__[self.sname]
         except KeyError:
             pass
         return super(_basefilecache, self).__get__(unfi, type)
 
     def set(self, repo, value):
         return super(_basefilecache, self).set(repo.unfiltered(), value)
 
 
 class repofilecache(_basefilecache):
     """filecache for files in .hg but outside of .hg/store"""
 
     def __init__(self, *paths):
         super(repofilecache, self).__init__(*paths)
         for path in paths:
             _cachedfiles.add((path, b'plain'))
 
     def join(self, obj, fname):
         return obj.vfs.join(fname)
 
 
 class storecache(_basefilecache):
     """filecache for files in the store"""
 
     def __init__(self, *paths):
         super(storecache, self).__init__(*paths)
         for path in paths:
             _cachedfiles.add((path, b''))
 
     def join(self, obj, fname):
         return obj.sjoin(fname)
 
 
 class changelogcache(storecache):
     """filecache for the changelog"""
 
     def __init__(self):
         super(changelogcache, self).__init__()
         _cachedfiles.add((b'00changelog.i', b''))
         _cachedfiles.add((b'00changelog.n', b''))
 
     def tracked_paths(self, obj):
         paths = [self.join(obj, b'00changelog.i')]
         if obj.store.opener.options.get(b'persistent-nodemap', False):
             paths.append(self.join(obj, b'00changelog.n'))
         return paths
 
 
 class manifestlogcache(storecache):
     """filecache for the manifestlog"""
 
     def __init__(self):
         super(manifestlogcache, self).__init__()
         _cachedfiles.add((b'00manifest.i', b''))
         _cachedfiles.add((b'00manifest.n', b''))
 
     def tracked_paths(self, obj):
         paths = [self.join(obj, b'00manifest.i')]
         if obj.store.opener.options.get(b'persistent-nodemap', False):
             paths.append(self.join(obj, b'00manifest.n'))
         return paths
 
 
 class mixedrepostorecache(_basefilecache):
     """filecache for a mix files in .hg/store and outside"""
 
     def __init__(self, *pathsandlocations):
         # scmutil.filecache only uses the path for passing back into our
         # join(), so we can safely pass a list of paths and locations
         super(mixedrepostorecache, self).__init__(*pathsandlocations)
         _cachedfiles.update(pathsandlocations)
 
     def join(self, obj, fnameandlocation):
         fname, location = fnameandlocation
         if location == b'plain':
             return obj.vfs.join(fname)
         else:
             if location != b'':
                 raise error.ProgrammingError(
                     b'unexpected location: %s' % location
                 )
             return obj.sjoin(fname)
 
 
 def isfilecached(repo, name):
     """check if a repo has already cached "name" filecache-ed property
 
     This returns (cachedobj-or-None, iscached) tuple.
     """
     cacheentry = repo.unfiltered()._filecache.get(name, None)
     if not cacheentry:
         return None, False
     return cacheentry.obj, True
 
 
 class unfilteredpropertycache(util.propertycache):
     """propertycache that apply to unfiltered repo only"""
 
     def __get__(self, repo, type=None):
         unfi = repo.unfiltered()
         if unfi is repo:
             return super(unfilteredpropertycache, self).__get__(unfi)
         return getattr(unfi, self.name)
 
 
 class filteredpropertycache(util.propertycache):
     """propertycache that must take filtering in account"""
 
     def cachevalue(self, obj, value):
         object.__setattr__(obj, self.name, value)
 
 
 def hasunfilteredcache(repo, name):
     """check if a repo has an unfilteredpropertycache value for <name>"""
     return name in vars(repo.unfiltered())
 
 
 def unfilteredmethod(orig):
     """decorate method that always need to be run on unfiltered version"""
 
     @functools.wraps(orig)
     def wrapper(repo, *args, **kwargs):
         return orig(repo.unfiltered(), *args, **kwargs)
 
     return wrapper
 
 
 moderncaps = {
     b'lookup',
     b'branchmap',
     b'pushkey',
     b'known',
     b'getbundle',
     b'unbundle',
 }
 legacycaps = moderncaps.union({b'changegroupsubset'})
 
 
 @interfaceutil.implementer(repository.ipeercommandexecutor)
 class localcommandexecutor:
     def __init__(self, peer):
         self._peer = peer
         self._sent = False
         self._closed = False
 
     def __enter__(self):
         return self
 
     def __exit__(self, exctype, excvalue, exctb):
         self.close()
 
     def callcommand(self, command, args):
         if self._sent:
             raise error.ProgrammingError(
                 b'callcommand() cannot be used after sendcommands()'
             )
 
         if self._closed:
             raise error.ProgrammingError(
                 b'callcommand() cannot be used after close()'
             )
 
         # We don't need to support anything fancy. Just call the named
         # method on the peer and return a resolved future.
         fn = getattr(self._peer, pycompat.sysstr(command))
 
         f = futures.Future()
 
         try:
             result = fn(**pycompat.strkwargs(args))
         except Exception:
             pycompat.future_set_exception_info(f, sys.exc_info()[1:])
         else:
             f.set_result(result)
 
         return f
 
     def sendcommands(self):
         self._sent = True
 
     def close(self):
         self._closed = True
 
 
 @interfaceutil.implementer(repository.ipeercommands)
 class localpeer(repository.peer):
     '''peer for a local repo; reflects only the most recent API'''
 
     def __init__(self, repo, caps=None):
         super(localpeer, self).__init__()
 
         if caps is None:
             caps = moderncaps.copy()
         self._repo = repo.filtered(b'served')
         self.ui = repo.ui
 
         if repo._wanted_sidedata:
             formatted = bundle2.format_remote_wanted_sidedata(repo)
             caps.add(b'exp-wanted-sidedata=' + formatted)
 
         self._caps = repo._restrictcapabilities(caps)
 
     # Begin of _basepeer interface.
 
     def url(self):
         return self._repo.url()
 
     def local(self):
         return self._repo
 
     def peer(self):
         return self
 
     def canpush(self):
         return True
 
     def close(self):
         self._repo.close()
 
     # End of _basepeer interface.
 
     # Begin of _basewirecommands interface.
 
     def branchmap(self):
         return self._repo.branchmap()
 
     def capabilities(self):
         return self._caps
 
     def clonebundles(self):
         return self._repo.tryread(bundlecaches.CB_MANIFEST_FILE)
 
     def debugwireargs(self, one, two, three=None, four=None, five=None):
         """Used to test argument passing over the wire"""
         return b"%s %s %s %s %s" % (
             one,
             two,
             pycompat.bytestr(three),
             pycompat.bytestr(four),
             pycompat.bytestr(five),
         )
 
     def getbundle(
         self,
         source,
         heads=None,
         common=None,
         bundlecaps=None,
         remote_sidedata=None,
         **kwargs
     ):
         chunks = exchange.getbundlechunks(
             self._repo,
             source,
             heads=heads,
             common=common,
             bundlecaps=bundlecaps,
             remote_sidedata=remote_sidedata,
             **kwargs
         )[1]
         cb = util.chunkbuffer(chunks)
 
         if exchange.bundle2requested(bundlecaps):
             # When requesting a bundle2, getbundle returns a stream to make the
             # wire level function happier. We need to build a proper object
             # from it in local peer.
             return bundle2.getunbundler(self.ui, cb)
         else:
             return changegroup.getunbundler(b'01', cb, None)
 
     def heads(self):
         return self._repo.heads()
 
     def known(self, nodes):
         return self._repo.known(nodes)
 
     def listkeys(self, namespace):
         return self._repo.listkeys(namespace)
 
     def lookup(self, key):
         return self._repo.lookup(key)
 
     def pushkey(self, namespace, key, old, new):
         return self._repo.pushkey(namespace, key, old, new)
 
     def stream_out(self):
         raise error.Abort(_(b'cannot perform stream clone against local peer'))
 
     def unbundle(self, bundle, heads, url):
         """apply a bundle on a repo
 
         This function handles the repo locking itself."""
         try:
             try:
                 bundle = exchange.readbundle(self.ui, bundle, None)
                 ret = exchange.unbundle(self._repo, bundle, heads, b'push', url)
                 if util.safehasattr(ret, b'getchunks'):
                     # This is a bundle20 object, turn it into an unbundler.
                     # This little dance should be dropped eventually when the
                     # API is finally improved.
                     stream = util.chunkbuffer(ret.getchunks())
                     ret = bundle2.getunbundler(self.ui, stream)
                 return ret
             except Exception as exc:
                 # If the exception contains output salvaged from a bundle2
                 # reply, we need to make sure it is printed before continuing
                 # to fail. So we build a bundle2 with such output and consume
                 # it directly.
                 #
                 # This is not very elegant but allows a "simple" solution for
                 # issue4594
                 output = getattr(exc, '_bundle2salvagedoutput', ())
                 if output:
                     bundler = bundle2.bundle20(self._repo.ui)
                     for out in output:
                         bundler.addpart(out)
                     stream = util.chunkbuffer(bundler.getchunks())
                     b = bundle2.getunbundler(self.ui, stream)
                     bundle2.processbundle(self._repo, b)
                 raise
         except error.PushRaced as exc:
             raise error.ResponseError(
                 _(b'push failed:'), stringutil.forcebytestr(exc)
             )
 
     # End of _basewirecommands interface.
 
     # Begin of peer interface.
 
     def commandexecutor(self):
         return localcommandexecutor(self)
 
     # End of peer interface.
 
 
 @interfaceutil.implementer(repository.ipeerlegacycommands)
 class locallegacypeer(localpeer):
     """peer extension which implements legacy methods too; used for tests with
     restricted capabilities"""
 
     def __init__(self, repo):
         super(locallegacypeer, self).__init__(repo, caps=legacycaps)
 
     # Begin of baselegacywirecommands interface.
 
     def between(self, pairs):
         return self._repo.between(pairs)
 
     def branches(self, nodes):
         return self._repo.branches(nodes)
 
     def changegroup(self, nodes, source):
         outgoing = discovery.outgoing(
             self._repo, missingroots=nodes, ancestorsof=self._repo.heads()
         )
         return changegroup.makechangegroup(self._repo, outgoing, b'01', source)
 
     def changegroupsubset(self, bases, heads, source):
         outgoing = discovery.outgoing(
             self._repo, missingroots=bases, ancestorsof=heads
         )
         return changegroup.makechangegroup(self._repo, outgoing, b'01', source)
 
     # End of baselegacywirecommands interface.
 
 
 # Functions receiving (ui, features) that extensions can register to impact
 # the ability to load repositories with custom requirements. Only
 # functions defined in loaded extensions are called.
 #
 # The function receives a set of requirement strings that the repository
 # is capable of opening. Functions will typically add elements to the
 # set to reflect that the extension knows how to handle that requirements.
 featuresetupfuncs = set()
 
 
 def _getsharedvfs(hgvfs, requirements):
     """returns the vfs object pointing to root of shared source
     repo for a shared repository
 
     hgvfs is vfs pointing at .hg/ of current repo (shared one)
     requirements is a set of requirements of current repo (shared one)
     """
     # The ``shared`` or ``relshared`` requirements indicate the
     # store lives in the path contained in the ``.hg/sharedpath`` file.
     # This is an absolute path for ``shared`` and relative to
     # ``.hg/`` for ``relshared``.
     sharedpath = hgvfs.read(b'sharedpath').rstrip(b'\n')
     if requirementsmod.RELATIVE_SHARED_REQUIREMENT in requirements:
         sharedpath = util.normpath(hgvfs.join(sharedpath))
 
     sharedvfs = vfsmod.vfs(sharedpath, realpath=True)
 
     if not sharedvfs.exists():
         raise error.RepoError(
             _(b'.hg/sharedpath points to nonexistent directory %s')
             % sharedvfs.base
         )
     return sharedvfs
 
 
 def _readrequires(vfs, allowmissing):
     """reads the require file present at root of this vfs
     and return a set of requirements
 
     If allowmissing is True, we suppress FileNotFoundError if raised"""
     # requires file contains a newline-delimited list of
     # features/capabilities the opener (us) must have in order to use
     # the repository. This file was introduced in Mercurial 0.9.2,
     # which means very old repositories may not have one. We assume
     # a missing file translates to no requirements.
     read = vfs.tryread if allowmissing else vfs.read
     return set(read(b'requires').splitlines())
 
 
 def makelocalrepository(baseui, path: bytes, intents=None):
     """Create a local repository object.
 
     Given arguments needed to construct a local repository, this function
     performs various early repository loading functionality (such as
     reading the ``.hg/requires`` and ``.hg/hgrc`` files), validates that
     the repository can be opened, derives a type suitable for representing
     that repository, and returns an instance of it.
 
     The returned object conforms to the ``repository.completelocalrepository``
     interface.
 
     The repository type is derived by calling a series of factory functions
     for each aspect/interface of the final repository. These are defined by
     ``REPO_INTERFACES``.
 
     Each factory function is called to produce a type implementing a specific
     interface. The cumulative list of returned types will be combined into a
     new type and that type will be instantiated to represent the local
     repository.
 
     The factory functions each receive various state that may be consulted
     as part of deriving a type.
 
     Extensions should wrap these factory functions to customize repository type
     creation. Note that an extension's wrapped function may be called even if
     that extension is not loaded for the repo being constructed. Extensions
     should check if their ``__name__`` appears in the
     ``extensionmodulenames`` set passed to the factory function and no-op if
     not.
     """
     ui = baseui.copy()
     # Prevent copying repo configuration.
     ui.copy = baseui.copy
 
     # Working directory VFS rooted at repository root.
     wdirvfs = vfsmod.vfs(path, expandpath=True, realpath=True)
 
     # Main VFS for .hg/ directory.
     hgpath = wdirvfs.join(b'.hg')
     hgvfs = vfsmod.vfs(hgpath, cacheaudited=True)
     # Whether this repository is shared one or not
     shared = False
     # If this repository is shared, vfs pointing to shared repo
     sharedvfs = None
 
     # The .hg/ path should exist and should be a directory. All other
     # cases are errors.
     if not hgvfs.isdir():
         try:
             hgvfs.stat()
         except FileNotFoundError:
             pass
         except ValueError as e:
             # Can be raised on Python 3.8 when path is invalid.
             raise error.Abort(
                 _(b'invalid path %s: %s') % (path, stringutil.forcebytestr(e))
             )
 
         raise error.RepoError(_(b'repository %s not found') % path)
 
     requirements = _readrequires(hgvfs, True)
     shared = (
         requirementsmod.SHARED_REQUIREMENT in requirements
         or requirementsmod.RELATIVE_SHARED_REQUIREMENT in requirements
     )
     storevfs = None
     if shared:
         # This is a shared repo
         sharedvfs = _getsharedvfs(hgvfs, requirements)
         storevfs = vfsmod.vfs(sharedvfs.join(b'store'))
     else:
         storevfs = vfsmod.vfs(hgvfs.join(b'store'))
 
     # if .hg/requires contains the sharesafe requirement, it means
     # there exists a `.hg/store/requires` too and we should read it
     # NOTE: presence of SHARESAFE_REQUIREMENT imply that store requirement
     # is present. We never write SHARESAFE_REQUIREMENT for a repo if store
     # is not present, refer checkrequirementscompat() for that
     #
     # However, if SHARESAFE_REQUIREMENT is not present, it means that the
     # repository was shared the old way. We check the share source .hg/requires
     # for SHARESAFE_REQUIREMENT to detect whether the current repository needs
     # to be reshared
     hint = _(b"see `hg help config.format.use-share-safe` for more information")
     if requirementsmod.SHARESAFE_REQUIREMENT in requirements:
 
         if (
             shared
             and requirementsmod.SHARESAFE_REQUIREMENT
             not in _readrequires(sharedvfs, True)
         ):
             mismatch_warn = ui.configbool(
                 b'share', b'safe-mismatch.source-not-safe.warn'
             )
             mismatch_config = ui.config(
                 b'share', b'safe-mismatch.source-not-safe'
             )
             mismatch_verbose_upgrade = ui.configbool(
                 b'share', b'safe-mismatch.source-not-safe:verbose-upgrade'
             )
             if mismatch_config in (
                 b'downgrade-allow',
                 b'allow',
                 b'downgrade-abort',
             ):
                 # prevent cyclic import localrepo -> upgrade -> localrepo
                 from . import upgrade
 
                 upgrade.downgrade_share_to_non_safe(
                     ui,
                     hgvfs,
                     sharedvfs,
                     requirements,
                     mismatch_config,
                     mismatch_warn,
                     mismatch_verbose_upgrade,
                 )
             elif mismatch_config == b'abort':
                 raise error.Abort(
                     _(b"share source does not support share-safe requirement"),
                     hint=hint,
                 )
             else:
                 raise error.Abort(
                     _(
                         b"share-safe mismatch with source.\nUnrecognized"
                         b" value '%s' of `share.safe-mismatch.source-not-safe`"
                         b" set."
                     )
                     % mismatch_config,
                     hint=hint,
                 )
         else:
             requirements |= _readrequires(storevfs, False)
     elif shared:
         sourcerequires = _readrequires(sharedvfs, False)
         if requirementsmod.SHARESAFE_REQUIREMENT in sourcerequires:
             mismatch_config = ui.config(b'share', b'safe-mismatch.source-safe')
             mismatch_warn = ui.configbool(
                 b'share', b'safe-mismatch.source-safe.warn'
             )
             mismatch_verbose_upgrade = ui.configbool(
                 b'share', b'safe-mismatch.source-safe:verbose-upgrade'
             )
             if mismatch_config in (
                 b'upgrade-allow',
                 b'allow',
                 b'upgrade-abort',
             ):
                 # prevent cyclic import localrepo -> upgrade -> localrepo
                 from . import upgrade
 
                 upgrade.upgrade_share_to_safe(
                     ui,
                     hgvfs,
                     storevfs,
                     requirements,
                     mismatch_config,
                     mismatch_warn,
                     mismatch_verbose_upgrade,
                 )
             elif mismatch_config == b'abort':
                 raise error.Abort(
                     _(
                         b'version mismatch: source uses share-safe'
                         b' functionality while the current share does not'
                     ),
                     hint=hint,
                 )
             else:
                 raise error.Abort(
                     _(
                         b"share-safe mismatch with source.\nUnrecognized"
                         b" value '%s' of `share.safe-mismatch.source-safe` set."
                     )
                     % mismatch_config,
                     hint=hint,
                 )
 
     # The .hg/hgrc file may load extensions or contain config options
     # that influence repository construction. Attempt to load it and
     # process any new extensions that it may have pulled in.
     if loadhgrc(ui, wdirvfs, hgvfs, requirements, sharedvfs):
         afterhgrcload(ui, wdirvfs, hgvfs, requirements)
         extensions.loadall(ui)
         extensions.populateui(ui)
 
     # Set of module names of extensions loaded for this repository.
     extensionmodulenames = {m.__name__ for n, m in extensions.extensions(ui)}
 
     supportedrequirements = gathersupportedrequirements(ui)
 
     # We first validate the requirements are known.
     ensurerequirementsrecognized(requirements, supportedrequirements)
 
     # Then we validate that the known set is reasonable to use together.
     ensurerequirementscompatible(ui, requirements)
 
     # TODO there are unhandled edge cases related to opening repositories with
     # shared storage. If storage is shared, we should also test for requirements
     # compatibility in the pointed-to repo. This entails loading the .hg/hgrc in
     # that repo, as that repo may load extensions needed to open it. This is a
     # bit complicated because we don't want the other hgrc to overwrite settings
     # in this hgrc.
     #
     # This bug is somewhat mitigated by the fact that we copy the .hg/requires
     # file when sharing repos. But if a requirement is added after the share is
     # performed, thereby introducing a new requirement for the opener, we may
     # will not see that and could encounter a run-time error interacting with
     # that shared store since it has an unknown-to-us requirement.
 
     # At this point, we know we should be capable of opening the repository.
     # Now get on with doing that.
 
     features = set()
 
     # The "store" part of the repository holds versioned data. How it is
     # accessed is determined by various requirements. If `shared` or
     # `relshared` requirements are present, this indicates current repository
     # is a share and store exists in path mentioned in `.hg/sharedpath`
     if shared:
         storebasepath = sharedvfs.base
         cachepath = sharedvfs.join(b'cache')
         features.add(repository.REPO_FEATURE_SHARED_STORAGE)
     else:
         storebasepath = hgvfs.base
         cachepath = hgvfs.join(b'cache')
     wcachepath = hgvfs.join(b'wcache')
 
     # The store has changed over time and the exact layout is dictated by
     # requirements. The store interface abstracts differences across all
     # of them.
     store = makestore(
         requirements,
         storebasepath,
         lambda base: vfsmod.vfs(base, cacheaudited=True),
     )
     hgvfs.createmode = store.createmode
 
     storevfs = store.vfs
     storevfs.options = resolvestorevfsoptions(ui, requirements, features)
 
     if (
         requirementsmod.REVLOGV2_REQUIREMENT in requirements
         or requirementsmod.CHANGELOGV2_REQUIREMENT in requirements
     ):
         features.add(repository.REPO_FEATURE_SIDE_DATA)
         # the revlogv2 docket introduced race condition that we need to fix
         features.discard(repository.REPO_FEATURE_STREAM_CLONE)
 
     # The cache vfs is used to manage cache files.
     cachevfs = vfsmod.vfs(cachepath, cacheaudited=True)
     cachevfs.createmode = store.createmode
     # The cache vfs is used to manage cache files related to the working copy
     wcachevfs = vfsmod.vfs(wcachepath, cacheaudited=True)
     wcachevfs.createmode = store.createmode
 
     # Now resolve the type for the repository object. We do this by repeatedly
     # calling a factory function to produces types for specific aspects of the
     # repo's operation. The aggregate returned types are used as base classes
     # for a dynamically-derived type, which will represent our new repository.
 
     bases = []
     extrastate = {}
 
     for iface, fn in REPO_INTERFACES:
         # We pass all potentially useful state to give extensions tons of
         # flexibility.
         typ = fn()(
             ui=ui,
             intents=intents,
             requirements=requirements,
             features=features,
             wdirvfs=wdirvfs,
             hgvfs=hgvfs,
             store=store,
             storevfs=storevfs,
             storeoptions=storevfs.options,
             cachevfs=cachevfs,
             wcachevfs=wcachevfs,
             extensionmodulenames=extensionmodulenames,
             extrastate=extrastate,
             baseclasses=bases,
         )
 
         if not isinstance(typ, type):
             raise error.ProgrammingError(
                 b'unable to construct type for %s' % iface
             )
 
         bases.append(typ)
 
     # type() allows you to use characters in type names that wouldn't be
     # recognized as Python symbols in source code. We abuse that to add
     # rich information about our constructed repo.
     name = pycompat.sysstr(
         b'derivedrepo:%s<%s>' % (wdirvfs.base, b','.join(sorted(requirements)))
     )
 
     cls = type(name, tuple(bases), {})
 
     return cls(
         baseui=baseui,
         ui=ui,
         origroot=path,
         wdirvfs=wdirvfs,
         hgvfs=hgvfs,
         requirements=requirements,
         supportedrequirements=supportedrequirements,
         sharedpath=storebasepath,
         store=store,
         cachevfs=cachevfs,
         wcachevfs=wcachevfs,
         features=features,
         intents=intents,
     )
 
 
 def loadhgrc(
     ui,
     wdirvfs: vfsmod.vfs,
     hgvfs: vfsmod.vfs,
     requirements,
     sharedvfs: Optional[vfsmod.vfs] = None,
 ):
     """Load hgrc files/content into a ui instance.
 
     This is called during repository opening to load any additional
     config files or settings relevant to the current repository.
 
     Returns a bool indicating whether any additional configs were loaded.
 
     Extensions should monkeypatch this function to modify how per-repo
     configs are loaded. For example, an extension may wish to pull in
     configs from alternate files or sources.
 
     sharedvfs is vfs object pointing to source repo if the current one is a
     shared one
     """
     if not rcutil.use_repo_hgrc():
         return False
 
     ret = False
     # first load config from shared source if we has to
     if requirementsmod.SHARESAFE_REQUIREMENT in requirements and sharedvfs:
         try:
             ui.readconfig(sharedvfs.join(b'hgrc'), root=sharedvfs.base)
             ret = True
         except IOError:
             pass
 
     try:
         ui.readconfig(hgvfs.join(b'hgrc'), root=wdirvfs.base)
         ret = True
     except IOError:
         pass
 
     try:
         ui.readconfig(hgvfs.join(b'hgrc-not-shared'), root=wdirvfs.base)
         ret = True
     except IOError:
         pass
 
     return ret
 
 
 def afterhgrcload(ui, wdirvfs, hgvfs, requirements):
     """Perform additional actions after .hg/hgrc is loaded.
 
     This function is called during repository loading immediately after
     the .hg/hgrc file is loaded and before per-repo extensions are loaded.
 
     The function can be used to validate configs, automatically add
     options (including extensions) based on requirements, etc.
     """
 
     # Map of requirements to list of extensions to load automatically when
     # requirement is present.
     autoextensions = {
         b'git': [b'git'],
         b'largefiles': [b'largefiles'],
         b'lfs': [b'lfs'],
     }
 
     for requirement, names in sorted(autoextensions.items()):
         if requirement not in requirements:
             continue
 
         for name in names:
             if not ui.hasconfig(b'extensions', name):
                 ui.setconfig(b'extensions', name, b'', source=b'autoload')
 
 
 def gathersupportedrequirements(ui):
     """Determine the complete set of recognized requirements."""
     # Start with all requirements supported by this file.
     supported = set(localrepository._basesupported)
 
     # Execute ``featuresetupfuncs`` entries if they belong to an extension
     # relevant to this ui instance.
     modules = {m.__name__ for n, m in extensions.extensions(ui)}
 
     for fn in featuresetupfuncs:
         if fn.__module__ in modules:
             fn(ui, supported)
 
     # Add derived requirements from registered compression engines.
     for name in util.compengines:
         engine = util.compengines[name]
         if engine.available() and engine.revlogheader():
             supported.add(b'exp-compression-%s' % name)
             if engine.name() == b'zstd':
                 supported.add(requirementsmod.REVLOG_COMPRESSION_ZSTD)
 
     return supported
 
 
 def ensurerequirementsrecognized(requirements, supported):
     """Validate that a set of local requirements is recognized.
 
     Receives a set of requirements. Raises an ``error.RepoError`` if there
     exists any requirement in that set that currently loaded code doesn't
     recognize.
 
     Returns a set of supported requirements.
     """
     missing = set()
 
     for requirement in requirements:
         if requirement in supported:
             continue
 
         if not requirement or not requirement[0:1].isalnum():
             raise error.RequirementError(_(b'.hg/requires file is corrupt'))
 
         missing.add(requirement)
 
     if missing:
         raise error.RequirementError(
             _(b'repository requires features unknown to this Mercurial: %s')
             % b' '.join(sorted(missing)),
             hint=_(
                 b'see https://mercurial-scm.org/wiki/MissingRequirement '
                 b'for more information'
             ),
         )
 
 
 def ensurerequirementscompatible(ui, requirements):
     """Validates that a set of recognized requirements is mutually compatible.
 
     Some requirements may not be compatible with others or require
     config options that aren't enabled. This function is called during
     repository opening to ensure that the set of requirements needed
     to open a repository is sane and compatible with config options.
 
     Extensions can monkeypatch this function to perform additional
     checking.
 
     ``error.RepoError`` should be raised on failure.
     """
     if (
         requirementsmod.SPARSE_REQUIREMENT in requirements
         and not sparse.enabled
     ):
         raise error.RepoError(
             _(
                 b'repository is using sparse feature but '
                 b'sparse is not enabled; enable the '
                 b'"sparse" extensions to access'
             )
         )
 
 
 def makestore(requirements, path, vfstype):
     """Construct a storage object for a repository."""
     if requirementsmod.STORE_REQUIREMENT in requirements:
         if requirementsmod.FNCACHE_REQUIREMENT in requirements:
             dotencode = requirementsmod.DOTENCODE_REQUIREMENT in requirements
             return storemod.fncachestore(path, vfstype, dotencode)
 
         return storemod.encodedstore(path, vfstype)
 
     return storemod.basicstore(path, vfstype)
 
 
 def resolvestorevfsoptions(ui, requirements, features):
     """Resolve the options to pass to the store vfs opener.
 
     The returned dict is used to influence behavior of the storage layer.
     """
     options = {}
 
     if requirementsmod.TREEMANIFEST_REQUIREMENT in requirements:
         options[b'treemanifest'] = True
 
     # experimental config: format.manifestcachesize
     manifestcachesize = ui.configint(b'format', b'manifestcachesize')
     if manifestcachesize is not None:
         options[b'manifestcachesize'] = manifestcachesize
 
     # In the absence of another requirement superseding a revlog-related
     # requirement, we have to assume the repo is using revlog version 0.
     # This revlog format is super old and we don't bother trying to parse
     # opener options for it because those options wouldn't do anything
     # meaningful on such old repos.
     if (
         requirementsmod.REVLOGV1_REQUIREMENT in requirements
         or requirementsmod.REVLOGV2_REQUIREMENT in requirements
     ):
         options.update(resolverevlogstorevfsoptions(ui, requirements, features))
     else:  # explicitly mark repo as using revlogv0
         options[b'revlogv0'] = True
 
     if requirementsmod.COPIESSDC_REQUIREMENT in requirements:
         options[b'copies-storage'] = b'changeset-sidedata'
     else:
         writecopiesto = ui.config(b'experimental', b'copies.write-to')
         copiesextramode = (b'changeset-only', b'compatibility')
         if writecopiesto in copiesextramode:
             options[b'copies-storage'] = b'extra'
 
     return options
 
 
 def resolverevlogstorevfsoptions(ui, requirements, features):
     """Resolve opener options specific to revlogs."""
 
     options = {}
     options[b'flagprocessors'] = {}
 
     if requirementsmod.REVLOGV1_REQUIREMENT in requirements:
         options[b'revlogv1'] = True
     if requirementsmod.REVLOGV2_REQUIREMENT in requirements:
         options[b'revlogv2'] = True
     if requirementsmod.CHANGELOGV2_REQUIREMENT in requirements:
         options[b'changelogv2'] = True
 
     if requirementsmod.GENERALDELTA_REQUIREMENT in requirements:
         options[b'generaldelta'] = True
 
     # experimental config: format.chunkcachesize
     chunkcachesize = ui.configint(b'format', b'chunkcachesize')
     if chunkcachesize is not None:
         options[b'chunkcachesize'] = chunkcachesize
 
     deltabothparents = ui.configbool(
         b'storage', b'revlog.optimize-delta-parent-choice'
     )
     options[b'deltabothparents'] = deltabothparents
+    dps_cgds = ui.configint(
+        b'storage',
+        b'revlog.delta-parent-search.candidate-group-chunk-size',
+    )
+    options[b'delta-parent-search.candidate-group-chunk-size'] = dps_cgds
     options[b'debug-delta'] = ui.configbool(b'debug', b'revlog.debug-delta')
 
     issue6528 = ui.configbool(b'storage', b'revlog.issue6528.fix-incoming')
     options[b'issue6528.fix-incoming'] = issue6528
 
     lazydelta = ui.configbool(b'storage', b'revlog.reuse-external-delta')
     lazydeltabase = False
     if lazydelta:
         lazydeltabase = ui.configbool(
             b'storage', b'revlog.reuse-external-delta-parent'
         )
     if lazydeltabase is None:
         lazydeltabase = not scmutil.gddeltaconfig(ui)
     options[b'lazydelta'] = lazydelta
     options[b'lazydeltabase'] = lazydeltabase
 
     chainspan = ui.configbytes(b'experimental', b'maxdeltachainspan')
     if 0 <= chainspan:
         options[b'maxdeltachainspan'] = chainspan
 
     mmapindexthreshold = ui.configbytes(b'experimental', b'mmapindexthreshold')
     if mmapindexthreshold is not None:
         options[b'mmapindexthreshold'] = mmapindexthreshold
 
     withsparseread = ui.configbool(b'experimental', b'sparse-read')
     srdensitythres = float(
         ui.config(b'experimental', b'sparse-read.density-threshold')
     )
     srmingapsize = ui.configbytes(b'experimental', b'sparse-read.min-gap-size')
     options[b'with-sparse-read'] = withsparseread
     options[b'sparse-read-density-threshold'] = srdensitythres
     options[b'sparse-read-min-gap-size'] = srmingapsize
 
     sparserevlog = requirementsmod.SPARSEREVLOG_REQUIREMENT in requirements
     options[b'sparse-revlog'] = sparserevlog
     if sparserevlog:
         options[b'generaldelta'] = True
 
     maxchainlen = None
     if sparserevlog:
         maxchainlen = revlogconst.SPARSE_REVLOG_MAX_CHAIN_LENGTH
     # experimental config: format.maxchainlen
     maxchainlen = ui.configint(b'format', b'maxchainlen', maxchainlen)
     if maxchainlen is not None:
         options[b'maxchainlen'] = maxchainlen
 
     for r in requirements:
         # we allow multiple compression engine requirement to co-exist because
         # strickly speaking, revlog seems to support mixed compression style.
         #
         # The compression used for new entries will be "the last one"
         prefix = r.startswith
         if prefix(b'revlog-compression-') or prefix(b'exp-compression-'):
             options[b'compengine'] = r.split(b'-', 2)[2]
 
     options[b'zlib.level'] = ui.configint(b'storage', b'revlog.zlib.level')
     if options[b'zlib.level'] is not None:
         if not (0 <= options[b'zlib.level'] <= 9):
             msg = _(b'invalid value for `storage.revlog.zlib.level` config: %d')
             raise error.Abort(msg % options[b'zlib.level'])
     options[b'zstd.level'] = ui.configint(b'storage', b'revlog.zstd.level')
     if options[b'zstd.level'] is not None:
         if not (0 <= options[b'zstd.level'] <= 22):
             msg = _(b'invalid value for `storage.revlog.zstd.level` config: %d')
             raise error.Abort(msg % options[b'zstd.level'])
 
     if requirementsmod.NARROW_REQUIREMENT in requirements:
         options[b'enableellipsis'] = True
 
     if ui.configbool(b'experimental', b'rust.index'):
         options[b'rust.index'] = True
     if requirementsmod.NODEMAP_REQUIREMENT in requirements:
         slow_path = ui.config(
             b'storage', b'revlog.persistent-nodemap.slow-path'
         )
         if slow_path not in (b'allow', b'warn', b'abort'):
             default = ui.config_default(
                 b'storage', b'revlog.persistent-nodemap.slow-path'
             )
             msg = _(
                 b'unknown value for config '
                 b'"storage.revlog.persistent-nodemap.slow-path": "%s"\n'
             )
             ui.warn(msg % slow_path)
             if not ui.quiet:
                 ui.warn(_(b'falling back to default value: %s\n') % default)
             slow_path = default
 
         msg = _(
             b"accessing `persistent-nodemap` repository without associated "
             b"fast implementation."
         )
         hint = _(
             b"check `hg help config.format.use-persistent-nodemap` "
             b"for details"
         )
         if not revlog.HAS_FAST_PERSISTENT_NODEMAP:
             if slow_path == b'warn':
                 msg = b"warning: " + msg + b'\n'
                 ui.warn(msg)
                 if not ui.quiet:
                     hint = b'(' + hint + b')\n'
                     ui.warn(hint)
             if slow_path == b'abort':
                 raise error.Abort(msg, hint=hint)
         options[b'persistent-nodemap'] = True
     if requirementsmod.DIRSTATE_V2_REQUIREMENT in requirements:
         slow_path = ui.config(b'storage', b'dirstate-v2.slow-path')
         if slow_path not in (b'allow', b'warn', b'abort'):
             default = ui.config_default(b'storage', b'dirstate-v2.slow-path')
             msg = _(b'unknown value for config "dirstate-v2.slow-path": "%s"\n')
             ui.warn(msg % slow_path)
             if not ui.quiet:
                 ui.warn(_(b'falling back to default value: %s\n') % default)
             slow_path = default
 
         msg = _(
             b"accessing `dirstate-v2` repository without associated "
             b"fast implementation."
         )
         hint = _(
             b"check `hg help config.format.use-dirstate-v2` " b"for details"
         )
         if not dirstate.HAS_FAST_DIRSTATE_V2:
             if slow_path == b'warn':
                 msg = b"warning: " + msg + b'\n'
                 ui.warn(msg)
                 if not ui.quiet:
                     hint = b'(' + hint + b')\n'
                     ui.warn(hint)
             if slow_path == b'abort':
                 raise error.Abort(msg, hint=hint)
     if ui.configbool(b'storage', b'revlog.persistent-nodemap.mmap'):
         options[b'persistent-nodemap.mmap'] = True
     if ui.configbool(b'devel', b'persistent-nodemap'):
         options[b'devel-force-nodemap'] = True
 
     return options
 
 
 def makemain(**kwargs):
     """Produce a type conforming to ``ilocalrepositorymain``."""
     return localrepository
 
 
 @interfaceutil.implementer(repository.ilocalrepositoryfilestorage)
 class revlogfilestorage:
     """File storage when using revlogs."""
 
     def file(self, path):
         if path.startswith(b'/'):
             path = path[1:]
 
         return filelog.filelog(self.svfs, path)
 
 
 @interfaceutil.implementer(repository.ilocalrepositoryfilestorage)
 class revlognarrowfilestorage:
     """File storage when using revlogs and narrow files."""
 
     def file(self, path):
         if path.startswith(b'/'):
             path = path[1:]
 
         return filelog.narrowfilelog(self.svfs, path, self._storenarrowmatch)
 
 
 def makefilestorage(requirements, features, **kwargs):
     """Produce a type conforming to ``ilocalrepositoryfilestorage``."""
     features.add(repository.REPO_FEATURE_REVLOG_FILE_STORAGE)
     features.add(repository.REPO_FEATURE_STREAM_CLONE)
 
     if requirementsmod.NARROW_REQUIREMENT in requirements:
         return revlognarrowfilestorage
     else:
         return revlogfilestorage
 
 
 # List of repository interfaces and factory functions for them. Each
 # will be called in order during ``makelocalrepository()`` to iteratively
 # derive the final type for a local repository instance. We capture the
 # function as a lambda so we don't hold a reference and the module-level
 # functions can be wrapped.
 REPO_INTERFACES = [
     (repository.ilocalrepositorymain, lambda: makemain),
     (repository.ilocalrepositoryfilestorage, lambda: makefilestorage),
 ]
 
 
 @interfaceutil.implementer(repository.ilocalrepositorymain)
 class localrepository:
     """Main class for representing local repositories.
 
     All local repositories are instances of this class.
 
     Constructed on its own, instances of this class are not usable as
     repository objects. To obtain a usable repository object, call
     ``hg.repository()``, ``localrepo.instance()``, or
     ``localrepo.makelocalrepository()``. The latter is the lowest-level.
     ``instance()`` adds support for creating new repositories.
     ``hg.repository()`` adds more extension integration, including calling
     ``reposetup()``. Generally speaking, ``hg.repository()`` should be
     used.
     """
 
     _basesupported = {
         requirementsmod.ARCHIVED_PHASE_REQUIREMENT,
         requirementsmod.BOOKMARKS_IN_STORE_REQUIREMENT,
         requirementsmod.CHANGELOGV2_REQUIREMENT,
         requirementsmod.COPIESSDC_REQUIREMENT,
         requirementsmod.DIRSTATE_TRACKED_HINT_V1,
         requirementsmod.DIRSTATE_V2_REQUIREMENT,
         requirementsmod.DOTENCODE_REQUIREMENT,
         requirementsmod.FNCACHE_REQUIREMENT,
         requirementsmod.GENERALDELTA_REQUIREMENT,
         requirementsmod.INTERNAL_PHASE_REQUIREMENT,
         requirementsmod.NODEMAP_REQUIREMENT,
         requirementsmod.RELATIVE_SHARED_REQUIREMENT,
         requirementsmod.REVLOGV1_REQUIREMENT,
         requirementsmod.REVLOGV2_REQUIREMENT,
         requirementsmod.SHARED_REQUIREMENT,
         requirementsmod.SHARESAFE_REQUIREMENT,
         requirementsmod.SPARSE_REQUIREMENT,
         requirementsmod.SPARSEREVLOG_REQUIREMENT,
         requirementsmod.STORE_REQUIREMENT,
         requirementsmod.TREEMANIFEST_REQUIREMENT,
     }
 
     # list of prefix for file which can be written without 'wlock'
     # Extensions should extend this list when needed
     _wlockfreeprefix = {
         # We migh consider requiring 'wlock' for the next
         # two, but pretty much all the existing code assume
         # wlock is not needed so we keep them excluded for
         # now.
         b'hgrc',
         b'requires',
         # XXX cache is a complicatged business someone
         # should investigate this in depth at some point
         b'cache/',
         # XXX shouldn't be dirstate covered by the wlock?
         b'dirstate',
         # XXX bisect was still a bit too messy at the time
         # this changeset was introduced. Someone should fix
         # the remainig bit and drop this line
         b'bisect.state',
     }
 
     def __init__(
         self,
         baseui,
         ui,
         origroot: bytes,
         wdirvfs: vfsmod.vfs,
         hgvfs: vfsmod.vfs,
         requirements,
         supportedrequirements,
         sharedpath: bytes,
         store,
         cachevfs: vfsmod.vfs,
         wcachevfs: vfsmod.vfs,
         features,
         intents=None,
     ):
         """Create a new local repository instance.
 
         Most callers should use ``hg.repository()``, ``localrepo.instance()``,
         or ``localrepo.makelocalrepository()`` for obtaining a new repository
         object.
 
         Arguments:
 
         baseui
            ``ui.ui`` instance that ``ui`` argument was based off of.
 
         ui
            ``ui.ui`` instance for use by the repository.
 
         origroot
            ``bytes`` path to working directory root of this repository.
 
         wdirvfs
            ``vfs.vfs`` rooted at the working directory.
 
         hgvfs
            ``vfs.vfs`` rooted at .hg/
 
         requirements
            ``set`` of bytestrings representing repository opening requirements.
 
         supportedrequirements
            ``set`` of bytestrings representing repository requirements that we
            know how to open. May be a supetset of ``requirements``.
 
         sharedpath
            ``bytes`` Defining path to storage base directory. Points to a
            ``.hg/`` directory somewhere.
 
         store
            ``store.basicstore`` (or derived) instance providing access to
            versioned storage.
 
         cachevfs
            ``vfs.vfs`` used for cache files.
 
         wcachevfs
            ``vfs.vfs`` used for cache files related to the working copy.
 
         features
            ``set`` of bytestrings defining features/capabilities of this
            instance.
 
         intents
            ``set`` of system strings indicating what this repo will be used
            for.
         """
         self.baseui = baseui
         self.ui = ui
         self.origroot = origroot
         # vfs rooted at working directory.
         self.wvfs = wdirvfs
         self.root = wdirvfs.base
         # vfs rooted at .hg/. Used to access most non-store paths.
         self.vfs = hgvfs
         self.path = hgvfs.base
         self.requirements = requirements
         self.nodeconstants = sha1nodeconstants
         self.nullid = self.nodeconstants.nullid
         self.supported = supportedrequirements
         self.sharedpath = sharedpath
         self.store = store
         self.cachevfs = cachevfs
         self.wcachevfs = wcachevfs
         self.features = features
 
         self.filtername = None
 
         if self.ui.configbool(b'devel', b'all-warnings') or self.ui.configbool(
             b'devel', b'check-locks'
         ):
             self.vfs.audit = self._getvfsward(self.vfs.audit)
         # A list of callback to shape the phase if no data were found.
         # Callback are in the form: func(repo, roots) --> processed root.
         # This list it to be filled by extension during repo setup
         self._phasedefaults = []
 
         color.setup(self.ui)
 
         self.spath = self.store.path
         self.svfs = self.store.vfs
         self.sjoin = self.store.join
         if self.ui.configbool(b'devel', b'all-warnings') or self.ui.configbool(
             b'devel', b'check-locks'
         ):
             if util.safehasattr(self.svfs, b'vfs'):  # this is filtervfs
                 self.svfs.vfs.audit = self._getsvfsward(self.svfs.vfs.audit)
             else:  # standard vfs
                 self.svfs.audit = self._getsvfsward(self.svfs.audit)
 
         self._dirstatevalidatewarned = False
 
         self._branchcaches = branchmap.BranchMapCache()
         self._revbranchcache = None
         self._filterpats = {}
         self._datafilters = {}
         self._transref = self._lockref = self._wlockref = None
 
         # A cache for various files under .hg/ that tracks file changes,
         # (used by the filecache decorator)
         #
         # Maps a property name to its util.filecacheentry
         self._filecache = {}
 
         # hold sets of revision to be filtered
         # should be cleared when something might have changed the filter value:
         # - new changesets,
         # - phase change,
         # - new obsolescence marker,
         # - working directory parent change,
         # - bookmark changes
         self.filteredrevcache = {}
 
         # post-dirstate-status hooks
         self._postdsstatus = []
 
         # generic mapping between names and nodes
         self.names = namespaces.namespaces()
 
         # Key to signature value.
         self._sparsesignaturecache = {}
         # Signature to cached matcher instance.
         self._sparsematchercache = {}
 
         self._extrafilterid = repoview.extrafilter(ui)
 
         self.filecopiesmode = None
         if requirementsmod.COPIESSDC_REQUIREMENT in self.requirements:
             self.filecopiesmode = b'changeset-sidedata'
 
         self._wanted_sidedata = set()
         self._sidedata_computers = {}
         sidedatamod.set_sidedata_spec_for_repo(self)
 
     def _getvfsward(self, origfunc):
         """build a ward for self.vfs"""
         rref = weakref.ref(self)
 
         def checkvfs(path, mode=None):
             ret = origfunc(path, mode=mode)
             repo = rref()
             if (
                 repo is None
                 or not util.safehasattr(repo, b'_wlockref')
                 or not util.safehasattr(repo, b'_lockref')
             ):
                 return
             if mode in (None, b'r', b'rb'):
                 return
             if path.startswith(repo.path):
                 # truncate name relative to the repository (.hg)
                 path = path[len(repo.path) + 1 :]
             if path.startswith(b'cache/'):
                 msg = b'accessing cache with vfs instead of cachevfs: "%s"'
                 repo.ui.develwarn(msg % path, stacklevel=3, config=b"cache-vfs")
             # path prefixes covered by 'lock'
             vfs_path_prefixes = (
                 b'journal.',
                 b'undo.',
                 b'strip-backup/',
                 b'cache/',
             )
             if any(path.startswith(prefix) for prefix in vfs_path_prefixes):
                 if repo._currentlock(repo._lockref) is None:
                     repo.ui.develwarn(
                         b'write with no lock: "%s"' % path,
                         stacklevel=3,
                         config=b'check-locks',
                     )
             elif repo._currentlock(repo._wlockref) is None:
                 # rest of vfs files are covered by 'wlock'
                 #
                 # exclude special files
                 for prefix in self._wlockfreeprefix:
                     if path.startswith(prefix):
                         return
                 repo.ui.develwarn(
                     b'write with no wlock: "%s"' % path,
                     stacklevel=3,
                     config=b'check-locks',
                 )
             return ret
 
         return checkvfs
 
     def _getsvfsward(self, origfunc):
         """build a ward for self.svfs"""
         rref = weakref.ref(self)
 
         def checksvfs(path, mode=None):
             ret = origfunc(path, mode=mode)
             repo = rref()
             if repo is None or not util.safehasattr(repo, b'_lockref'):
                 return
             if mode in (None, b'r', b'rb'):
                 return
             if path.startswith(repo.sharedpath):
                 # truncate name relative to the repository (.hg)
                 path = path[len(repo.sharedpath) + 1 :]
             if repo._currentlock(repo._lockref) is None:
                 repo.ui.develwarn(
                     b'write with no lock: "%s"' % path, stacklevel=4
                 )
             return ret
 
         return checksvfs
 
     def close(self):
         self._writecaches()
 
     def _writecaches(self):
         if self._revbranchcache:
             self._revbranchcache.write()
 
     def _restrictcapabilities(self, caps):
         if self.ui.configbool(b'experimental', b'bundle2-advertise'):
             caps = set(caps)
             capsblob = bundle2.encodecaps(
                 bundle2.getrepocaps(self, role=b'client')
             )
             caps.add(b'bundle2=' + urlreq.quote(capsblob))
         if self.ui.configbool(b'experimental', b'narrow'):
             caps.add(wireprototypes.NARROWCAP)
         return caps
 
     # Don't cache auditor/nofsauditor, or you'll end up with reference cycle:
     # self -> auditor -> self._checknested -> self
 
     @property
     def auditor(self):
         # This is only used by context.workingctx.match in order to
         # detect files in subrepos.
         return pathutil.pathauditor(self.root, callback=self._checknested)
 
     @property
     def nofsauditor(self):
         # This is only used by context.basectx.match in order to detect
         # files in subrepos.
         return pathutil.pathauditor(
             self.root, callback=self._checknested, realfs=False, cached=True
         )
 
     def _checknested(self, path):
         """Determine if path is a legal nested repository."""
         if not path.startswith(self.root):
             return False
         subpath = path[len(self.root) + 1 :]
         normsubpath = util.pconvert(subpath)
 
         # XXX: Checking against the current working copy is wrong in
         # the sense that it can reject things like
         #
         #   $ hg cat -r 10 sub/x.txt
         #
         # if sub/ is no longer a subrepository in the working copy
         # parent revision.
         #
         # However, it can of course also allow things that would have
         # been rejected before, such as the above cat command if sub/
         # is a subrepository now, but was a normal directory before.
         # The old path auditor would have rejected by mistake since it
         # panics when it sees sub/.hg/.
         #
         # All in all, checking against the working copy seems sensible
         # since we want to prevent access to nested repositories on
         # the filesystem *now*.
         ctx = self[None]
         parts = util.splitpath(subpath)
         while parts:
             prefix = b'/'.join(parts)
             if prefix in ctx.substate:
                 if prefix == normsubpath:
                     return True
                 else:
                     sub = ctx.sub(prefix)
                     return sub.checknested(subpath[len(prefix) + 1 :])
             else:
                 parts.pop()
         return False
 
     def peer(self):
         return localpeer(self)  # not cached to avoid reference cycle
 
     def unfiltered(self):
         """Return unfiltered version of the repository
 
         Intended to be overwritten by filtered repo."""
         return self
 
     def filtered(self, name, visibilityexceptions=None):
         """Return a filtered version of a repository
 
         The `name` parameter is the identifier of the requested view. This
         will return a repoview object set "exactly" to the specified view.
 
         This function does not apply recursive filtering to a repository. For
         example calling `repo.filtered("served")` will return a repoview using
         the "served" view, regardless of the initial view used by `repo`.
 
         In other word, there is always only one level of `repoview` "filtering".
         """
         if self._extrafilterid is not None and b'%' not in name:
             name = name + b'%' + self._extrafilterid
 
         cls = repoview.newtype(self.unfiltered().__class__)
         return cls(self, name, visibilityexceptions)
 
     @mixedrepostorecache(
         (b'bookmarks', b'plain'),
         (b'bookmarks.current', b'plain'),
         (b'bookmarks', b''),
         (b'00changelog.i', b''),
     )
     def _bookmarks(self):
         # Since the multiple files involved in the transaction cannot be
         # written atomically (with current repository format), there is a race
         # condition here.
         #
         # 1) changelog content A is read
         # 2) outside transaction update changelog to content B
         # 3) outside transaction update bookmark file referring to content B
         # 4) bookmarks file content is read and filtered against changelog-A
         #
         # When this happens, bookmarks against nodes missing from A are dropped.
         #
         # Having this happening during read is not great, but it become worse
         # when this happen during write because the bookmarks to the "unknown"
         # nodes will be dropped for good. However, writes happen within locks.
         # This locking makes it possible to have a race free consistent read.
         # For this purpose data read from disc before locking  are
         # "invalidated" right after the locks are taken. This invalidations are
         # "light", the `filecache` mechanism keep the data in memory and will
         # reuse them if the underlying files did not changed. Not parsing the
         # same data multiple times helps performances.
         #
         # Unfortunately in the case describe above, the files tracked by the
         # bookmarks file cache might not have changed, but the in-memory
         # content is still "wrong" because we used an older changelog content
         # to process the on-disk data. So after locking, the changelog would be
         # refreshed but `_bookmarks` would be preserved.
         # Adding `00changelog.i` to the list of tracked file is not
         # enough, because at the time we build the content for `_bookmarks` in
         # (4), the changelog file has already diverged from the content used
         # for loading `changelog` in (1)
         #
         # To prevent the issue, we force the changelog to be explicitly
         # reloaded while computing `_bookmarks`. The data race can still happen
         # without the lock (with a narrower window), but it would no longer go
         # undetected during the lock time refresh.
         #
         # The new schedule is as follow
         #
         # 1) filecache logic detect that `_bookmarks` needs to be computed
         # 2) cachestat for `bookmarks` and `changelog` are captured (for book)
         # 3) We force `changelog` filecache to be tested
         # 4) cachestat for `changelog` are captured (for changelog)
         # 5) `_bookmarks` is computed and cached
         #
         # The step in (3) ensure we have a changelog at least as recent as the
         # cache stat computed in (1). As a result at locking time:
         #  * if the changelog did not changed since (1) -> we can reuse the data
         #  * otherwise -> the bookmarks get refreshed.
         self._refreshchangelog()
         return bookmarks.bmstore(self)
 
     def _refreshchangelog(self):
         """make sure the in memory changelog match the on-disk one"""
         if 'changelog' in vars(self) and self.currenttransaction() is None:
             del self.changelog
 
     @property
     def _activebookmark(self):
         return self._bookmarks.active
 
     # _phasesets depend on changelog. what we need is to call
     # _phasecache.invalidate() if '00changelog.i' was changed, but it
     # can't be easily expressed in filecache mechanism.
     @storecache(b'phaseroots', b'00changelog.i')
     def _phasecache(self):
         return phases.phasecache(self, self._phasedefaults)
 
     @storecache(b'obsstore')
     def obsstore(self):
         return obsolete.makestore(self.ui, self)
 
     @changelogcache()
     def changelog(repo):
         # load dirstate before changelog to avoid race see issue6303
         repo.dirstate.prefetch_parents()
         return repo.store.changelog(
             txnutil.mayhavepending(repo.root),
             concurrencychecker=revlogchecker.get_checker(repo.ui, b'changelog'),
         )
 
     @manifestlogcache()
     def manifestlog(self):
         return self.store.manifestlog(self, self._storenarrowmatch)
 
     @repofilecache(b'dirstate')
     def dirstate(self):
         return self._makedirstate()
 
     def _makedirstate(self):
         """Extension point for wrapping the dirstate per-repo."""
         sparsematchfn = None
         if sparse.use_sparse(self):
             sparsematchfn = lambda: sparse.matcher(self)
         v2_req = requirementsmod.DIRSTATE_V2_REQUIREMENT
         th = requirementsmod.DIRSTATE_TRACKED_HINT_V1
         use_dirstate_v2 = v2_req in self.requirements
         use_tracked_hint = th in self.requirements
 
         return dirstate.dirstate(
             self.vfs,
             self.ui,
             self.root,
             self._dirstatevalidate,
             sparsematchfn,
             self.nodeconstants,
             use_dirstate_v2,
             use_tracked_hint=use_tracked_hint,
         )
 
     def _dirstatevalidate(self, node):
         try:
             self.changelog.rev(node)
             return node
         except error.LookupError:
             if not self._dirstatevalidatewarned:
                 self._dirstatevalidatewarned = True
                 self.ui.warn(
                     _(b"warning: ignoring unknown working parent %s!\n")
                     % short(node)
                 )
             return self.nullid
 
     @storecache(narrowspec.FILENAME)
     def narrowpats(self):
         """matcher patterns for this repository's narrowspec
 
         A tuple of (includes, excludes).
         """
         return narrowspec.load(self)
 
     @storecache(narrowspec.FILENAME)
     def _storenarrowmatch(self):
         if requirementsmod.NARROW_REQUIREMENT not in self.requirements:
             return matchmod.always()
         include, exclude = self.narrowpats
         return narrowspec.match(self.root, include=include, exclude=exclude)
 
     @storecache(narrowspec.FILENAME)
     def _narrowmatch(self):
         if requirementsmod.NARROW_REQUIREMENT not in self.requirements:
             return matchmod.always()
         narrowspec.checkworkingcopynarrowspec(self)
         include, exclude = self.narrowpats
         return narrowspec.match(self.root, include=include, exclude=exclude)
 
     def narrowmatch(self, match=None, includeexact=False):
         """matcher corresponding the the repo's narrowspec
 
         If `match` is given, then that will be intersected with the narrow
         matcher.
 
         If `includeexact` is True, then any exact matches from `match` will
         be included even if they're outside the narrowspec.
         """
         if match:
             if includeexact and not self._narrowmatch.always():
                 # do not exclude explicitly-specified paths so that they can
                 # be warned later on
                 em = matchmod.exact(match.files())
                 nm = matchmod.unionmatcher([self._narrowmatch, em])
                 return matchmod.intersectmatchers(match, nm)
             return matchmod.intersectmatchers(match, self._narrowmatch)
         return self._narrowmatch
 
     def setnarrowpats(self, newincludes, newexcludes):
         narrowspec.save(self, newincludes, newexcludes)
         self.invalidate(clearfilecache=True)
 
     @unfilteredpropertycache
     def _quick_access_changeid_null(self):
         return {
             b'null': (nullrev, self.nodeconstants.nullid),
             nullrev: (nullrev, self.nodeconstants.nullid),
             self.nullid: (nullrev, self.nullid),
         }
 
     @unfilteredpropertycache
     def _quick_access_changeid_wc(self):
         # also fast path access to the working copy parents
         # however, only do it for filter that ensure wc is visible.
         quick = self._quick_access_changeid_null.copy()
         cl = self.unfiltered().changelog
         for node in self.dirstate.parents():
             if node == self.nullid:
                 continue
             rev = cl.index.get_rev(node)
             if rev is None:
                 # unknown working copy parent case:
                 #
                 #   skip the fast path and let higher code deal with it
                 continue
             pair = (rev, node)
             quick[rev] = pair
             quick[node] = pair
             # also add the parents of the parents
             for r in cl.parentrevs(rev):
                 if r == nullrev:
                     continue
                 n = cl.node(r)
                 pair = (r, n)
                 quick[r] = pair
                 quick[n] = pair
         p1node = self.dirstate.p1()
         if p1node != self.nullid:
             quick[b'.'] = quick[p1node]
         return quick
 
     @unfilteredmethod
     def _quick_access_changeid_invalidate(self):
         if '_quick_access_changeid_wc' in vars(self):
             del self.__dict__['_quick_access_changeid_wc']
 
     @property
     def _quick_access_changeid(self):
         """an helper dictionnary for __getitem__ calls
 
         This contains a list of symbol we can recognise right away without
         further processing.
         """
         if self.filtername in repoview.filter_has_wc:
             return self._quick_access_changeid_wc
         return self._quick_access_changeid_null
 
     def __getitem__(self, changeid):
         # dealing with special cases
         if changeid is None:
             return context.workingctx(self)
         if isinstance(changeid, context.basectx):
             return changeid
 
         # dealing with multiple revisions
         if isinstance(changeid, slice):
             # wdirrev isn't contiguous so the slice shouldn't include it
             return [
                 self[i]
                 for i in range(*changeid.indices(len(self)))
                 if i not in self.changelog.filteredrevs
             ]
 
         # dealing with some special values
         quick_access = self._quick_access_changeid.get(changeid)
         if quick_access is not None:
             rev, node = quick_access
             return context.changectx(self, rev, node, maybe_filtered=False)
         if changeid == b'tip':
             node = self.changelog.tip()
             rev = self.changelog.rev(node)
             return context.changectx(self, rev, node)
 
         # dealing with arbitrary values
         try:
             if isinstance(changeid, int):
                 node = self.changelog.node(changeid)
                 rev = changeid
             elif changeid == b'.':
                 # this is a hack to delay/avoid loading obsmarkers
                 # when we know that '.' won't be hidden
                 node = self.dirstate.p1()
                 rev = self.unfiltered().changelog.rev(node)
             elif len(changeid) == self.nodeconstants.nodelen:
                 try:
                     node = changeid
                     rev = self.changelog.rev(changeid)
                 except error.FilteredLookupError:
                     changeid = hex(changeid)  # for the error message
                     raise
                 except LookupError:
                     # check if it might have come from damaged dirstate
                     #
                     # XXX we could avoid the unfiltered if we had a recognizable
                     # exception for filtered changeset access
                     if (
                         self.local()
                         and changeid in self.unfiltered().dirstate.parents()
                     ):
                         msg = _(b"working directory has unknown parent '%s'!")
                         raise error.Abort(msg % short(changeid))
                     changeid = hex(changeid)  # for the error message
                     raise
 
             elif len(changeid) == 2 * self.nodeconstants.nodelen:
                 node = bin(changeid)
                 rev = self.changelog.rev(node)
             else:
                 raise error.ProgrammingError(
                     b"unsupported changeid '%s' of type %s"
                     % (changeid, pycompat.bytestr(type(changeid)))
                 )
 
             return context.changectx(self, rev, node)
 
         except (error.FilteredIndexError, error.FilteredLookupError):
             raise error.FilteredRepoLookupError(
                 _(b"filtered revision '%s'") % pycompat.bytestr(changeid)
             )
         except (IndexError, LookupError):
             raise error.RepoLookupError(
                 _(b"unknown revision '%s'") % pycompat.bytestr(changeid)
             )
         except error.WdirUnsupported:
             return context.workingctx(self)
 
     def __contains__(self, changeid):
         """True if the given changeid exists"""
         try:
             self[changeid]
             return True
         except error.RepoLookupError:
             return False
 
     def __nonzero__(self):
         return True
 
     __bool__ = __nonzero__
 
     def __len__(self):
         # no need to pay the cost of repoview.changelog
         unfi = self.unfiltered()
         return len(unfi.changelog)
 
     def __iter__(self):
         return iter(self.changelog)
 
     def revs(self, expr: bytes, *args):
         """Find revisions matching a revset.
 
         The revset is specified as a string ``expr`` that may contain
         %-formatting to escape certain types. See ``revsetlang.formatspec``.
 
         Revset aliases from the configuration are not expanded. To expand
         user aliases, consider calling ``scmutil.revrange()`` or
         ``repo.anyrevs([expr], user=True)``.
 
         Returns a smartset.abstractsmartset, which is a list-like interface
         that contains integer revisions.
         """
         tree = revsetlang.spectree(expr, *args)
         return revset.makematcher(tree)(self)
 
     def set(self, expr: bytes, *args):
         """Find revisions matching a revset and emit changectx instances.
 
         This is a convenience wrapper around ``revs()`` that iterates the
         result and is a generator of changectx instances.
 
         Revset aliases from the configuration are not expanded. To expand
         user aliases, consider calling ``scmutil.revrange()``.
         """
         for r in self.revs(expr, *args):
             yield self[r]
 
     def anyrevs(self, specs: bytes, user=False, localalias=None):
         """Find revisions matching one of the given revsets.
 
         Revset aliases from the configuration are not expanded by default. To
         expand user aliases, specify ``user=True``. To provide some local
         definitions overriding user aliases, set ``localalias`` to
         ``{name: definitionstring}``.
         """
         if specs == [b'null']:
             return revset.baseset([nullrev])
         if specs == [b'.']:
             quick_data = self._quick_access_changeid.get(b'.')
             if quick_data is not None:
                 return revset.baseset([quick_data[0]])
         if user:
             m = revset.matchany(
                 self.ui,
                 specs,
                 lookup=revset.lookupfn(self),
                 localalias=localalias,
             )
         else:
             m = revset.matchany(None, specs, localalias=localalias)
         return m(self)
 
     def url(self) -> bytes:
         return b'file:' + self.root
 
     def hook(self, name, throw=False, **args):
         """Call a hook, passing this repo instance.
 
         This a convenience method to aid invoking hooks. Extensions likely
         won't call this unless they have registered a custom hook or are
         replacing code that is expected to call a hook.
         """
         return hook.hook(self.ui, self, name, throw, **args)
 
     @filteredpropertycache
     def _tagscache(self):
         """Returns a tagscache object that contains various tags related
         caches."""
 
         # This simplifies its cache management by having one decorated
         # function (this one) and the rest simply fetch things from it.
         class tagscache:
             def __init__(self):
                 # These two define the set of tags for this repository. tags
                 # maps tag name to node; tagtypes maps tag name to 'global' or
                 # 'local'. (Global tags are defined by .hgtags across all
                 # heads, and local tags are defined in .hg/localtags.)
                 # They constitute the in-memory cache of tags.
                 self.tags = self.tagtypes = None
 
                 self.nodetagscache = self.tagslist = None
 
         cache = tagscache()
         cache.tags, cache.tagtypes = self._findtags()
 
         return cache
 
     def tags(self):
         '''return a mapping of tag to node'''
         t = {}
         if self.changelog.filteredrevs:
             tags, tt = self._findtags()
         else:
             tags = self._tagscache.tags
         rev = self.changelog.rev
         for k, v in tags.items():
             try:
                 # ignore tags to unknown nodes
                 rev(v)
                 t[k] = v
             except (error.LookupError, ValueError):
                 pass
         return t
 
     def _findtags(self):
         """Do the hard work of finding tags.  Return a pair of dicts
         (tags, tagtypes) where tags maps tag name to node, and tagtypes
         maps tag name to a string like \'global\' or \'local\'.
         Subclasses or extensions are free to add their own tags, but
         should be aware that the returned dicts will be retained for the
         duration of the localrepo object."""
 
         # XXX what tagtype should subclasses/extensions use?  Currently
         # mq and bookmarks add tags, but do not set the tagtype at all.
         # Should each extension invent its own tag type?  Should there
         # be one tagtype for all such "virtual" tags?  Or is the status
         # quo fine?
 
         # map tag name to (node, hist)
         alltags = tagsmod.findglobaltags(self.ui, self)
         # map tag name to tag type
         tagtypes = {tag: b'global' for tag in alltags}
 
         tagsmod.readlocaltags(self.ui, self, alltags, tagtypes)
 
         # Build the return dicts.  Have to re-encode tag names because
         # the tags module always uses UTF-8 (in order not to lose info
         # writing to the cache), but the rest of Mercurial wants them in
         # local encoding.
         tags = {}
         for (name, (node, hist)) in alltags.items():
             if node != self.nullid:
                 tags[encoding.tolocal(name)] = node
         tags[b'tip'] = self.changelog.tip()
         tagtypes = {
             encoding.tolocal(name): value for (name, value) in tagtypes.items()
         }
         return (tags, tagtypes)
 
     def tagtype(self, tagname):
         """
         return the type of the given tag. result can be:
 
         'local'  : a local tag
         'global' : a global tag
         None     : tag does not exist
         """
 
         return self._tagscache.tagtypes.get(tagname)
 
     def tagslist(self):
         '''return a list of tags ordered by revision'''
         if not self._tagscache.tagslist:
             l = []
             for t, n in self.tags().items():
                 l.append((self.changelog.rev(n), t, n))
             self._tagscache.tagslist = [(t, n) for r, t, n in sorted(l)]
 
         return self._tagscache.tagslist
 
     def nodetags(self, node):
         '''return the tags associated with a node'''
         if not self._tagscache.nodetagscache:
             nodetagscache = {}
             for t, n in self._tagscache.tags.items():
                 nodetagscache.setdefault(n, []).append(t)
             for tags in nodetagscache.values():
                 tags.sort()
             self._tagscache.nodetagscache = nodetagscache
         return self._tagscache.nodetagscache.get(node, [])
 
     def nodebookmarks(self, node):
         """return the list of bookmarks pointing to the specified node"""
         return self._bookmarks.names(node)
 
     def branchmap(self):
         """returns a dictionary {branch: [branchheads]} with branchheads
         ordered by increasing revision number"""
         return self._branchcaches[self]
 
     @unfilteredmethod
     def revbranchcache(self):
         if not self._revbranchcache:
             self._revbranchcache = branchmap.revbranchcache(self.unfiltered())
         return self._revbranchcache
 
     def register_changeset(self, rev, changelogrevision):
         self.revbranchcache().setdata(rev, changelogrevision)
 
     def branchtip(self, branch, ignoremissing=False):
         """return the tip node for a given branch
 
         If ignoremissing is True, then this method will not raise an error.
         This is helpful for callers that only expect None for a missing branch
         (e.g. namespace).
 
         """
         try:
             return self.branchmap().branchtip(branch)
         except KeyError:
             if not ignoremissing:
                 raise error.RepoLookupError(_(b"unknown branch '%s'") % branch)
             else:
                 pass
 
     def lookup(self, key):
         node = scmutil.revsymbol(self, key).node()
         if node is None:
             raise error.RepoLookupError(_(b"unknown revision '%s'") % key)
         return node
 
     def lookupbranch(self, key):
         if self.branchmap().hasbranch(key):
             return key
 
         return scmutil.revsymbol(self, key).branch()
 
     def known(self, nodes):
         cl = self.changelog
         get_rev = cl.index.get_rev
         filtered = cl.filteredrevs
         result = []
         for n in nodes:
             r = get_rev(n)
             resp = not (r is None or r in filtered)
             result.append(resp)
         return result
 
     def local(self):
         return self
 
     def publishing(self):
         # it's safe (and desirable) to trust the publish flag unconditionally
         # so that we don't finalize changes shared between users via ssh or nfs
         return self.ui.configbool(b'phases', b'publish', untrusted=True)
 
     def cancopy(self):
         # so statichttprepo's override of local() works
         if not self.local():
             return False
         if not self.publishing():
             return True
         # if publishing we can't copy if there is filtered content
         return not self.filtered(b'visible').changelog.filteredrevs
 
     def shared(self):
         '''the type of shared repository (None if not shared)'''
         if self.sharedpath != self.path:
             return b'store'
         return None
 
     def wjoin(self, f: bytes, *insidef: bytes) -> bytes:
         return self.vfs.reljoin(self.root, f, *insidef)
 
     def setparents(self, p1, p2=None):
         if p2 is None:
             p2 = self.nullid
         self[None].setparents(p1, p2)
         self._quick_access_changeid_invalidate()
 
     def filectx(self, path: bytes, changeid=None, fileid=None, changectx=None):
         """changeid must be a changeset revision, if specified.
         fileid can be a file revision or node."""
         return context.filectx(
             self, path, changeid, fileid, changectx=changectx
         )
 
     def getcwd(self) -> bytes:
         return self.dirstate.getcwd()
 
     def pathto(self, f: bytes, cwd: Optional[bytes] = None) -> bytes:
         return self.dirstate.pathto(f, cwd)
 
     def _loadfilter(self, filter):
         if filter not in self._filterpats:
             l = []
             for pat, cmd in self.ui.configitems(filter):
                 if cmd == b'!':
                     continue
                 mf = matchmod.match(self.root, b'', [pat])
                 fn = None
                 params = cmd
                 for name, filterfn in self._datafilters.items():
                     if cmd.startswith(name):
                         fn = filterfn
                         params = cmd[len(name) :].lstrip()
                         break
                 if not fn:
                     fn = lambda s, c, **kwargs: procutil.filter(s, c)
                     fn.__name__ = 'commandfilter'
                 # Wrap old filters not supporting keyword arguments
                 if not pycompat.getargspec(fn)[2]:
                     oldfn = fn
                     fn = lambda s, c, oldfn=oldfn, **kwargs: oldfn(s, c)
                     fn.__name__ = 'compat-' + oldfn.__name__
                 l.append((mf, fn, params))
             self._filterpats[filter] = l
         return self._filterpats[filter]
 
     def _filter(self, filterpats, filename, data):
         for mf, fn, cmd in filterpats:
             if mf(filename):
                 self.ui.debug(
                     b"filtering %s through %s\n"
                     % (filename, cmd or pycompat.sysbytes(fn.__name__))
                 )
                 data = fn(data, cmd, ui=self.ui, repo=self, filename=filename)
                 break
 
         return data
 
     @unfilteredpropertycache
     def _encodefilterpats(self):
         return self._loadfilter(b'encode')
 
     @unfilteredpropertycache
     def _decodefilterpats(self):
         return self._loadfilter(b'decode')
 
     def adddatafilter(self, name, filter):
         self._datafilters[name] = filter
 
     def wread(self, filename: bytes) -> bytes:
         if self.wvfs.islink(filename):
             data = self.wvfs.readlink(filename)
         else:
             data = self.wvfs.read(filename)
         return self._filter(self._encodefilterpats, filename, data)
 
     def wwrite(
         self,
         filename: bytes,
         data: bytes,
         flags: bytes,
         backgroundclose=False,
         **kwargs
     ) -> int:
         """write ``data`` into ``filename`` in the working directory
 
         This returns length of written (maybe decoded) data.
         """
         data = self._filter(self._decodefilterpats, filename, data)
         if b'l' in flags:
             self.wvfs.symlink(data, filename)
         else:
             self.wvfs.write(
                 filename, data, backgroundclose=backgroundclose, **kwargs
             )
             if b'x' in flags:
                 self.wvfs.setflags(filename, False, True)
             else:
                 self.wvfs.setflags(filename, False, False)
         return len(data)
 
     def wwritedata(self, filename: bytes, data: bytes) -> bytes:
         return self._filter(self._decodefilterpats, filename, data)
 
     def currenttransaction(self):
         """return the current transaction or None if non exists"""
         if self._transref:
             tr = self._transref()
         else:
             tr = None
 
         if tr and tr.running():
             return tr
         return None
 
     def transaction(self, desc, report=None):
         if self.ui.configbool(b'devel', b'all-warnings') or self.ui.configbool(
             b'devel', b'check-locks'
         ):
             if self._currentlock(self._lockref) is None:
                 raise error.ProgrammingError(b'transaction requires locking')
         tr = self.currenttransaction()
         if tr is not None:
             return tr.nest(name=desc)
 
         # abort here if the journal already exists
         if self.svfs.exists(b"journal"):
             raise error.RepoError(
                 _(b"abandoned transaction found"),
                 hint=_(b"run 'hg recover' to clean up transaction"),
             )
 
         idbase = b"%.40f#%f" % (random.random(), time.time())
         ha = hex(hashutil.sha1(idbase).digest())
         txnid = b'TXN:' + ha
         self.hook(b'pretxnopen', throw=True, txnname=desc, txnid=txnid)
 
         self._writejournal(desc)
         renames = [(vfs, x, undoname(x)) for vfs, x in self._journalfiles()]
         if report:
             rp = report
         else:
             rp = self.ui.warn
         vfsmap = {b'plain': self.vfs, b'store': self.svfs}  # root of .hg/
         # we must avoid cyclic reference between repo and transaction.
         reporef = weakref.ref(self)
         # Code to track tag movement
         #
         # Since tags are all handled as file content, it is actually quite hard
         # to track these movement from a code perspective. So we fallback to a
         # tracking at the repository level. One could envision to track changes
         # to the '.hgtags' file through changegroup apply but that fails to
         # cope with case where transaction expose new heads without changegroup
         # being involved (eg: phase movement).
         #
         # For now, We gate the feature behind a flag since this likely comes
         # with performance impacts. The current code run more often than needed
         # and do not use caches as much as it could.  The current focus is on
         # the behavior of the feature so we disable it by default. The flag
         # will be removed when we are happy with the performance impact.
         #
         # Once this feature is no longer experimental move the following
         # documentation to the appropriate help section:
         #
         # The ``HG_TAG_MOVED`` variable will be set if the transaction touched
         # tags (new or changed or deleted tags). In addition the details of
         # these changes are made available in a file at:
         #     ``REPOROOT/.hg/changes/tags.changes``.
         # Make sure you check for HG_TAG_MOVED before reading that file as it
         # might exist from a previous transaction even if no tag were touched
         # in this one. Changes are recorded in a line base format::
         #
         #     <action> <hex-node> <tag-name>\n
         #
         # Actions are defined as follow:
         #   "-R": tag is removed,
         #   "+A": tag is added,
         #   "-M": tag is moved (old value),
         #   "+M": tag is moved (new value),
         tracktags = lambda x: None
         # experimental config: experimental.hook-track-tags
         shouldtracktags = self.ui.configbool(
             b'experimental', b'hook-track-tags'
         )
         if desc != b'strip' and shouldtracktags:
             oldheads = self.changelog.headrevs()
 
             def tracktags(tr2):
                 repo = reporef()
                 assert repo is not None  # help pytype
                 oldfnodes = tagsmod.fnoderevs(repo.ui, repo, oldheads)
                 newheads = repo.changelog.headrevs()
                 newfnodes = tagsmod.fnoderevs(repo.ui, repo, newheads)
                 # notes: we compare lists here.
                 # As we do it only once buiding set would not be cheaper
                 changes = tagsmod.difftags(repo.ui, repo, oldfnodes, newfnodes)
                 if changes:
                     tr2.hookargs[b'tag_moved'] = b'1'
                     with repo.vfs(
                         b'changes/tags.changes', b'w', atomictemp=True
                     ) as changesfile:
                         # note: we do not register the file to the transaction
                         # because we needs it to still exist on the transaction
                         # is close (for txnclose hooks)
                         tagsmod.writediff(changesfile, changes)
 
         def validate(tr2):
             """will run pre-closing hooks"""
             # XXX the transaction API is a bit lacking here so we take a hacky
             # path for now
             #
             # We cannot add this as a "pending" hooks since the 'tr.hookargs'
             # dict is copied before these run. In addition we needs the data
             # available to in memory hooks too.
             #
             # Moreover, we also need to make sure this runs before txnclose
             # hooks and there is no "pending" mechanism that would execute
             # logic only if hooks are about to run.
             #
             # Fixing this limitation of the transaction is also needed to track
             # other families of changes (bookmarks, phases, obsolescence).
             #
             # This will have to be fixed before we remove the experimental
             # gating.
             tracktags(tr2)
             repo = reporef()
             assert repo is not None  # help pytype
 
             singleheadopt = (b'experimental', b'single-head-per-branch')
             singlehead = repo.ui.configbool(*singleheadopt)
             if singlehead:
                 singleheadsub = repo.ui.configsuboptions(*singleheadopt)[1]
                 accountclosed = singleheadsub.get(
                     b"account-closed-heads", False
                 )
                 if singleheadsub.get(b"public-changes-only", False):
                     filtername = b"immutable"
                 else:
                     filtername = b"visible"
                 scmutil.enforcesinglehead(
                     repo, tr2, desc, accountclosed, filtername
                 )
             if hook.hashook(repo.ui, b'pretxnclose-bookmark'):
                 for name, (old, new) in sorted(
                     tr.changes[b'bookmarks'].items()
                 ):
                     args = tr.hookargs.copy()
                     args.update(bookmarks.preparehookargs(name, old, new))
                     repo.hook(
                         b'pretxnclose-bookmark',
                         throw=True,
                         **pycompat.strkwargs(args)
                     )
             if hook.hashook(repo.ui, b'pretxnclose-phase'):
                 cl = repo.unfiltered().changelog
                 for revs, (old, new) in tr.changes[b'phases']:
                     for rev in revs:
                         args = tr.hookargs.copy()
                         node = hex(cl.node(rev))
                         args.update(phases.preparehookargs(node, old, new))
                         repo.hook(
                             b'pretxnclose-phase',
                             throw=True,
                             **pycompat.strkwargs(args)
                         )
 
             repo.hook(
                 b'pretxnclose', throw=True, **pycompat.strkwargs(tr.hookargs)
             )
 
         def releasefn(tr, success):
             repo = reporef()
             if repo is None:
                 # If the repo has been GC'd (and this release function is being
                 # called from transaction.__del__), there's not much we can do,
                 # so just leave the unfinished transaction there and let the
                 # user run `hg recover`.
                 return
             if success:
                 # this should be explicitly invoked here, because
                 # in-memory changes aren't written out at closing
                 # transaction, if tr.addfilegenerator (via
                 # dirstate.write or so) isn't invoked while
                 # transaction running
                 repo.dirstate.write(None)
             else:
                 # discard all changes (including ones already written
                 # out) in this transaction
                 narrowspec.restorebackup(self, b'journal.narrowspec')
                 narrowspec.restorewcbackup(self, b'journal.narrowspec.dirstate')
                 repo.dirstate.restorebackup(None, b'journal.dirstate')
 
                 repo.invalidate(clearfilecache=True)
 
         tr = transaction.transaction(
             rp,
             self.svfs,
             vfsmap,
             b"journal",
             b"undo",
             aftertrans(renames),
             self.store.createmode,
             validator=validate,
             releasefn=releasefn,
             checkambigfiles=_cachedfiles,
             name=desc,
         )
         tr.changes[b'origrepolen'] = len(self)
         tr.changes[b'obsmarkers'] = set()
         tr.changes[b'phases'] = []
         tr.changes[b'bookmarks'] = {}
 
         tr.hookargs[b'txnid'] = txnid
         tr.hookargs[b'txnname'] = desc
         tr.hookargs[b'changes'] = tr.changes
         # note: writing the fncache only during finalize mean that the file is
         # outdated when running hooks. As fncache is used for streaming clone,
         # this is not expected to break anything that happen during the hooks.
         tr.addfinalize(b'flush-fncache', self.store.write)
 
         def txnclosehook(tr2):
             """To be run if transaction is successful, will schedule a hook run"""
             # Don't reference tr2 in hook() so we don't hold a reference.
             # This reduces memory consumption when there are multiple
             # transactions per lock. This can likely go away if issue5045
             # fixes the function accumulation.
             hookargs = tr2.hookargs
 
             def hookfunc(unused_success):
                 repo = reporef()
                 assert repo is not None  # help pytype
 
                 if hook.hashook(repo.ui, b'txnclose-bookmark'):
                     bmchanges = sorted(tr.changes[b'bookmarks'].items())
                     for name, (old, new) in bmchanges:
                         args = tr.hookargs.copy()
                         args.update(bookmarks.preparehookargs(name, old, new))
                         repo.hook(
                             b'txnclose-bookmark',
                             throw=False,
                             **pycompat.strkwargs(args)
                         )
 
                 if hook.hashook(repo.ui, b'txnclose-phase'):
                     cl = repo.unfiltered().changelog
                     phasemv = sorted(
                         tr.changes[b'phases'], key=lambda r: r[0][0]
                     )
                     for revs, (old, new) in phasemv:
                         for rev in revs:
                             args = tr.hookargs.copy()
                             node = hex(cl.node(rev))
                             args.update(phases.preparehookargs(node, old, new))
                             repo.hook(
                                 b'txnclose-phase',
                                 throw=False,
                                 **pycompat.strkwargs(args)
                             )
 
                 repo.hook(
                     b'txnclose', throw=False, **pycompat.strkwargs(hookargs)
                 )
 
             repo = reporef()
             assert repo is not None  # help pytype
             repo._afterlock(hookfunc)
 
         tr.addfinalize(b'txnclose-hook', txnclosehook)
         # Include a leading "-" to make it happen before the transaction summary
         # reports registered via scmutil.registersummarycallback() whose names
         # are 00-txnreport etc. That way, the caches will be warm when the
         # callbacks run.
         tr.addpostclose(b'-warm-cache', self._buildcacheupdater(tr))
 
         def txnaborthook(tr2):
             """To be run if transaction is aborted"""
             repo = reporef()
             assert repo is not None  # help pytype
             repo.hook(
                 b'txnabort', throw=False, **pycompat.strkwargs(tr2.hookargs)
             )
 
         tr.addabort(b'txnabort-hook', txnaborthook)
         # avoid eager cache invalidation. in-memory data should be identical
         # to stored data if transaction has no error.
         tr.addpostclose(b'refresh-filecachestats', self._refreshfilecachestats)
         self._transref = weakref.ref(tr)
         scmutil.registersummarycallback(self, tr, desc)
         return tr
 
     def _journalfiles(self):
         first = (
             (self.svfs, b'journal'),
             (self.svfs, b'journal.narrowspec'),
             (self.vfs, b'journal.narrowspec.dirstate'),
             (self.vfs, b'journal.dirstate'),
         )
         middle = []
         dirstate_data = self.dirstate.data_backup_filename(b'journal.dirstate')
         if dirstate_data is not None:
             middle.append((self.vfs, dirstate_data))
         end = (
             (self.vfs, b'journal.branch'),
             (self.vfs, b'journal.desc'),
             (bookmarks.bookmarksvfs(self), b'journal.bookmarks'),
             (self.svfs, b'journal.phaseroots'),
         )
         return first + tuple(middle) + end
 
     def undofiles(self):
         return [(vfs, undoname(x)) for vfs, x in self._journalfiles()]
 
     @unfilteredmethod
     def _writejournal(self, desc):
         self.dirstate.savebackup(None, b'journal.dirstate')
         narrowspec.savewcbackup(self, b'journal.narrowspec.dirstate')
         narrowspec.savebackup(self, b'journal.narrowspec')
         self.vfs.write(
             b"journal.branch", encoding.fromlocal(self.dirstate.branch())
         )
         self.vfs.write(b"journal.desc", b"%d\n%s\n" % (len(self), desc))
         bookmarksvfs = bookmarks.bookmarksvfs(self)
         bookmarksvfs.write(
             b"journal.bookmarks", bookmarksvfs.tryread(b"bookmarks")
         )
         self.svfs.write(b"journal.phaseroots", self.svfs.tryread(b"phaseroots"))
 
     def recover(self):
         with self.lock():
             if self.svfs.exists(b"journal"):
                 self.ui.status(_(b"rolling back interrupted transaction\n"))
                 vfsmap = {
                     b'': self.svfs,
                     b'plain': self.vfs,
                 }
                 transaction.rollback(
                     self.svfs,
                     vfsmap,
                     b"journal",
                     self.ui.warn,
                     checkambigfiles=_cachedfiles,
                 )
                 self.invalidate()
                 return True
             else:
                 self.ui.warn(_(b"no interrupted transaction available\n"))
                 return False
 
     def rollback(self, dryrun=False, force=False):
         wlock = lock = dsguard = None
         try:
             wlock = self.wlock()
             lock = self.lock()
             if self.svfs.exists(b"undo"):
                 dsguard = dirstateguard.dirstateguard(self, b'rollback')
 
                 return self._rollback(dryrun, force, dsguard)
             else:
                 self.ui.warn(_(b"no rollback information available\n"))
                 return 1
         finally:
             release(dsguard, lock, wlock)
 
     @unfilteredmethod  # Until we get smarter cache management
     def _rollback(self, dryrun, force, dsguard):
         ui = self.ui
         try:
             args = self.vfs.read(b'undo.desc').splitlines()
             (oldlen, desc, detail) = (int(args[0]), args[1], None)
             if len(args) >= 3:
                 detail = args[2]
             oldtip = oldlen - 1
 
             if detail and ui.verbose:
                 msg = _(
                     b'repository tip rolled back to revision %d'
                     b' (undo %s: %s)\n'
                 ) % (oldtip, desc, detail)
             else:
                 msg = _(
                     b'repository tip rolled back to revision %d (undo %s)\n'
                 ) % (oldtip, desc)
         except IOError:
             msg = _(b'rolling back unknown transaction\n')
             desc = None
 
         if not force and self[b'.'] != self[b'tip'] and desc == b'commit':
             raise error.Abort(
                 _(
                     b'rollback of last commit while not checked out '
                     b'may lose data'
                 ),
                 hint=_(b'use -f to force'),
             )
 
         ui.status(msg)
         if dryrun:
             return 0
 
         parents = self.dirstate.parents()
         self.destroying()
         vfsmap = {b'plain': self.vfs, b'': self.svfs}
         transaction.rollback(
             self.svfs, vfsmap, b'undo', ui.warn, checkambigfiles=_cachedfiles
         )
         bookmarksvfs = bookmarks.bookmarksvfs(self)
         if bookmarksvfs.exists(b'undo.bookmarks'):
             bookmarksvfs.rename(
                 b'undo.bookmarks', b'bookmarks', checkambig=True
             )
         if self.svfs.exists(b'undo.phaseroots'):
             self.svfs.rename(b'undo.phaseroots', b'phaseroots', checkambig=True)
         self.invalidate()
 
         has_node = self.changelog.index.has_node
         parentgone = any(not has_node(p) for p in parents)
         if parentgone:
             # prevent dirstateguard from overwriting already restored one
             dsguard.close()
 
             narrowspec.restorebackup(self, b'undo.narrowspec')
             narrowspec.restorewcbackup(self, b'undo.narrowspec.dirstate')
             self.dirstate.restorebackup(None, b'undo.dirstate')
             try:
                 branch = self.vfs.read(b'undo.branch')
                 self.dirstate.setbranch(encoding.tolocal(branch))
             except IOError:
                 ui.warn(
                     _(
                         b'named branch could not be reset: '
                         b'current branch is still \'%s\'\n'
                     )
                     % self.dirstate.branch()
                 )
 
             parents = tuple([p.rev() for p in self[None].parents()])
             if len(parents) > 1:
                 ui.status(
                     _(
                         b'working directory now based on '
                         b'revisions %d and %d\n'
                     )
                     % parents
                 )
             else:
                 ui.status(
                     _(b'working directory now based on revision %d\n') % parents
                 )
             mergestatemod.mergestate.clean(self)
 
         # TODO: if we know which new heads may result from this rollback, pass
         # them to destroy(), which will prevent the branchhead cache from being
         # invalidated.
         self.destroyed()
         return 0
 
     def _buildcacheupdater(self, newtransaction):
         """called during transaction to build the callback updating cache
 
         Lives on the repository to help extension who might want to augment
         this logic. For this purpose, the created transaction is passed to the
         method.
         """
         # we must avoid cyclic reference between repo and transaction.
         reporef = weakref.ref(self)
 
         def updater(tr):
             repo = reporef()
             assert repo is not None  # help pytype
             repo.updatecaches(tr)
 
         return updater
 
     @unfilteredmethod
     def updatecaches(self, tr=None, full=False, caches=None):
         """warm appropriate caches
 
         If this function is called after a transaction closed. The transaction
         will be available in the 'tr' argument. This can be used to selectively
         update caches relevant to the changes in that transaction.
 
         If 'full' is set, make sure all caches the function knows about have
         up-to-date data. Even the ones usually loaded more lazily.
 
         The `full` argument can take a special "post-clone" value. In this case
         the cache warming is made after a clone and of the slower cache might
         be skipped, namely the `.fnodetags` one. This argument is 5.8 specific
         as we plan for a cleaner way to deal with this for 5.9.
         """
         if tr is not None and tr.hookargs.get(b'source') == b'strip':
             # During strip, many caches are invalid but
             # later call to `destroyed` will refresh them.
             return
 
         unfi = self.unfiltered()
 
         if full:
             msg = (
                 "`full` argument for `repo.updatecaches` is deprecated\n"
                 "(use `caches=repository.CACHE_ALL` instead)"
             )
             self.ui.deprecwarn(msg, b"5.9")
             caches = repository.CACHES_ALL
             if full == b"post-clone":
                 caches = repository.CACHES_POST_CLONE
             caches = repository.CACHES_ALL
         elif caches is None:
             caches = repository.CACHES_DEFAULT
 
         if repository.CACHE_BRANCHMAP_SERVED in caches:
             if tr is None or tr.changes[b'origrepolen'] < len(self):
                 # accessing the 'served' branchmap should refresh all the others,
                 self.ui.debug(b'updating the branch cache\n')
                 self.filtered(b'served').branchmap()
                 self.filtered(b'served.hidden').branchmap()
                 # flush all possibly delayed write.
                 self._branchcaches.write_delayed(self)
 
         if repository.CACHE_CHANGELOG_CACHE in caches:
             self.changelog.update_caches(transaction=tr)
 
         if repository.CACHE_MANIFESTLOG_CACHE in caches:
             self.manifestlog.update_caches(transaction=tr)
 
         if repository.CACHE_REV_BRANCH in caches:
             rbc = unfi.revbranchcache()
             for r in unfi.changelog:
                 rbc.branchinfo(r)
             rbc.write()
 
         if repository.CACHE_FULL_MANIFEST in caches:
             # ensure the working copy parents are in the manifestfulltextcache
             for ctx in self[b'.'].parents():
                 ctx.manifest()  # accessing the manifest is enough
 
         if repository.CACHE_FILE_NODE_TAGS in caches:
             # accessing fnode cache warms the cache
             tagsmod.fnoderevs(self.ui, unfi, unfi.changelog.revs())
 
         if repository.CACHE_TAGS_DEFAULT in caches:
             # accessing tags warm the cache
             self.tags()
         if repository.CACHE_TAGS_SERVED in caches:
             self.filtered(b'served').tags()
 
         if repository.CACHE_BRANCHMAP_ALL in caches:
             # The CACHE_BRANCHMAP_ALL updates lazily-loaded caches immediately,
             # so we're forcing a write to cause these caches to be warmed up
             # even if they haven't explicitly been requested yet (if they've
             # never been used by hg, they won't ever have been written, even if
             # they're a subset of another kind of cache that *has* been used).
             for filt in repoview.filtertable.keys():
                 filtered = self.filtered(filt)
                 filtered.branchmap().write(filtered)
 
     def invalidatecaches(self):
 
         if '_tagscache' in vars(self):
             # can't use delattr on proxy
             del self.__dict__['_tagscache']
 
         self._branchcaches.clear()
         self.invalidatevolatilesets()
         self._sparsesignaturecache.clear()
 
     def invalidatevolatilesets(self):
         self.filteredrevcache.clear()
         obsolete.clearobscaches(self)
         self._quick_access_changeid_invalidate()
 
     def invalidatedirstate(self):
         """Invalidates the dirstate, causing the next call to dirstate
         to check if it was modified since the last time it was read,
         rereading it if it has.
 
         This is different to dirstate.invalidate() that it doesn't always
         rereads the dirstate. Use dirstate.invalidate() if you want to
         explicitly read the dirstate again (i.e. restoring it to a previous
         known good state)."""
         if hasunfilteredcache(self, 'dirstate'):
             for k in self.dirstate._filecache:
                 try:
                     delattr(self.dirstate, k)
                 except AttributeError:
                     pass
             delattr(self.unfiltered(), 'dirstate')
 
     def invalidate(self, clearfilecache=False):
         """Invalidates both store and non-store parts other than dirstate
 
         If a transaction is running, invalidation of store is omitted,
         because discarding in-memory changes might cause inconsistency
         (e.g. incomplete fncache causes unintentional failure, but
         redundant one doesn't).
         """
         unfiltered = self.unfiltered()  # all file caches are stored unfiltered
         for k in list(self._filecache.keys()):
             # dirstate is invalidated separately in invalidatedirstate()
             if k == b'dirstate':
                 continue
             if (
                 k == b'changelog'
                 and self.currenttransaction()
                 and self.changelog._delayed
             ):
                 # The changelog object may store unwritten revisions. We don't
                 # want to lose them.
                 # TODO: Solve the problem instead of working around it.
                 continue
 
             if clearfilecache:
                 del self._filecache[k]
             try:
                 delattr(unfiltered, k)
             except AttributeError:
                 pass
         self.invalidatecaches()
         if not self.currenttransaction():
             # TODO: Changing contents of store outside transaction
             # causes inconsistency. We should make in-memory store
             # changes detectable, and abort if changed.
             self.store.invalidatecaches()
 
     def invalidateall(self):
         """Fully invalidates both store and non-store parts, causing the
         subsequent operation to reread any outside changes."""
         # extension should hook this to invalidate its caches
         self.invalidate()
         self.invalidatedirstate()
 
     @unfilteredmethod
     def _refreshfilecachestats(self, tr):
         """Reload stats of cached files so that they are flagged as valid"""
         for k, ce in self._filecache.items():
             k = pycompat.sysstr(k)
             if k == 'dirstate' or k not in self.__dict__:
                 continue
             ce.refresh()
 
     def _lock(
         self,
         vfs,
         lockname,
         wait,
         releasefn,
         acquirefn,
         desc,
     ):
         timeout = 0
         warntimeout = 0
         if wait:
             timeout = self.ui.configint(b"ui", b"timeout")
             warntimeout = self.ui.configint(b"ui", b"timeout.warn")
         # internal config: ui.signal-safe-lock
         signalsafe = self.ui.configbool(b'ui', b'signal-safe-lock')
 
         l = lockmod.trylock(
             self.ui,
             vfs,
             lockname,
             timeout,
             warntimeout,
             releasefn=releasefn,
             acquirefn=acquirefn,
             desc=desc,
             signalsafe=signalsafe,
         )
         return l
 
     def _afterlock(self, callback):
         """add a callback to be run when the repository is fully unlocked
 
         The callback will be executed when the outermost lock is released
         (with wlock being higher level than 'lock')."""
         for ref in (self._wlockref, self._lockref):
             l = ref and ref()
             if l and l.held:
                 l.postrelease.append(callback)
                 break
         else:  # no lock have been found.
             callback(True)
 
     def lock(self, wait=True):
         """Lock the repository store (.hg/store) and return a weak reference
         to the lock. Use this before modifying the store (e.g. committing or
         stripping). If you are opening a transaction, get a lock as well.)
 
         If both 'lock' and 'wlock' must be acquired, ensure you always acquires
         'wlock' first to avoid a dead-lock hazard."""
         l = self._currentlock(self._lockref)
         if l is not None:
             l.lock()
             return l
 
         l = self._lock(
             vfs=self.svfs,
             lockname=b"lock",
             wait=wait,
             releasefn=None,
             acquirefn=self.invalidate,
             desc=_(b'repository %s') % self.origroot,
         )
         self._lockref = weakref.ref(l)
         return l
 
     def wlock(self, wait=True):
         """Lock the non-store parts of the repository (everything under
         .hg except .hg/store) and return a weak reference to the lock.
 
         Use this before modifying files in .hg.
 
         If both 'lock' and 'wlock' must be acquired, ensure you always acquires
         'wlock' first to avoid a dead-lock hazard."""
         l = self._wlockref() if self._wlockref else None
         if l is not None and l.held:
             l.lock()
             return l
 
         # We do not need to check for non-waiting lock acquisition.  Such
         # acquisition would not cause dead-lock as they would just fail.
         if wait and (
             self.ui.configbool(b'devel', b'all-warnings')
             or self.ui.configbool(b'devel', b'check-locks')
         ):
             if self._currentlock(self._lockref) is not None:
                 self.ui.develwarn(b'"wlock" acquired after "lock"')
 
         def unlock():
             if self.dirstate.pendingparentchange():
                 self.dirstate.invalidate()
             else:
                 self.dirstate.write(None)
 
             self._filecache[b'dirstate'].refresh()
 
         l = self._lock(
             self.vfs,
             b"wlock",
             wait,
             unlock,
             self.invalidatedirstate,
             _(b'working directory of %s') % self.origroot,
         )
         self._wlockref = weakref.ref(l)
         return l
 
     def _currentlock(self, lockref):
         """Returns the lock if it's held, or None if it's not."""
         if lockref is None:
             return None
         l = lockref()
         if l is None or not l.held:
             return None
         return l
 
     def currentwlock(self):
         """Returns the wlock if it's held, or None if it's not."""
         return self._currentlock(self._wlockref)
 
     def checkcommitpatterns(self, wctx, match, status, fail):
         """check for commit arguments that aren't committable"""
         if match.isexact() or match.prefix():
             matched = set(status.modified + status.added + status.removed)
 
             for f in match.files():
                 f = self.dirstate.normalize(f)
                 if f == b'.' or f in matched or f in wctx.substate:
                     continue
                 if f in status.deleted:
                     fail(f, _(b'file not found!'))
                 # Is it a directory that exists or used to exist?
                 if self.wvfs.isdir(f) or wctx.p1().hasdir(f):
                     d = f + b'/'
                     for mf in matched:
                         if mf.startswith(d):
                             break
                     else:
                         fail(f, _(b"no match under directory!"))
                 elif f not in self.dirstate:
                     fail(f, _(b"file not tracked!"))
 
     @unfilteredmethod
     def commit(
         self,
         text=b"",
         user=None,
         date=None,
         match=None,
         force=False,
         editor=None,
         extra=None,
     ):
         """Add a new revision to current repository.
 
         Revision information is gathered from the working directory,
         match can be used to filter the committed files. If editor is
         supplied, it is called to get a commit message.
         """
         if extra is None:
             extra = {}
 
         def fail(f, msg):
             raise error.InputError(b'%s: %s' % (f, msg))
 
         if not match:
             match = matchmod.always()
 
         if not force:
             match.bad = fail
 
         # lock() for recent changelog (see issue4368)
         with self.wlock(), self.lock():
             wctx = self[None]
             merge = len(wctx.parents()) > 1
 
             if not force and merge and not match.always():
                 raise error.Abort(
                     _(
                         b'cannot partially commit a merge '
                         b'(do not specify files or patterns)'
                     )
                 )
 
             status = self.status(match=match, clean=force)
             if force:
                 status.modified.extend(
                     status.clean
                 )  # mq may commit clean files
 
             # check subrepos
             subs, commitsubs, newstate = subrepoutil.precommit(
                 self.ui, wctx, status, match, force=force
             )
 
             # make sure all explicit patterns are matched
             if not force:
                 self.checkcommitpatterns(wctx, match, status, fail)
 
             cctx = context.workingcommitctx(
                 self, status, text, user, date, extra
             )
 
             ms = mergestatemod.mergestate.read(self)
             mergeutil.checkunresolved(ms)
 
             # internal config: ui.allowemptycommit
             if cctx.isempty() and not self.ui.configbool(
                 b'ui', b'allowemptycommit'
             ):
                 self.ui.debug(b'nothing to commit, clearing merge state\n')
                 ms.reset()
                 return None
 
             if merge and cctx.deleted():
                 raise error.Abort(_(b"cannot commit merge with missing files"))
 
             if editor:
                 cctx._text = editor(self, cctx, subs)
             edited = text != cctx._text
 
             # Save commit message in case this transaction gets rolled back
             # (e.g. by a pretxncommit hook).  Leave the content alone on
             # the assumption that the user will use the same editor again.
             msg_path = self.savecommitmessage(cctx._text)
 
             # commit subs and write new state
             if subs:
                 uipathfn = scmutil.getuipathfn(self)
                 for s in sorted(commitsubs):
                     sub = wctx.sub(s)
                     self.ui.status(
                         _(b'committing subrepository %s\n')
                         % uipathfn(subrepoutil.subrelpath(sub))
                     )
                     sr = sub.commit(cctx._text, user, date)
                     newstate[s] = (newstate[s][0], sr)
                 subrepoutil.writestate(self, newstate)
 
             p1, p2 = self.dirstate.parents()
             hookp1, hookp2 = hex(p1), (p2 != self.nullid and hex(p2) or b'')
             try:
                 self.hook(
                     b"precommit", throw=True, parent1=hookp1, parent2=hookp2
                 )
                 with self.transaction(b'commit'):
                     ret = self.commitctx(cctx, True)
                     # update bookmarks, dirstate and mergestate
                     bookmarks.update(self, [p1, p2], ret)
                     cctx.markcommitted(ret)
                     ms.reset()
             except:  # re-raises
                 if edited:
                     self.ui.write(
                         _(b'note: commit message saved in %s\n') % msg_path
                     )
                     self.ui.write(
                         _(
                             b"note: use 'hg commit --logfile "
                             b"%s --edit' to reuse it\n"
                         )
                         % msg_path
                     )
                 raise
 
         def commithook(unused_success):
             # hack for command that use a temporary commit (eg: histedit)
             # temporary commit got stripped before hook release
             if self.changelog.hasnode(ret):
                 self.hook(
                     b"commit", node=hex(ret), parent1=hookp1, parent2=hookp2
                 )
 
         self._afterlock(commithook)
         return ret
 
     @unfilteredmethod
     def commitctx(self, ctx, error=False, origctx=None):
         return commit.commitctx(self, ctx, error=error, origctx=origctx)
 
     @unfilteredmethod
     def destroying(self):
         """Inform the repository that nodes are about to be destroyed.
         Intended for use by strip and rollback, so there's a common
         place for anything that has to be done before destroying history.
 
         This is mostly useful for saving state that is in memory and waiting
         to be flushed when the current lock is released. Because a call to
         destroyed is imminent, the repo will be invalidated causing those
         changes to stay in memory (waiting for the next unlock), or vanish
         completely.
         """
         # When using the same lock to commit and strip, the phasecache is left
         # dirty after committing. Then when we strip, the repo is invalidated,
         # causing those changes to disappear.
         if '_phasecache' in vars(self):
             self._phasecache.write()
 
     @unfilteredmethod
     def destroyed(self):
         """Inform the repository that nodes have been destroyed.
         Intended for use by strip and rollback, so there's a common
         place for anything that has to be done after destroying history.
         """
         # When one tries to:
         # 1) destroy nodes thus calling this method (e.g. strip)
         # 2) use phasecache somewhere (e.g. commit)
         #
         # then 2) will fail because the phasecache contains nodes that were
         # removed. We can either remove phasecache from the filecache,
         # causing it to reload next time it is accessed, or simply filter
         # the removed nodes now and write the updated cache.
         self._phasecache.filterunknown(self)
         self._phasecache.write()
 
         # refresh all repository caches
         self.updatecaches()
 
         # Ensure the persistent tag cache is updated.  Doing it now
         # means that the tag cache only has to worry about destroyed
         # heads immediately after a strip/rollback.  That in turn
         # guarantees that "cachetip == currenttip" (comparing both rev
         # and node) always means no nodes have been added or destroyed.
 
         # XXX this is suboptimal when qrefresh'ing: we strip the current
         # head, refresh the tag cache, then immediately add a new head.
         # But I think doing it this way is necessary for the "instant
         # tag cache retrieval" case to work.
         self.invalidate()
 
     def status(
         self,
         node1=b'.',
         node2=None,
         match=None,
         ignored=False,
         clean=False,
         unknown=False,
         listsubrepos=False,
     ):
         '''a convenience method that calls node1.status(node2)'''
         return self[node1].status(
             node2, match, ignored, clean, unknown, listsubrepos
         )
 
     def addpostdsstatus(self, ps):
         """Add a callback to run within the wlock, at the point at which status
         fixups happen.
 
         On status completion, callback(wctx, status) will be called with the
         wlock held, unless the dirstate has changed from underneath or the wlock
         couldn't be grabbed.
 
         Callbacks should not capture and use a cached copy of the dirstate --
         it might change in the meanwhile. Instead, they should access the
         dirstate via wctx.repo().dirstate.
 
         This list is emptied out after each status run -- extensions should
         make sure it adds to this list each time dirstate.status is called.
         Extensions should also make sure they don't call this for statuses
         that don't involve the dirstate.
         """
 
         # The list is located here for uniqueness reasons -- it is actually
         # managed by the workingctx, but that isn't unique per-repo.
         self._postdsstatus.append(ps)
 
     def postdsstatus(self):
         """Used by workingctx to get the list of post-dirstate-status hooks."""
         return self._postdsstatus
 
     def clearpostdsstatus(self):
         """Used by workingctx to clear post-dirstate-status hooks."""
         del self._postdsstatus[:]
 
     def heads(self, start=None):
         if start is None:
             cl = self.changelog
             headrevs = reversed(cl.headrevs())
             return [cl.node(rev) for rev in headrevs]
 
         heads = self.changelog.heads(start)
         # sort the output in rev descending order
         return sorted(heads, key=self.changelog.rev, reverse=True)
 
     def branchheads(self, branch=None, start=None, closed=False):
         """return a (possibly filtered) list of heads for the given branch
 
         Heads are returned in topological order, from newest to oldest.
         If branch is None, use the dirstate branch.
         If start is not None, return only heads reachable from start.
         If closed is True, return heads that are marked as closed as well.
         """
         if branch is None:
             branch = self[None].branch()
         branches = self.branchmap()
         if not branches.hasbranch(branch):
             return []
         # the cache returns heads ordered lowest to highest
         bheads = list(reversed(branches.branchheads(branch, closed=closed)))
         if start is not None:
             # filter out the heads that cannot be reached from startrev
             fbheads = set(self.changelog.nodesbetween([start], bheads)[2])
             bheads = [h for h in bheads if h in fbheads]
         return bheads
 
     def branches(self, nodes):
         if not nodes:
             nodes = [self.changelog.tip()]
         b = []
         for n in nodes:
             t = n
             while True:
                 p = self.changelog.parents(n)
                 if p[1] != self.nullid or p[0] == self.nullid:
                     b.append((t, n, p[0], p[1]))
                     break
                 n = p[0]
         return b
 
     def between(self, pairs):
         r = []
 
         for top, bottom in pairs:
             n, l, i = top, [], 0
             f = 1
 
             while n != bottom and n != self.nullid:
                 p = self.changelog.parents(n)[0]
                 if i == f:
                     l.append(n)
                     f = f * 2
                 n = p
                 i += 1
 
             r.append(l)
 
         return r
 
     def checkpush(self, pushop):
         """Extensions can override this function if additional checks have
         to be performed before pushing, or call it if they override push
         command.
         """
 
     @unfilteredpropertycache
     def prepushoutgoinghooks(self):
         """Return util.hooks consists of a pushop with repo, remote, outgoing
         methods, which are called before pushing changesets.
         """
         return util.hooks()
 
     def pushkey(self, namespace, key, old, new):
         try:
             tr = self.currenttransaction()
             hookargs = {}
             if tr is not None:
                 hookargs.update(tr.hookargs)
             hookargs = pycompat.strkwargs(hookargs)
             hookargs['namespace'] = namespace
             hookargs['key'] = key
             hookargs['old'] = old
             hookargs['new'] = new
             self.hook(b'prepushkey', throw=True, **hookargs)
         except error.HookAbort as exc:
             self.ui.write_err(_(b"pushkey-abort: %s\n") % exc)
             if exc.hint:
                 self.ui.write_err(_(b"(%s)\n") % exc.hint)
             return False
         self.ui.debug(b'pushing key for "%s:%s"\n' % (namespace, key))
         ret = pushkey.push(self, namespace, key, old, new)
 
         def runhook(unused_success):
             self.hook(
                 b'pushkey',
                 namespace=namespace,
                 key=key,
                 old=old,
                 new=new,
                 ret=ret,
             )
 
         self._afterlock(runhook)
         return ret
 
     def listkeys(self, namespace):
         self.hook(b'prelistkeys', throw=True, namespace=namespace)
         self.ui.debug(b'listing keys for "%s"\n' % namespace)
         values = pushkey.list(self, namespace)
         self.hook(b'listkeys', namespace=namespace, values=values)
         return values
 
     def debugwireargs(self, one, two, three=None, four=None, five=None):
         '''used to test argument passing over the wire'''
         return b"%s %s %s %s %s" % (
             one,
             two,
             pycompat.bytestr(three),
             pycompat.bytestr(four),
             pycompat.bytestr(five),
         )
 
     def savecommitmessage(self, text):
         fp = self.vfs(b'last-message.txt', b'wb')
         try:
             fp.write(text)
         finally:
             fp.close()
         return self.pathto(fp.name[len(self.root) + 1 :])
 
     def register_wanted_sidedata(self, category):
         if repository.REPO_FEATURE_SIDE_DATA not in self.features:
             # Only revlogv2 repos can want sidedata.
             return
         self._wanted_sidedata.add(pycompat.bytestr(category))
 
     def register_sidedata_computer(
         self, kind, category, keys, computer, flags, replace=False
     ):
         if kind not in revlogconst.ALL_KINDS:
             msg = _(b"unexpected revlog kind '%s'.")
             raise error.ProgrammingError(msg % kind)
         category = pycompat.bytestr(category)
         already_registered = category in self._sidedata_computers.get(kind, [])
         if already_registered and not replace:
             msg = _(
                 b"cannot register a sidedata computer twice for category '%s'."
             )
             raise error.ProgrammingError(msg % category)
         if replace and not already_registered:
             msg = _(
                 b"cannot replace a sidedata computer that isn't registered "
                 b"for category '%s'."
             )
             raise error.ProgrammingError(msg % category)
         self._sidedata_computers.setdefault(kind, {})
         self._sidedata_computers[kind][category] = (keys, computer, flags)
 
 
 # used to avoid circular references so destructors work
 def aftertrans(files):
     renamefiles = [tuple(t) for t in files]
 
     def a():
         for vfs, src, dest in renamefiles:
             # if src and dest refer to a same file, vfs.rename is a no-op,
             # leaving both src and dest on disk. delete dest to make sure
             # the rename couldn't be such a no-op.
             vfs.tryunlink(dest)
             try:
                 vfs.rename(src, dest)
             except FileNotFoundError:  # journal file does not yet exist
                 pass
 
     return a
 
 
 def undoname(fn: bytes) -> bytes:
     base, name = os.path.split(fn)
     assert name.startswith(b'journal')
     return os.path.join(base, name.replace(b'journal', b'undo', 1))
 
 
 def instance(ui, path: bytes, create, intents=None, createopts=None):
 
     # prevent cyclic import localrepo -> upgrade -> localrepo
     from . import upgrade
 
     localpath = urlutil.urllocalpath(path)
     if create:
         createrepository(ui, localpath, createopts=createopts)
 
     def repo_maker():
         return makelocalrepository(ui, localpath, intents=intents)
 
     repo = repo_maker()
     repo = upgrade.may_auto_upgrade(repo, repo_maker)
     return repo
 
 
 def islocal(path: bytes) -> bool:
     return True
 
 
 def defaultcreateopts(ui, createopts=None):
     """Populate the default creation options for a repository.
 
     A dictionary of explicitly requested creation options can be passed
     in. Missing keys will be populated.
     """
     createopts = dict(createopts or {})
 
     if b'backend' not in createopts:
         # experimental config: storage.new-repo-backend
         createopts[b'backend'] = ui.config(b'storage', b'new-repo-backend')
 
     return createopts
 
 
 def clone_requirements(ui, createopts, srcrepo):
     """clone the requirements of a local repo for a local clone
 
     The store requirements are unchanged while the working copy requirements
     depends on the configuration
     """
     target_requirements = set()
     if not srcrepo.requirements:
         # this is a legacy revlog "v0" repository, we cannot do anything fancy
         # with it.
         return target_requirements
     createopts = defaultcreateopts(ui, createopts=createopts)
     for r in newreporequirements(ui, createopts):
         if r in requirementsmod.WORKING_DIR_REQUIREMENTS:
             target_requirements.add(r)
 
     for r in srcrepo.requirements:
         if r not in requirementsmod.WORKING_DIR_REQUIREMENTS:
             target_requirements.add(r)
     return target_requirements
 
 
 def newreporequirements(ui, createopts):
     """Determine the set of requirements for a new local repository.
 
     Extensions can wrap this function to specify custom requirements for
     new repositories.
     """
 
     if b'backend' not in createopts:
         raise error.ProgrammingError(
             b'backend key not present in createopts; '
             b'was defaultcreateopts() called?'
         )
 
     if createopts[b'backend'] != b'revlogv1':
         raise error.Abort(
             _(
                 b'unable to determine repository requirements for '
                 b'storage backend: %s'
             )
             % createopts[b'backend']
         )
 
     requirements = {requirementsmod.REVLOGV1_REQUIREMENT}
     if ui.configbool(b'format', b'usestore'):
         requirements.add(requirementsmod.STORE_REQUIREMENT)
         if ui.configbool(b'format', b'usefncache'):
             requirements.add(requirementsmod.FNCACHE_REQUIREMENT)
             if ui.configbool(b'format', b'dotencode'):
                 requirements.add(requirementsmod.DOTENCODE_REQUIREMENT)
 
     compengines = ui.configlist(b'format', b'revlog-compression')
     for compengine in compengines:
         if compengine in util.compengines:
             engine = util.compengines[compengine]
             if engine.available() and engine.revlogheader():
                 break
     else:
         raise error.Abort(
             _(
                 b'compression engines %s defined by '
                 b'format.revlog-compression not available'
             )
             % b', '.join(b'"%s"' % e for e in compengines),
             hint=_(
                 b'run "hg debuginstall" to list available '
                 b'compression engines'
             ),
         )
 
     # zlib is the historical default and doesn't need an explicit requirement.
     if compengine == b'zstd':
         requirements.add(b'revlog-compression-zstd')
     elif compengine != b'zlib':
         requirements.add(b'exp-compression-%s' % compengine)
 
     if scmutil.gdinitconfig(ui):
         requirements.add(requirementsmod.GENERALDELTA_REQUIREMENT)
         if ui.configbool(b'format', b'sparse-revlog'):
             requirements.add(requirementsmod.SPARSEREVLOG_REQUIREMENT)
 
     # experimental config: format.use-dirstate-v2
     # Keep this logic in sync with `has_dirstate_v2()` in `tests/hghave.py`
     if ui.configbool(b'format', b'use-dirstate-v2'):
         requirements.add(requirementsmod.DIRSTATE_V2_REQUIREMENT)
 
     # experimental config: format.exp-use-copies-side-data-changeset
     if ui.configbool(b'format', b'exp-use-copies-side-data-changeset'):
         requirements.add(requirementsmod.CHANGELOGV2_REQUIREMENT)
         requirements.add(requirementsmod.COPIESSDC_REQUIREMENT)
     if ui.configbool(b'experimental', b'treemanifest'):
         requirements.add(requirementsmod.TREEMANIFEST_REQUIREMENT)
 
     changelogv2 = ui.config(b'format', b'exp-use-changelog-v2')
     if changelogv2 == b'enable-unstable-format-and-corrupt-my-data':
         requirements.add(requirementsmod.CHANGELOGV2_REQUIREMENT)
 
     revlogv2 = ui.config(b'experimental', b'revlogv2')
     if revlogv2 == b'enable-unstable-format-and-corrupt-my-data':
         requirements.discard(requirementsmod.REVLOGV1_REQUIREMENT)
         requirements.add(requirementsmod.REVLOGV2_REQUIREMENT)
     # experimental config: format.internal-phase
     if ui.configbool(b'format', b'use-internal-phase'):
         requirements.add(requirementsmod.INTERNAL_PHASE_REQUIREMENT)
 
     # experimental config: format.exp-archived-phase
     if ui.configbool(b'format', b'exp-archived-phase'):
         requirements.add(requirementsmod.ARCHIVED_PHASE_REQUIREMENT)
 
     if createopts.get(b'narrowfiles'):
         requirements.add(requirementsmod.NARROW_REQUIREMENT)
 
     if createopts.get(b'lfs'):
         requirements.add(b'lfs')
 
     if ui.configbool(b'format', b'bookmarks-in-store'):
         requirements.add(requirementsmod.BOOKMARKS_IN_STORE_REQUIREMENT)
 
     if ui.configbool(b'format', b'use-persistent-nodemap'):
         requirements.add(requirementsmod.NODEMAP_REQUIREMENT)
 
     # if share-safe is enabled, let's create the new repository with the new
     # requirement
     if ui.configbool(b'format', b'use-share-safe'):
         requirements.add(requirementsmod.SHARESAFE_REQUIREMENT)
 
     # if we are creating a share-repo¹  we have to handle requirement
     # differently.
     #
     # [1] (i.e. reusing the store from another repository, just having a
     # working copy)
     if b'sharedrepo' in createopts:
         source_requirements = set(createopts[b'sharedrepo'].requirements)
 
         if requirementsmod.SHARESAFE_REQUIREMENT not in source_requirements:
             # share to an old school repository, we have to copy the
             # requirements and hope for the best.
             requirements = source_requirements
         else:
             # We have control on the working copy only, so "copy" the non
             # working copy part over, ignoring previous logic.
             to_drop = set()
             for req in requirements:
                 if req in requirementsmod.WORKING_DIR_REQUIREMENTS:
                     continue
                 if req in source_requirements:
                     continue
                 to_drop.add(req)
             requirements -= to_drop
             requirements |= source_requirements
 
         if createopts.get(b'sharedrelative'):
             requirements.add(requirementsmod.RELATIVE_SHARED_REQUIREMENT)
         else:
             requirements.add(requirementsmod.SHARED_REQUIREMENT)
 
     if ui.configbool(b'format', b'use-dirstate-tracked-hint'):
         version = ui.configint(b'format', b'use-dirstate-tracked-hint.version')
         msg = _(b"ignoring unknown tracked key version: %d\n")
         hint = _(
             b"see `hg help config.format.use-dirstate-tracked-hint-version"
         )
         if version != 1:
             ui.warn(msg % version, hint=hint)
         else:
             requirements.add(requirementsmod.DIRSTATE_TRACKED_HINT_V1)
 
     return requirements
 
 
 def checkrequirementscompat(ui, requirements):
     """Checks compatibility of repository requirements enabled and disabled.
 
     Returns a set of requirements which needs to be dropped because dependend
     requirements are not enabled. Also warns users about it"""
 
     dropped = set()
 
     if requirementsmod.STORE_REQUIREMENT not in requirements:
         if requirementsmod.BOOKMARKS_IN_STORE_REQUIREMENT in requirements:
             ui.warn(
                 _(
                     b'ignoring enabled \'format.bookmarks-in-store\' config '
                     b'beacuse it is incompatible with disabled '
                     b'\'format.usestore\' config\n'
                 )
             )
             dropped.add(requirementsmod.BOOKMARKS_IN_STORE_REQUIREMENT)
 
         if (
             requirementsmod.SHARED_REQUIREMENT in requirements
             or requirementsmod.RELATIVE_SHARED_REQUIREMENT in requirements
         ):
             raise error.Abort(
                 _(
                     b"cannot create shared repository as source was created"
                     b" with 'format.usestore' config disabled"
                 )
             )
 
         if requirementsmod.SHARESAFE_REQUIREMENT in requirements:
             if ui.hasconfig(b'format', b'use-share-safe'):
                 msg = _(
                     b"ignoring enabled 'format.use-share-safe' config because "
                     b"it is incompatible with disabled 'format.usestore'"
                     b" config\n"
                 )
                 ui.warn(msg)
             dropped.add(requirementsmod.SHARESAFE_REQUIREMENT)
 
     return dropped
 
 
 def filterknowncreateopts(ui, createopts):
     """Filters a dict of repo creation options against options that are known.
 
     Receives a dict of repo creation options and returns a dict of those
     options that we don't know how to handle.
 
     This function is called as part of repository creation. If the
     returned dict contains any items, repository creation will not
     be allowed, as it means there was a request to create a repository
     with options not recognized by loaded code.
 
     Extensions can wrap this function to filter out creation options
     they know how to handle.
     """
     known = {
         b'backend',
         b'lfs',
         b'narrowfiles',
         b'sharedrepo',
         b'sharedrelative',
         b'shareditems',
         b'shallowfilestore',
     }
 
     return {k: v for k, v in createopts.items() if k not in known}
 
 
 def createrepository(ui, path: bytes, createopts=None, requirements=None):
     """Create a new repository in a vfs.
 
     ``path`` path to the new repo's working directory.
     ``createopts`` options for the new repository.
     ``requirement`` predefined set of requirements.
                     (incompatible with ``createopts``)
 
     The following keys for ``createopts`` are recognized:
 
     backend
        The storage backend to use.
     lfs
        Repository will be created with ``lfs`` requirement. The lfs extension
        will automatically be loaded when the repository is accessed.
     narrowfiles
        Set up repository to support narrow file storage.
     sharedrepo
        Repository object from which storage should be shared.
     sharedrelative
        Boolean indicating if the path to the shared repo should be
        stored as relative. By default, the pointer to the "parent" repo
        is stored as an absolute path.
     shareditems
        Set of items to share to the new repository (in addition to storage).
     shallowfilestore
        Indicates that storage for files should be shallow (not all ancestor
        revisions are known).
     """
 
     if requirements is not None:
         if createopts is not None:
             msg = b'cannot specify both createopts and requirements'
             raise error.ProgrammingError(msg)
         createopts = {}
     else:
         createopts = defaultcreateopts(ui, createopts=createopts)
 
         unknownopts = filterknowncreateopts(ui, createopts)
 
         if not isinstance(unknownopts, dict):
             raise error.ProgrammingError(
                 b'filterknowncreateopts() did not return a dict'
             )
 
         if unknownopts:
             raise error.Abort(
                 _(
                     b'unable to create repository because of unknown '
                     b'creation option: %s'
                 )
                 % b', '.join(sorted(unknownopts)),
                 hint=_(b'is a required extension not loaded?'),
             )
 
         requirements = newreporequirements(ui, createopts=createopts)
         requirements -= checkrequirementscompat(ui, requirements)
 
     wdirvfs = vfsmod.vfs(path, expandpath=True, realpath=True)
 
     hgvfs = vfsmod.vfs(wdirvfs.join(b'.hg'))
     if hgvfs.exists():
         raise error.RepoError(_(b'repository %s already exists') % path)
 
     if b'sharedrepo' in createopts:
         sharedpath = createopts[b'sharedrepo'].sharedpath
 
         if createopts.get(b'sharedrelative'):
             try:
                 sharedpath = os.path.relpath(sharedpath, hgvfs.base)
                 sharedpath = util.pconvert(sharedpath)
             except (IOError, ValueError) as e:
                 # ValueError is raised on Windows if the drive letters differ
                 # on each path.
                 raise error.Abort(
                     _(b'cannot calculate relative path'),
                     hint=stringutil.forcebytestr(e),
                 )
 
     if not wdirvfs.exists():
         wdirvfs.makedirs()
 
     hgvfs.makedir(notindexed=True)
     if b'sharedrepo' not in createopts:
         hgvfs.mkdir(b'cache')
     hgvfs.mkdir(b'wcache')
 
     has_store = requirementsmod.STORE_REQUIREMENT in requirements
     if has_store and b'sharedrepo' not in createopts:
         hgvfs.mkdir(b'store')
 
         # We create an invalid changelog outside the store so very old
         # Mercurial versions (which didn't know about the requirements
         # file) encounter an error on reading the changelog. This
         # effectively locks out old clients and prevents them from
         # mucking with a repo in an unknown format.
         #
         # The revlog header has version 65535, which won't be recognized by
         # such old clients.
         hgvfs.append(
             b'00changelog.i',
             b'\0\0\xFF\xFF dummy changelog to prevent using the old repo '
             b'layout',
         )
 
     # Filter the requirements into working copy and store ones
     wcreq, storereq = scmutil.filterrequirements(requirements)
     # write working copy ones
     scmutil.writerequires(hgvfs, wcreq)
     # If there are store requirements and the current repository
     # is not a shared one, write stored requirements
     # For new shared repository, we don't need to write the store
     # requirements as they are already present in store requires
     if storereq and b'sharedrepo' not in createopts:
         storevfs = vfsmod.vfs(hgvfs.join(b'store'), cacheaudited=True)
         scmutil.writerequires(storevfs, storereq)
 
     # Write out file telling readers where to find the shared store.
     if b'sharedrepo' in createopts:
         hgvfs.write(b'sharedpath', sharedpath)
 
     if createopts.get(b'shareditems'):
         shared = b'\n'.join(sorted(createopts[b'shareditems'])) + b'\n'
         hgvfs.write(b'shared', shared)
 
 
 def poisonrepository(repo):
     """Poison a repository instance so it can no longer be used."""
     # Perform any cleanup on the instance.
     repo.close()
 
     # Our strategy is to replace the type of the object with one that
     # has all attribute lookups result in error.
     #
     # But we have to allow the close() method because some constructors
     # of repos call close() on repo references.
     class poisonedrepository:
         def __getattribute__(self, item):
             if item == 'close':
                 return object.__getattribute__(self, item)
 
             raise error.ProgrammingError(
                 b'repo instances should not be used after unshare'
             )
 
         def close(self):
             pass
 
     # We may have a repoview, which intercepts __setattr__. So be sure
     # we operate at the lowest level possible.
     object.__setattr__(repo, '__class__', poisonedrepository)

mercurial/revlog.py

@@ -1,3354 +1,3358 b''
 # revlog.py - storage back-end for mercurial
 # coding: utf8
 #
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """Storage back-end for Mercurial.
 
 This provides efficient delta storage with O(1) retrieve and append
 and O(changes) merge between branches.
 """
 
 
 import binascii
 import collections
 import contextlib
 import io
 import os
 import struct
 import zlib
 
 # import stuff from node for others to import from revlog
 from .node import (
     bin,
     hex,
     nullrev,
     sha1nodeconstants,
     short,
     wdirrev,
 )
 from .i18n import _
 from .pycompat import getattr
 from .revlogutils.constants import (
     ALL_KINDS,
     CHANGELOGV2,
     COMP_MODE_DEFAULT,
     COMP_MODE_INLINE,
     COMP_MODE_PLAIN,
     ENTRY_RANK,
     FEATURES_BY_VERSION,
     FLAG_GENERALDELTA,
     FLAG_INLINE_DATA,
     INDEX_HEADER,
     KIND_CHANGELOG,
     KIND_FILELOG,
     RANK_UNKNOWN,
     REVLOGV0,
     REVLOGV1,
     REVLOGV1_FLAGS,
     REVLOGV2,
     REVLOGV2_FLAGS,
     REVLOG_DEFAULT_FLAGS,
     REVLOG_DEFAULT_FORMAT,
     REVLOG_DEFAULT_VERSION,
     SUPPORTED_FLAGS,
 )
 from .revlogutils.flagutil import (
     REVIDX_DEFAULT_FLAGS,
     REVIDX_ELLIPSIS,
     REVIDX_EXTSTORED,
     REVIDX_FLAGS_ORDER,
     REVIDX_HASCOPIESINFO,
     REVIDX_ISCENSORED,
     REVIDX_RAWTEXT_CHANGING_FLAGS,
 )
 from .thirdparty import attr
 from . import (
     ancestor,
     dagop,
     error,
     mdiff,
     policy,
     pycompat,
     revlogutils,
     templatefilters,
     util,
 )
 from .interfaces import (
     repository,
     util as interfaceutil,
 )
 from .revlogutils import (
     deltas as deltautil,
     docket as docketutil,
     flagutil,
     nodemap as nodemaputil,
     randomaccessfile,
     revlogv0,
     rewrite,
     sidedata as sidedatautil,
 )
 from .utils import (
     storageutil,
     stringutil,
 )
 
 # blanked usage of all the name to prevent pyflakes constraints
 # We need these name available in the module for extensions.
 
 REVLOGV0
 REVLOGV1
 REVLOGV2
 CHANGELOGV2
 FLAG_INLINE_DATA
 FLAG_GENERALDELTA
 REVLOG_DEFAULT_FLAGS
 REVLOG_DEFAULT_FORMAT
 REVLOG_DEFAULT_VERSION
 REVLOGV1_FLAGS
 REVLOGV2_FLAGS
 REVIDX_ISCENSORED
 REVIDX_ELLIPSIS
 REVIDX_HASCOPIESINFO
 REVIDX_EXTSTORED
 REVIDX_DEFAULT_FLAGS
 REVIDX_FLAGS_ORDER
 REVIDX_RAWTEXT_CHANGING_FLAGS
 
 parsers = policy.importmod('parsers')
 rustancestor = policy.importrust('ancestor')
 rustdagop = policy.importrust('dagop')
 rustrevlog = policy.importrust('revlog')
 
 # Aliased for performance.
 _zlibdecompress = zlib.decompress
 
 # max size of revlog with inline data
 _maxinline = 131072
 
 # Flag processors for REVIDX_ELLIPSIS.
 def ellipsisreadprocessor(rl, text):
     return text, False
 
 
 def ellipsiswriteprocessor(rl, text):
     return text, False
 
 
 def ellipsisrawprocessor(rl, text):
     return False
 
 
 ellipsisprocessor = (
     ellipsisreadprocessor,
     ellipsiswriteprocessor,
     ellipsisrawprocessor,
 )
 
 
 def _verify_revision(rl, skipflags, state, node):
     """Verify the integrity of the given revlog ``node`` while providing a hook
     point for extensions to influence the operation."""
     if skipflags:
         state[b'skipread'].add(node)
     else:
         # Side-effect: read content and verify hash.
         rl.revision(node)
 
 
 # True if a fast implementation for persistent-nodemap is available
 #
 # We also consider we have a "fast" implementation in "pure" python because
 # people using pure don't really have performance consideration (and a
 # wheelbarrow of other slowness source)
 HAS_FAST_PERSISTENT_NODEMAP = rustrevlog is not None or util.safehasattr(
     parsers, 'BaseIndexObject'
 )
 
 
 @interfaceutil.implementer(repository.irevisiondelta)
 @attr.s(slots=True)
 class revlogrevisiondelta:
     node = attr.ib()
     p1node = attr.ib()
     p2node = attr.ib()
     basenode = attr.ib()
     flags = attr.ib()
     baserevisionsize = attr.ib()
     revision = attr.ib()
     delta = attr.ib()
     sidedata = attr.ib()
     protocol_flags = attr.ib()
     linknode = attr.ib(default=None)
 
 
 @interfaceutil.implementer(repository.iverifyproblem)
 @attr.s(frozen=True)
 class revlogproblem:
     warning = attr.ib(default=None)
     error = attr.ib(default=None)
     node = attr.ib(default=None)
 
 
 def parse_index_v1(data, inline):
     # call the C implementation to parse the index data
     index, cache = parsers.parse_index2(data, inline)
     return index, cache
 
 
 def parse_index_v2(data, inline):
     # call the C implementation to parse the index data
     index, cache = parsers.parse_index2(data, inline, format=REVLOGV2)
     return index, cache
 
 
 def parse_index_cl_v2(data, inline):
     # call the C implementation to parse the index data
     index, cache = parsers.parse_index2(data, inline, format=CHANGELOGV2)
     return index, cache
 
 
 if util.safehasattr(parsers, 'parse_index_devel_nodemap'):
 
     def parse_index_v1_nodemap(data, inline):
         index, cache = parsers.parse_index_devel_nodemap(data, inline)
         return index, cache
 
 
 else:
     parse_index_v1_nodemap = None
 
 
 def parse_index_v1_mixed(data, inline):
     index, cache = parse_index_v1(data, inline)
     return rustrevlog.MixedIndex(index), cache
 
 
 # corresponds to uncompressed length of indexformatng (2 gigs, 4-byte
 # signed integer)
 _maxentrysize = 0x7FFFFFFF
 
 FILE_TOO_SHORT_MSG = _(
     b'cannot read from revlog %s;'
     b'  expected %d bytes from offset %d, data size is %d'
 )
 
 hexdigits = b'0123456789abcdefABCDEF'
 
 
 class revlog:
     """
     the underlying revision storage object
 
     A revlog consists of two parts, an index and the revision data.
 
     The index is a file with a fixed record size containing
     information on each revision, including its nodeid (hash), the
     nodeids of its parents, the position and offset of its data within
     the data file, and the revision it's based on. Finally, each entry
     contains a linkrev entry that can serve as a pointer to external
     data.
 
     The revision data itself is a linear collection of data chunks.
     Each chunk represents a revision and is usually represented as a
     delta against the previous chunk. To bound lookup time, runs of
     deltas are limited to about 2 times the length of the original
     version data. This makes retrieval of a version proportional to
     its size, or O(1) relative to the number of revisions.
 
     Both pieces of the revlog are written to in an append-only
     fashion, which means we never need to rewrite a file to insert or
     remove data, and can use some simple techniques to avoid the need
     for locking while reading.
 
     If checkambig, indexfile is opened with checkambig=True at
     writing, to avoid file stat ambiguity.
 
     If mmaplargeindex is True, and an mmapindexthreshold is set, the
     index will be mmapped rather than read if it is larger than the
     configured threshold.
 
     If censorable is True, the revlog can have censored revisions.
 
     If `upperboundcomp` is not None, this is the expected maximal gain from
     compression for the data content.
 
     `concurrencychecker` is an optional function that receives 3 arguments: a
     file handle, a filename, and an expected position. It should check whether
     the current position in the file handle is valid, and log/warn/fail (by
     raising).
 
     See mercurial/revlogutils/contants.py for details about the content of an
     index entry.
     """
 
     _flagserrorclass = error.RevlogError
 
     def __init__(
         self,
         opener,
         target,
         radix,
         postfix=None,  # only exist for `tmpcensored` now
         checkambig=False,
         mmaplargeindex=False,
         censorable=False,
         upperboundcomp=None,
         persistentnodemap=False,
         concurrencychecker=None,
         trypending=False,
         canonical_parent_order=True,
     ):
         """
         create a revlog object
 
         opener is a function that abstracts the file opening operation
         and can be used to implement COW semantics or the like.
 
         `target`: a (KIND, ID) tuple that identify the content stored in
         this revlog. It help the rest of the code to understand what the revlog
         is about without having to resort to heuristic and index filename
         analysis. Note: that this must be reliably be set by normal code, but
         that test, debug, or performance measurement code might not set this to
         accurate value.
         """
         self.upperboundcomp = upperboundcomp
 
         self.radix = radix
 
         self._docket_file = None
         self._indexfile = None
         self._datafile = None
         self._sidedatafile = None
         self._nodemap_file = None
         self.postfix = postfix
         self._trypending = trypending
         self.opener = opener
         if persistentnodemap:
             self._nodemap_file = nodemaputil.get_nodemap_file(self)
 
         assert target[0] in ALL_KINDS
         assert len(target) == 2
         self.target = target
         #  When True, indexfile is opened with checkambig=True at writing, to
         #  avoid file stat ambiguity.
         self._checkambig = checkambig
         self._mmaplargeindex = mmaplargeindex
         self._censorable = censorable
         # 3-tuple of (node, rev, text) for a raw revision.
         self._revisioncache = None
         # Maps rev to chain base rev.
         self._chainbasecache = util.lrucachedict(100)
         # 2-tuple of (offset, data) of raw data from the revlog at an offset.
         self._chunkcache = (0, b'')
         # How much data to read and cache into the raw revlog data cache.
         self._chunkcachesize = 65536
         self._maxchainlen = None
         self._deltabothparents = True
+        self._candidate_group_chunk_size = 0
         self._debug_delta = False
         self.index = None
         self._docket = None
         self._nodemap_docket = None
         # Mapping of partial identifiers to full nodes.
         self._pcache = {}
         # Mapping of revision integer to full node.
         self._compengine = b'zlib'
         self._compengineopts = {}
         self._maxdeltachainspan = -1
         self._withsparseread = False
         self._sparserevlog = False
         self.hassidedata = False
         self._srdensitythreshold = 0.50
         self._srmingapsize = 262144
 
         # Make copy of flag processors so each revlog instance can support
         # custom flags.
         self._flagprocessors = dict(flagutil.flagprocessors)
 
         # 3-tuple of file handles being used for active writing.
         self._writinghandles = None
         # prevent nesting of addgroup
         self._adding_group = None
 
         self._loadindex()
 
         self._concurrencychecker = concurrencychecker
 
         # parent order is supposed to be semantically irrelevant, so we
         # normally resort parents to ensure that the first parent is non-null,
         # if there is a non-null parent at all.
         # filelog abuses the parent order as flag to mark some instances of
         # meta-encoded files, so allow it to disable this behavior.
         self.canonical_parent_order = canonical_parent_order
 
     def _init_opts(self):
         """process options (from above/config) to setup associated default revlog mode
 
         These values might be affected when actually reading on disk information.
 
         The relevant values are returned for use in _loadindex().
 
         * newversionflags:
             version header to use if we need to create a new revlog
 
         * mmapindexthreshold:
             minimal index size for start to use mmap
 
         * force_nodemap:
             force the usage of a "development" version of the nodemap code
         """
         mmapindexthreshold = None
         opts = self.opener.options
 
         if b'changelogv2' in opts and self.revlog_kind == KIND_CHANGELOG:
             new_header = CHANGELOGV2
         elif b'revlogv2' in opts:
             new_header = REVLOGV2
         elif b'revlogv1' in opts:
             new_header = REVLOGV1 | FLAG_INLINE_DATA
             if b'generaldelta' in opts:
                 new_header |= FLAG_GENERALDELTA
         elif b'revlogv0' in self.opener.options:
             new_header = REVLOGV0
         else:
             new_header = REVLOG_DEFAULT_VERSION
 
         if b'chunkcachesize' in opts:
             self._chunkcachesize = opts[b'chunkcachesize']
         if b'maxchainlen' in opts:
             self._maxchainlen = opts[b'maxchainlen']
         if b'deltabothparents' in opts:
             self._deltabothparents = opts[b'deltabothparents']
+        dps_cgds = opts.get(b'delta-parent-search.candidate-group-chunk-size')
+        if dps_cgds:
+            self._candidate_group_chunk_size = dps_cgds
         self._lazydelta = bool(opts.get(b'lazydelta', True))
         self._lazydeltabase = False
         if self._lazydelta:
             self._lazydeltabase = bool(opts.get(b'lazydeltabase', False))
         if b'debug-delta' in opts:
             self._debug_delta = opts[b'debug-delta']
         if b'compengine' in opts:
             self._compengine = opts[b'compengine']
         if b'zlib.level' in opts:
             self._compengineopts[b'zlib.level'] = opts[b'zlib.level']
         if b'zstd.level' in opts:
             self._compengineopts[b'zstd.level'] = opts[b'zstd.level']
         if b'maxdeltachainspan' in opts:
             self._maxdeltachainspan = opts[b'maxdeltachainspan']
         if self._mmaplargeindex and b'mmapindexthreshold' in opts:
             mmapindexthreshold = opts[b'mmapindexthreshold']
         self._sparserevlog = bool(opts.get(b'sparse-revlog', False))
         withsparseread = bool(opts.get(b'with-sparse-read', False))
         # sparse-revlog forces sparse-read
         self._withsparseread = self._sparserevlog or withsparseread
         if b'sparse-read-density-threshold' in opts:
             self._srdensitythreshold = opts[b'sparse-read-density-threshold']
         if b'sparse-read-min-gap-size' in opts:
             self._srmingapsize = opts[b'sparse-read-min-gap-size']
         if opts.get(b'enableellipsis'):
             self._flagprocessors[REVIDX_ELLIPSIS] = ellipsisprocessor
 
         # revlog v0 doesn't have flag processors
         for flag, processor in opts.get(b'flagprocessors', {}).items():
             flagutil.insertflagprocessor(flag, processor, self._flagprocessors)
 
         if self._chunkcachesize <= 0:
             raise error.RevlogError(
                 _(b'revlog chunk cache size %r is not greater than 0')
                 % self._chunkcachesize
             )
         elif self._chunkcachesize & (self._chunkcachesize - 1):
             raise error.RevlogError(
                 _(b'revlog chunk cache size %r is not a power of 2')
                 % self._chunkcachesize
             )
         force_nodemap = opts.get(b'devel-force-nodemap', False)
         return new_header, mmapindexthreshold, force_nodemap
 
     def _get_data(self, filepath, mmap_threshold, size=None):
         """return a file content with or without mmap
 
         If the file is missing return the empty string"""
         try:
             with self.opener(filepath) as fp:
                 if mmap_threshold is not None:
                     file_size = self.opener.fstat(fp).st_size
                     if file_size >= mmap_threshold:
                         if size is not None:
                             # avoid potentiel mmap crash
                             size = min(file_size, size)
                         # TODO: should .close() to release resources without
                         # relying on Python GC
                         if size is None:
                             return util.buffer(util.mmapread(fp))
                         else:
                             return util.buffer(util.mmapread(fp, size))
                 if size is None:
                     return fp.read()
                 else:
                     return fp.read(size)
         except FileNotFoundError:
             return b''
 
     def _loadindex(self, docket=None):
 
         new_header, mmapindexthreshold, force_nodemap = self._init_opts()
 
         if self.postfix is not None:
             entry_point = b'%s.i.%s' % (self.radix, self.postfix)
         elif self._trypending and self.opener.exists(b'%s.i.a' % self.radix):
             entry_point = b'%s.i.a' % self.radix
         else:
             entry_point = b'%s.i' % self.radix
 
         if docket is not None:
             self._docket = docket
             self._docket_file = entry_point
         else:
             self._initempty = True
             entry_data = self._get_data(entry_point, mmapindexthreshold)
             if len(entry_data) > 0:
                 header = INDEX_HEADER.unpack(entry_data[:4])[0]
                 self._initempty = False
             else:
                 header = new_header
 
             self._format_flags = header & ~0xFFFF
             self._format_version = header & 0xFFFF
 
             supported_flags = SUPPORTED_FLAGS.get(self._format_version)
             if supported_flags is None:
                 msg = _(b'unknown version (%d) in revlog %s')
                 msg %= (self._format_version, self.display_id)
                 raise error.RevlogError(msg)
             elif self._format_flags & ~supported_flags:
                 msg = _(b'unknown flags (%#04x) in version %d revlog %s')
                 display_flag = self._format_flags >> 16
                 msg %= (display_flag, self._format_version, self.display_id)
                 raise error.RevlogError(msg)
 
             features = FEATURES_BY_VERSION[self._format_version]
             self._inline = features[b'inline'](self._format_flags)
             self._generaldelta = features[b'generaldelta'](self._format_flags)
             self.hassidedata = features[b'sidedata']
 
             if not features[b'docket']:
                 self._indexfile = entry_point
                 index_data = entry_data
             else:
                 self._docket_file = entry_point
                 if self._initempty:
                     self._docket = docketutil.default_docket(self, header)
                 else:
                     self._docket = docketutil.parse_docket(
                         self, entry_data, use_pending=self._trypending
                     )
 
         if self._docket is not None:
             self._indexfile = self._docket.index_filepath()
             index_data = b''
             index_size = self._docket.index_end
             if index_size > 0:
                 index_data = self._get_data(
                     self._indexfile, mmapindexthreshold, size=index_size
                 )
                 if len(index_data) < index_size:
                     msg = _(b'too few index data for %s: got %d, expected %d')
                     msg %= (self.display_id, len(index_data), index_size)
                     raise error.RevlogError(msg)
 
             self._inline = False
             # generaldelta implied by version 2 revlogs.
             self._generaldelta = True
             # the logic for persistent nodemap will be dealt with within the
             # main docket, so disable it for now.
             self._nodemap_file = None
 
         if self._docket is not None:
             self._datafile = self._docket.data_filepath()
             self._sidedatafile = self._docket.sidedata_filepath()
         elif self.postfix is None:
             self._datafile = b'%s.d' % self.radix
         else:
             self._datafile = b'%s.d.%s' % (self.radix, self.postfix)
 
         self.nodeconstants = sha1nodeconstants
         self.nullid = self.nodeconstants.nullid
 
         # sparse-revlog can't be on without general-delta (issue6056)
         if not self._generaldelta:
             self._sparserevlog = False
 
         self._storedeltachains = True
 
         devel_nodemap = (
             self._nodemap_file
             and force_nodemap
             and parse_index_v1_nodemap is not None
         )
 
         use_rust_index = False
         if rustrevlog is not None:
             if self._nodemap_file is not None:
                 use_rust_index = True
             else:
                 use_rust_index = self.opener.options.get(b'rust.index')
 
         self._parse_index = parse_index_v1
         if self._format_version == REVLOGV0:
             self._parse_index = revlogv0.parse_index_v0
         elif self._format_version == REVLOGV2:
             self._parse_index = parse_index_v2
         elif self._format_version == CHANGELOGV2:
             self._parse_index = parse_index_cl_v2
         elif devel_nodemap:
             self._parse_index = parse_index_v1_nodemap
         elif use_rust_index:
             self._parse_index = parse_index_v1_mixed
         try:
             d = self._parse_index(index_data, self._inline)
             index, chunkcache = d
             use_nodemap = (
                 not self._inline
                 and self._nodemap_file is not None
                 and util.safehasattr(index, 'update_nodemap_data')
             )
             if use_nodemap:
                 nodemap_data = nodemaputil.persisted_data(self)
                 if nodemap_data is not None:
                     docket = nodemap_data[0]
                     if (
                         len(d[0]) > docket.tip_rev
                         and d[0][docket.tip_rev][7] == docket.tip_node
                     ):
                         # no changelog tampering
                         self._nodemap_docket = docket
                         index.update_nodemap_data(*nodemap_data)
         except (ValueError, IndexError):
             raise error.RevlogError(
                 _(b"index %s is corrupted") % self.display_id
             )
         self.index = index
         self._segmentfile = randomaccessfile.randomaccessfile(
             self.opener,
             (self._indexfile if self._inline else self._datafile),
             self._chunkcachesize,
             chunkcache,
         )
         self._segmentfile_sidedata = randomaccessfile.randomaccessfile(
             self.opener,
             self._sidedatafile,
             self._chunkcachesize,
         )
         # revnum -> (chain-length, sum-delta-length)
         self._chaininfocache = util.lrucachedict(500)
         # revlog header -> revlog compressor
         self._decompressors = {}
 
     @util.propertycache
     def revlog_kind(self):
         return self.target[0]
 
     @util.propertycache
     def display_id(self):
         """The public facing "ID" of the revlog that we use in message"""
         if self.revlog_kind == KIND_FILELOG:
             # Reference the file without the "data/" prefix, so it is familiar
             # to the user.
             return self.target[1]
         else:
             return self.radix
 
     def _get_decompressor(self, t):
         try:
             compressor = self._decompressors[t]
         except KeyError:
             try:
                 engine = util.compengines.forrevlogheader(t)
                 compressor = engine.revlogcompressor(self._compengineopts)
                 self._decompressors[t] = compressor
             except KeyError:
                 raise error.RevlogError(
                     _(b'unknown compression type %s') % binascii.hexlify(t)
                 )
         return compressor
 
     @util.propertycache
     def _compressor(self):
         engine = util.compengines[self._compengine]
         return engine.revlogcompressor(self._compengineopts)
 
     @util.propertycache
     def _decompressor(self):
         """the default decompressor"""
         if self._docket is None:
             return None
         t = self._docket.default_compression_header
         c = self._get_decompressor(t)
         return c.decompress
 
     def _indexfp(self):
         """file object for the revlog's index file"""
         return self.opener(self._indexfile, mode=b"r")
 
     def __index_write_fp(self):
         # You should not use this directly and use `_writing` instead
         try:
             f = self.opener(
                 self._indexfile, mode=b"r+", checkambig=self._checkambig
             )
             if self._docket is None:
                 f.seek(0, os.SEEK_END)
             else:
                 f.seek(self._docket.index_end, os.SEEK_SET)
             return f
         except FileNotFoundError:
             return self.opener(
                 self._indexfile, mode=b"w+", checkambig=self._checkambig
             )
 
     def __index_new_fp(self):
         # You should not use this unless you are upgrading from inline revlog
         return self.opener(
             self._indexfile,
             mode=b"w",
             checkambig=self._checkambig,
             atomictemp=True,
         )
 
     def _datafp(self, mode=b'r'):
         """file object for the revlog's data file"""
         return self.opener(self._datafile, mode=mode)
 
     @contextlib.contextmanager
     def _sidedatareadfp(self):
         """file object suitable to read sidedata"""
         if self._writinghandles:
             yield self._writinghandles[2]
         else:
             with self.opener(self._sidedatafile) as fp:
                 yield fp
 
     def tiprev(self):
         return len(self.index) - 1
 
     def tip(self):
         return self.node(self.tiprev())
 
     def __contains__(self, rev):
         return 0 <= rev < len(self)
 
     def __len__(self):
         return len(self.index)
 
     def __iter__(self):
         return iter(range(len(self)))
 
     def revs(self, start=0, stop=None):
         """iterate over all rev in this revlog (from start to stop)"""
         return storageutil.iterrevs(len(self), start=start, stop=stop)
 
     def hasnode(self, node):
         try:
             self.rev(node)
             return True
         except KeyError:
             return False
 
     def candelta(self, baserev, rev):
         """whether two revisions (baserev, rev) can be delta-ed or not"""
         # Disable delta if either rev requires a content-changing flag
         # processor (ex. LFS). This is because such flag processor can alter
         # the rawtext content that the delta will be based on, and two clients
         # could have a same revlog node with different flags (i.e. different
         # rawtext contents) and the delta could be incompatible.
         if (self.flags(baserev) & REVIDX_RAWTEXT_CHANGING_FLAGS) or (
             self.flags(rev) & REVIDX_RAWTEXT_CHANGING_FLAGS
         ):
             return False
         return True
 
     def update_caches(self, transaction):
         if self._nodemap_file is not None:
             if transaction is None:
                 nodemaputil.update_persistent_nodemap(self)
             else:
                 nodemaputil.setup_persistent_nodemap(transaction, self)
 
     def clearcaches(self):
         self._revisioncache = None
         self._chainbasecache.clear()
         self._segmentfile.clear_cache()
         self._segmentfile_sidedata.clear_cache()
         self._pcache = {}
         self._nodemap_docket = None
         self.index.clearcaches()
         # The python code is the one responsible for validating the docket, we
         # end up having to refresh it here.
         use_nodemap = (
             not self._inline
             and self._nodemap_file is not None
             and util.safehasattr(self.index, 'update_nodemap_data')
         )
         if use_nodemap:
             nodemap_data = nodemaputil.persisted_data(self)
             if nodemap_data is not None:
                 self._nodemap_docket = nodemap_data[0]
                 self.index.update_nodemap_data(*nodemap_data)
 
     def rev(self, node):
         try:
             return self.index.rev(node)
         except TypeError:
             raise
         except error.RevlogError:
             # parsers.c radix tree lookup failed
             if (
                 node == self.nodeconstants.wdirid
                 or node in self.nodeconstants.wdirfilenodeids
             ):
                 raise error.WdirUnsupported
             raise error.LookupError(node, self.display_id, _(b'no node'))
 
     # Accessors for index entries.
 
     # First tuple entry is 8 bytes. First 6 bytes are offset. Last 2 bytes
     # are flags.
     def start(self, rev):
         return int(self.index[rev][0] >> 16)
 
     def sidedata_cut_off(self, rev):
         sd_cut_off = self.index[rev][8]
         if sd_cut_off != 0:
             return sd_cut_off
         # This is some annoying dance, because entries without sidedata
         # currently use 0 as their ofsset. (instead of previous-offset +
         # previous-size)
         #
         # We should reconsider this sidedata → 0 sidata_offset policy.
         # In the meantime, we need this.
         while 0 <= rev:
             e = self.index[rev]
             if e[9] != 0:
                 return e[8] + e[9]
             rev -= 1
         return 0
 
     def flags(self, rev):
         return self.index[rev][0] & 0xFFFF
 
     def length(self, rev):
         return self.index[rev][1]
 
     def sidedata_length(self, rev):
         if not self.hassidedata:
             return 0
         return self.index[rev][9]
 
     def rawsize(self, rev):
         """return the length of the uncompressed text for a given revision"""
         l = self.index[rev][2]
         if l >= 0:
             return l
 
         t = self.rawdata(rev)
         return len(t)
 
     def size(self, rev):
         """length of non-raw text (processed by a "read" flag processor)"""
         # fast path: if no "read" flag processor could change the content,
         # size is rawsize. note: ELLIPSIS is known to not change the content.
         flags = self.flags(rev)
         if flags & (flagutil.REVIDX_KNOWN_FLAGS ^ REVIDX_ELLIPSIS) == 0:
             return self.rawsize(rev)
 
         return len(self.revision(rev))
 
     def fast_rank(self, rev):
         """Return the rank of a revision if already known, or None otherwise.
 
         The rank of a revision is the size of the sub-graph it defines as a
         head. Equivalently, the rank of a revision `r` is the size of the set
         `ancestors(r)`, `r` included.
 
         This method returns the rank retrieved from the revlog in constant
         time. It makes no attempt at computing unknown values for versions of
         the revlog which do not persist the rank.
         """
         rank = self.index[rev][ENTRY_RANK]
         if self._format_version != CHANGELOGV2 or rank == RANK_UNKNOWN:
             return None
         if rev == nullrev:
             return 0  # convention
         return rank
 
     def chainbase(self, rev):
         base = self._chainbasecache.get(rev)
         if base is not None:
             return base
 
         index = self.index
         iterrev = rev
         base = index[iterrev][3]
         while base != iterrev:
             iterrev = base
             base = index[iterrev][3]
 
         self._chainbasecache[rev] = base
         return base
 
     def linkrev(self, rev):
         return self.index[rev][4]
 
     def parentrevs(self, rev):
         try:
             entry = self.index[rev]
         except IndexError:
             if rev == wdirrev:
                 raise error.WdirUnsupported
             raise
 
         if self.canonical_parent_order and entry[5] == nullrev:
             return entry[6], entry[5]
         else:
             return entry[5], entry[6]
 
     # fast parentrevs(rev) where rev isn't filtered
     _uncheckedparentrevs = parentrevs
 
     def node(self, rev):
         try:
             return self.index[rev][7]
         except IndexError:
             if rev == wdirrev:
                 raise error.WdirUnsupported
             raise
 
     # Derived from index values.
 
     def end(self, rev):
         return self.start(rev) + self.length(rev)
 
     def parents(self, node):
         i = self.index
         d = i[self.rev(node)]
         # inline node() to avoid function call overhead
         if self.canonical_parent_order and d[5] == self.nullid:
             return i[d[6]][7], i[d[5]][7]
         else:
             return i[d[5]][7], i[d[6]][7]
 
     def chainlen(self, rev):
         return self._chaininfo(rev)[0]
 
     def _chaininfo(self, rev):
         chaininfocache = self._chaininfocache
         if rev in chaininfocache:
             return chaininfocache[rev]
         index = self.index
         generaldelta = self._generaldelta
         iterrev = rev
         e = index[iterrev]
         clen = 0
         compresseddeltalen = 0
         while iterrev != e[3]:
             clen += 1
             compresseddeltalen += e[1]
             if generaldelta:
                 iterrev = e[3]
             else:
                 iterrev -= 1
             if iterrev in chaininfocache:
                 t = chaininfocache[iterrev]
                 clen += t[0]
                 compresseddeltalen += t[1]
                 break
             e = index[iterrev]
         else:
             # Add text length of base since decompressing that also takes
             # work. For cache hits the length is already included.
             compresseddeltalen += e[1]
         r = (clen, compresseddeltalen)
         chaininfocache[rev] = r
         return r
 
     def _deltachain(self, rev, stoprev=None):
         """Obtain the delta chain for a revision.
 
         ``stoprev`` specifies a revision to stop at. If not specified, we
         stop at the base of the chain.
 
         Returns a 2-tuple of (chain, stopped) where ``chain`` is a list of
         revs in ascending order and ``stopped`` is a bool indicating whether
         ``stoprev`` was hit.
         """
         # Try C implementation.
         try:
             return self.index.deltachain(rev, stoprev, self._generaldelta)
         except AttributeError:
             pass
 
         chain = []
 
         # Alias to prevent attribute lookup in tight loop.
         index = self.index
         generaldelta = self._generaldelta
 
         iterrev = rev
         e = index[iterrev]
         while iterrev != e[3] and iterrev != stoprev:
             chain.append(iterrev)
             if generaldelta:
                 iterrev = e[3]
             else:
                 iterrev -= 1
             e = index[iterrev]
 
         if iterrev == stoprev:
             stopped = True
         else:
             chain.append(iterrev)
             stopped = False
 
         chain.reverse()
         return chain, stopped
 
     def ancestors(self, revs, stoprev=0, inclusive=False):
         """Generate the ancestors of 'revs' in reverse revision order.
         Does not generate revs lower than stoprev.
 
         See the documentation for ancestor.lazyancestors for more details."""
 
         # first, make sure start revisions aren't filtered
         revs = list(revs)
         checkrev = self.node
         for r in revs:
             checkrev(r)
         # and we're sure ancestors aren't filtered as well
 
         if rustancestor is not None and self.index.rust_ext_compat:
             lazyancestors = rustancestor.LazyAncestors
             arg = self.index
         else:
             lazyancestors = ancestor.lazyancestors
             arg = self._uncheckedparentrevs
         return lazyancestors(arg, revs, stoprev=stoprev, inclusive=inclusive)
 
     def descendants(self, revs):
         return dagop.descendantrevs(revs, self.revs, self.parentrevs)
 
     def findcommonmissing(self, common=None, heads=None):
         """Return a tuple of the ancestors of common and the ancestors of heads
         that are not ancestors of common. In revset terminology, we return the
         tuple:
 
           ::common, (::heads) - (::common)
 
         The list is sorted by revision number, meaning it is
         topologically sorted.
 
         'heads' and 'common' are both lists of node IDs.  If heads is
         not supplied, uses all of the revlog's heads.  If common is not
         supplied, uses nullid."""
         if common is None:
             common = [self.nullid]
         if heads is None:
             heads = self.heads()
 
         common = [self.rev(n) for n in common]
         heads = [self.rev(n) for n in heads]
 
         # we want the ancestors, but inclusive
         class lazyset:
             def __init__(self, lazyvalues):
                 self.addedvalues = set()
                 self.lazyvalues = lazyvalues
 
             def __contains__(self, value):
                 return value in self.addedvalues or value in self.lazyvalues
 
             def __iter__(self):
                 added = self.addedvalues
                 for r in added:
                     yield r
                 for r in self.lazyvalues:
                     if not r in added:
                         yield r
 
             def add(self, value):
                 self.addedvalues.add(value)
 
             def update(self, values):
                 self.addedvalues.update(values)
 
         has = lazyset(self.ancestors(common))
         has.add(nullrev)
         has.update(common)
 
         # take all ancestors from heads that aren't in has
         missing = set()
         visit = collections.deque(r for r in heads if r not in has)
         while visit:
             r = visit.popleft()
             if r in missing:
                 continue
             else:
                 missing.add(r)
                 for p in self.parentrevs(r):
                     if p not in has:
                         visit.append(p)
         missing = list(missing)
         missing.sort()
         return has, [self.node(miss) for miss in missing]
 
     def incrementalmissingrevs(self, common=None):
         """Return an object that can be used to incrementally compute the
         revision numbers of the ancestors of arbitrary sets that are not
         ancestors of common. This is an ancestor.incrementalmissingancestors
         object.
 
         'common' is a list of revision numbers. If common is not supplied, uses
         nullrev.
         """
         if common is None:
             common = [nullrev]
 
         if rustancestor is not None and self.index.rust_ext_compat:
             return rustancestor.MissingAncestors(self.index, common)
         return ancestor.incrementalmissingancestors(self.parentrevs, common)
 
     def findmissingrevs(self, common=None, heads=None):
         """Return the revision numbers of the ancestors of heads that
         are not ancestors of common.
 
         More specifically, return a list of revision numbers corresponding to
         nodes N such that every N satisfies the following constraints:
 
           1. N is an ancestor of some node in 'heads'
           2. N is not an ancestor of any node in 'common'
 
         The list is sorted by revision number, meaning it is
         topologically sorted.
 
         'heads' and 'common' are both lists of revision numbers.  If heads is
         not supplied, uses all of the revlog's heads.  If common is not
         supplied, uses nullid."""
         if common is None:
             common = [nullrev]
         if heads is None:
             heads = self.headrevs()
 
         inc = self.incrementalmissingrevs(common=common)
         return inc.missingancestors(heads)
 
     def findmissing(self, common=None, heads=None):
         """Return the ancestors of heads that are not ancestors of common.
 
         More specifically, return a list of nodes N such that every N
         satisfies the following constraints:
 
           1. N is an ancestor of some node in 'heads'
           2. N is not an ancestor of any node in 'common'
 
         The list is sorted by revision number, meaning it is
         topologically sorted.
 
         'heads' and 'common' are both lists of node IDs.  If heads is
         not supplied, uses all of the revlog's heads.  If common is not
         supplied, uses nullid."""
         if common is None:
             common = [self.nullid]
         if heads is None:
             heads = self.heads()
 
         common = [self.rev(n) for n in common]
         heads = [self.rev(n) for n in heads]
 
         inc = self.incrementalmissingrevs(common=common)
         return [self.node(r) for r in inc.missingancestors(heads)]
 
     def nodesbetween(self, roots=None, heads=None):
         """Return a topological path from 'roots' to 'heads'.
 
         Return a tuple (nodes, outroots, outheads) where 'nodes' is a
         topologically sorted list of all nodes N that satisfy both of
         these constraints:
 
           1. N is a descendant of some node in 'roots'
           2. N is an ancestor of some node in 'heads'
 
         Every node is considered to be both a descendant and an ancestor
         of itself, so every reachable node in 'roots' and 'heads' will be
         included in 'nodes'.
 
         'outroots' is the list of reachable nodes in 'roots', i.e., the
         subset of 'roots' that is returned in 'nodes'.  Likewise,
         'outheads' is the subset of 'heads' that is also in 'nodes'.
 
         'roots' and 'heads' are both lists of node IDs.  If 'roots' is
         unspecified, uses nullid as the only root.  If 'heads' is
         unspecified, uses list of all of the revlog's heads."""
         nonodes = ([], [], [])
         if roots is not None:
             roots = list(roots)
             if not roots:
                 return nonodes
             lowestrev = min([self.rev(n) for n in roots])
         else:
             roots = [self.nullid]  # Everybody's a descendant of nullid
             lowestrev = nullrev
         if (lowestrev == nullrev) and (heads is None):
             # We want _all_ the nodes!
             return (
                 [self.node(r) for r in self],
                 [self.nullid],
                 list(self.heads()),
             )
         if heads is None:
             # All nodes are ancestors, so the latest ancestor is the last
             # node.
             highestrev = len(self) - 1
             # Set ancestors to None to signal that every node is an ancestor.
             ancestors = None
             # Set heads to an empty dictionary for later discovery of heads
             heads = {}
         else:
             heads = list(heads)
             if not heads:
                 return nonodes
             ancestors = set()
             # Turn heads into a dictionary so we can remove 'fake' heads.
             # Also, later we will be using it to filter out the heads we can't
             # find from roots.
             heads = dict.fromkeys(heads, False)
             # Start at the top and keep marking parents until we're done.
             nodestotag = set(heads)
             # Remember where the top was so we can use it as a limit later.
             highestrev = max([self.rev(n) for n in nodestotag])
             while nodestotag:
                 # grab a node to tag
                 n = nodestotag.pop()
                 # Never tag nullid
                 if n == self.nullid:
                     continue
                 # A node's revision number represents its place in a
                 # topologically sorted list of nodes.
                 r = self.rev(n)
                 if r >= lowestrev:
                     if n not in ancestors:
                         # If we are possibly a descendant of one of the roots
                         # and we haven't already been marked as an ancestor
                         ancestors.add(n)  # Mark as ancestor
                         # Add non-nullid parents to list of nodes to tag.
                         nodestotag.update(
                             [p for p in self.parents(n) if p != self.nullid]
                         )
                     elif n in heads:  # We've seen it before, is it a fake head?
                         # So it is, real heads should not be the ancestors of
                         # any other heads.
                         heads.pop(n)
             if not ancestors:
                 return nonodes
             # Now that we have our set of ancestors, we want to remove any
             # roots that are not ancestors.
 
             # If one of the roots was nullid, everything is included anyway.
             if lowestrev > nullrev:
                 # But, since we weren't, let's recompute the lowest rev to not
                 # include roots that aren't ancestors.
 
                 # Filter out roots that aren't ancestors of heads
                 roots = [root for root in roots if root in ancestors]
                 # Recompute the lowest revision
                 if roots:
                     lowestrev = min([self.rev(root) for root in roots])
                 else:
                     # No more roots?  Return empty list
                     return nonodes
             else:
                 # We are descending from nullid, and don't need to care about
                 # any other roots.
                 lowestrev = nullrev
                 roots = [self.nullid]
         # Transform our roots list into a set.
         descendants = set(roots)
         # Also, keep the original roots so we can filter out roots that aren't
         # 'real' roots (i.e. are descended from other roots).
         roots = descendants.copy()
         # Our topologically sorted list of output nodes.
         orderedout = []
         # Don't start at nullid since we don't want nullid in our output list,
         # and if nullid shows up in descendants, empty parents will look like
         # they're descendants.
         for r in self.revs(start=max(lowestrev, 0), stop=highestrev + 1):
             n = self.node(r)
             isdescendant = False
             if lowestrev == nullrev:  # Everybody is a descendant of nullid
                 isdescendant = True
             elif n in descendants:
                 # n is already a descendant
                 isdescendant = True
                 # This check only needs to be done here because all the roots
                 # will start being marked is descendants before the loop.
                 if n in roots:
                     # If n was a root, check if it's a 'real' root.
                     p = tuple(self.parents(n))
                     # If any of its parents are descendants, it's not a root.
                     if (p[0] in descendants) or (p[1] in descendants):
                         roots.remove(n)
             else:
                 p = tuple(self.parents(n))
                 # A node is a descendant if either of its parents are
                 # descendants.  (We seeded the dependents list with the roots
                 # up there, remember?)
                 if (p[0] in descendants) or (p[1] in descendants):
                     descendants.add(n)
                     isdescendant = True
             if isdescendant and ((ancestors is None) or (n in ancestors)):
                 # Only include nodes that are both descendants and ancestors.
                 orderedout.append(n)
                 if (ancestors is not None) and (n in heads):
                     # We're trying to figure out which heads are reachable
                     # from roots.
                     # Mark this head as having been reached
                     heads[n] = True
                 elif ancestors is None:
                     # Otherwise, we're trying to discover the heads.
                     # Assume this is a head because if it isn't, the next step
                     # will eventually remove it.
                     heads[n] = True
                     # But, obviously its parents aren't.
                     for p in self.parents(n):
                         heads.pop(p, None)
         heads = [head for head, flag in heads.items() if flag]
         roots = list(roots)
         assert orderedout
         assert roots
         assert heads
         return (orderedout, roots, heads)
 
     def headrevs(self, revs=None):
         if revs is None:
             try:
                 return self.index.headrevs()
             except AttributeError:
                 return self._headrevs()
         if rustdagop is not None and self.index.rust_ext_compat:
             return rustdagop.headrevs(self.index, revs)
         return dagop.headrevs(revs, self._uncheckedparentrevs)
 
     def computephases(self, roots):
         return self.index.computephasesmapsets(roots)
 
     def _headrevs(self):
         count = len(self)
         if not count:
             return [nullrev]
         # we won't iter over filtered rev so nobody is a head at start
         ishead = [0] * (count + 1)
         index = self.index
         for r in self:
             ishead[r] = 1  # I may be an head
             e = index[r]
             ishead[e[5]] = ishead[e[6]] = 0  # my parent are not
         return [r for r, val in enumerate(ishead) if val]
 
     def heads(self, start=None, stop=None):
         """return the list of all nodes that have no children
 
         if start is specified, only heads that are descendants of
         start will be returned
         if stop is specified, it will consider all the revs from stop
         as if they had no children
         """
         if start is None and stop is None:
             if not len(self):
                 return [self.nullid]
             return [self.node(r) for r in self.headrevs()]
 
         if start is None:
             start = nullrev
         else:
             start = self.rev(start)
 
         stoprevs = {self.rev(n) for n in stop or []}
 
         revs = dagop.headrevssubset(
             self.revs, self.parentrevs, startrev=start, stoprevs=stoprevs
         )
 
         return [self.node(rev) for rev in revs]
 
     def children(self, node):
         """find the children of a given node"""
         c = []
         p = self.rev(node)
         for r in self.revs(start=p + 1):
             prevs = [pr for pr in self.parentrevs(r) if pr != nullrev]
             if prevs:
                 for pr in prevs:
                     if pr == p:
                         c.append(self.node(r))
             elif p == nullrev:
                 c.append(self.node(r))
         return c
 
     def commonancestorsheads(self, a, b):
         """calculate all the heads of the common ancestors of nodes a and b"""
         a, b = self.rev(a), self.rev(b)
         ancs = self._commonancestorsheads(a, b)
         return pycompat.maplist(self.node, ancs)
 
     def _commonancestorsheads(self, *revs):
         """calculate all the heads of the common ancestors of revs"""
         try:
             ancs = self.index.commonancestorsheads(*revs)
         except (AttributeError, OverflowError):  # C implementation failed
             ancs = ancestor.commonancestorsheads(self.parentrevs, *revs)
         return ancs
 
     def isancestor(self, a, b):
         """return True if node a is an ancestor of node b
 
         A revision is considered an ancestor of itself."""
         a, b = self.rev(a), self.rev(b)
         return self.isancestorrev(a, b)
 
     def isancestorrev(self, a, b):
         """return True if revision a is an ancestor of revision b
 
         A revision is considered an ancestor of itself.
 
         The implementation of this is trivial but the use of
         reachableroots is not."""
         if a == nullrev:
             return True
         elif a == b:
             return True
         elif a > b:
             return False
         return bool(self.reachableroots(a, [b], [a], includepath=False))
 
     def reachableroots(self, minroot, heads, roots, includepath=False):
         """return (heads(::(<roots> and <roots>::<heads>)))
 
         If includepath is True, return (<roots>::<heads>)."""
         try:
             return self.index.reachableroots2(
                 minroot, heads, roots, includepath
             )
         except AttributeError:
             return dagop._reachablerootspure(
                 self.parentrevs, minroot, roots, heads, includepath
             )
 
     def ancestor(self, a, b):
         """calculate the "best" common ancestor of nodes a and b"""
 
         a, b = self.rev(a), self.rev(b)
         try:
             ancs = self.index.ancestors(a, b)
         except (AttributeError, OverflowError):
             ancs = ancestor.ancestors(self.parentrevs, a, b)
         if ancs:
             # choose a consistent winner when there's a tie
             return min(map(self.node, ancs))
         return self.nullid
 
     def _match(self, id):
         if isinstance(id, int):
             # rev
             return self.node(id)
         if len(id) == self.nodeconstants.nodelen:
             # possibly a binary node
             # odds of a binary node being all hex in ASCII are 1 in 10**25
             try:
                 node = id
                 self.rev(node)  # quick search the index
                 return node
             except error.LookupError:
                 pass  # may be partial hex id
         try:
             # str(rev)
             rev = int(id)
             if b"%d" % rev != id:
                 raise ValueError
             if rev < 0:
                 rev = len(self) + rev
             if rev < 0 or rev >= len(self):
                 raise ValueError
             return self.node(rev)
         except (ValueError, OverflowError):
             pass
         if len(id) == 2 * self.nodeconstants.nodelen:
             try:
                 # a full hex nodeid?
                 node = bin(id)
                 self.rev(node)
                 return node
             except (binascii.Error, error.LookupError):
                 pass
 
     def _partialmatch(self, id):
         # we don't care wdirfilenodeids as they should be always full hash
         maybewdir = self.nodeconstants.wdirhex.startswith(id)
         ambiguous = False
         try:
             partial = self.index.partialmatch(id)
             if partial and self.hasnode(partial):
                 if maybewdir:
                     # single 'ff...' match in radix tree, ambiguous with wdir
                     ambiguous = True
                 else:
                     return partial
             elif maybewdir:
                 # no 'ff...' match in radix tree, wdir identified
                 raise error.WdirUnsupported
             else:
                 return None
         except error.RevlogError:
             # parsers.c radix tree lookup gave multiple matches
             # fast path: for unfiltered changelog, radix tree is accurate
             if not getattr(self, 'filteredrevs', None):
                 ambiguous = True
             # fall through to slow path that filters hidden revisions
         except (AttributeError, ValueError):
             # we are pure python, or key is not hex
             pass
         if ambiguous:
             raise error.AmbiguousPrefixLookupError(
                 id, self.display_id, _(b'ambiguous identifier')
             )
 
         if id in self._pcache:
             return self._pcache[id]
 
         if len(id) <= 40:
             # hex(node)[:...]
             l = len(id) // 2 * 2  # grab an even number of digits
             try:
                 # we're dropping the last digit, so let's check that it's hex,
                 # to avoid the expensive computation below if it's not
                 if len(id) % 2 > 0:
                     if not (id[-1] in hexdigits):
                         return None
                 prefix = bin(id[:l])
             except binascii.Error:
                 pass
             else:
                 nl = [e[7] for e in self.index if e[7].startswith(prefix)]
                 nl = [
                     n for n in nl if hex(n).startswith(id) and self.hasnode(n)
                 ]
                 if self.nodeconstants.nullhex.startswith(id):
                     nl.append(self.nullid)
                 if len(nl) > 0:
                     if len(nl) == 1 and not maybewdir:
                         self._pcache[id] = nl[0]
                         return nl[0]
                     raise error.AmbiguousPrefixLookupError(
                         id, self.display_id, _(b'ambiguous identifier')
                     )
                 if maybewdir:
                     raise error.WdirUnsupported
                 return None
 
     def lookup(self, id):
         """locate a node based on:
         - revision number or str(revision number)
         - nodeid or subset of hex nodeid
         """
         n = self._match(id)
         if n is not None:
             return n
         n = self._partialmatch(id)
         if n:
             return n
 
         raise error.LookupError(id, self.display_id, _(b'no match found'))
 
     def shortest(self, node, minlength=1):
         """Find the shortest unambiguous prefix that matches node."""
 
         def isvalid(prefix):
             try:
                 matchednode = self._partialmatch(prefix)
             except error.AmbiguousPrefixLookupError:
                 return False
             except error.WdirUnsupported:
                 # single 'ff...' match
                 return True
             if matchednode is None:
                 raise error.LookupError(node, self.display_id, _(b'no node'))
             return True
 
         def maybewdir(prefix):
             return all(c == b'f' for c in pycompat.iterbytestr(prefix))
 
         hexnode = hex(node)
 
         def disambiguate(hexnode, minlength):
             """Disambiguate against wdirid."""
             for length in range(minlength, len(hexnode) + 1):
                 prefix = hexnode[:length]
                 if not maybewdir(prefix):
                     return prefix
 
         if not getattr(self, 'filteredrevs', None):
             try:
                 length = max(self.index.shortest(node), minlength)
                 return disambiguate(hexnode, length)
             except error.RevlogError:
                 if node != self.nodeconstants.wdirid:
                     raise error.LookupError(
                         node, self.display_id, _(b'no node')
                     )
             except AttributeError:
                 # Fall through to pure code
                 pass
 
         if node == self.nodeconstants.wdirid:
             for length in range(minlength, len(hexnode) + 1):
                 prefix = hexnode[:length]
                 if isvalid(prefix):
                     return prefix
 
         for length in range(minlength, len(hexnode) + 1):
             prefix = hexnode[:length]
             if isvalid(prefix):
                 return disambiguate(hexnode, length)
 
     def cmp(self, node, text):
         """compare text with a given file revision
 
         returns True if text is different than what is stored.
         """
         p1, p2 = self.parents(node)
         return storageutil.hashrevisionsha1(text, p1, p2) != node
 
     def _getsegmentforrevs(self, startrev, endrev, df=None):
         """Obtain a segment of raw data corresponding to a range of revisions.
 
         Accepts the start and end revisions and an optional already-open
         file handle to be used for reading. If the file handle is read, its
         seek position will not be preserved.
 
         Requests for data may be satisfied by a cache.
 
         Returns a 2-tuple of (offset, data) for the requested range of
         revisions. Offset is the integer offset from the beginning of the
         revlog and data is a str or buffer of the raw byte data.
 
         Callers will need to call ``self.start(rev)`` and ``self.length(rev)``
         to determine where each revision's data begins and ends.
         """
         # Inlined self.start(startrev) & self.end(endrev) for perf reasons
         # (functions are expensive).
         index = self.index
         istart = index[startrev]
         start = int(istart[0] >> 16)
         if startrev == endrev:
             end = start + istart[1]
         else:
             iend = index[endrev]
             end = int(iend[0] >> 16) + iend[1]
 
         if self._inline:
             start += (startrev + 1) * self.index.entry_size
             end += (endrev + 1) * self.index.entry_size
         length = end - start
 
         return start, self._segmentfile.read_chunk(start, length, df)
 
     def _chunk(self, rev, df=None):
         """Obtain a single decompressed chunk for a revision.
 
         Accepts an integer revision and an optional already-open file handle
         to be used for reading. If used, the seek position of the file will not
         be preserved.
 
         Returns a str holding uncompressed data for the requested revision.
         """
         compression_mode = self.index[rev][10]
         data = self._getsegmentforrevs(rev, rev, df=df)[1]
         if compression_mode == COMP_MODE_PLAIN:
             return data
         elif compression_mode == COMP_MODE_DEFAULT:
             return self._decompressor(data)
         elif compression_mode == COMP_MODE_INLINE:
             return self.decompress(data)
         else:
             msg = b'unknown compression mode %d'
             msg %= compression_mode
             raise error.RevlogError(msg)
 
     def _chunks(self, revs, df=None, targetsize=None):
         """Obtain decompressed chunks for the specified revisions.
 
         Accepts an iterable of numeric revisions that are assumed to be in
         ascending order. Also accepts an optional already-open file handle
         to be used for reading. If used, the seek position of the file will
         not be preserved.
 
         This function is similar to calling ``self._chunk()`` multiple times,
         but is faster.
 
         Returns a list with decompressed data for each requested revision.
         """
         if not revs:
             return []
         start = self.start
         length = self.length
         inline = self._inline
         iosize = self.index.entry_size
         buffer = util.buffer
 
         l = []
         ladd = l.append
 
         if not self._withsparseread:
             slicedchunks = (revs,)
         else:
             slicedchunks = deltautil.slicechunk(
                 self, revs, targetsize=targetsize
             )
 
         for revschunk in slicedchunks:
             firstrev = revschunk[0]
             # Skip trailing revisions with empty diff
             for lastrev in revschunk[::-1]:
                 if length(lastrev) != 0:
                     break
 
             try:
                 offset, data = self._getsegmentforrevs(firstrev, lastrev, df=df)
             except OverflowError:
                 # issue4215 - we can't cache a run of chunks greater than
                 # 2G on Windows
                 return [self._chunk(rev, df=df) for rev in revschunk]
 
             decomp = self.decompress
             # self._decompressor might be None, but will not be used in that case
             def_decomp = self._decompressor
             for rev in revschunk:
                 chunkstart = start(rev)
                 if inline:
                     chunkstart += (rev + 1) * iosize
                 chunklength = length(rev)
                 comp_mode = self.index[rev][10]
                 c = buffer(data, chunkstart - offset, chunklength)
                 if comp_mode == COMP_MODE_PLAIN:
                     ladd(c)
                 elif comp_mode == COMP_MODE_INLINE:
                     ladd(decomp(c))
                 elif comp_mode == COMP_MODE_DEFAULT:
                     ladd(def_decomp(c))
                 else:
                     msg = b'unknown compression mode %d'
                     msg %= comp_mode
                     raise error.RevlogError(msg)
 
         return l
 
     def deltaparent(self, rev):
         """return deltaparent of the given revision"""
         base = self.index[rev][3]
         if base == rev:
             return nullrev
         elif self._generaldelta:
             return base
         else:
             return rev - 1
 
     def issnapshot(self, rev):
         """tells whether rev is a snapshot"""
         if not self._sparserevlog:
             return self.deltaparent(rev) == nullrev
         elif util.safehasattr(self.index, b'issnapshot'):
             # directly assign the method to cache the testing and access
             self.issnapshot = self.index.issnapshot
             return self.issnapshot(rev)
         if rev == nullrev:
             return True
         entry = self.index[rev]
         base = entry[3]
         if base == rev:
             return True
         if base == nullrev:
             return True
         p1 = entry[5]
         while self.length(p1) == 0:
             b = self.deltaparent(p1)
             if b == p1:
                 break
             p1 = b
         p2 = entry[6]
         while self.length(p2) == 0:
             b = self.deltaparent(p2)
             if b == p2:
                 break
             p2 = b
         if base == p1 or base == p2:
             return False
         return self.issnapshot(base)
 
     def snapshotdepth(self, rev):
         """number of snapshot in the chain before this one"""
         if not self.issnapshot(rev):
             raise error.ProgrammingError(b'revision %d not a snapshot')
         return len(self._deltachain(rev)[0]) - 1
 
     def revdiff(self, rev1, rev2):
         """return or calculate a delta between two revisions
 
         The delta calculated is in binary form and is intended to be written to
         revlog data directly. So this function needs raw revision data.
         """
         if rev1 != nullrev and self.deltaparent(rev2) == rev1:
             return bytes(self._chunk(rev2))
 
         return mdiff.textdiff(self.rawdata(rev1), self.rawdata(rev2))
 
     def revision(self, nodeorrev, _df=None):
         """return an uncompressed revision of a given node or revision
         number.
 
         _df - an existing file handle to read from. (internal-only)
         """
         return self._revisiondata(nodeorrev, _df)
 
     def sidedata(self, nodeorrev, _df=None):
         """a map of extra data related to the changeset but not part of the hash
 
         This function currently return a dictionary. However, more advanced
         mapping object will likely be used in the future for a more
         efficient/lazy code.
         """
         # deal with <nodeorrev> argument type
         if isinstance(nodeorrev, int):
             rev = nodeorrev
         else:
             rev = self.rev(nodeorrev)
         return self._sidedata(rev)
 
     def _revisiondata(self, nodeorrev, _df=None, raw=False):
         # deal with <nodeorrev> argument type
         if isinstance(nodeorrev, int):
             rev = nodeorrev
             node = self.node(rev)
         else:
             node = nodeorrev
             rev = None
 
         # fast path the special `nullid` rev
         if node == self.nullid:
             return b""
 
         # ``rawtext`` is the text as stored inside the revlog. Might be the
         # revision or might need to be processed to retrieve the revision.
         rev, rawtext, validated = self._rawtext(node, rev, _df=_df)
 
         if raw and validated:
             # if we don't want to process the raw text and that raw
             # text is cached, we can exit early.
             return rawtext
         if rev is None:
             rev = self.rev(node)
         # the revlog's flag for this revision
         # (usually alter its state or content)
         flags = self.flags(rev)
 
         if validated and flags == REVIDX_DEFAULT_FLAGS:
             # no extra flags set, no flag processor runs, text = rawtext
             return rawtext
 
         if raw:
             validatehash = flagutil.processflagsraw(self, rawtext, flags)
             text = rawtext
         else:
             r = flagutil.processflagsread(self, rawtext, flags)
             text, validatehash = r
         if validatehash:
             self.checkhash(text, node, rev=rev)
         if not validated:
             self._revisioncache = (node, rev, rawtext)
 
         return text
 
     def _rawtext(self, node, rev, _df=None):
         """return the possibly unvalidated rawtext for a revision
 
         returns (rev, rawtext, validated)
         """
 
         # revision in the cache (could be useful to apply delta)
         cachedrev = None
         # An intermediate text to apply deltas to
         basetext = None
 
         # Check if we have the entry in cache
         # The cache entry looks like (node, rev, rawtext)
         if self._revisioncache:
             if self._revisioncache[0] == node:
                 return (rev, self._revisioncache[2], True)
             cachedrev = self._revisioncache[1]
 
         if rev is None:
             rev = self.rev(node)
 
         chain, stopped = self._deltachain(rev, stoprev=cachedrev)
         if stopped:
             basetext = self._revisioncache[2]
 
         # drop cache to save memory, the caller is expected to
         # update self._revisioncache after validating the text
         self._revisioncache = None
 
         targetsize = None
         rawsize = self.index[rev][2]
         if 0 <= rawsize:
             targetsize = 4 * rawsize
 
         bins = self._chunks(chain, df=_df, targetsize=targetsize)
         if basetext is None:
             basetext = bytes(bins[0])
             bins = bins[1:]
 
         rawtext = mdiff.patches(basetext, bins)
         del basetext  # let us have a chance to free memory early
         return (rev, rawtext, False)
 
     def _sidedata(self, rev):
         """Return the sidedata for a given revision number."""
         index_entry = self.index[rev]
         sidedata_offset = index_entry[8]
         sidedata_size = index_entry[9]
 
         if self._inline:
             sidedata_offset += self.index.entry_size * (1 + rev)
         if sidedata_size == 0:
             return {}
 
         if self._docket.sidedata_end < sidedata_offset + sidedata_size:
             filename = self._sidedatafile
             end = self._docket.sidedata_end
             offset = sidedata_offset
             length = sidedata_size
             m = FILE_TOO_SHORT_MSG % (filename, length, offset, end)
             raise error.RevlogError(m)
 
         comp_segment = self._segmentfile_sidedata.read_chunk(
             sidedata_offset, sidedata_size
         )
 
         comp = self.index[rev][11]
         if comp == COMP_MODE_PLAIN:
             segment = comp_segment
         elif comp == COMP_MODE_DEFAULT:
             segment = self._decompressor(comp_segment)
         elif comp == COMP_MODE_INLINE:
             segment = self.decompress(comp_segment)
         else:
             msg = b'unknown compression mode %d'
             msg %= comp
             raise error.RevlogError(msg)
 
         sidedata = sidedatautil.deserialize_sidedata(segment)
         return sidedata
 
     def rawdata(self, nodeorrev, _df=None):
         """return an uncompressed raw data of a given node or revision number.
 
         _df - an existing file handle to read from. (internal-only)
         """
         return self._revisiondata(nodeorrev, _df, raw=True)
 
     def hash(self, text, p1, p2):
         """Compute a node hash.
 
         Available as a function so that subclasses can replace the hash
         as needed.
         """
         return storageutil.hashrevisionsha1(text, p1, p2)
 
     def checkhash(self, text, node, p1=None, p2=None, rev=None):
         """Check node hash integrity.
 
         Available as a function so that subclasses can extend hash mismatch
         behaviors as needed.
         """
         try:
             if p1 is None and p2 is None:
                 p1, p2 = self.parents(node)
             if node != self.hash(text, p1, p2):
                 # Clear the revision cache on hash failure. The revision cache
                 # only stores the raw revision and clearing the cache does have
                 # the side-effect that we won't have a cache hit when the raw
                 # revision data is accessed. But this case should be rare and
                 # it is extra work to teach the cache about the hash
                 # verification state.
                 if self._revisioncache and self._revisioncache[0] == node:
                     self._revisioncache = None
 
                 revornode = rev
                 if revornode is None:
                     revornode = templatefilters.short(hex(node))
                 raise error.RevlogError(
                     _(b"integrity check failed on %s:%s")
                     % (self.display_id, pycompat.bytestr(revornode))
                 )
         except error.RevlogError:
             if self._censorable and storageutil.iscensoredtext(text):
                 raise error.CensoredNodeError(self.display_id, node, text)
             raise
 
     def _enforceinlinesize(self, tr):
         """Check if the revlog is too big for inline and convert if so.
 
         This should be called after revisions are added to the revlog. If the
         revlog has grown too large to be an inline revlog, it will convert it
         to use multiple index and data files.
         """
         tiprev = len(self) - 1
         total_size = self.start(tiprev) + self.length(tiprev)
         if not self._inline or total_size < _maxinline:
             return
 
         troffset = tr.findoffset(self._indexfile)
         if troffset is None:
             raise error.RevlogError(
                 _(b"%s not found in the transaction") % self._indexfile
             )
         trindex = None
         tr.add(self._datafile, 0)
 
         existing_handles = False
         if self._writinghandles is not None:
             existing_handles = True
             fp = self._writinghandles[0]
             fp.flush()
             fp.close()
             # We can't use the cached file handle after close(). So prevent
             # its usage.
             self._writinghandles = None
             self._segmentfile.writing_handle = None
             # No need to deal with sidedata writing handle as it is only
             # relevant with revlog-v2 which is never inline, not reaching
             # this code
 
         new_dfh = self._datafp(b'w+')
         new_dfh.truncate(0)  # drop any potentially existing data
         try:
             with self._indexfp() as read_ifh:
                 for r in self:
                     new_dfh.write(self._getsegmentforrevs(r, r, df=read_ifh)[1])
                     if (
                         trindex is None
                         and troffset
                         <= self.start(r) + r * self.index.entry_size
                     ):
                         trindex = r
                 new_dfh.flush()
 
             if trindex is None:
                 trindex = 0
 
             with self.__index_new_fp() as fp:
                 self._format_flags &= ~FLAG_INLINE_DATA
                 self._inline = False
                 for i in self:
                     e = self.index.entry_binary(i)
                     if i == 0 and self._docket is None:
                         header = self._format_flags | self._format_version
                         header = self.index.pack_header(header)
                         e = header + e
                     fp.write(e)
                 if self._docket is not None:
                     self._docket.index_end = fp.tell()
 
                 # There is a small transactional race here. If the rename of
                 # the index fails, we should remove the datafile. It is more
                 # important to ensure that the data file is not truncated
                 # when the index is replaced as otherwise data is lost.
                 tr.replace(self._datafile, self.start(trindex))
 
                 # the temp file replace the real index when we exit the context
                 # manager
 
             tr.replace(self._indexfile, trindex * self.index.entry_size)
             nodemaputil.setup_persistent_nodemap(tr, self)
             self._segmentfile = randomaccessfile.randomaccessfile(
                 self.opener,
                 self._datafile,
                 self._chunkcachesize,
             )
 
             if existing_handles:
                 # switched from inline to conventional reopen the index
                 ifh = self.__index_write_fp()
                 self._writinghandles = (ifh, new_dfh, None)
                 self._segmentfile.writing_handle = new_dfh
                 new_dfh = None
                 # No need to deal with sidedata writing handle as it is only
                 # relevant with revlog-v2 which is never inline, not reaching
                 # this code
         finally:
             if new_dfh is not None:
                 new_dfh.close()
 
     def _nodeduplicatecallback(self, transaction, node):
         """called when trying to add a node already stored."""
 
     @contextlib.contextmanager
     def reading(self):
         """Context manager that keeps data and sidedata files open for reading"""
         with self._segmentfile.reading():
             with self._segmentfile_sidedata.reading():
                 yield
 
     @contextlib.contextmanager
     def _writing(self, transaction):
         if self._trypending:
             msg = b'try to write in a `trypending` revlog: %s'
             msg %= self.display_id
             raise error.ProgrammingError(msg)
         if self._writinghandles is not None:
             yield
         else:
             ifh = dfh = sdfh = None
             try:
                 r = len(self)
                 # opening the data file.
                 dsize = 0
                 if r:
                     dsize = self.end(r - 1)
                 dfh = None
                 if not self._inline:
                     try:
                         dfh = self._datafp(b"r+")
                         if self._docket is None:
                             dfh.seek(0, os.SEEK_END)
                         else:
                             dfh.seek(self._docket.data_end, os.SEEK_SET)
                     except FileNotFoundError:
                         dfh = self._datafp(b"w+")
                     transaction.add(self._datafile, dsize)
                 if self._sidedatafile is not None:
                     # revlog-v2 does not inline, help Pytype
                     assert dfh is not None
                     try:
                         sdfh = self.opener(self._sidedatafile, mode=b"r+")
                         dfh.seek(self._docket.sidedata_end, os.SEEK_SET)
                     except FileNotFoundError:
                         sdfh = self.opener(self._sidedatafile, mode=b"w+")
                     transaction.add(
                         self._sidedatafile, self._docket.sidedata_end
                     )
 
                 # opening the index file.
                 isize = r * self.index.entry_size
                 ifh = self.__index_write_fp()
                 if self._inline:
                     transaction.add(self._indexfile, dsize + isize)
                 else:
                     transaction.add(self._indexfile, isize)
                 # exposing all file handle for writing.
                 self._writinghandles = (ifh, dfh, sdfh)
                 self._segmentfile.writing_handle = ifh if self._inline else dfh
                 self._segmentfile_sidedata.writing_handle = sdfh
                 yield
                 if self._docket is not None:
                     self._write_docket(transaction)
             finally:
                 self._writinghandles = None
                 self._segmentfile.writing_handle = None
                 self._segmentfile_sidedata.writing_handle = None
                 if dfh is not None:
                     dfh.close()
                 if sdfh is not None:
                     sdfh.close()
                 # closing the index file last to avoid exposing referent to
                 # potential unflushed data content.
                 if ifh is not None:
                     ifh.close()
 
     def _write_docket(self, transaction):
         """write the current docket on disk
 
         Exist as a method to help changelog to implement transaction logic
 
         We could also imagine using the same transaction logic for all revlog
         since docket are cheap."""
         self._docket.write(transaction)
 
     def addrevision(
         self,
         text,
         transaction,
         link,
         p1,
         p2,
         cachedelta=None,
         node=None,
         flags=REVIDX_DEFAULT_FLAGS,
         deltacomputer=None,
         sidedata=None,
     ):
         """add a revision to the log
 
         text - the revision data to add
         transaction - the transaction object used for rollback
         link - the linkrev data to add
         p1, p2 - the parent nodeids of the revision
         cachedelta - an optional precomputed delta
         node - nodeid of revision; typically node is not specified, and it is
             computed by default as hash(text, p1, p2), however subclasses might
             use different hashing method (and override checkhash() in such case)
         flags - the known flags to set on the revision
         deltacomputer - an optional deltacomputer instance shared between
             multiple calls
         """
         if link == nullrev:
             raise error.RevlogError(
                 _(b"attempted to add linkrev -1 to %s") % self.display_id
             )
 
         if sidedata is None:
             sidedata = {}
         elif sidedata and not self.hassidedata:
             raise error.ProgrammingError(
                 _(b"trying to add sidedata to a revlog who don't support them")
             )
 
         if flags:
             node = node or self.hash(text, p1, p2)
 
         rawtext, validatehash = flagutil.processflagswrite(self, text, flags)
 
         # If the flag processor modifies the revision data, ignore any provided
         # cachedelta.
         if rawtext != text:
             cachedelta = None
 
         if len(rawtext) > _maxentrysize:
             raise error.RevlogError(
                 _(
                     b"%s: size of %d bytes exceeds maximum revlog storage of 2GiB"
                 )
                 % (self.display_id, len(rawtext))
             )
 
         node = node or self.hash(rawtext, p1, p2)
         rev = self.index.get_rev(node)
         if rev is not None:
             return rev
 
         if validatehash:
             self.checkhash(rawtext, node, p1=p1, p2=p2)
 
         return self.addrawrevision(
             rawtext,
             transaction,
             link,
             p1,
             p2,
             node,
             flags,
             cachedelta=cachedelta,
             deltacomputer=deltacomputer,
             sidedata=sidedata,
         )
 
     def addrawrevision(
         self,
         rawtext,
         transaction,
         link,
         p1,
         p2,
         node,
         flags,
         cachedelta=None,
         deltacomputer=None,
         sidedata=None,
     ):
         """add a raw revision with known flags, node and parents
         useful when reusing a revision not stored in this revlog (ex: received
         over wire, or read from an external bundle).
         """
         with self._writing(transaction):
             return self._addrevision(
                 node,
                 rawtext,
                 transaction,
                 link,
                 p1,
                 p2,
                 flags,
                 cachedelta,
                 deltacomputer=deltacomputer,
                 sidedata=sidedata,
             )
 
     def compress(self, data):
         """Generate a possibly-compressed representation of data."""
         if not data:
             return b'', data
 
         compressed = self._compressor.compress(data)
 
         if compressed:
             # The revlog compressor added the header in the returned data.
             return b'', compressed
 
         if data[0:1] == b'\0':
             return b'', data
         return b'u', data
 
     def decompress(self, data):
         """Decompress a revlog chunk.
 
         The chunk is expected to begin with a header identifying the
         format type so it can be routed to an appropriate decompressor.
         """
         if not data:
             return data
 
         # Revlogs are read much more frequently than they are written and many
         # chunks only take microseconds to decompress, so performance is
         # important here.
         #
         # We can make a few assumptions about revlogs:
         #
         # 1) the majority of chunks will be compressed (as opposed to inline
         #    raw data).
         # 2) decompressing *any* data will likely by at least 10x slower than
         #    returning raw inline data.
         # 3) we want to prioritize common and officially supported compression
         #    engines
         #
         # It follows that we want to optimize for "decompress compressed data
         # when encoded with common and officially supported compression engines"
         # case over "raw data" and "data encoded by less common or non-official
         # compression engines." That is why we have the inline lookup first
         # followed by the compengines lookup.
         #
         # According to `hg perfrevlogchunks`, this is ~0.5% faster for zlib
         # compressed chunks. And this matters for changelog and manifest reads.
         t = data[0:1]
 
         if t == b'x':
             try:
                 return _zlibdecompress(data)
             except zlib.error as e:
                 raise error.RevlogError(
                     _(b'revlog decompress error: %s')
                     % stringutil.forcebytestr(e)
                 )
         # '\0' is more common than 'u' so it goes first.
         elif t == b'\0':
             return data
         elif t == b'u':
             return util.buffer(data, 1)
 
         compressor = self._get_decompressor(t)
 
         return compressor.decompress(data)
 
     def _addrevision(
         self,
         node,
         rawtext,
         transaction,
         link,
         p1,
         p2,
         flags,
         cachedelta,
         alwayscache=False,
         deltacomputer=None,
         sidedata=None,
     ):
         """internal function to add revisions to the log
 
         see addrevision for argument descriptions.
 
         note: "addrevision" takes non-raw text, "_addrevision" takes raw text.
 
         if "deltacomputer" is not provided or None, a defaultdeltacomputer will
         be used.
 
         invariants:
         - rawtext is optional (can be None); if not set, cachedelta must be set.
           if both are set, they must correspond to each other.
         """
         if node == self.nullid:
             raise error.RevlogError(
                 _(b"%s: attempt to add null revision") % self.display_id
             )
         if (
             node == self.nodeconstants.wdirid
             or node in self.nodeconstants.wdirfilenodeids
         ):
             raise error.RevlogError(
                 _(b"%s: attempt to add wdir revision") % self.display_id
             )
         if self._writinghandles is None:
             msg = b'adding revision outside `revlog._writing` context'
             raise error.ProgrammingError(msg)
 
         if self._inline:
             fh = self._writinghandles[0]
         else:
             fh = self._writinghandles[1]
 
         btext = [rawtext]
 
         curr = len(self)
         prev = curr - 1
 
         offset = self._get_data_offset(prev)
 
         if self._concurrencychecker:
             ifh, dfh, sdfh = self._writinghandles
             # XXX no checking for the sidedata file
             if self._inline:
                 # offset is "as if" it were in the .d file, so we need to add on
                 # the size of the entry metadata.
                 self._concurrencychecker(
                     ifh, self._indexfile, offset + curr * self.index.entry_size
                 )
             else:
                 # Entries in the .i are a consistent size.
                 self._concurrencychecker(
                     ifh, self._indexfile, curr * self.index.entry_size
                 )
                 self._concurrencychecker(dfh, self._datafile, offset)
 
         p1r, p2r = self.rev(p1), self.rev(p2)
 
         # full versions are inserted when the needed deltas
         # become comparable to the uncompressed text
         if rawtext is None:
             # need rawtext size, before changed by flag processors, which is
             # the non-raw size. use revlog explicitly to avoid filelog's extra
             # logic that might remove metadata size.
             textlen = mdiff.patchedsize(
                 revlog.size(self, cachedelta[0]), cachedelta[1]
             )
         else:
             textlen = len(rawtext)
 
         if deltacomputer is None:
             write_debug = None
             if self._debug_delta:
                 write_debug = transaction._report
             deltacomputer = deltautil.deltacomputer(
                 self, write_debug=write_debug
             )
 
         revinfo = revlogutils.revisioninfo(
             node,
             p1,
             p2,
             btext,
             textlen,
             cachedelta,
             flags,
         )
 
         deltainfo = deltacomputer.finddeltainfo(revinfo, fh)
 
         compression_mode = COMP_MODE_INLINE
         if self._docket is not None:
             default_comp = self._docket.default_compression_header
             r = deltautil.delta_compression(default_comp, deltainfo)
             compression_mode, deltainfo = r
 
         sidedata_compression_mode = COMP_MODE_INLINE
         if sidedata and self.hassidedata:
             sidedata_compression_mode = COMP_MODE_PLAIN
             serialized_sidedata = sidedatautil.serialize_sidedata(sidedata)
             sidedata_offset = self._docket.sidedata_end
             h, comp_sidedata = self.compress(serialized_sidedata)
             if (
                 h != b'u'
                 and comp_sidedata[0:1] != b'\0'
                 and len(comp_sidedata) < len(serialized_sidedata)
             ):
                 assert not h
                 if (
                     comp_sidedata[0:1]
                     == self._docket.default_compression_header
                 ):
                     sidedata_compression_mode = COMP_MODE_DEFAULT
                     serialized_sidedata = comp_sidedata
                 else:
                     sidedata_compression_mode = COMP_MODE_INLINE
                     serialized_sidedata = comp_sidedata
         else:
             serialized_sidedata = b""
             # Don't store the offset if the sidedata is empty, that way
             # we can easily detect empty sidedata and they will be no different
             # than ones we manually add.
             sidedata_offset = 0
 
         rank = RANK_UNKNOWN
         if self._format_version == CHANGELOGV2:
             if (p1r, p2r) == (nullrev, nullrev):
                 rank = 1
             elif p1r != nullrev and p2r == nullrev:
                 rank = 1 + self.fast_rank(p1r)
             elif p1r == nullrev and p2r != nullrev:
                 rank = 1 + self.fast_rank(p2r)
             else:  # merge node
                 if rustdagop is not None and self.index.rust_ext_compat:
                     rank = rustdagop.rank(self.index, p1r, p2r)
                 else:
                     pmin, pmax = sorted((p1r, p2r))
                     rank = 1 + self.fast_rank(pmax)
                     rank += sum(1 for _ in self.findmissingrevs([pmax], [pmin]))
 
         e = revlogutils.entry(
             flags=flags,
             data_offset=offset,
             data_compressed_length=deltainfo.deltalen,
             data_uncompressed_length=textlen,
             data_compression_mode=compression_mode,
             data_delta_base=deltainfo.base,
             link_rev=link,
             parent_rev_1=p1r,
             parent_rev_2=p2r,
             node_id=node,
             sidedata_offset=sidedata_offset,
             sidedata_compressed_length=len(serialized_sidedata),
             sidedata_compression_mode=sidedata_compression_mode,
             rank=rank,
         )
 
         self.index.append(e)
         entry = self.index.entry_binary(curr)
         if curr == 0 and self._docket is None:
             header = self._format_flags | self._format_version
             header = self.index.pack_header(header)
             entry = header + entry
         self._writeentry(
             transaction,
             entry,
             deltainfo.data,
             link,
             offset,
             serialized_sidedata,
             sidedata_offset,
         )
 
         rawtext = btext[0]
 
         if alwayscache and rawtext is None:
             rawtext = deltacomputer.buildtext(revinfo, fh)
 
         if type(rawtext) == bytes:  # only accept immutable objects
             self._revisioncache = (node, curr, rawtext)
         self._chainbasecache[curr] = deltainfo.chainbase
         return curr
 
     def _get_data_offset(self, prev):
         """Returns the current offset in the (in-transaction) data file.
         Versions < 2 of the revlog can get this 0(1), revlog v2 needs a docket
         file to store that information: since sidedata can be rewritten to the
         end of the data file within a transaction, you can have cases where, for
         example, rev `n` does not have sidedata while rev `n - 1` does, leading
         to `n - 1`'s sidedata being written after `n`'s data.
 
         TODO cache this in a docket file before getting out of experimental."""
         if self._docket is None:
             return self.end(prev)
         else:
             return self._docket.data_end
 
     def _writeentry(
         self, transaction, entry, data, link, offset, sidedata, sidedata_offset
     ):
         # Files opened in a+ mode have inconsistent behavior on various
         # platforms. Windows requires that a file positioning call be made
         # when the file handle transitions between reads and writes. See
         # 3686fa2b8eee and the mixedfilemodewrapper in windows.py. On other
         # platforms, Python or the platform itself can be buggy. Some versions
         # of Solaris have been observed to not append at the end of the file
         # if the file was seeked to before the end. See issue4943 for more.
         #
         # We work around this issue by inserting a seek() before writing.
         # Note: This is likely not necessary on Python 3. However, because
         # the file handle is reused for reads and may be seeked there, we need
         # to be careful before changing this.
         if self._writinghandles is None:
             msg = b'adding revision outside `revlog._writing` context'
             raise error.ProgrammingError(msg)
         ifh, dfh, sdfh = self._writinghandles
         if self._docket is None:
             ifh.seek(0, os.SEEK_END)
         else:
             ifh.seek(self._docket.index_end, os.SEEK_SET)
         if dfh:
             if self._docket is None:
                 dfh.seek(0, os.SEEK_END)
             else:
                 dfh.seek(self._docket.data_end, os.SEEK_SET)
         if sdfh:
             sdfh.seek(self._docket.sidedata_end, os.SEEK_SET)
 
         curr = len(self) - 1
         if not self._inline:
             transaction.add(self._datafile, offset)
             if self._sidedatafile:
                 transaction.add(self._sidedatafile, sidedata_offset)
             transaction.add(self._indexfile, curr * len(entry))
             if data[0]:
                 dfh.write(data[0])
             dfh.write(data[1])
             if sidedata:
                 sdfh.write(sidedata)
             ifh.write(entry)
         else:
             offset += curr * self.index.entry_size
             transaction.add(self._indexfile, offset)
             ifh.write(entry)
             ifh.write(data[0])
             ifh.write(data[1])
             assert not sidedata
             self._enforceinlinesize(transaction)
         if self._docket is not None:
             # revlog-v2 always has 3 writing handles, help Pytype
             wh1 = self._writinghandles[0]
             wh2 = self._writinghandles[1]
             wh3 = self._writinghandles[2]
             assert wh1 is not None
             assert wh2 is not None
             assert wh3 is not None
             self._docket.index_end = wh1.tell()
             self._docket.data_end = wh2.tell()
             self._docket.sidedata_end = wh3.tell()
 
         nodemaputil.setup_persistent_nodemap(transaction, self)
 
     def addgroup(
         self,
         deltas,
         linkmapper,
         transaction,
         alwayscache=False,
         addrevisioncb=None,
         duplicaterevisioncb=None,
         debug_info=None,
     ):
         """
         add a delta group
 
         given a set of deltas, add them to the revision log. the
         first delta is against its parent, which should be in our
         log, the rest are against the previous delta.
 
         If ``addrevisioncb`` is defined, it will be called with arguments of
         this revlog and the node that was added.
         """
 
         if self._adding_group:
             raise error.ProgrammingError(b'cannot nest addgroup() calls')
 
         self._adding_group = True
         empty = True
         try:
             with self._writing(transaction):
                 write_debug = None
                 if self._debug_delta:
                     write_debug = transaction._report
                 deltacomputer = deltautil.deltacomputer(
                     self,
                     write_debug=write_debug,
                     debug_info=debug_info,
                 )
                 # loop through our set of deltas
                 for data in deltas:
                     (
                         node,
                         p1,
                         p2,
                         linknode,
                         deltabase,
                         delta,
                         flags,
                         sidedata,
                     ) = data
                     link = linkmapper(linknode)
                     flags = flags or REVIDX_DEFAULT_FLAGS
 
                     rev = self.index.get_rev(node)
                     if rev is not None:
                         # this can happen if two branches make the same change
                         self._nodeduplicatecallback(transaction, rev)
                         if duplicaterevisioncb:
                             duplicaterevisioncb(self, rev)
                         empty = False
                         continue
 
                     for p in (p1, p2):
                         if not self.index.has_node(p):
                             raise error.LookupError(
                                 p, self.radix, _(b'unknown parent')
                             )
 
                     if not self.index.has_node(deltabase):
                         raise error.LookupError(
                             deltabase, self.display_id, _(b'unknown delta base')
                         )
 
                     baserev = self.rev(deltabase)
 
                     if baserev != nullrev and self.iscensored(baserev):
                         # if base is censored, delta must be full replacement in a
                         # single patch operation
                         hlen = struct.calcsize(b">lll")
                         oldlen = self.rawsize(baserev)
                         newlen = len(delta) - hlen
                         if delta[:hlen] != mdiff.replacediffheader(
                             oldlen, newlen
                         ):
                             raise error.CensoredBaseError(
                                 self.display_id, self.node(baserev)
                             )
 
                     if not flags and self._peek_iscensored(baserev, delta):
                         flags |= REVIDX_ISCENSORED
 
                     # We assume consumers of addrevisioncb will want to retrieve
                     # the added revision, which will require a call to
                     # revision(). revision() will fast path if there is a cache
                     # hit. So, we tell _addrevision() to always cache in this case.
                     # We're only using addgroup() in the context of changegroup
                     # generation so the revision data can always be handled as raw
                     # by the flagprocessor.
                     rev = self._addrevision(
                         node,
                         None,
                         transaction,
                         link,
                         p1,
                         p2,
                         flags,
                         (baserev, delta),
                         alwayscache=alwayscache,
                         deltacomputer=deltacomputer,
                         sidedata=sidedata,
                     )
 
                     if addrevisioncb:
                         addrevisioncb(self, rev)
                     empty = False
         finally:
             self._adding_group = False
         return not empty
 
     def iscensored(self, rev):
         """Check if a file revision is censored."""
         if not self._censorable:
             return False
 
         return self.flags(rev) & REVIDX_ISCENSORED
 
     def _peek_iscensored(self, baserev, delta):
         """Quickly check if a delta produces a censored revision."""
         if not self._censorable:
             return False
 
         return storageutil.deltaiscensored(delta, baserev, self.rawsize)
 
     def getstrippoint(self, minlink):
         """find the minimum rev that must be stripped to strip the linkrev
 
         Returns a tuple containing the minimum rev and a set of all revs that
         have linkrevs that will be broken by this strip.
         """
         return storageutil.resolvestripinfo(
             minlink,
             len(self) - 1,
             self.headrevs(),
             self.linkrev,
             self.parentrevs,
         )
 
     def strip(self, minlink, transaction):
         """truncate the revlog on the first revision with a linkrev >= minlink
 
         This function is called when we're stripping revision minlink and
         its descendants from the repository.
 
         We have to remove all revisions with linkrev >= minlink, because
         the equivalent changelog revisions will be renumbered after the
         strip.
 
         So we truncate the revlog on the first of these revisions, and
         trust that the caller has saved the revisions that shouldn't be
         removed and that it'll re-add them after this truncation.
         """
         if len(self) == 0:
             return
 
         rev, _ = self.getstrippoint(minlink)
         if rev == len(self):
             return
 
         # first truncate the files on disk
         data_end = self.start(rev)
         if not self._inline:
             transaction.add(self._datafile, data_end)
             end = rev * self.index.entry_size
         else:
             end = data_end + (rev * self.index.entry_size)
 
         if self._sidedatafile:
             sidedata_end = self.sidedata_cut_off(rev)
             transaction.add(self._sidedatafile, sidedata_end)
 
         transaction.add(self._indexfile, end)
         if self._docket is not None:
             # XXX we could, leverage the docket while stripping. However it is
             # not powerfull enough at the time of this comment
             self._docket.index_end = end
             self._docket.data_end = data_end
             self._docket.sidedata_end = sidedata_end
             self._docket.write(transaction, stripping=True)
 
         # then reset internal state in memory to forget those revisions
         self._revisioncache = None
         self._chaininfocache = util.lrucachedict(500)
         self._segmentfile.clear_cache()
         self._segmentfile_sidedata.clear_cache()
 
         del self.index[rev:-1]
 
     def checksize(self):
         """Check size of index and data files
 
         return a (dd, di) tuple.
         - dd: extra bytes for the "data" file
         - di: extra bytes for the "index" file
 
         A healthy revlog will return (0, 0).
         """
         expected = 0
         if len(self):
             expected = max(0, self.end(len(self) - 1))
 
         try:
             with self._datafp() as f:
                 f.seek(0, io.SEEK_END)
                 actual = f.tell()
             dd = actual - expected
         except FileNotFoundError:
             dd = 0
 
         try:
             f = self.opener(self._indexfile)
             f.seek(0, io.SEEK_END)
             actual = f.tell()
             f.close()
             s = self.index.entry_size
             i = max(0, actual // s)
             di = actual - (i * s)
             if self._inline:
                 databytes = 0
                 for r in self:
                     databytes += max(0, self.length(r))
                 dd = 0
                 di = actual - len(self) * s - databytes
         except FileNotFoundError:
             di = 0
 
         return (dd, di)
 
     def files(self):
         res = [self._indexfile]
         if self._docket_file is None:
             if not self._inline:
                 res.append(self._datafile)
         else:
             res.append(self._docket_file)
             res.extend(self._docket.old_index_filepaths(include_empty=False))
             if self._docket.data_end:
                 res.append(self._datafile)
             res.extend(self._docket.old_data_filepaths(include_empty=False))
             if self._docket.sidedata_end:
                 res.append(self._sidedatafile)
             res.extend(self._docket.old_sidedata_filepaths(include_empty=False))
         return res
 
     def emitrevisions(
         self,
         nodes,
         nodesorder=None,
         revisiondata=False,
         assumehaveparentrevisions=False,
         deltamode=repository.CG_DELTAMODE_STD,
         sidedata_helpers=None,
         debug_info=None,
     ):
         if nodesorder not in (b'nodes', b'storage', b'linear', None):
             raise error.ProgrammingError(
                 b'unhandled value for nodesorder: %s' % nodesorder
             )
 
         if nodesorder is None and not self._generaldelta:
             nodesorder = b'storage'
 
         if (
             not self._storedeltachains
             and deltamode != repository.CG_DELTAMODE_PREV
         ):
             deltamode = repository.CG_DELTAMODE_FULL
 
         return storageutil.emitrevisions(
             self,
             nodes,
             nodesorder,
             revlogrevisiondelta,
             deltaparentfn=self.deltaparent,
             candeltafn=self.candelta,
             rawsizefn=self.rawsize,
             revdifffn=self.revdiff,
             flagsfn=self.flags,
             deltamode=deltamode,
             revisiondata=revisiondata,
             assumehaveparentrevisions=assumehaveparentrevisions,
             sidedata_helpers=sidedata_helpers,
             debug_info=debug_info,
         )
 
     DELTAREUSEALWAYS = b'always'
     DELTAREUSESAMEREVS = b'samerevs'
     DELTAREUSENEVER = b'never'
 
     DELTAREUSEFULLADD = b'fulladd'
 
     DELTAREUSEALL = {b'always', b'samerevs', b'never', b'fulladd'}
 
     def clone(
         self,
         tr,
         destrevlog,
         addrevisioncb=None,
         deltareuse=DELTAREUSESAMEREVS,
         forcedeltabothparents=None,
         sidedata_helpers=None,
     ):
         """Copy this revlog to another, possibly with format changes.
 
         The destination revlog will contain the same revisions and nodes.
         However, it may not be bit-for-bit identical due to e.g. delta encoding
         differences.
 
         The ``deltareuse`` argument control how deltas from the existing revlog
         are preserved in the destination revlog. The argument can have the
         following values:
 
         DELTAREUSEALWAYS
            Deltas will always be reused (if possible), even if the destination
            revlog would not select the same revisions for the delta. This is the
            fastest mode of operation.
         DELTAREUSESAMEREVS
            Deltas will be reused if the destination revlog would pick the same
            revisions for the delta. This mode strikes a balance between speed
            and optimization.
         DELTAREUSENEVER
            Deltas will never be reused. This is the slowest mode of execution.
            This mode can be used to recompute deltas (e.g. if the diff/delta
            algorithm changes).
         DELTAREUSEFULLADD
            Revision will be re-added as if their were new content. This is
            slower than DELTAREUSEALWAYS but allow more mechanism to kicks in.
            eg: large file detection and handling.
 
         Delta computation can be slow, so the choice of delta reuse policy can
         significantly affect run time.
 
         The default policy (``DELTAREUSESAMEREVS``) strikes a balance between
         two extremes. Deltas will be reused if they are appropriate. But if the
         delta could choose a better revision, it will do so. This means if you
         are converting a non-generaldelta revlog to a generaldelta revlog,
         deltas will be recomputed if the delta's parent isn't a parent of the
         revision.
 
         In addition to the delta policy, the ``forcedeltabothparents``
         argument controls whether to force compute deltas against both parents
         for merges. By default, the current default is used.
 
         See `revlogutil.sidedata.get_sidedata_helpers` for the doc on
         `sidedata_helpers`.
         """
         if deltareuse not in self.DELTAREUSEALL:
             raise ValueError(
                 _(b'value for deltareuse invalid: %s') % deltareuse
             )
 
         if len(destrevlog):
             raise ValueError(_(b'destination revlog is not empty'))
 
         if getattr(self, 'filteredrevs', None):
             raise ValueError(_(b'source revlog has filtered revisions'))
         if getattr(destrevlog, 'filteredrevs', None):
             raise ValueError(_(b'destination revlog has filtered revisions'))
 
         # lazydelta and lazydeltabase controls whether to reuse a cached delta,
         # if possible.
         oldlazydelta = destrevlog._lazydelta
         oldlazydeltabase = destrevlog._lazydeltabase
         oldamd = destrevlog._deltabothparents
 
         try:
             if deltareuse == self.DELTAREUSEALWAYS:
                 destrevlog._lazydeltabase = True
                 destrevlog._lazydelta = True
             elif deltareuse == self.DELTAREUSESAMEREVS:
                 destrevlog._lazydeltabase = False
                 destrevlog._lazydelta = True
             elif deltareuse == self.DELTAREUSENEVER:
                 destrevlog._lazydeltabase = False
                 destrevlog._lazydelta = False
 
             destrevlog._deltabothparents = forcedeltabothparents or oldamd
 
             self._clone(
                 tr,
                 destrevlog,
                 addrevisioncb,
                 deltareuse,
                 forcedeltabothparents,
                 sidedata_helpers,
             )
 
         finally:
             destrevlog._lazydelta = oldlazydelta
             destrevlog._lazydeltabase = oldlazydeltabase
             destrevlog._deltabothparents = oldamd
 
     def _clone(
         self,
         tr,
         destrevlog,
         addrevisioncb,
         deltareuse,
         forcedeltabothparents,
         sidedata_helpers,
     ):
         """perform the core duty of `revlog.clone` after parameter processing"""
         write_debug = None
         if self._debug_delta:
             write_debug = tr._report
         deltacomputer = deltautil.deltacomputer(
             destrevlog,
             write_debug=write_debug,
         )
         index = self.index
         for rev in self:
             entry = index[rev]
 
             # Some classes override linkrev to take filtered revs into
             # account. Use raw entry from index.
             flags = entry[0] & 0xFFFF
             linkrev = entry[4]
             p1 = index[entry[5]][7]
             p2 = index[entry[6]][7]
             node = entry[7]
 
             # (Possibly) reuse the delta from the revlog if allowed and
             # the revlog chunk is a delta.
             cachedelta = None
             rawtext = None
             if deltareuse == self.DELTAREUSEFULLADD:
                 text = self._revisiondata(rev)
                 sidedata = self.sidedata(rev)
 
                 if sidedata_helpers is not None:
                     (sidedata, new_flags) = sidedatautil.run_sidedata_helpers(
                         self, sidedata_helpers, sidedata, rev
                     )
                     flags = flags | new_flags[0] & ~new_flags[1]
 
                 destrevlog.addrevision(
                     text,
                     tr,
                     linkrev,
                     p1,
                     p2,
                     cachedelta=cachedelta,
                     node=node,
                     flags=flags,
                     deltacomputer=deltacomputer,
                     sidedata=sidedata,
                 )
             else:
                 if destrevlog._lazydelta:
                     dp = self.deltaparent(rev)
                     if dp != nullrev:
                         cachedelta = (dp, bytes(self._chunk(rev)))
 
                 sidedata = None
                 if not cachedelta:
                     rawtext = self._revisiondata(rev)
                     sidedata = self.sidedata(rev)
                 if sidedata is None:
                     sidedata = self.sidedata(rev)
 
                 if sidedata_helpers is not None:
                     (sidedata, new_flags) = sidedatautil.run_sidedata_helpers(
                         self, sidedata_helpers, sidedata, rev
                     )
                     flags = flags | new_flags[0] & ~new_flags[1]
 
                 with destrevlog._writing(tr):
                     destrevlog._addrevision(
                         node,
                         rawtext,
                         tr,
                         linkrev,
                         p1,
                         p2,
                         flags,
                         cachedelta,
                         deltacomputer=deltacomputer,
                         sidedata=sidedata,
                     )
 
             if addrevisioncb:
                 addrevisioncb(self, rev, node)
 
     def censorrevision(self, tr, censornode, tombstone=b''):
         if self._format_version == REVLOGV0:
             raise error.RevlogError(
                 _(b'cannot censor with version %d revlogs')
                 % self._format_version
             )
         elif self._format_version == REVLOGV1:
             rewrite.v1_censor(self, tr, censornode, tombstone)
         else:
             rewrite.v2_censor(self, tr, censornode, tombstone)
 
     def verifyintegrity(self, state):
         """Verifies the integrity of the revlog.
 
         Yields ``revlogproblem`` instances describing problems that are
         found.
         """
         dd, di = self.checksize()
         if dd:
             yield revlogproblem(error=_(b'data length off by %d bytes') % dd)
         if di:
             yield revlogproblem(error=_(b'index contains %d extra bytes') % di)
 
         version = self._format_version
 
         # The verifier tells us what version revlog we should be.
         if version != state[b'expectedversion']:
             yield revlogproblem(
                 warning=_(b"warning: '%s' uses revlog format %d; expected %d")
                 % (self.display_id, version, state[b'expectedversion'])
             )
 
         state[b'skipread'] = set()
         state[b'safe_renamed'] = set()
 
         for rev in self:
             node = self.node(rev)
 
             # Verify contents. 4 cases to care about:
             #
             #   common: the most common case
             #   rename: with a rename
             #   meta: file content starts with b'\1\n', the metadata
             #         header defined in filelog.py, but without a rename
             #   ext: content stored externally
             #
             # More formally, their differences are shown below:
             #
             #                       | common | rename | meta  | ext
             #  -------------------------------------------------------
             #   flags()             | 0      | 0      | 0     | not 0
             #   renamed()           | False  | True   | False | ?
             #   rawtext[0:2]=='\1\n'| False  | True   | True  | ?
             #
             # "rawtext" means the raw text stored in revlog data, which
             # could be retrieved by "rawdata(rev)". "text"
             # mentioned below is "revision(rev)".
             #
             # There are 3 different lengths stored physically:
             #  1. L1: rawsize, stored in revlog index
             #  2. L2: len(rawtext), stored in revlog data
             #  3. L3: len(text), stored in revlog data if flags==0, or
             #     possibly somewhere else if flags!=0
             #
             # L1 should be equal to L2. L3 could be different from them.
             # "text" may or may not affect commit hash depending on flag
             # processors (see flagutil.addflagprocessor).
             #
             #              | common  | rename | meta  | ext
             # -------------------------------------------------
             #    rawsize() | L1      | L1     | L1    | L1
             #       size() | L1      | L2-LM  | L1(*) | L1 (?)
             # len(rawtext) | L2      | L2     | L2    | L2
             #    len(text) | L2      | L2     | L2    | L3
             #  len(read()) | L2      | L2-LM  | L2-LM | L3 (?)
             #
             # LM:  length of metadata, depending on rawtext
             # (*): not ideal, see comment in filelog.size
             # (?): could be "- len(meta)" if the resolved content has
             #      rename metadata
             #
             # Checks needed to be done:
             #  1. length check: L1 == L2, in all cases.
             #  2. hash check: depending on flag processor, we may need to
             #     use either "text" (external), or "rawtext" (in revlog).
 
             try:
                 skipflags = state.get(b'skipflags', 0)
                 if skipflags:
                     skipflags &= self.flags(rev)
 
                 _verify_revision(self, skipflags, state, node)
 
                 l1 = self.rawsize(rev)
                 l2 = len(self.rawdata(node))
 
                 if l1 != l2:
                     yield revlogproblem(
                         error=_(b'unpacked size is %d, %d expected') % (l2, l1),
                         node=node,
                     )
 
             except error.CensoredNodeError:
                 if state[b'erroroncensored']:
                     yield revlogproblem(
                         error=_(b'censored file data'), node=node
                     )
                     state[b'skipread'].add(node)
             except Exception as e:
                 yield revlogproblem(
                     error=_(b'unpacking %s: %s')
                     % (short(node), stringutil.forcebytestr(e)),
                     node=node,
                 )
                 state[b'skipread'].add(node)
 
     def storageinfo(
         self,
         exclusivefiles=False,
         sharedfiles=False,
         revisionscount=False,
         trackedsize=False,
         storedsize=False,
     ):
         d = {}
 
         if exclusivefiles:
             d[b'exclusivefiles'] = [(self.opener, self._indexfile)]
             if not self._inline:
                 d[b'exclusivefiles'].append((self.opener, self._datafile))
 
         if sharedfiles:
             d[b'sharedfiles'] = []
 
         if revisionscount:
             d[b'revisionscount'] = len(self)
 
         if trackedsize:
             d[b'trackedsize'] = sum(map(self.rawsize, iter(self)))
 
         if storedsize:
             d[b'storedsize'] = sum(
                 self.opener.stat(path).st_size for path in self.files()
             )
 
         return d
 
     def rewrite_sidedata(self, transaction, helpers, startrev, endrev):
         if not self.hassidedata:
             return
         # revlog formats with sidedata support does not support inline
         assert not self._inline
         if not helpers[1] and not helpers[2]:
             # Nothing to generate or remove
             return
 
         new_entries = []
         # append the new sidedata
         with self._writing(transaction):
             ifh, dfh, sdfh = self._writinghandles
             dfh.seek(self._docket.sidedata_end, os.SEEK_SET)
 
             current_offset = sdfh.tell()
             for rev in range(startrev, endrev + 1):
                 entry = self.index[rev]
                 new_sidedata, flags = sidedatautil.run_sidedata_helpers(
                     store=self,
                     sidedata_helpers=helpers,
                     sidedata={},
                     rev=rev,
                 )
 
                 serialized_sidedata = sidedatautil.serialize_sidedata(
                     new_sidedata
                 )
 
                 sidedata_compression_mode = COMP_MODE_INLINE
                 if serialized_sidedata and self.hassidedata:
                     sidedata_compression_mode = COMP_MODE_PLAIN
                     h, comp_sidedata = self.compress(serialized_sidedata)
                     if (
                         h != b'u'
                         and comp_sidedata[0] != b'\0'
                         and len(comp_sidedata) < len(serialized_sidedata)
                     ):
                         assert not h
                         if (
                             comp_sidedata[0]
                             == self._docket.default_compression_header
                         ):
                             sidedata_compression_mode = COMP_MODE_DEFAULT
                             serialized_sidedata = comp_sidedata
                         else:
                             sidedata_compression_mode = COMP_MODE_INLINE
                             serialized_sidedata = comp_sidedata
                 if entry[8] != 0 or entry[9] != 0:
                     # rewriting entries that already have sidedata is not
                     # supported yet, because it introduces garbage data in the
                     # revlog.
                     msg = b"rewriting existing sidedata is not supported yet"
                     raise error.Abort(msg)
 
                 # Apply (potential) flags to add and to remove after running
                 # the sidedata helpers
                 new_offset_flags = entry[0] | flags[0] & ~flags[1]
                 entry_update = (
                     current_offset,
                     len(serialized_sidedata),
                     new_offset_flags,
                     sidedata_compression_mode,
                 )
 
                 # the sidedata computation might have move the file cursors around
                 sdfh.seek(current_offset, os.SEEK_SET)
                 sdfh.write(serialized_sidedata)
                 new_entries.append(entry_update)
                 current_offset += len(serialized_sidedata)
                 self._docket.sidedata_end = sdfh.tell()
 
             # rewrite the new index entries
             ifh.seek(startrev * self.index.entry_size)
             for i, e in enumerate(new_entries):
                 rev = startrev + i
                 self.index.replace_sidedata_info(rev, *e)
                 packed = self.index.entry_binary(rev)
                 if rev == 0 and self._docket is None:
                     header = self._format_flags | self._format_version
                     header = self.index.pack_header(header)
                     packed = header + packed
                 ifh.write(packed)

mercurial/revlogutils/deltas.py

@@ -1,1407 +1,1427 b''
 # revlogdeltas.py - Logic around delta computation for revlog
 #
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 # Copyright 2018 Octobus <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 """Helper class to compute deltas stored inside revlogs"""
 
 
 import collections
 import struct
 
 # import stuff from node for others to import from revlog
 from ..node import nullrev
 from ..i18n import _
 from ..pycompat import getattr
 
 from .constants import (
     COMP_MODE_DEFAULT,
     COMP_MODE_INLINE,
     COMP_MODE_PLAIN,
     KIND_CHANGELOG,
     KIND_FILELOG,
     KIND_MANIFESTLOG,
     REVIDX_ISCENSORED,
     REVIDX_RAWTEXT_CHANGING_FLAGS,
 )
 
 from ..thirdparty import attr
 
 from .. import (
     error,
     mdiff,
     util,
 )
 
 from . import flagutil
 
 # maximum <delta-chain-data>/<revision-text-length> ratio
 LIMIT_DELTA2TEXT = 2
 
 
 class _testrevlog:
     """minimalist fake revlog to use in doctests"""
 
     def __init__(self, data, density=0.5, mingap=0, snapshot=()):
         """data is an list of revision payload boundaries"""
         self._data = data
         self._srdensitythreshold = density
         self._srmingapsize = mingap
         self._snapshot = set(snapshot)
         self.index = None
 
     def start(self, rev):
         if rev == nullrev:
             return 0
         if rev == 0:
             return 0
         return self._data[rev - 1]
 
     def end(self, rev):
         if rev == nullrev:
             return 0
         return self._data[rev]
 
     def length(self, rev):
         return self.end(rev) - self.start(rev)
 
     def __len__(self):
         return len(self._data)
 
     def issnapshot(self, rev):
         if rev == nullrev:
             return True
         return rev in self._snapshot
 
 
 def slicechunk(revlog, revs, targetsize=None):
     """slice revs to reduce the amount of unrelated data to be read from disk.
 
     ``revs`` is sliced into groups that should be read in one time.
     Assume that revs are sorted.
 
     The initial chunk is sliced until the overall density (payload/chunks-span
     ratio) is above `revlog._srdensitythreshold`. No gap smaller than
     `revlog._srmingapsize` is skipped.
 
     If `targetsize` is set, no chunk larger than `targetsize` will be yield.
     For consistency with other slicing choice, this limit won't go lower than
     `revlog._srmingapsize`.
 
     If individual revisions chunk are larger than this limit, they will still
     be raised individually.
 
     >>> data = [
     ...  5,  #00 (5)
     ...  10, #01 (5)
     ...  12, #02 (2)
     ...  12, #03 (empty)
     ...  27, #04 (15)
     ...  31, #05 (4)
     ...  31, #06 (empty)
     ...  42, #07 (11)
     ...  47, #08 (5)
     ...  47, #09 (empty)
     ...  48, #10 (1)
     ...  51, #11 (3)
     ...  74, #12 (23)
     ...  85, #13 (11)
     ...  86, #14 (1)
     ...  91, #15 (5)
     ... ]
     >>> revlog = _testrevlog(data, snapshot=range(16))
 
     >>> list(slicechunk(revlog, list(range(16))))
     [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]]
     >>> list(slicechunk(revlog, [0, 15]))
     [[0], [15]]
     >>> list(slicechunk(revlog, [0, 11, 15]))
     [[0], [11], [15]]
     >>> list(slicechunk(revlog, [0, 11, 13, 15]))
     [[0], [11, 13, 15]]
     >>> list(slicechunk(revlog, [1, 2, 3, 5, 8, 10, 11, 14]))
     [[1, 2], [5, 8, 10, 11], [14]]
 
     Slicing with a maximum chunk size
     >>> list(slicechunk(revlog, [0, 11, 13, 15], targetsize=15))
     [[0], [11], [13], [15]]
     >>> list(slicechunk(revlog, [0, 11, 13, 15], targetsize=20))
     [[0], [11], [13, 15]]
 
     Slicing involving nullrev
     >>> list(slicechunk(revlog, [-1, 0, 11, 13, 15], targetsize=20))
     [[-1, 0], [11], [13, 15]]
     >>> list(slicechunk(revlog, [-1, 13, 15], targetsize=5))
     [[-1], [13], [15]]
     """
     if targetsize is not None:
         targetsize = max(targetsize, revlog._srmingapsize)
     # targetsize should not be specified when evaluating delta candidates:
     # * targetsize is used to ensure we stay within specification when reading,
     densityslicing = getattr(revlog.index, 'slicechunktodensity', None)
     if densityslicing is None:
         densityslicing = lambda x, y, z: _slicechunktodensity(revlog, x, y, z)
     for chunk in densityslicing(
         revs, revlog._srdensitythreshold, revlog._srmingapsize
     ):
         for subchunk in _slicechunktosize(revlog, chunk, targetsize):
             yield subchunk
 
 
 def _slicechunktosize(revlog, revs, targetsize=None):
     """slice revs to match the target size
 
     This is intended to be used on chunk that density slicing selected by that
     are still too large compared to the read garantee of revlog. This might
     happens when "minimal gap size" interrupted the slicing or when chain are
     built in a way that create large blocks next to each other.
 
     >>> data = [
     ...  3,  #0 (3)
     ...  5,  #1 (2)
     ...  6,  #2 (1)
     ...  8,  #3 (2)
     ...  8,  #4 (empty)
     ...  11, #5 (3)
     ...  12, #6 (1)
     ...  13, #7 (1)
     ...  14, #8 (1)
     ... ]
 
     == All snapshots cases ==
     >>> revlog = _testrevlog(data, snapshot=range(9))
 
     Cases where chunk is already small enough
     >>> list(_slicechunktosize(revlog, [0], 3))
     [[0]]
     >>> list(_slicechunktosize(revlog, [6, 7], 3))
     [[6, 7]]
     >>> list(_slicechunktosize(revlog, [0], None))
     [[0]]
     >>> list(_slicechunktosize(revlog, [6, 7], None))
     [[6, 7]]
 
     cases where we need actual slicing
     >>> list(_slicechunktosize(revlog, [0, 1], 3))
     [[0], [1]]
     >>> list(_slicechunktosize(revlog, [1, 3], 3))
     [[1], [3]]
     >>> list(_slicechunktosize(revlog, [1, 2, 3], 3))
     [[1, 2], [3]]
     >>> list(_slicechunktosize(revlog, [3, 5], 3))
     [[3], [5]]
     >>> list(_slicechunktosize(revlog, [3, 4, 5], 3))
     [[3], [5]]
     >>> list(_slicechunktosize(revlog, [5, 6, 7, 8], 3))
     [[5], [6, 7, 8]]
     >>> list(_slicechunktosize(revlog, [0, 1, 2, 3, 4, 5, 6, 7, 8], 3))
     [[0], [1, 2], [3], [5], [6, 7, 8]]
 
     Case with too large individual chunk (must return valid chunk)
     >>> list(_slicechunktosize(revlog, [0, 1], 2))
     [[0], [1]]
     >>> list(_slicechunktosize(revlog, [1, 3], 1))
     [[1], [3]]
     >>> list(_slicechunktosize(revlog, [3, 4, 5], 2))
     [[3], [5]]
 
     == No Snapshot cases ==
     >>> revlog = _testrevlog(data)
 
     Cases where chunk is already small enough
     >>> list(_slicechunktosize(revlog, [0], 3))
     [[0]]
     >>> list(_slicechunktosize(revlog, [6, 7], 3))
     [[6, 7]]
     >>> list(_slicechunktosize(revlog, [0], None))
     [[0]]
     >>> list(_slicechunktosize(revlog, [6, 7], None))
     [[6, 7]]
 
     cases where we need actual slicing
     >>> list(_slicechunktosize(revlog, [0, 1], 3))
     [[0], [1]]
     >>> list(_slicechunktosize(revlog, [1, 3], 3))
     [[1], [3]]
     >>> list(_slicechunktosize(revlog, [1, 2, 3], 3))
     [[1], [2, 3]]
     >>> list(_slicechunktosize(revlog, [3, 5], 3))
     [[3], [5]]
     >>> list(_slicechunktosize(revlog, [3, 4, 5], 3))
     [[3], [4, 5]]
     >>> list(_slicechunktosize(revlog, [5, 6, 7, 8], 3))
     [[5], [6, 7, 8]]
     >>> list(_slicechunktosize(revlog, [0, 1, 2, 3, 4, 5, 6, 7, 8], 3))
     [[0], [1, 2], [3], [5], [6, 7, 8]]
 
     Case with too large individual chunk (must return valid chunk)
     >>> list(_slicechunktosize(revlog, [0, 1], 2))
     [[0], [1]]
     >>> list(_slicechunktosize(revlog, [1, 3], 1))
     [[1], [3]]
     >>> list(_slicechunktosize(revlog, [3, 4, 5], 2))
     [[3], [5]]
 
     == mixed case ==
     >>> revlog = _testrevlog(data, snapshot=[0, 1, 2])
     >>> list(_slicechunktosize(revlog, list(range(9)), 5))
     [[0, 1], [2], [3, 4, 5], [6, 7, 8]]
     """
     assert targetsize is None or 0 <= targetsize
     startdata = revlog.start(revs[0])
     enddata = revlog.end(revs[-1])
     fullspan = enddata - startdata
     if targetsize is None or fullspan <= targetsize:
         yield revs
         return
 
     startrevidx = 0
     endrevidx = 1
     iterrevs = enumerate(revs)
     next(iterrevs)  # skip first rev.
     # first step: get snapshots out of the way
     for idx, r in iterrevs:
         span = revlog.end(r) - startdata
         snapshot = revlog.issnapshot(r)
         if span <= targetsize and snapshot:
             endrevidx = idx + 1
         else:
             chunk = _trimchunk(revlog, revs, startrevidx, endrevidx)
             if chunk:
                 yield chunk
             startrevidx = idx
             startdata = revlog.start(r)
             endrevidx = idx + 1
         if not snapshot:
             break
 
     # for the others, we use binary slicing to quickly converge toward valid
     # chunks (otherwise, we might end up looking for start/end of many
     # revisions). This logic is not looking for the perfect slicing point, it
     # focuses on quickly converging toward valid chunks.
     nbitem = len(revs)
     while (enddata - startdata) > targetsize:
         endrevidx = nbitem
         if nbitem - startrevidx <= 1:
             break  # protect against individual chunk larger than limit
         localenddata = revlog.end(revs[endrevidx - 1])
         span = localenddata - startdata
         while span > targetsize:
             if endrevidx - startrevidx <= 1:
                 break  # protect against individual chunk larger than limit
             endrevidx -= (endrevidx - startrevidx) // 2
             localenddata = revlog.end(revs[endrevidx - 1])
             span = localenddata - startdata
         chunk = _trimchunk(revlog, revs, startrevidx, endrevidx)
         if chunk:
             yield chunk
         startrevidx = endrevidx
         startdata = revlog.start(revs[startrevidx])
 
     chunk = _trimchunk(revlog, revs, startrevidx)
     if chunk:
         yield chunk
 
 
 def _slicechunktodensity(revlog, revs, targetdensity=0.5, mingapsize=0):
     """slice revs to reduce the amount of unrelated data to be read from disk.
 
     ``revs`` is sliced into groups that should be read in one time.
     Assume that revs are sorted.
 
     The initial chunk is sliced until the overall density (payload/chunks-span
     ratio) is above `targetdensity`. No gap smaller than `mingapsize` is
     skipped.
 
     >>> revlog = _testrevlog([
     ...  5,  #00 (5)
     ...  10, #01 (5)
     ...  12, #02 (2)
     ...  12, #03 (empty)
     ...  27, #04 (15)
     ...  31, #05 (4)
     ...  31, #06 (empty)
     ...  42, #07 (11)
     ...  47, #08 (5)
     ...  47, #09 (empty)
     ...  48, #10 (1)
     ...  51, #11 (3)
     ...  74, #12 (23)
     ...  85, #13 (11)
     ...  86, #14 (1)
     ...  91, #15 (5)
     ... ])
 
     >>> list(_slicechunktodensity(revlog, list(range(16))))
     [[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15]]
     >>> list(_slicechunktodensity(revlog, [0, 15]))
     [[0], [15]]
     >>> list(_slicechunktodensity(revlog, [0, 11, 15]))
     [[0], [11], [15]]
     >>> list(_slicechunktodensity(revlog, [0, 11, 13, 15]))
     [[0], [11, 13, 15]]
     >>> list(_slicechunktodensity(revlog, [1, 2, 3, 5, 8, 10, 11, 14]))
     [[1, 2], [5, 8, 10, 11], [14]]
     >>> list(_slicechunktodensity(revlog, [1, 2, 3, 5, 8, 10, 11, 14],
     ...                           mingapsize=20))
     [[1, 2, 3, 5, 8, 10, 11], [14]]
     >>> list(_slicechunktodensity(revlog, [1, 2, 3, 5, 8, 10, 11, 14],
     ...                           targetdensity=0.95))
     [[1, 2], [5], [8, 10, 11], [14]]
     >>> list(_slicechunktodensity(revlog, [1, 2, 3, 5, 8, 10, 11, 14],
     ...                           targetdensity=0.95, mingapsize=12))
     [[1, 2], [5, 8, 10, 11], [14]]
     """
     start = revlog.start
     length = revlog.length
 
     if len(revs) <= 1:
         yield revs
         return
 
     deltachainspan = segmentspan(revlog, revs)
 
     if deltachainspan < mingapsize:
         yield revs
         return
 
     readdata = deltachainspan
     chainpayload = sum(length(r) for r in revs)
 
     if deltachainspan:
         density = chainpayload / float(deltachainspan)
     else:
         density = 1.0
 
     if density >= targetdensity:
         yield revs
         return
 
     # Store the gaps in a heap to have them sorted by decreasing size
     gaps = []
     prevend = None
     for i, rev in enumerate(revs):
         revstart = start(rev)
         revlen = length(rev)
 
         # Skip empty revisions to form larger holes
         if revlen == 0:
             continue
 
         if prevend is not None:
             gapsize = revstart - prevend
             # only consider holes that are large enough
             if gapsize > mingapsize:
                 gaps.append((gapsize, i))
 
         prevend = revstart + revlen
     # sort the gaps to pop them from largest to small
     gaps.sort()
 
     # Collect the indices of the largest holes until the density is acceptable
     selected = []
     while gaps and density < targetdensity:
         gapsize, gapidx = gaps.pop()
 
         selected.append(gapidx)
 
         # the gap sizes are stored as negatives to be sorted decreasingly
         # by the heap
         readdata -= gapsize
         if readdata > 0:
             density = chainpayload / float(readdata)
         else:
             density = 1.0
     selected.sort()
 
     # Cut the revs at collected indices
     previdx = 0
     for idx in selected:
 
         chunk = _trimchunk(revlog, revs, previdx, idx)
         if chunk:
             yield chunk
 
         previdx = idx
 
     chunk = _trimchunk(revlog, revs, previdx)
     if chunk:
         yield chunk
 
 
 def _trimchunk(revlog, revs, startidx, endidx=None):
     """returns revs[startidx:endidx] without empty trailing revs
 
     Doctest Setup
     >>> revlog = _testrevlog([
     ...  5,  #0
     ...  10, #1
     ...  12, #2
     ...  12, #3 (empty)
     ...  17, #4
     ...  21, #5
     ...  21, #6 (empty)
     ... ])
 
     Contiguous cases:
     >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 0)
     [0, 1, 2, 3, 4, 5]
     >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 0, 5)
     [0, 1, 2, 3, 4]
     >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 0, 4)
     [0, 1, 2]
     >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 2, 4)
     [2]
     >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 3)
     [3, 4, 5]
     >>> _trimchunk(revlog, [0, 1, 2, 3, 4, 5, 6], 3, 5)
     [3, 4]
 
     Discontiguous cases:
     >>> _trimchunk(revlog, [1, 3, 5, 6], 0)
     [1, 3, 5]
     >>> _trimchunk(revlog, [1, 3, 5, 6], 0, 2)
     [1]
     >>> _trimchunk(revlog, [1, 3, 5, 6], 1, 3)
     [3, 5]
     >>> _trimchunk(revlog, [1, 3, 5, 6], 1)
     [3, 5]
     """
     length = revlog.length
 
     if endidx is None:
         endidx = len(revs)
 
     # If we have a non-emtpy delta candidate, there are nothing to trim
     if revs[endidx - 1] < len(revlog):
         # Trim empty revs at the end, except the very first revision of a chain
         while (
             endidx > 1 and endidx > startidx and length(revs[endidx - 1]) == 0
         ):
             endidx -= 1
 
     return revs[startidx:endidx]
 
 
 def segmentspan(revlog, revs):
     """Get the byte span of a segment of revisions
 
     revs is a sorted array of revision numbers
 
     >>> revlog = _testrevlog([
     ...  5,  #0
     ...  10, #1
     ...  12, #2
     ...  12, #3 (empty)
     ...  17, #4
     ... ])
 
     >>> segmentspan(revlog, [0, 1, 2, 3, 4])
     17
     >>> segmentspan(revlog, [0, 4])
     17
     >>> segmentspan(revlog, [3, 4])
     5
     >>> segmentspan(revlog, [1, 2, 3,])
     7
     >>> segmentspan(revlog, [1, 3])
     7
     """
     if not revs:
         return 0
     end = revlog.end(revs[-1])
     return end - revlog.start(revs[0])
 
 
 def _textfromdelta(fh, revlog, baserev, delta, p1, p2, flags, expectednode):
     """build full text from a (base, delta) pair and other metadata"""
     # special case deltas which replace entire base; no need to decode
     # base revision. this neatly avoids censored bases, which throw when
     # they're decoded.
     hlen = struct.calcsize(b">lll")
     if delta[:hlen] == mdiff.replacediffheader(
         revlog.rawsize(baserev), len(delta) - hlen
     ):
         fulltext = delta[hlen:]
     else:
         # deltabase is rawtext before changed by flag processors, which is
         # equivalent to non-raw text
         basetext = revlog.revision(baserev, _df=fh)
         fulltext = mdiff.patch(basetext, delta)
 
     try:
         validatehash = flagutil.processflagsraw(revlog, fulltext, flags)
         if validatehash:
             revlog.checkhash(fulltext, expectednode, p1=p1, p2=p2)
         if flags & REVIDX_ISCENSORED:
             raise error.StorageError(
                 _(b'node %s is not censored') % expectednode
             )
     except error.CensoredNodeError:
         # must pass the censored index flag to add censored revisions
         if not flags & REVIDX_ISCENSORED:
             raise
     return fulltext
 
 
 @attr.s(slots=True, frozen=True)
 class _deltainfo:
     distance = attr.ib()
     deltalen = attr.ib()
     data = attr.ib()
     base = attr.ib()
     chainbase = attr.ib()
     chainlen = attr.ib()
     compresseddeltalen = attr.ib()
     snapshotdepth = attr.ib()
 
 
 def drop_u_compression(delta):
     """turn into a "u" (no-compression) into no-compression without header
 
     This is useful for revlog format that has better compression method.
     """
     assert delta.data[0] == b'u', delta.data[0]
     return _deltainfo(
         delta.distance,
         delta.deltalen - 1,
         (b'', delta.data[1]),
         delta.base,
         delta.chainbase,
         delta.chainlen,
         delta.compresseddeltalen,
         delta.snapshotdepth,
     )
 
 
 def isgooddeltainfo(revlog, deltainfo, revinfo):
     """Returns True if the given delta is good. Good means that it is within
     the disk span, disk size, and chain length bounds that we know to be
     performant."""
     if deltainfo is None:
         return False
 
     # - 'deltainfo.distance' is the distance from the base revision --
     #   bounding it limits the amount of I/O we need to do.
     # - 'deltainfo.compresseddeltalen' is the sum of the total size of
     #   deltas we need to apply -- bounding it limits the amount of CPU
     #   we consume.
 
     textlen = revinfo.textlen
     defaultmax = textlen * 4
     maxdist = revlog._maxdeltachainspan
     if not maxdist:
         maxdist = deltainfo.distance  # ensure the conditional pass
     maxdist = max(maxdist, defaultmax)
 
     # Bad delta from read span:
     #
     #   If the span of data read is larger than the maximum allowed.
     #
     #   In the sparse-revlog case, we rely on the associated "sparse reading"
     #   to avoid issue related to the span of data. In theory, it would be
     #   possible to build pathological revlog where delta pattern would lead
     #   to too many reads. However, they do not happen in practice at all. So
     #   we skip the span check entirely.
     if not revlog._sparserevlog and maxdist < deltainfo.distance:
         return False
 
     # Bad delta from new delta size:
     #
     #   If the delta size is larger than the target text, storing the
     #   delta will be inefficient.
     if textlen < deltainfo.deltalen:
         return False
 
     # Bad delta from cumulated payload size:
     #
     #   If the sum of delta get larger than K * target text length.
     if textlen * LIMIT_DELTA2TEXT < deltainfo.compresseddeltalen:
         return False
 
     # Bad delta from chain length:
     #
     #   If the number of delta in the chain gets too high.
     if revlog._maxchainlen and revlog._maxchainlen < deltainfo.chainlen:
         return False
 
     # bad delta from intermediate snapshot size limit
     #
     #   If an intermediate snapshot size is higher than the limit.  The
     #   limit exist to prevent endless chain of intermediate delta to be
     #   created.
     if (
         deltainfo.snapshotdepth is not None
         and (textlen >> deltainfo.snapshotdepth) < deltainfo.deltalen
     ):
         return False
 
     # bad delta if new intermediate snapshot is larger than the previous
     # snapshot
     if (
         deltainfo.snapshotdepth
         and revlog.length(deltainfo.base) < deltainfo.deltalen
     ):
         return False
 
     return True
 
 
 # If a revision's full text is that much bigger than a base candidate full
 # text's, it is very unlikely that it will produce a valid delta. We no longer
 # consider these candidates.
 LIMIT_BASE2TEXT = 500
 
 
 def _candidategroups(
     revlog,
     textlen,
     p1,
     p2,
     cachedelta,
     excluded_bases=None,
     target_rev=None,
 ):
     """Provides group of revision to be tested as delta base
 
     This top level function focus on emitting groups with unique and worthwhile
     content. See _raw_candidate_groups for details about the group order.
     """
     # should we try to build a delta?
     if not (len(revlog) and revlog._storedeltachains):
         yield None
         return
 
     deltalength = revlog.length
     deltaparent = revlog.deltaparent
     sparse = revlog._sparserevlog
     good = None
 
     deltas_limit = textlen * LIMIT_DELTA2TEXT
+    group_chunk_size = revlog._candidate_group_chunk_size
 
     tested = {nullrev}
     candidates = _refinedgroups(
         revlog,
         p1,
         p2,
         cachedelta,
     )
     while True:
         temptative = candidates.send(good)
         if temptative is None:
             break
         group = []
         for rev in temptative:
             # skip over empty delta (no need to include them in a chain)
             while revlog._generaldelta and not (
                 rev == nullrev or rev in tested or deltalength(rev)
             ):
                 tested.add(rev)
                 rev = deltaparent(rev)
             # no need to try a delta against nullrev, this will be done as a
             # last resort.
             if rev == nullrev:
                 continue
             # filter out revision we tested already
             if rev in tested:
                 continue
             # an higher authority deamed the base unworthy (e.g. censored)
             if excluded_bases is not None and rev in excluded_bases:
                 tested.add(rev)
                 continue
             # We are in some recomputation cases and that rev is too high in
             # the revlog
             if target_rev is not None and rev >= target_rev:
                 tested.add(rev)
                 continue
             # filter out delta base that will never produce good delta
             if deltas_limit < revlog.length(rev):
                 tested.add(rev)
                 continue
             if sparse and revlog.rawsize(rev) < (textlen // LIMIT_BASE2TEXT):
                 tested.add(rev)
                 continue
             # no delta for rawtext-changing revs (see "candelta" for why)
             if revlog.flags(rev) & REVIDX_RAWTEXT_CHANGING_FLAGS:
                 tested.add(rev)
                 continue
 
             # If we reach here, we are about to build and test a delta.
             # The delta building process will compute the chaininfo in all
             # case, since that computation is cached, it is fine to access it
             # here too.
             chainlen, chainsize = revlog._chaininfo(rev)
             # if chain will be too long, skip base
             if revlog._maxchainlen and chainlen >= revlog._maxchainlen:
                 tested.add(rev)
                 continue
             # if chain already have too much data, skip base
             if deltas_limit < chainsize:
                 tested.add(rev)
                 continue
             if sparse and revlog.upperboundcomp is not None:
                 maxcomp = revlog.upperboundcomp
                 basenotsnap = (p1, p2, nullrev)
                 if rev not in basenotsnap and revlog.issnapshot(rev):
                     snapshotdepth = revlog.snapshotdepth(rev)
                     # If text is significantly larger than the base, we can
                     # expect the resulting delta to be proportional to the size
                     # difference
                     revsize = revlog.rawsize(rev)
                     rawsizedistance = max(textlen - revsize, 0)
                     # use an estimate of the compression upper bound.
                     lowestrealisticdeltalen = rawsizedistance // maxcomp
 
                     # check the absolute constraint on the delta size
                     snapshotlimit = textlen >> snapshotdepth
                     if snapshotlimit < lowestrealisticdeltalen:
                         # delta lower bound is larger than accepted upper bound
                         tested.add(rev)
                         continue
 
                     # check the relative constraint on the delta size
                     revlength = revlog.length(rev)
                     if revlength < lowestrealisticdeltalen:
                         # delta probable lower bound is larger than target base
                         tested.add(rev)
                         continue
 
             group.append(rev)
         if group:
-            # XXX: in the sparse revlog case, group can become large,
-            #      impacting performances. Some bounding or slicing mecanism
-            #      would help to reduce this impact.
+            # When the size of the candidate group is big, it can result in a
+            # quite significant performance impact. To reduce this, we can send
+            # them in smaller batches until the new batch does not provide any
+            # improvements.
+            #
+            # This might reduce the overall efficiency of the compression in
+            # some corner cases, but that should also prevent very pathological
+            # cases from being an issue. (eg. 20 000 candidates).
+            #
+            # XXX note that the ordering of the group becomes important as it
+            # now impacts the final result. The current order is unprocessed
+            # and can be improved.
+            if group_chunk_size == 0:
             tested.update(group)
             good = yield tuple(group)
+            else:
+                prev_good = good
+                for start in range(0, len(group), group_chunk_size):
+                    sub_group = group[start : start + group_chunk_size]
+                    tested.update(sub_group)
+                    good = yield tuple(sub_group)
+                    if prev_good == good:
+                        break
+
     yield None
 
 
 def _findsnapshots(revlog, cache, start_rev):
     """find snapshot from start_rev to tip"""
     if util.safehasattr(revlog.index, b'findsnapshots'):
         revlog.index.findsnapshots(cache, start_rev)
     else:
         deltaparent = revlog.deltaparent
         issnapshot = revlog.issnapshot
         for rev in revlog.revs(start_rev):
             if issnapshot(rev):
                 cache[deltaparent(rev)].append(rev)
 
 
 def _refinedgroups(revlog, p1, p2, cachedelta):
     good = None
     # First we try to reuse a the delta contained in the bundle.
     # (or from the source revlog)
     #
     # This logic only applies to general delta repositories and can be disabled
     # through configuration. Disabling reuse source delta is useful when
     # we want to make sure we recomputed "optimal" deltas.
     debug_info = None
     if cachedelta and revlog._generaldelta and revlog._lazydeltabase:
         # Assume what we received from the server is a good choice
         # build delta will reuse the cache
         if debug_info is not None:
             debug_info['cached-delta.tested'] += 1
         good = yield (cachedelta[0],)
         if good is not None:
             if debug_info is not None:
                 debug_info['cached-delta.accepted'] += 1
             yield None
             return
     # XXX cache me higher
     snapshots = collections.defaultdict(list)
     groups = _rawgroups(
         revlog,
         p1,
         p2,
         cachedelta,
         snapshots,
     )
     for candidates in groups:
         good = yield candidates
         if good is not None:
             break
 
     # If sparse revlog is enabled, we can try to refine the available deltas
     if not revlog._sparserevlog:
         yield None
         return
 
     # if we have a refinable value, try to refine it
     if good is not None and good not in (p1, p2) and revlog.issnapshot(good):
         # refine snapshot down
         previous = None
         while previous != good:
             previous = good
             base = revlog.deltaparent(good)
             if base == nullrev:
                 break
             good = yield (base,)
         # refine snapshot up
         if not snapshots:
             _findsnapshots(revlog, snapshots, good + 1)
         previous = None
         while good != previous:
             previous = good
             children = tuple(sorted(c for c in snapshots[good]))
             good = yield children
 
     if debug_info is not None:
         if good is None:
             debug_info['no-solution'] += 1
 
     yield None
 
 
 def _rawgroups(revlog, p1, p2, cachedelta, snapshots=None):
     """Provides group of revision to be tested as delta base
 
     This lower level function focus on emitting delta theorically interresting
     without looking it any practical details.
 
     The group order aims at providing fast or small candidates first.
     """
     gdelta = revlog._generaldelta
     # gate sparse behind general-delta because of issue6056
     sparse = gdelta and revlog._sparserevlog
     curr = len(revlog)
     prev = curr - 1
     deltachain = lambda rev: revlog._deltachain(rev)[0]
 
     if gdelta:
         # exclude already lazy tested base if any
         parents = [p for p in (p1, p2) if p != nullrev]
 
         if not revlog._deltabothparents and len(parents) == 2:
             parents.sort()
             # To minimize the chance of having to build a fulltext,
             # pick first whichever parent is closest to us (max rev)
             yield (parents[1],)
             # then the other one (min rev) if the first did not fit
             yield (parents[0],)
         elif len(parents) > 0:
             # Test all parents (1 or 2), and keep the best candidate
             yield parents
 
     if sparse and parents:
         if snapshots is None:
             # map: base-rev: [snapshot-revs]
             snapshots = collections.defaultdict(list)
         # See if we can use an existing snapshot in the parent chains to use as
         # a base for a new intermediate-snapshot
         #
         # search for snapshot in parents delta chain
         # map: snapshot-level: snapshot-rev
         parents_snaps = collections.defaultdict(set)
         candidate_chains = [deltachain(p) for p in parents]
         for chain in candidate_chains:
             for idx, s in enumerate(chain):
                 if not revlog.issnapshot(s):
                     break
                 parents_snaps[idx].add(s)
         snapfloor = min(parents_snaps[0]) + 1
         _findsnapshots(revlog, snapshots, snapfloor)
         # search for the highest "unrelated" revision
         #
         # Adding snapshots used by "unrelated" revision increase the odd we
         # reuse an independant, yet better snapshot chain.
         #
         # XXX instead of building a set of revisions, we could lazily enumerate
         # over the chains. That would be more efficient, however we stick to
         # simple code for now.
         all_revs = set()
         for chain in candidate_chains:
             all_revs.update(chain)
         other = None
         for r in revlog.revs(prev, snapfloor):
             if r not in all_revs:
                 other = r
                 break
         if other is not None:
             # To avoid unfair competition, we won't use unrelated intermediate
             # snapshot that are deeper than the ones from the parent delta
             # chain.
             max_depth = max(parents_snaps.keys())
             chain = deltachain(other)
             for depth, s in enumerate(chain):
                 if s < snapfloor:
                     continue
                 if max_depth < depth:
                     break
                 if not revlog.issnapshot(s):
                     break
                 parents_snaps[depth].add(s)
         # Test them as possible intermediate snapshot base
         # We test them from highest to lowest level. High level one are more
         # likely to result in small delta
         floor = None
         for idx, snaps in sorted(parents_snaps.items(), reverse=True):
             siblings = set()
             for s in snaps:
                 siblings.update(snapshots[s])
             # Before considering making a new intermediate snapshot, we check
             # if an existing snapshot, children of base we consider, would be
             # suitable.
             #
             # It give a change to reuse a delta chain "unrelated" to the
             # current revision instead of starting our own. Without such
             # re-use, topological branches would keep reopening new chains.
             # Creating more and more snapshot as the repository grow.
 
             if floor is not None:
                 # We only do this for siblings created after the one in our
                 # parent's delta chain. Those created before has less chances
                 # to be valid base since our ancestors had to create a new
                 # snapshot.
                 siblings = [r for r in siblings if floor < r]
             yield tuple(sorted(siblings))
             # then test the base from our parent's delta chain.
             yield tuple(sorted(snaps))
             floor = min(snaps)
         # No suitable base found in the parent chain, search if any full
         # snapshots emitted since parent's base would be a suitable base for an
         # intermediate snapshot.
         #
         # It give a chance to reuse a delta chain unrelated to the current
         # revisions instead of starting our own. Without such re-use,
         # topological branches would keep reopening new full chains. Creating
         # more and more snapshot as the repository grow.
         yield tuple(snapshots[nullrev])
 
     if not sparse:
         # other approach failed try against prev to hopefully save us a
         # fulltext.
         yield (prev,)
 
 
 class deltacomputer:
     def __init__(
         self,
         revlog,
         write_debug=None,
         debug_search=False,
         debug_info=None,
     ):
         self.revlog = revlog
         self._write_debug = write_debug
         self._debug_search = debug_search
         self._debug_info = debug_info
 
     def buildtext(self, revinfo, fh):
         """Builds a fulltext version of a revision
 
         revinfo: revisioninfo instance that contains all needed info
         fh:      file handle to either the .i or the .d revlog file,
                  depending on whether it is inlined or not
         """
         btext = revinfo.btext
         if btext[0] is not None:
             return btext[0]
 
         revlog = self.revlog
         cachedelta = revinfo.cachedelta
         baserev = cachedelta[0]
         delta = cachedelta[1]
 
         fulltext = btext[0] = _textfromdelta(
             fh,
             revlog,
             baserev,
             delta,
             revinfo.p1,
             revinfo.p2,
             revinfo.flags,
             revinfo.node,
         )
         return fulltext
 
     def _builddeltadiff(self, base, revinfo, fh):
         revlog = self.revlog
         t = self.buildtext(revinfo, fh)
         if revlog.iscensored(base):
             # deltas based on a censored revision must replace the
             # full content in one patch, so delta works everywhere
             header = mdiff.replacediffheader(revlog.rawsize(base), len(t))
             delta = header + t
         else:
             ptext = revlog.rawdata(base, _df=fh)
             delta = mdiff.textdiff(ptext, t)
 
         return delta
 
     def _builddeltainfo(self, revinfo, base, fh):
         # can we use the cached delta?
         revlog = self.revlog
         debug_search = self._write_debug is not None and self._debug_search
         chainbase = revlog.chainbase(base)
         if revlog._generaldelta:
             deltabase = base
         else:
             deltabase = chainbase
         snapshotdepth = None
         if revlog._sparserevlog and deltabase == nullrev:
             snapshotdepth = 0
         elif revlog._sparserevlog and revlog.issnapshot(deltabase):
             # A delta chain should always be one full snapshot,
             # zero or more semi-snapshots, and zero or more deltas
             p1, p2 = revlog.rev(revinfo.p1), revlog.rev(revinfo.p2)
             if deltabase not in (p1, p2) and revlog.issnapshot(deltabase):
                 snapshotdepth = len(revlog._deltachain(deltabase)[0])
         delta = None
         if revinfo.cachedelta:
             cachebase, cachediff = revinfo.cachedelta
             # check if the diff still apply
             currentbase = cachebase
             while (
                 currentbase != nullrev
                 and currentbase != base
                 and self.revlog.length(currentbase) == 0
             ):
                 currentbase = self.revlog.deltaparent(currentbase)
             if self.revlog._lazydelta and currentbase == base:
                 delta = revinfo.cachedelta[1]
         if delta is None:
             delta = self._builddeltadiff(base, revinfo, fh)
         if debug_search:
             msg = b"DBG-DELTAS-SEARCH:     uncompressed-delta-size=%d\n"
             msg %= len(delta)
             self._write_debug(msg)
         # snapshotdept need to be neither None nor 0 level snapshot
         if revlog.upperboundcomp is not None and snapshotdepth:
             lowestrealisticdeltalen = len(delta) // revlog.upperboundcomp
             snapshotlimit = revinfo.textlen >> snapshotdepth
             if debug_search:
                 msg = b"DBG-DELTAS-SEARCH:     projected-lower-size=%d\n"
                 msg %= lowestrealisticdeltalen
                 self._write_debug(msg)
             if snapshotlimit < lowestrealisticdeltalen:
                 if debug_search:
                     msg = b"DBG-DELTAS-SEARCH:     DISCARDED (snapshot limit)\n"
                     self._write_debug(msg)
                 return None
             if revlog.length(base) < lowestrealisticdeltalen:
                 if debug_search:
                     msg = b"DBG-DELTAS-SEARCH:     DISCARDED (prev size)\n"
                     self._write_debug(msg)
                 return None
         header, data = revlog.compress(delta)
         deltalen = len(header) + len(data)
         offset = revlog.end(len(revlog) - 1)
         dist = deltalen + offset - revlog.start(chainbase)
         chainlen, compresseddeltalen = revlog._chaininfo(base)
         chainlen += 1
         compresseddeltalen += deltalen
 
         return _deltainfo(
             dist,
             deltalen,
             (header, data),
             deltabase,
             chainbase,
             chainlen,
             compresseddeltalen,
             snapshotdepth,
         )
 
     def _fullsnapshotinfo(self, fh, revinfo, curr):
         rawtext = self.buildtext(revinfo, fh)
         data = self.revlog.compress(rawtext)
         compresseddeltalen = deltalen = dist = len(data[1]) + len(data[0])
         deltabase = chainbase = curr
         snapshotdepth = 0
         chainlen = 1
 
         return _deltainfo(
             dist,
             deltalen,
             data,
             deltabase,
             chainbase,
             chainlen,
             compresseddeltalen,
             snapshotdepth,
         )
 
     def finddeltainfo(self, revinfo, fh, excluded_bases=None, target_rev=None):
         """Find an acceptable delta against a candidate revision
 
         revinfo: information about the revision (instance of _revisioninfo)
         fh:      file handle to either the .i or the .d revlog file,
                  depending on whether it is inlined or not
 
         Returns the first acceptable candidate revision, as ordered by
         _candidategroups
 
         If no suitable deltabase is found, we return delta info for a full
         snapshot.
 
         `excluded_bases` is an optional set of revision that cannot be used as
         a delta base. Use this to recompute delta suitable in censor or strip
         context.
         """
         if target_rev is None:
             target_rev = len(self.revlog)
 
         if not revinfo.textlen:
             return self._fullsnapshotinfo(fh, revinfo, target_rev)
 
         if excluded_bases is None:
             excluded_bases = set()
 
         # no delta for flag processor revision (see "candelta" for why)
         # not calling candelta since only one revision needs test, also to
         # avoid overhead fetching flags again.
         if revinfo.flags & REVIDX_RAWTEXT_CHANGING_FLAGS:
             return self._fullsnapshotinfo(fh, revinfo, target_rev)
 
         gather_debug = (
             self._write_debug is not None or self._debug_info is not None
         )
         debug_search = self._write_debug is not None and self._debug_search
 
         if gather_debug:
             start = util.timer()
 
         # count the number of different delta we tried (for debug purpose)
         dbg_try_count = 0
         # count the number of "search round" we did. (for debug purpose)
         dbg_try_rounds = 0
         dbg_type = b'unknown'
 
         cachedelta = revinfo.cachedelta
         p1 = revinfo.p1
         p2 = revinfo.p2
         revlog = self.revlog
 
         deltainfo = None
         p1r, p2r = revlog.rev(p1), revlog.rev(p2)
 
         if gather_debug:
             if p1r != nullrev:
                 p1_chain_len = revlog._chaininfo(p1r)[0]
             else:
                 p1_chain_len = -1
             if p2r != nullrev:
                 p2_chain_len = revlog._chaininfo(p2r)[0]
             else:
                 p2_chain_len = -1
         if debug_search:
             msg = b"DBG-DELTAS-SEARCH: SEARCH rev=%d\n"
             msg %= target_rev
             self._write_debug(msg)
 
         groups = _candidategroups(
             self.revlog,
             revinfo.textlen,
             p1r,
             p2r,
             cachedelta,
             excluded_bases,
             target_rev,
         )
         candidaterevs = next(groups)
         while candidaterevs is not None:
             dbg_try_rounds += 1
             if debug_search:
                 prev = None
                 if deltainfo is not None:
                     prev = deltainfo.base
 
                 if (
                     cachedelta is not None
                     and len(candidaterevs) == 1
                     and cachedelta[0] in candidaterevs
                 ):
                     round_type = b"cached-delta"
                 elif p1 in candidaterevs or p2 in candidaterevs:
                     round_type = b"parents"
                 elif prev is not None and all(c < prev for c in candidaterevs):
                     round_type = b"refine-down"
                 elif prev is not None and all(c > prev for c in candidaterevs):
                     round_type = b"refine-up"
                 else:
                     round_type = b"search-down"
                 msg = b"DBG-DELTAS-SEARCH: ROUND #%d - %d candidates - %s\n"
                 msg %= (dbg_try_rounds, len(candidaterevs), round_type)
                 self._write_debug(msg)
             nominateddeltas = []
             if deltainfo is not None:
                 if debug_search:
                     msg = (
                         b"DBG-DELTAS-SEARCH:   CONTENDER: rev=%d - length=%d\n"
                     )
                     msg %= (deltainfo.base, deltainfo.deltalen)
                     self._write_debug(msg)
                 # if we already found a good delta,
                 # challenge it against refined candidates
                 nominateddeltas.append(deltainfo)
             for candidaterev in candidaterevs:
                 if debug_search:
                     msg = b"DBG-DELTAS-SEARCH:   CANDIDATE: rev=%d\n"
                     msg %= candidaterev
                     self._write_debug(msg)
                     candidate_type = None
                     if candidaterev == p1:
                         candidate_type = b"p1"
                     elif candidaterev == p2:
                         candidate_type = b"p2"
                     elif self.revlog.issnapshot(candidaterev):
                         candidate_type = b"snapshot-%d"
                         candidate_type %= self.revlog.snapshotdepth(
                             candidaterev
                         )
 
                     if candidate_type is not None:
                         msg = b"DBG-DELTAS-SEARCH:     type=%s\n"
                         msg %= candidate_type
                         self._write_debug(msg)
                     msg = b"DBG-DELTAS-SEARCH:     size=%d\n"
                     msg %= self.revlog.length(candidaterev)
                     self._write_debug(msg)
                     msg = b"DBG-DELTAS-SEARCH:     base=%d\n"
                     msg %= self.revlog.deltaparent(candidaterev)
                     self._write_debug(msg)
 
                 dbg_try_count += 1
 
                 if debug_search:
                     delta_start = util.timer()
                 candidatedelta = self._builddeltainfo(revinfo, candidaterev, fh)
                 if debug_search:
                     delta_end = util.timer()
                     msg = b"DBG-DELTAS-SEARCH:     delta-search-time=%f\n"
                     msg %= delta_end - delta_start
                     self._write_debug(msg)
                 if candidatedelta is not None:
                     if isgooddeltainfo(self.revlog, candidatedelta, revinfo):
                         if debug_search:
                             msg = b"DBG-DELTAS-SEARCH:     DELTA: length=%d (GOOD)\n"
                             msg %= candidatedelta.deltalen
                             self._write_debug(msg)
                         nominateddeltas.append(candidatedelta)
                     elif debug_search:
                         msg = b"DBG-DELTAS-SEARCH:     DELTA: length=%d (BAD)\n"
                         msg %= candidatedelta.deltalen
                         self._write_debug(msg)
                 elif debug_search:
                     msg = b"DBG-DELTAS-SEARCH:     NO-DELTA\n"
                     self._write_debug(msg)
             if nominateddeltas:
                 deltainfo = min(nominateddeltas, key=lambda x: x.deltalen)
             if deltainfo is not None:
                 candidaterevs = groups.send(deltainfo.base)
             else:
                 candidaterevs = next(groups)
 
         if deltainfo is None:
             dbg_type = b"full"
             deltainfo = self._fullsnapshotinfo(fh, revinfo, target_rev)
         elif deltainfo.snapshotdepth:  # pytype: disable=attribute-error
             dbg_type = b"snapshot"
         else:
             dbg_type = b"delta"
 
         if gather_debug:
             end = util.timer()
             used_cached = (
                 cachedelta is not None
                 and dbg_try_rounds == 1
                 and dbg_try_count == 1
                 and deltainfo.base == cachedelta[0]
             )
             dbg = {
                 'duration': end - start,
                 'revision': target_rev,
                 'delta-base': deltainfo.base,  # pytype: disable=attribute-error
                 'search_round_count': dbg_try_rounds,
                 'using-cached-base': used_cached,
                 'delta_try_count': dbg_try_count,
                 'type': dbg_type,
                 'p1-chain-len': p1_chain_len,
                 'p2-chain-len': p2_chain_len,
             }
             if (
                 deltainfo.snapshotdepth  # pytype: disable=attribute-error
                 is not None
             ):
                 dbg[
                     'snapshot-depth'
                 ] = deltainfo.snapshotdepth  # pytype: disable=attribute-error
             else:
                 dbg['snapshot-depth'] = 0
             target_revlog = b"UNKNOWN"
             target_type = self.revlog.target[0]
             target_key = self.revlog.target[1]
             if target_type == KIND_CHANGELOG:
                 target_revlog = b'CHANGELOG:'
             elif target_type == KIND_MANIFESTLOG:
                 target_revlog = b'MANIFESTLOG:'
                 if target_key:
                     target_revlog += b'%s:' % target_key
             elif target_type == KIND_FILELOG:
                 target_revlog = b'FILELOG:'
                 if target_key:
                     target_revlog += b'%s:' % target_key
             dbg['target-revlog'] = target_revlog
 
             if self._debug_info is not None:
                 self._debug_info.append(dbg)
 
             if self._write_debug is not None:
                 msg = (
                     b"DBG-DELTAS:"
                     b" %-12s"
                     b" rev=%d:"
                     b" delta-base=%d"
                     b" is-cached=%d"
                     b" - search-rounds=%d"
                     b" try-count=%d"
                     b" - delta-type=%-6s"
                     b" snap-depth=%d"
                     b" - p1-chain-length=%d"
                     b" p2-chain-length=%d"
                     b" - duration=%f"
                     b"\n"
                 )
                 msg %= (
                     dbg["target-revlog"],
                     dbg["revision"],
                     dbg["delta-base"],
                     dbg["using-cached-base"],
                     dbg["search_round_count"],
                     dbg["delta_try_count"],
                     dbg["type"],
                     dbg["snapshot-depth"],
                     dbg["p1-chain-len"],
                     dbg["p2-chain-len"],
                     dbg["duration"],
                 )
                 self._write_debug(msg)
         return deltainfo
 
 
 def delta_compression(default_compression_header, deltainfo):
     """return (COMPRESSION_MODE, deltainfo)
 
     used by revlog v2+ format to dispatch between PLAIN and DEFAULT
     compression.
     """
     h, d = deltainfo.data
     compression_mode = COMP_MODE_INLINE
     if not h and not d:
         # not data to store at all... declare them uncompressed
         compression_mode = COMP_MODE_PLAIN
     elif not h:
         t = d[0:1]
         if t == b'\0':
             compression_mode = COMP_MODE_PLAIN
         elif t == default_compression_header:
             compression_mode = COMP_MODE_DEFAULT
     elif h == b'u':
         # we have a more efficient way to declare uncompressed
         h = b''
         compression_mode = COMP_MODE_PLAIN
         deltainfo = drop_u_compression(deltainfo)
     return compression_mode, deltainfo