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

annotate mercurial/help.py @ 49763:2a70d1fc70c4

typing: add type hints to mercurial/help.py Was hoping to find more issues like f09bc2ed9100, but it may be that nothing checks the args to that operation. In any event, the work is done and pytype doesn't do a very good job inferring the types. A few of th emore complicated things like the command table are left untyped, because they come from modules that aren't typed yet.

author	Matt Harbison <matt_harbison@yahoo.com>
date	Sun, 20 Nov 2022 22:54:43 -0500
parents	04e6add9e4dc
children	f56873a7284c

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

Mercurial > public > mercurial-scm > hg-stable

annotate mercurial/help.py @ 49763:2a70d1fc70c4