Fix up help message for reset-state call

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

2 files changed, 18 insertions, 11 deletions

diff --git a/cinderclient/v1/shell.py b/cinderclient/v1/shell.py
index 20e52c6..bd442b9 100644
--- a/cinderclient/v1/shell.py
+++ b/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."""
diff --git a/cinderclient/v2/shell.py b/cinderclient/v2/shell.py
index b528947..626ac6f 100644
--- a/cinderclient/v2/shell.py
+++ b/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."""