summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoshua Harlow <harlowja@yahoo-inc.com>2015-01-23 10:55:19 -0800
committerJoshua Harlow <harlowja@yahoo-inc.com>2015-02-10 12:57:28 -0800
commited4e2d775a56b9d47ed314f96dccd9221a91e241 (patch)
tree1ab7ebc4fd7128b0ce60ca0433784092bca0d063 /doc
parentff05ecc7ea8e0ab4f7eb9c88a0de105ddd23f1a1 (diff)
downloadoslo-utils-ed4e2d775a56b9d47ed314f96dccd9221a91e241.tar.gz
Add a eventlet utils helper module
When greenthreads are being used (and/or eventlet is available and some modules have been monkey-patched) emit warnings to the users that certain modules should be monkey-patched and if they are not then spurious or unexpected lock-ups and/or hangs may result due to this type of mixed usage which doesn't typically end well. This commit adds that functionality to a new eventlet utils module that can be used by calling code when that code really knows it will not work without modules being patched or partially being patched. Change-Id: I9a856fc0a6502b438c8da9b2f589154a6fa89a9f
Diffstat (limited to 'doc')
-rw-r--r--doc/source/api/eventletutils.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/source/api/eventletutils.rst b/doc/source/api/eventletutils.rst
new file mode 100644
index 0000000..5e7a39a
--- /dev/null
+++ b/doc/source/api/eventletutils.rst
@@ -0,0 +1,6 @@
+===============
+ eventletutils
+===============
+
+.. automodule:: oslo_utils.eventletutils
+ :members: