Added note about configure not effecting the build process.

[SVN r37635]
This commit is contained in:
John Maddock
2007-05-08 16:59:24 +00:00
parent ec4827dea7
commit 7d6a6b771e

View File

@@ -67,6 +67,9 @@
The best way to keep abreast of changes to the macros used in user code is to 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.</P> monitor the discussions on the Boost developers list.</P>
<h4><a name="config_script">Using the configure script</a></h4> <h4><a name="config_script">Using the configure script</a></h4>
<P><STRONG>Note</STRONG>: this configure script only sets up the Boost headers for
use with a particular compiler.&nbsp; <STRONG><EM>It has no effect on Boost.Build, or
how the libraries are built</EM></STRONG>.</P>
<p>If you know that boost is incorrectly configured for your particular setup, and <p>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 you are on a UNIX like platform, then you may want to try and improve things by
running the boost configure script. From a shell command prompt you will need running the boost configure script. From a shell command prompt you will need
@@ -1601,14 +1604,14 @@ int test()
test system proceeds as:</p> test system proceeds as:</p>
<UL> <UL>
<LI> <LI>
cd into libs/config/tools and run <EM>bjam --v2 </EM>: this generates the .cpp cd into libs/config/tools and run <EM>bjam --v2 </EM>
file test cases from the .ipp file, updates the Jamfile, config_test.cpp and : this generates the .cpp file test cases from the .ipp file, updates the
config_info.cpp.</LI> Jamfile, config_test.cpp and config_info.cpp.
<LI> <LI>
cd into libs/config/test and run <EM>bjam --v2 MACRONAME compiler-list</EM>&nbsp;: cd into libs/config/test and run <EM>bjam --v2 MACRONAME compiler-list</EM>&nbsp;:
where <EM>MACRONAME</EM> is the name of the new macro, and <EM>compiler-list</EM> where <EM>MACRONAME</EM> is the name of the new macro, and <EM>compiler-list</EM>
is the list of compilers to test with.&nbsp; You should see the tests pass with is the list of compilers to test with.&nbsp; You should see the tests pass with
those compilers that don't have the defect, and fail with those that do.</LI> those compilers that don't have the defect, and fail with those that do.
<LI> <LI>
cd into libs/config/test and run <EM>bjam --v2 config_info config_test cd into libs/config/test and run <EM>bjam --v2 config_info config_test
compiler-list</EM> : config_info should build and run cleanly for all the compiler-list</EM> : config_info should build and run cleanly for all the
@@ -1617,14 +1620,14 @@ int test()
<P>Then you should:</P> <P>Then you should:</P>
<UL> <UL>
<LI> <LI>
Define the defect macro in those config headers that require it.</LI> Define the defect macro in those config headers that require it.
<LI> <LI>
Document the macro in this documentation (please do not forget this step!!)</LI> Document the macro in this documentation (please do not forget this step!!)
<LI> <LI>
Commit everything.</LI> Commit everything.
<LI> <LI>
Keep an eye on the regression tests for new failures in Boost.Config caused by Keep an eye on the regression tests for new failures in Boost.Config caused by
the addition.</LI> the addition.
<LI> <LI>
Start using the macro.</LI></UL> Start using the macro.</LI></UL>
<h4><a name="feature_guidelines"></a>Adding New Feature Test Macros</h4> <h4><a name="feature_guidelines"></a>Adding New Feature Test Macros</h4>