Skip to content

Commit 1686dc5

Browse files
Dean Troyerstevemar
Dean Troyer
authored and
stevemar
committed
Help/docs cleanups: marker, limit, ip-address metavars
Cleanup help strings and docs for clarity and to keep things consistent: * --limit metavar should be <num-resource> to indicate what is being counted * --marker metavar should be <resource> or <resource-id> to indicate the type of value being specified * <*-ip-address> metavars should be just <ip-address> as there is no difference in format between fixed and floating IPs * Move all occurances of '(name or ID)' to end of help text Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
1 parent b2ceb58 commit 1686dc5

29 files changed

Lines changed: 121 additions & 118 deletions

‎doc/source/command-objects/container.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ List containers
5151
[--prefix <prefix>]
5252
[--marker <marker>]
5353
[--end-marker <end-marker>]
54-
[--limit <limit>]
54+
[--limit <num-containers>]
5555
[--long]
5656
[--all]
5757
@@ -67,7 +67,7 @@ List containers
6767

6868
End anchor for paging
6969

70-
.. option:: --limit <limit>
70+
.. option:: --limit <num-containers>
7171

7272
Limit the number of containers returned
7373

‎doc/source/command-objects/flavor.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,8 @@ List flavors
108108
openstack flavor list
109109
[--public | --private | --all]
110110
[--long]
111-
[--marker <marker>]
112-
[--limit <limit>]
111+
[--marker <flavor-id>]
112+
[--limit <num-flavors>]
113113
114114
.. option:: --public
115115

@@ -127,11 +127,11 @@ List flavors
127127

128128
List additional fields in output
129129

130-
.. option:: --marker <marker>
130+
.. option:: --marker <flavor-id>
131131

132132
The last flavor ID of the previous page
133133

134-
.. option:: --limit <limit>
134+
.. option:: --limit <num-flavors>
135135

136136
Maximum number of flavors to display
137137

‎doc/source/command-objects/floating-ip.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Create floating IP
1515
openstack floating ip create
1616
[--subnet <subnet>]
1717
[--port <port>]
18-
[--floating-ip-address <floating-ip-address>]
19-
[--fixed-ip-address <fixed-ip-address>]
18+
[--floating-ip-address <ip-address>]
19+
[--fixed-ip-address <ip-address>]
2020
[--description <description>]
2121
[--project <project> [--project-domain <project-domain>]]
2222
<network>
@@ -31,12 +31,12 @@ Create floating IP
3131
Port to be associated with the floating IP (name or ID)
3232
*Network version 2 only*
3333
34-
.. option:: --floating-ip-address <floating-ip-address>
34+
.. option:: --floating-ip-address <ip-address>
3535
3636
Floating IP address
3737
*Network version 2 only*
3838
39-
.. option:: --fixed-ip-address <fixed-ip-address>
39+
.. option:: --fixed-ip-address <ip-address>
4040
4141
Fixed IP address mapped to the floating IP
4242
*Network version 2 only*
@@ -88,7 +88,7 @@ List floating IP(s)
8888
openstack floating ip list
8989
[--network <network>]
9090
[--port <port>]
91-
[--fixed-ip-address <fixed-ip-address>]
91+
[--fixed-ip-address <ip-address>]
9292
[--long]
9393
[--status <status>]
9494
[--project <project> [--project-domain <project-domain>]]
@@ -106,7 +106,7 @@ List floating IP(s)
106106
107107
*Network version 2 only*
108108
109-
.. option:: --fixed-ip-address <fixed-ip-address>
109+
.. option:: --fixed-ip-address <ip-address>
110110
111111
List floating IP(s) according to given fixed IP address
112112

‎doc/source/command-objects/image.rst‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -199,8 +199,8 @@ List available images
199199
[--property <key=value>]
200200
[--long]
201201
[--sort <key>[:<direction>]]
202-
[--limit <limit>]
203-
[--marker <marker>]
202+
[--limit <num-images>]
203+
[--marker <image>]
204204
205205
.. option:: --public
206206
@@ -229,14 +229,18 @@ List available images
229229
Sort output by selected keys and directions(asc or desc) (default: name:asc),
230230
multiple keys and directions can be specified separated by comma
231231
232-
.. option:: --limit <limit>
232+
.. option:: --limit <num-images>
233233
234234
Maximum number of images to display.
235235
236-
.. option:: --marker <marker>
236+
*Image version 2 only*
237237
238-
The last image (name or ID) of the previous page. Display list of images
239-
after marker. Display all images if not specified.
238+
.. option:: --marker <image>
239+
240+
The last image of the previous page. Display list of images
241+
after marker. Display all images if not specified. (name or ID)
242+
243+
*Image version 2 only*
240244
241245
image remove project
242246
--------------------

‎doc/source/command-objects/object.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ List objects
6262
[--delimiter <delimiter>]
6363
[--marker <marker>]
6464
[--end-marker <end-marker>]
65-
[--limit <limit>]
65+
[--limit <num-objects>]
6666
[--long]
6767
[--all]
6868
<container>
@@ -83,7 +83,7 @@ List objects
8383

8484
End anchor for paging
8585

86-
.. option:: --limit <limit>
86+
.. option:: --limit <num-objects>
8787

8888
Limit number of objects returned
8989

‎doc/source/command-objects/port.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Create new port
4444
4545
.. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address>
4646
47-
Desired IP and/or subnet (name or ID) for this port:
47+
Desired IP and/or subnet for this port (name or ID):
4848
subnet=<subnet>,ip-address=<ip-address>
4949
(repeat option to set multiple fixed IP addresses)
5050
@@ -182,7 +182,7 @@ List ports
182182
183183
.. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address>
184184
185-
Desired IP and/or subnet (name or ID) for filtering ports:
185+
Desired IP and/or subnet for filtering ports (name or ID):
186186
subnet=<subnet>,ip-address=<ip-address>
187187
(repeat option to set multiple fixed IP addresses)
188188
@@ -234,7 +234,7 @@ Set port properties
234234
235235
.. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address>
236236
237-
Desired IP and/or subnet (name or ID) for this port:
237+
Desired IP and/or subnet for this port (name or ID):
238238
subnet=<subnet>,ip-address=<ip-address>
239239
(repeat option to set multiple fixed IP addresses)
240240
@@ -363,8 +363,8 @@ Unset port properties
363363
364364
.. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address>
365365
366-
Desired IP and/or subnet (name or ID) which should be removed
367-
from this port: subnet=<subnet>,ip-address=<ip-address>
366+
Desired IP and/or subnet which should be removed
367+
from this port (name or ID): subnet=<subnet>,ip-address=<ip-address>
368368
(repeat option to unset multiple fixed IP addresses)
369369
370370
.. option:: --binding-profile <binding-profile-key>

‎doc/source/command-objects/server.rst‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Add fixed IP address to server
1818
1919
.. describe:: <server>
2020

21-
Server (name or ID) to receive the fixed IP address
21+
Server to receive the fixed IP address (name or ID)
2222

2323
.. describe:: <network>
2424

25-
Network (name or ID) to allocate the fixed IP address from
25+
Network to allocate the fixed IP address from (name or ID)
2626

2727
server add floating ip
2828
----------------------
@@ -33,21 +33,21 @@ Add floating IP address to server
3333
.. code:: bash
3434
3535
openstack server add floating ip
36-
[--fixed-ip-address <fixed-ip-address>]
36+
[--fixed-ip-address <ip-address>]
3737
<server>
3838
<ip-address>
3939
40-
.. option:: --fixed-ip-address <fixed-ip-address>
40+
.. option:: --fixed-ip-address <ip-address>
4141

4242
Fixed IP address to associate with this floating IP address
4343

4444
.. describe:: <server>
4545

46-
Server (name or ID) to receive the floating IP address
46+
Server to receive the floating IP address (name or ID)
4747

4848
.. describe:: <ip-address>
4949

50-
Floating IP address (IP address only) to assign to server
50+
Floating IP address to assign to server (IP only)
5151

5252
server add security group
5353
-------------------------
@@ -264,7 +264,7 @@ List servers
264264
[--project <project> [--project-domain <project-domain>]]
265265
[--long]
266266
[--marker <server>]
267-
[--limit <limit>]
267+
[--limit <num-servers>]
268268
[--deleted]
269269
[--changes-since <changes-since>]
270270
@@ -332,10 +332,10 @@ List servers
332332
333333
.. option:: --marker <server>
334334
335-
The last server (name or ID) of the previous page. Display list of servers
336-
after marker. Display all servers if not specified.
335+
The last server of the previous page. Display list of servers
336+
after marker. Display all servers if not specified. (name or ID)
337337
338-
.. option:: --limit <limit>
338+
.. option:: --limit <num-servers>
339339
340340
Maximum number of servers to display. If limit equals -1, all servers will
341341
be displayed. If limit is greater than 'osapi_max_limit' option of Nova
@@ -497,11 +497,11 @@ Remove fixed IP address from server
497497
498498
.. describe:: <server>
499499
500-
Server (name or ID) to remove the fixed IP address from
500+
Server to remove the fixed IP address from (name or ID)
501501
502502
.. describe:: <ip-address>
503503
504-
Fixed IP address (IP address only) to remove from the server
504+
Fixed IP address to remove from the server (IP only)
505505
506506
server remove floating ip
507507
-------------------------
@@ -517,11 +517,11 @@ Remove floating IP address from server
517517
518518
.. describe:: <server>
519519
520-
Server (name or ID) to remove the floating IP address from
520+
Server to remove the floating IP address from (name or ID)
521521
522522
.. describe:: <ip-address>
523523
524-
Floating IP address (IP address only) to remove from server
524+
Floating IP address to remove from server (IP only)
525525
526526
server remove security group
527527
----------------------------

‎doc/source/command-objects/snapshot.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ List snapshots
7272
openstack snapshot list
7373
[--all-projects]
7474
[--long]
75-
[--limit <limit>]
76-
[--marker <marker>]
75+
[--limit <num-snapshots>]
76+
[--marker <snapshot>]
7777
7878
.. option:: --all-projects
7979

@@ -83,13 +83,13 @@ List snapshots
8383

8484
List additional fields in output
8585

86-
.. option:: --limit <limit>
86+
.. option:: --limit <num-snapshots>
8787

8888
Maximum number of snapshots to display
8989

9090
*Volume version 2 only*
9191

92-
.. option:: --marker <marker>
92+
.. option:: --marker <snapshot>
9393

9494
The last snapshot ID of the previous page
9595

‎doc/source/command-objects/subnet-pool.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ List subnet pools
150150
151151
.. option:: --address-scope <address-scope>
152152
153-
List only subnet pools of given address scope (name or ID) in output
153+
List only subnet pools of given address scope in output (name or ID)
154154
155155
subnet pool set
156156
---------------

‎doc/source/command-objects/subnet.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ List subnets
194194
195195
.. option:: --project <project>
196196
197-
List only subnets which belong to a given project (name or ID) in output
197+
List only subnets which belong to a given project in output (name or ID)
198198
199199
.. option:: --project-domain <project-domain>
200200
@@ -203,7 +203,7 @@ List subnets
203203
204204
.. option:: --network <network>
205205
206-
List only subnets which belong to a given network (name or ID) in output
206+
List only subnets which belong to a given network in output (name or ID)
207207
208208
.. option:: --gateway <gateway>
209209

0 commit comments

Comments
 (0)