Skip to content

Commit b4402a0

Browse files
author
Dean Troyer
committed
Docs cleanup: volume type
Clean up volume type command help, add volume type show to doc, sort command classes in v1/volume_type.py. Change-Id: I1f8e5c047d9c08f5704fc23cfb694f23d32e3caf
1 parent 5f55e99 commit b4402a0

3 files changed

Lines changed: 54 additions & 33 deletions

File tree

‎doc/source/command-objects/volume-type.rst‎

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Create new volume type
2020
2121
.. option:: --description <description>
2222

23-
New volume type description
23+
Volume type description
2424

2525
.. versionadded:: 2
2626

@@ -40,9 +40,10 @@ Create new volume type
4040

4141
Set a property on this volume type (repeat option to set multiple properties)
4242

43+
.. _volume_type_create-name:
4344
.. describe:: <name>
4445

45-
New volume type name
46+
Volume type name
4647

4748
volume type delete
4849
------------------
@@ -55,6 +56,7 @@ Delete volume type
5556
os volume type delete
5657
<volume-type>
5758
59+
.. _volume_type_delete-volume-type:
5860
.. describe:: <volume-type>
5961

6062
Volume type to delete (name or ID)
@@ -102,12 +104,30 @@ Set volume type properties
102104

103105
.. option:: --property <key=value>
104106

105-
Property to add or modify for this volume type (repeat option to set multiple properties)
107+
Set a property on this volume type (repeat option to set multiple properties)
106108

109+
.. _volume_type_set-volume-type:
107110
.. describe:: <volume-type>
108111

109112
Volume type to modify (name or ID)
110113

114+
volume type show
115+
----------------
116+
117+
Display volume type details
118+
119+
120+
.. program:: volume type show
121+
.. code:: bash
122+
123+
os volume type show
124+
<volume-type>
125+
126+
.. _volume_type_show-volume-type:
127+
.. describe:: <volume-type>
128+
129+
Volume type to display (name or ID)
130+
111131
volume type unset
112132
-----------------
113133

@@ -124,6 +144,7 @@ Unset volume type properties
124144

125145
Property to remove from volume type (repeat option to remove multiple properties)
126146

147+
.. _volume_type_unset-volume-type:
127148
.. describe:: <volume-type>
128149

129150
Volume type to modify (name or ID)

‎openstackclient/volume/v1/volume_type.py‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ def get_parser(self, prog_name):
3030
parser.add_argument(
3131
'name',
3232
metavar='<name>',
33-
help='New volume type name',
33+
help='Volume type name',
3434
)
3535
parser.add_argument(
3636
'--property',
3737
metavar='<key=value>',
3838
action=parseractions.KeyValueAction,
39-
help='Property to add for this volume type '
39+
help='Set a property on this volume type '
4040
'(repeat option to set multiple properties)',
4141
)
4242
return parser
@@ -114,7 +114,7 @@ def get_parser(self, prog_name):
114114
'--property',
115115
metavar='<key=value>',
116116
action=parseractions.KeyValueAction,
117-
help='Property to add or modify for this volume type '
117+
help='Set a property on this volume type '
118118
'(repeat option to set multiple properties)',
119119
)
120120
return parser
@@ -128,6 +128,27 @@ def take_action(self, parsed_args):
128128
volume_type.set_keys(parsed_args.property)
129129

130130

131+
class ShowVolumeType(command.ShowOne):
132+
"""Display volume type details"""
133+
134+
def get_parser(self, prog_name):
135+
parser = super(ShowVolumeType, self).get_parser(prog_name)
136+
parser.add_argument(
137+
"volume_type",
138+
metavar="<volume-type>",
139+
help="Volume type to display (name or ID)"
140+
)
141+
return parser
142+
143+
def take_action(self, parsed_args):
144+
volume_client = self.app.client_manager.volume
145+
volume_type = utils.find_resource(
146+
volume_client.volume_types, parsed_args.volume_type)
147+
properties = utils.format_dict(volume_type._info.pop('extra_specs'))
148+
volume_type._info.update({'properties': properties})
149+
return zip(*sorted(six.iteritems(volume_type._info)))
150+
151+
131152
class UnsetVolumeType(command.Command):
132153
"""Unset volume type properties"""
133154

@@ -143,7 +164,7 @@ def get_parser(self, prog_name):
143164
metavar='<key>',
144165
action='append',
145166
default=[],
146-
help='Property to remove from volume type '
167+
help='Remove a property from this volume type '
147168
'(repeat option to remove multiple properties)',
148169
required=True,
149170
)
@@ -160,24 +181,3 @@ def take_action(self, parsed_args):
160181
volume_type.unset_keys(parsed_args.property)
161182
else:
162183
self.app.log.error("No changes requested\n")
163-
164-
165-
class ShowVolumeType(command.ShowOne):
166-
"""Display volume type details"""
167-
168-
def get_parser(self, prog_name):
169-
parser = super(ShowVolumeType, self).get_parser(prog_name)
170-
parser.add_argument(
171-
"volume_type",
172-
metavar="<volume-type>",
173-
help="Volume type to display (name or ID)"
174-
)
175-
return parser
176-
177-
def take_action(self, parsed_args):
178-
volume_client = self.app.client_manager.volume
179-
volume_type = utils.find_resource(
180-
volume_client.volume_types, parsed_args.volume_type)
181-
properties = utils.format_dict(volume_type._info.pop('extra_specs'))
182-
volume_type._info.update({'properties': properties})
183-
return zip(*sorted(six.iteritems(volume_type._info)))

‎openstackclient/volume/v2/volume_type.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ def get_parser(self, prog_name):
2929
parser.add_argument(
3030
"name",
3131
metavar="<name>",
32-
help="New volume type name"
32+
help="Volume type name",
3333
)
3434
parser.add_argument(
3535
"--description",
3636
metavar="<description>",
37-
help="New volume type description",
37+
help="Volume type description",
3838
)
3939
public_group = parser.add_mutually_exclusive_group()
4040
public_group.add_argument(
@@ -55,7 +55,7 @@ def get_parser(self, prog_name):
5555
'--property',
5656
metavar='<key=value>',
5757
action=parseractions.KeyValueAction,
58-
help='Property to add for this volume type'
58+
help='Set a property on this volume type'
5959
'(repeat option to set multiple properties)',
6060
)
6161
return parser
@@ -153,7 +153,7 @@ def get_parser(self, prog_name):
153153
'--property',
154154
metavar='<key=value>',
155155
action=parseractions.KeyValueAction,
156-
help='Property to add or modify for this volume type '
156+
help='Set a property on this volume type '
157157
'(repeat option to set multiple properties)',
158158
)
159159
return parser
@@ -221,7 +221,7 @@ def get_parser(self, prog_name):
221221
metavar='<key>',
222222
default=[],
223223
required=True,
224-
help='Property to remove from volume type '
224+
help='Remove a property from this volume type '
225225
'(repeat option to remove multiple properties)',
226226
)
227227
return parser

0 commit comments

Comments
 (0)