Skip to content

Commit 847da51

Browse files
author
Kevin_Zheng
committed
change os in command example to openstack(2)
In the current doc, the command examples are like "os server create" but the acutal command should be started with "openstack" instead of "os", it is misleading to first time users. Change-Id: I80c96f0938cec382f2f714a500138bd5a2c81aa0
1 parent e51a2b3 commit 847da51

35 files changed

Lines changed: 146 additions & 146 deletions

doc/source/command-objects/federation-protocol.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Create new federation protocol
1414
.. program:: federation protocol create
1515
.. code:: bash
1616
17-
os federation protocol create
17+
openstack federation protocol create
1818
--identity-provider <identity-provider>
1919
--mapping <mapping>
2020
<name>
@@ -39,7 +39,7 @@ Delete federation protocol(s)
3939
.. program:: federation protocol delete
4040
.. code:: bash
4141
42-
os federation protocol delete
42+
openstack federation protocol delete
4343
--identity-provider <identity-provider>
4444
<federation-protocol> [<federation-protocol> ...]
4545
@@ -59,7 +59,7 @@ List federation protocols
5959
.. program:: federation protocol list
6060
.. code:: bash
6161
62-
os federation protocol list
62+
openstack federation protocol list
6363
--identity-provider <identity-provider>
6464
6565
.. option:: --identity-provider <identity-provider>
@@ -74,7 +74,7 @@ Set federation protocol properties
7474
.. program:: federation protocol set
7575
.. code:: bash
7676
77-
os federation protocol set
77+
openstack federation protocol set
7878
--identity-provider <identity-provider>
7979
[--mapping <mapping>]
8080
<federation-protocol>
@@ -99,7 +99,7 @@ Display federation protocol details
9999
.. program:: federation protocol show
100100
.. code:: bash
101101
102-
os federation protocol show
102+
openstack federation protocol show
103103
--identity-provider <identity-provider>
104104
<federation-protocol>
105105

doc/source/command-objects/flavor.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Create new flavor
1212
.. program:: flavor create
1313
.. code:: bash
1414
15-
os flavor create
15+
openstack flavor create
1616
[--id <id>]
1717
[--ram <size-mb>]
1818
[--disk <size-gb>]
@@ -89,7 +89,7 @@ Delete flavor(s)
8989
.. program:: flavor delete
9090
.. code:: bash
9191
92-
os flavor delete
92+
openstack flavor delete
9393
<flavor> [<flavor> ...]
9494
9595
.. _flavor_delete-flavor:
@@ -105,7 +105,7 @@ List flavors
105105
.. program:: flavor list
106106
.. code:: bash
107107
108-
os flavor list
108+
openstack flavor list
109109
[--public | --private | --all]
110110
[--long]
111111
[--marker <marker>]
@@ -143,7 +143,7 @@ Set flavor properties
143143
.. program:: flavor set
144144
.. code:: bash
145145
146-
os flavor set
146+
openstack flavor set
147147
[--property <key=value> [...] ]
148148
[--project <project>]
149149
[--project-domain <project-domain>]
@@ -174,7 +174,7 @@ Display flavor details
174174
.. program:: flavor show
175175
.. code:: bash
176176
177-
os flavor show
177+
openstack flavor show
178178
<flavor>
179179
180180
.. _flavor_show-flavor:
@@ -190,7 +190,7 @@ Unset flavor properties
190190
.. program:: flavor unset
191191
.. code:: bash
192192
193-
os flavor unset
193+
openstack flavor unset
194194
[--property <key> [...] ]
195195
[--project <project>]
196196
[--project-domain <project-domain>]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ List pools of floating IP addresses
1212
.. program:: floating ip pool list
1313
.. code:: bash
1414
15-
os floating ip pool list
15+
openstack floating ip pool list

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Create floating IP
1212
.. program:: floating ip create
1313
.. code:: bash
1414
15-
os floating ip create
15+
openstack floating ip create
1616
[--subnet <subnet>]
1717
[--port <port>]
1818
[--floating-ip-address <floating-ip-address>]
@@ -71,7 +71,7 @@ Delete floating IP(s)
7171
.. program:: floating ip delete
7272
.. code:: bash
7373
74-
os floating ip delete <floating-ip> [<floating-ip> ...]
74+
openstack floating ip delete <floating-ip> [<floating-ip> ...]
7575
7676
.. describe:: <floating-ip>
7777
@@ -85,7 +85,7 @@ List floating IP(s)
8585
.. program:: floating ip list
8686
.. code:: bash
8787
88-
os floating ip list
88+
openstack floating ip list
8989
[--network <network>]
9090
[--port <port>]
9191
[--fixed-ip-address <fixed-ip-address>]
@@ -151,7 +151,7 @@ Display floating IP details
151151
.. program:: floating ip show
152152
.. code:: bash
153153
154-
os floating ip show <floating-ip>
154+
openstack floating ip show <floating-ip>
155155
156156
.. describe:: <floating-ip>
157157

doc/source/command-objects/group.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Check user membership in group
4848
.. program:: group contains user
4949
.. code:: bash
5050
51-
os group contains user
51+
openstack group contains user
5252
[--group-domain <group-domain>]
5353
[--user-domain <user-domain>]
5454
<group>
@@ -84,7 +84,7 @@ Create new group
8484
.. program:: group create
8585
.. code:: bash
8686
87-
os group create
87+
openstack group create
8888
[--domain <domain>]
8989
[--description <description>]
9090
[--or-show]
@@ -116,7 +116,7 @@ Delete group
116116
.. program:: group delete
117117
.. code:: bash
118118
119-
os group delete
119+
openstack group delete
120120
[--domain <domain>]
121121
<group> [<group> ...]
122122
@@ -136,7 +136,7 @@ List groups
136136
.. program:: group list
137137
.. code:: bash
138138
139-
os group list
139+
openstack group list
140140
[--domain <domain>]
141141
[--user <user> [--user-domain <user-domain>]]
142142
[--long]
@@ -168,7 +168,7 @@ Remove user from group
168168
.. program:: group remove user
169169
.. code:: bash
170170
171-
os group remove user
171+
openstack group remove user
172172
[--group-domain <group-domain>]
173173
[--user-domain <user-domain>]
174174
<group>
@@ -204,7 +204,7 @@ Set group properties
204204
.. program:: group set
205205
.. code:: bash
206206
207-
os group set
207+
openstack group set
208208
[--domain <domain>]
209209
[--name <name>]
210210
[--description <description>]
@@ -234,7 +234,7 @@ Display group details
234234
.. program:: group show
235235
.. code:: bash
236236
237-
os group show
237+
openstack group show
238238
[--domain <domain>]
239239
<group>
240240

doc/source/command-objects/host.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ List hosts
1414
.. program:: host list
1515
.. code:: bash
1616
17-
os host list
17+
openstack host list
1818
[--zone <availability-zone>]
1919
2020
.. option:: --zone <availability-zone>
@@ -29,7 +29,7 @@ Set host properties
2929
.. program:: host set
3030
.. code:: bash
3131
32-
os host set
32+
openstack host set
3333
[--enable | --disable]
3434
[--enable-maintenance | --disable-maintenance]
3535
<host>
@@ -64,7 +64,7 @@ Display host details
6464
.. program:: host show
6565
.. code:: bash
6666
67-
os host show
67+
openstack host show
6868
<host>
6969
7070
.. describe:: <host>

doc/source/command-objects/hypervisor-stats.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ Display hypervisor stats details
1212
.. program:: hypervisor stats show
1313
.. code:: bash
1414
15-
os hypervisor stats show
15+
openstack hypervisor stats show
1616

doc/source/command-objects/hypervisor.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ List hypervisors
1212
.. program:: hypervisor list
1313
.. code:: bash
1414
15-
os hypervisor list
15+
openstack hypervisor list
1616
[--matching <hostname>]
1717
[--long]
1818
@@ -32,7 +32,7 @@ Display hypervisor details
3232
.. program:: hypervisor show
3333
.. code:: bash
3434
35-
os hypervisor show
35+
openstack hypervisor show
3636
<hypervisor>
3737
3838
.. _hypervisor_show-flavor:

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Create new identity provider
1414
.. program:: identity provider create
1515
.. code:: bash
1616
17-
os identity provider create
17+
openstack identity provider create
1818
[--remote-id <remote-id> [...] | --remote-id-file <file-name>]
1919
[--description <description>]
2020
[--enable | --disable]
@@ -54,7 +54,7 @@ Delete identity provider(s)
5454
.. program:: identity provider delete
5555
.. code:: bash
5656
57-
os identity provider delete
57+
openstack identity provider delete
5858
<identity-provider> [<identity-provider> ...]
5959
6060
.. describe:: <identity-provider>
@@ -69,7 +69,7 @@ List identity providers
6969
.. program:: identity provider list
7070
.. code:: bash
7171
72-
os identity provider list
72+
openstack identity provider list
7373
7474
identity provider set
7575
---------------------
@@ -79,7 +79,7 @@ Set identity provider properties
7979
.. program:: identity provider set
8080
.. code:: bash
8181
82-
os identity provider set
82+
openstack identity provider set
8383
[--remote-id <remote-id> [...] | --remote-id-file <file-name>]
8484
[--description <description>]
8585
[--enable | --disable]
@@ -119,7 +119,7 @@ Display identity provider details
119119
.. program:: identity provider show
120120
.. code:: bash
121121
122-
os identity provider show
122+
openstack identity provider show
123123
<identity-provider>
124124
125125
.. describe:: <identity-provider>

doc/source/command-objects/image.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Associate project with image
1414
.. program:: image add project
1515
.. code:: bash
1616
17-
os image add project
17+
openstack image add project
1818
[--project-domain <project-domain>]
1919
<image> <project>
2020
@@ -41,7 +41,7 @@ Create/upload an image
4141
.. program:: image create
4242
.. code:: bash
4343
44-
os image create
44+
openstack image create
4545
[--id <id>]
4646
[--store <store>]
4747
[--container-format <container-format>]
@@ -175,7 +175,7 @@ Delete image(s)
175175
.. program:: image delete
176176
.. code:: bash
177177
178-
os image delete
178+
openstack image delete
179179
<image>
180180
181181
.. describe:: <image>
@@ -190,7 +190,7 @@ List available images
190190
.. program:: image list
191191
.. code:: bash
192192
193-
os image list
193+
openstack image list
194194
[--public | --private | --shared]
195195
[--property <key=value>]
196196
[--long]
@@ -244,7 +244,7 @@ Disassociate project with image
244244
.. program:: image remove project
245245
.. code:: bash
246246
247-
os image remove remove
247+
openstack image remove remove
248248
[--project-domain <project-domain>]
249249
<image> <project>
250250
@@ -269,7 +269,7 @@ Save an image locally
269269
.. program:: image save
270270
.. code:: bash
271271
272-
os image save
272+
openstack image save
273273
--file <filename>
274274
<image>
275275
@@ -291,7 +291,7 @@ Set image properties
291291
.. program:: image set
292292
.. code:: bash
293293
294-
os image set
294+
openstack image set
295295
[--name <name>]
296296
[--min-disk <disk-gb>]
297297
[--min-ram <disk-ram>]
@@ -495,7 +495,7 @@ Display image details
495495
.. program:: image show
496496
.. code:: bash
497497
498-
os image show
498+
openstack image show
499499
<image>
500500
501501
.. describe:: <image>
@@ -512,7 +512,7 @@ Unset image tags or properties
512512
.. program:: image unset
513513
.. code:: bash
514514
515-
os image set
515+
openstack image set
516516
[--tag <tag>]
517517
[--property <property>]
518518
<image>

0 commit comments

Comments
 (0)