deb-oslo.config/doc/source/namespaces.rst
Davanum Srinivas 0a7abd0aa8 Add some guidance for group names
Closes-Bug: #1375898
Change-Id: I358f0f1529ae88007bdfd1cb453d432c529cb5fd
2014-10-09 16:14:04 -04:00

523 B

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.