Subject: [Boost-commit] svn:boost r50070 - sandbox/math_toolkit/libs/math/doc/sf_and_dist
Date: 2008-12-02 10:27:34
Date: 2008-12-02 10:27:34 EST (Tue, 02 Dec 2008)
New Revision: 50070
added link the C99 and Tr1 sections.
Text files modified:
sandbox/math_toolkit/libs/math/doc/sf_and_dist/building.qbk | 33 +++++++++++++++++----------------
1 files changed, 17 insertions(+), 16 deletions(-)
--- sandbox/math_toolkit/libs/math/doc/sf_and_dist/building.qbk (original)
+++ sandbox/math_toolkit/libs/math/doc/sf_and_dist/building.qbk 2008-12-02 10:27:34 EST (Tue, 02 Dec 2008)
@@ -4,24 +4,25 @@
The first thing you need to ask yourself is "Do I need to build anything at all?"
as the bulk of this library is header only: meaning you can use it just by
-#including the necessary header(s). (The library includes everything,
-so if you only use a few components,
-your total executables size will be *much* greater).
+#including the necessary header(s). Refer to
+[link math_toolkit.special.extern_c C99 and C++ TR1 C-style Functions]
+for pros and cons of using
+the TR1 components as opposed to the header only ones.
-The ['only] time you need to build the library is if you want to use the
+The ['only] time you ['need] to build the library is if you want to use the
`extern "C"` functions declared in `<boost/math/tr1.hpp>`. To build this
using Boost.Build, from a commandline boost-root directory issue a command like:
bjam toolset=gcc --with-math install
will do the job on Linux, while:
bjam toolset=msvc --with-math --build-type=complete stage
will work better on Windows (leaving libraries built
in sub-folder `/stage` below your Boost root directory).
Either way you should consult the
getting started guide] for more information.
You can also build the libraries from your favourite IDE or command line tool:
@@ -29,7 +30,7 @@
source file with the same name in `libs/math/src/tr1`. Just select the
sources corresponding to the functions you are using and build them into
a library, or else add them directly to your project. Note that the
-directory `libs/math/src/tr1` will need to be in your compiler's
+directory `libs/math/src/tr1` will need to be in your compiler's
#include path as well as the boost-root directory
(MSVC Tools, Options, Projects and Solutions, VC++ Directories, Include files).
@@ -37,8 +38,8 @@
a Windows compiler that supports auto-linking and you have built the sources
yourself (or added them directly to your project) then you will need to
prevent `<boost/math/tr1.hpp>` from trying to auto-link to the binaries
-that Boost.Build generates. You can do this by defining either
-BOOST_MATH_NO_LIB or BOOST_ALL_NO_LIB at project level
+that Boost.Build generates. You can do this by defining either
+BOOST_MATH_NO_LIB or BOOST_ALL_NO_LIB at project level
(so the defines get passed to each compiler invocation).
@@ -65,20 +66,20 @@
using Boost.Build and the supplied Jamfile. If you plan to
build them separately from your favourite IDE then you will
need to add `libs/math/test` to the list of your compiler's
You will also need to build and link to
the Boost.Regex library for many of the tests: this can built
-from the command line by following the
+from the command line by following the
getting started guide], using a command such as:
bjam toolset=gcc --with-regex install
bjam toolset=msvc --with-regex --build-type=complete stage
depending on whether you are on Linux or Windows.
Many of the tests have optional precompiled header support
@@ -92,7 +93,7 @@
Copyright 2006, 2007, 2008 John Maddock and Paul A. Bristow.
Distributed under the Boost Software License, Version 1.0.
(See accompanying file LICENSE_1_0.txt or copy at
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk