nova-manage useage exposes action-args

Bug #1260538 reported by Scott Devoid
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Wishlist
Juan Manuel Ollé

Bug Description

The nova-manage command exposes the action_args options during the usage output for command.

E.g.
$ nova-manage network modify -h
usage: nova-manage network modify [-h] [--fixed_range <x.x.x.x/yy>]
                                  [--project <project name>] [--host <host>]
                                  [--disassociate-project]
                                  [--disassociate-host]
                                  [action_args [action_args ...]]

positional arguments:
  action_args

<snip>

This can cause confusion as users naturally expect there to be more "actions" on commands like "modify". Even in straightforward cases, this positional argument leaks into usage.

$ nova-manage db version -h
usage: nova-manage db version [-h] [action_args [action_args ...]]

positional arguments:
  action_args

Please consider suppressing documentation on action_args. In addition, expose the __doc__ strings for these functions, which is done in the nova command.

affects: barbican → nova
tags: added: low-hanging-fruit user-experience
tags: added: nova-manage ux
Changed in nova:
status: New → Triaged
importance: Undecided → Wishlist
Changed in nova:
assignee: nobody → sahid (sahid-ferdjaoui)
Revision history for this message
Sahid Orentino (sahid-ferdjaoui) wrote :

Actually I don't know what action_args is used for?
https://github.com/openstack/nova/blob/master/nova/cmd/manage.py#L1312

Changed in nova:
assignee: sahid (sahid-ferdjaoui) → nobody
Changed in nova:
assignee: nobody → Juan Manuel Ollé (juan-m-olle)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

Fix proposed to branch: master
Review: https://review.openstack.org/74503

Changed in nova:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to nova (master)

Reviewed: https://review.openstack.org/74503
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=62c869d2375009190c5358636fd7de2ab9d194a5
Submitter: Jenkins
Branch: master

commit 62c869d2375009190c5358636fd7de2ab9d194a5
Author: Juan Manuel Olle <email address hidden>
Date: Tue Feb 18 17:47:57 2014 -0300

    Remove action-args from nova-manage help

    During help [action_args [action_args ...]] could be
    confusing for users

    $ nova-manage network list -h
    usage: nova-manage network list [-h]
             [action_args [action_args ...]]

    Because of that action_args is set to "SUPPRESS" from the help

    Change-Id: I0fdc480724d3b59a8eebb2d294f324441c5e46b2
    Closes-Bug: #1260538

Changed in nova:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in nova:
milestone: none → juno-1
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in nova:
milestone: juno-1 → 2014.2
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.