From 325420f6d166aef0b58242918fac464642395b5d Mon Sep 17 00:00:00 2001
From: Richard Theis <rtheis@us.ibm.com>
Date: Tue, 24 Nov 2015 10:31:07 -0600
Subject: Doc: Update and add IP address

Fix the 'ip floating' command documentation file name.
Add missing command list documentation for the 'ip fixed'
and 'ip floating pool' commands.  In addition, update the
command description and argument help to fix minor issues
and use consistent terminology.  And finally, cleanup the
Network command object formatting.

Change-Id: I0168891bc674c9f0d4df4062f7e93f497dc8fe6f
---
 openstackclient/compute/v2/fixedip.py        | 12 ++++++------
 openstackclient/compute/v2/floatingip.py     | 18 +++++++++---------
 openstackclient/compute/v2/floatingippool.py |  2 +-
 3 files changed, 16 insertions(+), 16 deletions(-)

(limited to 'openstackclient')

diff --git a/openstackclient/compute/v2/fixedip.py b/openstackclient/compute/v2/fixedip.py
index d105e391..da9d85c3 100644
--- a/openstackclient/compute/v2/fixedip.py
+++ b/openstackclient/compute/v2/fixedip.py
@@ -23,7 +23,7 @@ from openstackclient.common import utils
 
 
 class AddFixedIP(command.Command):
-    """Add fixed-ip command"""
+    """Add fixed IP address to server"""
 
     log = logging.getLogger(__name__ + ".AddFixedIP")
 
@@ -32,12 +32,12 @@ class AddFixedIP(command.Command):
         parser.add_argument(
             "network",
             metavar="<network>",
-            help="Name of the network to fetch an IP address from",
+            help="Network to fetch an IP address from (name or ID)",
         )
         parser.add_argument(
             "server",
             metavar="<server>",
-            help="Name of the server to receive the IP address",
+            help="Server to receive the IP address (name or ID)",
         )
         return parser
 
@@ -56,7 +56,7 @@ class AddFixedIP(command.Command):
 
 
 class RemoveFixedIP(command.Command):
-    """Remove fixed-ip command"""
+    """Remove fixed IP address from server"""
 
     log = logging.getLogger(__name__ + ".RemoveFixedIP")
 
@@ -65,12 +65,12 @@ class RemoveFixedIP(command.Command):
         parser.add_argument(
             "ip_address",
             metavar="<ip-address>",
-            help="IP address to remove from server",
+            help="IP address to remove from server (name only)",
         )
         parser.add_argument(
             "server",
             metavar="<server>",
-            help="Name of the server to remove the IP address from",
+            help="Server to remove the IP address from (name or ID)",
         )
         return parser
 
diff --git a/openstackclient/compute/v2/floatingip.py b/openstackclient/compute/v2/floatingip.py
index c557c24b..65fe5910 100644
--- a/openstackclient/compute/v2/floatingip.py
+++ b/openstackclient/compute/v2/floatingip.py
@@ -26,7 +26,7 @@ from openstackclient.common import utils
 
 
 class AddFloatingIP(command.Command):
-    """Add floating-ip to server"""
+    """Add floating IP address to server"""
 
     log = logging.getLogger(__name__ + ".AddFloatingIP")
 
@@ -35,7 +35,7 @@ class AddFloatingIP(command.Command):
         parser.add_argument(
             "ip_address",
             metavar="<ip-address>",
-            help="IP address to add to server",
+            help="IP address to add to server (name only)",
         )
         parser.add_argument(
             "server",
@@ -56,7 +56,7 @@ class AddFloatingIP(command.Command):
 
 
 class CreateFloatingIP(show.ShowOne):
-    """Create new floating-ip"""
+    """Create new floating IP address"""
 
     log = logging.getLogger(__name__ + '.CreateFloatingIP')
 
@@ -65,7 +65,7 @@ class CreateFloatingIP(show.ShowOne):
         parser.add_argument(
             'pool',
             metavar='<pool>',
-            help='Pool to fetch floating IP from',
+            help='Pool to fetch IP address from (name or ID)',
         )
         return parser
 
@@ -80,7 +80,7 @@ class CreateFloatingIP(show.ShowOne):
 
 
 class DeleteFloatingIP(command.Command):
-    """Delete a floating-ip"""
+    """Delete a floating IP address"""
 
     log = logging.getLogger(__name__ + '.DeleteFloatingIP')
 
@@ -89,7 +89,7 @@ class DeleteFloatingIP(command.Command):
         parser.add_argument(
             "ip_address",
             metavar="<ip-address>",
-            help="IP address to delete",
+            help="IP address to delete (ID only)",
         )
         return parser
 
@@ -107,7 +107,7 @@ class DeleteFloatingIP(command.Command):
 
 
 class ListFloatingIP(lister.Lister):
-    """List floating-ips"""
+    """List floating IP addresses"""
 
     log = logging.getLogger(__name__ + '.ListFloatingIP')
 
@@ -127,7 +127,7 @@ class ListFloatingIP(lister.Lister):
 
 
 class RemoveFloatingIP(command.Command):
-    """Remove floating-ip from server"""
+    """Remove floating IP address from server"""
 
     log = logging.getLogger(__name__ + ".RemoveFloatingIP")
 
@@ -136,7 +136,7 @@ class RemoveFloatingIP(command.Command):
         parser.add_argument(
             "ip_address",
             metavar="<ip-address>",
-            help="IP address to remove from server",
+            help="IP address to remove from server (name only)",
         )
         parser.add_argument(
             "server",
diff --git a/openstackclient/compute/v2/floatingippool.py b/openstackclient/compute/v2/floatingippool.py
index cc485552..39a2d8fe 100644
--- a/openstackclient/compute/v2/floatingippool.py
+++ b/openstackclient/compute/v2/floatingippool.py
@@ -23,7 +23,7 @@ from openstackclient.common import utils
 
 
 class ListFloatingIPPool(lister.Lister):
-    """List floating-ip-pools"""
+    """List pools of floating IP addresses"""
 
     log = logging.getLogger(__name__ + '.ListFloatingIPPool')
 
-- 
cgit v1.2.1