| hg-reviewers |
Previously, .. container:: verbose and platform-dependent names like
windows, plan9 could be used to make conditional help text. This patch
adds the special config:section.name=(true|false) syntax so we can also
control help output by using configs.
This could be useful for documenting experimental features.
| Lint Skipped |
| Unit Tests Skipped |
| Path | Packages | |||
|---|---|---|---|---|
| M | mercurial/help.py (7 lines) | |||
| M | mercurial/minirst.py (10 lines) | |||
| M | tests/test-help.t (29 lines) |
| # help.py - help data for mercurial | # help.py - help data for mercurial | ||||
| # | # | ||||
| # Copyright 2006 Matt Mackall <mpm@selenic.com> | # Copyright 2006 Matt Mackall <mpm@selenic.com> | ||||
| # | # | ||||
| # This software may be used and distributed according to the terms of the | # This software may be used and distributed according to the terms of the | ||||
| # GNU General Public License version 2 or any later version. | # GNU General Public License version 2 or any later version. | ||||
| from __future__ import absolute_import | from __future__ import absolute_import | ||||
| import itertools | import itertools | ||||
| import os | import os | ||||
| import re | |||||
| import textwrap | import textwrap | ||||
| from .i18n import ( | from .i18n import ( | ||||
| _, | _, | ||||
| gettext, | gettext, | ||||
| ) | ) | ||||
| from . import ( | from . import ( | ||||
| cmdutil, | cmdutil, | ||||
| section = remaining | section = remaining | ||||
| textwidth = ui.configint('ui', 'textwidth') | textwidth = ui.configint('ui', 'textwidth') | ||||
| termwidth = ui.termwidth() - 2 | termwidth = ui.termwidth() - 2 | ||||
| if textwidth <= 0 or termwidth < textwidth: | if textwidth <= 0 or termwidth < textwidth: | ||||
| textwidth = termwidth | textwidth = termwidth | ||||
| text = help_(ui, commands, name, | text = help_(ui, commands, name, | ||||
| subtopic=subtopic, unknowncmd=unknowncmd, full=full, **opts) | subtopic=subtopic, unknowncmd=unknowncmd, full=full, **opts) | ||||
| # Boolean configs, ex. "container:: config:experimental.foo=true" | |||||
| configs = re.findall('(config:([^.]*)\.([\S]*)=(true|false))', text) | |||||
| for fullname, cfgsection, cfgname, cfgvalue in set(configs): | |||||
| if ui.configbool(cfgsection, cfgname) == (cfgvalue == 'true'): | |||||
| keep.append(fullname) | |||||
| formatted, pruned = minirst.format(text, textwidth, keep=keep, | formatted, pruned = minirst.format(text, textwidth, keep=keep, | ||||
| section=section) | section=section) | ||||
| # We could have been given a weird ".foo" section without a name | # We could have been given a weird ".foo" section without a name | ||||
| # to look for, or we could have simply failed to found "foo.bar" | # to look for, or we could have simply failed to found "foo.bar" | ||||
| # because bar isn't a section of foo | # because bar isn't a section of foo | ||||
| if section and not (formatted and name): | if section and not (formatted and name): | ||||
| raise error.Abort(_("help section not found: %s") % fullname) | raise error.Abort(_("help section not found: %s") % fullname) | ||||
| if 'verbose' in pruned: | if 'verbose' in pruned: | ||||
| keep.append('omitted') | keep.append('omitted') | ||||
| else: | else: | ||||
| keep.append('notomitted') | keep.append('notomitted') | ||||
| formatted, pruned = minirst.format(text, textwidth, keep=keep, | formatted, pruned = minirst.format(text, textwidth, keep=keep, | ||||
| section=section) | section=section) | ||||
| return formatted | return formatted | ||||
| # +---+ | | # +---+ | | ||||
| # | blocks | | # | blocks | | ||||
| # +-------------------------------+ | # +-------------------------------+ | ||||
| if (blocks[i]['type'] == 'paragraph' and | if (blocks[i]['type'] == 'paragraph' and | ||||
| blocks[i]['lines'][0].startswith('.. container::')): | blocks[i]['lines'][0].startswith('.. container::')): | ||||
| indent = blocks[i]['indent'] | indent = blocks[i]['indent'] | ||||
| adjustment = blocks[i + 1]['indent'] - indent | adjustment = blocks[i + 1]['indent'] - indent | ||||
| containertype = blocks[i]['lines'][0][15:] | containertype = blocks[i]['lines'][0][15:] | ||||
| prune = True | prune = (containertype not in keep) | ||||
| if prune and ':' not in containertype: | |||||
| for c in keep: | for c in keep: | ||||
| if c in containertype.split('.'): | if c in containertype.split('.'): | ||||
| prune = False | prune = False | ||||
| break | |||||
| if prune: | if prune: | ||||
| pruned.append(containertype) | pruned.append(containertype) | ||||
| # Always delete "..container:: type" block | # Always delete "..container:: type" block | ||||
| del blocks[i] | del blocks[i] | ||||
| j = i | j = i | ||||
| i -= 1 | i -= 1 | ||||
| while j < len(blocks) and blocks[j]['indent'] > indent: | while j < len(blocks) and blocks[j]['indent'] > indent: | ||||
| --time time how long the command takes | --time time how long the command takes | ||||
| --profile print command execution profile | --profile print command execution profile | ||||
| --version output version information and exit | --version output version information and exit | ||||
| -h --help display help and exit | -h --help display help and exit | ||||
| --hidden consider hidden changesets | --hidden consider hidden changesets | ||||
| --pager TYPE when to paginate (boolean, always, auto, or never) | --pager TYPE when to paginate (boolean, always, auto, or never) | ||||
| (default: auto) | (default: auto) | ||||
| Help depending on boolean config options | |||||
| $ cat > $TESTTMP/myext.py << EOF | |||||
| > """test help text with conditional configs | |||||
| > .. container:: config:commands.update.requiredest=true | |||||
| > | |||||
| > This shows up when commands.update.requiredest is set to True. | |||||
| > | |||||
| > .. container:: config:commands.update.requiredest=false | |||||
| > | |||||
| > This shows up when commands.update.requiredest is set to False. | |||||
| > """ | |||||
| > EOF | |||||
| $ hg help -e myext --config extensions.myext=$TESTTMP/myext.py | |||||
| myext extension - test help text with conditional configs | |||||
| This shows up when commands.update.requiredest is set to False. | |||||
| no commands defined | |||||
| $ hg help -e myext --config extensions.myext=$TESTTMP/myext.py \ | |||||
| > --config commands.update.requiredest=1 | |||||
| myext extension - test help text with conditional configs | |||||
| This shows up when commands.update.requiredest is set to True. | |||||
| no commands defined | |||||
| Test the textwidth config option | Test the textwidth config option | ||||
| $ hg root -h --config ui.textwidth=50 | $ hg root -h --config ui.textwidth=50 | ||||
| hg root | hg root | ||||
| print the root (top) of the current working | print the root (top) of the current working | ||||
| directory | directory | ||||