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/floating-ip.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/floating-ip.rst')
| -rw-r--r-- | doc/source/command-objects/floating-ip.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst index 5a38bc1b..cbb473b8 100644 --- a/doc/source/command-objects/floating-ip.rst +++ b/doc/source/command-objects/floating-ip.rst @@ -15,8 +15,8 @@ Create floating IP openstack floating ip create [--subnet <subnet>] [--port <port>] - [--floating-ip-address <floating-ip-address>] - [--fixed-ip-address <fixed-ip-address>] + [--floating-ip-address <ip-address>] + [--fixed-ip-address <ip-address>] [--description <description>] [--project <project> [--project-domain <project-domain>]] <network> @@ -31,12 +31,12 @@ Create floating IP Port to be associated with the floating IP (name or ID) *Network version 2 only* -.. option:: --floating-ip-address <floating-ip-address> +.. option:: --floating-ip-address <ip-address> Floating IP address *Network version 2 only* -.. option:: --fixed-ip-address <fixed-ip-address> +.. option:: --fixed-ip-address <ip-address> Fixed IP address mapped to the floating IP *Network version 2 only* @@ -88,7 +88,7 @@ List floating IP(s) openstack floating ip list [--network <network>] [--port <port>] - [--fixed-ip-address <fixed-ip-address>] + [--fixed-ip-address <ip-address>] [--long] [--status <status>] [--project <project> [--project-domain <project-domain>]] @@ -106,7 +106,7 @@ List floating IP(s) *Network version 2 only* -.. option:: --fixed-ip-address <fixed-ip-address> +.. option:: --fixed-ip-address <ip-address> List floating IP(s) according to given fixed IP address |