doc/mgr/plugins: mgr accessor during init causes exception

Currently calling a mgr accessor during a plugins __init__ method causes
a cyclic locking exception.

Signed-off-by: Jan Fajerski <jfajerski@suse.com>

diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst
index b5a13cc3eada1b9ef4964b880a2c1cae706ad229..465f2cc0db221b48c6facac24483367eaf055a5b 100644 (file)
--- a/doc/mgr/plugins.rst
+++ b/doc/mgr/plugins.rst
@@ -97,6 +97,9 @@ have no metadata, or vice versa.  On a healthy cluster these
 will be very rare transient states, but plugins should be written
 to cope with the possibility.
 
+Note that these accessors must not be called in the modules ``__init__``
+function. This will result in a circular locking exception.
+
 ``get(self, data_name)``
 
 Fetch named cluster-wide objects such as the OSDMap.  Valid things