diff options
| author | Doug Hellmann <doug.hellmann@dreamhost.com> | 2014-06-17 06:58:10 -0700 |
|---|---|---|
| committer | Doug Hellmann <doug.hellmann@dreamhost.com> | 2014-06-17 07:00:42 -0700 |
| commit | 15ea8719794a76f654ea28f530b4339f181085bc (patch) | |
| tree | a65d79a34664ce1ef4526b825ac6061cfcd95018 | |
| parent | 1746fd2908bec7dd215d06667c615174237809cc (diff) | |
| download | oslo-config-15ea8719794a76f654ea28f530b4339f181085bc.tar.gz | |
Add warning about interpolating values from groups
Add a warning explaining that options in groups cannot be used with
the interpolation syntax.
Reformat note to use directive so it is highlighted.
Add "docs" section to tox.ini to make testing doc build easier.
Change-Id: If5106aa44d4c87abe84a7fb7a250541bba9f5068
| -rw-r--r-- | oslo/config/cfg.py | 11 | ||||
| -rw-r--r-- | tox.ini | 3 |
2 files changed, 13 insertions, 1 deletions
diff --git a/oslo/config/cfg.py b/oslo/config/cfg.py index ece7916..98507b4 100644 --- a/oslo/config/cfg.py +++ b/oslo/config/cfg.py @@ -232,7 +232,16 @@ Option values may reference other values using PEP 292 string substitution:: help='Connection string for SQL database.'), ] -Note that interpolation can be avoided by using `$$`. +.. note:: + + Interpolation can be avoided by using `$$`. + +.. warning:: + + Interpolation using the values of options in groups is not yet + supported. The interpolated option must be in the DEFAULT group + (i.e., ``"$state_path"`` works but ``"$database.state_path"`` does + not). Special Handling Instructions ----------------------------- @@ -19,6 +19,9 @@ commands = [testenv:venv] commands = {posargs} +[testenv:docs] +commands = python setup.py build_sphinx + [flake8] show-source = True ignore = H305 |