openstack/python-cinderclient
Code Issues Proposed changes

Fix up help message for reset-state call

Browse Source 
There's some confusion about what the reset-state
call does.  It's not clear to some that this call
simply changes the state of the object in the data-base.

This patch just updates the help message to indicate more
clearly that reset-state ONLY changes state in the DB.

Change-Id: Ia389cfd8b1a821a356706201c009cf3c8dca8419
This commit is contained in:
John Griffith 2015-01-28 11:58:32 -06:00
parent 0d93c3b76d
commit e9e8aab2ec
2 changed files with 18 additions and 11 deletions
cinderclient
v1
shell.py
v2
shell.py

19
cinderclient/v1/shell.py

@ -332,9 +332,11 @@ def do_force_delete(cs, args):
'Separate multiple volumes with a space.')
@utils.arg('--state', metavar='<state>', default='available',
help=('The state to assign to the volume. Valid values are '
'"available," "error," "creating," "deleting," or '
'"error_deleting." '
'Default is "available."'))
'"available," "error," "creating," "deleting," and '
'"error_deleting." NOTE: This command simply changes '
'the state of the Volume in the DataBase with no regard '
'to actual status, exercise caution when using. '
'Default=available.'))
@utils.service_type('volume')
def do_reset_state(cs, args):
"""Explicitly updates the volume state."""
@ -542,12 +544,13 @@ def do_snapshot_rename(cs, args):
@utils.arg('snapshot', metavar='<snapshot>', nargs='+',
help='Name or ID of snapshot to modify.')
@utils.arg('--state', metavar='<state>',
default='available',
@utils.arg('--state', metavar='<state>', default='available',
help=('The state to assign to the snapshot. Valid values are '
'"available," "error," "creating," "deleting," or '
'"error_deleting." '
'Default is "available."'))
'"available," "error," "creating," "deleting," and '
'"error_deleting." NOTE: This command simply changes '
'the state of the Snapshot in the DataBase with no regard '
'to actual status, exercise caution when using. '
'Default=available.'))
@utils.service_type('volume')
def do_snapshot_reset_state(cs, args):
"""Explicitly updates the snapshot state."""

10
cinderclient/v2/shell.py

@ -421,7 +421,9 @@ def do_force_delete(cs, args):
@utils.arg('--state', metavar='<state>', default='available',
help=('The state to assign to the volume. Valid values are '
'"available," "error," "creating," "deleting," and '
'"error_deleting." '
'"error_deleting." NOTE: This command simply changes '
'the state of the Volume in the DataBase with no regard '
'to actual status, exercise caution when using. '
'Default=available.'))
@utils.service_type('volumev2')
def do_reset_state(cs, args):
@ -674,8 +676,10 @@ def do_snapshot_rename(cs, args):
default='available',
help=('The state to assign to the snapshot. Valid values are '
'"available," "error," "creating," "deleting," and '
'"error_deleting." '
'Default is "available."'))
'"error_deleting." NOTE: This command simply changes '
'the state of the Snapshot in the DataBase with no regard '
'to actual status, exercise caution when using. '
'Default=available.'))
@utils.service_type('volumev2')
def do_snapshot_reset_state(cs, args):
"""Explicitly updates the snapshot state."""