Skip to content

Commit 446e6f2

Browse files
author
Kevin_Zheng
committed
change os in command example to openstack(3)
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: Ie67c0152d8ff8b7c456f91dc8b9a9164437ee9d1
1 parent e51a2b3 commit 446e6f2

26 files changed

Lines changed: 135 additions & 135 deletions

‎doc/source/command-objects/security-group-rule.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Create a new security group rule
1515
.. program:: security group rule create
1616
.. code:: bash
1717
18-
os security group rule create
18+
openstack security group rule create
1919
[--remote-ip <ip-address> | --remote-group <group>]
2020
[--dst-port <port-range> | [--icmp-type <icmp-type> [--icmp-code <icmp-code>]]]
2121
[--protocol <protocol>]
@@ -116,7 +116,7 @@ Delete security group rule(s)
116116
.. program:: security group rule delete
117117
.. code:: bash
118118
119-
os security group rule delete
119+
openstack security group rule delete
120120
<rule> [<rule> ...]
121121
122122
.. describe:: <rule>
@@ -131,7 +131,7 @@ List security group rules
131131
.. program:: security group rule list
132132
.. code:: bash
133133
134-
os security group rule list
134+
openstack security group rule list
135135
[--all-projects]
136136
[--protocol <protocol>]
137137
[--ingress | --egress]
@@ -185,7 +185,7 @@ Display security group rule details
185185
.. program:: security group rule show
186186
.. code:: bash
187187
188-
os security group rule show
188+
openstack security group rule show
189189
<rule>
190190
191191
.. describe:: <rule>

‎doc/source/command-objects/security-group.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Create a new security group
1616
.. program:: security group create
1717
.. code:: bash
1818
19-
os security group create
19+
openstack security group create
2020
[--description <description>]
2121
[--project <project> [--project-domain <project-domain>]]
2222
<name>
@@ -50,7 +50,7 @@ Delete security group(s)
5050
.. program:: security group delete
5151
.. code:: bash
5252
53-
os security group delete
53+
openstack security group delete
5454
<group> [<group> ...]
5555
5656
.. describe:: <group>
@@ -65,7 +65,7 @@ List security groups
6565
.. program:: security group list
6666
.. code:: bash
6767
68-
os security group list
68+
openstack security group list
6969
[--all-projects]
7070
[--project <project> [--project-domain <project-domain>]]
7171
@@ -97,7 +97,7 @@ Set security group properties
9797
.. program:: security group set
9898
.. code:: bash
9999
100-
os security group set
100+
openstack security group set
101101
[--name <new-name>]
102102
[--description <description>]
103103
<group>
@@ -122,7 +122,7 @@ Display security group details
122122
.. program:: security group show
123123
.. code:: bash
124124
125-
os security group show
125+
openstack security group show
126126
<group>
127127
128128
.. describe:: <group>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Create a server backup image
1515
.. program:: server create
1616
.. code:: bash
1717
18-
os server backup create
18+
openstack server backup create
1919
[--name <image-name>]
2020
[--type <backup-type>]
2121
[--rotate <count>]

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Create a new server group
1414
.. program:: server group create
1515
.. code-block:: bash
1616
17-
os server group create
17+
openstack server group create
1818
--policy <policy> [--policy <policy>] ...
1919
<name>
2020
@@ -36,7 +36,7 @@ Delete existing server group(s)
3636
.. program:: server group delete
3737
.. code-block:: bash
3838
39-
os server group delete
39+
openstack server group delete
4040
<server-group> [<server-group> ...]
4141
4242
.. describe:: <server-group>
@@ -52,7 +52,7 @@ List all server groups
5252
.. program:: server group list
5353
.. code-block:: bash
5454
55-
os server group list
55+
openstack server group list
5656
[--all-projects]
5757
[--long]
5858
@@ -72,7 +72,7 @@ Display server group details
7272
.. program:: server group show
7373
.. code-block:: bash
7474
75-
os server group show
75+
openstack server group show
7676
<server-group>
7777
7878
.. describe:: <server-group>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Create a new server disk image from an existing server
1515
.. program:: server image create
1616
.. code:: bash
1717
18-
os server image create
18+
openstack server image create
1919
[--name <image-name>]
2020
[--wait]
2121
<server>

0 commit comments

Comments
 (0)