From 2a61a39950769ff9520ed82db4839afe534db01a Mon Sep 17 00:00:00 2001 From: John Maddock Date: Wed, 15 Dec 2004 12:24:04 +0000 Subject: [PATCH] Integrated wording suggested on mailing list. [SVN r26512] --- config.htm | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/config.htm b/config.htm index 81077c00..ac6b0e87 100644 --- a/config.htm +++ b/config.htm @@ -47,19 +47,24 @@

The <boost/config.hpp> header

Boost library implementations access configuration macros via #include - <boost/config.hpp>. -

-

Boost library users are never required to #include <boost/config.hpp> - directly, unless they are using the Boost informational - or helper macros which are designed for use by - Boost users as well as for our own internal use.  However, note that while - all the Boost configuration macros are documented here, the feature - test and defect test macros are designed for - internal use by Boost libraries.  If you write code that depends upon - these you should be aware that they are subject to the needs of - Boost library developers, and while we will try to avoid gratuitous - changes, subtle breaking changes are not entirely unknown. + <boost/config.hpp>.  

+

While Boost library users are not required to include that file directly, or + use those configuration macros, such use is acceptable.  The configuration + macros are documented as to their purpose, usage, and limitations which makes + them usable by both Boost library and user code. +

+

Boost informational or helper + macros are designed for use by Boost users as well as for our own internal + use.  Note however, that the feature test and + defect test macros were designed for internal use by Boost libraries, + not user code, so they can change at any time (though no gratuitous changes are + made to them). Boost library problems resulting from changes to the + configuration macros are caught by the Boost regression tests, so the Boost + libraries are updated to account for those changes. By contrast, Boost library + user code can be adversely affected by changes to the macros without warning. + The best way to keep abreast of changes to the macros used in user code is to + monitor the discussions on the Boost developers list.

Using the configure script

If you know that boost is incorrectly configured for your particular setup, and you are on a UNIX like platform, then you may want to try and improve things by