oslo.concurrency/doc/source/usage.rst
Doug Hellmann d59543df4a Clean up API documentation
Use explicit files instead of auto-generating them.

Fail the build on a warning.

Tweak titles and other headings.

Add instructions for using lockutils-wrapper.

Change-Id: Ie92ce14b33180d35d84bbd0998e61b659487481d
2014-12-10 08:31:04 -05:00

555 B

Usage

To use oslo.concurrency in a project, import the relevant module. For example:

from oslo_concurrency import lockutils
  • API Documentation <api/index>

Command Line Wrapper

oslo.concurrency includes a command line tool for use in test jobs that need the environment variable OSLO_LOCK_PATH set. To use it, prefix the command to be run with lockutils-wrapper. For example:

$ lockutils-wrapper env | grep OSLO_LOCK_PATH
OSLO_LOCK_PATH=/tmp/tmpbFHK45