openstack/deb-python-neutron-lib
Code Issues Proposed changes

Doc olso config option approach

Browse Source 
This update to the review guidelines, captures at a high
level the discussion Armando and I had regarding how
oslo config options should be rehomed to neutron-lib.

For more details search for 'common config options' in
[1].

[1] http://eavesdrop.openstack.org/irclogs/%23openstack-
neutron/%23openstack-neutron.2016-11-17.log.html

Change-Id: I31990a793690d3ed7b3ab588c213d453959d93bf
This commit is contained in:
Boden R
2016-11-17 12:03:52 -07:00
parent fa6c37f35b
commit 3225a572b7
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/source/review-guidelines.rst
View File

@@ -52,3 +52,13 @@ When reviewing neutron-lib changes, please be aware:
moved into neutron-lib:
- eventlet
* With respect to `Oslo config options <http://docs.openstack.org/developer/oslo.config/>`_:
- Config options should only be included in neutron-lib when the respective
functionality that uses the options lives in neutron-lib. In this case the
options will need to be exposed as entry points for
`config generation <http://docs.openstack.org/developer/oslo.config/generator.html>`_.
- Common functionality in neutron-lib that accesses config values should
assume the caller has registered them and document such in the docstring for
the respective functionality in neutron-lib.