From 3225a572b70d1cfe08322c3b1c90074bb5facde9 Mon Sep 17 00:00:00 2001 From: Boden R Date: Thu, 17 Nov 2016 12:03:52 -0700 Subject: [PATCH] Doc olso config option approach 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 --- doc/source/review-guidelines.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/source/review-guidelines.rst b/doc/source/review-guidelines.rst index ba7f991..e7a766b 100644 --- a/doc/source/review-guidelines.rst +++ b/doc/source/review-guidelines.rst @@ -52,3 +52,13 @@ When reviewing neutron-lib changes, please be aware: moved into neutron-lib: - eventlet + +* With respect to `Oslo config options `_: + + - 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 `_. + - 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.