mercurial-scm/hg-stable: mercurial/help.py annotate

annotate mercurial/help.py @ 30026:f3c4edfd35e1

help: mark boolean flags with [no-] to explain that they can be negated That is, help gets tweaked thus: global options ([+] can be repeated): -v --[no-]verbose enable additional output Other proposals have included: global options ([+] can be repeated, options marked [?] are boolean flags): -v --verbose[?] enable additional output and global options ([+] can be repeated, options marked [^] are boolean flags): -v --verbose[^] enable additional output which avoid the unfortunate visual noise in this patch. In this version's favor, it's consistent with what I'm used to seeing in man pages and similar documentation venues.

author	Augie Fackler <augie@google.com>
date	Tue, 13 Sep 2016 22:58:12 -0400
parents	7109d5ddeb0c
children	d65e246100ed

rev	line source
3795 17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	1 # help.py - help data for mercurial
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	2 #
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	3 # Copyright 2006 Matt Mackall <mpm@selenic.com>
17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	4 #
8225 46293a0c7e9f updated license to be explicit about GPL version 2 Martin Geisler <mg@lazybytes.net> parents: 8159 diff changeset	5 # This software may be used and distributed according to the terms of the
10263 25e572394f5c Update license to GPLv2+ Matt Mackall <mpm@selenic.com> parents: 9785 diff changeset	6 # GNU General Public License version 2 or any later version.
3795 17a11f4ff260 Add basic support for help topics and a dates topic Matt Mackall <mpm@selenic.com> parents: diff changeset	7
27479 3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	8 from __future__ import absolute_import
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	9
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	10 import itertools
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	11 import os
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	12 import textwrap
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	13
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	14 from .i18n import (
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	15 _,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	16 gettext,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	17 )
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	18 from . import (
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	19 cmdutil,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	20 encoding,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	21 error,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	22 extensions,
30026 f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	23 fancyopts,
27479 3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	24 filemerge,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	25 fileset,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	26 minirst,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	27 revset,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	28 templatefilters,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	29 templatekw,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	30 templater,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	31 util,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	32 )
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	33 from .hgweb import (
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	34 webcommands,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	35 )
8863 7b19c3c0172b help: adding a new help topic about extensions C?dric Duval <cedricduval@free.fr> parents: 8668 diff changeset	36
26369 4799b5c4aaf4 help: define list of keywords that should be excluded from non-verbose output Yuya Nishihara <yuya@tcha.org> parents: 26238 diff changeset	37 _exclkeywords = [
26370 44cc9f63a2f1 help: include parens in DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26369 diff changeset	38 "(DEPRECATED)",
44cc9f63a2f1 help: include parens in DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26369 diff changeset	39 "(EXPERIMENTAL)",
44cc9f63a2f1 help: include parens in DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26369 diff changeset	40 # i18n: "(DEPRECATED)" is a keyword, must be translated consistently
44cc9f63a2f1 help: include parens in DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26369 diff changeset	41 _("(DEPRECATED)"),
44cc9f63a2f1 help: include parens in DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26369 diff changeset	42 # i18n: "(EXPERIMENTAL)" is a keyword, must be translated consistently
44cc9f63a2f1 help: include parens in DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26369 diff changeset	43 _("(EXPERIMENTAL)"),
26369 4799b5c4aaf4 help: define list of keywords that should be excluded from non-verbose output Yuya Nishihara <yuya@tcha.org> parents: 26238 diff changeset	44 ]
4799b5c4aaf4 help: define list of keywords that should be excluded from non-verbose output Yuya Nishihara <yuya@tcha.org> parents: 26238 diff changeset	45
20582 02c303f64917 help: exclude deprecated extensions in the disabled part of 'help extensions' Augie Fackler <raf@durin42.com> parents: 20034 diff changeset	46 def listexts(header, exts, indent=1, showdeprecated=False):
8879 d0a3eadfbdb3 help: more improvements for the extensions topic C?dric Duval <cedricduval@free.fr> parents: 8871 diff changeset	47 '''return a text listing of the given extensions'''
16852 af69b2b64d6e help: format extension lists using RST Olav Reinert <seroton10@gmail.com> parents: 16845 diff changeset	48 rst = []
af69b2b64d6e help: format extension lists using RST Olav Reinert <seroton10@gmail.com> parents: 16845 diff changeset	49 if exts:
af69b2b64d6e help: format extension lists using RST Olav Reinert <seroton10@gmail.com> parents: 16845 diff changeset	50 for name, desc in sorted(exts.iteritems()):
26371 51b309ce6c7d help: unify handling of DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26370 diff changeset	51 if not showdeprecated and any(w in desc for w in _exclkeywords):
20582 02c303f64917 help: exclude deprecated extensions in the disabled part of 'help extensions' Augie Fackler <raf@durin42.com> parents: 20034 diff changeset	52 continue
16852 af69b2b64d6e help: format extension lists using RST Olav Reinert <seroton10@gmail.com> parents: 16845 diff changeset	53 rst.append('%s:%s: %s\n' % (' ' * indent, name, desc))
27151 7625f6387fc4 help: make listexts less confusing for deprecated exts timeless <timeless@mozdev.org> parents: 26845 diff changeset	54 if rst:
7625f6387fc4 help: make listexts less confusing for deprecated exts timeless <timeless@mozdev.org> parents: 26845 diff changeset	55 rst.insert(0, '\n%s\n\n' % header)
16852 af69b2b64d6e help: format extension lists using RST Olav Reinert <seroton10@gmail.com> parents: 16845 diff changeset	56 return rst
8864 cad6370a15cb help: refactor extensions listing, and show enabled ones in the dedicated topic C?dric Duval <cedricduval@free.fr> parents: 8863 diff changeset	57
26413 e0c572d4d112 help: pass around ui to doc loader (API) Yuya Nishihara <yuya@tcha.org> parents: 26371 diff changeset	58 def extshelp(ui):
e0c572d4d112 help: pass around ui to doc loader (API) Yuya Nishihara <yuya@tcha.org> parents: 26371 diff changeset	59 rst = loaddoc('extensions')(ui).splitlines(True)
20582 02c303f64917 help: exclude deprecated extensions in the disabled part of 'help extensions' Augie Fackler <raf@durin42.com> parents: 20034 diff changeset	60 rst.extend(listexts(
02c303f64917 help: exclude deprecated extensions in the disabled part of 'help extensions' Augie Fackler <raf@durin42.com> parents: 20034 diff changeset	61 _('enabled extensions:'), extensions.enabled(), showdeprecated=True))
16852 af69b2b64d6e help: format extension lists using RST Olav Reinert <seroton10@gmail.com> parents: 16845 diff changeset	62 rst.extend(listexts(_('disabled extensions:'), extensions.disabled()))
af69b2b64d6e help: format extension lists using RST Olav Reinert <seroton10@gmail.com> parents: 16845 diff changeset	63 doc = ''.join(rst)
8863 7b19c3c0172b help: adding a new help topic about extensions C?dric Duval <cedricduval@free.fr> parents: 8668 diff changeset	64 return doc
7013 f56e788fa292 i18n: mark help strings for translation Martin Geisler <mg@daimi.au.dk> parents: 7012 diff changeset	65
22116 161085f87b95 help: roll option list header into option formatter Matt Mackall <mpm@selenic.com> parents: 22115 diff changeset	66 def optrst(header, options, verbose):
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	67 data = []
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	68 multioccur = False
30026 f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	69 alllong = set(o[1] for o in options)
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	70 for option in options:
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	71 if len(option) == 5:
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	72 shortopt, longopt, default, desc, optlabel = option
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	73 else:
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	74 shortopt, longopt, default, desc = option
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	75 optlabel = _("VALUE") # default label
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	76
26369 4799b5c4aaf4 help: define list of keywords that should be excluded from non-verbose output Yuya Nishihara <yuya@tcha.org> parents: 26238 diff changeset	77 if not verbose and any(w in desc for w in _exclkeywords):
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	78 continue
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	79
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	80 so = ''
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	81 if shortopt:
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	82 so = '-' + shortopt
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	83 lo = '--' + longopt
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	84 if default:
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	85 desc += _(" (default: %s)") % default
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	86
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	87 if isinstance(default, list):
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	88 lo += " %s [+]" % optlabel
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	89 multioccur = True
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	90 elif (default is not None) and not isinstance(default, bool):
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	91 lo += " %s" % optlabel
30026 f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	92 elif longopt not in fancyopts.nevernegate:
f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	93 if longopt.startswith('no-'):
f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	94 # This odd if statement guards against showing
f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	95 # --no-commit and --commit on backout (as a practical
f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	96 # example) as --[no-]commit in help.
f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	97 if (longopt[3:]) not in alllong:
f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	98 lo = '--[no-]' + lo[5:]
f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	99 else:
f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	100 if ('no-' + longopt) not in alllong:
f3c4edfd35e1 help: mark boolean flags with [no-] to explain that they can be negated Augie Fackler <augie@google.com> parents: 29978 diff changeset	101 lo = '--[no-]' + lo[2:]
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	102
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	103 data.append((so, lo, desc))
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	104
22117 c1d93edcf004 help: fold repeatable option message into option table header Matt Mackall <mpm@selenic.com> parents: 22116 diff changeset	105 if multioccur:
c1d93edcf004 help: fold repeatable option message into option table header Matt Mackall <mpm@selenic.com> parents: 22116 diff changeset	106 header += (_(" ([+] can be repeated)"))
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	107
22116 161085f87b95 help: roll option list header into option formatter Matt Mackall <mpm@selenic.com> parents: 22115 diff changeset	108 rst = ['\n%s:\n\n' % header]
161085f87b95 help: roll option list header into option formatter Matt Mackall <mpm@selenic.com> parents: 22115 diff changeset	109 rst.extend(minirst.maketable(data, 1))
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	110
16815 e740746ea557 minirst: generate tables as a list of joined lines Olav Reinert <seroton10@gmail.com> parents: 16781 diff changeset	111 return ''.join(rst)
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	112
17837 b623e323c561 help: indicate help omitting if help document is not fully displayed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17323 diff changeset	113 def indicateomitted(rst, omitted, notomitted=None):
b623e323c561 help: indicate help omitting if help document is not fully displayed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17323 diff changeset	114 rst.append('\n\n.. container:: omitted\n\n %s\n\n' % omitted)
b623e323c561 help: indicate help omitting if help document is not fully displayed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17323 diff changeset	115 if notomitted:
b623e323c561 help: indicate help omitting if help document is not fully displayed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17323 diff changeset	116 rst.append('\n\n.. container:: notomitted\n\n %s\n\n' % notomitted)
b623e323c561 help: indicate help omitting if help document is not fully displayed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17323 diff changeset	117
27323 0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	118 def filtercmd(ui, cmd, kw, doc):
0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	119 if not ui.debugflag and cmd.startswith("debug") and kw != "debug":
0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	120 return True
0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	121 if not ui.verbose and doc and any(w in doc for w in _exclkeywords):
0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	122 return True
0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	123 return False
0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	124
26413 e0c572d4d112 help: pass around ui to doc loader (API) Yuya Nishihara <yuya@tcha.org> parents: 26371 diff changeset	125 def topicmatch(ui, kw):
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	126 """Return help topics matching kw.
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	127
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	128 Returns {'section': [(name, summary), ...], ...} where section is
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	129 one of topics, commands, extensions, or extensioncommands.
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	130 """
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	131 kw = encoding.lower(kw)
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	132 def lowercontains(container):
16845 4594729c61ee help: fix search with `-k` option in non-ASCII locales Nikolaj Sjujskij <sterkrig@myopera.com> parents: 16816 diff changeset	133 return kw in encoding.lower(container) # translated in helptable
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	134 results = {'topics': [],
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	135 'commands': [],
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	136 'extensions': [],
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	137 'extensioncommands': [],
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	138 }
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	139 for names, header, doc in helptable:
22322 e284de138f00 help: only call doc() when it is callable Gregory Szorc <gregory.szorc@gmail.com> parents: 21796 diff changeset	140 # Old extensions may use a str as doc.
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	141 if (sum(map(lowercontains, names))
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	142 or lowercontains(header)
26413 e0c572d4d112 help: pass around ui to doc loader (API) Yuya Nishihara <yuya@tcha.org> parents: 26371 diff changeset	143 or (callable(doc) and lowercontains(doc(ui)))):
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	144 results['topics'].append((names[0], header))
27479 3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	145 from . import commands # avoid cycle
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	146 for cmd, entry in commands.table.iteritems():
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	147 if len(entry) == 3:
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	148 summary = entry[2]
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	149 else:
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	150 summary = ''
16845 4594729c61ee help: fix search with `-k` option in non-ASCII locales Nikolaj Sjujskij <sterkrig@myopera.com> parents: 16816 diff changeset	151 # translate docs before searching there
4594729c61ee help: fix search with `-k` option in non-ASCII locales Nikolaj Sjujskij <sterkrig@myopera.com> parents: 16816 diff changeset	152 docs = _(getattr(entry[0], '__doc__', None)) or ''
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	153 if kw in cmd or lowercontains(summary) or lowercontains(docs):
16845 4594729c61ee help: fix search with `-k` option in non-ASCII locales Nikolaj Sjujskij <sterkrig@myopera.com> parents: 16816 diff changeset	154 doclines = docs.splitlines()
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	155 if doclines:
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	156 summary = doclines[0]
26845 7a77ee434179 help: replace some str.split() calls by str.partition() or str.rpartition() Anton Shestakov <av6@dwimlabs.net> parents: 26587 diff changeset	157 cmdname = cmd.partition('\|')[0].lstrip('^')
27324 5456374561a7 help: call filtercmd from topicmatch timeless <timeless@mozdev.org> parents: 27323 diff changeset	158 if filtercmd(ui, cmdname, kw, docs):
5456374561a7 help: call filtercmd from topicmatch timeless <timeless@mozdev.org> parents: 27323 diff changeset	159 continue
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	160 results['commands'].append((cmdname, summary))
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	161 for name, docs in itertools.chain(
19769 83d79a00cc24 help: use full name of extensions to look up them for keyword search FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 18748 diff changeset	162 extensions.enabled(False).iteritems(),
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	163 extensions.disabled().iteritems()):
28058 ff6e8dc659f8 help: don't crash in keyword search if an extension fails to provide docs Simon Farnsworth <simonfar@fb.com> parents: 27660 diff changeset	164 if not docs:
ff6e8dc659f8 help: don't crash in keyword search if an extension fails to provide docs Simon Farnsworth <simonfar@fb.com> parents: 27660 diff changeset	165 continue
27660 512f883c234c mercurial: pass ui to extensions.load (issue5007) Jun Wu <quark@fb.com> parents: 27631 diff changeset	166 mod = extensions.load(ui, name, '')
26845 7a77ee434179 help: replace some str.split() calls by str.partition() or str.rpartition() Anton Shestakov <av6@dwimlabs.net> parents: 26587 diff changeset	167 name = name.rpartition('.')[-1]
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	168 if lowercontains(name) or lowercontains(docs):
16845 4594729c61ee help: fix search with `-k` option in non-ASCII locales Nikolaj Sjujskij <sterkrig@myopera.com> parents: 16816 diff changeset	169 # extension docs are already translated
4594729c61ee help: fix search with `-k` option in non-ASCII locales Nikolaj Sjujskij <sterkrig@myopera.com> parents: 16816 diff changeset	170 results['extensions'].append((name, docs.splitlines()[0]))
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	171 for cmd, entry in getattr(mod, 'cmdtable', {}).iteritems():
16711 497deec204d1 help: add --keyword (-k) for searching help Augie Fackler <raf@durin42.com> parents: 16710 diff changeset	172 if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])):
26845 7a77ee434179 help: replace some str.split() calls by str.partition() or str.rpartition() Anton Shestakov <av6@dwimlabs.net> parents: 26587 diff changeset	173 cmdname = cmd.partition('\|')[0].lstrip('^')
16942 87882c8753d4 help: fix extension commands help in keyword search Olav Reinert <seroton10@gmail.com> parents: 16884 diff changeset	174 if entry[0].__doc__:
87882c8753d4 help: fix extension commands help in keyword search Olav Reinert <seroton10@gmail.com> parents: 16884 diff changeset	175 cmddoc = gettext(entry[0].__doc__).splitlines()[0]
16884 4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs Thomas Arendsen Hein <thomas@intevation.de> parents: 16855 diff changeset	176 else:
4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs Thomas Arendsen Hein <thomas@intevation.de> parents: 16855 diff changeset	177 cmddoc = _('(no help text available)')
27387 dfab0afde928 help: filter extension commands timeless <timeless@mozdev.org> parents: 27379 diff changeset	178 if filtercmd(ui, cmdname, kw, cmddoc):
dfab0afde928 help: filter extension commands timeless <timeless@mozdev.org> parents: 27379 diff changeset	179 continue
16884 4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs Thomas Arendsen Hein <thomas@intevation.de> parents: 16855 diff changeset	180 results['extensioncommands'].append((cmdname, cmddoc))
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	181 return results
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	182
27375 c4a062d090ee help: teach loaddoc to load from a different directory Gregory Szorc <gregory.szorc@gmail.com> parents: 27325 diff changeset	183 def loaddoc(topic, subdir=None):
9539 c904e76e3834 help: move help topics from mercurial/help.py to help/.txt Martin Geisler <mg@lazybytes.net>* parents: 9536 diff changeset	184 """Return a delayed loader for help/topic.txt."""
3798 6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	185
26413 e0c572d4d112 help: pass around ui to doc loader (API) Yuya Nishihara <yuya@tcha.org> parents: 26371 diff changeset	186 def loader(ui):
22637 149141c3a25f help: don't search randomly for help data - trust util.datapath Mads Kiilerich <madski@unity3d.com> parents: 22633 diff changeset	187 docdir = os.path.join(util.datapath, 'help')
27375 c4a062d090ee help: teach loaddoc to load from a different directory Gregory Szorc <gregory.szorc@gmail.com> parents: 27325 diff changeset	188 if subdir:
c4a062d090ee help: teach loaddoc to load from a different directory Gregory Szorc <gregory.szorc@gmail.com> parents: 27325 diff changeset	189 docdir = os.path.join(docdir, subdir)
9539 c904e76e3834 help: move help topics from mercurial/help.py to help/.txt Martin Geisler <mg@lazybytes.net>* parents: 9536 diff changeset	190 path = os.path.join(docdir, topic + ".txt")
14168 135e244776f0 prevent transient leaks of file handle by using new helper functions Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 14044 diff changeset	191 doc = gettext(util.readfile(path))
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	192 for rewriter in helphooks.get(topic, []):
26414 c44b507e7c78 help: pass around ui to rewriter hooks (API) Yuya Nishihara <yuya@tcha.org> parents: 26413 diff changeset	193 doc = rewriter(ui, topic, doc)
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	194 return doc
0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	195
9539 c904e76e3834 help: move help topics from mercurial/help.py to help/.txt Martin Geisler <mg@lazybytes.net>* parents: 9536 diff changeset	196 return loader
7677 6a0bc2dc9da6 help: add a topic about some of the templating features Alexander Solovyov <piranha@piranha.org.ua> parents: 7387 diff changeset	197
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	198 internalstable = sorted([
29759 aba2bb2a6d0f help: don't try to render a section on sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 28828 diff changeset	199 (['bundles'], _('Bundles'),
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	200 loaddoc('bundles', subdir='internals')),
29759 aba2bb2a6d0f help: don't try to render a section on sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 28828 diff changeset	201 (['changegroups'], _('Changegroups'),
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	202 loaddoc('changegroups', subdir='internals')),
29759 aba2bb2a6d0f help: don't try to render a section on sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 28828 diff changeset	203 (['requirements'], _('Repository Requirements'),
28523 045fe7042510 help: document requirements Gregory Szorc <gregory.szorc@gmail.com> parents: 28058 diff changeset	204 loaddoc('requirements', subdir='internals')),
29759 aba2bb2a6d0f help: don't try to render a section on sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 28828 diff changeset	205 (['revlogs'], _('Revision Logs'),
27631 c18292a6ff54 internals: document revlog format Gregory Szorc <gregory.szorc@gmail.com> parents: 27479 diff changeset	206 loaddoc('revlogs', subdir='internals')),
29865 a1092e2d70a3 help: internals topic for wire protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 29759 diff changeset	207 (['wireprotocol'], _('Wire Protocol'),
a1092e2d70a3 help: internals topic for wire protocol Gregory Szorc <gregory.szorc@gmail.com> parents: 29759 diff changeset	208 loaddoc('wireprotocol', subdir='internals')),
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	209 ])
fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	210
fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	211 def internalshelp(ui):
fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	212 """Generate the index for the "internals" topic."""
fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	213 lines = []
fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	214 for names, header, doc in internalstable:
27400 64208bd4c580 help: add missed last new line to "internals" topic Yuya Nishihara <yuya@tcha.org> parents: 27387 diff changeset	215 lines.append(' :%s: %s\n' % (names[0], header))
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	216
27400 64208bd4c580 help: add missed last new line to "internals" topic Yuya Nishihara <yuya@tcha.org> parents: 27387 diff changeset	217 return ''.join(lines)
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	218
13888 9e5407a67dea help: sort help topics to make the output more readable (issue2751) Yun Lee <yunlee.bj@gmail.com> parents: 13593 diff changeset	219 helptable = sorted([
12145 c407b4ca666e help: make "hg help hgrc" an alias for "hg help config" Martin Geisler <mg@lazybytes.net> parents: 11657 diff changeset	220 (["config", "hgrc"], _("Configuration Files"), loaddoc('config')),
9539 c904e76e3834 help: move help topics from mercurial/help.py to help/.txt Martin Geisler <mg@lazybytes.net>* parents: 9536 diff changeset	221 (["dates"], _("Date Formats"), loaddoc('dates')),
c904e76e3834 help: move help topics from mercurial/help.py to help/.txt Martin Geisler <mg@lazybytes.net>* parents: 9536 diff changeset	222 (["patterns"], _("File Name Patterns"), loaddoc('patterns')),
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	223 (['environment', 'env'], _('Environment Variables'),
08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	224 loaddoc('environment')),
17322 7124f984dc8d help: use the first topic name from helptable, not the longest alias Mads Kiilerich <mads@kiilerich.com> parents: 17321 diff changeset	225 (['revisions', 'revs'], _('Specifying Single Revisions'),
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	226 loaddoc('revisions')),
17322 7124f984dc8d help: use the first topic name from helptable, not the longest alias Mads Kiilerich <mads@kiilerich.com> parents: 17321 diff changeset	227 (['multirevs', 'mrevs'], _('Specifying Multiple Revisions'),
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	228 loaddoc('multirevs')),
17322 7124f984dc8d help: use the first topic name from helptable, not the longest alias Mads Kiilerich <mads@kiilerich.com> parents: 17321 diff changeset	229 (['revsets', 'revset'], _("Specifying Revision Sets"), loaddoc('revsets')),
7124f984dc8d help: use the first topic name from helptable, not the longest alias Mads Kiilerich <mads@kiilerich.com> parents: 17321 diff changeset	230 (['filesets', 'fileset'], _("Specifying File Sets"), loaddoc('filesets')),
9539 c904e76e3834 help: move help topics from mercurial/help.py to help/.txt Martin Geisler <mg@lazybytes.net>* parents: 9536 diff changeset	231 (['diffs'], _('Diff Formats'), loaddoc('diffs')),
17323 2be2a070f294 help: add 'mergetools' alias for the 'merge-tools' help topic Mads Kiilerich <mads@kiilerich.com> parents: 17322 diff changeset	232 (['merge-tools', 'mergetools'], _('Merge Tools'), loaddoc('merge-tools')),
16568 770190bff625 help: add reference to template help (issue3413) A. S. Budden <abudden@gmail.com> parents: 16547 diff changeset	233 (['templating', 'templates', 'template', 'style'], _('Template Usage'),
10282 08a0f04b56bd many, many trivial check-code fixups Matt Mackall <mpm@selenic.com> parents: 10263 diff changeset	234 loaddoc('templates')),
9539 c904e76e3834 help: move help topics from mercurial/help.py to help/.txt Martin Geisler <mg@lazybytes.net>* parents: 9536 diff changeset	235 (['urls'], _('URL Paths'), loaddoc('urls')),
16547 23072be2eaa3 help: consistently use title capitalization for help topics Martin Geisler <mg@aragost.com> parents: 16250 diff changeset	236 (["extensions"], _("Using Additional Features"), extshelp),
17322 7124f984dc8d help: use the first topic name from helptable, not the longest alias Mads Kiilerich <mads@kiilerich.com> parents: 17321 diff changeset	237 (["subrepos", "subrepo"], _("Subrepositories"), loaddoc('subrepos')),
17321 f3fd9d6802b7 help: fix helptable indentation Mads Kiilerich <mads@kiilerich.com> parents: 17187 diff changeset	238 (["hgweb"], _("Configuring hgweb"), loaddoc('hgweb')),
f3fd9d6802b7 help: fix helptable indentation Mads Kiilerich <mads@kiilerich.com> parents: 17187 diff changeset	239 (["glossary"], _("Glossary"), loaddoc('glossary')),
f3fd9d6802b7 help: fix helptable indentation Mads Kiilerich <mads@kiilerich.com> parents: 17187 diff changeset	240 (["hgignore", "ignore"], _("Syntax for Mercurial Ignore Files"),
f3fd9d6802b7 help: fix helptable indentation Mads Kiilerich <mads@kiilerich.com> parents: 17187 diff changeset	241 loaddoc('hgignore')),
f3fd9d6802b7 help: fix helptable indentation Mads Kiilerich <mads@kiilerich.com> parents: 17187 diff changeset	242 (["phases"], _("Working with Phases"), loaddoc('phases')),
25881 9de443515f1d help: scripting help topic Gregory Szorc <gregory.szorc@gmail.com> parents: 25660 diff changeset	243 (['scripting'], _('Using Mercurial from scripts and automation'),
9de443515f1d help: scripting help topic Gregory Szorc <gregory.szorc@gmail.com> parents: 25660 diff changeset	244 loaddoc('scripting')),
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	245 (['internals'], _("Technical implementation topics"),
fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	246 internalshelp),
13888 9e5407a67dea help: sort help topics to make the output more readable (issue2751) Yun Lee <yunlee.bj@gmail.com> parents: 13593 diff changeset	247 ])
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	248
27379 2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	249 # Maps topics with sub-topics to a list of their sub-topics.
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	250 subtopics = {
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	251 'internals': internalstable,
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	252 }
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	253
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	254 # Map topics to lists of callable taking the current topic help and
0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	255 # returning the updated version
14318 1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	256 helphooks = {}
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	257
0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	258 def addtopichook(topic, rewriter):
0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	259 helphooks.setdefault(topic, []).append(rewriter)
13593 cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	260
26414 c44b507e7c78 help: pass around ui to rewriter hooks (API) Yuya Nishihara <yuya@tcha.org> parents: 26413 diff changeset	261 def makeitemsdoc(ui, topic, doc, marker, items, dedent=False):
13593 cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	262 """Extract docstring from the items key to function mapping, build a
26196 3a4620ad4490 help: fix makeitemsdoc English description timeless@mozdev.org parents: 25881 diff changeset	263 single documentation block and use it to overwrite the marker in doc.
13593 cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	264 """
cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	265 entries = []
cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	266 for name in sorted(items):
cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	267 text = (items[name].__doc__ or '').rstrip()
26415 46af0adb5c37 help: hide deprecated filesets, revsets and template items if not verbose Yuya Nishihara <yuya@tcha.org> parents: 26414 diff changeset	268 if (not text
46af0adb5c37 help: hide deprecated filesets, revsets and template items if not verbose Yuya Nishihara <yuya@tcha.org> parents: 26414 diff changeset	269 or not ui.verbose and any(w in text for w in _exclkeywords)):
13593 cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	270 continue
cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	271 text = gettext(text)
24098 067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	272 if dedent:
067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	273 text = textwrap.dedent(text)
13593 cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	274 lines = text.splitlines()
16250 684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	275 doclines = [(lines[0])]
684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	276 for l in lines[1:]:
684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	277 # Stop once we find some Python doctest
684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	278 if l.strip().startswith('>>>'):
684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	279 break
24098 067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	280 if dedent:
067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	281 doclines.append(l.rstrip())
067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	282 else:
067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	283 doclines.append(' ' + l.strip())
16250 684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	284 entries.append('\n'.join(doclines))
13593 cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	285 entries = '\n\n'.join(entries)
cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	286 return doc.replace(marker, entries)
14318 1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	287
24098 067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	288 def addtopicsymbols(topic, marker, symbols, dedent=False):
26414 c44b507e7c78 help: pass around ui to rewriter hooks (API) Yuya Nishihara <yuya@tcha.org> parents: 26413 diff changeset	289 def add(ui, topic, doc):
c44b507e7c78 help: pass around ui to rewriter hooks (API) Yuya Nishihara <yuya@tcha.org> parents: 26413 diff changeset	290 return makeitemsdoc(ui, topic, doc, marker, symbols, dedent=dedent)
14318 1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	291 addtopichook(topic, add)
1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	292
14686 6ab8b17adc03 fileset: add a help topic Matt Mackall <mpm@selenic.com> parents: 14318 diff changeset	293 addtopicsymbols('filesets', '.. predicatesmarker', fileset.symbols)
24099 be83fd9d46d5 help.merge-tools: do not double document merge tools Gregory Szorc <gregory.szorc@gmail.com> parents: 24098 diff changeset	294 addtopicsymbols('merge-tools', '.. internaltoolsmarker',
be83fd9d46d5 help.merge-tools: do not double document merge tools Gregory Szorc <gregory.szorc@gmail.com> parents: 24098 diff changeset	295 filemerge.internalsdoc)
14318 1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	296 addtopicsymbols('revsets', '.. predicatesmarker', revset.symbols)
26436 a2291c9c85a1 templatekw: remove dockeywords hack Yuya Nishihara <yuya@tcha.org> parents: 26415 diff changeset	297 addtopicsymbols('templates', '.. keywordsmarker', templatekw.keywords)
14318 1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	298 addtopicsymbols('templates', '.. filtersmarker', templatefilters.filters)
24587 76c0b4cfa039 help: populate template functions via docstrings Gregory Szorc <gregory.szorc@gmail.com> parents: 24099 diff changeset	299 addtopicsymbols('templates', '.. functionsmarker', templater.funcs)
24098 067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	300 addtopicsymbols('hgweb', '.. webcommandsmarker', webcommands.commands,
067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	301 dedent=True)
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	302
27377 d1c998d7b103 help: pass subtopic into help() Gregory Szorc <gregory.szorc@gmail.com> parents: 27376 diff changeset	303 def help_(ui, name, unknowncmd=False, full=True, subtopic=None, **opts):
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	304 '''
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	305 Generate the help for 'name' as unformatted restructured text. If
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	306 'name' is None, describe the commands available.
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	307 '''
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	308
27479 3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	309 from . import commands # avoid cycle
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	310
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	311 def helpcmd(name, subtopic=None):
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	312 try:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	313 aliases, entry = cmdutil.findcmd(name, commands.table,
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	314 strict=unknowncmd)
25660 328739ea70c3 global: mass rewrite to use modern exception syntax Gregory Szorc <gregory.szorc@gmail.com> parents: 24871 diff changeset	315 except error.AmbiguousCommand as inst:
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	316 # py3k fix: except vars can't be used outside the scope of the
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	317 # except block, nor can be used inside a lambda. python issue4617
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	318 prefix = inst.args[0]
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	319 select = lambda c: c.lstrip('^').startswith(prefix)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	320 rst = helplist(select)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	321 return rst
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	322
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	323 rst = []
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	324
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	325 # check if it's an invalid alias and display its error if it is
22160 645457f73aa6 alias: keep error message in "badalias" so that help can see it Yuya Nishihara <yuya@tcha.org> parents: 22118 diff changeset	326 if getattr(entry[0], 'badalias', None):
22162 7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	327 rst.append(entry[0].badalias + '\n')
7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	328 if entry[0].unknowncmd:
7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	329 try:
7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	330 rst.extend(helpextcmd(entry[0].cmdname))
7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	331 except error.UnknownCommand:
7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	332 pass
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	333 return rst
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	334
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	335 # synopsis
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	336 if len(entry) > 2:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	337 if entry[2].startswith('hg'):
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	338 rst.append("%s\n" % entry[2])
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	339 else:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	340 rst.append('hg %s %s\n' % (aliases[0], entry[2]))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	341 else:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	342 rst.append('hg %s\n' % aliases[0])
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	343 # aliases
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	344 if full and not ui.quiet and len(aliases) > 1:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	345 rst.append(_("\naliases: %s\n") % ', '.join(aliases[1:]))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	346 rst.append('\n')
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	347
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	348 # description
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	349 doc = gettext(entry[0].__doc__)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	350 if not doc:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	351 doc = _("(no help text available)")
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	352 if util.safehasattr(entry[0], 'definition'): # aliased command
28828 3640c1702c43 help: report source of aliases timeless <timeless@mozdev.org> parents: 28523 diff changeset	353 source = entry[0].source
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	354 if entry[0].definition.startswith('!'): # shell alias
28828 3640c1702c43 help: report source of aliases timeless <timeless@mozdev.org> parents: 28523 diff changeset	355 doc = (_('shell alias for::\n\n %s\n\ndefined by: %s\n') %
3640c1702c43 help: report source of aliases timeless <timeless@mozdev.org> parents: 28523 diff changeset	356 (entry[0].definition[1:], source))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	357 else:
28828 3640c1702c43 help: report source of aliases timeless <timeless@mozdev.org> parents: 28523 diff changeset	358 doc = (_('alias for: hg %s\n\n%s\n\ndefined by: %s\n') %
3640c1702c43 help: report source of aliases timeless <timeless@mozdev.org> parents: 28523 diff changeset	359 (entry[0].definition, doc, source))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	360 doc = doc.splitlines(True)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	361 if ui.quiet or not full:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	362 rst.append(doc[0])
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	363 else:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	364 rst.extend(doc)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	365 rst.append('\n')
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	366
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	367 # check if this command shadows a non-trivial (multi-line)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	368 # extension help text
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	369 try:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	370 mod = extensions.find(name)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	371 doc = gettext(mod.__doc__) or ''
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	372 if '\n' in doc.strip():
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	373 msg = _("(use 'hg help -e %s' to show help for "
7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	374 "the %s extension)") % (name, name)
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	375 rst.append('\n%s\n' % msg)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	376 except KeyError:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	377 pass
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	378
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	379 # options
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	380 if not ui.quiet and entry[1]:
22116 161085f87b95 help: roll option list header into option formatter Matt Mackall <mpm@selenic.com> parents: 22115 diff changeset	381 rst.append(optrst(_("options"), entry[1], ui.verbose))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	382
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	383 if ui.verbose:
22116 161085f87b95 help: roll option list header into option formatter Matt Mackall <mpm@selenic.com> parents: 22115 diff changeset	384 rst.append(optrst(_("global options"),
161085f87b95 help: roll option list header into option formatter Matt Mackall <mpm@selenic.com> parents: 22115 diff changeset	385 commands.globalopts, ui.verbose))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	386
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	387 if not ui.verbose:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	388 if not full:
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	389 rst.append(_("\n(use 'hg %s -h' to show more help)\n")
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	390 % name)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	391 elif not ui.quiet:
22110 26f7c8033bed help: tweak --verbose command help hint Matt Mackall <mpm@selenic.com> parents: 21796 diff changeset	392 rst.append(_('\n(some details hidden, use --verbose '
26f7c8033bed help: tweak --verbose command help hint Matt Mackall <mpm@selenic.com> parents: 21796 diff changeset	393 'to show complete help)'))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	394
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	395 return rst
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	396
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	397
27325 eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	398 def helplist(select=None, **opts):
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	399 # list of commands
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	400 if name == "shortlist":
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	401 header = _('basic commands:\n\n')
20822 be87397f98c9 help: let 'hg help debug' show the list of secret debug commands Mads Kiilerich <madski@unity3d.com> parents: 20743 diff changeset	402 elif name == "debug":
be87397f98c9 help: let 'hg help debug' show the list of secret debug commands Mads Kiilerich <madski@unity3d.com> parents: 20743 diff changeset	403 header = _('debug commands (internal and unsupported):\n\n')
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	404 else:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	405 header = _('list of commands:\n\n')
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	406
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	407 h = {}
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	408 cmds = {}
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	409 for c, e in commands.table.iteritems():
26845 7a77ee434179 help: replace some str.split() calls by str.partition() or str.rpartition() Anton Shestakov <av6@dwimlabs.net> parents: 26587 diff changeset	410 f = c.partition("\|")[0]
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	411 if select and not select(f):
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	412 continue
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	413 if (not select and name != 'shortlist' and
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	414 e[0].__module__ != commands.__name__):
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	415 continue
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	416 if name == "shortlist" and not f.startswith("^"):
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	417 continue
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	418 f = f.lstrip("^")
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	419 doc = e[0].__doc__
27323 0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	420 if filtercmd(ui, f, name, doc):
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	421 continue
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	422 doc = gettext(doc)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	423 if not doc:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	424 doc = _("(no help text available)")
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	425 h[f] = doc.splitlines()[0].rstrip()
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	426 cmds[f] = c.lstrip("^")
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	427
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	428 rst = []
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	429 if not h:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	430 if not ui.quiet:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	431 rst.append(_('no commands defined\n'))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	432 return rst
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	433
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	434 if not ui.quiet:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	435 rst.append(header)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	436 fns = sorted(h)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	437 for f in fns:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	438 if ui.verbose:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	439 commacmds = cmds[f].replace("\|",", ")
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	440 rst.append(" :%s: %s\n" % (commacmds, h[f]))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	441 else:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	442 rst.append(' :%s: %s\n' % (f, h[f]))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	443
27325 eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	444 ex = opts.get
eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	445 anyopts = (ex('keyword') or not (ex('command') or ex('extension')))
eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	446 if not name and anyopts:
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	447 exts = listexts(_('enabled extensions:'), extensions.enabled())
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	448 if exts:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	449 rst.append('\n')
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	450 rst.extend(exts)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	451
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	452 rst.append(_("\nadditional help topics:\n\n"))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	453 topics = []
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	454 for names, header, doc in helptable:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	455 topics.append((names[0], header))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	456 for t, desc in topics:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	457 rst.append(" :%s: %s\n" % (t, desc))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	458
22115 8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	459 if ui.quiet:
8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	460 pass
8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	461 elif ui.verbose:
22116 161085f87b95 help: roll option list header into option formatter Matt Mackall <mpm@selenic.com> parents: 22115 diff changeset	462 rst.append('\n%s\n' % optrst(_("global options"),
161085f87b95 help: roll option list header into option formatter Matt Mackall <mpm@selenic.com> parents: 22115 diff changeset	463 commands.globalopts, ui.verbose))
22115 8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	464 if name == 'shortlist':
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	465 rst.append(_("\n(use 'hg help' for the full list "
7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	466 "of commands)\n"))
22115 8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	467 else:
8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	468 if name == 'shortlist':
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	469 rst.append(_("\n(use 'hg help' for the full list of commands "
7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	470 "or 'hg -v' for details)\n"))
22115 8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	471 elif name and not full:
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	472 rst.append(_("\n(use 'hg help %s' to show the full help "
7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	473 "text)\n") % name)
23624 861ddedfb402 help: suggest '-v -e' to get built-in aliases for extensions (issue4461) Chingis Dugarzhapov <chingis.dug@gmail.com> parents: 22637 diff changeset	474 elif name and cmds and name in cmds.keys():
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	475 rst.append(_("\n(use 'hg help -v -e %s' to show built-in "
7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	476 "aliases and global options)\n") % name)
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	477 else:
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	478 rst.append(_("\n(use 'hg help -v%s' to show built-in aliases "
7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	479 "and global options)\n")
22118 9a299c39de01 help: normalize helplist hints Matt Mackall <mpm@selenic.com> parents: 22117 diff changeset	480 % (name and " " + name or ""))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	481 return rst
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	482
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	483 def helptopic(name, subtopic=None):
27379 2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	484 # Look for sub-topic entry first.
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	485 header, doc = None, None
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	486 if subtopic and name in subtopics:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	487 for names, header, doc in subtopics[name]:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	488 if subtopic in names:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	489 break
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	490
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	491 if not header:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	492 for names, header, doc in helptable:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	493 if name in names:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	494 break
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	495 else:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	496 raise error.UnknownCommand(name)
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	497
18748 6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 18746 diff changeset	498 rst = [minirst.section(header)]
6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 18746 diff changeset	499
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	500 # description
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	501 if not doc:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	502 rst.append(" %s\n" % _("(no help text available)"))
21796 8225bb1f0ad3 help: restore use of callable() since it was readded in Python 3.2 Augie Fackler <raf@durin42.com> parents: 21289 diff changeset	503 if callable(doc):
26413 e0c572d4d112 help: pass around ui to doc loader (API) Yuya Nishihara <yuya@tcha.org> parents: 26371 diff changeset	504 rst += [" %s\n" % l for l in doc(ui).splitlines()]
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	505
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	506 if not ui.verbose:
22114 3ba1d7ca3dfd help: normalize topic and extension verbose hints Matt Mackall <mpm@selenic.com> parents: 22113 diff changeset	507 omitted = _('(some details hidden, use --verbose'
3ba1d7ca3dfd help: normalize topic and extension verbose hints Matt Mackall <mpm@selenic.com> parents: 22113 diff changeset	508 ' to show complete help)')
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	509 indicateomitted(rst, omitted)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	510
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	511 try:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	512 cmdutil.findcmd(name, commands.table)
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	513 rst.append(_("\nuse 'hg help -c %s' to see help for "
7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	514 "the %s command\n") % (name, name))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	515 except error.UnknownCommand:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	516 pass
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	517 return rst
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	518
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	519 def helpext(name, subtopic=None):
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	520 try:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	521 mod = extensions.find(name)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	522 doc = gettext(mod.__doc__) or _('no help text available')
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	523 except KeyError:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	524 mod = None
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	525 doc = extensions.disabledext(name)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	526 if not doc:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	527 raise error.UnknownCommand(name)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	528
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	529 if '\n' not in doc:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	530 head, tail = doc, ""
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	531 else:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	532 head, tail = doc.split('\n', 1)
26845 7a77ee434179 help: replace some str.split() calls by str.partition() or str.rpartition() Anton Shestakov <av6@dwimlabs.net> parents: 26587 diff changeset	533 rst = [_('%s extension - %s\n\n') % (name.rpartition('.')[-1], head)]
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	534 if tail:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	535 rst.extend(tail.splitlines(True))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	536 rst.append('\n')
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	537
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	538 if not ui.verbose:
22114 3ba1d7ca3dfd help: normalize topic and extension verbose hints Matt Mackall <mpm@selenic.com> parents: 22113 diff changeset	539 omitted = _('(some details hidden, use --verbose'
3ba1d7ca3dfd help: normalize topic and extension verbose hints Matt Mackall <mpm@selenic.com> parents: 22113 diff changeset	540 ' to show complete help)')
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	541 indicateomitted(rst, omitted)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	542
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	543 if mod:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	544 try:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	545 ct = mod.cmdtable
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	546 except AttributeError:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	547 ct = {}
26845 7a77ee434179 help: replace some str.split() calls by str.partition() or str.rpartition() Anton Shestakov <av6@dwimlabs.net> parents: 26587 diff changeset	548 modcmds = set([c.partition('\|')[0] for c in ct])
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	549 rst.extend(helplist(modcmds.__contains__))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	550 else:
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	551 rst.append(_("(use 'hg help extensions' for information on enabling"
7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	552 " extensions)\n"))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	553 return rst
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	554
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	555 def helpextcmd(name, subtopic=None):
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	556 cmd, ext, mod = extensions.disabledcmd(ui, name,
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	557 ui.configbool('ui', 'strict'))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	558 doc = gettext(mod.__doc__).splitlines()[0]
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	559
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	560 rst = listexts(_("'%s' is provided by the following "
27152 ac27b1b3be85 help: make help deprecated mention the extension timeless <timeless@mozdev.org> parents: 27151 diff changeset	561 "extension:") % cmd, {ext: doc}, indent=4,
ac27b1b3be85 help: make help deprecated mention the extension timeless <timeless@mozdev.org> parents: 27151 diff changeset	562 showdeprecated=True)
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	563 rst.append('\n')
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	564 rst.append(_("(use 'hg help extensions' for information on enabling "
7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	565 "extensions)\n"))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	566 return rst
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	567
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	568
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	569 rst = []
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	570 kw = opts.get('keyword')
27325 eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	571 if kw or name is None and any(opts[o] for o in opts):
eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	572 matches = topicmatch(ui, name or '')
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	573 helpareas = []
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	574 if opts.get('extension'):
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	575 helpareas += [('extensions', _('Extensions'))]
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	576 if opts.get('command'):
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	577 helpareas += [('commands', _('Commands'))]
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	578 if not helpareas:
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	579 helpareas = [('topics', _('Topics')),
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	580 ('commands', _('Commands')),
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	581 ('extensions', _('Extensions')),
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	582 ('extensioncommands', _('Extension Commands'))]
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	583 for t, title in helpareas:
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	584 if matches[t]:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	585 rst.append('%s:\n\n' % title)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	586 rst.extend(minirst.maketable(sorted(matches[t]), 1))
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	587 rst.append('\n')
21288 eb6eaef7ae44 help: provide a more helpful message when no keyword are matched Pierre-Yves David <pierre-yves.david@fb.com> parents: 20823 diff changeset	588 if not rst:
eb6eaef7ae44 help: provide a more helpful message when no keyword are matched Pierre-Yves David <pierre-yves.david@fb.com> parents: 20823 diff changeset	589 msg = _('no matches')
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	590 hint = _("try 'hg help' for a list of topics")
26587 56b2bcea2529 error: get Abort from 'error' instead of 'util' Pierre-Yves David <pierre-yves.david@fb.com> parents: 26436 diff changeset	591 raise error.Abort(msg, hint=hint)
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	592 elif name and name != 'shortlist':
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	593 queries = []
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	594 if unknowncmd:
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	595 queries += [helpextcmd]
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	596 if opts.get('extension'):
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	597 queries += [helpext]
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	598 if opts.get('command'):
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	599 queries += [helpcmd]
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	600 if not queries:
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	601 queries = (helptopic, helpcmd, helpext, helpextcmd)
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	602 for f in queries:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	603 try:
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	604 rst = f(name, subtopic)
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	605 break
21289 c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	606 except error.UnknownCommand:
c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	607 pass
c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	608 else:
c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	609 if unknowncmd:
c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	610 raise error.UnknownCommand(name)
c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	611 else:
c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	612 msg = _('no such help topic: %s') % name
29978 7109d5ddeb0c help: use single quotes in use warning timeless <timeless@mozdev.org> parents: 29865 diff changeset	613 hint = _("try 'hg help --keyword %s'") % name
26587 56b2bcea2529 error: get Abort from 'error' instead of 'util' Pierre-Yves David <pierre-yves.david@fb.com> parents: 26436 diff changeset	614 raise error.Abort(msg, hint=hint)
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	615 else:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	616 # program name
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	617 if not ui.quiet:
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	618 rst = [_("Mercurial Distributed SCM\n"), '\n']
27325 eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	619 rst.extend(helplist(None, **opts))
18746 c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	620
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	621 return ''.join(rst)

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/help.py @ 30026:f3c4edfd35e1