From: khizmax <libcds.dev@gmail.com> Date: Sat, 23 May 2015 10:40:19 +0000 (+0300) Subject: Doc fixed X-Git-Tag: v2.1.0~227 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=e02af3a092829713e500c390da641eecc61dd985;p=libcds.git Doc fixed --- diff --git a/cds/container/michael_list_rcu.h b/cds/container/michael_list_rcu.h index 6d0b5daf..b2a3fb70 100644 --- a/cds/container/michael_list_rcu.h +++ b/cds/container/michael_list_rcu.h @@ -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> diff --git a/cds/intrusive/lazy_list_rcu.h b/cds/intrusive/lazy_list_rcu.h index bd76c694..7fdb2ba1 100644 --- a/cds/intrusive/lazy_list_rcu.h +++ b/cds/intrusive/lazy_list_rcu.h @@ -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 diff --git a/cds/intrusive/michael_list_rcu.h b/cds/intrusive/michael_list_rcu.h index 4fd11dd9..e3473d2b 100644 --- a/cds/intrusive/michael_list_rcu.h +++ b/cds/intrusive/michael_list_rcu.h @@ -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>