help: use full name of extensions to look up them for keyword search

Before this patch, "hg help -k KEYWORD" fails, if there is the
extension of which name includes ".", because "extensions.load()"
invoked from "help.topicmatch()" fails to look such extension up, even
though it is already loaded in.

"help.topicmatch()" invokes "extensions.load()" with the name gotten
from "extensions.enabled()". The former expects full name of extension
(= key in '[extensions]' section), but the latter returns names
shortened by "split('.')[-1]". This difference causes failure of
looking extension up.

This patch adds "shortname" argument to "extensions.enabled()" to make
it return shortened names only if it is True. "help.topicmatch()"
turns it off to get full name of extensions.

Then, this patch shortens full name of extensions by "split('.')[-1]"
for showing them in the list of extensions.

Shortening is also applied on names gotten from
"extensions.disabled()" but harmless, because it returns only
extensions directly under "hgext" and their names should not include
".".

mercurial/extensions.py

@@ -1,360 +1,361
 # extensions.py - extension handling 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.
 
 import imp, os
 import util, cmdutil, error
 from i18n import _, gettext
 
 _extensions = {}
 _order = []
 _ignore = ['hbisect', 'bookmarks', 'parentrevspec', 'interhg']
 
 def extensions():
     for name in _order:
         module = _extensions[name]
         if module:
             yield name, module
 
 def find(name):
     '''return module with given extension name'''
     mod = None
     try:
         mod =  _extensions[name]
     except KeyError:
         for k, v in _extensions.iteritems():
             if k.endswith('.' + name) or k.endswith('/' + name):
                 mod = v
                 break
     if not mod:
         raise KeyError(name)
     return mod
 
 def loadpath(path, module_name):
     module_name = module_name.replace('.', '_')
     path = util.expandpath(path)
     if os.path.isdir(path):
         # module/__init__.py style
         d, f = os.path.split(path.rstrip('/'))
         fd, fpath, desc = imp.find_module(f, [d])
         return imp.load_module(module_name, fd, fpath, desc)
     else:
         try:
             return imp.load_source(module_name, path)
         except IOError, exc:
             if not exc.filename:
                 exc.filename = path # python does not fill this
             raise
 
 def load(ui, name, path):
     if name.startswith('hgext.') or name.startswith('hgext/'):
         shortname = name[6:]
     else:
         shortname = name
     if shortname in _ignore:
         return None
     if shortname in _extensions:
         return _extensions[shortname]
     _extensions[shortname] = None
     if path:
         # the module will be loaded in sys.modules
         # choose an unique name so that it doesn't
         # conflicts with other modules
         mod = loadpath(path, 'hgext.%s' % name)
     else:
         def importh(name):
             mod = __import__(name)
             components = name.split('.')
             for comp in components[1:]:
                 mod = getattr(mod, comp)
             return mod
         try:
             mod = importh("hgext.%s" % name)
         except ImportError, err:
             ui.debug('could not import hgext.%s (%s): trying %s\n'
                      % (name, err, name))
             mod = importh(name)
     _extensions[shortname] = mod
     _order.append(shortname)
     return mod
 
 def loadall(ui):
     result = ui.configitems("extensions")
     newindex = len(_order)
     for (name, path) in result:
         if path:
             if path[0] == '!':
                 continue
         try:
             load(ui, name, path)
         except KeyboardInterrupt:
             raise
         except Exception, inst:
             if path:
                 ui.warn(_("*** failed to import extension %s from %s: %s\n")
                         % (name, path, inst))
             else:
                 ui.warn(_("*** failed to import extension %s: %s\n")
                         % (name, inst))
             if ui.traceback():
                 return 1
 
     for name in _order[newindex:]:
         uisetup = getattr(_extensions[name], 'uisetup', None)
         if uisetup:
             uisetup(ui)
 
     for name in _order[newindex:]:
         extsetup = getattr(_extensions[name], 'extsetup', None)
         if extsetup:
             try:
                 extsetup(ui)
             except TypeError:
                 if extsetup.func_code.co_argcount != 0:
                     raise
                 extsetup() # old extsetup with no ui argument
 
 def wrapcommand(table, command, wrapper):
     '''Wrap the command named `command' in table
 
     Replace command in the command table with wrapper. The wrapped command will
     be inserted into the command table specified by the table argument.
 
     The wrapper will be called like
 
       wrapper(orig, *args, **kwargs)
 
     where orig is the original (wrapped) function, and *args, **kwargs
     are the arguments passed to it.
     '''
     assert util.safehasattr(wrapper, '__call__')
     aliases, entry = cmdutil.findcmd(command, table)
     for alias, e in table.iteritems():
         if e is entry:
             key = alias
             break
 
     origfn = entry[0]
     def wrap(*args, **kwargs):
         return util.checksignature(wrapper)(
             util.checksignature(origfn), *args, **kwargs)
 
     wrap.__doc__ = getattr(origfn, '__doc__')
     wrap.__module__ = getattr(origfn, '__module__')
 
     newentry = list(entry)
     newentry[0] = wrap
     table[key] = tuple(newentry)
     return entry
 
 def wrapfunction(container, funcname, wrapper):
     '''Wrap the function named funcname in container
 
     Replace the funcname member in the given container with the specified
     wrapper. The container is typically a module, class, or instance.
 
     The wrapper will be called like
 
       wrapper(orig, *args, **kwargs)
 
     where orig is the original (wrapped) function, and *args, **kwargs
     are the arguments passed to it.
 
     Wrapping methods of the repository object is not recommended since
     it conflicts with extensions that extend the repository by
     subclassing. All extensions that need to extend methods of
     localrepository should use this subclassing trick: namely,
     reposetup() should look like
 
       def reposetup(ui, repo):
           class myrepo(repo.__class__):
               def whatever(self, *args, **kwargs):
                   [...extension stuff...]
                   super(myrepo, self).whatever(*args, **kwargs)
                   [...extension stuff...]
 
           repo.__class__ = myrepo
 
     In general, combining wrapfunction() with subclassing does not
     work. Since you cannot control what other extensions are loaded by
     your end users, you should play nicely with others by using the
     subclass trick.
     '''
     assert util.safehasattr(wrapper, '__call__')
     def wrap(*args, **kwargs):
         return wrapper(origfn, *args, **kwargs)
 
     origfn = getattr(container, funcname)
     assert util.safehasattr(origfn, '__call__')
     setattr(container, funcname, wrap)
     return origfn
 
 def _disabledpaths(strip_init=False):
     '''find paths of disabled extensions. returns a dict of {name: path}
     removes /__init__.py from packages if strip_init is True'''
     import hgext
     extpath = os.path.dirname(os.path.abspath(hgext.__file__))
     try: # might not be a filesystem path
         files = os.listdir(extpath)
     except OSError:
         return {}
 
     exts = {}
     for e in files:
         if e.endswith('.py'):
             name = e.rsplit('.', 1)[0]
             path = os.path.join(extpath, e)
         else:
             name = e
             path = os.path.join(extpath, e, '__init__.py')
             if not os.path.exists(path):
                 continue
             if strip_init:
                 path = os.path.dirname(path)
         if name in exts or name in _order or name == '__init__':
             continue
         exts[name] = path
     return exts
 
 def _moduledoc(file):
     '''return the top-level python documentation for the given file
 
     Loosely inspired by pydoc.source_synopsis(), but rewritten to
     handle triple quotes and to return the whole text instead of just
     the synopsis'''
     result = []
 
     line = file.readline()
     while line[:1] == '#' or not line.strip():
         line = file.readline()
         if not line:
             break
 
     start = line[:3]
     if start == '"""' or start == "'''":
         line = line[3:]
         while line:
             if line.rstrip().endswith(start):
                 line = line.split(start)[0]
                 if line:
                     result.append(line)
                 break
             elif not line:
                 return None # unmatched delimiter
             result.append(line)
             line = file.readline()
     else:
         return None
 
     return ''.join(result)
 
 def _disabledhelp(path):
     '''retrieve help synopsis of a disabled extension (without importing)'''
     try:
         file = open(path)
     except IOError:
         return
     else:
         doc = _moduledoc(file)
         file.close()
 
     if doc: # extracting localized synopsis
         return gettext(doc).splitlines()[0]
     else:
         return _('(no help text available)')
 
 def disabled():
     '''find disabled extensions from hgext. returns a dict of {name: desc}'''
     try:
         from hgext import __index__
         return dict((name, gettext(desc))
                     for name, desc in __index__.docs.iteritems()
                     if name not in _order)
     except ImportError:
         pass
 
     paths = _disabledpaths()
     if not paths:
         return {}
 
     exts = {}
     for name, path in paths.iteritems():
         doc = _disabledhelp(path)
         if doc:
             exts[name] = doc
 
     return exts
 
 def disabledext(name):
     '''find a specific disabled extension from hgext. returns desc'''
     try:
         from hgext import __index__
         if name in _order:  # enabled
             return
         else:
             return gettext(__index__.docs.get(name))
     except ImportError:
         pass
 
     paths = _disabledpaths()
     if name in paths:
         return _disabledhelp(paths[name])
 
 def disabledcmd(ui, cmd, strict=False):
     '''import disabled extensions until cmd is found.
     returns (cmdname, extname, module)'''
 
     paths = _disabledpaths(strip_init=True)
     if not paths:
         raise error.UnknownCommand(cmd)
 
     def findcmd(cmd, name, path):
         try:
             mod = loadpath(path, 'hgext.%s' % name)
         except Exception:
             return
         try:
             aliases, entry = cmdutil.findcmd(cmd,
                 getattr(mod, 'cmdtable', {}), strict)
         except (error.AmbiguousCommand, error.UnknownCommand):
             return
         except Exception:
             ui.warn(_('warning: error finding commands in %s\n') % path)
             ui.traceback()
             return
         for c in aliases:
             if c.startswith(cmd):
                 cmd = c
                 break
         else:
             cmd = aliases[0]
         return (cmd, name, mod)
 
     ext = None
     # first, search for an extension with the same name as the command
     path = paths.pop(cmd, None)
     if path:
         ext = findcmd(cmd, cmd, path)
     if not ext:
         # otherwise, interrogate each extension until there's a match
         for name, path in paths.iteritems():
             ext = findcmd(cmd, name, path)
             if ext:
                 break
     if ext and 'DEPRECATED' not in ext.__doc__:
         return ext
 
     raise error.UnknownCommand(cmd)
 
-def enabled():
+def enabled(shortname=True):
     '''return a dict of {name: desc} of extensions'''
     exts = {}
     for ename, ext in extensions():
         doc = (gettext(ext.__doc__) or _('(no help text available)'))
+        if shortname:
         ename = ename.split('.')[-1]
         exts[ename] = doc.splitlines()[0].strip()
 
     return exts

mercurial/help.py

@@ -1,504 +1,505
 # help.py - help data for mercurial
 #
 # Copyright 2006 Matt Mackall <[e-mail]>
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from i18n import gettext, _
 import itertools, sys, os, error
 import extensions, revset, fileset, templatekw, templatefilters, filemerge
 import encoding, util, minirst
 import cmdutil
 
 def listexts(header, exts, indent=1):
     '''return a text listing of the given extensions'''
     rst = []
     if exts:
         rst.append('\n%s\n\n' % header)
         for name, desc in sorted(exts.iteritems()):
             rst.append('%s:%s: %s\n' % (' ' * indent, name, desc))
     return rst
 
 def extshelp():
     rst = loaddoc('extensions')().splitlines(True)
     rst.extend(listexts(_('enabled extensions:'), extensions.enabled()))
     rst.extend(listexts(_('disabled extensions:'), extensions.disabled()))
     doc = ''.join(rst)
     return doc
 
 def optrst(options, verbose):
     data = []
     multioccur = False
     for option in options:
         if len(option) == 5:
             shortopt, longopt, default, desc, optlabel = option
         else:
             shortopt, longopt, default, desc = option
             optlabel = _("VALUE") # default label
 
         if _("DEPRECATED") in desc and not verbose:
             continue
 
         so = ''
         if shortopt:
             so = '-' + shortopt
         lo = '--' + longopt
         if default:
             desc += _(" (default: %s)") % default
 
         if isinstance(default, list):
             lo += " %s [+]" % optlabel
             multioccur = True
         elif (default is not None) and not isinstance(default, bool):
             lo += " %s" % optlabel
 
         data.append((so, lo, desc))
 
     rst = minirst.maketable(data, 1)
 
     if multioccur:
         rst.append(_("\n[+] marked option can be specified multiple times\n"))
 
     return ''.join(rst)
 
 def indicateomitted(rst, omitted, notomitted=None):
     rst.append('\n\n.. container:: omitted\n\n    %s\n\n' % omitted)
     if notomitted:
         rst.append('\n\n.. container:: notomitted\n\n    %s\n\n' % notomitted)
 
 def topicmatch(kw):
     """Return help topics matching kw.
 
     Returns {'section': [(name, summary), ...], ...} where section is
     one of topics, commands, extensions, or extensioncommands.
     """
     kw = encoding.lower(kw)
     def lowercontains(container):
         return kw in encoding.lower(container)  # translated in helptable
     results = {'topics': [],
                'commands': [],
                'extensions': [],
                'extensioncommands': [],
                }
     for names, header, doc in helptable:
         if (sum(map(lowercontains, names))
             or lowercontains(header)
             or lowercontains(doc())):
             results['topics'].append((names[0], header))
     import commands # avoid cycle
     for cmd, entry in commands.table.iteritems():
         if cmd.startswith('debug'):
             continue
         if len(entry) == 3:
             summary = entry[2]
         else:
             summary = ''
         # translate docs *before* searching there
         docs = _(getattr(entry[0], '__doc__', None)) or ''
         if kw in cmd or lowercontains(summary) or lowercontains(docs):
             doclines = docs.splitlines()
             if doclines:
                 summary = doclines[0]
             cmdname = cmd.split('|')[0].lstrip('^')
             results['commands'].append((cmdname, summary))
     for name, docs in itertools.chain(
-        extensions.enabled().iteritems(),
+        extensions.enabled(False).iteritems(),
         extensions.disabled().iteritems()):
         # extensions.load ignores the UI argument
         mod = extensions.load(None, name, '')
+        name = name.split('.')[-1]
         if lowercontains(name) or lowercontains(docs):
             # extension docs are already translated
             results['extensions'].append((name, docs.splitlines()[0]))
         for cmd, entry in getattr(mod, 'cmdtable', {}).iteritems():
             if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])):
                 cmdname = cmd.split('|')[0].lstrip('^')
                 if entry[0].__doc__:
                     cmddoc = gettext(entry[0].__doc__).splitlines()[0]
                 else:
                     cmddoc = _('(no help text available)')
                 results['extensioncommands'].append((cmdname, cmddoc))
     return results
 
 def loaddoc(topic):
     """Return a delayed loader for help/topic.txt."""
 
     def loader():
         if util.mainfrozen():
             module = sys.executable
         else:
             module = __file__
         base = os.path.dirname(module)
 
         for dir in ('.', '..'):
             docdir = os.path.join(base, dir, 'help')
             if os.path.isdir(docdir):
                 break
 
         path = os.path.join(docdir, topic + ".txt")
         doc = gettext(util.readfile(path))
         for rewriter in helphooks.get(topic, []):
             doc = rewriter(topic, doc)
         return doc
 
     return loader
 
 helptable = sorted([
     (["config", "hgrc"], _("Configuration Files"), loaddoc('config')),
     (["dates"], _("Date Formats"), loaddoc('dates')),
     (["patterns"], _("File Name Patterns"), loaddoc('patterns')),
     (['environment', 'env'], _('Environment Variables'),
      loaddoc('environment')),
     (['revisions', 'revs'], _('Specifying Single Revisions'),
      loaddoc('revisions')),
     (['multirevs', 'mrevs'], _('Specifying Multiple Revisions'),
      loaddoc('multirevs')),
     (['revsets', 'revset'], _("Specifying Revision Sets"), loaddoc('revsets')),
     (['filesets', 'fileset'], _("Specifying File Sets"), loaddoc('filesets')),
     (['diffs'], _('Diff Formats'), loaddoc('diffs')),
     (['merge-tools', 'mergetools'], _('Merge Tools'), loaddoc('merge-tools')),
     (['templating', 'templates', 'template', 'style'], _('Template Usage'),
      loaddoc('templates')),
     (['urls'], _('URL Paths'), loaddoc('urls')),
     (["extensions"], _("Using Additional Features"), extshelp),
     (["subrepos", "subrepo"], _("Subrepositories"), loaddoc('subrepos')),
     (["hgweb"], _("Configuring hgweb"), loaddoc('hgweb')),
     (["glossary"], _("Glossary"), loaddoc('glossary')),
     (["hgignore", "ignore"], _("Syntax for Mercurial Ignore Files"),
      loaddoc('hgignore')),
     (["phases"], _("Working with Phases"), loaddoc('phases')),
 ])
 
 # Map topics to lists of callable taking the current topic help and
 # returning the updated version
 helphooks = {}
 
 def addtopichook(topic, rewriter):
     helphooks.setdefault(topic, []).append(rewriter)
 
 def makeitemsdoc(topic, doc, marker, items):
     """Extract docstring from the items key to function mapping, build a
     .single documentation block and use it to overwrite the marker in doc
     """
     entries = []
     for name in sorted(items):
         text = (items[name].__doc__ or '').rstrip()
         if not text:
             continue
         text = gettext(text)
         lines = text.splitlines()
         doclines = [(lines[0])]
         for l in lines[1:]:
             # Stop once we find some Python doctest
             if l.strip().startswith('>>>'):
                 break
             doclines.append('  ' + l.strip())
         entries.append('\n'.join(doclines))
     entries = '\n\n'.join(entries)
     return doc.replace(marker, entries)
 
 def addtopicsymbols(topic, marker, symbols):
     def add(topic, doc):
         return makeitemsdoc(topic, doc, marker, symbols)
     addtopichook(topic, add)
 
 addtopicsymbols('filesets', '.. predicatesmarker', fileset.symbols)
 addtopicsymbols('merge-tools', '.. internaltoolsmarker', filemerge.internals)
 addtopicsymbols('revsets', '.. predicatesmarker', revset.symbols)
 addtopicsymbols('templates', '.. keywordsmarker', templatekw.dockeywords)
 addtopicsymbols('templates', '.. filtersmarker', templatefilters.filters)
 
 def help_(ui, name, unknowncmd=False, full=True, **opts):
     '''
     Generate the help for 'name' as unformatted restructured text. If
     'name' is None, describe the commands available.
     '''
 
     import commands # avoid cycle
 
     def helpcmd(name):
         try:
             aliases, entry = cmdutil.findcmd(name, commands.table,
                                              strict=unknowncmd)
         except error.AmbiguousCommand, inst:
             # py3k fix: except vars can't be used outside the scope of the
             # except block, nor can be used inside a lambda. python issue4617
             prefix = inst.args[0]
             select = lambda c: c.lstrip('^').startswith(prefix)
             rst = helplist(select)
             return rst
 
         rst = []
 
         # check if it's an invalid alias and display its error if it is
         if getattr(entry[0], 'badalias', False):
             if not unknowncmd:
                 ui.pushbuffer()
                 entry[0](ui)
                 rst.append(ui.popbuffer())
             return rst
 
         # synopsis
         if len(entry) > 2:
             if entry[2].startswith('hg'):
                 rst.append("%s\n" % entry[2])
             else:
                 rst.append('hg %s %s\n' % (aliases[0], entry[2]))
         else:
             rst.append('hg %s\n' % aliases[0])
         # aliases
         if full and not ui.quiet and len(aliases) > 1:
             rst.append(_("\naliases: %s\n") % ', '.join(aliases[1:]))
         rst.append('\n')
 
         # description
         doc = gettext(entry[0].__doc__)
         if not doc:
             doc = _("(no help text available)")
         if util.safehasattr(entry[0], 'definition'):  # aliased command
             if entry[0].definition.startswith('!'):  # shell alias
                 doc = _('shell alias for::\n\n    %s') % entry[0].definition[1:]
             else:
                 doc = _('alias for: hg %s\n\n%s') % (entry[0].definition, doc)
         doc = doc.splitlines(True)
         if ui.quiet or not full:
             rst.append(doc[0])
         else:
             rst.extend(doc)
         rst.append('\n')
 
         # check if this command shadows a non-trivial (multi-line)
         # extension help text
         try:
             mod = extensions.find(name)
             doc = gettext(mod.__doc__) or ''
             if '\n' in doc.strip():
                 msg = _('use "hg help -e %s" to show help for '
                         'the %s extension') % (name, name)
                 rst.append('\n%s\n' % msg)
         except KeyError:
             pass
 
         # options
         if not ui.quiet and entry[1]:
             rst.append('\n%s\n\n' % _("options:"))
             rst.append(optrst(entry[1], ui.verbose))
 
         if ui.verbose:
             rst.append('\n%s\n\n' % _("global options:"))
             rst.append(optrst(commands.globalopts, ui.verbose))
 
         if not ui.verbose:
             if not full:
                 rst.append(_('\nuse "hg help %s" to show the full help text\n')
                            % name)
             elif not ui.quiet:
                 omitted = _('use "hg -v help %s" to show more complete'
                             ' help and the global options') % name
                 notomitted = _('use "hg -v help %s" to show'
                                ' the global options') % name
                 indicateomitted(rst, omitted, notomitted)
 
         return rst
 
 
     def helplist(select=None):
         # list of commands
         if name == "shortlist":
             header = _('basic commands:\n\n')
         else:
             header = _('list of commands:\n\n')
 
         h = {}
         cmds = {}
         for c, e in commands.table.iteritems():
             f = c.split("|", 1)[0]
             if select and not select(f):
                 continue
             if (not select and name != 'shortlist' and
                 e[0].__module__ != commands.__name__):
                 continue
             if name == "shortlist" and not f.startswith("^"):
                 continue
             f = f.lstrip("^")
             if not ui.debugflag and f.startswith("debug"):
                 continue
             doc = e[0].__doc__
             if doc and 'DEPRECATED' in doc and not ui.verbose:
                 continue
             doc = gettext(doc)
             if not doc:
                 doc = _("(no help text available)")
             h[f] = doc.splitlines()[0].rstrip()
             cmds[f] = c.lstrip("^")
 
         rst = []
         if not h:
             if not ui.quiet:
                 rst.append(_('no commands defined\n'))
             return rst
 
         if not ui.quiet:
             rst.append(header)
         fns = sorted(h)
         for f in fns:
             if ui.verbose:
                 commacmds = cmds[f].replace("|",", ")
                 rst.append(" :%s: %s\n" % (commacmds, h[f]))
             else:
                 rst.append(' :%s: %s\n' % (f, h[f]))
 
         if not name:
             exts = listexts(_('enabled extensions:'), extensions.enabled())
             if exts:
                 rst.append('\n')
                 rst.extend(exts)
 
             rst.append(_("\nadditional help topics:\n\n"))
             topics = []
             for names, header, doc in helptable:
                 topics.append((names[0], header))
             for t, desc in topics:
                 rst.append(" :%s: %s\n" % (t, desc))
 
         optlist = []
         if not ui.quiet:
             if ui.verbose:
                 optlist.append((_("global options:"), commands.globalopts))
                 if name == 'shortlist':
                     optlist.append((_('use "hg help" for the full list '
                                            'of commands'), ()))
             else:
                 if name == 'shortlist':
                     msg = _('use "hg help" for the full list of commands '
                             'or "hg -v" for details')
                 elif name and not full:
                     msg = _('use "hg help %s" to show the full help '
                             'text') % name
                 else:
                     msg = _('use "hg -v help%s" to show builtin aliases and '
                             'global options') % (name and " " + name or "")
                 optlist.append((msg, ()))
 
         if optlist:
             for title, options in optlist:
                 rst.append('\n%s\n' % title)
                 if options:
                     rst.append('\n%s\n' % optrst(options, ui.verbose))
         return rst
 
     def helptopic(name):
         for names, header, doc in helptable:
             if name in names:
                 break
         else:
             raise error.UnknownCommand(name)
 
         rst = [minirst.section(header)]
 
         # description
         if not doc:
             rst.append("    %s\n" % _("(no help text available)"))
         if util.safehasattr(doc, '__call__'):
             rst += ["    %s\n" % l for l in doc().splitlines()]
 
         if not ui.verbose:
             omitted = (_('use "hg help -v %s" to show more complete help') %
                        name)
             indicateomitted(rst, omitted)
 
         try:
             cmdutil.findcmd(name, commands.table)
             rst.append(_('\nuse "hg help -c %s" to see help for '
                        'the %s command\n') % (name, name))
         except error.UnknownCommand:
             pass
         return rst
 
     def helpext(name):
         try:
             mod = extensions.find(name)
             doc = gettext(mod.__doc__) or _('no help text available')
         except KeyError:
             mod = None
             doc = extensions.disabledext(name)
             if not doc:
                 raise error.UnknownCommand(name)
 
         if '\n' not in doc:
             head, tail = doc, ""
         else:
             head, tail = doc.split('\n', 1)
         rst = [_('%s extension - %s\n\n') % (name.split('.')[-1], head)]
         if tail:
             rst.extend(tail.splitlines(True))
             rst.append('\n')
 
         if not ui.verbose:
             omitted = (_('use "hg help -v %s" to show more complete help') %
                        name)
             indicateomitted(rst, omitted)
 
         if mod:
             try:
                 ct = mod.cmdtable
             except AttributeError:
                 ct = {}
             modcmds = set([c.split('|', 1)[0] for c in ct])
             rst.extend(helplist(modcmds.__contains__))
         else:
             rst.append(_('use "hg help extensions" for information on enabling '
                        'extensions\n'))
         return rst
 
     def helpextcmd(name):
         cmd, ext, mod = extensions.disabledcmd(ui, name,
                                                ui.configbool('ui', 'strict'))
         doc = gettext(mod.__doc__).splitlines()[0]
 
         rst = listexts(_("'%s' is provided by the following "
                               "extension:") % cmd, {ext: doc}, indent=4)
         rst.append('\n')
         rst.append(_('use "hg help extensions" for information on enabling '
                    'extensions\n'))
         return rst
 
 
     rst = []
     kw = opts.get('keyword')
     if kw:
         matches = topicmatch(kw)
         for t, title in (('topics', _('Topics')),
                          ('commands', _('Commands')),
                          ('extensions', _('Extensions')),
                          ('extensioncommands', _('Extension Commands'))):
             if matches[t]:
                 rst.append('%s:\n\n' % title)
                 rst.extend(minirst.maketable(sorted(matches[t]), 1))
                 rst.append('\n')
     elif name and name != 'shortlist':
         i = None
         if unknowncmd:
             queries = (helpextcmd,)
         elif opts.get('extension'):
             queries = (helpext,)
         elif opts.get('command'):
             queries = (helpcmd,)
         else:
             queries = (helptopic, helpcmd, helpext, helpextcmd)
         for f in queries:
             try:
                 rst = f(name)
                 i = None
                 break
             except error.UnknownCommand, inst:
                 i = inst
         if i:
             raise i
     else:
         # program name
         if not ui.quiet:
             rst = [_("Mercurial Distributed SCM\n"), '\n']
         rst.extend(helplist())
 
     return ''.join(rst)

tests/test-help.t

@@ -1,1905 +1,1912
 Short help:
 
   $ hg
   Mercurial Distributed SCM
   
   basic commands:
   
    add           add the specified files on the next commit
    annotate      show changeset information by line for each file
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    merge         merge working directory with another revision
    pull          pull changes from the specified source
    push          push changes to the specified destination
    remove        remove the specified files on the next commit
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    update        update working directory (or switch revisions)
   
   use "hg help" for the full list of commands or "hg -v" for details
 
   $ hg -q
    add           add the specified files on the next commit
    annotate      show changeset information by line for each file
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    merge         merge working directory with another revision
    pull          pull changes from the specified source
    push          push changes to the specified destination
    remove        remove the specified files on the next commit
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    update        update working directory (or switch revisions)
 
   $ hg help
   Mercurial Distributed SCM
   
   list of commands:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    annotate      show changeset information by line for each file
    archive       create an unversioned archive of a repository revision
    backout       reverse effect of earlier changeset
    bisect        subdivision search of changesets
    bookmarks     track a line of development with movable markers
    branch        set or show the current branch name
    branches      list repository named branches
    bundle        create a changegroup file
    cat           output the current or given revision of files
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    graft         copy changes from other branches onto the current branch
    grep          search for a pattern in specified files and revisions
    heads         show branch heads
    help          show help for a given topic or a help overview
    identify      identify the working copy or specified revision
    import        import an ordered set of patches
    incoming      show new changesets found in source
    init          create a new repository in the given directory
    locate        locate files matching specific patterns
    log           show revision history of entire repository or files
    manifest      output the current or given revision of the project manifest
    merge         merge working directory with another revision
    outgoing      show changesets not found in the destination
    parents       show the parents of the working directory or revision
    paths         show aliases for remote repositories
    phase         set or show the current phase name
    pull          pull changes from the specified source
    push          push changes to the specified destination
    recover       roll back an interrupted transaction
    remove        remove the specified files on the next commit
    rename        rename files; equivalent of copy + remove
    resolve       redo merges or set/view the merge status of files
    revert        restore files to their checkout state
    root          print the root (top) of the current working directory
    serve         start stand-alone webserver
    showconfig    show combined config settings from all hgrc files
    status        show changed files in the working directory
    summary       summarize working directory state
    tag           add one or more tags for the current or given revision
    tags          list repository tags
    unbundle      apply one or more changegroup files
    update        update working directory (or switch revisions)
    verify        verify the integrity of the repository
    version       output version and copyright information
   
   additional help topics:
   
    config        Configuration Files
    dates         Date Formats
    diffs         Diff Formats
    environment   Environment Variables
    extensions    Using Additional Features
    filesets      Specifying File Sets
    glossary      Glossary
    hgignore      Syntax for Mercurial Ignore Files
    hgweb         Configuring hgweb
    merge-tools   Merge Tools
    multirevs     Specifying Multiple Revisions
    patterns      File Name Patterns
    phases        Working with Phases
    revisions     Specifying Single Revisions
    revsets       Specifying Revision Sets
    subrepos      Subrepositories
    templating    Template Usage
    urls          URL Paths
   
   use "hg -v help" to show builtin aliases and global options
 
   $ hg -q help
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    annotate      show changeset information by line for each file
    archive       create an unversioned archive of a repository revision
    backout       reverse effect of earlier changeset
    bisect        subdivision search of changesets
    bookmarks     track a line of development with movable markers
    branch        set or show the current branch name
    branches      list repository named branches
    bundle        create a changegroup file
    cat           output the current or given revision of files
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    graft         copy changes from other branches onto the current branch
    grep          search for a pattern in specified files and revisions
    heads         show branch heads
    help          show help for a given topic or a help overview
    identify      identify the working copy or specified revision
    import        import an ordered set of patches
    incoming      show new changesets found in source
    init          create a new repository in the given directory
    locate        locate files matching specific patterns
    log           show revision history of entire repository or files
    manifest      output the current or given revision of the project manifest
    merge         merge working directory with another revision
    outgoing      show changesets not found in the destination
    parents       show the parents of the working directory or revision
    paths         show aliases for remote repositories
    phase         set or show the current phase name
    pull          pull changes from the specified source
    push          push changes to the specified destination
    recover       roll back an interrupted transaction
    remove        remove the specified files on the next commit
    rename        rename files; equivalent of copy + remove
    resolve       redo merges or set/view the merge status of files
    revert        restore files to their checkout state
    root          print the root (top) of the current working directory
    serve         start stand-alone webserver
    showconfig    show combined config settings from all hgrc files
    status        show changed files in the working directory
    summary       summarize working directory state
    tag           add one or more tags for the current or given revision
    tags          list repository tags
    unbundle      apply one or more changegroup files
    update        update working directory (or switch revisions)
    verify        verify the integrity of the repository
    version       output version and copyright information
   
   additional help topics:
   
    config        Configuration Files
    dates         Date Formats
    diffs         Diff Formats
    environment   Environment Variables
    extensions    Using Additional Features
    filesets      Specifying File Sets
    glossary      Glossary
    hgignore      Syntax for Mercurial Ignore Files
    hgweb         Configuring hgweb
    merge-tools   Merge Tools
    multirevs     Specifying Multiple Revisions
    patterns      File Name Patterns
    phases        Working with Phases
    revisions     Specifying Single Revisions
    revsets       Specifying Revision Sets
    subrepos      Subrepositories
    templating    Template Usage
    urls          URL Paths
 
 Test short command list with verbose option
 
   $ hg -v help shortlist
   Mercurial Distributed SCM
   
   basic commands:
   
    add           add the specified files on the next commit
    annotate, blame
                  show changeset information by line for each file
    clone         make a copy of an existing repository
    commit, ci    commit the specified files or all outstanding changes
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    init          create a new repository in the given directory
    log, history  show revision history of entire repository or files
    merge         merge working directory with another revision
    pull          pull changes from the specified source
    push          push changes to the specified destination
    remove, rm    remove the specified files on the next commit
    serve         start stand-alone webserver
    status, st    show changed files in the working directory
    summary, sum  summarize working directory state
    update, up, checkout, co
                  update working directory (or switch revisions)
   
   global options:
   
    -R --repository REPO   repository root directory or name of overlay bundle
                           file
       --cwd DIR           change working directory
    -y --noninteractive    do not prompt, automatically pick the first choice for
                           all prompts
    -q --quiet             suppress output
    -v --verbose           enable additional output
       --config CONFIG [+] set/override config option (use 'section.name=value')
       --debug             enable debugging output
       --debugger          start debugger
       --encoding ENCODE   set the charset encoding (default: ascii)
       --encodingmode MODE set the charset encoding mode (default: strict)
       --traceback         always print a traceback on exception
       --time              time how long the command takes
       --profile           print command execution profile
       --version           output version information and exit
    -h --help              display help and exit
       --hidden            consider hidden changesets
   
   [+] marked option can be specified multiple times
   
   use "hg help" for the full list of commands
 
   $ hg add -h
   hg add [OPTION]... [FILE]...
   
   add the specified files on the next commit
   
       Schedule files to be version controlled and added to the repository.
   
       The files will be added to the repository at the next commit. To undo an
       add before that, see "hg forget".
   
       If no names are given, add all files to the repository.
   
       Returns 0 if all files are successfully added.
   
   options:
   
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
    -n --dry-run             do not perform actions, just print output
   
   [+] marked option can be specified multiple times
   
   use "hg -v help add" to show more complete help and the global options
 
 Verbose help for add
 
   $ hg add -hv
   hg add [OPTION]... [FILE]...
   
   add the specified files on the next commit
   
       Schedule files to be version controlled and added to the repository.
   
       The files will be added to the repository at the next commit. To undo an
       add before that, see "hg forget".
   
       If no names are given, add all files to the repository.
   
       An example showing how new (unknown) files are added automatically by "hg
       add":
   
         $ ls
         foo.c
         $ hg status
         ? foo.c
         $ hg add
         adding foo.c
         $ hg status
         A foo.c
   
       Returns 0 if all files are successfully added.
   
   options:
   
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
    -n --dry-run             do not perform actions, just print output
   
   [+] marked option can be specified multiple times
   
   global options:
   
    -R --repository REPO   repository root directory or name of overlay bundle
                           file
       --cwd DIR           change working directory
    -y --noninteractive    do not prompt, automatically pick the first choice for
                           all prompts
    -q --quiet             suppress output
    -v --verbose           enable additional output
       --config CONFIG [+] set/override config option (use 'section.name=value')
       --debug             enable debugging output
       --debugger          start debugger
       --encoding ENCODE   set the charset encoding (default: ascii)
       --encodingmode MODE set the charset encoding mode (default: strict)
       --traceback         always print a traceback on exception
       --time              time how long the command takes
       --profile           print command execution profile
       --version           output version information and exit
    -h --help              display help and exit
       --hidden            consider hidden changesets
   
   [+] marked option can be specified multiple times
 
 Test help option with version option
 
   $ hg add -h --version
   Mercurial Distributed SCM (version *) (glob)
   (see http://mercurial.selenic.com for more information)
   
   Copyright (C) 2005-2013 Matt Mackall and others
   This is free software; see the source for copying conditions. There is NO
   warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
   $ hg add --skjdfks
   hg add: option --skjdfks not recognized
   hg add [OPTION]... [FILE]...
   
   add the specified files on the next commit
   
   options:
   
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
    -n --dry-run             do not perform actions, just print output
   
   [+] marked option can be specified multiple times
   
   use "hg help add" to show the full help text
   [255]
 
 Test ambiguous command help
 
   $ hg help ad
   list of commands:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
   
   use "hg -v help ad" to show builtin aliases and global options
 
 Test command without options
 
   $ hg help verify
   hg verify
   
   verify the integrity of the repository
   
       Verify the integrity of the current repository.
   
       This will perform an extensive check of the repository's integrity,
       validating the hashes and checksums of each entry in the changelog,
       manifest, and tracked files, as well as the integrity of their crosslinks
       and indices.
   
       Please see http://mercurial.selenic.com/wiki/RepositoryCorruption for more
       information about recovery from corruption of the repository.
   
       Returns 0 on success, 1 if errors are encountered.
   
   use "hg -v help verify" to show the global options
 
   $ hg help diff
   hg diff [OPTION]... ([-c REV] | [-r REV1 [-r REV2]]) [FILE]...
   
   diff repository (or selected files)
   
       Show differences between revisions for the specified files.
   
       Differences between files are shown using the unified diff format.
   
       Note:
          diff may generate unexpected results for merges, as it will default to
          comparing against the working directory's first parent changeset if no
          revisions are specified.
   
       When two revision arguments are given, then changes are shown between
       those revisions. If only one revision is specified then that revision is
       compared to the working directory, and, when no revisions are specified,
       the working directory files are compared to its parent.
   
       Alternatively you can specify -c/--change with a revision to see the
       changes in that changeset relative to its first parent.
   
       Without the -a/--text option, diff will avoid generating diffs of files it
       detects as binary. With -a, diff will generate a diff anyway, probably
       with undesirable results.
   
       Use the -g/--git option to generate diffs in the git extended diff format.
       For more information, read "hg help diffs".
   
       Returns 0 on success.
   
   options:
   
    -r --rev REV [+]         revision
    -c --change REV          change made by revision
    -a --text                treat all files as text
    -g --git                 use git extended diff format
       --nodates             omit dates from diff headers
    -p --show-function       show which function each change is in
       --reverse             produce a diff that undoes the changes
    -w --ignore-all-space    ignore white space when comparing lines
    -b --ignore-space-change ignore changes in the amount of white space
    -B --ignore-blank-lines  ignore changes whose lines are all blank
    -U --unified NUM         number of lines of context to show
       --stat                output diffstat-style summary of changes
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
   
   [+] marked option can be specified multiple times
   
   use "hg -v help diff" to show more complete help and the global options
 
   $ hg help status
   hg status [OPTION]... [FILE]...
   
   aliases: st
   
   show changed files in the working directory
   
       Show status of files in the repository. If names are given, only files
       that match are shown. Files that are clean or ignored or the source of a
       copy/move operation, are not listed unless -c/--clean, -i/--ignored,
       -C/--copies or -A/--all are given. Unless options described with "show
       only ..." are given, the options -mardu are used.
   
       Option -q/--quiet hides untracked (unknown and ignored) files unless
       explicitly requested with -u/--unknown or -i/--ignored.
   
       Note:
          status may appear to disagree with diff if permissions have changed or
          a merge has occurred. The standard diff format does not report
          permission changes and diff only reports changes relative to one merge
          parent.
   
       If one revision is given, it is used as the base revision. If two
       revisions are given, the differences between them are shown. The --change
       option can also be used as a shortcut to list the changed files of a
       revision from its first parent.
   
       The codes used to show the status of files are:
   
         M = modified
         A = added
         R = removed
         C = clean
         ! = missing (deleted by non-hg command, but still tracked)
         ? = not tracked
         I = ignored
           = origin of the previous file listed as A (added)
   
       Returns 0 on success.
   
   options:
   
    -A --all                 show status of all files
    -m --modified            show only modified files
    -a --added               show only added files
    -r --removed             show only removed files
    -d --deleted             show only deleted (but tracked) files
    -c --clean               show only files without changes
    -u --unknown             show only unknown (not tracked) files
    -i --ignored             show only ignored files
    -n --no-status           hide status prefix
    -C --copies              show source of copied files
    -0 --print0              end filenames with NUL, for use with xargs
       --rev REV [+]         show difference from revision
       --change REV          list the changed files of a revision
    -I --include PATTERN [+] include names matching the given patterns
    -X --exclude PATTERN [+] exclude names matching the given patterns
    -S --subrepos            recurse into subrepositories
   
   [+] marked option can be specified multiple times
   
   use "hg -v help status" to show more complete help and the global options
 
   $ hg -q help status
   hg status [OPTION]... [FILE]...
   
   show changed files in the working directory
 
   $ hg help foo
   hg: unknown command 'foo'
   Mercurial Distributed SCM
   
   basic commands:
   
    add           add the specified files on the next commit
    annotate      show changeset information by line for each file
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    merge         merge working directory with another revision
    pull          pull changes from the specified source
    push          push changes to the specified destination
    remove        remove the specified files on the next commit
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    update        update working directory (or switch revisions)
   
   use "hg help" for the full list of commands or "hg -v" for details
   [255]
 
   $ hg skjdfks
   hg: unknown command 'skjdfks'
   Mercurial Distributed SCM
   
   basic commands:
   
    add           add the specified files on the next commit
    annotate      show changeset information by line for each file
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    init          create a new repository in the given directory
    log           show revision history of entire repository or files
    merge         merge working directory with another revision
    pull          pull changes from the specified source
    push          push changes to the specified destination
    remove        remove the specified files on the next commit
    serve         start stand-alone webserver
    status        show changed files in the working directory
    summary       summarize working directory state
    update        update working directory (or switch revisions)
   
   use "hg help" for the full list of commands or "hg -v" for details
   [255]
 
   $ cat > helpext.py <<EOF
   > import os
   > from mercurial import commands
   > 
   > def nohelp(ui, *args, **kwargs):
   >     pass
   > 
   > cmdtable = {
   >     "nohelp": (nohelp, [], "hg nohelp"),
   > }
   > 
   > commands.norepo += ' nohelp'
   > EOF
   $ echo '[extensions]' >> $HGRCPATH
   $ echo "helpext = `pwd`/helpext.py" >> $HGRCPATH
 
 Test command with no help text
 
   $ hg help nohelp
   hg nohelp
   
   (no help text available)
   
   use "hg -v help nohelp" to show the global options
 
   $ hg help -k nohelp
   Commands:
   
    nohelp hg nohelp
   
   Extension Commands:
   
    nohelp (no help text available)
 
 Test that default list of commands omits extension commands
 
   $ hg help
   Mercurial Distributed SCM
   
   list of commands:
   
    add           add the specified files on the next commit
    addremove     add all new files, delete all missing files
    annotate      show changeset information by line for each file
    archive       create an unversioned archive of a repository revision
    backout       reverse effect of earlier changeset
    bisect        subdivision search of changesets
    bookmarks     track a line of development with movable markers
    branch        set or show the current branch name
    branches      list repository named branches
    bundle        create a changegroup file
    cat           output the current or given revision of files
    clone         make a copy of an existing repository
    commit        commit the specified files or all outstanding changes
    copy          mark files as copied for the next commit
    diff          diff repository (or selected files)
    export        dump the header and diffs for one or more changesets
    forget        forget the specified files on the next commit
    graft         copy changes from other branches onto the current branch
    grep          search for a pattern in specified files and revisions
    heads         show branch heads
    help          show help for a given topic or a help overview
    identify      identify the working copy or specified revision
    import        import an ordered set of patches
    incoming      show new changesets found in source
    init          create a new repository in the given directory
    locate        locate files matching specific patterns
    log           show revision history of entire repository or files
    manifest      output the current or given revision of the project manifest
    merge         merge working directory with another revision
    outgoing      show changesets not found in the destination
    parents       show the parents of the working directory or revision
    paths         show aliases for remote repositories
    phase         set or show the current phase name
    pull          pull changes from the specified source
    push          push changes to the specified destination
    recover       roll back an interrupted transaction
    remove        remove the specified files on the next commit
    rename        rename files; equivalent of copy + remove
    resolve       redo merges or set/view the merge status of files
    revert        restore files to their checkout state
    root          print the root (top) of the current working directory
    serve         start stand-alone webserver
    showconfig    show combined config settings from all hgrc files
    status        show changed files in the working directory
    summary       summarize working directory state
    tag           add one or more tags for the current or given revision
    tags          list repository tags
    unbundle      apply one or more changegroup files
    update        update working directory (or switch revisions)
    verify        verify the integrity of the repository
    version       output version and copyright information
   
   enabled extensions:
   
    helpext       (no help text available)
   
   additional help topics:
   
    config        Configuration Files
    dates         Date Formats
    diffs         Diff Formats
    environment   Environment Variables
    extensions    Using Additional Features
    filesets      Specifying File Sets
    glossary      Glossary
    hgignore      Syntax for Mercurial Ignore Files
    hgweb         Configuring hgweb
    merge-tools   Merge Tools
    multirevs     Specifying Multiple Revisions
    patterns      File Name Patterns
    phases        Working with Phases
    revisions     Specifying Single Revisions
    revsets       Specifying Revision Sets
    subrepos      Subrepositories
    templating    Template Usage
    urls          URL Paths
   
   use "hg -v help" to show builtin aliases and global options
 
 
 
 Test list of commands with command with no help text
 
   $ hg help helpext
   helpext extension - no help text available
   
   list of commands:
   
    nohelp        (no help text available)
   
   use "hg -v help helpext" to show builtin aliases and global options
 
 Test a help topic
 
   $ hg help revs
   Specifying Single Revisions
   """""""""""""""""""""""""""
   
       Mercurial supports several ways to specify individual revisions.
   
       A plain integer is treated as a revision number. Negative integers are
       treated as sequential offsets from the tip, with -1 denoting the tip, -2
       denoting the revision prior to the tip, and so forth.
   
       A 40-digit hexadecimal string is treated as a unique revision identifier.
   
       A hexadecimal string less than 40 characters long is treated as a unique
       revision identifier and is referred to as a short-form identifier. A
       short-form identifier is only valid if it is the prefix of exactly one
       full-length identifier.
   
       Any other string is treated as a bookmark, tag, or branch name. A bookmark
       is a movable pointer to a revision. A tag is a permanent name associated
       with a revision. A branch name denotes the tipmost revision of that
       branch. Bookmark, tag, and branch names must not contain the ":"
       character.
   
       The reserved name "tip" always identifies the most recent revision.
   
       The reserved name "null" indicates the null revision. This is the revision
       of an empty repository, and the parent of revision 0.
   
       The reserved name "." indicates the working directory parent. If no
       working directory is checked out, it is equivalent to null. If an
       uncommitted merge is in progress, "." is the revision of the first parent.
 
 Test templating help
 
   $ hg help templating | egrep '(desc|diffstat|firstline|nonempty)  '
       desc          String. The text of the changeset description.
       diffstat      String. Statistics of changes with the following format:
       firstline     Any text. Returns the first line of text.
       nonempty      Any text. Returns '(none)' if the string is empty.
 
 Test help hooks
 
   $ cat > helphook1.py <<EOF
   > from mercurial import help
   > 
   > def rewrite(topic, doc):
   >     return doc + '\nhelphook1\n'
   > 
   > def extsetup(ui):
   >     help.addtopichook('revsets', rewrite)
   > EOF
   $ cat > helphook2.py <<EOF
   > from mercurial import help
   > 
   > def rewrite(topic, doc):
   >     return doc + '\nhelphook2\n'
   > 
   > def extsetup(ui):
   >     help.addtopichook('revsets', rewrite)
   > EOF
   $ echo '[extensions]' >> $HGRCPATH
   $ echo "helphook1 = `pwd`/helphook1.py" >> $HGRCPATH
   $ echo "helphook2 = `pwd`/helphook2.py" >> $HGRCPATH
   $ hg help revsets | grep helphook
       helphook1
       helphook2
 
 Test keyword search help
 
+  $ cat > prefixedname.py <<EOF
+  > '''matched against word "clone"
+  > '''
+  > EOF
+  $ echo '[extensions]' >> $HGRCPATH
+  $ echo "dot.dot.prefixedname = `pwd`/prefixedname.py" >> $HGRCPATH
   $ hg help -k clone
   Topics:
   
    config     Configuration Files
    extensions Using Additional Features
    glossary   Glossary
    phases     Working with Phases
    subrepos   Subrepositories
    urls       URL Paths
   
   Commands:
   
    bookmarks track a line of development with movable markers
    clone     make a copy of an existing repository
    paths     show aliases for remote repositories
    update    update working directory (or switch revisions)
   
   Extensions:
   
+   prefixedname matched against word "clone"
    relink recreates hardlinks between repository clones
   
   Extension Commands:
   
    qclone clone main and patch repository at same time
 
 Test omit indicating for help
 
   $ cat > addverboseitems.py <<EOF
   > '''extension to test omit indicating.
   > 
   > This paragraph is never omitted (for extension)
   > 
   > .. container:: verbose
   > 
   >   This paragraph is omitted,
   >   if :hg:\`help\` is invoked witout \`\`-v\`\` (for extension)
   > 
   > This paragraph is never omitted, too (for extension)
   > '''
   > 
   > from mercurial import help, commands
   > testtopic = """This paragraph is never omitted (for topic).
   > 
   > .. container:: verbose
   > 
   >   This paragraph is omitted,
   >   if :hg:\`help\` is invoked witout \`\`-v\`\` (for topic)
   > 
   > This paragraph is never omitted, too (for topic)
   > """
   > def extsetup(ui):
   >     help.helptable.append((["topic-containing-verbose"],
   >                            "This is the topic to test omit indicating.",
   >                            lambda : testtopic))
   > EOF
   $ echo '[extensions]' >> $HGRCPATH
   $ echo "addverboseitems = `pwd`/addverboseitems.py" >> $HGRCPATH
   $ hg help addverboseitems
   addverboseitems extension - extension to test omit indicating.
   
   This paragraph is never omitted (for extension)
   
   This paragraph is never omitted, too (for extension)
   
   use "hg help -v addverboseitems" to show more complete help
   
   no commands defined
   $ hg help -v addverboseitems
   addverboseitems extension - extension to test omit indicating.
   
   This paragraph is never omitted (for extension)
   
   This paragraph is omitted, if "hg help" is invoked witout "-v" (for extension)
   
   This paragraph is never omitted, too (for extension)
   
   no commands defined
   $ hg help topic-containing-verbose
   This is the topic to test omit indicating.
   """"""""""""""""""""""""""""""""""""""""""
   
       This paragraph is never omitted (for topic).
   
       This paragraph is never omitted, too (for topic)
   
   use "hg help -v topic-containing-verbose" to show more complete help
   $ hg help -v topic-containing-verbose
   This is the topic to test omit indicating.
   """"""""""""""""""""""""""""""""""""""""""
   
       This paragraph is never omitted (for topic).
   
       This paragraph is omitted, if "hg help" is invoked witout "-v" (for topic)
   
       This paragraph is never omitted, too (for topic)
 
 Test usage of section marks in help documents
 
   $ cd "$TESTDIR"/../doc
   $ python check-seclevel.py
   $ cd $TESTTMP
 
 #if serve
 
 Test the help pages in hgweb.
 
 Dish up an empty repo; serve it cold.
 
   $ hg init "$TESTTMP/test"
   $ hg serve -R "$TESTTMP/test" -n test -p $HGPORT -d --pid-file=hg.pid
   $ cat hg.pid >> $DAEMON_PIDS
 
   $ "$TESTDIR/get-with-headers.py" 127.0.0.1:$HGPORT "help"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: Index</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="http://mercurial.selenic.com/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
   <li class="active">help</li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" /></p>
   <div id="hint">find changesets by author, revision,
   files, or words in the commit message</div>
   </form>
   <table class="bigtable">
   <tr><td colspan="2"><h2><a name="main" href="#topics">Topics</a></h2></td></tr>
   
   <tr><td>
   <a href="/help/config">
   config
   </a>
   </td><td>
   Configuration Files
   </td></tr>
   <tr><td>
   <a href="/help/dates">
   dates
   </a>
   </td><td>
   Date Formats
   </td></tr>
   <tr><td>
   <a href="/help/diffs">
   diffs
   </a>
   </td><td>
   Diff Formats
   </td></tr>
   <tr><td>
   <a href="/help/environment">
   environment
   </a>
   </td><td>
   Environment Variables
   </td></tr>
   <tr><td>
   <a href="/help/extensions">
   extensions
   </a>
   </td><td>
   Using Additional Features
   </td></tr>
   <tr><td>
   <a href="/help/filesets">
   filesets
   </a>
   </td><td>
   Specifying File Sets
   </td></tr>
   <tr><td>
   <a href="/help/glossary">
   glossary
   </a>
   </td><td>
   Glossary
   </td></tr>
   <tr><td>
   <a href="/help/hgignore">
   hgignore
   </a>
   </td><td>
   Syntax for Mercurial Ignore Files
   </td></tr>
   <tr><td>
   <a href="/help/hgweb">
   hgweb
   </a>
   </td><td>
   Configuring hgweb
   </td></tr>
   <tr><td>
   <a href="/help/merge-tools">
   merge-tools
   </a>
   </td><td>
   Merge Tools
   </td></tr>
   <tr><td>
   <a href="/help/multirevs">
   multirevs
   </a>
   </td><td>
   Specifying Multiple Revisions
   </td></tr>
   <tr><td>
   <a href="/help/patterns">
   patterns
   </a>
   </td><td>
   File Name Patterns
   </td></tr>
   <tr><td>
   <a href="/help/phases">
   phases
   </a>
   </td><td>
   Working with Phases
   </td></tr>
   <tr><td>
   <a href="/help/revisions">
   revisions
   </a>
   </td><td>
   Specifying Single Revisions
   </td></tr>
   <tr><td>
   <a href="/help/revsets">
   revsets
   </a>
   </td><td>
   Specifying Revision Sets
   </td></tr>
   <tr><td>
   <a href="/help/subrepos">
   subrepos
   </a>
   </td><td>
   Subrepositories
   </td></tr>
   <tr><td>
   <a href="/help/templating">
   templating
   </a>
   </td><td>
   Template Usage
   </td></tr>
   <tr><td>
   <a href="/help/urls">
   urls
   </a>
   </td><td>
   URL Paths
   </td></tr>
   <tr><td>
   <a href="/help/topic-containing-verbose">
   topic-containing-verbose
   </a>
   </td><td>
   This is the topic to test omit indicating.
   </td></tr>
   
   <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
   
   <tr><td>
   <a href="/help/add">
   add
   </a>
   </td><td>
   add the specified files on the next commit
   </td></tr>
   <tr><td>
   <a href="/help/annotate">
   annotate
   </a>
   </td><td>
   show changeset information by line for each file
   </td></tr>
   <tr><td>
   <a href="/help/clone">
   clone
   </a>
   </td><td>
   make a copy of an existing repository
   </td></tr>
   <tr><td>
   <a href="/help/commit">
   commit
   </a>
   </td><td>
   commit the specified files or all outstanding changes
   </td></tr>
   <tr><td>
   <a href="/help/diff">
   diff
   </a>
   </td><td>
   diff repository (or selected files)
   </td></tr>
   <tr><td>
   <a href="/help/export">
   export
   </a>
   </td><td>
   dump the header and diffs for one or more changesets
   </td></tr>
   <tr><td>
   <a href="/help/forget">
   forget
   </a>
   </td><td>
   forget the specified files on the next commit
   </td></tr>
   <tr><td>
   <a href="/help/init">
   init
   </a>
   </td><td>
   create a new repository in the given directory
   </td></tr>
   <tr><td>
   <a href="/help/log">
   log
   </a>
   </td><td>
   show revision history of entire repository or files
   </td></tr>
   <tr><td>
   <a href="/help/merge">
   merge
   </a>
   </td><td>
   merge working directory with another revision
   </td></tr>
   <tr><td>
   <a href="/help/pull">
   pull
   </a>
   </td><td>
   pull changes from the specified source
   </td></tr>
   <tr><td>
   <a href="/help/push">
   push
   </a>
   </td><td>
   push changes to the specified destination
   </td></tr>
   <tr><td>
   <a href="/help/remove">
   remove
   </a>
   </td><td>
   remove the specified files on the next commit
   </td></tr>
   <tr><td>
   <a href="/help/serve">
   serve
   </a>
   </td><td>
   start stand-alone webserver
   </td></tr>
   <tr><td>
   <a href="/help/status">
   status
   </a>
   </td><td>
   show changed files in the working directory
   </td></tr>
   <tr><td>
   <a href="/help/summary">
   summary
   </a>
   </td><td>
   summarize working directory state
   </td></tr>
   <tr><td>
   <a href="/help/update">
   update
   </a>
   </td><td>
   update working directory (or switch revisions)
   </td></tr>
   
   <tr><td colspan="2"><h2><a name="other" href="#other">Other Commands</a></h2></td></tr>
   
   <tr><td>
   <a href="/help/addremove">
   addremove
   </a>
   </td><td>
   add all new files, delete all missing files
   </td></tr>
   <tr><td>
   <a href="/help/archive">
   archive
   </a>
   </td><td>
   create an unversioned archive of a repository revision
   </td></tr>
   <tr><td>
   <a href="/help/backout">
   backout
   </a>
   </td><td>
   reverse effect of earlier changeset
   </td></tr>
   <tr><td>
   <a href="/help/bisect">
   bisect
   </a>
   </td><td>
   subdivision search of changesets
   </td></tr>
   <tr><td>
   <a href="/help/bookmarks">
   bookmarks
   </a>
   </td><td>
   track a line of development with movable markers
   </td></tr>
   <tr><td>
   <a href="/help/branch">
   branch
   </a>
   </td><td>
   set or show the current branch name
   </td></tr>
   <tr><td>
   <a href="/help/branches">
   branches
   </a>
   </td><td>
   list repository named branches
   </td></tr>
   <tr><td>
   <a href="/help/bundle">
   bundle
   </a>
   </td><td>
   create a changegroup file
   </td></tr>
   <tr><td>
   <a href="/help/cat">
   cat
   </a>
   </td><td>
   output the current or given revision of files
   </td></tr>
   <tr><td>
   <a href="/help/copy">
   copy
   </a>
   </td><td>
   mark files as copied for the next commit
   </td></tr>
   <tr><td>
   <a href="/help/graft">
   graft
   </a>
   </td><td>
   copy changes from other branches onto the current branch
   </td></tr>
   <tr><td>
   <a href="/help/grep">
   grep
   </a>
   </td><td>
   search for a pattern in specified files and revisions
   </td></tr>
   <tr><td>
   <a href="/help/heads">
   heads
   </a>
   </td><td>
   show branch heads
   </td></tr>
   <tr><td>
   <a href="/help/help">
   help
   </a>
   </td><td>
   show help for a given topic or a help overview
   </td></tr>
   <tr><td>
   <a href="/help/identify">
   identify
   </a>
   </td><td>
   identify the working copy or specified revision
   </td></tr>
   <tr><td>
   <a href="/help/import">
   import
   </a>
   </td><td>
   import an ordered set of patches
   </td></tr>
   <tr><td>
   <a href="/help/incoming">
   incoming
   </a>
   </td><td>
   show new changesets found in source
   </td></tr>
   <tr><td>
   <a href="/help/locate">
   locate
   </a>
   </td><td>
   locate files matching specific patterns
   </td></tr>
   <tr><td>
   <a href="/help/manifest">
   manifest
   </a>
   </td><td>
   output the current or given revision of the project manifest
   </td></tr>
   <tr><td>
   <a href="/help/nohelp">
   nohelp
   </a>
   </td><td>
   (no help text available)
   </td></tr>
   <tr><td>
   <a href="/help/outgoing">
   outgoing
   </a>
   </td><td>
   show changesets not found in the destination
   </td></tr>
   <tr><td>
   <a href="/help/parents">
   parents
   </a>
   </td><td>
   show the parents of the working directory or revision
   </td></tr>
   <tr><td>
   <a href="/help/paths">
   paths
   </a>
   </td><td>
   show aliases for remote repositories
   </td></tr>
   <tr><td>
   <a href="/help/phase">
   phase
   </a>
   </td><td>
   set or show the current phase name
   </td></tr>
   <tr><td>
   <a href="/help/recover">
   recover
   </a>
   </td><td>
   roll back an interrupted transaction
   </td></tr>
   <tr><td>
   <a href="/help/rename">
   rename
   </a>
   </td><td>
   rename files; equivalent of copy + remove
   </td></tr>
   <tr><td>
   <a href="/help/resolve">
   resolve
   </a>
   </td><td>
   redo merges or set/view the merge status of files
   </td></tr>
   <tr><td>
   <a href="/help/revert">
   revert
   </a>
   </td><td>
   restore files to their checkout state
   </td></tr>
   <tr><td>
   <a href="/help/root">
   root
   </a>
   </td><td>
   print the root (top) of the current working directory
   </td></tr>
   <tr><td>
   <a href="/help/showconfig">
   showconfig
   </a>
   </td><td>
   show combined config settings from all hgrc files
   </td></tr>
   <tr><td>
   <a href="/help/tag">
   tag
   </a>
   </td><td>
   add one or more tags for the current or given revision
   </td></tr>
   <tr><td>
   <a href="/help/tags">
   tags
   </a>
   </td><td>
   list repository tags
   </td></tr>
   <tr><td>
   <a href="/help/unbundle">
   unbundle
   </a>
   </td><td>
   apply one or more changegroup files
   </td></tr>
   <tr><td>
   <a href="/help/verify">
   verify
   </a>
   </td><td>
   verify the integrity of the repository
   </td></tr>
   <tr><td>
   <a href="/help/version">
   version
   </a>
   </td><td>
   output version and copyright information
   </td></tr>
   </table>
   </div>
   </div>
   
   <script type="text/javascript">process_dates()</script>
   
   
   </body>
   </html>
   
 
   $ "$TESTDIR/get-with-headers.py" 127.0.0.1:$HGPORT "help/add"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: add</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="http://mercurial.selenic.com/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
    <li class="active"><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <h3>Help: add</h3>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" /></p>
   <div id="hint">find changesets by author, revision,
   files, or words in the commit message</div>
   </form>
   <div id="doc">
   <p>
   hg add [OPTION]... [FILE]...
   </p>
   <p>
   add the specified files on the next commit
   </p>
   <p>
   Schedule files to be version controlled and added to the
   repository.
   </p>
   <p>
   The files will be added to the repository at the next commit. To
   undo an add before that, see &quot;hg forget&quot;.
   </p>
   <p>
   If no names are given, add all files to the repository.
   </p>
   <p>
   An example showing how new (unknown) files are added
   automatically by &quot;hg add&quot;:
   </p>
   <pre>
   \$ ls (re)
   foo.c
   \$ hg status (re)
   ? foo.c
   \$ hg add (re)
   adding foo.c
   \$ hg status (re)
   A foo.c
   </pre>
   <p>
   Returns 0 if all files are successfully added.
   </p>
   <p>
   options:
   </p>
   <table>
   <tr><td>-I</td>
   <td>--include PATTERN [+]</td>
   <td>include names matching the given patterns</td></tr>
   <tr><td>-X</td>
   <td>--exclude PATTERN [+]</td>
   <td>exclude names matching the given patterns</td></tr>
   <tr><td>-S</td>
   <td>--subrepos</td>
   <td>recurse into subrepositories</td></tr>
   <tr><td>-n</td>
   <td>--dry-run</td>
   <td>do not perform actions, just print output</td></tr>
   </table>
   <p>
   [+] marked option can be specified multiple times
   </p>
   <p>
   global options:
   </p>
   <table>
   <tr><td>-R</td>
   <td>--repository REPO</td>
   <td>repository root directory or name of overlay bundle file</td></tr>
   <tr><td></td>
   <td>--cwd DIR</td>
   <td>change working directory</td></tr>
   <tr><td>-y</td>
   <td>--noninteractive</td>
   <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
   <tr><td>-q</td>
   <td>--quiet</td>
   <td>suppress output</td></tr>
   <tr><td>-v</td>
   <td>--verbose</td>
   <td>enable additional output</td></tr>
   <tr><td></td>
   <td>--config CONFIG [+]</td>
   <td>set/override config option (use 'section.name=value')</td></tr>
   <tr><td></td>
   <td>--debug</td>
   <td>enable debugging output</td></tr>
   <tr><td></td>
   <td>--debugger</td>
   <td>start debugger</td></tr>
   <tr><td></td>
   <td>--encoding ENCODE</td>
   <td>set the charset encoding (default: ascii)</td></tr>
   <tr><td></td>
   <td>--encodingmode MODE</td>
   <td>set the charset encoding mode (default: strict)</td></tr>
   <tr><td></td>
   <td>--traceback</td>
   <td>always print a traceback on exception</td></tr>
   <tr><td></td>
   <td>--time</td>
   <td>time how long the command takes</td></tr>
   <tr><td></td>
   <td>--profile</td>
   <td>print command execution profile</td></tr>
   <tr><td></td>
   <td>--version</td>
   <td>output version information and exit</td></tr>
   <tr><td>-h</td>
   <td>--help</td>
   <td>display help and exit</td></tr>
   <tr><td></td>
   <td>--hidden</td>
   <td>consider hidden changesets</td></tr>
   </table>
   <p>
   [+] marked option can be specified multiple times
   </p>
   
   </div>
   </div>
   </div>
   
   <script type="text/javascript">process_dates()</script>
   
   
   </body>
   </html>
   
 
   $ "$TESTDIR/get-with-headers.py" 127.0.0.1:$HGPORT "help/remove"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: remove</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="http://mercurial.selenic.com/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
    <li class="active"><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <h3>Help: remove</h3>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" /></p>
   <div id="hint">find changesets by author, revision,
   files, or words in the commit message</div>
   </form>
   <div id="doc">
   <p>
   hg remove [OPTION]... FILE...
   </p>
   <p>
   aliases: rm
   </p>
   <p>
   remove the specified files on the next commit
   </p>
   <p>
   Schedule the indicated files for removal from the current branch.
   </p>
   <p>
   This command schedules the files to be removed at the next commit.
   To undo a remove before that, see &quot;hg revert&quot;. To undo added
   files, see &quot;hg forget&quot;.
   </p>
   <p>
   -A/--after can be used to remove only files that have already
   been deleted, -f/--force can be used to force deletion, and -Af
   can be used to remove files from the next revision without
   deleting them from the working directory.
   </p>
   <p>
   The following table details the behavior of remove for different
   file states (columns) and option combinations (rows). The file
   states are Added [A], Clean [C], Modified [M] and Missing [!]
   (as reported by &quot;hg status&quot;). The actions are Warn, Remove
   (from branch) and Delete (from disk):
   </p>
   <table>
   <tr><td></td>
   <td>A</td>
   <td>C</td>
   <td>M</td>
   <td>!</td></tr>
   <tr><td>none</td>
   <td>W</td>
   <td>RD</td>
   <td>W</td>
   <td>R</td></tr>
   <tr><td>-f</td>
   <td>R</td>
   <td>RD</td>
   <td>RD</td>
   <td>R</td></tr>
   <tr><td>-A</td>
   <td>W</td>
   <td>W</td>
   <td>W</td>
   <td>R</td></tr>
   <tr><td>-Af</td>
   <td>R</td>
   <td>R</td>
   <td>R</td>
   <td>R</td></tr>
   </table>
   <p>
   Note that remove never deletes files in Added [A] state from the
   working directory, not even if option --force is specified.
   </p>
   <p>
   Returns 0 on success, 1 if any warnings encountered.
   </p>
   <p>
   options:
   </p>
   <table>
   <tr><td>-A</td>
   <td>--after</td>
   <td>record delete for missing files</td></tr>
   <tr><td>-f</td>
   <td>--force</td>
   <td>remove (and delete) file even if added or modified</td></tr>
   <tr><td>-I</td>
   <td>--include PATTERN [+]</td>
   <td>include names matching the given patterns</td></tr>
   <tr><td>-X</td>
   <td>--exclude PATTERN [+]</td>
   <td>exclude names matching the given patterns</td></tr>
   </table>
   <p>
   [+] marked option can be specified multiple times
   </p>
   <p>
   global options:
   </p>
   <table>
   <tr><td>-R</td>
   <td>--repository REPO</td>
   <td>repository root directory or name of overlay bundle file</td></tr>
   <tr><td></td>
   <td>--cwd DIR</td>
   <td>change working directory</td></tr>
   <tr><td>-y</td>
   <td>--noninteractive</td>
   <td>do not prompt, automatically pick the first choice for all prompts</td></tr>
   <tr><td>-q</td>
   <td>--quiet</td>
   <td>suppress output</td></tr>
   <tr><td>-v</td>
   <td>--verbose</td>
   <td>enable additional output</td></tr>
   <tr><td></td>
   <td>--config CONFIG [+]</td>
   <td>set/override config option (use 'section.name=value')</td></tr>
   <tr><td></td>
   <td>--debug</td>
   <td>enable debugging output</td></tr>
   <tr><td></td>
   <td>--debugger</td>
   <td>start debugger</td></tr>
   <tr><td></td>
   <td>--encoding ENCODE</td>
   <td>set the charset encoding (default: ascii)</td></tr>
   <tr><td></td>
   <td>--encodingmode MODE</td>
   <td>set the charset encoding mode (default: strict)</td></tr>
   <tr><td></td>
   <td>--traceback</td>
   <td>always print a traceback on exception</td></tr>
   <tr><td></td>
   <td>--time</td>
   <td>time how long the command takes</td></tr>
   <tr><td></td>
   <td>--profile</td>
   <td>print command execution profile</td></tr>
   <tr><td></td>
   <td>--version</td>
   <td>output version information and exit</td></tr>
   <tr><td>-h</td>
   <td>--help</td>
   <td>display help and exit</td></tr>
   <tr><td></td>
   <td>--hidden</td>
   <td>consider hidden changesets</td></tr>
   </table>
   <p>
   [+] marked option can be specified multiple times
   </p>
   
   </div>
   </div>
   </div>
   
   <script type="text/javascript">process_dates()</script>
   
   
   </body>
   </html>
   
 
   $ "$TESTDIR/get-with-headers.py" 127.0.0.1:$HGPORT "help/revisions"
   200 Script output follows
   
   <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
   <head>
   <link rel="icon" href="/static/hgicon.png" type="image/png" />
   <meta name="robots" content="index, nofollow" />
   <link rel="stylesheet" href="/static/style-paper.css" type="text/css" />
   <script type="text/javascript" src="/static/mercurial.js"></script>
   
   <title>Help: revisions</title>
   </head>
   <body>
   
   <div class="container">
   <div class="menu">
   <div class="logo">
   <a href="http://mercurial.selenic.com/">
   <img src="/static/hglogo.png" alt="mercurial" /></a>
   </div>
   <ul>
   <li><a href="/shortlog">log</a></li>
   <li><a href="/graph">graph</a></li>
   <li><a href="/tags">tags</a></li>
   <li><a href="/bookmarks">bookmarks</a></li>
   <li><a href="/branches">branches</a></li>
   </ul>
   <ul>
    <li class="active"><a href="/help">help</a></li>
   </ul>
   </div>
   
   <div class="main">
   <h2 class="breadcrumb"><a href="/">Mercurial</a> </h2>
   <h3>Help: revisions</h3>
   
   <form class="search" action="/log">
   
   <p><input name="rev" id="search1" type="text" size="30" /></p>
   <div id="hint">find changesets by author, revision,
   files, or words in the commit message</div>
   </form>
   <div id="doc">
   <h1>Specifying Single Revisions</h1>
   <p>
   Mercurial supports several ways to specify individual revisions.
   </p>
   <p>
   A plain integer is treated as a revision number. Negative integers are
   treated as sequential offsets from the tip, with -1 denoting the tip,
   -2 denoting the revision prior to the tip, and so forth.
   </p>
   <p>
   A 40-digit hexadecimal string is treated as a unique revision
   identifier.
   </p>
   <p>
   A hexadecimal string less than 40 characters long is treated as a
   unique revision identifier and is referred to as a short-form
   identifier. A short-form identifier is only valid if it is the prefix
   of exactly one full-length identifier.
   </p>
   <p>
   Any other string is treated as a bookmark, tag, or branch name. A
   bookmark is a movable pointer to a revision. A tag is a permanent name
   associated with a revision. A branch name denotes the tipmost revision
   of that branch. Bookmark, tag, and branch names must not contain the &quot;:&quot;
   character.
   </p>
   <p>
   The reserved name &quot;tip&quot; always identifies the most recent revision.
   </p>
   <p>
   The reserved name &quot;null&quot; indicates the null revision. This is the
   revision of an empty repository, and the parent of revision 0.
   </p>
   <p>
   The reserved name &quot;.&quot; indicates the working directory parent. If no
   working directory is checked out, it is equivalent to null. If an
   uncommitted merge is in progress, &quot;.&quot; is the revision of the first
   parent.
   </p>
   
   </div>
   </div>
   </div>
   
   <script type="text/javascript">process_dates()</script>
   
   
   </body>
   </html>
   
 
   $ "$TESTDIR/killdaemons.py" $DAEMON_PIDS
 
 #endif