Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r60621 - in branches/release/libs/config: . doc doc/html doc/html/boost_config test
From: john_at_[hidden]
Date: 2010-03-15 13:53:54

Next message: john_at_[hidden]: "[Boost-commit] svn:boost r60622 - in branches/release/boost/config: . compiler platform"
Previous message: steven_at_[hidden]: "[Boost-commit] svn:boost r60620 - trunk/status"

Author: johnmaddock
Date: 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
New Revision: 60621
URL: http://svn.boost.org/trac/boost/changeset/60621

Log:
Merge doc updates from Trunk.
Properties modified:
   branches/release/libs/config/ (props changed)
Text files modified:
   branches/release/libs/config/doc/config.qbk | 2
   branches/release/libs/config/doc/guidelines.qbk | 18 ++++++++-----
   branches/release/libs/config/doc/html/boost_config/acknowledgements.html | 4 +-
   branches/release/libs/config/doc/html/boost_config/boost_macro_reference.html | 53 +++++++++++++++++++++++++++++++++++++--
   branches/release/libs/config/doc/html/boost_config/guidelines_for_boost_authors.html | 30 ++++++++++++----------
   branches/release/libs/config/doc/html/boost_config/rationale.html | 4 +-
   branches/release/libs/config/doc/html/index.html | 10 +++---
   branches/release/libs/config/doc/macro_reference.qbk | 30 +++++++++++++++++++++
   branches/release/libs/config/test/boost_no_integral_int64_t.ipp | 4 --
   9 files changed, 117 insertions(+), 38 deletions(-)

Modified: branches/release/libs/config/doc/config.qbk
==============================================================================
--- branches/release/libs/config/doc/config.qbk (original)
+++ branches/release/libs/config/doc/config.qbk 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
@@ -29,7 +29,7 @@
[/ Other web resources ]

[def __STL_PORT__ [@http://stlport.sourceforge.net STLport]]
-[def __BOOST_TRACKER__ [@http://sourceforge.net/tracker/?group_id=7586 Tracker]]
+[def __BOOST_TRACKER__ [@https://svn.boost.org/trac/boost/newticket Trac]]
[def __CORE_LANGUAGE_DR337__ [@http://www.open-std.org/jtc1/sc22/wg21/docs/cwg_defects.html#337 Core Language DR337]]
[def __PRINCIPLES_AND_PATTERNS_ARTICLE__ [@http://www.objectmentor.com/resources/articles/Principles_and_Patterns.pdf following article]]

Modified: branches/release/libs/config/doc/guidelines.qbk
==============================================================================
--- branches/release/libs/config/doc/guidelines.qbk (original)
+++ branches/release/libs/config/doc/guidelines.qbk 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
@@ -112,8 +112,8 @@
"`int test()`" that is declared in a namespace with the same name as the macro,
but in all lower case, and which returns zero on success:

- namespace boost_no_foo {

+ namespace boost_no_foo {
     int test()
     {
         // test code goes here:
@@ -126,14 +126,18 @@
Once the test code is in place in libs/config/test, updating the configuration
test system proceeds as:

-* cd into `libs/config/tools` and run `bjam` : this generates the `.cpp`
+* cd into `libs/config/tools` and run `bjam`. This generates the `.cpp`
file test cases from the `.ipp` file, updates the
-libs/config/test/all/Jamfile.v2, `config_test.cpp` and `config_info.cpp`.
-* cd into `libs/config/test/all` and run `bjam `['MACRONAME` compiler-list`] : where
+libs/config/test/all/Jamfile.v2, `config_test.cpp` and `config_info.cpp`.[br][br]
+
+* cd into `libs/config/test/all` and run `bjam `['MACRONAME` compiler-list`], where
['MACRONAME] is the name of the new macro, and ['`compiler-list`] is a space separated list of
-compilers to test with. You should see the tests pass with those compilers
-that don't have the defect, and fail with those that do.
-* cd into `libs/config/test` and run `bjam config_info config_test `['`compiler-list`] :
+compilers to test with.[br][br]
+The xxx_pass_test and the xxx_fail_test [*should both report `**passed**`].[br][br]
+If ['MACRONAME] is not defined when it should be defined, xxx_pass_test will not report `**passed**`.
+If ['MACRONAME] is defined when it should not be defined, xxx_fail_test will not report `**passed**`.[br][br]
+
+* cd into `libs/config/test` and run `bjam config_info config_test `['`compiler-list`].
`config_info` should build and run cleanly for all the compilers in ['`compiler-list`]
while `config_test` should fail for those that have the defect, and pass for those
that do not.

Modified: branches/release/libs/config/doc/html/boost_config/acknowledgements.html
==============================================================================
--- branches/release/libs/config/doc/html/boost_config/acknowledgements.html (original)
+++ branches/release/libs/config/doc/html/boost_config/acknowledgements.html 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
@@ -1,6 +1,6 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Acknowledgements</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
@@ -47,7 +47,7 @@
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock
+<td align="right"><div class="copyright-footer">Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock
 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)

Modified: branches/release/libs/config/doc/html/boost_config/boost_macro_reference.html
==============================================================================
--- branches/release/libs/config/doc/html/boost_config/boost_macro_reference.html (original)
+++ branches/release/libs/config/doc/html/boost_config/boost_macro_reference.html 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
@@ -1,6 +1,6 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Boost Macro Reference</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
@@ -2851,6 +2851,53 @@
<tr>
<td>
 
+ <code class="computeroutput">BOOST_WORKAROUND</code>
+ 
+ </td>
+<td>
+ 
+ This macro is used where a compiler specific workaround is required
+ that is not otherwise described by one of the other Boost.Config
+ macros. To use the macro you must first
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">#include <boost/detail/workaround.hpp>
+</pre>
+
+ usage is then:
+
+<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting">#if BOOST_WORKAROUND(MACRONAME, CONDITION)
+ // workaround code goes here...
+#else
+ // Standard conforming code goes here...
+#endif
+</pre>
+
+ where <code class="computeroutput">MACRONAME</code> is
+ a macro that usually describes the version number to be tested against,
+ and <code class="computeroutput">CONDITION</code> is
+ a comparison operator followed by a value. For example <code class="computeroutput">BOOST_WORKAROUND(BOOST_INTEL,
+ <= 1010)</code> would evaluate to <code class="computeroutput">1</code> for Intel C++ 10.1 and earlier.
+ 
+ 
+ The macro can also be used with <code class="computeroutput">BOOST_TESTED_AT</code>
+ if all current compiler versions exhibit the issue, but the issue
+ is expected to be fixed at some later point.
+ 
+ 
+ For example <code class="computeroutput">BOOST_WORKAROUND(__BORLANDC__, BOOST_TESTED_AT(0x590))</code> would normally evaluate to <code class="computeroutput">1</code> for all values of <code class="computeroutput">__BORLANDC__</code>
+ unless the macro <code class="computeroutput">BOOST_DETECT_OUTDATED_WORKAROUNDS</code>
+ is defined, in which case evaluates to <code class="computeroutput">(__BORLANDC__ <=
+ 0x590)</code>.
+ 
+ 
+ Note: the ultimate source of documentation
+ for this macro is in boost/detail/workaround.hpp.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
 <code class="computeroutput">BOOST_DEDUCED_TYPENAME</code>
 
 </td>
@@ -3160,7 +3207,7 @@
 </td>
<td>
 
- Describes the boost version number in XXYYZZ format such that: <code class="computeroutput">(BOOST_VERSION
+ Describes the boost version number in XYYYZZ format such that: <code class="computeroutput">(BOOST_VERSION
 % 100)</code> is the sub-minor version, <code class="computeroutput">((BOOST_VERSION
 / 100) % 1000)</code>
 is the minor version, and <code class="computeroutput">(BOOST_VERSION /
@@ -3534,7 +3581,7 @@
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock
+<td align="right"><div class="copyright-footer">Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock
 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)

Modified: branches/release/libs/config/doc/html/boost_config/guidelines_for_boost_authors.html
==============================================================================
--- branches/release/libs/config/doc/html/boost_config/guidelines_for_boost_authors.html (original)
+++ branches/release/libs/config/doc/html/boost_config/guidelines_for_boost_authors.html 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
@@ -1,6 +1,6 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Guidelines for Boost Authors</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
@@ -220,7 +220,6 @@
 on success:
 
<pre class="programlisting">namespace boost_no_foo {
-
int test()
{
 // test code goes here:
@@ -236,24 +235,27 @@
 
<div class="itemizedlist"><ul type="disc">
<li>
- cd into <code class="computeroutput">libs/config/tools</code> and run <code class="computeroutput">bjam</code>
- : this generates the <code class="computeroutput">.cpp</code>
+ cd into <code class="computeroutput">libs/config/tools</code> and run <code class="computeroutput">bjam</code>.
+ This generates the <code class="computeroutput">.cpp</code>
 file test cases from the <code class="computeroutput">.ipp</code> file, updates the libs/config/test/all/Jamfile.v2,
- <code class="computeroutput">config_test.cpp</code> and <code class="computeroutput">config_info.cpp</code>.
- </li>
+ <code class="computeroutput">config_test.cpp</code> and <code class="computeroutput">config_info.cpp</code>. 
+</li>
<li>
 cd into <code class="computeroutput">libs/config/test/all</code> and run <code class="computeroutput">bjam
- </code>MACRONAME<code class="computeroutput"> compiler-list</code>
- : where MACRONAME is the name of the new macro, and
+ </code>MACRONAME<code class="computeroutput"> compiler-list</code>,
+ where MACRONAME is the name of the new macro, and
 <code class="computeroutput">compiler-list</code> is a space separated
- list of compilers to test with. You should see the tests pass with those
- compilers that don't have the defect, and fail with those that do.
- </li>
+ list of compilers to test with. The xxx_pass_test and the
+ xxx_fail_test should both report <code class="computeroutput">**passed**</code>. If MACRONAME is not defined when it should
+ be defined, xxx_pass_test will not report <code class="computeroutput">**passed**</code>.
+ If MACRONAME is defined when it should not be defined,
+ xxx_fail_test will not report <code class="computeroutput">**passed**</code>. 
+</li>
<li>
 cd into <code class="computeroutput">libs/config/test</code> and run <code class="computeroutput">bjam
 config_info config_test
- </code><code class="computeroutput">compiler-list</code>
- : <code class="computeroutput">config_info</code> should build
+ </code><code class="computeroutput">compiler-list</code>.
+ <code class="computeroutput">config_info</code> should build
 and run cleanly for all the compilers in <code class="computeroutput">compiler-list</code>
 while <code class="computeroutput">config_test</code> should
 fail for those that have the defect, and pass for those that do not.
@@ -358,7 +360,7 @@
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock
+<td align="right"><div class="copyright-footer">Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock
 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)

Modified: branches/release/libs/config/doc/html/boost_config/rationale.html
==============================================================================
--- branches/release/libs/config/doc/html/boost_config/rationale.html (original)
+++ branches/release/libs/config/doc/html/boost_config/rationale.html 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
@@ -1,6 +1,6 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Rationale</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
@@ -121,7 +121,7 @@
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
-<td align="right"><div class="copyright-footer">Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock
+<td align="right"><div class="copyright-footer">Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock
 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)

Modified: branches/release/libs/config/doc/html/index.html
==============================================================================
--- branches/release/libs/config/doc/html/index.html (original)
+++ branches/release/libs/config/doc/html/index.html 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
@@ -1,6 +1,6 @@
<html>
<head>
-<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Boost.Config</title>
<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
@@ -26,9 +26,9 @@
<div><div class="authorgroup"><div class="author"><h3 class="author">
Vesa Karvonen, John Maddock Beman Dawes
</h3></div></div></div>
-<div>Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock</div>
+<div>Copyright © 2001 -2007 Beman Dawes, Vesa Karvonen, John Maddock</div>
<div><div class="legalnotice">
-<a name="id770460"></a>
+<a name="id793416"></a>
 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)
 
@@ -131,7 +131,7 @@
 

 Boost library users can request support for additional compilers or platforms
- by visiting our Tracker
+ by visiting our Trac
 and submitting a support request.
 
</div>
@@ -960,7 +960,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: August 06, 2009 at 09:16:56 GMT</td>
+<td align="left">Last revised: March 02, 2010 at 17:08:14 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: branches/release/libs/config/doc/macro_reference.qbk
==============================================================================
--- branches/release/libs/config/doc/macro_reference.qbk (original)
+++ branches/release/libs/config/doc/macro_reference.qbk 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
@@ -633,6 +633,34 @@
[table
[[Macro ][Description ]]

+[[`BOOST_WORKAROUND`][
+This macro is used where a compiler specific workaround is required that is not otherwise
+described by one of the other Boost.Config macros. To use the macro you must first
+``
+#include <boost/detail/workaround.hpp>
+``
+usage is then:
+``
+#if BOOST_WORKAROUND(MACRONAME, CONDITION)
+ // workaround code goes here...
+#else
+ // Standard conforming code goes here...
+#endif
+``
+where `MACRONAME` is a macro that usually describes the version number to be tested against, and `CONDITION`
+is a comparison operator followed by a value. For example `BOOST_WORKAROUND(BOOST_INTEL, <= 1010)` would
+evaluate to `1` for Intel C++ 10.1 and earlier.
+
+The macro can also be used with `BOOST_TESTED_AT` if all
+current compiler versions exhibit the issue, but the issue is expected to be fixed at some later point.
+
+For example
+`BOOST_WORKAROUND(__BORLANDC__, BOOST_TESTED_AT(0x590))` would normally evaluate to `1` for all values
+of `__BORLANDC__` /unless/ the macro `BOOST_DETECT_OUTDATED_WORKAROUNDS` is defined, in which case evaluates to
+`(__BORLANDC__ <= 0x590)`.
+
+[*Note]: the ultimate source of documentation for this macro is in [@../../../../boost/detail/workaround.hpp boost/detail/workaround.hpp].
+]]
[[`BOOST_DEDUCED_TYPENAME`][
Some compilers don't support the use of typename for dependent types in deduced
contexts. This macro expands to nothing on those compilers, and typename
@@ -778,7 +806,7 @@
[[Macro ][Header ][Description ]]

[[`BOOST_VERSION`][`<boost/version.hpp>`][
-Describes the boost version number in XXYYZZ format such that:
+Describes the boost version number in XYYYZZ format such that:
`(BOOST_VERSION % 100)` is the sub-minor version, `((BOOST_VERSION / 100) % 1000)`
is the minor version, and `(BOOST_VERSION / 100000)` is the major version.
]]

Modified: branches/release/libs/config/test/boost_no_integral_int64_t.ipp
==============================================================================
--- branches/release/libs/config/test/boost_no_integral_int64_t.ipp (original)
+++ branches/release/libs/config/test/boost_no_integral_int64_t.ipp 2010-03-15 13:53:53 EDT (Mon, 15 Mar 2010)
@@ -43,9 +43,7 @@

int test()
{
- llt<mask> m;
- (void)m;
- return 0;
+ return llt<mask>::value != (1uLL << 50);
}

}

Next message: john_at_[hidden]: "[Boost-commit] svn:boost r60622 - in branches/release/boost/config: . compiler platform"
Previous message: steven_at_[hidden]: "[Boost-commit] svn:boost r60620 - trunk/status"

Date view	Thread view	Subject view	Author view

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