Skip to content

Commit 1dce52a

Browse files
zhang.xiuhuastevemar
authored andcommitted
Modify few words and change output format for command "ip floating list"
According to OpenStack Documentation, preferred word choice: Link: http://docs.openstack.org/contributor-guide/writing-style/word-choice.html Change from 'etc.' to 'and so on' Change-Id: Id8a5cc99a8bba8ac7531636248edaca8f98da917
1 parent 044a46e commit 1dce52a

3 files changed

Lines changed: 40 additions & 25 deletions

File tree

doc/source/backwards-incompatible.rst

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Releases Before 3.0
124124

125125
8. `region` commands no longer support `url`
126126

127-
The Keystone team removed support for thr `url` attribute from the client
127+
The Keystone team removed support for the `url` attribute from the client
128128
and server side. Changes to the `create`, `set` and `list` commands for
129129
regions have been affected.
130130

@@ -184,27 +184,41 @@ Releases Before 3.0
184184

185185
14. Output of `ip floating list` command has changed.
186186

187-
When using Compute v2, the original output of `ip floating list` command is:
188-
+----+--------+------------+----------+-------------+
189-
| ID | Pool | IP | Fixed IP | Instance ID |
190-
+----+--------+-----------------------+-------------+
191-
| 1 | public | 172.24.4.1 | None | None |
192-
+----+--------+------------+----------+-------------+
187+
When using Compute v2, the original output is:
188+
189+
.. code-block:: bash
190+
191+
# ip floating list
192+
193+
+----+--------+------------+----------+-------------+
194+
| ID | Pool | IP | Fixed IP | Instance ID |
195+
+----+--------+-----------------------+-------------+
196+
| 1 | public | 172.24.4.1 | None | None |
197+
+----+--------+------------+----------+-------------+
193198
194199
Now it changes to:
195-
+----+---------------------+------------------+-----------+--------+
196-
| ID | Floating IP Address | Fixed IP Address | Server ID | Pool |
197-
+----+---------------------+------------------+-----------+--------+
198-
| 1 | 172.24.4.1 | None | None | public |
199-
+----+---------------------+------------------+-----------+--------+
200-
201-
When using Network v2, the output of `ip floating list` command is:
202-
+--------------------------------------+---------------------+------------------+------+
203-
| ID | Floating IP Address | Fixed IP Address | Port |
204-
+--------------------------------------+---------------------+------------------+------+
205-
| 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3 | None | None |
206-
+--------------------------------------+---------------------+------------------+------+
207-
which is different from Compute v2.
200+
201+
.. code-block:: bash
202+
203+
# ip floating list
204+
205+
+----+---------------------+------------------+-----------+--------+
206+
| ID | Floating IP Address | Fixed IP Address | Server ID | Pool |
207+
+----+---------------------+------------------+-----------+--------+
208+
| 1 | 172.24.4.1 | None | None | public |
209+
+----+---------------------+------------------+-----------+--------+
210+
211+
When using Network v2, which is different from Compute v2. The output is:
212+
213+
.. code-block:: bash
214+
215+
# ip floating list
216+
217+
+--------------------------------------+---------------------+------------------+------+
218+
| ID | Floating IP Address | Fixed IP Address | Port |
219+
+--------------------------------------+---------------------+------------------+------+
220+
| 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3 | None | None |
221+
+--------------------------------------+---------------------+------------------+------+
208222
209223
* In favor of: Use `ip floating list` command
210224
* As of: NA

doc/source/commands.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,12 @@ Commands take the form::
88

99
openstack [<global-options>] <object-1> <action> [<object-2>] [<command-arguments>]
1010

11-
* All long options names begin with two dashes (``--``) and use a single dash
11+
.. NOTE::
12+
13+
All long options names begin with two dashes (``--``) and use a single dash
1214
(``-``) internally between words (``--like-this``). Underscores (``_``) are
1315
not used in option names.
1416

15-
1617
Global Options
1718
--------------
1819

@@ -78,7 +79,7 @@ referring to both Compute and Volume quotas.
7879
* ``command``: (**Internal**) installed commands in the OSC process
7980
* ``compute agent``: (**Compute**) a cloud Compute agent available to a hypervisor
8081
* ``compute service``: (**Compute**) a cloud Compute process running on a host
81-
* ``configuration``: (**Internal**) openstack client configuration
82+
* ``configuration``: (**Internal**) OpenStack client configuration
8283
* ``console log``: (**Compute**) server console text dump
8384
* ``console url``: (**Compute**) server remote console URL
8485
* ``consumer``: (**Identity**) OAuth-based delegatee
@@ -89,7 +90,7 @@ referring to both Compute and Volume quotas.
8990
* ``endpoint``: (**Identity**) the base URL used to contact a specific service
9091
* ``extension``: (**Compute**, **Identity**, **Network**, **Volume**) OpenStack server API extensions
9192
* ``federation protocol``: (**Identity**) the underlying protocol used while federating identities
92-
* ``flavor``: (**Compute**) predefined server configurations: ram, root disk, etc
93+
* ``flavor``: (**Compute**) predefined server configurations: ram, root disk and so on
9394
* ``group``: (**Identity**) a grouping of users
9495
* ``host``: (**Compute**) - the physical computer running compute services
9596
* ``hypervisor``: (**Compute**) the virtual machine manager

doc/source/humaninterfaceguide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Simplicity
8585
To best support new users and create straight forward interactions, designs
8686
should be as simple as possible. When crafting new commands, designs should
8787
minimize the amount of noise present in output: large amounts of
88-
nonessential data, overabundance of possible actions, etc. Designs should
88+
nonessential data, overabundance of possible actions and so on. Designs should
8989
focus on the intent of the command, requiring only the necessary components
9090
and either removing superfluous elements or making
9191
them accessible through optional arguments. An example of this principle occurs

0 commit comments

Comments
 (0)