| durin42 |
| hg-reviewers |
It seems reasonable to have a similar mechanism for the rest of the
help, but no such thing is implemented.
The goal is to make the help of commands clearer in the presence of
significant default changes, like tweakdefaults or with company-wide
hgrcs. In these cases, a user looking at the help of a command doesn't
exactly know what his hgrc is doing.
Apply to this to the --git option of commands that display diffs, as
this option in particular causes confusion for some reason.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/cmdutil.py (2 lines) | |||
| M | mercurial/help.py (28 lines) | |||
| M | tests/test-help.t (6 lines) |
| Status | Author | Revision | |
|---|---|---|---|
| Closed | valentin.gatienbaron | ||
| Closed | valentin.gatienbaron |
| (b'l', b'limit', b'', _(b'limit number of changes displayed'), _(b'NUM')), | (b'l', b'limit', b'', _(b'limit number of changes displayed'), _(b'NUM')), | ||||
| (b'M', b'no-merges', None, _(b'do not show merges')), | (b'M', b'no-merges', None, _(b'do not show merges')), | ||||
| (b'', b'stat', None, _(b'output diffstat-style summary of changes')), | (b'', b'stat', None, _(b'output diffstat-style summary of changes')), | ||||
| (b'G', b'graph', None, _(b"show the revision DAG")), | (b'G', b'graph', None, _(b"show the revision DAG")), | ||||
| ] + templateopts | ] + templateopts | ||||
| diffopts = [ | diffopts = [ | ||||
| (b'a', b'text', None, _(b'treat all files as text')), | (b'a', b'text', None, _(b'treat all files as text')), | ||||
| (b'g', b'git', None, _(b'use git extended diff format')), | (b'g', b'git', None, _(b'use git extended diff format (DEFAULT: diff.git)')), | ||||
| (b'', b'binary', None, _(b'generate binary diffs in git mode (default)')), | (b'', b'binary', None, _(b'generate binary diffs in git mode (default)')), | ||||
| (b'', b'nodates', None, _(b'omit dates from diff headers')), | (b'', b'nodates', None, _(b'omit dates from diff headers')), | ||||
| ] | ] | ||||
| diffwsopts = [ | diffwsopts = [ | ||||
| ( | ( | ||||
| b'w', | b'w', | ||||
| b'ignore-all-space', | b'ignore-all-space', | ||||
| _(b'disabled extensions:'), | _(b'disabled extensions:'), | ||||
| extensions.disabled(), | extensions.disabled(), | ||||
| showdeprecated=ui.verbose, | showdeprecated=ui.verbose, | ||||
| ) | ) | ||||
| ) | ) | ||||
| doc = b''.join(rst) | doc = b''.join(rst) | ||||
| return doc | return doc | ||||
| def parsedefaultmarker(text): | |||||
| """given a text 'abc (DEFAULT: def.ghi)', | |||||
| returns (b'abc', (b'def', b'ghi')). Otherwise return None""" | |||||
| if text[-1:] == b')': | |||||
| marker = b' (DEFAULT: ' | |||||
| pos = text.find(marker) | |||||
| if pos >= 0: | |||||
| item = text[pos + len(marker):-1] | |||||
| return text[:pos], item.split(b'.', 2) | |||||
| def optrst(header, options, verbose): | def optrst(header, options, verbose, ui): | ||||
| data = [] | data = [] | ||||
| multioccur = False | multioccur = False | ||||
| for option in options: | for option in options: | ||||
| if len(option) == 5: | if len(option) == 5: | ||||
| shortopt, longopt, default, desc, optlabel = option | shortopt, longopt, default, desc, optlabel = option | ||||
| else: | else: | ||||
| shortopt, longopt, default, desc = option | shortopt, longopt, default, desc = option | ||||
| optlabel = _(b"VALUE") # default label | optlabel = _(b"VALUE") # default label | ||||
| if not verbose and any(w in desc for w in _exclkeywords): | if not verbose and any(w in desc for w in _exclkeywords): | ||||
| continue | continue | ||||
| defaultstrsuffix = b'' | |||||
| if default is None: | |||||
| parseresult = parsedefaultmarker(desc) | |||||
| if parseresult is not None: | |||||
| (desc, (section, name)) = parseresult | |||||
| if ui.configbool(section, name): | |||||
| default = True | |||||
| defaultstrsuffix = _(b' from config') | |||||
| so = b'' | so = b'' | ||||
| if shortopt: | if shortopt: | ||||
| so = b'-' + shortopt | so = b'-' + shortopt | ||||
| lo = b'--' + longopt | lo = b'--' + longopt | ||||
| if default is True: | if default is True: | ||||
| lo = b'--[no-]' + longopt | lo = b'--[no-]' + longopt | ||||
| if isinstance(default, fancyopts.customopt): | if isinstance(default, fancyopts.customopt): | ||||
| default = default.getdefaultvalue() | default = default.getdefaultvalue() | ||||
| if default and not callable(default): | if default and not callable(default): | ||||
| # default is of unknown type, and in Python 2 we abused | # default is of unknown type, and in Python 2 we abused | ||||
| # the %s-shows-repr property to handle integers etc. To | # the %s-shows-repr property to handle integers etc. To | ||||
| # match that behavior on Python 3, we do str(default) and | # match that behavior on Python 3, we do str(default) and | ||||
| # then convert it to bytes. | # then convert it to bytes. | ||||
| defaultstr = pycompat.bytestr(default) | defaultstr = pycompat.bytestr(default) | ||||
| if default is True: | if default is True: | ||||
| defaultstr = _(b"on") | defaultstr = _(b"on") | ||||
| desc += _(b" (default: %s)") % defaultstr | desc += _(b" (default: %s)") % (defaultstr + defaultstrsuffix) | ||||
| if isinstance(default, list): | if isinstance(default, list): | ||||
| lo += b" %s [+]" % optlabel | lo += b" %s [+]" % optlabel | ||||
| multioccur = True | multioccur = True | ||||
| elif (default is not None) and not isinstance(default, bool): | elif (default is not None) and not isinstance(default, bool): | ||||
| lo += b" %s" % optlabel | lo += b" %s" % optlabel | ||||
| data.append((so, lo, desc)) | data.append((so, lo, desc)) | ||||
| b"the %s extension)" | b"the %s extension)" | ||||
| ) % (name, name) | ) % (name, name) | ||||
| rst.append(b'\n%s\n' % msg) | rst.append(b'\n%s\n' % msg) | ||||
| except KeyError: | except KeyError: | ||||
| pass | pass | ||||
| # options | # options | ||||
| if not ui.quiet and entry[1]: | if not ui.quiet and entry[1]: | ||||
| rst.append(optrst(_(b"options"), entry[1], ui.verbose)) | rst.append(optrst(_(b"options"), entry[1], ui.verbose, ui)) | ||||
| if ui.verbose: | if ui.verbose: | ||||
| rst.append( | rst.append( | ||||
| optrst(_(b"global options"), commands.globalopts, ui.verbose) | optrst(_(b"global options"), commands.globalopts, ui.verbose, ui) | ||||
| ) | ) | ||||
| if not ui.verbose: | if not ui.verbose: | ||||
| if not full: | if not full: | ||||
| rst.append(_(b"\n(use 'hg %s -h' to show more help)\n") % name) | rst.append(_(b"\n(use 'hg %s -h' to show more help)\n") % name) | ||||
| elif not ui.quiet: | elif not ui.quiet: | ||||
| rst.append( | rst.append( | ||||
| _( | _( | ||||
| for t, desc in topics: | for t, desc in topics: | ||||
| rst.append(b" :%s: %s\n" % (t, desc)) | rst.append(b" :%s: %s\n" % (t, desc)) | ||||
| if ui.quiet: | if ui.quiet: | ||||
| pass | pass | ||||
| elif ui.verbose: | elif ui.verbose: | ||||
| rst.append( | rst.append( | ||||
| b'\n%s\n' | b'\n%s\n' | ||||
| % optrst(_(b"global options"), commands.globalopts, ui.verbose) | % optrst(_(b"global options"), commands.globalopts, ui.verbose, ui) | ||||
| ) | ) | ||||
| if name == b'shortlist': | if name == b'shortlist': | ||||
| rst.append( | rst.append( | ||||
| _(b"\n(use 'hg help' for the full list of commands)\n") | _(b"\n(use 'hg help' for the full list of commands)\n") | ||||
| ) | ) | ||||
| else: | else: | ||||
| if name == b'shortlist': | if name == b'shortlist': | ||||
| rst.append( | rst.append( | ||||
| hg: unknown command 'rebase' | hg: unknown command 'rebase' | ||||
| 'rebase' is provided by the following extension: | 'rebase' is provided by the following extension: | ||||
| rebase command to move sets of revisions to a different ancestor | rebase command to move sets of revisions to a different ancestor | ||||
| (use 'hg help extensions' for information on enabling extensions) | (use 'hg help extensions' for information on enabling extensions) | ||||
| [255] | [255] | ||||
| Checking that help adapts based on the config: | |||||
| $ hg help diff --config ui.tweakdefaults=true | egrep -e '^ *(-g|config)' | |||||
| -g --[no-]git use git extended diff format (default: on from | |||||
| config) | |||||
| Make sure that we don't run afoul of the help system thinking that | Make sure that we don't run afoul of the help system thinking that | ||||
| this is a section and erroring out weirdly. | this is a section and erroring out weirdly. | ||||
| $ hg .log | $ hg .log | ||||
| hg: unknown command '.log' | hg: unknown command '.log' | ||||
| (did you mean log?) | (did you mean log?) | ||||
| [255] | [255] | ||||