( )⚙ D5077 help: allow hiding of help topics

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5077

help: allow hiding of help topics
ClosedPublic

Authored by rdamazio on Oct 13 2018, 8:44 AM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHG1ddd202c47d9: help: allow hiding of help topics
Summary

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

rdamazio created this revision.Oct 13 2018, 8:44 AM
rdamazio updated this revision to Diff 12126.Oct 14 2018, 6:32 AM
yuja added a subscriber: yuja.Oct 14 2018, 11:30 AM

+def filtertopic(ui, topic):
+ return ui.configbool('help', 'hide.%s' % topic, False)

Maybe we need a separate namespace (e.g. help.hidden-topic.%s)?

rdamazio updated this revision to Diff 12255.Oct 18 2018, 11:25 PM
rdamazio added a comment.Oct 18 2018, 11:25 PM
In D5077#76403, @yuja wrote:

+def filtertopic(ui, topic):
+ return ui.configbool('help', 'hide.%s' % topic, False)

Maybe we need a separate namespace (e.g. help.hidden-topic.%s)?

Done.

Closed by commit rHG1ddd202c47d9: help: allow hiding of help topics (authored by rdamazio). · Explain WhyOct 23 2018, 7:39 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/configitems.py (4 lines)
Mmercurial/help.py (12 lines)
Mtests/test-help-hide.t (128 lines)

Diff 12317

mercurial/configitems.py

) )
coreconfigitem('fsmonitor', 'warn_update_file_count', coreconfigitem('fsmonitor', 'warn_update_file_count',
default=50000, default=50000,
) )
coreconfigitem('help', 'hidden-command\..*', coreconfigitem('help', 'hidden-command\..*',
default=False, default=False,
generic=True, generic=True,
) )
coreconfigitem('help', 'hidden-topic\..*',
default=False,
generic=True,
)
coreconfigitem('hooks', '.*', coreconfigitem('hooks', '.*',
default=dynamicdefault, default=dynamicdefault,
generic=True, generic=True,
) )
coreconfigitem('hgweb-paths', '.*', coreconfigitem('hgweb-paths', '.*',
default=list, default=list,
generic=True, generic=True,
) )

mercurial/help.py

if not ui.debugflag and cmd.startswith("debug") and kw != "debug": if not ui.debugflag and cmd.startswith("debug") and kw != "debug":
return True return True
if not ui.verbose and doc and any(w in doc for w in _exclkeywords): if not ui.verbose and doc and any(w in doc for w in _exclkeywords):
return True return True
if ui.configbool('help', 'hidden-command.%s' % cmd): if ui.configbool('help', 'hidden-command.%s' % cmd):
return True return True
return False return False
def filtertopic(ui, topic):
return ui.configbool('help', 'hidden-topic.%s' % topic, False)
def topicmatch(ui, commands, kw): def topicmatch(ui, commands, kw):
"""Return help topics matching kw. """Return help topics matching kw.
Returns {'section': [(name, summary), ...], ...} where section is Returns {'section': [(name, summary), ...], ...} where section is
one of topics, commands, extensions, or extensioncommands. one of topics, commands, extensions, or extensioncommands.
""" """
kw = encoding.lower(kw) kw = encoding.lower(kw)
def lowercontains(container): def lowercontains(container):
return kw in encoding.lower(container) # translated in helptable return kw in encoding.lower(container) # translated in helptable
results = {'topics': [], results = {'topics': [],
'commands': [], 'commands': [],
'extensions': [], 'extensions': [],
'extensioncommands': [], 'extensioncommands': [],
} }
for topic in helptable: for topic in helptable:
names, header, doc = topic[0:3] names, header, doc = topic[0:3]
# Old extensions may use a str as doc. # Old extensions may use a str as doc.
if (sum(map(lowercontains, names)) if (sum(map(lowercontains, names))
or lowercontains(header) or lowercontains(header)
or (callable(doc) and lowercontains(doc(ui)))): or (callable(doc) and lowercontains(doc(ui)))):
name = names[0]
if not filtertopic(ui, name):
results['topics'].append((names[0], header)) results['topics'].append((names[0], header))
for cmd, entry in commands.table.iteritems(): for cmd, entry in commands.table.iteritems():
if len(entry) == 3: if len(entry) == 3:
summary = entry[2] summary = entry[2]
else: else:
summary = '' summary = ''
# translate docs *before* searching there # translate docs *before* searching there
docs = _(pycompat.getdoc(entry[0])) or '' docs = _(pycompat.getdoc(entry[0])) or ''
if kw in cmd or lowercontains(summary) or lowercontains(docs): if kw in cmd or lowercontains(summary) or lowercontains(docs):
topiccats = {} topiccats = {}
for topic in helptable: for topic in helptable:
names, header, doc = topic[0:3] names, header, doc = topic[0:3]
if len(topic) > 3 and topic[3]: if len(topic) > 3 and topic[3]:
category = topic[3] category = topic[3]
else: else:
category = TOPIC_CATEGORY_NONE category = TOPIC_CATEGORY_NONE
topiccats.setdefault(category, []).append((names[0], header)) topicname = names[0]
if not filtertopic(ui, topicname):
topiccats.setdefault(category, []).append(
(topicname, header))
# Check that all categories have an order. # Check that all categories have an order.
missing_order = set(topiccats.keys()) - set(TOPIC_CATEGORY_ORDER) missing_order = set(topiccats.keys()) - set(TOPIC_CATEGORY_ORDER)
if missing_order: if missing_order:
ui.develwarn( ui.develwarn(
'help categories missing from TOPIC_CATEGORY_ORDER: %s' % 'help categories missing from TOPIC_CATEGORY_ORDER: %s' %
missing_order) missing_order)

tests/test-help-hide.t

Miscellaneous: Miscellaneous:
deprecated Deprecated Features deprecated Deprecated Features
internals Technical implementation topics internals Technical implementation topics
scripting Using Mercurial from scripts and automation scripting Using Mercurial from scripts and automation
(use 'hg help -v' to show built-in aliases and global options) (use 'hg help -v' to show built-in aliases and global options)
Test hiding some topics.
$ hg --config help.hidden-topic.deprecated=true \
> --config help.hidden-topic.internals=true \
> --config help.hidden-topic.scripting=true help
Mercurial Distributed SCM
list of commands:
Repository creation:
clone make a copy of an existing repository
init create a new repository in the given directory
Remote repository management:
incoming show new changesets found in source
outgoing show changesets not found in the destination
paths show aliases for remote repositories
pull pull changes from the specified source
push push changes to the specified destination
serve start stand-alone webserver
Change creation:
commit commit the specified files or all outstanding changes
Change manipulation:
backout reverse effect of earlier changeset
graft copy changes from other branches onto the current branch
merge merge another revision into working directory
Change organization:
bookmarks create a new bookmark or list existing bookmarks
branch set or show the current branch name
branches list repository named branches
phase set or show the current phase name
tag add one or more tags for the current or given revision
tags list repository tags
File content management:
annotate show changeset information by line for each file
cat output the current or given revision of files
copy mark files as copied for the next commit
diff diff repository (or selected files)
grep search revision history for a pattern in specified files
Change navigation:
bisect subdivision search of changesets
heads show branch heads
identify identify the working directory or specified revision
log show revision history of entire repository or files
Working directory management:
add add the specified files on the next commit
addremove add all new files, delete all missing files
files list tracked files
forget forget the specified files on the next commit
remove remove the specified files on the next commit
rename rename files; equivalent of copy + remove
resolve redo merges or set/view the merge status of files
revert restore files to their checkout state
root print the root (top) of the current working directory
status show changed files in the working directory
summary summarize working directory state
update update working directory (or switch revisions)
Change import/export:
archive create an unversioned archive of a repository revision
bundle create a bundle file
export dump the header and diffs for one or more changesets
import import an ordered set of patches
unbundle apply one or more bundle files
Repository maintenance:
manifest output the current or given revision of the project manifest
recover roll back an interrupted transaction
verify verify the integrity of the repository
Help:
config show combined config settings from all hgrc files
help show help for a given topic or a help overview
version output version and copyright information
additional help topics:
Mercurial identifiers:
filesets Specifying File Sets
hgignore Syntax for Mercurial Ignore Files
patterns File Name Patterns
revisions Specifying Revisions
urls URL Paths
Mercurial output:
color Colorizing Outputs
dates Date Formats
diffs Diff Formats
templating Template Usage
Mercurial configuration:
config Configuration Files
environment Environment Variables
extensions Using Additional Features
flags Command-line flags
hgweb Configuring hgweb
merge-tools Merge Tools
pager Pager Support
Concepts:
bundlespec Bundle File Formats
glossary Glossary
phases Working with Phases
subrepos Subrepositories
(use 'hg help -v' to show built-in aliases and global options)