Subject: [Boost-commit] svn:boost r49019 - in sandbox/thread_safe_signals/trunk/libs/signals2/doc: . reference
From: fmhess_at_[hidden]
Date: 2008-09-29 14:14:18
Author: fmhess
Date: 2008-09-29 14:14:17 EDT (Mon, 29 Sep 2008)
New Revision: 49019
URL: http://svn.boost.org/trac/boost/changeset/49019
Log:
Updated docs with respect to rename of
signals2::lightweight_mutex to signals2::mutex
Added:
sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/mutex.xml
- copied, changed from r48979, /sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/lightweight_mutex.xml
Removed:
sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/lightweight_mutex.xml
Text files modified:
sandbox/thread_safe_signals/trunk/libs/signals2/doc/Makefile | 2 +-
sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/mutex.xml | 17 +++++++++--------
sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/reference.xml | 2 +-
sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/signal_header.xml | 4 ++--
4 files changed, 13 insertions(+), 12 deletions(-)
Modified: sandbox/thread_safe_signals/trunk/libs/signals2/doc/Makefile
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/Makefile (original)
+++ sandbox/thread_safe_signals/trunk/libs/signals2/doc/Makefile 2008-09-29 14:14:17 EDT (Mon, 29 Sep 2008)
@@ -15,7 +15,7 @@
reference/deconstruct_ptr.xml \
reference/dummy_mutex.xml \
reference/last_value.xml \
- reference/lightweight_mutex.xml \
+ reference/mutex.xml \
reference/postconstructible.xml \
reference/predestructible.xml \
reference/reference.xml \
Deleted: sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/lightweight_mutex.xml
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/lightweight_mutex.xml 2008-09-29 14:14:17 EDT (Mon, 29 Sep 2008)
+++ (empty file)
@@ -1,63 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE header PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
- "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
-<header name="boost/signals2/lightweight_mutex.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
- <using-namespace name="boost"/>
- <using-namespace name="boost::signals2"/>
- <namespace name="boost">
- <namespace name="signals2">
- <class name="lightweight_mutex">
- <purpose>A header-only mutex which implements the Lockable concept of Boost.Thread.</purpose>
-
- <description>
- <para>
- The <code>lightweight mutex</code> class implements the <code>Lockable</code>
- concept of Boost.Thread, and is the default <code>Mutex</code> type for signals.
- If boost has detected thread support in the compiler's current
- translation mode, lightweight mutex will map to a CRITICAL_SECTION on Windows
- or a pthread_mutex on POSIX. If thread support is not detected, lightweight_mutex
- will behave similarly to a <classname>dummy_mutex</classname>.
- The header file <code>boost/config.hpp</code>
- defines the macro BOOST_HAS_THREADS when boost detects threading support.
- The user may globally disable thread support
- in boost by defining BOOST_DISABLE_THREADS before any boost header files are included.
- </para>
- <para>
- If you are already using the Boost.Thread library, you may prefer to use its
- <classname>boost::mutex</classname> class as the mutex type for your signals.
- </para>
- <para>
- You may wish to use a thread-unsafe signal in a multi-threaded program, if
- the signal is only used by a single thread. In that case, you may prefer to
- use the <classname>dummy_mutex</classname> class as the <code>Mutex</code>
- template type for your signal.
- </para>
- </description>
- <access name="public">
- <method name="lock">
- <type>void</type>
- <description>
- <para>Locks the mutex.
- </para>
- </description>
- </method>
- <method name="try_lock">
- <type>bool</type>
- <description>
- <para>Makes a non-blocking attempt to lock the mutex.
- </para>
- </description>
- <returns><para><code>true</code> on success.</para></returns>
- </method>
- <method name="unlock">
- <type>void</type>
- <description>
- <para>Unlocks the mutex.
- </para>
- </description>
- </method>
- </access>
- </class>
- </namespace>
- </namespace>
-</header>
Copied: sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/mutex.xml (from r48979, /sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/lightweight_mutex.xml)
==============================================================================
--- /sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/lightweight_mutex.xml (original)
+++ sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/mutex.xml 2008-09-29 14:14:17 EDT (Mon, 29 Sep 2008)
@@ -1,30 +1,31 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE header PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
-<header name="boost/signals2/lightweight_mutex.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
+<header name="boost/signals2/mutex.hpp" last-revision="$Date: 2007-03-06 16:51:55 -0500 (Tue, 06 Mar 2007) $">
<using-namespace name="boost"/>
<using-namespace name="boost::signals2"/>
<namespace name="boost">
<namespace name="signals2">
- <class name="lightweight_mutex">
+ <class name="mutex">
<purpose>A header-only mutex which implements the Lockable concept of Boost.Thread.</purpose>
<description>
<para>
- The <code>lightweight mutex</code> class implements the <code>Lockable</code>
- concept of Boost.Thread, and is the default <code>Mutex</code> type for signals.
+ The <code>mutex</code> class implements the <code>Lockable</code>
+ concept of Boost.Thread, and is the default <code>Mutex</code> template parameter
+ type for signals.
If boost has detected thread support in the compiler's current
- translation mode, lightweight mutex will map to a CRITICAL_SECTION on Windows
- or a pthread_mutex on POSIX. If thread support is not detected, lightweight_mutex
+ translation mode, mutex will map to a CRITICAL_SECTION on Windows
+ or a pthread_mutex on POSIX. If thread support is not detected, <code>mutex</code>
will behave similarly to a <classname>dummy_mutex</classname>.
The header file <code>boost/config.hpp</code>
- defines the macro BOOST_HAS_THREADS when boost detects threading support.
+ defines the macro <code>BOOST_HAS_THREADS</code> when boost detects threading support.
The user may globally disable thread support
in boost by defining BOOST_DISABLE_THREADS before any boost header files are included.
</para>
<para>
If you are already using the Boost.Thread library, you may prefer to use its
- <classname>boost::mutex</classname> class as the mutex type for your signals.
+ <classname>boost::mutex</classname> class instead as the mutex type for your signals.
</para>
<para>
You may wish to use a thread-unsafe signal in a multi-threaded program, if
Modified: sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/reference.xml
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/reference.xml (original)
+++ sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/reference.xml 2008-09-29 14:14:17 EDT (Mon, 29 Sep 2008)
@@ -17,7 +17,7 @@
<xi:include href="connection.xml"/>
<xi:include href="shared_connection_block.xml"/>
<xi:include href="last_value.xml"/>
- <xi:include href="lightweight_mutex.xml"/>
+ <xi:include href="mutex.xml"/>
<xi:include href="dummy_mutex.xml"/>
<xi:include href="deconstruct_ptr.xml"/>
<xi:include href="postconstructible.xml"/>
Modified: sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/signal_header.xml
==============================================================================
--- sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/signal_header.xml (original)
+++ sandbox/thread_safe_signals/trunk/libs/signals2/doc/reference/signal_header.xml 2008-09-29 14:14:17 EDT (Mon, 29 Sep 2008)
@@ -30,7 +30,7 @@
<default><classname>functionN</classname><R, T1, T2, ..., TN></default>
</template-type-parameter>
<template-type-parameter name="Mutex">
- <default><classname>lightweight_mutex</classname></default>
+ <default><classname>mutex</classname></default>
</template-type-parameter>
</template>
<inherit access="public">
@@ -349,7 +349,7 @@
<default><classname>function</classname><Signature></default>
</template-type-parameter>
<template-type-parameter name="Mutex">
- <default><classname>lightweight_mutex</classname></default>
+ <default><classname>mutex</classname></default>
</template-type-parameter>
</template>