diff options
| author | ChangBo Guo(gcb) <eric.guo@easystack.cn> | 2016-09-22 17:07:18 +0800 |
|---|---|---|
| committer | ChangBo Guo(gcb) <eric.guo@easystack.cn> | 2016-09-22 17:09:59 +0800 |
| commit | 9b4d7d063f7c7595ec9aed73a3db20969c57aa33 (patch) | |
| tree | 718320d859d1c631769c4b91726de652b818d677 | |
| parent | 3cd4d430f728658034bb148dc86adb85ebe78dd2 (diff) | |
| download | oslo-policy-9b4d7d063f7c7595ec9aed73a3db20969c57aa33.tar.gz | |
Doc: declare YAML/JSON support
oslo.policy can support both of YAML and JSON until now,
but some docstring and config option's help text are inconsistent.
This commit fixes them.
Change-Id: I23cc60c84be97a3aec158f81ac21ac0ba3779abd
| -rw-r--r-- | oslo_policy/opts.py | 4 | ||||
| -rw-r--r-- | oslo_policy/policy.py | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/oslo_policy/opts.py b/oslo_policy/opts.py index d247e8a..2f11968 100644 --- a/oslo_policy/opts.py +++ b/oslo_policy/opts.py @@ -27,7 +27,7 @@ _option_group = 'oslo_policy' _options = [ cfg.StrOpt('policy_file', default='policy.json', - help=_('The JSON file that defines policies.'), + help=_('The file that defines policies.'), deprecated_group='DEFAULT'), cfg.StrOpt('policy_default_rule', default='default', @@ -84,7 +84,7 @@ def set_defaults(conf, policy_file=None): :param conf: Configuration object, managed by the caller. :type conf: oslo.config.cfg.ConfigOpts - :param policy_file: The base filename for the JSON file that + :param policy_file: The base filename for the file that defines policies. :type policy_file: unicode """ diff --git a/oslo_policy/policy.py b/oslo_policy/policy.py index 342bf01..9337280 100644 --- a/oslo_policy/policy.py +++ b/oslo_policy/policy.py @@ -584,7 +584,7 @@ class Enforcer(object): LOG.debug('Reloaded policy file: %(path)s', {'path': path}) def _get_policy_path(self, path): - """Locate the policy JSON data file/path. + """Locate the policy YAML/JSON data file/path. :param path: It's value can be a full path or related path. When full path specified, this function just returns the full |