diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/cli/common/generator-opts.rst | 5 | ||||
| -rw-r--r-- | doc/source/user/sphinxpolicygen.rst | 5 |
2 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/cli/common/generator-opts.rst b/doc/source/cli/common/generator-opts.rst index b88549f..afa7d16 100644 --- a/doc/source/cli/common/generator-opts.rst +++ b/doc/source/cli/common/generator-opts.rst @@ -1,3 +1,8 @@ .. option:: --output-file OUTPUT_FILE Path of the file to write to. Defaults to stdout. + +.. option:: --exclude-deprecated True + + Option allowing the rendered output to be generated *without* deprecated + policy information. diff --git a/doc/source/user/sphinxpolicygen.rst b/doc/source/user/sphinxpolicygen.rst index 227dbad..4aae146 100644 --- a/doc/source/user/sphinxpolicygen.rst +++ b/doc/source/user/sphinxpolicygen.rst @@ -40,6 +40,11 @@ where: ``_static/nova.policy.yaml.sample``. If this option is not specified, the file will be output to ``sample.policy.yaml``. +``exclude_deprecated`` + Boolean value, default False, controls if the output should include deprecated + policy information or values, as these can be confusing and misleading + in some cases. + Once configured, you can include this configuration file in your source: .. code:: reST |