From e541ca285d5a0f484c886fb28514b84580c3dc02 Mon Sep 17 00:00:00 2001
From: Justin Hammond <justin.hammond@rackspace.com>
Date: Tue, 3 Sep 2013 15:57:52 -0500
Subject: [PATCH] Adds help text to brocade configuration options

Help text was added to the configuration options defined in the brocade neutron
plugin. This help text should assist users of the brocade plugin. The OSTYPE
configuration option was not used in the plugin and was labeled as such so a
user of the plugin would not worry about the meaning of it.

The example etc file /etc/neutron/plugins/brocade/brocade.ini has been updated
to share the same help values where applicable.

Fixes-Bug: #1157511

Change-Id: Ie068396e77902037a7a0b5334d4dfb0dcdd3575e
---
 etc/neutron/plugins/brocade/brocade.ini  | 10 +++++-----
 neutron/plugins/brocade/NeutronPlugin.py | 16 +++++++++++-----
 2 files changed, 16 insertions(+), 10 deletions(-)

diff --git a/etc/neutron/plugins/brocade/brocade.ini b/etc/neutron/plugins/brocade/brocade.ini
index 6501c1b21..9acd1d990 100644
--- a/etc/neutron/plugins/brocade/brocade.ini
+++ b/etc/neutron/plugins/brocade/brocade.ini
@@ -1,8 +1,8 @@
 [switch]
-# username = <mgmt admin username>
-# password = <mgmt admin password>
-# address  = <switch mgmt ip address>
-# ostype   = NOS
+# username = The SSH username to use
+# password = The SSH password to use
+# address  = The address of the host to SSH to
+# ostype   = Should be NOS, but is unused otherwise
 #
 # Example:
 # username = admin
@@ -11,7 +11,7 @@
 # ostype   = NOS
 
 [physical_interface]
-# physical_interface = <physical network name>
+# physical_interface = The network interface to use when creating a port
 #
 # Example:
 # physical_interface = physnet1
diff --git a/neutron/plugins/brocade/NeutronPlugin.py b/neutron/plugins/brocade/NeutronPlugin.py
index 2f0a169b7..d2f137c65 100644
--- a/neutron/plugins/brocade/NeutronPlugin.py
+++ b/neutron/plugins/brocade/NeutronPlugin.py
@@ -59,13 +59,19 @@ PLUGIN_VERSION = 0.88
 AGENT_OWNER_PREFIX = "network:"
 NOS_DRIVER = 'neutron.plugins.brocade.nos.nosdriver.NOSdriver'
 
-SWITCH_OPTS = [cfg.StrOpt('address', default=''),
-               cfg.StrOpt('username', default=''),
-               cfg.StrOpt('password', default='', secret=True),
-               cfg.StrOpt('ostype', default='NOS')
+SWITCH_OPTS = [cfg.StrOpt('address', default='',
+                          help=_('The address of the host to SSH to')),
+               cfg.StrOpt('username', default='',
+                          help=_('The SSH username to use')),
+               cfg.StrOpt('password', default='', secret=True,
+                          help=_('The SSH password to use')),
+               cfg.StrOpt('ostype', default='NOS',
+                          help=_('Currently unused'))
                ]
 
-PHYSICAL_INTERFACE_OPTS = [cfg.StrOpt('physical_interface', default='eth0')
+PHYSICAL_INTERFACE_OPTS = [cfg.StrOpt('physical_interface', default='eth0',
+                           help=_('The network interface to use when creating'
+                                  'a port'))
                            ]
 
 cfg.CONF.register_opts(SWITCH_OPTS, "SWITCH")
-- 
2.45.2