-h and --help revert to top level help when used in a subcommand

[opavlenk]

The only way to get help output for a 'sub-command' (like `user set` or `user list`) is to insert 'help' as the first positional argument.

Like so: $ openstack help user set`

usage: openstack user set [-h] [--name <name>] [--project <project>]
                          [--password <user-password>] [--password-prompt]
                          [--email <email-address>] [--enable | --disable]
                          <user>

If using -h or --help anywhere, the "top-level" help output is printed. (the same output as `openstack help`)

$ openstack user set --help

OR

$ openstack -h user set

Will both print out the *entire* help output, with all env. properties and command options.

usage: openstack [--version] [-v] [--log-file LOG_FILE] [-q] [--debug]
                 [--os-region-name <auth-region-name>]
                 [--os-cacert <ca-bundle-file>] [--verify | --insecure]
...
Commands:
  aggregate add host Add host to aggregate
  aggregate create Create a new aggregate
  aggregate delete Delete an existing aggregate

[Steve Martinelli (stevemar)]

i'm a bit confused here - is the issue that the -h option isn't showing up?

[Steve Martinelli (stevemar)]

I run `$ openstack help user set`

Actual results:
usage: openstack user set [-h] [--name <name>] [--project <project>]
                          [--password <user-password>] [--password-prompt]
                          [--email <email-address>] [--enable | --disable]
                          <user>

[Dean Troyer (dtroyer)]

So this is the intended behaviour, -h and --help are global options and are intended to produce the help for the other global options and list the recognized commands for the selected API versions.

Help for commands is returned using the help command, which actually is an OSC command (cliff really).

[Steve Martinelli (stevemar)]

I'll keep this tracked in OSC too, even though we won't fix anything, i'll use this bug to track when we actually bump the cliff requirement

[Steve Martinelli (stevemar)]

Fix for cliff is at: https://review.openstack.org/#/c/201258/

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/201258
Committed: https://git.openstack.org/cgit/openstack/cliff/commit/?id=5d5aeb2f99410bd71904f92bf21fba7abf4ea284
Submitter: Jenkins
Branch: master

commit 5d5aeb2f99410bd71904f92bf21fba7abf4ea284
Author: Sean Perry <email address hidden>
Date: Mon Jul 13 09:00:28 2015 -0700

    Allow subcommands to accept --help when using 'deferred_help'.

    This patch changes how cliff handles help for subcommands but only when
    'deferred_help' is enabled. Currently cliff consumes --help requests at the top
    level. This means `myapp foo --help` and `myapp --help` produce the same output.
    To get help for `foo` one must use `myapp help foo`. With this change
    `myapp foo --help` will produce the same output as `myapp help foo` by
    transforming the --help request into a help subcommand one. This is only done
    when there are any options on the command line other than --help. When a top
    level --help is requested the original behavior of print_help_if_requested()
    is preserved.

    Change-Id: I628bbfc383de516045288512cc023213d723a027
    Closes-Bug: 1444983

[Steve Martinelli (stevemar)]

this will be resolved when we release 1.6.0 of osc