diff options
| author | Petr Viktorin <pviktori@redhat.com> | 2012-11-08 08:57:39 -0500 |
|---|---|---|
| committer | Rob Crittenden <rcritten@redhat.com> | 2013-02-18 13:07:17 -0500 |
| commit | f16c100f1e72e8afbe26e12e7d236d3ef60f4433 (patch) | |
| tree | df9099f1795fb5cc498fdc06280a8cd4ed076e3e /ipalib | |
| parent | de1c4eeae2f3439c1550f9627f45adb4586fa83c (diff) | |
| download | freeipa-f16c100f1e72e8afbe26e12e7d236d3ef60f4433.tar.gz freeipa-f16c100f1e72e8afbe26e12e7d236d3ef60f4433.tar.xz freeipa-f16c100f1e72e8afbe26e12e7d236d3ef60f4433.zip | |
Mention `ipa COMMAND --help` as the preferred way to get command help
This avoids the problem with ambiguous command/topic names.
No functionality is changed; `ipa help <COMMAND>` still works as before
if there's no topic with the same name.
https://fedorahosted.org/freeipa/ticket/3247
Diffstat (limited to 'ipalib')
| -rw-r--r-- | ipalib/cli.py | 5 | ||||
| -rw-r--r-- | ipalib/plugable.py | 2 |
2 files changed, 5 insertions, 2 deletions
diff --git a/ipalib/cli.py b/ipalib/cli.py index ab2918b53..59abc3b15 100644 --- a/ipalib/cli.py +++ b/ipalib/cli.py @@ -664,7 +664,10 @@ class help(frontend.Local): Display help for a command or topic. """ - takes_args = (Str('command?'),) + takes_args = ( + Str('command?', cli_name='topic', label=_('Topic or Command'), + doc=_('The topic or command name.')), + ) takes_options = ( Any('outfile?', flags=['no_option']), ) diff --git a/ipalib/plugable.py b/ipalib/plugable.py index d2541e3b7..8f42c6304 100644 --- a/ipalib/plugable.py +++ b/ipalib/plugable.py @@ -531,7 +531,7 @@ class API(DictProxy): 'See "ipa help <TOPIC>" for more information on a ' 'specific topic.', 'See "ipa help commands" for the full list of commands.', - 'See "ipa help <COMMAND>" for more information on a ' + 'See "ipa <COMMAND> --help" for more information on a ' 'specific command.', ])) parser.disable_interspersed_args() |