help.py
656 lines
| 22.9 KiB
| text/x-python
|
PythonLexer
/ mercurial / help.py
Matt Mackall
|
r3795 | # help.py - help data for mercurial | ||
# | ||||
# Copyright 2006 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
Martin Geisler
|
r8225 | # This software may be used and distributed according to the terms of the | ||
Matt Mackall
|
r10263 | # GNU General Public License version 2 or any later version. | ||
Matt Mackall
|
r3795 | |||
Gregory Szorc
|
r27479 | from __future__ import absolute_import | ||
import itertools | ||||
import os | ||||
import textwrap | ||||
from .i18n import ( | ||||
_, | ||||
gettext, | ||||
) | ||||
from . import ( | ||||
cmdutil, | ||||
encoding, | ||||
error, | ||||
extensions, | ||||
filemerge, | ||||
fileset, | ||||
minirst, | ||||
revset, | ||||
templatefilters, | ||||
templatekw, | ||||
templater, | ||||
util, | ||||
) | ||||
from .hgweb import ( | ||||
webcommands, | ||||
) | ||||
Cédric Duval
|
r8863 | |||
Jun Wu
|
r31080 | _exclkeywords = set([ | ||
"(ADVANCED)", | ||||
Yuya Nishihara
|
r26370 | "(DEPRECATED)", | ||
"(EXPERIMENTAL)", | ||||
Jun Wu
|
r31080 | # i18n: "(ADVANCED)" is a keyword, must be translated consistently | ||
_("(ADVANCED)"), | ||||
Yuya Nishihara
|
r26370 | # i18n: "(DEPRECATED)" is a keyword, must be translated consistently | ||
_("(DEPRECATED)"), | ||||
# i18n: "(EXPERIMENTAL)" is a keyword, must be translated consistently | ||||
_("(EXPERIMENTAL)"), | ||||
Jun Wu
|
r31080 | ]) | ||
Yuya Nishihara
|
r26369 | |||
Augie Fackler
|
r20582 | def listexts(header, exts, indent=1, showdeprecated=False): | ||
Cédric Duval
|
r8879 | '''return a text listing of the given extensions''' | ||
Olav Reinert
|
r16852 | rst = [] | ||
if exts: | ||||
for name, desc in sorted(exts.iteritems()): | ||||
Yuya Nishihara
|
r26371 | if not showdeprecated and any(w in desc for w in _exclkeywords): | ||
Augie Fackler
|
r20582 | continue | ||
Olav Reinert
|
r16852 | rst.append('%s:%s: %s\n' % (' ' * indent, name, desc)) | ||
timeless
|
r27151 | if rst: | ||
rst.insert(0, '\n%s\n\n' % header) | ||||
Olav Reinert
|
r16852 | return rst | ||
Cédric Duval
|
r8864 | |||
Yuya Nishihara
|
r26413 | def extshelp(ui): | ||
rst = loaddoc('extensions')(ui).splitlines(True) | ||||
Augie Fackler
|
r20582 | rst.extend(listexts( | ||
_('enabled extensions:'), extensions.enabled(), showdeprecated=True)) | ||||
Olav Reinert
|
r16852 | rst.extend(listexts(_('disabled extensions:'), extensions.disabled())) | ||
doc = ''.join(rst) | ||||
Cédric Duval
|
r8863 | return doc | ||
Martin Geisler
|
r7013 | |||
Matt Mackall
|
r22116 | def optrst(header, options, verbose): | ||
Olav Reinert
|
r16781 | 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 | ||||
Yuya Nishihara
|
r26369 | if not verbose and any(w in desc for w in _exclkeywords): | ||
Olav Reinert
|
r16781 | 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)) | ||||
Matt Mackall
|
r22117 | if multioccur: | ||
header += (_(" ([+] can be repeated)")) | ||||
Olav Reinert
|
r16781 | |||
Matt Mackall
|
r22116 | rst = ['\n%s:\n\n' % header] | ||
rst.extend(minirst.maketable(data, 1)) | ||||
Olav Reinert
|
r16781 | |||
Olav Reinert
|
r16815 | return ''.join(rst) | ||
Olav Reinert
|
r16781 | |||
FUJIWARA Katsunori
|
r17837 | 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) | ||||
timeless
|
r27323 | def filtercmd(ui, cmd, kw, doc): | ||
if not ui.debugflag and cmd.startswith("debug") and kw != "debug": | ||||
return True | ||||
if not ui.verbose and doc and any(w in doc for w in _exclkeywords): | ||||
return True | ||||
return False | ||||
Yuya Nishihara
|
r26413 | def topicmatch(ui, kw): | ||
Augie Fackler
|
r16710 | """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): | ||||
Nikolaj Sjujskij
|
r16845 | return kw in encoding.lower(container) # translated in helptable | ||
Augie Fackler
|
r16710 | results = {'topics': [], | ||
'commands': [], | ||||
'extensions': [], | ||||
'extensioncommands': [], | ||||
} | ||||
for names, header, doc in helptable: | ||||
Gregory Szorc
|
r22322 | # Old extensions may use a str as doc. | ||
Augie Fackler
|
r16710 | if (sum(map(lowercontains, names)) | ||
or lowercontains(header) | ||||
Yuya Nishihara
|
r26413 | or (callable(doc) and lowercontains(doc(ui)))): | ||
Augie Fackler
|
r16710 | results['topics'].append((names[0], header)) | ||
Gregory Szorc
|
r27479 | from . import commands # avoid cycle | ||
Augie Fackler
|
r16710 | for cmd, entry in commands.table.iteritems(): | ||
if len(entry) == 3: | ||||
summary = entry[2] | ||||
else: | ||||
summary = '' | ||||
Nikolaj Sjujskij
|
r16845 | # translate docs *before* searching there | ||
docs = _(getattr(entry[0], '__doc__', None)) or '' | ||||
Augie Fackler
|
r16710 | if kw in cmd or lowercontains(summary) or lowercontains(docs): | ||
Nikolaj Sjujskij
|
r16845 | doclines = docs.splitlines() | ||
Augie Fackler
|
r16710 | if doclines: | ||
summary = doclines[0] | ||||
r26845 | cmdname = cmd.partition('|')[0].lstrip('^') | |||
timeless
|
r27324 | if filtercmd(ui, cmdname, kw, docs): | ||
continue | ||||
Augie Fackler
|
r16710 | results['commands'].append((cmdname, summary)) | ||
for name, docs in itertools.chain( | ||||
FUJIWARA Katsunori
|
r19769 | extensions.enabled(False).iteritems(), | ||
Augie Fackler
|
r16710 | extensions.disabled().iteritems()): | ||
Simon Farnsworth
|
r28058 | if not docs: | ||
continue | ||||
Jun Wu
|
r27660 | mod = extensions.load(ui, name, '') | ||
r26845 | name = name.rpartition('.')[-1] | |||
Augie Fackler
|
r16710 | if lowercontains(name) or lowercontains(docs): | ||
Nikolaj Sjujskij
|
r16845 | # extension docs are already translated | ||
results['extensions'].append((name, docs.splitlines()[0])) | ||||
Augie Fackler
|
r16710 | for cmd, entry in getattr(mod, 'cmdtable', {}).iteritems(): | ||
Augie Fackler
|
r16711 | if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])): | ||
r26845 | cmdname = cmd.partition('|')[0].lstrip('^') | |||
Olav Reinert
|
r16942 | if entry[0].__doc__: | ||
cmddoc = gettext(entry[0].__doc__).splitlines()[0] | ||||
Thomas Arendsen Hein
|
r16884 | else: | ||
cmddoc = _('(no help text available)') | ||||
timeless
|
r27387 | if filtercmd(ui, cmdname, kw, cmddoc): | ||
continue | ||||
Thomas Arendsen Hein
|
r16884 | results['extensioncommands'].append((cmdname, cmddoc)) | ||
Augie Fackler
|
r16710 | return results | ||
Gregory Szorc
|
r27375 | def loaddoc(topic, subdir=None): | ||
Martin Geisler
|
r9539 | """Return a delayed loader for help/topic.txt.""" | ||
Matt Mackall
|
r3798 | |||
Yuya Nishihara
|
r26413 | def loader(ui): | ||
Mads Kiilerich
|
r22637 | docdir = os.path.join(util.datapath, 'help') | ||
Gregory Szorc
|
r27375 | if subdir: | ||
docdir = os.path.join(docdir, subdir) | ||||
Martin Geisler
|
r9539 | path = os.path.join(docdir, topic + ".txt") | ||
Dan Villiom Podlaski Christiansen
|
r14168 | doc = gettext(util.readfile(path)) | ||
Patrick Mezard
|
r12820 | for rewriter in helphooks.get(topic, []): | ||
Yuya Nishihara
|
r26414 | doc = rewriter(ui, topic, doc) | ||
Patrick Mezard
|
r12820 | return doc | ||
Martin Geisler
|
r9539 | return loader | ||
Alexander Solovyov
|
r7677 | |||
Gregory Szorc
|
r27376 | internalstable = sorted([ | ||
Gregory Szorc
|
r29747 | (['bundles'], _('Bundles'), | ||
Gregory Szorc
|
r27376 | loaddoc('bundles', subdir='internals')), | ||
Gregory Szorc
|
r29747 | (['changegroups'], _('Changegroups'), | ||
Gregory Szorc
|
r27376 | loaddoc('changegroups', subdir='internals')), | ||
Gregory Szorc
|
r29747 | (['requirements'], _('Repository Requirements'), | ||
Gregory Szorc
|
r28523 | loaddoc('requirements', subdir='internals')), | ||
Gregory Szorc
|
r29747 | (['revlogs'], _('Revision Logs'), | ||
Gregory Szorc
|
r27631 | loaddoc('revlogs', subdir='internals')), | ||
Gregory Szorc
|
r29859 | (['wireprotocol'], _('Wire Protocol'), | ||
loaddoc('wireprotocol', subdir='internals')), | ||||
Gregory Szorc
|
r27376 | ]) | ||
def internalshelp(ui): | ||||
"""Generate the index for the "internals" topic.""" | ||||
lines = [] | ||||
for names, header, doc in internalstable: | ||||
Yuya Nishihara
|
r27400 | lines.append(' :%s: %s\n' % (names[0], header)) | ||
Gregory Szorc
|
r27376 | |||
Yuya Nishihara
|
r27400 | return ''.join(lines) | ||
Gregory Szorc
|
r27376 | |||
Yun Lee
|
r13888 | helptable = sorted([ | ||
Pierre-Yves David
|
r31129 | (['color'], _("Colorizing Outputs"), loaddoc('color')), | ||
Martin Geisler
|
r12145 | (["config", "hgrc"], _("Configuration Files"), loaddoc('config')), | ||
Martin Geisler
|
r9539 | (["dates"], _("Date Formats"), loaddoc('dates')), | ||
(["patterns"], _("File Name Patterns"), loaddoc('patterns')), | ||||
Matt Mackall
|
r10282 | (['environment', 'env'], _('Environment Variables'), | ||
loaddoc('environment')), | ||||
Martin von Zweigbergk
|
r30769 | (['revisions', 'revs', 'revsets', 'revset', 'multirevs', 'mrevs'], | ||
_('Specifying Revisions'), loaddoc('revisions')), | ||||
Mads Kiilerich
|
r17322 | (['filesets', 'fileset'], _("Specifying File Sets"), loaddoc('filesets')), | ||
Martin Geisler
|
r9539 | (['diffs'], _('Diff Formats'), loaddoc('diffs')), | ||
Gregory Szorc
|
r30812 | (['merge-tools', 'mergetools', 'mergetool'], _('Merge Tools'), | ||
loaddoc('merge-tools')), | ||||
A. S. Budden
|
r16568 | (['templating', 'templates', 'template', 'style'], _('Template Usage'), | ||
Matt Mackall
|
r10282 | loaddoc('templates')), | ||
Martin Geisler
|
r9539 | (['urls'], _('URL Paths'), loaddoc('urls')), | ||
Martin Geisler
|
r16547 | (["extensions"], _("Using Additional Features"), extshelp), | ||
Mads Kiilerich
|
r17322 | (["subrepos", "subrepo"], _("Subrepositories"), loaddoc('subrepos')), | ||
Mads Kiilerich
|
r17321 | (["hgweb"], _("Configuring hgweb"), loaddoc('hgweb')), | ||
(["glossary"], _("Glossary"), loaddoc('glossary')), | ||||
(["hgignore", "ignore"], _("Syntax for Mercurial Ignore Files"), | ||||
loaddoc('hgignore')), | ||||
(["phases"], _("Working with Phases"), loaddoc('phases')), | ||||
Gregory Szorc
|
r25881 | (['scripting'], _('Using Mercurial from scripts and automation'), | ||
loaddoc('scripting')), | ||||
Gregory Szorc
|
r27376 | (['internals'], _("Technical implementation topics"), | ||
internalshelp), | ||||
Augie Fackler
|
r31061 | (['pager'], _("Pager Support"), loaddoc('pager')), | ||
Yun Lee
|
r13888 | ]) | ||
Patrick Mezard
|
r12820 | |||
Gregory Szorc
|
r27379 | # Maps topics with sub-topics to a list of their sub-topics. | ||
subtopics = { | ||||
'internals': internalstable, | ||||
} | ||||
Patrick Mezard
|
r12820 | # Map topics to lists of callable taking the current topic help and | ||
# returning the updated version | ||||
Matt Mackall
|
r14318 | helphooks = {} | ||
Patrick Mezard
|
r12820 | |||
def addtopichook(topic, rewriter): | ||||
helphooks.setdefault(topic, []).append(rewriter) | ||||
Patrick Mezard
|
r13593 | |||
Yuya Nishihara
|
r26414 | def makeitemsdoc(ui, topic, doc, marker, items, dedent=False): | ||
Patrick Mezard
|
r13593 | """Extract docstring from the items key to function mapping, build a | ||
timeless@mozdev.org
|
r26196 | single documentation block and use it to overwrite the marker in doc. | ||
Patrick Mezard
|
r13593 | """ | ||
entries = [] | ||||
for name in sorted(items): | ||||
text = (items[name].__doc__ or '').rstrip() | ||||
Yuya Nishihara
|
r26415 | if (not text | ||
or not ui.verbose and any(w in text for w in _exclkeywords)): | ||||
Patrick Mezard
|
r13593 | continue | ||
text = gettext(text) | ||||
Gregory Szorc
|
r24098 | if dedent: | ||
text = textwrap.dedent(text) | ||||
Patrick Mezard
|
r13593 | lines = text.splitlines() | ||
"Yann E. MORIN"
|
r16250 | doclines = [(lines[0])] | ||
for l in lines[1:]: | ||||
# Stop once we find some Python doctest | ||||
if l.strip().startswith('>>>'): | ||||
break | ||||
Gregory Szorc
|
r24098 | if dedent: | ||
doclines.append(l.rstrip()) | ||||
else: | ||||
doclines.append(' ' + l.strip()) | ||||
"Yann E. MORIN"
|
r16250 | entries.append('\n'.join(doclines)) | ||
Patrick Mezard
|
r13593 | entries = '\n\n'.join(entries) | ||
return doc.replace(marker, entries) | ||||
Matt Mackall
|
r14318 | |||
Gregory Szorc
|
r24098 | def addtopicsymbols(topic, marker, symbols, dedent=False): | ||
Yuya Nishihara
|
r26414 | def add(ui, topic, doc): | ||
return makeitemsdoc(ui, topic, doc, marker, symbols, dedent=dedent) | ||||
Matt Mackall
|
r14318 | addtopichook(topic, add) | ||
Matt Mackall
|
r14686 | addtopicsymbols('filesets', '.. predicatesmarker', fileset.symbols) | ||
Gregory Szorc
|
r24099 | addtopicsymbols('merge-tools', '.. internaltoolsmarker', | ||
filemerge.internalsdoc) | ||||
Martin von Zweigbergk
|
r30769 | addtopicsymbols('revisions', '.. predicatesmarker', revset.symbols) | ||
Yuya Nishihara
|
r26436 | addtopicsymbols('templates', '.. keywordsmarker', templatekw.keywords) | ||
Matt Mackall
|
r14318 | addtopicsymbols('templates', '.. filtersmarker', templatefilters.filters) | ||
Gregory Szorc
|
r24587 | addtopicsymbols('templates', '.. functionsmarker', templater.funcs) | ||
Gregory Szorc
|
r24098 | addtopicsymbols('hgweb', '.. webcommandsmarker', webcommands.commands, | ||
dedent=True) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | |||
Gregory Szorc
|
r27377 | def help_(ui, name, unknowncmd=False, full=True, subtopic=None, **opts): | ||
Dan Villiom Podlaski Christiansen
|
r18746 | ''' | ||
Generate the help for 'name' as unformatted restructured text. If | ||||
'name' is None, describe the commands available. | ||||
''' | ||||
Gregory Szorc
|
r27479 | from . import commands # avoid cycle | ||
Dan Villiom Podlaski Christiansen
|
r18746 | |||
Gregory Szorc
|
r27378 | def helpcmd(name, subtopic=None): | ||
Dan Villiom Podlaski Christiansen
|
r18746 | try: | ||
aliases, entry = cmdutil.findcmd(name, commands.table, | ||||
strict=unknowncmd) | ||||
Gregory Szorc
|
r25660 | except error.AmbiguousCommand as inst: | ||
Dan Villiom Podlaski Christiansen
|
r18746 | # 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 | ||||
Yuya Nishihara
|
r22160 | if getattr(entry[0], 'badalias', None): | ||
Yuya Nishihara
|
r22162 | rst.append(entry[0].badalias + '\n') | ||
if entry[0].unknowncmd: | ||||
try: | ||||
rst.extend(helpextcmd(entry[0].cmdname)) | ||||
except error.UnknownCommand: | ||||
pass | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | 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 | ||||
timeless
|
r28828 | source = entry[0].source | ||
Dan Villiom Podlaski Christiansen
|
r18746 | if entry[0].definition.startswith('!'): # shell alias | ||
timeless
|
r28828 | doc = (_('shell alias for::\n\n %s\n\ndefined by: %s\n') % | ||
(entry[0].definition[1:], source)) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | else: | ||
timeless
|
r28828 | doc = (_('alias for: hg %s\n\n%s\n\ndefined by: %s\n') % | ||
(entry[0].definition, doc, source)) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | 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(): | ||||
timeless
|
r29974 | msg = _("(use 'hg help -e %s' to show help for " | ||
"the %s extension)") % (name, name) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | rst.append('\n%s\n' % msg) | ||
except KeyError: | ||||
pass | ||||
# options | ||||
if not ui.quiet and entry[1]: | ||||
Matt Mackall
|
r22116 | rst.append(optrst(_("options"), entry[1], ui.verbose)) | ||
Dan Villiom Podlaski Christiansen
|
r18746 | |||
if ui.verbose: | ||||
Matt Mackall
|
r22116 | rst.append(optrst(_("global options"), | ||
commands.globalopts, ui.verbose)) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | |||
if not ui.verbose: | ||||
if not full: | ||||
timeless
|
r29974 | rst.append(_("\n(use 'hg %s -h' to show more help)\n") | ||
Dan Villiom Podlaski Christiansen
|
r18746 | % name) | ||
elif not ui.quiet: | ||||
Matt Mackall
|
r22110 | rst.append(_('\n(some details hidden, use --verbose ' | ||
'to show complete help)')) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | |||
return rst | ||||
timeless
|
r27325 | def helplist(select=None, **opts): | ||
Dan Villiom Podlaski Christiansen
|
r18746 | # list of commands | ||
if name == "shortlist": | ||||
header = _('basic commands:\n\n') | ||||
Mads Kiilerich
|
r20822 | elif name == "debug": | ||
header = _('debug commands (internal and unsupported):\n\n') | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | else: | ||
header = _('list of commands:\n\n') | ||||
h = {} | ||||
cmds = {} | ||||
for c, e in commands.table.iteritems(): | ||||
r26845 | f = c.partition("|")[0] | |||
Dan Villiom Podlaski Christiansen
|
r18746 | 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("^") | ||||
doc = e[0].__doc__ | ||||
timeless
|
r27323 | if filtercmd(ui, f, name, doc): | ||
Dan Villiom Podlaski Christiansen
|
r18746 | 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])) | ||||
timeless
|
r27325 | ex = opts.get | ||
anyopts = (ex('keyword') or not (ex('command') or ex('extension'))) | ||||
if not name and anyopts: | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | 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)) | ||||
Matt Mackall
|
r22115 | if ui.quiet: | ||
pass | ||||
elif ui.verbose: | ||||
Matt Mackall
|
r22116 | rst.append('\n%s\n' % optrst(_("global options"), | ||
commands.globalopts, ui.verbose)) | ||||
Matt Mackall
|
r22115 | if name == 'shortlist': | ||
timeless
|
r29974 | rst.append(_("\n(use 'hg help' for the full list " | ||
"of commands)\n")) | ||||
Matt Mackall
|
r22115 | else: | ||
if name == 'shortlist': | ||||
timeless
|
r29974 | rst.append(_("\n(use 'hg help' for the full list of commands " | ||
"or 'hg -v' for details)\n")) | ||||
Matt Mackall
|
r22115 | elif name and not full: | ||
timeless
|
r29974 | rst.append(_("\n(use 'hg help %s' to show the full help " | ||
"text)\n") % name) | ||||
Chingis Dugarzhapov
|
r23624 | elif name and cmds and name in cmds.keys(): | ||
timeless
|
r29974 | rst.append(_("\n(use 'hg help -v -e %s' to show built-in " | ||
"aliases and global options)\n") % name) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | else: | ||
timeless
|
r29974 | rst.append(_("\n(use 'hg help -v%s' to show built-in aliases " | ||
"and global options)\n") | ||||
Matt Mackall
|
r22118 | % (name and " " + name or "")) | ||
Dan Villiom Podlaski Christiansen
|
r18746 | return rst | ||
Gregory Szorc
|
r27378 | def helptopic(name, subtopic=None): | ||
Gregory Szorc
|
r27379 | # Look for sub-topic entry first. | ||
header, doc = None, None | ||||
if subtopic and name in subtopics: | ||||
for names, header, doc in subtopics[name]: | ||||
if subtopic in names: | ||||
break | ||||
if not header: | ||||
for names, header, doc in helptable: | ||||
if name in names: | ||||
break | ||||
else: | ||||
raise error.UnknownCommand(name) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | |||
Dan Villiom Podlaski Christiansen
|
r18748 | rst = [minirst.section(header)] | ||
Dan Villiom Podlaski Christiansen
|
r18746 | # description | ||
if not doc: | ||||
rst.append(" %s\n" % _("(no help text available)")) | ||||
Augie Fackler
|
r21796 | if callable(doc): | ||
Yuya Nishihara
|
r26413 | rst += [" %s\n" % l for l in doc(ui).splitlines()] | ||
Dan Villiom Podlaski Christiansen
|
r18746 | |||
if not ui.verbose: | ||||
Matt Mackall
|
r22114 | omitted = _('(some details hidden, use --verbose' | ||
' to show complete help)') | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | indicateomitted(rst, omitted) | ||
try: | ||||
cmdutil.findcmd(name, commands.table) | ||||
timeless
|
r29974 | rst.append(_("\nuse 'hg help -c %s' to see help for " | ||
"the %s command\n") % (name, name)) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | except error.UnknownCommand: | ||
pass | ||||
return rst | ||||
Gregory Szorc
|
r27378 | def helpext(name, subtopic=None): | ||
Dan Villiom Podlaski Christiansen
|
r18746 | 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) | ||||
r26845 | rst = [_('%s extension - %s\n\n') % (name.rpartition('.')[-1], head)] | |||
Dan Villiom Podlaski Christiansen
|
r18746 | if tail: | ||
rst.extend(tail.splitlines(True)) | ||||
rst.append('\n') | ||||
if not ui.verbose: | ||||
Matt Mackall
|
r22114 | omitted = _('(some details hidden, use --verbose' | ||
' to show complete help)') | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | indicateomitted(rst, omitted) | ||
if mod: | ||||
try: | ||||
ct = mod.cmdtable | ||||
except AttributeError: | ||||
ct = {} | ||||
r26845 | modcmds = set([c.partition('|')[0] for c in ct]) | |||
Dan Villiom Podlaski Christiansen
|
r18746 | rst.extend(helplist(modcmds.__contains__)) | ||
else: | ||||
timeless
|
r29974 | rst.append(_("(use 'hg help extensions' for information on enabling" | ||
" extensions)\n")) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | return rst | ||
Gregory Szorc
|
r27378 | def helpextcmd(name, subtopic=None): | ||
Dan Villiom Podlaski Christiansen
|
r18746 | 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 " | ||||
timeless
|
r27152 | "extension:") % cmd, {ext: doc}, indent=4, | ||
showdeprecated=True) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | rst.append('\n') | ||
timeless
|
r29974 | rst.append(_("(use 'hg help extensions' for information on enabling " | ||
"extensions)\n")) | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | return rst | ||
rst = [] | ||||
kw = opts.get('keyword') | ||||
timeless
|
r27325 | if kw or name is None and any(opts[o] for o in opts): | ||
matches = topicmatch(ui, name or '') | ||||
timeless@mozdev.org
|
r26238 | helpareas = [] | ||
if opts.get('extension'): | ||||
helpareas += [('extensions', _('Extensions'))] | ||||
if opts.get('command'): | ||||
helpareas += [('commands', _('Commands'))] | ||||
if not helpareas: | ||||
helpareas = [('topics', _('Topics')), | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | ('commands', _('Commands')), | ||
('extensions', _('Extensions')), | ||||
timeless@mozdev.org
|
r26238 | ('extensioncommands', _('Extension Commands'))] | ||
for t, title in helpareas: | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | if matches[t]: | ||
rst.append('%s:\n\n' % title) | ||||
rst.extend(minirst.maketable(sorted(matches[t]), 1)) | ||||
rst.append('\n') | ||||
Pierre-Yves David
|
r21288 | if not rst: | ||
msg = _('no matches') | ||||
timeless
|
r29974 | hint = _("try 'hg help' for a list of topics") | ||
Pierre-Yves David
|
r26587 | raise error.Abort(msg, hint=hint) | ||
Dan Villiom Podlaski Christiansen
|
r18746 | elif name and name != 'shortlist': | ||
timeless@mozdev.org
|
r26238 | queries = [] | ||
Dan Villiom Podlaski Christiansen
|
r18746 | if unknowncmd: | ||
timeless@mozdev.org
|
r26238 | queries += [helpextcmd] | ||
if opts.get('extension'): | ||||
queries += [helpext] | ||||
if opts.get('command'): | ||||
queries += [helpcmd] | ||||
if not queries: | ||||
Dan Villiom Podlaski Christiansen
|
r18746 | queries = (helptopic, helpcmd, helpext, helpextcmd) | ||
for f in queries: | ||||
try: | ||||
Gregory Szorc
|
r27378 | rst = f(name, subtopic) | ||
Dan Villiom Podlaski Christiansen
|
r18746 | break | ||
Pierre-Yves David
|
r21289 | except error.UnknownCommand: | ||
pass | ||||
else: | ||||
if unknowncmd: | ||||
raise error.UnknownCommand(name) | ||||
else: | ||||
msg = _('no such help topic: %s') % name | ||||
timeless
|
r29974 | hint = _("try 'hg help --keyword %s'") % name | ||
Pierre-Yves David
|
r26587 | raise error.Abort(msg, hint=hint) | ||
Dan Villiom Podlaski Christiansen
|
r18746 | else: | ||
# program name | ||||
if not ui.quiet: | ||||
rst = [_("Mercurial Distributed SCM\n"), '\n'] | ||||
timeless
|
r27325 | rst.extend(helplist(None, **opts)) | ||
Dan Villiom Podlaski Christiansen
|
r18746 | |||
return ''.join(rst) | ||||
Augie Fackler
|
r31059 | |||
def formattedhelp(ui, name, keep=None, unknowncmd=False, full=True, **opts): | ||||
"""get help for a given topic (as a dotted name) as rendered rst | ||||
Either returns the rendered help text or raises an exception. | ||||
""" | ||||
if keep is None: | ||||
keep = [] | ||||
fullname = name | ||||
section = None | ||||
subtopic = None | ||||
if name and '.' in name: | ||||
name, remaining = name.split('.', 1) | ||||
remaining = encoding.lower(remaining) | ||||
if '.' in remaining: | ||||
subtopic, section = remaining.split('.', 1) | ||||
else: | ||||
if name in subtopics: | ||||
subtopic = remaining | ||||
else: | ||||
section = remaining | ||||
textwidth = ui.configint('ui', 'textwidth', 78) | ||||
termwidth = ui.termwidth() - 2 | ||||
if textwidth <= 0 or termwidth < textwidth: | ||||
textwidth = termwidth | ||||
text = help_(ui, name, | ||||
subtopic=subtopic, unknowncmd=unknowncmd, full=full, **opts) | ||||
formatted, pruned = minirst.format(text, textwidth, keep=keep, | ||||
section=section) | ||||
# We could have been given a weird ".foo" section without a name | ||||
# to look for, or we could have simply failed to found "foo.bar" | ||||
# because bar isn't a section of foo | ||||
if section and not (formatted and name): | ||||
raise error.Abort(_("help section not found: %s") % fullname) | ||||
if 'verbose' in pruned: | ||||
keep.append('omitted') | ||||
else: | ||||
keep.append('notomitted') | ||||
formatted, pruned = minirst.format(text, textwidth, keep=keep, | ||||
section=section) | ||||
return formatted | ||||