openstack/oslo.config
Code Issues Proposed changes

Add some guidance for group names

Browse Source 
Closes-Bug: #1375898
Change-Id: I358f0f1529ae88007bdfd1cb453d432c529cb5fd
This commit is contained in:
Davanum Srinivas 2014-09-30 16:59:22 -04:00 committed by Doug Hellmann
parent 5ada83306c
commit 0a7abd0aa8
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/index.rst
View File

@ -19,6 +19,7 @@ Contents
fixture
parser
exceptions
namespaces
styleguide
generator

12
doc/source/namespaces.rst Normal file
View File

@ -0,0 +1,12 @@
----------------------------------------------
Choosing group names for configuration options
----------------------------------------------
Applications should use a meaningful name without a prefix. For Oslo
libraries, when naming groups for configuration options using the
name of the library itself instead of a descriptive name to help avoid
collisions. If the library name is namespaced then use '_' as a separator
in the group name.
For example, the ``oslo.log`` library should use ``oslo_log`` as the
group name.