diff options
| author | Lance Bragstad <lbragstad@gmail.com> | 2021-09-09 19:11:42 +0000 |
|---|---|---|
| committer | Lance Bragstad <lbragstad@gmail.com> | 2021-09-09 19:11:42 +0000 |
| commit | a0e407e6929bd07a8c97919ae63c9a2fea00d2c2 (patch) | |
| tree | 453b412c2c75959e43eac02830e2a1df049eb11c | |
| parent | c7fd9f4fcd43fb78534921530d981634ec516344 (diff) | |
| download | oslo-policy-a0e407e6929bd07a8c97919ae63c9a2fea00d2c2.tar.gz | |
Clarify enforce_new_defaults help text
The help text isn't clear what happens when enforce_new_defaults is
False, which is the default behavior. Explicity call that out in the
help text since it's important for users to understand that behavior.
Change-Id: Iaed5682bc72f4c66adb9a40c6510b399314574df
| -rw-r--r-- | oslo_policy/opts.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/oslo_policy/opts.py b/oslo_policy/opts.py index 5eb93d7..f4e641a 100644 --- a/oslo_policy/opts.py +++ b/oslo_policy/opts.py @@ -44,7 +44,11 @@ _options = [ 'defaults, it will be disallowed. It is encouraged to ' 'enable this flag along with the ``enforce_scope`` ' 'flag so that you can get the benefits of new defaults ' - 'and ``scope_type`` together')), + 'and ``scope_type`` together. If ``False``, the ' + 'deprecated policy check string is logically OR\'d ' + 'with the new policy check string, allowing for a ' + 'graceful upgrade experience between releases with ' + 'new policies, which is the default behavior.')), cfg.StrOpt('policy_file', default='policy.json', help=_('The relative or absolute path of a file that maps ' |