diff options
author | Jenkins <jenkins@review.openstack.org> | 2014-10-25 02:29:09 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2014-10-25 02:29:09 +0000 |
commit | 6c5f5bfb2bd552eaa85b850b46f3e5575c401a15 (patch) | |
tree | 079fb337d3732160ac941e5deecec51a9e2748a0 | |
parent | 660f6089979781be0f8941f3bb20b04afe8f226c (diff) | |
parent | 973fb2cd6bf3bc7dee5635dc345417522865f0c9 (diff) | |
download | oslo-concurrency-6c5f5bfb2bd552eaa85b850b46f3e5575c401a15.tar.gz |
Merge "Improve lock_path help and documentation"
-rw-r--r-- | oslo/concurrency/lockutils.py | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/oslo/concurrency/lockutils.py b/oslo/concurrency/lockutils.py index bd08fb1..4726fd5 100644 --- a/oslo/concurrency/lockutils.py +++ b/oslo/concurrency/lockutils.py @@ -44,7 +44,9 @@ _opts = [ default=os.environ.get("OSLO_LOCK_PATH"), help='Directory to use for lock files. For security, the ' 'specified directory should only be writable by the user ' - 'running the processes that need locking.', + 'running the processes that need locking. ' + 'Defaults to environment variable OSLO_LOCK_PATH. ' + 'If external locks are used, a lock path must be set.', deprecated_group='DEFAULT') ] @@ -54,6 +56,10 @@ CONF.register_opts(_opts, group='oslo_concurrency') def set_defaults(lock_path): + """Set value for lock_path. + + This can be used by tests to set lock_path to a temporary directory. + """ cfg.set_defaults(_opts, lock_path=lock_path) |