help: supporting both help and doc for aliases

This allows an alias to be definted like:

[alias]
lj = log -Tjson
lj:help = [-r REV]
lj:doc = Shows the revision log in JSON format.

Differential Revision: https://phab.mercurial-scm.org/D2678

hgext/show.py

@@ -1,469 +1,469 b''
 # show.py - Extension implementing `hg show`
 #
 # Copyright 2017 Gregory Szorc <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 """unified command to show various repository information (EXPERIMENTAL)
 
 This extension provides the :hg:`show` command, which provides a central
 command for displaying commonly-accessed repository data and views of that
 data.
 
 The following config options can influence operation.
 
 ``commands``
 ------------
 
 ``show.aliasprefix``
    List of strings that will register aliases for views. e.g. ``s`` will
    effectively set config options ``alias.s<view> = show <view>`` for all
    views. i.e. `hg swork` would execute `hg show work`.
 
    Aliases that would conflict with existing registrations will not be
    performed.
 """
 
 from __future__ import absolute_import
 
 from mercurial.i18n import _
 from mercurial.node import (
     hex,
     nullrev,
 )
 from mercurial import (
     cmdutil,
     commands,
     destutil,
     error,
     formatter,
     graphmod,
     logcmdutil,
     phases,
     pycompat,
     registrar,
     revset,
     revsetlang,
 )
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
 # be specifying the version(s) of Mercurial they are tested with, or
 # leave the attribute unspecified.
 testedwith = 'ships-with-hg-core'
 
 cmdtable = {}
 command = registrar.command(cmdtable)
 
 revsetpredicate = registrar.revsetpredicate()
 
 class showcmdfunc(registrar._funcregistrarbase):
     """Register a function to be invoked for an `hg show <thing>`."""
 
     # Used by _formatdoc().
     _docformat = '%s -- %s'
 
     def _extrasetup(self, name, func, fmtopic=None, csettopic=None):
         """Called with decorator arguments to register a show view.
 
         ``name`` is the sub-command name.
 
         ``func`` is the function being decorated.
 
         ``fmtopic`` is the topic in the style that will be rendered for
         this view.
 
         ``csettopic`` is the topic in the style to be used for a changeset
         printer.
 
         If ``fmtopic`` is specified, the view function will receive a
         formatter instance. If ``csettopic`` is specified, the view
         function will receive a changeset printer.
         """
         func._fmtopic = fmtopic
         func._csettopic = csettopic
 
 showview = showcmdfunc()
 
 @command('show', [
     # TODO: Switch this template flag to use cmdutil.formatteropts if
     # 'hg show' becomes stable before --template/-T is stable. For now,
     # we are putting it here without the '(EXPERIMENTAL)' flag because it
     # is an important part of the 'hg show' user experience and the entire
     # 'hg show' experience is experimental.
     ('T', 'template', '', ('display with template'), _('TEMPLATE')),
     ], _('VIEW'))
 def show(ui, repo, view=None, template=None):
     """show various repository information
 
     A requested view of repository data is displayed.
 
     If no view is requested, the list of available views is shown and the
     command aborts.
 
     .. note::
 
        There are no backwards compatibility guarantees for the output of this
        command. Output may change in any future Mercurial release.
 
        Consumers wanting stable command output should specify a template via
        ``-T/--template``.
 
     List of available views:
     """
     if ui.plain() and not template:
         hint = _('invoke with -T/--template to control output format')
         raise error.Abort(_('must specify a template in plain mode'), hint=hint)
 
     views = showview._table
 
     if not view:
         ui.pager('show')
         # TODO consider using formatter here so available views can be
         # rendered to custom format.
         ui.write(_('available views:\n'))
         ui.write('\n')
 
         for name, func in sorted(views.items()):
             ui.write(('%s\n') % pycompat.sysbytes(func.__doc__))
 
         ui.write('\n')
         raise error.Abort(_('no view requested'),
                           hint=_('use "hg show VIEW" to choose a view'))
 
     # TODO use same logic as dispatch to perform prefix matching.
     if view not in views:
         raise error.Abort(_('unknown view: %s') % view,
                           hint=_('run "hg show" to see available views'))
 
     template = template or 'show'
 
     fn = views[view]
     ui.pager('show')
 
     if fn._fmtopic:
         fmtopic = 'show%s' % fn._fmtopic
         with ui.formatter(fmtopic, {'template': template}) as fm:
             return fn(ui, repo, fm)
     elif fn._csettopic:
         ref = 'show%s' % fn._csettopic
         spec = formatter.lookuptemplate(ui, ref, template)
         displayer = logcmdutil.changesettemplater(ui, repo, spec, buffered=True)
         return fn(ui, repo, displayer)
     else:
         return fn(ui, repo)
 
 @showview('bookmarks', fmtopic='bookmarks')
 def showbookmarks(ui, repo, fm):
     """bookmarks and their associated changeset"""
     marks = repo._bookmarks
     if not len(marks):
         # This is a bit hacky. Ideally, templates would have a way to
         # specify an empty output, but we shouldn't corrupt JSON while
         # waiting for this functionality.
         if not isinstance(fm, formatter.jsonformatter):
             ui.write(_('(no bookmarks set)\n'))
         return
 
     revs = [repo[node].rev() for node in marks.values()]
     active = repo._activebookmark
     longestname = max(len(b) for b in marks)
     nodelen = longestshortest(repo, revs)
 
     for bm, node in sorted(marks.items()):
         fm.startitem()
         fm.context(ctx=repo[node])
         fm.write('bookmark', '%s', bm)
         fm.write('node', fm.hexfunc(node), fm.hexfunc(node))
         fm.data(active=bm == active,
                 longestbookmarklen=longestname,
                 nodelen=nodelen)
 
 @showview('stack', csettopic='stack')
 def showstack(ui, repo, displayer):
     """current line of work"""
     wdirctx = repo['.']
     if wdirctx.rev() == nullrev:
         raise error.Abort(_('stack view only available when there is a '
                             'working directory'))
 
     if wdirctx.phase() == phases.public:
         ui.write(_('(empty stack; working directory parent is a published '
                    'changeset)\n'))
         return
 
     # TODO extract "find stack" into a function to facilitate
     # customization and reuse.
 
     baserev = destutil.stackbase(ui, repo)
     basectx = None
 
     if baserev is None:
         baserev = wdirctx.rev()
         stackrevs = {wdirctx.rev()}
     else:
         stackrevs = set(repo.revs('%d::.', baserev))
 
     ctx = repo[baserev]
     if ctx.p1().rev() != nullrev:
         basectx = ctx.p1()
 
     # And relevant descendants.
     branchpointattip = False
     cl = repo.changelog
 
     for rev in cl.descendants([wdirctx.rev()]):
         ctx = repo[rev]
 
         # Will only happen if . is public.
         if ctx.phase() == phases.public:
             break
 
         stackrevs.add(ctx.rev())
 
         # ctx.children() within a function iterating on descandants
         # potentially has severe performance concerns because revlog.children()
         # iterates over all revisions after ctx's node. However, the number of
         # draft changesets should be a reasonably small number. So even if
         # this is quadratic, the perf impact should be minimal.
         if len(ctx.children()) > 1:
             branchpointattip = True
             break
 
     stackrevs = list(sorted(stackrevs, reverse=True))
 
     # Find likely target heads for the current stack. These are likely
     # merge or rebase targets.
     if basectx:
         # TODO make this customizable?
         newheads = set(repo.revs('heads(%d::) - %ld - not public()',
                                  basectx.rev(), stackrevs))
     else:
         newheads = set()
 
     allrevs = set(stackrevs) | newheads | set([baserev])
     nodelen = longestshortest(repo, allrevs)
 
     try:
         cmdutil.findcmd('rebase', commands.table)
         haverebase = True
     except (error.AmbiguousCommand, error.UnknownCommand):
         haverebase = False
 
     # TODO use templating.
     # TODO consider using graphmod. But it may not be necessary given
     # our simplicity and the customizations required.
     # TODO use proper graph symbols from graphmod
 
     tres = formatter.templateresources(ui, repo)
     shortesttmpl = formatter.maketemplater(ui, '{shortest(node, %d)}' % nodelen,
                                            resources=tres)
     def shortest(ctx):
         return shortesttmpl.renderdefault({'ctx': ctx, 'node': ctx.hex()})
 
     # We write out new heads to aid in DAG awareness and to help with decision
     # making on how the stack should be reconciled with commits made since the
     # branch point.
     if newheads:
         # Calculate distance from base so we can render the count and so we can
         # sort display order by commit distance.
         revdistance = {}
         for head in newheads:
             # There is some redundancy in DAG traversal here and therefore
             # room to optimize.
             ancestors = cl.ancestors([head], stoprev=basectx.rev())
             revdistance[head] = len(list(ancestors))
 
         sourcectx = repo[stackrevs[-1]]
 
         sortedheads = sorted(newheads, key=lambda x: revdistance[x],
                              reverse=True)
 
         for i, rev in enumerate(sortedheads):
             ctx = repo[rev]
 
             if i:
                 ui.write(': ')
             else:
                 ui.write('  ')
 
             ui.write(('o  '))
             displayer.show(ctx, nodelen=nodelen)
             displayer.flush(ctx)
             ui.write('\n')
 
             if i:
                 ui.write(':/')
             else:
                 ui.write(' /')
 
             ui.write('    (')
             ui.write(_('%d commits ahead') % revdistance[rev],
                      label='stack.commitdistance')
 
             if haverebase:
                 # TODO may be able to omit --source in some scenarios
                 ui.write('; ')
                 ui.write(('hg rebase --source %s --dest %s' % (
                          shortest(sourcectx), shortest(ctx))),
                          label='stack.rebasehint')
 
             ui.write(')\n')
 
         ui.write(':\n:    ')
         ui.write(_('(stack head)\n'), label='stack.label')
 
     if branchpointattip:
         ui.write(' \\ /  ')
         ui.write(_('(multiple children)\n'), label='stack.label')
         ui.write('  |\n')
 
     for rev in stackrevs:
         ctx = repo[rev]
         symbol = '@' if rev == wdirctx.rev() else 'o'
 
         if newheads:
             ui.write(': ')
         else:
             ui.write('  ')
 
         ui.write(symbol, '  ')
         displayer.show(ctx, nodelen=nodelen)
         displayer.flush(ctx)
         ui.write('\n')
 
     # TODO display histedit hint?
 
     if basectx:
         # Vertically and horizontally separate stack base from parent
         # to reinforce stack boundary.
         if newheads:
             ui.write(':/   ')
         else:
             ui.write(' /   ')
 
         ui.write(_('(stack base)'), '\n', label='stack.label')
         ui.write(('o  '))
 
         displayer.show(basectx, nodelen=nodelen)
         displayer.flush(basectx)
         ui.write('\n')
 
 @revsetpredicate('_underway([commitage[, headage]])')
 def underwayrevset(repo, subset, x):
     args = revset.getargsdict(x, 'underway', 'commitage headage')
     if 'commitage' not in args:
         args['commitage'] = None
     if 'headage' not in args:
         args['headage'] = None
 
     # We assume callers of this revset add a topographical sort on the
     # result. This means there is no benefit to making the revset lazy
     # since the topographical sort needs to consume all revs.
     #
     # With this in mind, we build up the set manually instead of constructing
     # a complex revset. This enables faster execution.
 
     # Mutable changesets (non-public) are the most important changesets
     # to return. ``not public()`` will also pull in obsolete changesets if
     # there is a non-obsolete changeset with obsolete ancestors. This is
     # why we exclude obsolete changesets from this query.
     rs = 'not public() and not obsolete()'
     rsargs = []
     if args['commitage']:
         rs += ' and date(%s)'
         rsargs.append(revsetlang.getstring(args['commitage'],
                                            _('commitage requires a string')))
 
     mutable = repo.revs(rs, *rsargs)
     relevant = revset.baseset(mutable)
 
     # Add parents of mutable changesets to provide context.
     relevant += repo.revs('parents(%ld)', mutable)
 
     # We also pull in (public) heads if they a) aren't closing a branch
     # b) are recent.
     rs = 'head() and not closed()'
     rsargs = []
     if args['headage']:
         rs += ' and date(%s)'
         rsargs.append(revsetlang.getstring(args['headage'],
                                            _('headage requires a string')))
 
     relevant += repo.revs(rs, *rsargs)
 
     # Add working directory parent.
     wdirrev = repo['.'].rev()
     if wdirrev != nullrev:
         relevant += revset.baseset({wdirrev})
 
     return subset & relevant
 
 @showview('work', csettopic='work')
 def showwork(ui, repo, displayer):
     """changesets that aren't finished"""
     # TODO support date-based limiting when calling revset.
     revs = repo.revs('sort(_underway(), topo)')
     nodelen = longestshortest(repo, revs)
 
     revdag = graphmod.dagwalker(repo, revs)
 
     ui.setconfig('experimental', 'graphshorten', True)
     logcmdutil.displaygraph(ui, repo, revdag, displayer, graphmod.asciiedges,
                             props={'nodelen': nodelen})
 
 def extsetup(ui):
     # Alias `hg <prefix><view>` to `hg show <view>`.
     for prefix in ui.configlist('commands', 'show.aliasprefix'):
         for view in showview._table:
             name = '%s%s' % (prefix, view)
 
             choice, allcommands = cmdutil.findpossible(name, commands.table,
                                                        strict=True)
 
             # This alias is already a command name. Don't set it.
             if name in choice:
                 continue
 
             # Same for aliases.
-            if ui.config('alias', name):
+            if ui.config('alias', name, None):
                 continue
 
             ui.setconfig('alias', name, 'show %s' % view, source='show')
 
 def longestshortest(repo, revs, minlen=4):
     """Return the length of the longest shortest node to identify revisions.
 
     The result of this function can be used with the ``shortest()`` template
     function to ensure that a value is unique and unambiguous for a given
     set of nodes.
 
     The number of revisions in the repo is taken into account to prevent
     a numeric node prefix from conflicting with an integer revision number.
     If we fail to do this, a value of e.g. ``10023`` could mean either
     revision 10023 or node ``10023abc...``.
     """
     if not revs:
         return minlen
     # don't use filtered repo because it's slow. see templater.shortest().
     cl = repo.unfiltered().changelog
     return max(len(cl.shortest(hex(cl.node(r)), minlen)) for r in revs)
 
 # Adjust the docstring of the show command so it shows all registered views.
 # This is a bit hacky because it runs at the end of module load. When moved
 # into core or when another extension wants to provide a view, we'll need
 # to do this more robustly.
 # TODO make this more robust.
 def _updatedocstring():
     longest = max(map(len, showview._table.keys()))
     entries = []
     for key in sorted(showview._table.keys()):
         entries.append(pycompat.sysstr('    %s   %s' % (
             key.ljust(longest), showview._table[key]._origdoc)))
 
     cmdtable['show'][0].__doc__ = pycompat.sysstr('%s\n\n%s\n    ') % (
         cmdtable['show'][0].__doc__.rstrip(),
         pycompat.sysstr('\n\n').join(entries))
 
 _updatedocstring()

mercurial/configitems.py

@@ -1,1320 +1,1320 b''
 # configitems.py - centralized declaration of configuration option
 #
 #  Copyright 2017 Pierre-Yves David <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import functools
 import re
 
 from . import (
     encoding,
     error,
 )
 
 def loadconfigtable(ui, extname, configtable):
     """update config item known to the ui with the extension ones"""
     for section, items in sorted(configtable.items()):
         knownitems = ui._knownconfig.setdefault(section, itemregister())
         knownkeys = set(knownitems)
         newkeys = set(items)
         for key in sorted(knownkeys & newkeys):
             msg = "extension '%s' overwrite config item '%s.%s'"
             msg %= (extname, section, key)
             ui.develwarn(msg, config='warn-config')
 
         knownitems.update(items)
 
 class configitem(object):
     """represent a known config item
 
     :section: the official config section where to find this item,
        :name: the official name within the section,
     :default: default value for this item,
     :alias: optional list of tuples as alternatives,
     :generic: this is a generic definition, match name using regular expression.
     """
 
     def __init__(self, section, name, default=None, alias=(),
                  generic=False, priority=0):
         self.section = section
         self.name = name
         self.default = default
         self.alias = list(alias)
         self.generic = generic
         self.priority = priority
         self._re = None
         if generic:
             self._re = re.compile(self.name)
 
 class itemregister(dict):
     """A specialized dictionary that can handle wild-card selection"""
 
     def __init__(self):
         super(itemregister, self).__init__()
         self._generics = set()
 
     def update(self, other):
         super(itemregister, self).update(other)
         self._generics.update(other._generics)
 
     def __setitem__(self, key, item):
         super(itemregister, self).__setitem__(key, item)
         if item.generic:
             self._generics.add(item)
 
     def get(self, key):
         baseitem = super(itemregister, self).get(key)
         if baseitem is not None and not baseitem.generic:
             return baseitem
 
         # search for a matching generic item
         generics = sorted(self._generics, key=(lambda x: (x.priority, x.name)))
         for item in generics:
             # we use 'match' instead of 'search' to make the matching simpler
             # for people unfamiliar with regular expression. Having the match
             # rooted to the start of the string will produce less surprising
             # result for user writing simple regex for sub-attribute.
             #
             # For example using "color\..*" match produces an unsurprising
             # result, while using search could suddenly match apparently
             # unrelated configuration that happens to contains "color."
             # anywhere. This is a tradeoff where we favor requiring ".*" on
             # some match to avoid the need to prefix most pattern with "^".
             # The "^" seems more error prone.
             if item._re.match(key):
                 return item
 
         return None
 
 coreitems = {}
 
 def _register(configtable, *args, **kwargs):
     item = configitem(*args, **kwargs)
     section = configtable.setdefault(item.section, itemregister())
     if item.name in section:
         msg = "duplicated config item registration for '%s.%s'"
         raise error.ProgrammingError(msg % (item.section, item.name))
     section[item.name] = item
 
 # special value for case where the default is derived from other values
 dynamicdefault = object()
 
 # Registering actual config items
 
 def getitemregister(configtable):
     f = functools.partial(_register, configtable)
     # export pseudo enum as configitem.*
     f.dynamicdefault = dynamicdefault
     return f
 
 coreconfigitem = getitemregister(coreitems)
 
 coreconfigitem('alias', '.*',
-    default=None,
+    default=dynamicdefault,
     generic=True,
 )
 coreconfigitem('annotate', 'nodates',
     default=False,
 )
 coreconfigitem('annotate', 'showfunc',
     default=False,
 )
 coreconfigitem('annotate', 'unified',
     default=None,
 )
 coreconfigitem('annotate', 'git',
     default=False,
 )
 coreconfigitem('annotate', 'ignorews',
     default=False,
 )
 coreconfigitem('annotate', 'ignorewsamount',
     default=False,
 )
 coreconfigitem('annotate', 'ignoreblanklines',
     default=False,
 )
 coreconfigitem('annotate', 'ignorewseol',
     default=False,
 )
 coreconfigitem('annotate', 'nobinary',
     default=False,
 )
 coreconfigitem('annotate', 'noprefix',
     default=False,
 )
 coreconfigitem('auth', 'cookiefile',
     default=None,
 )
 # bookmarks.pushing: internal hack for discovery
 coreconfigitem('bookmarks', 'pushing',
     default=list,
 )
 # bundle.mainreporoot: internal hack for bundlerepo
 coreconfigitem('bundle', 'mainreporoot',
     default='',
 )
 # bundle.reorder: experimental config
 coreconfigitem('bundle', 'reorder',
     default='auto',
 )
 coreconfigitem('censor', 'policy',
     default='abort',
 )
 coreconfigitem('chgserver', 'idletimeout',
     default=3600,
 )
 coreconfigitem('chgserver', 'skiphash',
     default=False,
 )
 coreconfigitem('cmdserver', 'log',
     default=None,
 )
 coreconfigitem('color', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('color', 'mode',
     default='auto',
 )
 coreconfigitem('color', 'pagermode',
     default=dynamicdefault,
 )
 coreconfigitem('commands', 'show.aliasprefix',
     default=list,
 )
 coreconfigitem('commands', 'status.relative',
     default=False,
 )
 coreconfigitem('commands', 'status.skipstates',
     default=[],
 )
 coreconfigitem('commands', 'status.verbose',
     default=False,
 )
 coreconfigitem('commands', 'update.check',
     default=None,
     # Deprecated, remove after 4.4 release
     alias=[('experimental', 'updatecheck')]
 )
 coreconfigitem('commands', 'update.requiredest',
     default=False,
 )
 coreconfigitem('committemplate', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('convert', 'cvsps.cache',
     default=True,
 )
 coreconfigitem('convert', 'cvsps.fuzz',
     default=60,
 )
 coreconfigitem('convert', 'cvsps.logencoding',
     default=None,
 )
 coreconfigitem('convert', 'cvsps.mergefrom',
     default=None,
 )
 coreconfigitem('convert', 'cvsps.mergeto',
     default=None,
 )
 coreconfigitem('convert', 'git.committeractions',
     default=lambda: ['messagedifferent'],
 )
 coreconfigitem('convert', 'git.extrakeys',
     default=list,
 )
 coreconfigitem('convert', 'git.findcopiesharder',
     default=False,
 )
 coreconfigitem('convert', 'git.remoteprefix',
     default='remote',
 )
 coreconfigitem('convert', 'git.renamelimit',
     default=400,
 )
 coreconfigitem('convert', 'git.saverev',
     default=True,
 )
 coreconfigitem('convert', 'git.similarity',
     default=50,
 )
 coreconfigitem('convert', 'git.skipsubmodules',
     default=False,
 )
 coreconfigitem('convert', 'hg.clonebranches',
     default=False,
 )
 coreconfigitem('convert', 'hg.ignoreerrors',
     default=False,
 )
 coreconfigitem('convert', 'hg.revs',
     default=None,
 )
 coreconfigitem('convert', 'hg.saverev',
     default=False,
 )
 coreconfigitem('convert', 'hg.sourcename',
     default=None,
 )
 coreconfigitem('convert', 'hg.startrev',
     default=None,
 )
 coreconfigitem('convert', 'hg.tagsbranch',
     default='default',
 )
 coreconfigitem('convert', 'hg.usebranchnames',
     default=True,
 )
 coreconfigitem('convert', 'ignoreancestorcheck',
     default=False,
 )
 coreconfigitem('convert', 'localtimezone',
     default=False,
 )
 coreconfigitem('convert', 'p4.encoding',
     default=dynamicdefault,
 )
 coreconfigitem('convert', 'p4.startrev',
     default=0,
 )
 coreconfigitem('convert', 'skiptags',
     default=False,
 )
 coreconfigitem('convert', 'svn.debugsvnlog',
     default=True,
 )
 coreconfigitem('convert', 'svn.trunk',
     default=None,
 )
 coreconfigitem('convert', 'svn.tags',
     default=None,
 )
 coreconfigitem('convert', 'svn.branches',
     default=None,
 )
 coreconfigitem('convert', 'svn.startrev',
     default=0,
 )
 coreconfigitem('debug', 'dirstate.delaywrite',
     default=0,
 )
 coreconfigitem('defaults', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('devel', 'all-warnings',
     default=False,
 )
 coreconfigitem('devel', 'bundle2.debug',
     default=False,
 )
 coreconfigitem('devel', 'cache-vfs',
     default=None,
 )
 coreconfigitem('devel', 'check-locks',
     default=False,
 )
 coreconfigitem('devel', 'check-relroot',
     default=False,
 )
 coreconfigitem('devel', 'default-date',
     default=None,
 )
 coreconfigitem('devel', 'deprec-warn',
     default=False,
 )
 coreconfigitem('devel', 'disableloaddefaultcerts',
     default=False,
 )
 coreconfigitem('devel', 'warn-empty-changegroup',
     default=False,
 )
 coreconfigitem('devel', 'legacy.exchange',
     default=list,
 )
 coreconfigitem('devel', 'servercafile',
     default='',
 )
 coreconfigitem('devel', 'serverexactprotocol',
     default='',
 )
 coreconfigitem('devel', 'serverrequirecert',
     default=False,
 )
 coreconfigitem('devel', 'strip-obsmarkers',
     default=True,
 )
 coreconfigitem('devel', 'warn-config',
     default=None,
 )
 coreconfigitem('devel', 'warn-config-default',
     default=None,
 )
 coreconfigitem('devel', 'user.obsmarker',
     default=None,
 )
 coreconfigitem('devel', 'warn-config-unknown',
     default=None,
 )
 coreconfigitem('devel', 'debug.peer-request',
     default=False,
 )
 coreconfigitem('diff', 'nodates',
     default=False,
 )
 coreconfigitem('diff', 'showfunc',
     default=False,
 )
 coreconfigitem('diff', 'unified',
     default=None,
 )
 coreconfigitem('diff', 'git',
     default=False,
 )
 coreconfigitem('diff', 'ignorews',
     default=False,
 )
 coreconfigitem('diff', 'ignorewsamount',
     default=False,
 )
 coreconfigitem('diff', 'ignoreblanklines',
     default=False,
 )
 coreconfigitem('diff', 'ignorewseol',
     default=False,
 )
 coreconfigitem('diff', 'nobinary',
     default=False,
 )
 coreconfigitem('diff', 'noprefix',
     default=False,
 )
 coreconfigitem('email', 'bcc',
     default=None,
 )
 coreconfigitem('email', 'cc',
     default=None,
 )
 coreconfigitem('email', 'charsets',
     default=list,
 )
 coreconfigitem('email', 'from',
     default=None,
 )
 coreconfigitem('email', 'method',
     default='smtp',
 )
 coreconfigitem('email', 'reply-to',
     default=None,
 )
 coreconfigitem('email', 'to',
     default=None,
 )
 coreconfigitem('experimental', 'archivemetatemplate',
     default=dynamicdefault,
 )
 coreconfigitem('experimental', 'bundle-phases',
     default=False,
 )
 coreconfigitem('experimental', 'bundle2-advertise',
     default=True,
 )
 coreconfigitem('experimental', 'bundle2-output-capture',
     default=False,
 )
 coreconfigitem('experimental', 'bundle2.pushback',
     default=False,
 )
 coreconfigitem('experimental', 'bundle2.stream',
     default=False,
 )
 coreconfigitem('experimental', 'bundle2lazylocking',
     default=False,
 )
 coreconfigitem('experimental', 'bundlecomplevel',
     default=None,
 )
 coreconfigitem('experimental', 'changegroup3',
     default=False,
 )
 coreconfigitem('experimental', 'clientcompressionengines',
     default=list,
 )
 coreconfigitem('experimental', 'copytrace',
     default='on',
 )
 coreconfigitem('experimental', 'copytrace.movecandidateslimit',
     default=100,
 )
 coreconfigitem('experimental', 'copytrace.sourcecommitlimit',
     default=100,
 )
 coreconfigitem('experimental', 'crecordtest',
     default=None,
 )
 coreconfigitem('experimental', 'directaccess',
     default=False,
 )
 coreconfigitem('experimental', 'directaccess.revnums',
     default=False,
 )
 coreconfigitem('experimental', 'editortmpinhg',
     default=False,
 )
 coreconfigitem('experimental', 'evolution',
     default=list,
 )
 coreconfigitem('experimental', 'evolution.allowdivergence',
     default=False,
     alias=[('experimental', 'allowdivergence')]
 )
 coreconfigitem('experimental', 'evolution.allowunstable',
     default=None,
 )
 coreconfigitem('experimental', 'evolution.createmarkers',
     default=None,
 )
 coreconfigitem('experimental', 'evolution.effect-flags',
     default=True,
     alias=[('experimental', 'effect-flags')]
 )
 coreconfigitem('experimental', 'evolution.exchange',
     default=None,
 )
 coreconfigitem('experimental', 'evolution.bundle-obsmarker',
     default=False,
 )
 coreconfigitem('experimental', 'evolution.report-instabilities',
     default=True,
 )
 coreconfigitem('experimental', 'evolution.track-operation',
     default=True,
 )
 coreconfigitem('experimental', 'worddiff',
     default=False,
 )
 coreconfigitem('experimental', 'maxdeltachainspan',
     default=-1,
 )
 coreconfigitem('experimental', 'mergetempdirprefix',
     default=None,
 )
 coreconfigitem('experimental', 'mmapindexthreshold',
     default=None,
 )
 coreconfigitem('experimental', 'nonnormalparanoidcheck',
     default=False,
 )
 coreconfigitem('experimental', 'exportableenviron',
     default=list,
 )
 coreconfigitem('experimental', 'extendedheader.index',
     default=None,
 )
 coreconfigitem('experimental', 'extendedheader.similarity',
     default=False,
 )
 coreconfigitem('experimental', 'format.compression',
     default='zlib',
 )
 coreconfigitem('experimental', 'graphshorten',
     default=False,
 )
 coreconfigitem('experimental', 'graphstyle.parent',
     default=dynamicdefault,
 )
 coreconfigitem('experimental', 'graphstyle.missing',
     default=dynamicdefault,
 )
 coreconfigitem('experimental', 'graphstyle.grandparent',
     default=dynamicdefault,
 )
 coreconfigitem('experimental', 'hook-track-tags',
     default=False,
 )
 coreconfigitem('experimental', 'httppostargs',
     default=False,
 )
 coreconfigitem('experimental', 'mergedriver',
     default=None,
 )
 coreconfigitem('experimental', 'obsmarkers-exchange-debug',
     default=False,
 )
 coreconfigitem('experimental', 'remotenames',
     default=False,
 )
 coreconfigitem('experimental', 'revlogv2',
     default=None,
 )
 coreconfigitem('experimental', 'single-head-per-branch',
     default=False,
 )
 coreconfigitem('experimental', 'sshserver.support-v2',
     default=False,
 )
 coreconfigitem('experimental', 'spacemovesdown',
     default=False,
 )
 coreconfigitem('experimental', 'sparse-read',
     default=False,
 )
 coreconfigitem('experimental', 'sparse-read.density-threshold',
     default=0.25,
 )
 coreconfigitem('experimental', 'sparse-read.min-gap-size',
     default='256K',
 )
 coreconfigitem('experimental', 'treemanifest',
     default=False,
 )
 coreconfigitem('experimental', 'update.atomic-file',
     default=False,
 )
 coreconfigitem('experimental', 'sshpeer.advertise-v2',
     default=False,
 )
 coreconfigitem('experimental', 'web.apiserver',
     default=False,
 )
 coreconfigitem('experimental', 'web.api.http-v2',
     default=False,
 )
 coreconfigitem('experimental', 'web.api.debugreflect',
     default=False,
 )
 coreconfigitem('experimental', 'xdiff',
     default=False,
 )
 coreconfigitem('extensions', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('extdata', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('format', 'aggressivemergedeltas',
     default=False,
 )
 coreconfigitem('format', 'chunkcachesize',
     default=None,
 )
 coreconfigitem('format', 'dotencode',
     default=True,
 )
 coreconfigitem('format', 'generaldelta',
     default=False,
 )
 coreconfigitem('format', 'manifestcachesize',
     default=None,
 )
 coreconfigitem('format', 'maxchainlen',
     default=None,
 )
 coreconfigitem('format', 'obsstore-version',
     default=None,
 )
 coreconfigitem('format', 'usefncache',
     default=True,
 )
 coreconfigitem('format', 'usegeneraldelta',
     default=True,
 )
 coreconfigitem('format', 'usestore',
     default=True,
 )
 coreconfigitem('fsmonitor', 'warn_when_unused',
     default=True,
 )
 coreconfigitem('fsmonitor', 'warn_update_file_count',
     default=50000,
 )
 coreconfigitem('hooks', '.*',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem('hgweb-paths', '.*',
     default=list,
     generic=True,
 )
 coreconfigitem('hostfingerprints', '.*',
     default=list,
     generic=True,
 )
 coreconfigitem('hostsecurity', 'ciphers',
     default=None,
 )
 coreconfigitem('hostsecurity', 'disabletls10warning',
     default=False,
 )
 coreconfigitem('hostsecurity', 'minimumprotocol',
     default=dynamicdefault,
 )
 coreconfigitem('hostsecurity', '.*:minimumprotocol$',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem('hostsecurity', '.*:ciphers$',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem('hostsecurity', '.*:fingerprints$',
     default=list,
     generic=True,
 )
 coreconfigitem('hostsecurity', '.*:verifycertsfile$',
     default=None,
     generic=True,
 )
 
 coreconfigitem('http_proxy', 'always',
     default=False,
 )
 coreconfigitem('http_proxy', 'host',
     default=None,
 )
 coreconfigitem('http_proxy', 'no',
     default=list,
 )
 coreconfigitem('http_proxy', 'passwd',
     default=None,
 )
 coreconfigitem('http_proxy', 'user',
     default=None,
 )
 coreconfigitem('logtoprocess', 'commandexception',
     default=None,
 )
 coreconfigitem('logtoprocess', 'commandfinish',
     default=None,
 )
 coreconfigitem('logtoprocess', 'command',
     default=None,
 )
 coreconfigitem('logtoprocess', 'develwarn',
     default=None,
 )
 coreconfigitem('logtoprocess', 'uiblocked',
     default=None,
 )
 coreconfigitem('merge', 'checkunknown',
     default='abort',
 )
 coreconfigitem('merge', 'checkignored',
     default='abort',
 )
 coreconfigitem('experimental', 'merge.checkpathconflicts',
     default=False,
 )
 coreconfigitem('merge', 'followcopies',
     default=True,
 )
 coreconfigitem('merge', 'on-failure',
     default='continue',
 )
 coreconfigitem('merge', 'preferancestor',
         default=lambda: ['*'],
 )
 coreconfigitem('merge-tools', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('merge-tools', br'.*\.args$',
     default="$local $base $other",
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.binary$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.check$',
     default=list,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.checkchanged$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.executable$',
     default=dynamicdefault,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.fixeol$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.gui$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.mergemarkers$',
     default='basic',
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.mergemarkertemplate$',
     default=dynamicdefault,  # take from ui.mergemarkertemplate
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.priority$',
     default=0,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.premerge$',
     default=dynamicdefault,
     generic=True,
     priority=-1,
 )
 coreconfigitem('merge-tools', br'.*\.symlink$',
     default=False,
     generic=True,
     priority=-1,
 )
 coreconfigitem('pager', 'attend-.*',
     default=dynamicdefault,
     generic=True,
 )
 coreconfigitem('pager', 'ignore',
     default=list,
 )
 coreconfigitem('pager', 'pager',
     default=dynamicdefault,
 )
 coreconfigitem('patch', 'eol',
     default='strict',
 )
 coreconfigitem('patch', 'fuzz',
     default=2,
 )
 coreconfigitem('paths', 'default',
     default=None,
 )
 coreconfigitem('paths', 'default-push',
     default=None,
 )
 coreconfigitem('paths', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('phases', 'checksubrepos',
     default='follow',
 )
 coreconfigitem('phases', 'new-commit',
     default='draft',
 )
 coreconfigitem('phases', 'publish',
     default=True,
 )
 coreconfigitem('profiling', 'enabled',
     default=False,
 )
 coreconfigitem('profiling', 'format',
     default='text',
 )
 coreconfigitem('profiling', 'freq',
     default=1000,
 )
 coreconfigitem('profiling', 'limit',
     default=30,
 )
 coreconfigitem('profiling', 'nested',
     default=0,
 )
 coreconfigitem('profiling', 'output',
     default=None,
 )
 coreconfigitem('profiling', 'showmax',
     default=0.999,
 )
 coreconfigitem('profiling', 'showmin',
     default=dynamicdefault,
 )
 coreconfigitem('profiling', 'sort',
     default='inlinetime',
 )
 coreconfigitem('profiling', 'statformat',
     default='hotpath',
 )
 coreconfigitem('profiling', 'type',
     default='stat',
 )
 coreconfigitem('progress', 'assume-tty',
     default=False,
 )
 coreconfigitem('progress', 'changedelay',
     default=1,
 )
 coreconfigitem('progress', 'clear-complete',
     default=True,
 )
 coreconfigitem('progress', 'debug',
     default=False,
 )
 coreconfigitem('progress', 'delay',
     default=3,
 )
 coreconfigitem('progress', 'disable',
     default=False,
 )
 coreconfigitem('progress', 'estimateinterval',
     default=60.0,
 )
 coreconfigitem('progress', 'format',
     default=lambda: ['topic', 'bar', 'number', 'estimate'],
 )
 coreconfigitem('progress', 'refresh',
     default=0.1,
 )
 coreconfigitem('progress', 'width',
     default=dynamicdefault,
 )
 coreconfigitem('push', 'pushvars.server',
     default=False,
 )
 coreconfigitem('server', 'bookmarks-pushkey-compat',
     default=True,
 )
 coreconfigitem('server', 'bundle1',
     default=True,
 )
 coreconfigitem('server', 'bundle1gd',
     default=None,
 )
 coreconfigitem('server', 'bundle1.pull',
     default=None,
 )
 coreconfigitem('server', 'bundle1gd.pull',
     default=None,
 )
 coreconfigitem('server', 'bundle1.push',
     default=None,
 )
 coreconfigitem('server', 'bundle1gd.push',
     default=None,
 )
 coreconfigitem('server', 'compressionengines',
     default=list,
 )
 coreconfigitem('server', 'concurrent-push-mode',
     default='strict',
 )
 coreconfigitem('server', 'disablefullbundle',
     default=False,
 )
 coreconfigitem('server', 'maxhttpheaderlen',
     default=1024,
 )
 coreconfigitem('server', 'preferuncompressed',
     default=False,
 )
 coreconfigitem('server', 'uncompressed',
     default=True,
 )
 coreconfigitem('server', 'uncompressedallowsecret',
     default=False,
 )
 coreconfigitem('server', 'validate',
     default=False,
 )
 coreconfigitem('server', 'zliblevel',
     default=-1,
 )
 coreconfigitem('share', 'pool',
     default=None,
 )
 coreconfigitem('share', 'poolnaming',
     default='identity',
 )
 coreconfigitem('smtp', 'host',
     default=None,
 )
 coreconfigitem('smtp', 'local_hostname',
     default=None,
 )
 coreconfigitem('smtp', 'password',
     default=None,
 )
 coreconfigitem('smtp', 'port',
     default=dynamicdefault,
 )
 coreconfigitem('smtp', 'tls',
     default='none',
 )
 coreconfigitem('smtp', 'username',
     default=None,
 )
 coreconfigitem('sparse', 'missingwarning',
     default=True,
 )
 coreconfigitem('subrepos', 'allowed',
     default=dynamicdefault,  # to make backporting simpler
 )
 coreconfigitem('subrepos', 'hg:allowed',
     default=dynamicdefault,
 )
 coreconfigitem('subrepos', 'git:allowed',
     default=dynamicdefault,
 )
 coreconfigitem('subrepos', 'svn:allowed',
     default=dynamicdefault,
 )
 coreconfigitem('templates', '.*',
     default=None,
     generic=True,
 )
 coreconfigitem('trusted', 'groups',
     default=list,
 )
 coreconfigitem('trusted', 'users',
     default=list,
 )
 coreconfigitem('ui', '_usedassubrepo',
     default=False,
 )
 coreconfigitem('ui', 'allowemptycommit',
     default=False,
 )
 coreconfigitem('ui', 'archivemeta',
     default=True,
 )
 coreconfigitem('ui', 'askusername',
     default=False,
 )
 coreconfigitem('ui', 'clonebundlefallback',
     default=False,
 )
 coreconfigitem('ui', 'clonebundleprefers',
     default=list,
 )
 coreconfigitem('ui', 'clonebundles',
     default=True,
 )
 coreconfigitem('ui', 'color',
     default='auto',
 )
 coreconfigitem('ui', 'commitsubrepos',
     default=False,
 )
 coreconfigitem('ui', 'debug',
     default=False,
 )
 coreconfigitem('ui', 'debugger',
     default=None,
 )
 coreconfigitem('ui', 'editor',
     default=dynamicdefault,
 )
 coreconfigitem('ui', 'fallbackencoding',
     default=None,
 )
 coreconfigitem('ui', 'forcecwd',
     default=None,
 )
 coreconfigitem('ui', 'forcemerge',
     default=None,
 )
 coreconfigitem('ui', 'formatdebug',
     default=False,
 )
 coreconfigitem('ui', 'formatjson',
     default=False,
 )
 coreconfigitem('ui', 'formatted',
     default=None,
 )
 coreconfigitem('ui', 'graphnodetemplate',
     default=None,
 )
 coreconfigitem('ui', 'interactive',
     default=None,
 )
 coreconfigitem('ui', 'interface',
     default=None,
 )
 coreconfigitem('ui', 'interface.chunkselector',
     default=None,
 )
 coreconfigitem('ui', 'logblockedtimes',
     default=False,
 )
 coreconfigitem('ui', 'logtemplate',
     default=None,
 )
 coreconfigitem('ui', 'merge',
     default=None,
 )
 coreconfigitem('ui', 'mergemarkers',
     default='basic',
 )
 coreconfigitem('ui', 'mergemarkertemplate',
     default=('{node|short} '
             '{ifeq(tags, "tip", "", '
             'ifeq(tags, "", "", "{tags} "))}'
             '{if(bookmarks, "{bookmarks} ")}'
             '{ifeq(branch, "default", "", "{branch} ")}'
             '- {author|user}: {desc|firstline}')
 )
 coreconfigitem('ui', 'nontty',
     default=False,
 )
 coreconfigitem('ui', 'origbackuppath',
     default=None,
 )
 coreconfigitem('ui', 'paginate',
     default=True,
 )
 coreconfigitem('ui', 'patch',
     default=None,
 )
 coreconfigitem('ui', 'portablefilenames',
     default='warn',
 )
 coreconfigitem('ui', 'promptecho',
     default=False,
 )
 coreconfigitem('ui', 'quiet',
     default=False,
 )
 coreconfigitem('ui', 'quietbookmarkmove',
     default=False,
 )
 coreconfigitem('ui', 'remotecmd',
     default='hg',
 )
 coreconfigitem('ui', 'report_untrusted',
     default=True,
 )
 coreconfigitem('ui', 'rollback',
     default=True,
 )
 coreconfigitem('ui', 'slash',
     default=False,
 )
 coreconfigitem('ui', 'ssh',
     default='ssh',
 )
 coreconfigitem('ui', 'ssherrorhint',
     default=None,
 )
 coreconfigitem('ui', 'statuscopies',
     default=False,
 )
 coreconfigitem('ui', 'strict',
     default=False,
 )
 coreconfigitem('ui', 'style',
     default='',
 )
 coreconfigitem('ui', 'supportcontact',
     default=None,
 )
 coreconfigitem('ui', 'textwidth',
     default=78,
 )
 coreconfigitem('ui', 'timeout',
     default='600',
 )
 coreconfigitem('ui', 'timeout.warn',
     default=0,
 )
 coreconfigitem('ui', 'traceback',
     default=False,
 )
 coreconfigitem('ui', 'tweakdefaults',
     default=False,
 )
 coreconfigitem('ui', 'username',
     alias=[('ui', 'user')]
 )
 coreconfigitem('ui', 'verbose',
     default=False,
 )
 coreconfigitem('verify', 'skipflags',
     default=None,
 )
 coreconfigitem('web', 'allowbz2',
     default=False,
 )
 coreconfigitem('web', 'allowgz',
     default=False,
 )
 coreconfigitem('web', 'allow-pull',
     alias=[('web', 'allowpull')],
     default=True,
 )
 coreconfigitem('web', 'allow-push',
     alias=[('web', 'allow_push')],
     default=list,
 )
 coreconfigitem('web', 'allowzip',
     default=False,
 )
 coreconfigitem('web', 'archivesubrepos',
     default=False,
 )
 coreconfigitem('web', 'cache',
     default=True,
 )
 coreconfigitem('web', 'contact',
     default=None,
 )
 coreconfigitem('web', 'deny_push',
     default=list,
 )
 coreconfigitem('web', 'guessmime',
     default=False,
 )
 coreconfigitem('web', 'hidden',
     default=False,
 )
 coreconfigitem('web', 'labels',
     default=list,
 )
 coreconfigitem('web', 'logoimg',
     default='hglogo.png',
 )
 coreconfigitem('web', 'logourl',
     default='https://mercurial-scm.org/',
 )
 coreconfigitem('web', 'accesslog',
     default='-',
 )
 coreconfigitem('web', 'address',
     default='',
 )
 coreconfigitem('web', 'allow_archive',
     default=list,
 )
 coreconfigitem('web', 'allow_read',
     default=list,
 )
 coreconfigitem('web', 'baseurl',
     default=None,
 )
 coreconfigitem('web', 'cacerts',
     default=None,
 )
 coreconfigitem('web', 'certificate',
     default=None,
 )
 coreconfigitem('web', 'collapse',
     default=False,
 )
 coreconfigitem('web', 'csp',
     default=None,
 )
 coreconfigitem('web', 'deny_read',
     default=list,
 )
 coreconfigitem('web', 'descend',
     default=True,
 )
 coreconfigitem('web', 'description',
     default="",
 )
 coreconfigitem('web', 'encoding',
     default=lambda: encoding.encoding,
 )
 coreconfigitem('web', 'errorlog',
     default='-',
 )
 coreconfigitem('web', 'ipv6',
     default=False,
 )
 coreconfigitem('web', 'maxchanges',
     default=10,
 )
 coreconfigitem('web', 'maxfiles',
     default=10,
 )
 coreconfigitem('web', 'maxshortchanges',
     default=60,
 )
 coreconfigitem('web', 'motd',
     default='',
 )
 coreconfigitem('web', 'name',
     default=dynamicdefault,
 )
 coreconfigitem('web', 'port',
     default=8000,
 )
 coreconfigitem('web', 'prefix',
     default='',
 )
 coreconfigitem('web', 'push_ssl',
     default=True,
 )
 coreconfigitem('web', 'refreshinterval',
     default=20,
 )
 coreconfigitem('web', 'server-header',
     default=None,
 )
 coreconfigitem('web', 'staticurl',
     default=None,
 )
 coreconfigitem('web', 'stripes',
     default=1,
 )
 coreconfigitem('web', 'style',
     default='paper',
 )
 coreconfigitem('web', 'templates',
     default=None,
 )
 coreconfigitem('web', 'view',
     default='served',
 )
 coreconfigitem('worker', 'backgroundclose',
     default=dynamicdefault,
 )
 # Windows defaults to a limit of 512 open files. A buffer of 128
 # should give us enough headway.
 coreconfigitem('worker', 'backgroundclosemaxqueue',
     default=384,
 )
 coreconfigitem('worker', 'backgroundcloseminfilecount',
     default=2048,
 )
 coreconfigitem('worker', 'backgroundclosethreadcount',
     default=4,
 )
 coreconfigitem('worker', 'enabled',
     default=True,
 )
 coreconfigitem('worker', 'numcpus',
     default=None,
 )
 
 # Rebase related configuration moved to core because other extension are doing
 # strange things. For example, shelve import the extensions to reuse some bit
 # without formally loading it.
 coreconfigitem('commands', 'rebase.requiredest',
             default=False,
 )
 coreconfigitem('experimental', 'rebaseskipobsolete',
     default=True,
 )
 coreconfigitem('rebase', 'singletransaction',
     default=False,
 )
 coreconfigitem('rebase', 'experimental.inmemory',
     default=False,
 )

mercurial/dispatch.py

@@ -1,1030 +1,1040 b''
 # dispatch.py - command dispatching for mercurial
 #
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import, print_function
 
 import difflib
 import errno
 import getopt
 import os
 import pdb
 import re
 import signal
 import sys
 import time
 import traceback
 
 
 from .i18n import _
 
 from . import (
     cmdutil,
     color,
     commands,
     demandimport,
     encoding,
     error,
     extensions,
     fancyopts,
     help,
     hg,
     hook,
     profiling,
     pycompat,
     registrar,
     scmutil,
     ui as uimod,
     util,
 )
 
 from .utils import (
     procutil,
     stringutil,
 )
 
 unrecoverablewrite = registrar.command.unrecoverablewrite
 
 class request(object):
     def __init__(self, args, ui=None, repo=None, fin=None, fout=None,
                  ferr=None, prereposetups=None):
         self.args = args
         self.ui = ui
         self.repo = repo
 
         # input/output/error streams
         self.fin = fin
         self.fout = fout
         self.ferr = ferr
 
         # remember options pre-parsed by _earlyparseopts()
         self.earlyoptions = {}
 
         # reposetups which run before extensions, useful for chg to pre-fill
         # low-level repo state (for example, changelog) before extensions.
         self.prereposetups = prereposetups or []
 
     def _runexithandlers(self):
         exc = None
         handlers = self.ui._exithandlers
         try:
             while handlers:
                 func, args, kwargs = handlers.pop()
                 try:
                     func(*args, **kwargs)
                 except: # re-raises below
                     if exc is None:
                         exc = sys.exc_info()[1]
                     self.ui.warn(('error in exit handlers:\n'))
                     self.ui.traceback(force=True)
         finally:
             if exc is not None:
                 raise exc
 
 def run():
     "run the command in sys.argv"
     _initstdio()
     req = request(pycompat.sysargv[1:])
     err = None
     try:
         status = (dispatch(req) or 0)
     except error.StdioError as e:
         err = e
         status = -1
     if util.safehasattr(req.ui, 'fout'):
         try:
             req.ui.fout.flush()
         except IOError as e:
             err = e
             status = -1
     if util.safehasattr(req.ui, 'ferr'):
         try:
             if err is not None and err.errno != errno.EPIPE:
                 req.ui.ferr.write('abort: %s\n' %
                                   encoding.strtolocal(err.strerror))
             req.ui.ferr.flush()
         # There's not much we can do about an I/O error here. So (possibly)
         # change the status code and move on.
         except IOError:
             status = -1
 
     _silencestdio()
     sys.exit(status & 255)
 
 if pycompat.ispy3:
     def _initstdio():
         pass
 
     def _silencestdio():
         for fp in (sys.stdout, sys.stderr):
             # Check if the file is okay
             try:
                 fp.flush()
                 continue
             except IOError:
                 pass
             # Otherwise mark it as closed to silence "Exception ignored in"
             # message emitted by the interpreter finalizer. Be careful to
             # not close procutil.stdout, which may be a fdopen-ed file object
             # and its close() actually closes the underlying file descriptor.
             try:
                 fp.close()
             except IOError:
                 pass
 else:
     def _initstdio():
         for fp in (sys.stdin, sys.stdout, sys.stderr):
             procutil.setbinary(fp)
 
     def _silencestdio():
         pass
 
 def _getsimilar(symbols, value):
     sim = lambda x: difflib.SequenceMatcher(None, value, x).ratio()
     # The cutoff for similarity here is pretty arbitrary. It should
     # probably be investigated and tweaked.
     return [s for s in symbols if sim(s) > 0.6]
 
 def _reportsimilar(write, similar):
     if len(similar) == 1:
         write(_("(did you mean %s?)\n") % similar[0])
     elif similar:
         ss = ", ".join(sorted(similar))
         write(_("(did you mean one of %s?)\n") % ss)
 
 def _formatparse(write, inst):
     similar = []
     if isinstance(inst, error.UnknownIdentifier):
         # make sure to check fileset first, as revset can invoke fileset
         similar = _getsimilar(inst.symbols, inst.function)
     if len(inst.args) > 1:
         write(_("hg: parse error at %s: %s\n") %
               (pycompat.bytestr(inst.args[1]), inst.args[0]))
         if inst.args[0].startswith(' '):
             write(_("unexpected leading whitespace\n"))
     else:
         write(_("hg: parse error: %s\n") % inst.args[0])
         _reportsimilar(write, similar)
     if inst.hint:
         write(_("(%s)\n") % inst.hint)
 
 def _formatargs(args):
     return ' '.join(procutil.shellquote(a) for a in args)
 
 def dispatch(req):
     "run the command specified in req.args"
     if req.ferr:
         ferr = req.ferr
     elif req.ui:
         ferr = req.ui.ferr
     else:
         ferr = procutil.stderr
 
     try:
         if not req.ui:
             req.ui = uimod.ui.load()
         req.earlyoptions.update(_earlyparseopts(req.ui, req.args))
         if req.earlyoptions['traceback']:
             req.ui.setconfig('ui', 'traceback', 'on', '--traceback')
 
         # set ui streams from the request
         if req.fin:
             req.ui.fin = req.fin
         if req.fout:
             req.ui.fout = req.fout
         if req.ferr:
             req.ui.ferr = req.ferr
     except error.Abort as inst:
         ferr.write(_("abort: %s\n") % inst)
         if inst.hint:
             ferr.write(_("(%s)\n") % inst.hint)
         return -1
     except error.ParseError as inst:
         _formatparse(ferr.write, inst)
         return -1
 
     msg = _formatargs(req.args)
     starttime = util.timer()
     ret = None
     try:
         ret = _runcatch(req)
     except error.ProgrammingError as inst:
         req.ui.warn(_('** ProgrammingError: %s\n') % inst)
         if inst.hint:
             req.ui.warn(_('** (%s)\n') % inst.hint)
         raise
     except KeyboardInterrupt as inst:
         try:
             if isinstance(inst, error.SignalInterrupt):
                 msg = _("killed!\n")
             else:
                 msg = _("interrupted!\n")
             req.ui.warn(msg)
         except error.SignalInterrupt:
             # maybe pager would quit without consuming all the output, and
             # SIGPIPE was raised. we cannot print anything in this case.
             pass
         except IOError as inst:
             if inst.errno != errno.EPIPE:
                 raise
         ret = -1
     finally:
         duration = util.timer() - starttime
         req.ui.flush()
         if req.ui.logblockedtimes:
             req.ui._blockedtimes['command_duration'] = duration * 1000
             req.ui.log('uiblocked', 'ui blocked ms',
                        **pycompat.strkwargs(req.ui._blockedtimes))
         req.ui.log("commandfinish", "%s exited %d after %0.2f seconds\n",
                    msg, ret or 0, duration)
         try:
             req._runexithandlers()
         except: # exiting, so no re-raises
             ret = ret or -1
     return ret
 
 def _runcatch(req):
     def catchterm(*args):
         raise error.SignalInterrupt
 
     ui = req.ui
     try:
         for name in 'SIGBREAK', 'SIGHUP', 'SIGTERM':
             num = getattr(signal, name, None)
             if num:
                 signal.signal(num, catchterm)
     except ValueError:
         pass # happens if called in a thread
 
     def _runcatchfunc():
         realcmd = None
         try:
             cmdargs = fancyopts.fancyopts(req.args[:], commands.globalopts, {})
             cmd = cmdargs[0]
             aliases, entry = cmdutil.findcmd(cmd, commands.table, False)
             realcmd = aliases[0]
         except (error.UnknownCommand, error.AmbiguousCommand,
                 IndexError, getopt.GetoptError):
             # Don't handle this here. We know the command is
             # invalid, but all we're worried about for now is that
             # it's not a command that server operators expect to
             # be safe to offer to users in a sandbox.
             pass
         if realcmd == 'serve' and '--stdio' in cmdargs:
             # We want to constrain 'hg serve --stdio' instances pretty
             # closely, as many shared-ssh access tools want to grant
             # access to run *only* 'hg -R $repo serve --stdio'. We
             # restrict to exactly that set of arguments, and prohibit
             # any repo name that starts with '--' to prevent
             # shenanigans wherein a user does something like pass
             # --debugger or --config=ui.debugger=1 as a repo
             # name. This used to actually run the debugger.
             if (len(req.args) != 4 or
                 req.args[0] != '-R' or
                 req.args[1].startswith('--') or
                 req.args[2] != 'serve' or
                 req.args[3] != '--stdio'):
                 raise error.Abort(
                     _('potentially unsafe serve --stdio invocation: %r') %
                     (req.args,))
 
         try:
             debugger = 'pdb'
             debugtrace = {
                 'pdb': pdb.set_trace
             }
             debugmortem = {
                 'pdb': pdb.post_mortem
             }
 
             # read --config before doing anything else
             # (e.g. to change trust settings for reading .hg/hgrc)
             cfgs = _parseconfig(req.ui, req.earlyoptions['config'])
 
             if req.repo:
                 # copy configs that were passed on the cmdline (--config) to
                 # the repo ui
                 for sec, name, val in cfgs:
                     req.repo.ui.setconfig(sec, name, val, source='--config')
 
             # developer config: ui.debugger
             debugger = ui.config("ui", "debugger")
             debugmod = pdb
             if not debugger or ui.plain():
                 # if we are in HGPLAIN mode, then disable custom debugging
                 debugger = 'pdb'
             elif req.earlyoptions['debugger']:
                 # This import can be slow for fancy debuggers, so only
                 # do it when absolutely necessary, i.e. when actual
                 # debugging has been requested
                 with demandimport.deactivated():
                     try:
                         debugmod = __import__(debugger)
                     except ImportError:
                         pass # Leave debugmod = pdb
 
             debugtrace[debugger] = debugmod.set_trace
             debugmortem[debugger] = debugmod.post_mortem
 
             # enter the debugger before command execution
             if req.earlyoptions['debugger']:
                 ui.warn(_("entering debugger - "
                         "type c to continue starting hg or h for help\n"))
 
                 if (debugger != 'pdb' and
                     debugtrace[debugger] == debugtrace['pdb']):
                     ui.warn(_("%s debugger specified "
                               "but its module was not found\n") % debugger)
                 with demandimport.deactivated():
                     debugtrace[debugger]()
             try:
                 return _dispatch(req)
             finally:
                 ui.flush()
         except: # re-raises
             # enter the debugger when we hit an exception
             if req.earlyoptions['debugger']:
                 traceback.print_exc()
                 debugmortem[debugger](sys.exc_info()[2])
             raise
 
     return _callcatch(ui, _runcatchfunc)
 
 def _callcatch(ui, func):
     """like scmutil.callcatch but handles more high-level exceptions about
     config parsing and commands. besides, use handlecommandexception to handle
     uncaught exceptions.
     """
     try:
         return scmutil.callcatch(ui, func)
     except error.AmbiguousCommand as inst:
         ui.warn(_("hg: command '%s' is ambiguous:\n    %s\n") %
                 (inst.args[0], " ".join(inst.args[1])))
     except error.CommandError as inst:
         if inst.args[0]:
             ui.pager('help')
             msgbytes = pycompat.bytestr(inst.args[1])
             ui.warn(_("hg %s: %s\n") % (inst.args[0], msgbytes))
             commands.help_(ui, inst.args[0], full=False, command=True)
         else:
             ui.pager('help')
             ui.warn(_("hg: %s\n") % inst.args[1])
             commands.help_(ui, 'shortlist')
     except error.ParseError as inst:
         _formatparse(ui.warn, inst)
         return -1
     except error.UnknownCommand as inst:
         nocmdmsg = _("hg: unknown command '%s'\n") % inst.args[0]
         try:
             # check if the command is in a disabled extension
             # (but don't check for extensions themselves)
             formatted = help.formattedhelp(ui, commands, inst.args[0],
                                            unknowncmd=True)
             ui.warn(nocmdmsg)
             ui.write(formatted)
         except (error.UnknownCommand, error.Abort):
             suggested = False
             if len(inst.args) == 2:
                 sim = _getsimilar(inst.args[1], inst.args[0])
                 if sim:
                     ui.warn(nocmdmsg)
                     _reportsimilar(ui.warn, sim)
                     suggested = True
             if not suggested:
                 ui.pager('help')
                 ui.warn(nocmdmsg)
                 commands.help_(ui, 'shortlist')
     except IOError:
         raise
     except KeyboardInterrupt:
         raise
     except:  # probably re-raises
         if not handlecommandexception(ui):
             raise
 
     return -1
 
 def aliasargs(fn, givenargs):
     args = []
     # only care about alias 'args', ignore 'args' set by extensions.wrapfunction
     if not util.safehasattr(fn, '_origfunc'):
         args = getattr(fn, 'args', args)
     if args:
         cmd = ' '.join(map(procutil.shellquote, args))
 
         nums = []
         def replacer(m):
             num = int(m.group(1)) - 1
             nums.append(num)
             if num < len(givenargs):
                 return givenargs[num]
             raise error.Abort(_('too few arguments for command alias'))
         cmd = re.sub(br'\$(\d+|\$)', replacer, cmd)
         givenargs = [x for i, x in enumerate(givenargs)
                      if i not in nums]
         args = pycompat.shlexsplit(cmd)
     return args + givenargs
 
 def aliasinterpolate(name, args, cmd):
     '''interpolate args into cmd for shell aliases
 
     This also handles $0, $@ and "$@".
     '''
     # util.interpolate can't deal with "$@" (with quotes) because it's only
     # built to match prefix + patterns.
     replacemap = dict(('$%d' % (i + 1), arg) for i, arg in enumerate(args))
     replacemap['$0'] = name
     replacemap['$$'] = '$'
     replacemap['$@'] = ' '.join(args)
     # Typical Unix shells interpolate "$@" (with quotes) as all the positional
     # parameters, separated out into words. Emulate the same behavior here by
     # quoting the arguments individually. POSIX shells will then typically
     # tokenize each argument into exactly one word.
     replacemap['"$@"'] = ' '.join(procutil.shellquote(arg) for arg in args)
     # escape '\$' for regex
     regex = '|'.join(replacemap.keys()).replace('$', br'\$')
     r = re.compile(regex)
     return r.sub(lambda x: replacemap[x.group()], cmd)
 
 class cmdalias(object):
-    def __init__(self, name, definition, cmdtable, source):
+    def __init__(self, ui, name, definition, cmdtable, source):
         self.name = self.cmd = name
         self.cmdname = ''
         self.definition = definition
         self.fn = None
         self.givenargs = []
         self.opts = []
         self.help = ''
         self.badalias = None
         self.unknowncmd = False
         self.source = source
 
         try:
             aliases, entry = cmdutil.findcmd(self.name, cmdtable)
             for alias, e in cmdtable.iteritems():
                 if e is entry:
                     self.cmd = alias
                     break
             self.shadows = True
         except error.UnknownCommand:
             self.shadows = False
 
         if not self.definition:
             self.badalias = _("no definition for alias '%s'") % self.name
             return
 
         if self.definition.startswith('!'):
+            shdef = self.definition[1:]
             self.shell = True
             def fn(ui, *args):
                 env = {'HG_ARGS': ' '.join((self.name,) + args)}
                 def _checkvar(m):
                     if m.groups()[0] == '$':
                         return m.group()
                     elif int(m.groups()[0]) <= len(args):
                         return m.group()
                     else:
                         ui.debug("No argument found for substitution "
                                  "of %i variable in alias '%s' definition.\n"
                                  % (int(m.groups()[0]), self.name))
                         return ''
-                cmd = re.sub(br'\$(\d+|\$)', _checkvar, self.definition[1:])
+                cmd = re.sub(br'\$(\d+|\$)', _checkvar, shdef)
                 cmd = aliasinterpolate(self.name, args, cmd)
                 return ui.system(cmd, environ=env,
                                  blockedtag='alias_%s' % self.name)
             self.fn = fn
+            self._populatehelp(ui, name, shdef, self.fn)
             return
 
         try:
             args = pycompat.shlexsplit(self.definition)
         except ValueError as inst:
             self.badalias = (_("error in definition for alias '%s': %s")
                              % (self.name, stringutil.forcebytestr(inst)))
             return
         earlyopts, args = _earlysplitopts(args)
         if earlyopts:
             self.badalias = (_("error in definition for alias '%s': %s may "
                                "only be given on the command line")
                              % (self.name, '/'.join(pycompat.ziplist(*earlyopts)
                                                     [0])))
             return
         self.cmdname = cmd = args.pop(0)
         self.givenargs = args
 
         try:
             tableentry = cmdutil.findcmd(cmd, cmdtable, False)[1]
             if len(tableentry) > 2:
-                self.fn, self.opts, self.help = tableentry
+                self.fn, self.opts, cmdhelp = tableentry
             else:
                 self.fn, self.opts = tableentry
+                cmdhelp = None
 
-            if self.help.startswith("hg " + cmd):
-                # drop prefix in old-style help lines so hg shows the alias
-                self.help = self.help[4 + len(cmd):]
-            self.__doc__ = self.fn.__doc__
+            self._populatehelp(ui, name, cmd, self.fn, cmdhelp)
 
         except error.UnknownCommand:
             self.badalias = (_("alias '%s' resolves to unknown command '%s'")
                              % (self.name, cmd))
             self.unknowncmd = True
         except error.AmbiguousCommand:
             self.badalias = (_("alias '%s' resolves to ambiguous command '%s'")
                              % (self.name, cmd))
 
+    def _populatehelp(self, ui, name, cmd, fn, defaulthelp=None):
+        self.help = ui.config('alias', '%s:help' % name, defaulthelp or '')
+        if self.help and self.help.startswith("hg " + cmd):
+            # drop prefix in old-style help lines so hg shows the alias
+            self.help = self.help[4 + len(cmd):]
+
+        self.__doc__ = ui.config('alias', '%s:doc' % name, fn.__doc__)
+
     @property
     def args(self):
         args = pycompat.maplist(util.expandpath, self.givenargs)
         return aliasargs(self.fn, args)
 
     def __getattr__(self, name):
         adefaults = {r'norepo': True, r'cmdtype': unrecoverablewrite,
                      r'optionalrepo': False, r'inferrepo': False}
         if name not in adefaults:
             raise AttributeError(name)
         if self.badalias or util.safehasattr(self, 'shell'):
             return adefaults[name]
         return getattr(self.fn, name)
 
     def __call__(self, ui, *args, **opts):
         if self.badalias:
             hint = None
             if self.unknowncmd:
                 try:
                     # check if the command is in a disabled extension
                     cmd, ext = extensions.disabledcmd(ui, self.cmdname)[:2]
                     hint = _("'%s' is provided by '%s' extension") % (cmd, ext)
                 except error.UnknownCommand:
                     pass
             raise error.Abort(self.badalias, hint=hint)
         if self.shadows:
             ui.debug("alias '%s' shadows command '%s'\n" %
                      (self.name, self.cmdname))
 
         ui.log('commandalias', "alias '%s' expands to '%s'\n",
                self.name, self.definition)
         if util.safehasattr(self, 'shell'):
             return self.fn(ui, *args, **opts)
         else:
             try:
                 return util.checksignature(self.fn)(ui, *args, **opts)
             except error.SignatureError:
                 args = ' '.join([self.cmdname] + self.args)
                 ui.debug("alias '%s' expands to '%s'\n" % (self.name, args))
                 raise
 
 class lazyaliasentry(object):
     """like a typical command entry (func, opts, help), but is lazy"""
 
-    def __init__(self, name, definition, cmdtable, source):
+    def __init__(self, ui, name, definition, cmdtable, source):
+        self.ui = ui
         self.name = name
         self.definition = definition
         self.cmdtable = cmdtable.copy()
         self.source = source
 
     @util.propertycache
     def _aliasdef(self):
-        return cmdalias(self.name, self.definition, self.cmdtable, self.source)
+        return cmdalias(self.ui, self.name, self.definition, self.cmdtable,
+                        self.source)
 
     def __getitem__(self, n):
         aliasdef = self._aliasdef
         if n == 0:
             return aliasdef
         elif n == 1:
             return aliasdef.opts
         elif n == 2:
             return aliasdef.help
         else:
             raise IndexError
 
     def __iter__(self):
         for i in range(3):
             yield self[i]
 
     def __len__(self):
         return 3
 
 def addaliases(ui, cmdtable):
     # aliases are processed after extensions have been loaded, so they
     # may use extension commands. Aliases can also use other alias definitions,
     # but only if they have been defined prior to the current definition.
-    for alias, definition in ui.configitems('alias'):
+    for alias, definition in ui.configitems('alias', ignoresub=True):
         try:
             if cmdtable[alias].definition == definition:
                 continue
         except (KeyError, AttributeError):
             # definition might not exist or it might not be a cmdalias
             pass
 
         source = ui.configsource('alias', alias)
-        entry = lazyaliasentry(alias, definition, cmdtable, source)
+        entry = lazyaliasentry(ui, alias, definition, cmdtable, source)
         cmdtable[alias] = entry
 
 def _parse(ui, args):
     options = {}
     cmdoptions = {}
 
     try:
         args = fancyopts.fancyopts(args, commands.globalopts, options)
     except getopt.GetoptError as inst:
         raise error.CommandError(None, stringutil.forcebytestr(inst))
 
     if args:
         cmd, args = args[0], args[1:]
         aliases, entry = cmdutil.findcmd(cmd, commands.table,
                                          ui.configbool("ui", "strict"))
         cmd = aliases[0]
         args = aliasargs(entry[0], args)
         defaults = ui.config("defaults", cmd)
         if defaults:
             args = pycompat.maplist(
                 util.expandpath, pycompat.shlexsplit(defaults)) + args
         c = list(entry[1])
     else:
         cmd = None
         c = []
 
     # combine global options into local
     for o in commands.globalopts:
         c.append((o[0], o[1], options[o[1]], o[3]))
 
     try:
         args = fancyopts.fancyopts(args, c, cmdoptions, gnu=True)
     except getopt.GetoptError as inst:
         raise error.CommandError(cmd, stringutil.forcebytestr(inst))
 
     # separate global options back out
     for o in commands.globalopts:
         n = o[1]
         options[n] = cmdoptions[n]
         del cmdoptions[n]
 
     return (cmd, cmd and entry[0] or None, args, options, cmdoptions)
 
 def _parseconfig(ui, config):
     """parse the --config options from the command line"""
     configs = []
 
     for cfg in config:
         try:
             name, value = [cfgelem.strip()
                            for cfgelem in cfg.split('=', 1)]
             section, name = name.split('.', 1)
             if not section or not name:
                 raise IndexError
             ui.setconfig(section, name, value, '--config')
             configs.append((section, name, value))
         except (IndexError, ValueError):
             raise error.Abort(_('malformed --config option: %r '
                                 '(use --config section.name=value)')
                               % pycompat.bytestr(cfg))
 
     return configs
 
 def _earlyparseopts(ui, args):
     options = {}
     fancyopts.fancyopts(args, commands.globalopts, options,
                         gnu=not ui.plain('strictflags'), early=True,
                         optaliases={'repository': ['repo']})
     return options
 
 def _earlysplitopts(args):
     """Split args into a list of possible early options and remainder args"""
     shortoptions = 'R:'
     # TODO: perhaps 'debugger' should be included
     longoptions = ['cwd=', 'repository=', 'repo=', 'config=']
     return fancyopts.earlygetopt(args, shortoptions, longoptions,
                                  gnu=True, keepsep=True)
 
 def runcommand(lui, repo, cmd, fullargs, ui, options, d, cmdpats, cmdoptions):
     # run pre-hook, and abort if it fails
     hook.hook(lui, repo, "pre-%s" % cmd, True, args=" ".join(fullargs),
               pats=cmdpats, opts=cmdoptions)
     try:
         ret = _runcommand(ui, options, cmd, d)
         # run post-hook, passing command result
         hook.hook(lui, repo, "post-%s" % cmd, False, args=" ".join(fullargs),
                   result=ret, pats=cmdpats, opts=cmdoptions)
     except Exception:
         # run failure hook and re-raise
         hook.hook(lui, repo, "fail-%s" % cmd, False, args=" ".join(fullargs),
                   pats=cmdpats, opts=cmdoptions)
         raise
     return ret
 
 def _getlocal(ui, rpath, wd=None):
     """Return (path, local ui object) for the given target path.
 
     Takes paths in [cwd]/.hg/hgrc into account."
     """
     if wd is None:
         try:
             wd = pycompat.getcwd()
         except OSError as e:
             raise error.Abort(_("error getting current working directory: %s") %
                               encoding.strtolocal(e.strerror))
     path = cmdutil.findrepo(wd) or ""
     if not path:
         lui = ui
     else:
         lui = ui.copy()
         lui.readconfig(os.path.join(path, ".hg", "hgrc"), path)
 
     if rpath:
         path = lui.expandpath(rpath)
         lui = ui.copy()
         lui.readconfig(os.path.join(path, ".hg", "hgrc"), path)
 
     return path, lui
 
 def _checkshellalias(lui, ui, args):
     """Return the function to run the shell alias, if it is required"""
     options = {}
 
     try:
         args = fancyopts.fancyopts(args, commands.globalopts, options)
     except getopt.GetoptError:
         return
 
     if not args:
         return
 
     cmdtable = commands.table
 
     cmd = args[0]
     try:
         strict = ui.configbool("ui", "strict")
         aliases, entry = cmdutil.findcmd(cmd, cmdtable, strict)
     except (error.AmbiguousCommand, error.UnknownCommand):
         return
 
     cmd = aliases[0]
     fn = entry[0]
 
     if cmd and util.safehasattr(fn, 'shell'):
         # shell alias shouldn't receive early options which are consumed by hg
         _earlyopts, args = _earlysplitopts(args)
         d = lambda: fn(ui, *args[1:])
         return lambda: runcommand(lui, None, cmd, args[:1], ui, options, d,
                                   [], {})
 
 def _dispatch(req):
     args = req.args
     ui = req.ui
 
     # check for cwd
     cwd = req.earlyoptions['cwd']
     if cwd:
         os.chdir(cwd)
 
     rpath = req.earlyoptions['repository']
     path, lui = _getlocal(ui, rpath)
 
     uis = {ui, lui}
 
     if req.repo:
         uis.add(req.repo.ui)
 
     if req.earlyoptions['profile']:
         for ui_ in uis:
             ui_.setconfig('profiling', 'enabled', 'true', '--profile')
 
     profile = lui.configbool('profiling', 'enabled')
     with profiling.profile(lui, enabled=profile) as profiler:
         # Configure extensions in phases: uisetup, extsetup, cmdtable, and
         # reposetup
         extensions.loadall(lui)
         # Propagate any changes to lui.__class__ by extensions
         ui.__class__ = lui.__class__
 
         # (uisetup and extsetup are handled in extensions.loadall)
 
         # (reposetup is handled in hg.repository)
 
         addaliases(lui, commands.table)
 
         # All aliases and commands are completely defined, now.
         # Check abbreviation/ambiguity of shell alias.
         shellaliasfn = _checkshellalias(lui, ui, args)
         if shellaliasfn:
             return shellaliasfn()
 
         # check for fallback encoding
         fallback = lui.config('ui', 'fallbackencoding')
         if fallback:
             encoding.fallbackencoding = fallback
 
         fullargs = args
         cmd, func, args, options, cmdoptions = _parse(lui, args)
 
         if options["config"] != req.earlyoptions["config"]:
             raise error.Abort(_("option --config may not be abbreviated!"))
         if options["cwd"] != req.earlyoptions["cwd"]:
             raise error.Abort(_("option --cwd may not be abbreviated!"))
         if options["repository"] != req.earlyoptions["repository"]:
             raise error.Abort(_(
                 "option -R has to be separated from other options (e.g. not "
                 "-qR) and --repository may only be abbreviated as --repo!"))
         if options["debugger"] != req.earlyoptions["debugger"]:
             raise error.Abort(_("option --debugger may not be abbreviated!"))
         # don't validate --profile/--traceback, which can be enabled from now
 
         if options["encoding"]:
             encoding.encoding = options["encoding"]
         if options["encodingmode"]:
             encoding.encodingmode = options["encodingmode"]
         if options["time"]:
             def get_times():
                 t = os.times()
                 if t[4] == 0.0:
                     # Windows leaves this as zero, so use time.clock()
                     t = (t[0], t[1], t[2], t[3], time.clock())
                 return t
             s = get_times()
             def print_time():
                 t = get_times()
                 ui.warn(
                     _("time: real %.3f secs (user %.3f+%.3f sys %.3f+%.3f)\n") %
                     (t[4]-s[4], t[0]-s[0], t[2]-s[2], t[1]-s[1], t[3]-s[3]))
             ui.atexit(print_time)
         if options["profile"]:
             profiler.start()
 
         if options['verbose'] or options['debug'] or options['quiet']:
             for opt in ('verbose', 'debug', 'quiet'):
                 val = pycompat.bytestr(bool(options[opt]))
                 for ui_ in uis:
                     ui_.setconfig('ui', opt, val, '--' + opt)
 
         if options['traceback']:
             for ui_ in uis:
                 ui_.setconfig('ui', 'traceback', 'on', '--traceback')
 
         if options['noninteractive']:
             for ui_ in uis:
                 ui_.setconfig('ui', 'interactive', 'off', '-y')
 
         if cmdoptions.get('insecure', False):
             for ui_ in uis:
                 ui_.insecureconnections = True
 
         # setup color handling before pager, because setting up pager
         # might cause incorrect console information
         coloropt = options['color']
         for ui_ in uis:
             if coloropt:
                 ui_.setconfig('ui', 'color', coloropt, '--color')
             color.setup(ui_)
 
         if stringutil.parsebool(options['pager']):
             # ui.pager() expects 'internal-always-' prefix in this case
             ui.pager('internal-always-' + cmd)
         elif options['pager'] != 'auto':
             for ui_ in uis:
                 ui_.disablepager()
 
         if options['version']:
             return commands.version_(ui)
         if options['help']:
             return commands.help_(ui, cmd, command=cmd is not None)
         elif not cmd:
             return commands.help_(ui, 'shortlist')
 
         repo = None
         cmdpats = args[:]
         if not func.norepo:
             # use the repo from the request only if we don't have -R
             if not rpath and not cwd:
                 repo = req.repo
 
             if repo:
                 # set the descriptors of the repo ui to those of ui
                 repo.ui.fin = ui.fin
                 repo.ui.fout = ui.fout
                 repo.ui.ferr = ui.ferr
             else:
                 try:
                     repo = hg.repository(ui, path=path,
                                          presetupfuncs=req.prereposetups)
                     if not repo.local():
                         raise error.Abort(_("repository '%s' is not local")
                                           % path)
                     repo.ui.setconfig("bundle", "mainreporoot", repo.root,
                                       'repo')
                 except error.RequirementError:
                     raise
                 except error.RepoError:
                     if rpath: # invalid -R path
                         raise
                     if not func.optionalrepo:
                         if func.inferrepo and args and not path:
                             # try to infer -R from command args
                             repos = pycompat.maplist(cmdutil.findrepo, args)
                             guess = repos[0]
                             if guess and repos.count(guess) == len(repos):
                                 req.args = ['--repository', guess] + fullargs
                                 req.earlyoptions['repository'] = guess
                                 return _dispatch(req)
                         if not path:
                             raise error.RepoError(_("no repository found in"
                                                     " '%s' (.hg not found)")
                                                   % pycompat.getcwd())
                         raise
             if repo:
                 ui = repo.ui
                 if options['hidden']:
                     repo = repo.unfiltered()
             args.insert(0, repo)
         elif rpath:
             ui.warn(_("warning: --repository ignored\n"))
 
         msg = _formatargs(fullargs)
         ui.log("command", '%s\n', msg)
         strcmdopt = pycompat.strkwargs(cmdoptions)
         d = lambda: util.checksignature(func)(ui, *args, **strcmdopt)
         try:
             return runcommand(lui, repo, cmd, fullargs, ui, options, d,
                               cmdpats, cmdoptions)
         finally:
             if repo and repo != req.repo:
                 repo.close()
 
 def _runcommand(ui, options, cmd, cmdfunc):
     """Run a command function, possibly with profiling enabled."""
     try:
         return cmdfunc()
     except error.SignatureError:
         raise error.CommandError(cmd, _('invalid arguments'))
 
 def _exceptionwarning(ui):
     """Produce a warning message for the current active exception"""
 
     # For compatibility checking, we discard the portion of the hg
     # version after the + on the assumption that if a "normal
     # user" is running a build with a + in it the packager
     # probably built from fairly close to a tag and anyone with a
     # 'make local' copy of hg (where the version number can be out
     # of date) will be clueful enough to notice the implausible
     # version number and try updating.
     ct = util.versiontuple(n=2)
     worst = None, ct, ''
     if ui.config('ui', 'supportcontact') is None:
         for name, mod in extensions.extensions():
             # 'testedwith' should be bytes, but not all extensions are ported
             # to py3 and we don't want UnicodeException because of that.
             testedwith = stringutil.forcebytestr(getattr(mod, 'testedwith', ''))
             report = getattr(mod, 'buglink', _('the extension author.'))
             if not testedwith.strip():
                 # We found an untested extension. It's likely the culprit.
                 worst = name, 'unknown', report
                 break
 
             # Never blame on extensions bundled with Mercurial.
             if extensions.ismoduleinternal(mod):
                 continue
 
             tested = [util.versiontuple(t, 2) for t in testedwith.split()]
             if ct in tested:
                 continue
 
             lower = [t for t in tested if t < ct]
             nearest = max(lower or tested)
             if worst[0] is None or nearest < worst[1]:
                 worst = name, nearest, report
     if worst[0] is not None:
         name, testedwith, report = worst
         if not isinstance(testedwith, (bytes, str)):
             testedwith = '.'.join([stringutil.forcebytestr(c)
                                    for c in testedwith])
         warning = (_('** Unknown exception encountered with '
                      'possibly-broken third-party extension %s\n'
                      '** which supports versions %s of Mercurial.\n'
                      '** Please disable %s and try your action again.\n'
                      '** If that fixes the bug please report it to %s\n')
                    % (name, testedwith, name, report))
     else:
         bugtracker = ui.config('ui', 'supportcontact')
         if bugtracker is None:
             bugtracker = _("https://mercurial-scm.org/wiki/BugTracker")
         warning = (_("** unknown exception encountered, "
                      "please report by visiting\n** ") + bugtracker + '\n')
     sysversion = pycompat.sysbytes(sys.version).replace('\n', '')
     warning += ((_("** Python %s\n") % sysversion) +
                 (_("** Mercurial Distributed SCM (version %s)\n") %
                  util.version()) +
                 (_("** Extensions loaded: %s\n") %
                  ", ".join([x[0] for x in extensions.extensions()])))
     return warning
 
 def handlecommandexception(ui):
     """Produce a warning message for broken commands
 
     Called when handling an exception; the exception is reraised if
     this function returns False, ignored otherwise.
     """
     warning = _exceptionwarning(ui)
     ui.log("commandexception", "%s\n%s\n", warning,
            pycompat.sysbytes(traceback.format_exc()))
     ui.warn(warning)
     return False  # re-raise the exception

mercurial/help.py

@@ -1,689 +1,689 b''
 # help.py - help data for mercurial
 #
 # Copyright 2006 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import itertools
 import os
 import textwrap
 
 from .i18n import (
     _,
     gettext,
 )
 from . import (
     cmdutil,
     encoding,
     error,
     extensions,
     fancyopts,
     filemerge,
     fileset,
     minirst,
     pycompat,
     revset,
     templatefilters,
     templatefuncs,
     templatekw,
     util,
 )
 from .hgweb import (
     webcommands,
 )
 
 _exclkeywords = {
     "(ADVANCED)",
     "(DEPRECATED)",
     "(EXPERIMENTAL)",
     # i18n: "(ADVANCED)" is a keyword, must be translated consistently
     _("(ADVANCED)"),
     # i18n: "(DEPRECATED)" is a keyword, must be translated consistently
     _("(DEPRECATED)"),
     # i18n: "(EXPERIMENTAL)" is a keyword, must be translated consistently
     _("(EXPERIMENTAL)"),
 }
 
 def listexts(header, exts, indent=1, showdeprecated=False):
     '''return a text listing of the given extensions'''
     rst = []
     if exts:
         for name, desc in sorted(exts.iteritems()):
             if not showdeprecated and any(w in desc for w in _exclkeywords):
                 continue
             rst.append('%s:%s: %s\n' % (' ' * indent, name, desc))
     if rst:
         rst.insert(0, '\n%s\n\n' % header)
     return rst
 
 def extshelp(ui):
     rst = loaddoc('extensions')(ui).splitlines(True)
     rst.extend(listexts(
         _('enabled extensions:'), extensions.enabled(), showdeprecated=True))
     rst.extend(listexts(_('disabled extensions:'), extensions.disabled(),
                         showdeprecated=ui.verbose))
     doc = ''.join(rst)
     return doc
 
 def optrst(header, options, verbose):
     data = []
     multioccur = False
     for option in options:
         if len(option) == 5:
             shortopt, longopt, default, desc, optlabel = option
         else:
             shortopt, longopt, default, desc = option
             optlabel = _("VALUE") # default label
 
         if not verbose and any(w in desc for w in _exclkeywords):
             continue
 
         so = ''
         if shortopt:
             so = '-' + shortopt
         lo = '--' + longopt
 
         if isinstance(default, fancyopts.customopt):
             default = default.getdefaultvalue()
         if default and not callable(default):
             # default is of unknown type, and in Python 2 we abused
             # the %s-shows-repr property to handle integers etc. To
             # match that behavior on Python 3, we do str(default) and
             # then convert it to bytes.
             desc += _(" (default: %s)") % pycompat.bytestr(default)
 
         if isinstance(default, list):
             lo += " %s [+]" % optlabel
             multioccur = True
         elif (default is not None) and not isinstance(default, bool):
             lo += " %s" % optlabel
 
         data.append((so, lo, desc))
 
     if multioccur:
         header += (_(" ([+] can be repeated)"))
 
     rst = ['\n%s:\n\n' % header]
     rst.extend(minirst.maketable(data, 1))
 
     return ''.join(rst)
 
 def indicateomitted(rst, omitted, notomitted=None):
     rst.append('\n\n.. container:: omitted\n\n    %s\n\n' % omitted)
     if notomitted:
         rst.append('\n\n.. container:: notomitted\n\n    %s\n\n' % notomitted)
 
 def filtercmd(ui, cmd, kw, doc):
     if not ui.debugflag and cmd.startswith("debug") and kw != "debug":
         return True
     if not ui.verbose and doc and any(w in doc for w in _exclkeywords):
         return True
     return False
 
 def topicmatch(ui, commands, kw):
     """Return help topics matching kw.
 
     Returns {'section': [(name, summary), ...], ...} where section is
     one of topics, commands, extensions, or extensioncommands.
     """
     kw = encoding.lower(kw)
     def lowercontains(container):
         return kw in encoding.lower(container)  # translated in helptable
     results = {'topics': [],
                'commands': [],
                'extensions': [],
                'extensioncommands': [],
                }
     for names, header, doc in helptable:
         # Old extensions may use a str as doc.
         if (sum(map(lowercontains, names))
             or lowercontains(header)
             or (callable(doc) and lowercontains(doc(ui)))):
             results['topics'].append((names[0], header))
     for cmd, entry in commands.table.iteritems():
         if len(entry) == 3:
             summary = entry[2]
         else:
             summary = ''
         # translate docs *before* searching there
         docs = _(pycompat.getdoc(entry[0])) or ''
         if kw in cmd or lowercontains(summary) or lowercontains(docs):
             doclines = docs.splitlines()
             if doclines:
                 summary = doclines[0]
             cmdname = cmdutil.parsealiases(cmd)[0]
             if filtercmd(ui, cmdname, kw, docs):
                 continue
             results['commands'].append((cmdname, summary))
     for name, docs in itertools.chain(
         extensions.enabled(False).iteritems(),
         extensions.disabled().iteritems()):
         if not docs:
             continue
         name = name.rpartition('.')[-1]
         if lowercontains(name) or lowercontains(docs):
             # extension docs are already translated
             results['extensions'].append((name, docs.splitlines()[0]))
         try:
             mod = extensions.load(ui, name, '')
         except ImportError:
             # debug message would be printed in extensions.load()
             continue
         for cmd, entry in getattr(mod, 'cmdtable', {}).iteritems():
             if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])):
                 cmdname = cmdutil.parsealiases(cmd)[0]
                 cmddoc = pycompat.getdoc(entry[0])
                 if cmddoc:
                     cmddoc = gettext(cmddoc).splitlines()[0]
                 else:
                     cmddoc = _('(no help text available)')
                 if filtercmd(ui, cmdname, kw, cmddoc):
                     continue
                 results['extensioncommands'].append((cmdname, cmddoc))
     return results
 
 def loaddoc(topic, subdir=None):
     """Return a delayed loader for help/topic.txt."""
 
     def loader(ui):
         docdir = os.path.join(util.datapath, 'help')
         if subdir:
             docdir = os.path.join(docdir, subdir)
         path = os.path.join(docdir, topic + ".txt")
         doc = gettext(util.readfile(path))
         for rewriter in helphooks.get(topic, []):
             doc = rewriter(ui, topic, doc)
         return doc
 
     return loader
 
 internalstable = sorted([
     (['bundle2'], _('Bundle2'),
      loaddoc('bundle2', subdir='internals')),
     (['bundles'], _('Bundles'),
      loaddoc('bundles', subdir='internals')),
     (['censor'], _('Censor'),
      loaddoc('censor', subdir='internals')),
     (['changegroups'], _('Changegroups'),
      loaddoc('changegroups', subdir='internals')),
     (['config'], _('Config Registrar'),
      loaddoc('config', subdir='internals')),
     (['requirements'], _('Repository Requirements'),
      loaddoc('requirements', subdir='internals')),
     (['revlogs'], _('Revision Logs'),
      loaddoc('revlogs', subdir='internals')),
     (['wireprotocol'], _('Wire Protocol'),
      loaddoc('wireprotocol', subdir='internals')),
 ])
 
 def internalshelp(ui):
     """Generate the index for the "internals" topic."""
     lines = ['To access a subtopic, use "hg help internals.{subtopic-name}"\n',
              '\n']
     for names, header, doc in internalstable:
         lines.append(' :%s: %s\n' % (names[0], header))
 
     return ''.join(lines)
 
 helptable = sorted([
     (['bundlespec'], _("Bundle File Formats"), loaddoc('bundlespec')),
     (['color'], _("Colorizing Outputs"), loaddoc('color')),
     (["config", "hgrc"], _("Configuration Files"), loaddoc('config')),
     (["dates"], _("Date Formats"), loaddoc('dates')),
     (["flags"], _("Command-line flags"), loaddoc('flags')),
     (["patterns"], _("File Name Patterns"), loaddoc('patterns')),
     (['environment', 'env'], _('Environment Variables'),
      loaddoc('environment')),
     (['revisions', 'revs', 'revsets', 'revset', 'multirevs', 'mrevs'],
       _('Specifying Revisions'), loaddoc('revisions')),
     (['filesets', 'fileset'], _("Specifying File Sets"), loaddoc('filesets')),
     (['diffs'], _('Diff Formats'), loaddoc('diffs')),
     (['merge-tools', 'mergetools', 'mergetool'], _('Merge Tools'),
      loaddoc('merge-tools')),
     (['templating', 'templates', 'template', 'style'], _('Template Usage'),
      loaddoc('templates')),
     (['urls'], _('URL Paths'), loaddoc('urls')),
     (["extensions"], _("Using Additional Features"), extshelp),
     (["subrepos", "subrepo"], _("Subrepositories"), loaddoc('subrepos')),
     (["hgweb"], _("Configuring hgweb"), loaddoc('hgweb')),
     (["glossary"], _("Glossary"), loaddoc('glossary')),
     (["hgignore", "ignore"], _("Syntax for Mercurial Ignore Files"),
      loaddoc('hgignore')),
     (["phases"], _("Working with Phases"), loaddoc('phases')),
     (['scripting'], _('Using Mercurial from scripts and automation'),
      loaddoc('scripting')),
     (['internals'], _("Technical implementation topics"),
      internalshelp),
     (['pager'], _("Pager Support"), loaddoc('pager')),
 ])
 
 # Maps topics with sub-topics to a list of their sub-topics.
 subtopics = {
     'internals': internalstable,
 }
 
 # Map topics to lists of callable taking the current topic help and
 # returning the updated version
 helphooks = {}
 
 def addtopichook(topic, rewriter):
     helphooks.setdefault(topic, []).append(rewriter)
 
 def makeitemsdoc(ui, topic, doc, marker, items, dedent=False):
     """Extract docstring from the items key to function mapping, build a
     single documentation block and use it to overwrite the marker in doc.
     """
     entries = []
     for name in sorted(items):
         text = (pycompat.getdoc(items[name]) or '').rstrip()
         if (not text
             or not ui.verbose and any(w in text for w in _exclkeywords)):
             continue
         text = gettext(text)
         if dedent:
             # Abuse latin1 to use textwrap.dedent() on bytes.
             text = textwrap.dedent(text.decode('latin1')).encode('latin1')
         lines = text.splitlines()
         doclines = [(lines[0])]
         for l in lines[1:]:
             # Stop once we find some Python doctest
             if l.strip().startswith('>>>'):
                 break
             if dedent:
                 doclines.append(l.rstrip())
             else:
                 doclines.append('  ' + l.strip())
         entries.append('\n'.join(doclines))
     entries = '\n\n'.join(entries)
     return doc.replace(marker, entries)
 
 def addtopicsymbols(topic, marker, symbols, dedent=False):
     def add(ui, topic, doc):
         return makeitemsdoc(ui, topic, doc, marker, symbols, dedent=dedent)
     addtopichook(topic, add)
 
 addtopicsymbols('bundlespec', '.. bundlecompressionmarker',
                 util.bundlecompressiontopics())
 addtopicsymbols('filesets', '.. predicatesmarker', fileset.symbols)
 addtopicsymbols('merge-tools', '.. internaltoolsmarker',
                 filemerge.internalsdoc)
 addtopicsymbols('revisions', '.. predicatesmarker', revset.symbols)
 addtopicsymbols('templates', '.. keywordsmarker', templatekw.keywords)
 addtopicsymbols('templates', '.. filtersmarker', templatefilters.filters)
 addtopicsymbols('templates', '.. functionsmarker', templatefuncs.funcs)
 addtopicsymbols('hgweb', '.. webcommandsmarker', webcommands.commands,
                 dedent=True)
 
 def help_(ui, commands, name, unknowncmd=False, full=True, subtopic=None,
           **opts):
     '''
     Generate the help for 'name' as unformatted restructured text. If
     'name' is None, describe the commands available.
     '''
 
     opts = pycompat.byteskwargs(opts)
 
     def helpcmd(name, subtopic=None):
         try:
             aliases, entry = cmdutil.findcmd(name, commands.table,
                                              strict=unknowncmd)
         except error.AmbiguousCommand as inst:
             # py3k fix: except vars can't be used outside the scope of the
             # except block, nor can be used inside a lambda. python issue4617
             prefix = inst.args[0]
             select = lambda c: cmdutil.parsealiases(c)[0].startswith(prefix)
             rst = helplist(select)
             return rst
 
         rst = []
 
         # check if it's an invalid alias and display its error if it is
         if getattr(entry[0], 'badalias', None):
             rst.append(entry[0].badalias + '\n')
             if entry[0].unknowncmd:
                 try:
                     rst.extend(helpextcmd(entry[0].cmdname))
                 except error.UnknownCommand:
                     pass
             return rst
 
         # synopsis
         if len(entry) > 2:
             if entry[2].startswith('hg'):
                 rst.append("%s\n" % entry[2])
             else:
                 rst.append('hg %s %s\n' % (aliases[0], entry[2]))
         else:
             rst.append('hg %s\n' % aliases[0])
         # aliases
         if full and not ui.quiet and len(aliases) > 1:
             rst.append(_("\naliases: %s\n") % ', '.join(aliases[1:]))
         rst.append('\n')
 
         # description
         doc = gettext(pycompat.getdoc(entry[0]))
         if not doc:
             doc = _("(no help text available)")
         if util.safehasattr(entry[0], 'definition'):  # aliased command
             source = entry[0].source
             if entry[0].definition.startswith('!'):  # shell alias
-                doc = (_('shell alias for::\n\n    %s\n\ndefined by: %s\n') %
-                       (entry[0].definition[1:], source))
+                doc = (_('shell alias for: %s\n\n%s\n\ndefined by: %s\n') %
+                       (entry[0].definition[1:], doc, source))
             else:
                 doc = (_('alias for: hg %s\n\n%s\n\ndefined by: %s\n') %
                        (entry[0].definition, doc, source))
         doc = doc.splitlines(True)
         if ui.quiet or not full:
             rst.append(doc[0])
         else:
             rst.extend(doc)
         rst.append('\n')
 
         # check if this command shadows a non-trivial (multi-line)
         # extension help text
         try:
             mod = extensions.find(name)
             doc = gettext(pycompat.getdoc(mod)) or ''
             if '\n' in doc.strip():
                 msg = _("(use 'hg help -e %s' to show help for "
                         "the %s extension)") % (name, name)
                 rst.append('\n%s\n' % msg)
         except KeyError:
             pass
 
         # options
         if not ui.quiet and entry[1]:
             rst.append(optrst(_("options"), entry[1], ui.verbose))
 
         if ui.verbose:
             rst.append(optrst(_("global options"),
                               commands.globalopts, ui.verbose))
 
         if not ui.verbose:
             if not full:
                 rst.append(_("\n(use 'hg %s -h' to show more help)\n")
                            % name)
             elif not ui.quiet:
                 rst.append(_('\n(some details hidden, use --verbose '
                                'to show complete help)'))
 
         return rst
 
 
     def helplist(select=None, **opts):
         # list of commands
         if name == "shortlist":
             header = _('basic commands:\n\n')
         elif name == "debug":
             header = _('debug commands (internal and unsupported):\n\n')
         else:
             header = _('list of commands:\n\n')
 
         h = {}
         cmds = {}
         for c, e in commands.table.iteritems():
             fs = cmdutil.parsealiases(c)
             f = fs[0]
             p = ''
             if c.startswith("^"):
                 p = '^'
             if select and not select(p + f):
                 continue
             if (not select and name != 'shortlist' and
                 e[0].__module__ != commands.__name__):
                 continue
             if name == "shortlist" and not p:
                 continue
             doc = pycompat.getdoc(e[0])
             if filtercmd(ui, f, name, doc):
                 continue
             doc = gettext(doc)
             if not doc:
                 doc = _("(no help text available)")
             h[f] = doc.splitlines()[0].rstrip()
             cmds[f] = '|'.join(fs)
 
         rst = []
         if not h:
             if not ui.quiet:
                 rst.append(_('no commands defined\n'))
             return rst
 
         if not ui.quiet:
             rst.append(header)
         fns = sorted(h)
         for f in fns:
             if ui.verbose:
                 commacmds = cmds[f].replace("|",", ")
                 rst.append(" :%s: %s\n" % (commacmds, h[f]))
             else:
                 rst.append(' :%s: %s\n' % (f, h[f]))
 
         ex = opts.get
         anyopts = (ex(r'keyword') or not (ex(r'command') or ex(r'extension')))
         if not name and anyopts:
             exts = listexts(_('enabled extensions:'), extensions.enabled())
             if exts:
                 rst.append('\n')
                 rst.extend(exts)
 
             rst.append(_("\nadditional help topics:\n\n"))
             topics = []
             for names, header, doc in helptable:
                 topics.append((names[0], header))
             for t, desc in topics:
                 rst.append(" :%s: %s\n" % (t, desc))
 
         if ui.quiet:
             pass
         elif ui.verbose:
             rst.append('\n%s\n' % optrst(_("global options"),
                                          commands.globalopts, ui.verbose))
             if name == 'shortlist':
                 rst.append(_("\n(use 'hg help' for the full list "
                              "of commands)\n"))
         else:
             if name == 'shortlist':
                 rst.append(_("\n(use 'hg help' for the full list of commands "
                              "or 'hg -v' for details)\n"))
             elif name and not full:
                 rst.append(_("\n(use 'hg help %s' to show the full help "
                              "text)\n") % name)
             elif name and cmds and name in cmds.keys():
                 rst.append(_("\n(use 'hg help -v -e %s' to show built-in "
                              "aliases and global options)\n") % name)
             else:
                 rst.append(_("\n(use 'hg help -v%s' to show built-in aliases "
                              "and global options)\n")
                            % (name and " " + name or ""))
         return rst
 
     def helptopic(name, subtopic=None):
         # Look for sub-topic entry first.
         header, doc = None, None
         if subtopic and name in subtopics:
             for names, header, doc in subtopics[name]:
                 if subtopic in names:
                     break
 
         if not header:
             for names, header, doc in helptable:
                 if name in names:
                     break
             else:
                 raise error.UnknownCommand(name)
 
         rst = [minirst.section(header)]
 
         # description
         if not doc:
             rst.append("    %s\n" % _("(no help text available)"))
         if callable(doc):
             rst += ["    %s\n" % l for l in doc(ui).splitlines()]
 
         if not ui.verbose:
             omitted = _('(some details hidden, use --verbose'
                          ' to show complete help)')
             indicateomitted(rst, omitted)
 
         try:
             cmdutil.findcmd(name, commands.table)
             rst.append(_("\nuse 'hg help -c %s' to see help for "
                        "the %s command\n") % (name, name))
         except error.UnknownCommand:
             pass
         return rst
 
     def helpext(name, subtopic=None):
         try:
             mod = extensions.find(name)
             doc = gettext(pycompat.getdoc(mod)) or _('no help text available')
         except KeyError:
             mod = None
             doc = extensions.disabledext(name)
             if not doc:
                 raise error.UnknownCommand(name)
 
         if '\n' not in doc:
             head, tail = doc, ""
         else:
             head, tail = doc.split('\n', 1)
         rst = [_('%s extension - %s\n\n') % (name.rpartition('.')[-1], head)]
         if tail:
             rst.extend(tail.splitlines(True))
             rst.append('\n')
 
         if not ui.verbose:
             omitted = _('(some details hidden, use --verbose'
                          ' to show complete help)')
             indicateomitted(rst, omitted)
 
         if mod:
             try:
                 ct = mod.cmdtable
             except AttributeError:
                 ct = {}
             modcmds = set([c.partition('|')[0] for c in ct])
             rst.extend(helplist(modcmds.__contains__))
         else:
             rst.append(_("(use 'hg help extensions' for information on enabling"
                        " extensions)\n"))
         return rst
 
     def helpextcmd(name, subtopic=None):
         cmd, ext, mod = extensions.disabledcmd(ui, name,
                                                ui.configbool('ui', 'strict'))
         doc = gettext(pycompat.getdoc(mod)).splitlines()[0]
 
         rst = listexts(_("'%s' is provided by the following "
                               "extension:") % cmd, {ext: doc}, indent=4,
                        showdeprecated=True)
         rst.append('\n')
         rst.append(_("(use 'hg help extensions' for information on enabling "
                    "extensions)\n"))
         return rst
 
 
     rst = []
     kw = opts.get('keyword')
     if kw or name is None and any(opts[o] for o in opts):
         matches = topicmatch(ui, commands, name or '')
         helpareas = []
         if opts.get('extension'):
             helpareas += [('extensions', _('Extensions'))]
         if opts.get('command'):
             helpareas += [('commands', _('Commands'))]
         if not helpareas:
             helpareas = [('topics', _('Topics')),
                          ('commands', _('Commands')),
                          ('extensions', _('Extensions')),
                          ('extensioncommands', _('Extension Commands'))]
         for t, title in helpareas:
             if matches[t]:
                 rst.append('%s:\n\n' % title)
                 rst.extend(minirst.maketable(sorted(matches[t]), 1))
                 rst.append('\n')
         if not rst:
             msg = _('no matches')
             hint = _("try 'hg help' for a list of topics")
             raise error.Abort(msg, hint=hint)
     elif name and name != 'shortlist':
         queries = []
         if unknowncmd:
             queries += [helpextcmd]
         if opts.get('extension'):
             queries += [helpext]
         if opts.get('command'):
             queries += [helpcmd]
         if not queries:
             queries = (helptopic, helpcmd, helpext, helpextcmd)
         for f in queries:
             try:
                 rst = f(name, subtopic)
                 break
             except error.UnknownCommand:
                 pass
         else:
             if unknowncmd:
                 raise error.UnknownCommand(name)
             else:
                 msg = _('no such help topic: %s') % name
                 hint = _("try 'hg help --keyword %s'") % name
                 raise error.Abort(msg, hint=hint)
     else:
         # program name
         if not ui.quiet:
             rst = [_("Mercurial Distributed SCM\n"), '\n']
         rst.extend(helplist(None, **pycompat.strkwargs(opts)))
 
     return ''.join(rst)
 
 def formattedhelp(ui, commands, name, keep=None, unknowncmd=False, full=True,
                   **opts):
     """get help for a given topic (as a dotted name) as rendered rst
 
     Either returns the rendered help text or raises an exception.
     """
     if keep is None:
         keep = []
     else:
         keep = list(keep) # make a copy so we can mutate this later
     fullname = name
     section = None
     subtopic = None
     if name and '.' in name:
         name, remaining = name.split('.', 1)
         remaining = encoding.lower(remaining)
         if '.' in remaining:
             subtopic, section = remaining.split('.', 1)
         else:
             if name in subtopics:
                 subtopic = remaining
             else:
                 section = remaining
     textwidth = ui.configint('ui', 'textwidth')
     termwidth = ui.termwidth() - 2
     if textwidth <= 0 or termwidth < textwidth:
         textwidth = termwidth
     text = help_(ui, commands, name,
                  subtopic=subtopic, unknowncmd=unknowncmd, full=full, **opts)
 
     formatted, pruned = minirst.format(text, textwidth, keep=keep,
                                        section=section)
 
     # We could have been given a weird ".foo" section without a name
     # to look for, or we could have simply failed to found "foo.bar"
     # because bar isn't a section of foo
     if section and not (formatted and name):
         raise error.Abort(_("help section not found: %s") % fullname)
 
     if 'verbose' in pruned:
         keep.append('omitted')
     else:
         keep.append('notomitted')
     formatted, pruned = minirst.format(text, textwidth, keep=keep,
                                        section=section)
     return formatted

mercurial/ui.py

@@ -1,1874 +1,1870 b''
 # ui.py - user interface bits for mercurial
 #
 # Copyright 2005-2007 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import collections
 import contextlib
 import errno
 import getpass
 import inspect
 import os
 import re
 import signal
 import socket
 import subprocess
 import sys
 import tempfile
 import traceback
 
 from .i18n import _
 from .node import hex
 
 from . import (
     color,
     config,
     configitems,
     encoding,
     error,
     formatter,
     progress,
     pycompat,
     rcutil,
     scmutil,
     util,
 )
 from .utils import (
     dateutil,
     procutil,
     stringutil,
 )
 
 urlreq = util.urlreq
 
 # for use with str.translate(None, _keepalnum), to keep just alphanumerics
 _keepalnum = ''.join(c for c in map(pycompat.bytechr, range(256))
                      if not c.isalnum())
 
 # The config knobs that will be altered (if unset) by ui.tweakdefaults.
 tweakrc = b"""
 [ui]
 # The rollback command is dangerous. As a rule, don't use it.
 rollback = False
 # Make `hg status` report copy information
 statuscopies = yes
 # Prefer curses UIs when available. Revert to plain-text with `text`.
 interface = curses
 
 [commands]
 # Make `hg status` emit cwd-relative paths by default.
 status.relative = yes
 # Refuse to perform an `hg update` that would cause a file content merge
 update.check = noconflict
 # Show conflicts information in `hg status`
 status.verbose = True
 # Skip the bisect state in conflicts information in `hg status`
 status.skipstates = bisect
 
 [diff]
 git = 1
 showfunc = 1
 """
 
 samplehgrcs = {
     'user':
 b"""# example user config (see 'hg help config' for more info)
 [ui]
 # name and email, e.g.
 # username = Jane Doe <[e-mail]>
 username =
 
 # We recommend enabling tweakdefaults to get slight improvements to
 # the UI over time. Make sure to set HGPLAIN in the environment when
 # writing scripts!
 # tweakdefaults = True
 
 # uncomment to disable color in command output
 # (see 'hg help color' for details)
 # color = never
 
 # uncomment to disable command output pagination
 # (see 'hg help pager' for details)
 # paginate = never
 
 [extensions]
 # uncomment these lines to enable some popular extensions
 # (see 'hg help extensions' for more info)
 #
 # churn =
 """,
 
     'cloned':
 b"""# example repository config (see 'hg help config' for more info)
 [paths]
 default = %s
 
 # path aliases to other clones of this repo in URLs or filesystem paths
 # (see 'hg help config.paths' for more info)
 #
 # default:pushurl = ssh://[e-mail]/hg/jdoes-fork
 # my-fork         = ssh://[e-mail]/hg/jdoes-fork
 # my-clone        = /home/jdoe/jdoes-clone
 
 [ui]
 # name and email (local to this repository, optional), e.g.
 # username = Jane Doe <[e-mail]>
 """,
 
     'local':
 b"""# example repository config (see 'hg help config' for more info)
 [paths]
 # path aliases to other clones of this repo in URLs or filesystem paths
 # (see 'hg help config.paths' for more info)
 #
 # default         = http://example.com/hg/example-repo
 # default:pushurl = ssh://[e-mail]/hg/jdoes-fork
 # my-fork         = ssh://[e-mail]/hg/jdoes-fork
 # my-clone        = /home/jdoe/jdoes-clone
 
 [ui]
 # name and email (local to this repository, optional), e.g.
 # username = Jane Doe <[e-mail]>
 """,
 
     'global':
 b"""# example system-wide hg config (see 'hg help config' for more info)
 
 [ui]
 # uncomment to disable color in command output
 # (see 'hg help color' for details)
 # color = never
 
 # uncomment to disable command output pagination
 # (see 'hg help pager' for details)
 # paginate = never
 
 [extensions]
 # uncomment these lines to enable some popular extensions
 # (see 'hg help extensions' for more info)
 #
 # blackbox =
 # churn =
 """,
 }
 
 def _maybestrurl(maybebytes):
     return util.rapply(pycompat.strurl, maybebytes)
 
 def _maybebytesurl(maybestr):
     return util.rapply(pycompat.bytesurl, maybestr)
 
 class httppasswordmgrdbproxy(object):
     """Delays loading urllib2 until it's needed."""
     def __init__(self):
         self._mgr = None
 
     def _get_mgr(self):
         if self._mgr is None:
             self._mgr = urlreq.httppasswordmgrwithdefaultrealm()
         return self._mgr
 
     def add_password(self, realm, uris, user, passwd):
         return self._get_mgr().add_password(
             _maybestrurl(realm), _maybestrurl(uris),
             _maybestrurl(user), _maybestrurl(passwd))
 
     def find_user_password(self, realm, uri):
         mgr = self._get_mgr()
         return _maybebytesurl(mgr.find_user_password(_maybestrurl(realm),
                                                      _maybestrurl(uri)))
 
 def _catchterm(*args):
     raise error.SignalInterrupt
 
 # unique object used to detect no default value has been provided when
 # retrieving configuration value.
 _unset = object()
 
 # _reqexithandlers: callbacks run at the end of a request
 _reqexithandlers = []
 
 class ui(object):
     def __init__(self, src=None):
         """Create a fresh new ui object if no src given
 
         Use uimod.ui.load() to create a ui which knows global and user configs.
         In most cases, you should use ui.copy() to create a copy of an existing
         ui object.
         """
         # _buffers: used for temporary capture of output
         self._buffers = []
         # 3-tuple describing how each buffer in the stack behaves.
         # Values are (capture stderr, capture subprocesses, apply labels).
         self._bufferstates = []
         # When a buffer is active, defines whether we are expanding labels.
         # This exists to prevent an extra list lookup.
         self._bufferapplylabels = None
         self.quiet = self.verbose = self.debugflag = self.tracebackflag = False
         self._reportuntrusted = True
         self._knownconfig = configitems.coreitems
         self._ocfg = config.config() # overlay
         self._tcfg = config.config() # trusted
         self._ucfg = config.config() # untrusted
         self._trustusers = set()
         self._trustgroups = set()
         self.callhooks = True
         # Insecure server connections requested.
         self.insecureconnections = False
         # Blocked time
         self.logblockedtimes = False
         # color mode: see mercurial/color.py for possible value
         self._colormode = None
         self._terminfoparams = {}
         self._styles = {}
 
         if src:
             self.fout = src.fout
             self.ferr = src.ferr
             self.fin = src.fin
             self.pageractive = src.pageractive
             self._disablepager = src._disablepager
             self._tweaked = src._tweaked
 
             self._tcfg = src._tcfg.copy()
             self._ucfg = src._ucfg.copy()
             self._ocfg = src._ocfg.copy()
             self._trustusers = src._trustusers.copy()
             self._trustgroups = src._trustgroups.copy()
             self.environ = src.environ
             self.callhooks = src.callhooks
             self.insecureconnections = src.insecureconnections
             self._colormode = src._colormode
             self._terminfoparams = src._terminfoparams.copy()
             self._styles = src._styles.copy()
 
             self.fixconfig()
 
             self.httppasswordmgrdb = src.httppasswordmgrdb
             self._blockedtimes = src._blockedtimes
         else:
             self.fout = procutil.stdout
             self.ferr = procutil.stderr
             self.fin = procutil.stdin
             self.pageractive = False
             self._disablepager = False
             self._tweaked = False
 
             # shared read-only environment
             self.environ = encoding.environ
 
             self.httppasswordmgrdb = httppasswordmgrdbproxy()
             self._blockedtimes = collections.defaultdict(int)
 
         allowed = self.configlist('experimental', 'exportableenviron')
         if '*' in allowed:
             self._exportableenviron = self.environ
         else:
             self._exportableenviron = {}
             for k in allowed:
                 if k in self.environ:
                     self._exportableenviron[k] = self.environ[k]
 
     @classmethod
     def load(cls):
         """Create a ui and load global and user configs"""
         u = cls()
         # we always trust global config files and environment variables
         for t, f in rcutil.rccomponents():
             if t == 'path':
                 u.readconfig(f, trust=True)
             elif t == 'items':
                 sections = set()
                 for section, name, value, source in f:
                     # do not set u._ocfg
                     # XXX clean this up once immutable config object is a thing
                     u._tcfg.set(section, name, value, source)
                     u._ucfg.set(section, name, value, source)
                     sections.add(section)
                 for section in sections:
                     u.fixconfig(section=section)
             else:
                 raise error.ProgrammingError('unknown rctype: %s' % t)
         u._maybetweakdefaults()
         return u
 
     def _maybetweakdefaults(self):
         if not self.configbool('ui', 'tweakdefaults'):
             return
         if self._tweaked or self.plain('tweakdefaults'):
             return
 
         # Note: it is SUPER IMPORTANT that you set self._tweaked to
         # True *before* any calls to setconfig(), otherwise you'll get
         # infinite recursion between setconfig and this method.
         #
         # TODO: We should extract an inner method in setconfig() to
         # avoid this weirdness.
         self._tweaked = True
         tmpcfg = config.config()
         tmpcfg.parse('<tweakdefaults>', tweakrc)
         for section in tmpcfg:
             for name, value in tmpcfg.items(section):
                 if not self.hasconfig(section, name):
                     self.setconfig(section, name, value, "<tweakdefaults>")
 
     def copy(self):
         return self.__class__(self)
 
     def resetstate(self):
         """Clear internal state that shouldn't persist across commands"""
         if self._progbar:
             self._progbar.resetstate()  # reset last-print time of progress bar
         self.httppasswordmgrdb = httppasswordmgrdbproxy()
 
     @contextlib.contextmanager
     def timeblockedsection(self, key):
         # this is open-coded below - search for timeblockedsection to find them
         starttime = util.timer()
         try:
             yield
         finally:
             self._blockedtimes[key + '_blocked'] += \
                 (util.timer() - starttime) * 1000
 
     def formatter(self, topic, opts):
         return formatter.formatter(self, self, topic, opts)
 
     def _trusted(self, fp, f):
         st = util.fstat(fp)
         if util.isowner(st):
             return True
 
         tusers, tgroups = self._trustusers, self._trustgroups
         if '*' in tusers or '*' in tgroups:
             return True
 
         user = util.username(st.st_uid)
         group = util.groupname(st.st_gid)
         if user in tusers or group in tgroups or user == util.username():
             return True
 
         if self._reportuntrusted:
             self.warn(_('not trusting file %s from untrusted '
                         'user %s, group %s\n') % (f, user, group))
         return False
 
     def readconfig(self, filename, root=None, trust=False,
                    sections=None, remap=None):
         try:
             fp = open(filename, u'rb')
         except IOError:
             if not sections: # ignore unless we were looking for something
                 return
             raise
 
         cfg = config.config()
         trusted = sections or trust or self._trusted(fp, filename)
 
         try:
             cfg.read(filename, fp, sections=sections, remap=remap)
             fp.close()
         except error.ConfigError as inst:
             if trusted:
                 raise
             self.warn(_("ignored: %s\n") % stringutil.forcebytestr(inst))
 
         if self.plain():
             for k in ('debug', 'fallbackencoding', 'quiet', 'slash',
                       'logtemplate', 'statuscopies', 'style',
                       'traceback', 'verbose'):
                 if k in cfg['ui']:
                     del cfg['ui'][k]
             for k, v in cfg.items('defaults'):
                 del cfg['defaults'][k]
             for k, v in cfg.items('commands'):
                 del cfg['commands'][k]
         # Don't remove aliases from the configuration if in the exceptionlist
         if self.plain('alias'):
             for k, v in cfg.items('alias'):
                 del cfg['alias'][k]
         if self.plain('revsetalias'):
             for k, v in cfg.items('revsetalias'):
                 del cfg['revsetalias'][k]
         if self.plain('templatealias'):
             for k, v in cfg.items('templatealias'):
                 del cfg['templatealias'][k]
 
         if trusted:
             self._tcfg.update(cfg)
             self._tcfg.update(self._ocfg)
         self._ucfg.update(cfg)
         self._ucfg.update(self._ocfg)
 
         if root is None:
             root = os.path.expanduser('~')
         self.fixconfig(root=root)
 
     def fixconfig(self, root=None, section=None):
         if section in (None, 'paths'):
             # expand vars and ~
             # translate paths relative to root (or home) into absolute paths
             root = root or pycompat.getcwd()
             for c in self._tcfg, self._ucfg, self._ocfg:
                 for n, p in c.items('paths'):
                     # Ignore sub-options.
                     if ':' in n:
                         continue
                     if not p:
                         continue
                     if '%%' in p:
                         s = self.configsource('paths', n) or 'none'
                         self.warn(_("(deprecated '%%' in path %s=%s from %s)\n")
                                   % (n, p, s))
                         p = p.replace('%%', '%')
                     p = util.expandpath(p)
                     if not util.hasscheme(p) and not os.path.isabs(p):
                         p = os.path.normpath(os.path.join(root, p))
                     c.set("paths", n, p)
 
         if section in (None, 'ui'):
             # update ui options
             self.debugflag = self.configbool('ui', 'debug')
             self.verbose = self.debugflag or self.configbool('ui', 'verbose')
             self.quiet = not self.debugflag and self.configbool('ui', 'quiet')
             if self.verbose and self.quiet:
                 self.quiet = self.verbose = False
             self._reportuntrusted = self.debugflag or self.configbool("ui",
                 "report_untrusted")
             self.tracebackflag = self.configbool('ui', 'traceback')
             self.logblockedtimes = self.configbool('ui', 'logblockedtimes')
 
         if section in (None, 'trusted'):
             # update trust information
             self._trustusers.update(self.configlist('trusted', 'users'))
             self._trustgroups.update(self.configlist('trusted', 'groups'))
 
     def backupconfig(self, section, item):
         return (self._ocfg.backup(section, item),
                 self._tcfg.backup(section, item),
                 self._ucfg.backup(section, item),)
     def restoreconfig(self, data):
         self._ocfg.restore(data[0])
         self._tcfg.restore(data[1])
         self._ucfg.restore(data[2])
 
     def setconfig(self, section, name, value, source=''):
         for cfg in (self._ocfg, self._tcfg, self._ucfg):
             cfg.set(section, name, value, source)
         self.fixconfig(section=section)
         self._maybetweakdefaults()
 
     def _data(self, untrusted):
         return untrusted and self._ucfg or self._tcfg
 
     def configsource(self, section, name, untrusted=False):
         return self._data(untrusted).source(section, name)
 
     def config(self, section, name, default=_unset, untrusted=False):
         """return the plain string version of a config"""
         value = self._config(section, name, default=default,
                              untrusted=untrusted)
         if value is _unset:
             return None
         return value
 
     def _config(self, section, name, default=_unset, untrusted=False):
         value = itemdefault = default
         item = self._knownconfig.get(section, {}).get(name)
         alternates = [(section, name)]
 
         if item is not None:
             alternates.extend(item.alias)
             if callable(item.default):
                 itemdefault = item.default()
             else:
                 itemdefault = item.default
         else:
             msg = ("accessing unregistered config item: '%s.%s'")
             msg %= (section, name)
             self.develwarn(msg, 2, 'warn-config-unknown')
 
         if default is _unset:
             if item is None:
                 value = default
             elif item.default is configitems.dynamicdefault:
                 value = None
                 msg = "config item requires an explicit default value: '%s.%s'"
                 msg %= (section, name)
                 self.develwarn(msg, 2, 'warn-config-default')
             else:
                 value = itemdefault
         elif (item is not None
               and item.default is not configitems.dynamicdefault
               and default != itemdefault):
             msg = ("specifying a mismatched default value for a registered "
                    "config item: '%s.%s' '%s'")
             msg %= (section, name, pycompat.bytestr(default))
             self.develwarn(msg, 2, 'warn-config-default')
 
         for s, n in alternates:
             candidate = self._data(untrusted).get(s, n, None)
             if candidate is not None:
                 value = candidate
                 section = s
                 name = n
                 break
 
         if self.debugflag and not untrusted and self._reportuntrusted:
             for s, n in alternates:
                 uvalue = self._ucfg.get(s, n)
                 if uvalue is not None and uvalue != value:
                     self.debug("ignoring untrusted configuration option "
                                "%s.%s = %s\n" % (s, n, uvalue))
         return value
 
     def configsuboptions(self, section, name, default=_unset, untrusted=False):
         """Get a config option and all sub-options.
 
         Some config options have sub-options that are declared with the
         format "key:opt = value". This method is used to return the main
         option and all its declared sub-options.
 
         Returns a 2-tuple of ``(option, sub-options)``, where `sub-options``
         is a dict of defined sub-options where keys and values are strings.
         """
         main = self.config(section, name, default, untrusted=untrusted)
         data = self._data(untrusted)
         sub = {}
         prefix = '%s:' % name
         for k, v in data.items(section):
             if k.startswith(prefix):
                 sub[k[len(prefix):]] = v
 
         if self.debugflag and not untrusted and self._reportuntrusted:
             for k, v in sub.items():
                 uvalue = self._ucfg.get(section, '%s:%s' % (name, k))
                 if uvalue is not None and uvalue != v:
                     self.debug('ignoring untrusted configuration option '
                                '%s:%s.%s = %s\n' % (section, name, k, uvalue))
 
         return main, sub
 
     def configpath(self, section, name, default=_unset, untrusted=False):
         'get a path config item, expanded relative to repo root or config file'
         v = self.config(section, name, default, untrusted)
         if v is None:
             return None
         if not os.path.isabs(v) or "://" not in v:
             src = self.configsource(section, name, untrusted)
             if ':' in src:
                 base = os.path.dirname(src.rsplit(':')[0])
                 v = os.path.join(base, os.path.expanduser(v))
         return v
 
     def configbool(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as a boolean
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'true', b'yes')
         >>> u.configbool(s, b'true')
         True
         >>> u.setconfig(s, b'false', b'no')
         >>> u.configbool(s, b'false')
         False
         >>> u.configbool(s, b'unknown')
         False
         >>> u.configbool(s, b'unknown', True)
         True
         >>> u.setconfig(s, b'invalid', b'somevalue')
         >>> u.configbool(s, b'invalid')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a boolean ('somevalue')
         """
 
         v = self._config(section, name, default, untrusted=untrusted)
         if v is None:
             return v
         if v is _unset:
             if default is _unset:
                 return False
             return default
         if isinstance(v, bool):
             return v
         b = stringutil.parsebool(v)
         if b is None:
             raise error.ConfigError(_("%s.%s is not a boolean ('%s')")
                                     % (section, name, v))
         return b
 
     def configwith(self, convert, section, name, default=_unset,
                    desc=None, untrusted=False):
         """parse a configuration element with a conversion function
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'float1', b'42')
         >>> u.configwith(float, s, b'float1')
         42.0
         >>> u.setconfig(s, b'float2', b'-4.25')
         >>> u.configwith(float, s, b'float2')
         -4.25
         >>> u.configwith(float, s, b'unknown', 7)
         7.0
         >>> u.setconfig(s, b'invalid', b'somevalue')
         >>> u.configwith(float, s, b'invalid')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a valid float ('somevalue')
         >>> u.configwith(float, s, b'invalid', desc=b'womble')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a valid womble ('somevalue')
         """
 
         v = self.config(section, name, default, untrusted)
         if v is None:
             return v # do not attempt to convert None
         try:
             return convert(v)
         except (ValueError, error.ParseError):
             if desc is None:
                 desc = pycompat.sysbytes(convert.__name__)
             raise error.ConfigError(_("%s.%s is not a valid %s ('%s')")
                                     % (section, name, desc, v))
 
     def configint(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as an integer
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'int1', b'42')
         >>> u.configint(s, b'int1')
         42
         >>> u.setconfig(s, b'int2', b'-42')
         >>> u.configint(s, b'int2')
         -42
         >>> u.configint(s, b'unknown', 7)
         7
         >>> u.setconfig(s, b'invalid', b'somevalue')
         >>> u.configint(s, b'invalid')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a valid integer ('somevalue')
         """
 
         return self.configwith(int, section, name, default, 'integer',
                                untrusted)
 
     def configbytes(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as a quantity in bytes
 
         Units can be specified as b (bytes), k or kb (kilobytes), m or
         mb (megabytes), g or gb (gigabytes).
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'val1', b'42')
         >>> u.configbytes(s, b'val1')
         42
         >>> u.setconfig(s, b'val2', b'42.5 kb')
         >>> u.configbytes(s, b'val2')
         43520
         >>> u.configbytes(s, b'unknown', b'7 MB')
         7340032
         >>> u.setconfig(s, b'invalid', b'somevalue')
         >>> u.configbytes(s, b'invalid')
         Traceback (most recent call last):
             ...
         ConfigError: foo.invalid is not a byte quantity ('somevalue')
         """
 
         value = self._config(section, name, default, untrusted)
         if value is _unset:
             if default is _unset:
                 default = 0
             value = default
         if not isinstance(value, bytes):
             return value
         try:
             return util.sizetoint(value)
         except error.ParseError:
             raise error.ConfigError(_("%s.%s is not a byte quantity ('%s')")
                                     % (section, name, value))
 
     def configlist(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as a list of comma/space separated
         strings
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'list1', b'this,is "a small" ,test')
         >>> u.configlist(s, b'list1')
         ['this', 'is', 'a small', 'test']
         >>> u.setconfig(s, b'list2', b'this, is "a small" , test ')
         >>> u.configlist(s, b'list2')
         ['this', 'is', 'a small', 'test']
         """
         # default is not always a list
         v = self.configwith(config.parselist, section, name, default,
                                'list', untrusted)
         if isinstance(v, bytes):
             return config.parselist(v)
         elif v is None:
             return []
         return v
 
     def configdate(self, section, name, default=_unset, untrusted=False):
         """parse a configuration element as a tuple of ints
 
         >>> u = ui(); s = b'foo'
         >>> u.setconfig(s, b'date', b'0 0')
         >>> u.configdate(s, b'date')
         (0, 0)
         """
         if self.config(section, name, default, untrusted):
             return self.configwith(dateutil.parsedate, section, name, default,
                                    'date', untrusted)
         if default is _unset:
             return None
         return default
 
     def hasconfig(self, section, name, untrusted=False):
         return self._data(untrusted).hasitem(section, name)
 
     def has_section(self, section, untrusted=False):
         '''tell whether section exists in config.'''
         return section in self._data(untrusted)
 
     def configitems(self, section, untrusted=False, ignoresub=False):
         items = self._data(untrusted).items(section)
         if ignoresub:
-            newitems = {}
-            for k, v in items:
-                if ':' not in k:
-                    newitems[k] = v
-            items = list(newitems.iteritems())
+            items = [i for i in items if ':' not in i[0]]
         if self.debugflag and not untrusted and self._reportuntrusted:
             for k, v in self._ucfg.items(section):
                 if self._tcfg.get(section, k) != v:
                     self.debug("ignoring untrusted configuration option "
                                "%s.%s = %s\n" % (section, k, v))
         return items
 
     def walkconfig(self, untrusted=False):
         cfg = self._data(untrusted)
         for section in cfg.sections():
             for name, value in self.configitems(section, untrusted):
                 yield section, name, value
 
     def plain(self, feature=None):
         '''is plain mode active?
 
         Plain mode means that all configuration variables which affect
         the behavior and output of Mercurial should be
         ignored. Additionally, the output should be stable,
         reproducible and suitable for use in scripts or applications.
 
         The only way to trigger plain mode is by setting either the
         `HGPLAIN' or `HGPLAINEXCEPT' environment variables.
 
         The return value can either be
         - False if HGPLAIN is not set, or feature is in HGPLAINEXCEPT
         - False if feature is disabled by default and not included in HGPLAIN
         - True otherwise
         '''
         if ('HGPLAIN' not in encoding.environ and
                 'HGPLAINEXCEPT' not in encoding.environ):
             return False
         exceptions = encoding.environ.get('HGPLAINEXCEPT',
                 '').strip().split(',')
         # TODO: add support for HGPLAIN=+feature,-feature syntax
         if '+strictflags' not in encoding.environ.get('HGPLAIN', '').split(','):
             exceptions.append('strictflags')
         if feature and exceptions:
             return feature not in exceptions
         return True
 
     def username(self, acceptempty=False):
         """Return default username to be used in commits.
 
         Searched in this order: $HGUSER, [ui] section of hgrcs, $EMAIL
         and stop searching if one of these is set.
         If not found and acceptempty is True, returns None.
         If not found and ui.askusername is True, ask the user, else use
         ($LOGNAME or $USER or $LNAME or $USERNAME) + "@full.hostname".
         If no username could be found, raise an Abort error.
         """
         user = encoding.environ.get("HGUSER")
         if user is None:
             user = self.config("ui", "username")
             if user is not None:
                 user = os.path.expandvars(user)
         if user is None:
             user = encoding.environ.get("EMAIL")
         if user is None and acceptempty:
             return user
         if user is None and self.configbool("ui", "askusername"):
             user = self.prompt(_("enter a commit username:"), default=None)
         if user is None and not self.interactive():
             try:
                 user = '%s@%s' % (procutil.getuser(),
                                   encoding.strtolocal(socket.getfqdn()))
                 self.warn(_("no username found, using '%s' instead\n") % user)
             except KeyError:
                 pass
         if not user:
             raise error.Abort(_('no username supplied'),
                              hint=_("use 'hg config --edit' "
                                     'to set your username'))
         if "\n" in user:
             raise error.Abort(_("username %r contains a newline\n")
                               % pycompat.bytestr(user))
         return user
 
     def shortuser(self, user):
         """Return a short representation of a user name or email address."""
         if not self.verbose:
             user = stringutil.shortuser(user)
         return user
 
     def expandpath(self, loc, default=None):
         """Return repository location relative to cwd or from [paths]"""
         try:
             p = self.paths.getpath(loc)
             if p:
                 return p.rawloc
         except error.RepoError:
             pass
 
         if default:
             try:
                 p = self.paths.getpath(default)
                 if p:
                     return p.rawloc
             except error.RepoError:
                 pass
 
         return loc
 
     @util.propertycache
     def paths(self):
         return paths(self)
 
     def pushbuffer(self, error=False, subproc=False, labeled=False):
         """install a buffer to capture standard output of the ui object
 
         If error is True, the error output will be captured too.
 
         If subproc is True, output from subprocesses (typically hooks) will be
         captured too.
 
         If labeled is True, any labels associated with buffered
         output will be handled. By default, this has no effect
         on the output returned, but extensions and GUI tools may
         handle this argument and returned styled output. If output
         is being buffered so it can be captured and parsed or
         processed, labeled should not be set to True.
         """
         self._buffers.append([])
         self._bufferstates.append((error, subproc, labeled))
         self._bufferapplylabels = labeled
 
     def popbuffer(self):
         '''pop the last buffer and return the buffered output'''
         self._bufferstates.pop()
         if self._bufferstates:
             self._bufferapplylabels = self._bufferstates[-1][2]
         else:
             self._bufferapplylabels = None
 
         return "".join(self._buffers.pop())
 
     def canwritewithoutlabels(self):
         '''check if write skips the label'''
         if self._buffers and not self._bufferapplylabels:
             return True
         return self._colormode is None
 
     def canbatchlabeledwrites(self):
         '''check if write calls with labels are batchable'''
         # Windows color printing is special, see ``write``.
         return self._colormode != 'win32'
 
     def write(self, *args, **opts):
         '''write args to output
 
         By default, this method simply writes to the buffer or stdout.
         Color mode can be set on the UI class to have the output decorated
         with color modifier before being written to stdout.
 
         The color used is controlled by an optional keyword argument, "label".
         This should be a string containing label names separated by space.
         Label names take the form of "topic.type". For example, ui.debug()
         issues a label of "ui.debug".
 
         When labeling output for a specific command, a label of
         "cmdname.type" is recommended. For example, status issues
         a label of "status.modified" for modified files.
         '''
         if self._buffers:
             if self._bufferapplylabels:
                 label = opts.get(r'label', '')
                 self._buffers[-1].extend(self.label(a, label) for a in args)
             else:
                 self._buffers[-1].extend(args)
         else:
             self._writenobuf(*args, **opts)
 
     def _writenobuf(self, *args, **opts):
         if self._colormode == 'win32':
             # windows color printing is its own can of crab, defer to
             # the color module and that is it.
             color.win32print(self, self._write, *args, **opts)
         else:
             msgs = args
             if self._colormode is not None:
                 label = opts.get(r'label', '')
                 msgs = [self.label(a, label) for a in args]
             self._write(*msgs, **opts)
 
     def _write(self, *msgs, **opts):
         self._progclear()
         # opencode timeblockedsection because this is a critical path
         starttime = util.timer()
         try:
             self.fout.write(''.join(msgs))
         except IOError as err:
             raise error.StdioError(err)
         finally:
             self._blockedtimes['stdio_blocked'] += \
                 (util.timer() - starttime) * 1000
 
     def write_err(self, *args, **opts):
         self._progclear()
         if self._bufferstates and self._bufferstates[-1][0]:
             self.write(*args, **opts)
         elif self._colormode == 'win32':
             # windows color printing is its own can of crab, defer to
             # the color module and that is it.
             color.win32print(self, self._write_err, *args, **opts)
         else:
             msgs = args
             if self._colormode is not None:
                 label = opts.get(r'label', '')
                 msgs = [self.label(a, label) for a in args]
             self._write_err(*msgs, **opts)
 
     def _write_err(self, *msgs, **opts):
         try:
             with self.timeblockedsection('stdio'):
                 if not getattr(self.fout, 'closed', False):
                     self.fout.flush()
                 for a in msgs:
                     self.ferr.write(a)
                 # stderr may be buffered under win32 when redirected to files,
                 # including stdout.
                 if not getattr(self.ferr, 'closed', False):
                     self.ferr.flush()
         except IOError as inst:
             if inst.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
                 raise error.StdioError(inst)
 
     def flush(self):
         # opencode timeblockedsection because this is a critical path
         starttime = util.timer()
         try:
             try:
                 self.fout.flush()
             except IOError as err:
                 if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
                     raise error.StdioError(err)
             finally:
                 try:
                     self.ferr.flush()
                 except IOError as err:
                     if err.errno not in (errno.EPIPE, errno.EIO, errno.EBADF):
                         raise error.StdioError(err)
         finally:
             self._blockedtimes['stdio_blocked'] += \
                 (util.timer() - starttime) * 1000
 
     def _isatty(self, fh):
         if self.configbool('ui', 'nontty'):
             return False
         return procutil.isatty(fh)
 
     def disablepager(self):
         self._disablepager = True
 
     def pager(self, command):
         """Start a pager for subsequent command output.
 
         Commands which produce a long stream of output should call
         this function to activate the user's preferred pagination
         mechanism (which may be no pager). Calling this function
         precludes any future use of interactive functionality, such as
         prompting the user or activating curses.
 
         Args:
           command: The full, non-aliased name of the command. That is, "log"
                    not "history, "summary" not "summ", etc.
         """
         if (self._disablepager
             or self.pageractive):
             # how pager should do is already determined
             return
 
         if not command.startswith('internal-always-') and (
             # explicit --pager=on (= 'internal-always-' prefix) should
             # take precedence over disabling factors below
             command in self.configlist('pager', 'ignore')
             or not self.configbool('ui', 'paginate')
             or not self.configbool('pager', 'attend-' + command, True)
             # TODO: if we want to allow HGPLAINEXCEPT=pager,
             # formatted() will need some adjustment.
             or not self.formatted()
             or self.plain()
             or self._buffers
             # TODO: expose debugger-enabled on the UI object
             or '--debugger' in pycompat.sysargv):
             # We only want to paginate if the ui appears to be
             # interactive, the user didn't say HGPLAIN or
             # HGPLAINEXCEPT=pager, and the user didn't specify --debug.
             return
 
         pagercmd = self.config('pager', 'pager', rcutil.fallbackpager)
         if not pagercmd:
             return
 
         pagerenv = {}
         for name, value in rcutil.defaultpagerenv().items():
             if name not in encoding.environ:
                 pagerenv[name] = value
 
         self.debug('starting pager for command %r\n' % command)
         self.flush()
 
         wasformatted = self.formatted()
         if util.safehasattr(signal, "SIGPIPE"):
             signal.signal(signal.SIGPIPE, _catchterm)
         if self._runpager(pagercmd, pagerenv):
             self.pageractive = True
             # Preserve the formatted-ness of the UI. This is important
             # because we mess with stdout, which might confuse
             # auto-detection of things being formatted.
             self.setconfig('ui', 'formatted', wasformatted, 'pager')
             self.setconfig('ui', 'interactive', False, 'pager')
 
             # If pagermode differs from color.mode, reconfigure color now that
             # pageractive is set.
             cm = self._colormode
             if cm != self.config('color', 'pagermode', cm):
                 color.setup(self)
         else:
             # If the pager can't be spawned in dispatch when --pager=on is
             # given, don't try again when the command runs, to avoid a duplicate
             # warning about a missing pager command.
             self.disablepager()
 
     def _runpager(self, command, env=None):
         """Actually start the pager and set up file descriptors.
 
         This is separate in part so that extensions (like chg) can
         override how a pager is invoked.
         """
         if command == 'cat':
             # Save ourselves some work.
             return False
         # If the command doesn't contain any of these characters, we
         # assume it's a binary and exec it directly. This means for
         # simple pager command configurations, we can degrade
         # gracefully and tell the user about their broken pager.
         shell = any(c in command for c in "|&;<>()$`\\\"' \t\n*?[#~=%")
 
         if pycompat.iswindows and not shell:
             # Window's built-in `more` cannot be invoked with shell=False, but
             # its `more.com` can.  Hide this implementation detail from the
             # user so we can also get sane bad PAGER behavior.  MSYS has
             # `more.exe`, so do a cmd.exe style resolution of the executable to
             # determine which one to use.
             fullcmd = procutil.findexe(command)
             if not fullcmd:
                 self.warn(_("missing pager command '%s', skipping pager\n")
                           % command)
                 return False
 
             command = fullcmd
 
         try:
             pager = subprocess.Popen(
                 command, shell=shell, bufsize=-1,
                 close_fds=procutil.closefds, stdin=subprocess.PIPE,
                 stdout=procutil.stdout, stderr=procutil.stderr,
                 env=procutil.shellenviron(env))
         except OSError as e:
             if e.errno == errno.ENOENT and not shell:
                 self.warn(_("missing pager command '%s', skipping pager\n")
                           % command)
                 return False
             raise
 
         # back up original file descriptors
         stdoutfd = os.dup(procutil.stdout.fileno())
         stderrfd = os.dup(procutil.stderr.fileno())
 
         os.dup2(pager.stdin.fileno(), procutil.stdout.fileno())
         if self._isatty(procutil.stderr):
             os.dup2(pager.stdin.fileno(), procutil.stderr.fileno())
 
         @self.atexit
         def killpager():
             if util.safehasattr(signal, "SIGINT"):
                 signal.signal(signal.SIGINT, signal.SIG_IGN)
             # restore original fds, closing pager.stdin copies in the process
             os.dup2(stdoutfd, procutil.stdout.fileno())
             os.dup2(stderrfd, procutil.stderr.fileno())
             pager.stdin.close()
             pager.wait()
 
         return True
 
     @property
     def _exithandlers(self):
         return _reqexithandlers
 
     def atexit(self, func, *args, **kwargs):
         '''register a function to run after dispatching a request
 
         Handlers do not stay registered across request boundaries.'''
         self._exithandlers.append((func, args, kwargs))
         return func
 
     def interface(self, feature):
         """what interface to use for interactive console features?
 
         The interface is controlled by the value of `ui.interface` but also by
         the value of feature-specific configuration. For example:
 
         ui.interface.histedit = text
         ui.interface.chunkselector = curses
 
         Here the features are "histedit" and "chunkselector".
 
         The configuration above means that the default interfaces for commands
         is curses, the interface for histedit is text and the interface for
         selecting chunk is crecord (the best curses interface available).
 
         Consider the following example:
         ui.interface = curses
         ui.interface.histedit = text
 
         Then histedit will use the text interface and chunkselector will use
         the default curses interface (crecord at the moment).
         """
         alldefaults = frozenset(["text", "curses"])
 
         featureinterfaces = {
             "chunkselector": [
                 "text",
                 "curses",
             ]
         }
 
         # Feature-specific interface
         if feature not in featureinterfaces.keys():
             # Programming error, not user error
             raise ValueError("Unknown feature requested %s" % feature)
 
         availableinterfaces = frozenset(featureinterfaces[feature])
         if alldefaults > availableinterfaces:
             # Programming error, not user error. We need a use case to
             # define the right thing to do here.
             raise ValueError(
                 "Feature %s does not handle all default interfaces" %
                 feature)
 
         if self.plain():
             return "text"
 
         # Default interface for all the features
         defaultinterface = "text"
         i = self.config("ui", "interface")
         if i in alldefaults:
             defaultinterface = i
 
         choseninterface = defaultinterface
         f = self.config("ui", "interface.%s" % feature)
         if f in availableinterfaces:
             choseninterface = f
 
         if i is not None and defaultinterface != i:
             if f is not None:
                 self.warn(_("invalid value for ui.interface: %s\n") %
                           (i,))
             else:
                 self.warn(_("invalid value for ui.interface: %s (using %s)\n") %
                          (i, choseninterface))
         if f is not None and choseninterface != f:
             self.warn(_("invalid value for ui.interface.%s: %s (using %s)\n") %
                       (feature, f, choseninterface))
 
         return choseninterface
 
     def interactive(self):
         '''is interactive input allowed?
 
         An interactive session is a session where input can be reasonably read
         from `sys.stdin'. If this function returns false, any attempt to read
         from stdin should fail with an error, unless a sensible default has been
         specified.
 
         Interactiveness is triggered by the value of the `ui.interactive'
         configuration variable or - if it is unset - when `sys.stdin' points
         to a terminal device.
 
         This function refers to input only; for output, see `ui.formatted()'.
         '''
         i = self.configbool("ui", "interactive")
         if i is None:
             # some environments replace stdin without implementing isatty
             # usually those are non-interactive
             return self._isatty(self.fin)
 
         return i
 
     def termwidth(self):
         '''how wide is the terminal in columns?
         '''
         if 'COLUMNS' in encoding.environ:
             try:
                 return int(encoding.environ['COLUMNS'])
             except ValueError:
                 pass
         return scmutil.termsize(self)[0]
 
     def formatted(self):
         '''should formatted output be used?
 
         It is often desirable to format the output to suite the output medium.
         Examples of this are truncating long lines or colorizing messages.
         However, this is not often not desirable when piping output into other
         utilities, e.g. `grep'.
 
         Formatted output is triggered by the value of the `ui.formatted'
         configuration variable or - if it is unset - when `sys.stdout' points
         to a terminal device. Please note that `ui.formatted' should be
         considered an implementation detail; it is not intended for use outside
         Mercurial or its extensions.
 
         This function refers to output only; for input, see `ui.interactive()'.
         This function always returns false when in plain mode, see `ui.plain()'.
         '''
         if self.plain():
             return False
 
         i = self.configbool("ui", "formatted")
         if i is None:
             # some environments replace stdout without implementing isatty
             # usually those are non-interactive
             return self._isatty(self.fout)
 
         return i
 
     def _readline(self):
         # Replacing stdin/stdout temporarily is a hard problem on Python 3
         # because they have to be text streams with *no buffering*. Instead,
         # we use rawinput() only if call_readline() will be invoked by
         # PyOS_Readline(), so no I/O will be made at Python layer.
         usereadline = (self._isatty(self.fin) and self._isatty(self.fout)
                        and procutil.isstdin(self.fin)
                        and procutil.isstdout(self.fout))
         if usereadline:
             try:
                 # magically add command line editing support, where
                 # available
                 import readline
                 # force demandimport to really load the module
                 readline.read_history_file
                 # windows sometimes raises something other than ImportError
             except Exception:
                 usereadline = False
 
         # prompt ' ' must exist; otherwise readline may delete entire line
         # - http://bugs.python.org/issue12833
         with self.timeblockedsection('stdio'):
             if usereadline:
                 line = encoding.strtolocal(pycompat.rawinput(r' '))
                 # When stdin is in binary mode on Windows, it can cause
                 # raw_input() to emit an extra trailing carriage return
                 if pycompat.oslinesep == b'\r\n' and line.endswith(b'\r'):
                     line = line[:-1]
             else:
                 self.fout.write(b' ')
                 self.fout.flush()
                 line = self.fin.readline()
                 if not line:
                     raise EOFError
                 line = line.rstrip(pycompat.oslinesep)
 
         return line
 
     def prompt(self, msg, default="y"):
         """Prompt user with msg, read response.
         If ui is not interactive, the default is returned.
         """
         if not self.interactive():
             self.write(msg, ' ', default or '', "\n")
             return default
         self._writenobuf(msg, label='ui.prompt')
         self.flush()
         try:
             r = self._readline()
             if not r:
                 r = default
             if self.configbool('ui', 'promptecho'):
                 self.write(r, "\n")
             return r
         except EOFError:
             raise error.ResponseExpected()
 
     @staticmethod
     def extractchoices(prompt):
         """Extract prompt message and list of choices from specified prompt.
 
         This returns tuple "(message, choices)", and "choices" is the
         list of tuple "(response character, text without &)".
 
         >>> ui.extractchoices(b"awake? $$ &Yes $$ &No")
         ('awake? ', [('y', 'Yes'), ('n', 'No')])
         >>> ui.extractchoices(b"line\\nbreak? $$ &Yes $$ &No")
         ('line\\nbreak? ', [('y', 'Yes'), ('n', 'No')])
         >>> ui.extractchoices(b"want lots of $$money$$?$$Ye&s$$N&o")
         ('want lots of $$money$$?', [('s', 'Yes'), ('o', 'No')])
         """
 
         # Sadly, the prompt string may have been built with a filename
         # containing "$$" so let's try to find the first valid-looking
         # prompt to start parsing. Sadly, we also can't rely on
         # choices containing spaces, ASCII, or basically anything
         # except an ampersand followed by a character.
         m = re.match(br'(?s)(.+?)\$\$([^\$]*&[^ \$].*)', prompt)
         msg = m.group(1)
         choices = [p.strip(' ') for p in m.group(2).split('$$')]
         def choicetuple(s):
             ampidx = s.index('&')
             return s[ampidx + 1:ampidx + 2].lower(), s.replace('&', '', 1)
         return (msg, [choicetuple(s) for s in choices])
 
     def promptchoice(self, prompt, default=0):
         """Prompt user with a message, read response, and ensure it matches
         one of the provided choices. The prompt is formatted as follows:
 
            "would you like fries with that (Yn)? $$ &Yes $$ &No"
 
         The index of the choice is returned. Responses are case
         insensitive. If ui is not interactive, the default is
         returned.
         """
 
         msg, choices = self.extractchoices(prompt)
         resps = [r for r, t in choices]
         while True:
             r = self.prompt(msg, resps[default])
             if r.lower() in resps:
                 return resps.index(r.lower())
             self.write(_("unrecognized response\n"))
 
     def getpass(self, prompt=None, default=None):
         if not self.interactive():
             return default
         try:
             self.write_err(self.label(prompt or _('password: '), 'ui.prompt'))
             # disable getpass() only if explicitly specified. it's still valid
             # to interact with tty even if fin is not a tty.
             with self.timeblockedsection('stdio'):
                 if self.configbool('ui', 'nontty'):
                     l = self.fin.readline()
                     if not l:
                         raise EOFError
                     return l.rstrip('\n')
                 else:
                     return getpass.getpass('')
         except EOFError:
             raise error.ResponseExpected()
     def status(self, *msg, **opts):
         '''write status message to output (if ui.quiet is False)
 
         This adds an output label of "ui.status".
         '''
         if not self.quiet:
             opts[r'label'] = opts.get(r'label', '') + ' ui.status'
             self.write(*msg, **opts)
     def warn(self, *msg, **opts):
         '''write warning message to output (stderr)
 
         This adds an output label of "ui.warning".
         '''
         opts[r'label'] = opts.get(r'label', '') + ' ui.warning'
         self.write_err(*msg, **opts)
     def note(self, *msg, **opts):
         '''write note to output (if ui.verbose is True)
 
         This adds an output label of "ui.note".
         '''
         if self.verbose:
             opts[r'label'] = opts.get(r'label', '') + ' ui.note'
             self.write(*msg, **opts)
     def debug(self, *msg, **opts):
         '''write debug message to output (if ui.debugflag is True)
 
         This adds an output label of "ui.debug".
         '''
         if self.debugflag:
             opts[r'label'] = opts.get(r'label', '') + ' ui.debug'
             self.write(*msg, **opts)
 
     def edit(self, text, user, extra=None, editform=None, pending=None,
              repopath=None, action=None):
         if action is None:
             self.develwarn('action is None but will soon be a required '
                            'parameter to ui.edit()')
         extra_defaults = {
             'prefix': 'editor',
             'suffix': '.txt',
         }
         if extra is not None:
             if extra.get('suffix') is not None:
                 self.develwarn('extra.suffix is not None but will soon be '
                                'ignored by ui.edit()')
             extra_defaults.update(extra)
         extra = extra_defaults
 
         if action == 'diff':
             suffix = '.diff'
         elif action:
             suffix = '.%s.hg.txt' % action
         else:
             suffix = extra['suffix']
 
         rdir = None
         if self.configbool('experimental', 'editortmpinhg'):
             rdir = repopath
         (fd, name) = tempfile.mkstemp(prefix='hg-' + extra['prefix'] + '-',
                                       suffix=suffix,
                                       dir=rdir)
         try:
             f = os.fdopen(fd, r'wb')
             f.write(util.tonativeeol(text))
             f.close()
 
             environ = {'HGUSER': user}
             if 'transplant_source' in extra:
                 environ.update({'HGREVISION': hex(extra['transplant_source'])})
             for label in ('intermediate-source', 'source', 'rebase_source'):
                 if label in extra:
                     environ.update({'HGREVISION': extra[label]})
                     break
             if editform:
                 environ.update({'HGEDITFORM': editform})
             if pending:
                 environ.update({'HG_PENDING': pending})
 
             editor = self.geteditor()
 
             self.system("%s \"%s\"" % (editor, name),
                         environ=environ,
                         onerr=error.Abort, errprefix=_("edit failed"),
                         blockedtag='editor')
 
             f = open(name, r'rb')
             t = util.fromnativeeol(f.read())
             f.close()
         finally:
             os.unlink(name)
 
         return t
 
     def system(self, cmd, environ=None, cwd=None, onerr=None, errprefix=None,
                blockedtag=None):
         '''execute shell command with appropriate output stream. command
         output will be redirected if fout is not stdout.
 
         if command fails and onerr is None, return status, else raise onerr
         object as exception.
         '''
         if blockedtag is None:
             # Long cmds tend to be because of an absolute path on cmd. Keep
             # the tail end instead
             cmdsuffix = cmd.translate(None, _keepalnum)[-85:]
             blockedtag = 'unknown_system_' + cmdsuffix
         out = self.fout
         if any(s[1] for s in self._bufferstates):
             out = self
         with self.timeblockedsection(blockedtag):
             rc = self._runsystem(cmd, environ=environ, cwd=cwd, out=out)
         if rc and onerr:
             errmsg = '%s %s' % (os.path.basename(cmd.split(None, 1)[0]),
                                 procutil.explainexit(rc)[0])
             if errprefix:
                 errmsg = '%s: %s' % (errprefix, errmsg)
             raise onerr(errmsg)
         return rc
 
     def _runsystem(self, cmd, environ, cwd, out):
         """actually execute the given shell command (can be overridden by
         extensions like chg)"""
         return procutil.system(cmd, environ=environ, cwd=cwd, out=out)
 
     def traceback(self, exc=None, force=False):
         '''print exception traceback if traceback printing enabled or forced.
         only to call in exception handler. returns true if traceback
         printed.'''
         if self.tracebackflag or force:
             if exc is None:
                 exc = sys.exc_info()
             cause = getattr(exc[1], 'cause', None)
 
             if cause is not None:
                 causetb = traceback.format_tb(cause[2])
                 exctb = traceback.format_tb(exc[2])
                 exconly = traceback.format_exception_only(cause[0], cause[1])
 
                 # exclude frame where 'exc' was chained and rethrown from exctb
                 self.write_err('Traceback (most recent call last):\n',
                                ''.join(exctb[:-1]),
                                ''.join(causetb),
                                ''.join(exconly))
             else:
                 output = traceback.format_exception(exc[0], exc[1], exc[2])
                 self.write_err(encoding.strtolocal(r''.join(output)))
         return self.tracebackflag or force
 
     def geteditor(self):
         '''return editor to use'''
         if pycompat.sysplatform == 'plan9':
             # vi is the MIPS instruction simulator on Plan 9. We
             # instead default to E to plumb commit messages to
             # avoid confusion.
             editor = 'E'
         else:
             editor = 'vi'
         return (encoding.environ.get("HGEDITOR") or
                 self.config("ui", "editor", editor))
 
     @util.propertycache
     def _progbar(self):
         """setup the progbar singleton to the ui object"""
         if (self.quiet or self.debugflag
                 or self.configbool('progress', 'disable')
                 or not progress.shouldprint(self)):
             return None
         return getprogbar(self)
 
     def _progclear(self):
         """clear progress bar output if any. use it before any output"""
         if not haveprogbar(): # nothing loaded yet
             return
         if self._progbar is not None and self._progbar.printed:
             self._progbar.clear()
 
     def progress(self, topic, pos, item="", unit="", total=None):
         '''show a progress message
 
         By default a textual progress bar will be displayed if an operation
         takes too long. 'topic' is the current operation, 'item' is a
         non-numeric marker of the current position (i.e. the currently
         in-process file), 'pos' is the current numeric position (i.e.
         revision, bytes, etc.), unit is a corresponding unit label,
         and total is the highest expected pos.
 
         Multiple nested topics may be active at a time.
 
         All topics should be marked closed by setting pos to None at
         termination.
         '''
         if self._progbar is not None:
             self._progbar.progress(topic, pos, item=item, unit=unit,
                                    total=total)
         if pos is None or not self.configbool('progress', 'debug'):
             return
 
         if unit:
             unit = ' ' + unit
         if item:
             item = ' ' + item
 
         if total:
             pct = 100.0 * pos / total
             self.debug('%s:%s %d/%d%s (%4.2f%%)\n'
                      % (topic, item, pos, total, unit, pct))
         else:
             self.debug('%s:%s %d%s\n' % (topic, item, pos, unit))
 
     def log(self, service, *msg, **opts):
         '''hook for logging facility extensions
 
         service should be a readily-identifiable subsystem, which will
         allow filtering.
 
         *msg should be a newline-terminated format string to log, and
         then any values to %-format into that format string.
 
         **opts currently has no defined meanings.
         '''
 
     def label(self, msg, label):
         '''style msg based on supplied label
 
         If some color mode is enabled, this will add the necessary control
         characters to apply such color. In addition, 'debug' color mode adds
         markup showing which label affects a piece of text.
 
         ui.write(s, 'label') is equivalent to
         ui.write(ui.label(s, 'label')).
         '''
         if self._colormode is not None:
             return color.colorlabel(self, msg, label)
         return msg
 
     def develwarn(self, msg, stacklevel=1, config=None):
         """issue a developer warning message
 
         Use 'stacklevel' to report the offender some layers further up in the
         stack.
         """
         if not self.configbool('devel', 'all-warnings'):
             if config is None or not self.configbool('devel', config):
                 return
         msg = 'devel-warn: ' + msg
         stacklevel += 1 # get in develwarn
         if self.tracebackflag:
             util.debugstacktrace(msg, stacklevel, self.ferr, self.fout)
             self.log('develwarn', '%s at:\n%s' %
                      (msg, ''.join(util.getstackframes(stacklevel))))
         else:
             curframe = inspect.currentframe()
             calframe = inspect.getouterframes(curframe, 2)
             fname, lineno, fmsg = calframe[stacklevel][1:4]
             fname, fmsg = pycompat.sysbytes(fname), pycompat.sysbytes(fmsg)
             self.write_err('%s at: %s:%d (%s)\n'
                            % (msg, fname, lineno, fmsg))
             self.log('develwarn', '%s at: %s:%d (%s)\n',
                      msg, fname, lineno, fmsg)
             curframe = calframe = None  # avoid cycles
 
     def deprecwarn(self, msg, version, stacklevel=2):
         """issue a deprecation warning
 
         - msg: message explaining what is deprecated and how to upgrade,
         - version: last version where the API will be supported,
         """
         if not (self.configbool('devel', 'all-warnings')
                 or self.configbool('devel', 'deprec-warn')):
             return
         msg += ("\n(compatibility will be dropped after Mercurial-%s,"
                 " update your code.)") % version
         self.develwarn(msg, stacklevel=stacklevel, config='deprec-warn')
 
     def exportableenviron(self):
         """The environment variables that are safe to export, e.g. through
         hgweb.
         """
         return self._exportableenviron
 
     @contextlib.contextmanager
     def configoverride(self, overrides, source=""):
         """Context manager for temporary config overrides
         `overrides` must be a dict of the following structure:
         {(section, name) : value}"""
         backups = {}
         try:
             for (section, name), value in overrides.items():
                 backups[(section, name)] = self.backupconfig(section, name)
                 self.setconfig(section, name, value, source)
             yield
         finally:
             for __, backup in backups.items():
                 self.restoreconfig(backup)
             # just restoring ui.quiet config to the previous value is not enough
             # as it does not update ui.quiet class member
             if ('ui', 'quiet') in overrides:
                 self.fixconfig(section='ui')
 
 class paths(dict):
     """Represents a collection of paths and their configs.
 
     Data is initially derived from ui instances and the config files they have
     loaded.
     """
     def __init__(self, ui):
         dict.__init__(self)
 
         for name, loc in ui.configitems('paths', ignoresub=True):
             # No location is the same as not existing.
             if not loc:
                 continue
             loc, sub = ui.configsuboptions('paths', name)
             self[name] = path(ui, name, rawloc=loc, suboptions=sub)
 
     def getpath(self, name, default=None):
         """Return a ``path`` from a string, falling back to default.
 
         ``name`` can be a named path or locations. Locations are filesystem
         paths or URIs.
 
         Returns None if ``name`` is not a registered path, a URI, or a local
         path to a repo.
         """
         # Only fall back to default if no path was requested.
         if name is None:
             if not default:
                 default = ()
             elif not isinstance(default, (tuple, list)):
                 default = (default,)
             for k in default:
                 try:
                     return self[k]
                 except KeyError:
                     continue
             return None
 
         # Most likely empty string.
         # This may need to raise in the future.
         if not name:
             return None
 
         try:
             return self[name]
         except KeyError:
             # Try to resolve as a local path or URI.
             try:
                 # We don't pass sub-options in, so no need to pass ui instance.
                 return path(None, None, rawloc=name)
             except ValueError:
                 raise error.RepoError(_('repository %s does not exist') %
                                         name)
 
 _pathsuboptions = {}
 
 def pathsuboption(option, attr):
     """Decorator used to declare a path sub-option.
 
     Arguments are the sub-option name and the attribute it should set on
     ``path`` instances.
 
     The decorated function will receive as arguments a ``ui`` instance,
     ``path`` instance, and the string value of this option from the config.
     The function should return the value that will be set on the ``path``
     instance.
 
     This decorator can be used to perform additional verification of
     sub-options and to change the type of sub-options.
     """
     def register(func):
         _pathsuboptions[option] = (attr, func)
         return func
     return register
 
 @pathsuboption('pushurl', 'pushloc')
 def pushurlpathoption(ui, path, value):
     u = util.url(value)
     # Actually require a URL.
     if not u.scheme:
         ui.warn(_('(paths.%s:pushurl not a URL; ignoring)\n') % path.name)
         return None
 
     # Don't support the #foo syntax in the push URL to declare branch to
     # push.
     if u.fragment:
         ui.warn(_('("#fragment" in paths.%s:pushurl not supported; '
                   'ignoring)\n') % path.name)
         u.fragment = None
 
     return bytes(u)
 
 @pathsuboption('pushrev', 'pushrev')
 def pushrevpathoption(ui, path, value):
     return value
 
 class path(object):
     """Represents an individual path and its configuration."""
 
     def __init__(self, ui, name, rawloc=None, suboptions=None):
         """Construct a path from its config options.
 
         ``ui`` is the ``ui`` instance the path is coming from.
         ``name`` is the symbolic name of the path.
         ``rawloc`` is the raw location, as defined in the config.
         ``pushloc`` is the raw locations pushes should be made to.
 
         If ``name`` is not defined, we require that the location be a) a local
         filesystem path with a .hg directory or b) a URL. If not,
         ``ValueError`` is raised.
         """
         if not rawloc:
             raise ValueError('rawloc must be defined')
 
         # Locations may define branches via syntax <base>#<branch>.
         u = util.url(rawloc)
         branch = None
         if u.fragment:
             branch = u.fragment
             u.fragment = None
 
         self.url = u
         self.branch = branch
 
         self.name = name
         self.rawloc = rawloc
         self.loc = '%s' % u
 
         # When given a raw location but not a symbolic name, validate the
         # location is valid.
         if not name and not u.scheme and not self._isvalidlocalpath(self.loc):
             raise ValueError('location is not a URL or path to a local '
                              'repo: %s' % rawloc)
 
         suboptions = suboptions or {}
 
         # Now process the sub-options. If a sub-option is registered, its
         # attribute will always be present. The value will be None if there
         # was no valid sub-option.
         for suboption, (attr, func) in _pathsuboptions.iteritems():
             if suboption not in suboptions:
                 setattr(self, attr, None)
                 continue
 
             value = func(ui, self, suboptions[suboption])
             setattr(self, attr, value)
 
     def _isvalidlocalpath(self, path):
         """Returns True if the given path is a potentially valid repository.
         This is its own function so that extensions can change the definition of
         'valid' in this case (like when pulling from a git repo into a hg
         one)."""
         return os.path.isdir(os.path.join(path, '.hg'))
 
     @property
     def suboptions(self):
         """Return sub-options and their values for this path.
 
         This is intended to be used for presentation purposes.
         """
         d = {}
         for subopt, (attr, _func) in _pathsuboptions.iteritems():
             value = getattr(self, attr)
             if value is not None:
                 d[subopt] = value
         return d
 
 # we instantiate one globally shared progress bar to avoid
 # competing progress bars when multiple UI objects get created
 _progresssingleton = None
 
 def getprogbar(ui):
     global _progresssingleton
     if _progresssingleton is None:
         # passing 'ui' object to the singleton is fishy,
         # this is how the extension used to work but feel free to rework it.
         _progresssingleton = progress.progbar(ui)
     return _progresssingleton
 
 def haveprogbar():
     return _progresssingleton is not None

tests/test-alias.t

@@ -1,596 +1,763 b''
   $ HGFOO=BAR; export HGFOO
   $ cat >> $HGRCPATH <<EOF
   > [alias]
   > # should clobber ci but not commit (issue2993)
   > ci = version
   > myinit = init
+  > myinit:doc = This is my documented alias for init.
+  > myinit:help = [OPTIONS] [BLA] [BLE]
   > mycommit = commit
+  > mycommit:doc = This is my alias with only doc.
   > optionalrepo = showconfig alias.myinit
   > cleanstatus = status -c
+  > cleanstatus:help = [ONLYHELPHERE]
   > unknown = bargle
   > ambiguous = s
   > recursive = recursive
   > disabled = email
   > nodefinition =
   > noclosingquotation = '
   > no--cwd = status --cwd elsewhere
   > no-R = status -R elsewhere
   > no--repo = status --repo elsewhere
   > no--repository = status --repository elsewhere
   > no--config = status --config a.config=1
   > mylog = log
   > lognull = log -r null
+  > lognull:doc = Logs the null rev
+  > lognull:help = foo bar baz
   > shortlog = log --template '{rev} {node|short} | {date|isodate}\n'
   > positional = log --template '{\$2} {\$1} | {date|isodate}\n'
   > dln = lognull --debug
+  > recursivedoc = dln
+  > recursivedoc:doc = Logs the null rev in debug mode
   > nousage = rollback
   > put = export -r 0 -o "\$FOO/%R.diff"
   > blank = !printf '\n'
   > self = !printf '\$0\n'
   > echoall = !printf '\$@\n'
   > echo1 = !printf '\$1\n'
   > echo2 = !printf '\$2\n'
   > echo13 = !printf '\$1 \$3\n'
   > echotokens = !printf "%s\n" "\$@"
   > count = !hg log -r "\$@" --template=. | wc -c | sed -e 's/ //g'
   > mcount = !hg log \$@ --template=. | wc -c | sed -e 's/ //g'
   > rt = root
   > tglog = log -G --template "{rev}:{node|short}: '{desc}' {branches}\n"
   > idalias = id
   > idaliaslong = id
   > idaliasshell = !echo test
   > parentsshell1 = !echo one
   > parentsshell2 = !echo two
   > escaped1 = !printf 'test\$\$test\n'
   > escaped2 = !sh -c 'echo "HGFOO is \$\$HGFOO"'
   > escaped3 = !sh -c 'echo "\$1 is \$\$\$1"'
   > escaped4 = !printf '\$\$0 \$\$@\n'
   > exit1 = !sh -c 'exit 1'
   > 
   > [defaults]
   > mylog = -q
   > lognull = -q
   > log = -v
   > EOF
 
-
 basic
 
   $ hg myinit alias
 
+help
+
+  $ hg help -c | grep myinit
+   myinit             This is my documented alias for init.
+  $ hg help -c | grep mycommit
+   mycommit           This is my alias with only doc.
+  $ hg help -c | grep cleanstatus
+   cleanstatus        show changed files in the working directory
+  $ hg help -c | grep lognull
+   lognull            Logs the null rev
+  $ hg help -c | grep dln
+   dln                Logs the null rev
+  $ hg help -c | grep recursivedoc
+   recursivedoc       Logs the null rev in debug mode
+  $ hg help myinit
+  hg myinit [OPTIONS] [BLA] [BLE]
+  
+  alias for: hg init
+  
+  This is my documented alias for init.
+  
+  defined by: * (glob)
+  */* (glob) (?)
+  */* (glob) (?)
+  */* (glob) (?)
+  
+  options:
+  
+   -e --ssh CMD       specify ssh command to use
+      --remotecmd CMD specify hg command to run on the remote side
+      --insecure      do not verify server certificate (ignoring web.cacerts
+                      config)
+  
+  (some details hidden, use --verbose to show complete help)
+
+  $ hg help mycommit
+  hg mycommit [OPTION]... [FILE]...
+  
+  alias for: hg commit
+  
+  This is my alias with only doc.
+  
+  defined by: * (glob)
+  */* (glob) (?)
+  */* (glob) (?)
+  */* (glob) (?)
+  
+  options ([+] can be repeated):
+  
+   -A --addremove           mark new/missing files as added/removed before
+                            committing
+      --close-branch        mark a branch head as closed
+      --amend               amend the parent of the working directory
+   -s --secret              use the secret phase for committing
+   -e --edit                invoke editor on commit messages
+   -i --interactive         use interactive mode
+   -I --include PATTERN [+] include names matching the given patterns
+   -X --exclude PATTERN [+] exclude names matching the given patterns
+   -m --message TEXT        use text as commit message
+   -l --logfile FILE        read commit message from file
+   -d --date DATE           record the specified date as commit date
+   -u --user USER           record the specified user as committer
+   -S --subrepos            recurse into subrepositories
+  
+  (some details hidden, use --verbose to show complete help)
+
+  $ hg help cleanstatus
+  hg cleanstatus [ONLYHELPHERE]
+  
+  alias for: hg status -c
+  
+  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.
+  
+  defined by: * (glob)
+  */* (glob) (?)
+  */* (glob) (?)
+  */* (glob) (?)
+  
+  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 deleted (but tracked) 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
+  
+  (some details hidden, use --verbose to show complete help)
+
+  $ hg help recursivedoc | head -n 5
+  hg recursivedoc foo bar baz
+  
+  alias for: hg dln
+  
+  Logs the null rev in debug mode
 
 unknown
 
   $ hg unknown
   abort: alias 'unknown' resolves to unknown command 'bargle'
   [255]
   $ hg help unknown
   alias 'unknown' resolves to unknown command 'bargle'
 
 
 ambiguous
 
   $ hg ambiguous
   abort: alias 'ambiguous' resolves to ambiguous command 's'
   [255]
   $ hg help ambiguous
   alias 'ambiguous' resolves to ambiguous command 's'
 
 
 recursive
 
   $ hg recursive
   abort: alias 'recursive' resolves to unknown command 'recursive'
   [255]
   $ hg help recursive
   alias 'recursive' resolves to unknown command 'recursive'
 
 
 disabled
 
   $ hg disabled
   abort: alias 'disabled' resolves to unknown command 'email'
   ('email' is provided by 'patchbomb' extension)
   [255]
   $ hg help disabled
   alias 'disabled' resolves to unknown command 'email'
   
   'email' is provided by the following extension:
   
       patchbomb     command to send changesets as (a series of) patch emails
   
   (use 'hg help extensions' for information on enabling extensions)
 
 
 no definition
 
   $ hg nodef
   abort: no definition for alias 'nodefinition'
   [255]
   $ hg help nodef
   no definition for alias 'nodefinition'
 
 
 no closing quotation
 
   $ hg noclosing
   abort: error in definition for alias 'noclosingquotation': No closing quotation
   [255]
   $ hg help noclosing
   error in definition for alias 'noclosingquotation': No closing quotation
 
 "--" in alias definition should be preserved
 
   $ hg --config alias.dash='cat --' -R alias dash -r0
   abort: -r0 not under root '$TESTTMP/alias'
   (consider using '--cwd alias')
   [255]
 
 invalid options
 
   $ hg no--cwd
   abort: error in definition for alias 'no--cwd': --cwd may only be given on the command line
   [255]
   $ hg help no--cwd
   error in definition for alias 'no--cwd': --cwd may only be given on the
   command line
   $ hg no-R
   abort: error in definition for alias 'no-R': -R may only be given on the command line
   [255]
   $ hg help no-R
   error in definition for alias 'no-R': -R may only be given on the command line
   $ hg no--repo
   abort: error in definition for alias 'no--repo': --repo may only be given on the command line
   [255]
   $ hg help no--repo
   error in definition for alias 'no--repo': --repo may only be given on the
   command line
   $ hg no--repository
   abort: error in definition for alias 'no--repository': --repository may only be given on the command line
   [255]
   $ hg help no--repository
   error in definition for alias 'no--repository': --repository may only be given
   on the command line
   $ hg no--config
   abort: error in definition for alias 'no--config': --config may only be given on the command line
   [255]
   $ hg no --config alias.no='--repo elsewhere --cwd elsewhere status'
   abort: error in definition for alias 'no': --repo/--cwd may only be given on the command line
   [255]
   $ hg no --config alias.no='--repo elsewhere'
   abort: error in definition for alias 'no': --repo may only be given on the command line
   [255]
 
 optional repository
 
 #if no-outer-repo
   $ hg optionalrepo
   init
 #endif
   $ cd alias
   $ cat > .hg/hgrc <<EOF
   > [alias]
   > myinit = init -q
   > EOF
   $ hg optionalrepo
   init -q
 
 no usage
 
   $ hg nousage
   no rollback information available
   [1]
 
   $ echo foo > foo
   $ hg commit -Amfoo
   adding foo
 
 infer repository
 
   $ cd ..
 
 #if no-outer-repo
   $ hg shortlog alias/foo
   0 e63c23eaa88a | 1970-01-01 00:00 +0000
 #endif
 
   $ cd alias
 
 with opts
 
   $ hg cleanst
   C foo
 
 
 with opts and whitespace
 
   $ hg shortlog
   0 e63c23eaa88a | 1970-01-01 00:00 +0000
 
 positional arguments
 
   $ hg positional
   abort: too few arguments for command alias
   [255]
   $ hg positional a
   abort: too few arguments for command alias
   [255]
   $ hg positional 'node|short' rev
   0 e63c23eaa88a | 1970-01-01 00:00 +0000
 
 interaction with defaults
 
   $ hg mylog
   0:e63c23eaa88a
   $ hg lognull
   -1:000000000000
 
 
 properly recursive
 
   $ hg dln
   changeset:   -1:0000000000000000000000000000000000000000
   phase:       public
   parent:      -1:0000000000000000000000000000000000000000
   parent:      -1:0000000000000000000000000000000000000000
   manifest:    -1:0000000000000000000000000000000000000000
   user:        
   date:        Thu Jan 01 00:00:00 1970 +0000
   extra:       branch=default
   
 
 
 path expanding
 
   $ FOO=`pwd` hg put
   $ cat 0.diff
   # HG changeset patch
   # User test
   # Date 0 0
   #      Thu Jan 01 00:00:00 1970 +0000
   # Node ID e63c23eaa88ae77967edcf4ea194d31167c478b0
   # Parent  0000000000000000000000000000000000000000
   foo
   
   diff -r 000000000000 -r e63c23eaa88a foo
   --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
   +++ b/foo	Thu Jan 01 00:00:00 1970 +0000
   @@ -0,0 +1,1 @@
   +foo
 
 
 simple shell aliases
 
   $ hg blank
   
   $ hg blank foo
   
   $ hg self
   self
   $ hg echoall
   
   $ hg echoall foo
   foo
   $ hg echoall 'test $2' foo
   test $2 foo
   $ hg echoall 'test $@' foo '$@'
   test $@ foo $@
   $ hg echoall 'test "$@"' foo '"$@"'
   test "$@" foo "$@"
   $ hg echo1 foo bar baz
   foo
   $ hg echo2 foo bar baz
   bar
   $ hg echo13 foo bar baz test
   foo baz
   $ hg echo2 foo
   
   $ hg echotokens
   
   $ hg echotokens foo 'bar $1 baz'
   foo
   bar $1 baz
   $ hg echotokens 'test $2' foo
   test $2
   foo
   $ hg echotokens 'test $@' foo '$@'
   test $@
   foo
   $@
   $ hg echotokens 'test "$@"' foo '"$@"'
   test "$@"
   foo
   "$@"
   $ echo bar > bar
   $ hg commit -qA -m bar
   $ hg count .
   1
   $ hg count 'branch(default)'
   2
   $ hg mcount -r '"branch(default)"'
   2
 
   $ hg tglog
   @  1:042423737847: 'bar'
   |
   o  0:e63c23eaa88a: 'foo'
   
 
 
 shadowing
 
   $ hg i
   hg: command 'i' is ambiguous:
       idalias idaliaslong idaliasshell identify import incoming init
   [255]
   $ hg id
   042423737847 tip
   $ hg ida
   hg: command 'ida' is ambiguous:
       idalias idaliaslong idaliasshell
   [255]
   $ hg idalias
   042423737847 tip
   $ hg idaliasl
   042423737847 tip
   $ hg idaliass
   test
   $ hg parentsshell
   hg: command 'parentsshell' is ambiguous:
       parentsshell1 parentsshell2
   [255]
   $ hg parentsshell1
   one
   $ hg parentsshell2
   two
 
 
 shell aliases with global options
 
   $ hg init sub
   $ cd sub
   $ hg count 'branch(default)'
   abort: unknown revision 'default'!
   0
   $ hg -v count 'branch(default)'
   abort: unknown revision 'default'!
   0
   $ hg -R .. count 'branch(default)'
   abort: unknown revision 'default'!
   0
   $ hg --cwd .. count 'branch(default)'
   2
   $ hg echoall --cwd ..
   
 
 "--" passed to shell alias should be preserved
 
   $ hg --config alias.printf='!printf "$@"' printf '%s %s %s\n' -- --cwd ..
   -- --cwd ..
 
 repo specific shell aliases
 
   $ cat >> .hg/hgrc <<EOF
   > [alias]
   > subalias = !echo sub
   > EOF
   $ cat >> ../.hg/hgrc <<EOF
   > [alias]
   > mainalias = !echo main
   > EOF
 
 
 shell alias defined in current repo
 
   $ hg subalias
   sub
   $ hg --cwd .. subalias > /dev/null
   hg: unknown command 'subalias'
   (did you mean idalias?)
   [255]
   $ hg -R .. subalias > /dev/null
   hg: unknown command 'subalias'
   (did you mean idalias?)
   [255]
 
 
 shell alias defined in other repo
 
   $ hg mainalias > /dev/null
   hg: unknown command 'mainalias'
   (did you mean idalias?)
   [255]
   $ hg -R .. mainalias
   main
   $ hg --cwd .. mainalias
   main
 
 typos get useful suggestions
   $ hg --cwd .. manalias
   hg: unknown command 'manalias'
   (did you mean one of idalias, mainalias, manifest?)
   [255]
 
 shell aliases with escaped $ chars
 
   $ hg escaped1
   test$test
   $ hg escaped2
   HGFOO is BAR
   $ hg escaped3 HGFOO
   HGFOO is BAR
   $ hg escaped4 test
   $0 $@
 
 abbreviated name, which matches against both shell alias and the
 command provided extension, should be aborted.
 
   $ cat >> .hg/hgrc <<EOF
   > [extensions]
   > hgext.rebase =
   > EOF
 #if windows
   $ cat >> .hg/hgrc <<EOF
   > [alias]
   > rebate = !echo this is %HG_ARGS%
   > EOF
 #else
   $ cat >> .hg/hgrc <<EOF
   > [alias]
   > rebate = !echo this is \$HG_ARGS
   > EOF
 #endif
+  $ cat >> .hg/hgrc <<EOF
+  > rebate:doc = This is my alias which just prints something.
+  > rebate:help = [MYARGS]
+  > EOF
   $ hg reba
   hg: command 'reba' is ambiguous:
       rebase rebate
   [255]
   $ hg rebat
   this is rebate
   $ hg rebat --foo-bar
   this is rebate --foo-bar
 
+help for a shell alias
+
+  $ hg help -c | grep rebate
+   rebate             This is my alias which just prints something.
+  $ hg help rebate
+  hg rebate [MYARGS]
+  
+  shell alias for: echo this is $HG_ARGS
+  
+  This is my alias which just prints something.
+  
+  defined by:* (glob)
+  */* (glob) (?)
+  */* (glob) (?)
+  */* (glob) (?)
+  
+  (some details hidden, use --verbose to show complete help)
+
 invalid arguments
 
   $ hg rt foo
   hg rt: invalid arguments
   hg rt
   
   alias for: hg root
   
   (use 'hg rt -h' to show more help)
   [255]
 
 invalid global arguments for normal commands, aliases, and shell aliases
 
   $ hg --invalid root
   hg: option --invalid not recognized
   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)
   [255]
   $ hg --invalid mylog
   hg: option --invalid not recognized
   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)
   [255]
   $ hg --invalid blank
   hg: option --invalid not recognized
   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)
   [255]
 
 environment variable changes in alias commands
 
   $ cat > $TESTTMP/expandalias.py <<EOF
   > import os
   > from mercurial import cmdutil, commands, registrar
   > cmdtable = {}
   > command = registrar.command(cmdtable)
   > @command(b'expandalias')
   > def expandalias(ui, repo, name):
   >     alias = cmdutil.findcmd(name, commands.table)[1][0]
   >     ui.write(b'%s args: %s\n' % (name, b' '.join(alias.args)))
   >     os.environ['COUNT'] = '2'
   >     ui.write(b'%s args: %s (with COUNT=2)\n' % (name, b' '.join(alias.args)))
   > EOF
 
   $ cat >> $HGRCPATH <<'EOF'
   > [extensions]
   > expandalias = $TESTTMP/expandalias.py
   > [alias]
   > showcount = log -T "$COUNT" -r .
   > EOF
 
   $ COUNT=1 hg expandalias showcount
   showcount args: -T 1 -r .
   showcount args: -T 2 -r . (with COUNT=2)
 
 This should show id:
 
   $ hg --config alias.log='id' log
   000000000000 tip
 
 This shouldn't:
 
   $ hg --config alias.log='id' history
 
   $ cd ../..
 
 return code of command and shell aliases:
 
   $ hg mycommit -R alias
   nothing changed
   [1]
   $ hg exit1
   [1]
 
 #if no-outer-repo
   $ hg root
   abort: no repository found in '$TESTTMP' (.hg not found)!
   [255]
   $ hg --config alias.hgroot='!hg root' hgroot
   abort: no repository found in '$TESTTMP' (.hg not found)!
   [255]
 #endif

tests/test-help.t

@@ -1,3494 +1,3494 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)
 
   $ hg help
   Mercurial Distributed SCM
   
   list of commands:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    annotate      show changeset information by line for each file
    archive       create an unversioned archive of a repository revision
    backout       reverse effect of earlier changeset
    bisect        subdivision search of changesets
    bookmarks     create a new bookmark or list existing bookmarks
    branch        set or show the current branch name
    branches      list repository named branches
    bundle        create a bundle file
    cat           output the current or given revision of files
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    config        show combined config settings from all hgrc files
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    files         list tracked files
    forget        forget the specified files on the next commit
    graft         copy changes from other branches onto the current branch
    grep          search revision history for a pattern in specified files
    heads         show branch heads
    help          show help for a given topic or a help overview
    identify      identify the working directory or specified revision
    import        import an ordered set of patches
    incoming      show new changesets found in source
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    manifest      output the current or given revision of the project manifest
    merge         merge another revision into working directory
    outgoing      show changesets not found in the destination
    paths         show aliases for remote repositories
    phase         set or show the current phase name
    pull          pull changes from the specified source
    push          push changes to the specified destination
    recover       roll back an interrupted transaction
    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
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    tag           add one or more tags for the current or given revision
    tags          list repository tags
    unbundle      apply one or more bundle files
    update        update working directory (or switch revisions)
    verify        verify the integrity of the repository
    version       output version and copyright information
   
   additional help topics:
   
    bundlespec    Bundle File Formats
    color         Colorizing Outputs
    config        Configuration Files
    dates         Date Formats
    diffs         Diff Formats
    environment   Environment Variables
    extensions    Using Additional Features
    filesets      Specifying File Sets
    flags         Command-line flags
    glossary      Glossary
    hgignore      Syntax for Mercurial Ignore Files
    hgweb         Configuring hgweb
    internals     Technical implementation topics
    merge-tools   Merge Tools
    pager         Pager Support
    patterns      File Name Patterns
    phases        Working with Phases
    revisions     Specifying Revisions
    scripting     Using Mercurial from scripts and automation
    subrepos      Subrepositories
    templating    Template Usage
    urls          URL Paths
   
   (use 'hg help -v' to show built-in aliases and global options)
 
   $ hg -q help
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    annotate      show changeset information by line for each file
    archive       create an unversioned archive of a repository revision
    backout       reverse effect of earlier changeset
    bisect        subdivision search of changesets
    bookmarks     create a new bookmark or list existing bookmarks
    branch        set or show the current branch name
    branches      list repository named branches
    bundle        create a bundle file
    cat           output the current or given revision of files
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    config        show combined config settings from all hgrc files
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    files         list tracked files
    forget        forget the specified files on the next commit
    graft         copy changes from other branches onto the current branch
    grep          search revision history for a pattern in specified files
    heads         show branch heads
    help          show help for a given topic or a help overview
    identify      identify the working directory or specified revision
    import        import an ordered set of patches
    incoming      show new changesets found in source
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    manifest      output the current or given revision of the project manifest
    merge         merge another revision into working directory
    outgoing      show changesets not found in the destination
    paths         show aliases for remote repositories
    phase         set or show the current phase name
    pull          pull changes from the specified source
    push          push changes to the specified destination
    recover       roll back an interrupted transaction
    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
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    tag           add one or more tags for the current or given revision
    tags          list repository tags
    unbundle      apply one or more bundle files
    update        update working directory (or switch revisions)
    verify        verify the integrity of the repository
    version       output version and copyright information
   
   additional help topics:
   
    bundlespec    Bundle File Formats
    color         Colorizing Outputs
    config        Configuration Files
    dates         Date Formats
    diffs         Diff Formats
    environment   Environment Variables
    extensions    Using Additional Features
    filesets      Specifying File Sets
    flags         Command-line flags
    glossary      Glossary
    hgignore      Syntax for Mercurial Ignore Files
    hgweb         Configuring hgweb
    internals     Technical implementation topics
    merge-tools   Merge Tools
    pager         Pager Support
    patterns      File Name Patterns
    phases        Working with Phases
    revisions     Specifying Revisions
    scripting     Using Mercurial from scripts and automation
    subrepos      Subrepositories
    templating    Template Usage
    urls          URL Paths
 
 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
        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
        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
        purge         command to delete untracked files from the working
                      directory
        relink        recreates hardlinks between repository clones
        remotenames   showing remotebookmarks and remotebranches in UI
        schemes       extend schemes with shortcuts to repository swarms
        share         share a common history between several working directories
        shelve        save and restore changes to the working directory
        strip         strip changesets and their descendants from history
        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
 
 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:
   
    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
    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.
   
   (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-* Matt 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)
   [255]
 
 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.
   
   (some details hidden, use --verbose to show complete help)
 
   $ hg help diff
   hg diff [OPTION]... ([-c REV] | [-r REV1 [-r 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.
   
       When two revision arguments are given, then changes are shown between
       those revisions. If only one revision is specified then that revision is
       compared to the working directory, and, when no revisions are specified,
       the working directory files are compared to its first parent.
   
       Alternatively you can specify -c/--change with a revision to see the
       changes in that changeset relative to its first parent.
   
       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):
   
    -r --rev REV [+]         revision
    -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 deleted (but tracked) 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
   
   (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')
   [255]
 
   $ hg skjdfks
   hg: unknown command 'skjdfks'
   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)
   [255]
 
 Typoed command gives suggestion
   $ hg puls
   hg: unknown command 'puls'
   (did you mean one of pull, push?)
   [255]
 
 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)
   [255]
 
 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)
   [255]
 
 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?)
   [255]
 
   $ hg log.
   hg: unknown command 'log.'
   (did you mean log?)
   [255]
   $ hg pu.lh
   hg: unknown command 'pu.lh'
   (did you mean one of pull, push?)
   [255]
 
   $ 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'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
   > 
   > def uisetup(ui):
   >     ui.setconfig(b'alias', b'shellalias', b'!echo hi', b'helpext')
   >     ui.setconfig(b'alias', b'hgalias', b'summary', b'helpext')
   > 
   > EOF
   $ echo '[extensions]' >> $HGRCPATH
   $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
 
 Test for aliases
 
   $ hg help hgalias
   hg hgalias [--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
+  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
       --callableopt VALUE           adds foo
       --customopt VALUE             adds bar
       --customopt-withdefault VALUE adds bar (default: foo)
   
   (some details hidden, use --verbose to show complete help)
 
   $ hg help -k nohelp
   Commands:
   
    nohelp hg nohelp
   
   Extension Commands:
   
    nohelp (no help text available)
 
 Test that default list of commands omits extension commands
 
   $ hg help
   Mercurial Distributed SCM
   
   list of commands:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    annotate      show changeset information by line for each file
    archive       create an unversioned archive of a repository revision
    backout       reverse effect of earlier changeset
    bisect        subdivision search of changesets
    bookmarks     create a new bookmark or list existing bookmarks
    branch        set or show the current branch name
    branches      list repository named branches
    bundle        create a bundle file
    cat           output the current or given revision of files
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    config        show combined config settings from all hgrc files
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    files         list tracked files
    forget        forget the specified files on the next commit
    graft         copy changes from other branches onto the current branch
    grep          search revision history for a pattern in specified files
    heads         show branch heads
    help          show help for a given topic or a help overview
    identify      identify the working directory or specified revision
    import        import an ordered set of patches
    incoming      show new changesets found in source
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    manifest      output the current or given revision of the project manifest
    merge         merge another revision into working directory
    outgoing      show changesets not found in the destination
    paths         show aliases for remote repositories
    phase         set or show the current phase name
    pull          pull changes from the specified source
    push          push changes to the specified destination
    recover       roll back an interrupted transaction
    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
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    tag           add one or more tags for the current or given revision
    tags          list repository tags
    unbundle      apply one or more bundle files
    update        update working directory (or switch revisions)
    verify        verify the integrity of the repository
    version       output version and copyright information
   
   enabled extensions:
   
    helpext       (no help text available)
   
   additional help topics:
   
    bundlespec    Bundle File Formats
    color         Colorizing Outputs
    config        Configuration Files
    dates         Date Formats
    diffs         Diff Formats
    environment   Environment Variables
    extensions    Using Additional Features
    filesets      Specifying File Sets
    flags         Command-line flags
    glossary      Glossary
    hgignore      Syntax for Mercurial Ignore Files
    hgweb         Configuring hgweb
    internals     Technical implementation topics
    merge-tools   Merge Tools
    pager         Pager Support
    patterns      File Name Patterns
    phases        Working with Phases
    revisions     Specifying Revisions
    scripting     Using Mercurial from scripts and automation
    subrepos      Subrepositories
    templating    Template Usage
    urls          URL Paths
   
   (use 'hg help -v' to show built-in aliases and global options)
 
 
 Test list of internal help commands
 
   $ hg help debug
   debug commands (internal and unsupported):
   
    debugancestor
                  find the ancestor revision of two revisions in a given index
    debugapplystreamclonebundle
                  apply a stream clone bundle file
    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
    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
    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
    debugindex    dump the contents of an index file
    debugindexdot
                  dump an index DAG as a graphviz dot file
    debuginstall  test Mercurial installation
    debugknown    test whether node ids are known to a repo
    debuglocks    show or modify state of locks
    debugmergestate
                  print merge state
    debugnamecomplete
                  complete "names" - tags, open branch names, bookmark names
    debugobsolete
                  create arbitrary obsolete marker
    debugoptADV   (no help text available)
    debugoptDEP   (no help text available)
    debugoptEXP   (no help text available)
    debugpathcomplete
                  complete part or all of a tracked path
    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
    debugrevlog   show data and statistics about a revlog
    debugrevspec  parse and apply a revision specification
    debugserve    run a server with advanced settings
    debugsetparents
                  manually set the parents of the current working directory
    debugssl      test a secure connection to a server
    debugsub      (no help text available)
    debugsuccessorssets
                  show set of successors for revision
    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}"
   
        bundle2       Bundle2
        bundles       Bundles
        censor        Censor
        changegroups  Changegroups
        config        Config Registrar
        requirements  Repository Requirements
        revlogs       Revision Logs
        wireprotocol  Wire Protocol
 
 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 3 versions of changegroups: "1", "2", and "3". 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 revlog flags in the *delta header* and optionally
       exchanging treemanifests (enabled by setting an option on the
       "changegroup" part in the bundle2).
   
       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", and "3" 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) |
         |            |             |             |            |            |           |
         +------------------------------------------------------------------------------+
   
       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.
   
       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
       only if the 'treemanifest' param is part of the bundle2 changegroup part
       (it is not possible to use changegroup version 3 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.
 
 Test list of commands with command with no help text
 
   $ hg help helpext
   helpext extension - no help text available
   
   list of commands:
   
    nohelp        (no help text available)
   
   (use 'hg help -v helpext' to show built-in aliases and global options)
 
 
 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 of 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".
   
 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)
 
 Separate sections from subsections
 
   $ hg help config.format | egrep '^    ("|-)|^\s*$' | uniq
       "format"
       --------
   
       "usegeneraldelta"
   
       "dotencode"
   
       "usefncache"
   
       "usestore"
   
       "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 + '\nhelphook1\n'
   > 
   > def extsetup(ui):
   >     help.addtopichook('revisions', rewrite)
   > EOF
   $ cat > helphook2.py <<EOF
   > from mercurial import help
   > 
   > def rewrite(ui, topic, doc):
   >     return doc + '\nhelphook2\n'
   > 
   > def extsetup(ui):
   >     help.addtopichook('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')
   [255]
   $ 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 > /dev/null
   abort: no such help topic: commit
   (try 'hg help --keyword commit')
   [255]
 
 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
    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:
   
    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')
   [255]
 
 Test unfound keyword
 
   $ hg help --keyword nonexistingwordthatwillneverexisteverever
   abort: no matches
   (try 'hg help' for a list of topics)
   [255]
 
 Test omit indicating for help
 
   $ cat > addverboseitems.py <<EOF
   > '''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 __future__ import absolute_import
   > from mercurial import commands, help
   > testtopic = """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((["topic-containing-verbose"],
   >                            "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'.
   
       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
   
       The following sub-options can be defined:
   
       "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.
   
       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
   [255]
 
   $ hg help glossary.mc.guffin
   abort: help section not found: glossary.mc.guffin
   [255]
 
   $ 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 ''.join('\u%x' % ord(uc) for uc in s.decode('cp932'))
   > # translation of "record" in ja_JP.cp932
   > upper = "\x8bL\x98^"
   > # str.lower()-ed section name should be treated as different one
   > lower = "\x8bl\x98^"
   > with open('ambiguous.py', 'w') as fp:
   >     fp.write("""# 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
   > upper = "\x8bL\x98^"
   > print("hg --encoding cp932 help -e ambiguous.%s" % upper)
   > EOF
   \x8bL\x98^ (esc)
   ----
   
   Upper name should show only this message
   
 
   $ $PYTHON <<EOF | sh
   > lower = "\x8bl\x98^"
   > print("hg --encoding cp932 help -e ambiguous.%s" % 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.
   
       ":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.
   
       ":forcedump"
         Creates three versions of the files as same as :dump, but omits
         premerge.
   
       ":local"
         Uses the local 'p1()' version of files as the merged version.
   
       ":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.
   
       ":other"
         Uses the other 'p2()' version of files as the merged version.
   
       ":prompt"
         Asks the user which of the local 'p1()' or the other 'p2()' version to
         keep as the merged version.
   
       ":tagmerge"
         Uses the internal tag merge algorithm (experimental).
   
       ":union"
         Uses the internal non-interactive simple merge algorithm for merging
         files. It will use both left and right sides for conflict regions. No
         markers are inserted.
   
       Internal tools are always available and do not require a GUI but will by
       default not handle symlinks or binary files.
   
       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. Here, binary capabilities
          of the merge tool are not considered.
       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.
   
       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/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/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/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/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/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 revision history for a pattern in specified files
   </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>
   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/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/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/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>
   </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 of today
   </ul>
   
   </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.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.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.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>
   
   
   
   
   
   </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 3 versions of changegroups: &quot;1&quot;, &quot;2&quot;, and &quot;3&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 revlog flags in the *delta header* and optionally
   exchanging treemanifests (enabled by setting an option on the
   &quot;changegroup&quot; part in the bundle2).
   </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;, and
   &quot;3&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>
   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>
   <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
   only if the 'treemanifest' param is part of the bundle2 changegroup part
   (it is not possible to use changegroup version 3 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