Doc fixed
authorkhizmax <libcds.dev@gmail.com>
Sat, 23 May 2015 10:40:19 +0000 (13:40 +0300)
committerkhizmax <libcds.dev@gmail.com>
Sat, 23 May 2015 10:40:19 +0000 (13:40 +0300)
cds/container/michael_list_rcu.h
cds/intrusive/lazy_list_rcu.h
cds/intrusive/michael_list_rcu.h

index 6d0b5daf391952ced087744e5f5b6a02b9185a7d..b2a3fb700bb0e620fecadd05aa75263b30ddfc80 100644 (file)
@@ -517,8 +517,8 @@ namespace cds { namespace container {
             If the item with the key equal to \p key is not found the function returns an empty \p exempt_ptr.
 
             @note The function does NOT dispose the item found. It just excludes the item from the list
-            and returns a pointer to item found.
-            You shouldn't lock RCU before calling this function.
+            and returns a pointer to the item.
+            You shouldn't lock RCU for current thread before calling this function.
 
             \code
             #include <cds/urcu/general_buffered.h>
index bd76c69488273f2ef024afc667aa7d71d4dc79d9..7fdb2ba1d44e2105753ea23c58595f14da11398c 100644 (file)
@@ -496,7 +496,7 @@ namespace cds { namespace intrusive {
 
             The function returns \p true if success and \p false otherwise.
 
-            RCU \p synchronize method can be called.
+            RCU \p synchronize method can be called. The RCU should not be locked.
             Note that depending on RCU type used the \ref disposer call can be deferred.
 
             The function can throw cds::urcu::rcu_deadlock exception if deadlock is encountered and
@@ -513,7 +513,7 @@ namespace cds { namespace intrusive {
             unlinks it from the list, and returns \p true.
             If the item with the key equal to \p key is not found the function return \p false.
 
-            RCU \p synchronize method can be called.
+            RCU \p synchronize method can be called. The RCU should not be locked.
             Note that depending on RCU type used the \ref disposer call can be deferred.
 
             The function can throw \ref cds_urcu_rcu_deadlock "cds::urcu::rcu_deadlock" exception if deadlock is encountered and
@@ -552,7 +552,7 @@ namespace cds { namespace intrusive {
 
             If the item with the key equal to \p key is not found the function return \p false.
 
-            RCU \p synchronize method can be called.
+            RCU \p synchronize method can be called. The RCU should not be locked.
             Note that depending on RCU type used the \ref disposer call can be deferred.
 
             The function can throw \ref cds_urcu_rcu_deadlock "cds::urcu::rcu_deadlock" exception if deadlock is encountered and
index 4fd11dd9817b02849e5297c97720dad47264ca3f..e3473d2bdfe1c1e3b1bdaaa45f5dc6dd2b0651f0 100644 (file)
@@ -608,8 +608,8 @@ namespace cds { namespace intrusive {
 
             @note The function does NOT dispose the item found. It just unlinks the item from the list
             and returns a pointer to item found.
-            You shouldn't lock RCU before calling this function, and you should manually release
-            \p dest exempt pointer outside the RCU lock before reusing the pointer.
+            You shouldn't lock RCU for current thread before calling this function, and you should manually release
+            \p dest exempt pointer outside the RCU lock before reusing it.
 
             \code
             #include <cds/urcu/general_buffered.h>