Brocade plugin options have no help text

Bug #1157511 reported by Tom Fifield
24
This bug affects 3 people
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Low
Justin Hammond

Bug Description

In the Brocade Quantum Plugin (quantum/plugins/brocade/QuantumPlugin.py), options are registered without help text:

 64 SWITCH_OPTS = [cfg.StrOpt('address', default=''),
 65 cfg.StrOpt('username', default=''),
 66 cfg.StrOpt('password', default='', secret=True),
 67 cfg.StrOpt('ostype', default='NOS')
 68 ]
 69
 70 PHYSICAL_INTERFACE_OPTS = [cfg.StrOpt('physical_interface', default='eth0')
 71 ]
 72
 73 cfg.CONF.register_opts(SWITCH_OPTS, "SWITCH")
 74 cfg.CONF.register_opts(PHYSICAL_INTERFACE_OPTS, "PHYSICAL_INTERFACE")
 75 cfg.CONF.register_opts(scheduler.AGENTS_SCHEDULER_OPTS)

I'm not familiar with the expectations of quantum development, but I'd suspect that having help text for every option would be good practice ...

dan wendlandt (danwent)
tags: added: brocade
Changed in quantum:
assignee: nobody → Gary Kotton (garyk)
importance: Undecided → Low
Changed in quantum:
status: New → Triaged
ZhiQiang Fan (aji-zqfan)
tags: added: low-hanging-fruit
Changed in neutron:
assignee: Gary Kotton (garyk) → Justin Hammond (justin-hammond)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to neutron (master)

Fix proposed to branch: master
Review: https://review.openstack.org/44953

Changed in neutron:
status: Triaged → In Progress
Aaron Rosen (arosen)
Changed in neutron:
milestone: none → havana-rc1
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron (master)

Reviewed: https://review.openstack.org/44953
Committed: http://github.com/openstack/neutron/commit/e541ca285d5a0f484c886fb28514b84580c3dc02
Submitter: Jenkins
Branch: master

commit e541ca285d5a0f484c886fb28514b84580c3dc02
Author: Justin Hammond <email address hidden>
Date: Tue Sep 3 15:57:52 2013 -0500

    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

Changed in neutron:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in neutron:
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in neutron:
milestone: havana-rc1 → 2013.2
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.