Skip to content

Commit 32c627e

Browse files
author
Tang Chen
committed
Doc: Unify repeatable option comments
There are lots of "this option can be repeated" comments in the doc, which are not consistent to other similar docs. This patch changes them to the following format: "repeat option to do something" Change-Id: I54e01053091c428bf87bb36bb95f73a0b80ab6e7
1 parent 3be49a8 commit 32c627e

19 files changed

Lines changed: 66 additions & 59 deletions

File tree

doc/source/command-objects/identity-provider.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Create new identity provider
2222
2323
.. option:: --remote-id <remote-id>
2424

25-
Remote IDs to associate with the Identity Provider (repeat to provide
26-
multiple values)
25+
Remote IDs to associate with the Identity Provider
26+
(repeat option to provide multiple values)
2727

2828
.. option:: --remote-id-file <file-name>
2929

@@ -87,8 +87,8 @@ Set identity provider properties
8787
8888
.. option:: --remote-id <remote-id>
8989

90-
Remote IDs to associate with the Identity Provider (repeat to provide
91-
multiple values)
90+
Remote IDs to associate with the Identity Provider
91+
(repeat option to provide multiple values)
9292

9393
.. option:: --remote-id-file <file-name>
9494

doc/source/command-objects/network.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,9 @@ Create new network
5858
5959
.. option:: --availability-zone-hint <availability-zone>
6060
61-
Availability Zone in which to create this network (requires the Network
62-
Availability Zone extension, this option can be repeated).
61+
Availability Zone in which to create this network
62+
(requires the Network Availability Zone extension,
63+
repeat option to set multiple availability zones)
6364
6465
*Network version 2 only*
6566

doc/source/command-objects/port.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Create new port
3333
3434
Desired IP and/or subnet (name or ID) for this port:
3535
subnet=<subnet>,ip-address=<ip-address>
36-
(this option can be repeated)
36+
(repeat option to set multiple fixed IP addresses)
3737
3838
.. option:: --device <device-id>
3939
@@ -51,7 +51,7 @@ Create new port
5151
.. option:: --binding-profile <binding-profile>
5252
5353
Custom data to be passed as binding:profile: <key>=<value>
54-
(this option can be repeated)
54+
(repeat option to set multiple binding:profile data)
5555
5656
.. option:: --host <host-id>
5757
@@ -137,7 +137,7 @@ Set port properties
137137
138138
Desired IP and/or subnet (name or ID) for this port:
139139
subnet=<subnet>,ip-address=<ip-address>
140-
(this option can be repeated)
140+
(repeat option to set multiple fixed IP addresses)
141141
142142
.. option:: --no-fixed-ip
143143
@@ -159,7 +159,7 @@ Set port properties
159159
.. option:: --binding-profile <binding-profile>
160160
161161
Custom data to be passed as binding:profile: <key>=<value>
162-
(this option can be repeated)
162+
(repeat option to set multiple binding:profile data)
163163
164164
.. option:: --no-binding-profile
165165

doc/source/command-objects/router.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,9 @@ Create new router
8686
8787
.. option:: --availability-zone-hint <availability-zone>
8888
89-
Availability Zone in which to create this router (requires the Router
90-
Availability Zone extension, this option can be repeated).
89+
Availability Zone in which to create this router
90+
(requires the Router Availability Zone extension,
91+
repeat option to set multiple availability zones)
9192
9293
.. _router_create-name:
9394
.. describe:: <name>
@@ -206,10 +207,10 @@ Set router properties
206207
207208
.. option:: --route destination=<subnet>,gateway=<ip-address>
208209
209-
Routes associated with the router.
210-
Repeat this option to set multiple routes.
211-
destination: destination subnet (in CIDR notation).
212-
gateway: nexthop IP address.
210+
Routes associated with the router
211+
destination: destination subnet (in CIDR notation)
212+
gateway: nexthop IP address
213+
(repeat option to set multiple routes)
213214
214215
.. option:: --clear-routes
215216

doc/source/command-objects/server.rst

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -90,19 +90,21 @@ Create a new server
9090
.. option:: --security-group <security-group-name>
9191

9292
Security group to assign to this server (name or ID)
93-
(repeat for multiple groups)
93+
(repeat option to set multiple groups)
9494

9595
.. option:: --key-name <key-name>
9696

9797
Keypair to inject into this server (optional extension)
9898

9999
.. option:: --property <key=value>
100100

101-
Set a property on this server (repeat for multiple values)
101+
Set a property on this server
102+
(repeat option to set multiple values)
102103

103104
.. option:: --file <dest-filename=source-filename>
104105

105-
File to inject into image before boot (repeat for multiple files)
106+
File to inject into image before boot
107+
(repeat option to set multiple files)
106108

107109
.. option:: --user-data <user-data>
108110

@@ -569,8 +571,8 @@ Set server properties
569571
570572
.. option:: --property <key=value>
571573
572-
Property to add/change for this server (repeat option to set
573-
multiple properties)
574+
Property to add/change for this server
575+
(repeat option to set multiple properties)
574576
575577
.. describe:: <server>
576578
@@ -764,7 +766,8 @@ Unset server properties
764766
765767
.. option:: --property <key>
766768
767-
Property key to remove from server (repeat to remove multiple values)
769+
Property key to remove from server
770+
(repeat option to remove multiple values)
768771
769772
.. describe:: <server>
770773

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Create subnet pool
2222
2323
.. option:: --pool-prefix <pool-prefix>
2424
25-
Set subnet pool prefixes (in CIDR notation).
26-
Repeat this option to set multiple prefixes.
25+
Set subnet pool prefixes (in CIDR notation)
26+
(repeat option to set multiple prefixes)
2727
2828
.. option:: --default-prefix-length <default-prefix-length>
2929
@@ -104,8 +104,8 @@ Set subnet pool properties
104104
105105
.. option:: --pool-prefix <pool-prefix>
106106
107-
Set subnet pool prefixes (in CIDR notation).
108-
Repeat this option to set multiple prefixes.
107+
Set subnet pool prefixes (in CIDR notation)
108+
(repeat option to set multiple prefixes)
109109
110110
.. option:: --default-prefix-length <default-prefix-length>
111111

doc/source/command-objects/subnet.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,8 @@ Create new subnet
5656
.. option:: --allocation-pool start=<ip-address>,end=<ip-address>
5757
5858
Allocation pool IP addresses for this subnet e.g.:
59-
``start=192.168.199.2,end=192.168.199.254`` (This option can be repeated)
59+
``start=192.168.199.2,end=192.168.199.254``
60+
(repeat option to add multiple IP addresses)
6061
6162
.. option:: --dhcp
6263
@@ -68,7 +69,7 @@ Create new subnet
6869
6970
.. option:: --dns-nameserver <dns-nameserver>
7071
71-
DNS name server for this subnet (This option can be repeated)
72+
DNS server for this subnet (repeat option to set multiple DNS servers)
7273
7374
.. option:: --gateway <gateway>
7475
@@ -85,7 +86,7 @@ Create new subnet
8586
``destination=10.10.0.0/16,gateway=192.168.71.254``
8687
destination: destination subnet (in CIDR notation)
8788
gateway: nexthop IP address
88-
(This option can be repeated)
89+
(repeat option to add multiple routes)
8990
9091
.. option:: --ip-version {4,6}
9192
@@ -162,7 +163,8 @@ Set subnet properties
162163
.. option:: --allocation-pool start=<ip-address>,end=<ip-address>
163164
164165
Allocation pool IP addresses for this subnet e.g.:
165-
``start=192.168.199.2,end=192.168.199.254`` (This option can be repeated)
166+
``start=192.168.199.2,end=192.168.199.254``
167+
(repeat option to add multiple IP addresses)
166168
167169
.. option:: --dhcp
168170
@@ -174,7 +176,7 @@ Set subnet properties
174176
175177
.. option:: --dns-nameserver <dns-nameserver>
176178
177-
DNS name server for this subnet (This option can be repeated)
179+
DNS server for this subnet (repeat option to set multiple DNS servers)
178180
179181
.. option:: --gateway <gateway>
180182
@@ -189,7 +191,7 @@ Set subnet properties
189191
``destination=10.10.0.0/16,gateway=192.168.71.254``
190192
destination: destination subnet (in CIDR notation)
191193
gateway: nexthop IP address
192-
(This option can be repeated)
194+
(repeat option to add multiple routes)
193195
194196
.. option:: --name
195197

doc/source/command-objects/trust.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Create new trust
2929

3030
.. option:: --role <role>
3131

32-
Roles to authorize (name or ID) (repeat to set multiple values) (required)
32+
Roles to authorize (name or ID) (repeat option to set multiple values, required)
3333

3434
.. option:: --impersonate
3535

openstackclient/compute/v2/server.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ def get_parser(self, prog_name):
293293
action='append',
294294
default=[],
295295
help=_('Security group to assign to this server (name or ID) '
296-
'(repeat for multiple groups)'),
296+
'(repeat option to set multiple groups)'),
297297
)
298298
parser.add_argument(
299299
'--key-name',
@@ -305,15 +305,15 @@ def get_parser(self, prog_name):
305305
metavar='<key=value>',
306306
action=parseractions.KeyValueAction,
307307
help=_('Set a property on this server '
308-
'(repeat for multiple values)'),
308+
'(repeat option to set multiple values)'),
309309
)
310310
parser.add_argument(
311311
'--file',
312312
metavar='<dest-filename=source-filename>',
313313
action='append',
314314
default=[],
315315
help=_('File to inject into image before boot '
316-
'(repeat for multiple files)'),
316+
'(repeat option to set multiple files)'),
317317
)
318318
parser.add_argument(
319319
'--user-data',
@@ -1738,7 +1738,7 @@ def get_parser(self, prog_name):
17381738
action='append',
17391739
default=[],
17401740
help=_('Property key to remove from server '
1741-
'(repeat to remove multiple values)'),
1741+
'(repeat option to remove multiple values)'),
17421742
)
17431743
return parser
17441744

openstackclient/identity/v3/identity_provider.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def get_parser(self, prog_name):
3535
metavar='<remote-id>',
3636
action='append',
3737
help='Remote IDs to associate with the Identity Provider '
38-
'(repeat to provide multiple values)'
38+
'(repeat option to provide multiple values)'
3939
)
4040
identity_remote_id_provider.add_argument(
4141
'--remote-id-file',
@@ -139,7 +139,7 @@ def get_parser(self, prog_name):
139139
metavar='<remote-id>',
140140
action='append',
141141
help='Remote IDs to associate with the Identity Provider '
142-
'(repeat to provide multiple values)'
142+
'(repeat option to provide multiple values)'
143143
)
144144
identity_remote_id_provider.add_argument(
145145
'--remote-id-file',

0 commit comments

Comments
 (0)