From d5a29ad9305c0c964fd3851483c662676afd4a70 Mon Sep 17 00:00:00 2001 From: Stephen Gordon Date: Mon, 7 Apr 2014 21:43:51 -0400 Subject: [PATCH] Typographical correction of Arista ML2 help The Configuration Reference Guide on docs.openstack.org contains configuration tables generated based on the help strings defined in the Python code. Typographical errors in the source for the Arista ML2 plugin, particularly a lack of spaces between the start and end of continuing lines, were resulting in errors in the guide. Change-Id: I793274d9bf631db890af57f242b99de99db6f1f6 --- .../plugins/ml2/drivers/mech_arista/config.py | 47 ++++++++++--------- 1 file changed, 24 insertions(+), 23 deletions(-) diff --git a/neutron/plugins/ml2/drivers/mech_arista/config.py b/neutron/plugins/ml2/drivers/mech_arista/config.py index c4bdfe7c6..2f968c874 100644 --- a/neutron/plugins/ml2/drivers/mech_arista/config.py +++ b/neutron/plugins/ml2/drivers/mech_arista/config.py @@ -28,42 +28,43 @@ OpenStack/Neutron controllers. ARISTA_DRIVER_OPTS = [ cfg.StrOpt('eapi_username', default='', - help=_('Username for Arista EOS. This is required field.' - 'if not set, all communications to Arista EOS' - 'will fail')), + help=_('Username for Arista EOS. This is required field. ' + 'If not set, all communications to Arista EOS' + 'will fail.')), cfg.StrOpt('eapi_password', default='', secret=True, # do not expose value in the logs - help=_('Password for Arista EOS. This is required field.' - 'if not set, all communications to Arista EOS' - 'will fail')), + help=_('Password for Arista EOS. This is required field. ' + 'If not set, all communications to Arista EOS ' + 'will fail.')), cfg.StrOpt('eapi_host', default='', - help=_('Arista EOS IP address. This is required field.' + help=_('Arista EOS IP address. This is required field. ' 'If not set, all communications to Arista EOS' - 'will fail')), + 'will fail.')), cfg.BoolOpt('use_fqdn', default=True, - help=_('Defines if hostnames are sent to Arista EOS as FQDNs' - '("node1.domain.com") or as short names ("node1").' - 'This is optional. If not set, a value of "True"' + help=_('Defines if hostnames are sent to Arista EOS as FQDNs ' + '("node1.domain.com") or as short names ("node1"). ' + 'This is optional. If not set, a value of "True" ' 'is assumed.')), cfg.IntOpt('sync_interval', default=180, - help=_('Sync interval in seconds between Neutron plugin and' - 'EOS. This interval defines how often the' - 'synchronization is performed. This is an optional' - 'field. If not set, a value of 180 seconds is assumed')), + help=_('Sync interval in seconds between Neutron plugin and ' + 'EOS. This interval defines how often the ' + 'synchronization is performed. This is an optional ' + 'field. If not set, a value of 180 seconds is ' + 'assumed.')), cfg.StrOpt('region_name', default='RegionOne', - help=_('Defines Region Name that is assigned to this OpenStack' - 'Controller. This is useful when multiple' - 'OpenStack/Neutron controllers are managing the same' - 'Arista HW clusters. Note that this name must match with' - 'the region name registered (or known) to keystone' - 'service. Authentication with Keysotne is performed by' - 'EOS. This is optional. If not set, a value of' - '"RegionOne" is assumed')) + help=_('Defines Region Name that is assigned to this OpenStack ' + 'Controller. This is useful when multiple ' + 'OpenStack/Neutron controllers are managing the same ' + 'Arista HW clusters. Note that this name must match ' + 'with the region name registered (or known) to keystone ' + 'service. Authentication with Keysotne is performed by ' + 'EOS. This is optional. If not set, a value of ' + '"RegionOne" is assumed.')) ] cfg.CONF.register_opts(ARISTA_DRIVER_OPTS, "ml2_arista") -- 2.45.2