openstack/python-openstackclient
Code Issues Proposed changes

Modify few words and change output format for command "ip floating list"

Browse Source 
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
This commit is contained in:
zhang.xiuhua 2016-06-03 16:20:42 +08:00 committed by Steve Martinelli
parent 044a46ed5f
commit 1dce52ace8
3 changed files with 39 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
doc/source/backwards-incompatible.rst
View File

@ -124,7 +124,7 @@ Releases Before 3.0
8. `region` commands no longer support `url`
The Keystone team removed support for thr `url` attribute from the client
The Keystone team removed support for the `url` attribute from the client
and server side. Changes to the `create`, `set` and `list` commands for
regions have been affected.
@ -184,27 +184,41 @@ Releases Before 3.0
14. Output of `ip floating list` command has changed.
When using Compute v2, the original output of `ip floating list` command is:
+----+--------+------------+----------+-------------+
| ID | Pool | IP | Fixed IP | Instance ID |
+----+--------+-----------------------+-------------+
| 1 | public | 172.24.4.1 | None | None |
+----+--------+------------+----------+-------------+
When using Compute v2, the original output is:
.. code-block:: bash
# ip floating list
+----+--------+------------+----------+-------------+
| ID | Pool | IP | Fixed IP | Instance ID |
+----+--------+-----------------------+-------------+
| 1 | public | 172.24.4.1 | None | None |
+----+--------+------------+----------+-------------+
Now it changes to:
+----+---------------------+------------------+-----------+--------+
| ID | Floating IP Address | Fixed IP Address | Server ID | Pool |
+----+---------------------+------------------+-----------+--------+
| 1 | 172.24.4.1 | None | None | public |
+----+---------------------+------------------+-----------+--------+
When using Network v2, the output of `ip floating list` command is:
+--------------------------------------+---------------------+------------------+------+
| ID | Floating IP Address | Fixed IP Address | Port |
+--------------------------------------+---------------------+------------------+------+
| 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3 | None | None |
+--------------------------------------+---------------------+------------------+------+
which is different from Compute v2.
.. code-block:: bash
# ip floating list
+----+---------------------+------------------+-----------+--------+
| ID | Floating IP Address | Fixed IP Address | Server ID | Pool |
+----+---------------------+------------------+-----------+--------+
| 1 | 172.24.4.1 | None | None | public |
+----+---------------------+------------------+-----------+--------+
When using Network v2, which is different from Compute v2. The output is:
.. code-block:: bash
# ip floating list
+--------------------------------------+---------------------+------------------+------+
| ID | Floating IP Address | Fixed IP Address | Port |
+--------------------------------------+---------------------+------------------+------+
| 1976df86-e66a-4f96-81bd-c6ffee6407f1 | 172.24.4.3 | None | None |
+--------------------------------------+---------------------+------------------+------+
* In favor of: Use `ip floating list` command
* As of: NA

9
doc/source/commands.rst
View File

@ -8,11 +8,12 @@ Commands take the form::
openstack [<global-options>] <object-1> <action> [<object-2>] [<command-arguments>]
* All long options names begin with two dashes (``--``) and use a single dash
.. NOTE::
All long options names begin with two dashes (``--``) and use a single dash
(``-``) internally between words (``--like-this``). Underscores (``_``) are
not used in option names.
Global Options
--------------
@ -78,7 +79,7 @@ referring to both Compute and Volume quotas.
* ``command``: (**Internal**) installed commands in the OSC process
* ``compute agent``: (**Compute**) a cloud Compute agent available to a hypervisor
* ``compute service``: (**Compute**) a cloud Compute process running on a host
* ``configuration``: (**Internal**) openstack client configuration
* ``configuration``: (**Internal**) OpenStack client configuration
* ``console log``: (**Compute**) server console text dump
* ``console url``: (**Compute**) server remote console URL
* ``consumer``: (**Identity**) OAuth-based delegatee
@ -89,7 +90,7 @@ referring to both Compute and Volume quotas.
* ``endpoint``: (**Identity**) the base URL used to contact a specific service
* ``extension``: (**Compute**, **Identity**, **Network**, **Volume**) OpenStack server API extensions
* ``federation protocol``: (**Identity**) the underlying protocol used while federating identities
* ``flavor``: (**Compute**) predefined server configurations: ram, root disk, etc
* ``flavor``: (**Compute**) predefined server configurations: ram, root disk and so on
* ``group``: (**Identity**) a grouping of users
* ``host``: (**Compute**) - the physical computer running compute services
* ``hypervisor``: (**Compute**) the virtual machine manager

2
doc/source/humaninterfaceguide.rst
View File

@ -85,7 +85,7 @@ Simplicity
To best support new users and create straight forward interactions, designs
should be as simple as possible. When crafting new commands, designs should
minimize the amount of noise present in output: large amounts of
nonessential data, overabundance of possible actions, etc. Designs should
nonessential data, overabundance of possible actions and so on. Designs should
focus on the intent of the command, requiring only the necessary components
and either removing superfluous elements or making
them accessible through optional arguments. An example of this principle occurs