summaryrefslogtreecommitdiff
path: root/cinderclient/v1
diff options
context:
space:
mode:
authorEric Harney <eharney@redhat.com>2014-05-22 15:29:51 -0400
committerEric Harney <eharney@redhat.com>2014-05-22 15:43:31 -0400
commit811af8f3742d8a06d2bec6ed62f4e8e9b3f02ae2 (patch)
treeac8043cd220be98f4cbe7a49bf6aac926f831cf3 /cinderclient/v1
parent12347c1a474fe2f93edf1c02f6c2c8dc094862b2 (diff)
downloadpython-cinderclient-811af8f3742d8a06d2bec6ed62f4e8e9b3f02ae2.tar.gz
Remove "OPTIONAL:" from optional argument help text
All arguments starting with '--' are optional and listed under the 'Optional arguments:' header by argparse. Remove the extra note shown for each argument. Change-Id: Ic361a3bdbd1f1669458e16b99995f0f108400699
Diffstat (limited to 'cinderclient/v1')
-rw-r--r--cinderclient/v1/shell.py96
1 files changed, 48 insertions, 48 deletions
diff --git a/cinderclient/v1/shell.py b/cinderclient/v1/shell.py
index 1ebe6c6..2f2eb19 100644
--- a/cinderclient/v1/shell.py
+++ b/cinderclient/v1/shell.py
@@ -148,19 +148,19 @@ def _extract_metadata(args):
'--display-name',
metavar='<display-name>',
default=None,
- help='Filters list by a volume display name. OPTIONAL: Default=None.')
+ help='Filters list by a volume display name. Default=None.')
@utils.arg(
'--status',
metavar='<status>',
default=None,
- help='Filters list by a status. OPTIONAL: Default=None.')
+ help='Filters list by a status. Default=None.')
@utils.arg(
'--metadata',
type=str,
nargs='*',
metavar='<key=value>',
help='Filters list by metadata key and value pair. '
- 'OPTIONAL: Default=None.',
+ 'Default=None.',
default=None)
@utils.service_type('volume')
def do_list(cs, args):
@@ -200,7 +200,7 @@ def do_show(cs, args):
metavar='<snapshot-id>',
default=None,
help='Creates volume from snapshot ID. '
- 'OPTIONAL: Default=None.')
+ 'Default=None.')
@utils.arg(
'--snapshot_id',
help=argparse.SUPPRESS)
@@ -209,7 +209,7 @@ def do_show(cs, args):
metavar='<source-volid>',
default=None,
help='Creates volume from volume ID. '
- 'OPTIONAL: Default=None.')
+ 'Default=None.')
@utils.arg(
'--source_volid',
help=argparse.SUPPRESS)
@@ -218,7 +218,7 @@ def do_show(cs, args):
metavar='<image-id>',
default=None,
help='Creates volume from image ID. '
- 'OPTIONAL: Default=None.')
+ 'Default=None.')
@utils.arg(
'--image_id',
help=argparse.SUPPRESS)
@@ -227,7 +227,7 @@ def do_show(cs, args):
metavar='<display-name>',
default=None,
help='Volume name. '
- 'OPTIONAL: Default=None.')
+ 'Default=None.')
@utils.arg(
'--display_name',
help=argparse.SUPPRESS)
@@ -236,7 +236,7 @@ def do_show(cs, args):
metavar='<display-description>',
default=None,
help='Volume description. '
- 'OPTIONAL: Default=None.')
+ 'Default=None.')
@utils.arg(
'--display_description',
help=argparse.SUPPRESS)
@@ -245,7 +245,7 @@ def do_show(cs, args):
metavar='<volume-type>',
default=None,
help='Volume type. '
- 'OPTIONAL: Default=None.')
+ 'Default=None.')
@utils.arg(
'--volume_type',
help=argparse.SUPPRESS)
@@ -254,7 +254,7 @@ def do_show(cs, args):
metavar='<availability-zone>',
default=None,
help='Availability zone for volume. '
- 'OPTIONAL: Default=None.')
+ 'Default=None.')
@utils.arg(
'--availability_zone',
help=argparse.SUPPRESS)
@@ -263,7 +263,7 @@ def do_show(cs, args):
nargs='*',
metavar='<key=value>',
help='Metadata key and value pairs. '
- 'OPTIONAL: Default=None.',
+ 'Default=None.',
default=None)
@utils.service_type('volume')
def do_create(cs, args):
@@ -328,7 +328,7 @@ def do_force_delete(cs, args):
help=('The state to assign to the volume. Valid values are '
'"available," "error," "creating," "deleting," or '
'"error_deleting." '
- 'OPTIONAL: Default is "available."'))
+ 'Default is "available."'))
@utils.service_type('volume')
def do_reset_state(cs, args):
"""Explicitly updates the volume state."""
@@ -356,7 +356,7 @@ def do_reset_state(cs, args):
@utils.arg('display_name', nargs='?', metavar='<display-name>',
help='New display name for volume.')
@utils.arg('--display-description', metavar='<display-description>',
- help='Volume description. OPTIONAL: Default=None.',
+ help='Volume description. Default=None.',
default=None)
@utils.service_type('volume')
def do_rename(cs, args):
@@ -387,7 +387,7 @@ def do_rename(cs, args):
default=[],
help='The metadata key and pair to set or unset. '
'For unset, specify only the key. '
- 'OPTIONAL: Default=[].')
+ 'Default=[].')
@utils.service_type('volume')
def do_metadata(cs, args):
"""Sets or deletes volume metadata."""
@@ -421,17 +421,17 @@ def do_metadata(cs, args):
'--display-name',
metavar='<display-name>',
default=None,
- help='Filters list by a display name. OPTIONAL: Default=None.')
+ help='Filters list by a display name. Default=None.')
@utils.arg(
'--status',
metavar='<status>',
default=None,
- help='Filters list by a status. OPTIONAL: Default=None.')
+ help='Filters list by a status. Default=None.')
@utils.arg(
'--volume-id',
metavar='<volume-id>',
default=None,
- help='Filters list by a volume ID. OPTIONAL: Default=None.')
+ help='Filters list by a volume ID. Default=None.')
@utils.service_type('volume')
def do_snapshot_list(cs, args):
"""Lists all snapshots."""
@@ -468,13 +468,13 @@ def do_snapshot_show(cs, args):
'If set to True, ignores the current status of the '
'volume when attempting to snapshot it rather '
'than forcing it to be available. '
- 'OPTIONAL: Default=False.',
+ 'Default=False.',
default=False)
@utils.arg(
'--display-name',
metavar='<display-name>',
default=None,
- help='The snapshot name. OPTIONAL: Default=None.')
+ help='The snapshot name. Default=None.')
@utils.arg(
'--display_name',
help=argparse.SUPPRESS)
@@ -482,7 +482,7 @@ def do_snapshot_show(cs, args):
'--display-description',
metavar='<display-description>',
default=None,
- help='The snapshot description. OPTIONAL: Default=None.')
+ help='The snapshot description. Default=None.')
@utils.arg(
'--display_description',
help=argparse.SUPPRESS)
@@ -520,7 +520,7 @@ def do_snapshot_delete(cs, args):
@utils.arg('display_name', nargs='?', metavar='<display-name>',
help='New display name for snapshot.')
@utils.arg('--display-description', metavar='<display-description>',
- help='Snapshot description. OPTIONAL: Default=None.',
+ help='Snapshot description. Default=None.',
default=None)
@utils.service_type('volume')
def do_snapshot_rename(cs, args):
@@ -545,7 +545,7 @@ def do_snapshot_rename(cs, args):
help=('The state to assign to the snapshot. Valid values are '
'"available," "error," "creating," "deleting," or '
'"error_deleting." '
- 'OPTIONAL: Default is "available."'))
+ 'Default is "available."'))
@utils.service_type('volume')
def do_snapshot_reset_state(cs, args):
"""Explicitly updates the snapshot state."""
@@ -624,7 +624,7 @@ def do_type_delete(cs, args):
nargs='*',
default=None,
help='The extra specs key and value pair to set or unset. '
- 'For unset, specify only the key. OPTIONAL: Default=None.')
+ 'For unset, specify only the key. Default=None.')
@utils.service_type('volume')
def do_type_key(cs, args):
"""Sets or unsets extra_spec for a volume type."""
@@ -731,19 +731,19 @@ def do_quota_defaults(cs, args):
@utils.arg('--volumes',
metavar='<volumes>',
type=int, default=None,
- help='The new "volumes" quota value. OPTIONAL: Default=None.')
+ help='The new "volumes" quota value. Default=None.')
@utils.arg('--snapshots',
metavar='<snapshots>',
type=int, default=None,
- help='The new "snapshots" quota value. OPTIONAL: Default=None.')
+ help='The new "snapshots" quota value. Default=None.')
@utils.arg('--gigabytes',
metavar='<gigabytes>',
type=int, default=None,
- help='The new "gigabytes" quota value. OPTIONAL: Default=None.')
+ help='The new "gigabytes" quota value. Default=None.')
@utils.arg('--volume-type',
metavar='<volume_type_name>',
default=None,
- help='Volume type. OPTIONAL: Default=None.')
+ help='Volume type. Default=None.')
@utils.service_type('volume')
def do_quota_update(cs, args):
"""Updates quotas for a tenant."""
@@ -774,19 +774,19 @@ def do_quota_class_show(cs, args):
@utils.arg('--volumes',
metavar='<volumes>',
type=int, default=None,
- help='The new "volumes" quota value. OPTIONAL: Default=None.')
+ help='The new "volumes" quota value. Default=None.')
@utils.arg('--snapshots',
metavar='<snapshots>',
type=int, default=None,
- help='The new "snapshots" quota value. OPTIONAL: Default=None.')
+ help='The new "snapshots" quota value. Default=None.')
@utils.arg('--gigabytes',
metavar='<gigabytes>',
type=int, default=None,
- help='The new "gigabytes" quota value. OPTIONAL: Default=None.')
+ help='The new "gigabytes" quota value. Default=None.')
@utils.arg('--volume-type',
metavar='<volume_type_name>',
default=None,
- help='Volume type. OPTIONAL: Default=None.')
+ help='Volume type. Default=None.')
@utils.service_type('volume')
def do_quota_class_update(cs, args):
"""Updates quotas for a quota class."""
@@ -829,17 +829,17 @@ def _find_volume_type(cs, vtype):
metavar='<True|False>',
help='Enables or disables upload of '
'a volume that is attached to an instance. '
- 'OPTIONAL: Default=False.',
+ 'Default=False.',
default=False)
@utils.arg('--container-format',
metavar='<container-format>',
help='Container format type. '
- 'OPTIONAL: Default is bare.',
+ 'Default is bare.',
default='bare')
@utils.arg('--disk-format',
metavar='<disk-format>',
help='Disk format type. '
- 'OPTIONAL: Default is raw.',
+ 'Default is raw.',
default='raw')
@utils.arg('image_name',
metavar='<image-name>',
@@ -857,13 +857,13 @@ def do_upload_to_image(cs, args):
@utils.arg('volume', metavar='<volume>',
help='Name or ID of volume to back up.')
@utils.arg('--container', metavar='<container>',
- help='Backup container name. OPTIONAL: Default=None.',
+ help='Backup container name. Default=None.',
default=None)
@utils.arg('--display-name', metavar='<display-name>',
- help='Backup name. OPTIONAL: Default=None.',
+ help='Backup name. Default=None.',
default=None)
@utils.arg('--display-description', metavar='<display-description>',
- help='Backup description. OPTIONAL: Default=None.',
+ help='Backup description. Default=None.',
default=None)
@utils.service_type('volume')
def do_backup_create(cs, args):
@@ -919,7 +919,7 @@ def do_backup_delete(cs, args):
help='ID of backup to restore.')
@utils.arg('--volume-id', metavar='<volume>',
help='ID or name of backup volume to '
- 'which to restore. OPTIONAL: Default=None.',
+ 'which to restore. Default=None.',
default=None)
@utils.service_type('volume')
def do_backup_restore(cs, args):
@@ -934,7 +934,7 @@ def do_backup_restore(cs, args):
@utils.arg('volume', metavar='<volume>',
help='Name or ID of volume to transfer.')
@utils.arg('--display-name', metavar='<display-name>',
- help='Transfer name. OPTIONAL: Default=None.',
+ help='Transfer name. Default=None.',
default=None)
@utils.service_type('volume')
def do_transfer_create(cs, args):
@@ -1014,9 +1014,9 @@ def do_extend(cs, args):
@utils.arg('--host', metavar='<hostname>', default=None,
- help='Host name. OPTIONAL: Default=None.')
+ help='Host name. Default=None.')
@utils.arg('--binary', metavar='<binary>', default=None,
- help='Service binary. OPTIONAL: Default=None.')
+ help='Service binary. Default=None.')
@utils.service_type('volume')
def do_service_list(cs, args):
"""Lists all services. Filter by host and service binary."""
@@ -1168,14 +1168,14 @@ def do_encryption_type_show(cs, args):
required=False,
default=None,
help='The encryption algorithm and mode. '
- 'For example, aes-xts-plain64. OPTIONAL: Default=None.')
+ 'For example, aes-xts-plain64. Default=None.')
@utils.arg('--key_size',
metavar='<key_size>',
type=int,
required=False,
default=None,
help='Size of encryption key, in bits. '
- 'For example, 128 or 256. OPTIONAL: Default=None.')
+ 'For example, 128 or 256. Default=None.')
@utils.arg('--control_location',
metavar='<control_location>',
choices=['front-end', 'back-end'],
@@ -1185,7 +1185,7 @@ def do_encryption_type_show(cs, args):
help='Notional service where encryption is performed. '
'Valid values are "front-end" or "back-end." '
'For example, front-end=Nova. '
- 'OPTIONAL: Default is "front-end."')
+ 'Default is "front-end."')
@utils.service_type('volume')
def do_encryption_type_create(cs, args):
"""Creates encryption type for a volume type. Admin only."""
@@ -1218,7 +1218,7 @@ def do_encryption_type_delete(cs, args):
choices=['True', 'False'], required=False,
help='Enables or disables generic host-based '
'force-migration, which bypasses driver '
- 'optimizations. OPTIONAL: Default=False.',
+ 'optimizations. Default=False.',
default=False)
@utils.service_type('volume')
def do_migrate(cs, args):
@@ -1284,7 +1284,7 @@ def do_qos_show(cs, args):
metavar='<True|False>',
default=False,
help='Enables or disables deletion of in-use '
- 'QoS specifications. OPTIONAL: Default=False.')
+ 'QoS specifications. Default=False.')
@utils.service_type('volume')
def do_qos_delete(cs, args):
"""Deletes a specified qos specs."""
@@ -1403,7 +1403,7 @@ def do_metadata_show(cs, args):
nargs='+',
default=[],
help='Metadata key and value pair or pairs to update. '
- 'OPTIONAL: Default=[].')
+ 'Default=[].')
@utils.service_type('volume')
def do_metadata_update_all(cs, args):
"""Updates volume metadata."""
@@ -1421,7 +1421,7 @@ def do_metadata_update_all(cs, args):
nargs='+',
default=[],
help='Metadata key and value pair or pairs to update. '
- 'OPTIONAL: Default=[].')
+ 'Default=[].')
@utils.service_type('volume')
def do_snapshot_metadata_update_all(cs, args):
"""Updates snapshot metadata."""