clone-bundles: add a command to clear all bundles

hgext/clonebundles.py

@@ -1,979 +1,996 b''
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """advertise pre-generated bundles to seed clones
 
 "clonebundles" is a server-side extension used to advertise the existence
 of pre-generated, externally hosted bundle files to clients that are
 cloning so that cloning can be faster, more reliable, and require less
 resources on the server. "pullbundles" is a related feature for sending
 pre-generated bundle files to clients as part of pull operations.
 
 Cloning can be a CPU and I/O intensive operation on servers. Traditionally,
 the server, in response to a client's request to clone, dynamically generates
 a bundle containing the entire repository content and sends it to the client.
 There is no caching on the server and the server will have to redundantly
 generate the same outgoing bundle in response to each clone request. For
 servers with large repositories or with high clone volume, the load from
 clones can make scaling the server challenging and costly.
 
 This extension provides server operators the ability to offload
 potentially expensive clone load to an external service. Pre-generated
 bundles also allow using more CPU intensive compression, reducing the
 effective bandwidth requirements.
 
 Here's how clone bundles work:
 
 1. A server operator establishes a mechanism for making bundle files available
    on a hosting service where Mercurial clients can fetch them.
 2. A manifest file listing available bundle URLs and some optional metadata
    is added to the Mercurial repository on the server.
 3. A client initiates a clone against a clone bundles aware server.
 4. The client sees the server is advertising clone bundles and fetches the
    manifest listing available bundles.
 5. The client filters and sorts the available bundles based on what it
    supports and prefers.
 6. The client downloads and applies an available bundle from the
    server-specified URL.
 7. The client reconnects to the original server and performs the equivalent
    of :hg:`pull` to retrieve all repository data not in the bundle. (The
    repository could have been updated between when the bundle was created
    and when the client started the clone.) This may use "pullbundles".
 
 Instead of the server generating full repository bundles for every clone
 request, it generates full bundles once and they are subsequently reused to
 bootstrap new clones. The server may still transfer data at clone time.
 However, this is only data that has been added/changed since the bundle was
 created. For large, established repositories, this can reduce server load for
 clones to less than 1% of original.
 
 Here's how pullbundles work:
 
 1. A manifest file listing available bundles and describing the revisions
    is added to the Mercurial repository on the server.
 2. A new-enough client informs the server that it supports partial pulls
    and initiates a pull.
 3. If the server has pull bundles enabled and sees the client advertising
    partial pulls, it checks for a matching pull bundle in the manifest.
    A bundle matches if the format is supported by the client, the client
    has the required revisions already and needs something from the bundle.
 4. If there is at least one matching bundle, the server sends it to the client.
 5. The client applies the bundle and notices that the server reply was
    incomplete. It initiates another pull.
 
 To work, this extension requires the following of server operators:
 
 * Generating bundle files of repository content (typically periodically,
   such as once per day).
 * Clone bundles: A file server that clients have network access to and that
   Python knows how to talk to through its normal URL handling facility
   (typically an HTTP/HTTPS server).
 * A process for keeping the bundles manifest in sync with available bundle
   files.
 
 Strictly speaking, using a static file hosting server isn't required: a server
 operator could use a dynamic service for retrieving bundle data. However,
 static file hosting services are simple and scalable and should be sufficient
 for most needs.
 
 Bundle files can be generated with the :hg:`bundle` command. Typically
 :hg:`bundle --all` is used to produce a bundle of the entire repository.
 
 :hg:`debugcreatestreamclonebundle` can be used to produce a special
 *streaming clonebundle*. These are bundle files that are extremely efficient
 to produce and consume (read: fast). However, they are larger than
 traditional bundle formats and require that clients support the exact set
 of repository data store formats in use by the repository that created them.
 Typically, a newer server can serve data that is compatible with older clients.
 However, *streaming clone bundles* don't have this guarantee. **Server
 operators need to be aware that newer versions of Mercurial may produce
 streaming clone bundles incompatible with older Mercurial versions.**
 
 A server operator is responsible for creating a ``.hg/clonebundles.manifest``
 file containing the list of available bundle files suitable for seeding
 clones. If this file does not exist, the repository will not advertise the
 existence of clone bundles when clients connect. For pull bundles,
 ``.hg/pullbundles.manifest`` is used.
 
 The manifest file contains a newline (\\n) delimited list of entries.
 
 Each line in this file defines an available bundle. Lines have the format:
 
     <URL> [<key>=<value>[ <key>=<value>]]
 
 That is, a URL followed by an optional, space-delimited list of key=value
 pairs describing additional properties of this bundle. Both keys and values
 are URI encoded.
 
 For pull bundles, the URL is a path under the ``.hg`` directory of the
 repository.
 
 Keys in UPPERCASE are reserved for use by Mercurial and are defined below.
 All non-uppercase keys can be used by site installations. An example use
 for custom properties is to use the *datacenter* attribute to define which
 data center a file is hosted in. Clients could then prefer a server in the
 data center closest to them.
 
 The following reserved keys are currently defined:
 
 BUNDLESPEC
    A "bundle specification" string that describes the type of the bundle.
 
    These are string values that are accepted by the "--type" argument of
    :hg:`bundle`.
 
    The values are parsed in strict mode, which means they must be of the
    "<compression>-<type>" form. See
    mercurial.exchange.parsebundlespec() for more details.
 
    :hg:`debugbundle --spec` can be used to print the bundle specification
    string for a bundle file. The output of this command can be used verbatim
    for the value of ``BUNDLESPEC`` (it is already escaped).
 
    Clients will automatically filter out specifications that are unknown or
    unsupported so they won't attempt to download something that likely won't
    apply.
 
    The actual value doesn't impact client behavior beyond filtering:
    clients will still sniff the bundle type from the header of downloaded
    files.
 
    **Use of this key is highly recommended**, as it allows clients to
    easily skip unsupported bundles. If this key is not defined, an old
    client may attempt to apply a bundle that it is incapable of reading.
 
 REQUIRESNI
    Whether Server Name Indication (SNI) is required to connect to the URL.
    SNI allows servers to use multiple certificates on the same IP. It is
    somewhat common in CDNs and other hosting providers. Older Python
    versions do not support SNI. Defining this attribute enables clients
    with older Python versions to filter this entry without experiencing
    an opaque SSL failure at connection time.
 
    If this is defined, it is important to advertise a non-SNI fallback
    URL or clients running old Python releases may not be able to clone
    with the clonebundles facility.
 
    Value should be "true".
 
 REQUIREDRAM
    Value specifies expected memory requirements to decode the payload.
    Values can have suffixes for common bytes sizes. e.g. "64MB".
 
    This key is often used with zstd-compressed bundles using a high
    compression level / window size, which can require 100+ MB of memory
    to decode.
 
 heads
    Used for pull bundles. This contains the ``;`` separated changeset
    hashes of the heads of the bundle content.
 
 bases
    Used for pull bundles. This contains the ``;`` separated changeset
    hashes of the roots of the bundle content. This can be skipped if
    the bundle was created without ``--base``.
 
 Manifests can contain multiple entries. Assuming metadata is defined, clients
 will filter entries from the manifest that they don't support. The remaining
 entries are optionally sorted by client preferences
 (``ui.clonebundleprefers`` config option). The client then attempts
 to fetch the bundle at the first URL in the remaining list.
 
 **Errors when downloading a bundle will fail the entire clone operation:
 clients do not automatically fall back to a traditional clone.** The reason
 for this is that if a server is using clone bundles, it is probably doing so
 because the feature is necessary to help it scale. In other words, there
 is an assumption that clone load will be offloaded to another service and
 that the Mercurial server isn't responsible for serving this clone load.
 If that other service experiences issues and clients start mass falling back to
 the original Mercurial server, the added clone load could overwhelm the server
 due to unexpected load and effectively take it offline. Not having clients
 automatically fall back to cloning from the original server mitigates this
 scenario.
 
 Because there is no automatic Mercurial server fallback on failure of the
 bundle hosting service, it is important for server operators to view the bundle
 hosting service as an extension of the Mercurial server in terms of
 availability and service level agreements: if the bundle hosting service goes
 down, so does the ability for clients to clone. Note: clients will see a
 message informing them how to bypass the clone bundles facility when a failure
 occurs. So server operators should prepare for some people to follow these
 instructions when a failure occurs, thus driving more load to the original
 Mercurial server when the bundle hosting service fails.
 
 
 auto-generation of clone bundles
 --------------------------------
 
 It is possible to set Mercurial to automatically re-generate clone bundles when
 enough new content is available.
 
 Mercurial will take care of the process asynchronously. The defined list of
 bundle-type will be generated, uploaded, and advertised. Older bundles will get
 decommissioned as newer ones replace them.
 
 Bundles Generation:
 ...................
 
 The extension can generate multiple variants of the clone bundle. Each
 different variant will be defined by the "bundle-spec" they use::
 
     [clone-bundles]
     auto-generate.formats= zstd-v2, gzip-v2
 
 See `hg help bundlespec` for details about available options.
 
 By default, new bundles are generated when 5% of the repository contents or at
 least 1000 revisions are not contained in the cached bundles. This option can
 be controlled by the `clone-bundles.trigger.below-bundled-ratio` option
 (default 0.95) and the `clone-bundles.trigger.revs` option (default 1000)::
 
     [clone-bundles]
     trigger.below-bundled-ratio=0.95
     trigger.revs=1000
 
 This logic can be manually triggered using the `admin::clone-bundles-refresh`
 command, or automatically on each repository change if
 `clone-bundles.auto-generate.on-change` is set to `yes`.
 
     [clone-bundles]
     auto-generate.on-change=yes
     auto-generate.formats= zstd-v2, gzip-v2
 
 Bundles Upload and Serving:
 ...........................
 
 The generated bundles need to be made available to users through a "public" URL.
 This should be donne through `clone-bundles.upload-command` configuration. The
 value of this command should be a shell command. It will have access to the
 bundle file path through the `$HGCB_BUNDLE_PATH` variable. And the expected
 basename in the "public" URL is accessible at::
 
   [clone-bundles]
   upload-command=sftp put $HGCB_BUNDLE_PATH \
       sftp://bundles.host/clone-bundles/$HGCB_BUNDLE_BASENAME
 
 If the file was already uploaded, the command must still succeed.
 
 After upload, the file should be available at an url defined by
 `clone-bundles.url-template`.
 
   [clone-bundles]
   url-template=https://bundles.host/cache/clone-bundles/{basename}
 
 Old bundles cleanup:
 ....................
 
 When new bundles are generated, the older ones are no longer necessary and can
 be removed from storage. This is done through the `clone-bundles.delete-command`
 configuration. The command is given the url of the artifact to delete through
 the `$HGCB_BUNDLE_URL` environment variable.
 
   [clone-bundles]
   delete-command=sftp rm sftp://bundles.host/clone-bundles/$HGCB_BUNDLE_BASENAME
 
 If the file was already deleted, the command must still succeed.
 """
 
 
 import os
 import weakref
 
 from mercurial.i18n import _
 
 from mercurial import (
     bundlecaches,
     commands,
     error,
     extensions,
     localrepo,
     lock,
     node,
     registrar,
     util,
     wireprotov1server,
 )
 
 
 from mercurial.utils import (
     procutil,
 )
 
 testedwith = b'ships-with-hg-core'
 
 
 def capabilities(orig, repo, proto):
     caps = orig(repo, proto)
 
     # Only advertise if a manifest exists. This does add some I/O to requests.
     # But this should be cheaper than a wasted network round trip due to
     # missing file.
     if repo.vfs.exists(bundlecaches.CB_MANIFEST_FILE):
         caps.append(b'clonebundles')
 
     return caps
 
 
 def extsetup(ui):
     extensions.wrapfunction(wireprotov1server, b'_capabilities', capabilities)
 
 
 # logic for bundle auto-generation
 
 
 configtable = {}
 configitem = registrar.configitem(configtable)
 
 cmdtable = {}
 command = registrar.command(cmdtable)
 
 configitem(b'clone-bundles', b'auto-generate.on-change', default=False)
 configitem(b'clone-bundles', b'auto-generate.formats', default=list)
 configitem(b'clone-bundles', b'trigger.below-bundled-ratio', default=0.95)
 configitem(b'clone-bundles', b'trigger.revs', default=1000)
 
 configitem(b'clone-bundles', b'upload-command', default=None)
 
 configitem(b'clone-bundles', b'delete-command', default=None)
 
 configitem(b'clone-bundles', b'url-template', default=None)
 
 configitem(b'devel', b'debug.clonebundles', default=False)
 
 
 # category for the post-close transaction hooks
 CAT_POSTCLOSE = b"clonebundles-autobundles"
 
 # template for bundle file names
 BUNDLE_MASK = (
     b"full-%(bundle_type)s-%(revs)d_revs-%(tip_short)s_tip-%(op_id)s.hg"
 )
 
 
 # file in .hg/ use to track clonebundles being auto-generated
 AUTO_GEN_FILE = b'clonebundles.auto-gen'
 
 
 class BundleBase(object):
     """represents the core of properties that matters for us in a bundle
 
     :bundle_type: the bundlespec (see hg help bundlespec)
     :revs:        the number of revisions in the repo at bundle creation time
     :tip_rev:     the rev-num of the tip revision
     :tip_node:    the node id of the tip-most revision in the bundle
 
     :ready:       True if the bundle is ready to be served
     """
 
     ready = False
 
     def __init__(self, bundle_type, revs, tip_rev, tip_node):
         self.bundle_type = bundle_type
         self.revs = revs
         self.tip_rev = tip_rev
         self.tip_node = tip_node
 
     def valid_for(self, repo):
         """is this bundle applicable to the current repository
 
         This is useful for detecting bundles made irrelevant by stripping.
         """
         tip_node = node.bin(self.tip_node)
         return repo.changelog.index.get_rev(tip_node) == self.tip_rev
 
     def __eq__(self, other):
         left = (self.ready, self.bundle_type, self.tip_rev, self.tip_node)
         right = (other.ready, other.bundle_type, other.tip_rev, other.tip_node)
         return left == right
 
     def __neq__(self, other):
         return not self == other
 
     def __cmp__(self, other):
         if self == other:
             return 0
         return -1
 
 
 class RequestedBundle(BundleBase):
     """A bundle that should be generated.
 
     Additional attributes compared to BundleBase
     :heads:       list of head revisions (as rev-num)
     :op_id:       a "unique" identifier for the operation triggering the change
     """
 
     def __init__(self, bundle_type, revs, tip_rev, tip_node, head_revs, op_id):
         self.head_revs = head_revs
         self.op_id = op_id
         super(RequestedBundle, self).__init__(
             bundle_type,
             revs,
             tip_rev,
             tip_node,
         )
 
     @property
     def suggested_filename(self):
         """A filename that can be used for the generated bundle"""
         data = {
             b'bundle_type': self.bundle_type,
             b'revs': self.revs,
             b'heads': self.head_revs,
             b'tip_rev': self.tip_rev,
             b'tip_node': self.tip_node,
             b'tip_short': self.tip_node[:12],
             b'op_id': self.op_id,
         }
         return BUNDLE_MASK % data
 
     def generate_bundle(self, repo, file_path):
         """generate the bundle at `filepath`"""
         commands.bundle(
             repo.ui,
             repo,
             file_path,
             base=[b"null"],
             rev=self.head_revs,
             type=self.bundle_type,
             quiet=True,
         )
 
     def generating(self, file_path, hostname=None, pid=None):
         """return a GeneratingBundle object from this object"""
         if pid is None:
             pid = os.getpid()
         if hostname is None:
             hostname = lock._getlockprefix()
         return GeneratingBundle(
             self.bundle_type,
             self.revs,
             self.tip_rev,
             self.tip_node,
             hostname,
             pid,
             file_path,
         )
 
 
 class GeneratingBundle(BundleBase):
     """A bundle being generated
 
     extra attributes compared to BundleBase:
 
     :hostname: the hostname of the machine generating the bundle
     :pid:      the pid of the process generating the bundle
     :filepath: the target filename of the bundle
 
     These attributes exist to help detect stalled generation processes.
     """
 
     ready = False
 
     def __init__(
         self, bundle_type, revs, tip_rev, tip_node, hostname, pid, filepath
     ):
         self.hostname = hostname
         self.pid = pid
         self.filepath = filepath
         super(GeneratingBundle, self).__init__(
             bundle_type, revs, tip_rev, tip_node
         )
 
     @classmethod
     def from_line(cls, line):
         """create an object by deserializing a line from AUTO_GEN_FILE"""
         assert line.startswith(b'PENDING-v1 ')
         (
             __,
             bundle_type,
             revs,
             tip_rev,
             tip_node,
             hostname,
             pid,
             filepath,
         ) = line.split()
         hostname = util.urlreq.unquote(hostname)
         filepath = util.urlreq.unquote(filepath)
         revs = int(revs)
         tip_rev = int(tip_rev)
         pid = int(pid)
         return cls(
             bundle_type, revs, tip_rev, tip_node, hostname, pid, filepath
         )
 
     def to_line(self):
         """serialize the object to include as a line in AUTO_GEN_FILE"""
         templ = b"PENDING-v1 %s %d %d %s %s %d %s"
         data = (
             self.bundle_type,
             self.revs,
             self.tip_rev,
             self.tip_node,
             util.urlreq.quote(self.hostname),
             self.pid,
             util.urlreq.quote(self.filepath),
         )
         return templ % data
 
     def __eq__(self, other):
         if not super(GeneratingBundle, self).__eq__(other):
             return False
         left = (self.hostname, self.pid, self.filepath)
         right = (other.hostname, other.pid, other.filepath)
         return left == right
 
     def uploaded(self, url, basename):
         """return a GeneratedBundle from this object"""
         return GeneratedBundle(
             self.bundle_type,
             self.revs,
             self.tip_rev,
             self.tip_node,
             url,
             basename,
         )
 
 
 class GeneratedBundle(BundleBase):
     """A bundle that is done being generated and can be served
 
     extra attributes compared to BundleBase:
 
     :file_url: the url where the bundle is available.
     :basename: the "basename" used to upload (useful for deletion)
 
     These attributes exist to generate a bundle manifest
     (.hg/pullbundles.manifest)
     """
 
     ready = True
 
     def __init__(
         self, bundle_type, revs, tip_rev, tip_node, file_url, basename
     ):
         self.file_url = file_url
         self.basename = basename
         super(GeneratedBundle, self).__init__(
             bundle_type, revs, tip_rev, tip_node
         )
 
     @classmethod
     def from_line(cls, line):
         """create an object by deserializing a line from AUTO_GEN_FILE"""
         assert line.startswith(b'DONE-v1 ')
         (
             __,
             bundle_type,
             revs,
             tip_rev,
             tip_node,
             file_url,
             basename,
         ) = line.split()
         revs = int(revs)
         tip_rev = int(tip_rev)
         file_url = util.urlreq.unquote(file_url)
         return cls(bundle_type, revs, tip_rev, tip_node, file_url, basename)
 
     def to_line(self):
         """serialize the object to include as a line in AUTO_GEN_FILE"""
         templ = b"DONE-v1 %s %d %d %s %s %s"
         data = (
             self.bundle_type,
             self.revs,
             self.tip_rev,
             self.tip_node,
             util.urlreq.quote(self.file_url),
             self.basename,
         )
         return templ % data
 
     def manifest_line(self):
         """serialize the object to include as a line in pullbundles.manifest"""
         templ = b"%s BUNDLESPEC=%s REQUIRESNI=true"
         return templ % (self.file_url, self.bundle_type)
 
     def __eq__(self, other):
         if not super(GeneratedBundle, self).__eq__(other):
             return False
         return self.file_url == other.file_url
 
 
 def parse_auto_gen(content):
     """parse the AUTO_GEN_FILE to return a list of Bundle object"""
     bundles = []
     for line in content.splitlines():
         if line.startswith(b'PENDING-v1 '):
             bundles.append(GeneratingBundle.from_line(line))
         elif line.startswith(b'DONE-v1 '):
             bundles.append(GeneratedBundle.from_line(line))
     return bundles
 
 
 def dumps_auto_gen(bundles):
     """serialize a list of Bundle as a AUTO_GEN_FILE content"""
     lines = []
     for b in bundles:
         lines.append(b"%s\n" % b.to_line())
     lines.sort()
     return b"".join(lines)
 
 
 def read_auto_gen(repo):
     """read the AUTO_GEN_FILE for the <repo> a list of Bundle object"""
     data = repo.vfs.tryread(AUTO_GEN_FILE)
     if not data:
         return []
     return parse_auto_gen(data)
 
 
 def write_auto_gen(repo, bundles):
     """write a list of Bundle objects into the repo's AUTO_GEN_FILE"""
     assert repo._cb_lock_ref is not None
     data = dumps_auto_gen(bundles)
     with repo.vfs(AUTO_GEN_FILE, mode=b'wb', atomictemp=True) as f:
         f.write(data)
 
 
 def generate_manifest(bundles):
     """write a list of Bundle objects into the repo's AUTO_GEN_FILE"""
     bundles = list(bundles)
     bundles.sort(key=lambda b: b.bundle_type)
     lines = []
     for b in bundles:
         lines.append(b"%s\n" % b.manifest_line())
     return b"".join(lines)
 
 
 def update_ondisk_manifest(repo):
     """update the clonebundle manifest with latest url"""
     with repo.clonebundles_lock():
         bundles = read_auto_gen(repo)
 
         per_types = {}
         for b in bundles:
             if not (b.ready and b.valid_for(repo)):
                 continue
             current = per_types.get(b.bundle_type)
             if current is not None and current.revs >= b.revs:
                 continue
             per_types[b.bundle_type] = b
         manifest = generate_manifest(per_types.values())
         with repo.vfs(
             bundlecaches.CB_MANIFEST_FILE, mode=b"wb", atomictemp=True
         ) as f:
             f.write(manifest)
 
 
 def update_bundle_list(repo, new_bundles=(), del_bundles=()):
     """modify the repo's AUTO_GEN_FILE
 
     This method also regenerates the clone bundle manifest when needed"""
     with repo.clonebundles_lock():
         bundles = read_auto_gen(repo)
         if del_bundles:
             bundles = [b for b in bundles if b not in del_bundles]
         new_bundles = [b for b in new_bundles if b not in bundles]
         bundles.extend(new_bundles)
         write_auto_gen(repo, bundles)
         all_changed = []
         all_changed.extend(new_bundles)
         all_changed.extend(del_bundles)
         if any(b.ready for b in all_changed):
             update_ondisk_manifest(repo)
 
 
 def cleanup_tmp_bundle(repo, target):
     """remove a GeneratingBundle file and entry"""
     assert not target.ready
     with repo.clonebundles_lock():
         repo.vfs.tryunlink(target.filepath)
         update_bundle_list(repo, del_bundles=[target])
 
 
 def finalize_one_bundle(repo, target):
     """upload a generated bundle and advertise it in the clonebundles.manifest"""
     with repo.clonebundles_lock():
         bundles = read_auto_gen(repo)
         if target in bundles and target.valid_for(repo):
             result = upload_bundle(repo, target)
             update_bundle_list(repo, new_bundles=[result])
     cleanup_tmp_bundle(repo, target)
 
 
 def find_outdated_bundles(repo, bundles):
     """finds outdated bundles"""
     olds = []
     per_types = {}
     for b in bundles:
         if not b.valid_for(repo):
             olds.append(b)
             continue
         l = per_types.setdefault(b.bundle_type, [])
         l.append(b)
     for key in sorted(per_types):
         all = per_types[key]
         if len(all) > 1:
             all.sort(key=lambda b: b.revs, reverse=True)
             olds.extend(all[1:])
     return olds
 
 
 def collect_garbage(repo):
     """finds outdated bundles and get them deleted"""
     with repo.clonebundles_lock():
         bundles = read_auto_gen(repo)
         olds = find_outdated_bundles(repo, bundles)
         for o in olds:
             delete_bundle(repo, o)
         update_bundle_list(repo, del_bundles=olds)
 
 
 def upload_bundle(repo, bundle):
     """upload the result of a GeneratingBundle and return a GeneratedBundle
 
     The upload is done using the `clone-bundles.upload-command`
     """
     cmd = repo.ui.config(b'clone-bundles', b'upload-command')
     url = repo.ui.config(b'clone-bundles', b'url-template')
     basename = repo.vfs.basename(bundle.filepath)
     filepath = procutil.shellquote(bundle.filepath)
     variables = {
         b'HGCB_BUNDLE_PATH': filepath,
         b'HGCB_BUNDLE_BASENAME': basename,
     }
     env = procutil.shellenviron(environ=variables)
     ret = repo.ui.system(cmd, environ=env)
     if ret:
         raise error.Abort(b"command returned status %d: %s" % (ret, cmd))
     url = (
         url.decode('utf8')
         .format(basename=basename.decode('utf8'))
         .encode('utf8')
     )
     return bundle.uploaded(url, basename)
 
 
 def delete_bundle(repo, bundle):
     """delete a bundle from storage"""
     assert bundle.ready
     msg = b'clone-bundles: deleting bundle %s\n'
     msg %= bundle.basename
     if repo.ui.configbool(b'devel', b'debug.clonebundles'):
         repo.ui.write(msg)
     else:
         repo.ui.debug(msg)
 
     cmd = repo.ui.config(b'clone-bundles', b'delete-command')
     variables = {
         b'HGCB_BUNDLE_URL': bundle.file_url,
         b'HGCB_BASENAME': bundle.basename,
     }
     env = procutil.shellenviron(environ=variables)
     ret = repo.ui.system(cmd, environ=env)
     if ret:
         raise error.Abort(b"command returned status %d: %s" % (ret, cmd))
 
 
 def auto_bundle_needed_actions(repo, bundles, op_id):
     """find the list of bundles that need action
 
     returns a list of RequestedBundle objects that need to be generated and
     uploaded."""
     create_bundles = []
     delete_bundles = []
     repo = repo.filtered(b"immutable")
     targets = repo.ui.configlist(b'clone-bundles', b'auto-generate.formats')
     ratio = float(
         repo.ui.config(b'clone-bundles', b'trigger.below-bundled-ratio')
     )
     abs_revs = repo.ui.configint(b'clone-bundles', b'trigger.revs')
     revs = len(repo.changelog)
     generic_data = {
         'revs': revs,
         'head_revs': repo.changelog.headrevs(),
         'tip_rev': repo.changelog.tiprev(),
         'tip_node': node.hex(repo.changelog.tip()),
         'op_id': op_id,
     }
     for t in targets:
         if new_bundle_needed(repo, bundles, ratio, abs_revs, t, revs):
             data = generic_data.copy()
             data['bundle_type'] = t
             b = RequestedBundle(**data)
             create_bundles.append(b)
     delete_bundles.extend(find_outdated_bundles(repo, bundles))
     return create_bundles, delete_bundles
 
 
 def new_bundle_needed(repo, bundles, ratio, abs_revs, bundle_type, revs):
     """consider the current cached content and trigger new bundles if needed"""
     threshold = max((revs * ratio), (revs - abs_revs))
     for b in bundles:
         if not b.valid_for(repo) or b.bundle_type != bundle_type:
             continue
         if b.revs > threshold:
             return False
     return True
 
 
 def start_one_bundle(repo, bundle):
     """start the generation of a single bundle file
 
     the `bundle` argument should be a RequestedBundle object.
 
     This data is passed to the `debugmakeclonebundles` "as is".
     """
     data = util.pickle.dumps(bundle)
     cmd = [procutil.hgexecutable(), b'--cwd', repo.path, INTERNAL_CMD]
     env = procutil.shellenviron()
     msg = b'clone-bundles: starting bundle generation: %s\n'
     stdout = None
     stderr = None
     waits = []
     record_wait = None
     if repo.ui.configbool(b'devel', b'debug.clonebundles'):
         stdout = procutil.stdout
         stderr = procutil.stderr
         repo.ui.write(msg % bundle.bundle_type)
         record_wait = waits.append
     else:
         repo.ui.debug(msg % bundle.bundle_type)
     bg = procutil.runbgcommand
     bg(
         cmd,
         env,
         stdin_bytes=data,
         stdout=stdout,
         stderr=stderr,
         record_wait=record_wait,
     )
     for f in waits:
         f()
 
 
 INTERNAL_CMD = b'debug::internal-make-clone-bundles'
 
 
 @command(INTERNAL_CMD, [], b'')
 def debugmakeclonebundles(ui, repo):
     """Internal command to auto-generate debug bundles"""
     requested_bundle = util.pickle.load(procutil.stdin)
     procutil.stdin.close()
 
     collect_garbage(repo)
 
     fname = requested_bundle.suggested_filename
     fpath = repo.vfs.makedirs(b'tmp-bundles')
     fpath = repo.vfs.join(b'tmp-bundles', fname)
     bundle = requested_bundle.generating(fpath)
     update_bundle_list(repo, new_bundles=[bundle])
 
     requested_bundle.generate_bundle(repo, fpath)
 
     repo.invalidate()
     finalize_one_bundle(repo, bundle)
 
 
 def make_auto_bundler(source_repo):
     reporef = weakref.ref(source_repo)
 
     def autobundle(tr):
         repo = reporef()
         assert repo is not None
         bundles = read_auto_gen(repo)
         new, __ = auto_bundle_needed_actions(repo, bundles, b"%d_txn" % id(tr))
         for data in new:
             start_one_bundle(repo, data)
         return None
 
     return autobundle
 
 
 def reposetup(ui, repo):
     """install the two pieces needed for automatic clonebundle generation
 
     - add a "post-close" hook that fires bundling when needed
     - introduce a clone-bundle lock to let multiple processes meddle with the
       state files.
     """
     if not repo.local():
         return
 
     class autobundlesrepo(repo.__class__):
         def transaction(self, *args, **kwargs):
             tr = super(autobundlesrepo, self).transaction(*args, **kwargs)
             enabled = repo.ui.configbool(
                 b'clone-bundles',
                 b'auto-generate.on-change',
             )
             targets = repo.ui.configlist(
                 b'clone-bundles', b'auto-generate.formats'
             )
             if enabled and targets:
                 tr.addpostclose(CAT_POSTCLOSE, make_auto_bundler(self))
             return tr
 
         @localrepo.unfilteredmethod
         def clonebundles_lock(self, wait=True):
             '''Lock the repository file related to clone bundles'''
             if not util.safehasattr(self, '_cb_lock_ref'):
                 self._cb_lock_ref = None
             l = self._currentlock(self._cb_lock_ref)
             if l is not None:
                 l.lock()
                 return l
 
             l = self._lock(
                 vfs=self.vfs,
                 lockname=b"clonebundleslock",
                 wait=wait,
                 releasefn=None,
                 acquirefn=None,
                 desc=_(b'repository %s') % self.origroot,
             )
             self._cb_lock_ref = weakref.ref(l)
             return l
 
     repo._wlockfreeprefix.add(AUTO_GEN_FILE)
     repo._wlockfreeprefix.add(bundlecaches.CB_MANIFEST_FILE)
     repo.__class__ = autobundlesrepo
 
 
 @command(b'admin::clone-bundles-refresh', [], b'')
 def cmd_admin_clone_bundles_refresh(ui, repo: localrepo.localrepository):
     """generate clone bundles according to the configuration
 
     This runs the logic for automatic generation, removing outdated bundles and
     generating new ones if necessary. See :hg:`help -e clone-bundles` for
     details about how to configure this feature.
     """
     debug = repo.ui.configbool(b'devel', b'debug.clonebundles')
     bundles = read_auto_gen(repo)
     op_id = b"%d_acbr" % os.getpid()
     create, delete = auto_bundle_needed_actions(repo, bundles, op_id)
 
     # we clean up outdated bundle before generating new one to keep the last
     # two version of the bundle around for a while and avoid having to deal
     # client that just got served a manifest.
     for o in delete:
         delete_bundle(repo, o)
     update_bundle_list(repo, del_bundles=delete)
 
     if create:
         fpath = repo.vfs.makedirs(b'tmp-bundles')
     for requested_bundle in create:
         if debug:
             msg = b'clone-bundles: starting bundle generation: %s\n'
             repo.ui.write(msg % requested_bundle.bundle_type)
         fname = requested_bundle.suggested_filename
         fpath = repo.vfs.join(b'tmp-bundles', fname)
         generating_bundle = requested_bundle.generating(fpath)
         update_bundle_list(repo, new_bundles=[generating_bundle])
         requested_bundle.generate_bundle(repo, fpath)
         result = upload_bundle(repo, generating_bundle)
         update_bundle_list(repo, new_bundles=[result])
         update_ondisk_manifest(repo)
         cleanup_tmp_bundle(repo, generating_bundle)
+
+
+@command(b'admin::clone-bundles-clear', [], b'')
+def cmd_admin_clone_bundles_clear(ui, repo: localrepo.localrepository):
+    """remove existing clone bundle caches
+
+    See `hg help admin::clone-bundles-refresh` for details on how to regenerate
+    them.
+
+    This command will only affect bundles currently available, it will not
+    affect bundles being asynchronously generated.
+    """
+    bundles = read_auto_gen(repo)
+    delete = [b for b in bundles if b.ready]
+    for o in delete:
+        delete_bundle(repo, o)
+    update_bundle_list(repo, del_bundles=delete)

tests/test-clonebundles-autogen.t

@@ -1,320 +1,337 b''
 
 #require no-reposimplestore no-chg
 
 initial setup
 
   $ hg init server
   $ cat >> server/.hg/hgrc << EOF
   > [extensions]
   > clonebundles =
   > 
   > [clone-bundles]
   > auto-generate.on-change = yes
   > auto-generate.formats = v2
   > upload-command = cp "\$HGCB_BUNDLE_PATH" "$TESTTMP"/final-upload/
   > delete-command = rm -f "$TESTTMP/final-upload/\$HGCB_BASENAME"
   > url-template = file://$TESTTMP/final-upload/{basename}
   > 
   > [devel]
   > debug.clonebundles=yes
   > EOF
 
   $ mkdir final-upload
   $ hg clone server client
   updating to branch default
   0 files updated, 0 files merged, 0 files removed, 0 files unresolved
   $ cd client
 
 Test bundles are generated on push
 ==================================
 
   $ touch foo
   $ hg -q commit -A -m 'add foo'
   $ touch bar
   $ hg -q commit -A -m 'add bar'
   $ hg push
   pushing to $TESTTMP/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   2 changesets found
   added 2 changesets with 2 changes to 2 files
   clone-bundles: starting bundle generation: v2
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v2-2_revs-aaff8d2ffbbf_tip-*_txn.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v2-2_revs-aaff8d2ffbbf_tip-*_txn.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
 
 Newer bundles are generated with more pushes
 --------------------------------------------
 
   $ touch baz
   $ hg -q commit -A -m 'add baz'
   $ touch buz
   $ hg -q commit -A -m 'add buz'
   $ hg push
   pushing to $TESTTMP/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   4 changesets found
   added 2 changesets with 2 changes to 2 files
   clone-bundles: starting bundle generation: v2
 
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v2-4_revs-6427147b985a_tip-*_txn.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v2-2_revs-aaff8d2ffbbf_tip-*_txn.hg (glob)
   full-v2-4_revs-6427147b985a_tip-*_txn.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
 
 Older bundles are cleaned up with more pushes
 ---------------------------------------------
 
   $ touch faz
   $ hg -q commit -A -m 'add faz'
   $ touch fuz
   $ hg -q commit -A -m 'add fuz'
   $ hg push
   pushing to $TESTTMP/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   clone-bundles: deleting bundle full-v2-2_revs-aaff8d2ffbbf_tip-*_txn.hg (glob)
   6 changesets found
   added 2 changesets with 2 changes to 2 files
   clone-bundles: starting bundle generation: v2
 
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v2-6_revs-b1010e95ea00_tip-*_txn.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v2-4_revs-6427147b985a_tip-*_txn.hg (glob)
   full-v2-6_revs-b1010e95ea00_tip-*_txn.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
 
 Test conditions to get them generated
 =====================================
 
 Check ratio
 
   $ cat >> ../server/.hg/hgrc << EOF
   > [clone-bundles]
   > trigger.below-bundled-ratio = 0.5
   > EOF
   $ touch far
   $ hg -q commit -A -m 'add far'
   $ hg push
   pushing to $TESTTMP/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v2-6_revs-b1010e95ea00_tip-*_txn.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v2-4_revs-6427147b985a_tip-*_txn.hg (glob)
   full-v2-6_revs-b1010e95ea00_tip-*_txn.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
 
 Check absolute number of revisions
 
   $ cat >> ../server/.hg/hgrc << EOF
   > [clone-bundles]
   > trigger.revs = 2
   > EOF
   $ touch bur
   $ hg -q commit -A -m 'add bur'
   $ hg push
   pushing to $TESTTMP/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   clone-bundles: deleting bundle full-v2-4_revs-6427147b985a_tip-*_txn.hg (glob)
   8 changesets found
   added 1 changesets with 1 changes to 1 files
   clone-bundles: starting bundle generation: v2
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v2-8_revs-8353e8af1306_tip-*_txn.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v2-6_revs-b1010e95ea00_tip-*_txn.hg (glob)
   full-v2-8_revs-8353e8af1306_tip-*_txn.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
 
 (that one would not generate new bundles)
 
   $ touch tur
   $ hg -q commit -A -m 'add tur'
   $ hg push
   pushing to $TESTTMP/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v2-8_revs-8353e8af1306_tip-*_txn.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v2-6_revs-b1010e95ea00_tip-*_txn.hg (glob)
   full-v2-8_revs-8353e8af1306_tip-*_txn.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
 
 Test generation through the dedicated command
 =============================================
 
   $ cat >> ../server/.hg/hgrc << EOF
   > [clone-bundles]
   > auto-generate.on-change = no
   > EOF
 
 Check the command can generate content when needed
 --------------------------------------------------
 
 Do a push that makes the condition fulfilled,
 Yet it should not automatically generate a bundle with
 "auto-generate.on-change" not set.
 
   $ touch quoi
   $ hg -q commit -A -m 'add quoi'
 
   $ pre_push_manifest=`cat ../server/.hg/clonebundles.manifest|f --sha256 | sed 's/.*=//' | cat`
   $ pre_push_upload=`ls -1 ../final-upload|f --sha256 | sed 's/.*=//' | cat`
   $ ls -1 ../server/.hg/tmp-bundles
 
   $ hg push
   pushing to $TESTTMP/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
 
   $ post_push_manifest=`cat ../server/.hg/clonebundles.manifest|f --sha256 | sed 's/.*=//' | cat`
   $ post_push_upload=`ls -1 ../final-upload|f --sha256 | sed 's/.*=//' | cat`
   $ ls -1 ../server/.hg/tmp-bundles
   $ test "$pre_push_manifest" = "$post_push_manifest"
   $ test "$pre_push_upload" = "$post_push_upload"
 
 Running the command should detect the stale bundles, and do the full automatic
 generation logic.
 
   $ hg -R ../server/ admin::clone-bundles-refresh
   clone-bundles: deleting bundle full-v2-6_revs-b1010e95ea00_tip-*_txn.hg (glob)
   clone-bundles: starting bundle generation: v2
   10 changesets found
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v2-10_revs-3b6f57f17d70_tip-*_acbr.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v2-10_revs-3b6f57f17d70_tip-*_acbr.hg (glob)
   full-v2-8_revs-8353e8af1306_tip-*_txn.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
 
 Check the command cleans up older bundles when possible
 -------------------------------------------------------
 
   $ hg -R ../server/ admin::clone-bundles-refresh
   clone-bundles: deleting bundle full-v2-8_revs-8353e8af1306_tip-*_txn.hg (glob)
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v2-10_revs-3b6f57f17d70_tip-*_acbr.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v2-10_revs-3b6f57f17d70_tip-*_acbr.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
 
 Nothing is generated when the bundles are sufficiently up to date
 -----------------------------------------------------------------
 
   $ touch feur
   $ hg -q commit -A -m 'add feur'
 
   $ pre_push_manifest=`cat ../server/.hg/clonebundles.manifest|f --sha256 | sed 's/.*=//' | cat`
   $ pre_push_upload=`ls -1 ../final-upload|f --sha256 | sed 's/.*=//' | cat`
   $ ls -1 ../server/.hg/tmp-bundles
 
   $ hg push
   pushing to $TESTTMP/server
   searching for changes
   adding changesets
   adding manifests
   adding file changes
   added 1 changesets with 1 changes to 1 files
 
   $ post_push_manifest=`cat ../server/.hg/clonebundles.manifest|f --sha256 | sed 's/.*=//' | cat`
   $ post_push_upload=`ls -1 ../final-upload|f --sha256 | sed 's/.*=//' | cat`
   $ ls -1 ../server/.hg/tmp-bundles
   $ test "$pre_push_manifest" = "$post_push_manifest"
   $ test "$pre_push_upload" = "$post_push_upload"
 
   $ hg -R ../server/ admin::clone-bundles-refresh
 
   $ post_refresh_manifest=`cat ../server/.hg/clonebundles.manifest|f --sha256 | sed 's/.*=//' | cat`
   $ post_refresh_upload=`ls -1 ../final-upload|f --sha256 | sed 's/.*=//' | cat`
   $ ls -1 ../server/.hg/tmp-bundles
   $ test "$pre_push_manifest" = "$post_refresh_manifest"
   $ test "$pre_push_upload" = "$post_refresh_upload"
 
 Test modification of configuration
 ==================================
 
 Testing that later runs adapt to configuration changes even if the repository is
 unchanged.
 
 adding more formats
 -------------------
 
 bundle for added formats should be generated
 
 change configuration
 
   $ cat >> ../server/.hg/hgrc << EOF
   > [clone-bundles]
   > auto-generate.formats = v1, v2
   > EOF
 
 refresh the bundles
 
   $ hg -R ../server/ admin::clone-bundles-refresh
   clone-bundles: starting bundle generation: v1
   11 changesets found
 
 the bundle for the "new" format should have been added
 
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v1-11_revs-4226b1cd5fda_tip-*_acbr.hg BUNDLESPEC=v1 REQUIRESNI=true (glob)
   file:/*/$TESTTMP/final-upload/full-v2-10_revs-3b6f57f17d70_tip-*_acbr.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v1-11_revs-4226b1cd5fda_tip-*_acbr.hg (glob)
   full-v2-10_revs-3b6f57f17d70_tip-*_acbr.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
 
 Changing the ratio
 ------------------
 
 Changing the ratio to something that would have triggered a bundle during the last push.
 
   $ cat >> ../server/.hg/hgrc << EOF
   > [clone-bundles]
   > trigger.below-bundled-ratio = 0.95
   > EOF
 
 refresh the bundles
 
   $ hg -R ../server/ admin::clone-bundles-refresh
   clone-bundles: starting bundle generation: v2
   11 changesets found
 
 
 the "outdated' bundle should be refreshed
 
   $ cat ../server/.hg/clonebundles.manifest
   file:/*/$TESTTMP/final-upload/full-v1-11_revs-4226b1cd5fda_tip-*_acbr.hg BUNDLESPEC=v1 REQUIRESNI=true (glob)
   file:/*/$TESTTMP/final-upload/full-v2-11_revs-4226b1cd5fda_tip-*_acbr.hg BUNDLESPEC=v2 REQUIRESNI=true (glob)
   $ ls -1 ../final-upload
   full-v1-11_revs-4226b1cd5fda_tip-*_acbr.hg (glob)
   full-v2-10_revs-3b6f57f17d70_tip-*_acbr.hg (glob)
   full-v2-11_revs-4226b1cd5fda_tip-*_acbr.hg (glob)
   $ ls -1 ../server/.hg/tmp-bundles
+
+Test more command options
+=========================
+
+bundle clearing
+---------------
+
+  $ hg -R ../server/ admin::clone-bundles-clear
+  clone-bundles: deleting bundle full-v1-11_revs-4226b1cd5fda_tip-*_acbr.hg (glob)
+  clone-bundles: deleting bundle full-v2-10_revs-3b6f57f17d70_tip-*_acbr.hg (glob)
+  clone-bundles: deleting bundle full-v2-11_revs-4226b1cd5fda_tip-*_acbr.hg (glob)
+
+Nothing should remain
+
+  $ cat ../server/.hg/clonebundles.manifest
+  $ ls -1 ../final-upload
+  $ ls -1 ../server/.hg/tmp-bundles

tests/test-help.t

@@ -1,4081 +1,4082 b''
 Short help:
 
   $ hg
   Mercurial Distributed SCM
   
   basic commands:
   
    add           add the specified files on the next commit
    annotate      show changeset information by line for each file
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    merge         merge another revision into working directory
    pull          pull changes from the specified source
    push          push changes to the specified destination
    remove        remove the specified files on the next commit
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    update        update working directory (or switch revisions)
   
   (use 'hg help' for the full list of commands or 'hg -v' for details)
 
   $ hg -q
    add           add the specified files on the next commit
    annotate      show changeset information by line for each file
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    merge         merge another revision into working directory
    pull          pull changes from the specified source
    push          push changes to the specified destination
    remove        remove the specified files on the next commit
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    update        update working directory (or switch revisions)
 
 Extra extensions will be printed in help output in a non-reliable order since
 the extension is unknown.
 #if no-extraextensions
 
   $ hg help
   Mercurial Distributed SCM
   
   list of commands:
   
   Repository creation:
   
    clone         make a copy of an existing repository
    init          create a new repository in the given directory
   
   Remote repository management:
   
    incoming      show new changesets found in source
    outgoing      show changesets not found in the destination
    paths         show aliases for remote repositories
    pull          pull changes from the specified source
    push          push changes to the specified destination
    serve         start stand-alone webserver
   
   Change creation:
   
    commit        commit the specified files or all outstanding changes
   
   Change manipulation:
   
    backout       reverse effect of earlier changeset
    graft         copy changes from other branches onto the current branch
    merge         merge another revision into working directory
   
   Change organization:
   
    bookmarks     create a new bookmark or list existing bookmarks
    branch        set or show the current branch name
    branches      list repository named branches
    phase         set or show the current phase name
    tag           add one or more tags for the current or given revision
    tags          list repository tags
   
   File content management:
   
    annotate      show changeset information by line for each file
    cat           output the current or given revision of files
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    grep          search for a pattern in specified files
   
   Change navigation:
   
    bisect        subdivision search of changesets
    heads         show branch heads
    identify      identify the working directory or specified revision
    log           show revision history of entire repository or files
   
   Working directory management:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    files         list tracked files
    forget        forget the specified files on the next commit
    purge         removes files not tracked by Mercurial
    remove        remove the specified files on the next commit
    rename        rename files; equivalent of copy + remove
    resolve       redo merges or set/view the merge status of files
    revert        restore files to their checkout state
    root          print the root (top) of the current working directory
    shelve        save and set aside changes from the working directory
    status        show changed files in the working directory
    summary       summarize working directory state
    unshelve      restore a shelved change to the working directory
    update        update working directory (or switch revisions)
   
   Change import/export:
   
    archive       create an unversioned archive of a repository revision
    bundle        create a bundle file
    export        dump the header and diffs for one or more changesets
    import        import an ordered set of patches
    unbundle      apply one or more bundle files
   
   Repository maintenance:
   
    manifest      output the current or given revision of the project manifest
    recover       roll back an interrupted transaction
    verify        verify the integrity of the repository
   
   Help:
   
    config        show combined config settings from all hgrc files
    help          show help for a given topic or a help overview
    version       output version and copyright information
   
   additional help topics:
   
   Mercurial identifiers:
   
    filesets      Specifying File Sets
    hgignore      Syntax for Mercurial Ignore Files
    patterns      File Name Patterns
    revisions     Specifying Revisions
    urls          URL Paths
   
   Mercurial output:
   
    color         Colorizing Outputs
    dates         Date Formats
    diffs         Diff Formats
    templating    Template Usage
   
   Mercurial configuration:
   
    config        Configuration Files
    environment   Environment Variables
    extensions    Using Additional Features
    flags         Command-line flags
    hgweb         Configuring hgweb
    merge-tools   Merge Tools
    pager         Pager Support
    rust          Rust in Mercurial
   
   Concepts:
   
    bundlespec    Bundle File Formats
    evolution     Safely rewriting history (EXPERIMENTAL)
    glossary      Glossary
    phases        Working with Phases
    subrepos      Subrepositories
   
   Miscellaneous:
   
    deprecated    Deprecated Features
    internals     Technical implementation topics
    scripting     Using Mercurial from scripts and automation
   
   (use 'hg help -v' to show built-in aliases and global options)
 
   $ hg -q help
   Repository creation:
   
    clone         make a copy of an existing repository
    init          create a new repository in the given directory
   
   Remote repository management:
   
    incoming      show new changesets found in source
    outgoing      show changesets not found in the destination
    paths         show aliases for remote repositories
    pull          pull changes from the specified source
    push          push changes to the specified destination
    serve         start stand-alone webserver
   
   Change creation:
   
    commit        commit the specified files or all outstanding changes
   
   Change manipulation:
   
    backout       reverse effect of earlier changeset
    graft         copy changes from other branches onto the current branch
    merge         merge another revision into working directory
   
   Change organization:
   
    bookmarks     create a new bookmark or list existing bookmarks
    branch        set or show the current branch name
    branches      list repository named branches
    phase         set or show the current phase name
    tag           add one or more tags for the current or given revision
    tags          list repository tags
   
   File content management:
   
    annotate      show changeset information by line for each file
    cat           output the current or given revision of files
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    grep          search for a pattern in specified files
   
   Change navigation:
   
    bisect        subdivision search of changesets
    heads         show branch heads
    identify      identify the working directory or specified revision
    log           show revision history of entire repository or files
   
   Working directory management:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    files         list tracked files
    forget        forget the specified files on the next commit
    purge         removes files not tracked by Mercurial
    remove        remove the specified files on the next commit
    rename        rename files; equivalent of copy + remove
    resolve       redo merges or set/view the merge status of files
    revert        restore files to their checkout state
    root          print the root (top) of the current working directory
    shelve        save and set aside changes from the working directory
    status        show changed files in the working directory
    summary       summarize working directory state
    unshelve      restore a shelved change to the working directory
    update        update working directory (or switch revisions)
   
   Change import/export:
   
    archive       create an unversioned archive of a repository revision
    bundle        create a bundle file
    export        dump the header and diffs for one or more changesets
    import        import an ordered set of patches
    unbundle      apply one or more bundle files
   
   Repository maintenance:
   
    manifest      output the current or given revision of the project manifest
    recover       roll back an interrupted transaction
    verify        verify the integrity of the repository
   
   Help:
   
    config        show combined config settings from all hgrc files
    help          show help for a given topic or a help overview
    version       output version and copyright information
   
   additional help topics:
   
   Mercurial identifiers:
   
    filesets      Specifying File Sets
    hgignore      Syntax for Mercurial Ignore Files
    patterns      File Name Patterns
    revisions     Specifying Revisions
    urls          URL Paths
   
   Mercurial output:
   
    color         Colorizing Outputs
    dates         Date Formats
    diffs         Diff Formats
    templating    Template Usage
   
   Mercurial configuration:
   
    config        Configuration Files
    environment   Environment Variables
    extensions    Using Additional Features
    flags         Command-line flags
    hgweb         Configuring hgweb
    merge-tools   Merge Tools
    pager         Pager Support
    rust          Rust in Mercurial
   
   Concepts:
   
    bundlespec    Bundle File Formats
    evolution     Safely rewriting history (EXPERIMENTAL)
    glossary      Glossary
    phases        Working with Phases
    subrepos      Subrepositories
   
   Miscellaneous:
   
    deprecated    Deprecated Features
    internals     Technical implementation topics
    scripting     Using Mercurial from scripts and automation
 
 Test extension help:
   $ hg help extensions --config extensions.rebase= --config extensions.children=
   Using Additional Features
   """""""""""""""""""""""""
   
       Mercurial has the ability to add new features through the use of
       extensions. Extensions may add new commands, add options to existing
       commands, change the default behavior of commands, or implement hooks.
   
       To enable the "foo" extension, either shipped with Mercurial or in the
       Python search path, create an entry for it in your configuration file,
       like this:
   
         [extensions]
         foo =
   
       You may also specify the full path to an extension:
   
         [extensions]
         myfeature = ~/.hgext/myfeature.py
   
       See 'hg help config' for more information on configuration files.
   
       Extensions are not loaded by default for a variety of reasons: they can
       increase startup overhead; they may be meant for advanced usage only; they
       may provide potentially dangerous abilities (such as letting you destroy
       or modify history); they might not be ready for prime time; or they may
       alter some usual behaviors of stock Mercurial. It is thus up to the user
       to activate extensions as needed.
   
       To explicitly disable an extension enabled in a configuration file of
       broader scope, prepend its path with !:
   
         [extensions]
         # disabling extension bar residing in /path/to/extension/bar.py
         bar = !/path/to/extension/bar.py
         # ditto, but no path was supplied for extension baz
         baz = !
   
       enabled extensions:
   
        children      command to display child changesets (DEPRECATED)
        rebase        command to move sets of revisions to a different ancestor
   
       disabled extensions:
   
        acl           hooks for controlling repository access
        blackbox      log repository events to a blackbox for debugging
        bugzilla      hooks for integrating with the Bugzilla bug tracker
        censor        erase file content at a given revision
        churn         command to display statistics about repository history
        clonebundles  advertise pre-generated bundles to seed clones
        closehead     close arbitrary heads without checking them out first
        convert       import revisions from foreign VCS repositories into
                      Mercurial
        eol           automatically manage newlines in repository files
        extdiff       command to allow external programs to compare revisions
        factotum      http authentication with factotum
        fastexport    export repositories as git fast-import stream
        githelp       try mapping git commands to Mercurial commands
        gpg           commands to sign and verify changesets
        hgk           browse the repository in a graphical way
        highlight     syntax highlighting for hgweb (requires Pygments)
        histedit      interactive history editing
        keyword       expand keywords in tracked files
        largefiles    track large binary files
        mq            manage a stack of patches
        notify        hooks for sending email push notifications
        patchbomb     command to send changesets as (a series of) patch emails
        relink        recreates hardlinks between repository clones
        schemes       extend schemes with shortcuts to repository swarms
        share         share a common history between several working directories
        transplant    command to transplant changesets from another branch
        win32mbcs     allow the use of MBCS paths with problematic encodings
        zeroconf      discover and advertise repositories on the local network
 
 #endif
 
 Verify that deprecated extensions are included if --verbose:
 
   $ hg -v help extensions | grep children
        children      command to display child changesets (DEPRECATED)
 
 Verify that extension keywords appear in help templates
 
   $ hg help --config extensions.transplant= templating|grep transplant > /dev/null
 
 Test short command list with verbose option
 
   $ hg -v help shortlist
   Mercurial Distributed SCM
   
   basic commands:
   
    abort         abort an unfinished operation (EXPERIMENTAL)
    add           add the specified files on the next commit
    annotate, blame
                  show changeset information by line for each file
    clone         make a copy of an existing repository
    commit, ci    commit the specified files or all outstanding changes
    continue      resumes an interrupted operation (EXPERIMENTAL)
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    init          create a new repository in the given directory
    log, history  show revision history of entire repository or files
    merge         merge another revision into working directory
    pull          pull changes from the specified source
    push          push changes to the specified destination
    remove, rm    remove the specified files on the next commit
    serve         start stand-alone webserver
    status, st    show changed files in the working directory
    summary, sum  summarize working directory state
    update, up, checkout, co
                  update working directory (or switch revisions)
   
   global options ([+] can be repeated):
   
    -R --repository REPO   repository root directory or name of overlay bundle
                           file
       --cwd DIR           change working directory
    -y --noninteractive    do not prompt, automatically pick the first choice for
                           all prompts
    -q --quiet             suppress output
    -v --verbose           enable additional output
       --color TYPE        when to colorize (boolean, always, auto, never, or
                           debug)
       --config CONFIG [+] set/override config option (use 'section.name=value')
       --debug             enable debugging output
       --debugger          start debugger
       --encoding ENCODE   set the charset encoding (default: ascii)
       --encodingmode MODE set the charset encoding mode (default: strict)
       --traceback         always print a traceback on exception
       --time              time how long the command takes
       --profile           print command execution profile
       --version           output version information and exit
    -h --help              display help and exit
       --hidden            consider hidden changesets
       --pager TYPE        when to paginate (boolean, always, auto, or never)
                           (default: auto)
   
   (use 'hg help' for the full list of commands)
 
   $ hg add -h
   hg add [OPTION]... [FILE]...
   
   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").
   
       Returns 0 if all files are successfully added.
   
   options ([+] can be repeated):
   
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
    -n --dry-run             do not perform actions, just print output
   
   (some details hidden, use --verbose to show complete help)
 
 Verbose help for add
 
   $ hg add -hv
   hg add [OPTION]... [FILE]...
   
   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").
   
       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.
   
   options ([+] can be repeated):
   
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
    -n --dry-run             do not perform actions, just print output
   
   global options ([+] can be repeated):
   
    -R --repository REPO   repository root directory or name of overlay bundle
                           file
       --cwd DIR           change working directory
    -y --noninteractive    do not prompt, automatically pick the first choice for
                           all prompts
    -q --quiet             suppress output
    -v --verbose           enable additional output
       --color TYPE        when to colorize (boolean, always, auto, never, or
                           debug)
       --config CONFIG [+] set/override config option (use 'section.name=value')
       --debug             enable debugging output
       --debugger          start debugger
       --encoding ENCODE   set the charset encoding (default: ascii)
       --encodingmode MODE set the charset encoding mode (default: strict)
       --traceback         always print a traceback on exception
       --time              time how long the command takes
       --profile           print command execution profile
       --version           output version information and exit
    -h --help              display help and exit
       --hidden            consider hidden changesets
       --pager TYPE        when to paginate (boolean, always, auto, or never)
                           (default: auto)
 
 Test the textwidth config option
 
   $ hg root -h  --config ui.textwidth=50
   hg root
   
   print the root (top) of the current working
   directory
   
       Print the root directory of the current
       repository.
   
       Returns 0 on success.
   
   options:
   
    -T --template TEMPLATE display with template
   
   (some details hidden, use --verbose to show
   complete help)
 
 Test help option with version option
 
   $ hg add -h --version
   Mercurial Distributed SCM (version *) (glob)
   (see https://mercurial-scm.org for more information)
   
   Copyright (C) 2005-* Olivia Mackall and others (glob)
   This is free software; see the source for copying conditions. There is NO
   warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
   $ hg add --skjdfks
   hg add: option --skjdfks not recognized
   hg add [OPTION]... [FILE]...
   
   add the specified files on the next commit
   
   options ([+] can be repeated):
   
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
    -n --dry-run             do not perform actions, just print output
   
   (use 'hg add -h' to show more help)
   [10]
 
 Test ambiguous command help
 
   $ hg help ad
   list of commands:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
   
   (use 'hg help -v ad' to show built-in aliases and global options)
 
 Test command without options
 
   $ hg help verify
   hg verify
   
   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.
   
   options:
   
   (some details hidden, use --verbose to show complete help)
 
   $ hg help diff
   hg diff [OPTION]... ([-c REV] | [--from REV1] [--to REV2]) [FILE]...
   
   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'.
   
       Returns 0 on success.
   
   options ([+] can be repeated):
   
       --from REV1           revision to diff from
       --to REV2             revision to diff to
    -c --change REV          change made by revision
    -a --text                treat all files as text
    -g --git                 use git extended diff format
       --binary              generate binary diffs in git mode (default)
       --nodates             omit dates from diff headers
       --noprefix            omit a/ and b/ prefixes from filenames
    -p --show-function       show which function each change is in
       --reverse             produce a diff that undoes the changes
    -w --ignore-all-space    ignore white space when comparing lines
    -b --ignore-space-change ignore changes in the amount of white space
    -B --ignore-blank-lines  ignore changes whose lines are all blank
    -Z --ignore-space-at-eol ignore changes in whitespace at EOL
    -U --unified NUM         number of lines of context to show
       --stat                output diffstat-style summary of changes
       --root DIR            produce diffs relative to subdirectory
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
   
   (some details hidden, use --verbose to show complete help)
 
   $ hg help status
   hg status [OPTION]... [FILE]...
   
   aliases: st
   
   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)
   
       Returns 0 on success.
   
   options ([+] can be repeated):
   
    -A --all                 show status of all files
    -m --modified            show only modified files
    -a --added               show only added files
    -r --removed             show only removed files
    -d --deleted             show only missing files
    -c --clean               show only files without changes
    -u --unknown             show only unknown (not tracked) files
    -i --ignored             show only ignored files
    -n --no-status           hide status prefix
    -C --copies              show source of copied files
    -0 --print0              end filenames with NUL, for use with xargs
       --rev REV [+]         show difference from revision
       --change REV          list the changed files of a revision
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
    -T --template TEMPLATE   display with template
   
   (some details hidden, use --verbose to show complete help)
 
   $ hg -q help status
   hg status [OPTION]... [FILE]...
   
   show changed files in the working directory
 
   $ hg help foo
   abort: no such help topic: foo
   (try 'hg help --keyword foo')
   [10]
 
   $ hg skjdfks
   hg: unknown command 'skjdfks'
   (use 'hg help' for a list of commands)
   [10]
 
 Typoed command gives suggestion
   $ hg puls
   hg: unknown command 'puls'
   (did you mean one of pull, push?)
   [10]
 
 Not enabled extension gets suggested
 
   $ hg rebase
   hg: unknown command 'rebase'
   'rebase' is provided by the following extension:
   
       rebase        command to move sets of revisions to a different ancestor
   
   (use 'hg help extensions' for information on enabling extensions)
   [10]
 
 Disabled extension gets suggested
   $ hg --config extensions.rebase=! rebase
   hg: unknown command 'rebase'
   'rebase' is provided by the following extension:
   
       rebase        command to move sets of revisions to a different ancestor
   
   (use 'hg help extensions' for information on enabling extensions)
   [10]
 
 Checking that help adapts based on the config:
 
   $ hg help diff --config ui.tweakdefaults=true | egrep -e '^ *(-g|config)'
    -g --[no-]git            use git extended diff format (default: on from
                             config)
 
 Make sure that we don't run afoul of the help system thinking that
 this is a section and erroring out weirdly.
 
   $ hg .log
   hg: unknown command '.log'
   (did you mean log?)
   [10]
 
   $ hg log.
   hg: unknown command 'log.'
   (did you mean log?)
   [10]
   $ hg pu.lh
   hg: unknown command 'pu.lh'
   (did you mean one of pull, push?)
   [10]
 
   $ cat > helpext.py <<EOF
   > import os
   > from mercurial import commands, fancyopts, registrar
   > 
   > def func(arg):
   >     return '%sfoo' % arg
   > class customopt(fancyopts.customopt):
   >     def newstate(self, oldstate, newparam, abort):
   >         return '%sbar' % oldstate
   > cmdtable = {}
   > command = registrar.command(cmdtable)
   > 
   > @command(b'nohelp',
   >     [(b'', b'longdesc', 3, b'x'*67),
   >     (b'n', b'', None, b'normal desc'),
   >     (b'', b'newline', b'', b'line1\nline2'),
   >     (b'', b'default-off', False, b'enable X'),
   >     (b'', b'default-on', True, b'enable Y'),
   >     (b'', b'callableopt', func, b'adds foo'),
   >     (b'', b'customopt', customopt(''), b'adds bar'),
   >     (b'', b'customopt-withdefault', customopt('foo'), b'adds bar')],
   >     b'hg nohelp',
   >     norepo=True)
   > @command(b'debugoptADV', [(b'', b'aopt', None, b'option is (ADVANCED)')])
   > @command(b'debugoptDEP', [(b'', b'dopt', None, b'option is (DEPRECATED)')])
   > @command(b'debugoptEXP', [(b'', b'eopt', None, b'option is (EXPERIMENTAL)')])
   > def nohelp(ui, *args, **kwargs):
   >     pass
   > 
   > @command(b'hashelp', [], b'hg hashelp', norepo=True)
   > def hashelp(ui, *args, **kwargs):
   >     """Extension command's help"""
   > 
   > def uisetup(ui):
   >     ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
   >     ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
   >     ui.setconfig(b'alias', b'hgalias:doc', b'My doc', b'helpext')
   >     ui.setconfig(b'alias', b'hgalias:category', b'navigation', b'helpext')
   >     ui.setconfig(b'alias', b'hgaliasnodoc', b'summary', b'helpext')
   > 
   > EOF
   $ echo '[extensions]' >> $HGRCPATH
   $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
 
 Test for aliases
 
   $ hg help | grep hgalias
    hgalias       My doc
 
   $ hg help hgalias
   hg hgalias [--remote]
   
   alias for: hg summary
   
   My doc
   
   defined by: helpext
   
   options:
   
     --remote check for push and pull
   
   (some details hidden, use --verbose to show complete help)
   $ hg help hgaliasnodoc
   hg hgaliasnodoc [--remote]
   
   alias for: hg summary
   
   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.
   
   defined by: helpext
   
   options:
   
     --remote check for push and pull
   
   (some details hidden, use --verbose to show complete help)
 
   $ hg help shellalias
   hg shellalias
   
   shell alias for: echo hi
   
   (no help text available)
   
   defined by: helpext
   
   (some details hidden, use --verbose to show complete help)
 
 Test command with no help text
 
   $ hg help nohelp
   hg nohelp
   
   (no help text available)
   
   options:
   
       --longdesc VALUE
                                     xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                                     xxxxxxxxxxxxxxxxxxxxxxx (default: 3)
    -n --                            normal desc
       --newline VALUE               line1 line2
       --default-off                 enable X
       --[no-]default-on             enable Y (default: on)
       --callableopt VALUE           adds foo
       --customopt VALUE             adds bar
       --customopt-withdefault VALUE adds bar (default: foo)
   
   (some details hidden, use --verbose to show complete help)
 
 Test that default list of commands includes extension commands that have help,
 but not those that don't, except in verbose mode, when a keyword is passed, or
 when help about the extension is requested.
 
 #if no-extraextensions
 
   $ hg help | grep hashelp
    hashelp       Extension command's help
   $ hg help | grep nohelp
   [1]
   $ hg help -v | grep nohelp
    nohelp        (no help text available)
 
   $ hg help -k nohelp
   Commands:
   
    nohelp hg nohelp
   
   Extension Commands:
   
    nohelp (no help text available)
 
   $ hg help helpext
   helpext extension - no help text available
   
   list of commands:
   
    hashelp       Extension command's help
    nohelp        (no help text available)
   
   (use 'hg help -v helpext' to show built-in aliases and global options)
 
 #endif
 
 Test list of internal help commands
 
   $ hg help debug
   debug commands (internal and unsupported):
   
    debug-delta-find
                  display the computation to get to a valid delta for storing REV
    debug-repair-issue6528
                  find affected revisions and repair them. See issue6528 for more
                  details.
    debug-revlog-index
                  dump index data for a revlog
    debug-revlog-stats
                  display statistics about revlogs in the store
    debug::stable-tail-sort
                  display the stable-tail sort of the ancestors of a given node
    debugancestor
                  find the ancestor revision of two revisions in a given index
    debugantivirusrunning
                  attempt to trigger an antivirus scanner to see if one is active
    debugapplystreamclonebundle
                  apply a stream clone bundle file
    debugbackupbundle
                  lists the changesets available in backup bundles
    debugbuilddag
                  builds a repo with a given DAG from scratch in the current
                  empty repo
    debugbundle   lists the contents of a bundle
    debugcapabilities
                  lists the capabilities of a remote peer
    debugchangedfiles
                  list the stored files changes for a revision
    debugcheckstate
                  validate the correctness of the current dirstate
    debugcolor    show available color, effects or style
    debugcommands
                  list all available commands and options
    debugcomplete
                  returns the completion list associated with the given command
    debugcreatestreamclonebundle
                  create a stream clone bundle file
    debugdag      format the changelog or an index DAG as a concise textual
                  description
    debugdata     dump the contents of a data file revision
    debugdate     parse and display a date
    debugdeltachain
                  dump information about delta chains in a revlog
    debugdirstate
                  show the contents of the current dirstate
    debugdirstateignorepatternshash
                  show the hash of ignore patterns stored in dirstate if v2,
    debugdiscovery
                  runs the changeset discovery protocol in isolation
    debugdownload
                  download a resource using Mercurial logic and config
    debugextensions
                  show information about active extensions
    debugfileset  parse and apply a fileset specification
    debugformat   display format information about the current repository
    debugfsinfo   show information detected about current filesystem
    debuggetbundle
                  retrieves a bundle from a repo
    debugignore   display the combined ignore pattern and information about
                  ignored files
    debugindexdot
                  dump an index DAG as a graphviz dot file
    debugindexstats
                  show stats related to the changelog index
    debuginstall  test Mercurial installation
    debugknown    test whether node ids are known to a repo
    debuglocks    show or modify state of locks
    debugmanifestfulltextcache
                  show, clear or amend the contents of the manifest fulltext
                  cache
    debugmergestate
                  print merge state
    debugnamecomplete
                  complete "names" - tags, open branch names, bookmark names
    debugnodemap  write and inspect on disk nodemap
    debugobsolete
                  create arbitrary obsolete marker
    debugoptADV   (no help text available)
    debugoptDEP   (no help text available)
    debugoptEXP   (no help text available)
    debugp1copies
                  dump copy information compared to p1
    debugp2copies
                  dump copy information compared to p2
    debugpathcomplete
                  complete part or all of a tracked path
    debugpathcopies
                  show copies between two revisions
    debugpeer     establish a connection to a peer repository
    debugpickmergetool
                  examine which merge tool is chosen for specified file
    debugpushkey  access the pushkey key/value protocol
    debugpvec     (no help text available)
    debugrebuilddirstate
                  rebuild the dirstate as it would look like for the given
                  revision
    debugrebuildfncache
                  rebuild the fncache file
    debugrename   dump rename information
    debugrequires
                  print the current repo requirements
    debugrevlog   show data and statistics about a revlog
    debugrevlogindex
                  dump the contents of a revlog index
    debugrevspec  parse and apply a revision specification
    debugserve    run a server with advanced settings
    debugsetparents
                  manually set the parents of the current working directory
                  (DANGEROUS)
    debugshell    run an interactive Python interpreter
    debugsidedata
                  dump the side data for a cl/manifest/file revision
    debugssl      test a secure connection to a server
    debugstrip    strip changesets and all their descendants from the repository
    debugsub      (no help text available)
    debugsuccessorssets
                  show set of successors for revision
    debugtagscache
                  display the contents of .hg/cache/hgtagsfnodes1
    debugtemplate
                  parse and apply a template
    debuguigetpass
                  show prompt to type password
    debuguiprompt
                  show plain prompt
    debugupdatecaches
                  warm all known caches in the repository
    debugupgraderepo
                  upgrade a repository to use different features
    debugwalk     show how files match on given patterns
    debugwhyunstable
                  explain instabilities of a changeset
    debugwireargs
                  (no help text available)
    debugwireproto
                  send wire protocol commands to a server
   
   (use 'hg help -v debug' to show built-in aliases and global options)
 
 internals topic renders index of available sub-topics
 
   $ hg help internals
   Technical implementation topics
   """""""""""""""""""""""""""""""
   
       To access a subtopic, use "hg help internals.{subtopic-name}"
   
        bid-merge     Bid Merge Algorithm
        bundle2       Bundle2
        bundles       Bundles
        cbor          CBOR
        censor        Censor
        changegroups  Changegroups
        config        Config Registrar
        dirstate-v2   dirstate-v2 file format
        extensions    Extension API
        mergestate    Mergestate
        requirements  Repository Requirements
        revlogs       Revision Logs
        wireprotocol  Wire Protocol
        wireprotocolrpc
                      Wire Protocol RPC
        wireprotocolv2
                      Wire Protocol Version 2
 
 sub-topics can be accessed
 
   $ hg help internals.changegroups
   Changegroups
   """"""""""""
   
       Changegroups are representations of repository revlog data, specifically
       the changelog data, root/flat manifest data, treemanifest data, and
       filelogs.
   
       There are 4 versions of changegroups: "1", "2", "3" and "4". From a high-
       level, versions "1" and "2" are almost exactly the same, with the only
       difference being an additional item in the *delta header*. Version "3"
       adds support for storage flags in the *delta header* and optionally
       exchanging treemanifests (enabled by setting an option on the
       "changegroup" part in the bundle2). Version "4" adds support for
       exchanging sidedata (additional revision metadata not part of the digest).
   
       Changegroups when not exchanging treemanifests consist of 3 logical
       segments:
   
         +---------------------------------+
         |           |          |          |
         | changeset | manifest | filelogs |
         |           |          |          |
         |           |          |          |
         +---------------------------------+
   
       When exchanging treemanifests, there are 4 logical segments:
   
         +-------------------------------------------------+
         |           |          |               |          |
         | changeset |   root   | treemanifests | filelogs |
         |           | manifest |               |          |
         |           |          |               |          |
         +-------------------------------------------------+
   
       The principle building block of each segment is a *chunk*. A *chunk* is a
       framed piece of data:
   
         +---------------------------------------+
         |           |                           |
         |  length   |           data            |
         | (4 bytes) |   (<length - 4> bytes)    |
         |           |                           |
         +---------------------------------------+
   
       All integers are big-endian signed integers. Each chunk starts with a
       32-bit integer indicating the length of the entire chunk (including the
       length field itself).
   
       There is a special case chunk that has a value of 0 for the length
       ("0x00000000"). We call this an *empty chunk*.
   
       Delta Groups
       ============
   
       A *delta group* expresses the content of a revlog as a series of deltas,
       or patches against previous revisions.
   
       Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
       to signal the end of the delta group:
   
         +------------------------------------------------------------------------+
         |                |             |               |             |           |
         | chunk0 length  | chunk0 data | chunk1 length | chunk1 data |    0x0    |
         |   (4 bytes)    |  (various)  |   (4 bytes)   |  (various)  | (4 bytes) |
         |                |             |               |             |           |
         +------------------------------------------------------------------------+
   
       Each *chunk*'s data consists of the following:
   
         +---------------------------------------+
         |                        |              |
         |     delta header       |  delta data  |
         |  (various by version)  |  (various)   |
         |                        |              |
         +---------------------------------------+
   
       The *delta data* is a series of *delta*s that describe a diff from an
       existing entry (either that the recipient already has, or previously
       specified in the bundle/changegroup).
   
       The *delta header* is different between versions "1", "2", "3" and "4" of
       the changegroup format.
   
       Version 1 (headerlen=80):
   
         +------------------------------------------------------+
         |            |             |             |             |
         |    node    |   p1 node   |   p2 node   |  link node  |
         | (20 bytes) |  (20 bytes) |  (20 bytes) |  (20 bytes) |
         |            |             |             |             |
         +------------------------------------------------------+
   
       Version 2 (headerlen=100):
   
         +------------------------------------------------------------------+
         |            |             |             |            |            |
         |    node    |   p1 node   |   p2 node   | base node  | link node  |
         | (20 bytes) |  (20 bytes) |  (20 bytes) | (20 bytes) | (20 bytes) |
         |            |             |             |            |            |
         +------------------------------------------------------------------+
   
       Version 3 (headerlen=102):
   
         +------------------------------------------------------------------------------+
         |            |             |             |            |            |           |
         |    node    |   p1 node   |   p2 node   | base node  | link node  |   flags   |
         | (20 bytes) |  (20 bytes) |  (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
         |            |             |             |            |            |           |
         +------------------------------------------------------------------------------+
   
       Version 4 (headerlen=103):
   
         +------------------------------------------------------------------------------+----------+
         |            |             |             |            |            |           |          |
         |    node    |   p1 node   |   p2 node   | base node  | link node  |   flags   |  pflags  |
         | (20 bytes) |  (20 bytes) |  (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) | (1 byte) |
         |            |             |             |            |            |           |          |
         +------------------------------------------------------------------------------+----------+
   
       The *delta data* consists of "chunklen - 4 - headerlen" bytes, which
       contain a series of *delta*s, densely packed (no separators). These deltas
       describe a diff from an existing entry (either that the recipient already
       has, or previously specified in the bundle/changegroup). The format is
       described more fully in "hg help internals.bdiff", but briefly:
   
         +---------------------------------------------------------------+
         |              |            |            |                      |
         | start offset | end offset | new length |        content       |
         |  (4 bytes)   |  (4 bytes) |  (4 bytes) | (<new length> bytes) |
         |              |            |            |                      |
         +---------------------------------------------------------------+
   
       Please note that the length field in the delta data does *not* include
       itself.
   
       In version 1, the delta is always applied against the previous node from
       the changegroup or the first parent if this is the first entry in the
       changegroup.
   
       In version 2 and up, the delta base node is encoded in the entry in the
       changegroup. This allows the delta to be expressed against any parent,
       which can result in smaller deltas and more efficient encoding of data.
   
       The *flags* field holds bitwise flags affecting the processing of revision
       data. The following flags are defined:
   
       32768
          Censored revision. The revision's fulltext has been replaced by censor
          metadata. May only occur on file revisions.
   
       16384
          Ellipsis revision. Revision hash does not match data (likely due to
          rewritten parents).
   
       8192
          Externally stored. The revision fulltext contains "key:value" "\n"
          delimited metadata defining an object stored elsewhere. Used by the LFS
          extension.
   
       4096
          Contains copy information. This revision changes files in a way that
          could affect copy tracing. This does *not* affect changegroup handling,
          but is relevant for other parts of Mercurial.
   
       For historical reasons, the integer values are identical to revlog version
       1 per-revision storage flags and correspond to bits being set in this
       2-byte field. Bits were allocated starting from the most-significant bit,
       hence the reverse ordering and allocation of these flags.
   
       The *pflags* (protocol flags) field holds bitwise flags affecting the
       protocol itself. They are first in the header since they may affect the
       handling of the rest of the fields in a future version. They are defined
       as such:
   
       1 indicates whether to read a chunk of sidedata (of variable length) right
         after the revision flags.
   
       Changeset Segment
       =================
   
       The *changeset segment* consists of a single *delta group* holding
       changelog data. The *empty chunk* at the end of the *delta group* denotes
       the boundary to the *manifest segment*.
   
       Manifest Segment
       ================
   
       The *manifest segment* consists of a single *delta group* holding manifest
       data. If treemanifests are in use, it contains only the manifest for the
       root directory of the repository. Otherwise, it contains the entire
       manifest data. The *empty chunk* at the end of the *delta group* denotes
       the boundary to the next segment (either the *treemanifests segment* or
       the *filelogs segment*, depending on version and the request options).
   
       Treemanifests Segment
       ---------------------
   
       The *treemanifests segment* only exists in changegroup version "3" and
       "4", and only if the 'treemanifest' param is part of the bundle2
       changegroup part (it is not possible to use changegroup version 3 or 4
       outside of bundle2). Aside from the filenames in the *treemanifests
       segment* containing a trailing "/" character, it behaves identically to
       the *filelogs segment* (see below). The final sub-segment is followed by
       an *empty chunk* (logically, a sub-segment with filename size 0). This
       denotes the boundary to the *filelogs segment*.
   
       Filelogs Segment
       ================
   
       The *filelogs segment* consists of multiple sub-segments, each
       corresponding to an individual file whose data is being described:
   
         +--------------------------------------------------+
         |          |          |          |     |           |
         | filelog0 | filelog1 | filelog2 | ... |    0x0    |
         |          |          |          |     | (4 bytes) |
         |          |          |          |     |           |
         +--------------------------------------------------+
   
       The final filelog sub-segment is followed by an *empty chunk* (logically,
       a sub-segment with filename size 0). This denotes the end of the segment
       and of the overall changegroup.
   
       Each filelog sub-segment consists of the following:
   
         +------------------------------------------------------+
         |                 |                      |             |
         | filename length |       filename       | delta group |
         |    (4 bytes)    | (<length - 4> bytes) |  (various)  |
         |                 |                      |             |
         +------------------------------------------------------+
   
       That is, a *chunk* consisting of the filename (not terminated or padded)
       followed by N chunks constituting the *delta group* for this file. The
       *empty chunk* at the end of each *delta group* denotes the boundary to the
       next filelog sub-segment.
 
 non-existent subtopics print an error
 
   $ hg help internals.foo
   abort: no such help topic: internals.foo
   (try 'hg help --keyword foo')
   [10]
 
 test advanced, deprecated and experimental options are hidden in command help
   $ hg help debugoptADV
   hg debugoptADV
   
   (no help text available)
   
   options:
   
   (some details hidden, use --verbose to show complete help)
   $ hg help debugoptDEP
   hg debugoptDEP
   
   (no help text available)
   
   options:
   
   (some details hidden, use --verbose to show complete help)
 
   $ hg help debugoptEXP
   hg debugoptEXP
   
   (no help text available)
   
   options:
   
   (some details hidden, use --verbose to show complete help)
 
 test advanced, deprecated and experimental options are shown with -v
   $ hg help -v debugoptADV | grep aopt
     --aopt option is (ADVANCED)
   $ hg help -v debugoptDEP | grep dopt
     --dopt option is (DEPRECATED)
   $ hg help -v debugoptEXP | grep eopt
     --eopt option is (EXPERIMENTAL)
 
 #if gettext
 test deprecated option is hidden with translation with untranslated description
 (use many globy for not failing on changed transaction)
   $ LANGUAGE=sv hg help debugoptDEP
   hg debugoptDEP
   
   (*) (glob)
   
   options:
   
   (some details hidden, use --verbose to show complete help)
 #endif
 
 Test commands that collide with topics (issue4240)
 
   $ hg config -hq
   hg config [-u] [NAME]...
   
   show combined config settings from all hgrc files
   $ hg showconfig -hq
   hg config [-u] [NAME]...
   
   show combined config settings from all hgrc files
 
 Test a help topic
 
   $ hg help dates
   Date Formats
   """"""""""""
   
       Some commands allow the user to specify a date, e.g.:
   
       - backout, commit, import, tag: Specify the commit date.
       - log, revert, update: Select revision(s) by date.
   
       Many date formats are valid. Here are some examples:
   
       - "Wed Dec 6 13:18:29 2006" (local timezone assumed)
       - "Dec 6 13:18 -0600" (year assumed, time offset provided)
       - "Dec 6 13:18 UTC" (UTC and GMT are aliases for +0000)
       - "Dec 6" (midnight)
       - "13:18" (today assumed)
       - "3:39" (3:39AM assumed)
       - "3:39pm" (15:39)
       - "2006-12-06 13:18:29" (ISO 8601 format)
       - "2006-12-6 13:18"
       - "2006-12-6"
       - "12-6"
       - "12/6"
       - "12/6/6" (Dec 6 2006)
       - "today" (midnight)
       - "yesterday" (midnight)
       - "now" - right now
   
       Lastly, there is Mercurial's internal format:
   
       - "1165411109 0" (Wed Dec 6 13:18:29 2006 UTC)
   
       This is the internal representation format for dates. The first number is
       the number of seconds since the epoch (1970-01-01 00:00 UTC). The second
       is the offset of the local timezone, in seconds west of UTC (negative if
       the timezone is east of UTC).
   
       The log command also accepts date ranges:
   
       - "<DATE" - at or before a given date/time
       - ">DATE" - on or after a given date/time
       - "DATE to DATE" - a date range, inclusive
       - "-DAYS" - within a given number of days from today
 
 Test repeated config section name
 
   $ hg help config.host
       "http_proxy.host"
           Host name and (optional) port of the proxy server, for example
           "myproxy:8000".
   
       "smtp.host"
           Host name of mail server, e.g. "mail.example.com".
   
 
 Test section name with dot
 
   $ hg help config.ui.username
       "ui.username"
           The committer of a changeset created when running "commit". Typically
           a person's name and email address, e.g. "Fred Widget
           <[e-mail]>". Environment variables in the username are
           expanded.
   
           (default: "$EMAIL" or "username@hostname". If the username in hgrc is
           empty, e.g. if the system admin set "username =" in the system hgrc,
           it has to be specified manually or in a different hgrc file)
   
 
   $ hg help config.annotate.git
   abort: help section not found: config.annotate.git
   [10]
 
   $ hg help config.update.check
       "commands.update.check"
           Determines what level of checking 'hg update' will perform before
           moving to a destination revision. Valid values are "abort", "none",
           "linear", and "noconflict".
   
           - "abort" always fails if the working directory has uncommitted
             changes.
           - "none" performs no checking, and may result in a merge with
             uncommitted changes.
           - "linear" allows any update as long as it follows a straight line in
             the revision history, and may trigger a merge with uncommitted
             changes.
           - "noconflict" will allow any update which would not trigger a merge
             with uncommitted changes, if any are present.
   
           (default: "linear")
   
 
   $ hg help config.commands.update.check
       "commands.update.check"
           Determines what level of checking 'hg update' will perform before
           moving to a destination revision. Valid values are "abort", "none",
           "linear", and "noconflict".
   
           - "abort" always fails if the working directory has uncommitted
             changes.
           - "none" performs no checking, and may result in a merge with
             uncommitted changes.
           - "linear" allows any update as long as it follows a straight line in
             the revision history, and may trigger a merge with uncommitted
             changes.
           - "noconflict" will allow any update which would not trigger a merge
             with uncommitted changes, if any are present.
   
           (default: "linear")
   
 
   $ hg help config.ommands.update.check
   abort: help section not found: config.ommands.update.check
   [10]
 
 Unrelated trailing paragraphs shouldn't be included
 
   $ hg help config.extramsg | grep '^$'
   
 
 Test capitalized section name
 
   $ hg help scripting.HGPLAIN > /dev/null
 
 Help subsection:
 
   $ hg help config.charsets |grep "Email example:" > /dev/null
   [1]
 
 Show nested definitions
 ("profiling.type"[break]"ls"[break]"stat"[break])
 
   $ hg help config.type | egrep '^$'|wc -l
   \s*3 (re)
 
   $ hg help config.profiling.type.ls
           "profiling.type.ls"
             Use Python's built-in instrumenting profiler. This profiler works on
             all platforms, but each line number it reports is the first line of
             a function. This restriction makes it difficult to identify the
             expensive parts of a non-trivial function.
   
 
 Separate sections from subsections
 
   $ hg help config.format | egrep '^    ("|-)|^\s*$' | uniq
       "format"
       --------
   
       "usegeneraldelta"
   
       "dotencode"
   
       "usefncache"
   
       "use-dirstate-v2"
   
       "use-dirstate-v2.automatic-upgrade-of-mismatching-repositories"
   
       "use-dirstate-v2.automatic-upgrade-of-mismatching-repositories:quiet"
   
       "use-dirstate-tracked-hint"
   
       "use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories"
   
       "use-dirstate-tracked-hint.automatic-upgrade-of-mismatching-repositories:quiet"
   
       "use-persistent-nodemap"
   
       "use-share-safe"
   
       "use-share-safe.automatic-upgrade-of-mismatching-repositories"
   
       "use-share-safe.automatic-upgrade-of-mismatching-repositories:quiet"
   
       "usestore"
   
       "sparse-revlog"
   
       "revlog-compression"
   
       "bookmarks-in-store"
   
       "profiling"
       -----------
   
       "format"
   
       "progress"
       ----------
   
       "format"
   
 
 Last item in help config.*:
 
   $ hg help config.`hg help config|grep '^    "'| \
   >       tail -1|sed 's![ "]*!!g'`| \
   >   grep 'hg help -c config' > /dev/null
   [1]
 
 note to use help -c for general hg help config:
 
   $ hg help config |grep 'hg help -c config' > /dev/null
 
 Test templating help
 
   $ hg help templating | egrep '(desc|diffstat|firstline|nonempty)  '
       desc          String. The text of the changeset description.
       diffstat      String. Statistics of changes with the following format:
       firstline     Any text. Returns the first line of text.
       nonempty      Any text. Returns '(none)' if the string is empty.
 
 Test deprecated items
 
   $ hg help -v templating | grep currentbookmark
       currentbookmark
   $ hg help templating | (grep currentbookmark || true)
 
 Test help hooks
 
   $ cat > helphook1.py <<EOF
   > from mercurial import help
   > 
   > def rewrite(ui, topic, doc):
   >     return doc + b'\nhelphook1\n'
   > 
   > def extsetup(ui):
   >     help.addtopichook(b'revisions', rewrite)
   > EOF
   $ cat > helphook2.py <<EOF
   > from mercurial import help
   > 
   > def rewrite(ui, topic, doc):
   >     return doc + b'\nhelphook2\n'
   > 
   > def extsetup(ui):
   >     help.addtopichook(b'revisions', rewrite)
   > EOF
   $ echo '[extensions]' >> $HGRCPATH
   $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
   $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
   $ hg help revsets | grep helphook
       helphook1
       helphook2
 
 help -c should only show debug --debug
 
   $ hg help -c --debug|egrep debug|wc -l|egrep '^\s*0\s*$'
   [1]
 
 help -c should only show deprecated for -v
 
   $ hg help -c -v|egrep DEPRECATED|wc -l|egrep '^\s*0\s*$'
   [1]
 
 Test -s / --system
 
   $ hg help config.files -s windows |grep 'etc/mercurial' | \
   > wc -l | sed -e 's/ //g'
   0
   $ hg help config.files --system unix | grep 'USER' | \
   > wc -l | sed -e 's/ //g'
   0
 
 Test -e / -c / -k combinations
 
   $ hg help -c|egrep '^[A-Z].*:|^ debug'
   Commands:
   $ hg help -e|egrep '^[A-Z].*:|^ debug'
   Extensions:
   $ hg help -k|egrep '^[A-Z].*:|^ debug'
   Topics:
   Commands:
   Extensions:
   Extension Commands:
   $ hg help -c schemes
   abort: no such help topic: schemes
   (try 'hg help --keyword schemes')
   [10]
   $ hg help -e schemes |head -1
   schemes extension - extend schemes with shortcuts to repository swarms
   $ hg help -c -k dates |egrep '^(Topics|Extensions|Commands):'
   Commands:
   $ hg help -e -k a |egrep '^(Topics|Extensions|Commands):'
   Extensions:
   $ hg help -e -c -k date |egrep '^(Topics|Extensions|Commands):'
   Extensions:
   Commands:
   $ hg help -c commit > /dev/null
   $ hg help -e -c commit > /dev/null
   $ hg help -e commit
   abort: no such help topic: commit
   (try 'hg help --keyword commit')
   [10]
 
 Test keyword search help
 
   $ cat > prefixedname.py <<EOF
   > '''matched against word "clone"
   > '''
   > EOF
   $ echo '[extensions]' >> $HGRCPATH
   $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
   $ hg help -k clone
   Topics:
   
    config     Configuration Files
    extensions Using Additional Features
    glossary   Glossary
    phases     Working with Phases
    subrepos   Subrepositories
    urls       URL Paths
   
   Commands:
   
    bookmarks create a new bookmark or list existing bookmarks
    clone     make a copy of an existing repository
    paths     show aliases for remote repositories
    pull      pull changes from the specified source
    update    update working directory (or switch revisions)
   
   Extensions:
   
    clonebundles advertise pre-generated bundles to seed clones
    narrow       create clones which fetch history data for subset of files
                 (EXPERIMENTAL)
    prefixedname matched against word "clone"
    relink       recreates hardlinks between repository clones
   
   Extension Commands:
   
+   admin::clone-bundles-clear   remove existing clone bundle caches
    admin::clone-bundles-refresh generate clone bundles according to the
                                 configuration
    qclone                       clone main and patch repository at same time
 
 Test unfound topic
 
   $ hg help nonexistingtopicthatwillneverexisteverever
   abort: no such help topic: nonexistingtopicthatwillneverexisteverever
   (try 'hg help --keyword nonexistingtopicthatwillneverexisteverever')
   [10]
 
 Test unfound keyword
 
   $ hg help --keyword nonexistingwordthatwillneverexisteverever
   abort: no matches
   (try 'hg help' for a list of topics)
   [10]
 
 Test omit indicating for help
 
   $ cat > addverboseitems.py <<EOF
   > r'''extension to test omit indicating.
   > 
   > This paragraph is never omitted (for extension)
   > 
   > .. container:: verbose
   > 
   >   This paragraph is omitted,
   >   if :hg:\`help\` is invoked without \`\`-v\`\` (for extension)
   > 
   > This paragraph is never omitted, too (for extension)
   > '''
   > from mercurial import commands, help
   > testtopic = br"""This paragraph is never omitted (for topic).
   > 
   > .. container:: verbose
   > 
   >   This paragraph is omitted,
   >   if :hg:\`help\` is invoked without \`\`-v\`\` (for topic)
   > 
   > This paragraph is never omitted, too (for topic)
   > """
   > def extsetup(ui):
   >     help.helptable.append(([b"topic-containing-verbose"],
   >                            b"This is the topic to test omit indicating.",
   >                            lambda ui: testtopic))
   > EOF
   $ echo '[extensions]' >> $HGRCPATH
   $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
   $ hg help addverboseitems
   addverboseitems extension - extension to test omit indicating.
   
   This paragraph is never omitted (for extension)
   
   This paragraph is never omitted, too (for extension)
   
   (some details hidden, use --verbose to show complete help)
   
   no commands defined
   $ hg help -v addverboseitems
   addverboseitems extension - extension to test omit indicating.
   
   This paragraph is never omitted (for extension)
   
   This paragraph is omitted, if 'hg help' is invoked without "-v" (for
   extension)
   
   This paragraph is never omitted, too (for extension)
   
   no commands defined
   $ hg help topic-containing-verbose
   This is the topic to test omit indicating.
   """"""""""""""""""""""""""""""""""""""""""
   
       This paragraph is never omitted (for topic).
   
       This paragraph is never omitted, too (for topic)
   
   (some details hidden, use --verbose to show complete help)
   $ hg help -v topic-containing-verbose
   This is the topic to test omit indicating.
   """"""""""""""""""""""""""""""""""""""""""
   
       This paragraph is never omitted (for topic).
   
       This paragraph is omitted, if 'hg help' is invoked without "-v" (for
       topic)
   
       This paragraph is never omitted, too (for topic)
 
 Test section lookup
 
   $ hg help revset.merge
       "merge()"
         Changeset is a merge changeset.
   
   $ hg help glossary.dag
       DAG
           The repository of changesets of a distributed version control system
           (DVCS) can be described as a directed acyclic graph (DAG), consisting
           of nodes and edges, where nodes correspond to changesets and edges
           imply a parent -> child relation. This graph can be visualized by
           graphical tools such as 'hg log --graph'. In Mercurial, the DAG is
           limited by the requirement for children to have at most two parents.
   
 
   $ hg help hgrc.paths
       "paths"
       -------
   
       Assigns symbolic names and behavior to repositories.
   
       Options are symbolic names defining the URL or directory that is the
       location of the repository. Example:
   
         [paths]
         my_server = https://example.com/my_repo
         local_path = /home/me/repo
   
       These symbolic names can be used from the command line. To pull from
       "my_server": 'hg pull my_server'. To push to "local_path": 'hg push
       local_path'. You can check 'hg help urls' for details about valid URLs.
   
       Options containing colons (":") denote sub-options that can influence
       behavior for that specific path. Example:
   
         [paths]
         my_server = https://example.com/my_path
         my_server:pushurl = ssh://example.com/my_path
   
       Paths using the 'path://otherpath' scheme will inherit the sub-options
       value from the path they point to.
   
       The following sub-options can be defined:
   
       "multi-urls"
          A boolean option. When enabled the value of the '[paths]' entry will be
          parsed as a list and the alias will resolve to multiple destination. If
          some of the list entry use the 'path://' syntax, the suboption will be
          inherited individually.
   
       "pushurl"
          The URL to use for push operations. If not defined, the location
          defined by the path's main entry is used.
   
       "pushrev"
          A revset defining which revisions to push by default.
   
          When 'hg push' is executed without a "-r" argument, the revset defined
          by this sub-option is evaluated to determine what to push.
   
          For example, a value of "." will push the working directory's revision
          by default.
   
          Revsets specifying bookmarks will not result in the bookmark being
          pushed.
   
       "bookmarks.mode"
         How bookmark will be dealt during the exchange. It support the following
         value
   
         - "default": the default behavior, local and remote bookmarks are
           "merged" on push/pull.
         - "mirror": when pulling, replace local bookmarks by remote bookmarks.
           This is useful to replicate a repository, or as an optimization.
         - "ignore": ignore bookmarks during exchange. (This currently only
           affect pulling)
   
       The following special named paths exist:
   
       "default"
          The URL or directory to use when no source or remote is specified.
   
          'hg clone' will automatically define this path to the location the
          repository was cloned from.
   
       "default-push"
          (deprecated) The URL or directory for the default 'hg push' location.
          "default:pushurl" should be used instead.
   
   $ hg help glossary.mcguffin
   abort: help section not found: glossary.mcguffin
   [10]
 
   $ hg help glossary.mc.guffin
   abort: help section not found: glossary.mc.guffin
   [10]
 
   $ hg help template.files
       files         List of strings. All files modified, added, or removed by
                     this changeset.
       files(pattern)
                     All files of the current changeset matching the pattern. See
                     'hg help patterns'.
 
 Test section lookup by translated message
 
 str.lower() instead of encoding.lower(str) on translated message might
 make message meaningless, because some encoding uses 0x41(A) - 0x5a(Z)
 as the second or later byte of multi-byte character.
 
 For example, "\x8bL\x98^" (translation of "record" in ja_JP.cp932)
 contains 0x4c (L). str.lower() replaces 0x4c(L) by 0x6c(l) and this
 replacement makes message meaningless.
 
 This tests that section lookup by translated string isn't broken by
 such str.lower().
 
   $ "$PYTHON" <<EOF
   > def escape(s):
   >     return b''.join(br'\\u%x' % ord(uc) for uc in s.decode('cp932'))
   > # translation of "record" in ja_JP.cp932
   > upper = b"\x8bL\x98^"
   > # str.lower()-ed section name should be treated as different one
   > lower = b"\x8bl\x98^"
   > with open('ambiguous.py', 'wb') as fp:
   >     fp.write(b"""# ambiguous section names in ja_JP.cp932
   > u'''summary of extension
   > 
   > %s
   > ----
   > 
   > Upper name should show only this message
   > 
   > %s
   > ----
   > 
   > Lower name should show only this message
   > 
   > subsequent section
   > ------------------
   > 
   > This should be hidden at 'hg help ambiguous' with section name.
   > '''
   > """ % (escape(upper), escape(lower)))
   > EOF
 
   $ cat >> $HGRCPATH <<EOF
   > [extensions]
   > ambiguous = ./ambiguous.py
   > EOF
 
   $ "$PYTHON" <<EOF | sh
   > from mercurial.utils import procutil
   > upper = b"\x8bL\x98^"
   > procutil.stdout.write(b"hg --encoding cp932 help -e ambiguous.%s\n" % upper)
   > EOF
   \x8bL\x98^ (esc)
   ----
   
   Upper name should show only this message
   
 
   $ "$PYTHON" <<EOF | sh
   > from mercurial.utils import procutil
   > lower = b"\x8bl\x98^"
   > procutil.stdout.write(b"hg --encoding cp932 help -e ambiguous.%s\n" % lower)
   > EOF
   \x8bl\x98^ (esc)
   ----
   
   Lower name should show only this message
   
 
   $ cat >> $HGRCPATH <<EOF
   > [extensions]
   > ambiguous = !
   > EOF
 
 Show help content of disabled extensions
 
   $ cat >> $HGRCPATH <<EOF
   > [extensions]
   > ambiguous = !./ambiguous.py
   > EOF
   $ hg help -e ambiguous
   ambiguous extension - (no help text available)
   
   (use 'hg help extensions' for information on enabling extensions)
 
 Test dynamic list of merge tools only shows up once
   $ hg help merge-tools
   Merge Tools
   """""""""""
   
       To merge files Mercurial uses merge tools.
   
       A merge tool combines two different versions of a file into a merged file.
       Merge tools are given the two files and the greatest common ancestor of
       the two file versions, so they can determine the changes made on both
       branches.
   
       Merge tools are used both for 'hg resolve', 'hg merge', 'hg update', 'hg
       backout' and in several extensions.
   
       Usually, the merge tool tries to automatically reconcile the files by
       combining all non-overlapping changes that occurred separately in the two
       different evolutions of the same initial base file. Furthermore, some
       interactive merge programs make it easier to manually resolve conflicting
       merges, either in a graphical way, or by inserting some conflict markers.
       Mercurial does not include any interactive merge programs but relies on
       external tools for that.
   
       Available merge tools
       =====================
   
       External merge tools and their properties are configured in the merge-
       tools configuration section - see hgrc(5) - but they can often just be
       named by their executable.
   
       A merge tool is generally usable if its executable can be found on the
       system and if it can handle the merge. The executable is found if it is an
       absolute or relative executable path or the name of an application in the
       executable search path. The tool is assumed to be able to handle the merge
       if it can handle symlinks if the file is a symlink, if it can handle
       binary files if the file is binary, and if a GUI is available if the tool
       requires a GUI.
   
       There are some internal merge tools which can be used. The internal merge
       tools are:
   
       ":dump"
         Creates three versions of the files to merge, containing the contents of
         local, other and base. These files can then be used to perform a merge
         manually. If the file to be merged is named "a.txt", these files will
         accordingly be named "a.txt.local", "a.txt.other" and "a.txt.base" and
         they will be placed in the same directory as "a.txt".
   
         This implies premerge. Therefore, files aren't dumped, if premerge runs
         successfully. Use :forcedump to forcibly write files out.
   
         (actual capabilities: binary, symlink)
   
       ":fail"
         Rather than attempting to merge files that were modified on both
         branches, it marks them as unresolved. The resolve command must be used
         to resolve these conflicts.
   
         (actual capabilities: binary, symlink)
   
       ":forcedump"
         Creates three versions of the files as same as :dump, but omits
         premerge.
   
         (actual capabilities: binary, symlink)
   
       ":local"
         Uses the local 'p1()' version of files as the merged version.
   
         (actual capabilities: binary, symlink)
   
       ":merge"
         Uses the internal non-interactive simple merge algorithm for merging
         files. It will fail if there are any conflicts and leave markers in the
         partially merged file. Markers will have two sections, one for each side
         of merge.
   
       ":merge-local"
         Like :merge, but resolve all conflicts non-interactively in favor of the
         local 'p1()' changes.
   
       ":merge-other"
         Like :merge, but resolve all conflicts non-interactively in favor of the
         other 'p2()' changes.
   
       ":merge3"
         Uses the internal non-interactive simple merge algorithm for merging
         files. It will fail if there are any conflicts and leave markers in the
         partially merged file. Marker will have three sections, one from each
         side of the merge and one for the base content.
   
       ":mergediff"
         Uses the internal non-interactive simple merge algorithm for merging
         files. It will fail if there are any conflicts and leave markers in the
         partially merged file. The marker will have two sections, one with the
         content from one side of the merge, and one with a diff from the base
         content to the content on the other side. (experimental)
   
       ":other"
         Uses the other 'p2()' version of files as the merged version.
   
         (actual capabilities: binary, symlink)
   
       ":prompt"
         Asks the user which of the local 'p1()' or the other 'p2()' version to
         keep as the merged version.
   
         (actual capabilities: binary, symlink)
   
       ":tagmerge"
         Uses the internal tag merge algorithm (experimental).
   
       ":union"
         Uses the internal non-interactive simple merge algorithm for merging
         files. It will use both local and other sides for conflict regions by
         adding local on top of other. No markers are inserted.
   
       ":union-other-first"
         Like :union, but add other on top of local.
   
       Internal tools are always available and do not require a GUI but will by
       default not handle symlinks or binary files. See next section for detail
       about "actual capabilities" described above.
   
       Choosing a merge tool
       =====================
   
       Mercurial uses these rules when deciding which merge tool to use:
   
       1. If a tool has been specified with the --tool option to merge or
          resolve, it is used.  If it is the name of a tool in the merge-tools
          configuration, its configuration is used. Otherwise the specified tool
          must be executable by the shell.
       2. If the "HGMERGE" environment variable is present, its value is used and
          must be executable by the shell.
       3. If the filename of the file to be merged matches any of the patterns in
          the merge-patterns configuration section, the first usable merge tool
          corresponding to a matching pattern is used.
       4. If ui.merge is set it will be considered next. If the value is not the
          name of a configured tool, the specified value is used and must be
          executable by the shell. Otherwise the named tool is used if it is
          usable.
       5. If any usable merge tools are present in the merge-tools configuration
          section, the one with the highest priority is used.
       6. If a program named "hgmerge" can be found on the system, it is used -
          but it will by default not be used for symlinks and binary files.
       7. If the file to be merged is not binary and is not a symlink, then
          internal ":merge" is used.
       8. Otherwise, ":prompt" is used.
   
       For historical reason, Mercurial treats merge tools as below while
       examining rules above.
   
       step specified via  binary symlink
       ----------------------------------
       1.   --tool         o/o    o/o
       2.   HGMERGE        o/o    o/o
       3.   merge-patterns o/o(*) x/?(*)
       4.   ui.merge       x/?(*) x/?(*)
   
       Each capability column indicates Mercurial behavior for internal/external
       merge tools at examining each rule.
   
       - "o": "assume that a tool has capability"
       - "x": "assume that a tool does not have capability"
       - "?": "check actual capability of a tool"
   
       If "merge.strict-capability-check" configuration is true, Mercurial checks
       capabilities of merge tools strictly in (*) cases above (= each capability
       column becomes "?/?"). It is false by default for backward compatibility.
   
       Note:
          After selecting a merge program, Mercurial will by default attempt to
          merge the files using a simple merge algorithm first. Only if it
          doesn't succeed because of conflicting changes will Mercurial actually
          execute the merge program. Whether to use the simple merge algorithm
          first can be controlled by the premerge setting of the merge tool.
          Premerge is enabled by default unless the file is binary or a symlink.
   
       See the merge-tools and ui sections of hgrc(5) for details on the
       configuration of merge tools.
 
 Compression engines listed in `hg help bundlespec`
 
   $ hg help bundlespec | grep gzip
           "v1" bundles can only use the "gzip", "bzip2", and "none" compression
         An algorithm that produces smaller bundles than "gzip".
         This engine will likely produce smaller bundles than "gzip" but will be
       "gzip"
         better compression than "gzip". It also frequently yields better (?)
 
 Test usage of section marks in help documents
 
   $ cd "$TESTDIR"/../doc
   $ "$PYTHON" check-seclevel.py
   $ cd $TESTTMP
 
 #if serve
 
 Test the help pages in hgweb.
 
 Dish up an empty repo; serve it cold.
 
   $ hg init "$TESTTMP/test"
   $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
   $ cat hg.pid >> $DAEMON_PIDS
 
   $ get-with-headers.py $LOCALIP:$HGPORT "help"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: Index</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="https://mercurial-scm.org/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
   <li class="active">help</li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
   <div id="hint">Find changesets by keywords (author, files, the commit message), revision
   number or hash, or <a href="/help/revsets">revset expression</a>.</div>
   </form>
   <table class="bigtable">
   <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
   
   <tr><td>
   <a href="/help/bundlespec">
   bundlespec
   </a>
   </td><td>
   Bundle File Formats
   </td></tr>
   <tr><td>
   <a href="/help/color">
   color
   </a>
   </td><td>
   Colorizing Outputs
   </td></tr>
   <tr><td>
   <a href="/help/config">
   config
   </a>
   </td><td>
   Configuration Files
   </td></tr>
   <tr><td>
   <a href="/help/dates">
   dates
   </a>
   </td><td>
   Date Formats
   </td></tr>
   <tr><td>
   <a href="/help/deprecated">
   deprecated
   </a>
   </td><td>
   Deprecated Features
   </td></tr>
   <tr><td>
   <a href="/help/diffs">
   diffs
   </a>
   </td><td>
   Diff Formats
   </td></tr>
   <tr><td>
   <a href="/help/environment">
   environment
   </a>
   </td><td>
   Environment Variables
   </td></tr>
   <tr><td>
   <a href="/help/evolution">
   evolution
   </a>
   </td><td>
   Safely rewriting history (EXPERIMENTAL)
   </td></tr>
   <tr><td>
   <a href="/help/extensions">
   extensions
   </a>
   </td><td>
   Using Additional Features
   </td></tr>
   <tr><td>
   <a href="/help/filesets">
   filesets
   </a>
   </td><td>
   Specifying File Sets
   </td></tr>
   <tr><td>
   <a href="/help/flags">
   flags
   </a>
   </td><td>
   Command-line flags
   </td></tr>
   <tr><td>
   <a href="/help/glossary">
   glossary
   </a>
   </td><td>
   Glossary
   </td></tr>
   <tr><td>
   <a href="/help/hgignore">
   hgignore
   </a>
   </td><td>
   Syntax for Mercurial Ignore Files
   </td></tr>
   <tr><td>
   <a href="/help/hgweb">
   hgweb
   </a>
   </td><td>
   Configuring hgweb
   </td></tr>
   <tr><td>
   <a href="/help/internals">
   internals
   </a>
   </td><td>
   Technical implementation topics
   </td></tr>
   <tr><td>
   <a href="/help/merge-tools">
   merge-tools
   </a>
   </td><td>
   Merge Tools
   </td></tr>
   <tr><td>
   <a href="/help/pager">
   pager
   </a>
   </td><td>
   Pager Support
   </td></tr>
   <tr><td>
   <a href="/help/patterns">
   patterns
   </a>
   </td><td>
   File Name Patterns
   </td></tr>
   <tr><td>
   <a href="/help/phases">
   phases
   </a>
   </td><td>
   Working with Phases
   </td></tr>
   <tr><td>
   <a href="/help/revisions">
   revisions
   </a>
   </td><td>
   Specifying Revisions
   </td></tr>
   <tr><td>
   <a href="/help/rust">
   rust
   </a>
   </td><td>
   Rust in Mercurial
   </td></tr>
   <tr><td>
   <a href="/help/scripting">
   scripting
   </a>
   </td><td>
   Using Mercurial from scripts and automation
   </td></tr>
   <tr><td>
   <a href="/help/subrepos">
   subrepos
   </a>
   </td><td>
   Subrepositories
   </td></tr>
   <tr><td>
   <a href="/help/templating">
   templating
   </a>
   </td><td>
   Template Usage
   </td></tr>
   <tr><td>
   <a href="/help/urls">
   urls
   </a>
   </td><td>
   URL Paths
   </td></tr>
   <tr><td>
   <a href="/help/topic-containing-verbose">
   topic-containing-verbose
   </a>
   </td><td>
   This is the topic to test omit indicating.
   </td></tr>
   
   
   <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
   
   <tr><td>
   <a href="/help/abort">
   abort
   </a>
   </td><td>
   abort an unfinished operation (EXPERIMENTAL)
   </td></tr>
   <tr><td>
   <a href="/help/add">
   add
   </a>
   </td><td>
   add the specified files on the next commit
   </td></tr>
   <tr><td>
   <a href="/help/annotate">
   annotate
   </a>
   </td><td>
   show changeset information by line for each file
   </td></tr>
   <tr><td>
   <a href="/help/clone">
   clone
   </a>
   </td><td>
   make a copy of an existing repository
   </td></tr>
   <tr><td>
   <a href="/help/commit">
   commit
   </a>
   </td><td>
   commit the specified files or all outstanding changes
   </td></tr>
   <tr><td>
   <a href="/help/continue">
   continue
   </a>
   </td><td>
   resumes an interrupted operation (EXPERIMENTAL)
   </td></tr>
   <tr><td>
   <a href="/help/diff">
   diff
   </a>
   </td><td>
   diff repository (or selected files)
   </td></tr>
   <tr><td>
   <a href="/help/export">
   export
   </a>
   </td><td>
   dump the header and diffs for one or more changesets
   </td></tr>
   <tr><td>
   <a href="/help/forget">
   forget
   </a>
   </td><td>
   forget the specified files on the next commit
   </td></tr>
   <tr><td>
   <a href="/help/init">
   init
   </a>
   </td><td>
   create a new repository in the given directory
   </td></tr>
   <tr><td>
   <a href="/help/log">
   log
   </a>
   </td><td>
   show revision history of entire repository or files
   </td></tr>
   <tr><td>
   <a href="/help/merge">
   merge
   </a>
   </td><td>
   merge another revision into working directory
   </td></tr>
   <tr><td>
   <a href="/help/pull">
   pull
   </a>
   </td><td>
   pull changes from the specified source
   </td></tr>
   <tr><td>
   <a href="/help/push">
   push
   </a>
   </td><td>
   push changes to the specified destination
   </td></tr>
   <tr><td>
   <a href="/help/remove">
   remove
   </a>
   </td><td>
   remove the specified files on the next commit
   </td></tr>
   <tr><td>
   <a href="/help/serve">
   serve
   </a>
   </td><td>
   start stand-alone webserver
   </td></tr>
   <tr><td>
   <a href="/help/status">
   status
   </a>
   </td><td>
   show changed files in the working directory
   </td></tr>
   <tr><td>
   <a href="/help/summary">
   summary
   </a>
   </td><td>
   summarize working directory state
   </td></tr>
   <tr><td>
   <a href="/help/update">
   update
   </a>
   </td><td>
   update working directory (or switch revisions)
   </td></tr>
   
   
   
   <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
   
   <tr><td>
   <a href="/help/addremove">
   addremove
   </a>
   </td><td>
   add all new files, delete all missing files
   </td></tr>
   <tr><td>
   <a href="/help/archive">
   archive
   </a>
   </td><td>
   create an unversioned archive of a repository revision
   </td></tr>
   <tr><td>
   <a href="/help/backout">
   backout
   </a>
   </td><td>
   reverse effect of earlier changeset
   </td></tr>
   <tr><td>
   <a href="/help/bisect">
   bisect
   </a>
   </td><td>
   subdivision search of changesets
   </td></tr>
   <tr><td>
   <a href="/help/bookmarks">
   bookmarks
   </a>
   </td><td>
   create a new bookmark or list existing bookmarks
   </td></tr>
   <tr><td>
   <a href="/help/branch">
   branch
   </a>
   </td><td>
   set or show the current branch name
   </td></tr>
   <tr><td>
   <a href="/help/branches">
   branches
   </a>
   </td><td>
   list repository named branches
   </td></tr>
   <tr><td>
   <a href="/help/bundle">
   bundle
   </a>
   </td><td>
   create a bundle file
   </td></tr>
   <tr><td>
   <a href="/help/cat">
   cat
   </a>
   </td><td>
   output the current or given revision of files
   </td></tr>
   <tr><td>
   <a href="/help/config">
   config
   </a>
   </td><td>
   show combined config settings from all hgrc files
   </td></tr>
   <tr><td>
   <a href="/help/copy">
   copy
   </a>
   </td><td>
   mark files as copied for the next commit
   </td></tr>
   <tr><td>
   <a href="/help/files">
   files
   </a>
   </td><td>
   list tracked files
   </td></tr>
   <tr><td>
   <a href="/help/graft">
   graft
   </a>
   </td><td>
   copy changes from other branches onto the current branch
   </td></tr>
   <tr><td>
   <a href="/help/grep">
   grep
   </a>
   </td><td>
   search for a pattern in specified files
   </td></tr>
   <tr><td>
   <a href="/help/hashelp">
   hashelp
   </a>
   </td><td>
   Extension command's help
   </td></tr>
   <tr><td>
   <a href="/help/heads">
   heads
   </a>
   </td><td>
   show branch heads
   </td></tr>
   <tr><td>
   <a href="/help/help">
   help
   </a>
   </td><td>
   show help for a given topic or a help overview
   </td></tr>
   <tr><td>
   <a href="/help/hgalias">
   hgalias
   </a>
   </td><td>
   My doc
   </td></tr>
   <tr><td>
   <a href="/help/hgaliasnodoc">
   hgaliasnodoc
   </a>
   </td><td>
   summarize working directory state
   </td></tr>
   <tr><td>
   <a href="/help/identify">
   identify
   </a>
   </td><td>
   identify the working directory or specified revision
   </td></tr>
   <tr><td>
   <a href="/help/import">
   import
   </a>
   </td><td>
   import an ordered set of patches
   </td></tr>
   <tr><td>
   <a href="/help/incoming">
   incoming
   </a>
   </td><td>
   show new changesets found in source
   </td></tr>
   <tr><td>
   <a href="/help/manifest">
   manifest
   </a>
   </td><td>
   output the current or given revision of the project manifest
   </td></tr>
   <tr><td>
   <a href="/help/nohelp">
   nohelp
   </a>
   </td><td>
   (no help text available)
   </td></tr>
   <tr><td>
   <a href="/help/outgoing">
   outgoing
   </a>
   </td><td>
   show changesets not found in the destination
   </td></tr>
   <tr><td>
   <a href="/help/paths">
   paths
   </a>
   </td><td>
   show aliases for remote repositories
   </td></tr>
   <tr><td>
   <a href="/help/phase">
   phase
   </a>
   </td><td>
   set or show the current phase name
   </td></tr>
   <tr><td>
   <a href="/help/purge">
   purge
   </a>
   </td><td>
   removes files not tracked by Mercurial
   </td></tr>
   <tr><td>
   <a href="/help/recover">
   recover
   </a>
   </td><td>
   roll back an interrupted transaction
   </td></tr>
   <tr><td>
   <a href="/help/rename">
   rename
   </a>
   </td><td>
   rename files; equivalent of copy + remove
   </td></tr>
   <tr><td>
   <a href="/help/resolve">
   resolve
   </a>
   </td><td>
   redo merges or set/view the merge status of files
   </td></tr>
   <tr><td>
   <a href="/help/revert">
   revert
   </a>
   </td><td>
   restore files to their checkout state
   </td></tr>
   <tr><td>
   <a href="/help/root">
   root
   </a>
   </td><td>
   print the root (top) of the current working directory
   </td></tr>
   <tr><td>
   <a href="/help/shellalias">
   shellalias
   </a>
   </td><td>
   (no help text available)
   </td></tr>
   <tr><td>
   <a href="/help/shelve">
   shelve
   </a>
   </td><td>
   save and set aside changes from the working directory
   </td></tr>
   <tr><td>
   <a href="/help/tag">
   tag
   </a>
   </td><td>
   add one or more tags for the current or given revision
   </td></tr>
   <tr><td>
   <a href="/help/tags">
   tags
   </a>
   </td><td>
   list repository tags
   </td></tr>
   <tr><td>
   <a href="/help/unbundle">
   unbundle
   </a>
   </td><td>
   apply one or more bundle files
   </td></tr>
   <tr><td>
   <a href="/help/unshelve">
   unshelve
   </a>
   </td><td>
   restore a shelved change to the working directory
   </td></tr>
   <tr><td>
   <a href="/help/verify">
   verify
   </a>
   </td><td>
   verify the integrity of the repository
   </td></tr>
   <tr><td>
   <a href="/help/version">
   version
   </a>
   </td><td>
   output version and copyright information
   </td></tr>
   
   
   </table>
   </div>
   </div>
   
   
   
   </body>
   </html>
   
 
   $ get-with-headers.py $LOCALIP:$HGPORT "help/add"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: add</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="https://mercurial-scm.org/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
    <li class="active"><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <h3>Help: add</h3>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
   <div id="hint">Find changesets by keywords (author, files, the commit message), revision
   number or hash, or <a href="/help/revsets">revset expression</a>.</div>
   </form>
   <div id="doc">
   <p>
   hg add [OPTION]... [FILE]...
   </p>
   <p>
   add the specified files on the next commit
   </p>
   <p>
   Schedule files to be version controlled and added to the
   repository.
   </p>
   <p>
   The files will be added to the repository at the next commit. To
   undo an add before that, see 'hg forget'.
   </p>
   <p>
   If no names are given, add all files to the repository (except
   files matching &quot;.hgignore&quot;).
   </p>
   <p>
   Examples:
   </p>
   <ul>
    <li> New (unknown) files are added   automatically by 'hg add':
   <pre>
   \$ ls (re)
   foo.c
   \$ hg status (re)
   ? foo.c
   \$ hg add (re)
   adding foo.c
   \$ hg status (re)
   A foo.c
   </pre>
    <li> Specific files to be added can be specified:
   <pre>
   \$ ls (re)
   bar.c  foo.c
   \$ hg status (re)
   ? bar.c
   ? foo.c
   \$ hg add bar.c (re)
   \$ hg status (re)
   A bar.c
   ? foo.c
   </pre>
   </ul>
   <p>
   Returns 0 if all files are successfully added.
   </p>
   <p>
   options ([+] can be repeated):
   </p>
   <table>
   <tr><td>-I</td>
   <td>--include PATTERN [+]</td>
   <td>include names matching the given patterns</td></tr>
   <tr><td>-X</td>
   <td>--exclude PATTERN [+]</td>
   <td>exclude names matching the given patterns</td></tr>
   <tr><td>-S</td>
   <td>--subrepos</td>
   <td>recurse into subrepositories</td></tr>
   <tr><td>-n</td>
   <td>--dry-run</td>
   <td>do not perform actions, just print output</td></tr>
   </table>
   <p>
   global options ([+] can be repeated):
   </p>
   <table>
   <tr><td>-R</td>
   <td>--repository REPO</td>
   <td>repository root directory or name of overlay bundle file</td></tr>
   <tr><td></td>
   <td>--cwd DIR</td>
   <td>change working directory</td></tr>
   <tr><td>-y</td>
   <td>--noninteractive</td>
   <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
   <tr><td>-q</td>
   <td>--quiet</td>
   <td>suppress output</td></tr>
   <tr><td>-v</td>
   <td>--verbose</td>
   <td>enable additional output</td></tr>
   <tr><td></td>
   <td>--color TYPE</td>
   <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
   <tr><td></td>
   <td>--config CONFIG [+]</td>
   <td>set/override config option (use 'section.name=value')</td></tr>
   <tr><td></td>
   <td>--debug</td>
   <td>enable debugging output</td></tr>
   <tr><td></td>
   <td>--debugger</td>
   <td>start debugger</td></tr>
   <tr><td></td>
   <td>--encoding ENCODE</td>
   <td>set the charset encoding (default: ascii)</td></tr>
   <tr><td></td>
   <td>--encodingmode MODE</td>
   <td>set the charset encoding mode (default: strict)</td></tr>
   <tr><td></td>
   <td>--traceback</td>
   <td>always print a traceback on exception</td></tr>
   <tr><td></td>
   <td>--time</td>
   <td>time how long the command takes</td></tr>
   <tr><td></td>
   <td>--profile</td>
   <td>print command execution profile</td></tr>
   <tr><td></td>
   <td>--version</td>
   <td>output version information and exit</td></tr>
   <tr><td>-h</td>
   <td>--help</td>
   <td>display help and exit</td></tr>
   <tr><td></td>
   <td>--hidden</td>
   <td>consider hidden changesets</td></tr>
   <tr><td></td>
   <td>--pager TYPE</td>
   <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
   </table>
   
   </div>
   </div>
   </div>
   
   
   
   </body>
   </html>
   
 
   $ get-with-headers.py $LOCALIP:$HGPORT "help/remove"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: remove</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="https://mercurial-scm.org/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
    <li class="active"><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <h3>Help: remove</h3>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
   <div id="hint">Find changesets by keywords (author, files, the commit message), revision
   number or hash, or <a href="/help/revsets">revset expression</a>.</div>
   </form>
   <div id="doc">
   <p>
   hg remove [OPTION]... FILE...
   </p>
   <p>
   aliases: rm
   </p>
   <p>
   remove the specified files on the next commit
   </p>
   <p>
   Schedule the indicated files for removal from the current branch.
   </p>
   <p>
   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'.
   </p>
   <p>
   -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.
   </p>
   <p>
   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):
   </p>
   <table>
   <tr><td>opt/state</td>
   <td>A</td>
   <td>C</td>
   <td>M</td>
   <td>!</td></tr>
   <tr><td>none</td>
   <td>W</td>
   <td>RD</td>
   <td>W</td>
   <td>R</td></tr>
   <tr><td>-f</td>
   <td>R</td>
   <td>RD</td>
   <td>RD</td>
   <td>R</td></tr>
   <tr><td>-A</td>
   <td>W</td>
   <td>W</td>
   <td>W</td>
   <td>R</td></tr>
   <tr><td>-Af</td>
   <td>R</td>
   <td>R</td>
   <td>R</td>
   <td>R</td></tr>
   </table>
   <p>
   <b>Note:</b> 
   </p>
   <p>
   'hg remove' never deletes files in Added [A] state from the
   working directory, not even if &quot;--force&quot; is specified.
   </p>
   <p>
   Returns 0 on success, 1 if any warnings encountered.
   </p>
   <p>
   options ([+] can be repeated):
   </p>
   <table>
   <tr><td>-A</td>
   <td>--after</td>
   <td>record delete for missing files</td></tr>
   <tr><td>-f</td>
   <td>--force</td>
   <td>forget added files, delete modified files</td></tr>
   <tr><td>-S</td>
   <td>--subrepos</td>
   <td>recurse into subrepositories</td></tr>
   <tr><td>-I</td>
   <td>--include PATTERN [+]</td>
   <td>include names matching the given patterns</td></tr>
   <tr><td>-X</td>
   <td>--exclude PATTERN [+]</td>
   <td>exclude names matching the given patterns</td></tr>
   <tr><td>-n</td>
   <td>--dry-run</td>
   <td>do not perform actions, just print output</td></tr>
   </table>
   <p>
   global options ([+] can be repeated):
   </p>
   <table>
   <tr><td>-R</td>
   <td>--repository REPO</td>
   <td>repository root directory or name of overlay bundle file</td></tr>
   <tr><td></td>
   <td>--cwd DIR</td>
   <td>change working directory</td></tr>
   <tr><td>-y</td>
   <td>--noninteractive</td>
   <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
   <tr><td>-q</td>
   <td>--quiet</td>
   <td>suppress output</td></tr>
   <tr><td>-v</td>
   <td>--verbose</td>
   <td>enable additional output</td></tr>
   <tr><td></td>
   <td>--color TYPE</td>
   <td>when to colorize (boolean, always, auto, never, or debug)</td></tr>
   <tr><td></td>
   <td>--config CONFIG [+]</td>
   <td>set/override config option (use 'section.name=value')</td></tr>
   <tr><td></td>
   <td>--debug</td>
   <td>enable debugging output</td></tr>
   <tr><td></td>
   <td>--debugger</td>
   <td>start debugger</td></tr>
   <tr><td></td>
   <td>--encoding ENCODE</td>
   <td>set the charset encoding (default: ascii)</td></tr>
   <tr><td></td>
   <td>--encodingmode MODE</td>
   <td>set the charset encoding mode (default: strict)</td></tr>
   <tr><td></td>
   <td>--traceback</td>
   <td>always print a traceback on exception</td></tr>
   <tr><td></td>
   <td>--time</td>
   <td>time how long the command takes</td></tr>
   <tr><td></td>
   <td>--profile</td>
   <td>print command execution profile</td></tr>
   <tr><td></td>
   <td>--version</td>
   <td>output version information and exit</td></tr>
   <tr><td>-h</td>
   <td>--help</td>
   <td>display help and exit</td></tr>
   <tr><td></td>
   <td>--hidden</td>
   <td>consider hidden changesets</td></tr>
   <tr><td></td>
   <td>--pager TYPE</td>
   <td>when to paginate (boolean, always, auto, or never) (default: auto)</td></tr>
   </table>
   
   </div>
   </div>
   </div>
   
   
   
   </body>
   </html>
   
 
   $ get-with-headers.py $LOCALIP:$HGPORT "help/dates"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: dates</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="https://mercurial-scm.org/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
    <li class="active"><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <h3>Help: dates</h3>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
   <div id="hint">Find changesets by keywords (author, files, the commit message), revision
   number or hash, or <a href="/help/revsets">revset expression</a>.</div>
   </form>
   <div id="doc">
   <h1>Date Formats</h1>
   <p>
   Some commands allow the user to specify a date, e.g.:
   </p>
   <ul>
    <li> backout, commit, import, tag: Specify the commit date.
    <li> log, revert, update: Select revision(s) by date.
   </ul>
   <p>
   Many date formats are valid. Here are some examples:
   </p>
   <ul>
    <li> &quot;Wed Dec 6 13:18:29 2006&quot; (local timezone assumed)
    <li> &quot;Dec 6 13:18 -0600&quot; (year assumed, time offset provided)
    <li> &quot;Dec 6 13:18 UTC&quot; (UTC and GMT are aliases for +0000)
    <li> &quot;Dec 6&quot; (midnight)
    <li> &quot;13:18&quot; (today assumed)
    <li> &quot;3:39&quot; (3:39AM assumed)
    <li> &quot;3:39pm&quot; (15:39)
    <li> &quot;2006-12-06 13:18:29&quot; (ISO 8601 format)
    <li> &quot;2006-12-6 13:18&quot;
    <li> &quot;2006-12-6&quot;
    <li> &quot;12-6&quot;
    <li> &quot;12/6&quot;
    <li> &quot;12/6/6&quot; (Dec 6 2006)
    <li> &quot;today&quot; (midnight)
    <li> &quot;yesterday&quot; (midnight)
    <li> &quot;now&quot; - right now
   </ul>
   <p>
   Lastly, there is Mercurial's internal format:
   </p>
   <ul>
    <li> &quot;1165411109 0&quot; (Wed Dec 6 13:18:29 2006 UTC)
   </ul>
   <p>
   This is the internal representation format for dates. The first number
   is the number of seconds since the epoch (1970-01-01 00:00 UTC). The
   second is the offset of the local timezone, in seconds west of UTC
   (negative if the timezone is east of UTC).
   </p>
   <p>
   The log command also accepts date ranges:
   </p>
   <ul>
    <li> &quot;&lt;DATE&quot; - at or before a given date/time
    <li> &quot;&gt;DATE&quot; - on or after a given date/time
    <li> &quot;DATE to DATE&quot; - a date range, inclusive
    <li> &quot;-DAYS&quot; - within a given number of days from today
   </ul>
   
   </div>
   </div>
   </div>
   
   
   
   </body>
   </html>
   
 
   $ get-with-headers.py $LOCALIP:$HGPORT "help/pager"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: pager</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="https://mercurial-scm.org/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
    <li class="active"><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <h3>Help: pager</h3>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
   <div id="hint">Find changesets by keywords (author, files, the commit message), revision
   number or hash, or <a href="/help/revsets">revset expression</a>.</div>
   </form>
   <div id="doc">
   <h1>Pager Support</h1>
   <p>
   Some Mercurial commands can produce a lot of output, and Mercurial will
   attempt to use a pager to make those commands more pleasant.
   </p>
   <p>
   To set the pager that should be used, set the application variable:
   </p>
   <pre>
   [pager]
   pager = less -FRX
   </pre>
   <p>
   If no pager is set in the user or repository configuration, Mercurial uses the
   environment variable $PAGER. If $PAGER is not set, pager.pager from the default
   or system configuration is used. If none of these are set, a default pager will
   be used, typically 'less' on Unix and 'more' on Windows.
   </p>
   <p>
   You can disable the pager for certain commands by adding them to the
   pager.ignore list:
   </p>
   <pre>
   [pager]
   ignore = version, help, update
   </pre>
   <p>
   To ignore global commands like 'hg version' or 'hg help', you have
   to specify them in your user configuration file.
   </p>
   <p>
   To control whether the pager is used at all for an individual command,
   you can use --pager=&lt;value&gt;:
   </p>
   <ul>
    <li> use as needed: 'auto'.
    <li> require the pager: 'yes' or 'on'.
    <li> suppress the pager: 'no' or 'off' (any unrecognized value   will also work).
   </ul>
   <p>
   To globally turn off all attempts to use a pager, set:
   </p>
   <pre>
   [ui]
   paginate = never
   </pre>
   <p>
   which will prevent the pager from running.
   </p>
   
   </div>
   </div>
   </div>
   
   
   
   </body>
   </html>
   
 
 Sub-topic indexes rendered properly
 
   $ get-with-headers.py $LOCALIP:$HGPORT "help/internals"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: internals</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="https://mercurial-scm.org/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
   <li><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
   <div id="hint">Find changesets by keywords (author, files, the commit message), revision
   number or hash, or <a href="/help/revsets">revset expression</a>.</div>
   </form>
   <table class="bigtable">
   <tr><td colspan="2"><h2><a name="topics" href="#topics">Topics</a></h2></td></tr>
   
   <tr><td>
   <a href="/help/internals.bid-merge">
   bid-merge
   </a>
   </td><td>
   Bid Merge Algorithm
   </td></tr>
   <tr><td>
   <a href="/help/internals.bundle2">
   bundle2
   </a>
   </td><td>
   Bundle2
   </td></tr>
   <tr><td>
   <a href="/help/internals.bundles">
   bundles
   </a>
   </td><td>
   Bundles
   </td></tr>
   <tr><td>
   <a href="/help/internals.cbor">
   cbor
   </a>
   </td><td>
   CBOR
   </td></tr>
   <tr><td>
   <a href="/help/internals.censor">
   censor
   </a>
   </td><td>
   Censor
   </td></tr>
   <tr><td>
   <a href="/help/internals.changegroups">
   changegroups
   </a>
   </td><td>
   Changegroups
   </td></tr>
   <tr><td>
   <a href="/help/internals.config">
   config
   </a>
   </td><td>
   Config Registrar
   </td></tr>
   <tr><td>
   <a href="/help/internals.dirstate-v2">
   dirstate-v2
   </a>
   </td><td>
   dirstate-v2 file format
   </td></tr>
   <tr><td>
   <a href="/help/internals.extensions">
   extensions
   </a>
   </td><td>
   Extension API
   </td></tr>
   <tr><td>
   <a href="/help/internals.mergestate">
   mergestate
   </a>
   </td><td>
   Mergestate
   </td></tr>
   <tr><td>
   <a href="/help/internals.requirements">
   requirements
   </a>
   </td><td>
   Repository Requirements
   </td></tr>
   <tr><td>
   <a href="/help/internals.revlogs">
   revlogs
   </a>
   </td><td>
   Revision Logs
   </td></tr>
   <tr><td>
   <a href="/help/internals.wireprotocol">
   wireprotocol
   </a>
   </td><td>
   Wire Protocol
   </td></tr>
   <tr><td>
   <a href="/help/internals.wireprotocolrpc">
   wireprotocolrpc
   </a>
   </td><td>
   Wire Protocol RPC
   </td></tr>
   <tr><td>
   <a href="/help/internals.wireprotocolv2">
   wireprotocolv2
   </a>
   </td><td>
   Wire Protocol Version 2
   </td></tr>
   
   
   
   
   
   </table>
   </div>
   </div>
   
   
   
   </body>
   </html>
   
 
 Sub-topic topics rendered properly
 
   $ get-with-headers.py $LOCALIP:$HGPORT "help/internals.changegroups"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: internals.changegroups</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="https://mercurial-scm.org/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
    <li class="active"><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <h3>Help: internals.changegroups</h3>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
   <div id="hint">Find changesets by keywords (author, files, the commit message), revision
   number or hash, or <a href="/help/revsets">revset expression</a>.</div>
   </form>
   <div id="doc">
   <h1>Changegroups</h1>
   <p>
   Changegroups are representations of repository revlog data, specifically
   the changelog data, root/flat manifest data, treemanifest data, and
   filelogs.
   </p>
   <p>
   There are 4 versions of changegroups: &quot;1&quot;, &quot;2&quot;, &quot;3&quot; and &quot;4&quot;. From a
   high-level, versions &quot;1&quot; and &quot;2&quot; are almost exactly the same, with the
   only difference being an additional item in the *delta header*. Version
   &quot;3&quot; adds support for storage flags in the *delta header* and optionally
   exchanging treemanifests (enabled by setting an option on the
   &quot;changegroup&quot; part in the bundle2). Version &quot;4&quot; adds support for exchanging
   sidedata (additional revision metadata not part of the digest).
   </p>
   <p>
   Changegroups when not exchanging treemanifests consist of 3 logical
   segments:
   </p>
   <pre>
   +---------------------------------+
   |           |          |          |
   | changeset | manifest | filelogs |
   |           |          |          |
   |           |          |          |
   +---------------------------------+
   </pre>
   <p>
   When exchanging treemanifests, there are 4 logical segments:
   </p>
   <pre>
   +-------------------------------------------------+
   |           |          |               |          |
   | changeset |   root   | treemanifests | filelogs |
   |           | manifest |               |          |
   |           |          |               |          |
   +-------------------------------------------------+
   </pre>
   <p>
   The principle building block of each segment is a *chunk*. A *chunk*
   is a framed piece of data:
   </p>
   <pre>
   +---------------------------------------+
   |           |                           |
   |  length   |           data            |
   | (4 bytes) |   (&lt;length - 4&gt; bytes)    |
   |           |                           |
   +---------------------------------------+
   </pre>
   <p>
   All integers are big-endian signed integers. Each chunk starts with a 32-bit
   integer indicating the length of the entire chunk (including the length field
   itself).
   </p>
   <p>
   There is a special case chunk that has a value of 0 for the length
   (&quot;0x00000000&quot;). We call this an *empty chunk*.
   </p>
   <h2>Delta Groups</h2>
   <p>
   A *delta group* expresses the content of a revlog as a series of deltas,
   or patches against previous revisions.
   </p>
   <p>
   Delta groups consist of 0 or more *chunks* followed by the *empty chunk*
   to signal the end of the delta group:
   </p>
   <pre>
   +------------------------------------------------------------------------+
   |                |             |               |             |           |
   | chunk0 length  | chunk0 data | chunk1 length | chunk1 data |    0x0    |
   |   (4 bytes)    |  (various)  |   (4 bytes)   |  (various)  | (4 bytes) |
   |                |             |               |             |           |
   +------------------------------------------------------------------------+
   </pre>
   <p>
   Each *chunk*'s data consists of the following:
   </p>
   <pre>
   +---------------------------------------+
   |                        |              |
   |     delta header       |  delta data  |
   |  (various by version)  |  (various)   |
   |                        |              |
   +---------------------------------------+
   </pre>
   <p>
   The *delta data* is a series of *delta*s that describe a diff from an existing
   entry (either that the recipient already has, or previously specified in the
   bundle/changegroup).
   </p>
   <p>
   The *delta header* is different between versions &quot;1&quot;, &quot;2&quot;, &quot;3&quot; and &quot;4&quot;
   of the changegroup format.
   </p>
   <p>
   Version 1 (headerlen=80):
   </p>
   <pre>
   +------------------------------------------------------+
   |            |             |             |             |
   |    node    |   p1 node   |   p2 node   |  link node  |
   | (20 bytes) |  (20 bytes) |  (20 bytes) |  (20 bytes) |
   |            |             |             |             |
   +------------------------------------------------------+
   </pre>
   <p>
   Version 2 (headerlen=100):
   </p>
   <pre>
   +------------------------------------------------------------------+
   |            |             |             |            |            |
   |    node    |   p1 node   |   p2 node   | base node  | link node  |
   | (20 bytes) |  (20 bytes) |  (20 bytes) | (20 bytes) | (20 bytes) |
   |            |             |             |            |            |
   +------------------------------------------------------------------+
   </pre>
   <p>
   Version 3 (headerlen=102):
   </p>
   <pre>
   +------------------------------------------------------------------------------+
   |            |             |             |            |            |           |
   |    node    |   p1 node   |   p2 node   | base node  | link node  |   flags   |
   | (20 bytes) |  (20 bytes) |  (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) |
   |            |             |             |            |            |           |
   +------------------------------------------------------------------------------+
   </pre>
   <p>
   Version 4 (headerlen=103):
   </p>
   <pre>
   +------------------------------------------------------------------------------+----------+
   |            |             |             |            |            |           |          |
   |    node    |   p1 node   |   p2 node   | base node  | link node  |   flags   |  pflags  |
   | (20 bytes) |  (20 bytes) |  (20 bytes) | (20 bytes) | (20 bytes) | (2 bytes) | (1 byte) |
   |            |             |             |            |            |           |          |
   +------------------------------------------------------------------------------+----------+
   </pre>
   <p>
   The *delta data* consists of &quot;chunklen - 4 - headerlen&quot; bytes, which contain a
   series of *delta*s, densely packed (no separators). These deltas describe a diff
   from an existing entry (either that the recipient already has, or previously
   specified in the bundle/changegroup). The format is described more fully in
   &quot;hg help internals.bdiff&quot;, but briefly:
   </p>
   <pre>
   +---------------------------------------------------------------+
   |              |            |            |                      |
   | start offset | end offset | new length |        content       |
   |  (4 bytes)   |  (4 bytes) |  (4 bytes) | (&lt;new length&gt; bytes) |
   |              |            |            |                      |
   +---------------------------------------------------------------+
   </pre>
   <p>
   Please note that the length field in the delta data does *not* include itself.
   </p>
   <p>
   In version 1, the delta is always applied against the previous node from
   the changegroup or the first parent if this is the first entry in the
   changegroup.
   </p>
   <p>
   In version 2 and up, the delta base node is encoded in the entry in the
   changegroup. This allows the delta to be expressed against any parent,
   which can result in smaller deltas and more efficient encoding of data.
   </p>
   <p>
   The *flags* field holds bitwise flags affecting the processing of revision
   data. The following flags are defined:
   </p>
   <dl>
    <dt>32768
    <dd>Censored revision. The revision's fulltext has been replaced by censor metadata. May only occur on file revisions.
    <dt>16384
    <dd>Ellipsis revision. Revision hash does not match data (likely due to rewritten parents).
    <dt>8192
    <dd>Externally stored. The revision fulltext contains &quot;key:value&quot; &quot;\n&quot; delimited metadata defining an object stored elsewhere. Used by the LFS extension.
    <dt>4096
    <dd>Contains copy information. This revision changes files in a way that could affect copy tracing. This does *not* affect changegroup handling, but is relevant for other parts of Mercurial.
   </dl>
   <p>
   For historical reasons, the integer values are identical to revlog version 1
   per-revision storage flags and correspond to bits being set in this 2-byte
   field. Bits were allocated starting from the most-significant bit, hence the
   reverse ordering and allocation of these flags.
   </p>
   <p>
   The *pflags* (protocol flags) field holds bitwise flags affecting the protocol
   itself. They are first in the header since they may affect the handling of the
   rest of the fields in a future version. They are defined as such:
   </p>
   <dl>
    <dt>1 indicates whether to read a chunk of sidedata (of variable length) right
    <dd>after the revision flags.
   </dl>
   <h2>Changeset Segment</h2>
   <p>
   The *changeset segment* consists of a single *delta group* holding
   changelog data. The *empty chunk* at the end of the *delta group* denotes
   the boundary to the *manifest segment*.
   </p>
   <h2>Manifest Segment</h2>
   <p>
   The *manifest segment* consists of a single *delta group* holding manifest
   data. If treemanifests are in use, it contains only the manifest for the
   root directory of the repository. Otherwise, it contains the entire
   manifest data. The *empty chunk* at the end of the *delta group* denotes
   the boundary to the next segment (either the *treemanifests segment* or the
   *filelogs segment*, depending on version and the request options).
   </p>
   <h3>Treemanifests Segment</h3>
   <p>
   The *treemanifests segment* only exists in changegroup version &quot;3&quot; and &quot;4&quot;,
   and only if the 'treemanifest' param is part of the bundle2 changegroup part
   (it is not possible to use changegroup version 3 or 4 outside of bundle2).
   Aside from the filenames in the *treemanifests segment* containing a
   trailing &quot;/&quot; character, it behaves identically to the *filelogs segment*
   (see below). The final sub-segment is followed by an *empty chunk* (logically,
   a sub-segment with filename size 0). This denotes the boundary to the
   *filelogs segment*.
   </p>
   <h2>Filelogs Segment</h2>
   <p>
   The *filelogs segment* consists of multiple sub-segments, each
   corresponding to an individual file whose data is being described:
   </p>
   <pre>
   +--------------------------------------------------+
   |          |          |          |     |           |
   | filelog0 | filelog1 | filelog2 | ... |    0x0    |
   |          |          |          |     | (4 bytes) |
   |          |          |          |     |           |
   +--------------------------------------------------+
   </pre>
   <p>
   The final filelog sub-segment is followed by an *empty chunk* (logically,
   a sub-segment with filename size 0). This denotes the end of the segment
   and of the overall changegroup.
   </p>
   <p>
   Each filelog sub-segment consists of the following:
   </p>
   <pre>
   +------------------------------------------------------+
   |                 |                      |             |
   | filename length |       filename       | delta group |
   |    (4 bytes)    | (&lt;length - 4&gt; bytes) |  (various)  |
   |                 |                      |             |
   +------------------------------------------------------+
   </pre>
   <p>
   That is, a *chunk* consisting of the filename (not terminated or padded)
   followed by N chunks constituting the *delta group* for this file. The
   *empty chunk* at the end of each *delta group* denotes the boundary to the
   next filelog sub-segment.
   </p>
   
   </div>
   </div>
   </div>
   
   
   
   </body>
   </html>
   
 
   $ get-with-headers.py 127.0.0.1:$HGPORT "help/unknowntopic"
   404 Not Found
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>test: error</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="https://mercurial-scm.org/">
   <img src="/static/hglogo.png" width=75 height=90 border=0 alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
   <li><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <h3>error</h3>
   
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" value="" /></p>
   <div id="hint">Find changesets by keywords (author, files, the commit message), revision
   number or hash, or <a href="/help/revsets">revset expression</a>.</div>
   </form>
   
   <div class="description">
   <p>
   An error occurred while processing your request:
   </p>
   <p>
   Not Found
   </p>
   </div>
   </div>
   </div>
   
   
   
   </body>
   </html>
   
   [1]
 
   $ killdaemons.py
 
 #endif