profiling: add a context manager that no-ops if profiling isn't enabled

And refactor dispatch.py to use it. As you can see, the resulting code
is much simpler.

I was tempted to inline _runcommand as part of writing this series.
However, a number of extensions wrap _runcommand. So keeping it around
is necessary (extensions can't easily wrap runcommand because it calls
hooks before and after command execution).

mercurial/dispatch.py

@@ -1,982 +1,973 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 atexit
 import difflib
 import errno
 import os
 import pdb
 import re
 import shlex
 import signal
 import socket
 import sys
 import time
 import traceback
 
 
 from .i18n import _
 
 from . import (
     cmdutil,
     commands,
     demandimport,
     encoding,
     error,
     extensions,
     fancyopts,
     fileset,
     hg,
     hook,
     profiling,
     revset,
     templatefilters,
     templatekw,
     templater,
     ui as uimod,
     util,
 )
 
 class request(object):
     def __init__(self, args, ui=None, repo=None, fin=None, fout=None,
                  ferr=None):
         self.args = args
         self.ui = ui
         self.repo = repo
 
         # input/output/error streams
         self.fin = fin
         self.fout = fout
         self.ferr = ferr
 
 def run():
     "run the command in sys.argv"
     sys.exit((dispatch(request(sys.argv[1:])) or 0) & 255)
 
 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") %
                          (inst.args[1], inst.args[0]))
         if (inst.args[0][0] == ' '):
             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 dispatch(req):
     "run the command specified in req.args"
     if req.ferr:
         ferr = req.ferr
     elif req.ui:
         ferr = req.ui.ferr
     else:
         ferr = sys.stderr
 
     try:
         if not req.ui:
             req.ui = uimod.ui()
         if '--traceback' in req.args:
             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 = ' '.join(' ' in a and repr(a) or a for a in req.args)
     starttime = time.time()
     ret = None
     try:
         ret = _runcatch(req)
     except KeyboardInterrupt:
         try:
             req.ui.warn(_("interrupted!\n"))
         except IOError as inst:
             if inst.errno != errno.EPIPE:
                 raise
         ret = -1
     finally:
         duration = time.time() - starttime
         req.ui.flush()
         req.ui.log("commandfinish", "%s exited %s after %0.2f seconds\n",
                    msg, ret or 0, duration)
     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():
         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, _earlygetopt(['--config'], req.args))
 
             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 '--debugger' in req.args:
                 # 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 '--debugger' in req.args:
                 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 '--debugger' in req.args:
                 traceback.print_exc()
                 debugmortem[debugger](sys.exc_info()[2])
             ui.traceback()
             raise
 
     return callcatch(ui, _runcatchfunc)
 
 def callcatch(ui, func):
     """call func() with global exception handling
 
     return func() if no exception happens. otherwise do some error handling
     and return an exit code accordingly.
     """
     try:
         return func()
     # Global exception handling, alphabetically
     # Mercurial-specific first, followed by built-in and library exceptions
     except error.AmbiguousCommand as inst:
         ui.warn(_("hg: command '%s' is ambiguous:\n    %s\n") %
                 (inst.args[0], " ".join(inst.args[1])))
     except error.ParseError as inst:
         _formatparse(ui.warn, inst)
         return -1
     except error.LockHeld as inst:
         if inst.errno == errno.ETIMEDOUT:
             reason = _('timed out waiting for lock held by %s') % inst.locker
         else:
             reason = _('lock held by %s') % inst.locker
         ui.warn(_("abort: %s: %s\n") % (inst.desc or inst.filename, reason))
     except error.LockUnavailable as inst:
         ui.warn(_("abort: could not lock %s: %s\n") %
                (inst.desc or inst.filename, inst.strerror))
     except error.CommandError as inst:
         if inst.args[0]:
             ui.warn(_("hg %s: %s\n") % (inst.args[0], inst.args[1]))
             commands.help_(ui, inst.args[0], full=False, command=True)
         else:
             ui.warn(_("hg: %s\n") % inst.args[1])
             commands.help_(ui, 'shortlist')
     except error.OutOfBandError as inst:
         if inst.args:
             msg = _("abort: remote error:\n")
         else:
             msg = _("abort: remote error\n")
         ui.warn(msg)
         if inst.args:
             ui.warn(''.join(inst.args))
         if inst.hint:
             ui.warn('(%s)\n' % inst.hint)
     except error.RepoError as inst:
         ui.warn(_("abort: %s!\n") % inst)
         if inst.hint:
             ui.warn(_("(%s)\n") % inst.hint)
     except error.ResponseError as inst:
         ui.warn(_("abort: %s") % inst.args[0])
         if not isinstance(inst.args[1], basestring):
             ui.warn(" %r\n" % (inst.args[1],))
         elif not inst.args[1]:
             ui.warn(_(" empty string\n"))
         else:
             ui.warn("\n%r\n" % util.ellipsis(inst.args[1]))
     except error.CensoredNodeError as inst:
         ui.warn(_("abort: file censored %s!\n") % inst)
     except error.RevlogError as inst:
         ui.warn(_("abort: %s!\n") % inst)
     except error.SignalInterrupt:
         ui.warn(_("killed!\n"))
     except error.UnknownCommand as inst:
         ui.warn(_("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)
             commands.help_(ui, inst.args[0], unknowncmd=True)
         except (error.UnknownCommand, error.Abort):
             suggested = False
             if len(inst.args) == 2:
                 sim = _getsimilar(inst.args[1], inst.args[0])
                 if sim:
                     _reportsimilar(ui.warn, sim)
                     suggested = True
             if not suggested:
                 commands.help_(ui, 'shortlist')
     except error.InterventionRequired as inst:
         ui.warn("%s\n" % inst)
         if inst.hint:
             ui.warn(_("(%s)\n") % inst.hint)
         return 1
     except error.Abort as inst:
         ui.warn(_("abort: %s\n") % inst)
         if inst.hint:
             ui.warn(_("(%s)\n") % inst.hint)
     except ImportError as inst:
         ui.warn(_("abort: %s!\n") % inst)
         m = str(inst).split()[-1]
         if m in "mpatch bdiff".split():
             ui.warn(_("(did you forget to compile extensions?)\n"))
         elif m in "zlib".split():
             ui.warn(_("(is your Python install correct?)\n"))
     except IOError as inst:
         if util.safehasattr(inst, "code"):
             ui.warn(_("abort: %s\n") % inst)
         elif util.safehasattr(inst, "reason"):
             try: # usually it is in the form (errno, strerror)
                 reason = inst.reason.args[1]
             except (AttributeError, IndexError):
                 # it might be anything, for example a string
                 reason = inst.reason
             if isinstance(reason, unicode):
                 # SSLError of Python 2.7.9 contains a unicode
                 reason = reason.encode(encoding.encoding, 'replace')
             ui.warn(_("abort: error: %s\n") % reason)
         elif (util.safehasattr(inst, "args")
               and inst.args and inst.args[0] == errno.EPIPE):
             pass
         elif getattr(inst, "strerror", None):
             if getattr(inst, "filename", None):
                 ui.warn(_("abort: %s: %s\n") % (inst.strerror, inst.filename))
             else:
                 ui.warn(_("abort: %s\n") % inst.strerror)
         else:
             raise
     except OSError as inst:
         if getattr(inst, "filename", None) is not None:
             ui.warn(_("abort: %s: '%s'\n") % (inst.strerror, inst.filename))
         else:
             ui.warn(_("abort: %s\n") % inst.strerror)
     except KeyboardInterrupt:
         raise
     except MemoryError:
         ui.warn(_("abort: out of memory\n"))
     except SystemExit as inst:
         # Commands shouldn't sys.exit directly, but give a return code.
         # Just in case catch this and and pass exit code to caller.
         return inst.code
     except socket.error as inst:
         ui.warn(_("abort: %s\n") % inst.args[-1])
     except:  # perhaps re-raises
         if not handlecommandexception(ui):
             raise
 
     return -1
 
 def aliasargs(fn, givenargs):
     args = getattr(fn, 'args', [])
     if args:
         cmd = ' '.join(map(util.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(r'\$(\d+|\$)', replacer, cmd)
         givenargs = [x for i, x in enumerate(givenargs)
                      if i not in nums]
         args = shlex.split(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(util.shellquote(arg) for arg in args)
     # escape '\$' for regex
     regex = '|'.join(replacemap.keys()).replace('$', r'\$')
     r = re.compile(regex)
     return r.sub(lambda x: replacemap[x.group()], cmd)
 
 class cmdalias(object):
     def __init__(self, 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('!'):
             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."
                                  % (int(m.groups()[0]), self.name))
                         return ''
                 cmd = re.sub(r'\$(\d+|\$)', _checkvar, self.definition[1:])
                 cmd = aliasinterpolate(self.name, args, cmd)
                 return ui.system(cmd, environ=env)
             self.fn = fn
             return
 
         try:
             args = shlex.split(self.definition)
         except ValueError as inst:
             self.badalias = (_("error in definition for alias '%s': %s")
                              % (self.name, inst))
             return
         self.cmdname = cmd = args.pop(0)
         self.givenargs = args
 
         for invalidarg in ("--cwd", "-R", "--repository", "--repo", "--config"):
             if _earlygetopt([invalidarg], args):
                 self.badalias = (_("error in definition for alias '%s': %s may "
                                    "only be given on the command line")
                                  % (self.name, invalidarg))
                 return
 
         try:
             tableentry = cmdutil.findcmd(cmd, cmdtable, False)[1]
             if len(tableentry) > 2:
                 self.fn, self.opts, self.help = tableentry
             else:
                 self.fn, self.opts = tableentry
 
             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__
 
         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))
 
     @property
     def args(self):
         args = map(util.expandpath, self.givenargs)
         return aliasargs(self.fn, args)
 
     def __getattr__(self, name):
         adefaults = {'norepo': True, 'optionalrepo': False, '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))
 
         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
 
 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'):
         source = ui.configsource('alias', alias)
         aliasdef = cmdalias(alias, definition, cmdtable, source)
 
         try:
             olddef = cmdtable[aliasdef.cmd][0]
             if olddef.definition == aliasdef.definition:
                 continue
         except (KeyError, AttributeError):
             # definition might not exist or it might not be a cmdalias
             pass
 
         cmdtable[aliasdef.name] = (aliasdef, aliasdef.opts, aliasdef.help)
 
 def _parse(ui, args):
     options = {}
     cmdoptions = {}
 
     try:
         args = fancyopts.fancyopts(args, commands.globalopts, options)
     except fancyopts.getopt.GetoptError as inst:
         raise error.CommandError(None, 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 = map(util.expandpath, shlex.split(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, True)
     except fancyopts.getopt.GetoptError as inst:
         raise error.CommandError(cmd, 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)') % cfg)
 
     return configs
 
 def _earlygetopt(aliases, args):
     """Return list of values for an option (or aliases).
 
     The values are listed in the order they appear in args.
     The options and values are removed from args.
 
     >>> args = ['x', '--cwd', 'foo', 'y']
     >>> _earlygetopt(['--cwd'], args), args
     (['foo'], ['x', 'y'])
 
     >>> args = ['x', '--cwd=bar', 'y']
     >>> _earlygetopt(['--cwd'], args), args
     (['bar'], ['x', 'y'])
 
     >>> args = ['x', '-R', 'foo', 'y']
     >>> _earlygetopt(['-R'], args), args
     (['foo'], ['x', 'y'])
 
     >>> args = ['x', '-Rbar', 'y']
     >>> _earlygetopt(['-R'], args), args
     (['bar'], ['x', 'y'])
     """
     try:
         argcount = args.index("--")
     except ValueError:
         argcount = len(args)
     shortopts = [opt for opt in aliases if len(opt) == 2]
     values = []
     pos = 0
     while pos < argcount:
         fullarg = arg = args[pos]
         equals = arg.find('=')
         if equals > -1:
             arg = arg[:equals]
         if arg in aliases:
             del args[pos]
             if equals > -1:
                 values.append(fullarg[equals + 1:])
                 argcount -= 1
             else:
                 if pos + 1 >= argcount:
                     # ignore and let getopt report an error if there is no value
                     break
                 values.append(args.pop(pos))
                 argcount -= 2
         elif arg[:2] in shortopts:
             # short option can have no following space, e.g. hg log -Rfoo
             values.append(args.pop(pos)[2:])
             argcount -= 1
         else:
             pos += 1
     return values
 
 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 = os.getcwd()
         except OSError as e:
             raise error.Abort(_("error getting current working directory: %s") %
                               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 and rpath[-1]:
         path = lui.expandpath(rpath[-1])
         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 fancyopts.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'):
         d = lambda: fn(ui, *args[1:])
         return lambda: runcommand(lui, None, cmd, args[:1], ui, options, d,
                                   [], {})
 
 def _cmdattr(ui, cmd, func, attr):
     try:
         return getattr(func, attr)
     except AttributeError:
         ui.deprecwarn("missing attribute '%s', use @command decorator "
                       "to register '%s'" % (attr, cmd), '3.8')
         return False
 
 _loaded = set()
 
 # list of (objname, loadermod, loadername) tuple:
 # - objname is the name of an object in extension module, from which
 #   extra information is loaded
 # - loadermod is the module where loader is placed
 # - loadername is the name of the function, which takes (ui, extensionname,
 #   extraobj) arguments
 extraloaders = [
     ('cmdtable', commands, 'loadcmdtable'),
     ('filesetpredicate', fileset, 'loadpredicate'),
     ('revsetpredicate', revset, 'loadpredicate'),
     ('templatefilter', templatefilters, 'loadfilter'),
     ('templatefunc', templater, 'loadfunction'),
     ('templatekeyword', templatekw, 'loadkeyword'),
 ]
 
 def _dispatch(req):
     args = req.args
     ui = req.ui
 
     # check for cwd
     cwd = _earlygetopt(['--cwd'], args)
     if cwd:
         os.chdir(cwd[-1])
 
     rpath = _earlygetopt(["-R", "--repository", "--repo"], args)
     path, lui = _getlocal(ui, rpath)
 
     # Configure extensions in phases: uisetup, extsetup, cmdtable, and
     # reposetup. Programs like TortoiseHg will call _dispatch several
     # times so we keep track of configured extensions in _loaded.
     extensions.loadall(lui)
     exts = [ext for ext in extensions.extensions() if ext[0] not in _loaded]
     # Propagate any changes to lui.__class__ by extensions
     ui.__class__ = lui.__class__
 
     # (uisetup and extsetup are handled in extensions.loadall)
 
     for name, module in exts:
         for objname, loadermod, loadername in extraloaders:
             extraobj = getattr(module, objname, None)
             if extraobj is not None:
                 getattr(loadermod, loadername)(ui, name, extraobj)
         _loaded.add(name)
 
     # (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"]:
         raise error.Abort(_("option --config may not be abbreviated!"))
     if options["cwd"]:
         raise error.Abort(_("option --cwd may not be abbreviated!"))
     if options["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["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]))
         atexit.register(print_time)
 
     uis = set([ui, lui])
 
     if req.repo:
         uis.add(req.repo.ui)
 
     if options['verbose'] or options['debug'] or options['quiet']:
         for opt in ('verbose', 'debug', 'quiet'):
             val = str(bool(options[opt]))
             for ui_ in uis:
                 ui_.setconfig('ui', opt, val, '--' + opt)
 
     if options['profile']:
         for ui_ in uis:
             ui_.setconfig('profiling', 'enabled', 'true', '--profile')
 
     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
 
     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 _cmdattr(ui, cmd, 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)
                 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 and rpath[-1]: # invalid -R path
                     raise
                 if not _cmdattr(ui, cmd, func, 'optionalrepo'):
                     if (_cmdattr(ui, cmd, func, 'inferrepo') and
                         args and not path):
                         # try to infer -R from command args
                         repos = map(cmdutil.findrepo, args)
                         guess = repos[0]
                         if guess and repos.count(guess) == len(repos):
                             req.args = ['--repository', guess] + fullargs
                             return _dispatch(req)
                     if not path:
                         raise error.RepoError(_("no repository found in '%s'"
                                                 " (.hg not found)")
                                               % os.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 = ' '.join(' ' in a and repr(a) or a for a in fullargs)
     ui.log("command", '%s\n', msg)
     d = lambda: util.checksignature(func)(ui, *args, **cmdoptions)
     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):
-    """Enables the profiler if applicable.
-
-    ``profiling.enabled`` - boolean config that enables or disables profiling
-    """
-    def checkargs():
+    """Run a command function, possibly with profiling enabled."""
+    with profiling.maybeprofile(ui):
         try:
             return cmdfunc()
         except error.SignatureError:
-            raise error.CommandError(cmd, _("invalid arguments"))
-
-    if ui.configbool('profiling', 'enabled'):
-        with profiling.profile(ui):
-            return checkargs()
-    else:
-        return checkargs()
+            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', None) is None:
         for name, mod in extensions.extensions():
             testedwith = 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 testedwith == 'internal':
                 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, str):
             testedwith = '.'.join([str(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', None)
         if bugtracker is None:
             bugtracker = _("https://mercurial-scm.org/wiki/BugTracker")
         warning = (_("** unknown exception encountered, "
                      "please report by visiting\n** ") + bugtracker + '\n')
     warning += ((_("** Python %s\n") % sys.version.replace('\n', '')) +
                 (_("** 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, traceback.format_exc())
     ui.warn(warning)
     return False  # re-raise the exception

mercurial/help/config.txt

@@ -1,2234 +1,2240 b''
 The Mercurial system uses a set of configuration files to control
 aspects of its behavior.
 
 Troubleshooting
 ===============
 
 If you're having problems with your configuration,
 :hg:`config --debug` can help you understand what is introducing
 a setting into your environment.
 
 See :hg:`help config.syntax` and :hg:`help config.files`
 for information about how and where to override things.
 
 Structure
 =========
 
 The configuration files use a simple ini-file format. A configuration
 file consists of sections, led by a ``[section]`` header and followed
 by ``name = value`` entries::
 
   [ui]
   username = Firstname Lastname <[e-mail]>
   verbose = True
 
 The above entries will be referred to as ``ui.username`` and
 ``ui.verbose``, respectively. See :hg:`help config.syntax`.
 
 Files
 =====
 
 Mercurial reads configuration data from several files, if they exist.
 These files do not exist by default and you will have to create the
 appropriate configuration files yourself:
 
 Local configuration is put into the per-repository ``<repo>/.hg/hgrc`` file.
 
 Global configuration like the username setting is typically put into:
 
 .. container:: windows
 
   - ``%USERPROFILE%\mercurial.ini`` (on Windows)
 
 .. container:: unix.plan9
 
   - ``$HOME/.hgrc`` (on Unix, Plan9)
 
 The names of these files depend on the system on which Mercurial is
 installed. ``*.rc`` files from a single directory are read in
 alphabetical order, later ones overriding earlier ones. Where multiple
 paths are given below, settings from earlier paths override later
 ones.
 
 .. container:: verbose.unix
 
   On Unix, the following files are consulted:
 
   - ``<repo>/.hg/hgrc`` (per-repository)
   - ``$HOME/.hgrc`` (per-user)
   - ``<install-root>/etc/mercurial/hgrc`` (per-installation)
   - ``<install-root>/etc/mercurial/hgrc.d/*.rc`` (per-installation)
   - ``/etc/mercurial/hgrc`` (per-system)
   - ``/etc/mercurial/hgrc.d/*.rc`` (per-system)
   - ``<internal>/default.d/*.rc`` (defaults)
 
 .. container:: verbose.windows
 
   On Windows, the following files are consulted:
 
   - ``<repo>/.hg/hgrc`` (per-repository)
   - ``%USERPROFILE%\.hgrc`` (per-user)
   - ``%USERPROFILE%\Mercurial.ini`` (per-user)
   - ``%HOME%\.hgrc`` (per-user)
   - ``%HOME%\Mercurial.ini`` (per-user)
   - ``HKEY_LOCAL_MACHINE\SOFTWARE\Mercurial`` (per-installation)
   - ``<install-dir>\hgrc.d\*.rc`` (per-installation)
   - ``<install-dir>\Mercurial.ini`` (per-installation)
   - ``<internal>/default.d/*.rc`` (defaults)
 
   .. note::
 
    The registry key ``HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Mercurial``
    is used when running 32-bit Python on 64-bit Windows.
 
 .. container:: windows
 
   On Windows 9x, ``%HOME%`` is replaced by ``%APPDATA%``.
 
 .. container:: verbose.plan9
 
   On Plan9, the following files are consulted:
 
   - ``<repo>/.hg/hgrc`` (per-repository)
   - ``$home/lib/hgrc`` (per-user)
   - ``<install-root>/lib/mercurial/hgrc`` (per-installation)
   - ``<install-root>/lib/mercurial/hgrc.d/*.rc`` (per-installation)
   - ``/lib/mercurial/hgrc`` (per-system)
   - ``/lib/mercurial/hgrc.d/*.rc`` (per-system)
   - ``<internal>/default.d/*.rc`` (defaults)
 
 Per-repository configuration options only apply in a
 particular repository. This file is not version-controlled, and
 will not get transferred during a "clone" operation. Options in
 this file override options in all other configuration files.
 
 .. container:: unix.plan9
 
   On Plan 9 and Unix, most of this file will be ignored if it doesn't
   belong to a trusted user or to a trusted group. See
   :hg:`help config.trusted` for more details.
 
 Per-user configuration file(s) are for the user running Mercurial.  Options
 in these files apply to all Mercurial commands executed by this user in any
 directory. Options in these files override per-system and per-installation
 options.
 
 Per-installation configuration files are searched for in the
 directory where Mercurial is installed. ``<install-root>`` is the
 parent directory of the **hg** executable (or symlink) being run.
 
 .. container:: unix.plan9
 
   For example, if installed in ``/shared/tools/bin/hg``, Mercurial
   will look in ``/shared/tools/etc/mercurial/hgrc``. Options in these
   files apply to all Mercurial commands executed by any user in any
   directory.
 
 Per-installation configuration files are for the system on
 which Mercurial is running. Options in these files apply to all
 Mercurial commands executed by any user in any directory. Registry
 keys contain PATH-like strings, every part of which must reference
 a ``Mercurial.ini`` file or be a directory where ``*.rc`` files will
 be read.  Mercurial checks each of these locations in the specified
 order until one or more configuration files are detected.
 
 Per-system configuration files are for the system on which Mercurial
 is running. Options in these files apply to all Mercurial commands
 executed by any user in any directory. Options in these files
 override per-installation options.
 
 Mercurial comes with some default configuration. The default configuration
 files are installed with Mercurial and will be overwritten on upgrades. Default
 configuration files should never be edited by users or administrators but can
 be overridden in other configuration files. So far the directory only contains
 merge tool configuration but packagers can also put other default configuration
 there.
 
 Syntax
 ======
 
 A configuration file consists of sections, led by a ``[section]`` header
 and followed by ``name = value`` entries (sometimes called
 ``configuration keys``)::
 
     [spam]
     eggs=ham
     green=
        eggs
 
 Each line contains one entry. If the lines that follow are indented,
 they are treated as continuations of that entry. Leading whitespace is
 removed from values. Empty lines are skipped. Lines beginning with
 ``#`` or ``;`` are ignored and may be used to provide comments.
 
 Configuration keys can be set multiple times, in which case Mercurial
 will use the value that was configured last. As an example::
 
     [spam]
     eggs=large
     ham=serrano
     eggs=small
 
 This would set the configuration key named ``eggs`` to ``small``.
 
 It is also possible to define a section multiple times. A section can
 be redefined on the same and/or on different configuration files. For
 example::
 
     [foo]
     eggs=large
     ham=serrano
     eggs=small
 
     [bar]
     eggs=ham
     green=
        eggs
 
     [foo]
     ham=prosciutto
     eggs=medium
     bread=toasted
 
 This would set the ``eggs``, ``ham``, and ``bread`` configuration keys
 of the ``foo`` section to ``medium``, ``prosciutto``, and ``toasted``,
 respectively. As you can see there only thing that matters is the last
 value that was set for each of the configuration keys.
 
 If a configuration key is set multiple times in different
 configuration files the final value will depend on the order in which
 the different configuration files are read, with settings from earlier
 paths overriding later ones as described on the ``Files`` section
 above.
 
 A line of the form ``%include file`` will include ``file`` into the
 current configuration file. The inclusion is recursive, which means
 that included files can include other files. Filenames are relative to
 the configuration file in which the ``%include`` directive is found.
 Environment variables and ``~user`` constructs are expanded in
 ``file``. This lets you do something like::
 
   %include ~/.hgrc.d/$HOST.rc
 
 to include a different configuration file on each computer you use.
 
 A line with ``%unset name`` will remove ``name`` from the current
 section, if it has been set previously.
 
 The values are either free-form text strings, lists of text strings,
 or Boolean values. Boolean values can be set to true using any of "1",
 "yes", "true", or "on" and to false using "0", "no", "false", or "off"
 (all case insensitive).
 
 List values are separated by whitespace or comma, except when values are
 placed in double quotation marks::
 
   allow_read = "John Doe, PhD", brian, betty
 
 Quotation marks can be escaped by prefixing them with a backslash. Only
 quotation marks at the beginning of a word is counted as a quotation
 (e.g., ``foo"bar baz`` is the list of ``foo"bar`` and ``baz``).
 
 Sections
 ========
 
 This section describes the different sections that may appear in a
 Mercurial configuration file, the purpose of each section, its possible
 keys, and their possible values.
 
 ``alias``
 ---------
 
 Defines command aliases.
 
 Aliases allow you to define your own commands in terms of other
 commands (or aliases), optionally including arguments. Positional
 arguments in the form of ``$1``, ``$2``, etc. in the alias definition
 are expanded by Mercurial before execution. Positional arguments not
 already used by ``$N`` in the definition are put at the end of the
 command to be executed.
 
 Alias definitions consist of lines of the form::
 
     <alias> = <command> [<argument>]...
 
 For example, this definition::
 
     latest = log --limit 5
 
 creates a new command ``latest`` that shows only the five most recent
 changesets. You can define subsequent aliases using earlier ones::
 
     stable5 = latest -b stable
 
 .. note::
 
    It is possible to create aliases with the same names as
    existing commands, which will then override the original
    definitions. This is almost always a bad idea!
 
 An alias can start with an exclamation point (``!``) to make it a
 shell alias. A shell alias is executed with the shell and will let you
 run arbitrary commands. As an example, ::
 
    echo = !echo $@
 
 will let you do ``hg echo foo`` to have ``foo`` printed in your
 terminal. A better example might be::
 
    purge = !$HG status --no-status --unknown -0 re: | xargs -0 rm
 
 which will make ``hg purge`` delete all unknown files in the
 repository in the same manner as the purge extension.
 
 Positional arguments like ``$1``, ``$2``, etc. in the alias definition
 expand to the command arguments. Unmatched arguments are
 removed. ``$0`` expands to the alias name and ``$@`` expands to all
 arguments separated by a space. ``"$@"`` (with quotes) expands to all
 arguments quoted individually and separated by a space. These expansions
 happen before the command is passed to the shell.
 
 Shell aliases are executed in an environment where ``$HG`` expands to
 the path of the Mercurial that was used to execute the alias. This is
 useful when you want to call further Mercurial commands in a shell
 alias, as was done above for the purge alias. In addition,
 ``$HG_ARGS`` expands to the arguments given to Mercurial. In the ``hg
 echo foo`` call above, ``$HG_ARGS`` would expand to ``echo foo``.
 
 .. note::
 
    Some global configuration options such as ``-R`` are
    processed before shell aliases and will thus not be passed to
    aliases.
 
 
 ``annotate``
 ------------
 
 Settings used when displaying file annotations. All values are
 Booleans and default to False. See :hg:`help config.diff` for
 related options for the diff command.
 
 ``ignorews``
     Ignore white space when comparing lines.
 
 ``ignorewsamount``
     Ignore changes in the amount of white space.
 
 ``ignoreblanklines``
     Ignore changes whose lines are all blank.
 
 
 ``auth``
 --------
 
 Authentication credentials for HTTP authentication. This section
 allows you to store usernames and passwords for use when logging
 *into* HTTP servers. See :hg:`help config.web` if
 you want to configure *who* can login to your HTTP server.
 
 Each line has the following format::
 
     <name>.<argument> = <value>
 
 where ``<name>`` is used to group arguments into authentication
 entries. Example::
 
     foo.prefix = hg.intevation.de/mercurial
     foo.username = foo
     foo.password = bar
     foo.schemes = http https
 
     bar.prefix = secure.example.org
     bar.key = path/to/file.key
     bar.cert = path/to/file.cert
     bar.schemes = https
 
 Supported arguments:
 
 ``prefix``
     Either ``*`` or a URI prefix with or without the scheme part.
     The authentication entry with the longest matching prefix is used
     (where ``*`` matches everything and counts as a match of length
     1). If the prefix doesn't include a scheme, the match is performed
     against the URI with its scheme stripped as well, and the schemes
     argument, q.v., is then subsequently consulted.
 
 ``username``
     Optional. Username to authenticate with. If not given, and the
     remote site requires basic or digest authentication, the user will
     be prompted for it. Environment variables are expanded in the
     username letting you do ``foo.username = $USER``. If the URI
     includes a username, only ``[auth]`` entries with a matching
     username or without a username will be considered.
 
 ``password``
     Optional. Password to authenticate with. If not given, and the
     remote site requires basic or digest authentication, the user
     will be prompted for it.
 
 ``key``
     Optional. PEM encoded client certificate key file. Environment
     variables are expanded in the filename.
 
 ``cert``
     Optional. PEM encoded client certificate chain file. Environment
     variables are expanded in the filename.
 
 ``schemes``
     Optional. Space separated list of URI schemes to use this
     authentication entry with. Only used if the prefix doesn't include
     a scheme. Supported schemes are http and https. They will match
     static-http and static-https respectively, as well.
     (default: https)
 
 If no suitable authentication entry is found, the user is prompted
 for credentials as usual if required by the remote.
 
 
 ``committemplate``
 ------------------
 
 ``changeset``
     String: configuration in this section is used as the template to
     customize the text shown in the editor when committing.
 
 In addition to pre-defined template keywords, commit log specific one
 below can be used for customization:
 
 ``extramsg``
     String: Extra message (typically 'Leave message empty to abort
     commit.'). This may be changed by some commands or extensions.
 
 For example, the template configuration below shows as same text as
 one shown by default::
 
     [committemplate]
     changeset = {desc}\n\n
         HG: Enter commit message.  Lines beginning with 'HG:' are removed.
         HG: {extramsg}
         HG: --
         HG: user: {author}\n{ifeq(p2rev, "-1", "",
        "HG: branch merge\n")
        }HG: branch '{branch}'\n{if(activebookmark,
        "HG: bookmark '{activebookmark}'\n")   }{subrepos %
        "HG: subrepo {subrepo}\n"              }{file_adds %
        "HG: added {file}\n"                   }{file_mods %
        "HG: changed {file}\n"                 }{file_dels %
        "HG: removed {file}\n"                 }{if(files, "",
        "HG: no files changed\n")}
 
 .. note::
 
    For some problematic encodings (see :hg:`help win32mbcs` for
    detail), this customization should be configured carefully, to
    avoid showing broken characters.
 
    For example, if a multibyte character ending with backslash (0x5c) is
    followed by the ASCII character 'n' in the customized template,
    the sequence of backslash and 'n' is treated as line-feed unexpectedly
    (and the multibyte character is broken, too).
 
 Customized template is used for commands below (``--edit`` may be
 required):
 
 - :hg:`backout`
 - :hg:`commit`
 - :hg:`fetch` (for merge commit only)
 - :hg:`graft`
 - :hg:`histedit`
 - :hg:`import`
 - :hg:`qfold`, :hg:`qnew` and :hg:`qrefresh`
 - :hg:`rebase`
 - :hg:`shelve`
 - :hg:`sign`
 - :hg:`tag`
 - :hg:`transplant`
 
 Configuring items below instead of ``changeset`` allows showing
 customized message only for specific actions, or showing different
 messages for each action.
 
 - ``changeset.backout`` for :hg:`backout`
 - ``changeset.commit.amend.merge`` for :hg:`commit --amend` on merges
 - ``changeset.commit.amend.normal`` for :hg:`commit --amend` on other
 - ``changeset.commit.normal.merge`` for :hg:`commit` on merges
 - ``changeset.commit.normal.normal`` for :hg:`commit` on other
 - ``changeset.fetch`` for :hg:`fetch` (impling merge commit)
 - ``changeset.gpg.sign`` for :hg:`sign`
 - ``changeset.graft`` for :hg:`graft`
 - ``changeset.histedit.edit`` for ``edit`` of :hg:`histedit`
 - ``changeset.histedit.fold`` for ``fold`` of :hg:`histedit`
 - ``changeset.histedit.mess`` for ``mess`` of :hg:`histedit`
 - ``changeset.histedit.pick`` for ``pick`` of :hg:`histedit`
 - ``changeset.import.bypass`` for :hg:`import --bypass`
 - ``changeset.import.normal.merge`` for :hg:`import` on merges
 - ``changeset.import.normal.normal`` for :hg:`import` on other
 - ``changeset.mq.qnew`` for :hg:`qnew`
 - ``changeset.mq.qfold`` for :hg:`qfold`
 - ``changeset.mq.qrefresh`` for :hg:`qrefresh`
 - ``changeset.rebase.collapse`` for :hg:`rebase --collapse`
 - ``changeset.rebase.merge`` for :hg:`rebase` on merges
 - ``changeset.rebase.normal`` for :hg:`rebase` on other
 - ``changeset.shelve.shelve`` for :hg:`shelve`
 - ``changeset.tag.add`` for :hg:`tag` without ``--remove``
 - ``changeset.tag.remove`` for :hg:`tag --remove`
 - ``changeset.transplant.merge`` for :hg:`transplant` on merges
 - ``changeset.transplant.normal`` for :hg:`transplant` on other
 
 These dot-separated lists of names are treated as hierarchical ones.
 For example, ``changeset.tag.remove`` customizes the commit message
 only for :hg:`tag --remove`, but ``changeset.tag`` customizes the
 commit message for :hg:`tag` regardless of ``--remove`` option.
 
 When the external editor is invoked for a commit, the corresponding
 dot-separated list of names without the ``changeset.`` prefix
 (e.g. ``commit.normal.normal``) is in the ``HGEDITFORM`` environment
 variable.
 
 In this section, items other than ``changeset`` can be referred from
 others. For example, the configuration to list committed files up
 below can be referred as ``{listupfiles}``::
 
     [committemplate]
     listupfiles = {file_adds %
        "HG: added {file}\n"     }{file_mods %
        "HG: changed {file}\n"   }{file_dels %
        "HG: removed {file}\n"   }{if(files, "",
        "HG: no files changed\n")}
 
 ``decode/encode``
 -----------------
 
 Filters for transforming files on checkout/checkin. This would
 typically be used for newline processing or other
 localization/canonicalization of files.
 
 Filters consist of a filter pattern followed by a filter command.
 Filter patterns are globs by default, rooted at the repository root.
 For example, to match any file ending in ``.txt`` in the root
 directory only, use the pattern ``*.txt``. To match any file ending
 in ``.c`` anywhere in the repository, use the pattern ``**.c``.
 For each file only the first matching filter applies.
 
 The filter command can start with a specifier, either ``pipe:`` or
 ``tempfile:``. If no specifier is given, ``pipe:`` is used by default.
 
 A ``pipe:`` command must accept data on stdin and return the transformed
 data on stdout.
 
 Pipe example::
 
   [encode]
   # uncompress gzip files on checkin to improve delta compression
   # note: not necessarily a good idea, just an example
   *.gz = pipe: gunzip
 
   [decode]
   # recompress gzip files when writing them to the working dir (we
   # can safely omit "pipe:", because it's the default)
   *.gz = gzip
 
 A ``tempfile:`` command is a template. The string ``INFILE`` is replaced
 with the name of a temporary file that contains the data to be
 filtered by the command. The string ``OUTFILE`` is replaced with the name
 of an empty temporary file, where the filtered data must be written by
 the command.
 
 .. container:: windows
 
    .. note::
 
      The tempfile mechanism is recommended for Windows systems,
      where the standard shell I/O redirection operators often have
      strange effects and may corrupt the contents of your files.
 
 This filter mechanism is used internally by the ``eol`` extension to
 translate line ending characters between Windows (CRLF) and Unix (LF)
 format. We suggest you use the ``eol`` extension for convenience.
 
 
 ``defaults``
 ------------
 
 (defaults are deprecated. Don't use them. Use aliases instead.)
 
 Use the ``[defaults]`` section to define command defaults, i.e. the
 default options/arguments to pass to the specified commands.
 
 The following example makes :hg:`log` run in verbose mode, and
 :hg:`status` show only the modified files, by default::
 
   [defaults]
   log = -v
   status = -m
 
 The actual commands, instead of their aliases, must be used when
 defining command defaults. The command defaults will also be applied
 to the aliases of the commands defined.
 
 
 ``diff``
 --------
 
 Settings used when displaying diffs. Everything except for ``unified``
 is a Boolean and defaults to False. See :hg:`help config.annotate`
 for related options for the annotate command.
 
 ``git``
     Use git extended diff format.
 
 ``nobinary``
     Omit git binary patches.
 
 ``nodates``
     Don't include dates in diff headers.
 
 ``noprefix``
     Omit 'a/' and 'b/' prefixes from filenames. Ignored in plain mode.
 
 ``showfunc``
     Show which function each change is in.
 
 ``ignorews``
     Ignore white space when comparing lines.
 
 ``ignorewsamount``
     Ignore changes in the amount of white space.
 
 ``ignoreblanklines``
     Ignore changes whose lines are all blank.
 
 ``unified``
     Number of lines of context to show.
 
 ``email``
 ---------
 
 Settings for extensions that send email messages.
 
 ``from``
     Optional. Email address to use in "From" header and SMTP envelope
     of outgoing messages.
 
 ``to``
     Optional. Comma-separated list of recipients' email addresses.
 
 ``cc``
     Optional. Comma-separated list of carbon copy recipients'
     email addresses.
 
 ``bcc``
     Optional. Comma-separated list of blind carbon copy recipients'
     email addresses.
 
 ``method``
     Optional. Method to use to send email messages. If value is ``smtp``
     (default), use SMTP (see the ``[smtp]`` section for configuration).
     Otherwise, use as name of program to run that acts like sendmail
     (takes ``-f`` option for sender, list of recipients on command line,
     message on stdin). Normally, setting this to ``sendmail`` or
     ``/usr/sbin/sendmail`` is enough to use sendmail to send messages.
 
 ``charsets``
     Optional. Comma-separated list of character sets considered
     convenient for recipients. Addresses, headers, and parts not
     containing patches of outgoing messages will be encoded in the
     first character set to which conversion from local encoding
     (``$HGENCODING``, ``ui.fallbackencoding``) succeeds. If correct
     conversion fails, the text in question is sent as is.
     (default: '')
 
     Order of outgoing email character sets:
 
     1. ``us-ascii``: always first, regardless of settings
     2. ``email.charsets``: in order given by user
     3. ``ui.fallbackencoding``: if not in email.charsets
     4. ``$HGENCODING``: if not in email.charsets
     5. ``utf-8``: always last, regardless of settings
 
 Email example::
 
   [email]
   from = Joseph User <[e-mail]>
   method = /usr/sbin/sendmail
   # charsets for western Europeans
   # us-ascii, utf-8 omitted, as they are tried first and last
   charsets = iso-8859-1, iso-8859-15, windows-1252
 
 
 ``extensions``
 --------------
 
 Mercurial has an extension mechanism for adding new features. To
 enable an extension, create an entry for it in this section.
 
 If you know that the extension is already in Python's search path,
 you can give the name of the module, followed by ``=``, with nothing
 after the ``=``.
 
 Otherwise, give a name that you choose, followed by ``=``, followed by
 the path to the ``.py`` file (including the file name extension) that
 defines the extension.
 
 To explicitly disable an extension that is enabled in an hgrc of
 broader scope, prepend its path with ``!``, as in ``foo = !/ext/path``
 or ``foo = !`` when path is not supplied.
 
 Example for ``~/.hgrc``::
 
   [extensions]
   # (the color extension will get loaded from Mercurial's path)
   color =
   # (this extension will get loaded from the file specified)
   myfeature = ~/.hgext/myfeature.py
 
 
 ``format``
 ----------
 
 ``usegeneraldelta``
     Enable or disable the "generaldelta" repository format which improves
     repository compression by allowing "revlog" to store delta against arbitrary
     revision instead of the previous stored one. This provides significant
     improvement for repositories with branches.
 
     Repositories with this on-disk format require Mercurial version 1.9.
 
     Enabled by default.
 
 ``dotencode``
     Enable or disable the "dotencode" repository format which enhances
     the "fncache" repository format (which has to be enabled to use
     dotencode) to avoid issues with filenames starting with ._ on
     Mac OS X and spaces on Windows.
 
     Repositories with this on-disk format require Mercurial version 1.7.
 
     Enabled by default.
 
 ``usefncache``
     Enable or disable the "fncache" repository format which enhances
     the "store" repository format (which has to be enabled to use
     fncache) to allow longer filenames and avoids using Windows
     reserved names, e.g. "nul".
 
     Repositories with this on-disk format require Mercurial version 1.1.
 
     Enabled by default.
 
 ``usestore``
     Enable or disable the "store" repository format which improves
     compatibility with systems that fold case or otherwise mangle
     filenames. Disabling this option will allow you to store longer filenames
     in some situations at the expense of compatibility.
 
     Repositories with this on-disk format require Mercurial version 0.9.4.
 
     Enabled by default.
 
 ``graph``
 ---------
 
 Web graph view configuration. This section let you change graph
 elements display properties by branches, for instance to make the
 ``default`` branch stand out.
 
 Each line has the following format::
 
     <branch>.<argument> = <value>
 
 where ``<branch>`` is the name of the branch being
 customized. Example::
 
     [graph]
     # 2px width
     default.width = 2
     # red color
     default.color = FF0000
 
 Supported arguments:
 
 ``width``
     Set branch edges width in pixels.
 
 ``color``
     Set branch edges color in hexadecimal RGB notation.
 
 ``hooks``
 ---------
 
 Commands or Python functions that get automatically executed by
 various actions such as starting or finishing a commit. Multiple
 hooks can be run for the same action by appending a suffix to the
 action. Overriding a site-wide hook can be done by changing its
 value or setting it to an empty string.  Hooks can be prioritized
 by adding a prefix of ``priority.`` to the hook name on a new line
 and setting the priority. The default priority is 0.
 
 Example ``.hg/hgrc``::
 
   [hooks]
   # update working directory after adding changesets
   changegroup.update = hg update
   # do not use the site-wide hook
   incoming =
   incoming.email = /my/email/hook
   incoming.autobuild = /my/build/hook
   # force autobuild hook to run before other incoming hooks
   priority.incoming.autobuild = 1
 
 Most hooks are run with environment variables set that give useful
 additional information. For each hook below, the environment
 variables it is passed are listed with names of the form ``$HG_foo``.
 
 ``changegroup``
   Run after a changegroup has been added via push, pull or unbundle.  ID of the
   first new changeset is in ``$HG_NODE`` and last in ``$HG_NODE_LAST``. URL
   from which changes came is in ``$HG_URL``.
 
 ``commit``
   Run after a changeset has been created in the local repository. ID
   of the newly created changeset is in ``$HG_NODE``. Parent changeset
   IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
 
 ``incoming``
   Run after a changeset has been pulled, pushed, or unbundled into
   the local repository. The ID of the newly arrived changeset is in
   ``$HG_NODE``. URL that was source of changes came is in ``$HG_URL``.
 
 ``outgoing``
   Run after sending changes from local repository to another. ID of
   first changeset sent is in ``$HG_NODE``. Source of operation is in
   ``$HG_SOURCE``; Also see :hg:`help config.hooks.preoutgoing` hook.
 
 ``post-<command>``
   Run after successful invocations of the associated command. The
   contents of the command line are passed as ``$HG_ARGS`` and the result
   code in ``$HG_RESULT``. Parsed command line arguments are passed as
   ``$HG_PATS`` and ``$HG_OPTS``. These contain string representations of
   the python data internally passed to <command>. ``$HG_OPTS`` is a
   dictionary of options (with unspecified options set to their defaults).
   ``$HG_PATS`` is a list of arguments. Hook failure is ignored.
 
 ``fail-<command>``
   Run after a failed invocation of an associated command. The contents
   of the command line are passed as ``$HG_ARGS``. Parsed command line
   arguments are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain
   string representations of the python data internally passed to
   <command>. ``$HG_OPTS`` is a dictionary of options (with unspecified
   options set to their defaults). ``$HG_PATS`` is a list of arguments.
   Hook failure is ignored.
 
 ``pre-<command>``
   Run before executing the associated command. The contents of the
   command line are passed as ``$HG_ARGS``. Parsed command line arguments
   are passed as ``$HG_PATS`` and ``$HG_OPTS``. These contain string
   representations of the data internally passed to <command>. ``$HG_OPTS``
   is a dictionary of options (with unspecified options set to their
   defaults). ``$HG_PATS`` is a list of arguments. If the hook returns
   failure, the command doesn't execute and Mercurial returns the failure
   code.
 
 ``prechangegroup``
   Run before a changegroup is added via push, pull or unbundle. Exit
   status 0 allows the changegroup to proceed. Non-zero status will
   cause the push, pull or unbundle to fail. URL from which changes
   will come is in ``$HG_URL``.
 
 ``precommit``
   Run before starting a local commit. Exit status 0 allows the
   commit to proceed. Non-zero status will cause the commit to fail.
   Parent changeset IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
 
 ``prelistkeys``
   Run before listing pushkeys (like bookmarks) in the
   repository. Non-zero status will cause failure. The key namespace is
   in ``$HG_NAMESPACE``.
 
 ``preoutgoing``
   Run before collecting changes to send from the local repository to
   another. Non-zero status will cause failure. This lets you prevent
   pull over HTTP or SSH. Also prevents against local pull, push
   (outbound) or bundle commands, but not effective, since you can
   just copy files instead then. Source of operation is in
   ``$HG_SOURCE``. If "serve", operation is happening on behalf of remote
   SSH or HTTP repository. If "push", "pull" or "bundle", operation
   is happening on behalf of repository on same system.
 
 ``prepushkey``
   Run before a pushkey (like a bookmark) is added to the
   repository. Non-zero status will cause the key to be rejected. The
   key namespace is in ``$HG_NAMESPACE``, the key is in ``$HG_KEY``,
   the old value (if any) is in ``$HG_OLD``, and the new value is in
   ``$HG_NEW``.
 
 ``pretag``
   Run before creating a tag. Exit status 0 allows the tag to be
   created. Non-zero status will cause the tag to fail. ID of
   changeset to tag is in ``$HG_NODE``. Name of tag is in ``$HG_TAG``. Tag is
   local if ``$HG_LOCAL=1``, in repository if ``$HG_LOCAL=0``.
 
 ``pretxnopen``
   Run before any new repository transaction is open. The reason for the
   transaction will be in ``$HG_TXNNAME`` and a unique identifier for the
   transaction will be in ``HG_TXNID``. A non-zero status will prevent the
   transaction from being opened.
 
 ``pretxnclose``
   Run right before the transaction is actually finalized. Any repository change
   will be visible to the hook program. This lets you validate the transaction
   content or change it. Exit status 0 allows the commit to proceed. Non-zero
   status will cause the transaction to be rolled back. The reason for the
   transaction opening will be in ``$HG_TXNNAME`` and a unique identifier for
   the transaction will be in ``HG_TXNID``. The rest of the available data will
   vary according the transaction type. New changesets will add ``$HG_NODE`` (id
   of the first added changeset), ``$HG_NODE_LAST`` (id of the last added
   changeset), ``$HG_URL`` and ``$HG_SOURCE`` variables, bookmarks and phases
   changes will set ``HG_BOOKMARK_MOVED`` and ``HG_PHASES_MOVED`` to ``1``, etc.
 
 ``txnclose``
   Run after any repository transaction has been committed. At this
   point, the transaction can no longer be rolled back. The hook will run
   after the lock is released. See :hg:`help config.hooks.pretxnclose` docs for
   details about available variables.
 
 ``txnabort``
   Run when a transaction is aborted. See :hg:`help config.hooks.pretxnclose`
   docs for details about available variables.
 
 ``pretxnchangegroup``
   Run after a changegroup has been added via push, pull or unbundle, but before
   the transaction has been committed. Changegroup is visible to hook program.
   This lets you validate incoming changes before accepting them. Passed the ID
   of the first new changeset in ``$HG_NODE`` and last in ``$HG_NODE_LAST``.
   Exit status 0 allows the transaction to commit. Non-zero status will cause
   the transaction to be rolled back and the push, pull or unbundle will fail.
   URL that was source of changes is in ``$HG_URL``.
 
 ``pretxncommit``
   Run after a changeset has been created but the transaction not yet
   committed. Changeset is visible to hook program. This lets you
   validate commit message and changes. Exit status 0 allows the
   commit to proceed. Non-zero status will cause the transaction to
   be rolled back. ID of changeset is in ``$HG_NODE``. Parent changeset
   IDs are in ``$HG_PARENT1`` and ``$HG_PARENT2``.
 
 ``preupdate``
   Run before updating the working directory. Exit status 0 allows
   the update to proceed. Non-zero status will prevent the update.
   Changeset ID of first new parent is in ``$HG_PARENT1``. If merge, ID
   of second new parent is in ``$HG_PARENT2``.
 
 ``listkeys``
   Run after listing pushkeys (like bookmarks) in the repository. The
   key namespace is in ``$HG_NAMESPACE``. ``$HG_VALUES`` is a
   dictionary containing the keys and values.
 
 ``pushkey``
   Run after a pushkey (like a bookmark) is added to the
   repository. The key namespace is in ``$HG_NAMESPACE``, the key is in
   ``$HG_KEY``, the old value (if any) is in ``$HG_OLD``, and the new
   value is in ``$HG_NEW``.
 
 ``tag``
   Run after a tag is created. ID of tagged changeset is in ``$HG_NODE``.
   Name of tag is in ``$HG_TAG``. Tag is local if ``$HG_LOCAL=1``, in
   repository if ``$HG_LOCAL=0``.
 
 ``update``
   Run after updating the working directory. Changeset ID of first
   new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is
   in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
   update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
 
 .. note::
 
    It is generally better to use standard hooks rather than the
    generic pre- and post- command hooks as they are guaranteed to be
    called in the appropriate contexts for influencing transactions.
    Also, hooks like "commit" will be called in all contexts that
    generate a commit (e.g. tag) and not just the commit command.
 
 .. note::
 
    Environment variables with empty values may not be passed to
    hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
    will have an empty value under Unix-like platforms for non-merge
    changesets, while it will not be available at all under Windows.
 
 The syntax for Python hooks is as follows::
 
   hookname = python:modulename.submodule.callable
   hookname = python:/path/to/python/module.py:callable
 
 Python hooks are run within the Mercurial process. Each hook is
 called with at least three keyword arguments: a ui object (keyword
 ``ui``), a repository object (keyword ``repo``), and a ``hooktype``
 keyword that tells what kind of hook is used. Arguments listed as
 environment variables above are passed as keyword arguments, with no
 ``HG_`` prefix, and names in lower case.
 
 If a Python hook returns a "true" value or raises an exception, this
 is treated as a failure.
 
 
 ``hostfingerprints``
 --------------------
 
 (Deprecated. Use ``[hostsecurity]``'s ``fingerprints`` options instead.)
 
 Fingerprints of the certificates of known HTTPS servers.
 
 A HTTPS connection to a server with a fingerprint configured here will
 only succeed if the servers certificate matches the fingerprint.
 This is very similar to how ssh known hosts works.
 
 The fingerprint is the SHA-1 hash value of the DER encoded certificate.
 Multiple values can be specified (separated by spaces or commas). This can
 be used to define both old and new fingerprints while a host transitions
 to a new certificate.
 
 The CA chain and web.cacerts is not used for servers with a fingerprint.
 
 For example::
 
     [hostfingerprints]
     hg.intevation.de = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
     hg.intevation.org = fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
 
 ``hostsecurity``
 ----------------
 
 Used to specify global and per-host security settings for connecting to
 other machines.
 
 The following options control default behavior for all hosts.
 
 ``ciphers``
     Defines the cryptographic ciphers to use for connections.
 
     Value must be a valid OpenSSL Cipher List Format as documented at
     https://www.openssl.org/docs/manmaster/apps/ciphers.html#CIPHER-LIST-FORMAT.
 
     This setting is for advanced users only. Setting to incorrect values
     can significantly lower connection security or decrease performance.
     You have been warned.
 
     This option requires Python 2.7.
 
 ``minimumprotocol``
     Defines the minimum channel encryption protocol to use.
 
     By default, the highest version of TLS supported by both client and server
     is used.
 
     Allowed values are: ``tls1.0``, ``tls1.1``, ``tls1.2``.
 
     When running on an old Python version, only ``tls1.0`` is allowed since
     old versions of Python only support up to TLS 1.0.
 
     When running a Python that supports modern TLS versions, the default is
     ``tls1.1``. ``tls1.0`` can still be used to allow TLS 1.0. However, this
     weakens security and should only be used as a feature of last resort if
     a server does not support TLS 1.1+.
 
 Options in the ``[hostsecurity]`` section can have the form
 ``hostname``:``setting``. This allows multiple settings to be defined on a
 per-host basis.
 
 The following per-host settings can be defined.
 
 ``ciphers``
     This behaves like ``ciphers`` as described above except it only applies
     to the host on which it is defined.
 
 ``fingerprints``
     A list of hashes of the DER encoded peer/remote certificate. Values have
     the form ``algorithm``:``fingerprint``. e.g.
     ``sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2``.
 
     The following algorithms/prefixes are supported: ``sha1``, ``sha256``,
     ``sha512``.
 
     Use of ``sha256`` or ``sha512`` is preferred.
 
     If a fingerprint is specified, the CA chain is not validated for this
     host and Mercurial will require the remote certificate to match one
     of the fingerprints specified. This means if the server updates its
     certificate, Mercurial will abort until a new fingerprint is defined.
     This can provide stronger security than traditional CA-based validation
     at the expense of convenience.
 
     This option takes precedence over ``verifycertsfile``.
 
 ``minimumprotocol``
     This behaves like ``minimumprotocol`` as described above except it
     only applies to the host on which it is defined.
 
 ``verifycertsfile``
     Path to file a containing a list of PEM encoded certificates used to
     verify the server certificate. Environment variables and ``~user``
     constructs are expanded in the filename.
 
     The server certificate or the certificate's certificate authority (CA)
     must match a certificate from this file or certificate verification
     will fail and connections to the server will be refused.
 
     If defined, only certificates provided by this file will be used:
     ``web.cacerts`` and any system/default certificates will not be
     used.
 
     This option has no effect if the per-host ``fingerprints`` option
     is set.
 
     The format of the file is as follows::
 
         -----BEGIN CERTIFICATE-----
         ... (certificate in base64 PEM encoding) ...
         -----END CERTIFICATE-----
         -----BEGIN CERTIFICATE-----
         ... (certificate in base64 PEM encoding) ...
         -----END CERTIFICATE-----
 
 For example::
 
     [hostsecurity]
     hg.example.com:fingerprints = sha256:c3ab8ff13720e8ad9047dd39466b3c8974e592c2fa383d4a3960714caef0c4f2
     hg2.example.com:fingerprints = sha1:914f1aff87249c09b6859b88b1906d30756491ca, sha1:fc:e2:8d:d9:51:cd:cb:c1:4d:18:6b:b7:44:8d:49:72:57:e6:cd:33
     foo.example.com:verifycertsfile = /etc/ssl/trusted-ca-certs.pem
 
 To change the default minimum protocol version to TLS 1.2 but to allow TLS 1.1
 when connecting to ``hg.example.com``::
 
     [hostsecurity]
     minimumprotocol = tls1.2
     hg.example.com:minimumprotocol = tls1.1
 
 ``http_proxy``
 --------------
 
 Used to access web-based Mercurial repositories through a HTTP
 proxy.
 
 ``host``
     Host name and (optional) port of the proxy server, for example
     "myproxy:8000".
 
 ``no``
     Optional. Comma-separated list of host names that should bypass
     the proxy.
 
 ``passwd``
     Optional. Password to authenticate with at the proxy server.
 
 ``user``
     Optional. User name to authenticate with at the proxy server.
 
 ``always``
     Optional. Always use the proxy, even for localhost and any entries
     in ``http_proxy.no``. (default: False)
 
 ``merge``
 ---------
 
 This section specifies behavior during merges and updates.
 
 ``checkignored``
    Controls behavior when an ignored file on disk has the same name as a tracked
    file in the changeset being merged or updated to, and has different
    contents. Options are ``abort``, ``warn`` and ``ignore``. With ``abort``,
    abort on such files. With ``warn``, warn on such files and back them up as
    ``.orig``. With ``ignore``, don't print a warning and back them up as
    ``.orig``. (default: ``abort``)
 
 ``checkunknown``
    Controls behavior when an unknown file that isn't ignored has the same name
    as a tracked file in the changeset being merged or updated to, and has
    different contents. Similar to ``merge.checkignored``, except for files that
    are not ignored. (default: ``abort``)
 
 ``merge-patterns``
 ------------------
 
 This section specifies merge tools to associate with particular file
 patterns. Tools matched here will take precedence over the default
 merge tool. Patterns are globs by default, rooted at the repository
 root.
 
 Example::
 
   [merge-patterns]
   **.c = kdiff3
   **.jpg = myimgmerge
 
 ``merge-tools``
 ---------------
 
 This section configures external merge tools to use for file-level
 merges. This section has likely been preconfigured at install time.
 Use :hg:`config merge-tools` to check the existing configuration.
 Also see :hg:`help merge-tools` for more details.
 
 Example ``~/.hgrc``::
 
   [merge-tools]
   # Override stock tool location
   kdiff3.executable = ~/bin/kdiff3
   # Specify command line
   kdiff3.args = $base $local $other -o $output
   # Give higher priority
   kdiff3.priority = 1
 
   # Changing the priority of preconfigured tool
   meld.priority = 0
 
   # Disable a preconfigured tool
   vimdiff.disabled = yes
 
   # Define new tool
   myHtmlTool.args = -m $local $other $base $output
   myHtmlTool.regkey = Software\FooSoftware\HtmlMerge
   myHtmlTool.priority = 1
 
 Supported arguments:
 
 ``priority``
   The priority in which to evaluate this tool.
   (default: 0)
 
 ``executable``
   Either just the name of the executable or its pathname.
 
   .. container:: windows
 
     On Windows, the path can use environment variables with ${ProgramFiles}
     syntax.
 
   (default: the tool name)
 
 ``args``
   The arguments to pass to the tool executable. You can refer to the
   files being merged as well as the output file through these
   variables: ``$base``, ``$local``, ``$other``, ``$output``. The meaning
   of ``$local`` and ``$other`` can vary depending on which action is being
   performed. During and update or merge, ``$local`` represents the original
   state of the file, while ``$other`` represents the commit you are updating
   to or the commit you are merging with. During a rebase ``$local``
   represents the destination of the rebase, and ``$other`` represents the
   commit being rebased.
   (default: ``$local $base $other``)
 
 ``premerge``
   Attempt to run internal non-interactive 3-way merge tool before
   launching external tool.  Options are ``true``, ``false``, ``keep`` or
   ``keep-merge3``. The ``keep`` option will leave markers in the file if the
   premerge fails. The ``keep-merge3`` will do the same but include information
   about the base of the merge in the marker (see internal :merge3 in
   :hg:`help merge-tools`).
   (default: True)
 
 ``binary``
   This tool can merge binary files. (default: False, unless tool
   was selected by file pattern match)
 
 ``symlink``
   This tool can merge symlinks. (default: False)
 
 ``check``
   A list of merge success-checking options:
 
   ``changed``
     Ask whether merge was successful when the merged file shows no changes.
   ``conflicts``
     Check whether there are conflicts even though the tool reported success.
   ``prompt``
     Always prompt for merge success, regardless of success reported by tool.
 
 ``fixeol``
   Attempt to fix up EOL changes caused by the merge tool.
   (default: False)
 
 ``gui``
   This tool requires a graphical interface to run. (default: False)
 
 .. container:: windows
 
   ``regkey``
     Windows registry key which describes install location of this
     tool. Mercurial will search for this key first under
     ``HKEY_CURRENT_USER`` and then under ``HKEY_LOCAL_MACHINE``.
     (default: None)
 
   ``regkeyalt``
     An alternate Windows registry key to try if the first key is not
     found.  The alternate key uses the same ``regname`` and ``regappend``
     semantics of the primary key.  The most common use for this key
     is to search for 32bit applications on 64bit operating systems.
     (default: None)
 
   ``regname``
     Name of value to read from specified registry key.
     (default: the unnamed (default) value)
 
   ``regappend``
     String to append to the value read from the registry, typically
     the executable name of the tool.
     (default: None)
 
 
 ``patch``
 ---------
 
 Settings used when applying patches, for instance through the 'import'
 command or with Mercurial Queues extension.
 
 ``eol``
     When set to 'strict' patch content and patched files end of lines
     are preserved. When set to ``lf`` or ``crlf``, both files end of
     lines are ignored when patching and the result line endings are
     normalized to either LF (Unix) or CRLF (Windows). When set to
     ``auto``, end of lines are again ignored while patching but line
     endings in patched files are normalized to their original setting
     on a per-file basis. If target file does not exist or has no end
     of line, patch line endings are preserved.
     (default: strict)
 
 ``fuzz``
     The number of lines of 'fuzz' to allow when applying patches. This
     controls how much context the patcher is allowed to ignore when
     trying to apply a patch.
     (default: 2)
 
 ``paths``
 ---------
 
 Assigns symbolic names and behavior to repositories.
 
 Options are symbolic names defining the URL or directory that is the
 location of the repository. Example::
 
     [paths]
     my_server = https://example.com/my_repo
     local_path = /home/me/repo
 
 These symbolic names can be used from the command line. To pull
 from ``my_server``: :hg:`pull my_server`. To push to ``local_path``:
 :hg:`push local_path`.
 
 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.
 
 ``phases``
 ----------
 
 Specifies default handling of phases. See :hg:`help phases` for more
 information about working with phases.
 
 ``publish``
     Controls draft phase behavior when working as a server. When true,
     pushed changesets are set to public in both client and server and
     pulled or cloned changesets are set to public in the client.
     (default: True)
 
 ``new-commit``
     Phase of newly-created commits.
     (default: draft)
 
 ``checksubrepos``
     Check the phase of the current revision of each subrepository. Allowed
     values are "ignore", "follow" and "abort". For settings other than
     "ignore", the phase of the current revision of each subrepository is
     checked before committing the parent repository. If any of those phases is
     greater than the phase of the parent repository (e.g. if a subrepo is in a
     "secret" phase while the parent repo is in "draft" phase), the commit is
     either aborted (if checksubrepos is set to "abort") or the higher phase is
     used for the parent repository commit (if set to "follow").
     (default: follow)
 
 
 ``profiling``
 -------------
 
 Specifies profiling type, format, and file output. Two profilers are
 supported: an instrumenting profiler (named ``ls``), and a sampling
 profiler (named ``stat``).
 
 In this section description, 'profiling data' stands for the raw data
 collected during profiling, while 'profiling report' stands for a
 statistical text report generated from the profiling data. The
 profiling is done using lsprof.
 
+``enabled``
+    Enable the profiler.
+    (default: false)
+
+    This is equivalent to passing ``--profile`` on the command line.
+
 ``type``
     The type of profiler to use.
     (default: ls)
 
     ``ls``
       Use Python's built-in instrumenting profiler. This profiler
       works on all platforms, but each line number it reports is the
       first line of a function. This restriction makes it difficult to
       identify the expensive parts of a non-trivial function.
     ``stat``
       Use a third-party statistical profiler, statprof. This profiler
       currently runs only on Unix systems, and is most useful for
       profiling commands that run for longer than about 0.1 seconds.
 
 ``format``
     Profiling format.  Specific to the ``ls`` instrumenting profiler.
     (default: text)
 
     ``text``
       Generate a profiling report. When saving to a file, it should be
       noted that only the report is saved, and the profiling data is
       not kept.
     ``kcachegrind``
       Format profiling data for kcachegrind use: when saving to a
       file, the generated file can directly be loaded into
       kcachegrind.
 
 ``frequency``
     Sampling frequency.  Specific to the ``stat`` sampling profiler.
     (default: 1000)
 
 ``output``
     File path where profiling data or report should be saved. If the
     file exists, it is replaced. (default: None, data is printed on
     stderr)
 
 ``sort``
     Sort field.  Specific to the ``ls`` instrumenting profiler.
     One of ``callcount``, ``reccallcount``, ``totaltime`` and
     ``inlinetime``.
     (default: inlinetime)
 
 ``limit``
     Number of lines to show. Specific to the ``ls`` instrumenting profiler.
     (default: 30)
 
 ``nested``
     Show at most this number of lines of drill-down info after each main entry.
     This can help explain the difference between Total and Inline.
     Specific to the ``ls`` instrumenting profiler.
     (default: 5)
 
 ``progress``
 ------------
 
 Mercurial commands can draw progress bars that are as informative as
 possible. Some progress bars only offer indeterminate information, while others
 have a definite end point.
 
 ``delay``
     Number of seconds (float) before showing the progress bar. (default: 3)
 
 ``changedelay``
     Minimum delay before showing a new topic. When set to less than 3 * refresh,
     that value will be used instead. (default: 1)
 
 ``refresh``
     Time in seconds between refreshes of the progress bar. (default: 0.1)
 
 ``format``
     Format of the progress bar.
 
     Valid entries for the format field are ``topic``, ``bar``, ``number``,
     ``unit``, ``estimate``, ``speed``, and ``item``. ``item`` defaults to the
     last 20 characters of the item, but this can be changed by adding either
     ``-<num>`` which would take the last num characters, or ``+<num>`` for the
     first num characters.
 
     (default: topic bar number estimate)
 
 ``width``
     If set, the maximum width of the progress information (that is, min(width,
     term width) will be used).
 
 ``clear-complete``
     Clear the progress bar after it's done. (default: True)
 
 ``disable``
     If true, don't show a progress bar.
 
 ``assume-tty``
     If true, ALWAYS show a progress bar, unless disable is given.
 
 ``rebase``
 ----------
 
 ``allowdivergence``
     Default to False, when True allow creating divergence when performing
     rebase of obsolete changesets.
 
 ``revsetalias``
 ---------------
 
 Alias definitions for revsets. See :hg:`help revsets` for details.
 
 ``server``
 ----------
 
 Controls generic server settings.
 
 ``uncompressed``
     Whether to allow clients to clone a repository using the
     uncompressed streaming protocol. This transfers about 40% more
     data than a regular clone, but uses less memory and CPU on both
     server and client. Over a LAN (100 Mbps or better) or a very fast
     WAN, an uncompressed streaming clone is a lot faster (~10x) than a
     regular clone. Over most WAN connections (anything slower than
     about 6 Mbps), uncompressed streaming is slower, because of the
     extra data transfer overhead. This mode will also temporarily hold
     the write lock while determining what data to transfer.
     (default: True)
 
 ``preferuncompressed``
     When set, clients will try to use the uncompressed streaming
     protocol. (default: False)
 
 ``validate``
     Whether to validate the completeness of pushed changesets by
     checking that all new file revisions specified in manifests are
     present. (default: False)
 
 ``maxhttpheaderlen``
     Instruct HTTP clients not to send request headers longer than this
     many bytes. (default: 1024)
 
 ``bundle1``
     Whether to allow clients to push and pull using the legacy bundle1
     exchange format. (default: True)
 
 ``bundle1gd``
     Like ``bundle1`` but only used if the repository is using the
     *generaldelta* storage format. (default: True)
 
 ``bundle1.push``
     Whether to allow clients to push using the legacy bundle1 exchange
     format. (default: True)
 
 ``bundle1gd.push``
     Like ``bundle1.push`` but only used if the repository is using the
     *generaldelta* storage format. (default: True)
 
 ``bundle1.pull``
     Whether to allow clients to pull using the legacy bundle1 exchange
     format. (default: True)
 
 ``bundle1gd.pull``
     Like ``bundle1.pull`` but only used if the repository is using the
     *generaldelta* storage format. (default: True)
 
     Large repositories using the *generaldelta* storage format should
     consider setting this option because converting *generaldelta*
     repositories to the exchange format required by the bundle1 data
     format can consume a lot of CPU.
 
 ``zliblevel``
     Integer between ``-1`` and ``9`` that controls the zlib compression level
     for wire protocol commands that send zlib compressed output (notably the
     commands that send repository history data).
 
     The default (``-1``) uses the default zlib compression level, which is
     likely equivalent to ``6``. ``0`` means no compression. ``9`` means
     maximum compression.
 
     Setting this option allows server operators to make trade-offs between
     bandwidth and CPU used. Lowering the compression lowers CPU utilization
     but sends more bytes to clients.
 
     This option only impacts the HTTP server.
 
 ``smtp``
 --------
 
 Configuration for extensions that need to send email messages.
 
 ``host``
     Host name of mail server, e.g. "mail.example.com".
 
 ``port``
     Optional. Port to connect to on mail server. (default: 465 if
     ``tls`` is smtps; 25 otherwise)
 
 ``tls``
     Optional. Method to enable TLS when connecting to mail server: starttls,
     smtps or none. (default: none)
 
 ``username``
     Optional. User name for authenticating with the SMTP server.
     (default: None)
 
 ``password``
     Optional. Password for authenticating with the SMTP server. If not
     specified, interactive sessions will prompt the user for a
     password; non-interactive sessions will fail. (default: None)
 
 ``local_hostname``
     Optional. The hostname that the sender can use to identify
     itself to the MTA.
 
 
 ``subpaths``
 ------------
 
 Subrepository source URLs can go stale if a remote server changes name
 or becomes temporarily unavailable. This section lets you define
 rewrite rules of the form::
 
     <pattern> = <replacement>
 
 where ``pattern`` is a regular expression matching a subrepository
 source URL and ``replacement`` is the replacement string used to
 rewrite it. Groups can be matched in ``pattern`` and referenced in
 ``replacements``. For instance::
 
     http://server/(.*)-hg/ = http://hg.server/\1/
 
 rewrites ``http://server/foo-hg/`` into ``http://hg.server/foo/``.
 
 Relative subrepository paths are first made absolute, and the
 rewrite rules are then applied on the full (absolute) path. If ``pattern``
 doesn't match the full path, an attempt is made to apply it on the
 relative path alone. The rules are applied in definition order.
 
 ``templatealias``
 -----------------
 
 Alias definitions for templates. See :hg:`help templates` for details.
 
 ``templates``
 -------------
 
 Use the ``[templates]`` section to define template strings.
 See :hg:`help templates` for details.
 
 ``trusted``
 -----------
 
 Mercurial will not use the settings in the
 ``.hg/hgrc`` file from a repository if it doesn't belong to a trusted
 user or to a trusted group, as various hgrc features allow arbitrary
 commands to be run. This issue is often encountered when configuring
 hooks or extensions for shared repositories or servers. However,
 the web interface will use some safe settings from the ``[web]``
 section.
 
 This section specifies what users and groups are trusted. The
 current user is always trusted. To trust everybody, list a user or a
 group with name ``*``. These settings must be placed in an
 *already-trusted file* to take effect, such as ``$HOME/.hgrc`` of the
 user or service running Mercurial.
 
 ``users``
   Comma-separated list of trusted users.
 
 ``groups``
   Comma-separated list of trusted groups.
 
 
 ``ui``
 ------
 
 User interface controls.
 
 ``archivemeta``
     Whether to include the .hg_archival.txt file containing meta data
     (hashes for the repository base and for tip) in archives created
     by the :hg:`archive` command or downloaded via hgweb.
     (default: True)
 
 ``askusername``
     Whether to prompt for a username when committing. If True, and
     neither ``$HGUSER`` nor ``$EMAIL`` has been specified, then the user will
     be prompted to enter a username. If no username is entered, the
     default ``USER@HOST`` is used instead.
     (default: False)
 
 ``clonebundles``
     Whether the "clone bundles" feature is enabled.
 
     When enabled, :hg:`clone` may download and apply a server-advertised
     bundle file from a URL instead of using the normal exchange mechanism.
 
     This can likely result in faster and more reliable clones.
 
     (default: True)
 
 ``clonebundlefallback``
     Whether failure to apply an advertised "clone bundle" from a server
     should result in fallback to a regular clone.
 
     This is disabled by default because servers advertising "clone
     bundles" often do so to reduce server load. If advertised bundles
     start mass failing and clients automatically fall back to a regular
     clone, this would add significant and unexpected load to the server
     since the server is expecting clone operations to be offloaded to
     pre-generated bundles. Failing fast (the default behavior) ensures
     clients don't overwhelm the server when "clone bundle" application
     fails.
 
     (default: False)
 
 ``clonebundleprefers``
     Defines preferences for which "clone bundles" to use.
 
     Servers advertising "clone bundles" may advertise multiple available
     bundles. Each bundle may have different attributes, such as the bundle
     type and compression format. This option is used to prefer a particular
     bundle over another.
 
     The following keys are defined by Mercurial:
 
     BUNDLESPEC
        A bundle type specifier. These are strings passed to :hg:`bundle -t`.
        e.g. ``gzip-v2`` or ``bzip2-v1``.
 
     COMPRESSION
        The compression format of the bundle. e.g. ``gzip`` and ``bzip2``.
 
     Server operators may define custom keys.
 
     Example values: ``COMPRESSION=bzip2``,
     ``BUNDLESPEC=gzip-v2, COMPRESSION=gzip``.
 
     By default, the first bundle advertised by the server is used.
 
 ``commitsubrepos``
     Whether to commit modified subrepositories when committing the
     parent repository. If False and one subrepository has uncommitted
     changes, abort the commit.
     (default: False)
 
 ``debug``
     Print debugging information. (default: False)
 
 ``editor``
     The editor to use during a commit. (default: ``$EDITOR`` or ``vi``)
 
 ``fallbackencoding``
     Encoding to try if it's not possible to decode the changelog using
     UTF-8. (default: ISO-8859-1)
 
 ``graphnodetemplate``
     The template used to print changeset nodes in an ASCII revision graph.
     (default: ``{graphnode}``)
 
 ``ignore``
     A file to read per-user ignore patterns from. This file should be
     in the same format as a repository-wide .hgignore file. Filenames
     are relative to the repository root. This option supports hook syntax,
     so if you want to specify multiple ignore files, you can do so by
     setting something like ``ignore.other = ~/.hgignore2``. For details
     of the ignore file format, see the ``hgignore(5)`` man page.
 
 ``interactive``
     Allow to prompt the user. (default: True)
 
 ``interface``
     Select the default interface for interactive features (default: text).
     Possible values are 'text' and 'curses'.
 
 ``interface.chunkselector``
     Select the interface for change recording (e.g. :hg:`commit -i`).
     Possible values are 'text' and 'curses'.
     This config overrides the interface specified by ui.interface.
 
 ``logtemplate``
     Template string for commands that print changesets.
 
 ``merge``
     The conflict resolution program to use during a manual merge.
     For more information on merge tools see :hg:`help merge-tools`.
     For configuring merge tools see the ``[merge-tools]`` section.
 
 ``mergemarkers``
     Sets the merge conflict marker label styling. The ``detailed``
     style uses the ``mergemarkertemplate`` setting to style the labels.
     The ``basic`` style just uses 'local' and 'other' as the marker label.
     One of ``basic`` or ``detailed``.
     (default: ``basic``)
 
 ``mergemarkertemplate``
     The template used to print the commit description next to each conflict
     marker during merge conflicts. See :hg:`help templates` for the template
     format.
 
     Defaults to showing the hash, tags, branches, bookmarks, author, and
     the first line of the commit description.
 
     If you use non-ASCII characters in names for tags, branches, bookmarks,
     authors, and/or commit descriptions, you must pay attention to encodings of
     managed files. At template expansion, non-ASCII characters use the encoding
     specified by the ``--encoding`` global option, ``HGENCODING`` or other
     environment variables that govern your locale. If the encoding of the merge
     markers is different from the encoding of the merged files,
     serious problems may occur.
 
 ``origbackuppath``
     The path to a directory used to store generated .orig files. If the path is
     not a directory, one will be created.
 
 ``patch``
     An optional external tool that ``hg import`` and some extensions
     will use for applying patches. By default Mercurial uses an
     internal patch utility. The external tool must work as the common
     Unix ``patch`` program. In particular, it must accept a ``-p``
     argument to strip patch headers, a ``-d`` argument to specify the
     current directory, a file name to patch, and a patch file to take
     from stdin.
 
     It is possible to specify a patch tool together with extra
     arguments. For example, setting this option to ``patch --merge``
     will use the ``patch`` program with its 2-way merge option.
 
 ``portablefilenames``
     Check for portable filenames. Can be ``warn``, ``ignore`` or ``abort``.
     (default: ``warn``)
 
     ``warn``
       Print a warning message on POSIX platforms, if a file with a non-portable
       filename is added (e.g. a file with a name that can't be created on
       Windows because it contains reserved parts like ``AUX``, reserved
       characters like ``:``, or would cause a case collision with an existing
       file).
 
     ``ignore``
       Don't print a warning.
 
     ``abort``
       The command is aborted.
 
     ``true``
       Alias for ``warn``.
 
     ``false``
       Alias for ``ignore``.
 
     .. container:: windows
 
       On Windows, this configuration option is ignored and the command aborted.
 
 ``quiet``
     Reduce the amount of output printed.
     (default: False)
 
 ``remotecmd``
     Remote command to use for clone/push/pull operations.
     (default: ``hg``)
 
 ``report_untrusted``
     Warn if a ``.hg/hgrc`` file is ignored due to not being owned by a
     trusted user or group.
     (default: True)
 
 ``slash``
     Display paths using a slash (``/``) as the path separator. This
     only makes a difference on systems where the default path
     separator is not the slash character (e.g. Windows uses the
     backslash character (``\``)).
     (default: False)
 
 ``statuscopies``
     Display copies in the status command.
 
 ``ssh``
     Command to use for SSH connections. (default: ``ssh``)
 
 ``strict``
     Require exact command names, instead of allowing unambiguous
     abbreviations. (default: False)
 
 ``style``
     Name of style to use for command output.
 
 ``supportcontact``
     A URL where users should report a Mercurial traceback. Use this if you are a
     large organisation with its own Mercurial deployment process and crash
     reports should be addressed to your internal support.
 
 ``textwidth``
     Maximum width of help text. A longer line generated by ``hg help`` or
     ``hg subcommand --help`` will be broken after white space to get this
     width or the terminal width, whichever comes first.
     A non-positive value will disable this and the terminal width will be
     used. (default: 78)
 
 ``timeout``
     The timeout used when a lock is held (in seconds), a negative value
     means no timeout. (default: 600)
 
 ``traceback``
     Mercurial always prints a traceback when an unknown exception
     occurs. Setting this to True will make Mercurial print a traceback
     on all exceptions, even those recognized by Mercurial (such as
     IOError or MemoryError). (default: False)
 
 ``username``
     The committer of a changeset created when running "commit".
     Typically a person's name and email address, e.g. ``Fred Widget
     <[e-mail]>``. Environment variables in the
     username are expanded.
 
     (default: ``$EMAIL`` or ``username@hostname``. If the username in
     hgrc is empty, e.g. if the system admin set ``username =`` in the
     system hgrc, it has to be specified manually or in a different
     hgrc file)
 
 ``verbose``
     Increase the amount of output printed. (default: False)
 
 
 ``web``
 -------
 
 Web interface configuration. The settings in this section apply to
 both the builtin webserver (started by :hg:`serve`) and the script you
 run through a webserver (``hgweb.cgi`` and the derivatives for FastCGI
 and WSGI).
 
 The Mercurial webserver does no authentication (it does not prompt for
 usernames and passwords to validate *who* users are), but it does do
 authorization (it grants or denies access for *authenticated users*
 based on settings in this section). You must either configure your
 webserver to do authentication for you, or disable the authorization
 checks.
 
 For a quick setup in a trusted environment, e.g., a private LAN, where
 you want it to accept pushes from anybody, you can use the following
 command line::
 
     $ hg --config web.allow_push=* --config web.push_ssl=False serve
 
 Note that this will allow anybody to push anything to the server and
 that this should not be used for public servers.
 
 The full set of options is:
 
 ``accesslog``
     Where to output the access log. (default: stdout)
 
 ``address``
     Interface address to bind to. (default: all)
 
 ``allow_archive``
     List of archive format (bz2, gz, zip) allowed for downloading.
     (default: empty)
 
 ``allowbz2``
     (DEPRECATED) Whether to allow .tar.bz2 downloading of repository
     revisions.
     (default: False)
 
 ``allowgz``
     (DEPRECATED) Whether to allow .tar.gz downloading of repository
     revisions.
     (default: False)
 
 ``allowpull``
     Whether to allow pulling from the repository. (default: True)
 
 ``allow_push``
     Whether to allow pushing to the repository. If empty or not set,
     pushing is not allowed. If the special value ``*``, any remote
     user can push, including unauthenticated users. Otherwise, the
     remote user must have been authenticated, and the authenticated
     user name must be present in this list. The contents of the
     allow_push list are examined after the deny_push list.
 
 ``allow_read``
     If the user has not already been denied repository access due to
     the contents of deny_read, this list determines whether to grant
     repository access to the user. If this list is not empty, and the
     user is unauthenticated or not present in the list, then access is
     denied for the user. If the list is empty or not set, then access
     is permitted to all users by default. Setting allow_read to the
     special value ``*`` is equivalent to it not being set (i.e. access
     is permitted to all users). The contents of the allow_read list are
     examined after the deny_read list.
 
 ``allowzip``
     (DEPRECATED) Whether to allow .zip downloading of repository
     revisions. This feature creates temporary files.
     (default: False)
 
 ``archivesubrepos``
     Whether to recurse into subrepositories when archiving.
     (default: False)
 
 ``baseurl``
     Base URL to use when publishing URLs in other locations, so
     third-party tools like email notification hooks can construct
     URLs. Example: ``http://hgserver/repos/``.
 
 ``cacerts``
     Path to file containing a list of PEM encoded certificate
     authority certificates. Environment variables and ``~user``
     constructs are expanded in the filename. If specified on the
     client, then it will verify the identity of remote HTTPS servers
     with these certificates.
 
     To disable SSL verification temporarily, specify ``--insecure`` from
     command line.
 
     You can use OpenSSL's CA certificate file if your platform has
     one. On most Linux systems this will be
     ``/etc/ssl/certs/ca-certificates.crt``. Otherwise you will have to
     generate this file manually. The form must be as follows::
 
         -----BEGIN CERTIFICATE-----
         ... (certificate in base64 PEM encoding) ...
         -----END CERTIFICATE-----
         -----BEGIN CERTIFICATE-----
         ... (certificate in base64 PEM encoding) ...
         -----END CERTIFICATE-----
 
 ``cache``
     Whether to support caching in hgweb. (default: True)
 
 ``certificate``
     Certificate to use when running :hg:`serve`.
 
 ``collapse``
     With ``descend`` enabled, repositories in subdirectories are shown at
     a single level alongside repositories in the current path. With
     ``collapse`` also enabled, repositories residing at a deeper level than
     the current path are grouped behind navigable directory entries that
     lead to the locations of these repositories. In effect, this setting
     collapses each collection of repositories found within a subdirectory
     into a single entry for that subdirectory. (default: False)
 
 ``comparisoncontext``
     Number of lines of context to show in side-by-side file comparison. If
     negative or the value ``full``, whole files are shown. (default: 5)
 
     This setting can be overridden by a ``context`` request parameter to the
     ``comparison`` command, taking the same values.
 
 ``contact``
     Name or email address of the person in charge of the repository.
     (default: ui.username or ``$EMAIL`` or "unknown" if unset or empty)
 
 ``deny_push``
     Whether to deny pushing to the repository. If empty or not set,
     push is not denied. If the special value ``*``, all remote users are
     denied push. Otherwise, unauthenticated users are all denied, and
     any authenticated user name present in this list is also denied. The
     contents of the deny_push list are examined before the allow_push list.
 
 ``deny_read``
     Whether to deny reading/viewing of the repository. If this list is
     not empty, unauthenticated users are all denied, and any
     authenticated user name present in this list is also denied access to
     the repository. If set to the special value ``*``, all remote users
     are denied access (rarely needed ;). If deny_read is empty or not set,
     the determination of repository access depends on the presence and
     content of the allow_read list (see description). If both
     deny_read and allow_read are empty or not set, then access is
     permitted to all users by default. If the repository is being
     served via hgwebdir, denied users will not be able to see it in
     the list of repositories. The contents of the deny_read list have
     priority over (are examined before) the contents of the allow_read
     list.
 
 ``descend``
     hgwebdir indexes will not descend into subdirectories. Only repositories
     directly in the current path will be shown (other repositories are still
     available from the index corresponding to their containing path).
 
 ``description``
     Textual description of the repository's purpose or contents.
     (default: "unknown")
 
 ``encoding``
     Character encoding name. (default: the current locale charset)
     Example: "UTF-8".
 
 ``errorlog``
     Where to output the error log. (default: stderr)
 
 ``guessmime``
     Control MIME types for raw download of file content.
     Set to True to let hgweb guess the content type from the file
     extension. This will serve HTML files as ``text/html`` and might
     allow cross-site scripting attacks when serving untrusted
     repositories. (default: False)
 
 ``hidden``
     Whether to hide the repository in the hgwebdir index.
     (default: False)
 
 ``ipv6``
     Whether to use IPv6. (default: False)
 
 ``labels``
     List of string *labels* associated with the repository.
 
     Labels are exposed as a template keyword and can be used to customize
     output. e.g. the ``index`` template can group or filter repositories
     by labels and the ``summary`` template can display additional content
     if a specific label is present.
 
 ``logoimg``
     File name of the logo image that some templates display on each page.
     The file name is relative to ``staticurl``. That is, the full path to
     the logo image is "staticurl/logoimg".
     If unset, ``hglogo.png`` will be used.
 
 ``logourl``
     Base URL to use for logos. If unset, ``https://mercurial-scm.org/``
     will be used.
 
 ``maxchanges``
     Maximum number of changes to list on the changelog. (default: 10)
 
 ``maxfiles``
     Maximum number of files to list per changeset. (default: 10)
 
 ``maxshortchanges``
     Maximum number of changes to list on the shortlog, graph or filelog
     pages. (default: 60)
 
 ``name``
     Repository name to use in the web interface.
     (default: current working directory)
 
 ``port``
     Port to listen on. (default: 8000)
 
 ``prefix``
     Prefix path to serve from. (default: '' (server root))
 
 ``push_ssl``
     Whether to require that inbound pushes be transported over SSL to
     prevent password sniffing. (default: True)
 
 ``refreshinterval``
     How frequently directory listings re-scan the filesystem for new
     repositories, in seconds. This is relevant when wildcards are used
     to define paths. Depending on how much filesystem traversal is
     required, refreshing may negatively impact performance.
 
     Values less than or equal to 0 always refresh.
     (default: 20)
 
 ``staticurl``
     Base URL to use for static files. If unset, static files (e.g. the
     hgicon.png favicon) will be served by the CGI script itself. Use
     this setting to serve them directly with the HTTP server.
     Example: ``http://hgserver/static/``.
 
 ``stripes``
     How many lines a "zebra stripe" should span in multi-line output.
     Set to 0 to disable. (default: 1)
 
 ``style``
     Which template map style to use. The available options are the names of
     subdirectories in the HTML templates path. (default: ``paper``)
     Example: ``monoblue``.
 
 ``templates``
     Where to find the HTML templates. The default path to the HTML templates
     can be obtained from ``hg debuginstall``.
 
 ``websub``
 ----------
 
 Web substitution filter definition. You can use this section to
 define a set of regular expression substitution patterns which
 let you automatically modify the hgweb server output.
 
 The default hgweb templates only apply these substitution patterns
 on the revision description fields. You can apply them anywhere
 you want when you create your own templates by adding calls to the
 "websub" filter (usually after calling the "escape" filter).
 
 This can be used, for example, to convert issue references to links
 to your issue tracker, or to convert "markdown-like" syntax into
 HTML (see the examples below).
 
 Each entry in this section names a substitution filter.
 The value of each entry defines the substitution expression itself.
 The websub expressions follow the old interhg extension syntax,
 which in turn imitates the Unix sed replacement syntax::
 
     patternname = s/SEARCH_REGEX/REPLACE_EXPRESSION/[i]
 
 You can use any separator other than "/". The final "i" is optional
 and indicates that the search must be case insensitive.
 
 Examples::
 
     [websub]
     issues = s|issue(\d+)|<a href="http://bts.example.org/issue\1">issue\1</a>|i
     italic = s/\b_(\S+)_\b/<i>\1<\/i>/
     bold = s/\*\b(\S+)\b\*/<b>\1<\/b>/
 
 ``worker``
 ----------
 
 Parallel master/worker configuration. We currently perform working
 directory updates in parallel on Unix-like systems, which greatly
 helps performance.
 
 ``numcpus``
     Number of CPUs to use for parallel operations. A zero or
     negative value is treated as ``use the default``.
     (default: 4 or the number of CPUs on the system, whichever is larger)
 
 ``backgroundclose``
     Whether to enable closing file handles on background threads during certain
     operations. Some platforms aren't very efficient at closing file
     handles that have been written or appended to. By performing file closing
     on background threads, file write rate can increase substantially.
     (default: true on Windows, false elsewhere)
 
 ``backgroundcloseminfilecount``
     Minimum number of files required to trigger background file closing.
     Operations not writing this many files won't start background close
     threads.
     (default: 2048)
 
 ``backgroundclosemaxqueue``
     The maximum number of opened file handles waiting to be closed in the
     background. This option only has an effect if ``backgroundclose`` is
     enabled.
     (default: 384)
 
 ``backgroundclosethreadcount``
     Number of threads to process background file closes. Only relevant if
     ``backgroundclose`` is enabled.
     (default: 4)

mercurial/profiling.py

@@ -1,145 +1,162 b''
 # profiling.py - profiling functions
 #
 # Copyright 2016 Gregory Szorc <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import, print_function
 
 import contextlib
 import os
 import sys
 import time
 
 from .i18n import _
 from . import (
     error,
     util,
 )
 
 @contextlib.contextmanager
 def lsprofile(ui, fp):
     format = ui.config('profiling', 'format', default='text')
     field = ui.config('profiling', 'sort', default='inlinetime')
     limit = ui.configint('profiling', 'limit', default=30)
     climit = ui.configint('profiling', 'nested', default=0)
 
     if format not in ['text', 'kcachegrind']:
         ui.warn(_("unrecognized profiling format '%s'"
                     " - Ignored\n") % format)
         format = 'text'
 
     try:
         from . import lsprof
     except ImportError:
         raise error.Abort(_(
             'lsprof not available - install from '
             'http://codespeak.net/svn/user/arigo/hack/misc/lsprof/'))
     p = lsprof.Profiler()
     p.enable(subcalls=True)
     try:
         yield
     finally:
         p.disable()
 
         if format == 'kcachegrind':
             from . import lsprofcalltree
             calltree = lsprofcalltree.KCacheGrind(p)
             calltree.output(fp)
         else:
             # format == 'text'
             stats = lsprof.Stats(p.getstats())
             stats.sort(field)
             stats.pprint(limit=limit, file=fp, climit=climit)
 
 @contextlib.contextmanager
 def flameprofile(ui, fp):
     try:
         from flamegraph import flamegraph
     except ImportError:
         raise error.Abort(_(
             'flamegraph not available - install from '
             'https://github.com/evanhempel/python-flamegraph'))
     # developer config: profiling.freq
     freq = ui.configint('profiling', 'freq', default=1000)
     filter_ = None
     collapse_recursion = True
     thread = flamegraph.ProfileThread(fp, 1.0 / freq,
                                       filter_, collapse_recursion)
     start_time = time.clock()
     try:
         thread.start()
         yield
     finally:
         thread.stop()
         thread.join()
         print('Collected %d stack frames (%d unique) in %2.2f seconds.' % (
             time.clock() - start_time, thread.num_frames(),
             thread.num_frames(unique=True)))
 
 @contextlib.contextmanager
 def statprofile(ui, fp):
     try:
         import statprof
     except ImportError:
         raise error.Abort(_(
             'statprof not available - install using "easy_install statprof"'))
 
     freq = ui.configint('profiling', 'freq', default=1000)
     if freq > 0:
         statprof.reset(freq)
     else:
         ui.warn(_("invalid sampling frequency '%s' - ignoring\n") % freq)
 
     statprof.start()
     try:
         yield
     finally:
         statprof.stop()
         statprof.display(fp)
 
 @contextlib.contextmanager
 def profile(ui):
     """Start profiling.
 
     Profiling is active when the context manager is active. When the context
     manager exits, profiling results will be written to the configured output.
     """
     profiler = os.getenv('HGPROF')
     if profiler is None:
         profiler = ui.config('profiling', 'type', default='ls')
     if profiler not in ('ls', 'stat', 'flame'):
         ui.warn(_("unrecognized profiler '%s' - ignored\n") % profiler)
         profiler = 'ls'
 
     output = ui.config('profiling', 'output')
 
     if output == 'blackbox':
         fp = util.stringio()
     elif output:
         path = ui.expandpath(output)
         fp = open(path, 'wb')
     else:
         fp = sys.stderr
 
     try:
         if profiler == 'ls':
             proffn = lsprofile
         elif profiler == 'flame':
             proffn = flameprofile
         else:
             proffn = statprofile
 
         with proffn(ui, fp):
             yield
 
     finally:
         if output:
             if output == 'blackbox':
                 val = 'Profile:\n%s' % fp.getvalue()
                 # ui.log treats the input as a format string,
                 # so we need to escape any % signs.
                 val = val.replace('%', '%%')
                 ui.log('profile', val)
             fp.close()
+
[e-mail]
+def maybeprofile(ui):
+    """Profile if enabled, else do nothing.
+
+    This context manager can be used to optionally profile if profiling
+    is enabled. Otherwise, it does nothing.
+
+    The purpose of this context manager is to make calling code simpler:
+    just use a single code path for calling into code you may want to profile
+    and this function determines whether to start profiling.
+    """
+    if ui.configbool('profiling', 'enabled'):
+        with profile(ui):
+            yield
+    else:
+        yield

tests/test-devel-warnings.t

@@ -1,179 +1,176 b''
 
   $ cat << EOF > buggylocking.py
   > """A small extension that tests our developer warnings
   > """
   > 
   > from mercurial import cmdutil, repair, revset
   > 
   > cmdtable = {}
   > command = cmdutil.command(cmdtable)
   > 
   > @command('buggylocking', [], '')
   > def buggylocking(ui, repo):
   >     lo = repo.lock()
   >     wl = repo.wlock()
   >     wl.release()
   >     lo.release()
   > 
   > @command('buggytransaction', [], '')
   > def buggylocking(ui, repo):
   >     tr = repo.transaction('buggy')
   >     # make sure we rollback the transaction as we don't want to rely on the__del__
   >     tr.release()
   > 
   > @command('properlocking', [], '')
   > def properlocking(ui, repo):
   >     """check that reentrance is fine"""
   >     wl = repo.wlock()
   >     lo = repo.lock()
   >     tr = repo.transaction('proper')
   >     tr2 = repo.transaction('proper')
   >     lo2 = repo.lock()
   >     wl2 = repo.wlock()
   >     wl2.release()
   >     lo2.release()
   >     tr2.close()
   >     tr.close()
   >     lo.release()
   >     wl.release()
   > 
   > @command('nowaitlocking', [], '')
   > def nowaitlocking(ui, repo):
   >     lo = repo.lock()
   >     wl = repo.wlock(wait=False)
   >     wl.release()
   >     lo.release()
   > 
   > @command('stripintr', [], '')
   > def stripintr(ui, repo):
   >     lo = repo.lock()
   >     tr = repo.transaction('foobar')
   >     try:
   >         repair.strip(repo.ui, repo, [repo['.'].node()])
   >     finally:
   >         lo.release()
   > @command('oldanddeprecated', [], '')
   > def oldanddeprecated(ui, repo):
   >     """test deprecation warning API"""
   >     def foobar(ui):
   >         ui.deprecwarn('foorbar is deprecated, go shopping', '42.1337')
   >     foobar(ui)
   > 
   > def oldstylerevset(repo, subset, x):
   >     return list(subset)
   > 
   > revset.symbols['oldstyle'] = oldstylerevset
   > EOF
 
   $ cat << EOF >> $HGRCPATH
   > [extensions]
   > buggylocking=$TESTTMP/buggylocking.py
   > mock=$TESTDIR/mockblackbox.py
   > blackbox=
   > [devel]
   > all-warnings=1
   > EOF
 
   $ hg init lock-checker
   $ cd lock-checker
   $ hg buggylocking
   devel-warn: "wlock" acquired after "lock" at: $TESTTMP/buggylocking.py:* (buggylocking) (glob)
   $ cat << EOF >> $HGRCPATH
   > [devel]
   > all=0
   > check-locks=1
   > EOF
   $ hg buggylocking
   devel-warn: "wlock" acquired after "lock" at: $TESTTMP/buggylocking.py:* (buggylocking) (glob)
   $ hg buggylocking --traceback
   devel-warn: "wlock" acquired after "lock" at:
    */hg:* in * (glob)
    */mercurial/dispatch.py:* in run (glob)
    */mercurial/dispatch.py:* in dispatch (glob)
    */mercurial/dispatch.py:* in _runcatch (glob)
    */mercurial/dispatch.py:* in callcatch (glob)
    */mercurial/dispatch.py:* in _runcatchfunc (glob)
    */mercurial/dispatch.py:* in _dispatch (glob)
    */mercurial/dispatch.py:* in runcommand (glob)
    */mercurial/dispatch.py:* in _runcommand (glob)
-   */mercurial/dispatch.py:* in checkargs (glob)
    */mercurial/dispatch.py:* in <lambda> (glob)
    */mercurial/util.py:* in check (glob)
    $TESTTMP/buggylocking.py:* in buggylocking (glob)
   $ hg properlocking
   $ hg nowaitlocking
 
   $ echo a > a
   $ hg add a
   $ hg commit -m a
   $ hg stripintr
   saved backup bundle to $TESTTMP/lock-checker/.hg/strip-backup/*-backup.hg (glob)
   abort: programming error: cannot strip from inside a transaction
   (contact your extension maintainer)
   [255]
 
   $ hg log -r "oldstyle()" -T '{rev}\n'
   devel-warn: revset "oldstyle" uses list instead of smartset
   (compatibility will be dropped after Mercurial-3.9, update your code.) at: *mercurial/revset.py:* (mfunc) (glob)
   0
   $ hg oldanddeprecated
   devel-warn: foorbar is deprecated, go shopping
   (compatibility will be dropped after Mercurial-42.1337, update your code.) at: $TESTTMP/buggylocking.py:* (oldanddeprecated) (glob)
 
   $ hg oldanddeprecated --traceback
   devel-warn: foorbar is deprecated, go shopping
   (compatibility will be dropped after Mercurial-42.1337, update your code.) at:
    */hg:* in <module> (glob)
    */mercurial/dispatch.py:* in run (glob)
    */mercurial/dispatch.py:* in dispatch (glob)
    */mercurial/dispatch.py:* in _runcatch (glob)
    */mercurial/dispatch.py:* in callcatch (glob)
    */mercurial/dispatch.py:* in _runcatchfunc (glob)
    */mercurial/dispatch.py:* in _dispatch (glob)
    */mercurial/dispatch.py:* in runcommand (glob)
    */mercurial/dispatch.py:* in _runcommand (glob)
-   */mercurial/dispatch.py:* in checkargs (glob)
    */mercurial/dispatch.py:* in <lambda> (glob)
    */mercurial/util.py:* in check (glob)
    $TESTTMP/buggylocking.py:* in oldanddeprecated (glob)
   $ hg blackbox -l 9
   1970/01/01 00:00:00 bob @cb9a9f314b8b07ba71012fcdbc544b5a4d82ff5b (5000)> devel-warn: revset "oldstyle" uses list instead of smartset
   (compatibility will be dropped after Mercurial-3.9, update your code.) at: *mercurial/revset.py:* (mfunc) (glob)
   1970/01/01 00:00:00 bob @cb9a9f314b8b07ba71012fcdbc544b5a4d82ff5b (5000)> log -r oldstyle() -T {rev}\n exited 0 after * seconds (glob)
   1970/01/01 00:00:00 bob @cb9a9f314b8b07ba71012fcdbc544b5a4d82ff5b (5000)> oldanddeprecated
   1970/01/01 00:00:00 bob @cb9a9f314b8b07ba71012fcdbc544b5a4d82ff5b (5000)> devel-warn: foorbar is deprecated, go shopping
   (compatibility will be dropped after Mercurial-42.1337, update your code.) at: $TESTTMP/buggylocking.py:* (oldanddeprecated) (glob)
   1970/01/01 00:00:00 bob @cb9a9f314b8b07ba71012fcdbc544b5a4d82ff5b (5000)> oldanddeprecated exited 0 after * seconds (glob)
   1970/01/01 00:00:00 bob @cb9a9f314b8b07ba71012fcdbc544b5a4d82ff5b (5000)> oldanddeprecated --traceback
   1970/01/01 00:00:00 bob @cb9a9f314b8b07ba71012fcdbc544b5a4d82ff5b (5000)> devel-warn: foorbar is deprecated, go shopping
   (compatibility will be dropped after Mercurial-42.1337, update your code.) at:
    */hg:* in <module> (glob)
    */mercurial/dispatch.py:* in run (glob)
    */mercurial/dispatch.py:* in dispatch (glob)
    */mercurial/dispatch.py:* in _runcatch (glob)
    */mercurial/dispatch.py:* in callcatch (glob)
    */mercurial/dispatch.py:* in _runcatchfunc (glob)
    */mercurial/dispatch.py:* in _dispatch (glob)
    */mercurial/dispatch.py:* in runcommand (glob)
    */mercurial/dispatch.py:* in _runcommand (glob)
-   */mercurial/dispatch.py:* in checkargs (glob)
    */mercurial/dispatch.py:* in <lambda> (glob)
    */mercurial/util.py:* in check (glob)
    $TESTTMP/buggylocking.py:* in oldanddeprecated (glob)
   1970/01/01 00:00:00 bob @cb9a9f314b8b07ba71012fcdbc544b5a4d82ff5b (5000)> oldanddeprecated --traceback exited 0 after * seconds (glob)
   1970/01/01 00:00:00 bob @cb9a9f314b8b07ba71012fcdbc544b5a4d82ff5b (5000)> blackbox -l 9
 
 Test programming error failure:
 
   $ hg buggytransaction 2>&1 | egrep -v '^  '
   ** Unknown exception encountered with possibly-broken third-party extension buggylocking
   ** which supports versions unknown of Mercurial.
   ** Please disable buggylocking and try your action again.
   ** If that fixes the bug please report it to the extension author.
   ** Python * (glob)
   ** Mercurial Distributed SCM (*) (glob)
   ** Extensions loaded: * (glob)
   Traceback (most recent call last):
   RuntimeError: programming error: transaction requires locking
 
   $ cd ..