[Boost-commit] svn:boost r81737 - trunk/libs/atomic/doc

Subject: [Boost-commit] svn:boost r81737 - trunk/libs/atomic/doc
From: tim_at_[hidden]
Date: 2012-12-06 07:35:43

Author: timblechmann
Date: 2012-12-06 07:35:42 EST (Thu, 06 Dec 2012)
New Revision: 81737
URL: http://svn.boost.org/trac/boost/changeset/81737

Log:
atomic: update documentation
Text files modified: 
   trunk/libs/atomic/doc/atomic.qbk |     7 +++++++                                 
   1 files changed, 7 insertions(+), 0 deletions(-)

Modified: trunk/libs/atomic/doc/atomic.qbk
==============================================================================
--- trunk/libs/atomic/doc/atomic.qbk	(original)
+++ trunk/libs/atomic/doc/atomic.qbk	2012-12-06 07:35:42 EST (Thu, 06 Dec 2012)
@@ -9,6 +9,7 @@
     [quickbook 1.4]
     [authors [Bahmann, Helge]]
     [copyright 2011 Helge Bahmann]
+    [copyright 2012 Tim Blechmann]
     [id atomic]
     [dirname atomic]
     [purpose Atomic operations]
@@ -415,6 +416,10 @@
       [Initialize to [^initial_value]]
     ]
     [
+      [`bool is_lock_free()`]
+      [Checks if the atomic object is lock-free]
+    ]
+    [
       [`T load(memory_order order)`]
       [Return current value]
     ]
@@ -645,6 +650,8 @@
   as "full compiler barriers" in this implementation. In corner
   cases this may lead to worse code than a C++11 compiler
   could generate.
+* [*No interprocess fallback]: using `atomic<T>` in shared memory only works
+  correctly, if `atomic<T>::is_lock_free == true`
 
 [endsect]