diff options
| author | Lance Bragstad <lbragstad@gmail.com> | 2019-04-03 13:10:26 +0000 |
|---|---|---|
| committer | Lance Bragstad <lbragstad@gmail.com> | 2019-04-03 13:10:26 +0000 |
| commit | 1e3f81c89b49451bd4c32a12f5a338441c5c1e56 (patch) | |
| tree | c58022a35f10ba928e3e408a7e94105efbb8c06c /oslo_policy/opts.py | |
| parent | 5d2b7a8634c0a1b7c75a71953e37b671e996a9ca (diff) | |
| download | oslo-policy-1e3f81c89b49451bd4c32a12f5a338441c5c1e56.tar.gz | |
Clarify policy_file configuration option help text
This options help text was ambiguous and didn't really give readers
a good idea of what policies were or if the path could be relative,
absolute, or both.
This commit attempts to clarify the help text a little bit so that
readers have a little more to go on.
Change-Id: Icda67f07f0ef5ee256113634d29f4662b48140cc
Diffstat (limited to 'oslo_policy/opts.py')
| -rw-r--r-- | oslo_policy/opts.py | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/oslo_policy/opts.py b/oslo_policy/opts.py index 0383b4a..e0e1dd6 100644 --- a/oslo_policy/opts.py +++ b/oslo_policy/opts.py @@ -36,7 +36,10 @@ _options = [ 'invoked with mismatching scope.')), cfg.StrOpt('policy_file', default='policy.json', - help=_('The file that defines policies.'), + help=_('The relative or absolute path of a file that maps ' + 'roles to permissions for a given service. Relative ' + 'paths must be specified in relation to the ' + 'configuration file setting this option.'), deprecated_group='DEFAULT'), cfg.StrOpt('policy_default_rule', default='default', |