x/deb-oslo.concurrency
Code Issues Proposed changes

Improve lock_path help and documentation

Browse Source 
Improve help string to state default value and that it's mandatory.
Document set_defaults function.

DocImpact: Document that the value needs to evaluate to a valid path.
So, either environment variable is set or option is set.

Change-Id: I481d2f8107476ba166a18bc56d3b4c1be5ff726f
This commit is contained in:
Andreas Jaeger
2014-10-22 22:27:08 +02:00
parent 151297f333
commit 973fb2cd6b
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
oslo/concurrency/lockutils.py
View File

@@ -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)