[Boost-commit] svn:boost r60675 - trunk/libs/circular_buffer/doc

Subject: [Boost-commit] svn:boost r60675 - trunk/libs/circular_buffer/doc
From: jano_gaspar_at_[hidden]
Date: 2010-03-17 10:37:24

Author: jano_gaspar
Date: 2010-03-17 10:37:23 EDT (Wed, 17 Mar 2010)
New Revision: 60675
URL: http://svn.boost.org/trac/boost/changeset/60675

Log:
circular_buffer: documentation update - Interprocess compatibility
Text files modified: 
   trunk/libs/circular_buffer/doc/circular_buffer.html |    16 +++++++++++++++-                        
   1 files changed, 15 insertions(+), 1 deletions(-)

Modified: trunk/libs/circular_buffer/doc/circular_buffer.html
==============================================================================
--- trunk/libs/circular_buffer/doc/circular_buffer.html	(original)
+++ trunk/libs/circular_buffer/doc/circular_buffer.html	2010-03-17 10:37:23 EDT (Wed, 17 Mar 2010)
@@ -66,6 +66,9 @@
         <a href="#debug">Debug Support</a>
       </dt>
       <dt>
+        Compatibility with Interprocess library
+      </dt>
+      <dt>
         <a href="#examples">More Examples</a>
       </dt>
       <dt>
@@ -594,7 +597,18 @@
     </p>
     <p>
       The debug support is enabled only in the debug mode (when the <code>NDEBUG</code> is not defined). It can also be
-      explicitly disabled by defining <code>BOOST_CB_DISABLE_DEBUG</code> macro.
+      explicitly disabled (only for <code>circular_buffer</code>) by defining <code>BOOST_CB_DISABLE_DEBUG</code>
+      macro.
+    </p>
+    <h2>
+      <a name="intreprocess" id="interprocess">Compatibility with Interprocess library</a>
+    </h2>
+    <p>
+      The <code>circular_buffer</code> is compatible with the <a href="../../../doc/html/interprocess.html">Boost
+      Interprocess</a> library used for interprocess communication. Considering that the <code>circular_buffer</code>'s
+      debug support relies on 'raw' pointers - which is not permited by the Interprocess library - the code has to
+      compiled with <code>-DBOOST_CB_DISABLE_DEBUG</code> or </code>-DNDEBUG</code> (which disables the
+      Debug Support). Not doing that will cause the compilation to fail.
     </p>
     <h2>
       <a name="examples" id="examples">More Examples</a>