From f16c100f1e72e8afbe26e12e7d236d3ef60f4433 Mon Sep 17 00:00:00 2001 From: Petr Viktorin Date: Thu, 8 Nov 2012 08:57:39 -0500 Subject: 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 ` still works as before if there's no topic with the same name. https://fedorahosted.org/freeipa/ticket/3247 --- ipalib/cli.py | 5 ++++- ipalib/plugable.py | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/ipalib/cli.py b/ipalib/cli.py index ab2918b5..59abc3b1 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 d2541e3b..8f42c630 100644 --- a/ipalib/plugable.py +++ b/ipalib/plugable.py @@ -531,7 +531,7 @@ class API(DictProxy): 'See "ipa help " for more information on a ' 'specific topic.', 'See "ipa help commands" for the full list of commands.', - 'See "ipa help " for more information on a ' + 'See "ipa --help" for more information on a ' 'specific command.', ])) parser.disable_interspersed_args() -- cgit