[PATCH 1 of 2 RESEND] help: hide command line options marked as "advanced"
Jun Wu
quark at fb.com
Thu Feb 23 02:30:01 UTC 2017
# HG changeset patch
# User Jun Wu <quark at fb.com>
# Date 1478011845 0
# Tue Nov 01 14:50:45 2016 +0000
# Node ID a9d70a1a09e4e391f8ec22d10831999d7c3e5294
# Parent 80f04ba7f4d1f439d726068f02172f9a52b981fe
# Available At https://bitbucket.org/quark-zju/hg-draft
# hg pull https://bitbucket.org/quark-zju/hg-draft -r a9d70a1a09e4
help: hide command line options marked as "advanced"
Previously, we have keywords like "(DEPRECATED)" and "(EXPERIMENTAL)" to
hide command line options in non-verbose help output.
However, sometimes an option is neither deprecated nor experimental. It's
well-tested and working, but just not designed to average users. This patch
adds a keyword "(ADVANCED)" to fit in such use cases.
Thanks rom1dep for the suggestion of the word "advanced".
diff --git a/mercurial/help.py b/mercurial/help.py
--- a/mercurial/help.py
+++ b/mercurial/help.py
@@ -34,12 +34,15 @@ from .hgweb import (
)
-_exclkeywords = [
+_exclkeywords = set([
+ "(ADVANCED)",
"(DEPRECATED)",
"(EXPERIMENTAL)",
+ # i18n: "(ADVANCED)" is a keyword, must be translated consistently
+ _("(ADVANCED)"),
# i18n: "(DEPRECATED)" is a keyword, must be translated consistently
_("(DEPRECATED)"),
# i18n: "(EXPERIMENTAL)" is a keyword, must be translated consistently
_("(EXPERIMENTAL)"),
- ]
+ ])
def listexts(header, exts, indent=1, showdeprecated=False):
diff --git a/tests/test-help.t b/tests/test-help.t
--- a/tests/test-help.t
+++ b/tests/test-help.t
@@ -684,4 +684,5 @@ this is a section and erroring out weird
> 'hg nohelp',
> norepo=True)
+ > @command('debugoptADV', [('', 'aopt', None, 'option is (ADVANCED)')])
> @command('debugoptDEP', [('', 'dopt', None, 'option is (DEPRECATED)')])
> @command('debugoptEXP', [('', 'eopt', None, 'option is (EXPERIMENTAL)')])
@@ -896,4 +897,5 @@ Test list of internal help commands
debugobsolete
create arbitrary obsolete marker
+ debugoptADV (no help text available)
debugoptDEP (no help text available)
debugoptEXP (no help text available)
@@ -1109,5 +1111,13 @@ Test list of commands with command with
-test deprecated and experimental options are hidden in command help
+test advanced, deprecated and experimental options are hidden in command help
+ $ hg help debugoptADV
+ hg debugoptADV
+
+ (no help text available)
+
+ options:
+
+ (some details hidden, use --verbose to show complete help)
$ hg help debugoptDEP
hg debugoptDEP
@@ -1128,5 +1138,7 @@ test deprecated and experimental options
(some details hidden, use --verbose to show complete help)
-test deprecated and experimental options is shown with -v
+test advanced, deprecated and experimental options are shown with -v
+ $ hg help -v debugoptADV | grep aopt
+ --aopt option is (ADVANCED)
$ hg help -v debugoptDEP | grep dopt
--dopt option is (DEPRECATED)
More information about the Mercurial-devel
mailing list