From 811af8f3742d8a06d2bec6ed62f4e8e9b3f02ae2 Mon Sep 17 00:00:00 2001 From: Eric Harney Date: Thu, 22 May 2014 15:29:51 -0400 Subject: [PATCH] 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 --- cinderclient/v1/shell.py | 96 ++++++++++++++++++++-------------------- cinderclient/v2/shell.py | 82 +++++++++++++++++----------------- 2 files changed, 89 insertions(+), 89 deletions(-) diff --git a/cinderclient/v1/shell.py b/cinderclient/v1/shell.py index 1ebe6c610..2f2eb1989 100644 --- a/cinderclient/v1/shell.py +++ b/cinderclient/v1/shell.py @@ -148,19 +148,19 @@ def _extract_metadata(args): '--display-name', metavar='', 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='', 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='', 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='', 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='', 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='', 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='', 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='', 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='', 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='', 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='', 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='', help='New display name for volume.') @utils.arg('--display-description', metavar='', - 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='', 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='', default=None, - help='Filters list by a status. OPTIONAL: Default=None.') + help='Filters list by a status. Default=None.') @utils.arg( '--volume-id', metavar='', 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='', 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='', 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='', help='New display name for snapshot.') @utils.arg('--display-description', metavar='', - 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='', 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='', 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='', 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='', 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='', 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='', 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='', 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='', 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='', 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='', help='Container format type. ' - 'OPTIONAL: Default is bare.', + 'Default is bare.', default='bare') @utils.arg('--disk-format', metavar='', help='Disk format type. ' - 'OPTIONAL: Default is raw.', + 'Default is raw.', default='raw') @utils.arg('image_name', metavar='', @@ -857,13 +857,13 @@ def do_upload_to_image(cs, args): @utils.arg('volume', metavar='', help='Name or ID of volume to back up.') @utils.arg('--container', metavar='', - help='Backup container name. OPTIONAL: Default=None.', + help='Backup container name. Default=None.', default=None) @utils.arg('--display-name', metavar='', - help='Backup name. OPTIONAL: Default=None.', + help='Backup name. Default=None.', default=None) @utils.arg('--display-description', metavar='', - 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='', 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='', help='Name or ID of volume to transfer.') @utils.arg('--display-name', metavar='', - 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='', default=None, - help='Host name. OPTIONAL: Default=None.') + help='Host name. Default=None.') @utils.arg('--binary', metavar='', 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='', 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='', 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='', 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.""" diff --git a/cinderclient/v2/shell.py b/cinderclient/v2/shell.py index 77a432685..a5c0f2d6c 100644 --- a/cinderclient/v2/shell.py +++ b/cinderclient/v2/shell.py @@ -202,25 +202,25 @@ def do_show(cs, args): @utils.arg('--snapshot-id', metavar='', default=None, - help='Creates volume from snapshot ID. OPTIONAL: Default=None.') + help='Creates volume from snapshot ID. Default=None.') @utils.arg('--snapshot_id', help=argparse.SUPPRESS) @utils.arg('--source-volid', metavar='', default=None, - help='Creates volume from volume ID. OPTIONAL: Default=None.') + help='Creates volume from volume ID. Default=None.') @utils.arg('--source_volid', help=argparse.SUPPRESS) @utils.arg('--image-id', metavar='', default=None, - help='Creates volume from image ID. OPTIONAL: Default=None.') + help='Creates volume from image ID. Default=None.') @utils.arg('--image_id', help=argparse.SUPPRESS) @utils.arg('--name', metavar='', default=None, - help='Volume name. OPTIONAL: Default=None.') + help='Volume name. Default=None.') @utils.arg('--display-name', help=argparse.SUPPRESS) @utils.arg('--display_name', @@ -228,7 +228,7 @@ def do_show(cs, args): @utils.arg('--description', metavar='', default=None, - help='Volume description. OPTIONAL: Default=None.') + help='Volume description. Default=None.') @utils.arg('--display-description', help=argparse.SUPPRESS) @utils.arg('--display_description', @@ -236,20 +236,20 @@ def do_show(cs, args): @utils.arg('--volume-type', metavar='', default=None, - help='Volume type. OPTIONAL: Default=None.') + help='Volume type. Default=None.') @utils.arg('--volume_type', help=argparse.SUPPRESS) @utils.arg('--availability-zone', metavar='', default=None, - help='Availability zone for volume. OPTIONAL: Default=None.') + help='Availability zone for volume. Default=None.') @utils.arg('--availability_zone', help=argparse.SUPPRESS) @utils.arg('--metadata', type=str, nargs='*', metavar='', - help='Metadata key and value pairs. OPTIONAL: Default=None.', + help='Metadata key and value pairs. Default=None.', default=None) @utils.arg('--hint', metavar='', @@ -347,7 +347,7 @@ def do_force_delete(cs, args): help=('The state to assign to the volume. Valid values are ' '"available," "error," "creating," "deleting," and ' '"error_deleting." ' - 'OPTIONAL: Default is available.')) + 'Default=available.')) @utils.service_type('volumev2') def do_reset_state(cs, args): """Explicitly updates the volume state.""" @@ -378,7 +378,7 @@ def do_reset_state(cs, args): metavar='', help='New name for volume.') @utils.arg('--description', metavar='', - help='Volume description. OPTIONAL: Default=None.', + help='Volume description. Default=None.', default=None) @utils.arg('--display-description', help=argparse.SUPPRESS) @@ -446,7 +446,7 @@ def do_metadata(cs, args): @utils.arg('--name', metavar='', default=None, - help='Filters results by a name. OPTIONAL: Default=None.') + help='Filters results by a name. Default=None.') @utils.arg('--display-name', help=argparse.SUPPRESS) @utils.arg('--display_name', @@ -454,11 +454,11 @@ def do_metadata(cs, args): @utils.arg('--status', metavar='', default=None, - help='Filters results by a status. OPTIONAL: Default=None.') + help='Filters results by a status. Default=None.') @utils.arg('--volume-id', metavar='', default=None, - help='Filters results by a volume ID. OPTIONAL: Default=None.') + help='Filters results by a volume ID. Default=None.') @utils.arg('--volume_id', help=argparse.SUPPRESS) @utils.service_type('volumev2') @@ -502,12 +502,12 @@ 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('--name', metavar='', default=None, - help='Snapshot name. OPTIONAL: Default=None.') + help='Snapshot name. Default=None.') @utils.arg('--display-name', help=argparse.SUPPRESS) @utils.arg('--display_name', @@ -515,7 +515,7 @@ def do_snapshot_show(cs, args): @utils.arg('--description', metavar='', default=None, - help='Snapshot description. OPTIONAL: Default=None.') + help='Snapshot description. Default=None.') @utils.arg('--display-description', help=argparse.SUPPRESS) @utils.arg('--display_description', @@ -560,7 +560,7 @@ def do_snapshot_delete(cs, args): @utils.arg('name', nargs='?', metavar='', help='New name for snapshot.') @utils.arg('--description', metavar='', - help='Snapshot description. OPTIONAL: Default=None.', + help='Snapshot description. Default=None.', default=None) @utils.arg('--display-description', help=argparse.SUPPRESS) @@ -593,7 +593,7 @@ def do_snapshot_rename(cs, args): help=('The state to assign to the snapshot. Valid values are ' '"available," "error," "creating," "deleting," and ' '"error_deleting." ' - 'OPTIONAL: Default is "available."')) + 'Default is "available."')) @utils.service_type('volumev2') def do_snapshot_reset_state(cs, args): """Explicitly updates the snapshot state.""" @@ -781,19 +781,19 @@ def do_quota_defaults(cs, args): @utils.arg('--volumes', metavar='', 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='', 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='', 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='', default=None, - help='Volume type. OPTIONAL: Default=None.') + help='Volume type. Default=None.') @utils.service_type('volumev2') def do_quota_update(cs, args): """Updates quotas for a tenant.""" @@ -826,19 +826,19 @@ def do_quota_class_show(cs, args): @utils.arg('--volumes', metavar='', 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='', 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='', 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='', default=None, - help='Volume type. OPTIONAL: Default=None.') + help='Volume type. Default=None.') @utils.service_type('volumev2') def do_quota_class_update(cs, args): """Updates quotas for a quota class.""" @@ -881,19 +881,19 @@ def _find_volume_type(cs, vtype): metavar='', 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='', help='Container format type. ' - 'OPTIONAL: Default is bare.', + 'Default is bare.', default='bare') @utils.arg('--container_format', help=argparse.SUPPRESS) @utils.arg('--disk-format', metavar='', help='Disk format type. ' - 'OPTIONAL: Default is raw.', + 'Default is raw.', default='raw') @utils.arg('--disk_format', help=argparse.SUPPRESS) @@ -918,7 +918,7 @@ def do_upload_to_image(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('volumev2') def do_migrate(cs, args): @@ -943,19 +943,19 @@ def do_retype(cs, args): @utils.arg('volume', metavar='', help='Name or ID of volume to backup.') @utils.arg('--container', metavar='', - help='Backup container name. OPTIONAL: Default=None.', + help='Backup container name. Default=None.', default=None) @utils.arg('--display-name', help=argparse.SUPPRESS) @utils.arg('--name', metavar='', - help='Backup name. OPTIONAL: Default=None.', + help='Backup name. Default=None.', default=None) @utils.arg('--display-description', help=argparse.SUPPRESS) @utils.arg('--description', metavar='', default=None, - help='Backup description. OPTIONAL: Default=None.') + help='Backup description. Default=None.') @utils.service_type('volumev2') def do_backup_create(cs, args): """Creates a volume backup.""" @@ -1017,7 +1017,7 @@ def do_backup_delete(cs, args): default=None) @utils.arg('--volume', metavar='', help='Name or ID of volume to which to restore. ' - 'OPTIONAL: Default=None.', + 'Default=None.', default=None) @utils.service_type('volumev2') def do_backup_restore(cs, args): @@ -1057,7 +1057,7 @@ def do_backup_import(cs, args): @utils.arg('--name', metavar='', default=None, - help='Transfer name. OPTIONAL: Default=None.') + help='Transfer name. Default=None.') @utils.arg('--display-name', help=argparse.SUPPRESS) @utils.service_type('volumev2') @@ -1135,9 +1135,9 @@ def do_extend(cs, args): @utils.arg('--host', metavar='', default=None, - help='Host name. OPTIONAL: Default=None.') + help='Host name. Default=None.') @utils.arg('--binary', metavar='', default=None, - help='Service binary. OPTIONAL: Default=None.') + help='Service binary. Default=None.') @utils.service_type('volumev2') def do_service_list(cs, args): """Lists all services. Filter by host and service binary.""" @@ -1289,14 +1289,14 @@ def do_encryption_type_show(cs, args): required=False, default=None, help='The encryption algorithm or mode. ' - 'For example, aes-xts-plain64. OPTIONAL: Default=None.') + 'For example, aes-xts-plain64. Default=None.') @utils.arg('--key_size', metavar='', 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='', choices=['front-end', 'back-end'], @@ -1305,7 +1305,7 @@ def do_encryption_type_show(cs, args): default='front-end', 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."') + 'For example, front-end=Nova. Default is "front-end."') @utils.service_type('volumev2') def do_encryption_type_create(cs, args): """Creates encryption type for a volume type. Admin only.""" @@ -1388,7 +1388,7 @@ def do_qos_show(cs, args): metavar='', default=False, help='Enables or disables deletion of in-use ' - 'QoS specifications. OPTIONAL: Default=False.') + 'QoS specifications. Default=False.') @utils.service_type('volumev2') def do_qos_delete(cs, args): """Deletes a specified qos specs."""