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
This commit is contained in:
Petr Viktorin 2012-11-08 08:57:39 -05:00 committed by Rob Crittenden
parent de1c4eeae2
commit f16c100f1e
2 changed files with 5 additions and 2 deletions

View File

@ -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']),
)

View File

@ -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()