[boost-doc-zh] r328 committed - 转换至1.40.0，第11批，全部完成。
- From: codesite-noreply@xxxxxxxxxx
- To: boost-doc-zh-notify@xxxxxxxxxxxxx
- Date: Sat, 12 Sep 2009 08:01:37 +0000
Revision: 328
Author: alai04
Date: Sat Sep 12 01:00:21 2009
Log: 转换至1.40.0，第11批，全部完成。
http://code.google.com/p/boost-doc-zh/source/detail?r=328
Added:
/trunk/status
/trunk/status/expected_results.xml
/trunk/status/explicit-failures-markup.xml
Modified:
/trunk/more/getting_started/index.html
/trunk/more/getting_started/unix-variants.html
/trunk/more/getting_started/windows.html
/trunk/more/writingdoc/design.html
/trunk/more/writingdoc/index.html
/trunk/more/writingdoc/introduction.html
/trunk/more/writingdoc/structure.html
/trunk/more/writingdoc/template/acknowledgments.html
/trunk/more/writingdoc/template/bibliography.html
/trunk/more/writingdoc/template/configuration.html
/trunk/more/writingdoc/template/definitions.html
/trunk/more/writingdoc/template/faq.html
/trunk/more/writingdoc/template/header.html
/trunk/more/writingdoc/template/index.html
/trunk/more/writingdoc/template/overview.html
/trunk/more/writingdoc/template/rationale.html
/trunk/wiki/index.html
=======================================
--- /dev/null
+++ /trunk/status/expected_results.xml Sat Sep 12 01:00:21 2009
File is too large to display a diff.
=======================================
--- /dev/null
+++ /trunk/status/explicit-failures-markup.xml Sat Sep 12 01:00:21 2009
@@ -0,0 +1,6261 @@
+<?xml version="1.0" encoding="utf-8"?>
+<explicit-failures-markup
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+ xsi:noNamespaceSchemaLocation="explicit-failures.xsd">
+
+ <!--
+ PLEASE VALIDATE THE XML BEFORE COMMITTING YOUR CHANGES!
+
+ Locally, the xmlint tool can be used:
+
+ xmllint <two-dashes>valid explicit-failures-markup.xml
<two-dashes>schema explicit-failures.xsd
+
+ The following online services can be used to validate your changes to
this
+ file:
+
+ -
http://syseng.nist.gov/b2bTestbed/projects/xmlvalidation/instance_validation.html
+ - http://xmlvalidation.com/
+
+ With both tools you need to provide both the
explicit-failures-markup.xml
+ file as the XML document and the explicit-failures.xsd as the schema
+ document. Use the browse buttons to select them from your local hard
+ drive.
+ -->
+
+ <!-- /////////////// Toolsets /////////////// -->
+ <mark-toolset name="acc" status="required"/>
+ <mark-toolset name="darwin-4.0.1" status="required"/>
+ <mark-toolset name="gcc-4.1.2_sunos_i86pc" status="required"/>
+ <mark-toolset name="gcc-4.1.3_linux" status="required"/>
+ <mark-toolset name="gcc-4.2.1" status="required"/>
+ <mark-toolset name="gcc-4.2.1_hpux_ia64" status="required"/>
+ <mark-toolset name="gcc-4.2.1_linux_x86_64" status="required"/>
+ <mark-toolset name="intel-linux-9.0" status="required"/>
+ <mark-toolset name="intel-vc8-win-10.0" status="required"/>
+ <mark-toolset name="intel-win-10.0" status="required"/>
+ <mark-toolset name="msvc-7.1" status="required"/>
+ <mark-toolset name="msvc-8.0" status="required"/>
+ <mark-toolset name="msvc-8.0_64" status="required"/>
+
+ <!-- /////////////// Libraries /////////////// -->
+
+ <!-- accumulators -->
+ <library name="accumulators">
+ <mark-unusable>
+ <toolset name="sun-5.7"/>
+ <toolset name="sun-5.8"/>
+ <toolset name="sun-5.9"/>
+ <toolset name="borland-*"/>
+ </mark-unusable>
+ <mark-expected-failures>
+ <test name="tail_variate_means"/>
+ <test name="weighted_tail_variate_means"/>
+ <toolset name="gcc-4.2.1*"/>
+ <note author="Boris Gubenko" refid="42"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="weighted_kurtosis"/>
+ <toolset name="acc"/>
+ <note author="Boris Gubenko" refid="38"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="weighted_tail_variate_means"/>
+ <toolset name="hp_cxx-71*"/>
+ <note author="Markus Schoepflin">
+ This failure is caused by a timeout when compiling the test. It
+ passes when the timeout value is increased.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="covariance"/>
+ <test name="pot_quantile"/>
+ <test name="tail_variate_means"/>
+ <test name="weighted_covariance"/>
+ <test name="weighted_pot_quantile"/>
+ <test name="weighted_tail_variate_means"/>
+ <toolset name="acc"/>
+ <note author="Boris Gubenko" refid="47"/>
+ </mark-expected-failures>
+ </library>
+
+ <!-- minmax -->
+ <library name="algorithm/minmax">
+ <mark-unusable>
+ <toolset name="sunpro-5_3-sunos"/>
+ </mark-unusable>
+ </library>
+
+ <!-- string_algo -->
+ <library name="algorithm/string">
+ <mark-unusable>
+ <toolset name="borland-5.5*"/>
+ <toolset name="msvc-6.5*"/>
+ <toolset name="msvc-7.1_stlport4"/>
+ <toolset name="iw-7_1-vc6"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.5.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <toolset name="mipspro"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note author="P.Droba">
+ The compiler does not support features that are essential
for the library.
+ </note>
+ </mark-unusable>
+ <test name="regex">
+ <mark-failure>
+ <toolset name="borland-5.9*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.6*"/>
+ <note author="P.Droba">
+ The toolset is not supported by Boost.Regex.
+ </note>
+ </mark-failure>
+ </test>
+ </library>
+
+ <!-- any -->
+ <library name="any">
+ <test name="any_to_ref_test">
+ <mark-failure>
+ <toolset name="msvc-6.5*"/>
+ <note author="Vladimir Prus">
+ The test fail with ICE, but the exact reason for ICE is not
+ known. A minimal example of casting any to reference type
+ seem to work. Anyone interested in using this functionality
+ with msvc is suggested to do additional testing.
+ </note>
+ </mark-failure>
+ </test>
+ </library>
+
+
+ <!-- array -->
+ <library name="array">
+ <test name="array0">
+ <mark-failure>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-6.5_stlport4"/>
+ <toolset name="msvc-7.0"/>
+ <note author="A.Meredith">
+ Compilers need to support partial template
specialization
+ to work with zero length arrays.
+ </note>
+ </mark-failure>
+ </test>
+ <test name="array3">
+ <mark-failure>
+ <toolset name="borland-5.5*"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-6.5_stlport4"/>
+ <toolset name="msvc-7.0"/>
+ <note refid="3"/>
+ </mark-failure>
+ <mark-failure>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note refid="4"/>
+ </mark-failure>
+ </test>
+ <test name="array4">
+ <mark-failure>
+ <toolset name="borland-5.5*"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-6.5_stlport4"/>
+ <toolset name="msvc-7.0"/>
+ <note refid="3"/>
+ </mark-failure>
+ </test>
+ </library>
+
+ <!-- asio -->
+ <library name="asio">
+ <mark-unusable>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <note author="Chris Kohlhoff">
+ This compiler does not support enable_if, which is needed by
the
+ Boost.System library on which Boost.Asio depends.
+ </note>
+ </mark-unusable>
+ <mark-expected-failures>
+ <test name="read_until"/>
+ <test name="read_until_select"/>
+ <toolset name="gcc-4.2.1_hpux_ia64"/>
+ <note author="Boris Gubenko">
+ On HP-UX 11.23 platform, these tests must be compiled with
+ _XOPEN_SOURCE_EXTENDED macro defined. It is likely related
+ to CR JAGag28813.
+ </note>
+ </mark-expected-failures>
+ </library>
+
+ <!-- assign -->
+ <library name="assign">
+ <mark-unusable>
+ <toolset name="dmc-8_43-stlport-4_5_3"/>
+ </mark-unusable>
+ <mark-expected-failures>
+ <test name="array"/>
+ <toolset name="msvc-6.5_stlport4"/>
+ <toolset name="msvc-7.0"/>
+ <note author="Thorsten Ottosen" >
+ The test would (most likely) compile and run properly if
the workaround
+ syntax .to_container( c ) was applied to all list_of()
expressions.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="email_example"/>
+ <toolset name="gcc-2.95.3*"/>
+ <note refid="27" author="Thorsten Ottosen"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="list_inserter"/>
+ <toolset name="msvc-7.0"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <toolset name="hp_cxx-65*"/>
+ <note refid="6" author="Thorsten Ottosen"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="list_inserter"/>
+ <toolset name="gcc-2.95.3*"/>
+ <note author="Thorsten Ottosen">
+ This test could probably be made to work if somebody with
knowledge
+ about the compilers would submit a patch.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="list_of"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <toolset name="hp_cxx-65*"/>
+ <toolset name="borland-5*"/>
+ <toolset name="msvc-6.5*"/>
+ <toolset name="msvc-7.0"/>
+ <note author="Thorsten Ottosen" >
+ The test would (most likely) compile and run properly if
the workaround
+ syntax .to_container( c ) was applied to all list_of()
expressions.
+ </note>
+ </mark-expected-failures>
+
+ <mark-expected-failures>
+ <test name="list_of_workaround"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note author="Thorsten Ottosen" >
+ The test could probably be made to work if somebody
submitted a patch.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="multi_index_container"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <toolset name="sun-5.8"/>
+ <toolset name="hp_cxx-65*"/>
+ <toolset name="borland-5*"/>
+ <toolset name="gcc-2.95.3*"/>
+ <note refid="27" author="Thorsten Ottosen"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="multi_index_container"/>
+ <toolset name="msvc-6.5*"/>
+ <toolset name="msvc-7.0"/>
+ <toolset name="mipspro"/>
+ <toolset name="hp_cxx-65*"/>
+ <note author="Thorsten Ottosen" >
+ The test would (most likely) compile and run properly if
the workaround
+ syntax .to_container( c ) was applied to all list_of()
expressions.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="my_vector_example"/>
+ <toolset name="gcc-2.95.3*"/>
+ <note refid="27" author="Thorsten Ottosen"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="ptr_list_inserter"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <toolset name="hp_cxx-65*"/>
+ <toolset name="borland-5*"/>
+ <toolset name="gcc-2.95.3*"/>
+ <toolset name="msvc-6.5*"/>
+ <toolset name="msvc-7.0"/>
+ <toolset name="mipspro"/>
+ <note author="Thorsten Ottosen" >
+ The test depends on Boost.Pointer Container which probably
does not work for
+ this compiler.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="ptr_list_of"/>
+ <toolset name="hp_cxx-65*"/>
+ <toolset name="borland-5*"/>
+ <toolset name="gcc-2.95.3*"/>
+ <toolset name="msvc-6.5*"/>
+ <toolset name="mipspro"/>
+ <note author="Thorsten Ottosen" >
+ The test depends on Boost.Pointer Container which probably
does not work for
+ this compiler.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="ptr_map_inserter"/>
+ <toolset name="hp_cxx-65*"/>
+ <toolset name="borland-5*"/>
+ <toolset name="gcc-2.95.3*"/>
+ <toolset name="msvc-6.5*"/>
+ <toolset name="mipspro"/>
+ <note author="Thorsten Ottosen" >
+ The test depends on Boost.Pointer Container which probably
does not work for
+ this compiler.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="std"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note author="Thorsten Ottosen" >
+ The test does not work for
+ this compiler.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="tuple_list_of"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <toolset name="borland-5*"/>
+ <toolset name="msvc-6.5*"/>
+ <toolset name="msvc-7.0"/>
+ <note author="Thorsten Ottosen" >
+ The test depends on Boost.Tuple which probably does not
work for
+ this compiler.
+ </note>
+ </mark-expected-failures>
+ </library>
+
+ <!-- bimap -->
+ <library name="bimap">
+ <mark-unusable>
+ <toolset name="borland-5.6*"/>
+ <note author="J. López" date="05 Jul 2004"
refid="17"/>
+ </mark-unusable>
+ <mark-unusable>
+ <toolset name="borland-5.8*"/>
+ <note author="Alisdair Meredith" date="26 May 2006"/>
+ </mark-unusable>
+ <mark-unusable>
+ <toolset name="borland-5.9*"/>
+ <note author="Alisdair Meredith" date="27 Feb 2007"/>
+ </mark-unusable>
+ <mark-unusable>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.5.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <note author="J. López" date="09 Jul 2004"
refid="17"/>
+ </mark-unusable>
+ <mark-unusable>
+ <toolset name="*como-4_3_3-msvc"/>
+ <note author="J. López" date="30 Jul 2004">
+ The VC++ 6.0 backend runs out of internal resources while
+ trying to process the Comeau output for this library;
+ Comeau Computing has been asked about a solution.
+ On the other hand, Comeau 4.3.3 with VC++ 7.0 backend works
+ fine.
+ </note>
+ </mark-unusable>
+ <mark-unusable>
+ <toolset name="sunpro-5_3-sunos"/>
+ <toolset name="sunpro-5_8u1-sunos"/>
+ <note author="J. López" date="22 Apr 2005"
refid="17"/>
+ </mark-unusable>
+ <mark-unusable>
+ <toolset name="dmc-8_43-stlport-4_5_3"/>
+ <toolset name="dmc-8_44b-stlport-4_5_3"/>
+ <toolset name="dmc-8_47-stlport-4_5_3"/>
+ <note author="J. López" date="03 Jun 2005"
refid="17"/>
+ </mark-unusable>
+ <mark-expected-failures>
+ <test name="test_bimap_assign"/>
+ <test name="test_bimap_ordered"/>
+ <test name="test_bimap_unconstrained"/>
+ <test name="test_bimap_unordered"/>
+ <toolset name="acc"/>
+ <note refid="38" author="Boris Gubenko"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="typeof"/>
+ <toolset name="acc*"/>
+ <toolset name="intel-vc71-win*"/>
+ <toolset name="intel-vc8-win*"/>
+ <toolset name="intel-win-9.1"/>
+ <toolset name="hp_cxx*"/>
+ <note refid="39" author="Boris Gubenko"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="test_bimap_serialization"/>
+ <toolset name="gcc-mingw-3.4.5"/>
+ <note author="Matias Capeletto">Compiler bug.</note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="test_bimap_property_map"/>
+ <toolset name="gcc-3.4.6_linux_x86_64"/>
+ <note author="Matias Capeletto">Time out.</note>
+ </mark-expected-failures>
+ </library>
+
+ <!-- bind-->
+ <library name="bind">
+ <mark-expected-failures>
+ <test name="bind_cv_test"/>
+ <test name="bind_stateful_test"/>
+ <toolset name="intel-7.1-linux"/>
+ <toolset name="intel-7.1-stdlib-default-linux"/>
+ <note refid="2" author="Aleksey Gurtovoy"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="bind_dm2_test"/>
+ <test name="mem_fn_dm_test"/>
+ <toolset name="msvc-6.*"/>
+ <toolset name="msvc-7.0"/>
+ <toolset name="cw-8.3"/>
+ <note refid="31" author="Peter Dimov"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="bind_dm_test"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note refid="31" author="Peter Dimov"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="bind_function_test"/>
+ <toolset name="sunpro-5_8u1-sunos"/>
+ <note author="Peter Dimov">
+ This failure is caused by Boost.Function.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="mem_fn_derived_test"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note refid="31" author="Peter Dimov"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="bind_rv_sp_test"/>
+ <toolset name="hp_cxx-65*"/>
+ <toolset name="hp_cxx-71*"/>
+ <note author="Markus Schoepflin">
+ This failure is caused by a bug in the compiler triggered by
the
+ use of the debug flag '-gall'. It has been reported to the
+ compiler vendor.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="bind_dm3_test"/>
+ <toolset name="borland-5*"/>
+ <toolset name="msvc-6.*"/>
+ <toolset name="msvc-7.0"/>
+ <note refid="31" author="Peter Dimov"/>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="mem_fn_eq_test"/>
+ <toolset name="msvc-7.1"/>
+ <note author="Peter Dimov">
+ This failure is only present in release mode and is caused by
/OPT:ICF.
+ </note>
+ </mark-expected-failures>
+ <mark-expected-failures>
+ <test name="bind_placeholder_test"/>
+ <toolset name="borland-*"/>
+ <toolset name="msvc-6.*"/>
+ <toolset name="msvc-7.0"/>
+ <note refid="31" author="Peter Dimov"/>
+ </mark-expected-failures>
+ </library>
+
+ <!-- build -->
+ <library name="build">
+ <test name="timedata">
+ <mark-failure>
+ <toolset name="msvc-7.1"/>
+ <toolset name="msvc-8.0"/>
+ <toolset name="msvc-9.0"/>
+ <note author="Vladimir Prus">
+ See
https://zigzag.lvk.cs.msu.su:7813/boost.build/ticket/218
+ </note>
+ </mark-failure>
+ </test>
+ </library>
+
+ <!-- circular_buffer -->
+ <library name="circular_buffer">
+ <mark-expected-failures>
+ <test name="base_test"/>
+ <test name="space_optimized_test"/>
+ <toolset name="acc"/>
+ <note author="Boris Gubenko" refid="41"/>
+ </mark-expected-failures>
+ </library>
+
+
+ <!-- concept_check -->
+ <library name="concept_check">
+ <test name="class_concept_fail_expected">
+ <mark-failure>
+ <toolset name="cw-8.3*"/>
+ <note author="B. Dawes" refid="3"/>
+ </mark-failure>
+ </test>
+ <test name="class_concept_fail_expected">
+ <mark-failure>
+ <toolset name="borland-5*"/>
+ <toolset name="msvc-6.5*"/>
+ <toolset name="msvc-7.0"/>
+ <note author="Jeremy Siek"/>
+ </mark-failure>
+ </test>
+ <test name="stl_concept_covering">
+ <mark-failure>
+ <toolset name="*"/>
+ <note author="Jeremy Siek" refid="1"/>
+ </mark-failure>
+ </test>
+ <test name="stl_concept_check">
+ <mark-failure>
+ <toolset name="hp_cxx*"/>
+ <note author="Markus Schoepflin" date="09 Dec 2007">
+ This version of the Rogue Wave library fails to provide all
+ needed addition operators for the iterator type and the
+ difference type of std::deque.
+ </note>
+ </mark-failure>
+ </test>
+ </library>
+
+ <!-- config -->
+ <library name="config">
+ <test name="config_link_test">
+ <mark-failure>
+ <toolset name="*como-4_3_3-vc7*"/>
+ <note author="J. Maddock" refid="3"/>
+ </mark-failure>
+ </test>
+ <test name="limits_test">
+ <mark-failure>
+ <toolset name="cw-8.3*"/>
+ <note author="B. Dawes" refid="3"/>
+ </mark-failure>
+ </test>
+ <test name="limits_test">
+ <mark-failure>
+ <toolset name="gcc-3_4_4_tru64"/>
+ <note author="John Maddock">
+ Long double NaN's are apparently handled incorrectly on
this platform.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="limits_test">
+ <mark-failure>
+ <toolset name="iw-7_1-vc6-stlp-4_5_3"/>
+ <note author="Aleksey Gurtovoy" refid="4"/>
+ </mark-failure>
+ </test>
+ <test name="limits_test">
+ <mark-failure>
+ <toolset name="borland-5.8*"/>
+ <note author="A.Meredith">
+ This failure is due to NaNs trapping.
+ </note>
+ </mark-failure>
+ </test>
+ <test name="limits_test">
+ <mark-failure>
+ <toolset name="borland-5.9*"/>
+ <note author="A.Meredith">
+ This failure is due to the compiler not recognising
the long double special values for infinity and quiet NaN
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="test_thread_fail1">
+ <mark-failure>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note author="J. Maddock" refid="3"/>
+ </mark-failure>
+ </test>
+ <test name="test_thread_fail2">
+ <mark-failure>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note author="J. Maddock" refid="3"/>
+ </mark-failure>
+ </test>
+ </library>
+
+
+ <!-- conversion -->
+ <library name="conversion">
+ <test name="lexical_cast_test">
+ <mark-failure>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note author="Douglas Gregor" refid="3"/>
+ </mark-failure>
+ </test>
+ <test name="lexical_cast_abstract_test">
+ <mark-failure>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <note author="Alisdair Meredith">
+ This compiler does not support the is_abstract type
trait
+ </note>
+ </mark-failure>
+ </test>
+ <test name="lexical_cast_loopback_test">
+ <mark-failure>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="gcc-3.4*"/>
+ <toolset name="gcc-4.1*"/>
+ <toolset name="gcc-4.2*"/>
+ <toolset name="gcc-mingw-3.4*"/>
+ <toolset name="sun-5.7*"/>
+ <toolset name="sun-5.8*"/>
+ <toolset name="sun-5.9*"/>
+ <toolset name="msvc-8.0*"/>
+ <toolset name="msvc-9.0*"/>
+ <toolset name="msvc-7.1*"/>
+ <toolset name="acc"/>
+ <note author="Alexander Nasonov">
+ Conversion double-string-double may give a different
value (or even throw) on many compilers
+ </note>
+ </mark-failure>
+ </test>
+ </library>
+
+ <!-- crc -->
+ <library name="crc">
+ <test name="crc_test">
+ <mark-failure>
+ <toolset name="sunpro-5_3-sunos"/>
+ <note author="Douglas Gregor" refid="3"/>
+ </mark-failure>
+ </test>
+ </library>
+
+ <!-- date_time -->
+ <library name="date_time">
+ <mark-unusable>
+ <toolset name="como-4_3_3-vc7_1"/>
+ <toolset name="sunpro-5_3-sunos"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-6.5_stlport5"/>
+ <toolset name="msvc-6.5_stlport4"/>
+ <toolset name="msvc-7.0"/>
+ <toolset name="msvc-7.0_stlport5"/>
+ <toolset name="iw-7_1-vc6-stlp-4_5_3"/>
+ <toolset name="iw-7_1-vc6"/>
+ <toolset name="dmc-*"/>
+ </mark-unusable>
+
+ <test name="testgreg_serialize*">
+ <mark-failure>
+ <toolset name="gcc-2.*"/>
+ <toolset name="msvc-6.5*"/>
+ <note author="B. Garst">The serialization library does not
support this compiler.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testgreg_serialize_xml">
+ <mark-failure>
+ <toolset name="msvc-7.0"/>
+ <note author="J. Garland">XML serialization is not supported
on this compiler.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testtime_serialize*">
+ <mark-failure>
+ <toolset name="gcc-2.*"/>
+ <toolset name="msvc-6.5*"/>
+ <note author="B. Garst">The serialization library does not
support this compiler.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testtime_serialize_xml*">
+ <mark-failure>
+ <toolset name="msvc-7.0"/>
+ <note author="J. Garland">XML serialization is not supported
on this compiler.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testdate_iterator">
+ <mark-failure>
+ <toolset name="intel-7.1-stdlib-default-linux"/>
+ <toolset name="intel-7.1-linux"/>
+ <note author="J. Garland" refid="19,21"/>
+ </mark-failure>
+ </test>
+ <test name="testdate_iterator_dll">
+ <mark-failure>
+ <toolset name="intel-7.1-stdlib-default-linux"/>
+ <toolset name="intel-7.1-linux"/>
+ <note author="J. Garland" refid="19,21"/>
+ </mark-failure>
+ </test>
+
+
+ <test name="testgeneric_period">
+ <mark-failure>
+ <toolset name="intel-7.1-stdlib-default-linux"/>
+ <toolset name="intel-7.1-linux"/>
+ <note author="J. Garland">These are strange runtime
failures for
+ which there is no obvious explanation. Later
versions of the
+ Intel compiler (eg:8.0) seem to have resolved
the issue.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testgreg_wstream">
+ <mark-failure>
+ <toolset name="msvc-6.5*"/>
+ <toolset name="msvc-7.0*"/>
+ <toolset name="cw-8.3*"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="mingw*"/>
+ <toolset name="*mingw*"/>
+ <toolset name="*cygwin*"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-3.1-darwin"/>
+ <toolset name="*como-4_3_3*"/>
+ <note author="B. Garst" refid="19,21"/>
+ </mark-failure>
+ </test>
+
+ <test name="testdate_input_facet*">
+ <mark-failure>
+ <toolset name="cw-9.4"/>
+ <toolset name="cw-9.5*"/>
+ <note author="J. Garland">
+ For some reason Code Warrior has difficulty compiling
some of the
+ input code. This may be related to limitations of
locale handling,
+ but it's unclear at this time (2005-May-21).
+ </note>
+ </mark-failure>
+ </test>
+
+
+ <test name="testlocal_time_facet">
+ <mark-failure>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.5.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-7.0"/>
+ <note author="J. Garland">
+ Some older compilers are confused by the template code
here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testlocal_time">
+ <mark-failure>
+ <toolset name="msvc-6.5"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.5.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <note author="J. Garland">
+ Some older compilers are confused by the template code
here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testlocal_time_iterator">
+ <mark-failure>
+ <toolset name="msvc-6.5"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.5.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <note author="J. Garland">
+ Some older compilers are confused by the template code
here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testlocal_time_period">
+ <mark-failure>
+ <toolset name="msvc-6.5"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.5.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <note author="J. Garland">
+ Some older compilers are confused by the template code
here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testclocks">
+ <mark-failure>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="msvc-7.0"/>
+ <toolset name="msvc-6.5"/>
+ <note author="J. Garland">
+ Some compilers are confused by the template code here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testlocal_time_input_facet">
+ <mark-failure>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="cw-8.3*"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.5.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-7.0"/>
+ <note author="J. Garland">
+ Some older compilers are confused by the template code
here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+
+ <test name="testtime_input_facet">
+ <mark-failure>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="cw-8.3*"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.5.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-7.0"/>
+ <note author="J. Garland">
+ Some older compilers are confused by the template code
here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testcustom_time_zone">
+ <mark-failure>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8.1"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="msvc-6.5"/>
+ <note author="J. Garland">
+ Some older compilers are confused by the template code
here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testposix_time_zone">
+ <mark-failure>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8.1"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="msvc-6.5"/>
+ <note author="J. Garland">
+ Some older compilers are confused by the template code
here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testtz_database">
+ <mark-failure>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8.1"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="msvc-6.5"/>
+ <note author="J. Garland">
+ Some compilers are confused by the template code here.
+ These are new features to date-time in 1.33 and there
is no
+ plan to backport to these non-compliant compilers.
+ </note>
+ </mark-failure>
+ </test>
+
+ <test name="testtime_wstream">
+ <mark-failure>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-3.1-darwin"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-7.0"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="mingw*"/>
+ <toolset name="*mingw*"/>
+ <toolset name="*cygwin*"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="hp_cxx-65*"/>
+ <note author="B. Garst" refid="19,21,22"/>
+ </mark-failure>
+ </test>
+
+ <test name="testtime_wstream_std_config">
+ <mark-failure>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-3.1-darwin"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-7.0"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="mingw*"/>
+ <toolset name="*como-4_3_3*"/>
+ <toolset name="hp_cxx-65*"/>
+ <note author="B. Garst" refid="19,21,22"/>
+ </mark-failure>
+ </test>
+ <test name="testdate_facet_new">
+ <mark-failure>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="cw-8.3*"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-7.0"/>
+ <note author="J. Garland">
+ These compilers are unfortunately able to correctly
compile the
+ new format-based input-output code for date time.
Suitable, but
+ less flexible, alternatives are available on these
compilers.
+ </note>
+ </mark-failure>
+ </test>
+ <test name="testdate_facet_new_dll">
+ <mark-failure>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="cw-8.3*"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-7.0"/>
+ <note author="J. Garland">
+ These compilers are unfortunately able to correctly
compile the
+ new format-based input-output code for date time.
Suitable, but
+ less flexible, alternatives are available on these
compilers.
+ </note>
+ </mark-failure>
+ </test>
+ <test name="testtime_facet">
+ <mark-failure>
+ <toolset name="gcc-2.95.3-linux"/>
+ <toolset name="gcc-2.95.3-stlport-4.6.2-linux"/>
+ <toolset name="borland-5.6*"/>
+ <toolset name="borland-5.8*"/>
+ <toolset name="borland-5.9*"/>
+ <toolset name="cw-8.3*"/>
+ <toolset name="msvc-6.5"/>
+ <toolset name="msvc-7.0"/>
+ <note author="J. Garland">
+ These compilers are unfortunately able to correctly
compile the
***The diff for this file has been truncated for email.***
=======================================
--- /trunk/more/getting_started/index.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/getting_started/index.html Sat Sep 12 01:00:21 2009
@@ -3,21 +3,20 @@
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.5:
http://docutils.sourceforge.net/"; />
+<meta name="generator" content="Docutils 0.6:
http://docutils.sourceforge.net/"; />
<title>Boost Getting Started</title>
<link rel="stylesheet" href="../../rst.css" type="text/css" />
</head>
<body>
<div class="document" id="logo-getting-started">
<h1 class="title"><a class="reference external"
href="../../index.htm"><img alt="Boost" class="boost-logo"
src="../../boost.png" /></a> Getting Started</h1>
-
<!-- Copyright David Abrahams 2006. 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)
-->
<div
class="admonition-use-the-latest-version-of-this-getting-started-guide
admonition">
<p class="first admonition-title">Use the latest version of this Getting
Started guide</p>
-<p class="last">The <a class="reference external"
href="http://www.boost.org/doc/libs/1_36_0/more/getting_started/index.html";>Boost
website version of this Getting Started guide</a> may
-have undated information, such as the location of additional installers
+<p class="last">The <a class="reference external"
href="http://www.boost.org/doc/libs/release/more/getting_started/index.html";>Boost
website version of this Getting Started guide</a> may
+have updated information, such as the location of additional installers
or improved installation procedures, so you might want use that version
if you've got an Internet connection available.</p>
</div>
=======================================
--- /trunk/more/getting_started/unix-variants.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/getting_started/unix-variants.html Sat Sep 12 01:00:21 2009
@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.5:
http://docutils.sourceforge.net/"; />
+<meta name="generator" content="Docutils 0.6:
http://docutils.sourceforge.net/"; />
<title>Boost Getting Started on Unix Variants</title>
<meta content="Getting Started with Boost on Unix Variants (including
Linux and MacOS)" name="description" />
<link rel="stylesheet" href="../../rst.css" type="text/css" />
@@ -30,45 +30,45 @@
<div class="contents topic" id="index">
<p class="topic-title first">Index</p>
<ul class="auto-toc simple">
-<li><a class="reference internal" href="#get-boost"
id="id18">1 Get Boost</a></li>
-<li><a class="reference internal" href="#the-boost-distribution"
id="id19">2 The Boost Distribution</a></li>
-<li><a class="reference internal" href="#header-only-libraries"
id="id20">3 Header-Only Libraries</a></li>
-<li><a class="reference internal"
href="#build-a-simple-program-using-boost"
id="id21">4 Build a Simple Program Using Boost</a><ul
class="auto-toc">
-<li><a class="reference internal" href="#errors-and-warnings"
id="id22">4.1 Errors and Warnings</a></li>
+<li><a class="reference internal" href="#get-boost"
id="id21">1 Get Boost</a></li>
+<li><a class="reference internal" href="#the-boost-distribution"
id="id22">2 The Boost Distribution</a></li>
+<li><a class="reference internal" href="#header-only-libraries"
id="id23">3 Header-Only Libraries</a></li>
+<li><a class="reference internal"
href="#build-a-simple-program-using-boost"
id="id24">4 Build a Simple Program Using Boost</a><ul
class="auto-toc">
+<li><a class="reference internal" href="#errors-and-warnings"
id="id25">4.1 Errors and Warnings</a></li>
</ul>
</li>
-<li><a class="reference internal"
href="#prepare-to-use-a-boost-library-binary"
id="id23">5 Prepare to Use a Boost Library Binary</a><ul
class="auto-toc">
-<li><a class="reference internal" href="#easy-build-and-install"
id="id24">5.1 Easy Build and Install</a></li>
-<li><a class="reference internal" href="#or-build-custom-binaries"
id="id25">5.2 Or, Build Custom Binaries</a><ul
class="auto-toc">
-<li><a class="reference internal" href="#get-bjam"
id="id26">5.2.1 Get <tt class="docutils literal"><span
class="pre">bjam</span></tt></a></li>
-<li><a class="reference internal" href="#identify-your-toolset"
id="id27">5.2.2 Identify Your Toolset</a></li>
-<li><a class="reference internal" href="#select-a-build-directory"
id="id28">5.2.3 Select a Build Directory</a></li>
-<li><a class="reference internal" href="#invoke-bjam"
id="id29">5.2.4 Invoke <tt class="docutils literal"><span
class="pre">bjam</span></tt></a></li>
+<li><a class="reference internal"
href="#prepare-to-use-a-boost-library-binary"
id="id26">5 Prepare to Use a Boost Library Binary</a><ul
class="auto-toc">
+<li><a class="reference internal" href="#easy-build-and-install"
id="id27">5.1 Easy Build and Install</a></li>
+<li><a class="reference internal" href="#or-build-custom-binaries"
id="id28">5.2 Or, Build Custom Binaries</a><ul
class="auto-toc">
+<li><a class="reference internal" href="#get-bjam"
id="id29">5.2.1 Get <tt class="docutils literal"><span
class="pre">bjam</span></tt></a></li>
+<li><a class="reference internal" href="#identify-your-toolset"
id="id30">5.2.2 Identify Your Toolset</a></li>
+<li><a class="reference internal" href="#select-a-build-directory"
id="id31">5.2.3 Select a Build Directory</a></li>
+<li><a class="reference internal" href="#invoke-bjam"
id="id32">5.2.4 Invoke <tt class="docutils literal"><span
class="pre">bjam</span></tt></a></li>
</ul>
</li>
-<li><a class="reference internal" href="#expected-build-output"
id="id30">5.3 Expected Build Output</a></li>
-<li><a class="reference internal" href="#in-case-of-build-errors"
id="id31">5.4 In Case of Build Errors</a></li>
+<li><a class="reference internal" href="#expected-build-output"
id="id33">5.3 Expected Build Output</a></li>
+<li><a class="reference internal" href="#in-case-of-build-errors"
id="id34">5.4 In Case of Build Errors</a></li>
</ul>
</li>
-<li><a class="reference internal"
href="#link-your-program-to-a-boost-library"
id="id32">6 Link Your Program to a Boost Library</a><ul
class="auto-toc">
-<li><a class="reference internal" href="#library-naming"
id="id33">6.1 Library Naming</a></li>
-<li><a class="reference internal" href="#test-your-program"
id="id34">6.2 Test Your Program</a></li>
+<li><a class="reference internal"
href="#link-your-program-to-a-boost-library"
id="id35">6 Link Your Program to a Boost Library</a><ul
class="auto-toc">
+<li><a class="reference internal" href="#library-naming"
id="id36">6.1 Library Naming</a></li>
+<li><a class="reference internal" href="#test-your-program"
id="id37">6.2 Test Your Program</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#conclusion-and-further-resources"
id="id35">7 Conclusion and Further Resources</a></li>
+<li><a class="reference internal" href="#conclusion-and-further-resources"
id="id38">7 Conclusion and Further Resources</a></li>
</ul>
</div>
<div class="section" id="get-boost">
-<h1><a class="toc-backref" href="#id18">1 Get
Boost</a></h1>
+<h1><a class="toc-backref" href="#id21">1 Get
Boost</a></h1>
<p>The most reliable way to get a copy of Boost is to download a
distribution from <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";>SourceForge</a>:</p>
<ol class="arabic">
-<li><p class="first">Download <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";><tt
class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt
class="docutils literal"><span class="pre">.tar.bz2</span></tt></a>.</p>
+<li><p class="first">Download <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";><tt
class="docutils literal"><span class="pre">boost_1_40_0</span></tt><tt
class="docutils literal"><span class="pre">.tar.bz2</span></tt></a>.</p>
</li>
<li><p class="first">In the directory where you want to put the Boost
installation,
execute</p>
<pre class="literal-block">
-tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt>.tar.bz2
+tar --bzip2 -xf <em>/path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt>.tar.bz2
</pre>
</li>
</ol>
@@ -88,10 +88,10 @@
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
</div>
<div class="section" id="the-boost-distribution">
-<h1><a class="toc-backref" href="#id19">2 The Boost
Distribution</a></h1>
+<h1><a class="toc-backref" href="#id22">2 The Boost
Distribution</a></h1>
<p>This is a sketch of the resulting directory structure:</p>
<pre class="literal-block">
-<strong>boost_1_36_0</strong><strong>/</strong> .................<em>The
“boost root directory”</em>
+<strong>boost_1_40_0</strong><strong>/</strong> .................<em>The
“boost root directory”</em>
<strong>index.htm</strong> .........<em>A copy of www.boost.org starts
here</em>
<strong>boost</strong><strong>/</strong> .........................<em>All
Boost Header files</em>
<tt class="docutils literal"> </tt>
@@ -136,7 +136,7 @@
</div>
<p>It's important to note the following:</p>
<ol class="arabic" id="boost-root-directory">
-<li><p class="first">The path to the <strong>boost root directory</strong>
(often <tt class="docutils literal"><span
class="pre">/usr/local/</span></tt><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt>) is
+<li><p class="first">The path to the <strong>boost root directory</strong>
(often <tt class="docutils literal"><span
class="pre">/usr/local/</span></tt><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt>) is
sometimes referred to as <tt class="docutils literal"><span
class="pre">$BOOST_ROOT</span></tt> in documentation and
mailing lists .</p>
</li>
@@ -166,7 +166,7 @@
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
</div>
<div class="section" id="header-only-libraries">
-<h1><a class="toc-backref" href="#id20">3 Header-Only
Libraries</a></h1>
+<h1><a class="toc-backref" href="#id23">3 Header-Only
Libraries</a></h1>
<p>The first thing many people want to know is, “how do I build
Boost?” The good news is that often, there's nothing to build.</p>
<div class="admonition-nothing-to-build admonition">
@@ -187,6 +187,7 @@
<li><a class="reference external"
href="../../libs/regex/index.html">Boost.Regex</a></li>
<li><a class="reference external"
href="../../libs/serialization/index.html">Boost.Serialization</a></li>
<li><a class="reference external"
href="../../libs/signals/index.html">Boost.Signals</a></li>
+<li><a class="reference external"
href="../../libs/system/index.html">Boost.System</a></li>
<li><a class="reference external"
href="../../doc/html/thread.html">Boost.Thread</a></li>
<li><a class="reference external"
href="../../libs/wave/index.html">Boost.Wave</a></li>
</ul>
@@ -206,7 +207,7 @@
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
</div>
<div class="section" id="build-a-simple-program-using-boost">
-<h1><a class="toc-backref" href="#id21">4 Build a Simple
Program Using Boost</a></h1>
+<h1><a class="toc-backref" href="#id24">4 Build a Simple
Program Using Boost</a></h1>
<p>To keep things simple, let's start by using a header-only library.
The following program reads a sequence of integers from standard
input, uses Boost.Lambda to multiply each number by three, and
@@ -230,7 +231,7 @@
<p>Now, in the directory where you saved <tt class="docutils
literal"><span class="pre">example.cpp</span></tt>, issue the
following command:</p>
<pre class="literal-block">
-c++ -I <em>path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt> example.cpp -o example
+c++ -I <em>path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt> example.cpp -o example
</pre>
<p>To test the result, type:</p>
<pre class="literal-block">
@@ -240,7 +241,7 @@
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
<div class="section" id="errors-and-warnings">
-<h2><a class="toc-backref" href="#id22">4.1 Errors and
Warnings</a></h2>
+<h2><a class="toc-backref" href="#id25">4.1 Errors and
Warnings</a></h2>
<p>Don't be alarmed if you see compiler warnings originating in Boost
headers. We try to eliminate them, but doing so isn't always
practical.<a class="footnote-reference" href="#warnings"
id="id5"><sup>3</sup></a> <strong>Errors are another matter</strong>. If
you're
@@ -253,29 +254,29 @@
</div>
</div>
<div class="section" id="prepare-to-use-a-boost-library-binary">
-<h1><a class="toc-backref" href="#id23">5 Prepare to Use
a Boost Library Binary</a></h1>
+<h1><a class="toc-backref" href="#id26">5 Prepare to Use
a Boost Library Binary</a></h1>
<p>If you want to use any of the separately-compiled Boost libraries,
you'll need to acquire library binaries.</p>
<div class="section" id="easy-build-and-install">
-<h2><a class="toc-backref" href="#id24">5.1 Easy Build
and Install</a></h2>
+<h2><a class="toc-backref" href="#id27">5.1 Easy Build
and Install</a></h2>
<p>Issue the following commands in the shell (don't type <tt
class="docutils literal"><span class="pre">$</span></tt>; that
represents the shell's prompt):</p>
<pre class="literal-block">
-<strong>$</strong> cd <em>path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt>
-<strong>$</strong> ./configure --help
+<strong>$</strong> cd <em>path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt>
+<strong>$</strong> ./bootstrap.sh --help
</pre>
-<p>Select your configuration options and invoke <tt class="docutils
literal"><span class="pre">./configure</span></tt> again
+<p>Select your configuration options and invoke <tt class="docutils
literal"><span class="pre">./bootstrap.sh</span></tt> again
without the <tt class="docutils literal"><span
class="pre">--help</span></tt> option. Unless you have write permission in
your system's <tt class="docutils literal"><span
class="pre">/usr/local/</span></tt> directory, you'll probably want to at
least use</p>
<pre class="literal-block">
-<strong>$</strong> ./configure
<strong>--prefix=</strong><em>path</em>/<em>to</em>/<em>installation</em>/<em>prefix</em>
+<strong>$</strong> ./bootstrap.sh
<strong>--prefix=</strong><em>path</em>/<em>to</em>/<em>installation</em>/<em>prefix</em>
</pre>
<p>to install somewhere else. Also, consider using the
-<tt class="docutils literal"><span
class="pre">--show-libraries</span></tt> and <tt class="docutils
literal"><span class="pre">--with-libraries=</span></tt> options to limit
the
+<tt class="docutils literal"><span
class="pre">--show-libraries</span></tt> and <tt class="docutils
literal"><span class="pre">--with-</span></tt><em>library_name</em> options
to limit the
long wait you'll experience if you build everything. Finally,</p>
<pre class="literal-block">
-<strong>$</strong> make install
+<strong>$</strong> ./bjam install
</pre>
<p>will leave Boost binaries in the <tt class="docutils literal"><span
class="pre">lib/</span></tt> subdirectory of your
installation prefix. You will also find a copy of the Boost
@@ -285,7 +286,7 @@
<p><a class="reference internal"
href="#link-your-program-to-a-boost-library"><em>skip to the next
step</em></a></p>
</div>
<div class="section" id="or-build-custom-binaries">
-<h2><a class="toc-backref" href="#id25">5.2 Or, Build
Custom Binaries</a></h2>
+<h2><a class="toc-backref" href="#id28">5.2 Or, Build
Custom Binaries</a></h2>
<p>If you're using a compiler other than your system's default, you'll
need to use <a class="reference external"
href="../../tools/build/index.html">Boost.Build</a> to create binaries.
You'll also
use this method if you need a nonstandard build variant (see the
@@ -298,18 +299,22 @@
<tt class="docutils literal"><span class="pre">bjam</span></tt>.</p>
<!-- .. _Boost.Jam documentation: Boost.Jam_ -->
<div class="section" id="get-bjam">
-<h3><a class="toc-backref" href="#id26">5.2.1 Get <tt
class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
+<h3><a class="toc-backref" href="#id29">5.2.1 Get <tt
class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
<p><tt class="docutils literal"><span class="pre">bjam</span></tt> is the
command-line tool that drives the Boost Build
system. To build Boost binaries, you'll invoke <tt class="docutils
literal"><span class="pre">bjam</span></tt> from the
Boost root.</p>
-<p>Boost provides <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941";>pre-compiled
<tt class="docutils literal"><span class="pre">bjam</span></tt>
executables</a> for a variety of platforms.
+<p>We suggest you <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941";>download
a pre-built <tt class="docutils literal"><span class="pre">bjam</span></tt>
executable</a> for your platform.
Alternatively, you can build <tt class="docutils literal"><span
class="pre">bjam</span></tt> yourself using <a class="reference external"
href="../../doc/html/jam/building.html">these
instructions</a>.</p>
+<p>Move the <tt class="docutils literal"><span
class="pre">bjam</span></tt> executable into a directory in your PATH. You
can
+see the list of directories in your PATH, separated by colons,
+by typing “<tt class="docutils literal"><span class="pre">echo</span>
<span class="pre">$PATH</span></tt>” at the command prompt.</p>
</div>
<div class="section" id="identify-your-toolset">
-<span id="toolset-name"></span><span id="toolset"></span><h3><a
class="toc-backref" href="#id27">5.2.2 Identify Your
Toolset</a></h3>
+<span id="toolset-name"></span><span id="toolset"></span><h3><a
class="toc-backref" href="#id30">5.2.2 Identify Your
Toolset</a></h3>
<p>First, find the toolset corresponding to your compiler in the
-following table.</p>
+following table (an up-to-date list is always available <a
class="reference external"
href="http://www.boost.org/boost-build2/doc/html/bbv2/reference/tools.html";>in
the
+Boost.Build documentation</a>).</p>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">If you previously chose a toolset for the purposes of
@@ -346,11 +351,11 @@
toolset to act as its backend</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">cw</span></tt></td>
-<td>Metrowerks/FreeScale</td>
+<td>Metrowerks/Freescale</td>
<td>The CodeWarrior compiler. We
have not tested versions of
this compiler produced since
-it was sold to FreeScale.</td>
+it was sold to Freescale.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">dmc</span></tt></td>
<td>Digital Mars</td>
@@ -379,10 +384,6 @@
<td>Intel</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal"><span
class="pre">kylix</span></tt></td>
-<td>Borland</td>
-<td> </td>
-</tr>
<tr><td><tt class="docutils literal"><span
class="pre">msvc</span></tt></td>
<td>Microsoft</td>
<td> </td>
@@ -409,7 +410,7 @@
<tt class="docutils literal"><span class="pre">borland-5.4.3</span></tt>.
<tt class="docutils literal"> </tt></p>
</div>
<div class="section" id="select-a-build-directory">
-<span id="id10"></span><span id="build-directory"></span><h3><a
class="toc-backref" href="#id28">5.2.3 Select a Build
Directory</a></h3>
+<span id="id11"></span><span id="build-directory"></span><h3><a
class="toc-backref" href="#id31">5.2.3 Select a Build
Directory</a></h3>
<p><a class="reference external"
href="../../tools/build/index.html">Boost.Build</a> will place all
intermediate files it generates while
building into the <strong>build directory</strong>. If your Boost root
directory is writable, this step isn't strictly necessary: by
@@ -417,27 +418,25 @@
purpose in your current working directory.</p>
</div>
<div class="section" id="invoke-bjam">
-<h3><a class="toc-backref" href="#id29">5.2.4 Invoke <tt
class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
+<h3><a class="toc-backref" href="#id32">5.2.4 Invoke <tt
class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
<p>Change your current directory to the Boost root directory and
invoke <tt class="docutils literal"><span class="pre">bjam</span></tt> as
follows:</p>
<pre class="literal-block">
-bjam <strong>--build-dir=</strong><a class="reference internal"
href="#id10"><em>build-directory</em></a> <strong>--toolset=</strong><a
class="reference internal" href="#toolset-name"><em>toolset-name</em></a>
<em>[</em><strong>--build-type=complete</strong><em>]</em> stage
+bjam <strong>--build-dir=</strong><a class="reference internal"
href="#id11"><em>build-directory</em></a> <strong>toolset=</strong><a
class="reference internal" href="#toolset-name"><em>toolset-name</em></a>
<tt class="docutils literal"> </tt> stage
</pre>
+<p>For a complete description of these and other invocation options,
+please see the <a class="reference external"
href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html";>Boost.Build
documentation</a>.</p>
<p>For example, your session might look like this:</p>
<pre class="literal-block">
-$ cd ~/<tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt>
-$ bjam <strong>--build-dir=</strong>/tmp/build-boost
<strong>--toolset=</strong>gcc stage
+$ cd ~/<tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt>
+$ bjam <strong>--build-dir=</strong>/tmp/build-boost
<strong>toolset=</strong>gcc stage
</pre>
-<p>That will build static and shared non-debug multi-threaded variations
of the libraries. To build all variations:</p>
-<pre class="literal-block">
-$ cd ~/<tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt>
-$ bjam <strong>--build-dir=</strong>/tmp/build-boost
<strong>--toolset=</strong>gcc <strong>--build-type=complete</strong> stage
-</pre>
+<p>That will build static and shared non-debug multi-threaded variants of
the libraries. To build all variants, pass the additional option, “<tt
class="docutils literal"><span
class="pre">--build-type=complete</span></tt>”.</p>
<!-- Copyright David Abrahams 2006. 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)
-->
<p>Building the special <tt class="docutils literal"><span
class="pre">stage</span></tt> target places Boost
-library binaries in the <tt class="docutils literal"><span
class="pre">stage</span></tt><tt class="docutils literal"><span
class="pre">/</span></tt> subdirectory of your <a class="reference
internal" href="#build-directory">build
+library binaries in the <tt class="docutils literal"><span
class="pre">stage</span></tt><tt class="docutils literal"><span
class="pre">/</span></tt><tt class="docutils literal"><span
class="pre">lib</span></tt><tt class="docutils literal"><span
class="pre">/</span></tt> subdirectory of your <a class="reference
internal" href="#build-directory">build
directory</a>.</p>
<div class="note">
<p class="first admonition-title">Note</p>
@@ -457,10 +456,17 @@
<li>choosing a specific build variant by adding <tt class="docutils
literal"><span class="pre">release</span></tt> or
<tt class="docutils literal"><span class="pre">debug</span></tt> to the
command line.</li>
</ul>
+<div class="note">
+<p class="first admonition-title">Note</p>
+<p class="last">Boost.Build can produce a great deal of output, which can
+make it easy to miss problems. If you want to make sure
+everything is went well, you might redirect the output into a
+file by appending “<tt class="docutils literal"><span
class="pre">>build.log</span> <span class="pre">2>&1</span></tt>”
to your command line.</p>
+</div>
</div>
</div>
<div class="section" id="expected-build-output">
-<h2><a class="toc-backref" href="#id30">5.3 Expected
Build Output</a></h2>
+<h2><a class="toc-backref" href="#id33">5.3 Expected
Build Output</a></h2>
<p>During the process of building Boost libraries, you can expect to
see some messages printed on the console. These may include</p>
<ul>
@@ -484,7 +490,7 @@
</ul>
</div>
<div class="section" id="in-case-of-build-errors">
-<h2><a class="toc-backref" href="#id31">5.4 In Case of
Build Errors</a></h2>
+<h2><a class="toc-backref" href="#id34">5.4 In Case of
Build Errors</a></h2>
<p>The only error messages you see when building Boost—if any—should
be related to the IOStreams library's support of zip and bzip2
formats as described <a class="reference external"
href="../../libs/iostreams/doc/installation.html">here</a>. Install the
relevant development
@@ -492,17 +498,16 @@
errors when building Boost libraries are cause for concern.</p>
<p>If it seems like the build system can't find your compiler and/or
linker, consider setting up a <tt class="docutils literal"><span
class="pre">user-config.jam</span></tt> file as described
-in the <a class="reference external"
href="../../tools/build/index.html">Boost.Build documentation</a>. If that
isn't your problem or
-the <tt class="docutils literal"><span
class="pre">user-config.jam</span></tt> file doesn't work for you, please
address
-questions about configuring Boost for your compiler to the
-<a class="reference external"
href="http://www.boost.org/more/mailing_lists.htm#jamboost";>Boost.Build
mailing list</a>.</p>
+<a class="reference external"
href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/configuration.html";>here</a>.
If that isn't your problem or the <tt class="docutils literal"><span
class="pre">user-config.jam</span></tt> file
+doesn't work for you, please address questions about configuring Boost
+for your compiler to the <a class="reference external"
href="http://www.boost.org/more/mailing_lists.htm#jamboost";>Boost.Build
mailing list</a>.</p>
<!-- Copyright David Abrahams 2006. 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)
-->
</div>
</div>
<div class="section" id="link-your-program-to-a-boost-library">
-<h1><a class="toc-backref" href="#id32">6 Link Your
Program to a Boost Library</a></h1>
+<h1><a class="toc-backref" href="#id35">6 Link Your
Program to a Boost Library</a></h1>
<p>To demonstrate linking with a Boost binary library, we'll use the
following simple program that extracts the subject lines from
emails. It uses the <a class="reference external"
href="../../libs/regex/index.html">Boost.Regex</a> library, which has a
@@ -538,15 +543,15 @@
<ol class="upperalpha">
<li><p class="first">You can specify the full path to each library:</p>
<pre class="literal-block">
-$ c++ -I <em>path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt> example.cpp -o example
<strong>\</strong>
- <strong>~/boost/lib/libboost_regex-gcc34-mt-d-1_36.a</strong>
+$ c++ -I <em>path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt> example.cpp -o example
<strong>\</strong>
+ <strong>~/boost/stage/lib/libboost_regex-gcc34-mt-d-1_36.a</strong>
</pre>
</li>
-<li><p class="first">You can separately specify a directory to search
(with <tt class="docutils literal"><span
class="pre">-L</span></tt><em>directory</em>) and a library name to search
for (with <tt class="docutils literal"><span
class="pre">-l</span></tt><em>library</em>,<a class="footnote-reference"
href="#lowercase-l" id="id12"><sup>2</sup></a> dropping the filename's
leading <tt class="docutils literal"><span class="pre">lib</span></tt> and
trailing
+<li><p class="first">You can separately specify a directory to search
(with <tt class="docutils literal"><span
class="pre">-L</span></tt><em>directory</em>) and a library name to search
for (with <tt class="docutils literal"><span
class="pre">-l</span></tt><em>library</em>,<a class="footnote-reference"
href="#lowercase-l" id="id15"><sup>2</sup></a> dropping the filename's
leading <tt class="docutils literal"><span class="pre">lib</span></tt> and
trailing
suffix (<tt class="docutils literal"><span class="pre">.a</span></tt> in
this case):</p>
<pre class="literal-block">
-$ c++ -I <em>path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt> example.cpp -o example
<strong>\</strong>
- <strong>-L~/boost/lib/ -lboost_regex-gcc34-mt-d-1_36</strong>
+$ c++ -I <em>path/to/</em><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt> example.cpp -o example
<strong>\</strong>
+ <strong>-L~/boost/stage/lib/ -lboost_regex-gcc34-mt-d-1_36</strong>
</pre>
<p>As you can see, this method is just as terse as method A for one
library; it <em>really</em> pays off when you're using multiple
@@ -560,7 +565,7 @@
<p>In both cases above, the bold text is what you'd add to <a
class="reference internal" href="#build-a-simple-program-using-boost">the
command lines we explored earlier</a>.</p>
<div class="section" id="library-naming">
-<h2><a class="toc-backref" href="#id33">6.1 Library
Naming</a></h2>
+<h2><a class="toc-backref" href="#id36">6.1 Library
Naming</a></h2>
<!-- Copyright David Abrahams 2006. 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)
-->
@@ -575,7 +580,7 @@
<dd><em>Prefix</em>: except on Microsoft Windows, every Boost library
name begins with this string. On Windows, only ordinary static
libraries use the <tt class="docutils literal"><span
class="pre">lib</span></tt> prefix; import libraries and DLLs do
-not.<a class="footnote-reference" href="#distinct"
id="id14"><sup>4</sup></a></dd>
+not.<a class="footnote-reference" href="#distinct"
id="id17"><sup>4</sup></a></dd>
<dt><tt class="docutils literal"><span
class="pre">boost_regex</span></tt></dt>
<dd><em>Library name</em>: all boost library filenames begin with <tt
class="docutils literal"><span class="pre">boost_</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">-vc71</span></tt></dt>
@@ -613,14 +618,14 @@
<td>using a special <a class="reference external"
href="../../libs/python/doc/building.html#variants">debug build of
Python</a>.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">d</span></tt></td>
-<td>building a debug version of your code.<a class="footnote-reference"
href="#debug-abi" id="id15"><sup>5</sup></a></td>
+<td>building a debug version of your code.<a class="footnote-reference"
href="#debug-abi" id="id18"><sup>5</sup></a></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">p</span></tt></td>
<td>using the STLPort standard library rather than the default one
supplied with
your compiler.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">n</span></tt></td>
-<td>using STLPort's deprecated “native iostreams” feature.<a
class="footnote-reference" href="#native" id="id16"><sup>6</sup></a></td>
+<td>using STLPort's deprecated “native iostreams” feature.<a
class="footnote-reference" href="#native" id="id19"><sup>6</sup></a></td>
</tr>
</tbody>
</table>
@@ -640,8 +645,7 @@
convention. On most unix-style platforms the extensions are
<tt class="docutils literal"><span class="pre">.a</span></tt> and <tt
class="docutils literal"><span class="pre">.so</span></tt> for static
libraries (archives) and shared
libraries, respectively. On Windows, <tt class="docutils literal"><span
class="pre">.dll</span></tt> indicates a shared
-library and (except for static libraries built by the <tt class="docutils
literal"><span class="pre">gcc</span></tt>
-<a class="reference internal" href="#toolset">toolset</a>, whose names
always end in <tt class="docutils literal"><span
class="pre">.a</span></tt>) <tt class="docutils literal"><span
class="pre">.lib</span></tt> indicates a
+library and <tt class="docutils literal"><span
class="pre">.lib</span></tt> indicates a
static or import library. Where supported by toolsets on unix
variants, a full version extension is added (e.g. ".so.1.34") and
a symbolic link to the library file, named without the trailing
@@ -653,7 +657,7 @@
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
</div>
<div class="section" id="test-your-program">
-<h2><a class="toc-backref" href="#id34">6.2 Test Your
Program</a></h2>
+<h2><a class="toc-backref" href="#id37">6.2 Test Your
Program</a></h2>
<p>To test our subject extraction, we'll filter the following text
file. Copy it out of your browser and save it as <tt class="docutils
literal"><span class="pre">jayne.txt</span></tt>:</p>
<pre class="literal-block">
@@ -693,7 +697,7 @@
</div>
</div>
<div class="section" id="conclusion-and-further-resources">
-<h1><a class="toc-backref" href="#id35">7 Conclusion and
Further Resources</a></h1>
+<h1><a class="toc-backref" href="#id38">7 Conclusion and
Further Resources</a></h1>
<p>This concludes your introduction to Boost and to integrating it
with your programs. As you start using Boost in earnest, there are
surely a few additional points you'll wish we had covered. One day
@@ -730,7 +734,7 @@
<table class="docutils footnote" frame="void" id="lowercase-l"
rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label"><a class="fn-backref"
href="#id12">[2]</a></td><td>That option is a dash followed by a lowercase
“L”
+<tr><td class="label"><a class="fn-backref"
href="#id15">[2]</a></td><td>That option is a dash followed by a lowercase
“L”
character, which looks very much like a numeral 1 in some fonts.</td></tr>
</tbody>
</table>
@@ -751,7 +755,7 @@
<table class="docutils footnote" frame="void" id="distinct" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label"><a class="fn-backref"
href="#id14">[4]</a></td><td>This convention distinguishes the static
version of
+<tr><td class="label"><a class="fn-backref"
href="#id17">[4]</a></td><td>This convention distinguishes the static
version of
a Boost library from the import library for an
identically-configured Boost DLL, which would otherwise have the
same name.</td></tr>
@@ -760,7 +764,7 @@
<table class="docutils footnote" frame="void" id="debug-abi" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label"><a class="fn-backref"
href="#id15">[5]</a></td><td>These libraries were compiled without
optimization
+<tr><td class="label"><a class="fn-backref"
href="#id18">[5]</a></td><td>These libraries were compiled without
optimization
or inlining, with full debug symbols enabled, and without
<tt class="docutils literal"><span class="pre">NDEBUG</span></tt> <tt
class="docutils literal"><span class="pre">#define</span></tt>d. Although
it's true that sometimes
these choices don't affect binary compatibility with other
@@ -770,7 +774,7 @@
<table class="docutils footnote" frame="void" id="native" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label"><a class="fn-backref"
href="#id16">[6]</a></td><td>This feature of STLPort is deprecated because
it's
+<tr><td class="label"><a class="fn-backref"
href="#id19">[6]</a></td><td>This feature of STLPort is deprecated because
it's
impossible to make it work transparently to the user; we don't
recommend it.</td></tr>
</tbody>
=======================================
--- /trunk/more/getting_started/windows.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/getting_started/windows.html Sat Sep 12 01:00:21 2009
@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.5:
http://docutils.sourceforge.net/"; />
+<meta name="generator" content="Docutils 0.6:
http://docutils.sourceforge.net/"; />
<title>Boost Getting Started on Windows</title>
<link rel="stylesheet" href="../../rst.css" type="text/css" />
</head>
@@ -26,61 +26,64 @@
<div class="contents topic" id="index">
<p class="topic-title first">Index</p>
<ul class="auto-toc simple">
-<li><a class="reference internal" href="#get-boost"
id="id26">1 Get Boost</a></li>
-<li><a class="reference internal" href="#the-boost-distribution"
id="id27">2 The Boost Distribution</a></li>
-<li><a class="reference internal" href="#header-only-libraries"
id="id28">3 Header-Only Libraries</a></li>
-<li><a class="reference internal"
href="#build-a-simple-program-using-boost"
id="id29">4 Build a Simple Program Using Boost</a><ul
class="auto-toc">
-<li><a class="reference internal" href="#build-from-the-visual-studio-ide"
id="id30">4.1 Build From the Visual Studio IDE</a></li>
-<li><a class="reference internal" href="#or-build-from-the-command-prompt"
id="id31">4.2 Or, Build From the Command Prompt</a></li>
-<li><a class="reference internal" href="#errors-and-warnings"
id="id32">4.3 Errors and Warnings</a></li>
+<li><a class="reference internal" href="#get-boost"
id="id30">1 Get Boost</a></li>
+<li><a class="reference internal" href="#the-boost-distribution"
id="id31">2 The Boost Distribution</a></li>
+<li><a class="reference internal" href="#header-only-libraries"
id="id32">3 Header-Only Libraries</a></li>
+<li><a class="reference internal"
href="#build-a-simple-program-using-boost"
id="id33">4 Build a Simple Program Using Boost</a><ul
class="auto-toc">
+<li><a class="reference internal" href="#build-from-the-visual-studio-ide"
id="id34">4.1 Build From the Visual Studio IDE</a></li>
+<li><a class="reference internal" href="#or-build-from-the-command-prompt"
id="id35">4.2 Or, Build From the Command Prompt</a></li>
+<li><a class="reference internal" href="#errors-and-warnings"
id="id36">4.3 Errors and Warnings</a></li>
</ul>
</li>
-<li><a class="reference internal"
href="#prepare-to-use-a-boost-library-binary"
id="id33">5 Prepare to Use a Boost Library Binary</a><ul
class="auto-toc">
-<li><a class="reference internal" href="#install-visual-studio-binaries"
id="id34">5.1 Install Visual Studio Binaries</a></li>
-<li><a class="reference internal" href="#or-build-binaries-from-source"
id="id35">5.2 Or, Build Binaries From Source</a><ul
class="auto-toc">
-<li><a class="reference internal" href="#get-bjam"
id="id36">5.2.1 Get <tt class="docutils literal"><span
class="pre">bjam</span></tt></a></li>
-<li><a class="reference internal" href="#identify-your-toolset"
id="id37">5.2.2 Identify Your Toolset</a></li>
-<li><a class="reference internal" href="#select-a-build-directory"
id="id38">5.2.3 Select a Build Directory</a></li>
-<li><a class="reference internal" href="#invoke-bjam"
id="id39">5.2.4 Invoke <tt class="docutils literal"><span
class="pre">bjam</span></tt></a></li>
+<li><a class="reference internal"
href="#prepare-to-use-a-boost-library-binary"
id="id37">5 Prepare to Use a Boost Library Binary</a><ul
class="auto-toc">
+<li><a class="reference internal" href="#install-visual-studio-binaries"
id="id38">5.1 Install Visual Studio Binaries</a></li>
+<li><a class="reference internal" href="#or-simplified-build-from-source"
id="id39">5.2 Or, Simplified Build From Source</a></li>
+<li><a class="reference internal" href="#or-build-binaries-from-source"
id="id40">5.3 Or, Build Binaries From Source</a><ul
class="auto-toc">
+<li><a class="reference internal" href="#get-bjam"
id="id41">5.3.1 Get <tt class="docutils literal"><span
class="pre">bjam</span></tt></a></li>
+<li><a class="reference internal" href="#identify-your-toolset"
id="id42">5.3.2 Identify Your Toolset</a></li>
+<li><a class="reference internal" href="#select-a-build-directory"
id="id43">5.3.3 Select a Build Directory</a></li>
+<li><a class="reference internal" href="#invoke-bjam"
id="id44">5.3.4 Invoke <tt class="docutils literal"><span
class="pre">bjam</span></tt></a></li>
</ul>
</li>
-<li><a class="reference internal" href="#expected-build-output"
id="id40">5.3 Expected Build Output</a></li>
-<li><a class="reference internal" href="#in-case-of-build-errors"
id="id41">5.4 In Case of Build Errors</a></li>
+<li><a class="reference internal" href="#expected-build-output"
id="id45">5.4 Expected Build Output</a></li>
+<li><a class="reference internal" href="#in-case-of-build-errors"
id="id46">5.5 In Case of Build Errors</a></li>
</ul>
</li>
-<li><a class="reference internal"
href="#link-your-program-to-a-boost-library"
id="id42">6 Link Your Program to a Boost Library</a><ul
class="auto-toc">
-<li><a class="reference internal"
href="#link-from-within-the-visual-studio-ide"
id="id43">6.1 Link From Within the Visual Studio
IDE</a></li>
-<li><a class="reference internal" href="#or-link-from-the-command-prompt"
id="id44">6.2 Or, Link From the Command Prompt</a></li>
-<li><a class="reference internal" href="#library-naming"
id="id45">6.3 Library Naming</a></li>
-<li><a class="reference internal" href="#test-your-program"
id="id46">6.4 Test Your Program</a></li>
+<li><a class="reference internal"
href="#link-your-program-to-a-boost-library"
id="id47">6 Link Your Program to a Boost Library</a><ul
class="auto-toc">
+<li><a class="reference internal"
href="#link-from-within-the-visual-studio-ide"
id="id48">6.1 Link From Within the Visual Studio
IDE</a></li>
+<li><a class="reference internal" href="#or-link-from-the-command-prompt"
id="id49">6.2 Or, Link From the Command Prompt</a></li>
+<li><a class="reference internal" href="#library-naming"
id="id50">6.3 Library Naming</a></li>
+<li><a class="reference internal" href="#test-your-program"
id="id51">6.4 Test Your Program</a></li>
</ul>
</li>
-<li><a class="reference internal" href="#conclusion-and-further-resources"
id="id47">7 Conclusion and Further Resources</a></li>
+<li><a class="reference internal" href="#conclusion-and-further-resources"
id="id52">7 Conclusion and Further Resources</a></li>
</ul>
</div>
<div class="section" id="get-boost">
-<h1><a class="toc-backref" href="#id26">1 Get
Boost</a></h1>
-<p>The easiest way to get a copy of Boost is to use an installer.
-The <a class="reference external"
href="http://www.boost.org/doc/libs/1_36_0/more/getting_started/index.html";>Boost
website version of this Getting Started guide</a> will
-have undated information on installers as they become available,
-or see <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";>Boost
downloads</a> or the <a class="reference external"
href="http://www.boostpro.com/products/free";>installer</a> provided by <a
class="reference external" href="http://www.boostpro.com";>BoostPro
Computing</a>. We especially recommend using
-an installer if you use Microsoft Visual Studio, because the installer can
download and install
-precompiled library binaries, saving you the trouble of building
-them yourself. To complete this tutorial, you'll need to at least
-install the <a class="reference external"
href="../../libs/regex/index.html">Boost.Regex</a> binaries when given the
option.</p>
+<h1><a class="toc-backref" href="#id30">1 Get
Boost</a></h1>
+<p>The easiest way to get a copy of Boost is to use an installer. The
+<a class="reference external"
href="http://www.boost.org/doc/libs/1_36_0/more/getting_started/index.html";>Boost
website version of this Getting Started guide</a> will have
+undated information on installers as they become available, or see
+<a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";>Boost
downloads</a> or the <a class="reference external"
href="http://www.boostpro.com/products/free";>installer</a> provided by <a
class="reference external" href="http://www.boostpro.com";>BoostPro
+Computing</a>. We especially recommend using an installer if you use
+Microsoft Visual Studio, because the installer can download and
+install precompiled library binaries, saving you the trouble of
+building them yourself. To complete this tutorial, you'll need to at
+least install the Static Multithreaded variants of the <a class="reference
external" href="../../libs/regex/index.html">Boost.Regex</a>
+binaries when given the option.</p>
<p>If you're using an earlier version of Visual Studio or some other
compiler, or if you prefer to build everything yourself, you can
-download <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";><tt
class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt
class="docutils literal"><span class="pre">.7z</span></tt></a> or <a
class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";><tt
class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt
class="docutils literal"><span class="pre">.zip</span></tt></a> and unpack
it to install a complete Boost
+download <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";><tt
class="docutils literal"><span class="pre">boost_1_40_0</span></tt><tt
class="docutils literal"><span class="pre">.7z</span></tt></a> or <a
class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";><tt
class="docutils literal"><span class="pre">boost_1_40_0</span></tt><tt
class="docutils literal"><span class="pre">.zip</span></tt></a> and unpack
it to install a complete Boost
distribution.<a class="footnote-reference" href="#zip"
id="id2"><sup>1</sup></a></p>
<!-- Copyright David Abrahams 2006. 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)
-->
</div>
<div class="section" id="the-boost-distribution">
-<h1><a class="toc-backref" href="#id27">2 The Boost
Distribution</a></h1>
+<h1><a class="toc-backref" href="#id31">2 The Boost
Distribution</a></h1>
<p>This is a sketch of the resulting directory structure:</p>
<pre class="literal-block">
-<strong>boost_1_36_0</strong><strong>\</strong> .................<em>The
“boost root directory”</em>
+<strong>boost_1_40_0</strong><strong>\</strong> .................<em>The
“boost root directory”</em>
<strong>index.htm</strong> .........<em>A copy of www.boost.org starts
here</em>
<strong>boost</strong><strong>\</strong> .........................<em>All
Boost Header files</em>
<strong>lib</strong><strong>\</strong> .....................<em>precompiled
library binaries</em>
@@ -125,7 +128,7 @@
</div>
<p>It's important to note the following:</p>
<ol class="arabic" id="boost-root-directory">
-<li><p class="first">The path to the <strong>boost root directory</strong>
(often <tt class="docutils literal"><span class="pre">C:\Program</span>
<span class="pre">Files\boost\</span></tt><tt class="docutils
literal"><span class="pre">boost_1_36_0</span></tt>) is
+<li><p class="first">The path to the <strong>boost root directory</strong>
(often <tt class="docutils literal"><span class="pre">C:\Program</span>
<span class="pre">Files\boost\</span></tt><tt class="docutils
literal"><span class="pre">boost_1_40_0</span></tt>) is
sometimes referred to as <tt class="docutils literal"><span
class="pre">$BOOST_ROOT</span></tt> in documentation and
mailing lists .</p>
</li>
@@ -160,7 +163,7 @@
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
</div>
<div class="section" id="header-only-libraries">
-<h1><a class="toc-backref" href="#id28">3 Header-Only
Libraries</a></h1>
+<h1><a class="toc-backref" href="#id32">3 Header-Only
Libraries</a></h1>
<p>The first thing many people want to know is, “how do I build
Boost?” The good news is that often, there's nothing to build.</p>
<div class="admonition-nothing-to-build admonition">
@@ -181,6 +184,7 @@
<li><a class="reference external"
href="../../libs/regex/index.html">Boost.Regex</a></li>
<li><a class="reference external"
href="../../libs/serialization/index.html">Boost.Serialization</a></li>
<li><a class="reference external"
href="../../libs/signals/index.html">Boost.Signals</a></li>
+<li><a class="reference external"
href="../../libs/system/index.html">Boost.System</a></li>
<li><a class="reference external"
href="../../doc/html/thread.html">Boost.Thread</a></li>
<li><a class="reference external"
href="../../libs/wave/index.html">Boost.Wave</a></li>
</ul>
@@ -200,7 +204,7 @@
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
</div>
<div class="section" id="build-a-simple-program-using-boost">
-<h1><a class="toc-backref" href="#id29">4 Build a Simple
Program Using Boost</a></h1>
+<h1><a class="toc-backref" href="#id33">4 Build a Simple
Program Using Boost</a></h1>
<p>To keep things simple, let's start by using a header-only library.
The following program reads a sequence of integers from standard
input, uses Boost.Lambda to multiply each number by three, and
@@ -249,14 +253,14 @@
</pre>
<p>followed by Return. For example,</p>
<pre class="literal-block">
-cd <tt class="docutils literal"><span class="pre">C:\Program</span> <span
class="pre">Files\boost\</span></tt><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt>
+cd <tt class="docutils literal"><span class="pre">C:\Program</span> <span
class="pre">Files\boost\</span></tt><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt>
</pre>
<p class="last">Long commands can be continued across several lines by
typing a
caret (<tt class="docutils literal"><span class="pre">^</span></tt>) at
the end of all but the last line. Some examples
on this page use that technique to save horizontal space.</p>
</div>
<div class="section" id="build-from-the-visual-studio-ide">
-<span id="vs-header-only"></span><h2><a class="toc-backref"
href="#id30">4.1 Build From the Visual Studio IDE</a></h2>
+<span id="vs-header-only"></span><h2><a class="toc-backref"
href="#id34">4.1 Build From the Visual Studio IDE</a></h2>
<ul>
<li><p class="first">From Visual Studio's <em>File</em> menu, select
<em>New</em> > <em>Project…</em></p>
</li>
@@ -274,7 +278,7 @@
<li><p class="first">In <em>Configuration Properties</em> >
<em>C/C++</em> > <em>General</em> > <em>Additional Include
Directories</em>, enter the path to the Boost root directory, for
example</p>
<blockquote>
-<p><tt class="docutils literal"><span class="pre">C:\Program</span> <span
class="pre">Files\boost\</span></tt><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt></p>
+<p><tt class="docutils literal"><span class="pre">C:\Program</span> <span
class="pre">Files\boost\</span></tt><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt></p>
</blockquote>
</li>
<li><p class="first">In <em>Configuration Properties</em> >
<em>C/C++</em> > <em>Precompiled Headers</em>, change
@@ -297,7 +301,7 @@
<p><a class="reference internal" href="#errors-and-warnings"><em>skip to
the next step</em></a></p>
</div>
<div class="section" id="or-build-from-the-command-prompt">
-<h2><a class="toc-backref" href="#id31">4.2 Or, Build
From the Command Prompt</a></h2>
+<h2><a class="toc-backref" href="#id35">4.2 Or, Build
From the Command Prompt</a></h2>
<p>From your computer's <em>Start</em> menu, if you are a Visual
Studio 2005 user, select</p>
<blockquote>
@@ -312,7 +316,7 @@
directory</a> to a suitable location for creating some temporary
files and type the following command followed by the Return key:</p>
<pre class="literal-block">
-cl /EHsc /I <em>path\to\</em><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt> <em>path</em>\<em>to</em>\example.cpp
+cl /EHsc /I <em>path\to\</em><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt> <em>path</em>\<em>to</em>\example.cpp
</pre>
<p>To test the result, type:</p>
<pre class="literal-block">
@@ -323,7 +327,7 @@
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
</div>
<div class="section" id="errors-and-warnings">
-<h2><a class="toc-backref" href="#id32">4.3 Errors and
Warnings</a></h2>
+<h2><a class="toc-backref" href="#id36">4.3 Errors and
Warnings</a></h2>
<p>Don't be alarmed if you see compiler warnings originating in Boost
headers. We try to eliminate them, but doing so isn't always
practical.<a class="footnote-reference" href="#warnings"
id="id7"><sup>5</sup></a> <strong>Errors are another matter</strong>. If
you're
@@ -336,21 +340,36 @@
</div>
</div>
<div class="section" id="prepare-to-use-a-boost-library-binary">
-<h1><a class="toc-backref" href="#id33">5 Prepare to Use
a Boost Library Binary</a></h1>
+<h1><a class="toc-backref" href="#id37">5 Prepare to Use
a Boost Library Binary</a></h1>
<p>If you want to use any of the separately-compiled Boost libraries,
you'll need to acquire library binaries.</p>
<div class="section" id="install-visual-studio-binaries">
-<h2><a class="toc-backref" href="#id34">5.1 Install
Visual Studio Binaries</a></h2>
-<p>The installers will download and
+<h2><a class="toc-backref" href="#id38">5.1 Install
Visual Studio Binaries</a></h2>
+<p>The installers supplied by BoostPro Computing will download and
install pre-compiled binaries into the <tt class="docutils literal"><span
class="pre">lib\</span></tt> subdirectory of the
-boost root, typically <tt class="docutils literal"><span
class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt
class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt
class="docutils literal"><span class="pre">\lib\</span></tt>. If you
installed
+boost root, typically <tt class="docutils literal"><span
class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt
class="docutils literal"><span class="pre">boost_1_40_0</span></tt><tt
class="docutils literal"><span class="pre">\lib\</span></tt>. If you
installed
all variants of the <a class="reference external"
href="../../libs/regex/index.html">Boost.Regex</a> binary, you're done with
this
step. Otherwise, please run the installer again and install them
now.</p>
<p><a class="reference internal"
href="#link-your-program-to-a-boost-library"><em>skip to the next
step</em></a></p>
</div>
+<div class="section" id="or-simplified-build-from-source">
+<h2><a class="toc-backref" href="#id39">5.2 Or,
Simplified Build From Source</a></h2>
+<p>If you wish to build from source with Visual C++, you can use a
+simple build procedure described in this section. Open the command prompt
+and change your current directory to the Boost root directory. Then, type
+the following commands:</p>
+<pre class="literal-block">
+bootstrap
+.\bjam
+</pre>
+<p>The first command prepares the Boost.Build system for use. The second
+command invokes Boost.Build to build the separately-compiled Boost
+libraries. Please consult the <a class="reference external"
href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html";>Boost.Build
documentation</a> for a list
+of options that can be passed to <tt class="docutils literal"><span
class="pre">bjam</span></tt>.</p>
+</div>
<div class="section" id="or-build-binaries-from-source">
-<h2><a class="toc-backref" href="#id35">5.2 Or, Build
Binaries From Source</a></h2>
+<h2><a class="toc-backref" href="#id40">5.3 Or, Build
Binaries From Source</a></h2>
<p>If you're using an earlier version of Visual C++, or a compiler
from another vendor, you'll need to use <a class="reference external"
href="../../tools/build/index.html">Boost.Build</a> to create your
own binaries.</p>
@@ -362,18 +381,22 @@
<tt class="docutils literal"><span class="pre">bjam</span></tt>.</p>
<!-- .. _Boost.Jam documentation: Boost.Jam_ -->
<div class="section" id="get-bjam">
-<h3><a class="toc-backref" href="#id36">5.2.1 Get <tt
class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
+<h3><a class="toc-backref" href="#id41">5.3.1 Get <tt
class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
<p><tt class="docutils literal"><span class="pre">bjam</span></tt> is the
<a class="reference internal" href="#command-line-tool">command-line
tool</a> that drives the Boost Build
system. To build Boost binaries, you'll invoke <tt class="docutils
literal"><span class="pre">bjam</span></tt> from the
Boost root.</p>
-<p>Boost provides <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941";>pre-compiled
<tt class="docutils literal"><span class="pre">bjam</span></tt>
executables</a> for a variety of platforms.
+<p>We suggest you <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941";>download
a pre-built <tt class="docutils literal"><span class="pre">bjam</span></tt>
executable</a> for your platform.
Alternatively, you can build <tt class="docutils literal"><span
class="pre">bjam</span></tt> yourself using <a class="reference external"
href="../../doc/html/jam/building.html">these
instructions</a>.</p>
+<p>Move the <tt class="docutils literal"><span
class="pre">bjam</span></tt> executable into a directory in your PATH. You
can
+see the list of directories in your PATH, separated by semicolons,
+by typing “<tt class="docutils literal"><span
class="pre">PATH</span></tt>” at the command prompt.</p>
</div>
<div class="section" id="identify-your-toolset">
-<span id="toolset-name"></span><span id="toolset"></span><h3><a
class="toc-backref" href="#id37">5.2.2 Identify Your
Toolset</a></h3>
+<span id="toolset-name"></span><span id="toolset"></span><h3><a
class="toc-backref" href="#id42">5.3.2 Identify Your
Toolset</a></h3>
<p>First, find the toolset corresponding to your compiler in the
-following table.</p>
+following table (an up-to-date list is always available <a
class="reference external"
href="http://www.boost.org/boost-build2/doc/html/bbv2/reference/tools.html";>in
the
+Boost.Build documentation</a>).</p>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last">If you previously chose a toolset for the purposes of
@@ -410,11 +433,11 @@
toolset to act as its backend</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">cw</span></tt></td>
-<td>Metrowerks/FreeScale</td>
+<td>Metrowerks/Freescale</td>
<td>The CodeWarrior compiler. We
have not tested versions of
this compiler produced since
-it was sold to FreeScale.</td>
+it was sold to Freescale.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">dmc</span></tt></td>
<td>Digital Mars</td>
@@ -443,10 +466,6 @@
<td>Intel</td>
<td> </td>
</tr>
-<tr><td><tt class="docutils literal"><span
class="pre">kylix</span></tt></td>
-<td>Borland</td>
-<td> </td>
-</tr>
<tr><td><tt class="docutils literal"><span
class="pre">msvc</span></tt></td>
<td>Microsoft</td>
<td> </td>
@@ -476,7 +495,7 @@
detection code) or <a class="reference internal"
href="#auto-linking">auto-linking</a> will fail.</p>
</div>
<div class="section" id="select-a-build-directory">
-<span id="id12"></span><span id="build-directory"></span><h3><a
class="toc-backref" href="#id38">5.2.3 Select a Build
Directory</a></h3>
+<span id="id14"></span><span id="build-directory"></span><h3><a
class="toc-backref" href="#id43">5.3.3 Select a Build
Directory</a></h3>
<p><a class="reference external"
href="../../tools/build/index.html">Boost.Build</a> will place all
intermediate files it generates while
building into the <strong>build directory</strong>. If your Boost root
directory is writable, this step isn't strictly necessary: by
@@ -484,34 +503,32 @@
purpose in your current working directory.</p>
</div>
<div class="section" id="invoke-bjam">
-<h3><a class="toc-backref" href="#id39">5.2.4 Invoke <tt
class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
+<h3><a class="toc-backref" href="#id44">5.3.4 Invoke <tt
class="docutils literal"><span class="pre">bjam</span></tt></a></h3>
<p>Change your current directory to the Boost root directory and
invoke <tt class="docutils literal"><span class="pre">bjam</span></tt> as
follows:</p>
<pre class="literal-block">
-bjam <strong>--build-dir=</strong><a class="reference internal"
href="#id12"><em>build-directory</em></a> <strong>--toolset=</strong><a
class="reference internal" href="#toolset-name"><em>toolset-name</em></a>
<em>[</em><strong>--build-type=complete</strong><em>]</em> stage
+bjam <strong>--build-dir=</strong><a class="reference internal"
href="#id14"><em>build-directory</em></a> <strong>toolset=</strong><a
class="reference internal" href="#toolset-name"><em>toolset-name</em></a>
<strong>--build-type=complete</strong> stage
</pre>
-<p>For example, your session might look like this:<a
class="footnote-reference" href="#continuation"
id="id13"><sup>4</sup></a></p>
+<p>For a complete description of these and other invocation options,
+please see the <a class="reference external"
href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html";>Boost.Build
documentation</a>.</p>
+<p>For example, your session might look like this:<a
class="footnote-reference" href="#continuation"
id="id16"><sup>4</sup></a></p>
<pre class="literal-block">
-C:\WINDOWS> cd <tt class="docutils literal"><span
class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt
class="docutils literal"><span class="pre">boost_1_36_0</span></tt>
-<tt class="docutils literal"><span class="pre">C:\Program</span> <span
class="pre">Files\boost\</span></tt><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt>> bjam <strong>^</strong>
+C:\WINDOWS> cd <tt class="docutils literal"><span
class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt
class="docutils literal"><span class="pre">boost_1_40_0</span></tt>
+<tt class="docutils literal"><span class="pre">C:\Program</span> <span
class="pre">Files\boost\</span></tt><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt>> bjam <strong>^</strong>
More? <strong>--build-dir=</strong>"C:\Documents and
Settings\dave\build-boost" <strong>^</strong>
-More? <strong>--toolset=</strong>msvc stage
+More? <strong>--build-type=complete</strong> <strong>msvc</strong> stage
</pre>
<p>Be sure to read <a class="reference internal" href="#continuation">this
note</a> about the appearance of <tt class="docutils literal"><span
class="pre">^</span></tt>,
<tt class="docutils literal"><span class="pre">More?</span></tt> and
quotation marks (<tt class="docutils literal"><span
class="pre">"</span></tt>) in that line.</p>
-<p>The above example session will build static and shared non-debug
multi-threaded
-variations of the libraries. To build all variations:</p>
-<pre class="literal-block">
-C:\WINDOWS> cd <tt class="docutils literal"><span
class="pre">C:\Program</span> <span class="pre">Files\boost\</span></tt><tt
class="docutils literal"><span class="pre">boost_1_36_0</span></tt>
-<tt class="docutils literal"><span class="pre">C:\Program</span> <span
class="pre">Files\boost\</span></tt><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt>> bjam <strong>^</strong>
-More? <strong>--build-dir=</strong>"C:\Documents and
Settings\dave\build-boost" <strong>^</strong>
-More? <strong>--toolset=</strong>msvc
<strong>--build-type=complete</strong> stage
-</pre>
+<p>The option “<strong>--build-type=complete</strong>” causes <tt
class="docutils literal"><span class="pre">bjam</span></tt> to build
+all supported variants of the libraries. For instructions on how to
+build only specific variants, please ask on the <a class="reference
external"
href="http://www.boost.org/more/mailing_lists.htm#jamboost";>Boost.Build
mailing
+list</a>.</p>
<!-- Copyright David Abrahams 2006. 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)
-->
<p>Building the special <tt class="docutils literal"><span
class="pre">stage</span></tt> target places Boost
-library binaries in the <tt class="docutils literal"><span
class="pre">stage</span></tt><tt class="docutils literal"><span
class="pre">\</span></tt> subdirectory of your <a class="reference
internal" href="#build-directory">build
+library binaries in the <tt class="docutils literal"><span
class="pre">stage</span></tt><tt class="docutils literal"><span
class="pre">\</span></tt><tt class="docutils literal"><span
class="pre">lib</span></tt><tt class="docutils literal"><span
class="pre">\</span></tt> subdirectory of your <a class="reference
internal" href="#build-directory">build
directory</a>.</p>
<div class="note">
<p class="first admonition-title">Note</p>
@@ -531,10 +548,17 @@
<li>choosing a specific build variant by adding <tt class="docutils
literal"><span class="pre">release</span></tt> or
<tt class="docutils literal"><span class="pre">debug</span></tt> to the
command line.</li>
</ul>
+<div class="note">
+<p class="first admonition-title">Note</p>
+<p class="last">Boost.Build can produce a great deal of output, which can
+make it easy to miss problems. If you want to make sure
+everything is went well, you might redirect the output into a
+file by appending “<tt class="docutils literal"><span
class="pre">>build.log</span> <span class="pre">2>&1</span></tt>”
to your command line.</p>
+</div>
</div>
</div>
<div class="section" id="expected-build-output">
-<h2><a class="toc-backref" href="#id40">5.3 Expected
Build Output</a></h2>
+<h2><a class="toc-backref" href="#id45">5.4 Expected
Build Output</a></h2>
<p>During the process of building Boost libraries, you can expect to
see some messages printed on the console. These may include</p>
<ul>
@@ -558,7 +582,7 @@
</ul>
</div>
<div class="section" id="in-case-of-build-errors">
-<h2><a class="toc-backref" href="#id41">5.4 In Case of
Build Errors</a></h2>
+<h2><a class="toc-backref" href="#id46">5.5 In Case of
Build Errors</a></h2>
<p>The only error messages you see when building Boost—if any—should
be related to the IOStreams library's support of zip and bzip2
formats as described <a class="reference external"
href="../../libs/iostreams/doc/installation.html">here</a>. Install the
relevant development
@@ -566,17 +590,16 @@
errors when building Boost libraries are cause for concern.</p>
<p>If it seems like the build system can't find your compiler and/or
linker, consider setting up a <tt class="docutils literal"><span
class="pre">user-config.jam</span></tt> file as described
-in the <a class="reference external"
href="../../tools/build/index.html">Boost.Build documentation</a>. If that
isn't your problem or
-the <tt class="docutils literal"><span
class="pre">user-config.jam</span></tt> file doesn't work for you, please
address
-questions about configuring Boost for your compiler to the
-<a class="reference external"
href="http://www.boost.org/more/mailing_lists.htm#jamboost";>Boost.Build
mailing list</a>.</p>
+<a class="reference external"
href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/configuration.html";>here</a>.
If that isn't your problem or the <tt class="docutils literal"><span
class="pre">user-config.jam</span></tt> file
+doesn't work for you, please address questions about configuring Boost
+for your compiler to the <a class="reference external"
href="http://www.boost.org/more/mailing_lists.htm#jamboost";>Boost.Build
mailing list</a>.</p>
<span class="target" id="auto-linking"></span><!-- Copyright David
Abrahams 2006. 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)
-->
</div>
</div>
<div class="section" id="link-your-program-to-a-boost-library">
-<h1><a class="toc-backref" href="#id42">6 Link Your
Program to a Boost Library</a></h1>
+<h1><a class="toc-backref" href="#id47">6 Link Your
Program to a Boost Library</a></h1>
<p>To demonstrate linking with a Boost binary library, we'll use the
following simple program that extracts the subject lines from
emails. It uses the <a class="reference external"
href="../../libs/regex/index.html">Boost.Regex</a> library, which has a
@@ -621,7 +644,7 @@
variant OSes</a> for the appropriate command-line options to use.</p>
</div>
<div class="section" id="link-from-within-the-visual-studio-ide">
-<h2><a class="toc-backref" href="#id43">6.1 Link From
Within the Visual Studio IDE</a></h2>
+<h2><a class="toc-backref" href="#id48">6.1 Link From
Within the Visual Studio IDE</a></h2>
<p>Starting with the <a class="reference internal"
href="#vs-header-only">header-only example project</a> we created
earlier:</p>
<ol class="arabic simple">
@@ -629,24 +652,24 @@
select <em>Properties</em> from the resulting pop-up menu</li>
<li>In <em>Configuration Properties</em> > <em>Linker</em> >
<em>Additional Library
Directories</em>, enter the path to the Boost binaries,
-e.g. <tt class="docutils literal"><span class="pre">C:\Program</span>
<span class="pre">Files\boost\</span></tt><tt class="docutils
literal"><span class="pre">boost_1_36_0</span></tt><tt class="docutils
literal"><span class="pre">\lib\</span></tt>.</li>
+e.g. <tt class="docutils literal"><span class="pre">C:\Program</span>
<span class="pre">Files\boost\</span></tt><tt class="docutils
literal"><span class="pre">boost_1_40_0</span></tt><tt class="docutils
literal"><span class="pre">\lib\</span></tt>.</li>
<li>From the <em>Build</em> menu, select <em>Build Solution</em>.</li>
</ol>
<p><a class="reference internal" href="#test-your-program"><em>skip to the
next step</em></a></p>
</div>
<div class="section" id="or-link-from-the-command-prompt">
-<h2><a class="toc-backref" href="#id44">6.2 Or, Link From
the Command Prompt</a></h2>
+<h2><a class="toc-backref" href="#id49">6.2 Or, Link From
the Command Prompt</a></h2>
<p>For example, we can compile and link the above program from the
Visual C++ command-line by simply adding the <strong>bold</strong> text
below to
the command line we used earlier, assuming your Boost binaries are
-in <tt class="docutils literal"><span class="pre">C:\Program</span> <span
class="pre">Files\boost\</span></tt><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt><tt class="docutils literal"><span
class="pre">\lib</span></tt>:</p>
+in <tt class="docutils literal"><span class="pre">C:\Program</span> <span
class="pre">Files\boost\</span></tt><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt><tt class="docutils literal"><span
class="pre">\lib</span></tt>:</p>
<pre class="literal-block">
-cl /EHsc /I <em>path\to\</em><tt class="docutils literal"><span
class="pre">boost_1_36_0</span></tt> example.cpp <strong>^</strong>
- <strong>/link /LIBPATH:</strong> <strong>C:\Program
Files\boost\</strong><strong>boost_1_36_0</strong><strong>\lib</strong>
+cl /EHsc /I <em>path\to\</em><tt class="docutils literal"><span
class="pre">boost_1_40_0</span></tt> example.cpp <strong>^</strong>
+ <strong>/link /LIBPATH:</strong> <strong>C:\Program
Files\boost\</strong><strong>boost_1_40_0</strong><strong>\lib</strong>
</pre>
</div>
<div class="section" id="library-naming">
-<h2><a class="toc-backref" href="#id45">6.3 Library
Naming</a></h2>
+<h2><a class="toc-backref" href="#id50">6.3 Library
Naming</a></h2>
<div class="note">
<p class="first admonition-title">Note</p>
<p>If, like Visual C++, your compiler supports auto-linking,
@@ -668,7 +691,7 @@
<dd><em>Prefix</em>: except on Microsoft Windows, every Boost library
name begins with this string. On Windows, only ordinary static
libraries use the <tt class="docutils literal"><span
class="pre">lib</span></tt> prefix; import libraries and DLLs do
-not.<a class="footnote-reference" href="#distinct"
id="id20"><sup>6</sup></a></dd>
+not.<a class="footnote-reference" href="#distinct"
id="id24"><sup>6</sup></a></dd>
<dt><tt class="docutils literal"><span
class="pre">boost_regex</span></tt></dt>
<dd><em>Library name</em>: all boost library filenames begin with <tt
class="docutils literal"><span class="pre">boost_</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">-vc71</span></tt></dt>
@@ -706,14 +729,14 @@
<td>using a special <a class="reference external"
href="../../libs/python/doc/building.html#variants">debug build of
Python</a>.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">d</span></tt></td>
-<td>building a debug version of your code.<a class="footnote-reference"
href="#debug-abi" id="id21"><sup>7</sup></a></td>
+<td>building a debug version of your code.<a class="footnote-reference"
href="#debug-abi" id="id25"><sup>7</sup></a></td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">p</span></tt></td>
<td>using the STLPort standard library rather than the default one
supplied with
your compiler.</td>
</tr>
<tr><td><tt class="docutils literal"><span class="pre">n</span></tt></td>
-<td>using STLPort's deprecated “native iostreams” feature.<a
class="footnote-reference" href="#native" id="id22"><sup>8</sup></a></td>
+<td>using STLPort's deprecated “native iostreams” feature.<a
class="footnote-reference" href="#native" id="id26"><sup>8</sup></a></td>
</tr>
</tbody>
</table>
@@ -733,8 +756,7 @@
convention. On most unix-style platforms the extensions are
<tt class="docutils literal"><span class="pre">.a</span></tt> and <tt
class="docutils literal"><span class="pre">.so</span></tt> for static
libraries (archives) and shared
libraries, respectively. On Windows, <tt class="docutils literal"><span
class="pre">.dll</span></tt> indicates a shared
-library and (except for static libraries built by the <tt class="docutils
literal"><span class="pre">gcc</span></tt>
-<a class="reference internal" href="#toolset">toolset</a>, whose names
always end in <tt class="docutils literal"><span
class="pre">.a</span></tt>) <tt class="docutils literal"><span
class="pre">.lib</span></tt> indicates a
+library and <tt class="docutils literal"><span
class="pre">.lib</span></tt> indicates a
static or import library. Where supported by toolsets on unix
variants, a full version extension is added (e.g. ".so.1.34") and
a symbolic link to the library file, named without the trailing
@@ -746,7 +768,7 @@
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
-->
</div>
<div class="section" id="test-your-program">
-<h2><a class="toc-backref" href="#id46">6.4 Test Your
Program</a></h2>
+<h2><a class="toc-backref" href="#id51">6.4 Test Your
Program</a></h2>
<p>To test our subject extraction, we'll filter the following text
file. Copy it out of your browser and save it as <tt class="docutils
literal"><span class="pre">jayne.txt</span></tt>:</p>
<pre class="literal-block">
@@ -768,7 +790,7 @@
</div>
</div>
<div class="section" id="conclusion-and-further-resources">
-<h1><a class="toc-backref" href="#id47">7 Conclusion and
Further Resources</a></h1>
+<h1><a class="toc-backref" href="#id52">7 Conclusion and
Further Resources</a></h1>
<p>This concludes your introduction to Boost and to integrating it
with your programs. As you start using Boost in earnest, there are
surely a few additional points you'll wish we had covered. One day
@@ -797,7 +819,7 @@
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
<tr><td class="label"><a class="fn-backref" href="#id2">[1]</a></td><td>We
recommend
-downloading <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";><tt
class="docutils literal"><span class="pre">boost_1_36_0</span></tt><tt
class="docutils literal"><span class="pre">.7z</span></tt></a> and using <a
class="reference external" href="http://www.7-zip.org";>7-Zip</a> to
decompress
+downloading <a class="reference external"
href="http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=8041";><tt
class="docutils literal"><span class="pre">boost_1_40_0</span></tt><tt
class="docutils literal"><span class="pre">.7z</span></tt></a> and using <a
class="reference external" href="http://www.7-zip.org";>7-Zip</a> to
decompress
it. We no longer recommend .zip files for Boost because they are twice
as large as the equivalent .7z files. We don't recommend using Windows'
built-in decompression as it can be painfully slow for large
archives.</td></tr>
@@ -825,7 +847,7 @@
<table class="docutils footnote" frame="void" id="continuation"
rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label"><a class="fn-backref"
href="#id13">[4]</a></td><td><p class="first">In this example, the caret
character <tt class="docutils literal"><span class="pre">^</span></tt> is a
+<tr><td class="label"><a class="fn-backref"
href="#id16">[4]</a></td><td><p class="first">In this example, the caret
character <tt class="docutils literal"><span class="pre">^</span></tt> is a
way of continuing the command on multiple lines, and must be the
<strong>final character</strong> used on the line to be continued (i.e. do
not follow it with spaces). The command prompt responds with
@@ -863,7 +885,7 @@
<table class="docutils footnote" frame="void" id="distinct" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label"><a class="fn-backref"
href="#id20">[6]</a></td><td>This convention distinguishes the static
version of
+<tr><td class="label"><a class="fn-backref"
href="#id24">[6]</a></td><td>This convention distinguishes the static
version of
a Boost library from the import library for an
identically-configured Boost DLL, which would otherwise have the
same name.</td></tr>
@@ -872,7 +894,7 @@
<table class="docutils footnote" frame="void" id="debug-abi" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label"><a class="fn-backref"
href="#id21">[7]</a></td><td>These libraries were compiled without
optimization
+<tr><td class="label"><a class="fn-backref"
href="#id25">[7]</a></td><td>These libraries were compiled without
optimization
or inlining, with full debug symbols enabled, and without
<tt class="docutils literal"><span class="pre">NDEBUG</span></tt> <tt
class="docutils literal"><span class="pre">#define</span></tt>d. Although
it's true that sometimes
these choices don't affect binary compatibility with other
@@ -882,7 +904,7 @@
<table class="docutils footnote" frame="void" id="native" rules="none">
<colgroup><col class="label" /><col /></colgroup>
<tbody valign="top">
-<tr><td class="label"><a class="fn-backref"
href="#id22">[8]</a></td><td>This feature of STLPort is deprecated because
it's
+<tr><td class="label"><a class="fn-backref"
href="#id26">[8]</a></td><td>This feature of STLPort is deprecated because
it's
impossible to make it work transparently to the user; we don't
recommend it.</td></tr>
</tbody>
=======================================
--- /trunk/more/writingdoc/design.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/writingdoc/design.html Sat Sep 12 01:00:21 2009
@@ -558,7 +558,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/index.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/writingdoc/index.html Sat Sep 12 01:00:21 2009
@@ -39,7 +39,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/introduction.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/writingdoc/introduction.html Sat Sep 12 01:00:21 2009
@@ -50,7 +50,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/structure.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/writingdoc/structure.html Sat Sep 12 01:00:21 2009
@@ -90,40 +90,44 @@
</dl>
</dd>
+ <dt><a href="#web">Web Reference Documentation</a></dt>
+
<dt><a href="#footnotes">Footnotes</a></dt>
</dl>
<h2><a name="introduction" id="introduction">Introduction</a></h2>
- <p>Boost itself does not require any specific documentation structure.
The
- C++ Standard, however, has very explicit requirements for the description
- of library components (Section 17.3). So for Boost libraries likely to be
- proposed for inclusion in the standard, it is highly desirable to
structure
- documentation in a way that meets the requirements of the the standard.
- Doing so eliminates the need to rewrite the documentation for
- standardization.</p>
-
- <p>Library developers should remember that for a library to be accepted
as
- part of the C++ Standard Library, the proposal must include full wording.
- The committee will not do that work for you.</p>
-
- <p>Beyond that, the documentation structure required for the standard is
an
- effective way to communicate the technical specifications for a library.
- Although terse, it is already familiar to many Boost users, and is far
more
- precise than most ad hoc documentation structures.</p>
-
- <p>The following description is for the structure of documentation
required
- by the standard. Boost libraries should also provided additional
- documentation, such as introductory, tutorial, example, and rationale
- material.</p>
+ <p>Boost does not require any specific documentation structure.
+ However, there are some important considerations that
+ influence content and structure. For example, many Boost
+ libraries wind up being proposed for inclusion in the C++
+ Standard, so writing them initially with text suitable for
+ inclusion in the Standard may be helpful. Also, Boost library
+ documentation is often accessed via the World Wide Web,
+ including via search engines, so context is often important
+ for every page. Finally, Boost libraries should provide
+ additional documentation, such as introductory, tutorial,
+ example, and rationale content. With those things in mind, we
+ suggest the following guidelines for Boost library
+ documentation.</p>
<h2><a name="standards-conforming" id="standards-conforming">Standards
Conforming</a> Documentation</h2>
+ <p>The documentation structure required for the C++ Standard is
+ an effective way to describe the technical specifications for
+ a library. Although terse, that format is familiar to many
+ Boost users and is far more precise than most ad hoc formats.
+ The following description is based upon §17.3 of the
+ Standard. (Note that while final Standard proposals must
+ include full standardese wording, which the committee will
+ not do for you, that level of detail is not expected of Boost
+ library documentation.)</p>
+
<h3><a name="elements" id="elements">Document elements</a></h3>
<p>Each document contains the following elements, as applicable<a class=
- "footnote" href="#footnote1">(1)</a>:</p>
+ "footnote" href="#footnote1" id="footnote1-location">(1)</a>:</p>
<ul>
<li><a href="#summary">Summary</a></li>
@@ -197,7 +201,7 @@
<p>In some cases the semantic requirements are presented as C++ code.
Such
code is intended as a specification of equivalance of a construct to
another construct, not necessarily as the way the construct must be
- implemented.<a class="footnote" href="#footnote2">(2)</a></p>
+ implemented.<a class="footnote" href="#footnote2"
id="footnote2-location">(2)</a></p>
<h4><a name="detailed-specs" id="detailed-specs">Detailed
specification</a></h4>
@@ -218,7 +222,7 @@
</ul>
<p>Descriptions of class member functions follow the order (as
- appropriate)<a class="footnote" href="#footnote3">(3)</a>:</p>
+ appropriate)<a class="footnote" href="#footnote3"
id="footnote3-location">(3)</a>:</p>
<ul>
<li>Constructor(s) and destructor</li>
@@ -236,7 +240,7 @@
<p>Descriptions of function semantics contain the following <a name=
"function-elements" id="function-elements">elements</a> (as
- appropriate)<a class="footnote" href="#footnote4">(4):</a></p>
+ appropriate)<a class="footnote" href="#footnote4"
id="footnote4-location">(4):</a></p>
<dl class="function-semantics">
<dt><b><a href="#requires">Requires:</a></b> the preconditions for
@@ -390,24 +394,48 @@
give users a lot of insight into why a library is designed the way it is.
More importantly, it can help prevent "fixing" something that wasn't
really
broken as the library matures.</p>
+
+ <h2 id="web">Web Reference Documentation</h2>
+
+ <p>Boost library documentation is often accessed via the World
+ Web. Using search engines, a page deep in the reference
+ content could be viewed without any further context.
+ Therefore, it is helpful to add extra context, such as the
+ following, to each page:</p>
+
+ <ul>
+ <li>Describe the enclosing namespace or use fully scoped
+ identifiers.
+ <li>Document required headers for each type or function.
+ <li>Link to relevant tutorial information.
+ <li>Link to related example code.
+ <li>Include the library name.
+ <li>Include navigation elements to the beginning of the
+ documentation.
+ </ul>
+
+ <p>It is also useful to consider the effectiveness of a
+ description in search engines. Terse or cryptic descriptions
+ are less likely to help the curious find a relevant function
+ or type.</p>
<h2><a name="footnotes" id="footnotes">Footnotes</a></h2>
<dl>
- <dt><a class="footnote" name="footnote1" id="footnote1">(1)</a> To save
+ <dt><a class="footnote" id="footnote1"
href="#footnote1-location">(1)</a> To save
space, items that do not apply to a clause are omitted. For example,
if a
clause does not specify any requirements, there will be
no "Requirements"
subclause.</dt>
- <dt><a class="footnote" name="footnote2" id="footnote2">(2)</a>
Although
+ <dt><a class="footnote" id="footnote2"
href="#footnote2-location">(2)</a> Although
in some cases the code is unambiguously the optimum
implementation.</dt>
- <dt><a class="footnote" name="footnote3" id="footnote3">(3)</a> To save
+ <dt><a class="footnote" id="footnote3"
href="#footnote3-location">(3)</a> To save
space, items that do not apply to a class are omitted. For example, if
a
class does not specify any comparison functions, there will be no
"Comparison functions" subclause.</dt>
- <dt><a class="footnote" name="footnote4" id="footnote4">(4)</a> To save
+ <dt><a class="footnote" id="footnote4"
href="#footnote4-location">(4)</a> To save
space, items that do not apply to a function are omitted. For example,
if
a function does not specify any precondition, there will be
no "Requires"
paragraph.</dt>
@@ -415,7 +443,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../doc/images/valid-html401.png" alt="Valid HTML 4.01 Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/template/acknowledgments.html Thu Sep 4
07:17:16 2008
+++ /trunk/more/writingdoc/template/acknowledgments.html Sat Sep 12
01:00:21 2009
@@ -30,7 +30,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01
Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/template/bibliography.html Thu Sep 4 07:17:16
2008
+++ /trunk/more/writingdoc/template/bibliography.html Sat Sep 12 01:00:21
2009
@@ -30,7 +30,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01
Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/template/configuration.html Thu Sep 4 07:17:16
2008
+++ /trunk/more/writingdoc/template/configuration.html Sat Sep 12 01:00:21
2009
@@ -127,7 +127,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01
Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/template/definitions.html Thu Sep 4 07:17:16
2008
+++ /trunk/more/writingdoc/template/definitions.html Sat Sep 12 01:00:21
2009
@@ -60,7 +60,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01
Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/template/faq.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/writingdoc/template/faq.html Sat Sep 12 01:00:21 2009
@@ -43,7 +43,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01
Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/template/header.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/writingdoc/template/header.html Sat Sep 12 01:00:21 2009
@@ -328,7 +328,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01
Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/template/index.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/writingdoc/template/index.html Sat Sep 12 01:00:21 2009
@@ -108,7 +108,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01
Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/template/overview.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/writingdoc/template/overview.html Sat Sep 12 01:00:21 2009
@@ -61,7 +61,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01
Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/more/writingdoc/template/rationale.html Thu Sep 4 07:17:16 2008
+++ /trunk/more/writingdoc/template/rationale.html Sat Sep 12 01:00:21 2009
@@ -61,7 +61,7 @@
<hr>
<p><a href="http://validator.w3.org/check?uri=referer";><img border="0"
src=
- "http://www.w3.org/Icons/valid-html401"; alt="Valid HTML 4.01
Transitional"
+ "../../../doc/images/valid-html401.png" alt="Valid HTML 4.01
Transitional"
height="31" width="88"></a></p>
<p>Revised
=======================================
--- /trunk/wiki/index.html Thu Sep 4 07:17:16 2008
+++ /trunk/wiki/index.html Sat Sep 12 01:00:21 2009
@@ -4,10 +4,10 @@
<html>
<head>
-<meta http-equiv="refresh" content="0;
URL=http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl";>
+<meta http-equiv="refresh" content="0;
URL=https://svn.boost.org/trac/boost/";>
</head>
<body>
Take me to the
-<a
href="http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl";>Boost
Wiki</a>.
+<a href="https://svn.boost.org/trac/boost/";>Boost Wiki</a>.
</body>
</html>
Other related posts:
- » [boost-doc-zh] r328 committed - 转换至1.40.0，第11批，全部完成。 - codesite-noreply
