pull: add --remote-hidden option and pass it through peer creation

This option will allow to pull changesets that are hidden on the remote. This
is useful when looking into a changeset’s evolution history, resolving
evolution instability or mirroring a repository.

The option is best effort and will only affect the pull when it can. The option
will be ignored when it cannot be honored.

Support for each type of peer is yet to be implemented. They currently all warn
about lack of support. The warning code will get removed as peers gain
support for this option.

The option is still experimental, so we will have freedom to update the UI or
implementation before it graduates out of experimental.

Based on a changeset by Pierre-Yves David, which added the option.

hgext/narrow/narrowrepo.py

@@ -1,28 +1,28 b''
 # narrowrepo.py - repository which supports narrow revlogs, lazy loading
 #
 # Copyright 2017 Google, Inc.
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 
 from mercurial import wireprototypes
 
 from . import narrowdirstate
 
 
 def wraprepo(repo):
     """Enables narrow clone functionality on a single local repository."""
 
     class narrowrepository(repo.__class__):
         def _makedirstate(self):
             dirstate = super(narrowrepository, self)._makedirstate()
             return narrowdirstate.wrapdirstate(self, dirstate)
 
-        def peer(self, path=None):
-            peer = super(narrowrepository, self).peer(path=path)
+        def peer(self, *args, **kwds):
+            peer = super(narrowrepository, self).peer(*args, **kwds)
             peer._caps.add(wireprototypes.NARROWCAP)
             peer._caps.add(wireprototypes.ELLIPSESCAP)
             return peer
 
     repo.__class__ = narrowrepository

mercurial/bundlerepo.py

@@ -1,742 +1,742 b''
 # bundlerepo.py - repository class for viewing uncompressed bundles
 #
 # Copyright 2006, 2007 Benoit Boissinot <[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.
 
 """Repository class for viewing uncompressed bundles.
 
 This provides a read-only repository interface to bundles as if they
 were part of the actual repository.
 """
 
 
 import os
 import shutil
 
 from .i18n import _
 from .node import (
     hex,
     nullrev,
 )
 
 from . import (
     bundle2,
     changegroup,
     changelog,
     cmdutil,
     discovery,
     encoding,
     error,
     exchange,
     filelog,
     localrepo,
     manifest,
     mdiff,
     pathutil,
     phases,
     pycompat,
     revlog,
     revlogutils,
     util,
     vfs as vfsmod,
 )
 from .utils import (
     urlutil,
 )
 
 from .revlogutils import (
     constants as revlog_constants,
 )
 
 
 class bundlerevlog(revlog.revlog):
     def __init__(self, opener, target, radix, cgunpacker, linkmapper):
         # How it works:
         # To retrieve a revision, we need to know the offset of the revision in
         # the bundle (an unbundle object). We store this offset in the index
         # (start). The base of the delta is stored in the base field.
         #
         # To differentiate a rev in the bundle from a rev in the revlog, we
         # check revision against repotiprev.
         opener = vfsmod.readonlyvfs(opener)
         revlog.revlog.__init__(self, opener, target=target, radix=radix)
         self.bundle = cgunpacker
         n = len(self)
         self.repotiprev = n - 1
         self.bundlerevs = set()  # used by 'bundle()' revset expression
         for deltadata in cgunpacker.deltaiter():
             node, p1, p2, cs, deltabase, delta, flags, sidedata = deltadata
 
             size = len(delta)
             start = cgunpacker.tell() - size
 
             if self.index.has_node(node):
                 # this can happen if two branches make the same change
                 self.bundlerevs.add(self.index.rev(node))
                 continue
             if cs == node:
                 linkrev = nullrev
             else:
                 linkrev = linkmapper(cs)
 
             for p in (p1, p2):
                 if not self.index.has_node(p):
                     raise error.LookupError(
                         p, self.display_id, _(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)
             # start, size, full unc. size, base (unused), link, p1, p2, node, sidedata_offset (unused), sidedata_size (unused)
             e = revlogutils.entry(
                 flags=flags,
                 data_offset=start,
                 data_compressed_length=size,
                 data_delta_base=baserev,
                 link_rev=linkrev,
                 parent_rev_1=self.rev(p1),
                 parent_rev_2=self.rev(p2),
                 node_id=node,
             )
             self.index.append(e)
             self.bundlerevs.add(n)
             n += 1
 
     def _chunk(self, rev, df=None):
         # Warning: in case of bundle, the diff is against what we stored as
         # delta base, not against rev - 1
         # XXX: could use some caching
         if rev <= self.repotiprev:
             return revlog.revlog._chunk(self, rev)
         self.bundle.seek(self.start(rev))
         return self.bundle.read(self.length(rev))
 
     def revdiff(self, rev1, rev2):
         """return or calculate a delta between two revisions"""
         if rev1 > self.repotiprev and rev2 > self.repotiprev:
             # hot path for bundle
             revb = self.index[rev2][3]
             if revb == rev1:
                 return self._chunk(rev2)
         elif rev1 <= self.repotiprev and rev2 <= self.repotiprev:
             return revlog.revlog.revdiff(self, rev1, rev2)
 
         return mdiff.textdiff(self.rawdata(rev1), self.rawdata(rev2))
 
     def _rawtext(self, node, rev, _df=None):
         if rev is None:
             rev = self.rev(node)
         validated = False
         rawtext = None
         chain = []
         iterrev = rev
         # reconstruct the revision if it is from a changegroup
         while iterrev > self.repotiprev:
             if self._revisioncache and self._revisioncache[1] == iterrev:
                 rawtext = self._revisioncache[2]
                 break
             chain.append(iterrev)
             iterrev = self.index[iterrev][3]
         if iterrev == nullrev:
             rawtext = b''
         elif rawtext is None:
             r = super(bundlerevlog, self)._rawtext(
                 self.node(iterrev), iterrev, _df=_df
             )
             __, rawtext, validated = r
         if chain:
             validated = False
         while chain:
             delta = self._chunk(chain.pop())
             rawtext = mdiff.patches(rawtext, [delta])
         return rev, rawtext, validated
 
     def addrevision(self, *args, **kwargs):
         raise NotImplementedError
 
     def addgroup(self, *args, **kwargs):
         raise NotImplementedError
 
     def strip(self, *args, **kwargs):
         raise NotImplementedError
 
     def checksize(self):
         raise NotImplementedError
 
 
 class bundlechangelog(bundlerevlog, changelog.changelog):
     def __init__(self, opener, cgunpacker):
         changelog.changelog.__init__(self, opener)
         linkmapper = lambda x: x
         bundlerevlog.__init__(
             self,
             opener,
             (revlog_constants.KIND_CHANGELOG, None),
             self.radix,
             cgunpacker,
             linkmapper,
         )
 
 
 class bundlemanifest(bundlerevlog, manifest.manifestrevlog):
     def __init__(
         self,
         nodeconstants,
         opener,
         cgunpacker,
         linkmapper,
         dirlogstarts=None,
         dir=b'',
     ):
         manifest.manifestrevlog.__init__(self, nodeconstants, opener, tree=dir)
         bundlerevlog.__init__(
             self,
             opener,
             (revlog_constants.KIND_MANIFESTLOG, dir),
             self._revlog.radix,
             cgunpacker,
             linkmapper,
         )
         if dirlogstarts is None:
             dirlogstarts = {}
             if self.bundle.version == b"03":
                 dirlogstarts = _getfilestarts(self.bundle)
         self._dirlogstarts = dirlogstarts
         self._linkmapper = linkmapper
 
     def dirlog(self, d):
         if d in self._dirlogstarts:
             self.bundle.seek(self._dirlogstarts[d])
             return bundlemanifest(
                 self.nodeconstants,
                 self.opener,
                 self.bundle,
                 self._linkmapper,
                 self._dirlogstarts,
                 dir=d,
             )
         return super(bundlemanifest, self).dirlog(d)
 
 
 class bundlefilelog(filelog.filelog):
     def __init__(self, opener, path, cgunpacker, linkmapper):
         filelog.filelog.__init__(self, opener, path)
         self._revlog = bundlerevlog(
             opener,
             # XXX should use the unencoded path
             target=(revlog_constants.KIND_FILELOG, path),
             radix=self._revlog.radix,
             cgunpacker=cgunpacker,
             linkmapper=linkmapper,
         )
 
 
 class bundlepeer(localrepo.localpeer):
     def canpush(self):
         return False
 
 
 class bundlephasecache(phases.phasecache):
     def __init__(self, *args, **kwargs):
         super(bundlephasecache, self).__init__(*args, **kwargs)
         if util.safehasattr(self, 'opener'):
             self.opener = vfsmod.readonlyvfs(self.opener)
 
     def write(self):
         raise NotImplementedError
 
     def _write(self, fp):
         raise NotImplementedError
 
     def _updateroots(self, phase, newroots, tr):
         self.phaseroots[phase] = newroots
         self.invalidate()
         self.dirty = True
 
 
 def _getfilestarts(cgunpacker):
     filespos = {}
     for chunkdata in iter(cgunpacker.filelogheader, {}):
         fname = chunkdata[b'filename']
         filespos[fname] = cgunpacker.tell()
         for chunk in iter(lambda: cgunpacker.deltachunk(None), {}):
             pass
     return filespos
 
 
 class bundlerepository:
     """A repository instance that is a union of a local repo and a bundle.
 
     Instances represent a read-only repository composed of a local repository
     with the contents of a bundle file applied. The repository instance is
     conceptually similar to the state of a repository after an
     ``hg unbundle`` operation. However, the contents of the bundle are never
     applied to the actual base repository.
 
     Instances constructed directly are not usable as repository objects.
     Use instance() or makebundlerepository() to create instances.
     """
 
     def __init__(self, bundlepath, url, tempparent):
         self._tempparent = tempparent
         self._url = url
 
         self.ui.setconfig(b'phases', b'publish', False, b'bundlerepo')
 
         # dict with the mapping 'filename' -> position in the changegroup.
         self._cgfilespos = {}
         self._bundlefile = None
         self._cgunpacker = None
         self.tempfile = None
         f = util.posixfile(bundlepath, b"rb")
         bundle = exchange.readbundle(self.ui, f, bundlepath)
 
         if isinstance(bundle, bundle2.unbundle20):
             self._bundlefile = bundle
 
             cgpart = None
             for part in bundle.iterparts(seekable=True):
                 if part.type == b'phase-heads':
                     self._handle_bundle2_phase_part(bundle, part)
                 elif part.type == b'changegroup':
                     if cgpart:
                         raise NotImplementedError(
                             b"can't process multiple changegroups"
                         )
                     cgpart = part
                     self._handle_bundle2_cg_part(bundle, part)
 
             if not cgpart:
                 raise error.Abort(_(b"No changegroups found"))
 
             # This is required to placate a later consumer, which expects
             # the payload offset to be at the beginning of the changegroup.
             # We need to do this after the iterparts() generator advances
             # because iterparts() will seek to end of payload after the
             # generator returns control to iterparts().
             cgpart.seek(0, os.SEEK_SET)
 
         elif isinstance(bundle, changegroup.cg1unpacker):
             self._handle_bundle1(bundle, bundlepath)
         else:
             raise error.Abort(
                 _(b'bundle type %r cannot be read') % type(bundle)
             )
 
     def _handle_bundle1(self, bundle, bundlepath):
         if bundle.compressed():
             f = self._writetempbundle(bundle.read, b'.hg10un', header=b'HG10UN')
             bundle = exchange.readbundle(self.ui, f, bundlepath, self.vfs)
 
         self._bundlefile = bundle
         self._cgunpacker = bundle
 
         self.firstnewrev = self.changelog.repotiprev + 1
         phases.retractboundary(
             self,
             None,
             phases.draft,
             [ctx.node() for ctx in self[self.firstnewrev :]],
         )
 
     def _handle_bundle2_cg_part(self, bundle, part):
         assert part.type == b'changegroup'
         cgstream = part
         targetphase = part.params.get(b'targetphase')
         try:
             targetphase = int(targetphase)
         except TypeError:
             pass
         if targetphase is None:
             targetphase = phases.draft
         if targetphase not in phases.allphases:
             m = _(b'unsupported targetphase: %d')
             m %= targetphase
             raise error.Abort(m)
         version = part.params.get(b'version', b'01')
         legalcgvers = changegroup.supportedincomingversions(self)
         if version not in legalcgvers:
             msg = _(b'Unsupported changegroup version: %s')
             raise error.Abort(msg % version)
         if bundle.compressed():
             cgstream = self._writetempbundle(part.read, b'.cg%sun' % version)
 
         self._cgunpacker = changegroup.getunbundler(version, cgstream, b'UN')
 
         self.firstnewrev = self.changelog.repotiprev + 1
         phases.retractboundary(
             self,
             None,
             targetphase,
             [ctx.node() for ctx in self[self.firstnewrev :]],
         )
 
     def _handle_bundle2_phase_part(self, bundle, part):
         assert part.type == b'phase-heads'
 
         unfi = self.unfiltered()
         headsbyphase = phases.binarydecode(part)
         phases.updatephases(unfi, lambda: None, headsbyphase)
 
     def _writetempbundle(self, readfn, suffix, header=b''):
         """Write a temporary file to disk"""
         fdtemp, temp = self.vfs.mkstemp(prefix=b"hg-bundle-", suffix=suffix)
         self.tempfile = temp
 
         with os.fdopen(fdtemp, 'wb') as fptemp:
             fptemp.write(header)
             while True:
                 chunk = readfn(2 ** 18)
                 if not chunk:
                     break
                 fptemp.write(chunk)
 
         return self.vfs.open(self.tempfile, mode=b"rb")
 
     @localrepo.unfilteredpropertycache
     def _phasecache(self):
         return bundlephasecache(self, self._phasedefaults)
 
     @localrepo.unfilteredpropertycache
     def changelog(self):
         # consume the header if it exists
         self._cgunpacker.changelogheader()
         c = bundlechangelog(self.svfs, self._cgunpacker)
         self.manstart = self._cgunpacker.tell()
         return c
 
     def _refreshchangelog(self):
         # changelog for bundle repo are not filecache, this method is not
         # applicable.
         pass
 
     @localrepo.unfilteredpropertycache
     def manifestlog(self):
         self._cgunpacker.seek(self.manstart)
         # consume the header if it exists
         self._cgunpacker.manifestheader()
         linkmapper = self.unfiltered().changelog.rev
         rootstore = bundlemanifest(
             self.nodeconstants, self.svfs, self._cgunpacker, linkmapper
         )
         self.filestart = self._cgunpacker.tell()
 
         return manifest.manifestlog(
             self.svfs, self, rootstore, self.narrowmatch()
         )
 
     def _consumemanifest(self):
         """Consumes the manifest portion of the bundle, setting filestart so the
         file portion can be read."""
         self._cgunpacker.seek(self.manstart)
         self._cgunpacker.manifestheader()
         for delta in self._cgunpacker.deltaiter():
             pass
         self.filestart = self._cgunpacker.tell()
 
     @localrepo.unfilteredpropertycache
     def manstart(self):
         self.changelog
         return self.manstart
 
     @localrepo.unfilteredpropertycache
     def filestart(self):
         self.manifestlog
 
         # If filestart was not set by self.manifestlog, that means the
         # manifestlog implementation did not consume the manifests from the
         # changegroup (ex: it might be consuming trees from a separate bundle2
         # part instead). So we need to manually consume it.
         if 'filestart' not in self.__dict__:
             self._consumemanifest()
 
         return self.filestart
 
     def url(self):
         return self._url
 
     def file(self, f):
         if not self._cgfilespos:
             self._cgunpacker.seek(self.filestart)
             self._cgfilespos = _getfilestarts(self._cgunpacker)
 
         if f in self._cgfilespos:
             self._cgunpacker.seek(self._cgfilespos[f])
             linkmapper = self.unfiltered().changelog.rev
             return bundlefilelog(self.svfs, f, self._cgunpacker, linkmapper)
         else:
             return super(bundlerepository, self).file(f)
 
     def close(self):
         """Close assigned bundle file immediately."""
         self._bundlefile.close()
         if self.tempfile is not None:
             self.vfs.unlink(self.tempfile)
         if self._tempparent:
             shutil.rmtree(self._tempparent, True)
 
     def cancopy(self):
         return False
 
-    def peer(self, path=None):
-        return bundlepeer(self, path=path)
+    def peer(self, path=None, remotehidden=False):
+        return bundlepeer(self, path=path, remotehidden=remotehidden)
 
     def getcwd(self):
         return encoding.getcwd()  # always outside the repo
 
     # Check if parents exist in localrepo before setting
     def setparents(self, p1, p2=None):
         if p2 is None:
             p2 = self.nullid
         p1rev = self.changelog.rev(p1)
         p2rev = self.changelog.rev(p2)
         msg = _(b"setting parent to node %s that only exists in the bundle\n")
         if self.changelog.repotiprev < p1rev:
             self.ui.warn(msg % hex(p1))
         if self.changelog.repotiprev < p2rev:
             self.ui.warn(msg % hex(p2))
         return super(bundlerepository, self).setparents(p1, p2)
 
 
 def instance(ui, path, create, intents=None, createopts=None):
     if create:
         raise error.Abort(_(b'cannot create new bundle repository'))
     # internal config: bundle.mainreporoot
     parentpath = ui.config(b"bundle", b"mainreporoot")
     if not parentpath:
         # try to find the correct path to the working directory repo
         parentpath = cmdutil.findrepo(encoding.getcwd())
         if parentpath is None:
             parentpath = b''
     if parentpath:
         # Try to make the full path relative so we get a nice, short URL.
         # In particular, we don't want temp dir names in test outputs.
         cwd = encoding.getcwd()
         if parentpath == cwd:
             parentpath = b''
         else:
             cwd = pathutil.normasprefix(cwd)
             if parentpath.startswith(cwd):
                 parentpath = parentpath[len(cwd) :]
     u = urlutil.url(path)
     path = u.localpath()
     if u.scheme == b'bundle':
         s = path.split(b"+", 1)
         if len(s) == 1:
             repopath, bundlename = parentpath, s[0]
         else:
             repopath, bundlename = s
     else:
         repopath, bundlename = parentpath, path
 
     return makebundlerepository(ui, repopath, bundlename)
 
 
 def makebundlerepository(ui, repopath, bundlepath):
     """Make a bundle repository object based on repo and bundle paths."""
     if repopath:
         url = b'bundle:%s+%s' % (util.expandpath(repopath), bundlepath)
     else:
         url = b'bundle:%s' % bundlepath
 
     # Because we can't make any guarantees about the type of the base
     # repository, we can't have a static class representing the bundle
     # repository. We also can't make any guarantees about how to even
     # call the base repository's constructor!
     #
     # So, our strategy is to go through ``localrepo.instance()`` to construct
     # a repo instance. Then, we dynamically create a new type derived from
     # both it and our ``bundlerepository`` class which overrides some
     # functionality. We then change the type of the constructed repository
     # to this new type and initialize the bundle-specific bits of it.
 
     try:
         repo = localrepo.instance(ui, repopath, create=False)
         tempparent = None
     except error.RequirementError:
         raise  # no fallback if the backing repo is unsupported
     except error.RepoError:
         tempparent = pycompat.mkdtemp()
         try:
             repo = localrepo.instance(ui, tempparent, create=True)
         except Exception:
             shutil.rmtree(tempparent)
             raise
 
     class derivedbundlerepository(bundlerepository, repo.__class__):
         pass
 
     repo.__class__ = derivedbundlerepository
     bundlerepository.__init__(repo, bundlepath, url, tempparent)
 
     return repo
 
 
 class bundletransactionmanager:
     def transaction(self):
         return None
 
     def close(self):
         raise NotImplementedError
 
     def release(self):
         raise NotImplementedError
 
 
 def getremotechanges(
     ui, repo, peer, onlyheads=None, bundlename=None, force=False
 ):
     """obtains a bundle of changes incoming from peer
 
     "onlyheads" restricts the returned changes to those reachable from the
       specified heads.
     "bundlename", if given, stores the bundle to this file path permanently;
       otherwise it's stored to a temp file and gets deleted again when you call
       the returned "cleanupfn".
     "force" indicates whether to proceed on unrelated repos.
 
     Returns a tuple (local, csets, cleanupfn):
 
     "local" is a local repo from which to obtain the actual incoming
       changesets; it is a bundlerepo for the obtained bundle when the
       original "peer" is remote.
     "csets" lists the incoming changeset node ids.
     "cleanupfn" must be called without arguments when you're done processing
       the changes; it closes both the original "peer" and the one returned
       here.
     """
     tmp = discovery.findcommonincoming(repo, peer, heads=onlyheads, force=force)
     common, incoming, rheads = tmp
     if not incoming:
         try:
             if bundlename:
                 os.unlink(bundlename)
         except OSError:
             pass
         return repo, [], peer.close
 
     commonset = set(common)
     rheads = [x for x in rheads if x not in commonset]
 
     bundle = None
     bundlerepo = None
     localrepo = peer.local()
     if bundlename or not localrepo:
         # create a bundle (uncompressed if peer repo is not local)
 
         # developer config: devel.legacy.exchange
         legexc = ui.configlist(b'devel', b'legacy.exchange')
         forcebundle1 = b'bundle2' not in legexc and b'bundle1' in legexc
         canbundle2 = (
             not forcebundle1
             and peer.capable(b'getbundle')
             and peer.capable(b'bundle2')
         )
         if canbundle2:
             with peer.commandexecutor() as e:
                 b2 = e.callcommand(
                     b'getbundle',
                     {
                         b'source': b'incoming',
                         b'common': common,
                         b'heads': rheads,
                         b'bundlecaps': exchange.caps20to10(
                             repo, role=b'client'
                         ),
                         b'cg': True,
                     },
                 ).result()
 
                 fname = bundle = changegroup.writechunks(
                     ui, b2._forwardchunks(), bundlename
                 )
         else:
             if peer.capable(b'getbundle'):
                 with peer.commandexecutor() as e:
                     cg = e.callcommand(
                         b'getbundle',
                         {
                             b'source': b'incoming',
                             b'common': common,
                             b'heads': rheads,
                         },
                     ).result()
             elif onlyheads is None and not peer.capable(b'changegroupsubset'):
                 # compat with older servers when pulling all remote heads
 
                 with peer.commandexecutor() as e:
                     cg = e.callcommand(
                         b'changegroup',
                         {
                             b'nodes': incoming,
                             b'source': b'incoming',
                         },
                     ).result()
 
                 rheads = None
             else:
                 with peer.commandexecutor() as e:
                     cg = e.callcommand(
                         b'changegroupsubset',
                         {
                             b'bases': incoming,
                             b'heads': rheads,
                             b'source': b'incoming',
                         },
                     ).result()
 
             if localrepo:
                 bundletype = b"HG10BZ"
             else:
                 bundletype = b"HG10UN"
             fname = bundle = bundle2.writebundle(ui, cg, bundlename, bundletype)
         # keep written bundle?
         if bundlename:
             bundle = None
         if not localrepo:
             # use the created uncompressed bundlerepo
             localrepo = bundlerepo = makebundlerepository(
                 repo.baseui, repo.root, fname
             )
 
             # this repo contains local and peer now, so filter out local again
             common = repo.heads()
     if localrepo:
         # Part of common may be remotely filtered
         # So use an unfiltered version
         # The discovery process probably need cleanup to avoid that
         localrepo = localrepo.unfiltered()
 
     csets = localrepo.changelog.findmissing(common, rheads)
 
     if bundlerepo:
         reponodes = [ctx.node() for ctx in bundlerepo[bundlerepo.firstnewrev :]]
 
         with peer.commandexecutor() as e:
             remotephases = e.callcommand(
                 b'listkeys',
                 {
                     b'namespace': b'phases',
                 },
             ).result()
 
         pullop = exchange.pulloperation(
             bundlerepo, peer, path=None, heads=reponodes
         )
         pullop.trmanager = bundletransactionmanager()
         exchange._pullapplyphases(pullop, remotephases)
 
     def cleanup():
         if bundlerepo:
             bundlerepo.close()
         if bundle:
             os.unlink(bundle)
         peer.close()
 
     return (localrepo, csets, cleanup)

mercurial/commands.py

@@ -1,8020 +1,8038 b''
 # commands.py - command processing for mercurial
 #
 # 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 os
 import re
 import sys
 
 from .i18n import _
 from .node import (
     hex,
     nullid,
     nullrev,
     short,
     wdirrev,
 )
 from .pycompat import open
 from . import (
     archival,
     bookmarks,
     bundle2,
     bundlecaches,
     changegroup,
     cmdutil,
     copies,
     debugcommands as debugcommandsmod,
     destutil,
     discovery,
     encoding,
     error,
     exchange,
     extensions,
     filemerge,
     formatter,
     graphmod,
     grep as grepmod,
     hbisect,
     help,
     hg,
     logcmdutil,
     merge as mergemod,
     mergestate as mergestatemod,
     narrowspec,
     obsolete,
     obsutil,
     patch,
     phases,
     pycompat,
     rcutil,
     registrar,
     requirements,
     revsetlang,
     rewriteutil,
     scmutil,
     server,
     shelve as shelvemod,
     state as statemod,
     streamclone,
     tags as tagsmod,
     ui as uimod,
     util,
     verify as verifymod,
     vfs as vfsmod,
     wireprotoserver,
 )
 from .utils import (
     dateutil,
     stringutil,
     urlutil,
 )
 
 table = {}
 table.update(debugcommandsmod.command._table)
 
 command = registrar.command(table)
 INTENT_READONLY = registrar.INTENT_READONLY
 
 # common command options
 
 globalopts = [
     (
         b'R',
         b'repository',
         b'',
         _(b'repository root directory or name of overlay bundle file'),
         _(b'REPO'),
     ),
     (b'', b'cwd', b'', _(b'change working directory'), _(b'DIR')),
     (
         b'y',
         b'noninteractive',
         None,
         _(
             b'do not prompt, automatically pick the first choice for all prompts'
         ),
     ),
     (b'q', b'quiet', None, _(b'suppress output')),
     (b'v', b'verbose', None, _(b'enable additional output')),
     (
         b'',
         b'color',
         b'',
         # i18n: 'always', 'auto', 'never', and 'debug' are keywords
         # and should not be translated
         _(b"when to colorize (boolean, always, auto, never, or debug)"),
         _(b'TYPE'),
     ),
     (
         b'',
         b'config',
         [],
         _(b'set/override config option (use \'section.name=value\')'),
         _(b'CONFIG'),
     ),
     (b'', b'debug', None, _(b'enable debugging output')),
     (b'', b'debugger', None, _(b'start debugger')),
     (
         b'',
         b'encoding',
         encoding.encoding,
         _(b'set the charset encoding'),
         _(b'ENCODE'),
     ),
     (
         b'',
         b'encodingmode',
         encoding.encodingmode,
         _(b'set the charset encoding mode'),
         _(b'MODE'),
     ),
     (b'', b'traceback', None, _(b'always print a traceback on exception')),
     (b'', b'time', None, _(b'time how long the command takes')),
     (b'', b'profile', None, _(b'print command execution profile')),
     (b'', b'version', None, _(b'output version information and exit')),
     (b'h', b'help', None, _(b'display help and exit')),
     (b'', b'hidden', False, _(b'consider hidden changesets')),
     (
         b'',
         b'pager',
         b'auto',
         _(b"when to paginate (boolean, always, auto, or never)"),
         _(b'TYPE'),
     ),
 ]
 
 dryrunopts = cmdutil.dryrunopts
 remoteopts = cmdutil.remoteopts
 walkopts = cmdutil.walkopts
 commitopts = cmdutil.commitopts
 commitopts2 = cmdutil.commitopts2
 commitopts3 = cmdutil.commitopts3
 formatteropts = cmdutil.formatteropts
 templateopts = cmdutil.templateopts
 logopts = cmdutil.logopts
 diffopts = cmdutil.diffopts
 diffwsopts = cmdutil.diffwsopts
 diffopts2 = cmdutil.diffopts2
 mergetoolopts = cmdutil.mergetoolopts
 similarityopts = cmdutil.similarityopts
 subrepoopts = cmdutil.subrepoopts
 debugrevlogopts = cmdutil.debugrevlogopts
 
 # Commands start here, listed alphabetically
 
 
 @command(
     b'abort',
     dryrunopts,
     helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
     helpbasic=True,
 )
 def abort(ui, repo, **opts):
     """abort an unfinished operation (EXPERIMENTAL)
 
     Aborts a multistep operation like graft, histedit, rebase, merge,
     and unshelve if they are in an unfinished state.
 
     use --dry-run/-n to dry run the command.
     """
     dryrun = opts.get('dry_run')
     abortstate = cmdutil.getunfinishedstate(repo)
     if not abortstate:
         raise error.StateError(_(b'no operation in progress'))
     if not abortstate.abortfunc:
         raise error.InputError(
             (
                 _(b"%s in progress but does not support 'hg abort'")
                 % (abortstate._opname)
             ),
             hint=abortstate.hint(),
         )
     if dryrun:
         ui.status(
             _(b'%s in progress, will be aborted\n') % (abortstate._opname)
         )
         return
     return abortstate.abortfunc(ui, repo)
 
 
 @command(
     b'add',
     walkopts + subrepoopts + dryrunopts,
     _(b'[OPTION]... [FILE]...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
     helpbasic=True,
     inferrepo=True,
 )
 def add(ui, repo, *pats, **opts):
     """add the specified files on the next commit
 
     Schedule files to be version controlled and added to the
     repository.
 
     The files will be added to the repository at the next commit. To
     undo an add before that, see :hg:`forget`.
 
     If no names are given, add all files to the repository (except
     files matching ``.hgignore``).
 
     .. container:: verbose
 
        Examples:
 
          - New (unknown) files are added
            automatically by :hg:`add`::
 
              $ ls
              foo.c
              $ hg status
              ? foo.c
              $ hg add
              adding foo.c
              $ hg status
              A foo.c
 
          - Specific files to be added can be specified::
 
              $ ls
              bar.c  foo.c
              $ hg status
              ? bar.c
              ? foo.c
              $ hg add bar.c
              $ hg status
              A bar.c
              ? foo.c
 
     Returns 0 if all files are successfully added.
     """
 
     with repo.wlock(), repo.dirstate.changing_files(repo):
         m = scmutil.match(repo[None], pats, pycompat.byteskwargs(opts))
         uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
         rejected = cmdutil.add(ui, repo, m, b"", uipathfn, False, **opts)
         return rejected and 1 or 0
 
 
 @command(
     b'addremove',
     similarityopts + subrepoopts + walkopts + dryrunopts,
     _(b'[OPTION]... [FILE]...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
     inferrepo=True,
 )
 def addremove(ui, repo, *pats, **opts):
     """add all new files, delete all missing files
 
     Add all new files and remove all missing files from the
     repository.
 
     Unless names are given, new files are ignored if they match any of
     the patterns in ``.hgignore``. As with add, these changes take
     effect at the next commit.
 
     Use the -s/--similarity option to detect renamed files. This
     option takes a percentage between 0 (disabled) and 100 (files must
     be identical) as its parameter. With a parameter greater than 0,
     this compares every removed file with every added file and records
     those similar enough as renames. Detecting renamed files this way
     can be expensive. After using this option, :hg:`status -C` can be
     used to check which files were identified as moved or renamed. If
     not specified, -s/--similarity defaults to 100 and only renames of
     identical files are detected.
 
     .. container:: verbose
 
        Examples:
 
          - A number of files (bar.c and foo.c) are new,
            while foobar.c has been removed (without using :hg:`remove`)
            from the repository::
 
              $ ls
              bar.c foo.c
              $ hg status
              ! foobar.c
              ? bar.c
              ? foo.c
              $ hg addremove
              adding bar.c
              adding foo.c
              removing foobar.c
              $ hg status
              A bar.c
              A foo.c
              R foobar.c
 
          - A file foobar.c was moved to foo.c without using :hg:`rename`.
            Afterwards, it was edited slightly::
 
              $ ls
              foo.c
              $ hg status
              ! foobar.c
              ? foo.c
              $ hg addremove --similarity 90
              removing foobar.c
              adding foo.c
              recording removal of foobar.c as rename to foo.c (94% similar)
              $ hg status -C
              A foo.c
                foobar.c
              R foobar.c
 
     Returns 0 if all files are successfully added.
     """
     opts = pycompat.byteskwargs(opts)
     if not opts.get(b'similarity'):
         opts[b'similarity'] = b'100'
     with repo.wlock(), repo.dirstate.changing_files(repo):
         matcher = scmutil.match(repo[None], pats, opts)
         relative = scmutil.anypats(pats, opts)
         uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=relative)
         return scmutil.addremove(repo, matcher, b"", uipathfn, opts)
 
 
 @command(
     b'annotate|blame',
     [
         (b'r', b'rev', b'', _(b'annotate the specified revision'), _(b'REV')),
         (
             b'',
             b'follow',
             None,
             _(b'follow copies/renames and list the filename (DEPRECATED)'),
         ),
         (b'', b'no-follow', None, _(b"don't follow copies and renames")),
         (b'a', b'text', None, _(b'treat all files as text')),
         (b'u', b'user', None, _(b'list the author (long with -v)')),
         (b'f', b'file', None, _(b'list the filename')),
         (b'd', b'date', None, _(b'list the date (short with -q)')),
         (b'n', b'number', None, _(b'list the revision number (default)')),
         (b'c', b'changeset', None, _(b'list the changeset')),
         (
             b'l',
             b'line-number',
             None,
             _(b'show line number at the first appearance'),
         ),
         (
             b'',
             b'skip',
             [],
             _(b'revset to not display (EXPERIMENTAL)'),
             _(b'REV'),
         ),
     ]
     + diffwsopts
     + walkopts
     + formatteropts,
     _(b'[-r REV] [-f] [-a] [-u] [-d] [-n] [-c] [-l] FILE...'),
     helpcategory=command.CATEGORY_FILE_CONTENTS,
     helpbasic=True,
     inferrepo=True,
 )
 def annotate(ui, repo, *pats, **opts):
     """show changeset information by line for each file
 
     List changes in files, showing the revision id responsible for
     each line.
 
     This command is useful for discovering when a change was made and
     by whom.
 
     If you include --file, --user, or --date, the revision number is
     suppressed unless you also include --number.
 
     Without the -a/--text option, annotate will avoid processing files
     it detects as binary. With -a, annotate will annotate the file
     anyway, although the results will probably be neither useful
     nor desirable.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions. See also :hg:`help templates`.
 
       :lines:   List of lines with annotation data.
       :path:    String. Repository-absolute path of the specified file.
 
       And each entry of ``{lines}`` provides the following sub-keywords in
       addition to ``{date}``, ``{node}``, ``{rev}``, ``{user}``, etc.
 
       :line:    String. Line content.
       :lineno:  Integer. Line number at that revision.
       :path:    String. Repository-absolute path of the file at that revision.
 
       See :hg:`help templates.operators` for the list expansion syntax.
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     if not pats:
         raise error.InputError(
             _(b'at least one filename or pattern is required')
         )
 
     if opts.get(b'follow'):
         # --follow is deprecated and now just an alias for -f/--file
         # to mimic the behavior of Mercurial before version 1.5
         opts[b'file'] = True
 
     if (
         not opts.get(b'user')
         and not opts.get(b'changeset')
         and not opts.get(b'date')
         and not opts.get(b'file')
     ):
         opts[b'number'] = True
 
     linenumber = opts.get(b'line_number') is not None
     if (
         linenumber
         and (not opts.get(b'changeset'))
         and (not opts.get(b'number'))
     ):
         raise error.InputError(_(b'at least one of -n/-c is required for -l'))
 
     rev = opts.get(b'rev')
     if rev:
         repo = scmutil.unhidehashlikerevs(repo, [rev], b'nowarn')
     ctx = logcmdutil.revsingle(repo, rev)
 
     ui.pager(b'annotate')
     rootfm = ui.formatter(b'annotate', opts)
     if ui.debugflag:
         shorthex = pycompat.identity
     else:
 
         def shorthex(h):
             return h[:12]
 
     if ui.quiet:
         datefunc = dateutil.shortdate
     else:
         datefunc = dateutil.datestr
     if ctx.rev() is None:
         if opts.get(b'changeset'):
             # omit "+" suffix which is appended to node hex
             def formatrev(rev):
                 if rev == wdirrev:
                     return b'%d' % ctx.p1().rev()
                 else:
                     return b'%d' % rev
 
         else:
 
             def formatrev(rev):
                 if rev == wdirrev:
                     return b'%d+' % ctx.p1().rev()
                 else:
                     return b'%d ' % rev
 
         def formathex(h):
             if h == repo.nodeconstants.wdirhex:
                 return b'%s+' % shorthex(hex(ctx.p1().node()))
             else:
                 return b'%s ' % shorthex(h)
 
     else:
         formatrev = b'%d'.__mod__
         formathex = shorthex
 
     opmap = [
         (b'user', b' ', lambda x: x.fctx.user(), ui.shortuser),
         (b'rev', b' ', lambda x: scmutil.intrev(x.fctx), formatrev),
         (b'node', b' ', lambda x: hex(scmutil.binnode(x.fctx)), formathex),
         (b'date', b' ', lambda x: x.fctx.date(), util.cachefunc(datefunc)),
         (b'path', b' ', lambda x: x.fctx.path(), pycompat.bytestr),
         (b'lineno', b':', lambda x: x.lineno, pycompat.bytestr),
     ]
     opnamemap = {
         b'rev': b'number',
         b'node': b'changeset',
         b'path': b'file',
         b'lineno': b'line_number',
     }
 
     if rootfm.isplain():
 
         def makefunc(get, fmt):
             return lambda x: fmt(get(x))
 
     else:
 
         def makefunc(get, fmt):
             return get
 
     datahint = rootfm.datahint()
     funcmap = [
         (makefunc(get, fmt), sep)
         for fn, sep, get, fmt in opmap
         if opts.get(opnamemap.get(fn, fn)) or fn in datahint
     ]
     funcmap[0] = (funcmap[0][0], b'')  # no separator in front of first column
     fields = b' '.join(
         fn
         for fn, sep, get, fmt in opmap
         if opts.get(opnamemap.get(fn, fn)) or fn in datahint
     )
 
     def bad(x, y):
         raise error.InputError(b"%s: %s" % (x, y))
 
     m = scmutil.match(ctx, pats, opts, badfn=bad)
 
     follow = not opts.get(b'no_follow')
     diffopts = patch.difffeatureopts(
         ui, opts, section=b'annotate', whitespace=True
     )
     skiprevs = opts.get(b'skip')
     if skiprevs:
         skiprevs = logcmdutil.revrange(repo, skiprevs)
 
     uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
     for abs in ctx.walk(m):
         fctx = ctx[abs]
         rootfm.startitem()
         rootfm.data(path=abs)
         if not opts.get(b'text') and fctx.isbinary():
             rootfm.plain(_(b"%s: binary file\n") % uipathfn(abs))
             continue
 
         fm = rootfm.nested(b'lines', tmpl=b'{rev}: {line}')
         lines = fctx.annotate(
             follow=follow, skiprevs=skiprevs, diffopts=diffopts
         )
         if not lines:
             fm.end()
             continue
         formats = []
         pieces = []
 
         for f, sep in funcmap:
             l = [f(n) for n in lines]
             if fm.isplain():
                 sizes = [encoding.colwidth(x) for x in l]
                 ml = max(sizes)
                 formats.append([sep + b' ' * (ml - w) + b'%s' for w in sizes])
             else:
                 formats.append([b'%s'] * len(l))
             pieces.append(l)
 
         for f, p, n in zip(zip(*formats), zip(*pieces), lines):
             fm.startitem()
             fm.context(fctx=n.fctx)
             fm.write(fields, b"".join(f), *p)
             if n.skip:
                 fmt = b"* %s"
             else:
                 fmt = b": %s"
             fm.write(b'line', fmt, n.text)
 
         if not lines[-1].text.endswith(b'\n'):
             fm.plain(b'\n')
         fm.end()
 
     rootfm.end()
 
 
 @command(
     b'archive',
     [
         (b'', b'no-decode', None, _(b'do not pass files through decoders')),
         (
             b'p',
             b'prefix',
             b'',
             _(b'directory prefix for files in archive'),
             _(b'PREFIX'),
         ),
         (b'r', b'rev', b'', _(b'revision to distribute'), _(b'REV')),
         (b't', b'type', b'', _(b'type of distribution to create'), _(b'TYPE')),
     ]
     + subrepoopts
     + walkopts,
     _(b'[OPTION]... DEST'),
     helpcategory=command.CATEGORY_IMPORT_EXPORT,
 )
 def archive(ui, repo, dest, **opts):
     """create an unversioned archive of a repository revision
 
     By default, the revision used is the parent of the working
     directory; use -r/--rev to specify a different revision.
 
     The archive type is automatically detected based on file
     extension (to override, use -t/--type).
 
     .. container:: verbose
 
       Examples:
 
       - create a zip file containing the 1.0 release::
 
           hg archive -r 1.0 project-1.0.zip
 
       - create a tarball excluding .hg files::
 
           hg archive project.tar.gz -X ".hg*"
 
     Valid types are:
 
     :``files``: a directory full of files (default)
     :``tar``:   tar archive, uncompressed
     :``tbz2``:  tar archive, compressed using bzip2
     :``tgz``:   tar archive, compressed using gzip
     :``txz``:   tar archive, compressed using lzma (only in Python 3)
     :``uzip``:  zip archive, uncompressed
     :``zip``:   zip archive, compressed using deflate
 
     The exact name of the destination archive or directory is given
     using a format string; see :hg:`help export` for details.
 
     Each member added to an archive file has a directory prefix
     prepended. Use -p/--prefix to specify a format string for the
     prefix. The default is the basename of the archive, with suffixes
     removed.
 
     Returns 0 on success.
     """
 
     opts = pycompat.byteskwargs(opts)
     rev = opts.get(b'rev')
     if rev:
         repo = scmutil.unhidehashlikerevs(repo, [rev], b'nowarn')
     ctx = logcmdutil.revsingle(repo, rev)
     if not ctx:
         raise error.InputError(
             _(b'no working directory: please specify a revision')
         )
     node = ctx.node()
     dest = cmdutil.makefilename(ctx, dest)
     if os.path.realpath(dest) == repo.root:
         raise error.InputError(_(b'repository root cannot be destination'))
 
     kind = opts.get(b'type') or archival.guesskind(dest) or b'files'
     prefix = opts.get(b'prefix')
 
     if dest == b'-':
         if kind == b'files':
             raise error.InputError(_(b'cannot archive plain files to stdout'))
         dest = cmdutil.makefileobj(ctx, dest)
         if not prefix:
             prefix = os.path.basename(repo.root) + b'-%h'
 
     prefix = cmdutil.makefilename(ctx, prefix)
     match = scmutil.match(ctx, [], opts)
     archival.archive(
         repo,
         dest,
         node,
         kind,
         not opts.get(b'no_decode'),
         match,
         prefix,
         subrepos=opts.get(b'subrepos'),
     )
 
 
 @command(
     b'backout',
     [
         (
             b'',
             b'merge',
             None,
             _(b'merge with old dirstate parent after backout'),
         ),
         (
             b'',
             b'commit',
             None,
             _(b'commit if no conflicts were encountered (DEPRECATED)'),
         ),
         (b'', b'no-commit', None, _(b'do not commit')),
         (
             b'',
             b'parent',
             b'',
             _(b'parent to choose when backing out merge (DEPRECATED)'),
             _(b'REV'),
         ),
         (b'r', b'rev', b'', _(b'revision to backout'), _(b'REV')),
         (b'e', b'edit', False, _(b'invoke editor on commit messages')),
     ]
     + mergetoolopts
     + walkopts
     + commitopts
     + commitopts2,
     _(b'[OPTION]... [-r] REV'),
     helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
 )
 def backout(ui, repo, node=None, rev=None, **opts):
     """reverse effect of earlier changeset
 
     Prepare a new changeset with the effect of REV undone in the
     current working directory. If no conflicts were encountered,
     it will be committed immediately.
 
     If REV is the parent of the working directory, then this new changeset
     is committed automatically (unless --no-commit is specified).
 
     .. note::
 
        :hg:`backout` cannot be used to fix either an unwanted or
        incorrect merge.
 
     .. container:: verbose
 
       Examples:
 
       - Reverse the effect of the parent of the working directory.
         This backout will be committed immediately::
 
           hg backout -r .
 
       - Reverse the effect of previous bad revision 23::
 
           hg backout -r 23
 
       - Reverse the effect of previous bad revision 23 and
         leave changes uncommitted::
 
           hg backout -r 23 --no-commit
           hg commit -m "Backout revision 23"
 
       By default, the pending changeset will have one parent,
       maintaining a linear history. With --merge, the pending
       changeset will instead have two parents: the old parent of the
       working directory and a new child of REV that simply undoes REV.
 
       Before version 1.7, the behavior without --merge was equivalent
       to specifying --merge followed by :hg:`update --clean .` to
       cancel the merge and leave the child of REV as a head to be
       merged separately.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     See :hg:`help revert` for a way to restore files to the state
     of another revision.
 
     Returns 0 on success, 1 if nothing to backout or there are unresolved
     files.
     """
     with repo.wlock(), repo.lock():
         return _dobackout(ui, repo, node, rev, **opts)
 
 
 def _dobackout(ui, repo, node=None, rev=None, **opts):
     cmdutil.check_incompatible_arguments(opts, 'no_commit', ['commit', 'merge'])
     opts = pycompat.byteskwargs(opts)
 
     if rev and node:
         raise error.InputError(_(b"please specify just one revision"))
 
     if not rev:
         rev = node
 
     if not rev:
         raise error.InputError(_(b"please specify a revision to backout"))
 
     date = opts.get(b'date')
     if date:
         opts[b'date'] = dateutil.parsedate(date)
 
     cmdutil.checkunfinished(repo)
     cmdutil.bailifchanged(repo)
     ctx = logcmdutil.revsingle(repo, rev)
     node = ctx.node()
 
     op1, op2 = repo.dirstate.parents()
     if not repo.changelog.isancestor(node, op1):
         raise error.InputError(
             _(b'cannot backout change that is not an ancestor')
         )
 
     p1, p2 = repo.changelog.parents(node)
     if p1 == repo.nullid:
         raise error.InputError(_(b'cannot backout a change with no parents'))
     if p2 != repo.nullid:
         if not opts.get(b'parent'):
             raise error.InputError(_(b'cannot backout a merge changeset'))
         p = repo.lookup(opts[b'parent'])
         if p not in (p1, p2):
             raise error.InputError(
                 _(b'%s is not a parent of %s') % (short(p), short(node))
             )
         parent = p
     else:
         if opts.get(b'parent'):
             raise error.InputError(
                 _(b'cannot use --parent on non-merge changeset')
             )
         parent = p1
 
     # the backout should appear on the same branch
     branch = repo.dirstate.branch()
     bheads = repo.branchheads(branch)
     rctx = scmutil.revsingle(repo, hex(parent))
     if not opts.get(b'merge') and op1 != node:
         with repo.transaction(b"backout"):
             overrides = {(b'ui', b'forcemerge'): opts.get(b'tool', b'')}
             with ui.configoverride(overrides, b'backout'):
                 stats = mergemod.back_out(ctx, parent=repo[parent])
             repo.setparents(op1, op2)
         hg._showstats(repo, stats)
         if stats.unresolvedcount:
             repo.ui.status(
                 _(b"use 'hg resolve' to retry unresolved file merges\n")
             )
             return 1
     else:
         hg.clean(repo, node, show_stats=False)
         repo.dirstate.setbranch(branch, repo.currenttransaction())
         cmdutil.revert(ui, repo, rctx)
 
     if opts.get(b'no_commit'):
         msg = _(b"changeset %s backed out, don't forget to commit.\n")
         ui.status(msg % short(node))
         return 0
 
     def commitfunc(ui, repo, message, match, opts):
         editform = b'backout'
         e = cmdutil.getcommiteditor(
             editform=editform, **pycompat.strkwargs(opts)
         )
         if not message:
             # we don't translate commit messages
             message = b"Backed out changeset %s" % short(node)
             e = cmdutil.getcommiteditor(edit=True, editform=editform)
         return repo.commit(
             message, opts.get(b'user'), opts.get(b'date'), match, editor=e
         )
 
     # save to detect changes
     tip = repo.changelog.tip()
 
     newnode = cmdutil.commit(ui, repo, commitfunc, [], opts)
     if not newnode:
         ui.status(_(b"nothing changed\n"))
         return 1
     cmdutil.commitstatus(repo, newnode, branch, bheads, tip)
 
     def nice(node):
         return b'%d:%s' % (repo.changelog.rev(node), short(node))
 
     ui.status(
         _(b'changeset %s backs out changeset %s\n')
         % (nice(newnode), nice(node))
     )
     if opts.get(b'merge') and op1 != node:
         hg.clean(repo, op1, show_stats=False)
         ui.status(_(b'merging with changeset %s\n') % nice(newnode))
         overrides = {(b'ui', b'forcemerge'): opts.get(b'tool', b'')}
         with ui.configoverride(overrides, b'backout'):
             return hg.merge(repo[b'tip'])
     return 0
 
 
 @command(
     b'bisect',
     [
         (b'r', b'reset', False, _(b'reset bisect state')),
         (b'g', b'good', False, _(b'mark changeset good')),
         (b'b', b'bad', False, _(b'mark changeset bad')),
         (b's', b'skip', False, _(b'skip testing changeset')),
         (b'e', b'extend', False, _(b'extend the bisect range')),
         (
             b'c',
             b'command',
             b'',
             _(b'use command to check changeset state'),
             _(b'CMD'),
         ),
         (b'U', b'noupdate', False, _(b'do not update to target')),
     ],
     _(b"[-gbsr] [-U] [-c CMD] [REV]"),
     helpcategory=command.CATEGORY_CHANGE_NAVIGATION,
 )
 def bisect(
     ui,
     repo,
     positional_1=None,
     positional_2=None,
     command=None,
     reset=None,
     good=None,
     bad=None,
     skip=None,
     extend=None,
     noupdate=None,
 ):
     """subdivision search of changesets
 
     This command helps to find changesets which introduce problems. To
     use, mark the earliest changeset you know exhibits the problem as
     bad, then mark the latest changeset which is free from the problem
     as good. Bisect will update your working directory to a revision
     for testing (unless the -U/--noupdate option is specified). Once
     you have performed tests, mark the working directory as good or
     bad, and bisect will either update to another candidate changeset
     or announce that it has found the bad revision.
 
     As a shortcut, you can also use the revision argument to mark a
     revision as good or bad without checking it out first.
 
     If you supply a command, it will be used for automatic bisection.
     The environment variable HG_NODE will contain the ID of the
     changeset being tested. The exit status of the command will be
     used to mark revisions as good or bad: status 0 means good, 125
     means to skip the revision, 127 (command not found) will abort the
     bisection, and any other non-zero exit status means the revision
     is bad.
 
     .. container:: verbose
 
       Some examples:
 
       - start a bisection with known bad revision 34, and good revision 12::
 
           hg bisect --bad 34
           hg bisect --good 12
 
       - advance the current bisection by marking current revision as good or
         bad::
 
           hg bisect --good
           hg bisect --bad
 
       - mark the current revision, or a known revision, to be skipped (e.g. if
         that revision is not usable because of another issue)::
 
           hg bisect --skip
           hg bisect --skip 23
 
       - skip all revisions that do not touch directories ``foo`` or ``bar``::
 
           hg bisect --skip "!( file('path:foo') & file('path:bar') )"
 
       - forget the current bisection::
 
           hg bisect --reset
 
       - use 'make && make tests' to automatically find the first broken
         revision::
 
           hg bisect --reset
           hg bisect --bad 34
           hg bisect --good 12
           hg bisect --command "make && make tests"
 
       - see all changesets whose states are already known in the current
         bisection::
 
           hg log -r "bisect(pruned)"
 
       - see the changeset currently being bisected (especially useful
         if running with -U/--noupdate)::
 
           hg log -r "bisect(current)"
 
       - see all changesets that took part in the current bisection::
 
           hg log -r "bisect(range)"
 
       - you can even get a nice graph::
 
           hg log --graph -r "bisect(range)"
 
       See :hg:`help revisions.bisect` for more about the `bisect()` predicate.
 
     Returns 0 on success.
     """
     rev = []
     # backward compatibility
     if positional_1 in (b"good", b"bad", b"reset", b"init"):
         ui.warn(_(b"(use of 'hg bisect <cmd>' is deprecated)\n"))
         cmd = positional_1
         rev.append(positional_2)
         if cmd == b"good":
             good = True
         elif cmd == b"bad":
             bad = True
         else:
             reset = True
     elif positional_2:
         raise error.InputError(_(b'incompatible arguments'))
     elif positional_1 is not None:
         rev.append(positional_1)
 
     incompatibles = {
         b'--bad': bad,
         b'--command': bool(command),
         b'--extend': extend,
         b'--good': good,
         b'--reset': reset,
         b'--skip': skip,
     }
 
     enabled = [x for x in incompatibles if incompatibles[x]]
 
     if len(enabled) > 1:
         raise error.InputError(
             _(b'%s and %s are incompatible') % tuple(sorted(enabled)[0:2])
         )
 
     if reset:
         hbisect.resetstate(repo)
         return
 
     state = hbisect.load_state(repo)
 
     if rev:
         revs = logcmdutil.revrange(repo, rev)
         goodnodes = state[b'good']
         badnodes = state[b'bad']
         if goodnodes and badnodes:
             candidates = repo.revs(b'(%ln)::(%ln)', goodnodes, badnodes)
             candidates += repo.revs(b'(%ln)::(%ln)', badnodes, goodnodes)
             revs = candidates & revs
         nodes = [repo.changelog.node(i) for i in revs]
     else:
         nodes = [repo.lookup(b'.')]
 
     # update state
     if good or bad or skip:
         if good:
             state[b'good'] += nodes
         elif bad:
             state[b'bad'] += nodes
         elif skip:
             state[b'skip'] += nodes
         hbisect.save_state(repo, state)
         if not (state[b'good'] and state[b'bad']):
             return
 
     def mayupdate(repo, node, show_stats=True):
         """common used update sequence"""
         if noupdate:
             return
         cmdutil.checkunfinished(repo)
         cmdutil.bailifchanged(repo)
         return hg.clean(repo, node, show_stats=show_stats)
 
     displayer = logcmdutil.changesetdisplayer(ui, repo, {})
 
     if command:
         changesets = 1
         if noupdate:
             try:
                 node = state[b'current'][0]
             except LookupError:
                 raise error.StateError(
                     _(
                         b'current bisect revision is unknown - '
                         b'start a new bisect to fix'
                     )
                 )
         else:
             node, p2 = repo.dirstate.parents()
             if p2 != repo.nullid:
                 raise error.StateError(_(b'current bisect revision is a merge'))
         if rev:
             if not nodes:
                 raise error.InputError(_(b'empty revision set'))
             node = repo[nodes[-1]].node()
         with hbisect.restore_state(repo, state, node):
             while changesets:
                 # update state
                 state[b'current'] = [node]
                 hbisect.save_state(repo, state)
                 status = ui.system(
                     command,
                     environ={b'HG_NODE': hex(node)},
                     blockedtag=b'bisect_check',
                 )
                 if status == 125:
                     transition = b"skip"
                 elif status == 0:
                     transition = b"good"
                 # status < 0 means process was killed
                 elif status == 127:
                     raise error.Abort(_(b"failed to execute %s") % command)
                 elif status < 0:
                     raise error.Abort(_(b"%s killed") % command)
                 else:
                     transition = b"bad"
                 state[transition].append(node)
                 ctx = repo[node]
                 summary = cmdutil.format_changeset_summary(ui, ctx, b'bisect')
                 ui.status(_(b'changeset %s: %s\n') % (summary, transition))
                 hbisect.checkstate(state)
                 # bisect
                 nodes, changesets, bgood = hbisect.bisect(repo, state)
                 # update to next check
                 node = nodes[0]
                 mayupdate(repo, node, show_stats=False)
         hbisect.printresult(ui, repo, state, displayer, nodes, bgood)
         return
 
     hbisect.checkstate(state)
 
     # actually bisect
     nodes, changesets, good = hbisect.bisect(repo, state)
     if extend:
         if not changesets:
             extendctx = hbisect.extendrange(repo, state, nodes, good)
             if extendctx is not None:
                 ui.write(
                     _(b"Extending search to changeset %s\n")
                     % cmdutil.format_changeset_summary(ui, extendctx, b'bisect')
                 )
                 state[b'current'] = [extendctx.node()]
                 hbisect.save_state(repo, state)
                 return mayupdate(repo, extendctx.node())
         raise error.StateError(_(b"nothing to extend"))
 
     if changesets == 0:
         hbisect.printresult(ui, repo, state, displayer, nodes, good)
     else:
         assert len(nodes) == 1  # only a single node can be tested next
         node = nodes[0]
         # compute the approximate number of remaining tests
         tests, size = 0, 2
         while size <= changesets:
             tests, size = tests + 1, size * 2
         rev = repo.changelog.rev(node)
         summary = cmdutil.format_changeset_summary(ui, repo[rev], b'bisect')
         ui.write(
             _(
                 b"Testing changeset %s "
                 b"(%d changesets remaining, ~%d tests)\n"
             )
             % (summary, changesets, tests)
         )
         state[b'current'] = [node]
         hbisect.save_state(repo, state)
         return mayupdate(repo, node)
 
 
 @command(
     b'bookmarks|bookmark',
     [
         (b'f', b'force', False, _(b'force')),
         (b'r', b'rev', b'', _(b'revision for bookmark action'), _(b'REV')),
         (b'd', b'delete', False, _(b'delete a given bookmark')),
         (b'm', b'rename', b'', _(b'rename a given bookmark'), _(b'OLD')),
         (b'i', b'inactive', False, _(b'mark a bookmark inactive')),
         (b'l', b'list', False, _(b'list existing bookmarks')),
     ]
     + formatteropts,
     _(b'hg bookmarks [OPTIONS]... [NAME]...'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def bookmark(ui, repo, *names, **opts):
     """create a new bookmark or list existing bookmarks
 
     Bookmarks are labels on changesets to help track lines of development.
     Bookmarks are unversioned and can be moved, renamed and deleted.
     Deleting or moving a bookmark has no effect on the associated changesets.
 
     Creating or updating to a bookmark causes it to be marked as 'active'.
     The active bookmark is indicated with a '*'.
     When a commit is made, the active bookmark will advance to the new commit.
     A plain :hg:`update` will also advance an active bookmark, if possible.
     Updating away from a bookmark will cause it to be deactivated.
 
     Bookmarks can be pushed and pulled between repositories (see
     :hg:`help push` and :hg:`help pull`). If a shared bookmark has
     diverged, a new 'divergent bookmark' of the form 'name@path' will
     be created. Using :hg:`merge` will resolve the divergence.
 
     Specifying bookmark as '.' to -m/-d/-l options is equivalent to specifying
     the active bookmark's name.
 
     A bookmark named '@' has the special property that :hg:`clone` will
     check it out by default if it exists.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions such as ``{bookmark}``. See also
       :hg:`help templates`.
 
       :active:  Boolean. True if the bookmark is active.
 
       Examples:
 
       - create an active bookmark for a new line of development::
 
           hg book new-feature
 
       - create an inactive bookmark as a place marker::
 
           hg book -i reviewed
 
       - create an inactive bookmark on another changeset::
 
           hg book -r .^ tested
 
       - rename bookmark turkey to dinner::
 
           hg book -m turkey dinner
 
       - move the '@' bookmark from another branch::
 
           hg book -f @
 
       - print only the active bookmark name::
 
           hg book -ql .
     """
     opts = pycompat.byteskwargs(opts)
     force = opts.get(b'force')
     rev = opts.get(b'rev')
     inactive = opts.get(b'inactive')  # meaning add/rename to inactive bookmark
 
     action = cmdutil.check_at_most_one_arg(opts, b'delete', b'rename', b'list')
     if action:
         cmdutil.check_incompatible_arguments(opts, action, [b'rev'])
     elif names or rev:
         action = b'add'
     elif inactive:
         action = b'inactive'  # meaning deactivate
     else:
         action = b'list'
 
     cmdutil.check_incompatible_arguments(
         opts, b'inactive', [b'delete', b'list']
     )
     if not names and action in {b'add', b'delete'}:
         raise error.InputError(_(b"bookmark name required"))
 
     if action in {b'add', b'delete', b'rename', b'inactive'}:
         with repo.wlock(), repo.lock(), repo.transaction(b'bookmark') as tr:
             if action == b'delete':
                 names = pycompat.maplist(repo._bookmarks.expandname, names)
                 bookmarks.delete(repo, tr, names)
             elif action == b'rename':
                 if not names:
                     raise error.InputError(_(b"new bookmark name required"))
                 elif len(names) > 1:
                     raise error.InputError(
                         _(b"only one new bookmark name allowed")
                     )
                 oldname = repo._bookmarks.expandname(opts[b'rename'])
                 bookmarks.rename(repo, tr, oldname, names[0], force, inactive)
             elif action == b'add':
                 bookmarks.addbookmarks(repo, tr, names, rev, force, inactive)
             elif action == b'inactive':
                 if len(repo._bookmarks) == 0:
                     ui.status(_(b"no bookmarks set\n"))
                 elif not repo._activebookmark:
                     ui.status(_(b"no active bookmark\n"))
                 else:
                     bookmarks.deactivate(repo)
     elif action == b'list':
         names = pycompat.maplist(repo._bookmarks.expandname, names)
         with ui.formatter(b'bookmarks', opts) as fm:
             bookmarks.printbookmarks(ui, repo, fm, names)
     else:
         raise error.ProgrammingError(b'invalid action: %s' % action)
 
 
 @command(
     b'branch',
     [
         (
             b'f',
             b'force',
             None,
             _(b'set branch name even if it shadows an existing branch'),
         ),
         (b'C', b'clean', None, _(b'reset branch name to parent branch name')),
         (
             b'r',
             b'rev',
             [],
             _(b'change branches of the given revs (EXPERIMENTAL)'),
         ),
     ],
     _(b'[-fC] [NAME]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def branch(ui, repo, label=None, **opts):
     """set or show the current branch name
 
     .. note::
 
        Branch names are permanent and global. Use :hg:`bookmark` to create a
        light-weight bookmark instead. See :hg:`help glossary` for more
        information about named branches and bookmarks.
 
     With no argument, show the current branch name. With one argument,
     set the working directory branch name (the branch will not exist
     in the repository until the next commit). Standard practice
     recommends that primary development take place on the 'default'
     branch.
 
     Unless -f/--force is specified, branch will not let you set a
     branch name that already exists.
 
     Use -C/--clean to reset the working directory branch to that of
     the parent of the working directory, negating a previous branch
     change.
 
     Use the command :hg:`update` to switch to an existing branch. Use
     :hg:`commit --close-branch` to mark this branch head as closed.
     When all heads of a branch are closed, the branch will be
     considered closed.
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     revs = opts.get(b'rev')
     if label:
         label = label.strip()
 
     if not opts.get(b'clean') and not label:
         if revs:
             raise error.InputError(
                 _(b"no branch name specified for the revisions")
             )
         ui.write(b"%s\n" % repo.dirstate.branch())
         return
 
     with repo.wlock():
         if opts.get(b'clean'):
             label = repo[b'.'].branch()
             repo.dirstate.setbranch(label, repo.currenttransaction())
             ui.status(_(b'reset working directory to branch %s\n') % label)
         elif label:
 
             scmutil.checknewlabel(repo, label, b'branch')
             if revs:
                 return cmdutil.changebranch(ui, repo, revs, label, opts)
 
             if not opts.get(b'force') and label in repo.branchmap():
                 if label not in [p.branch() for p in repo[None].parents()]:
                     raise error.InputError(
                         _(b'a branch of the same name already exists'),
                         # i18n: "it" refers to an existing branch
                         hint=_(b"use 'hg update' to switch to it"),
                     )
 
             repo.dirstate.setbranch(label, repo.currenttransaction())
             ui.status(_(b'marked working directory as branch %s\n') % label)
 
             # find any open named branches aside from default
             for n, h, t, c in repo.branchmap().iterbranches():
                 if n != b"default" and not c:
                     return 0
             ui.status(
                 _(
                     b'(branches are permanent and global, '
                     b'did you want a bookmark?)\n'
                 )
             )
 
 
 @command(
     b'branches',
     [
         (
             b'a',
             b'active',
             False,
             _(b'show only branches that have unmerged heads (DEPRECATED)'),
         ),
         (b'c', b'closed', False, _(b'show normal and closed branches')),
         (b'r', b'rev', [], _(b'show branch name(s) of the given rev')),
     ]
     + formatteropts,
     _(b'[-c]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
     intents={INTENT_READONLY},
 )
 def branches(ui, repo, active=False, closed=False, **opts):
     """list repository named branches
 
     List the repository's named branches, indicating which ones are
     inactive. If -c/--closed is specified, also list branches which have
     been marked closed (see :hg:`commit --close-branch`).
 
     Use the command :hg:`update` to switch to an existing branch.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions such as ``{branch}``. See also
       :hg:`help templates`.
 
       :active:  Boolean. True if the branch is active.
       :closed:  Boolean. True if the branch is closed.
       :current: Boolean. True if it is the current branch.
 
     Returns 0.
     """
 
     opts = pycompat.byteskwargs(opts)
     revs = opts.get(b'rev')
     selectedbranches = None
     if revs:
         revs = logcmdutil.revrange(repo, revs)
         getbi = repo.revbranchcache().branchinfo
         selectedbranches = {getbi(r)[0] for r in revs}
 
     ui.pager(b'branches')
     fm = ui.formatter(b'branches', opts)
     hexfunc = fm.hexfunc
 
     allheads = set(repo.heads())
     branches = []
     for tag, heads, tip, isclosed in repo.branchmap().iterbranches():
         if selectedbranches is not None and tag not in selectedbranches:
             continue
         isactive = False
         if not isclosed:
             openheads = set(repo.branchmap().iteropen(heads))
             isactive = bool(openheads & allheads)
         branches.append((tag, repo[tip], isactive, not isclosed))
     branches.sort(key=lambda i: (i[2], i[1].rev(), i[0], i[3]), reverse=True)
 
     for tag, ctx, isactive, isopen in branches:
         if active and not isactive:
             continue
         if isactive:
             label = b'branches.active'
             notice = b''
         elif not isopen:
             if not closed:
                 continue
             label = b'branches.closed'
             notice = _(b' (closed)')
         else:
             label = b'branches.inactive'
             notice = _(b' (inactive)')
         current = tag == repo.dirstate.branch()
         if current:
             label = b'branches.current'
 
         fm.startitem()
         fm.write(b'branch', b'%s', tag, label=label)
         rev = ctx.rev()
         padsize = max(31 - len(b"%d" % rev) - encoding.colwidth(tag), 0)
         fmt = b' ' * padsize + b' %d:%s'
         fm.condwrite(
             not ui.quiet,
             b'rev node',
             fmt,
             rev,
             hexfunc(ctx.node()),
             label=b'log.changeset changeset.%s' % ctx.phasestr(),
         )
         fm.context(ctx=ctx)
         fm.data(active=isactive, closed=not isopen, current=current)
         if not ui.quiet:
             fm.plain(notice)
         fm.plain(b'\n')
     fm.end()
 
 
 @command(
     b'bundle',
     [
         (
             b'',
             b'exact',
             None,
             _(b'compute the base from the revision specified'),
         ),
         (
             b'f',
             b'force',
             None,
             _(b'run even when the destination is unrelated'),
         ),
         (
             b'r',
             b'rev',
             [],
             _(b'a changeset intended to be added to the destination'),
             _(b'REV'),
         ),
         (
             b'b',
             b'branch',
             [],
             _(b'a specific branch you would like to bundle'),
             _(b'BRANCH'),
         ),
         (
             b'',
             b'base',
             [],
             _(b'a base changeset assumed to be available at the destination'),
             _(b'REV'),
         ),
         (b'a', b'all', None, _(b'bundle all changesets in the repository')),
         (
             b't',
             b'type',
             b'bzip2',
             _(b'bundle compression type to use'),
             _(b'TYPE'),
         ),
     ]
     + remoteopts,
     _(b'[-f] [-t BUNDLESPEC] [-a] [-r REV]... [--base REV]... FILE [DEST]...'),
     helpcategory=command.CATEGORY_IMPORT_EXPORT,
 )
 def bundle(ui, repo, fname, *dests, **opts):
     """create a bundle file
 
     Generate a bundle file containing data to be transferred to another
     repository.
 
     To create a bundle containing all changesets, use -a/--all
     (or --base null). Otherwise, hg assumes the destination will have
     all the nodes you specify with --base parameters. Otherwise, hg
     will assume the repository has all the nodes in destination, or
     default-push/default if no destination is specified, where destination
     is the repositories you provide through DEST option.
 
     You can change bundle format with the -t/--type option. See
     :hg:`help bundlespec` for documentation on this format. By default,
     the most appropriate format is used and compression defaults to
     bzip2.
 
     The bundle file can then be transferred using conventional means
     and applied to another repository with the unbundle or pull
     command. This is useful when direct push and pull are not
     available or when exporting an entire repository is undesirable.
 
     Applying bundles preserves all changeset contents including
     permissions, copy/rename information, and revision history.
 
     Returns 0 on success, 1 if no changes found.
     """
     opts = pycompat.byteskwargs(opts)
 
     revs = None
     if b'rev' in opts:
         revstrings = opts[b'rev']
         revs = logcmdutil.revrange(repo, revstrings)
         if revstrings and not revs:
             raise error.InputError(_(b'no commits to bundle'))
 
     bundletype = opts.get(b'type', b'bzip2').lower()
     try:
         bundlespec = bundlecaches.parsebundlespec(
             repo, bundletype, strict=False
         )
     except error.UnsupportedBundleSpecification as e:
         raise error.InputError(
             pycompat.bytestr(e),
             hint=_(b"see 'hg help bundlespec' for supported values for --type"),
         )
     cgversion = bundlespec.params[b"cg.version"]
 
     # Packed bundles are a pseudo bundle format for now.
     if cgversion == b's1':
         raise error.InputError(
             _(b'packed bundles cannot be produced by "hg bundle"'),
             hint=_(b"use 'hg debugcreatestreamclonebundle'"),
         )
 
     if opts.get(b'all'):
         if dests:
             raise error.InputError(
                 _(b"--all is incompatible with specifying destinations")
             )
         if opts.get(b'base'):
             ui.warn(_(b"ignoring --base because --all was specified\n"))
         if opts.get(b'exact'):
             ui.warn(_(b"ignoring --exact because --all was specified\n"))
         base = [nullrev]
     elif opts.get(b'exact'):
         if dests:
             raise error.InputError(
                 _(b"--exact is incompatible with specifying destinations")
             )
         if opts.get(b'base'):
             ui.warn(_(b"ignoring --base because --exact was specified\n"))
         base = repo.revs(b'parents(%ld) - %ld', revs, revs)
         if not base:
             base = [nullrev]
     else:
         base = logcmdutil.revrange(repo, opts.get(b'base'))
     if cgversion not in changegroup.supportedoutgoingversions(repo):
         raise error.Abort(
             _(b"repository does not support bundle version %s") % cgversion
         )
 
     if base:
         if dests:
             raise error.InputError(
                 _(b"--base is incompatible with specifying destinations")
             )
         cl = repo.changelog
         common = [cl.node(rev) for rev in base]
         heads = [cl.node(r) for r in revs] if revs else None
         outgoing = discovery.outgoing(repo, common, heads)
         missing = outgoing.missing
         excluded = outgoing.excluded
     else:
         missing = set()
         excluded = set()
         for path in urlutil.get_push_paths(repo, ui, dests):
             other = hg.peer(repo, opts, path)
             if revs is not None:
                 hex_revs = [repo[r].hex() for r in revs]
             else:
                 hex_revs = None
             branches = (path.branch, [])
             head_revs, checkout = hg.addbranchrevs(
                 repo, repo, branches, hex_revs
             )
             heads = (
                 head_revs
                 and pycompat.maplist(repo.lookup, head_revs)
                 or head_revs
             )
             outgoing = discovery.findcommonoutgoing(
                 repo,
                 other,
                 onlyheads=heads,
                 force=opts.get(b'force'),
                 portable=True,
             )
             missing.update(outgoing.missing)
             excluded.update(outgoing.excluded)
 
     if not missing:
         scmutil.nochangesfound(ui, repo, not base and excluded)
         return 1
 
     # internal changeset are internal implementation details that should not
     # leave the repository. Bundling with `hg bundle` create such risk.
     bundled_internal = repo.revs(b"%ln and _internal()", missing)
     if bundled_internal:
         msg = _(b"cannot bundle internal changesets")
         hint = _(b"%d internal changesets selected") % len(bundled_internal)
         raise error.Abort(msg, hint=hint)
 
     if heads:
         outgoing = discovery.outgoing(
             repo, missingroots=missing, ancestorsof=heads
         )
     else:
         outgoing = discovery.outgoing(repo, missingroots=missing)
     outgoing.excluded = sorted(excluded)
 
     if cgversion == b'01':  # bundle1
         bversion = b'HG10' + bundlespec.wirecompression
         bcompression = None
     elif cgversion in (b'02', b'03'):
         bversion = b'HG20'
         bcompression = bundlespec.wirecompression
     else:
         raise error.ProgrammingError(
             b'bundle: unexpected changegroup version %s' % cgversion
         )
 
     # TODO compression options should be derived from bundlespec parsing.
     # This is a temporary hack to allow adjusting bundle compression
     # level without a) formalizing the bundlespec changes to declare it
     # b) introducing a command flag.
     compopts = {}
     complevel = ui.configint(
         b'experimental', b'bundlecomplevel.' + bundlespec.compression
     )
     if complevel is None:
         complevel = ui.configint(b'experimental', b'bundlecomplevel')
     if complevel is not None:
         compopts[b'level'] = complevel
 
     compthreads = ui.configint(
         b'experimental', b'bundlecompthreads.' + bundlespec.compression
     )
     if compthreads is None:
         compthreads = ui.configint(b'experimental', b'bundlecompthreads')
     if compthreads is not None:
         compopts[b'threads'] = compthreads
 
     # Bundling of obsmarker and phases is optional as not all clients
     # support the necessary features.
     cfg = ui.configbool
     obsolescence_cfg = cfg(b'experimental', b'evolution.bundle-obsmarker')
     bundlespec.set_param(b'obsolescence', obsolescence_cfg, overwrite=False)
     obs_mand_cfg = cfg(b'experimental', b'evolution.bundle-obsmarker:mandatory')
     bundlespec.set_param(
         b'obsolescence-mandatory', obs_mand_cfg, overwrite=False
     )
     if not bundlespec.params.get(b'phases', False):
         phases_cfg = cfg(b'experimental', b'bundle-phases')
         bundlespec.set_param(b'phases', phases_cfg, overwrite=False)
 
     bundle2.writenewbundle(
         ui,
         repo,
         b'bundle',
         fname,
         bversion,
         outgoing,
         bundlespec.params,
         compression=bcompression,
         compopts=compopts,
     )
 
 
 @command(
     b'cat',
     [
         (
             b'o',
             b'output',
             b'',
             _(b'print output to file with formatted name'),
             _(b'FORMAT'),
         ),
         (b'r', b'rev', b'', _(b'print the given revision'), _(b'REV')),
         (b'', b'decode', None, _(b'apply any matching decode filter')),
     ]
     + walkopts
     + formatteropts,
     _(b'[OPTION]... FILE...'),
     helpcategory=command.CATEGORY_FILE_CONTENTS,
     inferrepo=True,
     intents={INTENT_READONLY},
 )
 def cat(ui, repo, file1, *pats, **opts):
     """output the current or given revision of files
 
     Print the specified files as they were at the given revision. If
     no revision is given, the parent of the working directory is used.
 
     Output may be to a file, in which case the name of the file is
     given using a template string. See :hg:`help templates`. In addition
     to the common template keywords, the following formatting rules are
     supported:
 
     :``%%``: literal "%" character
     :``%s``: basename of file being printed
     :``%d``: dirname of file being printed, or '.' if in repository root
     :``%p``: root-relative path name of file being printed
     :``%H``: changeset hash (40 hexadecimal digits)
     :``%R``: changeset revision number
     :``%h``: short-form changeset hash (12 hexadecimal digits)
     :``%r``: zero-padded changeset revision number
     :``%b``: basename of the exporting repository
     :``\\``: literal "\\" character
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions. See also :hg:`help templates`.
 
       :data:    String. File content.
       :path:    String. Repository-absolute path of the file.
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     rev = opts.get(b'rev')
     if rev:
         repo = scmutil.unhidehashlikerevs(repo, [rev], b'nowarn')
     ctx = logcmdutil.revsingle(repo, rev)
     m = scmutil.match(ctx, (file1,) + pats, opts)
     fntemplate = opts.pop(b'output', b'')
     if cmdutil.isstdiofilename(fntemplate):
         fntemplate = b''
 
     if fntemplate:
         fm = formatter.nullformatter(ui, b'cat', opts)
     else:
         ui.pager(b'cat')
         fm = ui.formatter(b'cat', opts)
     with fm:
         return cmdutil.cat(
             ui, repo, ctx, m, fm, fntemplate, b'', **pycompat.strkwargs(opts)
         )
 
 
 @command(
     b'clone',
     [
         (
             b'U',
             b'noupdate',
             None,
             _(
                 b'the clone will include an empty working '
                 b'directory (only a repository)'
             ),
         ),
         (
             b'u',
             b'updaterev',
             b'',
             _(b'revision, tag, or branch to check out'),
             _(b'REV'),
         ),
         (
             b'r',
             b'rev',
             [],
             _(
                 b'do not clone everything, but include this changeset'
                 b' and its ancestors'
             ),
             _(b'REV'),
         ),
         (
             b'b',
             b'branch',
             [],
             _(
                 b'do not clone everything, but include this branch\'s'
                 b' changesets and their ancestors'
             ),
             _(b'BRANCH'),
         ),
         (b'', b'pull', None, _(b'use pull protocol to copy metadata')),
         (b'', b'uncompressed', None, _(b'an alias to --stream (DEPRECATED)')),
         (b'', b'stream', None, _(b'clone with minimal data processing')),
     ]
     + remoteopts,
     _(b'[OPTION]... SOURCE [DEST]'),
     helpcategory=command.CATEGORY_REPO_CREATION,
     helpbasic=True,
     norepo=True,
 )
 def clone(ui, source, dest=None, **opts):
     """make a copy of an existing repository
 
     Create a copy of an existing repository in a new directory.
 
     If no destination directory name is specified, it defaults to the
     basename of the source.
 
     The location of the source is added to the new repository's
     ``.hg/hgrc`` file, as the default to be used for future pulls.
 
     Only local paths and ``ssh://`` URLs are supported as
     destinations. For ``ssh://`` destinations, no working directory or
     ``.hg/hgrc`` will be created on the remote side.
 
     If the source repository has a bookmark called '@' set, that
     revision will be checked out in the new repository by default.
 
     To check out a particular version, use -u/--update, or
     -U/--noupdate to create a clone with no working directory.
 
     To pull only a subset of changesets, specify one or more revisions
     identifiers with -r/--rev or branches with -b/--branch. The
     resulting clone will contain only the specified changesets and
     their ancestors. These options (or 'clone src#rev dest') imply
     --pull, even for local source repositories.
 
     In normal clone mode, the remote normalizes repository data into a common
     exchange format and the receiving end translates this data into its local
     storage format. --stream activates a different clone mode that essentially
     copies repository files from the remote with minimal data processing. This
     significantly reduces the CPU cost of a clone both remotely and locally.
     However, it often increases the transferred data size by 30-40%. This can
     result in substantially faster clones where I/O throughput is plentiful,
     especially for larger repositories. A side-effect of --stream clones is
     that storage settings and requirements on the remote are applied locally:
     a modern client may inherit legacy or inefficient storage used by the
     remote or a legacy Mercurial client may not be able to clone from a
     modern Mercurial remote.
 
     .. note::
 
        Specifying a tag will include the tagged changeset but not the
        changeset containing the tag.
 
     .. container:: verbose
 
       For efficiency, hardlinks are used for cloning whenever the
       source and destination are on the same filesystem (note this
       applies only to the repository data, not to the working
       directory). Some filesystems, such as AFS, implement hardlinking
       incorrectly, but do not report errors. In these cases, use the
       --pull option to avoid hardlinking.
 
       Mercurial will update the working directory to the first applicable
       revision from this list:
 
       a) null if -U or the source repository has no changesets
       b) if -u . and the source repository is local, the first parent of
          the source repository's working directory
       c) the changeset specified with -u (if a branch name, this means the
          latest head of that branch)
       d) the changeset specified with -r
       e) the tipmost head specified with -b
       f) the tipmost head specified with the url#branch source syntax
       g) the revision marked with the '@' bookmark, if present
       h) the tipmost head of the default branch
       i) tip
 
       When cloning from servers that support it, Mercurial may fetch
       pre-generated data from a server-advertised URL or inline from the
       same stream. When this is done, hooks operating on incoming changesets
       and changegroups may fire more than once, once for each pre-generated
       bundle and as well as for any additional remaining data. In addition,
       if an error occurs, the repository may be rolled back to a partial
       clone. This behavior may change in future releases.
       See :hg:`help -e clonebundles` for more.
 
       Examples:
 
       - clone a remote repository to a new directory named hg/::
 
           hg clone https://www.mercurial-scm.org/repo/hg/
 
       - create a lightweight local clone::
 
           hg clone project/ project-feature/
 
       - clone from an absolute path on an ssh server (note double-slash)::
 
           hg clone ssh://user@server//home/projects/alpha/
 
       - do a streaming clone while checking out a specified version::
 
           hg clone --stream http://server/repo -u 1.5
 
       - create a repository without changesets after a particular revision::
 
           hg clone -r 04e544 experimental/ good/
 
       - clone (and track) a particular named branch::
 
           hg clone https://www.mercurial-scm.org/repo/hg/#stable
 
     See :hg:`help urls` for details on specifying URLs.
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     cmdutil.check_at_most_one_arg(opts, b'noupdate', b'updaterev')
 
     # --include/--exclude can come from narrow or sparse.
     includepats, excludepats = None, None
 
     # hg.clone() differentiates between None and an empty set. So make sure
     # patterns are sets if narrow is requested without patterns.
     if opts.get(b'narrow'):
         includepats = set()
         excludepats = set()
 
         if opts.get(b'include'):
             includepats = narrowspec.parsepatterns(opts.get(b'include'))
         if opts.get(b'exclude'):
             excludepats = narrowspec.parsepatterns(opts.get(b'exclude'))
 
     r = hg.clone(
         ui,
         opts,
         source,
         dest,
         pull=opts.get(b'pull'),
         stream=opts.get(b'stream') or opts.get(b'uncompressed'),
         revs=opts.get(b'rev'),
         update=opts.get(b'updaterev') or not opts.get(b'noupdate'),
         branch=opts.get(b'branch'),
         shareopts=opts.get(b'shareopts'),
         storeincludepats=includepats,
         storeexcludepats=excludepats,
         depth=opts.get(b'depth') or None,
     )
 
     return r is None
 
 
 @command(
     b'commit|ci',
     [
         (
             b'A',
             b'addremove',
             None,
             _(b'mark new/missing files as added/removed before committing'),
         ),
         (b'', b'close-branch', None, _(b'mark a branch head as closed')),
         (b'', b'amend', None, _(b'amend the parent of the working directory')),
         (b's', b'secret', None, _(b'use the secret phase for committing')),
         (b'', b'draft', None, _(b'use the draft phase for committing')),
         (b'e', b'edit', None, _(b'invoke editor on commit messages')),
         (
             b'',
             b'force-close-branch',
             None,
             _(b'forcibly close branch from a non-head changeset (ADVANCED)'),
         ),
         (b'i', b'interactive', None, _(b'use interactive mode')),
     ]
     + walkopts
     + commitopts
     + commitopts2
     + subrepoopts,
     _(b'[OPTION]... [FILE]...'),
     helpcategory=command.CATEGORY_COMMITTING,
     helpbasic=True,
     inferrepo=True,
 )
 def commit(ui, repo, *pats, **opts):
     """commit the specified files or all outstanding changes
 
     Commit changes to the given files into the repository. Unlike a
     centralized SCM, this operation is a local operation. See
     :hg:`push` for a way to actively distribute your changes.
 
     If a list of files is omitted, all changes reported by :hg:`status`
     will be committed.
 
     If you are committing the result of a merge, do not provide any
     filenames or -I/-X filters.
 
     If no commit message is specified, Mercurial starts your
     configured editor where you can enter a message. In case your
     commit fails, you will find a backup of your message in
     ``.hg/last-message.txt``.
 
     The --close-branch flag can be used to mark the current branch
     head closed. When all heads of a branch are closed, the branch
     will be considered closed and no longer listed.
 
     The --amend flag can be used to amend the parent of the
     working directory with a new commit that contains the changes
     in the parent in addition to those currently reported by :hg:`status`,
     if there are any. The old commit is stored in a backup bundle in
     ``.hg/strip-backup`` (see :hg:`help bundle` and :hg:`help unbundle`
     on how to restore it).
 
     Message, user and date are taken from the amended commit unless
     specified. When a message isn't specified on the command line,
     the editor will open with the message of the amended commit.
 
     It is not possible to amend public changesets (see :hg:`help phases`)
     or changesets that have children.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     Returns 0 on success, 1 if nothing changed.
 
     .. container:: verbose
 
       Examples:
 
       - commit all files ending in .py::
 
           hg commit --include "set:**.py"
 
       - commit all non-binary files::
 
           hg commit --exclude "set:binary()"
 
       - amend the current commit and set the date to now::
 
           hg commit --amend --date now
     """
     cmdutil.check_at_most_one_arg(opts, 'draft', 'secret')
     cmdutil.check_incompatible_arguments(opts, 'subrepos', ['amend'])
     with repo.wlock(), repo.lock():
         return _docommit(ui, repo, *pats, **opts)
 
 
 def _docommit(ui, repo, *pats, **opts):
     if opts.get('interactive'):
         opts.pop('interactive')
         ret = cmdutil.dorecord(
             ui, repo, commit, None, False, cmdutil.recordfilter, *pats, **opts
         )
         # ret can be 0 (no changes to record) or the value returned by
         # commit(), 1 if nothing changed or None on success.
         return 1 if ret == 0 else ret
 
     if opts.get('subrepos'):
         # Let --subrepos on the command line override config setting.
         ui.setconfig(b'ui', b'commitsubrepos', True, b'commit')
 
     cmdutil.checkunfinished(repo, commit=True)
 
     branch = repo[None].branch()
     bheads = repo.branchheads(branch)
     tip = repo.changelog.tip()
 
     extra = {}
     if opts.get('close_branch') or opts.get('force_close_branch'):
         extra[b'close'] = b'1'
 
         if repo[b'.'].closesbranch():
             # Not ideal, but let us do an extra status early to prevent early
             # bail out.
             matcher = scmutil.match(
                 repo[None], pats, pycompat.byteskwargs(opts)
             )
             s = repo.status(match=matcher)
             if s.modified or s.added or s.removed:
                 bheads = repo.branchheads(branch, closed=True)
             else:
                 msg = _(b'current revision is already a branch closing head')
                 raise error.InputError(msg)
 
         if not bheads:
             raise error.InputError(
                 _(b'branch "%s" has no heads to close') % branch
             )
         elif (
             branch == repo[b'.'].branch()
             and repo[b'.'].node() not in bheads
             and not opts.get('force_close_branch')
         ):
             hint = _(
                 b'use --force-close-branch to close branch from a non-head'
                 b' changeset'
             )
             raise error.InputError(_(b'can only close branch heads'), hint=hint)
         elif opts.get('amend'):
             if (
                 repo[b'.'].p1().branch() != branch
                 and repo[b'.'].p2().branch() != branch
             ):
                 raise error.InputError(_(b'can only close branch heads'))
 
     if opts.get('amend'):
         if ui.configbool(b'ui', b'commitsubrepos'):
             raise error.InputError(
                 _(b'cannot amend with ui.commitsubrepos enabled')
             )
 
         old = repo[b'.']
         rewriteutil.precheck(repo, [old.rev()], b'amend')
 
         # Currently histedit gets confused if an amend happens while histedit
         # is in progress. Since we have a checkunfinished command, we are
         # temporarily honoring it.
         #
         # Note: eventually this guard will be removed. Please do not expect
         # this behavior to remain.
         if not obsolete.isenabled(repo, obsolete.createmarkersopt):
             cmdutil.checkunfinished(repo)
 
         node = cmdutil.amend(ui, repo, old, extra, pats, opts)
         opts = pycompat.byteskwargs(opts)
         if node == old.node():
             ui.status(_(b"nothing changed\n"))
             return 1
     else:
 
         def commitfunc(ui, repo, message, match, opts):
             overrides = {}
             if opts.get(b'secret'):
                 overrides[(b'phases', b'new-commit')] = b'secret'
             elif opts.get(b'draft'):
                 overrides[(b'phases', b'new-commit')] = b'draft'
 
             baseui = repo.baseui
             with baseui.configoverride(overrides, b'commit'):
                 with ui.configoverride(overrides, b'commit'):
                     editform = cmdutil.mergeeditform(
                         repo[None], b'commit.normal'
                     )
                     editor = cmdutil.getcommiteditor(
                         editform=editform, **pycompat.strkwargs(opts)
                     )
                     return repo.commit(
                         message,
                         opts.get(b'user'),
                         opts.get(b'date'),
                         match,
                         editor=editor,
                         extra=extra,
                     )
 
         opts = pycompat.byteskwargs(opts)
         node = cmdutil.commit(ui, repo, commitfunc, pats, opts)
 
         if not node:
             stat = cmdutil.postcommitstatus(repo, pats, opts)
             if stat.deleted:
                 ui.status(
                     _(
                         b"nothing changed (%d missing files, see "
                         b"'hg status')\n"
                     )
                     % len(stat.deleted)
                 )
             else:
                 ui.status(_(b"nothing changed\n"))
             return 1
 
     cmdutil.commitstatus(repo, node, branch, bheads, tip, opts)
 
     if not ui.quiet and ui.configbool(b'commands', b'commit.post-status'):
         status(
             ui,
             repo,
             modified=True,
             added=True,
             removed=True,
             deleted=True,
             unknown=True,
             subrepos=opts.get(b'subrepos'),
         )
 
 
 @command(
     b'config|showconfig|debugconfig',
     [
         (b'u', b'untrusted', None, _(b'show untrusted configuration options')),
         # This is experimental because we need
         # * reasonable behavior around aliases,
         # * decide if we display [debug] [experimental] and [devel] section par
         #   default
         # * some way to display "generic" config entry (the one matching
         #   regexp,
         # * proper display of the different value type
         # * a better way to handle <DYNAMIC> values (and variable types),
         # * maybe some type information ?
         (
             b'',
             b'exp-all-known',
             None,
             _(b'show all known config option (EXPERIMENTAL)'),
         ),
         (b'e', b'edit', None, _(b'edit user config')),
         (b'l', b'local', None, _(b'edit repository config')),
         (b'', b'source', None, _(b'show source of configuration value')),
         (
             b'',
             b'shared',
             None,
             _(b'edit shared source repository config (EXPERIMENTAL)'),
         ),
         (b'', b'non-shared', None, _(b'edit non shared config (EXPERIMENTAL)')),
         (b'g', b'global', None, _(b'edit global config')),
     ]
     + formatteropts,
     _(b'[-u] [NAME]...'),
     helpcategory=command.CATEGORY_HELP,
     optionalrepo=True,
     intents={INTENT_READONLY},
 )
 def config(ui, repo, *values, **opts):
     """show combined config settings from all hgrc files
 
     With no arguments, print names and values of all config items.
 
     With one argument of the form section.name, print just the value
     of that config item.
 
     With multiple arguments, print names and values of all config
     items with matching section names or section.names.
 
     With --edit, start an editor on the user-level config file. With
     --global, edit the system-wide config file. With --local, edit the
     repository-level config file.
 
     With --source, the source (filename and line number) is printed
     for each config item.
 
     See :hg:`help config` for more information about config files.
 
     .. container:: verbose
 
       --non-shared flag is used to edit `.hg/hgrc-not-shared` config file.
       This file is not shared across shares when in share-safe mode.
 
       Template:
 
       The following keywords are supported. See also :hg:`help templates`.
 
       :name:    String. Config name.
       :source:  String. Filename and line number where the item is defined.
       :value:   String. Config value.
 
       The --shared flag can be used to edit the config file of shared source
       repository. It only works when you have shared using the experimental
       share safe feature.
 
     Returns 0 on success, 1 if NAME does not exist.
 
     """
 
     opts = pycompat.byteskwargs(opts)
     editopts = (b'edit', b'local', b'global', b'shared', b'non_shared')
     if any(opts.get(o) for o in editopts):
         cmdutil.check_at_most_one_arg(opts, *editopts[1:])
         if opts.get(b'local'):
             if not repo:
                 raise error.InputError(
                     _(b"can't use --local outside a repository")
                 )
             paths = [repo.vfs.join(b'hgrc')]
         elif opts.get(b'global'):
             paths = rcutil.systemrcpath()
         elif opts.get(b'shared'):
             if not repo.shared():
                 raise error.InputError(
                     _(b"repository is not shared; can't use --shared")
                 )
             if requirements.SHARESAFE_REQUIREMENT not in repo.requirements:
                 raise error.InputError(
                     _(
                         b"share safe feature not enabled; "
                         b"unable to edit shared source repository config"
                     )
                 )
             paths = [vfsmod.vfs(repo.sharedpath).join(b'hgrc')]
         elif opts.get(b'non_shared'):
             paths = [repo.vfs.join(b'hgrc-not-shared')]
         else:
             paths = rcutil.userrcpath()
 
         for f in paths:
             if os.path.exists(f):
                 break
         else:
             if opts.get(b'global'):
                 samplehgrc = uimod.samplehgrcs[b'global']
             elif opts.get(b'local'):
                 samplehgrc = uimod.samplehgrcs[b'local']
             else:
                 samplehgrc = uimod.samplehgrcs[b'user']
 
             f = paths[0]
             fp = open(f, b"wb")
             fp.write(util.tonativeeol(samplehgrc))
             fp.close()
 
         editor = ui.geteditor()
         ui.system(
             b"%s \"%s\"" % (editor, f),
             onerr=error.InputError,
             errprefix=_(b"edit failed"),
             blockedtag=b'config_edit',
         )
         return
     ui.pager(b'config')
     fm = ui.formatter(b'config', opts)
     for t, f in rcutil.rccomponents():
         if t == b'path':
             ui.debug(b'read config from: %s\n' % f)
         elif t == b'resource':
             ui.debug(b'read config from: resource:%s.%s\n' % (f[0], f[1]))
         elif t == b'items':
             # Don't print anything for 'items'.
             pass
         else:
             raise error.ProgrammingError(b'unknown rctype: %s' % t)
     untrusted = bool(opts.get(b'untrusted'))
 
     selsections = selentries = []
     if values:
         selsections = [v for v in values if b'.' not in v]
         selentries = [v for v in values if b'.' in v]
     uniquesel = len(selentries) == 1 and not selsections
     selsections = set(selsections)
     selentries = set(selentries)
 
     matched = False
     all_known = opts[b'exp_all_known']
     show_source = ui.debugflag or opts.get(b'source')
     entries = ui.walkconfig(untrusted=untrusted, all_known=all_known)
     for section, name, value in entries:
         source = ui.configsource(section, name, untrusted)
         value = pycompat.bytestr(value)
         defaultvalue = ui.configdefault(section, name)
         if fm.isplain():
             source = source or b'none'
             value = value.replace(b'\n', b'\\n')
         entryname = section + b'.' + name
         if values and not (section in selsections or entryname in selentries):
             continue
         fm.startitem()
         fm.condwrite(show_source, b'source', b'%s: ', source)
         if uniquesel:
             fm.data(name=entryname)
             fm.write(b'value', b'%s\n', value)
         else:
             fm.write(b'name value', b'%s=%s\n', entryname, value)
         if formatter.isprintable(defaultvalue):
             fm.data(defaultvalue=defaultvalue)
         elif isinstance(defaultvalue, list) and all(
             formatter.isprintable(e) for e in defaultvalue
         ):
             fm.data(defaultvalue=fm.formatlist(defaultvalue, name=b'value'))
         # TODO: no idea how to process unsupported defaultvalue types
         matched = True
     fm.end()
     if matched:
         return 0
     return 1
 
 
 @command(
     b'continue',
     dryrunopts,
     helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
     helpbasic=True,
 )
 def continuecmd(ui, repo, **opts):
     """resumes an interrupted operation (EXPERIMENTAL)
 
     Finishes a multistep operation like graft, histedit, rebase, merge,
     and unshelve if they are in an interrupted state.
 
     use --dry-run/-n to dry run the command.
     """
     dryrun = opts.get('dry_run')
     contstate = cmdutil.getunfinishedstate(repo)
     if not contstate:
         raise error.StateError(_(b'no operation in progress'))
     if not contstate.continuefunc:
         raise error.StateError(
             (
                 _(b"%s in progress but does not support 'hg continue'")
                 % (contstate._opname)
             ),
             hint=contstate.continuemsg(),
         )
     if dryrun:
         ui.status(_(b'%s in progress, will be resumed\n') % (contstate._opname))
         return
     return contstate.continuefunc(ui, repo)
 
 
 @command(
     b'copy|cp',
     [
         (b'', b'forget', None, _(b'unmark a destination file as copied')),
         (b'A', b'after', None, _(b'record a copy that has already occurred')),
         (
             b'',
             b'at-rev',
             b'',
             _(b'(un)mark copies in the given revision (EXPERIMENTAL)'),
             _(b'REV'),
         ),
         (
             b'f',
             b'force',
             None,
             _(b'forcibly copy over an existing managed file'),
         ),
     ]
     + walkopts
     + dryrunopts,
     _(b'[OPTION]... (SOURCE... DEST | --forget DEST...)'),
     helpcategory=command.CATEGORY_FILE_CONTENTS,
 )
 def copy(ui, repo, *pats, **opts):
     """mark files as copied for the next commit
 
     Mark dest as having copies of source files. If dest is a
     directory, copies are put in that directory. If dest is a file,
     the source must be a single file.
 
     By default, this command copies the contents of files as they
     exist in the working directory. If invoked with -A/--after, the
     operation is recorded, but no copying is performed.
 
     To undo marking a destination file as copied, use --forget. With that
     option, all given (positional) arguments are unmarked as copies. The
     destination file(s) will be left in place (still tracked). Note that
     :hg:`copy --forget` behaves the same way as :hg:`rename --forget`.
 
     This command takes effect with the next commit by default.
 
     Returns 0 on success, 1 if errors are encountered.
     """
     opts = pycompat.byteskwargs(opts)
 
     context = lambda repo: repo.dirstate.changing_files(repo)
     rev = opts.get(b'at_rev')
     ctx = None
     if rev:
         ctx = logcmdutil.revsingle(repo, rev)
         if ctx.rev() is not None:
 
             def context(repo):
                 return util.nullcontextmanager()
 
             opts[b'at_rev'] = ctx.rev()
     with repo.wlock(), context(repo):
         return cmdutil.copy(ui, repo, pats, opts)
 
 
 @command(
     b'debugcommands',
     [],
     _(b'[COMMAND]'),
     helpcategory=command.CATEGORY_HELP,
     norepo=True,
 )
 def debugcommands(ui, cmd=b'', *args):
     """list all available commands and options"""
     for cmd, vals in sorted(table.items()):
         cmd = cmd.split(b'|')[0]
         opts = b', '.join([i[1] for i in vals[1]])
         ui.write(b'%s: %s\n' % (cmd, opts))
 
 
 @command(
     b'debugcomplete',
     [(b'o', b'options', None, _(b'show the command options'))],
     _(b'[-o] CMD'),
     helpcategory=command.CATEGORY_HELP,
     norepo=True,
 )
 def debugcomplete(ui, cmd=b'', **opts):
     """returns the completion list associated with the given command"""
 
     if opts.get('options'):
         options = []
         otables = [globalopts]
         if cmd:
             aliases, entry = cmdutil.findcmd(cmd, table, False)
             otables.append(entry[1])
         for t in otables:
             for o in t:
                 if b"(DEPRECATED)" in o[3]:
                     continue
                 if o[0]:
                     options.append(b'-%s' % o[0])
                 options.append(b'--%s' % o[1])
         ui.write(b"%s\n" % b"\n".join(options))
         return
 
     cmdlist, unused_allcmds = cmdutil.findpossible(cmd, table)
     if ui.verbose:
         cmdlist = [b' '.join(c[0]) for c in cmdlist.values()]
     ui.write(b"%s\n" % b"\n".join(sorted(cmdlist)))
 
 
 @command(
     b'diff',
     [
         (b'r', b'rev', [], _(b'revision (DEPRECATED)'), _(b'REV')),
         (b'', b'from', b'', _(b'revision to diff from'), _(b'REV1')),
         (b'', b'to', b'', _(b'revision to diff to'), _(b'REV2')),
         (b'c', b'change', b'', _(b'change made by revision'), _(b'REV')),
     ]
     + diffopts
     + diffopts2
     + walkopts
     + subrepoopts,
     _(b'[OPTION]... ([-c REV] | [--from REV1] [--to REV2]) [FILE]...'),
     helpcategory=command.CATEGORY_FILE_CONTENTS,
     helpbasic=True,
     inferrepo=True,
     intents={INTENT_READONLY},
 )
 def diff(ui, repo, *pats, **opts):
     """diff repository (or selected files)
 
     Show differences between revisions for the specified files.
 
     Differences between files are shown using the unified diff format.
 
     .. note::
 
        :hg:`diff` may generate unexpected results for merges, as it will
        default to comparing against the working directory's first
        parent changeset if no revisions are specified.  To diff against the
        conflict regions, you can use `--config diff.merge=yes`.
 
     By default, the working directory files are compared to its first parent. To
     see the differences from another revision, use --from. To see the difference
     to another revision, use --to. For example, :hg:`diff --from .^` will show
     the differences from the working copy's grandparent to the working copy,
     :hg:`diff --to .` will show the diff from the working copy to its parent
     (i.e. the reverse of the default), and :hg:`diff --from 1.0 --to 1.2` will
     show the diff between those two revisions.
 
     Alternatively you can specify -c/--change with a revision to see the changes
     in that changeset relative to its first parent (i.e. :hg:`diff -c 42` is
     equivalent to :hg:`diff --from 42^ --to 42`)
 
     Without the -a/--text option, diff will avoid generating diffs of
     files it detects as binary. With -a, diff will generate a diff
     anyway, probably with undesirable results.
 
     Use the -g/--git option to generate diffs in the git extended diff
     format. For more information, read :hg:`help diffs`.
 
     .. container:: verbose
 
       Examples:
 
       - compare a file in the current working directory to its parent::
 
           hg diff foo.c
 
       - compare two historical versions of a directory, with rename info::
 
           hg diff --git --from 1.0 --to 1.2 lib/
 
       - get change stats relative to the last change on some date::
 
           hg diff --stat --from "date('may 2')"
 
       - diff all newly-added files that contain a keyword::
 
           hg diff "set:added() and grep(GNU)"
 
       - compare a revision and its parents::
 
           hg diff -c 9353                  # compare against first parent
           hg diff --from 9353^ --to 9353   # same using revset syntax
           hg diff --from 9353^2 --to 9353  # compare against the second parent
 
     Returns 0 on success.
     """
 
     cmdutil.check_at_most_one_arg(opts, 'rev', 'change')
     opts = pycompat.byteskwargs(opts)
     revs = opts.get(b'rev')
     change = opts.get(b'change')
     from_rev = opts.get(b'from')
     to_rev = opts.get(b'to')
     stat = opts.get(b'stat')
     reverse = opts.get(b'reverse')
 
     cmdutil.check_incompatible_arguments(opts, b'from', [b'rev', b'change'])
     cmdutil.check_incompatible_arguments(opts, b'to', [b'rev', b'change'])
     if change:
         repo = scmutil.unhidehashlikerevs(repo, [change], b'nowarn')
         ctx2 = logcmdutil.revsingle(repo, change, None)
         ctx1 = logcmdutil.diff_parent(ctx2)
     elif from_rev or to_rev:
         repo = scmutil.unhidehashlikerevs(
             repo, [from_rev] + [to_rev], b'nowarn'
         )
         ctx1 = logcmdutil.revsingle(repo, from_rev, None)
         ctx2 = logcmdutil.revsingle(repo, to_rev, None)
     else:
         repo = scmutil.unhidehashlikerevs(repo, revs, b'nowarn')
         ctx1, ctx2 = logcmdutil.revpair(repo, revs)
 
     if reverse:
         ctxleft = ctx2
         ctxright = ctx1
     else:
         ctxleft = ctx1
         ctxright = ctx2
 
     diffopts = patch.diffallopts(ui, opts)
     m = scmutil.match(ctx2, pats, opts)
     m = repo.narrowmatch(m)
     ui.pager(b'diff')
     logcmdutil.diffordiffstat(
         ui,
         repo,
         diffopts,
         ctxleft,
         ctxright,
         m,
         stat=stat,
         listsubrepos=opts.get(b'subrepos'),
         root=opts.get(b'root'),
     )
 
 
 @command(
     b'export',
     [
         (
             b'B',
             b'bookmark',
             b'',
             _(b'export changes only reachable by given bookmark'),
             _(b'BOOKMARK'),
         ),
         (
             b'o',
             b'output',
             b'',
             _(b'print output to file with formatted name'),
             _(b'FORMAT'),
         ),
         (b'', b'switch-parent', None, _(b'diff against the second parent')),
         (b'r', b'rev', [], _(b'revisions to export'), _(b'REV')),
     ]
     + diffopts
     + formatteropts,
     _(b'[OPTION]... [-o OUTFILESPEC] [-r] [REV]...'),
     helpcategory=command.CATEGORY_IMPORT_EXPORT,
     helpbasic=True,
     intents={INTENT_READONLY},
 )
 def export(ui, repo, *changesets, **opts):
     """dump the header and diffs for one or more changesets
 
     Print the changeset header and diffs for one or more revisions.
     If no revision is given, the parent of the working directory is used.
 
     The information shown in the changeset header is: author, date,
     branch name (if non-default), changeset hash, parent(s) and commit
     comment.
 
     .. note::
 
        :hg:`export` may generate unexpected diff output for merge
        changesets, as it will compare the merge changeset against its
        first parent only.
 
     Output may be to a file, in which case the name of the file is
     given using a template string. See :hg:`help templates`. In addition
     to the common template keywords, the following formatting rules are
     supported:
 
     :``%%``: literal "%" character
     :``%H``: changeset hash (40 hexadecimal digits)
     :``%N``: number of patches being generated
     :``%R``: changeset revision number
     :``%b``: basename of the exporting repository
     :``%h``: short-form changeset hash (12 hexadecimal digits)
     :``%m``: first line of the commit message (only alphanumeric characters)
     :``%n``: zero-padded sequence number, starting at 1
     :``%r``: zero-padded changeset revision number
     :``\\``: literal "\\" character
 
     Without the -a/--text option, export will avoid generating diffs
     of files it detects as binary. With -a, export will generate a
     diff anyway, probably with undesirable results.
 
     With -B/--bookmark changesets reachable by the given bookmark are
     selected.
 
     Use the -g/--git option to generate diffs in the git extended diff
     format. See :hg:`help diffs` for more information.
 
     With the --switch-parent option, the diff will be against the
     second parent. It can be useful to review a merge.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions. See also :hg:`help templates`.
 
       :diff:    String. Diff content.
       :parents: List of strings. Parent nodes of the changeset.
 
       Examples:
 
       - use export and import to transplant a bugfix to the current
         branch::
 
           hg export -r 9353 | hg import -
 
       - export all the changesets between two revisions to a file with
         rename information::
 
           hg export --git -r 123:150 > changes.txt
 
       - split outgoing changes into a series of patches with
         descriptive names::
 
           hg export -r "outgoing()" -o "%n-%m.patch"
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     bookmark = opts.get(b'bookmark')
     changesets += tuple(opts.get(b'rev', []))
 
     cmdutil.check_at_most_one_arg(opts, b'rev', b'bookmark')
 
     if bookmark:
         if bookmark not in repo._bookmarks:
             raise error.InputError(_(b"bookmark '%s' not found") % bookmark)
 
         revs = scmutil.bookmarkrevs(repo, bookmark)
     else:
         if not changesets:
             changesets = [b'.']
 
         repo = scmutil.unhidehashlikerevs(repo, changesets, b'nowarn')
         revs = logcmdutil.revrange(repo, changesets)
 
     if not revs:
         raise error.InputError(_(b"export requires at least one changeset"))
     if len(revs) > 1:
         ui.note(_(b'exporting patches:\n'))
     else:
         ui.note(_(b'exporting patch:\n'))
 
     fntemplate = opts.get(b'output')
     if cmdutil.isstdiofilename(fntemplate):
         fntemplate = b''
 
     if fntemplate:
         fm = formatter.nullformatter(ui, b'export', opts)
     else:
         ui.pager(b'export')
         fm = ui.formatter(b'export', opts)
     with fm:
         cmdutil.export(
             repo,
             revs,
             fm,
             fntemplate=fntemplate,
             switch_parent=opts.get(b'switch_parent'),
             opts=patch.diffallopts(ui, opts),
         )
 
 
 @command(
     b'files',
     [
         (
             b'r',
             b'rev',
             b'',
             _(b'search the repository as it is in REV'),
             _(b'REV'),
         ),
         (
             b'0',
             b'print0',
             None,
             _(b'end filenames with NUL, for use with xargs'),
         ),
     ]
     + walkopts
     + formatteropts
     + subrepoopts,
     _(b'[OPTION]... [FILE]...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
     intents={INTENT_READONLY},
 )
 def files(ui, repo, *pats, **opts):
     """list tracked files
 
     Print files under Mercurial control in the working directory or
     specified revision for given files (excluding removed files).
     Files can be specified as filenames or filesets.
 
     If no files are given to match, this command prints the names
     of all files under Mercurial control.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions. See also :hg:`help templates`.
 
       :flags:   String. Character denoting file's symlink and executable bits.
       :path:    String. Repository-absolute path of the file.
       :size:    Integer. Size of the file in bytes.
 
       Examples:
 
       - list all files under the current directory::
 
           hg files .
 
       - shows sizes and flags for current revision::
 
           hg files -vr .
 
       - list all files named README::
 
           hg files -I "**/README"
 
       - list all binary files::
 
           hg files "set:binary()"
 
       - find files containing a regular expression::
 
           hg files "set:grep('bob')"
 
       - search tracked file contents with xargs and grep::
 
           hg files -0 | xargs -0 grep foo
 
     See :hg:`help patterns` and :hg:`help filesets` for more information
     on specifying file patterns.
 
     Returns 0 if a match is found, 1 otherwise.
 
     """
 
     opts = pycompat.byteskwargs(opts)
     rev = opts.get(b'rev')
     if rev:
         repo = scmutil.unhidehashlikerevs(repo, [rev], b'nowarn')
     ctx = logcmdutil.revsingle(repo, rev, None)
 
     end = b'\n'
     if opts.get(b'print0'):
         end = b'\0'
     fmt = b'%s' + end
 
     m = scmutil.match(ctx, pats, opts)
     ui.pager(b'files')
     uipathfn = scmutil.getuipathfn(ctx.repo(), legacyrelativevalue=True)
     with ui.formatter(b'files', opts) as fm:
         return cmdutil.files(
             ui, ctx, m, uipathfn, fm, fmt, opts.get(b'subrepos')
         )
 
 
 @command(
     b'forget',
     [
         (b'i', b'interactive', None, _(b'use interactive mode')),
     ]
     + walkopts
     + dryrunopts,
     _(b'[OPTION]... FILE...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
     helpbasic=True,
     inferrepo=True,
 )
 def forget(ui, repo, *pats, **opts):
     """forget the specified files on the next commit
 
     Mark the specified files so they will no longer be tracked
     after the next commit.
 
     This only removes files from the current branch, not from the
     entire project history, and it does not delete them from the
     working directory.
 
     To delete the file from the working directory, see :hg:`remove`.
 
     To undo a forget before the next commit, see :hg:`add`.
 
     .. container:: verbose
 
       Examples:
 
       - forget newly-added binary files::
 
           hg forget "set:added() and binary()"
 
       - forget files that would be excluded by .hgignore::
 
           hg forget "set:hgignore()"
 
     Returns 0 on success.
     """
 
     opts = pycompat.byteskwargs(opts)
     if not pats:
         raise error.InputError(_(b'no files specified'))
 
     with repo.wlock(), repo.dirstate.changing_files(repo):
         m = scmutil.match(repo[None], pats, opts)
         dryrun, interactive = opts.get(b'dry_run'), opts.get(b'interactive')
         uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
         rejected = cmdutil.forget(
             ui,
             repo,
             m,
             prefix=b"",
             uipathfn=uipathfn,
             explicitonly=False,
             dryrun=dryrun,
             interactive=interactive,
         )[0]
     return rejected and 1 or 0
 
 
 @command(
     b'graft',
     [
         (b'r', b'rev', [], _(b'revisions to graft'), _(b'REV')),
         (
             b'',
             b'base',
             b'',
             _(b'base revision when doing the graft merge (ADVANCED)'),
             _(b'REV'),
         ),
         (b'c', b'continue', False, _(b'resume interrupted graft')),
         (b'', b'stop', False, _(b'stop interrupted graft')),
         (b'', b'abort', False, _(b'abort interrupted graft')),
         (b'e', b'edit', False, _(b'invoke editor on commit messages')),
         (b'', b'log', None, _(b'append graft info to log message')),
         (
             b'',
             b'no-commit',
             None,
             _(b"don't commit, just apply the changes in working directory"),
         ),
         (b'f', b'force', False, _(b'force graft')),
         (
             b'D',
             b'currentdate',
             False,
             _(b'record the current date as commit date'),
         ),
         (
             b'U',
             b'currentuser',
             False,
             _(b'record the current user as committer'),
         ),
     ]
     + commitopts2
     + mergetoolopts
     + dryrunopts,
     _(b'[OPTION]... [-r REV]... REV...'),
     helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
 )
 def graft(ui, repo, *revs, **opts):
     """copy changes from other branches onto the current branch
 
     This command uses Mercurial's merge logic to copy individual
     changes from other branches without merging branches in the
     history graph. This is sometimes known as 'backporting' or
     'cherry-picking'. By default, graft will copy user, date, and
     description from the source changesets.
 
     Changesets that are ancestors of the current revision, that have
     already been grafted, or that are merges will be skipped.
 
     If --log is specified, log messages will have a comment appended
     of the form::
 
       (grafted from CHANGESETHASH)
 
     If --force is specified, revisions will be grafted even if they
     are already ancestors of, or have been grafted to, the destination.
     This is useful when the revisions have since been backed out.
 
     If a graft merge results in conflicts, the graft process is
     interrupted so that the current merge can be manually resolved.
     Once all conflicts are addressed, the graft process can be
     continued with the -c/--continue option.
 
     The -c/--continue option reapplies all the earlier options.
 
     .. container:: verbose
 
       The --base option exposes more of how graft internally uses merge with a
       custom base revision. --base can be used to specify another ancestor than
       the first and only parent.
 
       The command::
 
         hg graft -r 345 --base 234
 
       is thus pretty much the same as::
 
         hg diff --from 234 --to 345 | hg import
 
       but using merge to resolve conflicts and track moved files.
 
       The result of a merge can thus be backported as a single commit by
       specifying one of the merge parents as base, and thus effectively
       grafting the changes from the other side.
 
       It is also possible to collapse multiple changesets and clean up history
       by specifying another ancestor as base, much like rebase --collapse
       --keep.
 
       The commit message can be tweaked after the fact using commit --amend .
 
       For using non-ancestors as the base to backout changes, see the backout
       command and the hidden --parent option.
 
     .. container:: verbose
 
       Examples:
 
       - copy a single change to the stable branch and edit its description::
 
           hg update stable
           hg graft --edit 9393
 
       - graft a range of changesets with one exception, updating dates::
 
           hg graft -D "2085::2093 and not 2091"
 
       - continue a graft after resolving conflicts::
 
           hg graft -c
 
       - show the source of a grafted changeset::
 
           hg log --debug -r .
 
       - show revisions sorted by date::
 
           hg log -r "sort(all(), date)"
 
       - backport the result of a merge as a single commit::
 
           hg graft -r 123 --base 123^
 
       - land a feature branch as one changeset::
 
           hg up -cr default
           hg graft -r featureX --base "ancestor('featureX', 'default')"
 
     See :hg:`help revisions` for more about specifying revisions.
 
     Returns 0 on successful completion, 1 if there are unresolved files.
     """
     with repo.wlock():
         return _dograft(ui, repo, *revs, **opts)
 
 
 def _dograft(ui, repo, *revs, **opts):
     if revs and opts.get('rev'):
         ui.warn(
             _(
                 b'warning: inconsistent use of --rev might give unexpected '
                 b'revision ordering!\n'
             )
         )
 
     revs = list(revs)
     revs.extend(opts.get('rev'))
     # a dict of data to be stored in state file
     statedata = {}
     # list of new nodes created by ongoing graft
     statedata[b'newnodes'] = []
 
     cmdutil.resolve_commit_options(ui, opts)
 
     editor = cmdutil.getcommiteditor(editform=b'graft', **opts)
 
     cmdutil.check_at_most_one_arg(opts, 'abort', 'stop', 'continue')
 
     cont = False
     if opts.get('no_commit'):
         cmdutil.check_incompatible_arguments(
             opts,
             'no_commit',
             ['edit', 'currentuser', 'currentdate', 'log'],
         )
 
     graftstate = statemod.cmdstate(repo, b'graftstate')
 
     if opts.get('stop'):
         cmdutil.check_incompatible_arguments(
             opts,
             'stop',
             [
                 'edit',
                 'log',
                 'user',
                 'date',
                 'currentdate',
                 'currentuser',
                 'rev',
             ],
         )
         return _stopgraft(ui, repo, graftstate)
     elif opts.get('abort'):
         cmdutil.check_incompatible_arguments(
             opts,
             'abort',
             [
                 'edit',
                 'log',
                 'user',
                 'date',
                 'currentdate',
                 'currentuser',
                 'rev',
             ],
         )
         return cmdutil.abortgraft(ui, repo, graftstate)
     elif opts.get('continue'):
         cont = True
         if revs:
             raise error.InputError(_(b"can't specify --continue and revisions"))
         # read in unfinished revisions
         if graftstate.exists():
             statedata = cmdutil.readgraftstate(repo, graftstate)
             if statedata.get(b'date'):
                 opts['date'] = statedata[b'date']
             if statedata.get(b'user'):
                 opts['user'] = statedata[b'user']
             if statedata.get(b'log'):
                 opts['log'] = True
             if statedata.get(b'no_commit'):
                 opts['no_commit'] = statedata.get(b'no_commit')
             if statedata.get(b'base'):
                 opts['base'] = statedata.get(b'base')
             nodes = statedata[b'nodes']
             revs = [repo[node].rev() for node in nodes]
         else:
             cmdutil.wrongtooltocontinue(repo, _(b'graft'))
     else:
         if not revs:
             raise error.InputError(_(b'no revisions specified'))
         cmdutil.checkunfinished(repo)
         cmdutil.bailifchanged(repo)
         revs = logcmdutil.revrange(repo, revs)
 
     skipped = set()
     basectx = None
     if opts.get('base'):
         basectx = logcmdutil.revsingle(repo, opts['base'], None)
     if basectx is None:
         # check for merges
         for rev in repo.revs(b'%ld and merge()', revs):
             ui.warn(_(b'skipping ungraftable merge revision %d\n') % rev)
             skipped.add(rev)
     revs = [r for r in revs if r not in skipped]
     if not revs:
         return -1
     if basectx is not None and len(revs) != 1:
         raise error.InputError(_(b'only one revision allowed with --base '))
 
     # Don't check in the --continue case, in effect retaining --force across
     # --continues. That's because without --force, any revisions we decided to
     # skip would have been filtered out here, so they wouldn't have made their
     # way to the graftstate. With --force, any revisions we would have otherwise
     # skipped would not have been filtered out, and if they hadn't been applied
     # already, they'd have been in the graftstate.
     if not (cont or opts.get('force')) and basectx is None:
         # check for ancestors of dest branch
         ancestors = repo.revs(b'%ld & (::.)', revs)
         for rev in ancestors:
             ui.warn(_(b'skipping ancestor revision %d:%s\n') % (rev, repo[rev]))
 
         revs = [r for r in revs if r not in ancestors]
 
         if not revs:
             return -1
 
         # analyze revs for earlier grafts
         ids = {}
         for ctx in repo.set(b"%ld", revs):
             ids[ctx.hex()] = ctx.rev()
             n = ctx.extra().get(b'source')
             if n:
                 ids[n] = ctx.rev()
 
         # check ancestors for earlier grafts
         ui.debug(b'scanning for duplicate grafts\n')
 
         # The only changesets we can be sure doesn't contain grafts of any
         # revs, are the ones that are common ancestors of *all* revs:
         for rev in repo.revs(b'only(%d,ancestor(%ld))', repo[b'.'].rev(), revs):
             ctx = repo[rev]
             n = ctx.extra().get(b'source')
             if n in ids:
                 try:
                     r = repo[n].rev()
                 except error.RepoLookupError:
                     r = None
                 if r in revs:
                     ui.warn(
                         _(
                             b'skipping revision %d:%s '
                             b'(already grafted to %d:%s)\n'
                         )
                         % (r, repo[r], rev, ctx)
                     )
                     revs.remove(r)
                 elif ids[n] in revs:
                     if r is None:
                         ui.warn(
                             _(
                                 b'skipping already grafted revision %d:%s '
                                 b'(%d:%s also has unknown origin %s)\n'
                             )
                             % (ids[n], repo[ids[n]], rev, ctx, n[:12])
                         )
                     else:
                         ui.warn(
                             _(
                                 b'skipping already grafted revision %d:%s '
                                 b'(%d:%s also has origin %d:%s)\n'
                             )
                             % (ids[n], repo[ids[n]], rev, ctx, r, n[:12])
                         )
                     revs.remove(ids[n])
             elif ctx.hex() in ids:
                 r = ids[ctx.hex()]
                 if r in revs:
                     ui.warn(
                         _(
                             b'skipping already grafted revision %d:%s '
                             b'(was grafted from %d:%s)\n'
                         )
                         % (r, repo[r], rev, ctx)
                     )
                     revs.remove(r)
         if not revs:
             return -1
 
     if opts.get('no_commit'):
         statedata[b'no_commit'] = True
     if opts.get('base'):
         statedata[b'base'] = opts['base']
     for pos, ctx in enumerate(repo.set(b"%ld", revs)):
         desc = b'%d:%s "%s"' % (
             ctx.rev(),
             ctx,
             ctx.description().split(b'\n', 1)[0],
         )
         names = repo.nodetags(ctx.node()) + repo.nodebookmarks(ctx.node())
         if names:
             desc += b' (%s)' % b' '.join(names)
         ui.status(_(b'grafting %s\n') % desc)
         if opts.get('dry_run'):
             continue
 
         source = ctx.extra().get(b'source')
         extra = {}
         if source:
             extra[b'source'] = source
             extra[b'intermediate-source'] = ctx.hex()
         else:
             extra[b'source'] = ctx.hex()
         user = ctx.user()
         if opts.get('user'):
             user = opts['user']
             statedata[b'user'] = user
         date = ctx.date()
         if opts.get('date'):
             date = opts['date']
             statedata[b'date'] = date
         message = ctx.description()
         if opts.get('log'):
             message += b'\n(grafted from %s)' % ctx.hex()
             statedata[b'log'] = True
 
         # we don't merge the first commit when continuing
         if not cont:
             # perform the graft merge with p1(rev) as 'ancestor'
             overrides = {(b'ui', b'forcemerge'): opts.get('tool', b'')}
             base = ctx.p1() if basectx is None else basectx
             with ui.configoverride(overrides, b'graft'):
                 stats = mergemod.graft(
                     repo, ctx, base, [b'local', b'graft', b'parent of graft']
                 )
             # report any conflicts
             if stats.unresolvedcount > 0:
                 # write out state for --continue
                 nodes = [repo[rev].hex() for rev in revs[pos:]]
                 statedata[b'nodes'] = nodes
                 stateversion = 1
                 graftstate.save(stateversion, statedata)
                 ui.error(_(b"abort: unresolved conflicts, can't continue\n"))
                 ui.error(_(b"(use 'hg resolve' and 'hg graft --continue')\n"))
                 return 1
         else:
             cont = False
 
         # commit if --no-commit is false
         if not opts.get('no_commit'):
             node = repo.commit(
                 text=message, user=user, date=date, extra=extra, editor=editor
             )
             if node is None:
                 ui.warn(
                     _(b'note: graft of %d:%s created no changes to commit\n')
                     % (ctx.rev(), ctx)
                 )
             # checking that newnodes exist because old state files won't have it
             elif statedata.get(b'newnodes') is not None:
                 nn = statedata[b'newnodes']
                 assert isinstance(nn, list)  # list of bytes
                 nn.append(node)
 
     # remove state when we complete successfully
     if not opts.get('dry_run'):
         graftstate.delete()
 
     return 0
 
 
 def _stopgraft(ui, repo, graftstate):
     """stop the interrupted graft"""
     if not graftstate.exists():
         raise error.StateError(_(b"no interrupted graft found"))
     pctx = repo[b'.']
     mergemod.clean_update(pctx)
     graftstate.delete()
     ui.status(_(b"stopped the interrupted graft\n"))
     ui.status(_(b"working directory is now at %s\n") % pctx.hex()[:12])
     return 0
 
 
 statemod.addunfinished(
     b'graft',
     fname=b'graftstate',
     clearable=True,
     stopflag=True,
     continueflag=True,
     abortfunc=cmdutil.hgabortgraft,
     cmdhint=_(b"use 'hg graft --continue' or 'hg graft --stop' to stop"),
 )
 
 
 @command(
     b'grep',
     [
         (b'0', b'print0', None, _(b'end fields with NUL')),
         (b'', b'all', None, _(b'an alias to --diff (DEPRECATED)')),
         (
             b'',
             b'diff',
             None,
             _(
                 b'search revision differences for when the pattern was added '
                 b'or removed'
             ),
         ),
         (b'a', b'text', None, _(b'treat all files as text')),
         (
             b'f',
             b'follow',
             None,
             _(
                 b'follow changeset history,'
                 b' or file history across copies and renames'
             ),
         ),
         (b'i', b'ignore-case', None, _(b'ignore case when matching')),
         (
             b'l',
             b'files-with-matches',
             None,
             _(b'print only filenames and revisions that match'),
         ),
         (b'n', b'line-number', None, _(b'print matching line numbers')),
         (
             b'r',
             b'rev',
             [],
             _(b'search files changed within revision range'),
             _(b'REV'),
         ),
         (
             b'',
             b'all-files',
             None,
             _(
                 b'include all files in the changeset while grepping (DEPRECATED)'
             ),
         ),
         (b'u', b'user', None, _(b'list the author (long with -v)')),
         (b'd', b'date', None, _(b'list the date (short with -q)')),
     ]
     + formatteropts
     + walkopts,
     _(b'[--diff] [OPTION]... PATTERN [FILE]...'),
     helpcategory=command.CATEGORY_FILE_CONTENTS,
     inferrepo=True,
     intents={INTENT_READONLY},
 )
 def grep(ui, repo, pattern, *pats, **opts):
     """search for a pattern in specified files
 
     Search the working directory or revision history for a regular
     expression in the specified files for the entire repository.
 
     By default, grep searches the repository files in the working
     directory and prints the files where it finds a match. To specify
     historical revisions instead of the working directory, use the
     --rev flag.
 
     To search instead historical revision differences that contains a
     change in match status ("-" for a match that becomes a non-match,
     or "+" for a non-match that becomes a match), use the --diff flag.
 
     PATTERN can be any Python (roughly Perl-compatible) regular
     expression.
 
     If no FILEs are specified and the --rev flag isn't supplied, all
     files in the working directory are searched. When using the --rev
     flag and specifying FILEs, use the --follow argument to also
     follow the specified FILEs across renames and copies.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions. See also :hg:`help templates`.
 
       :change:  String. Character denoting insertion ``+`` or removal ``-``.
                 Available if ``--diff`` is specified.
       :lineno:  Integer. Line number of the match.
       :path:    String. Repository-absolute path of the file.
       :texts:   List of text chunks.
 
       And each entry of ``{texts}`` provides the following sub-keywords.
 
       :matched: Boolean. True if the chunk matches the specified pattern.
       :text:    String. Chunk content.
 
       See :hg:`help templates.operators` for the list expansion syntax.
 
     Returns 0 if a match is found, 1 otherwise.
 
     """
     cmdutil.check_incompatible_arguments(opts, 'all_files', ['all', 'diff'])
 
     diff = opts.get('all') or opts.get('diff')
     follow = opts.get('follow')
     if opts.get('all_files') is None and not diff:
         opts['all_files'] = True
     plaingrep = (
         opts.get('all_files') and not opts.get('rev') and not opts.get('follow')
     )
     all_files = opts.get('all_files')
     if plaingrep:
         opts['rev'] = [b'wdir()']
 
     reflags = re.M
     if opts.get('ignore_case'):
         reflags |= re.I
     try:
         regexp = util.re.compile(pattern, reflags)
     except re.error as inst:
         ui.warn(
             _(b"grep: invalid match pattern: %s\n")
             % stringutil.forcebytestr(inst)
         )
         return 1
     sep, eol = b':', b'\n'
     if opts.get('print0'):
         sep = eol = b'\0'
 
     searcher = grepmod.grepsearcher(
         ui, repo, regexp, all_files=all_files, diff=diff, follow=follow
     )
 
     getfile = searcher._getfile
 
     uipathfn = scmutil.getuipathfn(repo)
 
     def display(fm, fn, ctx, pstates, states):
         rev = scmutil.intrev(ctx)
         if fm.isplain():
             formatuser = ui.shortuser
         else:
             formatuser = pycompat.bytestr
         if ui.quiet:
             datefmt = b'%Y-%m-%d'
         else:
             datefmt = b'%a %b %d %H:%M:%S %Y %1%2'
         found = False
 
         @util.cachefunc
         def binary():
             flog = getfile(fn)
             try:
                 return stringutil.binary(flog.read(ctx.filenode(fn)))
             except error.WdirUnsupported:
                 return ctx[fn].isbinary()
 
         fieldnamemap = {b'linenumber': b'lineno'}
         if diff:
             iter = grepmod.difflinestates(pstates, states)
         else:
             iter = [(b'', l) for l in states]
         for change, l in iter:
             fm.startitem()
             fm.context(ctx=ctx)
             fm.data(node=fm.hexfunc(scmutil.binnode(ctx)), path=fn)
             fm.plain(uipathfn(fn), label=b'grep.filename')
 
             cols = [
                 (b'rev', b'%d', rev, not plaingrep, b''),
                 (
                     b'linenumber',
                     b'%d',
                     l.linenum,
                     opts.get('line_number'),
                     b'',
                 ),
             ]
             if diff:
                 cols.append(
                     (
                         b'change',
                         b'%s',
                         change,
                         True,
                         b'grep.inserted '
                         if change == b'+'
                         else b'grep.deleted ',
                     )
                 )
             cols.extend(
                 [
                     (
                         b'user',
                         b'%s',
                         formatuser(ctx.user()),
                         opts.get('user'),
                         b'',
                     ),
                     (
                         b'date',
                         b'%s',
                         fm.formatdate(ctx.date(), datefmt),
                         opts.get('date'),
                         b'',
                     ),
                 ]
             )
             for name, fmt, data, cond, extra_label in cols:
                 if cond:
                     fm.plain(sep, label=b'grep.sep')
                 field = fieldnamemap.get(name, name)
                 label = extra_label + (b'grep.%s' % name)
                 fm.condwrite(cond, field, fmt, data, label=label)
             if not opts.get('files_with_matches'):
                 fm.plain(sep, label=b'grep.sep')
                 if not opts.get('text') and binary():
                     fm.plain(_(b" Binary file matches"))
                 else:
                     displaymatches(fm.nested(b'texts', tmpl=b'{text}'), l)
             fm.plain(eol)
             found = True
             if opts.get('files_with_matches'):
                 break
         return found
 
     def displaymatches(fm, l):
         p = 0
         for s, e in l.findpos(regexp):
             if p < s:
                 fm.startitem()
                 fm.write(b'text', b'%s', l.line[p:s])
                 fm.data(matched=False)
             fm.startitem()
             fm.write(b'text', b'%s', l.line[s:e], label=b'grep.match')
             fm.data(matched=True)
             p = e
         if p < len(l.line):
             fm.startitem()
             fm.write(b'text', b'%s', l.line[p:])
             fm.data(matched=False)
         fm.end()
 
     found = False
 
     wopts = logcmdutil.walkopts(
         pats=pats,
         opts=opts,
         revspec=opts['rev'],
         include_pats=opts['include'],
         exclude_pats=opts['exclude'],
         follow=follow,
         force_changelog_traversal=all_files,
         filter_revisions_by_pats=not all_files,
     )
     revs, makefilematcher = logcmdutil.makewalker(repo, wopts)
 
     ui.pager(b'grep')
     fm = ui.formatter(b'grep', pycompat.byteskwargs(opts))
     for fn, ctx, pstates, states in searcher.searchfiles(revs, makefilematcher):
         r = display(fm, fn, ctx, pstates, states)
         found = found or r
         if r and not diff and not all_files:
             searcher.skipfile(fn, ctx.rev())
     fm.end()
 
     return not found
 
 
 @command(
     b'heads',
     [
         (
             b'r',
             b'rev',
             b'',
             _(b'show only heads which are descendants of STARTREV'),
             _(b'STARTREV'),
         ),
         (b't', b'topo', False, _(b'show topological heads only')),
         (
             b'a',
             b'active',
             False,
             _(b'show active branchheads only (DEPRECATED)'),
         ),
         (b'c', b'closed', False, _(b'show normal and closed branch heads')),
     ]
     + templateopts,
     _(b'[-ct] [-r STARTREV] [REV]...'),
     helpcategory=command.CATEGORY_CHANGE_NAVIGATION,
     intents={INTENT_READONLY},
 )
 def heads(ui, repo, *branchrevs, **opts):
     """show branch heads
 
     With no arguments, show all open branch heads in the repository.
     Branch heads are changesets that have no descendants on the
     same branch. They are where development generally takes place and
     are the usual targets for update and merge operations.
 
     If one or more REVs are given, only open branch heads on the
     branches associated with the specified changesets are shown. This
     means that you can use :hg:`heads .` to see the heads on the
     currently checked-out branch.
 
     If -c/--closed is specified, also show branch heads marked closed
     (see :hg:`commit --close-branch`).
 
     If STARTREV is specified, only those heads that are descendants of
     STARTREV will be displayed.
 
     If -t/--topo is specified, named branch mechanics will be ignored and only
     topological heads (changesets with no children) will be shown.
 
     Returns 0 if matching heads are found, 1 if not.
     """
 
     opts = pycompat.byteskwargs(opts)
     start = None
     rev = opts.get(b'rev')
     if rev:
         repo = scmutil.unhidehashlikerevs(repo, [rev], b'nowarn')
         start = logcmdutil.revsingle(repo, rev, None).node()
 
     if opts.get(b'topo'):
         heads = [repo[h] for h in repo.heads(start)]
     else:
         heads = []
         for branch in repo.branchmap():
             heads += repo.branchheads(branch, start, opts.get(b'closed'))
         heads = [repo[h] for h in heads]
 
     if branchrevs:
         branches = {
             repo[r].branch() for r in logcmdutil.revrange(repo, branchrevs)
         }
         heads = [h for h in heads if h.branch() in branches]
 
     if opts.get(b'active') and branchrevs:
         dagheads = repo.heads(start)
         heads = [h for h in heads if h.node() in dagheads]
 
     if branchrevs:
         haveheads = {h.branch() for h in heads}
         if branches - haveheads:
             headless = b', '.join(b for b in branches - haveheads)
             msg = _(b'no open branch heads found on branches %s')
             if opts.get(b'rev'):
                 msg += _(b' (started at %s)') % opts[b'rev']
             ui.warn((msg + b'\n') % headless)
 
     if not heads:
         return 1
 
     ui.pager(b'heads')
     heads = sorted(heads, key=lambda x: -(x.rev()))
     displayer = logcmdutil.changesetdisplayer(ui, repo, opts)
     for ctx in heads:
         displayer.show(ctx)
     displayer.close()
 
 
 @command(
     b'help',
     [
         (b'e', b'extension', None, _(b'show only help for extensions')),
         (b'c', b'command', None, _(b'show only help for commands')),
         (b'k', b'keyword', None, _(b'show topics matching keyword')),
         (
             b's',
             b'system',
             [],
             _(b'show help for specific platform(s)'),
             _(b'PLATFORM'),
         ),
     ],
     _(b'[-eck] [-s PLATFORM] [TOPIC]'),
     helpcategory=command.CATEGORY_HELP,
     norepo=True,
     intents={INTENT_READONLY},
 )
 def help_(ui, name=None, **opts):
     """show help for a given topic or a help overview
 
     With no arguments, print a list of commands with short help messages.
 
     Given a topic, extension, or command name, print help for that
     topic.
 
     Returns 0 if successful.
     """
 
     keep = opts.get('system') or []
     if len(keep) == 0:
         if pycompat.sysplatform.startswith(b'win'):
             keep.append(b'windows')
         elif pycompat.sysplatform == b'OpenVMS':
             keep.append(b'vms')
         elif pycompat.sysplatform == b'plan9':
             keep.append(b'plan9')
         else:
             keep.append(b'unix')
             keep.append(pycompat.sysplatform.lower())
     if ui.verbose:
         keep.append(b'verbose')
 
     commands = sys.modules[__name__]
     formatted = help.formattedhelp(ui, commands, name, keep=keep, **opts)
     ui.pager(b'help')
     ui.write(formatted)
 
 
 @command(
     b'identify|id',
     [
         (b'r', b'rev', b'', _(b'identify the specified revision'), _(b'REV')),
         (b'n', b'num', None, _(b'show local revision number')),
         (b'i', b'id', None, _(b'show global revision id')),
         (b'b', b'branch', None, _(b'show branch')),
         (b't', b'tags', None, _(b'show tags')),
         (b'B', b'bookmarks', None, _(b'show bookmarks')),
     ]
     + remoteopts
     + formatteropts,
     _(b'[-nibtB] [-r REV] [SOURCE]'),
     helpcategory=command.CATEGORY_CHANGE_NAVIGATION,
     optionalrepo=True,
     intents={INTENT_READONLY},
 )
 def identify(
     ui,
     repo,
     source=None,
     rev=None,
     num=None,
     id=None,
     branch=None,
     tags=None,
     bookmarks=None,
     **opts
 ):
     """identify the working directory or specified revision
 
     Print a summary identifying the repository state at REV using one or
     two parent hash identifiers, followed by a "+" if the working
     directory has uncommitted changes, the branch name (if not default),
     a list of tags, and a list of bookmarks.
 
     When REV is not given, print a summary of the current state of the
     repository including the working directory. Specify -r. to get information
     of the working directory parent without scanning uncommitted changes.
 
     Specifying a path to a repository root or Mercurial bundle will
     cause lookup to operate on that repository/bundle.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions. See also :hg:`help templates`.
 
       :dirty:   String. Character ``+`` denoting if the working directory has
                 uncommitted changes.
       :id:      String. One or two nodes, optionally followed by ``+``.
       :parents: List of strings. Parent nodes of the changeset.
 
       Examples:
 
       - generate a build identifier for the working directory::
 
           hg id --id > build-id.dat
 
       - find the revision corresponding to a tag::
 
           hg id -n -r 1.3
 
       - check the most recent revision of a remote repository::
 
           hg id -r tip https://www.mercurial-scm.org/repo/hg/
 
     See :hg:`log` for generating more information about specific revisions,
     including full hash identifiers.
 
     Returns 0 if successful.
     """
 
     opts = pycompat.byteskwargs(opts)
     if not repo and not source:
         raise error.InputError(
             _(b"there is no Mercurial repository here (.hg not found)")
         )
 
     default = not (num or id or branch or tags or bookmarks)
     output = []
     revs = []
 
     peer = None
     try:
         if source:
             path = urlutil.get_unique_pull_path_obj(b'identify', ui, source)
             # only pass ui when no repo
             peer = hg.peer(repo or ui, opts, path)
             repo = peer.local()
             branches = (path.branch, [])
             revs, checkout = hg.addbranchrevs(repo, peer, branches, None)
 
         fm = ui.formatter(b'identify', opts)
         fm.startitem()
 
         if not repo:
             if num or branch or tags:
                 raise error.InputError(
                     _(b"can't query remote revision number, branch, or tags")
                 )
             if not rev and revs:
                 rev = revs[0]
             if not rev:
                 rev = b"tip"
 
             remoterev = peer.lookup(rev)
             hexrev = fm.hexfunc(remoterev)
             if default or id:
                 output = [hexrev]
             fm.data(id=hexrev)
 
             @util.cachefunc
             def getbms():
                 bms = []
 
                 if b'bookmarks' in peer.listkeys(b'namespaces'):
                     hexremoterev = hex(remoterev)
                     bms = [
                         bm
                         for bm, bmr in peer.listkeys(b'bookmarks').items()
                         if bmr == hexremoterev
                     ]
 
                 return sorted(bms)
 
             if fm.isplain():
                 if bookmarks:
                     output.extend(getbms())
                 elif default and not ui.quiet:
                     # multiple bookmarks for a single parent separated by '/'
                     bm = b'/'.join(getbms())
                     if bm:
                         output.append(bm)
             else:
                 fm.data(node=hex(remoterev))
                 if bookmarks or b'bookmarks' in fm.datahint():
                     fm.data(bookmarks=fm.formatlist(getbms(), name=b'bookmark'))
         else:
             if rev:
                 repo = scmutil.unhidehashlikerevs(repo, [rev], b'nowarn')
             ctx = logcmdutil.revsingle(repo, rev, None)
 
             if ctx.rev() is None:
                 ctx = repo[None]
                 parents = ctx.parents()
                 taglist = []
                 for p in parents:
                     taglist.extend(p.tags())
 
                 dirty = b""
                 if ctx.dirty(missing=True, merge=False, branch=False):
                     dirty = b'+'
                 fm.data(dirty=dirty)
 
                 hexoutput = [fm.hexfunc(p.node()) for p in parents]
                 if default or id:
                     output = [b"%s%s" % (b'+'.join(hexoutput), dirty)]
                 fm.data(id=b"%s%s" % (b'+'.join(hexoutput), dirty))
 
                 if num:
                     numoutput = [b"%d" % p.rev() for p in parents]
                     output.append(b"%s%s" % (b'+'.join(numoutput), dirty))
 
                 fm.data(
                     parents=fm.formatlist(
                         [fm.hexfunc(p.node()) for p in parents], name=b'node'
                     )
                 )
             else:
                 hexoutput = fm.hexfunc(ctx.node())
                 if default or id:
                     output = [hexoutput]
                 fm.data(id=hexoutput)
 
                 if num:
                     output.append(pycompat.bytestr(ctx.rev()))
                 taglist = ctx.tags()
 
             if default and not ui.quiet:
                 b = ctx.branch()
                 if b != b'default':
                     output.append(b"(%s)" % b)
 
                 # multiple tags for a single parent separated by '/'
                 t = b'/'.join(taglist)
                 if t:
                     output.append(t)
 
                 # multiple bookmarks for a single parent separated by '/'
                 bm = b'/'.join(ctx.bookmarks())
                 if bm:
                     output.append(bm)
             else:
                 if branch:
                     output.append(ctx.branch())
 
                 if tags:
                     output.extend(taglist)
 
                 if bookmarks:
                     output.extend(ctx.bookmarks())
 
             fm.data(node=ctx.hex())
             fm.data(branch=ctx.branch())
             fm.data(tags=fm.formatlist(taglist, name=b'tag', sep=b':'))
             fm.data(bookmarks=fm.formatlist(ctx.bookmarks(), name=b'bookmark'))
             fm.context(ctx=ctx)
 
         fm.plain(b"%s\n" % b' '.join(output))
         fm.end()
     finally:
         if peer:
             peer.close()
 
 
 @command(
     b'import|patch',
     [
         (
             b'p',
             b'strip',
             1,
             _(
                 b'directory strip option for patch. This has the same '
                 b'meaning as the corresponding patch option'
             ),
             _(b'NUM'),
         ),
         (b'b', b'base', b'', _(b'base path (DEPRECATED)'), _(b'PATH')),
         (b'', b'secret', None, _(b'use the secret phase for committing')),
         (b'e', b'edit', False, _(b'invoke editor on commit messages')),
         (
             b'f',
             b'force',
             None,
             _(b'skip check for outstanding uncommitted changes (DEPRECATED)'),
         ),
         (
             b'',
             b'no-commit',
             None,
             _(b"don't commit, just update the working directory"),
         ),
         (
             b'',
             b'bypass',
             None,
             _(b"apply patch without touching the working directory"),
         ),
         (b'', b'partial', None, _(b'commit even if some hunks fail')),
         (b'', b'exact', None, _(b'abort if patch would apply lossily')),
         (b'', b'prefix', b'', _(b'apply patch to subdirectory'), _(b'DIR')),
         (
             b'',
             b'import-branch',
             None,
             _(b'use any branch information in patch (implied by --exact)'),
         ),
     ]
     + commitopts
     + commitopts2
     + similarityopts,
     _(b'[OPTION]... PATCH...'),
     helpcategory=command.CATEGORY_IMPORT_EXPORT,
 )
 def import_(ui, repo, patch1=None, *patches, **opts):
     """import an ordered set of patches
 
     Import a list of patches and commit them individually (unless
     --no-commit is specified).
 
     To read a patch from standard input (stdin), use "-" as the patch
     name. If a URL is specified, the patch will be downloaded from
     there.
 
     Import first applies changes to the working directory (unless
     --bypass is specified), import will abort if there are outstanding
     changes.
 
     Use --bypass to apply and commit patches directly to the
     repository, without affecting the working directory. Without
     --exact, patches will be applied on top of the working directory
     parent revision.
 
     You can import a patch straight from a mail message. Even patches
     as attachments work (to use the body part, it must have type
     text/plain or text/x-patch). From and Subject headers of email
     message are used as default committer and commit message. All
     text/plain body parts before first diff are added to the commit
     message.
 
     If the imported patch was generated by :hg:`export`, user and
     description from patch override values from message headers and
     body. Values given on command line with -m/--message and -u/--user
     override these.
 
     If --exact is specified, import will set the working directory to
     the parent of each patch before applying it, and will abort if the
     resulting changeset has a different ID than the one recorded in
     the patch. This will guard against various ways that portable
     patch formats and mail systems might fail to transfer Mercurial
     data or metadata. See :hg:`bundle` for lossless transmission.
 
     Use --partial to ensure a changeset will be created from the patch
     even if some hunks fail to apply. Hunks that fail to apply will be
     written to a <target-file>.rej file. Conflicts can then be resolved
     by hand before :hg:`commit --amend` is run to update the created
     changeset. This flag exists to let people import patches that
     partially apply without losing the associated metadata (author,
     date, description, ...).
 
     .. note::
 
        When no hunks apply cleanly, :hg:`import --partial` will create
        an empty changeset, importing only the patch metadata.
 
     With -s/--similarity, hg will attempt to discover renames and
     copies in the patch in the same way as :hg:`addremove`.
 
     It is possible to use external patch programs to perform the patch
     by setting the ``ui.patch`` configuration option. For the default
     internal tool, the fuzz can also be configured via ``patch.fuzz``.
     See :hg:`help config` for more information about configuration
     files and how to use these options.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     .. container:: verbose
 
       Examples:
 
       - import a traditional patch from a website and detect renames::
 
           hg import -s 80 http://example.com/bugfix.patch
 
       - import a changeset from an hgweb server::
 
           hg import https://www.mercurial-scm.org/repo/hg/rev/5ca8c111e9aa
 
       - import all the patches in an Unix-style mbox::
 
           hg import incoming-patches.mbox
 
       - import patches from stdin::
 
           hg import -
 
       - attempt to exactly restore an exported changeset (not always
         possible)::
 
           hg import --exact proposed-fix.patch
 
       - use an external tool to apply a patch which is too fuzzy for
         the default internal tool.
 
           hg import --config ui.patch="patch --merge" fuzzy.patch
 
       - change the default fuzzing from 2 to a less strict 7
 
           hg import --config ui.fuzz=7 fuzz.patch
 
     Returns 0 on success, 1 on partial success (see --partial).
     """
 
     cmdutil.check_incompatible_arguments(
         opts, 'no_commit', ['bypass', 'secret']
     )
     cmdutil.check_incompatible_arguments(opts, 'exact', ['edit', 'prefix'])
     opts = pycompat.byteskwargs(opts)
     if not patch1:
         raise error.InputError(_(b'need at least one patch to import'))
 
     patches = (patch1,) + patches
 
     date = opts.get(b'date')
     if date:
         opts[b'date'] = dateutil.parsedate(date)
 
     exact = opts.get(b'exact')
     update = not opts.get(b'bypass')
     try:
         sim = float(opts.get(b'similarity') or 0)
     except ValueError:
         raise error.InputError(_(b'similarity must be a number'))
     if sim < 0 or sim > 100:
         raise error.InputError(_(b'similarity must be between 0 and 100'))
     if sim and not update:
         raise error.InputError(_(b'cannot use --similarity with --bypass'))
 
     base = opts[b"base"]
     msgs = []
     ret = 0
 
     with repo.wlock():
         if update:
             cmdutil.checkunfinished(repo)
             if exact or not opts.get(b'force'):
                 cmdutil.bailifchanged(repo)
 
         if not opts.get(b'no_commit'):
             lock = repo.lock
             tr = lambda: repo.transaction(b'import')
         else:
             lock = util.nullcontextmanager
             tr = util.nullcontextmanager
         with lock(), tr():
             parents = repo[None].parents()
             for patchurl in patches:
                 if patchurl == b'-':
                     ui.status(_(b'applying patch from stdin\n'))
                     patchfile = ui.fin
                     patchurl = b'stdin'  # for error message
                 else:
                     patchurl = os.path.join(base, patchurl)
                     ui.status(_(b'applying %s\n') % patchurl)
                     patchfile = hg.openpath(ui, patchurl, sendaccept=False)
 
                 haspatch = False
                 for hunk in patch.split(patchfile):
                     with patch.extract(ui, hunk) as patchdata:
                         msg, node, rej = cmdutil.tryimportone(
                             ui, repo, patchdata, parents, opts, msgs, hg.clean
                         )
                     if msg:
                         haspatch = True
                         ui.note(msg + b'\n')
                     if update or exact:
                         parents = repo[None].parents()
                     else:
                         parents = [repo[node]]
                     if rej:
                         ui.write_err(_(b"patch applied partially\n"))
                         ui.write_err(
                             _(
                                 b"(fix the .rej files and run "
                                 b"`hg commit --amend`)\n"
                             )
                         )
                         ret = 1
                         break
 
                 if not haspatch:
                     raise error.InputError(_(b'%s: no diffs found') % patchurl)
 
             if msgs:
                 repo.savecommitmessage(b'\n* * *\n'.join(msgs))
         return ret
 
 
 @command(
     b'incoming|in',
     [
         (
             b'f',
             b'force',
             None,
             _(b'run even if remote repository is unrelated'),
         ),
         (b'n', b'newest-first', None, _(b'show newest record first')),
         (b'', b'bundle', b'', _(b'file to store the bundles into'), _(b'FILE')),
         (
             b'r',
             b'rev',
             [],
             _(b'a remote changeset intended to be added'),
             _(b'REV'),
         ),
         (b'B', b'bookmarks', False, _(b"compare bookmarks")),
         (
             b'b',
             b'branch',
             [],
             _(b'a specific branch you would like to pull'),
             _(b'BRANCH'),
         ),
     ]
     + logopts
     + remoteopts
     + subrepoopts,
     _(b'[-p] [-n] [-M] [-f] [-r REV]... [--bundle FILENAME] [SOURCE]'),
     helpcategory=command.CATEGORY_REMOTE_REPO_MANAGEMENT,
 )
 def incoming(ui, repo, source=b"default", **opts):
     """show new changesets found in source
 
     Show new changesets found in the specified path/URL or the default
     pull location. These are the changesets that would have been pulled
     by :hg:`pull` at the time you issued this command.
 
     See pull for valid source format details.
 
     .. container:: verbose
 
       With -B/--bookmarks, the result of bookmark comparison between
       local and remote repositories is displayed. With -v/--verbose,
       status is also displayed for each bookmark like below::
 
         BM1               01234567890a added
         BM2               1234567890ab advanced
         BM3               234567890abc diverged
         BM4               34567890abcd changed
 
       The action taken locally when pulling depends on the
       status of each bookmark:
 
       :``added``: pull will create it
       :``advanced``: pull will update it
       :``diverged``: pull will create a divergent bookmark
       :``changed``: result depends on remote changesets
 
       From the point of view of pulling behavior, bookmark
       existing only in the remote repository are treated as ``added``,
       even if it is in fact locally deleted.
 
     .. container:: verbose
 
       For remote repository, using --bundle avoids downloading the
       changesets twice if the incoming is followed by a pull.
 
       Examples:
 
       - show incoming changes with patches and full description::
 
           hg incoming -vp
 
       - show incoming changes excluding merges, store a bundle::
 
           hg in -vpM --bundle incoming.hg
           hg pull incoming.hg
 
       - briefly list changes inside a bundle::
 
           hg in changes.hg -T "{desc|firstline}\\n"
 
     Returns 0 if there are incoming changes, 1 otherwise.
     """
     opts = pycompat.byteskwargs(opts)
     if opts.get(b'graph'):
         logcmdutil.checkunsupportedgraphflags([], opts)
 
         def display(other, chlist, displayer):
             revdag = logcmdutil.graphrevs(other, chlist, opts)
             logcmdutil.displaygraph(
                 ui, repo, revdag, displayer, graphmod.asciiedges
             )
 
         hg._incoming(display, lambda: 1, ui, repo, source, opts, buffered=True)
         return 0
 
     cmdutil.check_incompatible_arguments(opts, b'subrepos', [b'bundle'])
 
     if opts.get(b'bookmarks'):
         srcs = urlutil.get_pull_paths(repo, ui, [source])
         for path in srcs:
             # XXX the "branches" options are not used. Should it be used?
             other = hg.peer(repo, opts, path)
             try:
                 if b'bookmarks' not in other.listkeys(b'namespaces'):
                     ui.warn(_(b"remote doesn't support bookmarks\n"))
                     return 0
                 ui.pager(b'incoming')
                 ui.status(
                     _(b'comparing with %s\n') % urlutil.hidepassword(path.loc)
                 )
                 return bookmarks.incoming(
                     ui, repo, other, mode=path.bookmarks_mode
                 )
             finally:
                 other.close()
 
     return hg.incoming(ui, repo, source, opts)
 
 
 @command(
     b'init',
     remoteopts,
     _(b'[-e CMD] [--remotecmd CMD] [DEST]'),
     helpcategory=command.CATEGORY_REPO_CREATION,
     helpbasic=True,
     norepo=True,
 )
 def init(ui, dest=b".", **opts):
     """create a new repository in the given directory
 
     Initialize a new repository in the given directory. If the given
     directory does not exist, it will be created.
 
     If no directory is given, the current directory is used.
 
     It is possible to specify an ``ssh://`` URL as the destination.
     See :hg:`help urls` for more information.
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     path = urlutil.get_clone_path_obj(ui, dest)
     peer = hg.peer(ui, opts, path, create=True)
     peer.close()
 
 
 @command(
     b'locate',
     [
         (
             b'r',
             b'rev',
             b'',
             _(b'search the repository as it is in REV'),
             _(b'REV'),
         ),
         (
             b'0',
             b'print0',
             None,
             _(b'end filenames with NUL, for use with xargs'),
         ),
         (
             b'f',
             b'fullpath',
             None,
             _(b'print complete paths from the filesystem root'),
         ),
     ]
     + walkopts,
     _(b'[OPTION]... [PATTERN]...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
 )
 def locate(ui, repo, *pats, **opts):
     """locate files matching specific patterns (DEPRECATED)
 
     Print files under Mercurial control in the working directory whose
     names match the given patterns.
 
     By default, this command searches all directories in the working
     directory. To search just the current directory and its
     subdirectories, use "--include .".
 
     If no patterns are given to match, this command prints the names
     of all files under Mercurial control in the working directory.
 
     If you want to feed the output of this command into the "xargs"
     command, use the -0 option to both this command and "xargs". This
     will avoid the problem of "xargs" treating single filenames that
     contain whitespace as multiple filenames.
 
     See :hg:`help files` for a more versatile command.
 
     Returns 0 if a match is found, 1 otherwise.
     """
     opts = pycompat.byteskwargs(opts)
     if opts.get(b'print0'):
         end = b'\0'
     else:
         end = b'\n'
     ctx = logcmdutil.revsingle(repo, opts.get(b'rev'), None)
 
     ret = 1
     m = scmutil.match(
         ctx, pats, opts, default=b'relglob', badfn=lambda x, y: False
     )
 
     ui.pager(b'locate')
     if ctx.rev() is None:
         # When run on the working copy, "locate" includes removed files, so
         # we get the list of files from the dirstate.
         filesgen = sorted(repo.dirstate.matches(m))
     else:
         filesgen = ctx.matches(m)
     uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=bool(pats))
     for abs in filesgen:
         if opts.get(b'fullpath'):
             ui.write(repo.wjoin(abs), end)
         else:
             ui.write(uipathfn(abs), end)
         ret = 0
 
     return ret
 
 
 @command(
     b'log|history',
     [
         (
             b'f',
             b'follow',
             None,
             _(
                 b'follow changeset history, or file history across copies and renames'
             ),
         ),
         (
             b'',
             b'follow-first',
             None,
             _(b'only follow the first parent of merge changesets (DEPRECATED)'),
         ),
         (
             b'd',
             b'date',
             b'',
             _(b'show revisions matching date spec'),
             _(b'DATE'),
         ),
         (b'C', b'copies', None, _(b'show copied files')),
         (
             b'k',
             b'keyword',
             [],
             _(b'do case-insensitive search for a given text'),
             _(b'TEXT'),
         ),
         (
             b'r',
             b'rev',
             [],
             _(b'revisions to select or follow from'),
             _(b'REV'),
         ),
         (
             b'L',
             b'line-range',
             [],
             _(b'follow line range of specified file (EXPERIMENTAL)'),
             _(b'FILE,RANGE'),
         ),
         (
             b'',
             b'removed',
             None,
             _(b'include revisions where files were removed'),
         ),
         (
             b'm',
             b'only-merges',
             None,
             _(b'show only merges (DEPRECATED) (use -r "merge()" instead)'),
         ),
         (b'u', b'user', [], _(b'revisions committed by user'), _(b'USER')),
         (
             b'',
             b'only-branch',
             [],
             _(
                 b'show only changesets within the given named branch (DEPRECATED)'
             ),
             _(b'BRANCH'),
         ),
         (
             b'b',
             b'branch',
             [],
             _(b'show changesets within the given named branch'),
             _(b'BRANCH'),
         ),
         (
             b'B',
             b'bookmark',
             [],
             _(b"show changesets within the given bookmark"),
             _(b'BOOKMARK'),
         ),
         (
             b'P',
             b'prune',
             [],
             _(b'do not display revision or any of its ancestors'),
             _(b'REV'),
         ),
     ]
     + logopts
     + walkopts,
     _(b'[OPTION]... [FILE]'),
     helpcategory=command.CATEGORY_CHANGE_NAVIGATION,
     helpbasic=True,
     inferrepo=True,
     intents={INTENT_READONLY},
 )
 def log(ui, repo, *pats, **opts):
     """show revision history of entire repository or files
 
     Print the revision history of the specified files or the entire
     project.
 
     If no revision range is specified, the default is ``tip:0`` unless
     --follow is set.
 
     File history is shown without following rename or copy history of
     files. Use -f/--follow with a filename to follow history across
     renames and copies. --follow without a filename will only show
     ancestors of the starting revisions. The starting revisions can be
     specified by -r/--rev, which default to the working directory parent.
 
     By default this command prints revision number and changeset id,
     tags, non-trivial parents, user, date and time, and a summary for
     each commit. When the -v/--verbose switch is used, the list of
     changed files and full commit message are shown.
 
     With --graph the revisions are shown as an ASCII art DAG with the most
     recent changeset at the top.
     'o' is a changeset, '@' is a working directory parent, '%' is a changeset
     involved in an unresolved merge conflict, '_' closes a branch,
     'x' is obsolete, '*' is unstable, and '+' represents a fork where the
     changeset from the lines below is a parent of the 'o' merge on the same
     line.
     Paths in the DAG are represented with '|', '/' and so forth. ':' in place
     of a '|' indicates one or more revisions in a path are omitted.
 
     .. container:: verbose
 
        Use -L/--line-range FILE,M:N options to follow the history of lines
        from M to N in FILE. With -p/--patch only diff hunks affecting
        specified line range will be shown. This option requires --follow;
        it can be specified multiple times. Currently, this option is not
        compatible with --graph. This option is experimental.
 
     .. note::
 
        :hg:`log --patch` may generate unexpected diff output for merge
        changesets, as it will only compare the merge changeset against
        its first parent. Also, only files different from BOTH parents
        will appear in files:.
 
     .. note::
 
        For performance reasons, :hg:`log FILE` may omit duplicate changes
        made on branches and will not show removals or mode changes. To
        see all such changes, use the --removed switch.
 
     .. container:: verbose
 
        .. note::
 
           The history resulting from -L/--line-range options depends on diff
           options; for instance if white-spaces are ignored, respective changes
           with only white-spaces in specified line range will not be listed.
 
     .. container:: verbose
 
       Some examples:
 
       - changesets with full descriptions and file lists::
 
           hg log -v
 
       - changesets ancestral to the working directory::
 
           hg log -f
 
       - last 10 commits on the current branch::
 
           hg log -l 10 -b .
 
       - changesets showing all modifications of a file, including removals::
 
           hg log --removed file.c
 
       - all changesets that touch a directory, with diffs, excluding merges::
 
           hg log -Mp lib/
 
       - all revision numbers that match a keyword::
 
           hg log -k bug --template "{rev}\\n"
 
       - the full hash identifier of the working directory parent::
 
           hg log -r . --template "{node}\\n"
 
       - list available log templates::
 
           hg log -T list
 
       - check if a given changeset is included in a tagged release::
 
           hg log -r "a21ccf and ancestor(1.9)"
 
       - find all changesets by some user in a date range::
 
           hg log -k alice -d "may 2008 to jul 2008"
 
       - summary of all changesets after the last tag::
 
           hg log -r "last(tagged())::" --template "{desc|firstline}\\n"
 
       - changesets touching lines 13 to 23 for file.c::
 
           hg log -L file.c,13:23
 
       - changesets touching lines 13 to 23 for file.c and lines 2 to 6 of
         main.c with patch::
 
           hg log -L file.c,13:23 -L main.c,2:6 -p
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     See :hg:`help revisions` for more about specifying and ordering
     revisions.
 
     See :hg:`help templates` for more about pre-packaged styles and
     specifying custom templates. The default template used by the log
     command can be customized via the ``command-templates.log`` configuration
     setting.
 
     Returns 0 on success.
 
     """
     opts = pycompat.byteskwargs(opts)
     linerange = opts.get(b'line_range')
 
     if linerange and not opts.get(b'follow'):
         raise error.InputError(_(b'--line-range requires --follow'))
 
     if linerange and pats:
         # TODO: take pats as patterns with no line-range filter
         raise error.InputError(
             _(b'FILE arguments are not compatible with --line-range option')
         )
 
     repo = scmutil.unhidehashlikerevs(repo, opts.get(b'rev'), b'nowarn')
     walk_opts = logcmdutil.parseopts(ui, pats, opts)
     revs, differ = logcmdutil.getrevs(repo, walk_opts)
     if linerange:
         # TODO: should follow file history from logcmdutil._initialrevs(),
         # then filter the result by logcmdutil._makerevset() and --limit
         revs, differ = logcmdutil.getlinerangerevs(repo, revs, opts)
 
     getcopies = None
     if opts.get(b'copies'):
         endrev = None
         if revs:
             endrev = revs.max() + 1
         getcopies = scmutil.getcopiesfn(repo, endrev=endrev)
 
     ui.pager(b'log')
     displayer = logcmdutil.changesetdisplayer(
         ui, repo, opts, differ, buffered=True
     )
     if opts.get(b'graph'):
         displayfn = logcmdutil.displaygraphrevs
     else:
         displayfn = logcmdutil.displayrevs
     displayfn(ui, repo, revs, displayer, getcopies)
 
 
 @command(
     b'manifest',
     [
         (b'r', b'rev', b'', _(b'revision to display'), _(b'REV')),
         (b'', b'all', False, _(b"list files from all revisions")),
     ]
     + formatteropts,
     _(b'[-r REV]'),
     helpcategory=command.CATEGORY_MAINTENANCE,
     intents={INTENT_READONLY},
 )
 def manifest(ui, repo, node=None, rev=None, **opts):
     """output the current or given revision of the project manifest
 
     Print a list of version controlled files for the given revision.
     If no revision is given, the first parent of the working directory
     is used, or the null revision if no revision is checked out.
 
     With -v, print file permissions, symlink and executable bits.
     With --debug, print file revision hashes.
 
     If option --all is specified, the list of all files from all revisions
     is printed. This includes deleted and renamed files.
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     fm = ui.formatter(b'manifest', opts)
 
     if opts.get(b'all'):
         if rev or node:
             raise error.InputError(_(b"can't specify a revision with --all"))
 
         res = set()
         for rev in repo:
             ctx = repo[rev]
             res |= set(ctx.files())
 
         ui.pager(b'manifest')
         for f in sorted(res):
             fm.startitem()
             fm.write(b"path", b'%s\n', f)
         fm.end()
         return
 
     if rev and node:
         raise error.InputError(_(b"please specify just one revision"))
 
     if not node:
         node = rev
 
     char = {b'l': b'@', b'x': b'*', b'': b'', b't': b'd'}
     mode = {b'l': b'644', b'x': b'755', b'': b'644', b't': b'755'}
     if node:
         repo = scmutil.unhidehashlikerevs(repo, [node], b'nowarn')
     ctx = logcmdutil.revsingle(repo, node)
     mf = ctx.manifest()
     ui.pager(b'manifest')
     for f in ctx:
         fm.startitem()
         fm.context(ctx=ctx)
         fl = ctx[f].flags()
         fm.condwrite(ui.debugflag, b'hash', b'%s ', hex(mf[f]))
         fm.condwrite(ui.verbose, b'mode type', b'%s %1s ', mode[fl], char[fl])
         fm.write(b'path', b'%s\n', f)
     fm.end()
 
 
 @command(
     b'merge',
     [
         (
             b'f',
             b'force',
             None,
             _(b'force a merge including outstanding changes (DEPRECATED)'),
         ),
         (b'r', b'rev', b'', _(b'revision to merge'), _(b'REV')),
         (
             b'P',
             b'preview',
             None,
             _(b'review revisions to merge (no merge is performed)'),
         ),
         (b'', b'abort', None, _(b'abort the ongoing merge')),
     ]
     + mergetoolopts,
     _(b'[-P] [[-r] REV]'),
     helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
     helpbasic=True,
 )
 def merge(ui, repo, node=None, **opts):
     """merge another revision into working directory
 
     The current working directory is updated with all changes made in
     the requested revision since the last common predecessor revision.
 
     Files that changed between either parent are marked as changed for
     the next commit and a commit must be performed before any further
     updates to the repository are allowed. The next commit will have
     two parents.
 
     ``--tool`` can be used to specify the merge tool used for file
     merges. It overrides the HGMERGE environment variable and your
     configuration files. See :hg:`help merge-tools` for options.
 
     If no revision is specified, the working directory's parent is a
     head revision, and the current branch contains exactly one other
     head, the other head is merged with by default. Otherwise, an
     explicit revision with which to merge must be provided.
 
     See :hg:`help resolve` for information on handling file conflicts.
 
     To undo an uncommitted merge, use :hg:`merge --abort` which
     will check out a clean copy of the original merge parent, losing
     all changes.
 
     Returns 0 on success, 1 if there are unresolved files.
     """
 
     opts = pycompat.byteskwargs(opts)
     abort = opts.get(b'abort')
     if abort and repo.dirstate.p2() == repo.nullid:
         cmdutil.wrongtooltocontinue(repo, _(b'merge'))
     cmdutil.check_incompatible_arguments(opts, b'abort', [b'rev', b'preview'])
     if abort:
         state = cmdutil.getunfinishedstate(repo)
         if state and state._opname != b'merge':
             raise error.StateError(
                 _(b'cannot abort merge with %s in progress') % (state._opname),
                 hint=state.hint(),
             )
         if node:
             raise error.InputError(_(b"cannot specify a node with --abort"))
         return hg.abortmerge(repo.ui, repo)
 
     if opts.get(b'rev') and node:
         raise error.InputError(_(b"please specify just one revision"))
     if not node:
         node = opts.get(b'rev')
 
     if node:
         ctx = logcmdutil.revsingle(repo, node)
     else:
         if ui.configbool(b'commands', b'merge.require-rev'):
             raise error.InputError(
                 _(
                     b'configuration requires specifying revision to merge '
                     b'with'
                 )
             )
         ctx = repo[destutil.destmerge(repo)]
 
     if ctx.node() is None:
         raise error.InputError(
             _(b'merging with the working copy has no effect')
         )
 
     if opts.get(b'preview'):
         # find nodes that are ancestors of p2 but not of p1
         p1 = repo[b'.'].node()
         p2 = ctx.node()
         nodes = repo.changelog.findmissing(common=[p1], heads=[p2])
 
         displayer = logcmdutil.changesetdisplayer(ui, repo, opts)
         for node in nodes:
             displayer.show(repo[node])
         displayer.close()
         return 0
 
     # ui.forcemerge is an internal variable, do not document
     overrides = {(b'ui', b'forcemerge'): opts.get(b'tool', b'')}
     with ui.configoverride(overrides, b'merge'):
         force = opts.get(b'force')
         labels = [b'working copy', b'merge rev', b'common ancestor']
         return hg.merge(ctx, force=force, labels=labels)
 
 
 statemod.addunfinished(
     b'merge',
     fname=None,
     clearable=True,
     allowcommit=True,
     cmdmsg=_(b'outstanding uncommitted merge'),
     abortfunc=hg.abortmerge,
     statushint=_(
         b'To continue:    hg commit\nTo abort:       hg merge --abort'
     ),
     cmdhint=_(b"use 'hg commit' or 'hg merge --abort'"),
 )
 
 
 @command(
     b'outgoing|out',
     [
         (
             b'f',
             b'force',
             None,
             _(b'run even when the destination is unrelated'),
         ),
         (
             b'r',
             b'rev',
             [],
             _(b'a changeset intended to be included in the destination'),
             _(b'REV'),
         ),
         (b'n', b'newest-first', None, _(b'show newest record first')),
         (b'B', b'bookmarks', False, _(b'compare bookmarks')),
         (
             b'b',
             b'branch',
             [],
             _(b'a specific branch you would like to push'),
             _(b'BRANCH'),
         ),
     ]
     + logopts
     + remoteopts
     + subrepoopts,
     _(b'[-M] [-p] [-n] [-f] [-r REV]... [DEST]...'),
     helpcategory=command.CATEGORY_REMOTE_REPO_MANAGEMENT,
 )
 def outgoing(ui, repo, *dests, **opts):
     """show changesets not found in the destination
 
     Show changesets not found in the specified destination repository
     or the default push location. These are the changesets that would
     be pushed if a push was requested.
 
     See pull for details of valid destination formats.
 
     .. container:: verbose
 
       With -B/--bookmarks, the result of bookmark comparison between
       local and remote repositories is displayed. With -v/--verbose,
       status is also displayed for each bookmark like below::
 
         BM1               01234567890a added
         BM2                            deleted
         BM3               234567890abc advanced
         BM4               34567890abcd diverged
         BM5               4567890abcde changed
 
       The action taken when pushing depends on the
       status of each bookmark:
 
       :``added``: push with ``-B`` will create it
       :``deleted``: push with ``-B`` will delete it
       :``advanced``: push will update it
       :``diverged``: push with ``-B`` will update it
       :``changed``: push with ``-B`` will update it
 
       From the point of view of pushing behavior, bookmarks
       existing only in the remote repository are treated as
       ``deleted``, even if it is in fact added remotely.
 
     Returns 0 if there are outgoing changes, 1 otherwise.
     """
     opts = pycompat.byteskwargs(opts)
     if opts.get(b'bookmarks'):
         for path in urlutil.get_push_paths(repo, ui, dests):
             other = hg.peer(repo, opts, path)
             try:
                 if b'bookmarks' not in other.listkeys(b'namespaces'):
                     ui.warn(_(b"remote doesn't support bookmarks\n"))
                     return 0
                 ui.status(
                     _(b'comparing with %s\n') % urlutil.hidepassword(path.loc)
                 )
                 ui.pager(b'outgoing')
                 return bookmarks.outgoing(ui, repo, other)
             finally:
                 other.close()
 
     return hg.outgoing(ui, repo, dests, opts)
 
 
 @command(
     b'parents',
     [
         (
             b'r',
             b'rev',
             b'',
             _(b'show parents of the specified revision'),
             _(b'REV'),
         ),
     ]
     + templateopts,
     _(b'[-r REV] [FILE]'),
     helpcategory=command.CATEGORY_CHANGE_NAVIGATION,
     inferrepo=True,
 )
 def parents(ui, repo, file_=None, **opts):
     """show the parents of the working directory or revision (DEPRECATED)
 
     Print the working directory's parent revisions. If a revision is
     given via -r/--rev, the parent of that revision will be printed.
     If a file argument is given, the revision in which the file was
     last changed (before the working directory revision or the
     argument to --rev if given) is printed.
 
     This command is equivalent to::
 
         hg log -r "p1()+p2()" or
         hg log -r "p1(REV)+p2(REV)" or
         hg log -r "max(::p1() and file(FILE))+max(::p2() and file(FILE))" or
         hg log -r "max(::p1(REV) and file(FILE))+max(::p2(REV) and file(FILE))"
 
     See :hg:`summary` and :hg:`help revsets` for related information.
 
     Returns 0 on success.
     """
 
     opts = pycompat.byteskwargs(opts)
     rev = opts.get(b'rev')
     if rev:
         repo = scmutil.unhidehashlikerevs(repo, [rev], b'nowarn')
     ctx = logcmdutil.revsingle(repo, rev, None)
 
     if file_:
         m = scmutil.match(ctx, (file_,), opts)
         if m.anypats() or len(m.files()) != 1:
             raise error.InputError(_(b'can only specify an explicit filename'))
         file_ = m.files()[0]
         filenodes = []
         for cp in ctx.parents():
             if not cp:
                 continue
             try:
                 filenodes.append(cp.filenode(file_))
             except error.LookupError:
                 pass
         if not filenodes:
             raise error.InputError(_(b"'%s' not found in manifest") % file_)
         p = []
         for fn in filenodes:
             fctx = repo.filectx(file_, fileid=fn)
             p.append(fctx.node())
     else:
         p = [cp.node() for cp in ctx.parents()]
 
     displayer = logcmdutil.changesetdisplayer(ui, repo, opts)
     for n in p:
         if n != repo.nullid:
             displayer.show(repo[n])
     displayer.close()
 
 
 @command(
     b'paths',
     formatteropts,
     _(b'[NAME]'),
     helpcategory=command.CATEGORY_REMOTE_REPO_MANAGEMENT,
     optionalrepo=True,
     intents={INTENT_READONLY},
 )
 def paths(ui, repo, search=None, **opts):
     """show aliases for remote repositories
 
     Show definition of symbolic path name NAME. If no name is given,
     show definition of all available names.
 
     Option -q/--quiet suppresses all output when searching for NAME
     and shows only the path names when listing all definitions.
 
     Path names are defined in the [paths] section of your
     configuration file and in ``/etc/mercurial/hgrc``. If run inside a
     repository, ``.hg/hgrc`` is used, too.
 
     The path names ``default`` and ``default-push`` have a special
     meaning.  When performing a push or pull operation, they are used
     as fallbacks if no location is specified on the command-line.
     When ``default-push`` is set, it will be used for push and
     ``default`` will be used for pull; otherwise ``default`` is used
     as the fallback for both.  When cloning a repository, the clone
     source is written as ``default`` in ``.hg/hgrc``.
 
     .. note::
 
        ``default`` and ``default-push`` apply to all inbound (e.g.
        :hg:`incoming`) and outbound (e.g. :hg:`outgoing`, :hg:`email`
        and :hg:`bundle`) operations.
 
     See :hg:`help urls` for more information.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported. See also :hg:`help templates`.
 
       :name:    String. Symbolic name of the path alias.
       :pushurl: String. URL for push operations.
       :url:     String. URL or directory path for the other operations.
 
     Returns 0 on success.
     """
 
     opts = pycompat.byteskwargs(opts)
 
     pathitems = urlutil.list_paths(ui, search)
     ui.pager(b'paths')
 
     fm = ui.formatter(b'paths', opts)
     if fm.isplain():
         hidepassword = urlutil.hidepassword
     else:
         hidepassword = bytes
     if ui.quiet:
         namefmt = b'%s\n'
     else:
         namefmt = b'%s = '
     showsubopts = not search and not ui.quiet
 
     for name, path in pathitems:
         fm.startitem()
         fm.condwrite(not search, b'name', namefmt, name)
         fm.condwrite(not ui.quiet, b'url', b'%s\n', hidepassword(path.rawloc))
         for subopt, value in sorted(path.suboptions.items()):
             assert subopt not in (b'name', b'url')
             if showsubopts:
                 fm.plain(b'%s:%s = ' % (name, subopt))
             if isinstance(value, bool):
                 if value:
                     value = b'yes'
                 else:
                     value = b'no'
             fm.condwrite(showsubopts, subopt, b'%s\n', value)
 
     fm.end()
 
     if search and not pathitems:
         if not ui.quiet:
             ui.warn(_(b"not found!\n"))
         return 1
     else:
         return 0
 
 
 @command(
     b'phase',
     [
         (b'p', b'public', False, _(b'set changeset phase to public')),
         (b'd', b'draft', False, _(b'set changeset phase to draft')),
         (b's', b'secret', False, _(b'set changeset phase to secret')),
         (b'f', b'force', False, _(b'allow to move boundary backward')),
         (b'r', b'rev', [], _(b'target revision'), _(b'REV')),
     ],
     _(b'[-p|-d|-s] [-f] [-r] [REV...]'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def phase(ui, repo, *revs, **opts):
     """set or show the current phase name
 
     With no argument, show the phase name of the current revision(s).
 
     With one of -p/--public, -d/--draft or -s/--secret, change the
     phase value of the specified revisions.
 
     Unless -f/--force is specified, :hg:`phase` won't move changesets from a
     lower phase to a higher phase. Phases are ordered as follows::
 
         public < draft < secret
 
     Returns 0 on success, 1 if some phases could not be changed.
 
     (For more information about the phases concept, see :hg:`help phases`.)
     """
     opts = pycompat.byteskwargs(opts)
     # search for a unique phase argument
     targetphase = None
     for idx, name in enumerate(phases.cmdphasenames):
         if opts[name]:
             if targetphase is not None:
                 raise error.InputError(_(b'only one phase can be specified'))
             targetphase = idx
 
     # look for specified revision
     revs = list(revs)
     revs.extend(opts[b'rev'])
     if revs:
         revs = logcmdutil.revrange(repo, revs)
     else:
         # display both parents as the second parent phase can influence
         # the phase of a merge commit
         revs = [c.rev() for c in repo[None].parents()]
 
     ret = 0
     if targetphase is None:
         # display
         for r in revs:
             ctx = repo[r]
             ui.write(b'%i: %s\n' % (ctx.rev(), ctx.phasestr()))
     else:
         with repo.lock(), repo.transaction(b"phase") as tr:
             # set phase
             if not revs:
                 raise error.InputError(_(b'empty revision set'))
             nodes = [repo[r].node() for r in revs]
             # moving revision from public to draft may hide them
             # We have to check result on an unfiltered repository
             unfi = repo.unfiltered()
             getphase = unfi._phasecache.phase
             olddata = [getphase(unfi, r) for r in unfi]
             phases.advanceboundary(repo, tr, targetphase, nodes)
             if opts[b'force']:
                 phases.retractboundary(repo, tr, targetphase, nodes)
         getphase = unfi._phasecache.phase
         newdata = [getphase(unfi, r) for r in unfi]
         changes = sum(newdata[r] != olddata[r] for r in unfi)
         cl = unfi.changelog
         rejected = [n for n in nodes if newdata[cl.rev(n)] < targetphase]
         if rejected:
             ui.warn(
                 _(
                     b'cannot move %i changesets to a higher '
                     b'phase, use --force\n'
                 )
                 % len(rejected)
             )
             ret = 1
         if changes:
             msg = _(b'phase changed for %i changesets\n') % changes
             if ret:
                 ui.status(msg)
             else:
                 ui.note(msg)
         else:
             ui.warn(_(b'no phases changed\n'))
     return ret
 
 
 def postincoming(ui, repo, modheads, optupdate, checkout, brev):
     """Run after a changegroup has been added via pull/unbundle
 
     This takes arguments below:
 
     :modheads: change of heads by pull/unbundle
     :optupdate: updating working directory is needed or not
     :checkout: update destination revision (or None to default destination)
     :brev: a name, which might be a bookmark to be activated after updating
 
     return True if update raise any conflict, False otherwise.
     """
     if modheads == 0:
         return False
     if optupdate:
         try:
             return hg.updatetotally(ui, repo, checkout, brev)
         except error.UpdateAbort as inst:
             msg = _(b"not updating: %s") % stringutil.forcebytestr(inst)
             hint = inst.hint
             raise error.UpdateAbort(msg, hint=hint)
     if modheads is not None and modheads > 1:
         currentbranchheads = len(repo.branchheads())
         if currentbranchheads == modheads:
             ui.status(
                 _(b"(run 'hg heads' to see heads, 'hg merge' to merge)\n")
             )
         elif currentbranchheads > 1:
             ui.status(
                 _(b"(run 'hg heads .' to see heads, 'hg merge' to merge)\n")
             )
         else:
             ui.status(_(b"(run 'hg heads' to see heads)\n"))
     elif not ui.configbool(b'commands', b'update.requiredest'):
         ui.status(_(b"(run 'hg update' to get a working copy)\n"))
     return False
 
 
 @command(
     b'pull',
     [
         (
             b'u',
             b'update',
             None,
             _(b'update to new branch head if new descendants were pulled'),
         ),
         (
             b'f',
             b'force',
             None,
             _(b'run even when remote repository is unrelated'),
         ),
         (
             b'',
             b'confirm',
             None,
             _(b'confirm pull before applying changes'),
         ),
         (
             b'r',
             b'rev',
             [],
             _(b'a remote changeset intended to be added'),
             _(b'REV'),
         ),
         (b'B', b'bookmark', [], _(b"bookmark to pull"), _(b'BOOKMARK')),
         (
             b'b',
             b'branch',
             [],
             _(b'a specific branch you would like to pull'),
             _(b'BRANCH'),
         ),
+        (
+            b'',
+            b'remote-hidden',
+            False,
+            _(b"include changesets hidden on the remote (EXPERIMENTAL)"),
+        ),
     ]
     + remoteopts,
     _(b'[-u] [-f] [-r REV]... [-e CMD] [--remotecmd CMD] [SOURCE]...'),
     helpcategory=command.CATEGORY_REMOTE_REPO_MANAGEMENT,
     helpbasic=True,
 )
 def pull(ui, repo, *sources, **opts):
     """pull changes from the specified source
 
     Pull changes from a remote repository to a local one.
 
     This finds all changes from the repository at the specified path
     or URL and adds them to a local repository (the current one unless
     -R is specified). By default, this does not update the copy of the
     project in the working directory.
 
     When cloning from servers that support it, Mercurial may fetch
     pre-generated data. When this is done, hooks operating on incoming
     changesets and changegroups may fire more than once, once for each
     pre-generated bundle and as well as for any additional remaining
     data. See :hg:`help -e clonebundles` for more.
 
     Use :hg:`incoming` if you want to see what would have been added
     by a pull at the time you issued this command. If you then decide
     to add those changes to the repository, you should use :hg:`pull
     -r X` where ``X`` is the last changeset listed by :hg:`incoming`.
 
     If SOURCE is omitted, the 'default' path will be used.
     See :hg:`help urls` for more information.
 
     If multiple sources are specified, they will be pulled sequentially as if
     the command was run multiple time. If --update is specify and the command
     will stop at the first failed --update.
 
     Specifying bookmark as ``.`` is equivalent to specifying the active
     bookmark's name.
 
+    .. container:: verbose
+
+        One can use the `--remote-hidden` flag to pull changesets
+        hidden on the remote. This flag is "best effort", and will only
+        work if the server supports the feature and is configured to
+        allow the user to access hidden changesets. This option is
+        experimental and backwards compatibility is not garanteed.
+
     Returns 0 on success, 1 if an update had unresolved files.
     """
 
     opts = pycompat.byteskwargs(opts)
     if ui.configbool(b'commands', b'update.requiredest') and opts.get(
         b'update'
     ):
         msg = _(b'update destination required by configuration')
         hint = _(b'use hg pull followed by hg update DEST')
         raise error.InputError(msg, hint=hint)
 
     for path in urlutil.get_pull_paths(repo, ui, sources):
         ui.status(_(b'pulling from %s\n') % urlutil.hidepassword(path.loc))
         ui.flush()
-        other = hg.peer(repo, opts, path)
+        other = hg.peer(repo, opts, path, remotehidden=opts[b'remote_hidden'])
         update_conflict = None
         try:
             branches = (path.branch, opts.get(b'branch', []))
             revs, checkout = hg.addbranchrevs(
-                repo, other, branches, opts.get(b'rev')
+                repo,
+                other,
+                branches,
+                opts.get(b'rev'),
+                remotehidden=opts[b'remote_hidden'],
             )
 
             pullopargs = {}
 
             nodes = None
             if opts.get(b'bookmark') or revs:
                 # The list of bookmark used here is the same used to actually update
                 # the bookmark names, to avoid the race from issue 4689 and we do
                 # all lookup and bookmark queries in one go so they see the same
                 # version of the server state (issue 4700).
                 nodes = []
                 fnodes = []
                 revs = revs or []
                 if revs and not other.capable(b'lookup'):
                     err = _(
                         b"other repository doesn't support revision lookup, "
                         b"so a rev cannot be specified."
                     )
                     raise error.Abort(err)
                 with other.commandexecutor() as e:
                     fremotebookmarks = e.callcommand(
                         b'listkeys', {b'namespace': b'bookmarks'}
                     )
                     for r in revs:
                         fnodes.append(e.callcommand(b'lookup', {b'key': r}))
                 remotebookmarks = fremotebookmarks.result()
                 remotebookmarks = bookmarks.unhexlifybookmarks(remotebookmarks)
                 pullopargs[b'remotebookmarks'] = remotebookmarks
                 for b in opts.get(b'bookmark', []):
                     b = repo._bookmarks.expandname(b)
                     if b not in remotebookmarks:
                         raise error.InputError(
                             _(b'remote bookmark %s not found!') % b
                         )
                     nodes.append(remotebookmarks[b])
                 for i, rev in enumerate(revs):
                     node = fnodes[i].result()
                     nodes.append(node)
                     if rev == checkout:
                         checkout = node
 
             wlock = util.nullcontextmanager()
             if opts.get(b'update'):
                 wlock = repo.wlock()
             with wlock:
                 pullopargs.update(opts.get(b'opargs', {}))
                 modheads = exchange.pull(
                     repo,
                     other,
                     path=path,
                     heads=nodes,
                     force=opts.get(b'force'),
                     bookmarks=opts.get(b'bookmark', ()),
                     opargs=pullopargs,
                     confirm=opts.get(b'confirm'),
                 ).cgresult
 
                 # brev is a name, which might be a bookmark to be activated at
                 # the end of the update. In other words, it is an explicit
                 # destination of the update
                 brev = None
 
                 if checkout:
                     checkout = repo.unfiltered().changelog.rev(checkout)
 
                     # order below depends on implementation of
                     # hg.addbranchrevs(). opts['bookmark'] is ignored,
                     # because 'checkout' is determined without it.
                     if opts.get(b'rev'):
                         brev = opts[b'rev'][0]
                     elif opts.get(b'branch'):
                         brev = opts[b'branch'][0]
                     else:
                         brev = path.branch
 
                 # XXX path: we are losing the `path` object here. Keeping it
                 # would be valuable. For example as a "variant" as we do
                 # for pushes.
                 repo._subtoppath = path.loc
                 try:
                     update_conflict = postincoming(
                         ui, repo, modheads, opts.get(b'update'), checkout, brev
                     )
                 except error.FilteredRepoLookupError as exc:
                     msg = _(b'cannot update to target: %s') % exc.args[0]
                     exc.args = (msg,) + exc.args[1:]
                     raise
                 finally:
                     del repo._subtoppath
 
         finally:
             other.close()
         # skip the remaining pull source if they are some conflict.
         if update_conflict:
             break
     if update_conflict:
         return 1
     else:
         return 0
 
 
 @command(
     b'purge|clean',
     [
         (b'a', b'abort-on-err', None, _(b'abort if an error occurs')),
         (b'', b'all', None, _(b'purge ignored files too')),
         (b'i', b'ignored', None, _(b'purge only ignored files')),
         (b'', b'dirs', None, _(b'purge empty directories')),
         (b'', b'files', None, _(b'purge files')),
         (b'p', b'print', None, _(b'print filenames instead of deleting them')),
         (
             b'0',
             b'print0',
             None,
             _(
                 b'end filenames with NUL, for use with xargs'
                 b' (implies -p/--print)'
             ),
         ),
         (b'', b'confirm', None, _(b'ask before permanently deleting files')),
     ]
     + cmdutil.walkopts,
     _(b'hg purge [OPTION]... [DIR]...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
 )
 def purge(ui, repo, *dirs, **opts):
     """removes files not tracked by Mercurial
 
     Delete files not known to Mercurial. This is useful to test local
     and uncommitted changes in an otherwise-clean source tree.
 
     This means that purge will delete the following by default:
 
     - Unknown files: files marked with "?" by :hg:`status`
     - Empty directories: in fact Mercurial ignores directories unless
       they contain files under source control management
 
     But it will leave untouched:
 
     - Modified and unmodified tracked files
     - Ignored files (unless -i or --all is specified)
     - New files added to the repository (with :hg:`add`)
 
     The --files and --dirs options can be used to direct purge to delete
     only files, only directories, or both. If neither option is given,
     both will be deleted.
 
     If directories are given on the command line, only files in these
     directories are considered.
 
     Be careful with purge, as you could irreversibly delete some files
     you forgot to add to the repository. If you only want to print the
     list of files that this program would delete, use the --print
     option.
     """
     opts = pycompat.byteskwargs(opts)
     cmdutil.check_at_most_one_arg(opts, b'all', b'ignored')
 
     act = not opts.get(b'print')
     eol = b'\n'
     if opts.get(b'print0'):
         eol = b'\0'
         act = False  # --print0 implies --print
     if opts.get(b'all', False):
         ignored = True
         unknown = True
     else:
         ignored = opts.get(b'ignored', False)
         unknown = not ignored
 
     removefiles = opts.get(b'files')
     removedirs = opts.get(b'dirs')
     confirm = opts.get(b'confirm')
     if confirm is None:
         try:
             extensions.find(b'purge')
             confirm = False
         except KeyError:
             confirm = True
 
     if not removefiles and not removedirs:
         removefiles = True
         removedirs = True
 
     match = scmutil.match(repo[None], dirs, opts)
 
     paths = mergemod.purge(
         repo,
         match,
         unknown=unknown,
         ignored=ignored,
         removeemptydirs=removedirs,
         removefiles=removefiles,
         abortonerror=opts.get(b'abort_on_err'),
         noop=not act,
         confirm=confirm,
     )
 
     for path in paths:
         if not act:
             ui.write(b'%s%s' % (path, eol))
 
 
 @command(
     b'push',
     [
         (b'f', b'force', None, _(b'force push')),
         (
             b'r',
             b'rev',
             [],
             _(b'a changeset intended to be included in the destination'),
             _(b'REV'),
         ),
         (b'B', b'bookmark', [], _(b"bookmark to push"), _(b'BOOKMARK')),
         (b'', b'all-bookmarks', None, _(b"push all bookmarks (EXPERIMENTAL)")),
         (
             b'b',
             b'branch',
             [],
             _(b'a specific branch you would like to push'),
             _(b'BRANCH'),
         ),
         (b'', b'new-branch', False, _(b'allow pushing a new branch')),
         (
             b'',
             b'pushvars',
             [],
             _(b'variables that can be sent to server (ADVANCED)'),
         ),
         (
             b'',
             b'publish',
             False,
             _(b'push the changeset as public (EXPERIMENTAL)'),
         ),
     ]
     + remoteopts,
     _(b'[-f] [-r REV]... [-e CMD] [--remotecmd CMD] [DEST]...'),
     helpcategory=command.CATEGORY_REMOTE_REPO_MANAGEMENT,
     helpbasic=True,
 )
 def push(ui, repo, *dests, **opts):
     """push changes to the specified destination
 
     Push changesets from the local repository to the specified
     destination.
 
     This operation is symmetrical to pull: it is identical to a pull
     in the destination repository from the current one.
 
     By default, push will not allow creation of new heads at the
     destination, since multiple heads would make it unclear which head
     to use. In this situation, it is recommended to pull and merge
     before pushing.
 
     Use --new-branch if you want to allow push to create a new named
     branch that is not present at the destination. This allows you to
     only create a new branch without forcing other changes.
 
     .. note::
 
        Extra care should be taken with the -f/--force option,
        which will push all new heads on all branches, an action which will
        almost always cause confusion for collaborators.
 
     If -r/--rev is used, the specified revision and all its ancestors
     will be pushed to the remote repository.
 
     If -B/--bookmark is used, the specified bookmarked revision, its
     ancestors, and the bookmark will be pushed to the remote
     repository. Specifying ``.`` is equivalent to specifying the active
     bookmark's name. Use the --all-bookmarks option for pushing all
     current bookmarks.
 
     Please see :hg:`help urls` for important details about ``ssh://``
     URLs. If DESTINATION is omitted, a default path will be used.
 
     When passed multiple destinations, push will process them one after the
     other, but stop should an error occur.
 
     .. container:: verbose
 
         The --pushvars option sends strings to the server that become
         environment variables prepended with ``HG_USERVAR_``. For example,
         ``--pushvars ENABLE_FEATURE=true``, provides the server side hooks with
         ``HG_USERVAR_ENABLE_FEATURE=true`` as part of their environment.
 
         pushvars can provide for user-overridable hooks as well as set debug
         levels. One example is having a hook that blocks commits containing
         conflict markers, but enables the user to override the hook if the file
         is using conflict markers for testing purposes or the file format has
         strings that look like conflict markers.
 
         By default, servers will ignore `--pushvars`. To enable it add the
         following to your configuration file::
 
             [push]
             pushvars.server = true
 
     Returns 0 if push was successful, 1 if nothing to push.
     """
 
     opts = pycompat.byteskwargs(opts)
 
     if opts.get(b'all_bookmarks'):
         cmdutil.check_incompatible_arguments(
             opts,
             b'all_bookmarks',
             [b'bookmark', b'rev'],
         )
         opts[b'bookmark'] = list(repo._bookmarks)
 
     if opts.get(b'bookmark'):
         ui.setconfig(b'bookmarks', b'pushing', opts[b'bookmark'], b'push')
         for b in opts[b'bookmark']:
             # translate -B options to -r so changesets get pushed
             b = repo._bookmarks.expandname(b)
             if b in repo._bookmarks:
                 opts.setdefault(b'rev', []).append(b)
             else:
                 # if we try to push a deleted bookmark, translate it to null
                 # this lets simultaneous -r, -b options continue working
                 opts.setdefault(b'rev', []).append(b"null")
 
     some_pushed = False
     result = 0
     for path in urlutil.get_push_paths(repo, ui, dests):
         dest = path.loc
         branches = (path.branch, opts.get(b'branch') or [])
         ui.status(_(b'pushing to %s\n') % urlutil.hidepassword(dest))
         revs, checkout = hg.addbranchrevs(
             repo, repo, branches, opts.get(b'rev')
         )
         other = hg.peer(repo, opts, dest)
 
         try:
             if revs:
                 revs = [repo[r].node() for r in logcmdutil.revrange(repo, revs)]
                 if not revs:
                     raise error.InputError(
                         _(b"specified revisions evaluate to an empty set"),
                         hint=_(b"use different revision arguments"),
                     )
             elif path.pushrev:
                 # It doesn't make any sense to specify ancestor revisions. So limit
                 # to DAG heads to make discovery simpler.
                 expr = revsetlang.formatspec(b'heads(%r)', path.pushrev)
                 revs = scmutil.revrange(repo, [expr])
                 revs = [repo[rev].node() for rev in revs]
                 if not revs:
                     raise error.InputError(
                         _(
                             b'default push revset for path evaluates to an empty set'
                         )
                     )
             elif ui.configbool(b'commands', b'push.require-revs'):
                 raise error.InputError(
                     _(b'no revisions specified to push'),
                     hint=_(b'did you mean "hg push -r ."?'),
                 )
 
             repo._subtoppath = dest
             try:
                 # push subrepos depth-first for coherent ordering
                 c = repo[b'.']
                 subs = c.substate  # only repos that are committed
                 for s in sorted(subs):
                     sub_result = c.sub(s).push(opts)
                     if sub_result == 0:
                         return 1
             finally:
                 del repo._subtoppath
 
             opargs = dict(
                 opts.get(b'opargs', {})
             )  # copy opargs since we may mutate it
             opargs.setdefault(b'pushvars', []).extend(opts.get(b'pushvars', []))
 
             pushop = exchange.push(
                 repo,
                 other,
                 opts.get(b'force'),
                 revs=revs,
                 newbranch=opts.get(b'new_branch'),
                 bookmarks=opts.get(b'bookmark', ()),
                 publish=opts.get(b'publish'),
                 opargs=opargs,
             )
 
             if pushop.cgresult == 0:
                 result = 1
             elif pushop.cgresult is not None:
                 some_pushed = True
 
             if pushop.bkresult is not None:
                 if pushop.bkresult == 2:
                     result = 2
                 elif not result and pushop.bkresult:
                     result = 2
 
             if result:
                 break
 
         finally:
             other.close()
     if result == 0 and not some_pushed:
         result = 1
     return result
 
 
 @command(
     b'recover',
     [
         (b'', b'verify', False, b"run `hg verify` after successful recover"),
     ],
     helpcategory=command.CATEGORY_MAINTENANCE,
 )
 def recover(ui, repo, **opts):
     """roll back an interrupted transaction
 
     Recover from an interrupted commit or pull.
 
     This command tries to fix the repository status after an
     interrupted operation. It should only be necessary when Mercurial
     suggests it.
 
     Returns 0 if successful, 1 if nothing to recover or verify fails.
     """
     ret = repo.recover()
     if ret:
         if opts['verify']:
             return hg.verify(repo)
         else:
             msg = _(
                 b"(verify step skipped, run `hg verify` to check your "
                 b"repository content)\n"
             )
             ui.warn(msg)
             return 0
     return 1
 
 
 @command(
     b'remove|rm',
     [
         (b'A', b'after', None, _(b'record delete for missing files')),
         (b'f', b'force', None, _(b'forget added files, delete modified files')),
     ]
     + subrepoopts
     + walkopts
     + dryrunopts,
     _(b'[OPTION]... FILE...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
     helpbasic=True,
     inferrepo=True,
 )
 def remove(ui, repo, *pats, **opts):
     """remove the specified files on the next commit
 
     Schedule the indicated files for removal from the current branch.
 
     This command schedules the files to be removed at the next commit.
     To undo a remove before that, see :hg:`revert`. To undo added
     files, see :hg:`forget`.
 
     .. container:: verbose
 
       -A/--after can be used to remove only files that have already
       been deleted, -f/--force can be used to force deletion, and -Af
       can be used to remove files from the next revision without
       deleting them from the working directory.
 
       The following table details the behavior of remove for different
       file states (columns) and option combinations (rows). The file
       states are Added [A], Clean [C], Modified [M] and Missing [!]
       (as reported by :hg:`status`). The actions are Warn, Remove
       (from branch) and Delete (from disk):
 
       ========= == == == ==
       opt/state A  C  M  !
       ========= == == == ==
       none      W  RD W  R
       -f        R  RD RD R
       -A        W  W  W  R
       -Af       R  R  R  R
       ========= == == == ==
 
       .. note::
 
          :hg:`remove` never deletes files in Added [A] state from the
          working directory, not even if ``--force`` is specified.
 
     Returns 0 on success, 1 if any warnings encountered.
     """
 
     opts = pycompat.byteskwargs(opts)
     after, force = opts.get(b'after'), opts.get(b'force')
     dryrun = opts.get(b'dry_run')
     if not pats and not after:
         raise error.InputError(_(b'no files specified'))
 
     with repo.wlock(), repo.dirstate.changing_files(repo):
         m = scmutil.match(repo[None], pats, opts)
         subrepos = opts.get(b'subrepos')
         uipathfn = scmutil.getuipathfn(repo, legacyrelativevalue=True)
         return cmdutil.remove(
             ui, repo, m, b"", uipathfn, after, force, subrepos, dryrun=dryrun
         )
 
 
 @command(
     b'rename|move|mv',
     [
         (b'', b'forget', None, _(b'unmark a destination file as renamed')),
         (b'A', b'after', None, _(b'record a rename that has already occurred')),
         (
             b'',
             b'at-rev',
             b'',
             _(b'(un)mark renames in the given revision (EXPERIMENTAL)'),
             _(b'REV'),
         ),
         (
             b'f',
             b'force',
             None,
             _(b'forcibly move over an existing managed file'),
         ),
     ]
     + walkopts
     + dryrunopts,
     _(b'[OPTION]... SOURCE... DEST'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
 )
 def rename(ui, repo, *pats, **opts):
     """rename files; equivalent of copy + remove
 
     Mark dest as copies of sources; mark sources for deletion. If dest
     is a directory, copies are put in that directory. If dest is a
     file, there can only be one source.
 
     By default, this command copies the contents of files as they
     exist in the working directory. If invoked with -A/--after, the
     operation is recorded, but no copying is performed.
 
     To undo marking a destination file as renamed, use --forget. With that
     option, all given (positional) arguments are unmarked as renames. The
     destination file(s) will be left in place (still tracked). The source
     file(s) will not be restored. Note that :hg:`rename --forget` behaves
     the same way as :hg:`copy --forget`.
 
     This command takes effect with the next commit by default.
 
     Returns 0 on success, 1 if errors are encountered.
     """
     opts = pycompat.byteskwargs(opts)
     context = lambda repo: repo.dirstate.changing_files(repo)
     rev = opts.get(b'at_rev')
     ctx = None
     if rev:
         ctx = logcmdutil.revsingle(repo, rev)
         if ctx.rev() is not None:
 
             def context(repo):
                 return util.nullcontextmanager()
 
             opts[b'at_rev'] = ctx.rev()
     with repo.wlock(), context(repo):
         return cmdutil.copy(ui, repo, pats, opts, rename=True)
 
 
 @command(
     b'resolve',
     [
         (b'a', b'all', None, _(b'select all unresolved files')),
         (b'l', b'list', None, _(b'list state of files needing merge')),
         (b'm', b'mark', None, _(b'mark files as resolved')),
         (b'u', b'unmark', None, _(b'mark files as unresolved')),
         (b'n', b'no-status', None, _(b'hide status prefix')),
         (b'', b're-merge', None, _(b're-merge files')),
     ]
     + mergetoolopts
     + walkopts
     + formatteropts,
     _(b'[OPTION]... [FILE]...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
     inferrepo=True,
 )
 def resolve(ui, repo, *pats, **opts):
     """redo merges or set/view the merge status of files
 
     Merges with unresolved conflicts are often the result of
     non-interactive merging using the ``internal:merge`` configuration
     setting, or a command-line merge tool like ``diff3``. The resolve
     command is used to manage the files involved in a merge, after
     :hg:`merge` has been run, and before :hg:`commit` is run (i.e. the
     working directory must have two parents). See :hg:`help
     merge-tools` for information on configuring merge tools.
 
     The resolve command can be used in the following ways:
 
     - :hg:`resolve [--re-merge] [--tool TOOL] FILE...`: attempt to re-merge
       the specified files, discarding any previous merge attempts. Re-merging
       is not performed for files already marked as resolved. Use ``--all/-a``
       to select all unresolved files. ``--tool`` can be used to specify
       the merge tool used for the given files. It overrides the HGMERGE
       environment variable and your configuration files.  Previous file
       contents are saved with a ``.orig`` suffix.
 
     - :hg:`resolve -m [FILE]`: mark a file as having been resolved
       (e.g. after having manually fixed-up the files). The default is
       to mark all unresolved files.
 
     - :hg:`resolve -u [FILE]...`: mark a file as unresolved. The
       default is to mark all resolved files.
 
     - :hg:`resolve -l`: list files which had or still have conflicts.
       In the printed list, ``U`` = unresolved and ``R`` = resolved.
       You can use ``set:unresolved()`` or ``set:resolved()`` to filter
       the list. See :hg:`help filesets` for details.
 
     .. note::
 
        Mercurial will not let you commit files with unresolved merge
        conflicts. You must use :hg:`resolve -m ...` before you can
        commit after a conflicting merge.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions. See also :hg:`help templates`.
 
       :mergestatus: String. Character denoting merge conflicts, ``U`` or ``R``.
       :path:    String. Repository-absolute path of the file.
 
     Returns 0 on success, 1 if any files fail a resolve attempt.
     """
 
     opts = pycompat.byteskwargs(opts)
     confirm = ui.configbool(b'commands', b'resolve.confirm')
     flaglist = b'all mark unmark list no_status re_merge'.split()
     all, mark, unmark, show, nostatus, remerge = [opts.get(o) for o in flaglist]
 
     actioncount = len(list(filter(None, [show, mark, unmark, remerge])))
     if actioncount > 1:
         raise error.InputError(_(b"too many actions specified"))
     elif actioncount == 0 and ui.configbool(
         b'commands', b'resolve.explicit-re-merge'
     ):
         hint = _(b'use --mark, --unmark, --list or --re-merge')
         raise error.InputError(_(b'no action specified'), hint=hint)
     if pats and all:
         raise error.InputError(_(b"can't specify --all and patterns"))
     if not (all or pats or show or mark or unmark):
         raise error.InputError(
             _(b'no files or directories specified'),
             hint=b'use --all to re-merge all unresolved files',
         )
 
     if confirm:
         if all:
             if ui.promptchoice(
                 _(b're-merge all unresolved files (yn)?$$ &Yes $$ &No')
             ):
                 raise error.CanceledError(_(b'user quit'))
         if mark and not pats:
             if ui.promptchoice(
                 _(
                     b'mark all unresolved files as resolved (yn)?'
                     b'$$ &Yes $$ &No'
                 )
             ):
                 raise error.CanceledError(_(b'user quit'))
         if unmark and not pats:
             if ui.promptchoice(
                 _(
                     b'mark all resolved files as unresolved (yn)?'
                     b'$$ &Yes $$ &No'
                 )
             ):
                 raise error.CanceledError(_(b'user quit'))
 
     uipathfn = scmutil.getuipathfn(repo)
 
     if show:
         ui.pager(b'resolve')
         fm = ui.formatter(b'resolve', opts)
         ms = mergestatemod.mergestate.read(repo)
         wctx = repo[None]
         m = scmutil.match(wctx, pats, opts)
 
         # Labels and keys based on merge state.  Unresolved path conflicts show
         # as 'P'.  Resolved path conflicts show as 'R', the same as normal
         # resolved conflicts.
         mergestateinfo = {
             mergestatemod.MERGE_RECORD_UNRESOLVED: (
                 b'resolve.unresolved',
                 b'U',
             ),
             mergestatemod.MERGE_RECORD_RESOLVED: (b'resolve.resolved', b'R'),
             mergestatemod.MERGE_RECORD_UNRESOLVED_PATH: (
                 b'resolve.unresolved',
                 b'P',
             ),
             mergestatemod.MERGE_RECORD_RESOLVED_PATH: (
                 b'resolve.resolved',
                 b'R',
             ),
         }
 
         for f in ms:
             if not m(f):
                 continue
 
             label, key = mergestateinfo[ms[f]]
             fm.startitem()
             fm.context(ctx=wctx)
             fm.condwrite(not nostatus, b'mergestatus', b'%s ', key, label=label)
             fm.data(path=f)
             fm.plain(b'%s\n' % uipathfn(f), label=label)
         fm.end()
         return 0
 
     with repo.wlock():
         ms = mergestatemod.mergestate.read(repo)
 
         if not (ms.active() or repo.dirstate.p2() != repo.nullid):
             raise error.StateError(
                 _(b'resolve command not applicable when not merging')
             )
 
         wctx = repo[None]
         m = scmutil.match(wctx, pats, opts)
         ret = 0
         didwork = False
 
         hasconflictmarkers = []
         if mark:
             markcheck = ui.config(b'commands', b'resolve.mark-check')
             if markcheck not in [b'warn', b'abort']:
                 # Treat all invalid / unrecognized values as 'none'.
                 markcheck = False
         for f in ms:
             if not m(f):
                 continue
 
             didwork = True
 
             # path conflicts must be resolved manually
             if ms[f] in (
                 mergestatemod.MERGE_RECORD_UNRESOLVED_PATH,
                 mergestatemod.MERGE_RECORD_RESOLVED_PATH,
             ):
                 if mark:
                     ms.mark(f, mergestatemod.MERGE_RECORD_RESOLVED_PATH)
                 elif unmark:
                     ms.mark(f, mergestatemod.MERGE_RECORD_UNRESOLVED_PATH)
                 elif ms[f] == mergestatemod.MERGE_RECORD_UNRESOLVED_PATH:
                     ui.warn(
                         _(b'%s: path conflict must be resolved manually\n')
                         % uipathfn(f)
                     )
                 continue
 
             if mark:
                 if markcheck:
                     fdata = repo.wvfs.tryread(f)
                     if (
                         filemerge.hasconflictmarkers(fdata)
                         and ms[f] != mergestatemod.MERGE_RECORD_RESOLVED
                     ):
                         hasconflictmarkers.append(f)
                 ms.mark(f, mergestatemod.MERGE_RECORD_RESOLVED)
             elif unmark:
                 ms.mark(f, mergestatemod.MERGE_RECORD_UNRESOLVED)
             else:
                 # backup pre-resolve (merge uses .orig for its own purposes)
                 a = repo.wjoin(f)
                 try:
                     util.copyfile(a, a + b".resolve")
                 except FileNotFoundError:
                     pass
 
                 try:
                     # preresolve file
                     overrides = {(b'ui', b'forcemerge'): opts.get(b'tool', b'')}
                     with ui.configoverride(overrides, b'resolve'):
                         r = ms.resolve(f, wctx)
                     if r:
                         ret = 1
                 finally:
                     ms.commit()
 
                 # replace filemerge's .orig file with our resolve file
                 try:
                     util.rename(
                         a + b".resolve", scmutil.backuppath(ui, repo, f)
                     )
                 except FileNotFoundError:
                     pass
 
         if hasconflictmarkers:
             ui.warn(
                 _(
                     b'warning: the following files still have conflict '
                     b'markers:\n'
                 )
                 + b''.join(
                     b'  ' + uipathfn(f) + b'\n' for f in hasconflictmarkers
                 )
             )
             if markcheck == b'abort' and not all and not pats:
                 raise error.StateError(
                     _(b'conflict markers detected'),
                     hint=_(b'use --all to mark anyway'),
                 )
 
         ms.commit()
         branchmerge = repo.dirstate.p2() != repo.nullid
         # resolve is not doing a parent change here, however, `record updates`
         # will call some dirstate API that at intended for parent changes call.
         # Ideally we would not need this and could implement a lighter version
         # of the recordupdateslogic that will not have to deal with the part
         # related to parent changes. However this would requires that:
         # - we are sure we passed around enough information at update/merge
         #   time to no longer needs it at `hg resolve time`
         # - we are sure we store that information well enough to be able to reuse it
         # - we are the necessary logic to reuse it right.
         #
         # All this should eventually happens, but in the mean time, we use this
         # context manager slightly out of the context it should be.
         with repo.dirstate.changing_parents(repo):
             mergestatemod.recordupdates(repo, ms.actions(), branchmerge, None)
 
         if not didwork and pats:
             hint = None
             if not any([p for p in pats if p.find(b':') >= 0]):
                 pats = [b'path:%s' % p for p in pats]
                 m = scmutil.match(wctx, pats, opts)
                 for f in ms:
                     if not m(f):
                         continue
 
                     def flag(o):
                         if o == b're_merge':
                             return b'--re-merge '
                         return b'-%s ' % o[0:1]
 
                     flags = b''.join([flag(o) for o in flaglist if opts.get(o)])
                     hint = _(b"(try: hg resolve %s%s)\n") % (
                         flags,
                         b' '.join(pats),
                     )
                     break
             ui.warn(_(b"arguments do not match paths that need resolving\n"))
             if hint:
                 ui.warn(hint)
 
     unresolvedf = ms.unresolvedcount()
     if not unresolvedf:
         ui.status(_(b'(no more unresolved files)\n'))
         cmdutil.checkafterresolved(repo)
 
     return ret
 
 
 @command(
     b'revert',
     [
         (b'a', b'all', None, _(b'revert all changes when no arguments given')),
         (b'd', b'date', b'', _(b'tipmost revision matching date'), _(b'DATE')),
         (b'r', b'rev', b'', _(b'revert to the specified revision'), _(b'REV')),
         (b'C', b'no-backup', None, _(b'do not save backup copies of files')),
         (b'i', b'interactive', None, _(b'interactively select the changes')),
     ]
     + walkopts
     + dryrunopts,
     _(b'[OPTION]... [-r REV] [NAME]...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
 )
 def revert(ui, repo, *pats, **opts):
     """restore files to their checkout state
 
     .. note::
 
        To check out earlier revisions, you should use :hg:`update REV`.
        To cancel an uncommitted merge (and lose your changes),
        use :hg:`merge --abort`.
 
     With no revision specified, revert the specified files or directories
     to the contents they had in the parent of the working directory.
     This restores the contents of files to an unmodified
     state and unschedules adds, removes, copies, and renames. If the
     working directory has two parents, you must explicitly specify a
     revision.
 
     Using the -r/--rev or -d/--date options, revert the given files or
     directories to their states as of a specific revision. Because
     revert does not change the working directory parents, this will
     cause these files to appear modified. This can be helpful to "back
     out" some or all of an earlier change. See :hg:`backout` for a
     related method.
 
     Modified files are saved with a .orig suffix before reverting.
     To disable these backups, use --no-backup. It is possible to store
     the backup files in a custom directory relative to the root of the
     repository by setting the ``ui.origbackuppath`` configuration
     option.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     See :hg:`help backout` for a way to reverse the effect of an
     earlier changeset.
 
     Returns 0 on success.
     """
 
     opts = pycompat.byteskwargs(opts)
     if opts.get(b"date"):
         cmdutil.check_incompatible_arguments(opts, b'date', [b'rev'])
         opts[b"rev"] = cmdutil.finddate(ui, repo, opts[b"date"])
 
     parent, p2 = repo.dirstate.parents()
     if not opts.get(b'rev') and p2 != repo.nullid:
         # revert after merge is a trap for new users (issue2915)
         raise error.InputError(
             _(b'uncommitted merge with no revision specified'),
             hint=_(b"use 'hg update' or see 'hg help revert'"),
         )
 
     rev = opts.get(b'rev')
     if rev:
         repo = scmutil.unhidehashlikerevs(repo, [rev], b'nowarn')
     ctx = logcmdutil.revsingle(repo, rev)
 
     if not (
         pats
         or opts.get(b'include')
         or opts.get(b'exclude')
         or opts.get(b'all')
         or opts.get(b'interactive')
     ):
         msg = _(b"no files or directories specified")
         if p2 != repo.nullid:
             hint = _(
                 b"uncommitted merge, use --all to discard all changes,"
                 b" or 'hg update -C .' to abort the merge"
             )
             raise error.InputError(msg, hint=hint)
         dirty = any(repo.status())
         node = ctx.node()
         if node != parent:
             if dirty:
                 hint = (
                     _(
                         b"uncommitted changes, use --all to discard all"
                         b" changes, or 'hg update %d' to update"
                     )
                     % ctx.rev()
                 )
             else:
                 hint = (
                     _(
                         b"use --all to revert all files,"
                         b" or 'hg update %d' to update"
                     )
                     % ctx.rev()
                 )
         elif dirty:
             hint = _(b"uncommitted changes, use --all to discard all changes")
         else:
             hint = _(b"use --all to revert all files")
         raise error.InputError(msg, hint=hint)
 
     return cmdutil.revert(ui, repo, ctx, *pats, **pycompat.strkwargs(opts))
 
 
 @command(
     b'rollback',
     dryrunopts + [(b'f', b'force', False, _(b'ignore safety measures'))],
     helpcategory=command.CATEGORY_MAINTENANCE,
 )
 def rollback(ui, repo, **opts):
     """roll back the last transaction (DANGEROUS) (DEPRECATED)
 
     Please use :hg:`commit --amend` instead of rollback to correct
     mistakes in the last commit.
 
     This command should be used with care. There is only one level of
     rollback, and there is no way to undo a rollback. It will also
     restore the dirstate at the time of the last transaction, losing
     any dirstate changes since that time. This command does not alter
     the working directory.
 
     Transactions are used to encapsulate the effects of all commands
     that create new changesets or propagate existing changesets into a
     repository.
 
     .. container:: verbose
 
       For example, the following commands are transactional, and their
       effects can be rolled back:
 
       - commit
       - import
       - pull
       - push (with this repository as the destination)
       - unbundle
 
       To avoid permanent data loss, rollback will refuse to rollback a
       commit transaction if it isn't checked out. Use --force to
       override this protection.
 
       The rollback command can be entirely disabled by setting the
       ``ui.rollback`` configuration setting to false. If you're here
       because you want to use rollback and it's disabled, you can
       re-enable the command by setting ``ui.rollback`` to true.
 
     This command is not intended for use on public repositories. Once
     changes are visible for pull by other users, rolling a transaction
     back locally is ineffective (someone else may already have pulled
     the changes). Furthermore, a race is possible with readers of the
     repository; for example an in-progress pull from the repository
     may fail if a rollback is performed.
 
     Returns 0 on success, 1 if no rollback data is available.
     """
     if not ui.configbool(b'ui', b'rollback'):
         raise error.Abort(
             _(b'rollback is disabled because it is unsafe'),
             hint=b'see `hg help -v rollback` for information',
         )
     return repo.rollback(dryrun=opts.get('dry_run'), force=opts.get('force'))
 
 
 @command(
     b'root',
     [] + formatteropts,
     intents={INTENT_READONLY},
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
 )
 def root(ui, repo, **opts):
     """print the root (top) of the current working directory
 
     Print the root directory of the current repository.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions. See also :hg:`help templates`.
 
       :hgpath:    String. Path to the .hg directory.
       :storepath: String. Path to the directory holding versioned data.
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     with ui.formatter(b'root', opts) as fm:
         fm.startitem()
         fm.write(b'reporoot', b'%s\n', repo.root)
         fm.data(hgpath=repo.path, storepath=repo.spath)
 
 
 @command(
     b'serve',
     [
         (
             b'A',
             b'accesslog',
             b'',
             _(b'name of access log file to write to'),
             _(b'FILE'),
         ),
         (b'd', b'daemon', None, _(b'run server in background')),
         (b'', b'daemon-postexec', [], _(b'used internally by daemon mode')),
         (
             b'E',
             b'errorlog',
             b'',
             _(b'name of error log file to write to'),
             _(b'FILE'),
         ),
         # use string type, then we can check if something was passed
         (
             b'p',
             b'port',
             b'',
             _(b'port to listen on (default: 8000)'),
             _(b'PORT'),
         ),
         (
             b'a',
             b'address',
             b'',
             _(b'address to listen on (default: all interfaces)'),
             _(b'ADDR'),
         ),
         (
             b'',
             b'prefix',
             b'',
             _(b'prefix path to serve from (default: server root)'),
             _(b'PREFIX'),
         ),
         (
             b'n',
             b'name',
             b'',
             _(b'name to show in web pages (default: working directory)'),
             _(b'NAME'),
         ),
         (
             b'',
             b'web-conf',
             b'',
             _(b"name of the hgweb config file (see 'hg help hgweb')"),
             _(b'FILE'),
         ),
         (
             b'',
             b'webdir-conf',
             b'',
             _(b'name of the hgweb config file (DEPRECATED)'),
             _(b'FILE'),
         ),
         (
             b'',
             b'pid-file',
             b'',
             _(b'name of file to write process ID to'),
             _(b'FILE'),
         ),
         (b'', b'stdio', None, _(b'for remote clients (ADVANCED)')),
         (
             b'',
             b'cmdserver',
             b'',
             _(b'for remote clients (ADVANCED)'),
             _(b'MODE'),
         ),
         (b't', b'templates', b'', _(b'web templates to use'), _(b'TEMPLATE')),
         (b'', b'style', b'', _(b'template style to use'), _(b'STYLE')),
         (b'6', b'ipv6', None, _(b'use IPv6 instead of IPv4')),
         (b'', b'certificate', b'', _(b'SSL certificate file'), _(b'FILE')),
         (b'', b'print-url', None, _(b'start and print only the URL')),
     ]
     + subrepoopts,
     _(b'[OPTION]...'),
     helpcategory=command.CATEGORY_REMOTE_REPO_MANAGEMENT,
     helpbasic=True,
     optionalrepo=True,
 )
 def serve(ui, repo, **opts):
     """start stand-alone webserver
 
     Start a local HTTP repository browser and pull server. You can use
     this for ad-hoc sharing and browsing of repositories. It is
     recommended to use a real web server to serve a repository for
     longer periods of time.
 
     Please note that the server does not implement access control.
     This means that, by default, anybody can read from the server and
     nobody can write to it by default. Set the ``web.allow-push``
     option to ``*`` to allow everybody to push to the server. You
     should use a real web server if you need to authenticate users.
 
     By default, the server logs accesses to stdout and errors to
     stderr. Use the -A/--accesslog and -E/--errorlog options to log to
     files.
 
     To have the server choose a free port number to listen on, specify
     a port number of 0; in this case, the server will print the port
     number it uses.
 
     Returns 0 on success.
     """
 
     cmdutil.check_incompatible_arguments(opts, 'stdio', ['cmdserver'])
     opts = pycompat.byteskwargs(opts)
     if opts[b"print_url"] and ui.verbose:
         raise error.InputError(_(b"cannot use --print-url with --verbose"))
 
     if opts[b"stdio"]:
         if repo is None:
             raise error.RepoError(
                 _(b"there is no Mercurial repository here (.hg not found)")
             )
         s = wireprotoserver.sshserver(ui, repo)
         s.serve_forever()
         return
 
     service = server.createservice(ui, repo, opts)
     return server.runservice(opts, initfn=service.init, runfn=service.run)
 
 
 @command(
     b'shelve',
     [
         (
             b'A',
             b'addremove',
             None,
             _(b'mark new/missing files as added/removed before shelving'),
         ),
         (b'u', b'unknown', None, _(b'store unknown files in the shelve')),
         (b'', b'cleanup', None, _(b'delete all shelved changes')),
         (
             b'',
             b'date',
             b'',
             _(b'shelve with the specified commit date'),
             _(b'DATE'),
         ),
         (b'd', b'delete', None, _(b'delete the named shelved change(s)')),
         (b'e', b'edit', False, _(b'invoke editor on commit messages')),
         (
             b'k',
             b'keep',
             False,
             _(b'shelve, but keep changes in the working directory'),
         ),
         (b'l', b'list', None, _(b'list current shelves')),
         (b'm', b'message', b'', _(b'use text as shelve message'), _(b'TEXT')),
         (
             b'n',
             b'name',
             b'',
             _(b'use the given name for the shelved commit'),
             _(b'NAME'),
         ),
         (
             b'p',
             b'patch',
             None,
             _(
                 b'output patches for changes (provide the names of the shelved '
                 b'changes as positional arguments)'
             ),
         ),
         (b'i', b'interactive', None, _(b'interactive mode')),
         (
             b'',
             b'stat',
             None,
             _(
                 b'output diffstat-style summary of changes (provide the names of '
                 b'the shelved changes as positional arguments)'
             ),
         ),
     ]
     + cmdutil.walkopts,
     _(b'hg shelve [OPTION]... [FILE]...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
 )
 def shelve(ui, repo, *pats, **opts):
     """save and set aside changes from the working directory
 
     Shelving takes files that "hg status" reports as not clean, saves
     the modifications to a bundle (a shelved change), and reverts the
     files so that their state in the working directory becomes clean.
 
     To restore these changes to the working directory, using "hg
     unshelve"; this will work even if you switch to a different
     commit.
 
     When no files are specified, "hg shelve" saves all not-clean
     files. If specific files or directories are named, only changes to
     those files are shelved.
 
     In bare shelve (when no files are specified, without interactive,
     include and exclude option), shelving remembers information if the
     working directory was on newly created branch, in other words working
     directory was on different branch than its first parent. In this
     situation unshelving restores branch information to the working directory.
 
     Each shelved change has a name that makes it easier to find later.
     The name of a shelved change defaults to being based on the active
     bookmark, or if there is no active bookmark, the current named
     branch.  To specify a different name, use ``--name``.
 
     To see a list of existing shelved changes, use the ``--list``
     option. For each shelved change, this will print its name, age,
     and description; use ``--patch`` or ``--stat`` for more details.
 
     To delete specific shelved changes, use ``--delete``. To delete
     all shelved changes, use ``--cleanup``.
     """
     opts = pycompat.byteskwargs(opts)
     allowables = [
         (b'addremove', {b'create'}),  # 'create' is pseudo action
         (b'unknown', {b'create'}),
         (b'cleanup', {b'cleanup'}),
         #       ('date', {'create'}), # ignored for passing '--date "0 0"' in tests
         (b'delete', {b'delete'}),
         (b'edit', {b'create'}),
         (b'keep', {b'create'}),
         (b'list', {b'list'}),
         (b'message', {b'create'}),
         (b'name', {b'create'}),
         (b'patch', {b'patch', b'list'}),
         (b'stat', {b'stat', b'list'}),
     ]
 
     def checkopt(opt):
         if opts.get(opt):
             for i, allowable in allowables:
                 if opts[i] and opt not in allowable:
                     raise error.InputError(
                         _(
                             b"options '--%s' and '--%s' may not be "
                             b"used together"
                         )
                         % (opt, i)
                     )
             return True
 
     if checkopt(b'cleanup'):
         if pats:
             raise error.InputError(
                 _(b"cannot specify names when using '--cleanup'")
             )
         return shelvemod.cleanupcmd(ui, repo)
     elif checkopt(b'delete'):
         return shelvemod.deletecmd(ui, repo, pats)
     elif checkopt(b'list'):
         return shelvemod.listcmd(ui, repo, pats, opts)
     elif checkopt(b'patch') or checkopt(b'stat'):
         return shelvemod.patchcmds(ui, repo, pats, opts)
     else:
         return shelvemod.createcmd(ui, repo, pats, opts)
 
 
 _NOTTERSE = b'nothing'
 
 
 @command(
     b'status|st',
     [
         (b'A', b'all', None, _(b'show status of all files')),
         (b'm', b'modified', None, _(b'show only modified files')),
         (b'a', b'added', None, _(b'show only added files')),
         (b'r', b'removed', None, _(b'show only removed files')),
         (b'd', b'deleted', None, _(b'show only missing files')),
         (b'c', b'clean', None, _(b'show only files without changes')),
         (b'u', b'unknown', None, _(b'show only unknown (not tracked) files')),
         (b'i', b'ignored', None, _(b'show only ignored files')),
         (b'n', b'no-status', None, _(b'hide status prefix')),
         (b't', b'terse', _NOTTERSE, _(b'show the terse output (EXPERIMENTAL)')),
         (
             b'C',
             b'copies',
             None,
             _(b'show source of copied files (DEFAULT: ui.statuscopies)'),
         ),
         (
             b'0',
             b'print0',
             None,
             _(b'end filenames with NUL, for use with xargs'),
         ),
         (b'', b'rev', [], _(b'show difference from revision'), _(b'REV')),
         (
             b'',
             b'change',
             b'',
             _(b'list the changed files of a revision'),
             _(b'REV'),
         ),
     ]
     + walkopts
     + subrepoopts
     + formatteropts,
     _(b'[OPTION]... [FILE]...'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
     helpbasic=True,
     inferrepo=True,
     intents={INTENT_READONLY},
 )
 def status(ui, repo, *pats, **opts):
     """show changed files in the working directory
 
     Show status of files in the repository. If names are given, only
     files that match are shown. Files that are clean or ignored or
     the source of a copy/move operation, are not listed unless
     -c/--clean, -i/--ignored, -C/--copies or -A/--all are given.
     Unless options described with "show only ..." are given, the
     options -mardu are used.
 
     Option -q/--quiet hides untracked (unknown and ignored) files
     unless explicitly requested with -u/--unknown or -i/--ignored.
 
     .. note::
 
        :hg:`status` may appear to disagree with diff if permissions have
        changed or a merge has occurred. The standard diff format does
        not report permission changes and diff only reports changes
        relative to one merge parent.
 
     If one revision is given, it is used as the base revision.
     If two revisions are given, the differences between them are
     shown. The --change option can also be used as a shortcut to list
     the changed files of a revision from its first parent.
 
     The codes used to show the status of files are::
 
       M = modified
       A = added
       R = removed
       C = clean
       ! = missing (deleted by non-hg command, but still tracked)
       ? = not tracked
       I = ignored
         = origin of the previous file (with --copies)
 
     .. container:: verbose
 
       The -t/--terse option abbreviates the output by showing only the directory
       name if all the files in it share the same status. The option takes an
       argument indicating the statuses to abbreviate: 'm' for 'modified', 'a'
       for 'added', 'r' for 'removed', 'd' for 'deleted', 'u' for 'unknown', 'i'
       for 'ignored' and 'c' for clean.
 
       It abbreviates only those statuses which are passed. Note that clean and
       ignored files are not displayed with '--terse ic' unless the -c/--clean
       and -i/--ignored options are also used.
 
       The -v/--verbose option shows information when the repository is in an
       unfinished merge, shelve, rebase state etc. You can have this behavior
       turned on by default by enabling the ``commands.status.verbose`` option.
 
       You can skip displaying some of these states by setting
       ``commands.status.skipstates`` to one or more of: 'bisect', 'graft',
       'histedit', 'merge', 'rebase', or 'unshelve'.
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions. See also :hg:`help templates`.
 
       :path:    String. Repository-absolute path of the file.
       :source:  String. Repository-absolute path of the file originated from.
                 Available if ``--copies`` is specified.
       :status:  String. Character denoting file's status.
 
       Examples:
 
       - show changes in the working directory relative to a
         changeset::
 
           hg status --rev 9353
 
       - show changes in the working directory relative to the
         current directory (see :hg:`help patterns` for more information)::
 
           hg status re:
 
       - show all changes including copies in an existing changeset::
 
           hg status --copies --change 9353
 
       - get a NUL separated list of added files, suitable for xargs::
 
           hg status -an0
 
       - show more information about the repository status, abbreviating
         added, removed, modified, deleted, and untracked paths::
 
           hg status -v -t mardu
 
     Returns 0 on success.
 
     """
 
     cmdutil.check_at_most_one_arg(opts, 'rev', 'change')
     opts = pycompat.byteskwargs(opts)
     revs = opts.get(b'rev', [])
     change = opts.get(b'change', b'')
     terse = opts.get(b'terse', _NOTTERSE)
     if terse is _NOTTERSE:
         if revs:
             terse = b''
         else:
             terse = ui.config(b'commands', b'status.terse')
 
     if revs and terse:
         msg = _(b'cannot use --terse with --rev')
         raise error.InputError(msg)
     elif change:
         repo = scmutil.unhidehashlikerevs(repo, [change], b'nowarn')
         ctx2 = logcmdutil.revsingle(repo, change, None)
         ctx1 = ctx2.p1()
     else:
         repo = scmutil.unhidehashlikerevs(repo, revs, b'nowarn')
         ctx1, ctx2 = logcmdutil.revpair(repo, revs)
 
     forcerelativevalue = None
     if ui.hasconfig(b'commands', b'status.relative'):
         forcerelativevalue = ui.configbool(b'commands', b'status.relative')
     uipathfn = scmutil.getuipathfn(
         repo,
         legacyrelativevalue=bool(pats),
         forcerelativevalue=forcerelativevalue,
     )
 
     if opts.get(b'print0'):
         end = b'\0'
     else:
         end = b'\n'
     states = b'modified added removed deleted unknown ignored clean'.split()
     show = [k for k in states if opts.get(k)]
     if opts.get(b'all'):
         show += ui.quiet and (states[:4] + [b'clean']) or states
 
     if not show:
         if ui.quiet:
             show = states[:4]
         else:
             show = states[:5]
 
     m = scmutil.match(ctx2, pats, opts)
     if terse:
         # we need to compute clean and unknown to terse
         stat = repo.status(
             ctx1.node(),
             ctx2.node(),
             m,
             b'ignored' in show or b'i' in terse,
             clean=True,
             unknown=True,
             listsubrepos=opts.get(b'subrepos'),
         )
 
         stat = cmdutil.tersedir(stat, terse)
     else:
         stat = repo.status(
             ctx1.node(),
             ctx2.node(),
             m,
             b'ignored' in show,
             b'clean' in show,
             b'unknown' in show,
             opts.get(b'subrepos'),
         )
 
     changestates = zip(
         states,
         pycompat.iterbytestr(b'MAR!?IC'),
         [getattr(stat, s.decode('utf8')) for s in states],
     )
 
     copy = {}
     show_copies = ui.configbool(b'ui', b'statuscopies')
     if opts.get(b'copies') is not None:
         show_copies = opts.get(b'copies')
     show_copies = (show_copies or opts.get(b'all')) and not opts.get(
         b'no_status'
     )
     if show_copies:
         copy = copies.pathcopies(ctx1, ctx2, m)
 
     morestatus = None
     if (
         (ui.verbose or ui.configbool(b'commands', b'status.verbose'))
         and not ui.plain()
         and not opts.get(b'print0')
     ):
         morestatus = cmdutil.readmorestatus(repo)
 
     ui.pager(b'status')
     fm = ui.formatter(b'status', opts)
     fmt = b'%s' + end
     showchar = not opts.get(b'no_status')
 
     for state, char, files in changestates:
         if state in show:
             label = b'status.' + state
             for f in files:
                 fm.startitem()
                 fm.context(ctx=ctx2)
                 fm.data(itemtype=b'file', path=f)
                 fm.condwrite(showchar, b'status', b'%s ', char, label=label)
                 fm.plain(fmt % uipathfn(f), label=label)
                 if f in copy:
                     fm.data(source=copy[f])
                     fm.plain(
                         (b'  %s' + end) % uipathfn(copy[f]),
                         label=b'status.copied',
                     )
                 if morestatus:
                     morestatus.formatfile(f, fm)
 
     if morestatus:
         morestatus.formatfooter(fm)
     fm.end()
 
 
 @command(
     b'summary|sum',
     [(b'', b'remote', None, _(b'check for push and pull'))],
     b'[--remote]',
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
     helpbasic=True,
     intents={INTENT_READONLY},
 )
 def summary(ui, repo, **opts):
     """summarize working directory state
 
     This generates a brief summary of the working directory state,
     including parents, branch, commit status, phase and available updates.
 
     With the --remote option, this will check the default paths for
     incoming and outgoing changes. This can be time-consuming.
 
     Returns 0 on success.
     """
 
     opts = pycompat.byteskwargs(opts)
     ui.pager(b'summary')
     ctx = repo[None]
     parents = ctx.parents()
     pnode = parents[0].node()
     marks = []
 
     try:
         ms = mergestatemod.mergestate.read(repo)
     except error.UnsupportedMergeRecords as e:
         s = b' '.join(e.recordtypes)
         ui.warn(
             _(b'warning: merge state has unsupported record types: %s\n') % s
         )
         unresolved = []
     else:
         unresolved = list(ms.unresolved())
 
     for p in parents:
         # label with log.changeset (instead of log.parent) since this
         # shows a working directory parent *changeset*:
         # i18n: column positioning for "hg summary"
         ui.write(
             _(b'parent: %d:%s ') % (p.rev(), p),
             label=logcmdutil.changesetlabels(p),
         )
         ui.write(b' '.join(p.tags()), label=b'log.tag')
         if p.bookmarks():
             marks.extend(p.bookmarks())
         if p.rev() == -1:
             if not len(repo):
                 ui.write(_(b' (empty repository)'))
             else:
                 ui.write(_(b' (no revision checked out)'))
         if p.obsolete():
             ui.write(_(b' (obsolete)'))
         if p.isunstable():
             instabilities = (
                 ui.label(instability, b'trouble.%s' % instability)
                 for instability in p.instabilities()
             )
             ui.write(b' (' + b', '.join(instabilities) + b')')
         ui.write(b'\n')
         if p.description():
             ui.status(
                 b' ' + p.description().splitlines()[0].strip() + b'\n',
                 label=b'log.summary',
             )
 
     branch = ctx.branch()
     bheads = repo.branchheads(branch)
     # i18n: column positioning for "hg summary"
     m = _(b'branch: %s\n') % branch
     if branch != b'default':
         ui.write(m, label=b'log.branch')
     else:
         ui.status(m, label=b'log.branch')
 
     if marks:
         active = repo._activebookmark
         # i18n: column positioning for "hg summary"
         ui.write(_(b'bookmarks:'), label=b'log.bookmark')
         if active is not None:
             if active in marks:
                 ui.write(b' *' + active, label=bookmarks.activebookmarklabel)
                 marks.remove(active)
             else:
                 ui.write(b' [%s]' % active, label=bookmarks.activebookmarklabel)
         for m in marks:
             ui.write(b' ' + m, label=b'log.bookmark')
         ui.write(b'\n', label=b'log.bookmark')
 
     status = repo.status(unknown=True)
 
     c = repo.dirstate.copies()
     copied, renamed = [], []
     for d, s in c.items():
         if s in status.removed:
             status.removed.remove(s)
             renamed.append(d)
         else:
             copied.append(d)
         if d in status.added:
             status.added.remove(d)
 
     subs = [s for s in ctx.substate if ctx.sub(s).dirty()]
 
     labels = [
         (ui.label(_(b'%d modified'), b'status.modified'), status.modified),
         (ui.label(_(b'%d added'), b'status.added'), status.added),
         (ui.label(_(b'%d removed'), b'status.removed'), status.removed),
         (ui.label(_(b'%d renamed'), b'status.copied'), renamed),
         (ui.label(_(b'%d copied'), b'status.copied'), copied),
         (ui.label(_(b'%d deleted'), b'status.deleted'), status.deleted),
         (ui.label(_(b'%d unknown'), b'status.unknown'), status.unknown),
         (ui.label(_(b'%d unresolved'), b'resolve.unresolved'), unresolved),
         (ui.label(_(b'%d subrepos'), b'status.modified'), subs),
     ]
     t = []
     for l, s in labels:
         if s:
             t.append(l % len(s))
 
     t = b', '.join(t)
     cleanworkdir = False
 
     if repo.vfs.exists(b'graftstate'):
         t += _(b' (graft in progress)')
     if repo.vfs.exists(b'updatestate'):
         t += _(b' (interrupted update)')
     elif len(parents) > 1:
         t += _(b' (merge)')
     elif branch != parents[0].branch():
         t += _(b' (new branch)')
     elif parents[0].closesbranch() and pnode in repo.branchheads(
         branch, closed=True
     ):
         t += _(b' (head closed)')
     elif not (
         status.modified
         or status.added
         or status.removed
         or renamed
         or copied
         or subs
     ):
         t += _(b' (clean)')
         cleanworkdir = True
     elif pnode not in bheads:
         t += _(b' (new branch head)')
 
     if parents:
         pendingphase = max(p.phase() for p in parents)
     else:
         pendingphase = phases.public
 
     if pendingphase > phases.newcommitphase(ui):
         t += b' (%s)' % phases.phasenames[pendingphase]
 
     if cleanworkdir:
         # i18n: column positioning for "hg summary"
         ui.status(_(b'commit: %s\n') % t.strip())
     else:
         # i18n: column positioning for "hg summary"
         ui.write(_(b'commit: %s\n') % t.strip())
 
     # all ancestors of branch heads - all ancestors of parent = new csets
     new = len(
         repo.changelog.findmissing([pctx.node() for pctx in parents], bheads)
     )
 
     if new == 0:
         # i18n: column positioning for "hg summary"
         ui.status(_(b'update: (current)\n'))
     elif pnode not in bheads:
         # i18n: column positioning for "hg summary"
         ui.write(_(b'update: %d new changesets (update)\n') % new)
     else:
         # i18n: column positioning for "hg summary"
         ui.write(
             _(b'update: %d new changesets, %d branch heads (merge)\n')
             % (new, len(bheads))
         )
 
     t = []
     draft = len(repo.revs(b'draft()'))
     if draft:
         t.append(_(b'%d draft') % draft)
     secret = len(repo.revs(b'secret()'))
     if secret:
         t.append(_(b'%d secret') % secret)
 
     if draft or secret:
         ui.status(_(b'phases: %s\n') % b', '.join(t))
 
     if obsolete.isenabled(repo, obsolete.createmarkersopt):
         for trouble in (b"orphan", b"contentdivergent", b"phasedivergent"):
             numtrouble = len(repo.revs(trouble + b"()"))
             # We write all the possibilities to ease translation
             troublemsg = {
                 b"orphan": _(b"orphan: %d changesets"),
                 b"contentdivergent": _(b"content-divergent: %d changesets"),
                 b"phasedivergent": _(b"phase-divergent: %d changesets"),
             }
             if numtrouble > 0:
                 ui.status(troublemsg[trouble] % numtrouble + b"\n")
 
     cmdutil.summaryhooks(ui, repo)
 
     if opts.get(b'remote'):
         needsincoming, needsoutgoing = True, True
     else:
         needsincoming, needsoutgoing = False, False
         for i, o in cmdutil.summaryremotehooks(ui, repo, opts, None):
             if i:
                 needsincoming = True
             if o:
                 needsoutgoing = True
         if not needsincoming and not needsoutgoing:
             return
 
     def getincoming():
         # XXX We should actually skip this if no default is specified, instead
         # of passing "default" which will resolve as "./default/" if no default
         # path is defined.
         path = urlutil.get_unique_pull_path_obj(b'summary', ui, b'default')
         sbranch = path.branch
         try:
             other = hg.peer(repo, {}, path)
         except error.RepoError:
             if opts.get(b'remote'):
                 raise
             return path.loc, sbranch, None, None, None
         branches = (path.branch, [])
         revs, checkout = hg.addbranchrevs(repo, other, branches, None)
         if revs:
             revs = [other.lookup(rev) for rev in revs]
         ui.debug(b'comparing with %s\n' % urlutil.hidepassword(path.loc))
         with repo.ui.silent():
             commoninc = discovery.findcommonincoming(repo, other, heads=revs)
         return path.loc, sbranch, other, commoninc, commoninc[1]
 
     if needsincoming:
         source, sbranch, sother, commoninc, incoming = getincoming()
     else:
         source = sbranch = sother = commoninc = incoming = None
 
     def getoutgoing():
         # XXX We should actually skip this if no default is specified, instead
         # of passing "default" which will resolve as "./default/" if no default
         # path is defined.
         d = None
         if b'default-push' in ui.paths:
             d = b'default-push'
         elif b'default' in ui.paths:
             d = b'default'
         path = None
         if d is not None:
             path = urlutil.get_unique_push_path(b'summary', repo, ui, d)
             dest = path.loc
             dbranch = path.branch
         else:
             dest = b'default'
             dbranch = None
         revs, checkout = hg.addbranchrevs(repo, repo, (dbranch, []), None)
         if source != dest:
             try:
                 dother = hg.peer(repo, {}, path if path is not None else dest)
             except error.RepoError:
                 if opts.get(b'remote'):
                     raise
                 return dest, dbranch, None, None
             ui.debug(b'comparing with %s\n' % urlutil.hidepassword(dest))
         elif sother is None:
             # there is no explicit destination peer, but source one is invalid
             return dest, dbranch, None, None
         else:
             dother = sother
         if source != dest or (sbranch is not None and sbranch != dbranch):
             common = None
         else:
             common = commoninc
         if revs:
             revs = [repo.lookup(rev) for rev in revs]
         with repo.ui.silent():
             outgoing = discovery.findcommonoutgoing(
                 repo, dother, onlyheads=revs, commoninc=common
             )
         return dest, dbranch, dother, outgoing
 
     if needsoutgoing:
         dest, dbranch, dother, outgoing = getoutgoing()
     else:
         dest = dbranch = dother = outgoing = None
 
     if opts.get(b'remote'):
         # Help pytype.  --remote sets both `needsincoming` and `needsoutgoing`.
         # The former always sets `sother` (or raises an exception if it can't);
         # the latter always sets `outgoing`.
         assert sother is not None
         assert outgoing is not None
 
         t = []
         if incoming:
             t.append(_(b'1 or more incoming'))
         o = outgoing.missing
         if o:
             t.append(_(b'%d outgoing') % len(o))
         other = dother or sother
         if b'bookmarks' in other.listkeys(b'namespaces'):
             counts = bookmarks.summary(repo, other)
             if counts[0] > 0:
                 t.append(_(b'%d incoming bookmarks') % counts[0])
             if counts[1] > 0:
                 t.append(_(b'%d outgoing bookmarks') % counts[1])
 
         if t:
             # i18n: column positioning for "hg summary"
             ui.write(_(b'remote: %s\n') % (b', '.join(t)))
         else:
             # i18n: column positioning for "hg summary"
             ui.status(_(b'remote: (synced)\n'))
 
     cmdutil.summaryremotehooks(
         ui,
         repo,
         opts,
         (
             (source, sbranch, sother, commoninc),
             (dest, dbranch, dother, outgoing),
         ),
     )
 
 
 @command(
     b'tag',
     [
         (b'f', b'force', None, _(b'force tag')),
         (b'l', b'local', None, _(b'make the tag local')),
         (b'r', b'rev', b'', _(b'revision to tag'), _(b'REV')),
         (b'', b'remove', None, _(b'remove a tag')),
         # -l/--local is already there, commitopts cannot be used
         (b'e', b'edit', None, _(b'invoke editor on commit messages')),
         (b'm', b'message', b'', _(b'use text as commit message'), _(b'TEXT')),
     ]
     + commitopts2,
     _(b'[-f] [-l] [-m TEXT] [-d DATE] [-u USER] [-r REV] NAME...'),
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
 )
 def tag(ui, repo, name1, *names, **opts):
     """add one or more tags for the current or given revision
 
     Name a particular revision using <name>.
 
     Tags are used to name particular revisions of the repository and are
     very useful to compare different revisions, to go back to significant
     earlier versions or to mark branch points as releases, etc. Changing
     an existing tag is normally disallowed; use -f/--force to override.
 
     If no revision is given, the parent of the working directory is
     used.
 
     To facilitate version control, distribution, and merging of tags,
     they are stored as a file named ".hgtags" which is managed similarly
     to other project files and can be hand-edited if necessary. This
     also means that tagging creates a new commit. The file
     ".hg/localtags" is used for local tags (not shared among
     repositories).
 
     Tag commits are usually made at the head of a branch. If the parent
     of the working directory is not a branch head, :hg:`tag` aborts; use
     -f/--force to force the tag commit to be based on a non-head
     changeset.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     Since tag names have priority over branch names during revision
     lookup, using an existing branch name as a tag name is discouraged.
 
     Returns 0 on success.
     """
     cmdutil.check_incompatible_arguments(opts, 'remove', ['rev'])
     opts = pycompat.byteskwargs(opts)
     with repo.wlock(), repo.lock():
         rev_ = b"."
         names = [t.strip() for t in (name1,) + names]
         if len(names) != len(set(names)):
             raise error.InputError(_(b'tag names must be unique'))
         for n in names:
             scmutil.checknewlabel(repo, n, b'tag')
             if not n:
                 raise error.InputError(
                     _(b'tag names cannot consist entirely of whitespace')
                 )
         if opts.get(b'rev'):
             rev_ = opts[b'rev']
         message = opts.get(b'message')
         if opts.get(b'remove'):
             if opts.get(b'local'):
                 expectedtype = b'local'
             else:
                 expectedtype = b'global'
 
             for n in names:
                 if repo.tagtype(n) == b'global':
                     alltags = tagsmod.findglobaltags(ui, repo)
                     if alltags[n][0] == repo.nullid:
                         raise error.InputError(
                             _(b"tag '%s' is already removed") % n
                         )
                 if not repo.tagtype(n):
                     raise error.InputError(_(b"tag '%s' does not exist") % n)
                 if repo.tagtype(n) != expectedtype:
                     if expectedtype == b'global':
                         raise error.InputError(
                             _(b"tag '%s' is not a global tag") % n
                         )
                     else:
                         raise error.InputError(
                             _(b"tag '%s' is not a local tag") % n
                         )
             rev_ = b'null'
             if not message:
                 # we don't translate commit messages
                 message = b'Removed tag %s' % b', '.join(names)
         elif not opts.get(b'force'):
             for n in names:
                 if n in repo.tags():
                     raise error.InputError(
                         _(b"tag '%s' already exists (use -f to force)") % n
                     )
         if not opts.get(b'local'):
             p1, p2 = repo.dirstate.parents()
             if p2 != repo.nullid:
                 raise error.StateError(_(b'uncommitted merge'))
             bheads = repo.branchheads()
             if not opts.get(b'force') and bheads and p1 not in bheads:
                 raise error.InputError(
                     _(
                         b'working directory is not at a branch head '
                         b'(use -f to force)'
                     )
                 )
         node = logcmdutil.revsingle(repo, rev_).node()
 
         # don't allow tagging the null rev or the working directory
         if node is None:
             raise error.InputError(_(b"cannot tag working directory"))
         elif not opts.get(b'remove') and node == nullid:
             raise error.InputError(_(b"cannot tag null revision"))
 
         if not message:
             # we don't translate commit messages
             message = b'Added tag %s for changeset %s' % (
                 b', '.join(names),
                 short(node),
             )
 
         date = opts.get(b'date')
         if date:
             date = dateutil.parsedate(date)
 
         if opts.get(b'remove'):
             editform = b'tag.remove'
         else:
             editform = b'tag.add'
         editor = cmdutil.getcommiteditor(
             editform=editform, **pycompat.strkwargs(opts)
         )
 
         tagsmod.tag(
             repo,
             names,
             node,
             message,
             opts.get(b'local'),
             opts.get(b'user'),
             date,
             editor=editor,
         )
 
 
 @command(
     b'tags',
     formatteropts,
     b'',
     helpcategory=command.CATEGORY_CHANGE_ORGANIZATION,
     intents={INTENT_READONLY},
 )
 def tags(ui, repo, **opts):
     """list repository tags
 
     This lists both regular and local tags. When the -v/--verbose
     switch is used, a third column "local" is printed for local tags.
     When the -q/--quiet switch is used, only the tag name is printed.
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported in addition to the common template
       keywords and functions such as ``{tag}``. See also
       :hg:`help templates`.
 
       :type:    String. ``local`` for local tags.
 
     Returns 0 on success.
     """
 
     opts = pycompat.byteskwargs(opts)
     ui.pager(b'tags')
     fm = ui.formatter(b'tags', opts)
     hexfunc = fm.hexfunc
 
     for t, n in reversed(repo.tagslist()):
         hn = hexfunc(n)
         label = b'tags.normal'
         tagtype = repo.tagtype(t)
         if not tagtype or tagtype == b'global':
             tagtype = b''
         else:
             label = b'tags.' + tagtype
 
         fm.startitem()
         fm.context(repo=repo)
         fm.write(b'tag', b'%s', t, label=label)
         fmt = b" " * (30 - encoding.colwidth(t)) + b' %5d:%s'
         fm.condwrite(
             not ui.quiet,
             b'rev node',
             fmt,
             repo.changelog.rev(n),
             hn,
             label=label,
         )
         fm.condwrite(
             ui.verbose and tagtype, b'type', b' %s', tagtype, label=label
         )
         fm.plain(b'\n')
     fm.end()
 
 
 @command(
     b'tip',
     [
         (b'p', b'patch', None, _(b'show patch')),
         (b'g', b'git', None, _(b'use git extended diff format')),
     ]
     + templateopts,
     _(b'[-p] [-g]'),
     helpcategory=command.CATEGORY_CHANGE_NAVIGATION,
 )
 def tip(ui, repo, **opts):
     """show the tip revision (DEPRECATED)
 
     The tip revision (usually just called the tip) is the changeset
     most recently added to the repository (and therefore the most
     recently changed head).
 
     If you have just made a commit, that commit will be the tip. If
     you have just pulled changes from another repository, the tip of
     that repository becomes the current tip. The "tip" tag is special
     and cannot be renamed or assigned to a different changeset.
 
     This command is deprecated, please use :hg:`heads` instead.
 
     Returns 0 on success.
     """
     opts = pycompat.byteskwargs(opts)
     displayer = logcmdutil.changesetdisplayer(ui, repo, opts)
     displayer.show(repo[b'tip'])
     displayer.close()
 
 
 @command(
     b'unbundle',
     [
         (
             b'u',
             b'update',
             None,
             _(b'update to new branch head if changesets were unbundled'),
         )
     ],
     _(b'[-u] FILE...'),
     helpcategory=command.CATEGORY_IMPORT_EXPORT,
 )
 def unbundle(ui, repo, fname1, *fnames, **opts):
     """apply one or more bundle files
 
     Apply one or more bundle files generated by :hg:`bundle`.
 
     Returns 0 on success, 1 if an update has unresolved files.
     """
     fnames = (fname1,) + fnames
 
     with repo.lock():
         for fname in fnames:
             f = hg.openpath(ui, fname)
             gen = exchange.readbundle(ui, f, fname)
             if isinstance(gen, streamclone.streamcloneapplier):
                 raise error.InputError(
                     _(
                         b'packed bundles cannot be applied with '
                         b'"hg unbundle"'
                     ),
                     hint=_(b'use "hg debugapplystreamclonebundle"'),
                 )
             url = b'bundle:' + fname
             try:
                 txnname = b'unbundle'
                 if not isinstance(gen, bundle2.unbundle20):
                     txnname = b'unbundle\n%s' % urlutil.hidepassword(url)
                 with repo.transaction(txnname) as tr:
                     op = bundle2.applybundle(
                         repo, gen, tr, source=b'unbundle', url=url
                     )
             except error.BundleUnknownFeatureError as exc:
                 raise error.Abort(
                     _(b'%s: unknown bundle feature, %s') % (fname, exc),
                     hint=_(
                         b"see https://mercurial-scm.org/"
                         b"wiki/BundleFeature for more "
                         b"information"
                     ),
                 )
             modheads = bundle2.combinechangegroupresults(op)
 
     if postincoming(ui, repo, modheads, opts.get('update'), None, None):
         return 1
     else:
         return 0
 
 
 @command(
     b'unshelve',
     [
         (b'a', b'abort', None, _(b'abort an incomplete unshelve operation')),
         (
             b'c',
             b'continue',
             None,
             _(b'continue an incomplete unshelve operation'),
         ),
         (b'i', b'interactive', None, _(b'use interactive mode (EXPERIMENTAL)')),
         (b'k', b'keep', None, _(b'keep shelve after unshelving')),
         (
             b'n',
             b'name',
             b'',
             _(b'restore shelved change with given name'),
             _(b'NAME'),
         ),
         (b't', b'tool', b'', _(b'specify merge tool')),
         (
             b'',
             b'date',
             b'',
             _(b'set date for temporary commits (DEPRECATED)'),
             _(b'DATE'),
         ),
     ],
     _(b'hg unshelve [OPTION]... [[-n] SHELVED]'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
 )
 def unshelve(ui, repo, *shelved, **opts):
     """restore a shelved change to the working directory
 
     This command accepts an optional name of a shelved change to
     restore. If none is given, the most recent shelved change is used.
 
     If a shelved change is applied successfully, the bundle that
     contains the shelved changes is moved to a backup location
     (.hg/shelve-backup).
 
     Since you can restore a shelved change on top of an arbitrary
     commit, it is possible that unshelving will result in a conflict
     between your changes and the commits you are unshelving onto. If
     this occurs, you must resolve the conflict, then use
     ``--continue`` to complete the unshelve operation. (The bundle
     will not be moved until you successfully complete the unshelve.)
 
     (Alternatively, you can use ``--abort`` to abandon an unshelve
     that causes a conflict. This reverts the unshelved changes, and
     leaves the bundle in place.)
 
     If bare shelved change (without interactive, include and exclude
     option) was done on newly created branch it would restore branch
     information to the working directory.
 
     After a successful unshelve, the shelved changes are stored in a
     backup directory. Only the N most recent backups are kept. N
     defaults to 10 but can be overridden using the ``shelve.maxbackups``
     configuration option.
 
     .. container:: verbose
 
        Timestamp in seconds is used to decide order of backups. More
        than ``maxbackups`` backups are kept, if same timestamp
        prevents from deciding exact order of them, for safety.
 
        Selected changes can be unshelved with ``--interactive`` flag.
        The working directory is updated with the selected changes, and
        only the unselected changes remain shelved.
        Note: The whole shelve is applied to working directory first before
        running interactively. So, this will bring up all the conflicts between
        working directory and the shelve, irrespective of which changes will be
        unshelved.
     """
     with repo.wlock():
         return shelvemod.unshelvecmd(ui, repo, *shelved, **opts)
 
 
 statemod.addunfinished(
     b'unshelve',
     fname=b'shelvedstate',
     continueflag=True,
     abortfunc=shelvemod.hgabortunshelve,
     continuefunc=shelvemod.hgcontinueunshelve,
     cmdmsg=_(b'unshelve already in progress'),
 )
 
 
 @command(
     b'update|up|checkout|co',
     [
         (b'C', b'clean', None, _(b'discard uncommitted changes (no backup)')),
         (b'c', b'check', None, _(b'require clean working directory')),
         (b'm', b'merge', None, _(b'merge uncommitted changes')),
         (b'd', b'date', b'', _(b'tipmost revision matching date'), _(b'DATE')),
         (b'r', b'rev', b'', _(b'revision'), _(b'REV')),
     ]
     + mergetoolopts,
     _(b'[-C|-c|-m] [-d DATE] [[-r] REV]'),
     helpcategory=command.CATEGORY_WORKING_DIRECTORY,
     helpbasic=True,
 )
 def update(ui, repo, node=None, **opts):
     """update working directory (or switch revisions)
 
     Update the repository's working directory to the specified
     changeset. If no changeset is specified, update to the tip of the
     current named branch and move the active bookmark (see :hg:`help
     bookmarks`).
 
     Update sets the working directory's parent revision to the specified
     changeset (see :hg:`help parents`).
 
     If the changeset is not a descendant or ancestor of the working
     directory's parent and there are uncommitted changes, the update is
     aborted. With the -c/--check option, the working directory is checked
     for uncommitted changes; if none are found, the working directory is
     updated to the specified changeset.
 
     .. container:: verbose
 
       The -C/--clean, -c/--check, and -m/--merge options control what
       happens if the working directory contains uncommitted changes.
       At most of one of them can be specified.
 
       1. If no option is specified, and if
          the requested changeset is an ancestor or descendant of
          the working directory's parent, the uncommitted changes
          are merged into the requested changeset and the merged
          result is left uncommitted. If the requested changeset is
          not an ancestor or descendant (that is, it is on another
          branch), the update is aborted and the uncommitted changes
          are preserved.
 
       2. With the -m/--merge option, the update is allowed even if the
          requested changeset is not an ancestor or descendant of
          the working directory's parent.
 
       3. With the -c/--check option, the update is aborted and the
          uncommitted changes are preserved.
 
       4. With the -C/--clean option, uncommitted changes are discarded and
          the working directory is updated to the requested changeset.
 
     To cancel an uncommitted merge (and lose your changes), use
     :hg:`merge --abort`.
 
     Use null as the changeset to remove the working directory (like
     :hg:`clone -U`).
 
     If you want to revert just one file to an older revision, use
     :hg:`revert [-r REV] NAME`.
 
     See :hg:`help dates` for a list of formats valid for -d/--date.
 
     Returns 0 on success, 1 if there are unresolved files.
     """
     cmdutil.check_at_most_one_arg(opts, 'clean', 'check', 'merge')
     rev = opts.get('rev')
     date = opts.get('date')
     clean = opts.get('clean')
     check = opts.get('check')
     merge = opts.get('merge')
     if rev and node:
         raise error.InputError(_(b"please specify just one revision"))
 
     if ui.configbool(b'commands', b'update.requiredest'):
         if not node and not rev and not date:
             raise error.InputError(
                 _(b'you must specify a destination'),
                 hint=_(b'for example: hg update ".::"'),
             )
 
     if rev is None or rev == b'':
         rev = node
 
     if date and rev is not None:
         raise error.InputError(_(b"you can't specify a revision and a date"))
 
     updatecheck = None
     if check or merge is not None and not merge:
         updatecheck = b'abort'
     elif merge or check is not None and not check:
         updatecheck = b'none'
 
     with repo.wlock():
         cmdutil.clearunfinished(repo)
         if date:
             rev = cmdutil.finddate(ui, repo, date)
 
         # if we defined a bookmark, we have to remember the original name
         brev = rev
         if rev:
             repo = scmutil.unhidehashlikerevs(repo, [rev], b'nowarn')
         ctx = logcmdutil.revsingle(repo, rev, default=None)
         rev = ctx.rev()
         hidden = ctx.hidden()
         overrides = {(b'ui', b'forcemerge'): opts.get('tool', b'')}
         with ui.configoverride(overrides, b'update'):
             ret = hg.updatetotally(
                 ui, repo, rev, brev, clean=clean, updatecheck=updatecheck
             )
         if hidden:
             ctxstr = ctx.hex()[:12]
             ui.warn(_(b"updated to hidden changeset %s\n") % ctxstr)
 
             if ctx.obsolete():
                 obsfatemsg = obsutil._getfilteredreason(repo, ctxstr, ctx)
                 ui.warn(b"(%s)\n" % obsfatemsg)
         return ret
 
 
 @command(
     b'verify',
     [(b'', b'full', False, b'perform more checks (EXPERIMENTAL)')],
     helpcategory=command.CATEGORY_MAINTENANCE,
 )
 def verify(ui, repo, **opts):
     """verify the integrity of the repository
 
     Verify the integrity of the current repository.
 
     This will perform an extensive check of the repository's
     integrity, validating the hashes and checksums of each entry in
     the changelog, manifest, and tracked files, as well as the
     integrity of their crosslinks and indices.
 
     Please see https://mercurial-scm.org/wiki/RepositoryCorruption
     for more information about recovery from corruption of the
     repository.
 
     Returns 0 on success, 1 if errors are encountered.
     """
     opts = pycompat.byteskwargs(opts)
 
     level = None
     if opts[b'full']:
         level = verifymod.VERIFY_FULL
     return hg.verify(repo, level)
 
 
 @command(
     b'version',
     [] + formatteropts,
     helpcategory=command.CATEGORY_HELP,
     norepo=True,
     intents={INTENT_READONLY},
 )
 def version_(ui, **opts):
     """output version and copyright information
 
     .. container:: verbose
 
       Template:
 
       The following keywords are supported. See also :hg:`help templates`.
 
       :extensions: List of extensions.
       :ver:     String. Version number.
 
       And each entry of ``{extensions}`` provides the following sub-keywords
       in addition to ``{ver}``.
 
       :bundled: Boolean. True if included in the release.
       :name:    String. Extension name.
     """
     opts = pycompat.byteskwargs(opts)
     if ui.verbose:
         ui.pager(b'version')
     fm = ui.formatter(b"version", opts)
     fm.startitem()
     fm.write(
         b"ver", _(b"Mercurial Distributed SCM (version %s)\n"), util.version()
     )
     license = _(
         b"(see https://mercurial-scm.org for more information)\n"
         b"\nCopyright (C) 2005-2023 Olivia Mackall and others\n"
         b"This is free software; see the source for copying conditions. "
         b"There is NO\nwarranty; "
         b"not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"
     )
     if not ui.quiet:
         fm.plain(license)
 
     if ui.verbose:
         fm.plain(_(b"\nEnabled extensions:\n\n"))
     # format names and versions into columns
     names = []
     vers = []
     isinternals = []
     for name, module in sorted(extensions.extensions()):
         names.append(name)
         vers.append(extensions.moduleversion(module) or None)
         isinternals.append(extensions.ismoduleinternal(module))
     fn = fm.nested(b"extensions", tmpl=b'{name}\n')
     if names:
         namefmt = b"  %%-%ds  " % max(len(n) for n in names)
         places = [_(b"external"), _(b"internal")]
         for n, v, p in zip(names, vers, isinternals):
             fn.startitem()
             fn.condwrite(ui.verbose, b"name", namefmt, n)
             if ui.verbose:
                 fn.plain(b"%s  " % places[p])
             fn.data(bundled=p)
             fn.condwrite(ui.verbose and v, b"ver", b"%s", v)
             if ui.verbose:
                 fn.plain(b"\n")
     fn.end()
     fm.end()
 
 
 def loadcmdtable(ui, name, cmdtable):
     """Load command functions from specified cmdtable"""
     overrides = [cmd for cmd in cmdtable if cmd in table]
     if overrides:
         ui.warn(
             _(b"extension '%s' overrides commands: %s\n")
             % (name, b" ".join(overrides))
         )
     table.update(cmdtable)

mercurial/hg.py

@@ -1,1672 +1,1681 b''
 # hg.py - repository classes for mercurial
 #
 # Copyright 2005-2007 Olivia Mackall <[e-mail]>
 # Copyright 2006 Vadim Gelfer <[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 os
 import posixpath
 import shutil
 import stat
 import weakref
 
 from .i18n import _
 from .node import (
     hex,
     sha1nodeconstants,
     short,
 )
 from .pycompat import getattr
 
 from . import (
     bookmarks,
     bundlerepo,
     cmdutil,
     destutil,
     discovery,
     error,
     exchange,
     extensions,
     graphmod,
     httppeer,
     localrepo,
     lock,
     logcmdutil,
     logexchange,
     merge as mergemod,
     mergestate as mergestatemod,
     narrowspec,
     phases,
     requirements,
     scmutil,
     sshpeer,
     statichttprepo,
     ui as uimod,
     unionrepo,
     url,
     util,
     verify as verifymod,
     vfs as vfsmod,
 )
 from .interfaces import repository as repositorymod
 from .utils import (
     hashutil,
     stringutil,
     urlutil,
 )
 
 
 release = lock.release
 
 # shared features
 sharedbookmarks = b'bookmarks'
 
 
-def addbranchrevs(lrepo, other, branches, revs):
+def addbranchrevs(lrepo, other, branches, revs, remotehidden=False):
     if util.safehasattr(other, 'peer'):
         # a courtesy to callers using a localrepo for other
-        peer = other.peer()
+        peer = other.peer(remotehidden=remotehidden)
     else:
         peer = other
     hashbranch, branches = branches
     if not hashbranch and not branches:
         x = revs or None
         if revs:
             y = revs[0]
         else:
             y = None
         return x, y
     if revs:
         revs = list(revs)
     else:
         revs = []
 
     if not peer.capable(b'branchmap'):
         if branches:
             raise error.Abort(_(b"remote branch lookup not supported"))
         revs.append(hashbranch)
         return revs, revs[0]
 
     with peer.commandexecutor() as e:
         branchmap = e.callcommand(b'branchmap', {}).result()
 
     def primary(branch):
         if branch == b'.':
             if not lrepo:
                 raise error.Abort(_(b"dirstate branch not accessible"))
             branch = lrepo.dirstate.branch()
         if branch in branchmap:
             revs.extend(hex(r) for r in reversed(branchmap[branch]))
             return True
         else:
             return False
 
     for branch in branches:
         if not primary(branch):
             raise error.RepoLookupError(_(b"unknown branch '%s'") % branch)
     if hashbranch:
         if not primary(hashbranch):
             revs.append(hashbranch)
     return revs, revs[0]
 
 
 def _isfile(path):
     try:
         # we use os.stat() directly here instead of os.path.isfile()
         # because the latter started returning `False` on invalid path
         # exceptions starting in 3.8 and we care about handling
         # invalid paths specially here.
         st = os.stat(path)
     except ValueError as e:
         msg = stringutil.forcebytestr(e)
         raise error.Abort(_(b'invalid path %s: %s') % (path, msg))
     except OSError:
         return False
     else:
         return stat.S_ISREG(st.st_mode)
 
 
 class LocalFactory:
     """thin wrapper to dispatch between localrepo and bundle repo"""
 
     @staticmethod
     def islocal(path: bytes) -> bool:
         path = util.expandpath(urlutil.urllocalpath(path))
         return not _isfile(path)
 
     @staticmethod
     def instance(ui, path, *args, **kwargs):
         path = util.expandpath(urlutil.urllocalpath(path))
         if _isfile(path):
             cls = bundlerepo
         else:
             cls = localrepo
         return cls.instance(ui, path, *args, **kwargs)
 
 
 repo_schemes = {
     b'bundle': bundlerepo,
     b'union': unionrepo,
     b'file': LocalFactory,
 }
 
 peer_schemes = {
     b'http': httppeer,
     b'https': httppeer,
     b'ssh': sshpeer,
     b'static-http': statichttprepo,
 }
 
 
 def islocal(repo):
     '''return true if repo (or path pointing to repo) is local'''
     if isinstance(repo, bytes):
         u = urlutil.url(repo)
         scheme = u.scheme or b'file'
         if scheme in peer_schemes:
             cls = peer_schemes[scheme]
             cls.make_peer  # make sure we load the module
         elif scheme in repo_schemes:
             cls = repo_schemes[scheme]
             cls.instance  # make sure we load the module
         else:
             cls = LocalFactory
         if util.safehasattr(cls, 'islocal'):
             return cls.islocal(repo)  # pytype: disable=module-attr
         return False
     repo.ui.deprecwarn(b"use obj.local() instead of islocal(obj)", b"6.4")
     return repo.local()
 
 
 def openpath(ui, path, sendaccept=True):
     '''open path with open if local, url.open if remote'''
     pathurl = urlutil.url(path, parsequery=False, parsefragment=False)
     if pathurl.islocal():
         return util.posixfile(pathurl.localpath(), b'rb')
     else:
         return url.open(ui, path, sendaccept=sendaccept)
 
 
 # a list of (ui, repo) functions called for wire peer initialization
 wirepeersetupfuncs = []
 
 
 def _setup_repo_or_peer(ui, obj, presetupfuncs=None):
     ui = getattr(obj, "ui", ui)
     for f in presetupfuncs or []:
         f(ui, obj)
     ui.log(b'extension', b'- executing reposetup hooks\n')
     with util.timedcm('all reposetup') as allreposetupstats:
         for name, module in extensions.extensions(ui):
             ui.log(b'extension', b'  - running reposetup for %s\n', name)
             hook = getattr(module, 'reposetup', None)
             if hook:
                 with util.timedcm('reposetup %r', name) as stats:
                     hook(ui, obj)
                 msg = b'  > reposetup for %s took %s\n'
                 ui.log(b'extension', msg, name, stats)
     ui.log(b'extension', b'> all reposetup took %s\n', allreposetupstats)
     if not obj.local():
         for f in wirepeersetupfuncs:
             f(ui, obj)
 
 
 def repository(
     ui,
     path=b'',
     create=False,
     presetupfuncs=None,
     intents=None,
     createopts=None,
 ):
     """return a repository object for the specified path"""
     scheme = urlutil.url(path).scheme
     if scheme is None:
         scheme = b'file'
     cls = repo_schemes.get(scheme)
     if cls is None:
         if scheme in peer_schemes:
             raise error.Abort(_(b"repository '%s' is not local") % path)
         cls = LocalFactory
     repo = cls.instance(
         ui,
         path,
         create,
         intents=intents,
         createopts=createopts,
     )
     _setup_repo_or_peer(ui, repo, presetupfuncs=presetupfuncs)
     return repo.filtered(b'visible')
 
 
-def peer(uiorrepo, opts, path, create=False, intents=None, createopts=None):
+def peer(
+    uiorrepo,
+    opts,
+    path,
+    create=False,
+    intents=None,
+    createopts=None,
+    remotehidden=False,
+):
     '''return a repository peer for the specified path'''
     ui = getattr(uiorrepo, 'ui', uiorrepo)
     rui = remoteui(uiorrepo, opts)
     if util.safehasattr(path, 'url'):
         # this is already a urlutil.path object
         peer_path = path
     else:
         peer_path = urlutil.path(ui, None, rawloc=path, validate_path=False)
     scheme = peer_path.url.scheme  # pytype: disable=attribute-error
     if scheme in peer_schemes:
         cls = peer_schemes[scheme]
         peer = cls.make_peer(
             rui,
             peer_path,
             create,
             intents=intents,
             createopts=createopts,
+            remotehidden=remotehidden,
         )
         _setup_repo_or_peer(rui, peer)
     else:
         # this is a repository
         repo_path = peer_path.loc  # pytype: disable=attribute-error
         if not repo_path:
             repo_path = peer_path.rawloc  # pytype: disable=attribute-error
         repo = repository(
             rui,
             repo_path,
             create,
             intents=intents,
             createopts=createopts,
         )
-        peer = repo.peer(path=peer_path)
+        peer = repo.peer(path=peer_path, remotehidden=remotehidden)
     return peer
 
 
 def defaultdest(source):
     """return default destination of clone if none is given
 
     >>> defaultdest(b'foo')
     'foo'
     >>> defaultdest(b'/foo/bar')
     'bar'
     >>> defaultdest(b'/')
     ''
     >>> defaultdest(b'')
     ''
     >>> defaultdest(b'http://example.org/')
     ''
     >>> defaultdest(b'http://example.org/foo/')
     'foo'
     """
     path = urlutil.url(source).path
     if not path:
         return b''
     return os.path.basename(os.path.normpath(path))
 
 
 def sharedreposource(repo):
     """Returns repository object for source repository of a shared repo.
 
     If repo is not a shared repository, returns None.
     """
     if repo.sharedpath == repo.path:
         return None
 
     if util.safehasattr(repo, b'srcrepo') and repo.srcrepo:
         return repo.srcrepo
 
     # the sharedpath always ends in the .hg; we want the path to the repo
     source = repo.vfs.split(repo.sharedpath)[0]
     srcurl, branches = urlutil.parseurl(source)
     srcrepo = repository(repo.ui, srcurl)
     repo.srcrepo = srcrepo
     return srcrepo
 
 
 def share(
     ui,
     source,
     dest=None,
     update=True,
     bookmarks=True,
     defaultpath=None,
     relative=False,
 ):
     '''create a shared repository'''
 
     not_local_msg = _(b'can only share local repositories')
     if util.safehasattr(source, 'local'):
         if source.local() is None:
             raise error.Abort(not_local_msg)
     elif not islocal(source):
         # XXX why are we getting bytes here ?
         raise error.Abort(not_local_msg)
 
     if not dest:
         dest = defaultdest(source)
     else:
         dest = urlutil.get_clone_path_obj(ui, dest).loc
 
     if isinstance(source, bytes):
         source_path = urlutil.get_clone_path_obj(ui, source)
         srcrepo = repository(ui, source_path.loc)
         branches = (source_path.branch, [])
         rev, checkout = addbranchrevs(srcrepo, srcrepo, branches, None)
     else:
         srcrepo = source.local()
         checkout = None
 
     shareditems = set()
     if bookmarks:
         shareditems.add(sharedbookmarks)
 
     r = repository(
         ui,
         dest,
         create=True,
         createopts={
             b'sharedrepo': srcrepo,
             b'sharedrelative': relative,
             b'shareditems': shareditems,
         },
     )
 
     postshare(srcrepo, r, defaultpath=defaultpath)
     r = repository(ui, dest)
     _postshareupdate(r, update, checkout=checkout)
     return r
 
 
 def _prependsourcehgrc(repo):
     """copies the source repo config and prepend it in current repo .hg/hgrc
     on unshare. This is only done if the share was perfomed using share safe
     method where we share config of source in shares"""
     srcvfs = vfsmod.vfs(repo.sharedpath)
     dstvfs = vfsmod.vfs(repo.path)
 
     if not srcvfs.exists(b'hgrc'):
         return
 
     currentconfig = b''
     if dstvfs.exists(b'hgrc'):
         currentconfig = dstvfs.read(b'hgrc')
 
     with dstvfs(b'hgrc', b'wb') as fp:
         sourceconfig = srcvfs.read(b'hgrc')
         fp.write(b"# Config copied from shared source\n")
         fp.write(sourceconfig)
         fp.write(b'\n')
         fp.write(currentconfig)
 
 
 def unshare(ui, repo):
     """convert a shared repository to a normal one
 
     Copy the store data to the repo and remove the sharedpath data.
 
     Returns a new repository object representing the unshared repository.
 
     The passed repository object is not usable after this function is
     called.
     """
 
     with repo.lock():
         # we use locks here because if we race with commit, we
         # can end up with extra data in the cloned revlogs that's
         # not pointed to by changesets, thus causing verify to
         # fail
         destlock = copystore(ui, repo, repo.path)
         with destlock or util.nullcontextmanager():
             if requirements.SHARESAFE_REQUIREMENT in repo.requirements:
                 # we were sharing .hg/hgrc of the share source with the current
                 # repo. We need to copy that while unsharing otherwise it can
                 # disable hooks and other checks
                 _prependsourcehgrc(repo)
 
             sharefile = repo.vfs.join(b'sharedpath')
             util.rename(sharefile, sharefile + b'.old')
 
             repo.requirements.discard(requirements.SHARED_REQUIREMENT)
             repo.requirements.discard(requirements.RELATIVE_SHARED_REQUIREMENT)
             scmutil.writereporequirements(repo)
 
     # Removing share changes some fundamental properties of the repo instance.
     # So we instantiate a new repo object and operate on it rather than
     # try to keep the existing repo usable.
     newrepo = repository(repo.baseui, repo.root, create=False)
 
     # TODO: figure out how to access subrepos that exist, but were previously
     #       removed from .hgsub
     c = newrepo[b'.']
     subs = c.substate
     for s in sorted(subs):
         c.sub(s).unshare()
 
     localrepo.poisonrepository(repo)
 
     return newrepo
 
 
 def postshare(sourcerepo, destrepo, defaultpath=None):
     """Called after a new shared repo is created.
 
     The new repo only has a requirements file and pointer to the source.
     This function configures additional shared data.
 
     Extensions can wrap this function and write additional entries to
     destrepo/.hg/shared to indicate additional pieces of data to be shared.
     """
     default = defaultpath or sourcerepo.ui.config(b'paths', b'default')
     if default:
         template = b'[paths]\ndefault = %s\n'
         destrepo.vfs.write(b'hgrc', util.tonativeeol(template % default))
     if requirements.NARROW_REQUIREMENT in sourcerepo.requirements:
         with destrepo.wlock(), destrepo.lock(), destrepo.transaction(
             b"narrow-share"
         ):
             narrowspec.copytoworkingcopy(destrepo)
 
 
 def _postshareupdate(repo, update, checkout=None):
     """Maybe perform a working directory update after a shared repo is created.
 
     ``update`` can be a boolean or a revision to update to.
     """
     if not update:
         return
 
     repo.ui.status(_(b"updating working directory\n"))
     if update is not True:
         checkout = update
     for test in (checkout, b'default', b'tip'):
         if test is None:
             continue
         try:
             uprev = repo.lookup(test)
             break
         except error.RepoLookupError:
             continue
     _update(repo, uprev)
 
 
 def copystore(ui, srcrepo, destpath):
     """copy files from store of srcrepo in destpath
 
     returns destlock
     """
     destlock = None
     try:
         hardlink = None
         topic = _(b'linking') if hardlink else _(b'copying')
         with ui.makeprogress(topic, unit=_(b'files')) as progress:
             num = 0
             srcpublishing = srcrepo.publishing()
             srcvfs = vfsmod.vfs(srcrepo.sharedpath)
             dstvfs = vfsmod.vfs(destpath)
             for f in srcrepo.store.copylist():
                 if srcpublishing and f.endswith(b'phaseroots'):
                     continue
                 dstbase = os.path.dirname(f)
                 if dstbase and not dstvfs.exists(dstbase):
                     dstvfs.mkdir(dstbase)
                 if srcvfs.exists(f):
                     if f.endswith(b'data'):
                         # 'dstbase' may be empty (e.g. revlog format 0)
                         lockfile = os.path.join(dstbase, b"lock")
                         # lock to avoid premature writing to the target
                         destlock = lock.lock(dstvfs, lockfile)
                     hardlink, n = util.copyfiles(
                         srcvfs.join(f), dstvfs.join(f), hardlink, progress
                     )
                     num += n
             if hardlink:
                 ui.debug(b"linked %d files\n" % num)
             else:
                 ui.debug(b"copied %d files\n" % num)
         return destlock
     except:  # re-raises
         release(destlock)
         raise
 
 
 def clonewithshare(
     ui,
     peeropts,
     sharepath,
     source,
     srcpeer,
     dest,
     pull=False,
     rev=None,
     update=True,
     stream=False,
 ):
     """Perform a clone using a shared repo.
 
     The store for the repository will be located at <sharepath>/.hg. The
     specified revisions will be cloned or pulled from "source". A shared repo
     will be created at "dest" and a working copy will be created if "update" is
     True.
     """
     revs = None
     if rev:
         if not srcpeer.capable(b'lookup'):
             raise error.Abort(
                 _(
                     b"src repository does not support "
                     b"revision lookup and so doesn't "
                     b"support clone by revision"
                 )
             )
 
         # TODO this is batchable.
         remoterevs = []
         for r in rev:
             with srcpeer.commandexecutor() as e:
                 remoterevs.append(
                     e.callcommand(
                         b'lookup',
                         {
                             b'key': r,
                         },
                     ).result()
                 )
         revs = remoterevs
 
     # Obtain a lock before checking for or cloning the pooled repo otherwise
     # 2 clients may race creating or populating it.
     pooldir = os.path.dirname(sharepath)
     # lock class requires the directory to exist.
     try:
         util.makedir(pooldir, False)
     except FileExistsError:
         pass
 
     poolvfs = vfsmod.vfs(pooldir)
     basename = os.path.basename(sharepath)
 
     with lock.lock(poolvfs, b'%s.lock' % basename):
         if os.path.exists(sharepath):
             ui.status(
                 _(b'(sharing from existing pooled repository %s)\n') % basename
             )
         else:
             ui.status(
                 _(b'(sharing from new pooled repository %s)\n') % basename
             )
             # Always use pull mode because hardlinks in share mode don't work
             # well. Never update because working copies aren't necessary in
             # share mode.
             clone(
                 ui,
                 peeropts,
                 source,
                 dest=sharepath,
                 pull=True,
                 revs=rev,
                 update=False,
                 stream=stream,
             )
 
     # Resolve the value to put in [paths] section for the source.
     if islocal(source):
         defaultpath = util.abspath(urlutil.urllocalpath(source))
     else:
         defaultpath = source
 
     sharerepo = repository(ui, path=sharepath)
     destrepo = share(
         ui,
         sharerepo,
         dest=dest,
         update=False,
         bookmarks=False,
         defaultpath=defaultpath,
     )
 
     # We need to perform a pull against the dest repo to fetch bookmarks
     # and other non-store data that isn't shared by default. In the case of
     # non-existing shared repo, this means we pull from the remote twice. This
     # is a bit weird. But at the time it was implemented, there wasn't an easy
     # way to pull just non-changegroup data.
     exchange.pull(destrepo, srcpeer, heads=revs)
 
     _postshareupdate(destrepo, update)
 
     return srcpeer, peer(ui, peeropts, dest)
 
 
 # Recomputing caches is often slow on big repos, so copy them.
 def _copycache(srcrepo, dstcachedir, fname):
     """copy a cache from srcrepo to destcachedir (if it exists)"""
     srcfname = srcrepo.cachevfs.join(fname)
     dstfname = os.path.join(dstcachedir, fname)
     if os.path.exists(srcfname):
         if not os.path.exists(dstcachedir):
             os.mkdir(dstcachedir)
         util.copyfile(srcfname, dstfname)
 
 
 def clone(
     ui,
     peeropts,
     source,
     dest=None,
     pull=False,
     revs=None,
     update=True,
     stream=False,
     branch=None,
     shareopts=None,
     storeincludepats=None,
     storeexcludepats=None,
     depth=None,
 ):
     """Make a copy of an existing repository.
 
     Create a copy of an existing repository in a new directory.  The
     source and destination are URLs, as passed to the repository
     function.  Returns a pair of repository peers, the source and
     newly created destination.
 
     The location of the source is added to the new repository's
     .hg/hgrc file, as the default to be used for future pulls and
     pushes.
 
     If an exception is raised, the partly cloned/updated destination
     repository will be deleted.
 
     Arguments:
 
     source: repository object or URL
 
     dest: URL of destination repository to create (defaults to base
     name of source repository)
 
     pull: always pull from source repository, even in local case or if the
     server prefers streaming
 
     stream: stream raw data uncompressed from repository (fast over
     LAN, slow over WAN)
 
     revs: revision to clone up to (implies pull=True)
 
     update: update working directory after clone completes, if
     destination is local repository (True means update to default rev,
     anything else is treated as a revision)
 
     branch: branches to clone
 
     shareopts: dict of options to control auto sharing behavior. The "pool" key
     activates auto sharing mode and defines the directory for stores. The
     "mode" key determines how to construct the directory name of the shared
     repository. "identity" means the name is derived from the node of the first
     changeset in the repository. "remote" means the name is derived from the
     remote's path/URL. Defaults to "identity."
 
     storeincludepats and storeexcludepats: sets of file patterns to include and
     exclude in the repository copy, respectively. If not defined, all files
     will be included (a "full" clone). Otherwise a "narrow" clone containing
     only the requested files will be performed. If ``storeincludepats`` is not
     defined but ``storeexcludepats`` is, ``storeincludepats`` is assumed to be
     ``path:.``. If both are empty sets, no files will be cloned.
     """
 
     if isinstance(source, bytes):
         src_path = urlutil.get_clone_path_obj(ui, source)
         if src_path is None:
             srcpeer = peer(ui, peeropts, b'')
             origsource = source = b''
             branches = (None, branch or [])
         else:
             srcpeer = peer(ui, peeropts, src_path)
             origsource = src_path.rawloc
             branches = (src_path.branch, branch or [])
             source = src_path.loc
     else:
         if util.safehasattr(source, 'peer'):
             srcpeer = source.peer()  # in case we were called with a localrepo
         else:
             srcpeer = source
         branches = (None, branch or [])
         # XXX path: simply use the peer `path` object when this become available
         origsource = source = srcpeer.url()
     srclock = destlock = destwlock = cleandir = None
     destpeer = None
     try:
         revs, checkout = addbranchrevs(srcpeer, srcpeer, branches, revs)
 
         if dest is None:
             dest = defaultdest(source)
             if dest:
                 ui.status(_(b"destination directory: %s\n") % dest)
         else:
             dest_path = urlutil.get_clone_path_obj(ui, dest)
             if dest_path is not None:
                 dest = dest_path.rawloc
             else:
                 dest = b''
 
         dest = urlutil.urllocalpath(dest)
         source = urlutil.urllocalpath(source)
 
         if not dest:
             raise error.InputError(_(b"empty destination path is not valid"))
 
         destvfs = vfsmod.vfs(dest, expandpath=True)
         if destvfs.lexists():
             if not destvfs.isdir():
                 raise error.InputError(
                     _(b"destination '%s' already exists") % dest
                 )
             elif destvfs.listdir():
                 raise error.InputError(
                     _(b"destination '%s' is not empty") % dest
                 )
 
         createopts = {}
         narrow = False
 
         if storeincludepats is not None:
             narrowspec.validatepatterns(storeincludepats)
             narrow = True
 
         if storeexcludepats is not None:
             narrowspec.validatepatterns(storeexcludepats)
             narrow = True
 
         if narrow:
             # Include everything by default if only exclusion patterns defined.
             if storeexcludepats and not storeincludepats:
                 storeincludepats = {b'path:.'}
 
             createopts[b'narrowfiles'] = True
 
         if depth:
             createopts[b'shallowfilestore'] = True
 
         if srcpeer.capable(b'lfs-serve'):
             # Repository creation honors the config if it disabled the extension, so
             # we can't just announce that lfs will be enabled.  This check avoids
             # saying that lfs will be enabled, and then saying it's an unknown
             # feature.  The lfs creation option is set in either case so that a
             # requirement is added.  If the extension is explicitly disabled but the
             # requirement is set, the clone aborts early, before transferring any
             # data.
             createopts[b'lfs'] = True
 
             if b'lfs' in extensions.disabled():
                 ui.status(
                     _(
                         b'(remote is using large file support (lfs), but it is '
                         b'explicitly disabled in the local configuration)\n'
                     )
                 )
             else:
                 ui.status(
                     _(
                         b'(remote is using large file support (lfs); lfs will '
                         b'be enabled for this repository)\n'
                     )
                 )
 
         shareopts = shareopts or {}
         sharepool = shareopts.get(b'pool')
         sharenamemode = shareopts.get(b'mode')
         if sharepool and islocal(dest):
             sharepath = None
             if sharenamemode == b'identity':
                 # Resolve the name from the initial changeset in the remote
                 # repository. This returns nullid when the remote is empty. It
                 # raises RepoLookupError if revision 0 is filtered or otherwise
                 # not available. If we fail to resolve, sharing is not enabled.
                 try:
                     with srcpeer.commandexecutor() as e:
                         rootnode = e.callcommand(
                             b'lookup',
                             {
                                 b'key': b'0',
                             },
                         ).result()
 
                     if rootnode != sha1nodeconstants.nullid:
                         sharepath = os.path.join(sharepool, hex(rootnode))
                     else:
                         ui.status(
                             _(
                                 b'(not using pooled storage: '
                                 b'remote appears to be empty)\n'
                             )
                         )
                 except error.RepoLookupError:
                     ui.status(
                         _(
                             b'(not using pooled storage: '
                             b'unable to resolve identity of remote)\n'
                         )
                     )
             elif sharenamemode == b'remote':
                 sharepath = os.path.join(
                     sharepool, hex(hashutil.sha1(source).digest())
                 )
             else:
                 raise error.Abort(
                     _(b'unknown share naming mode: %s') % sharenamemode
                 )
 
             # TODO this is a somewhat arbitrary restriction.
             if narrow:
                 ui.status(
                     _(b'(pooled storage not supported for narrow clones)\n')
                 )
                 sharepath = None
 
             if sharepath:
                 return clonewithshare(
                     ui,
                     peeropts,
                     sharepath,
                     source,
                     srcpeer,
                     dest,
                     pull=pull,
                     rev=revs,
                     update=update,
                     stream=stream,
                 )
 
         srcrepo = srcpeer.local()
 
         abspath = origsource
         if islocal(origsource):
             abspath = util.abspath(urlutil.urllocalpath(origsource))
 
         if islocal(dest):
             if os.path.exists(dest):
                 # only clean up directories we create ourselves
                 hgdir = os.path.realpath(os.path.join(dest, b".hg"))
                 cleandir = hgdir
             else:
                 cleandir = dest
 
         copy = False
         if (
             srcrepo
             and srcrepo.cancopy()
             and islocal(dest)
             and not phases.hassecret(srcrepo)
         ):
             copy = not pull and not revs
 
         # TODO this is a somewhat arbitrary restriction.
         if narrow:
             copy = False
 
         if copy:
             try:
                 # we use a lock here because if we race with commit, we
                 # can end up with extra data in the cloned revlogs that's
                 # not pointed to by changesets, thus causing verify to
                 # fail
                 srclock = srcrepo.lock(wait=False)
             except error.LockError:
                 copy = False
 
         if copy:
             srcrepo.hook(b'preoutgoing', throw=True, source=b'clone')
 
             destrootpath = urlutil.urllocalpath(dest)
             dest_reqs = localrepo.clone_requirements(ui, createopts, srcrepo)
             localrepo.createrepository(
                 ui,
                 destrootpath,
                 requirements=dest_reqs,
             )
             destrepo = localrepo.makelocalrepository(ui, destrootpath)
 
             destwlock = destrepo.wlock()
             destlock = destrepo.lock()
             from . import streamclone  # avoid cycle
 
             streamclone.local_copy(srcrepo, destrepo)
 
             # we need to re-init the repo after manually copying the data
             # into it
             destpeer = peer(srcrepo, peeropts, dest)
 
             # make the peer aware that is it already locked
             #
             # important:
             #
             #    We still need to release that lock at the end of the function
             destpeer.local()._lockref = weakref.ref(destlock)
             destpeer.local()._wlockref = weakref.ref(destwlock)
             # dirstate also needs to be copied because `_wlockref` has a reference
             # to it: this dirstate is saved to disk when the wlock is released
             destpeer.local().dirstate = destrepo.dirstate
 
             srcrepo.hook(
                 b'outgoing', source=b'clone', node=srcrepo.nodeconstants.nullhex
             )
         else:
             try:
                 # only pass ui when no srcrepo
                 destpeer = peer(
                     srcrepo or ui,
                     peeropts,
                     dest,
                     create=True,
                     createopts=createopts,
                 )
             except FileExistsError:
                 cleandir = None
                 raise error.Abort(_(b"destination '%s' already exists") % dest)
 
             if revs:
                 if not srcpeer.capable(b'lookup'):
                     raise error.Abort(
                         _(
                             b"src repository does not support "
                             b"revision lookup and so doesn't "
                             b"support clone by revision"
                         )
                     )
 
                 # TODO this is batchable.
                 remoterevs = []
                 for rev in revs:
                     with srcpeer.commandexecutor() as e:
                         remoterevs.append(
                             e.callcommand(
                                 b'lookup',
                                 {
                                     b'key': rev,
                                 },
                             ).result()
                         )
                 revs = remoterevs
 
                 checkout = revs[0]
             else:
                 revs = None
             local = destpeer.local()
             if local:
                 if narrow:
                     with local.wlock(), local.lock(), local.transaction(
                         b'narrow-clone'
                     ):
                         local.setnarrowpats(storeincludepats, storeexcludepats)
                         narrowspec.copytoworkingcopy(local)
 
                 u = urlutil.url(abspath)
                 defaulturl = bytes(u)
                 local.ui.setconfig(b'paths', b'default', defaulturl, b'clone')
                 if not stream:
                     if pull:
                         stream = False
                     else:
                         stream = None
                 # internal config: ui.quietbookmarkmove
                 overrides = {(b'ui', b'quietbookmarkmove'): True}
                 with local.ui.configoverride(overrides, b'clone'):
                     exchange.pull(
                         local,
                         srcpeer,
                         heads=revs,
                         streamclonerequested=stream,
                         includepats=storeincludepats,
                         excludepats=storeexcludepats,
                         depth=depth,
                     )
             elif srcrepo:
                 # TODO lift restriction once exchange.push() accepts narrow
                 # push.
                 if narrow:
                     raise error.Abort(
                         _(
                             b'narrow clone not available for '
                             b'remote destinations'
                         )
                     )
 
                 exchange.push(
                     srcrepo,
                     destpeer,
                     revs=revs,
                     bookmarks=srcrepo._bookmarks.keys(),
                 )
             else:
                 raise error.Abort(
                     _(b"clone from remote to remote not supported")
                 )
 
         cleandir = None
 
         destrepo = destpeer.local()
         if destrepo:
             template = uimod.samplehgrcs[b'cloned']
             u = urlutil.url(abspath)
             u.passwd = None
             defaulturl = bytes(u)
             destrepo.vfs.write(b'hgrc', util.tonativeeol(template % defaulturl))
             destrepo.ui.setconfig(b'paths', b'default', defaulturl, b'clone')
 
             if ui.configbool(b'experimental', b'remotenames'):
                 logexchange.pullremotenames(destrepo, srcpeer)
 
             if update:
                 if update is not True:
                     with srcpeer.commandexecutor() as e:
                         checkout = e.callcommand(
                             b'lookup',
                             {
                                 b'key': update,
                             },
                         ).result()
 
                 uprev = None
                 status = None
                 if checkout is not None:
                     # Some extensions (at least hg-git and hg-subversion) have
                     # a peer.lookup() implementation that returns a name instead
                     # of a nodeid. We work around it here until we've figured
                     # out a better solution.
                     if len(checkout) == 20 and checkout in destrepo:
                         uprev = checkout
                     elif scmutil.isrevsymbol(destrepo, checkout):
                         uprev = scmutil.revsymbol(destrepo, checkout).node()
                     else:
                         if update is not True:
                             try:
                                 uprev = destrepo.lookup(update)
                             except error.RepoLookupError:
                                 pass
                 if uprev is None:
                     try:
                         if destrepo._activebookmark:
                             uprev = destrepo.lookup(destrepo._activebookmark)
                             update = destrepo._activebookmark
                         else:
                             uprev = destrepo._bookmarks[b'@']
                             update = b'@'
                         bn = destrepo[uprev].branch()
                         if bn == b'default':
                             status = _(b"updating to bookmark %s\n" % update)
                         else:
                             status = (
                                 _(b"updating to bookmark %s on branch %s\n")
                             ) % (update, bn)
                     except KeyError:
                         try:
                             uprev = destrepo.branchtip(b'default')
                         except error.RepoLookupError:
                             uprev = destrepo.lookup(b'tip')
                 if not status:
                     bn = destrepo[uprev].branch()
                     status = _(b"updating to branch %s\n") % bn
                 destrepo.ui.status(status)
                 _update(destrepo, uprev)
                 if update in destrepo._bookmarks:
                     bookmarks.activate(destrepo, update)
             if destlock is not None:
                 release(destlock)
             if destwlock is not None:
                 release(destlock)
             # here is a tiny windows were someone could end up writing the
             # repository before the cache are sure to be warm. This is "fine"
             # as the only "bad" outcome would be some slowness. That potential
             # slowness already affect reader.
             with destrepo.lock():
                 destrepo.updatecaches(caches=repositorymod.CACHES_POST_CLONE)
     finally:
         release(srclock, destlock, destwlock)
         if cleandir is not None:
             shutil.rmtree(cleandir, True)
         if srcpeer is not None:
             srcpeer.close()
         if destpeer and destpeer.local() is None:
             destpeer.close()
     return srcpeer, destpeer
 
 
 def _showstats(repo, stats, quietempty=False):
     if quietempty and stats.isempty():
         return
     repo.ui.status(
         _(
             b"%d files updated, %d files merged, "
             b"%d files removed, %d files unresolved\n"
         )
         % (
             stats.updatedcount,
             stats.mergedcount,
             stats.removedcount,
             stats.unresolvedcount,
         )
     )
 
 
 def updaterepo(repo, node, overwrite, updatecheck=None):
     """Update the working directory to node.
 
     When overwrite is set, changes are clobbered, merged else
 
     returns stats (see pydoc mercurial.merge.applyupdates)"""
     repo.ui.deprecwarn(
         b'prefer merge.update() or merge.clean_update() over hg.updaterepo()',
         b'5.7',
     )
     return mergemod._update(
         repo,
         node,
         branchmerge=False,
         force=overwrite,
         labels=[b'working copy', b'destination'],
         updatecheck=updatecheck,
     )
 
 
 def update(repo, node, quietempty=False, updatecheck=None):
     """update the working directory to node"""
     stats = mergemod.update(repo[node], updatecheck=updatecheck)
     _showstats(repo, stats, quietempty)
     if stats.unresolvedcount:
         repo.ui.status(_(b"use 'hg resolve' to retry unresolved file merges\n"))
     return stats.unresolvedcount > 0
 
 
 # naming conflict in clone()
 _update = update
 
 
 def clean(repo, node, show_stats=True, quietempty=False):
     """forcibly switch the working directory to node, clobbering changes"""
     stats = mergemod.clean_update(repo[node])
     assert stats.unresolvedcount == 0
     if show_stats:
         _showstats(repo, stats, quietempty)
     return False
 
 
 # naming conflict in updatetotally()
 _clean = clean
 
 _VALID_UPDATECHECKS = {
     mergemod.UPDATECHECK_ABORT,
     mergemod.UPDATECHECK_NONE,
     mergemod.UPDATECHECK_LINEAR,
     mergemod.UPDATECHECK_NO_CONFLICT,
 }
 
 
 def updatetotally(ui, repo, checkout, brev, clean=False, updatecheck=None):
     """Update the working directory with extra care for non-file components
 
     This takes care of non-file components below:
 
     :bookmark: might be advanced or (in)activated
 
     This takes arguments below:
 
     :checkout: to which revision the working directory is updated
     :brev: a name, which might be a bookmark to be activated after updating
     :clean: whether changes in the working directory can be discarded
     :updatecheck: how to deal with a dirty working directory
 
     Valid values for updatecheck are the UPDATECHECK_* constants
     defined in the merge module. Passing `None` will result in using the
     configured default.
 
      * ABORT: abort if the working directory is dirty
      * NONE: don't check (merge working directory changes into destination)
      * LINEAR: check that update is linear before merging working directory
                changes into destination
      * NO_CONFLICT: check that the update does not result in file merges
 
     This returns whether conflict is detected at updating or not.
     """
     if updatecheck is None:
         updatecheck = ui.config(b'commands', b'update.check')
         if updatecheck not in _VALID_UPDATECHECKS:
             # If not configured, or invalid value configured
             updatecheck = mergemod.UPDATECHECK_LINEAR
     if updatecheck not in _VALID_UPDATECHECKS:
         raise ValueError(
             r'Invalid updatecheck value %r (can accept %r)'
             % (updatecheck, _VALID_UPDATECHECKS)
         )
     with repo.wlock():
         movemarkfrom = None
         warndest = False
         if checkout is None:
             updata = destutil.destupdate(repo, clean=clean)
             checkout, movemarkfrom, brev = updata
             warndest = True
 
         if clean:
             ret = _clean(repo, checkout)
         else:
             if updatecheck == mergemod.UPDATECHECK_ABORT:
                 cmdutil.bailifchanged(repo, merge=False)
                 updatecheck = mergemod.UPDATECHECK_NONE
             ret = _update(repo, checkout, updatecheck=updatecheck)
 
         if not ret and movemarkfrom:
             if movemarkfrom == repo[b'.'].node():
                 pass  # no-op update
             elif bookmarks.update(repo, [movemarkfrom], repo[b'.'].node()):
                 b = ui.label(repo._activebookmark, b'bookmarks.active')
                 ui.status(_(b"updating bookmark %s\n") % b)
             else:
                 # this can happen with a non-linear update
                 b = ui.label(repo._activebookmark, b'bookmarks')
                 ui.status(_(b"(leaving bookmark %s)\n") % b)
                 bookmarks.deactivate(repo)
         elif brev in repo._bookmarks:
             if brev != repo._activebookmark:
                 b = ui.label(brev, b'bookmarks.active')
                 ui.status(_(b"(activating bookmark %s)\n") % b)
             bookmarks.activate(repo, brev)
         elif brev:
             if repo._activebookmark:
                 b = ui.label(repo._activebookmark, b'bookmarks')
                 ui.status(_(b"(leaving bookmark %s)\n") % b)
             bookmarks.deactivate(repo)
 
         if warndest:
             destutil.statusotherdests(ui, repo)
 
     return ret
 
 
 def merge(
     ctx,
     force=False,
     remind=True,
     labels=None,
 ):
     """Branch merge with node, resolving changes. Return true if any
     unresolved conflicts."""
     repo = ctx.repo()
     stats = mergemod.merge(ctx, force=force, labels=labels)
     _showstats(repo, stats)
     if stats.unresolvedcount:
         repo.ui.status(
             _(
                 b"use 'hg resolve' to retry unresolved file merges "
                 b"or 'hg merge --abort' to abandon\n"
             )
         )
     elif remind:
         repo.ui.status(_(b"(branch merge, don't forget to commit)\n"))
     return stats.unresolvedcount > 0
 
 
 def abortmerge(ui, repo):
     ms = mergestatemod.mergestate.read(repo)
     if ms.active():
         # there were conflicts
         node = ms.localctx.hex()
     else:
         # there were no conficts, mergestate was not stored
         node = repo[b'.'].hex()
 
     repo.ui.status(_(b"aborting the merge, updating back to %s\n") % node[:12])
     stats = mergemod.clean_update(repo[node])
     assert stats.unresolvedcount == 0
     _showstats(repo, stats)
 
 
 def _incoming(
     displaychlist,
     subreporecurse,
     ui,
     repo,
     source,
     opts,
     buffered=False,
     subpath=None,
 ):
     """
     Helper for incoming / gincoming.
     displaychlist gets called with
         (remoterepo, incomingchangesetlist, displayer) parameters,
     and is supposed to contain only code that can't be unified.
     """
     srcs = urlutil.get_pull_paths(repo, ui, [source])
     srcs = list(srcs)
     if len(srcs) != 1:
         msg = _(b'for now, incoming supports only a single source, %d provided')
         msg %= len(srcs)
         raise error.Abort(msg)
     path = srcs[0]
     if subpath is None:
         peer_path = path
         url = path.loc
     else:
         # XXX path: we are losing the `path` object here. Keeping it would be
         # valuable. For example as a "variant" as we do for pushes.
         subpath = urlutil.url(subpath)
         if subpath.isabs():
             peer_path = url = bytes(subpath)
         else:
             p = urlutil.url(path.loc)
             if p.islocal():
                 normpath = os.path.normpath
             else:
                 normpath = posixpath.normpath
             p.path = normpath(b'%s/%s' % (p.path, subpath))
             peer_path = url = bytes(p)
     other = peer(repo, opts, peer_path)
     cleanupfn = other.close
     try:
         ui.status(_(b'comparing with %s\n') % urlutil.hidepassword(url))
         branches = (path.branch, opts.get(b'branch', []))
         revs, checkout = addbranchrevs(repo, other, branches, opts.get(b'rev'))
 
         if revs:
             revs = [other.lookup(rev) for rev in revs]
         other, chlist, cleanupfn = bundlerepo.getremotechanges(
             ui, repo, other, revs, opts.get(b"bundle"), opts.get(b"force")
         )
 
         if not chlist:
             ui.status(_(b"no changes found\n"))
             return subreporecurse()
         ui.pager(b'incoming')
         displayer = logcmdutil.changesetdisplayer(
             ui, other, opts, buffered=buffered
         )
         displaychlist(other, chlist, displayer)
         displayer.close()
     finally:
         cleanupfn()
     subreporecurse()
     return 0  # exit code is zero since we found incoming changes
 
 
 def incoming(ui, repo, source, opts, subpath=None):
     def subreporecurse():
         ret = 1
         if opts.get(b'subrepos'):
             ctx = repo[None]
             for subpath in sorted(ctx.substate):
                 sub = ctx.sub(subpath)
                 ret = min(ret, sub.incoming(ui, source, opts))
         return ret
 
     def display(other, chlist, displayer):
         limit = logcmdutil.getlimit(opts)
         if opts.get(b'newest_first'):
             chlist.reverse()
         count = 0
         for n in chlist:
             if limit is not None and count >= limit:
                 break
             parents = [
                 p for p in other.changelog.parents(n) if p != repo.nullid
             ]
             if opts.get(b'no_merges') and len(parents) == 2:
                 continue
             count += 1
             displayer.show(other[n])
 
     return _incoming(
         display, subreporecurse, ui, repo, source, opts, subpath=subpath
     )
 
 
 def _outgoing(ui, repo, dests, opts, subpath=None):
     out = set()
     others = []
     for path in urlutil.get_push_paths(repo, ui, dests):
         dest = path.loc
         if subpath is not None:
             subpath = urlutil.url(subpath)
             if subpath.isabs():
                 dest = bytes(subpath)
             else:
                 p = urlutil.url(dest)
                 if p.islocal():
                     normpath = os.path.normpath
                 else:
                     normpath = posixpath.normpath
                 p.path = normpath(b'%s/%s' % (p.path, subpath))
                 dest = bytes(p)
         branches = path.branch, opts.get(b'branch') or []
 
         ui.status(_(b'comparing with %s\n') % urlutil.hidepassword(dest))
         revs, checkout = addbranchrevs(repo, repo, branches, opts.get(b'rev'))
         if revs:
             revs = [repo[rev].node() for rev in logcmdutil.revrange(repo, revs)]
 
         other = peer(repo, opts, dest)
         try:
             outgoing = discovery.findcommonoutgoing(
                 repo, other, revs, force=opts.get(b'force')
             )
             o = outgoing.missing
             out.update(o)
             if not o:
                 scmutil.nochangesfound(repo.ui, repo, outgoing.excluded)
             others.append(other)
         except:  # re-raises
             other.close()
             raise
     # make sure this is ordered by revision number
     outgoing_revs = list(out)
     cl = repo.changelog
     outgoing_revs.sort(key=cl.rev)
     return outgoing_revs, others
 
 
 def _outgoing_recurse(ui, repo, dests, opts):
     ret = 1
     if opts.get(b'subrepos'):
         ctx = repo[None]
         for subpath in sorted(ctx.substate):
             sub = ctx.sub(subpath)
             ret = min(ret, sub.outgoing(ui, dests, opts))
     return ret
 
 
 def _outgoing_filter(repo, revs, opts):
     """apply revision filtering/ordering option for outgoing"""
     limit = logcmdutil.getlimit(opts)
     no_merges = opts.get(b'no_merges')
     if opts.get(b'newest_first'):
         revs.reverse()
     if limit is None and not no_merges:
         for r in revs:
             yield r
         return
 
     count = 0
     cl = repo.changelog
     for n in revs:
         if limit is not None and count >= limit:
             break
         parents = [p for p in cl.parents(n) if p != repo.nullid]
         if no_merges and len(parents) == 2:
             continue
         count += 1
         yield n
 
 
 def outgoing(ui, repo, dests, opts, subpath=None):
     if opts.get(b'graph'):
         logcmdutil.checkunsupportedgraphflags([], opts)
     o, others = _outgoing(ui, repo, dests, opts, subpath=subpath)
     ret = 1
     try:
         if o:
             ret = 0
 
             if opts.get(b'graph'):
                 revdag = logcmdutil.graphrevs(repo, o, opts)
                 ui.pager(b'outgoing')
                 displayer = logcmdutil.changesetdisplayer(
                     ui, repo, opts, buffered=True
                 )
                 logcmdutil.displaygraph(
                     ui, repo, revdag, displayer, graphmod.asciiedges
                 )
             else:
                 ui.pager(b'outgoing')
                 displayer = logcmdutil.changesetdisplayer(ui, repo, opts)
                 for n in _outgoing_filter(repo, o, opts):
                     displayer.show(repo[n])
                 displayer.close()
         for oth in others:
             cmdutil.outgoinghooks(ui, repo, oth, opts, o)
             ret = min(ret, _outgoing_recurse(ui, repo, dests, opts))
         return ret  # exit code is zero since we found outgoing changes
     finally:
         for oth in others:
             oth.close()
 
 
 def verify(repo, level=None):
     """verify the consistency of a repository"""
     ret = verifymod.verify(repo, level=level)
 
     # Broken subrepo references in hidden csets don't seem worth worrying about,
     # since they can't be pushed/pulled, and --hidden can be used if they are a
     # concern.
 
     # pathto() is needed for -R case
     revs = repo.revs(
         b"filelog(%s)", util.pathto(repo.root, repo.getcwd(), b'.hgsubstate')
     )
 
     if revs:
         repo.ui.status(_(b'checking subrepo links\n'))
         for rev in revs:
             ctx = repo[rev]
             try:
                 for subpath in ctx.substate:
                     try:
                         ret = (
                             ctx.sub(subpath, allowcreate=False).verify() or ret
                         )
                     except error.RepoError as e:
                         repo.ui.warn(b'%d: %s\n' % (rev, e))
             except Exception:
                 repo.ui.warn(
                     _(b'.hgsubstate is corrupt in revision %s\n')
                     % short(ctx.node())
                 )
 
     return ret
 
 
 def remoteui(src, opts):
     """build a remote ui from ui or repo and opts"""
     if util.safehasattr(src, b'baseui'):  # looks like a repository
         dst = src.baseui.copy()  # drop repo-specific config
         src = src.ui  # copy target options from repo
     else:  # assume it's a global ui object
         dst = src.copy()  # keep all global options
 
     # copy ssh-specific options
     for o in b'ssh', b'remotecmd':
         v = opts.get(o) or src.config(b'ui', o)
         if v:
             dst.setconfig(b"ui", o, v, b'copied')
 
     # copy bundle-specific options
     r = src.config(b'bundle', b'mainreporoot')
     if r:
         dst.setconfig(b'bundle', b'mainreporoot', r, b'copied')
 
     # copy selected local settings to the remote ui
     for sect in (b'auth', b'hostfingerprints', b'hostsecurity', b'http_proxy'):
         for key, val in src.configitems(sect):
             dst.setconfig(sect, key, val, b'copied')
     v = src.config(b'web', b'cacerts')
     if v:
         dst.setconfig(b'web', b'cacerts', util.expandpath(v), b'copied')
 
     return dst
 
 
 # Files of interest
 # Used to check if the repository has changed looking at mtime and size of
 # these files.
 foi = [
     (b'spath', b'00changelog.i'),
     (b'spath', b'phaseroots'),  # ! phase can change content at the same size
     (b'spath', b'obsstore'),
     (b'path', b'bookmarks'),  # ! bookmark can change content at the same size
 ]
 
 
 class cachedlocalrepo:
     """Holds a localrepository that can be cached and reused."""
 
     def __init__(self, repo):
         """Create a new cached repo from an existing repo.
 
         We assume the passed in repo was recently created. If the
         repo has changed between when it was created and when it was
         turned into a cache, it may not refresh properly.
         """
         assert isinstance(repo, localrepo.localrepository)
         self._repo = repo
         self._state, self.mtime = self._repostate()
         self._filtername = repo.filtername
 
     def fetch(self):
         """Refresh (if necessary) and return a repository.
 
         If the cached instance is out of date, it will be recreated
         automatically and returned.
 
         Returns a tuple of the repo and a boolean indicating whether a new
         repo instance was created.
         """
         # We compare the mtimes and sizes of some well-known files to
         # determine if the repo changed. This is not precise, as mtimes
         # are susceptible to clock skew and imprecise filesystems and
         # file content can change while maintaining the same size.
 
         state, mtime = self._repostate()
         if state == self._state:
             return self._repo, False
 
         repo = repository(self._repo.baseui, self._repo.url())
         if self._filtername:
             self._repo = repo.filtered(self._filtername)
         else:
             self._repo = repo.unfiltered()
         self._state = state
         self.mtime = mtime
 
         return self._repo, True
 
     def _repostate(self):
         state = []
         maxmtime = -1
         for attr, fname in foi:
             prefix = getattr(self._repo, attr)
             p = os.path.join(prefix, fname)
             try:
                 st = os.stat(p)
             except OSError:
                 st = os.stat(prefix)
             state.append((st[stat.ST_MTIME], st.st_size))
             maxmtime = max(maxmtime, st[stat.ST_MTIME])
 
         return tuple(state), maxmtime
 
     def copy(self):
         """Obtain a copy of this class instance.
 
         A new localrepository instance is obtained. The new instance should be
         completely independent of the original.
         """
         repo = repository(self._repo.baseui, self._repo.origroot)
         if self._filtername:
             repo = repo.filtered(self._filtername)
         else:
             repo = repo.unfiltered()
         c = cachedlocalrepo(repo)
         c._state = self._state
         c.mtime = self.mtime
         return c

mercurial/httppeer.py

@@ -1,640 +1,659 b''
 # httppeer.py - HTTP repository proxy classes for mercurial
 #
 # Copyright 2005, 2006 Olivia Mackall <[e-mail]>
 # Copyright 2006 Vadim Gelfer <[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 errno
 import io
 import os
 import socket
 import struct
 
 from concurrent import futures
 from .i18n import _
 from .pycompat import getattr
 from . import (
     bundle2,
     error,
     httpconnection,
     pycompat,
     statichttprepo,
     url as urlmod,
     util,
     wireprotov1peer,
 )
 from .utils import urlutil
 
 httplib = util.httplib
 urlerr = util.urlerr
 urlreq = util.urlreq
 
 
 def encodevalueinheaders(value, header, limit):
     """Encode a string value into multiple HTTP headers.
 
     ``value`` will be encoded into 1 or more HTTP headers with the names
     ``header-<N>`` where ``<N>`` is an integer starting at 1. Each header
     name + value will be at most ``limit`` bytes long.
 
     Returns an iterable of 2-tuples consisting of header names and
     values as native strings.
     """
     # HTTP Headers are ASCII. Python 3 requires them to be unicodes,
     # not bytes. This function always takes bytes in as arguments.
     fmt = pycompat.strurl(header) + r'-%s'
     # Note: it is *NOT* a bug that the last bit here is a bytestring
     # and not a unicode: we're just getting the encoded length anyway,
     # and using an r-string to make it portable between Python 2 and 3
     # doesn't work because then the \r is a literal backslash-r
     # instead of a carriage return.
     valuelen = limit - len(fmt % '000') - len(b': \r\n')
     result = []
 
     n = 0
     for i in range(0, len(value), valuelen):
         n += 1
         result.append((fmt % str(n), pycompat.strurl(value[i : i + valuelen])))
 
     return result
 
 
 class _multifile:
     def __init__(self, *fileobjs):
         for f in fileobjs:
             if not util.safehasattr(f, b'length'):
                 raise ValueError(
                     b'_multifile only supports file objects that '
                     b'have a length but this one does not:',
                     type(f),
                     f,
                 )
         self._fileobjs = fileobjs
         self._index = 0
 
     @property
     def length(self):
         return sum(f.length for f in self._fileobjs)
 
     def read(self, amt=None):
         if amt <= 0:
             return b''.join(f.read() for f in self._fileobjs)
         parts = []
         while amt and self._index < len(self._fileobjs):
             parts.append(self._fileobjs[self._index].read(amt))
             got = len(parts[-1])
             if got < amt:
                 self._index += 1
             amt -= got
         return b''.join(parts)
 
     def seek(self, offset, whence=os.SEEK_SET):
         if whence != os.SEEK_SET:
             raise NotImplementedError(
                 b'_multifile does not support anything other'
                 b' than os.SEEK_SET for whence on seek()'
             )
         if offset != 0:
             raise NotImplementedError(
                 b'_multifile only supports seeking to start, but that '
                 b'could be fixed if you need it'
             )
         for f in self._fileobjs:
             f.seek(0)
         self._index = 0
 
 
 def makev1commandrequest(
     ui, requestbuilder, caps, capablefn, repobaseurl, cmd, args
 ):
     """Make an HTTP request to run a command for a version 1 client.
 
     ``caps`` is a set of known server capabilities. The value may be
     None if capabilities are not yet known.
 
     ``capablefn`` is a function to evaluate a capability.
 
     ``cmd``, ``args``, and ``data`` define the command, its arguments, and
     raw data to pass to it.
     """
     if cmd == b'pushkey':
         args[b'data'] = b''
     data = args.pop(b'data', None)
     headers = args.pop(b'headers', {})
 
     ui.debug(b"sending %s command\n" % cmd)
     q = [(b'cmd', cmd)]
     headersize = 0
     # Important: don't use self.capable() here or else you end up
     # with infinite recursion when trying to look up capabilities
     # for the first time.
     postargsok = caps is not None and b'httppostargs' in caps
 
     # Send arguments via POST.
     if postargsok and args:
         strargs = urlreq.urlencode(sorted(args.items()))
         if not data:
             data = strargs
         else:
             if isinstance(data, bytes):
                 i = io.BytesIO(data)
                 i.length = len(data)
                 data = i
             argsio = io.BytesIO(strargs)
             argsio.length = len(strargs)
             data = _multifile(argsio, data)
         headers['X-HgArgs-Post'] = len(strargs)
     elif args:
         # Calling self.capable() can infinite loop if we are calling
         # "capabilities". But that command should never accept wire
         # protocol arguments. So this should never happen.
         assert cmd != b'capabilities'
         httpheader = capablefn(b'httpheader')
         if httpheader:
             headersize = int(httpheader.split(b',', 1)[0])
 
         # Send arguments via HTTP headers.
         if headersize > 0:
             # The headers can typically carry more data than the URL.
             encoded_args = urlreq.urlencode(sorted(args.items()))
             for header, value in encodevalueinheaders(
                 encoded_args, b'X-HgArg', headersize
             ):
                 headers[header] = value
         # Send arguments via query string (Mercurial <1.9).
         else:
             q += sorted(args.items())
 
     qs = b'?%s' % urlreq.urlencode(q)
     cu = b"%s%s" % (repobaseurl, qs)
     size = 0
     if util.safehasattr(data, b'length'):
         size = data.length
     elif data is not None:
         size = len(data)
     if data is not None and 'Content-Type' not in headers:
         headers['Content-Type'] = 'application/mercurial-0.1'
 
     # Tell the server we accept application/mercurial-0.2 and multiple
     # compression formats if the server is capable of emitting those
     # payloads.
     # Note: Keep this set empty by default, as client advertisement of
     # protocol parameters should only occur after the handshake.
     protoparams = set()
 
     mediatypes = set()
     if caps is not None:
         mt = capablefn(b'httpmediatype')
         if mt:
             protoparams.add(b'0.1')
             mediatypes = set(mt.split(b','))
 
         protoparams.add(b'partial-pull')
 
     if b'0.2tx' in mediatypes:
         protoparams.add(b'0.2')
 
     if b'0.2tx' in mediatypes and capablefn(b'compression'):
         # We /could/ compare supported compression formats and prune
         # non-mutually supported or error if nothing is mutually supported.
         # For now, send the full list to the server and have it error.
         comps = [
             e.wireprotosupport().name
             for e in util.compengines.supportedwireengines(util.CLIENTROLE)
         ]
         protoparams.add(b'comp=%s' % b','.join(comps))
 
     if protoparams:
         protoheaders = encodevalueinheaders(
             b' '.join(sorted(protoparams)), b'X-HgProto', headersize or 1024
         )
         for header, value in protoheaders:
             headers[header] = value
 
     varyheaders = []
     for header in headers:
         if header.lower().startswith('x-hg'):
             varyheaders.append(header)
 
     if varyheaders:
         headers['Vary'] = ','.join(sorted(varyheaders))
 
     req = requestbuilder(pycompat.strurl(cu), data, headers)
 
     if data is not None:
         ui.debug(b"sending %d bytes\n" % size)
         req.add_unredirected_header('Content-Length', '%d' % size)
 
     return req, cu, qs
 
 
 def sendrequest(ui, opener, req):
     """Send a prepared HTTP request.
 
     Returns the response object.
     """
     dbg = ui.debug
     if ui.debugflag and ui.configbool(b'devel', b'debug.peer-request'):
         line = b'devel-peer-request: %s\n'
         dbg(
             line
             % b'%s %s'
             % (
                 pycompat.bytesurl(req.get_method()),
                 pycompat.bytesurl(req.get_full_url()),
             )
         )
         hgargssize = None
 
         for header, value in sorted(req.header_items()):
             header = pycompat.bytesurl(header)
             value = pycompat.bytesurl(value)
             if header.startswith(b'X-hgarg-'):
                 if hgargssize is None:
                     hgargssize = 0
                 hgargssize += len(value)
             else:
                 dbg(line % b'  %s %s' % (header, value))
 
         if hgargssize is not None:
             dbg(
                 line
                 % b'  %d bytes of commands arguments in headers'
                 % hgargssize
             )
         data = req.data
         if data is not None:
             length = getattr(data, 'length', None)
             if length is None:
                 length = len(data)
             dbg(line % b'  %d bytes of data' % length)
 
         start = util.timer()
 
     res = None
     try:
         res = opener.open(req)
     except urlerr.httperror as inst:
         if inst.code == 401:
             raise error.Abort(_(b'authorization failed'))
         raise
     except httplib.HTTPException as inst:
         ui.debug(
             b'http error requesting %s\n'
             % urlutil.hidepassword(req.get_full_url())
         )
         ui.traceback()
         raise IOError(None, inst)
     finally:
         if ui.debugflag and ui.configbool(b'devel', b'debug.peer-request'):
             code = res.code if res else -1
             dbg(
                 line
                 % b'  finished in %.4f seconds (%d)'
                 % (util.timer() - start, code)
             )
 
     # Insert error handlers for common I/O failures.
     urlmod.wrapresponse(res)
 
     return res
 
 
 class RedirectedRepoError(error.RepoError):
     def __init__(self, msg, respurl):
         super(RedirectedRepoError, self).__init__(msg)
         self.respurl = respurl
 
 
 def parsev1commandresponse(ui, baseurl, requrl, qs, resp, compressible):
     # record the url we got redirected to
     redirected = False
     respurl = pycompat.bytesurl(resp.geturl())
     if respurl.endswith(qs):
         respurl = respurl[: -len(qs)]
         qsdropped = False
     else:
         qsdropped = True
 
     if baseurl.rstrip(b'/') != respurl.rstrip(b'/'):
         redirected = True
         if not ui.quiet:
             ui.warn(_(b'real URL is %s\n') % respurl)
 
     try:
         proto = pycompat.bytesurl(resp.getheader('content-type', ''))
     except AttributeError:
         proto = pycompat.bytesurl(resp.headers.get('content-type', ''))
 
     safeurl = urlutil.hidepassword(baseurl)
     if proto.startswith(b'application/hg-error'):
         raise error.OutOfBandError(resp.read())
 
     # Pre 1.0 versions of Mercurial used text/plain and
     # application/hg-changegroup. We don't support such old servers.
     if not proto.startswith(b'application/mercurial-'):
         ui.debug(b"requested URL: '%s'\n" % urlutil.hidepassword(requrl))
         msg = _(
             b"'%s' does not appear to be an hg repository:\n"
             b"---%%<--- (%s)\n%s\n---%%<---\n"
         ) % (safeurl, proto or b'no content-type', resp.read(1024))
 
         # Some servers may strip the query string from the redirect. We
         # raise a special error type so callers can react to this specially.
         if redirected and qsdropped:
             raise RedirectedRepoError(msg, respurl)
         else:
             raise error.RepoError(msg)
 
     try:
         subtype = proto.split(b'-', 1)[1]
 
         version_info = tuple([int(n) for n in subtype.split(b'.')])
     except ValueError:
         raise error.RepoError(
             _(b"'%s' sent a broken Content-Type header (%s)") % (safeurl, proto)
         )
 
     # TODO consider switching to a decompression reader that uses
     # generators.
     if version_info == (0, 1):
         if compressible:
             resp = util.compengines[b'zlib'].decompressorreader(resp)
 
     elif version_info == (0, 2):
         # application/mercurial-0.2 always identifies the compression
         # engine in the payload header.
         elen = struct.unpack(b'B', util.readexactly(resp, 1))[0]
         ename = util.readexactly(resp, elen)
         engine = util.compengines.forwiretype(ename)
 
         resp = engine.decompressorreader(resp)
     else:
         raise error.RepoError(
             _(b"'%s' uses newer protocol %s") % (safeurl, subtype)
         )
 
     return respurl, proto, resp
 
 
 class httppeer(wireprotov1peer.wirepeer):
-    def __init__(self, ui, path, url, opener, requestbuilder, caps):
-        super().__init__(ui, path=path)
+    def __init__(
+        self, ui, path, url, opener, requestbuilder, caps, remotehidden=False
+    ):
+        super().__init__(ui, path=path, remotehidden=remotehidden)
+        if remotehidden:
+            msg = _(
+                b"ignoring `--remote-hidden` request\n"
+                b"(access to hidden changeset for http peers not "
+                b"supported yet)\n"
+            )
+            ui.warn(msg)
         self._url = url
         self._caps = caps
         self.limitedarguments = caps is not None and b'httppostargs' not in caps
         self._urlopener = opener
         self._requestbuilder = requestbuilder
 
     def __del__(self):
         for h in self._urlopener.handlers:
             h.close()
             getattr(h, "close_all", lambda: None)()
 
     # Begin of ipeerconnection interface.
 
     def url(self):
         return self.path.loc
 
     def local(self):
         return None
 
     def canpush(self):
         return True
 
     def close(self):
         try:
             reqs, sent, recv = (
                 self._urlopener.requestscount,
                 self._urlopener.sentbytescount,
                 self._urlopener.receivedbytescount,
             )
         except AttributeError:
             return
         self.ui.note(
             _(
                 b'(sent %d HTTP requests and %d bytes; '
                 b'received %d bytes in responses)\n'
             )
             % (reqs, sent, recv)
         )
 
     # End of ipeerconnection interface.
 
     # Begin of ipeercommands interface.
 
     def capabilities(self):
         return self._caps
 
     # End of ipeercommands interface.
 
     def _callstream(self, cmd, _compressible=False, **args):
         args = pycompat.byteskwargs(args)
 
         req, cu, qs = makev1commandrequest(
             self.ui,
             self._requestbuilder,
             self._caps,
             self.capable,
             self._url,
             cmd,
             args,
         )
 
         resp = sendrequest(self.ui, self._urlopener, req)
 
         self._url, ct, resp = parsev1commandresponse(
             self.ui, self._url, cu, qs, resp, _compressible
         )
 
         return resp
 
     def _call(self, cmd, **args):
         fp = self._callstream(cmd, **args)
         try:
             return fp.read()
         finally:
             # if using keepalive, allow connection to be reused
             fp.close()
 
     def _callpush(self, cmd, cg, **args):
         # have to stream bundle to a temp file because we do not have
         # http 1.1 chunked transfer.
 
         types = self.capable(b'unbundle')
         try:
             types = types.split(b',')
         except AttributeError:
             # servers older than d1b16a746db6 will send 'unbundle' as a
             # boolean capability. They only support headerless/uncompressed
             # bundles.
             types = [b""]
         for x in types:
             if x in bundle2.bundletypes:
                 type = x
                 break
 
         tempname = bundle2.writebundle(self.ui, cg, None, type)
         fp = httpconnection.httpsendfile(self.ui, tempname, b"rb")
         headers = {'Content-Type': 'application/mercurial-0.1'}
 
         try:
             r = self._call(cmd, data=fp, headers=headers, **args)
             vals = r.split(b'\n', 1)
             if len(vals) < 2:
                 raise error.ResponseError(_(b"unexpected response:"), r)
             return vals
         except urlerr.httperror:
             # Catch and re-raise these so we don't try and treat them
             # like generic socket errors. They lack any values in
             # .args on Python 3 which breaks our socket.error block.
             raise
         except socket.error as err:
             if err.args[0] in (errno.ECONNRESET, errno.EPIPE):
                 raise error.Abort(_(b'push failed: %s') % err.args[1])
             raise error.Abort(err.args[1])
         finally:
             fp.close()
             os.unlink(tempname)
 
     def _calltwowaystream(self, cmd, fp, **args):
         filename = None
         try:
             # dump bundle to disk
             fd, filename = pycompat.mkstemp(prefix=b"hg-bundle-", suffix=b".hg")
             with os.fdopen(fd, "wb") as fh:
                 d = fp.read(4096)
                 while d:
                     fh.write(d)
                     d = fp.read(4096)
             # start http push
             with httpconnection.httpsendfile(self.ui, filename, b"rb") as fp_:
                 headers = {'Content-Type': 'application/mercurial-0.1'}
                 return self._callstream(cmd, data=fp_, headers=headers, **args)
         finally:
             if filename is not None:
                 os.unlink(filename)
 
     def _callcompressable(self, cmd, **args):
         return self._callstream(cmd, _compressible=True, **args)
 
     def _abort(self, exception):
         raise exception
 
 
 class queuedcommandfuture(futures.Future):
     """Wraps result() on command futures to trigger submission on call."""
 
     def result(self, timeout=None):
         if self.done():
             return futures.Future.result(self, timeout)
 
         self._peerexecutor.sendcommands()
 
         # sendcommands() will restore the original __class__ and self.result
         # will resolve to Future.result.
         return self.result(timeout)
 
 
 def performhandshake(ui, url, opener, requestbuilder):
     # The handshake is a request to the capabilities command.
 
     caps = None
 
     def capable(x):
         raise error.ProgrammingError(b'should not be called')
 
     args = {}
 
     req, requrl, qs = makev1commandrequest(
         ui, requestbuilder, caps, capable, url, b'capabilities', args
     )
     resp = sendrequest(ui, opener, req)
 
     # The server may redirect us to the repo root, stripping the
     # ?cmd=capabilities query string from the URL. The server would likely
     # return HTML in this case and ``parsev1commandresponse()`` would raise.
     # We catch this special case and re-issue the capabilities request against
     # the new URL.
     #
     # We should ideally not do this, as a redirect that drops the query
     # string from the URL is arguably a server bug. (Garbage in, garbage out).
     # However,  Mercurial clients for several years appeared to handle this
     # issue without behavior degradation. And according to issue 5860, it may
     # be a longstanding bug in some server implementations. So we allow a
     # redirect that drops the query string to "just work."
     try:
         respurl, ct, resp = parsev1commandresponse(
             ui, url, requrl, qs, resp, compressible=False
         )
     except RedirectedRepoError as e:
         req, requrl, qs = makev1commandrequest(
             ui, requestbuilder, caps, capable, e.respurl, b'capabilities', args
         )
         resp = sendrequest(ui, opener, req)
         respurl, ct, resp = parsev1commandresponse(
             ui, url, requrl, qs, resp, compressible=False
         )
 
     try:
         rawdata = resp.read()
     finally:
         resp.close()
 
     if not ct.startswith(b'application/mercurial-'):
         raise error.ProgrammingError(b'unexpected content-type: %s' % ct)
 
     info = {b'v1capabilities': set(rawdata.split())}
 
     return respurl, info
 
 
-def _make_peer(ui, path, opener=None, requestbuilder=urlreq.request):
+def _make_peer(
+    ui, path, opener=None, requestbuilder=urlreq.request, remotehidden=False
+):
     """Construct an appropriate HTTP peer instance.
 
     ``opener`` is an ``url.opener`` that should be used to establish
     connections, perform HTTP requests.
 
     ``requestbuilder`` is the type used for constructing HTTP requests.
     It exists as an argument so extensions can override the default.
     """
     if path.url.query or path.url.fragment:
         msg = _(b'unsupported URL component: "%s"')
         msg %= path.url.query or path.url.fragment
         raise error.Abort(msg)
 
     # urllib cannot handle URLs with embedded user or passwd.
     url, authinfo = path.url.authinfo()
     ui.debug(b'using %s\n' % url)
 
     opener = opener or urlmod.opener(ui, authinfo)
 
     respurl, info = performhandshake(ui, url, opener, requestbuilder)
 
     return httppeer(
-        ui, path, respurl, opener, requestbuilder, info[b'v1capabilities']
+        ui,
+        path,
+        respurl,
+        opener,
+        requestbuilder,
+        info[b'v1capabilities'],
+        remotehidden=remotehidden,
     )
 
 
-def make_peer(ui, path, create, intents=None, createopts=None):
+def make_peer(
+    ui, path, create, intents=None, createopts=None, remotehidden=False
+):
     if create:
         raise error.Abort(_(b'cannot create new http repository'))
     try:
         if path.url.scheme == b'https' and not urlmod.has_https:
             raise error.Abort(
                 _(b'Python support for SSL and HTTPS is not installed')
             )
 
-        inst = _make_peer(ui, path)
+        inst = _make_peer(ui, path, remotehidden=remotehidden)
 
         return inst
     except error.RepoError as httpexception:
         try:
             r = statichttprepo.make_peer(ui, b"static-" + path.loc, create)
             ui.note(_(b'(falling back to static-http)\n'))
             return r
         except error.RepoError:
             raise httpexception  # use the original http RepoError instead

mercurial/interfaces/repository.py

@@ -1,2065 +1,2065 b''
 # repository.py - Interfaces and base classes for repositories and peers.
 # coding: utf-8
 #
 # Copyright 2017 Gregory Szorc <[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.
 
 
 from ..i18n import _
 from .. import error
 from . import util as interfaceutil
 
 # Local repository feature string.
 
 # Revlogs are being used for file storage.
 REPO_FEATURE_REVLOG_FILE_STORAGE = b'revlogfilestorage'
 # The storage part of the repository is shared from an external source.
 REPO_FEATURE_SHARED_STORAGE = b'sharedstore'
 # LFS supported for backing file storage.
 REPO_FEATURE_LFS = b'lfs'
 # Repository supports being stream cloned.
 REPO_FEATURE_STREAM_CLONE = b'streamclone'
 # Repository supports (at least) some sidedata to be stored
 REPO_FEATURE_SIDE_DATA = b'side-data'
 # Files storage may lack data for all ancestors.
 REPO_FEATURE_SHALLOW_FILE_STORAGE = b'shallowfilestorage'
 
 REVISION_FLAG_CENSORED = 1 << 15
 REVISION_FLAG_ELLIPSIS = 1 << 14
 REVISION_FLAG_EXTSTORED = 1 << 13
 REVISION_FLAG_HASCOPIESINFO = 1 << 12
 
 REVISION_FLAGS_KNOWN = (
     REVISION_FLAG_CENSORED
     | REVISION_FLAG_ELLIPSIS
     | REVISION_FLAG_EXTSTORED
     | REVISION_FLAG_HASCOPIESINFO
 )
 
 CG_DELTAMODE_STD = b'default'
 CG_DELTAMODE_PREV = b'previous'
 CG_DELTAMODE_FULL = b'fulltext'
 CG_DELTAMODE_P1 = b'p1'
 
 
 ## Cache related constants:
 #
 # Used to control which cache should be warmed in a repo.updatecaches(…) call.
 
 # Warm branchmaps of all known repoview's filter-level
 CACHE_BRANCHMAP_ALL = b"branchmap-all"
 # Warm branchmaps of repoview's filter-level used by server
 CACHE_BRANCHMAP_SERVED = b"branchmap-served"
 # Warm internal changelog cache (eg: persistent nodemap)
 CACHE_CHANGELOG_CACHE = b"changelog-cache"
 # Warm full manifest cache
 CACHE_FULL_MANIFEST = b"full-manifest"
 # Warm file-node-tags cache
 CACHE_FILE_NODE_TAGS = b"file-node-tags"
 # Warm internal manifestlog cache (eg: persistent nodemap)
 CACHE_MANIFESTLOG_CACHE = b"manifestlog-cache"
 # Warn rev branch cache
 CACHE_REV_BRANCH = b"rev-branch-cache"
 # Warm tags' cache for default repoview'
 CACHE_TAGS_DEFAULT = b"tags-default"
 # Warm tags' cache for  repoview's filter-level used by server
 CACHE_TAGS_SERVED = b"tags-served"
 
 # the cache to warm by default after a simple transaction
 # (this is a mutable set to let extension update it)
 CACHES_DEFAULT = {
     CACHE_BRANCHMAP_SERVED,
 }
 
 # the caches to warm when warming all of them
 # (this is a mutable set to let extension update it)
 CACHES_ALL = {
     CACHE_BRANCHMAP_SERVED,
     CACHE_BRANCHMAP_ALL,
     CACHE_CHANGELOG_CACHE,
     CACHE_FILE_NODE_TAGS,
     CACHE_FULL_MANIFEST,
     CACHE_MANIFESTLOG_CACHE,
     CACHE_TAGS_DEFAULT,
     CACHE_TAGS_SERVED,
 }
 
 # the cache to warm by default on simple call
 # (this is a mutable set to let extension update it)
 CACHES_POST_CLONE = CACHES_ALL.copy()
 CACHES_POST_CLONE.discard(CACHE_FILE_NODE_TAGS)
 
 
 class ipeerconnection(interfaceutil.Interface):
     """Represents a "connection" to a repository.
 
     This is the base interface for representing a connection to a repository.
     It holds basic properties and methods applicable to all peer types.
 
     This is not a complete interface definition and should not be used
     outside of this module.
     """
 
     ui = interfaceutil.Attribute("""ui.ui instance""")
     path = interfaceutil.Attribute("""a urlutil.path instance or None""")
 
     def url():
         """Returns a URL string representing this peer.
 
         Currently, implementations expose the raw URL used to construct the
         instance. It may contain credentials as part of the URL. The
         expectations of the value aren't well-defined and this could lead to
         data leakage.
 
         TODO audit/clean consumers and more clearly define the contents of this
         value.
         """
 
     def local():
         """Returns a local repository instance.
 
         If the peer represents a local repository, returns an object that
         can be used to interface with it. Otherwise returns ``None``.
         """
 
     def canpush():
         """Returns a boolean indicating if this peer can be pushed to."""
 
     def close():
         """Close the connection to this peer.
 
         This is called when the peer will no longer be used. Resources
         associated with the peer should be cleaned up.
         """
 
 
 class ipeercapabilities(interfaceutil.Interface):
     """Peer sub-interface related to capabilities."""
 
     def capable(name):
         """Determine support for a named capability.
 
         Returns ``False`` if capability not supported.
 
         Returns ``True`` if boolean capability is supported. Returns a string
         if capability support is non-boolean.
 
         Capability strings may or may not map to wire protocol capabilities.
         """
 
     def requirecap(name, purpose):
         """Require a capability to be present.
 
         Raises a ``CapabilityError`` if the capability isn't present.
         """
 
 
 class ipeercommands(interfaceutil.Interface):
     """Client-side interface for communicating over the wire protocol.
 
     This interface is used as a gateway to the Mercurial wire protocol.
     methods commonly call wire protocol commands of the same name.
     """
 
     def branchmap():
         """Obtain heads in named branches.
 
         Returns a dict mapping branch name to an iterable of nodes that are
         heads on that branch.
         """
 
     def capabilities():
         """Obtain capabilities of the peer.
 
         Returns a set of string capabilities.
         """
 
     def clonebundles():
         """Obtains the clone bundles manifest for the repo.
 
         Returns the manifest as unparsed bytes.
         """
 
     def debugwireargs(one, two, three=None, four=None, five=None):
         """Used to facilitate debugging of arguments passed over the wire."""
 
     def getbundle(source, **kwargs):
         """Obtain remote repository data as a bundle.
 
         This command is how the bulk of repository data is transferred from
         the peer to the local repository
 
         Returns a generator of bundle data.
         """
 
     def heads():
         """Determine all known head revisions in the peer.
 
         Returns an iterable of binary nodes.
         """
 
     def known(nodes):
         """Determine whether multiple nodes are known.
 
         Accepts an iterable of nodes whose presence to check for.
 
         Returns an iterable of booleans indicating of the corresponding node
         at that index is known to the peer.
         """
 
     def listkeys(namespace):
         """Obtain all keys in a pushkey namespace.
 
         Returns an iterable of key names.
         """
 
     def lookup(key):
         """Resolve a value to a known revision.
 
         Returns a binary node of the resolved revision on success.
         """
 
     def pushkey(namespace, key, old, new):
         """Set a value using the ``pushkey`` protocol.
 
         Arguments correspond to the pushkey namespace and key to operate on and
         the old and new values for that key.
 
         Returns a string with the peer result. The value inside varies by the
         namespace.
         """
 
     def stream_out():
         """Obtain streaming clone data.
 
         Successful result should be a generator of data chunks.
         """
 
     def unbundle(bundle, heads, url):
         """Transfer repository data to the peer.
 
         This is how the bulk of data during a push is transferred.
 
         Returns the integer number of heads added to the peer.
         """
 
 
 class ipeerlegacycommands(interfaceutil.Interface):
     """Interface for implementing support for legacy wire protocol commands.
 
     Wire protocol commands transition to legacy status when they are no longer
     used by modern clients. To facilitate identifying which commands are
     legacy, the interfaces are split.
     """
 
     def between(pairs):
         """Obtain nodes between pairs of nodes.
 
         ``pairs`` is an iterable of node pairs.
 
         Returns an iterable of iterables of nodes corresponding to each
         requested pair.
         """
 
     def branches(nodes):
         """Obtain ancestor changesets of specific nodes back to a branch point.
 
         For each requested node, the peer finds the first ancestor node that is
         a DAG root or is a merge.
 
         Returns an iterable of iterables with the resolved values for each node.
         """
 
     def changegroup(nodes, source):
         """Obtain a changegroup with data for descendants of specified nodes."""
 
     def changegroupsubset(bases, heads, source):
         pass
 
 
 class ipeercommandexecutor(interfaceutil.Interface):
     """Represents a mechanism to execute remote commands.
 
     This is the primary interface for requesting that wire protocol commands
     be executed. Instances of this interface are active in a context manager
     and have a well-defined lifetime. When the context manager exits, all
     outstanding requests are waited on.
     """
 
     def callcommand(name, args):
         """Request that a named command be executed.
 
         Receives the command name and a dictionary of command arguments.
 
         Returns a ``concurrent.futures.Future`` that will resolve to the
         result of that command request. That exact value is left up to
         the implementation and possibly varies by command.
 
         Not all commands can coexist with other commands in an executor
         instance: it depends on the underlying wire protocol transport being
         used and the command itself.
 
         Implementations MAY call ``sendcommands()`` automatically if the
         requested command can not coexist with other commands in this executor.
 
         Implementations MAY call ``sendcommands()`` automatically when the
         future's ``result()`` is called. So, consumers using multiple
         commands with an executor MUST ensure that ``result()`` is not called
         until all command requests have been issued.
         """
 
     def sendcommands():
         """Trigger submission of queued command requests.
 
         Not all transports submit commands as soon as they are requested to
         run. When called, this method forces queued command requests to be
         issued. It will no-op if all commands have already been sent.
 
         When called, no more new commands may be issued with this executor.
         """
 
     def close():
         """Signal that this command request is finished.
 
         When called, no more new commands may be issued. All outstanding
         commands that have previously been issued are waited on before
         returning. This not only includes waiting for the futures to resolve,
         but also waiting for all response data to arrive. In other words,
         calling this waits for all on-wire state for issued command requests
         to finish.
 
         When used as a context manager, this method is called when exiting the
         context manager.
 
         This method may call ``sendcommands()`` if there are buffered commands.
         """
 
 
 class ipeerrequests(interfaceutil.Interface):
     """Interface for executing commands on a peer."""
 
     limitedarguments = interfaceutil.Attribute(
         """True if the peer cannot receive large argument value for commands."""
     )
 
     def commandexecutor():
         """A context manager that resolves to an ipeercommandexecutor.
 
         The object this resolves to can be used to issue command requests
         to the peer.
 
         Callers should call its ``callcommand`` method to issue command
         requests.
 
         A new executor should be obtained for each distinct set of commands
         (possibly just a single command) that the consumer wants to execute
         as part of a single operation or round trip. This is because some
         peers are half-duplex and/or don't support persistent connections.
         e.g. in the case of HTTP peers, commands sent to an executor represent
         a single HTTP request. While some peers may support multiple command
         sends over the wire per executor, consumers need to code to the least
         capable peer. So it should be assumed that command executors buffer
         called commands until they are told to send them and that each
         command executor could result in a new connection or wire-level request
         being issued.
         """
 
 
 class ipeerbase(ipeerconnection, ipeercapabilities, ipeerrequests):
     """Unified interface for peer repositories.
 
     All peer instances must conform to this interface.
     """
 
 
 class ipeerv2(ipeerconnection, ipeercapabilities, ipeerrequests):
     """Unified peer interface for wire protocol version 2 peers."""
 
     apidescriptor = interfaceutil.Attribute(
         """Data structure holding description of server API."""
     )
 
 
 @interfaceutil.implementer(ipeerbase)
 class peer:
     """Base class for peer repositories."""
 
     limitedarguments = False
 
-    def __init__(self, ui, path=None):
+    def __init__(self, ui, path=None, remotehidden=False):
         self.ui = ui
         self.path = path
 
     def capable(self, name):
         caps = self.capabilities()
         if name in caps:
             return True
 
         name = b'%s=' % name
         for cap in caps:
             if cap.startswith(name):
                 return cap[len(name) :]
 
         return False
 
     def requirecap(self, name, purpose):
         if self.capable(name):
             return
 
         raise error.CapabilityError(
             _(
                 b'cannot %s; remote repository does not support the '
                 b'\'%s\' capability'
             )
             % (purpose, name)
         )
 
 
 class iverifyproblem(interfaceutil.Interface):
     """Represents a problem with the integrity of the repository.
 
     Instances of this interface are emitted to describe an integrity issue
     with a repository (e.g. corrupt storage, missing data, etc).
 
     Instances are essentially messages associated with severity.
     """
 
     warning = interfaceutil.Attribute(
         """Message indicating a non-fatal problem."""
     )
 
     error = interfaceutil.Attribute("""Message indicating a fatal problem.""")
 
     node = interfaceutil.Attribute(
         """Revision encountering the problem.
 
         ``None`` means the problem doesn't apply to a single revision.
         """
     )
 
 
 class irevisiondelta(interfaceutil.Interface):
     """Represents a delta between one revision and another.
 
     Instances convey enough information to allow a revision to be exchanged
     with another repository.
 
     Instances represent the fulltext revision data or a delta against
     another revision. Therefore the ``revision`` and ``delta`` attributes
     are mutually exclusive.
 
     Typically used for changegroup generation.
     """
 
     node = interfaceutil.Attribute("""20 byte node of this revision.""")
 
     p1node = interfaceutil.Attribute(
         """20 byte node of 1st parent of this revision."""
     )
 
     p2node = interfaceutil.Attribute(
         """20 byte node of 2nd parent of this revision."""
     )
 
     linknode = interfaceutil.Attribute(
         """20 byte node of the changelog revision this node is linked to."""
     )
 
     flags = interfaceutil.Attribute(
         """2 bytes of integer flags that apply to this revision.
 
         This is a bitwise composition of the ``REVISION_FLAG_*`` constants.
         """
     )
 
     basenode = interfaceutil.Attribute(
         """20 byte node of the revision this data is a delta against.
 
         ``nullid`` indicates that the revision is a full revision and not
         a delta.
         """
     )
 
     baserevisionsize = interfaceutil.Attribute(
         """Size of base revision this delta is against.
 
         May be ``None`` if ``basenode`` is ``nullid``.
         """
     )
 
     revision = interfaceutil.Attribute(
         """Raw fulltext of revision data for this node."""
     )
 
     delta = interfaceutil.Attribute(
         """Delta between ``basenode`` and ``node``.
 
         Stored in the bdiff delta format.
         """
     )
 
     sidedata = interfaceutil.Attribute(
         """Raw sidedata bytes for the given revision."""
     )
 
     protocol_flags = interfaceutil.Attribute(
         """Single byte of integer flags that can influence the protocol.
 
         This is a bitwise composition of the ``storageutil.CG_FLAG*`` constants.
         """
     )
 
 
 class ifilerevisionssequence(interfaceutil.Interface):
     """Contains index data for all revisions of a file.
 
     Types implementing this behave like lists of tuples. The index
     in the list corresponds to the revision number. The values contain
     index metadata.
 
     The *null* revision (revision number -1) is always the last item
     in the index.
     """
 
     def __len__():
         """The total number of revisions."""
 
     def __getitem__(rev):
         """Returns the object having a specific revision number.
 
         Returns an 8-tuple with the following fields:
 
         offset+flags
            Contains the offset and flags for the revision. 64-bit unsigned
            integer where first 6 bytes are the offset and the next 2 bytes
            are flags. The offset can be 0 if it is not used by the store.
         compressed size
             Size of the revision data in the store. It can be 0 if it isn't
             needed by the store.
         uncompressed size
             Fulltext size. It can be 0 if it isn't needed by the store.
         base revision
             Revision number of revision the delta for storage is encoded
             against. -1 indicates not encoded against a base revision.
         link revision
             Revision number of changelog revision this entry is related to.
         p1 revision
             Revision number of 1st parent. -1 if no 1st parent.
         p2 revision
             Revision number of 2nd parent. -1 if no 1st parent.
         node
             Binary node value for this revision number.
 
         Negative values should index off the end of the sequence. ``-1``
         should return the null revision. ``-2`` should return the most
         recent revision.
         """
 
     def __contains__(rev):
         """Whether a revision number exists."""
 
     def insert(self, i, entry):
         """Add an item to the index at specific revision."""
 
 
 class ifileindex(interfaceutil.Interface):
     """Storage interface for index data of a single file.
 
     File storage data is divided into index metadata and data storage.
     This interface defines the index portion of the interface.
 
     The index logically consists of:
 
     * A mapping between revision numbers and nodes.
     * DAG data (storing and querying the relationship between nodes).
     * Metadata to facilitate storage.
     """
 
     nullid = interfaceutil.Attribute(
         """node for the null revision for use as delta base."""
     )
 
     def __len__():
         """Obtain the number of revisions stored for this file."""
 
     def __iter__():
         """Iterate over revision numbers for this file."""
 
     def hasnode(node):
         """Returns a bool indicating if a node is known to this store.
 
         Implementations must only return True for full, binary node values:
         hex nodes, revision numbers, and partial node matches must be
         rejected.
 
         The null node is never present.
         """
 
     def revs(start=0, stop=None):
         """Iterate over revision numbers for this file, with control."""
 
     def parents(node):
         """Returns a 2-tuple of parent nodes for a revision.
 
         Values will be ``nullid`` if the parent is empty.
         """
 
     def parentrevs(rev):
         """Like parents() but operates on revision numbers."""
 
     def rev(node):
         """Obtain the revision number given a node.
 
         Raises ``error.LookupError`` if the node is not known.
         """
 
     def node(rev):
         """Obtain the node value given a revision number.
 
         Raises ``IndexError`` if the node is not known.
         """
 
     def lookup(node):
         """Attempt to resolve a value to a node.
 
         Value can be a binary node, hex node, revision number, or a string
         that can be converted to an integer.
 
         Raises ``error.LookupError`` if a node could not be resolved.
         """
 
     def linkrev(rev):
         """Obtain the changeset revision number a revision is linked to."""
 
     def iscensored(rev):
         """Return whether a revision's content has been censored."""
 
     def commonancestorsheads(node1, node2):
         """Obtain an iterable of nodes containing heads of common ancestors.
 
         See ``ancestor.commonancestorsheads()``.
         """
 
     def descendants(revs):
         """Obtain descendant revision numbers for a set of revision numbers.
 
         If ``nullrev`` is in the set, this is equivalent to ``revs()``.
         """
 
     def heads(start=None, stop=None):
         """Obtain a list of nodes that are DAG heads, with control.
 
         The set of revisions examined can be limited by specifying
         ``start`` and ``stop``. ``start`` is a node. ``stop`` is an
         iterable of nodes. DAG traversal starts at earlier revision
         ``start`` and iterates forward until any node in ``stop`` is
         encountered.
         """
 
     def children(node):
         """Obtain nodes that are children of a node.
 
         Returns a list of nodes.
         """
 
 
 class ifiledata(interfaceutil.Interface):
     """Storage interface for data storage of a specific file.
 
     This complements ``ifileindex`` and provides an interface for accessing
     data for a tracked file.
     """
 
     def size(rev):
         """Obtain the fulltext size of file data.
 
         Any metadata is excluded from size measurements.
         """
 
     def revision(node, raw=False):
         """Obtain fulltext data for a node.
 
         By default, any storage transformations are applied before the data
         is returned. If ``raw`` is True, non-raw storage transformations
         are not applied.
 
         The fulltext data may contain a header containing metadata. Most
         consumers should use ``read()`` to obtain the actual file data.
         """
 
     def rawdata(node):
         """Obtain raw data for a node."""
 
     def read(node):
         """Resolve file fulltext data.
 
         This is similar to ``revision()`` except any metadata in the data
         headers is stripped.
         """
 
     def renamed(node):
         """Obtain copy metadata for a node.
 
         Returns ``False`` if no copy metadata is stored or a 2-tuple of
         (path, node) from which this revision was copied.
         """
 
     def cmp(node, fulltext):
         """Compare fulltext to another revision.
 
         Returns True if the fulltext is different from what is stored.
 
         This takes copy metadata into account.
 
         TODO better document the copy metadata and censoring logic.
         """
 
     def emitrevisions(
         nodes,
         nodesorder=None,
         revisiondata=False,
         assumehaveparentrevisions=False,
         deltamode=CG_DELTAMODE_STD,
     ):
         """Produce ``irevisiondelta`` for revisions.
 
         Given an iterable of nodes, emits objects conforming to the
         ``irevisiondelta`` interface that describe revisions in storage.
 
         This method is a generator.
 
         The input nodes may be unordered. Implementations must ensure that a
         node's parents are emitted before the node itself. Transitively, this
         means that a node may only be emitted once all its ancestors in
         ``nodes`` have also been emitted.
 
         By default, emits "index" data (the ``node``, ``p1node``, and
         ``p2node`` attributes). If ``revisiondata`` is set, revision data
         will also be present on the emitted objects.
 
         With default argument values, implementations can choose to emit
         either fulltext revision data or a delta. When emitting deltas,
         implementations must consider whether the delta's base revision
         fulltext is available to the receiver.
 
         The base revision fulltext is guaranteed to be available if any of
         the following are met:
 
         * Its fulltext revision was emitted by this method call.
         * A delta for that revision was emitted by this method call.
         * ``assumehaveparentrevisions`` is True and the base revision is a
           parent of the node.
 
         ``nodesorder`` can be used to control the order that revisions are
         emitted. By default, revisions can be reordered as long as they are
         in DAG topological order (see above). If the value is ``nodes``,
         the iteration order from ``nodes`` should be used. If the value is
         ``storage``, then the native order from the backing storage layer
         is used. (Not all storage layers will have strong ordering and behavior
         of this mode is storage-dependent.) ``nodes`` ordering can force
         revisions to be emitted before their ancestors, so consumers should
         use it with care.
 
         The ``linknode`` attribute on the returned ``irevisiondelta`` may not
         be set and it is the caller's responsibility to resolve it, if needed.
 
         If ``deltamode`` is CG_DELTAMODE_PREV and revision data is requested,
         all revision data should be emitted as deltas against the revision
         emitted just prior. The initial revision should be a delta against its
         1st parent.
         """
 
 
 class ifilemutation(interfaceutil.Interface):
     """Storage interface for mutation events of a tracked file."""
 
     def add(filedata, meta, transaction, linkrev, p1, p2):
         """Add a new revision to the store.
 
         Takes file data, dictionary of metadata, a transaction, linkrev,
         and parent nodes.
 
         Returns the node that was added.
 
         May no-op if a revision matching the supplied data is already stored.
         """
 
     def addrevision(
         revisiondata,
         transaction,
         linkrev,
         p1,
         p2,
         node=None,
         flags=0,
         cachedelta=None,
     ):
         """Add a new revision to the store and return its number.
 
         This is similar to ``add()`` except it operates at a lower level.
 
         The data passed in already contains a metadata header, if any.
 
         ``node`` and ``flags`` can be used to define the expected node and
         the flags to use with storage. ``flags`` is a bitwise value composed
         of the various ``REVISION_FLAG_*`` constants.
 
         ``add()`` is usually called when adding files from e.g. the working
         directory. ``addrevision()`` is often called by ``add()`` and for
         scenarios where revision data has already been computed, such as when
         applying raw data from a peer repo.
         """
 
     def addgroup(
         deltas,
         linkmapper,
         transaction,
         addrevisioncb=None,
         duplicaterevisioncb=None,
         maybemissingparents=False,
     ):
         """Process a series of deltas for storage.
 
         ``deltas`` is an iterable of 7-tuples of
         (node, p1, p2, linknode, deltabase, delta, flags) defining revisions
         to add.
 
         The ``delta`` field contains ``mpatch`` data to apply to a base
         revision, identified by ``deltabase``. The base node can be
         ``nullid``, in which case the header from the delta can be ignored
         and the delta used as the fulltext.
 
         ``alwayscache`` instructs the lower layers to cache the content of the
         newly added revision, even if it needs to be explicitly computed.
         This used to be the default when ``addrevisioncb`` was provided up to
         Mercurial 5.8.
 
         ``addrevisioncb`` should be called for each new rev as it is committed.
         ``duplicaterevisioncb`` should be called for all revs with a
         pre-existing node.
 
         ``maybemissingparents`` is a bool indicating whether the incoming
         data may reference parents/ancestor revisions that aren't present.
         This flag is set when receiving data into a "shallow" store that
         doesn't hold all history.
 
         Returns a list of nodes that were processed. A node will be in the list
         even if it existed in the store previously.
         """
 
     def censorrevision(tr, node, tombstone=b''):
         """Remove the content of a single revision.
 
         The specified ``node`` will have its content purged from storage.
         Future attempts to access the revision data for this node will
         result in failure.
 
         A ``tombstone`` message can optionally be stored. This message may be
         displayed to users when they attempt to access the missing revision
         data.
 
         Storage backends may have stored deltas against the previous content
         in this revision. As part of censoring a revision, these storage
         backends are expected to rewrite any internally stored deltas such
         that they no longer reference the deleted content.
         """
 
     def getstrippoint(minlink):
         """Find the minimum revision that must be stripped to strip a linkrev.
 
         Returns a 2-tuple containing the minimum revision number and a set
         of all revisions numbers that would be broken by this strip.
 
         TODO this is highly revlog centric and should be abstracted into
         a higher-level deletion API. ``repair.strip()`` relies on this.
         """
 
     def strip(minlink, transaction):
         """Remove storage of items starting at a linkrev.
 
         This uses ``getstrippoint()`` to determine the first node to remove.
         Then it effectively truncates storage for all revisions after that.
 
         TODO this is highly revlog centric and should be abstracted into a
         higher-level deletion API.
         """
 
 
 class ifilestorage(ifileindex, ifiledata, ifilemutation):
     """Complete storage interface for a single tracked file."""
 
     def files():
         """Obtain paths that are backing storage for this file.
 
         TODO this is used heavily by verify code and there should probably
         be a better API for that.
         """
 
     def storageinfo(
         exclusivefiles=False,
         sharedfiles=False,
         revisionscount=False,
         trackedsize=False,
         storedsize=False,
     ):
         """Obtain information about storage for this file's data.
 
         Returns a dict describing storage for this tracked path. The keys
         in the dict map to arguments of the same. The arguments are bools
         indicating whether to calculate and obtain that data.
 
         exclusivefiles
            Iterable of (vfs, path) describing files that are exclusively
            used to back storage for this tracked path.
 
         sharedfiles
            Iterable of (vfs, path) describing files that are used to back
            storage for this tracked path. Those files may also provide storage
            for other stored entities.
 
         revisionscount
            Number of revisions available for retrieval.
 
         trackedsize
            Total size in bytes of all tracked revisions. This is a sum of the
            length of the fulltext of all revisions.
 
         storedsize
            Total size in bytes used to store data for all tracked revisions.
            This is commonly less than ``trackedsize`` due to internal usage
            of deltas rather than fulltext revisions.
 
         Not all storage backends may support all queries are have a reasonable
         value to use. In that case, the value should be set to ``None`` and
         callers are expected to handle this special value.
         """
 
     def verifyintegrity(state):
         """Verifies the integrity of file storage.
 
         ``state`` is a dict holding state of the verifier process. It can be
         used to communicate data between invocations of multiple storage
         primitives.
 
         If individual revisions cannot have their revision content resolved,
         the method is expected to set the ``skipread`` key to a set of nodes
         that encountered problems.  If set, the method can also add the node(s)
         to ``safe_renamed`` in order to indicate nodes that may perform the
         rename checks with currently accessible data.
 
         The method yields objects conforming to the ``iverifyproblem``
         interface.
         """
 
 
 class idirs(interfaceutil.Interface):
     """Interface representing a collection of directories from paths.
 
     This interface is essentially a derived data structure representing
     directories from a collection of paths.
     """
 
     def addpath(path):
         """Add a path to the collection.
 
         All directories in the path will be added to the collection.
         """
 
     def delpath(path):
         """Remove a path from the collection.
 
         If the removal was the last path in a particular directory, the
         directory is removed from the collection.
         """
 
     def __iter__():
         """Iterate over the directories in this collection of paths."""
 
     def __contains__(path):
         """Whether a specific directory is in this collection."""
 
 
 class imanifestdict(interfaceutil.Interface):
     """Interface representing a manifest data structure.
 
     A manifest is effectively a dict mapping paths to entries. Each entry
     consists of a binary node and extra flags affecting that entry.
     """
 
     def __getitem__(path):
         """Returns the binary node value for a path in the manifest.
 
         Raises ``KeyError`` if the path does not exist in the manifest.
 
         Equivalent to ``self.find(path)[0]``.
         """
 
     def find(path):
         """Returns the entry for a path in the manifest.
 
         Returns a 2-tuple of (node, flags).
 
         Raises ``KeyError`` if the path does not exist in the manifest.
         """
 
     def __len__():
         """Return the number of entries in the manifest."""
 
     def __nonzero__():
         """Returns True if the manifest has entries, False otherwise."""
 
     __bool__ = __nonzero__
 
     def __setitem__(path, node):
         """Define the node value for a path in the manifest.
 
         If the path is already in the manifest, its flags will be copied to
         the new entry.
         """
 
     def __contains__(path):
         """Whether a path exists in the manifest."""
 
     def __delitem__(path):
         """Remove a path from the manifest.
 
         Raises ``KeyError`` if the path is not in the manifest.
         """
 
     def __iter__():
         """Iterate over paths in the manifest."""
 
     def iterkeys():
         """Iterate over paths in the manifest."""
 
     def keys():
         """Obtain a list of paths in the manifest."""
 
     def filesnotin(other, match=None):
         """Obtain the set of paths in this manifest but not in another.
 
         ``match`` is an optional matcher function to be applied to both
         manifests.
 
         Returns a set of paths.
         """
 
     def dirs():
         """Returns an object implementing the ``idirs`` interface."""
 
     def hasdir(dir):
         """Returns a bool indicating if a directory is in this manifest."""
 
     def walk(match):
         """Generator of paths in manifest satisfying a matcher.
 
         If the matcher has explicit files listed and they don't exist in
         the manifest, ``match.bad()`` is called for each missing file.
         """
 
     def diff(other, match=None, clean=False):
         """Find differences between this manifest and another.
 
         This manifest is compared to ``other``.
 
         If ``match`` is provided, the two manifests are filtered against this
         matcher and only entries satisfying the matcher are compared.
 
         If ``clean`` is True, unchanged files are included in the returned
         object.
 
         Returns a dict with paths as keys and values of 2-tuples of 2-tuples of
         the form ``((node1, flag1), (node2, flag2))`` where ``(node1, flag1)``
         represents the node and flags for this manifest and ``(node2, flag2)``
         are the same for the other manifest.
         """
 
     def setflag(path, flag):
         """Set the flag value for a given path.
 
         Raises ``KeyError`` if the path is not already in the manifest.
         """
 
     def get(path, default=None):
         """Obtain the node value for a path or a default value if missing."""
 
     def flags(path):
         """Return the flags value for a path (default: empty bytestring)."""
 
     def copy():
         """Return a copy of this manifest."""
 
     def items():
         """Returns an iterable of (path, node) for items in this manifest."""
 
     def iteritems():
         """Identical to items()."""
 
     def iterentries():
         """Returns an iterable of (path, node, flags) for this manifest.
 
         Similar to ``iteritems()`` except items are a 3-tuple and include
         flags.
         """
 
     def text():
         """Obtain the raw data representation for this manifest.
 
         Result is used to create a manifest revision.
         """
 
     def fastdelta(base, changes):
         """Obtain a delta between this manifest and another given changes.
 
         ``base`` in the raw data representation for another manifest.
 
         ``changes`` is an iterable of ``(path, to_delete)``.
 
         Returns a 2-tuple containing ``bytearray(self.text())`` and the
         delta between ``base`` and this manifest.
 
         If this manifest implementation can't support ``fastdelta()``,
         raise ``mercurial.manifest.FastdeltaUnavailable``.
         """
 
 
 class imanifestrevisionbase(interfaceutil.Interface):
     """Base interface representing a single revision of a manifest.
 
     Should not be used as a primary interface: should always be inherited
     as part of a larger interface.
     """
 
     def copy():
         """Obtain a copy of this manifest instance.
 
         Returns an object conforming to the ``imanifestrevisionwritable``
         interface. The instance will be associated with the same
         ``imanifestlog`` collection as this instance.
         """
 
     def read():
         """Obtain the parsed manifest data structure.
 
         The returned object conforms to the ``imanifestdict`` interface.
         """
 
 
 class imanifestrevisionstored(imanifestrevisionbase):
     """Interface representing a manifest revision committed to storage."""
 
     def node():
         """The binary node for this manifest."""
 
     parents = interfaceutil.Attribute(
         """List of binary nodes that are parents for this manifest revision."""
     )
 
     def readdelta(shallow=False):
         """Obtain the manifest data structure representing changes from parent.
 
         This manifest is compared to its 1st parent. A new manifest representing
         those differences is constructed.
 
         The returned object conforms to the ``imanifestdict`` interface.
         """
 
     def readfast(shallow=False):
         """Calls either ``read()`` or ``readdelta()``.
 
         The faster of the two options is called.
         """
 
     def find(key):
         """Calls self.read().find(key)``.
 
         Returns a 2-tuple of ``(node, flags)`` or raises ``KeyError``.
         """
 
 
 class imanifestrevisionwritable(imanifestrevisionbase):
     """Interface representing a manifest revision that can be committed."""
 
     def write(transaction, linkrev, p1node, p2node, added, removed, match=None):
         """Add this revision to storage.
 
         Takes a transaction object, the changeset revision number it will
         be associated with, its parent nodes, and lists of added and
         removed paths.
 
         If match is provided, storage can choose not to inspect or write out
         items that do not match. Storage is still required to be able to provide
         the full manifest in the future for any directories written (these
         manifests should not be "narrowed on disk").
 
         Returns the binary node of the created revision.
         """
 
 
 class imanifeststorage(interfaceutil.Interface):
     """Storage interface for manifest data."""
 
     nodeconstants = interfaceutil.Attribute(
         """nodeconstants used by the current repository."""
     )
 
     tree = interfaceutil.Attribute(
         """The path to the directory this manifest tracks.
 
         The empty bytestring represents the root manifest.
         """
     )
 
     index = interfaceutil.Attribute(
         """An ``ifilerevisionssequence`` instance."""
     )
 
     opener = interfaceutil.Attribute(
         """VFS opener to use to access underlying files used for storage.
 
         TODO this is revlog specific and should not be exposed.
         """
     )
 
     _generaldelta = interfaceutil.Attribute(
         """Whether generaldelta storage is being used.
 
         TODO this is revlog specific and should not be exposed.
         """
     )
 
     fulltextcache = interfaceutil.Attribute(
         """Dict with cache of fulltexts.
 
         TODO this doesn't feel appropriate for the storage interface.
         """
     )
 
     def __len__():
         """Obtain the number of revisions stored for this manifest."""
 
     def __iter__():
         """Iterate over revision numbers for this manifest."""
 
     def rev(node):
         """Obtain the revision number given a binary node.
 
         Raises ``error.LookupError`` if the node is not known.
         """
 
     def node(rev):
         """Obtain the node value given a revision number.
 
         Raises ``error.LookupError`` if the revision is not known.
         """
 
     def lookup(value):
         """Attempt to resolve a value to a node.
 
         Value can be a binary node, hex node, revision number, or a bytes
         that can be converted to an integer.
 
         Raises ``error.LookupError`` if a ndoe could not be resolved.
         """
 
     def parents(node):
         """Returns a 2-tuple of parent nodes for a node.
 
         Values will be ``nullid`` if the parent is empty.
         """
 
     def parentrevs(rev):
         """Like parents() but operates on revision numbers."""
 
     def linkrev(rev):
         """Obtain the changeset revision number a revision is linked to."""
 
     def revision(node, _df=None):
         """Obtain fulltext data for a node."""
 
     def rawdata(node, _df=None):
         """Obtain raw data for a node."""
 
     def revdiff(rev1, rev2):
         """Obtain a delta between two revision numbers.
 
         The returned data is the result of ``bdiff.bdiff()`` on the raw
         revision data.
         """
 
     def cmp(node, fulltext):
         """Compare fulltext to another revision.
 
         Returns True if the fulltext is different from what is stored.
         """
 
     def emitrevisions(
         nodes,
         nodesorder=None,
         revisiondata=False,
         assumehaveparentrevisions=False,
     ):
         """Produce ``irevisiondelta`` describing revisions.
 
         See the documentation for ``ifiledata`` for more.
         """
 
     def addgroup(
         deltas,
         linkmapper,
         transaction,
         addrevisioncb=None,
         duplicaterevisioncb=None,
     ):
         """Process a series of deltas for storage.
 
         See the documentation in ``ifilemutation`` for more.
         """
 
     def rawsize(rev):
         """Obtain the size of tracked data.
 
         Is equivalent to ``len(m.rawdata(node))``.
 
         TODO this method is only used by upgrade code and may be removed.
         """
 
     def getstrippoint(minlink):
         """Find minimum revision that must be stripped to strip a linkrev.
 
         See the documentation in ``ifilemutation`` for more.
         """
 
     def strip(minlink, transaction):
         """Remove storage of items starting at a linkrev.
 
         See the documentation in ``ifilemutation`` for more.
         """
 
     def checksize():
         """Obtain the expected sizes of backing files.
 
         TODO this is used by verify and it should not be part of the interface.
         """
 
     def files():
         """Obtain paths that are backing storage for this manifest.
 
         TODO this is used by verify and there should probably be a better API
         for this functionality.
         """
 
     def deltaparent(rev):
         """Obtain the revision that a revision is delta'd against.
 
         TODO delta encoding is an implementation detail of storage and should
         not be exposed to the storage interface.
         """
 
     def clone(tr, dest, **kwargs):
         """Clone this instance to another."""
 
     def clearcaches(clear_persisted_data=False):
         """Clear any caches associated with this instance."""
 
     def dirlog(d):
         """Obtain a manifest storage instance for a tree."""
 
     def add(
         m, transaction, link, p1, p2, added, removed, readtree=None, match=None
     ):
         """Add a revision to storage.
 
         ``m`` is an object conforming to ``imanifestdict``.
 
         ``link`` is the linkrev revision number.
 
         ``p1`` and ``p2`` are the parent revision numbers.
 
         ``added`` and ``removed`` are iterables of added and removed paths,
         respectively.
 
         ``readtree`` is a function that can be used to read the child tree(s)
         when recursively writing the full tree structure when using
         treemanifets.
 
         ``match`` is a matcher that can be used to hint to storage that not all
         paths must be inspected; this is an optimization and can be safely
         ignored. Note that the storage must still be able to reproduce a full
         manifest including files that did not match.
         """
 
     def storageinfo(
         exclusivefiles=False,
         sharedfiles=False,
         revisionscount=False,
         trackedsize=False,
         storedsize=False,
     ):
         """Obtain information about storage for this manifest's data.
 
         See ``ifilestorage.storageinfo()`` for a description of this method.
         This one behaves the same way, except for manifest data.
         """
 
 
 class imanifestlog(interfaceutil.Interface):
     """Interface representing a collection of manifest snapshots.
 
     Represents the root manifest in a repository.
 
     Also serves as a means to access nested tree manifests and to cache
     tree manifests.
     """
 
     nodeconstants = interfaceutil.Attribute(
         """nodeconstants used by the current repository."""
     )
 
     def __getitem__(node):
         """Obtain a manifest instance for a given binary node.
 
         Equivalent to calling ``self.get('', node)``.
 
         The returned object conforms to the ``imanifestrevisionstored``
         interface.
         """
 
     def get(tree, node, verify=True):
         """Retrieve the manifest instance for a given directory and binary node.
 
         ``node`` always refers to the node of the root manifest (which will be
         the only manifest if flat manifests are being used).
 
         If ``tree`` is the empty string, the root manifest is returned.
         Otherwise the manifest for the specified directory will be returned
         (requires tree manifests).
 
         If ``verify`` is True, ``LookupError`` is raised if the node is not
         known.
 
         The returned object conforms to the ``imanifestrevisionstored``
         interface.
         """
 
     def getstorage(tree):
         """Retrieve an interface to storage for a particular tree.
 
         If ``tree`` is the empty bytestring, storage for the root manifest will
         be returned. Otherwise storage for a tree manifest is returned.
 
         TODO formalize interface for returned object.
         """
 
     def clearcaches():
         """Clear caches associated with this collection."""
 
     def rev(node):
         """Obtain the revision number for a binary node.
 
         Raises ``error.LookupError`` if the node is not known.
         """
 
     def update_caches(transaction):
         """update whatever cache are relevant for the used storage."""
 
 
 class ilocalrepositoryfilestorage(interfaceutil.Interface):
     """Local repository sub-interface providing access to tracked file storage.
 
     This interface defines how a repository accesses storage for a single
     tracked file path.
     """
 
     def file(f):
         """Obtain a filelog for a tracked path.
 
         The returned type conforms to the ``ifilestorage`` interface.
         """
 
 
 class ilocalrepositorymain(interfaceutil.Interface):
     """Main interface for local repositories.
 
     This currently captures the reality of things - not how things should be.
     """
 
     nodeconstants = interfaceutil.Attribute(
         """Constant nodes matching the hash function used by the repository."""
     )
     nullid = interfaceutil.Attribute(
         """null revision for the hash function used by the repository."""
     )
 
     supported = interfaceutil.Attribute(
         """Set of requirements that this repo is capable of opening."""
     )
 
     requirements = interfaceutil.Attribute(
         """Set of requirements this repo uses."""
     )
 
     features = interfaceutil.Attribute(
         """Set of "features" this repository supports.
 
         A "feature" is a loosely-defined term. It can refer to a feature
         in the classical sense or can describe an implementation detail
         of the repository. For example, a ``readonly`` feature may denote
         the repository as read-only. Or a ``revlogfilestore`` feature may
         denote that the repository is using revlogs for file storage.
 
         The intent of features is to provide a machine-queryable mechanism
         for repo consumers to test for various repository characteristics.
 
         Features are similar to ``requirements``. The main difference is that
         requirements are stored on-disk and represent requirements to open the
         repository. Features are more run-time capabilities of the repository
         and more granular capabilities (which may be derived from requirements).
         """
     )
 
     filtername = interfaceutil.Attribute(
         """Name of the repoview that is active on this repo."""
     )
 
     vfs_map = interfaceutil.Attribute(
         """a bytes-key → vfs mapping used by transaction and others"""
     )
 
     wvfs = interfaceutil.Attribute(
         """VFS used to access the working directory."""
     )
 
     vfs = interfaceutil.Attribute(
         """VFS rooted at the .hg directory.
 
         Used to access repository data not in the store.
         """
     )
 
     svfs = interfaceutil.Attribute(
         """VFS rooted at the store.
 
         Used to access repository data in the store. Typically .hg/store.
         But can point elsewhere if the store is shared.
         """
     )
 
     root = interfaceutil.Attribute(
         """Path to the root of the working directory."""
     )
 
     path = interfaceutil.Attribute("""Path to the .hg directory.""")
 
     origroot = interfaceutil.Attribute(
         """The filesystem path that was used to construct the repo."""
     )
 
     auditor = interfaceutil.Attribute(
         """A pathauditor for the working directory.
 
         This checks if a path refers to a nested repository.
 
         Operates on the filesystem.
         """
     )
 
     nofsauditor = interfaceutil.Attribute(
         """A pathauditor for the working directory.
 
         This is like ``auditor`` except it doesn't do filesystem checks.
         """
     )
 
     baseui = interfaceutil.Attribute(
         """Original ui instance passed into constructor."""
     )
 
     ui = interfaceutil.Attribute("""Main ui instance for this instance.""")
 
     sharedpath = interfaceutil.Attribute(
         """Path to the .hg directory of the repo this repo was shared from."""
     )
 
     store = interfaceutil.Attribute("""A store instance.""")
 
     spath = interfaceutil.Attribute("""Path to the store.""")
 
     sjoin = interfaceutil.Attribute("""Alias to self.store.join.""")
 
     cachevfs = interfaceutil.Attribute(
         """A VFS used to access the cache directory.
 
         Typically .hg/cache.
         """
     )
 
     wcachevfs = interfaceutil.Attribute(
         """A VFS used to access the cache directory dedicated to working copy
 
         Typically .hg/wcache.
         """
     )
 
     filteredrevcache = interfaceutil.Attribute(
         """Holds sets of revisions to be filtered."""
     )
 
     names = interfaceutil.Attribute("""A ``namespaces`` instance.""")
 
     filecopiesmode = interfaceutil.Attribute(
         """The way files copies should be dealt with in this repo."""
     )
 
     def close():
         """Close the handle on this repository."""
 
     def peer(path=None):
         """Obtain an object conforming to the ``peer`` interface."""
 
     def unfiltered():
         """Obtain an unfiltered/raw view of this repo."""
 
     def filtered(name, visibilityexceptions=None):
         """Obtain a named view of this repository."""
 
     obsstore = interfaceutil.Attribute("""A store of obsolescence data.""")
 
     changelog = interfaceutil.Attribute("""A handle on the changelog revlog.""")
 
     manifestlog = interfaceutil.Attribute(
         """An instance conforming to the ``imanifestlog`` interface.
 
         Provides access to manifests for the repository.
         """
     )
 
     dirstate = interfaceutil.Attribute("""Working directory state.""")
 
     narrowpats = interfaceutil.Attribute(
         """Matcher patterns for this repository's narrowspec."""
     )
 
     def narrowmatch(match=None, includeexact=False):
         """Obtain a matcher for the narrowspec."""
 
     def setnarrowpats(newincludes, newexcludes):
         """Define the narrowspec for this repository."""
 
     def __getitem__(changeid):
         """Try to resolve a changectx."""
 
     def __contains__(changeid):
         """Whether a changeset exists."""
 
     def __nonzero__():
         """Always returns True."""
         return True
 
     __bool__ = __nonzero__
 
     def __len__():
         """Returns the number of changesets in the repo."""
 
     def __iter__():
         """Iterate over revisions in the changelog."""
 
     def revs(expr, *args):
         """Evaluate a revset.
 
         Emits revisions.
         """
 
     def set(expr, *args):
         """Evaluate a revset.
 
         Emits changectx instances.
         """
 
     def anyrevs(specs, user=False, localalias=None):
         """Find revisions matching one of the given revsets."""
 
     def url():
         """Returns a string representing the location of this repo."""
 
     def hook(name, throw=False, **args):
         """Call a hook."""
 
     def tags():
         """Return a mapping of tag to node."""
 
     def tagtype(tagname):
         """Return the type of a given tag."""
 
     def tagslist():
         """Return a list of tags ordered by revision."""
 
     def nodetags(node):
         """Return the tags associated with a node."""
 
     def nodebookmarks(node):
         """Return the list of bookmarks pointing to the specified node."""
 
     def branchmap():
         """Return a mapping of branch to heads in that branch."""
 
     def revbranchcache():
         pass
 
     def register_changeset(rev, changelogrevision):
         """Extension point for caches for new nodes.
 
         Multiple consumers are expected to need parts of the changelogrevision,
         so it is provided as optimization to avoid duplicate lookups. A simple
         cache would be fragile when other revisions are accessed, too."""
         pass
 
     def branchtip(branchtip, ignoremissing=False):
         """Return the tip node for a given branch."""
 
     def lookup(key):
         """Resolve the node for a revision."""
 
     def lookupbranch(key):
         """Look up the branch name of the given revision or branch name."""
 
     def known(nodes):
         """Determine whether a series of nodes is known.
 
         Returns a list of bools.
         """
 
     def local():
         """Whether the repository is local."""
         return True
 
     def publishing():
         """Whether the repository is a publishing repository."""
 
     def cancopy():
         pass
 
     def shared():
         """The type of shared repository or None."""
 
     def wjoin(f, *insidef):
         """Calls self.vfs.reljoin(self.root, f, *insidef)"""
 
     def setparents(p1, p2):
         """Set the parent nodes of the working directory."""
 
     def filectx(path, changeid=None, fileid=None):
         """Obtain a filectx for the given file revision."""
 
     def getcwd():
         """Obtain the current working directory from the dirstate."""
 
     def pathto(f, cwd=None):
         """Obtain the relative path to a file."""
 
     def adddatafilter(name, fltr):
         pass
 
     def wread(filename):
         """Read a file from wvfs, using data filters."""
 
     def wwrite(filename, data, flags, backgroundclose=False, **kwargs):
         """Write data to a file in the wvfs, using data filters."""
 
     def wwritedata(filename, data):
         """Resolve data for writing to the wvfs, using data filters."""
 
     def currenttransaction():
         """Obtain the current transaction instance or None."""
 
     def transaction(desc, report=None):
         """Open a new transaction to write to the repository."""
 
     def undofiles():
         """Returns a list of (vfs, path) for files to undo transactions."""
 
     def recover():
         """Roll back an interrupted transaction."""
 
     def rollback(dryrun=False, force=False):
         """Undo the last transaction.
 
         DANGEROUS.
         """
 
     def updatecaches(tr=None, full=False, caches=None):
         """Warm repo caches."""
 
     def invalidatecaches():
         """Invalidate cached data due to the repository mutating."""
 
     def invalidatevolatilesets():
         pass
 
     def invalidatedirstate():
         """Invalidate the dirstate."""
 
     def invalidate(clearfilecache=False):
         pass
 
     def invalidateall():
         pass
 
     def lock(wait=True):
         """Lock the repository store and return a lock instance."""
 
     def currentlock():
         """Return the lock if it's held or None."""
 
     def wlock(wait=True):
         """Lock the non-store parts of the repository."""
 
     def currentwlock():
         """Return the wlock if it's held or None."""
 
     def checkcommitpatterns(wctx, match, status, fail):
         pass
 
     def commit(
         text=b'',
         user=None,
         date=None,
         match=None,
         force=False,
         editor=False,
         extra=None,
     ):
         """Add a new revision to the repository."""
 
     def commitctx(ctx, error=False, origctx=None):
         """Commit a commitctx instance to the repository."""
 
     def destroying():
         """Inform the repository that nodes are about to be destroyed."""
 
     def destroyed():
         """Inform the repository that nodes have been destroyed."""
 
     def status(
         node1=b'.',
         node2=None,
         match=None,
         ignored=False,
         clean=False,
         unknown=False,
         listsubrepos=False,
     ):
         """Convenience method to call repo[x].status()."""
 
     def addpostdsstatus(ps):
         pass
 
     def postdsstatus():
         pass
 
     def clearpostdsstatus():
         pass
 
     def heads(start=None):
         """Obtain list of nodes that are DAG heads."""
 
     def branchheads(branch=None, start=None, closed=False):
         pass
 
     def branches(nodes):
         pass
 
     def between(pairs):
         pass
 
     def checkpush(pushop):
         pass
 
     prepushoutgoinghooks = interfaceutil.Attribute("""util.hooks instance.""")
 
     def pushkey(namespace, key, old, new):
         pass
 
     def listkeys(namespace):
         pass
 
     def debugwireargs(one, two, three=None, four=None, five=None):
         pass
 
     def savecommitmessage(text):
         pass
 
     def register_sidedata_computer(
         kind, category, keys, computer, flags, replace=False
     ):
         pass
 
     def register_wanted_sidedata(category):
         pass
 
 
 class completelocalrepository(
     ilocalrepositorymain, ilocalrepositoryfilestorage
 ):
     """Complete interface for a local repository."""
 
 
 class iwireprotocolcommandcacher(interfaceutil.Interface):
     """Represents a caching backend for wire protocol commands.
 
     Wire protocol version 2 supports transparent caching of many commands.
     To leverage this caching, servers can activate objects that cache
     command responses. Objects handle both cache writing and reading.
     This interface defines how that response caching mechanism works.
 
     Wire protocol version 2 commands emit a series of objects that are
     serialized and sent to the client. The caching layer exists between
     the invocation of the command function and the sending of its output
     objects to an output layer.
 
     Instances of this interface represent a binding to a cache that
     can serve a response (in place of calling a command function) and/or
     write responses to a cache for subsequent use.
 
     When a command request arrives, the following happens with regards
     to this interface:
 
     1. The server determines whether the command request is cacheable.
     2. If it is, an instance of this interface is spawned.
     3. The cacher is activated in a context manager (``__enter__`` is called).
     4. A cache *key* for that request is derived. This will call the
        instance's ``adjustcachekeystate()`` method so the derivation
        can be influenced.
     5. The cacher is informed of the derived cache key via a call to
        ``setcachekey()``.
     6. The cacher's ``lookup()`` method is called to test for presence of
        the derived key in the cache.
     7. If ``lookup()`` returns a hit, that cached result is used in place
        of invoking the command function. ``__exit__`` is called and the instance
        is discarded.
     8. The command function is invoked.
     9. ``onobject()`` is called for each object emitted by the command
        function.
     10. After the final object is seen, ``onfinished()`` is called.
     11. ``__exit__`` is called to signal the end of use of the instance.
 
     Cache *key* derivation can be influenced by the instance.
 
     Cache keys are initially derived by a deterministic representation of
     the command request. This includes the command name, arguments, protocol
     version, etc. This initial key derivation is performed by CBOR-encoding a
     data structure and feeding that output into a hasher.
 
     Instances of this interface can influence this initial key derivation
     via ``adjustcachekeystate()``.
 
     The instance is informed of the derived cache key via a call to
     ``setcachekey()``. The instance must store the key locally so it can
     be consulted on subsequent operations that may require it.
 
     When constructed, the instance has access to a callable that can be used
     for encoding response objects. This callable receives as its single
     argument an object emitted by a command function. It returns an iterable
     of bytes chunks representing the encoded object. Unless the cacher is
     caching native Python objects in memory or has a way of reconstructing
     the original Python objects, implementations typically call this function
     to produce bytes from the output objects and then store those bytes in
     the cache. When it comes time to re-emit those bytes, they are wrapped
     in a ``wireprototypes.encodedresponse`` instance to tell the output
     layer that they are pre-encoded.
 
     When receiving the objects emitted by the command function, instances
     can choose what to do with those objects. The simplest thing to do is
     re-emit the original objects. They will be forwarded to the output
     layer and will be processed as if the cacher did not exist.
 
     Implementations could also choose to not emit objects - instead locally
     buffering objects or their encoded representation. They could then emit
     a single "coalesced" object when ``onfinished()`` is called. In
     this way, the implementation would function as a filtering layer of
     sorts.
 
     When caching objects, typically the encoded form of the object will
     be stored. Keep in mind that if the original object is forwarded to
     the output layer, it will need to be encoded there as well. For large
     output, this redundant encoding could add overhead. Implementations
     could wrap the encoded object data in ``wireprototypes.encodedresponse``
     instances to avoid this overhead.
     """
 
     def __enter__():
         """Marks the instance as active.
 
         Should return self.
         """
 
     def __exit__(exctype, excvalue, exctb):
         """Called when cacher is no longer used.
 
         This can be used by implementations to perform cleanup actions (e.g.
         disconnecting network sockets, aborting a partially cached response.
         """
 
     def adjustcachekeystate(state):
         """Influences cache key derivation by adjusting state to derive key.
 
         A dict defining the state used to derive the cache key is passed.
 
         Implementations can modify this dict to record additional state that
         is wanted to influence key derivation.
 
         Implementations are *highly* encouraged to not modify or delete
         existing keys.
         """
 
     def setcachekey(key):
         """Record the derived cache key for this request.
 
         Instances may mutate the key for internal usage, as desired. e.g.
         instances may wish to prepend the repo name, introduce path
         components for filesystem or URL addressing, etc. Behavior is up to
         the cache.
 
         Returns a bool indicating if the request is cacheable by this
         instance.
         """
 
     def lookup():
         """Attempt to resolve an entry in the cache.
 
         The instance is instructed to look for the cache key that it was
         informed about via the call to ``setcachekey()``.
 
         If there's no cache hit or the cacher doesn't wish to use the cached
         entry, ``None`` should be returned.
 
         Else, a dict defining the cached result should be returned. The
         dict may have the following keys:
 
         objs
            An iterable of objects that should be sent to the client. That
            iterable of objects is expected to be what the command function
            would return if invoked or an equivalent representation thereof.
         """
 
     def onobject(obj):
         """Called when a new object is emitted from the command function.
 
         Receives as its argument the object that was emitted from the
         command function.
 
         This method returns an iterator of objects to forward to the output
         layer. The easiest implementation is a generator that just
         ``yield obj``.
         """
 
     def onfinished():
         """Called after all objects have been emitted from the command function.
 
         Implementations should return an iterator of objects to forward to
         the output layer.
 
         This method can be a generator.
         """