Improved docs

diff --git a/cds/intrusive/lazy_list_rcu.h b/cds/intrusive/lazy_list_rcu.h
index 1981bc542d0e29f107cd698400ab8b091de1f510..244e42865ca5f6e23b50cfdd6e318354ed796fe2 100644 (file)
--- a/cds/intrusive/lazy_list_rcu.h
+++ b/cds/intrusive/lazy_list_rcu.h
@@ -352,7 +352,7 @@ namespace cds { namespace intrusive {
         //@endcond
 
     public:
-    ///@name Forward iterators (only for debugging purpose)
+    ///@name Forward iterators (thread-safe only under RCU lock)
     //@{
         /// Forward iterator
         /**

diff --git a/cds/intrusive/michael_list_rcu.h b/cds/intrusive/michael_list_rcu.h
index ed21242bcf5042c10ffb616635169b642e5b346d..b19cf84a2f0d12e1af5280089ca5fb61eb47aff2 100644 (file)
--- a/cds/intrusive/michael_list_rcu.h
+++ b/cds/intrusive/michael_list_rcu.h
@@ -371,7 +371,7 @@ namespace cds { namespace intrusive {
         //@endcond
 
     public:
-    ///@name Forward iterators (only for debugging purpose)
+    ///@name Forward iterators (thread-safe only under RCU lock)
     //@{
         /// Forward iterator
         /**

diff --git a/cds/intrusive/michael_set_rcu.h b/cds/intrusive/michael_set_rcu.h
index bda744f36658ea1b8ed56ee5feefb2b520299174..867191e7bf35150dd58773f764fea5bdf32e17f9 100644 (file)
--- a/cds/intrusive/michael_set_rcu.h
+++ b/cds/intrusive/michael_set_rcu.h
@@ -156,7 +156,7 @@ namespace cds { namespace intrusive {
         //@endcond
 
     public:
-    ///@name Forward iterators (only for debugging purpose)
+    ///@name Forward iterators (thread-safe only under RCU lock)
     //@{
         /// Forward iterator
         /**
@@ -164,7 +164,8 @@ namespace cds { namespace intrusive {
             - it has no post-increment operator
             - it iterates items in unordered fashion
 
-            @warning Use this iterator on the concurrent container for debugging purpose only.
+            You may safely use iterators in multi-threaded environment only under RCU lock.
+            Otherwise, a crash is possible if another thread deletes the element the iterator points to.
         */
         typedef michael_set::details::iterator< bucket_type, false >    iterator;