Improve some plugins help strings

For consistency add a "." everywhere, remove an extra space at end of a
string, add missing space between strings, fix descriptions and
capitalization.

Change-Id: Ib1523352b19768425263c09855d6a218e06e588a

diff --git a/neutron/plugins/ibm/common/config.py b/neutron/plugins/ibm/common/config.py
index 68e2dbd421c824b4f148e437ca69b4f8f842e502..9d4b116ad98a1bae43d3d02b453608800fe9d488 100644 (file)
--- a/neutron/plugins/ibm/common/config.py
+++ b/neutron/plugins/ibm/common/config.py
@@ -25,47 +25,48 @@ DEFAULT_CONTROLLER_IPS = ['127.0.0.1']
 
 sdnve_opts = [
     cfg.BoolOpt('use_fake_controller', default=False,
-                help=_("If set to True uses a fake controller.")),
+                help=_("Whether to use a fake controller.")),
     cfg.StrOpt('base_url', default='/one/nb/v2/',
-               help=_("Base URL for SDN-VE controller REST API")),
+               help=_("Base URL for SDN-VE controller REST API.")),
     cfg.ListOpt('controller_ips', default=DEFAULT_CONTROLLER_IPS,
-                help=_("List of IP addresses of SDN-VE controller(s)")),
+                help=_("List of IP addresses of SDN-VE controller(s).")),
     cfg.StrOpt('info', default='sdnve_info_string',
-               help=_("SDN-VE RPC subject")),
+               help=_("SDN-VE RPC subject.")),
     cfg.StrOpt('port', default='8443',
-               help=_("SDN-VE controller port number")),
+               help=_("SDN-VE controller port number.")),
     cfg.StrOpt('format', default='json',
-               help=_("SDN-VE request/response format")),
+               help=_("SDN-VE request/response format.")),
     cfg.StrOpt('userid', default='admin',
-               help=_("SDN-VE administrator user id")),
+               help=_("SDN-VE administrator user ID.")),
     cfg.StrOpt('password', default='admin', secret=True,
-               help=_("SDN-VE administrator password")),
+               help=_("SDN-VE administrator password.")),
     cfg.StrOpt('integration_bridge',
-               help=_("Integration bridge to use")),
+               help=_("Integration bridge to use.")),
     cfg.BoolOpt('reset_bridge', default=True,
-                help=_("Reset the integration bridge before use")),
+                help=_("Whether to reset the integration bridge before use.")),
     cfg.BoolOpt('out_of_band', default=True,
-                help=_("Indicating if controller is out of band or not")),
+                help=_("Indicating if controller is out of band or not.")),
     cfg.ListOpt('interface_mappings',
                 default=DEFAULT_INTERFACE_MAPPINGS,
-                help=_("List of <physical_network_name>:<interface_name>")),
+                help=_("List of <physical_network_name>:<interface_name> "
+                       "mappings.")),
     cfg.StrOpt('default_tenant_type', default='OVERLAY',
-               help=_("Tenant type: OVERLAY (default) or OF")),
+               help=_("Tenant type: OVERLAY (default) or OF.")),
     cfg.StrOpt('overlay_signature', default='SDNVE-OVERLAY',
                help=_("The string in tenant description that indicates "
-                      "the tenant is a OVERLAY tenant")),
+                      "the tenant is a OVERLAY tenant.")),
     cfg.StrOpt('of_signature', default='SDNVE-OF',
                help=_("The string in tenant description that indicates "
-                      "the tenant is a OF tenant")),
+                      "the tenant is a OF tenant.")),
 ]
 
 sdnve_agent_opts = [
     cfg.IntOpt('polling_interval', default=2,
-               help=_("Agent polling interval if necessary")),
+               help=_("Agent polling interval if necessary.")),
     cfg.StrOpt('root_helper', default='sudo',
-               help=_("Using root helper")),
+               help=_("Using root helper.")),
     cfg.BoolOpt('rpc', default=True,
-                help=_("Whether using rpc")),
+                help=_("Whether to use rpc.")),
 
 ]
 

diff --git a/neutron/plugins/nec/common/config.py b/neutron/plugins/nec/common/config.py
index 76c85c8e6f6fb2720d4dda013a05823b57dc458a..fd4bba642b9eeaab9f38f692d06d30a3e75ddaf8 100644 (file)
--- a/neutron/plugins/nec/common/config.py
+++ b/neutron/plugins/nec/common/config.py
@@ -21,7 +21,7 @@ from neutron.plugins.nec.common import constants as nconst
 
 ovs_opts = [
     cfg.StrOpt('integration_bridge', default='br-int',
-               help=_("Integration bridge to use")),
+               help=_("Integration bridge to use.")),
 ]
 
 agent_opts = [
@@ -32,28 +32,28 @@ agent_opts = [
 
 ofc_opts = [
     cfg.StrOpt('host', default='127.0.0.1',
-               help=_("Host to connect to")),
+               help=_("Host to connect to.")),
     cfg.StrOpt('path_prefix', default='',
                help=_("Base URL of OFC REST API. "
                       "It is prepended to each API request.")),
     cfg.StrOpt('port', default='8888',
-               help=_("Port to connect to")),
+               help=_("Port to connect to.")),
     cfg.StrOpt('driver', default='trema',
-               help=_("Driver to use")),
+               help=_("Driver to use.")),
     cfg.BoolOpt('enable_packet_filter', default=True,
-                help=_("Enable packet filter")),
+                help=_("Enable packet filter.")),
     cfg.BoolOpt('use_ssl', default=False,
-                help=_("Use SSL to connect")),
+                help=_("Use SSL to connect.")),
     cfg.StrOpt('key_file',
-               help=_("Key file")),
+               help=_("Location of key file.")),
     cfg.StrOpt('cert_file',
-               help=_("Certificate file")),
+               help=_("Location of certificate file.")),
     cfg.BoolOpt('insecure_ssl', default=False,
-                help=_("Disable SSL certificate verification")),
+                help=_("Disable SSL certificate verification.")),
     cfg.IntOpt('api_max_attempts', default=3,
-               help=_("Maximum attempts per OFC API request."
+               help=_("Maximum attempts per OFC API request. "
                       "NEC plugin retries API request to OFC "
-                      "when OFC returns ServiceUnavailable (503)."
+                      "when OFC returns ServiceUnavailable (503). "
                       "The value must be greater than 0.")),
 ]
 

diff --git a/neutron/plugins/openvswitch/common/config.py b/neutron/plugins/openvswitch/common/config.py
index 09316b3716f0696270812e2a5385798beb37c49a..07ab6564a6893979fc5078af8c1ae18e38d49866 100644 (file)
--- a/neutron/plugins/openvswitch/common/config.py
+++ b/neutron/plugins/openvswitch/common/config.py
@@ -26,17 +26,17 @@ DEFAULT_TUNNEL_TYPES = []
 
 ovs_opts = [
     cfg.StrOpt('integration_bridge', default='br-int',
-               help=_("Integration bridge to use")),
+               help=_("Integration bridge to use.")),
     cfg.BoolOpt('enable_tunneling', default=False,
-                help=_("Enable tunneling support")),
+                help=_("Enable tunneling support.")),
     cfg.StrOpt('tunnel_bridge', default='br-tun',
-               help=_("Tunnel bridge to use")),
+               help=_("Tunnel bridge to use.")),
     cfg.StrOpt('int_peer_patch_port', default='patch-tun',
                help=_("Peer patch port in integration bridge for tunnel "
-                      "bridge")),
+                      "bridge.")),
     cfg.StrOpt('tun_peer_patch_port', default='patch-int',
                help=_("Peer patch port in tunnel bridge for integration "
-                      "bridge")),
+                      "bridge.")),
     cfg.StrOpt('local_ip', default='',
                help=_("Local IP address of GRE tunnel endpoints.")),
     cfg.ListOpt('bridge_mappings',
@@ -44,20 +44,20 @@ ovs_opts = [
                 help=_("List of <physical_network>:<bridge>")),
     cfg.StrOpt('tenant_network_type', default='local',
                help=_("Network type for tenant networks "
-                      "(local, vlan, gre, vxlan, or none)")),
+                      "(local, vlan, gre, vxlan, or none).")),
     cfg.ListOpt('network_vlan_ranges',
                 default=DEFAULT_VLAN_RANGES,
                 help=_("List of <physical_network>:<vlan_min>:<vlan_max> "
-                       "or <physical_network>")),
+                       "or <physical_network>.")),
     cfg.ListOpt('tunnel_id_ranges',
                 default=DEFAULT_TUNNEL_RANGES,
-                help=_("List of <tun_min>:<tun_max>")),
+                help=_("List of <tun_min>:<tun_max>.")),
     cfg.StrOpt('tunnel_type', default='',
                help=_("The type of tunnels to use when utilizing tunnels, "
-                      "either 'gre' or 'vxlan'")),
+                      "either 'gre' or 'vxlan'.")),
     cfg.BoolOpt('use_veth_interconnection', default=False,
                 help=_("Use veths instead of patch ports to interconnect the "
-                       "integration bridge to physical bridges")),
+                       "integration bridge to physical bridges.")),
 ]
 
 agent_opts = [
@@ -71,28 +71,28 @@ agent_opts = [
     cfg.IntOpt('ovsdb_monitor_respawn_interval',
                default=constants.DEFAULT_OVSDBMON_RESPAWN,
                help=_("The number of seconds to wait before respawning the "
-                      "ovsdb monitor after losing communication with it")),
+                      "ovsdb monitor after losing communication with it.")),
     cfg.ListOpt('tunnel_types', default=DEFAULT_TUNNEL_TYPES,
                 help=_("Network types supported by the agent "
-                       "(gre and/or vxlan)")),
+                       "(gre and/or vxlan).")),
     cfg.IntOpt('vxlan_udp_port', default=p_const.VXLAN_UDP_PORT,
                help=_("The UDP port to use for VXLAN tunnels.")),
     cfg.IntOpt('veth_mtu',
                help=_("MTU size of veth interfaces")),
     cfg.BoolOpt('l2_population', default=False,
                 help=_("Use ML2 l2population mechanism driver to learn "
-                       "remote mac and IPs and improve tunnel scalability")),
+                       "remote MAC and IPs and improve tunnel scalability.")),
     cfg.BoolOpt('arp_responder', default=False,
                 help=_("Enable local ARP responder if it is supported. "
                        "Requires OVS 2.1 and ML2 l2population driver. "
                        "Allows the switch (when supporting an overlay) "
                        "to respond to an ARP request locally without "
-                       "performing a costly ARP broadcast into the overlay")),
+                       "performing a costly ARP broadcast into the overlay.")),
     cfg.BoolOpt('dont_fragment', default=True,
                 help=_("Set or un-set the don't fragment (DF) bit on "
-                       "outgoing IP packet carrying GRE/VXLAN tunnel")),
+                       "outgoing IP packet carrying GRE/VXLAN tunnel.")),
     cfg.BoolOpt('enable_distributed_routing', default=False,
-                help=_("Make the l2 agent run in DVR mode ")),
+                help=_("Make the l2 agent run in DVR mode.")),
 ]
 
 

diff --git a/neutron/plugins/ryu/common/config.py b/neutron/plugins/ryu/common/config.py
index 57c3e784076fd3bb5730ca926cf126045e59e093..a7a699e036ec9bb798c16133bcaa558092511d65 100644 (file)
--- a/neutron/plugins/ryu/common/config.py
+++ b/neutron/plugins/ryu/common/config.py
@@ -19,23 +19,23 @@ from neutron.agent.linux import ovs_lib  # noqa
 
 ovs_opts = [
     cfg.StrOpt('integration_bridge', default='br-int',
-               help=_("Integration bridge to use")),
+               help=_("Integration bridge to use.")),
     cfg.StrOpt('openflow_rest_api', default='127.0.0.1:8080',
-               help=_("OpenFlow REST API location")),
+               help=_("OpenFlow REST API location.")),
     cfg.IntOpt('tunnel_key_min', default=1,
-               help=_("Minimum tunnel ID to use")),
+               help=_("Minimum tunnel ID to use.")),
     cfg.IntOpt('tunnel_key_max', default=0xffffff,
-               help=_("Maximum tunnel ID to use")),
+               help=_("Maximum tunnel ID to use.")),
     cfg.StrOpt('tunnel_ip',
-               help=_("Tunnel IP to use")),
+               help=_("Tunnel IP to use.")),
     cfg.StrOpt('tunnel_interface',
-               help=_("Tunnel interface to use")),
+               help=_("Tunnel interface to use.")),
     cfg.IntOpt('ovsdb_port', default=6634,
-               help=_("OVSDB port to connect to")),
+               help=_("OVSDB port to connect to.")),
     cfg.StrOpt('ovsdb_ip',
-               help=_("OVSDB IP to connect to")),
+               help=_("OVSDB IP to connect to.")),
     cfg.StrOpt('ovsdb_interface',
-               help=_("OVSDB interface to connect to")),
+               help=_("OVSDB interface to connect to.")),
 ]
 
 agent_opts = [