openstack/oslo.config
Code Issues Proposed changes
beb7b6ce2b
oslo.config/doc/source/reference/helpers.rst
Ben Nemec 2610dff995 Switch to sphinxcontrib-apidoc 
Rather than have the API docs hand-curated and scattered throughout
the documentation, let's use the apidoc module like all of the other
Oslo projects so our API docs are consistent and easy to find.

The documents that were exclusively API docs are removed entirely,
and the ones where API docs were included with other content have
been changed to reference the generated API docs rather than include
them inline. The one exception is the drivers because they are in
private modules that don't show up in the API docs. Those are still
explicitly documented.

Change-Id: I00bdd963e0d4f270c0d4b50c05f420317a137fd5
2019-06-18 16:31:48 +00:00

818 B
Raw Blame History

Helper Functions

Showing detailed locations for configuration settings

oslo.config can track the location in application and library code where an option is defined, defaults are set, or values are overridden. This feature is disabled by default because it is expensive and incurs a significant performance penalty, but it can be useful for developers tracing down issues with configuration option definitions.

To turn on detailed location tracking, set the environment variable OSLO_CONFIG_SHOW_CODE_LOCATIONS to any non-empty value (for example, "1" or "yes, please") before starting the application, test suite, or script. Then use ConfigOpts.get_location to access the location data for the option.