openstack
/
oslo.config
Code Issues Proposed changes

Add note to docs about CLI opts and config files 

CLI opts can also be read from file, so once an option is registered
for CLI use it doesn't need to be registered again to be usable in
a config file. Add a note in the Registering Options section that
explicitly explains this behavior.

Change-Id: Ib75b5c314b96ec4c46f94e2847016a953433f480
This commit is contained in:
Ben Nemec 2019-03-12 15:21:42 +00:00
parent fd4c1a0bf4
commit eedab79f44
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/reference/defining.rst
View File

@ -112,7 +112,11 @@ class which uses the option:
An option may optionally be made available via the command line. Such options
must be registered with the config manager before the command line is parsed
(for the purposes of --help and CLI arg validation):
(for the purposes of --help and CLI arg validation).
Note that options registered for CLI use do not need to be registered again for
use from other config sources, such as files. CLI options can be read from
either the CLI or from the other enabled config sources.
.. code-block:: python