Skip to content

Commit 9663424

Browse files
author
Kevin_Zheng
committed
change os in command example to openstack
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: Ic7686257725e1aa8e4e0d65a712eff1c079927a8
1 parent e51a2b3 commit 9663424

22 files changed

Lines changed: 76 additions & 76 deletions

doc/source/command-objects/access-token.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Create an access token
1414
.. program:: access token create
1515
.. code:: bash
1616
17-
os access token create
17+
openstack access token create
1818
--consumer-key <consumer-key>
1919
--consumer-secret <consumer-secret>
2020
--request-key <request-key>

doc/source/command-objects/address-scope.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Create new address scope
1515
.. program:: address scope create
1616
.. code:: bash
1717
18-
os address scope create
18+
openstack address scope create
1919
[--project <project> [--project-domain <project-domain>]]
2020
[--ip-version <ip-version>]
2121
[--share | --no-share]
@@ -55,7 +55,7 @@ Delete address scope(s)
5555
.. program:: address scope delete
5656
.. code:: bash
5757
58-
os address scope delete
58+
openstack address scope delete
5959
<address-scope> [<address-scope> ...]
6060
6161
.. _address_scope_delete-address-scope:
@@ -71,7 +71,7 @@ List address scopes
7171
.. program:: address scope list
7272
.. code:: bash
7373
74-
os address scope list
74+
openstack address scope list
7575
[--name <name>]
7676
[--ip-version <ip-version>]
7777
[--project <project> [--project-domain <project-domain>]]
@@ -110,7 +110,7 @@ Set address scope properties
110110
.. program:: address scope set
111111
.. code:: bash
112112
113-
os address scope set
113+
openstack address scope set
114114
[--name <name>]
115115
[--share | --no-share]
116116
<address-scope>
@@ -140,7 +140,7 @@ Display address scope details
140140
.. program:: address scope show
141141
.. code:: bash
142142
143-
os address scope show
143+
openstack address scope show
144144
<address-scope>
145145
146146
.. _address_scope_show-address-scope:

doc/source/command-objects/aggregate.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Add host to aggregate
1515
.. program:: aggregate add host
1616
.. code:: bash
1717
18-
os aggregate add host
18+
openstack aggregate add host
1919
<aggregate>
2020
<host>
2121
@@ -36,7 +36,7 @@ Create a new aggregate
3636
.. program:: aggregate create
3737
.. code:: bash
3838
39-
os aggregate create
39+
openstack aggregate create
4040
[--zone <availability-zone>]
4141
[--property <key=value> [...] ]
4242
<name>
@@ -61,7 +61,7 @@ Delete existing aggregate(s)
6161
.. program:: aggregate delete
6262
.. code:: bash
6363
64-
os aggregate delete
64+
openstack aggregate delete
6565
<aggregate> [<aggregate> ...]
6666
6767
.. describe:: <aggregate>
@@ -76,7 +76,7 @@ List all aggregates
7676
.. program:: aggregate list
7777
.. code:: bash
7878
79-
os aggregate list
79+
openstack aggregate list
8080
[--long]
8181
8282
.. option:: --long
@@ -91,7 +91,7 @@ Remove host from aggregate
9191
.. program:: aggregate remove host
9292
.. code:: bash
9393
94-
os aggregate remove host
94+
openstack aggregate remove host
9595
<aggregate>
9696
<host>
9797
@@ -112,7 +112,7 @@ Set aggregate properties
112112
.. program:: aggregate set
113113
.. code:: bash
114114
115-
os aggregate set
115+
openstack aggregate set
116116
[--name <new-name>]
117117
[--zone <availability-zone>]
118118
[--property <key=value> [...] ]
@@ -151,7 +151,7 @@ Display aggregate details
151151
.. program:: aggregate show
152152
.. code:: bash
153153
154-
os aggregate show
154+
openstack aggregate show
155155
<aggregate>
156156
157157
.. describe:: <aggregate>
@@ -166,7 +166,7 @@ Unset aggregate properties
166166
.. program:: aggregate unset
167167
.. code-block:: bash
168168
169-
os aggregate unset
169+
openstack aggregate unset
170170
[--property <key> [...] ]
171171
<aggregate>
172172

doc/source/command-objects/availability-zone.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ List availability zones and their status
1515
.. program availability zone list
1616
.. code:: bash
1717
18-
os availability zone list
18+
openstack availability zone list
1919
[--compute]
2020
[--network]
2121
[--volume]

doc/source/command-objects/backup.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Create new backup
1313
.. program:: backup create
1414
.. code:: bash
1515
16-
os backup create
16+
openstack backup create
1717
[--container <container>]
1818
[--name <name>]
1919
[--description <description>]
@@ -66,7 +66,7 @@ Delete backup(s)
6666
.. program:: backup delete
6767
.. code:: bash
6868
69-
os backup delete
69+
openstack backup delete
7070
[--force]
7171
<backup> [<backup> ...]
7272
@@ -90,7 +90,7 @@ List backups
9090
.. program:: backup list
9191
.. code:: bash
9292
93-
os backup list
93+
openstack backup list
9494
9595
.. _backup_list-backup:
9696
.. option:: --long
@@ -106,7 +106,7 @@ Restore backup
106106
.. program:: backup restore
107107
.. code:: bash
108108
109-
os backup restore
109+
openstack backup restore
110110
<backup>
111111
<volume>
112112
@@ -128,7 +128,7 @@ Display backup details
128128
.. program:: backup show
129129
.. code:: bash
130130
131-
os backup show
131+
openstack backup show
132132
<backup>
133133
134134
.. _backup_show-backup:

doc/source/command-objects/catalog.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ List services in the service catalog
1212
.. program:: catalog list
1313
.. code:: bash
1414
15-
os catalog list
15+
openstack catalog list
1616
1717
catalog show
1818
------------
@@ -22,7 +22,7 @@ Display service catalog details
2222
.. program:: catalog show
2323
.. code:: bash
2424
25-
os catalog show
25+
openstack catalog show
2626
<service>
2727
2828
.. describe:: <service>

doc/source/command-objects/command.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ List recognized commands by group
1414
.. program:: command list
1515
.. code:: bash
1616
17-
os command list
17+
openstack command list

doc/source/command-objects/complete.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ print bash completion command
2222
.. program:: complete
2323
.. code:: bash
2424
25-
os complete
25+
openstack complete

doc/source/command-objects/compute-agent.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Create compute agent
1212
.. program:: compute agent create
1313
.. code:: bash
1414
15-
os compute agent create
15+
openstack compute agent create
1616
<os> <architecture> <version> <url> <md5hash>
1717
<hypervisor>
1818
@@ -49,7 +49,7 @@ Delete compute agent(s)
4949
.. program:: compute agent delete
5050
.. code:: bash
5151
52-
os compute agent delete <id> [<id> ...]
52+
openstack compute agent delete <id> [<id> ...]
5353
5454
.. _compute_agent-delete:
5555
.. describe:: <id>
@@ -64,7 +64,7 @@ List compute agents
6464
.. program:: compute agent list
6565
.. code:: bash
6666
67-
os compute agent list [--hypervisor <hypervisor>]
67+
openstack compute agent list [--hypervisor <hypervisor>]
6868
6969
.. option:: --hypervisor <hypervisor>
7070

@@ -78,7 +78,7 @@ Set compute agent properties
7878
.. program:: agent set
7979
.. code:: bash
8080
81-
os compute agent set
81+
openstack compute agent set
8282
[--agent-version <version>]
8383
[--url <url]
8484
[--md5hash <md5hash>]

doc/source/command-objects/compute-service.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Delete compute service(s)
1212
.. program:: compute service delete
1313
.. code:: bash
1414
15-
os compute service delete
15+
openstack compute service delete
1616
<service> [<service> ...]
1717
1818
.. _compute-service-delete:
@@ -28,7 +28,7 @@ List compute services
2828
.. program:: compute service list
2929
.. code:: bash
3030
31-
os compute service list
31+
openstack compute service list
3232
[--host <host>]
3333
[--service <service>]
3434
[--long]
@@ -55,7 +55,7 @@ Set compute service properties
5555
.. program:: compute service set
5656
.. code:: bash
5757
58-
os compute service set
58+
openstack compute service set
5959
[--enable | --disable]
6060
[--disable-reason <reason>]
6161
[--up | --down]

0 commit comments

Comments
 (0)