openstack/oslo.config
Code Issues Proposed changes
beb7b6ce2b
oslo.config/doc/source/reference/naming.rst
Doug Hellmann bd463ee3b6 move some documentation out of the source files 
The cfg module is very large, and starts with a huge block of
documentation. This patch moves that information into separate files
in the reference section of the docs. A few formatting fixes need to
be made to have it build cleanly, but the content is not changed in a
substantive way.

Change-Id: I86aa90bbf180b5dc9acbcedb024e5361d49954c3
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-07-19 17:26:38 -04:00

523 B
Raw Blame History

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.