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

annotate mercurial/help.py @ 44341:142d2a4cb69a

help: add a mechanism to change flags' help depending on config It seems reasonable to have a similar mechanism for the rest of the help, but no such thing is implemented. The goal is to make the help of commands clearer in the presence of significant default changes, like tweakdefaults or with company-wide hgrcs. In these cases, a user looking at the help of a command doesn't exactly know what his hgrc is doing. Apply to this to the --git option of commands that display diffs, as this option in particular causes confusion for some reason. Differential Revision: https://phab.mercurial-scm.org/D8100

author	Valentin Gatien-Baron <valentin.gatienbaron@gmail.com>
date	Sun, 09 Feb 2020 15:50:36 -0500
parents	52f0140c2604
children	a0ec05d93c8e

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
40412 e928bedf0919 help: describe what ui.tweakdefaults changes, concretely Valentin Gatien-Baron <vgatien-baron@janestreet.com> parents: 40295 diff changeset	11 import re
27479 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 )
43089 c59eb1560c44 py3: manually import getattr where it is needed Gregory Szorc <gregory.szorc@gmail.com> parents: 43077 diff changeset	18 from .pycompat import getattr
27479 3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	19 from . import (
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	20 cmdutil,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	21 encoding,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	22 error,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	23 extensions,
37094 979c8ce9022d fancyopts: fix rendering of customopt defaults in help text Daniel Ploch <dploch@google.com> parents: 36928 diff changeset	24 fancyopts,
27479 3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	25 filemerge,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	26 fileset,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	27 minirst,
32192 964c6be36590 py3: make sure opts are passed and used correctly in help command Pulkit Goyal <7895pulkit@gmail.com> parents: 32076 diff changeset	28 pycompat,
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	29 registrar,
27479 3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	30 revset,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	31 templatefilters,
36928 521f6c7e1756 templater: split template functions to new module Yuya Nishihara <yuya@tcha.org> parents: 36481 diff changeset	32 templatefuncs,
27479 3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	33 templatekw,
40412 e928bedf0919 help: describe what ui.tweakdefaults changes, concretely Valentin Gatien-Baron <vgatien-baron@janestreet.com> parents: 40295 diff changeset	34 ui as uimod,
27479 3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	35 util,
3ce1d50daa99 help: use absolute_import Gregory Szorc <gregory.szorc@gmail.com> parents: 27400 diff changeset	36 )
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	37 from .hgweb import webcommands
43715 5be909dbe385 util: remove datapath and swith users over to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43676 diff changeset	38 from .utils import (
5be909dbe385 util: remove datapath and swith users over to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43676 diff changeset	39 compression,
5be909dbe385 util: remove datapath and swith users over to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43676 diff changeset	40 resourceutil,
5be909dbe385 util: remove datapath and swith users over to resourceutil Martin von Zweigbergk <martinvonz@google.com> parents: 43676 diff changeset	41 )
8863 7b19c3c0172b help: adding a new help topic about extensions C?dric Duval <cedricduval@free.fr> parents: 8668 diff changeset	42
32331 bd872f64a8ba cleanup: use set literals Martin von Zweigbergk <martinvonz@google.com> parents: 32192 diff changeset	43 _exclkeywords = {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	44 b"(ADVANCED)",
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	45 b"(DEPRECATED)",
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	46 b"(EXPERIMENTAL)",
31097 6918c9215201 help: hide command line options marked as "advanced" Jun Wu <quark@fb.com> parents: 31081 diff changeset	47 # i18n: "(ADVANCED)" is a keyword, must be translated consistently
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	48 _(b"(ADVANCED)"),
26370 44cc9f63a2f1 help: include parens in DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26369 diff changeset	49 # i18n: "(DEPRECATED)" is a keyword, must be translated consistently
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	50 _(b"(DEPRECATED)"),
26370 44cc9f63a2f1 help: include parens in DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26369 diff changeset	51 # i18n: "(EXPERIMENTAL)" is a keyword, must be translated consistently
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	52 _(b"(EXPERIMENTAL)"),
32331 bd872f64a8ba cleanup: use set literals Martin von Zweigbergk <martinvonz@google.com> parents: 32192 diff changeset	53 }
26369 4799b5c4aaf4 help: define list of keywords that should be excluded from non-verbose output Yuya Nishihara <yuya@tcha.org> parents: 26238 diff changeset	54
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	55 # The order in which command categories will be displayed.
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	56 # Extensions with custom categories should insert them into this list
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	57 # after/before the appropriate item, rather than replacing the list or
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	58 # assuming absolute positions.
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	59 CATEGORY_ORDER = [
40293 c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	60 registrar.command.CATEGORY_REPO_CREATION,
c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	61 registrar.command.CATEGORY_REMOTE_REPO_MANAGEMENT,
c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	62 registrar.command.CATEGORY_COMMITTING,
c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	63 registrar.command.CATEGORY_CHANGE_MANAGEMENT,
c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	64 registrar.command.CATEGORY_CHANGE_ORGANIZATION,
c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	65 registrar.command.CATEGORY_FILE_CONTENTS,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	66 registrar.command.CATEGORY_CHANGE_NAVIGATION,
40293 c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	67 registrar.command.CATEGORY_WORKING_DIRECTORY,
c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	68 registrar.command.CATEGORY_IMPORT_EXPORT,
c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	69 registrar.command.CATEGORY_MAINTENANCE,
c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	70 registrar.command.CATEGORY_HELP,
c303d65d2e34 help: assigning categories to existing commands rdamazio@google.com parents: 40292 diff changeset	71 registrar.command.CATEGORY_MISC,
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	72 registrar.command.CATEGORY_NONE,
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	73 ]
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	74
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	75 # Human-readable category names. These are translated.
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	76 # Extensions with custom categories should add their names here.
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	77 CATEGORY_NAMES = {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	78 registrar.command.CATEGORY_REPO_CREATION: b'Repository creation',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	79 registrar.command.CATEGORY_REMOTE_REPO_MANAGEMENT: b'Remote repository management',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	80 registrar.command.CATEGORY_COMMITTING: b'Change creation',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	81 registrar.command.CATEGORY_CHANGE_NAVIGATION: b'Change navigation',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	82 registrar.command.CATEGORY_CHANGE_MANAGEMENT: b'Change manipulation',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	83 registrar.command.CATEGORY_CHANGE_ORGANIZATION: b'Change organization',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	84 registrar.command.CATEGORY_WORKING_DIRECTORY: b'Working directory management',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	85 registrar.command.CATEGORY_FILE_CONTENTS: b'File content management',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	86 registrar.command.CATEGORY_IMPORT_EXPORT: b'Change import/export',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	87 registrar.command.CATEGORY_MAINTENANCE: b'Repository maintenance',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	88 registrar.command.CATEGORY_HELP: b'Help',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	89 registrar.command.CATEGORY_MISC: b'Miscellaneous commands',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	90 registrar.command.CATEGORY_NONE: b'Uncategorized commands',
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	91 }
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	92
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	93 # Topic categories.
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	94 TOPIC_CATEGORY_IDS = b'ids'
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	95 TOPIC_CATEGORY_OUTPUT = b'output'
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	96 TOPIC_CATEGORY_CONFIG = b'config'
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	97 TOPIC_CATEGORY_CONCEPTS = b'concepts'
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	98 TOPIC_CATEGORY_MISC = b'misc'
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	99 TOPIC_CATEGORY_NONE = b'none'
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	100
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	101 # The order in which topic categories will be displayed.
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	102 # Extensions with custom categories should insert them into this list
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	103 # after/before the appropriate item, rather than replacing the list or
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	104 # assuming absolute positions.
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	105 TOPIC_CATEGORY_ORDER = [
40294 fabbf9310025 help: assigning topic categories Rodrigo Damazio <rdamazio@google.com> parents: 40293 diff changeset	106 TOPIC_CATEGORY_IDS,
fabbf9310025 help: assigning topic categories Rodrigo Damazio <rdamazio@google.com> parents: 40293 diff changeset	107 TOPIC_CATEGORY_OUTPUT,
fabbf9310025 help: assigning topic categories Rodrigo Damazio <rdamazio@google.com> parents: 40293 diff changeset	108 TOPIC_CATEGORY_CONFIG,
fabbf9310025 help: assigning topic categories Rodrigo Damazio <rdamazio@google.com> parents: 40293 diff changeset	109 TOPIC_CATEGORY_CONCEPTS,
fabbf9310025 help: assigning topic categories Rodrigo Damazio <rdamazio@google.com> parents: 40293 diff changeset	110 TOPIC_CATEGORY_MISC,
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	111 TOPIC_CATEGORY_NONE,
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	112 ]
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	113
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	114 # Human-readable topic category names. These are translated.
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	115 TOPIC_CATEGORY_NAMES = {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	116 TOPIC_CATEGORY_IDS: b'Mercurial identifiers',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	117 TOPIC_CATEGORY_OUTPUT: b'Mercurial output',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	118 TOPIC_CATEGORY_CONFIG: b'Mercurial configuration',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	119 TOPIC_CATEGORY_CONCEPTS: b'Concepts',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	120 TOPIC_CATEGORY_MISC: b'Miscellaneous',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	121 TOPIC_CATEGORY_NONE: b'Uncategorized topics',
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	122 }
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	123
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	124
20582 02c303f64917 help: exclude deprecated extensions in the disabled part of 'help extensions' Augie Fackler <raf@durin42.com> parents: 20034 diff changeset	125 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	126 '''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	127 rst = []
af69b2b64d6e help: format extension lists using RST Olav Reinert <seroton10@gmail.com> parents: 16845 diff changeset	128 if exts:
43106 d783f945a701 py3: finish porting iteritems() to pycompat and remove source transformer Gregory Szorc <gregory.szorc@gmail.com> parents: 43089 diff changeset	129 for name, desc in sorted(pycompat.iteritems(exts)):
26371 51b309ce6c7d help: unify handling of DEPRECATED/EXPERIMENTAL keywords Yuya Nishihara <yuya@tcha.org> parents: 26370 diff changeset	130 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	131 continue
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	132 rst.append(b'%s:%s: %s\n' % (b' ' * indent, name, desc))
27151 7625f6387fc4 help: make listexts less confusing for deprecated exts timeless <timeless@mozdev.org> parents: 26845 diff changeset	133 if rst:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	134 rst.insert(0, b'\n%s\n\n' % header)
16852 af69b2b64d6e help: format extension lists using RST Olav Reinert <seroton10@gmail.com> parents: 16845 diff changeset	135 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	136
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	137
26413 e0c572d4d112 help: pass around ui to doc loader (API) Yuya Nishihara <yuya@tcha.org> parents: 26371 diff changeset	138 def extshelp(ui):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	139 rst = loaddoc(b'extensions')(ui).splitlines(True)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	140 rst.extend(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	141 listexts(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	142 _(b'enabled extensions:'), extensions.enabled(), showdeprecated=True
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	143 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	144 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	145 rst.extend(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	146 listexts(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	147 _(b'disabled extensions:'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	148 extensions.disabled(),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	149 showdeprecated=ui.verbose,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	150 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	151 )
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	152 doc = b''.join(rst)
8863 7b19c3c0172b help: adding a new help topic about extensions C?dric Duval <cedricduval@free.fr> parents: 8668 diff changeset	153 return doc
7013 f56e788fa292 i18n: mark help strings for translation Martin Geisler <mg@daimi.au.dk> parents: 7012 diff changeset	154
44341 142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	155 def parsedefaultmarker(text):
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	156 """given a text 'abc (DEFAULT: def.ghi)',
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	157 returns (b'abc', (b'def', b'ghi')). Otherwise return None"""
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	158 if text[-1:] == b')':
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	159 marker = b' (DEFAULT: '
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	160 pos = text.find(marker)
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	161 if pos >= 0:
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	162 item = text[pos + len(marker):-1]
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	163 return text[:pos], item.split(b'.', 2)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	164
44341 142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	165 def optrst(header, options, verbose, ui):
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	166 data = []
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	167 multioccur = False
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	168 for option in options:
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	169 if len(option) == 5:
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	170 shortopt, longopt, default, desc, optlabel = option
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	171 else:
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	172 shortopt, longopt, default, desc = option
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	173 optlabel = _(b"VALUE") # default label
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	174
26369 4799b5c4aaf4 help: define list of keywords that should be excluded from non-verbose output Yuya Nishihara <yuya@tcha.org> parents: 26238 diff changeset	175 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	176 continue
44341 142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	177 defaultstrsuffix = b''
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	178 if default is None:
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	179 parseresult = parsedefaultmarker(desc)
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	180 if parseresult is not None:
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	181 (desc, (section, name)) = parseresult
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	182 if ui.configbool(section, name):
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	183 default = True
142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	184 defaultstrsuffix = _(b' from config')
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	185 so = b''
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	186 if shortopt:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	187 so = b'-' + shortopt
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	188 lo = b'--' + longopt
41019 fcc0a7ac9ebd help: show "[no-]" only for default-on Flags Martin von Zweigbergk <martinvonz@google.com> parents: 40968 diff changeset	189 if default is True:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	190 lo = b'--[no-]' + longopt
37094 979c8ce9022d fancyopts: fix rendering of customopt defaults in help text Daniel Ploch <dploch@google.com> parents: 36928 diff changeset	191
979c8ce9022d fancyopts: fix rendering of customopt defaults in help text Daniel Ploch <dploch@google.com> parents: 36928 diff changeset	192 if isinstance(default, fancyopts.customopt):
37095 ef6215df2402 fancyopts: prevent mutation of the default value in customopts Daniel Ploch <dploch@google.com> parents: 37094 diff changeset	193 default = default.getdefaultvalue()
41020 e8e2a7656e83 help: hide default value for default-off flags Martin von Zweigbergk <martinvonz@google.com> parents: 41019 diff changeset	194 if default and not callable(default):
32642 d110fb58424c help: convert flag default to bytes portably Augie Fackler <raf@durin42.com> parents: 32638 diff changeset	195 # default is of unknown type, and in Python 2 we abused
d110fb58424c help: convert flag default to bytes portably Augie Fackler <raf@durin42.com> parents: 32638 diff changeset	196 # the %s-shows-repr property to handle integers etc. To
d110fb58424c help: convert flag default to bytes portably Augie Fackler <raf@durin42.com> parents: 32638 diff changeset	197 # match that behavior on Python 3, we do str(default) and
d110fb58424c help: convert flag default to bytes portably Augie Fackler <raf@durin42.com> parents: 32638 diff changeset	198 # then convert it to bytes.
40966 05abb5fb146a help: use "default: on" instead of "default: True" Martin von Zweigbergk <martinvonz@google.com> parents: 40642 diff changeset	199 defaultstr = pycompat.bytestr(default)
41020 e8e2a7656e83 help: hide default value for default-off flags Martin von Zweigbergk <martinvonz@google.com> parents: 41019 diff changeset	200 if default is True:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	201 defaultstr = _(b"on")
44341 142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	202 desc += _(b" (default: %s)") % (defaultstr + defaultstrsuffix)
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	203
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	204 if isinstance(default, list):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	205 lo += b" %s [+]" % optlabel
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	206 multioccur = True
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	207 elif (default is not None) and not isinstance(default, bool):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	208 lo += b" %s" % optlabel
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	209
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	210 data.append((so, lo, desc))
c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	211
22117 c1d93edcf004 help: fold repeatable option message into option table header Matt Mackall <mpm@selenic.com> parents: 22116 diff changeset	212 if multioccur:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	213 header += _(b" ([+] can be repeated)")
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	214
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	215 rst = [b'\n%s:\n\n' % header]
22116 161085f87b95 help: roll option list header into option formatter Matt Mackall <mpm@selenic.com> parents: 22115 diff changeset	216 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	217
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	218 return b''.join(rst)
16781 c0b98f436cce help: move some helper functions to help.py Olav Reinert <seroton10@gmail.com> parents: 16711 diff changeset	219
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	220
17837 b623e323c561 help: indicate help omitting if help document is not fully displayed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17323 diff changeset	221 def indicateomitted(rst, omitted, notomitted=None):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	222 rst.append(b'\n\n.. container:: omitted\n\n %s\n\n' % omitted)
17837 b623e323c561 help: indicate help omitting if help document is not fully displayed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17323 diff changeset	223 if notomitted:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	224 rst.append(b'\n\n.. container:: notomitted\n\n %s\n\n' % notomitted)
17837 b623e323c561 help: indicate help omitting if help document is not fully displayed FUJIWARA Katsunori <foozy@lares.dti.ne.jp> parents: 17323 diff changeset	225
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	226
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	227 def filtercmd(ui, cmd, func, kw, doc):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	228 if not ui.debugflag and cmd.startswith(b"debug") and kw != b"debug":
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	229 # Debug command, and user is not looking for those.
27323 0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	230 return True
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	231 if not ui.verbose:
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	232 if not kw and not doc:
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	233 # Command had no documentation, no point in showing it by default.
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	234 return True
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	235 if getattr(func, 'alias', False) and not getattr(func, 'owndoc', False):
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	236 # Alias didn't have its own documentation.
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	237 return True
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	238 if doc and any(w in doc for w in _exclkeywords):
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	239 # Documentation has excluded keywords.
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	240 return True
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	241 if kw == b"shortlist" and not getattr(func, 'helpbasic', False):
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	242 # We're presenting the short list but the command is not basic.
27323 0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	243 return True
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	244 if ui.configbool(b'help', b'hidden-command.%s' % cmd):
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	245 # Configuration explicitly hides the command.
27323 0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	246 return True
0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	247 return False
0fe93498ef07 help: refactor filtercmd timeless <timeless@mozdev.org> parents: 27152 diff changeset	248
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	249
40489 1ddd202c47d9 help: allow hiding of help topics rdamazio@google.com parents: 40488 diff changeset	250 def filtertopic(ui, topic):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	251 return ui.configbool(b'help', b'hidden-topic.%s' % topic, False)
40489 1ddd202c47d9 help: allow hiding of help topics rdamazio@google.com parents: 40488 diff changeset	252
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	253
32599 1b90036f42f0 help: pass commands module by argument Yuya Nishihara <yuya@tcha.org> parents: 32582 diff changeset	254 def topicmatch(ui, commands, kw):
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	255 """Return help topics matching kw.
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	256
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	257 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	258 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	259 """
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	260 kw = encoding.lower(kw)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	261
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	262 def lowercontains(container):
16845 4594729c61ee help: fix search with `-k` option in non-ASCII locales Nikolaj Sjujskij <sterkrig@myopera.com> parents: 16816 diff changeset	263 return kw in encoding.lower(container) # translated in helptable
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	264
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	265 results = {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	266 b'topics': [],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	267 b'commands': [],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	268 b'extensions': [],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	269 b'extensioncommands': [],
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	270 }
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	271 for topic in helptable:
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	272 names, header, doc = topic[0:3]
22322 e284de138f00 help: only call doc() when it is callable Gregory Szorc <gregory.szorc@gmail.com> parents: 21796 diff changeset	273 # Old extensions may use a str as doc.
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	274 if (
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	275 sum(map(lowercontains, names))
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	276 or lowercontains(header)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	277 or (callable(doc) and lowercontains(doc(ui)))
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	278 ):
40489 1ddd202c47d9 help: allow hiding of help topics rdamazio@google.com parents: 40488 diff changeset	279 name = names[0]
1ddd202c47d9 help: allow hiding of help topics rdamazio@google.com parents: 40488 diff changeset	280 if not filtertopic(ui, name):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	281 results[b'topics'].append((names[0], header))
43106 d783f945a701 py3: finish porting iteritems() to pycompat and remove source transformer Gregory Szorc <gregory.szorc@gmail.com> parents: 43089 diff changeset	282 for cmd, entry in pycompat.iteritems(commands.table):
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	283 if len(entry) == 3:
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	284 summary = entry[2]
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	285 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	286 summary = b''
16845 4594729c61ee help: fix search with `-k` option in non-ASCII locales Nikolaj Sjujskij <sterkrig@myopera.com> parents: 16816 diff changeset	287 # translate docs before searching there
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	288 func = entry[0]
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	289 docs = _(pycompat.getdoc(func)) or b''
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	290 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	291 doclines = docs.splitlines()
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	292 if doclines:
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	293 summary = doclines[0]
36283 4174970c9147 help: use cmdutil.parsealiases() to resolve command name Yuya Nishihara <yuya@tcha.org> parents: 36282 diff changeset	294 cmdname = cmdutil.parsealiases(cmd)[0]
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	295 if filtercmd(ui, cmdname, func, kw, docs):
27324 5456374561a7 help: call filtercmd from topicmatch timeless <timeless@mozdev.org> parents: 27323 diff changeset	296 continue
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	297 results[b'commands'].append((cmdname, summary))
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	298 for name, docs in itertools.chain(
43106 d783f945a701 py3: finish porting iteritems() to pycompat and remove source transformer Gregory Szorc <gregory.szorc@gmail.com> parents: 43089 diff changeset	299 pycompat.iteritems(extensions.enabled(False)),
d783f945a701 py3: finish porting iteritems() to pycompat and remove source transformer Gregory Szorc <gregory.szorc@gmail.com> parents: 43089 diff changeset	300 pycompat.iteritems(extensions.disabled()),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	301 ):
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	302 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	303 continue
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	304 name = name.rpartition(b'.')[-1]
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	305 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	306 # extension docs are already translated
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	307 results[b'extensions'].append((name, docs.splitlines()[0]))
34912 1e2454b60e59 help: do not abort topicmatch() because of unimportable extensions Yuya Nishihara <yuya@tcha.org> parents: 33499 diff changeset	308 try:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	309 mod = extensions.load(ui, name, b'')
34912 1e2454b60e59 help: do not abort topicmatch() because of unimportable extensions Yuya Nishihara <yuya@tcha.org> parents: 33499 diff changeset	310 except ImportError:
1e2454b60e59 help: do not abort topicmatch() because of unimportable extensions Yuya Nishihara <yuya@tcha.org> parents: 33499 diff changeset	311 # debug message would be printed in extensions.load()
1e2454b60e59 help: do not abort topicmatch() because of unimportable extensions Yuya Nishihara <yuya@tcha.org> parents: 33499 diff changeset	312 continue
43106 d783f945a701 py3: finish porting iteritems() to pycompat and remove source transformer Gregory Szorc <gregory.szorc@gmail.com> parents: 43089 diff changeset	313 for cmd, entry in pycompat.iteritems(getattr(mod, 'cmdtable', {})):
16711 497deec204d1 help: add --keyword (-k) for searching help Augie Fackler <raf@durin42.com> parents: 16710 diff changeset	314 if kw in cmd or (len(entry) > 2 and lowercontains(entry[2])):
36283 4174970c9147 help: use cmdutil.parsealiases() to resolve command name Yuya Nishihara <yuya@tcha.org> parents: 36282 diff changeset	315 cmdname = cmdutil.parsealiases(cmd)[0]
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	316 func = entry[0]
444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	317 cmddoc = pycompat.getdoc(func)
32638 c9318beb7c1a py3: convert __doc__ back to bytes in help.py Yuya Nishihara <yuya@tcha.org> parents: 32599 diff changeset	318 if cmddoc:
c9318beb7c1a py3: convert __doc__ back to bytes in help.py Yuya Nishihara <yuya@tcha.org> parents: 32599 diff changeset	319 cmddoc = gettext(cmddoc).splitlines()[0]
16884 4fd1f1d7569b help: fix 'hg help -k' matching an extension without docs Thomas Arendsen Hein <thomas@intevation.de> parents: 16855 diff changeset	320 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	321 cmddoc = _(b'(no help text available)')
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	322 if filtercmd(ui, cmdname, func, kw, cmddoc):
27387 dfab0afde928 help: filter extension commands timeless <timeless@mozdev.org> parents: 27379 diff changeset	323 continue
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	324 results[b'extensioncommands'].append((cmdname, cmddoc))
16710 a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	325 return results
a17983680f12 help: introduce topicmatch for finding topics matching a keyword Augie Fackler <raf@durin42.com> parents: 16568 diff changeset	326
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	327
27375 c4a062d090ee help: teach loaddoc to load from a different directory Gregory Szorc <gregory.szorc@gmail.com> parents: 27325 diff changeset	328 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	329 """Return a delayed loader for help/topic.txt."""
3798 6f0c42d50394 move environment topic Matt Mackall <mpm@selenic.com> parents: 3795 diff changeset	330
26413 e0c572d4d112 help: pass around ui to doc loader (API) Yuya Nishihara <yuya@tcha.org> parents: 26371 diff changeset	331 def loader(ui):
44029 52f0140c2604 resourceutil: don't limit resources to the `mercurial` package Matt Harbison <matt_harbison@yahoo.com> parents: 43877 diff changeset	332 package = b'mercurial.helptext'
27375 c4a062d090ee help: teach loaddoc to load from a different directory Gregory Szorc <gregory.szorc@gmail.com> parents: 27325 diff changeset	333 if subdir:
44029 52f0140c2604 resourceutil: don't limit resources to the `mercurial` package Matt Harbison <matt_harbison@yahoo.com> parents: 43877 diff changeset	334 package += b'.' + subdir
43877 1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43715 diff changeset	335 with resourceutil.open_resource(package, topic + b'.txt') as fp:
1390bb81163e help: get helptext/ data from `resources` module if available Martin von Zweigbergk <martinvonz@google.com> parents: 43715 diff changeset	336 doc = gettext(fp.read())
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	337 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	338 doc = rewriter(ui, topic, doc)
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	339 return doc
0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	340
9539 c904e76e3834 help: move help topics from mercurial/help.py to help/.txt Martin Geisler <mg@lazybytes.net>* parents: 9536 diff changeset	341 return loader
7677 6a0bc2dc9da6 help: add a topic about some of the templating features Alexander Solovyov <piranha@piranha.org.ua> parents: 7387 diff changeset	342
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	343
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	344 internalstable = sorted(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	345 [
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	346 ([b'bundle2'], _(b'Bundle2'), loaddoc(b'bundle2', subdir=b'internals')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	347 ([b'bundles'], _(b'Bundles'), loaddoc(b'bundles', subdir=b'internals')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	348 ([b'cbor'], _(b'CBOR'), loaddoc(b'cbor', subdir=b'internals')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	349 ([b'censor'], _(b'Censor'), loaddoc(b'censor', subdir=b'internals')),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	350 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	351 [b'changegroups'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	352 _(b'Changegroups'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	353 loaddoc(b'changegroups', subdir=b'internals'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	354 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	355 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	356 [b'config'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	357 _(b'Config Registrar'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	358 loaddoc(b'config', subdir=b'internals'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	359 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	360 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	361 [b'extensions', b'extension'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	362 _(b'Extension API'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	363 loaddoc(b'extensions', subdir=b'internals'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	364 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	365 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	366 [b'mergestate'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	367 _(b'Mergestate'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	368 loaddoc(b'mergestate', subdir=b'internals'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	369 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	370 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	371 [b'requirements'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	372 _(b'Repository Requirements'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	373 loaddoc(b'requirements', subdir=b'internals'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	374 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	375 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	376 [b'revlogs'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	377 _(b'Revision Logs'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	378 loaddoc(b'revlogs', subdir=b'internals'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	379 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	380 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	381 [b'wireprotocol'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	382 _(b'Wire Protocol'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	383 loaddoc(b'wireprotocol', subdir=b'internals'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	384 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	385 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	386 [b'wireprotocolrpc'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	387 _(b'Wire Protocol RPC'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	388 loaddoc(b'wireprotocolrpc', subdir=b'internals'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	389 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	390 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	391 [b'wireprotocolv2'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	392 _(b'Wire Protocol Version 2'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	393 loaddoc(b'wireprotocolv2', subdir=b'internals'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	394 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	395 ]
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	396 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	397
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	398
fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	399 def internalshelp(ui):
fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	400 """Generate the index for the "internals" topic."""
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	401 lines = [
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	402 b'To access a subtopic, use "hg help internals.{subtopic-name}"\n',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	403 b'\n',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	404 ]
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	405 for names, header, doc in internalstable:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	406 lines.append(b' :%s: %s\n' % (names[0], header))
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	407
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	408 return b''.join(lines)
27376 fc810d950278 help: add "internals" topic Gregory Szorc <gregory.szorc@gmail.com> parents: 27375 diff changeset	409
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	410
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	411 helptable = sorted(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	412 [
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	413 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	414 [b'bundlespec'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	415 _(b"Bundle File Formats"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	416 loaddoc(b'bundlespec'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	417 TOPIC_CATEGORY_CONCEPTS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	418 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	419 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	420 [b'color'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	421 _(b"Colorizing Outputs"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	422 loaddoc(b'color'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	423 TOPIC_CATEGORY_OUTPUT,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	424 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	425 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	426 [b"config", b"hgrc"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	427 _(b"Configuration Files"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	428 loaddoc(b'config'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	429 TOPIC_CATEGORY_CONFIG,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	430 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	431 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	432 [b'deprecated'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	433 _(b"Deprecated Features"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	434 loaddoc(b'deprecated'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	435 TOPIC_CATEGORY_MISC,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	436 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	437 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	438 [b"dates"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	439 _(b"Date Formats"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	440 loaddoc(b'dates'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	441 TOPIC_CATEGORY_OUTPUT,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	442 ),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	443 (
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	444 [b"flags"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	445 _(b"Command-line flags"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	446 loaddoc(b'flags'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	447 TOPIC_CATEGORY_CONFIG,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	448 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	449 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	450 [b"patterns"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	451 _(b"File Name Patterns"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	452 loaddoc(b'patterns'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	453 TOPIC_CATEGORY_IDS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	454 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	455 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	456 [b'environment', b'env'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	457 _(b'Environment Variables'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	458 loaddoc(b'environment'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	459 TOPIC_CATEGORY_CONFIG,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	460 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	461 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	462 [
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	463 b'revisions',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	464 b'revs',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	465 b'revsets',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	466 b'revset',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	467 b'multirevs',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	468 b'mrevs',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	469 ],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	470 _(b'Specifying Revisions'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	471 loaddoc(b'revisions'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	472 TOPIC_CATEGORY_IDS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	473 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	474 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	475 [b'filesets', b'fileset'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	476 _(b"Specifying File Sets"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	477 loaddoc(b'filesets'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	478 TOPIC_CATEGORY_IDS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	479 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	480 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	481 [b'diffs'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	482 _(b'Diff Formats'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	483 loaddoc(b'diffs'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	484 TOPIC_CATEGORY_OUTPUT,
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	485 ),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	486 (
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	487 [b'merge-tools', b'mergetools', b'mergetool'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	488 _(b'Merge Tools'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	489 loaddoc(b'merge-tools'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	490 TOPIC_CATEGORY_CONFIG,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	491 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	492 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	493 [b'templating', b'templates', b'template', b'style'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	494 _(b'Template Usage'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	495 loaddoc(b'templates'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	496 TOPIC_CATEGORY_OUTPUT,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	497 ),
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	498 ([b'urls'], _(b'URL Paths'), loaddoc(b'urls'), TOPIC_CATEGORY_IDS),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	499 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	500 [b"extensions"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	501 _(b"Using Additional Features"),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	502 extshelp,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	503 TOPIC_CATEGORY_CONFIG,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	504 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	505 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	506 [b"subrepos", b"subrepo"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	507 _(b"Subrepositories"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	508 loaddoc(b'subrepos'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	509 TOPIC_CATEGORY_CONCEPTS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	510 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	511 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	512 [b"hgweb"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	513 _(b"Configuring hgweb"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	514 loaddoc(b'hgweb'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	515 TOPIC_CATEGORY_CONFIG,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	516 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	517 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	518 [b"glossary"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	519 _(b"Glossary"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	520 loaddoc(b'glossary'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	521 TOPIC_CATEGORY_CONCEPTS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	522 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	523 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	524 [b"hgignore", b"ignore"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	525 _(b"Syntax for Mercurial Ignore Files"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	526 loaddoc(b'hgignore'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	527 TOPIC_CATEGORY_IDS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	528 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	529 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	530 [b"phases"],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	531 _(b"Working with Phases"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	532 loaddoc(b'phases'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	533 TOPIC_CATEGORY_CONCEPTS,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	534 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	535 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	536 [b'scripting'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	537 _(b'Using Mercurial from scripts and automation'),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	538 loaddoc(b'scripting'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	539 TOPIC_CATEGORY_MISC,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	540 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	541 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	542 [b'internals'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	543 _(b"Technical implementation topics"),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	544 internalshelp,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	545 TOPIC_CATEGORY_MISC,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	546 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	547 (
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	548 [b'pager'],
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	549 _(b"Pager Support"),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	550 loaddoc(b'pager'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	551 TOPIC_CATEGORY_CONFIG,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	552 ),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	553 ]
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	554 )
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	555
27379 2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	556 # 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	557 subtopics = {
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	558 b'internals': internalstable,
27379 2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	559 }
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	560
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	561 # 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	562 # returning the updated version
14318 1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	563 helphooks = {}
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	564
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	565
12820 0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	566 def addtopichook(topic, rewriter):
0edc0aa7432d help: add topic rewriting hooks Patrick Mezard <pmezard@gmail.com> parents: 12818 diff changeset	567 helphooks.setdefault(topic, []).append(rewriter)
13593 cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	568
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	569
26414 c44b507e7c78 help: pass around ui to rewriter hooks (API) Yuya Nishihara <yuya@tcha.org> parents: 26413 diff changeset	570 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	571 """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	572 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	573 """
cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	574 entries = []
cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	575 for name in sorted(items):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	576 text = (pycompat.getdoc(items[name]) or b'').rstrip()
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	577 if not text 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	578 continue
cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	579 text = gettext(text)
24098 067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	580 if dedent:
32582 633c635a790a help: work around textwrap.dedent() only working on strings Augie Fackler <raf@durin42.com> parents: 32580 diff changeset	581 # Abuse latin1 to use textwrap.dedent() on bytes.
633c635a790a help: work around textwrap.dedent() only working on strings Augie Fackler <raf@durin42.com> parents: 32580 diff changeset	582 text = textwrap.dedent(text.decode('latin1')).encode('latin1')
13593 cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	583 lines = text.splitlines()
16250 684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	584 doclines = [(lines[0])]
684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	585 for l in lines[1:]:
684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	586 # Stop once we find some Python doctest
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	587 if l.strip().startswith(b'>>>'):
16250 684864d54903 help: strip doctest from dochelp "Yann E. MORIN" <yann.morin.1998@free.fr> parents: 16126 diff changeset	588 break
24098 067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	589 if dedent:
067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	590 doclines.append(l.rstrip())
067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	591 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	592 doclines.append(b' ' + l.strip())
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	593 entries.append(b'\n'.join(doclines))
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	594 entries = b'\n\n'.join(entries)
13593 cc4721ed7a2a help: extract items doc generation function Patrick Mezard <pmezard@gmail.com> parents: 12828 diff changeset	595 return doc.replace(marker, entries)
14318 1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	596
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	597
24098 067540702f64 help: teach topic symbols how to dedent Gregory Szorc <gregory.szorc@gmail.com> parents: 24080 diff changeset	598 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	599 def add(ui, topic, doc):
c44b507e7c78 help: pass around ui to rewriter hooks (API) Yuya Nishihara <yuya@tcha.org> parents: 26413 diff changeset	600 return makeitemsdoc(ui, topic, doc, marker, symbols, dedent=dedent)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	601
14318 1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	602 addtopichook(topic, add)
1f46be4689ed help: consolidate topic hooks in help.py Matt Mackall <mpm@selenic.com> parents: 14317 diff changeset	603
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	604
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	605 addtopicsymbols(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	606 b'bundlespec',
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	607 b'.. bundlecompressionmarker',
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	608 compression.bundlecompressiontopics(),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	609 )
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	610 addtopicsymbols(b'filesets', b'.. predicatesmarker', fileset.symbols)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	611 addtopicsymbols(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	612 b'merge-tools', b'.. internaltoolsmarker', filemerge.internalsdoc
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	613 )
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	614 addtopicsymbols(b'revisions', b'.. predicatesmarker', revset.symbols)
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	615 addtopicsymbols(b'templates', b'.. keywordsmarker', templatekw.keywords)
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	616 addtopicsymbols(b'templates', b'.. filtersmarker', templatefilters.filters)
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	617 addtopicsymbols(b'templates', b'.. functionsmarker', templatefuncs.funcs)
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	618 addtopicsymbols(
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	619 b'hgweb', b'.. webcommandsmarker', webcommands.commands, dedent=True
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	620 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	621
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	622
40412 e928bedf0919 help: describe what ui.tweakdefaults changes, concretely Valentin Gatien-Baron <vgatien-baron@janestreet.com> parents: 40295 diff changeset	623 def inserttweakrc(ui, topic, doc):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	624 marker = b'.. tweakdefaultsmarker'
40412 e928bedf0919 help: describe what ui.tweakdefaults changes, concretely Valentin Gatien-Baron <vgatien-baron@janestreet.com> parents: 40295 diff changeset	625 repl = uimod.tweakrc
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	626
40412 e928bedf0919 help: describe what ui.tweakdefaults changes, concretely Valentin Gatien-Baron <vgatien-baron@janestreet.com> parents: 40295 diff changeset	627 def sub(m):
e928bedf0919 help: describe what ui.tweakdefaults changes, concretely Valentin Gatien-Baron <vgatien-baron@janestreet.com> parents: 40295 diff changeset	628 lines = [m.group(1) + s for s in repl.splitlines()]
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	629 return b'\n'.join(lines)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	630
40412 e928bedf0919 help: describe what ui.tweakdefaults changes, concretely Valentin Gatien-Baron <vgatien-baron@janestreet.com> parents: 40295 diff changeset	631 return re.sub(br'( *)%s' % re.escape(marker), sub, doc)
e928bedf0919 help: describe what ui.tweakdefaults changes, concretely Valentin Gatien-Baron <vgatien-baron@janestreet.com> parents: 40295 diff changeset	632
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	633
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	634 addtopichook(b'config', inserttweakrc)
40412 e928bedf0919 help: describe what ui.tweakdefaults changes, concretely Valentin Gatien-Baron <vgatien-baron@janestreet.com> parents: 40295 diff changeset	635
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	636
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	637 def help_(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	638 ui,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	639 commands,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	640 name,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	641 unknowncmd=False,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	642 full=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	643 subtopic=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	644 fullname=None,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	645 **opts
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	646 ):
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	647 '''
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	648 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	649 '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	650 '''
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	651
32192 964c6be36590 py3: make sure opts are passed and used correctly in help command Pulkit Goyal <7895pulkit@gmail.com> parents: 32076 diff changeset	652 opts = pycompat.byteskwargs(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	653
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	654 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	655 try:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	656 aliases, entry = cmdutil.findcmd(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	657 name, commands.table, strict=unknowncmd
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	658 )
25660 328739ea70c3 global: mass rewrite to use modern exception syntax Gregory Szorc <gregory.szorc@gmail.com> parents: 24871 diff changeset	659 except error.AmbiguousCommand as inst:
40263 8cf459d8b111 py3: use py3 as the test tag, dropping the k Martijn Pieters <mj@octobus.net> parents: 39630 diff changeset	660 # py3 fix: except vars can't be used outside the scope of the
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	661 # 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	662 prefix = inst.args[0]
36283 4174970c9147 help: use cmdutil.parsealiases() to resolve command name Yuya Nishihara <yuya@tcha.org> parents: 36282 diff changeset	663 select = lambda c: cmdutil.parsealiases(c)[0].startswith(prefix)
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	664 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	665 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	666
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	667 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	668
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	669 # 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	670 if getattr(entry[0], 'badalias', None):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	671 rst.append(entry[0].badalias + b'\n')
22162 7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	672 if entry[0].unknowncmd:
7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	673 try:
7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	674 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	675 except error.UnknownCommand:
7ada34676db8 help: provide help of bad alias without executing aliascmd() Yuya Nishihara <yuya@tcha.org> parents: 22160 diff changeset	676 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	677 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	678
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	679 # 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	680 if len(entry) > 2:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	681 if entry[2].startswith(b'hg'):
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	682 rst.append(b"%s\n" % entry[2])
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	683 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	684 rst.append(b'hg %s %s\n' % (aliases[0], entry[2]))
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	685 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	686 rst.append(b'hg %s\n' % aliases[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	687 # 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	688 if full and not ui.quiet and len(aliases) > 1:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	689 rst.append(_(b"\naliases: %s\n") % b', '.join(aliases[1:]))
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	690 rst.append(b'\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	691
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	692 # description
32638 c9318beb7c1a py3: convert __doc__ back to bytes in help.py Yuya Nishihara <yuya@tcha.org> parents: 32599 diff changeset	693 doc = gettext(pycompat.getdoc(entry[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	694 if not doc:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	695 doc = _(b"(no help text available)")
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	696 if util.safehasattr(entry[0], b'definition'): # aliased command
28828 3640c1702c43 help: report source of aliases timeless <timeless@mozdev.org> parents: 28523 diff changeset	697 source = entry[0].source
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	698 if entry[0].definition.startswith(b'!'): # shell alias
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	699 doc = _(b'shell alias for: %s\n\n%s\n\ndefined by: %s\n') % (
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	700 entry[0].definition[1:],
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	701 doc,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	702 source,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	703 )
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	704 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	705 doc = _(b'alias for: hg %s\n\n%s\n\ndefined by: %s\n') % (
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	706 entry[0].definition,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	707 doc,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	708 source,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	709 )
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	710 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	711 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	712 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	713 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	714 rst.extend(doc)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	715 rst.append(b'\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	716
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	717 # 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	718 # 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	719 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	720 mod = extensions.find(name)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	721 doc = gettext(pycompat.getdoc(mod)) or b''
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	722 if b'\n' in doc.strip():
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	723 msg = _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	724 b"(use 'hg help -e %s' to show help for "
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	725 b"the %s extension)"
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	726 ) % (name, name)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	727 rst.append(b'\n%s\n' % msg)
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	728 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	729 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	730
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	731 # 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	732 if not ui.quiet and entry[1]:
44341 142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	733 rst.append(optrst(_(b"options"), entry[1], ui.verbose, ui))
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	734
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	735 if ui.verbose:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	736 rst.append(
44341 142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	737 optrst(_(b"global options"), commands.globalopts, ui.verbose, ui)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	738 )
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	739
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	740 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	741 if not full:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	742 rst.append(_(b"\n(use 'hg %s -h' to show more help)\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	743 elif not ui.quiet:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	744 rst.append(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	745 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	746 b'\n(some details hidden, use --verbose '
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	747 b'to show complete help)'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	748 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	749 )
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	750
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	751 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	752
27325 eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	753 def helplist(select=None, **opts):
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	754 # Category -> list of commands
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	755 cats = {}
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	756 # Command -> short description
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	757 h = {}
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	758 # Command -> string showing synonyms
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	759 syns = {}
43106 d783f945a701 py3: finish porting iteritems() to pycompat and remove source transformer Gregory Szorc <gregory.szorc@gmail.com> parents: 43089 diff changeset	760 for c, e in pycompat.iteritems(commands.table):
36283 4174970c9147 help: use cmdutil.parsealiases() to resolve command name Yuya Nishihara <yuya@tcha.org> parents: 36282 diff changeset	761 fs = cmdutil.parsealiases(c)
4174970c9147 help: use cmdutil.parsealiases() to resolve command name Yuya Nishihara <yuya@tcha.org> parents: 36282 diff changeset	762 f = fs[0]
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	763 syns[f] = b', '.join(fs)
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	764 func = e[0]
40295 fa88170c10bb help: adding a proper declaration for shortlist/basic commands (API) Rodrigo Damazio <rdamazio@google.com> parents: 40294 diff changeset	765 if select and not select(f):
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	766 continue
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	767 doc = pycompat.getdoc(func)
40490 444861dc1e55 help: displaying documented aliases by default rdamazio@google.com parents: 40489 diff changeset	768 if filtercmd(ui, f, func, 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	769 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	770 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	771 if not doc:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	772 doc = _(b"(no help text available)")
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	773 h[f] = doc.splitlines()[0].rstrip()
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	774
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	775 cat = getattr(func, 'helpcategory', None) or (
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	776 registrar.command.CATEGORY_NONE
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	777 )
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	778 cats.setdefault(cat, []).append(f)
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	779
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	780 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	781 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	782 if not ui.quiet:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	783 rst.append(_(b'no commands defined\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	784 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	785
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	786 # Output top header.
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	787 if not ui.quiet:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	788 if name == b"shortlist":
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	789 rst.append(_(b'basic commands:\n\n'))
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	790 elif name == b"debug":
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	791 rst.append(_(b'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	792 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	793 rst.append(_(b'list of commands:\n'))
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	794
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	795 def appendcmds(cmds):
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	796 cmds = sorted(cmds)
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	797 for c in cmds:
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	798 if ui.verbose:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	799 rst.append(b" :%s: %s\n" % (syns[c], h[c]))
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	800 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	801 rst.append(b' :%s: %s\n' % (c, h[c]))
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	802
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	803 if name in (b'shortlist', b'debug'):
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	804 # List without categories.
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	805 appendcmds(h)
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	806 else:
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	807 # Check that all categories have an order.
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	808 missing_order = set(cats.keys()) - set(CATEGORY_ORDER)
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	809 if missing_order:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	810 ui.develwarn(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	811 b'help categories missing from CATEGORY_ORDER: %s'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	812 % missing_order
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	813 )
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	814
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	815 # List per category.
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	816 for cat in CATEGORY_ORDER:
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	817 catfns = cats.get(cat, [])
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	818 if catfns:
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	819 if len(cats) > 1:
170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	820 catname = gettext(CATEGORY_NAMES[cat])
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	821 rst.append(b"\n%s:\n" % catname)
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	822 rst.append(b"\n")
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	823 appendcmds(catfns)
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	824
27325 eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	825 ex = opts.get
43554 9f70512ae2cf cleanup: remove pointless r-prefixes on single-quoted strings Augie Fackler <augie@google.com> parents: 43117 diff changeset	826 anyopts = ex('keyword') or not (ex('command') or ex('extension'))
27325 eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	827 if not name and anyopts:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	828 exts = listexts(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	829 _(b'enabled extensions:'),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	830 extensions.enabled(),
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	831 showdeprecated=ui.verbose,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	832 )
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	833 if exts:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	834 rst.append(b'\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	835 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	836
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	837 rst.append(_(b"\nadditional help topics:\n"))
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	838 # Group commands by category.
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	839 topiccats = {}
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	840 for topic in helptable:
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	841 names, header, doc = topic[0:3]
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	842 if len(topic) > 3 and topic[3]:
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	843 category = topic[3]
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	844 else:
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	845 category = TOPIC_CATEGORY_NONE
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	846
40489 1ddd202c47d9 help: allow hiding of help topics rdamazio@google.com parents: 40488 diff changeset	847 topicname = names[0]
1ddd202c47d9 help: allow hiding of help topics rdamazio@google.com parents: 40488 diff changeset	848 if not filtertopic(ui, topicname):
1ddd202c47d9 help: allow hiding of help topics rdamazio@google.com parents: 40488 diff changeset	849 topiccats.setdefault(category, []).append(
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	850 (topicname, header)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	851 )
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	852
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	853 # Check that all categories have an order.
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	854 missing_order = set(topiccats.keys()) - set(TOPIC_CATEGORY_ORDER)
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	855 if missing_order:
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	856 ui.develwarn(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	857 b'help categories missing from TOPIC_CATEGORY_ORDER: %s'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	858 % missing_order
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	859 )
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	860
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	861 # Output topics per category.
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	862 for cat in TOPIC_CATEGORY_ORDER:
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	863 topics = topiccats.get(cat, [])
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	864 if topics:
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	865 if len(topiccats) > 1:
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	866 catname = gettext(TOPIC_CATEGORY_NAMES[cat])
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	867 rst.append(b"\n%s:\n" % catname)
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	868 rst.append(b"\n")
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	869 for t, desc in topics:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	870 rst.append(b" :%s: %s\n" % (t, desc))
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	871
22115 8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	872 if ui.quiet:
8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	873 pass
8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	874 elif ui.verbose:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	875 rst.append(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	876 b'\n%s\n'
44341 142d2a4cb69a help: add a mechanism to change flags' help depending on config Valentin Gatien-Baron <valentin.gatienbaron@gmail.com> parents: 44029 diff changeset	877 % optrst(_(b"global options"), commands.globalopts, ui.verbose, ui)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	878 )
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	879 if name == b'shortlist':
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	880 rst.append(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	881 _(b"\n(use 'hg help' for the full list of commands)\n")
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	882 )
22115 8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	883 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	884 if name == b'shortlist':
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	885 rst.append(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	886 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	887 b"\n(use 'hg help' for the full list of commands "
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	888 b"or 'hg -v' for details)\n"
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	889 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	890 )
22115 8465625f7364 help: refactor helplist optlist mess Matt Mackall <mpm@selenic.com> parents: 22114 diff changeset	891 elif name and not full:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	892 rst.append(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	893 _(b"\n(use 'hg help %s' to show the full help text)\n")
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	894 % name
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	895 )
40291 170926caf44c help: adding support for command categories rdamazio@google.com parents: 40263 diff changeset	896 elif name and syns and name in syns.keys():
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	897 rst.append(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	898 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	899 b"\n(use 'hg help -v -e %s' to show built-in "
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	900 b"aliases and global options)\n"
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	901 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	902 % name
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	903 )
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	904 else:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	905 rst.append(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	906 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	907 b"\n(use 'hg help -v%s' to show built-in aliases "
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	908 b"and global options)\n"
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	909 )
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	910 % (name and b" " + name or b"")
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	911 )
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	912 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	913
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	914 def helptopic(name, subtopic=None):
27379 2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	915 # Look for sub-topic entry first.
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	916 header, doc = None, None
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	917 if subtopic and name in subtopics:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	918 for names, header, doc in subtopics[name]:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	919 if subtopic in names:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	920 break
42412 a84564b1a0b1 help: check if a subtopic exists and raise an error if it doesn't (issue6145) Nathan Goldbaum <nathan12343@gmail.com> parents: 42057 diff changeset	921 if not any(subtopic in s[0] for s in subtopics[name]):
a84564b1a0b1 help: check if a subtopic exists and raise an error if it doesn't (issue6145) Nathan Goldbaum <nathan12343@gmail.com> parents: 42057 diff changeset	922 raise error.UnknownCommand(name)
27379 2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	923
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	924 if not header:
40292 9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	925 for topic in helptable:
9c6473d2038b help: splitting the topics by category Rodrigo Damazio <rdamazio@google.com> parents: 40291 diff changeset	926 names, header, doc = topic[0:3]
27379 2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	927 if name in names:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	928 break
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	929 else:
2278870bb997 help: support loading sub-topics Gregory Szorc <gregory.szorc@gmail.com> parents: 27378 diff changeset	930 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	931
18748 6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 18746 diff changeset	932 rst = [minirst.section(header)]
6e676fb6ea44 help: use a full header for topic titles Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 18746 diff changeset	933
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	934 # 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	935 if not doc:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	936 rst.append(b" %s\n" % _(b"(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	937 if callable(doc):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	938 rst += [b" %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	939
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	940 if not ui.verbose:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	941 omitted = _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	942 b'(some details hidden, use --verbose'
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	943 b' to show complete help)'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	944 )
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	945 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	946
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	947 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	948 cmdutil.findcmd(name, commands.table)
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	949 rst.append(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	950 _(b"\nuse 'hg help -c %s' to see help for the %s command\n")
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	951 % (name, name)
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	952 )
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	953 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	954 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	955 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	956
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	957 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	958 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	959 mod = extensions.find(name)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	960 doc = gettext(pycompat.getdoc(mod)) or _(b'no help text available')
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	961 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	962 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	963 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	964 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	965 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	966
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	967 if b'\n' not in doc:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	968 head, tail = doc, b""
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	969 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	970 head, tail = doc.split(b'\n', 1)
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	971 rst = [_(b'%s extension - %s\n\n') % (name.rpartition(b'.')[-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	972 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	973 rst.extend(tail.splitlines(True))
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	974 rst.append(b'\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	975
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	976 if not ui.verbose:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	977 omitted = _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	978 b'(some details hidden, use --verbose'
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	979 b' to show complete help)'
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	980 )
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	981 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	982
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	983 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	984 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	985 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	986 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	987 ct = {}
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	988 modcmds = {c.partition(b'\|')[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	989 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	990 else:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	991 rst.append(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	992 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	993 b"(use 'hg help extensions' for information on enabling"
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	994 b" extensions)\n"
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	995 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	996 )
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	997 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	998
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	999 def helpextcmd(name, subtopic=None):
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1000 cmd, ext, doc = extensions.disabledcmd(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1001 ui, name, ui.configbool(b'ui', b'strict')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1002 )
38019 6e526b0961a8 help: load module doc of disabled extension in extensions.disabledcmd() Yuya Nishihara <yuya@tcha.org> parents: 37137 diff changeset	1003 doc = doc.splitlines()[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	1004
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1005 rst = listexts(
43117 8ff1ecfadcd1 cleanup: join string literals that are already on one line Martin von Zweigbergk <martinvonz@google.com> parents: 43106 diff changeset	1006 _(b"'%s' is provided by the following extension:") % cmd,
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1007 {ext: doc},
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1008 indent=4,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1009 showdeprecated=True,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1010 )
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1011 rst.append(b'\n')
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1012 rst.append(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1013 _(
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1014 b"(use 'hg help extensions' for information on enabling "
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1015 b"extensions)\n"
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1016 )
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1017 )
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	1018 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	1019
c0087d48ec3a help: move the majority of the help command to the help module Dan Villiom Podlaski Christiansen <danchr@gmail.com> parents: 17837 diff changeset	1020 rst = []
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1021 kw = opts.get(b'keyword')
27325 eadbbd14bdc1 help: fix help -c/help -e/help -k timeless <timeless@mozdev.org> parents: 27324 diff changeset	1022 if kw or name is None and any(opts[o] for o in opts):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1023 matches = topicmatch(ui, commands, name or b'')
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	1024 helpareas = []
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1025 if opts.get(b'extension'):
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1026 helpareas += [(b'extensions', _(b'Extensions'))]
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1027 if opts.get(b'command'):
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1028 helpareas += [(b'commands', _(b'Commands'))]
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	1029 if not helpareas:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1030 helpareas = [
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1031 (b'topics', _(b'Topics')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1032 (b'commands', _(b'Commands')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1033 (b'extensions', _(b'Extensions')),
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1034 (b'extensioncommands', _(b'Extension Commands')),
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1035 ]
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	1036 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	1037 if matches[t]:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1038 rst.append(b'%s:\n\n' % title)
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	1039 rst.extend(minirst.maketable(sorted(matches[t]), 1))
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1040 rst.append(b'\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	1041 if not rst:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1042 msg = _(b'no matches')
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1043 hint = _(b"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	1044 raise error.Abort(msg, hint=hint)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1045 elif name and name != b'shortlist':
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	1046 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	1047 if unknowncmd:
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	1048 queries += [helpextcmd]
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1049 if opts.get(b'extension'):
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	1050 queries += [helpext]
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1051 if opts.get(b'command'):
26238 69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	1052 queries += [helpcmd]
69da16b366ad help: fix help argument parsing and documentation timeless@mozdev.org parents: 26196 diff changeset	1053 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	1054 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	1055 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	1056 try:
27378 c709b515218e help: pass sub-topic into help query functions Gregory Szorc <gregory.szorc@gmail.com> parents: 27377 diff changeset	1057 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	1058 break
21289 c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	1059 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	1060 pass
c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	1061 else:
c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	1062 if unknowncmd:
c3784e3c3e8d help: suggest keyword search when no topic is found Pierre-Yves David <pierre-yves.david@fb.com> parents: 21288 diff changeset	1063 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	1064 else:
42413 ad55a0a5894f help: include subtopic in error message if passed Nathan Goldbaum <nathan12343@gmail.com> parents: 42412 diff changeset	1065 if fullname:
ad55a0a5894f help: include subtopic in error message if passed Nathan Goldbaum <nathan12343@gmail.com> parents: 42412 diff changeset	1066 formatname = fullname
ad55a0a5894f help: include subtopic in error message if passed Nathan Goldbaum <nathan12343@gmail.com> parents: 42412 diff changeset	1067 else:
ad55a0a5894f help: include subtopic in error message if passed Nathan Goldbaum <nathan12343@gmail.com> parents: 42412 diff changeset	1068 formatname = name
ad55a0a5894f help: include subtopic in error message if passed Nathan Goldbaum <nathan12343@gmail.com> parents: 42412 diff changeset	1069 if subtopic:
ad55a0a5894f help: include subtopic in error message if passed Nathan Goldbaum <nathan12343@gmail.com> parents: 42412 diff changeset	1070 hintname = subtopic
ad55a0a5894f help: include subtopic in error message if passed Nathan Goldbaum <nathan12343@gmail.com> parents: 42412 diff changeset	1071 else:
ad55a0a5894f help: include subtopic in error message if passed Nathan Goldbaum <nathan12343@gmail.com> parents: 42412 diff changeset	1072 hintname = name
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1073 msg = _(b'no such help topic: %s') % formatname
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1074 hint = _(b"try 'hg help --keyword %s'") % hintname
26587 56b2bcea2529 error: get Abort from 'error' instead of 'util' Pierre-Yves David <pierre-yves.david@fb.com> parents: 26436 diff changeset	1075 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	1076 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	1077 # 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	1078 if not ui.quiet:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1079 rst = [_(b"Mercurial Distributed SCM\n"), b'\n']
32580 0cec8ad579d4 help: convert dict to strkwargs Augie Fackler <raf@durin42.com> parents: 32331 diff changeset	1080 rst.extend(helplist(None, **pycompat.strkwargs(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	1081
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1082 return b''.join(rst)
31079 2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1083
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1084
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1085 def formattedhelp(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1086 ui, commands, fullname, keep=None, unknowncmd=False, full=True, **opts
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1087 ):
31079 2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1088 """get help for a given topic (as a dotted name) as rendered rst
2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1089
2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1090 Either returns the rendered help text or raises an exception.
2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1091 """
2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1092 if keep is None:
2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1093 keep = []
31275 79715ba22f9c help: avoid mutating passed-in `keep` list in `formattedhelp` Augie Fackler <augie@google.com> parents: 31144 diff changeset	1094 else:
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1095 keep = list(keep) # make a copy so we can mutate this later
39366 d30867a745a1 help: rewrite parsing of help topic to not drop section name with dots Yuya Nishihara <yuya@tcha.org> parents: 39336 diff changeset	1096
d30867a745a1 help: rewrite parsing of help topic to not drop section name with dots Yuya Nishihara <yuya@tcha.org> parents: 39336 diff changeset	1097 # <fullname> := <name>[.<subtopic][.<section>]
d30867a745a1 help: rewrite parsing of help topic to not drop section name with dots Yuya Nishihara <yuya@tcha.org> parents: 39336 diff changeset	1098 name = subtopic = section = None
d30867a745a1 help: rewrite parsing of help topic to not drop section name with dots Yuya Nishihara <yuya@tcha.org> parents: 39336 diff changeset	1099 if fullname is not None:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1100 nameparts = fullname.split(b'.')
39366 d30867a745a1 help: rewrite parsing of help topic to not drop section name with dots Yuya Nishihara <yuya@tcha.org> parents: 39336 diff changeset	1101 name = nameparts.pop(0)
d30867a745a1 help: rewrite parsing of help topic to not drop section name with dots Yuya Nishihara <yuya@tcha.org> parents: 39336 diff changeset	1102 if nameparts and name in subtopics:
d30867a745a1 help: rewrite parsing of help topic to not drop section name with dots Yuya Nishihara <yuya@tcha.org> parents: 39336 diff changeset	1103 subtopic = nameparts.pop(0)
d30867a745a1 help: rewrite parsing of help topic to not drop section name with dots Yuya Nishihara <yuya@tcha.org> parents: 39336 diff changeset	1104 if nameparts:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1105 section = encoding.lower(b'.'.join(nameparts))
39366 d30867a745a1 help: rewrite parsing of help topic to not drop section name with dots Yuya Nishihara <yuya@tcha.org> parents: 39336 diff changeset	1106
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1107 textwidth = ui.configint(b'ui', b'textwidth')
31079 2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1108 termwidth = ui.termwidth() - 2
2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1109 if textwidth <= 0 or termwidth < textwidth:
2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1110 textwidth = termwidth
43076 2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1111 text = help_(
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1112 ui,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1113 commands,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1114 name,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1115 fullname=fullname,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1116 subtopic=subtopic,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1117 unknowncmd=unknowncmd,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1118 full=full,
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1119 **opts
2372284d9457 formatting: blacken the codebase Augie Fackler <augie@google.com> parents: 42466 diff changeset	1120 )
31079 2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1121
39335 9b800601701c help: inline minirst.format() Yuya Nishihara <yuya@tcha.org> parents: 38041 diff changeset	1122 blocks, pruned = minirst.parse(text, keep=keep)
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1123 if b'verbose' in pruned:
687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1124 keep.append(b'omitted')
31079 2a0c8e3636b0 help: move rst formatting of help documents into help.py Augie Fackler <augie@google.com> parents: 30812 diff changeset	1125 else:
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1126 keep.append(b'notomitted')
39335 9b800601701c help: inline minirst.format() Yuya Nishihara <yuya@tcha.org> parents: 38041 diff changeset	1127 blocks, pruned = minirst.parse(text, keep=keep)
9b800601701c help: inline minirst.format() Yuya Nishihara <yuya@tcha.org> parents: 38041 diff changeset	1128 if section:
9b800601701c help: inline minirst.format() Yuya Nishihara <yuya@tcha.org> parents: 38041 diff changeset	1129 blocks = minirst.filtersections(blocks, section)
39336 0a766cb1092a help: reorder section filtering flow to not format help text twice Yuya Nishihara <yuya@tcha.org> parents: 39335 diff changeset	1130
0a766cb1092a help: reorder section filtering flow to not format help text twice Yuya Nishihara <yuya@tcha.org> parents: 39335 diff changeset	1131 # We could have been given a weird ".foo" section without a name
0a766cb1092a help: reorder section filtering flow to not format help text twice Yuya Nishihara <yuya@tcha.org> parents: 39335 diff changeset	1132 # to look for, or we could have simply failed to found "foo.bar"
0a766cb1092a help: reorder section filtering flow to not format help text twice Yuya Nishihara <yuya@tcha.org> parents: 39335 diff changeset	1133 # because bar isn't a section of foo
0a766cb1092a help: reorder section filtering flow to not format help text twice Yuya Nishihara <yuya@tcha.org> parents: 39335 diff changeset	1134 if section and not (blocks and name):
43077 687b865b95ad formatting: byteify all mercurial/ and hgext/ string literals Augie Fackler <augie@google.com> parents: 43076 diff changeset	1135 raise error.Abort(_(b"help section not found: %s") % fullname)
39336 0a766cb1092a help: reorder section filtering flow to not format help text twice Yuya Nishihara <yuya@tcha.org> parents: 39335 diff changeset	1136
39335 9b800601701c help: inline minirst.format() Yuya Nishihara <yuya@tcha.org> parents: 38041 diff changeset	1137 return minirst.formatplain(blocks, textwidth)

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/help.py @ 44341:142d2a4cb69a