From 662b7ff80036ba924538cdab2b14f8119c8977cc Mon Sep 17 00:00:00 2001 From: Marshall Clow Date: Thu, 8 Mar 2012 15:42:11 +0000 Subject: [PATCH] Updated the Quickbook to show macro changes; regenerated the HTML docs [SVN r77264] --- doc/html/boost_config/acknowledgements.html | 4 +- .../boost_config/boost_macro_reference.html | 467 ++++++++++++------ .../guidelines_for_boost_authors.html | 12 +- doc/html/boost_config/rationale.html | 8 +- doc/html/index.html | 30 +- doc/macro_reference.qbk | 70 ++- 6 files changed, 402 insertions(+), 189 deletions(-) diff --git a/doc/html/boost_config/acknowledgements.html b/doc/html/boost_config/acknowledgements.html index 8286d72d..17e711df 100644 --- a/doc/html/boost_config/acknowledgements.html +++ b/doc/html/boost_config/acknowledgements.html @@ -3,7 +3,7 @@ Acknowledgements - + @@ -21,7 +21,7 @@
PrevUpHome
-
+
diff --git a/doc/html/boost_config/boost_macro_reference.html b/doc/html/boost_config/boost_macro_reference.html index e344acf0..afc8d52f 100644 --- a/doc/html/boost_config/boost_macro_reference.html +++ b/doc/html/boost_config/boost_macro_reference.html @@ -3,7 +3,7 @@ Boost Macro Reference - + @@ -22,7 +22,7 @@
PrevUpHomeNext
-
+ -
+

Macros that describe C++03 defects @@ -315,7 +317,7 @@

The compiler fails to compile a nested class that has a dependent - base class: + base class:

template<typename T>
 struct foo : {
@@ -341,9 +343,8 @@
 
                 

Template value parameters cannot have a dependent type, for example: -

-
template<class T, typename T::type value> 
+
template<class T, typename T::type value>
 class X { ... };
 

@@ -422,7 +423,7 @@

The compiler does not perform function template ordering or its - function template ordering is incorrect. + function template ordering is incorrect.

// #1
 template<class T> void f(T);
@@ -1314,7 +1315,7 @@
 
                 

The compiler does not allow a void function to return the result - of calling another void function. + of calling another void function.

void f() {}
 void g() { return f(); }
@@ -1326,7 +1327,7 @@
 
 

-
+
-
+
-
+
-
+

Macros that allow use of C++11 features with C++03 compilers @@ -2906,12 +2907,12 @@

Some compilers don't support the use of constexpr. This macro expands to nothing on those compilers, and constexpr elsewhere. For example, - when defining a constexpr function or constructor replace: + when defining a constexpr function or constructor replace:

constexpr tuple();
 

- with: + with:

BOOST_CONSTEXPR tuple();
 
@@ -2931,12 +2932,11 @@ This macro expands to const on those compilers, and constexpr elsewhere. For example, when defining const expr variables replace: -

static constexpr UIntType xor_mask = a;
 

- with: + with:

static BOOST_CONSTEXPR_OR_CONST UIntType xor_mask = a;
 
@@ -2954,12 +2954,12 @@

This is a shortcut for static BOOST_CONSTEXPR_OR_CONSTFor - example, when defining const expr variables replace: + example, when defining const expr variables replace:

static constexpr UIntType xor_mask = a;
 

- with: + with:

BOOST_STATIC_CONSTEXPR UIntType xor_mask = a;
 
@@ -2970,7 +2970,6 @@

-

BOOST_NOEXCEPT
 BOOST_NOEXCEPT_IF(Predicate)
@@ -2987,7 +2986,6 @@
                 

-

#define BOOST_NOEXCEPT
 #define BOOST_NOEXCEPT_IF(Predicate)
@@ -3003,7 +3001,6 @@
                 

-

#define BOOST_NOEXCEPT noexcept
 #define BOOST_NOEXCEPT_IF(Predicate) noexcept((Predicate))
@@ -3017,7 +3014,7 @@
 
 
-
+

Boost Helper Macros @@ -3054,12 +3051,12 @@

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 + macros. To use the macro you must first

#include <boost/detail/workaround.hpp>
 

- usage is then: + usage is then:

#if BOOST_WORKAROUND(MACRONAME, CONDITION)
    // workaround code goes here...
@@ -3102,12 +3099,12 @@
                   Sometimes you have a function name with the same name as a C macro,
                   for example "min" and "max" member functions,
                   in which case one can prevent the function being expanded as a
-                  macro using: 
+                  macro using:
 

someclass.min BOOST_PREVENT_MACRO_SUBSTITUTION(arg1, arg2);
 

- The following also works in most, but not all, contexts: + The following also works in most, but not all, contexts:

(someclass.max)(arg1, arg2);
 
@@ -3202,14 +3199,14 @@ integral constant members, we must use enums as a workaround if we want the constants to be available at compile-time. This macro gives us a convenient way to declare such constants. For example - instead of: + instead of:

struct foo{
    static const int value = 2;
 };
 

- use: + use:

struct foo{
    BOOST_STATIC_CONSTANT(int, value = 2);
@@ -3242,7 +3239,7 @@
                 

Some compilers silently "fold" different function template instantiations if some of the template parameters don't appear - in the function parameter list. For instance: + in the function parameter list. For instance:

#include <iostream>
 #include <ostream>
@@ -3266,7 +3263,7 @@
                   incorrectly outputs 2 2 double double on VC++
                   6. These macros, to be used in the function parameter list, fix
                   the problem without effects on the calling syntax. For instance,
-                  in the case above write: 
+                  in the case above write:
 

template <int n>
 void f(BOOST_EXPLICIT_TEMPLATE_NON_TYPE(int, n)) { ... }
@@ -3392,7 +3389,7 @@
                   techniques.
                 

- Usage example: + Usage example:

template<class T>
 BOOST_FORCEINLINE T& f(T& t)
@@ -3413,7 +3410,7 @@
 
 

-
+

Boost Informational Macros @@ -3691,14 +3688,14 @@

+

- The following macros have been deprecated; their use is no longer recommended. - Please use the suggested replacements instead. - They will be removed in a future release of Boost. + The following have been deprecated; please use the replacements instead. + They will be removed in a future version of boost.

@@ -3707,170 +3704,350 @@ - - + + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - +

+ + + - - - +

+ + + - - - +

+ + + - - - +

+ + + - - - +

+ + +

Macro

Replacement

+

+ Deprecated Macro +

+
+

+ Replacement +

+
+

+ When deprecated +

+

+

+

BOOST_NO_0X_HDR_ARRAY -

- Use BOOST_NO_CXX11_HDR_ARRAY instead. -

+

+ BOOST_NO_CXX11_HDR_ARRAY +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_CHRONO -

- Use BOOST_NO_CXX11_HDR_CHRONO instead. -

+

+ BOOST_NO_CXX11_HDR_CHRONO +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_CODECVT -

- Use BOOST_NO_CXX11_HDR_CODECVT instead. -

+

+ BOOST_NO_CXX11_HDR_CODECVT +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_CONDITION_VARIABLE -

- Use BOOST_NO_CXX11_HDR_CONDITION_VARIABLE instead. -

+

+ BOOST_NO_CXX11_HDR_CONDITION_VARIABLE +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_FORWARD_LIST -

- Use BOOST_NO_CXX11_HDR_FORWARD_LIST instead. -

+

+ BOOST_NO_CXX11_HDR_FORWARD_LIST +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_FUTURE -

- Use BOOST_NO_CXX11_HDR_FUTURE instead. -

+

+ BOOST_NO_CXX11_HDR_FUTURE +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_INITIALIZER_LIST -

- Use BOOST_NO_CXX11_HDR_INITIALIZER_LIST instead. -

+

+ BOOST_NO_CXX11_HDR_INITIALIZER_LIST +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_INITIALIZER_LISTS -

- Use BOOST_NO_CXX11_HDR_INITIALIZER_LIST instead. -

+

+ BOOST_NO_CXX11_HDR_INITIALIZER_LIST +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_MUTEX -

- Use BOOST_NO_CXX11_HDR_MUTEX instead. -

+

+ BOOST_NO_CXX11_HDR_MUTEX +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_RANDOM -

- Use BOOST_NO_CXX11_HDR_RANDOM instead. -

+

+ BOOST_NO_CXX11_HDR_RANDOM +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_RATIO -

- Use BOOST_NO_CXX11_HDR_RATIO instead. -

+

+ BOOST_NO_CXX11_HDR_RATIO +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_REGEX -

- Use BOOST_NO_CXX11_HDR_REGEX instead. -

+

+ BOOST_NO_CXX11_HDR_REGEX +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_SYSTEM_ERROR -

- Use BOOST_NO_CXX11_HDR_SYSTEM_ERROR instead. -

+

+ BOOST_NO_CXX11_HDR_SYSTEM_ERROR +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_THREAD -

- Use BOOST_NO_CXX11_HDR_THREAD instead. -

+

+ BOOST_NO_CXX11_HDR_THREAD +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_TUPLE -

- Use BOOST_NO_CXX11_HDR_TUPLE instead. -

+

+ BOOST_NO_CXX11_HDR_TUPLE +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_TYPE_TRAITS -

- Use BOOST_NO_CXX11_HDR_TYPE_TRAITS instead. -

+

+ BOOST_NO_CXX11_HDR_TYPE_TRAITS +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_TYPEINDEX -

- Use BOOST_NO_CXX11_HDR_TYPEINDEX instead. -

+

+ BOOST_NO_CXX11_HDR_TYPEINDEX +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_UNORDERED_MAP -

- Use BOOST_NO_CXX11_HDR_UNORDERED_MAP instead. -

+

+ BOOST_NO_CXX11_HDR_UNORDERED_MAP +

+
+

+ Boost 1.50 +

+

+

+

BOOST_NO_0X_HDR_UNORDERED_SET -

- Use BOOST_NO_CXX11_HDR_UNORDERED_SET instead. -

+

+ BOOST_NO_CXX11_HDR_UNORDERED_SET +

+
+

+ Boost 1.50 +

+
-
+

Macros for libraries with separate source code @@ -3903,7 +4080,7 @@ See Guidelines for Authors of Boost Libraries Containing Separate Source

-
+

Macros controlling shared library symbol visibility @@ -3989,7 +4166,7 @@ RTTI. Examples include class for objects that will be thrown as exceptions or used in dynamic_casts, across shared library boundaries. For example, a header-only exception class might - look like this: + look like this:

class BOOST_SYMBOL_VISIBLE my_exception : public std::runtime_error { ... };
 
@@ -4027,7 +4204,7 @@ #if defined(BOOST_ALL_DYN_LINK) || defined(BOOST_FOO_DYN_LINK) # if defined(BOOST_FOO_SOURCE) # define BOOST_FOO_DECL BOOST_SYMBOL_EXPORT -# else +# else # define BOOST_FOO_DECL BOOST_SYMBOL_IMPORT # endif #else @@ -4049,7 +4226,7 @@ boost/libs/foo/src/foo.cpp

#define BOOST_FOO_SOURCE
-#include <boost/foo/foo.hpp>    
+#include <boost/foo/foo.hpp>
 ...
 void BOOST_FOO_DECL f()
 {
@@ -4058,7 +4235,7 @@
 ...
 

-
+

ABI Fixing @@ -4116,7 +4293,7 @@ to point to their own prefix/suffix headers if they so wish.

-
+

Automatic library selection diff --git a/doc/html/boost_config/guidelines_for_boost_authors.html b/doc/html/boost_config/guidelines_for_boost_authors.html index cbc7dbce..70185cd9 100644 --- a/doc/html/boost_config/guidelines_for_boost_authors.html +++ b/doc/html/boost_config/guidelines_for_boost_authors.html @@ -3,7 +3,7 @@ Guidelines for Boost Authors - + @@ -22,7 +22,7 @@
PrevUpHomeNext
-
+

Guidelines for Boost Authors @@ -103,7 +103,7 @@ the majority of compilers, such as namespaces, exceptions, RTTI, or templates.

-
+

Disabling Compiler Warnings @@ -182,7 +182,7 @@

-
+

Adding New Defect Macros @@ -285,7 +285,7 @@

-
+

Adding New Feature Test Macros @@ -309,7 +309,7 @@ <unistd.h>).

-
+

Modifying the Boost Configuration Headers diff --git a/doc/html/boost_config/rationale.html b/doc/html/boost_config/rationale.html index d62510c1..68dfc28a 100644 --- a/doc/html/boost_config/rationale.html +++ b/doc/html/boost_config/rationale.html @@ -3,7 +3,7 @@ Rationale - + @@ -22,7 +22,7 @@
PrevUpHomeNext
-
+
@@ -39,7 +39,7 @@ principles from the following article.

-
+
@@ -90,7 +90,7 @@ code must be provided.

-
+
diff --git a/doc/html/index.html b/doc/html/index.html index 9dc678b1..995adbe5 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -3,7 +3,7 @@ Boost.Config - + @@ -29,7 +29,7 @@
-

+

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)

@@ -72,6 +72,8 @@ Helper Macros
Boost Informational Macros
+
Boost + Deprecated Macros
Macros for libraries with separate source code
@@ -95,7 +97,7 @@
Acknowledgements
-
+
-
+

Using the default boost configuration @@ -138,7 +140,7 @@ and submitting a support request.

-
+

The <boost/config.hpp> header @@ -169,7 +171,7 @@ developers list.

-
+

Using the configure script @@ -277,7 +279,7 @@ export CXXFLAGS="-Aa -DAportable -D__HPACC_THREAD_SAFE_RB_TREE \ -DRWSTD_MULTI_THREAD -DRW_MULTI_THREAD -D_REENTRANT -D_THREAD_SAFE" export LDFLAGS="-DAportable" -export LIBS="-lpthread" +export LIBS="-lpthread" sh ./configure

@@ -311,7 +313,7 @@

-
+

User settable options @@ -677,7 +679,7 @@

-
+

Advanced configuration usage @@ -721,7 +723,7 @@

The following usage examples represent just a few of the possibilities:

-
+

Example 1, creating our own frozen configuration @@ -753,7 +755,7 @@ yet supported by boost.

-
+

Example 2: skipping files that you don't need @@ -772,7 +774,7 @@ a dependency on two boost headers.

-
+
-
+

Testing the boost configuration @@ -949,7 +951,7 @@

- +

Last revised: October 11, 2011 at 17:21:29 GMT

Last revised: March 08, 2012 at 15:40:04 GMT


diff --git a/doc/macro_reference.qbk b/doc/macro_reference.qbk index 01402555..ac85062c 100644 --- a/doc/macro_reference.qbk +++ b/doc/macro_reference.qbk @@ -538,24 +538,24 @@ that are not yet supported by a particular compiler or library. [table [[Macro ][Description ]] -[[`BOOST_NO_0X_HDR_ARRAY`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_CHRONO`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_CODECVT`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_CONDITION_VARIABLE`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_FORWARD_LIST`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_FUTURE`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_INITIALIZER_LIST`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_MUTEX`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_RANDOM`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_RATIO`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_REGEX`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_SYSTEM_ERROR`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_THREAD`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_TUPLE`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_TYPEINDEX`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_TYPE_TRAITS`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_UNORDERED_MAP`][The standard library does not provide header .]] -[[`BOOST_NO_0X_HDR_UNORDERED_SET`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_ARRAY`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_CHRONO`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_CODECVT`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_CONDITION_VARIABLE`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_FORWARD_LIST`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_FUTURE`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_INITIALIZER_LIST`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_MUTEX`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_RANDOM`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_RATIO`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_REGEX`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_SYSTEM_ERROR`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_THREAD`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_TUPLE`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_TYPEINDEX`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_TYPE_TRAITS`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_UNORDERED_MAP`][The standard library does not provide header .]] +[[`BOOST_NO_CXX11_HDR_UNORDERED_SET`][The standard library does not provide header .]] [[`BOOST_NO_AUTO_DECLARATIONS`][The compiler does not support type deduction for variables declared with the `auto` keyword (`auto var = ...;`). @@ -977,6 +977,40 @@ the configuration. [endsect] +[#deprecated_macros] + +[section Boost Deprecated Macros] + +The following have been deprecated; please use the replacements instead. +They will be removed in a future version of boost. + +[table + +[[Deprecated Macro ][Replacement ][When deprecated]] + +[[`BOOST_NO_0X_HDR_ARRAY`][`BOOST_NO_CXX11_HDR_ARRAY`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_CHRONO`][`BOOST_NO_CXX11_HDR_CHRONO`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_CODECVT`][`BOOST_NO_CXX11_HDR_CODECVT`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_CONDITION_VARIABLE`][`BOOST_NO_CXX11_HDR_CONDITION_VARIABLE`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_FORWARD_LIST`][`BOOST_NO_CXX11_HDR_FORWARD_LIST`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_FUTURE`][`BOOST_NO_CXX11_HDR_FUTURE`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_INITIALIZER_LIST`][`BOOST_NO_CXX11_HDR_INITIALIZER_LIST`][Boost 1.50]] +[[`BOOST_NO_INITIALIZER_LISTS`][`BOOST_NO_CXX11_HDR_INITIALIZER_LIST`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_MUTEX`][`BOOST_NO_CXX11_HDR_MUTEX`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_RANDOM`][`BOOST_NO_CXX11_HDR_RANDOM`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_RATIO`][`BOOST_NO_CXX11_HDR_RATIO`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_REGEX`][`BOOST_NO_CXX11_HDR_REGEX`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_SYSTEM_ERROR`][`BOOST_NO_CXX11_HDR_SYSTEM_ERROR`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_THREAD`][`BOOST_NO_CXX11_HDR_THREAD`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_TUPLE`][`BOOST_NO_CXX11_HDR_TUPLE`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_TYPE_TRAITS`][`BOOST_NO_CXX11_HDR_TYPE_TRAITS`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_TYPEINDEX`][`BOOST_NO_CXX11_HDR_TYPEINDEX`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_UNORDERED_MAP`][`BOOST_NO_CXX11_HDR_UNORDERED_MAP`][Boost 1.50]] +[[`BOOST_NO_0X_HDR_UNORDERED_SET`][`BOOST_NO_CXX11_HDR_UNORDERED_SET`][Boost 1.50]] +] + +[endsect] + [section Macros for libraries with separate source code] The following macros and helper headers are of use to authors whose libraries