diff options
| author | Zuul <zuul@review.openstack.org> | 2018-11-02 19:58:06 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2018-11-02 19:58:06 +0000 |
| commit | 4e0e72d480f157984d827c8e3da0bb4ab5356882 (patch) | |
| tree | 556f0cbea29aa7049b218776db53c793876df1ea /doc/source | |
| parent | 76fd7231cbd90812f38ea6cb8851472a8abdb56a (diff) | |
| parent | ea8a0f6a8b260474151fb27c2adc9dcc88774850 (diff) | |
| download | oslo-config-4e0e72d480f157984d827c8e3da0bb4ab5356882.tar.gz | |
Merge "Add support for looking in environment for config"
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/reference/defining.rst | 4 | ||||
| -rw-r--r-- | doc/source/reference/drivers.rst | 1 | ||||
| -rw-r--r-- | doc/source/reference/locations.rst | 4 |
3 files changed, 8 insertions, 1 deletions
diff --git a/doc/source/reference/defining.rst b/doc/source/reference/defining.rst index 65a602f..59d80d5 100644 --- a/doc/source/reference/defining.rst +++ b/doc/source/reference/defining.rst @@ -2,7 +2,9 @@ Defining Options ================== -Configuration options may be set on the command line or in config files. +Configuration options may be set on the command line, in the +:mod:`environment <oslo_config.sources._environment>`, or in config files. +Options are processed in that order. The schema for each option is defined using the :class:`Opt` class or its sub-classes, for example: diff --git a/doc/source/reference/drivers.rst b/doc/source/reference/drivers.rst index 3790675..0c06ab1 100644 --- a/doc/source/reference/drivers.rst +++ b/doc/source/reference/drivers.rst @@ -10,3 +10,4 @@ Known Backend Drivers --------------------- .. automodule:: oslo_config.sources._uri +.. automodule:: oslo_config.sources._environment diff --git a/doc/source/reference/locations.rst b/doc/source/reference/locations.rst index bfade1a..40b2625 100644 --- a/doc/source/reference/locations.rst +++ b/doc/source/reference/locations.rst @@ -47,6 +47,10 @@ describing the location. Its value depends on the ``location``. - ``True`` - A value set by the user on the command line. - Empty string. + * - ``environment`` + - ``True`` + - A value set by the user in the process environment. + - The name of the environment variable. Did a user set a configuration option? ====================================== |