diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2017-04-03 16:15:14 -0500 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2017-04-04 03:56:19 +0000 |
| commit | 1686dc54f09b6e77b1de3abc708c297710987a04 (patch) | |
| tree | 6c02758c2006da60f634940324c607e6785b433f /doc/source/command-objects/server.rst | |
| parent | b2ceb58fc377cd9030becaa934fc4e5d13cb55b4 (diff) | |
| download | python-openstackclient-1686dc54f09b6e77b1de3abc708c297710987a04.tar.gz | |
Help/docs cleanups: marker, limit, ip-address metavars
Cleanup help strings and docs for clarity and to keep things consistent:
* --limit metavar should be <num-resource> to indicate what is being counted
* --marker metavar should be <resource> or <resource-id> to indicate the
type of value being specified
* <*-ip-address> metavars should be just <ip-address> as there is no difference
in format between fixed and floating IPs
* Move all occurances of '(name or ID)' to end of help text
Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
Diffstat (limited to 'doc/source/command-objects/server.rst')
| -rw-r--r-- | doc/source/command-objects/server.rst | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 047bf181..ce4e168d 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -18,11 +18,11 @@ Add fixed IP address to server .. describe:: <server> - Server (name or ID) to receive the fixed IP address + Server to receive the fixed IP address (name or ID) .. describe:: <network> - Network (name or ID) to allocate the fixed IP address from + Network to allocate the fixed IP address from (name or ID) server add floating ip ---------------------- @@ -33,21 +33,21 @@ Add floating IP address to server .. code:: bash openstack server add floating ip - [--fixed-ip-address <fixed-ip-address>] + [--fixed-ip-address <ip-address>] <server> <ip-address> -.. option:: --fixed-ip-address <fixed-ip-address> +.. option:: --fixed-ip-address <ip-address> Fixed IP address to associate with this floating IP address .. describe:: <server> - Server (name or ID) to receive the floating IP address + Server to receive the floating IP address (name or ID) .. describe:: <ip-address> - Floating IP address (IP address only) to assign to server + Floating IP address to assign to server (IP only) server add security group ------------------------- @@ -264,7 +264,7 @@ List servers [--project <project> [--project-domain <project-domain>]] [--long] [--marker <server>] - [--limit <limit>] + [--limit <num-servers>] [--deleted] [--changes-since <changes-since>] @@ -332,10 +332,10 @@ List servers .. option:: --marker <server> - The last server (name or ID) of the previous page. Display list of servers - after marker. Display all servers if not specified. + The last server of the previous page. Display list of servers + after marker. Display all servers if not specified. (name or ID) -.. option:: --limit <limit> +.. option:: --limit <num-servers> Maximum number of servers to display. If limit equals -1, all servers will be displayed. If limit is greater than 'osapi_max_limit' option of Nova @@ -497,11 +497,11 @@ Remove fixed IP address from server .. describe:: <server> - Server (name or ID) to remove the fixed IP address from + Server to remove the fixed IP address from (name or ID) .. describe:: <ip-address> - Fixed IP address (IP address only) to remove from the server + Fixed IP address to remove from the server (IP only) server remove floating ip ------------------------- @@ -517,11 +517,11 @@ Remove floating IP address from server .. describe:: <server> - Server (name or ID) to remove the floating IP address from + Server to remove the floating IP address from (name or ID) .. describe:: <ip-address> - Floating IP address (IP address only) to remove from server + Floating IP address to remove from server (IP only) server remove security group ---------------------------- |