|
Boost-Commit : |
From: anthony_at_[hidden]
Date: 2008-07-23 05:37:04
Author: anthonyw
Date: 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
New Revision: 47701
URL: http://svn.boost.org/trac/boost/changeset/47701
Log:
Merged thread doc changes from trunk
Text files modified:
branches/release/libs/thread/doc/acknowledgements.qbk | 7 +++++++
branches/release/libs/thread/doc/barrier.qbk | 7 +++++++
branches/release/libs/thread/doc/changes.qbk | 7 +++++++
branches/release/libs/thread/doc/condition_variables.qbk | 13 +++++++++++++
branches/release/libs/thread/doc/mutex_concepts.qbk | 7 +++++++
branches/release/libs/thread/doc/mutexes.qbk | 7 +++++++
branches/release/libs/thread/doc/once.qbk | 11 +++++++++--
branches/release/libs/thread/doc/overview.qbk | 7 +++++++
branches/release/libs/thread/doc/shared_mutex_ref.qbk | 7 +++++++
branches/release/libs/thread/doc/thread.qbk | 7 +++++++
branches/release/libs/thread/doc/thread_ref.qbk | 7 +++++++
branches/release/libs/thread/doc/time.qbk | 7 +++++++
branches/release/libs/thread/doc/tss.qbk | 7 +++++++
13 files changed, 99 insertions(+), 2 deletions(-)
Modified: branches/release/libs/thread/doc/acknowledgements.qbk
==============================================================================
--- branches/release/libs/thread/doc/acknowledgements.qbk (original)
+++ branches/release/libs/thread/doc/acknowledgements.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:acknowledgements Acknowledgments]
The original implementation of __boost_thread__ was written by William Kempf, with contributions from numerous others. This new
Modified: branches/release/libs/thread/doc/barrier.qbk
==============================================================================
--- branches/release/libs/thread/doc/barrier.qbk (original)
+++ branches/release/libs/thread/doc/barrier.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:barriers Barriers]
A barrier is a simple concept. Also known as a ['rendezvous], it is a synchronization point between multiple threads. The barrier is
Modified: branches/release/libs/thread/doc/changes.qbk
==============================================================================
--- branches/release/libs/thread/doc/changes.qbk (original)
+++ branches/release/libs/thread/doc/changes.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:changes Changes since boost 1.34]
Almost every line of code in __boost_thread__ has been changed since the 1.34 release of boost. However, most of the interface
Modified: branches/release/libs/thread/doc/condition_variables.qbk
==============================================================================
--- branches/release/libs/thread/doc/condition_variables.qbk (original)
+++ branches/release/libs/thread/doc/condition_variables.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:condvar_ref Condition Variables]
[heading Synopsis]
@@ -75,6 +82,9 @@
condition_variable();
~condition_variable();
+ void notify_one();
+ void notify_all();
+
void wait(boost::unique_lock<boost::mutex>& lock);
template<typename predicate_type>
@@ -292,6 +302,9 @@
condition_variable_any();
~condition_variable_any();
+ void notify_one();
+ void notify_all();
+
template<typename lock_type>
void wait(lock_type& lock);
Modified: branches/release/libs/thread/doc/mutex_concepts.qbk
==============================================================================
--- branches/release/libs/thread/doc/mutex_concepts.qbk (original)
+++ branches/release/libs/thread/doc/mutex_concepts.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:mutex_concepts Mutex Concepts]
A mutex object facilitates protection against data races and allows thread-safe synchronization of data between threads. A thread
Modified: branches/release/libs/thread/doc/mutexes.qbk
==============================================================================
--- branches/release/libs/thread/doc/mutexes.qbk (original)
+++ branches/release/libs/thread/doc/mutexes.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:mutex_types Mutex Types]
[section:mutex Class `mutex`]
Modified: branches/release/libs/thread/doc/once.qbk
==============================================================================
--- branches/release/libs/thread/doc/once.qbk (original)
+++ branches/release/libs/thread/doc/once.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:once One-time Initialization]
`boost::call_once` provides a mechanism for ensuring that an initialization routine is run exactly once without data races or deadlocks.
@@ -24,8 +31,8 @@
be equivalent to calling the original. ]]
[[Effects:] [Calls to `call_once` on the same `once_flag` object are serialized. If there has been no prior effective `call_once` on
-the same `once_flag` object, the argument `func` (or a copy thereof) is called as-if by invoking `func(args)`, and the invocation of
-`call_once` is effective if and only if `func(args)` returns without exception. If an exception is thrown, the exception is
+the same `once_flag` object, the argument `func` (or a copy thereof) is called as-if by invoking `func()`, and the invocation of
+`call_once` is effective if and only if `func()` returns without exception. If an exception is thrown, the exception is
propagated to the caller. If there has been a prior effective `call_once` on the same `once_flag` object, the `call_once` returns
without invoking `func`. ]]
Modified: branches/release/libs/thread/doc/overview.qbk
==============================================================================
--- branches/release/libs/thread/doc/overview.qbk (original)
+++ branches/release/libs/thread/doc/overview.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:overview Overview]
__boost_thread__ enables the use of multiple threads of execution with shared data in portable C++ code. It provides classes and
Modified: branches/release/libs/thread/doc/shared_mutex_ref.qbk
==============================================================================
--- branches/release/libs/thread/doc/shared_mutex_ref.qbk (original)
+++ branches/release/libs/thread/doc/shared_mutex_ref.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:shared_mutex Class `shared_mutex`]
class shared_mutex
Modified: branches/release/libs/thread/doc/thread.qbk
==============================================================================
--- branches/release/libs/thread/doc/thread.qbk (original)
+++ branches/release/libs/thread/doc/thread.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[article Thread
[quickbook 1.4]
[authors [Williams, Anthony]]
Modified: branches/release/libs/thread/doc/thread_ref.qbk
==============================================================================
--- branches/release/libs/thread/doc/thread_ref.qbk (original)
+++ branches/release/libs/thread/doc/thread_ref.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:thread_management Thread Management]
[heading Synopsis]
Modified: branches/release/libs/thread/doc/time.qbk
==============================================================================
--- branches/release/libs/thread/doc/time.qbk (original)
+++ branches/release/libs/thread/doc/time.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section:time Date and Time Requirements]
As of Boost 1.35.0, the __boost_thread__ library uses the [link date_time Boost.Date_Time] library for all operations that require a
Modified: branches/release/libs/thread/doc/tss.qbk
==============================================================================
--- branches/release/libs/thread/doc/tss.qbk (original)
+++ branches/release/libs/thread/doc/tss.qbk 2008-07-23 05:37:02 EDT (Wed, 23 Jul 2008)
@@ -1,3 +1,10 @@
+[/
+ (C) Copyright 2007-8 Anthony Williams.
+ Distributed under the Boost Software License, Version 1.0.
+ (See accompanying file LICENSE_1_0.txt or copy at
+ http://www.boost.org/LICENSE_1_0.txt).
+]
+
[section Thread Local Storage]
[heading Synopsis]
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk