From 1dce52ace8aaa2a6220baf9eb1716bcc0f05f676 Mon Sep 17 00:00:00 2001 From: "zhang.xiuhua" Date: Fri, 3 Jun 2016 16:20:42 +0800 Subject: [PATCH] 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 --- doc/source/backwards-incompatible.rst | 52 +++++++++++++++++---------- doc/source/commands.rst | 9 ++--- doc/source/humaninterfaceguide.rst | 2 +- 3 files changed, 39 insertions(+), 24 deletions(-) diff --git a/doc/source/backwards-incompatible.rst b/doc/source/backwards-incompatible.rst index f86cfce4c2..da3c1b6417 100644 --- a/doc/source/backwards-incompatible.rst +++ b/doc/source/backwards-incompatible.rst @@ -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 diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 9fb0555d7c..9d8ad6fd26 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -8,11 +8,12 @@ Commands take the form:: openstack [] [] [] -* 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 diff --git a/doc/source/humaninterfaceguide.rst b/doc/source/humaninterfaceguide.rst index 9cca5aa758..5d3c48dcca 100644 --- a/doc/source/humaninterfaceguide.rst +++ b/doc/source/humaninterfaceguide.rst @@ -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