diff --git a/getting_started/detail/build-from-source-head.rst b/getting_started/detail/build-from-source-head.rst index f031648..52f5b0e 100644 --- a/getting_started/detail/build-from-source-head.rst +++ b/getting_started/detail/build-from-source-head.rst @@ -39,7 +39,10 @@ Identify Your Toolset ..................... First, find the toolset corresponding to your compiler in the -following table. +following table (an up-to-date list is always available `in the +Boost.Build documentation`__). + +__ http://www.boost.org/boost-build2/doc/html/bbv2/reference/tools.html .. Note:: If you previously chose a toolset for the purposes of `building bjam`_, you should assume it won't work and instead @@ -82,8 +85,6 @@ following table. +-----------+--------------------+-----------------------------+ |``intel`` |Intel | | +-----------+--------------------+-----------------------------+ -|``kylix`` |Borland | | -+-----------+--------------------+-----------------------------+ |``msvc`` |Microsoft | | +-----------+--------------------+-----------------------------+ |``qcc`` |QNX Software Systems| | @@ -126,4 +127,10 @@ invoke ``bjam`` as follows: .. parsed-literal:: - bjam **--build-dir=**\ |build-directory|_ **--toolset=**\ |toolset-name|_ |build-type-complete| stage + bjam **--build-dir=**\ |build-directory|_ **toolset=**\ |toolset-name|_ |build-type-complete| stage + +For a complete description of these and other invocation options, +please see the `Boost.Build documentation`__. + +__ http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html + diff --git a/getting_started/detail/build-from-source-tail.rst b/getting_started/detail/build-from-source-tail.rst index c8377ad..46d2ff8 100644 --- a/getting_started/detail/build-from-source-tail.rst +++ b/getting_started/detail/build-from-source-tail.rst @@ -65,8 +65,8 @@ __ ../../libs/iostreams/doc/installation.html If it seems like the build system can't find your compiler and/or linker, consider setting up a ``user-config.jam`` file as described -in the `Boost.Build documentation`_. If that isn't your problem or -the ``user-config.jam`` file doesn't work for you, please address -questions about configuring Boost for your compiler to the -`Boost.Build mailing list`_. +`here`__. If that isn't your problem or the ``user-config.jam`` file +doesn't work for you, please address questions about configuring Boost +for your compiler to the `Boost.Build mailing list`_. +__ http://www.boost.org/boost-build2/doc/html/bbv2/advanced/configuration.html diff --git a/getting_started/unix-variants.html b/getting_started/unix-variants.html index 819b6d1..6c181de 100644 --- a/getting_started/unix-variants.html +++ b/getting_started/unix-variants.html @@ -30,36 +30,36 @@

Index

-

1   Get Boost

+

1   Get Boost

The most reliable way to get a copy of Boost is to download a distribution from SourceForge:

    @@ -88,7 +88,7 @@ from -

    2   The Boost Distribution

    +

    2   The Boost Distribution

    This is a sketch of the resulting directory structure:

     boost_1_39_0/ .................The “boost root directory”
    @@ -166,7 +166,7 @@ contains a subset of the Boost documentation.  Start with
     
     
-

3   Header-Only Libraries

+

3   Header-Only Libraries

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.

@@ -206,7 +206,7 @@ use.
-

4   Build a Simple Program Using Boost

+

4   Build a Simple Program Using Boost

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 @@ -240,7 +240,7 @@ echo 1 2 3 | ./example

-

4.1   Errors and Warnings

+

4.1   Errors and Warnings

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.3 Errors are another matter. If you're @@ -253,11 +253,11 @@ correctly identified the -

5   Prepare to Use a Boost Library Binary

+

5   Prepare to Use a Boost Library Binary

If you want to use any of the separately-compiled Boost libraries, you'll need to acquire library binaries.

-

5.1   Easy Build and Install

+

5.1   Easy Build and Install

Issue the following commands in the shell (don't type $; that represents the shell's prompt):

@@ -285,7 +285,7 @@ path in place of the Boost root directory.

skip to the next step

-

5.2   Or, Build Custom Binaries

+

5.2   Or, Build Custom Binaries

If you're using a compiler other than your system's default, you'll need to use Boost.Build to create binaries. You'll also use this method if you need a nonstandard build variant (see the @@ -298,7 +298,7 @@ installing software. To use it, you'll need an executable called bjam.

-

5.2.1   Get bjam

+

5.2.1   Get bjam

bjam is the command-line tool that drives the Boost Build system. To build Boost binaries, you'll invoke bjam from the Boost root.

@@ -310,9 +310,10 @@ see the list of directories in your PATH, separated by colons, by typing “echo $PATH” at the command prompt.

-

5.2.2   Identify Your Toolset

+

5.2.2   Identify Your Toolset

First, find the toolset corresponding to your compiler in the -following table.

+following table (an up-to-date list is always available in the +Boost.Build documentation).

Note

If you previously chose a toolset for the purposes of @@ -382,10 +383,6 @@ operating system. Intel   -kylix -Borland -  - msvc Microsoft   @@ -412,7 +409,7 @@ a hyphen, e.g. intel-9.0borland-5.4.3.

-

5.2.3   Select a Build Directory

+

5.2.3   Select a Build Directory

Boost.Build will place all intermediate files it generates while building into the build directory. If your Boost root directory is writable, this step isn't strictly necessary: by @@ -420,16 +417,18 @@ default Boost.Build will create a

-

5.2.4   Invoke bjam

+

5.2.4   Invoke bjam

Change your current directory to the Boost root directory and invoke bjam as follows:

-bjam --build-dir=build-directory --toolset=toolset-name   stage
+bjam --build-dir=build-directory toolset=toolset-name   stage
 
+

For a complete description of these and other invocation options, +please see the Boost.Build documentation.

For example, your session might look like this:

 $ cd ~/boost_1_39_0
-$ bjam --build-dir=/tmp/build-boost --toolset=gcc stage
+$ bjam --build-dir=/tmp/build-boost toolset=gcc stage
 

That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “--build-type=complete”.

@@ -466,7 +465,7 @@ file by appending “>build.lo
-

5.3   Expected Build Output

+

5.3   Expected Build Output

During the process of building Boost libraries, you can expect to see some messages printed on the console. These may include

    @@ -490,7 +489,7 @@ look something like:

-

5.4   In Case of Build Errors

+

5.4   In Case of Build Errors

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 here. Install the relevant development @@ -498,17 +497,16 @@ packages for libz and libbz2 if you need those features. Other errors when building Boost libraries are cause for concern.

If it seems like the build system can't find your compiler and/or linker, consider setting up a user-config.jam file as described -in the Boost.Build documentation. If that isn't your problem or -the user-config.jam file doesn't work for you, please address -questions about configuring Boost for your compiler to the -Boost.Build mailing list.

+here. If that isn't your problem or the user-config.jam file +doesn't work for you, please address questions about configuring Boost +for your compiler to the Boost.Build mailing list.

-

7   Conclusion and Further Resources

+

7   Conclusion and Further Resources

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 @@ -735,7 +733,7 @@ to the -[2]That option is a dash followed by a lowercase “L” +[2]That option is a dash followed by a lowercase “L” character, which looks very much like a numeral 1 in some fonts. @@ -756,7 +754,7 @@ have any source code mechanism for suppressing warnings. - @@ -765,7 +763,7 @@ same name.
[4]This convention distinguishes the static version of +
[4]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.
-
[5]These libraries were compiled without optimization +
[5]These libraries were compiled without optimization or inlining, with full debug symbols enabled, and without NDEBUG #defined. Although it's true that sometimes these choices don't affect binary compatibility with other @@ -775,7 +773,7 @@ compiled code, you can't count on that with Boost libraries.
- diff --git a/getting_started/unix-variants.rst b/getting_started/unix-variants.rst index 548343e..ee516fd 100644 --- a/getting_started/unix-variants.rst +++ b/getting_started/unix-variants.rst @@ -140,7 +140,7 @@ For example, your session might look like this: .. parsed-literal:: $ cd ~/|boost_ver| - $ bjam **--build-dir=**\ /tmp/build-boost **--toolset=**\ gcc stage + $ bjam **--build-dir=**\ /tmp/build-boost **toolset=**\ gcc stage That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “``--build-type=complete``”. diff --git a/getting_started/windows.html b/getting_started/windows.html index 4cec250..686b803 100644 --- a/getting_started/windows.html +++ b/getting_started/windows.html @@ -26,40 +26,40 @@ not supported—they may or may not work.

Index

-

1   Get Boost

+

1   Get Boost

The easiest way to get a copy of Boost is to use an installer. The Boost website version of this Getting Started guide will have undated information on installers as they become available, or see @@ -79,7 +79,7 @@ distribution.1

-

2   The Boost Distribution

+

2   The Boost Distribution

This is a sketch of the resulting directory structure:

 boost_1_39_0\ .................The “boost root directory”
@@ -162,7 +162,7 @@ contains a subset of the Boost documentation.  Start with
 
 
-

3   Header-Only Libraries

+

3   Header-Only Libraries

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.

@@ -202,7 +202,7 @@ use.
-

4   Build a Simple Program Using Boost

+

4   Build a Simple Program Using Boost

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 @@ -258,7 +258,7 @@ caret (^) at the end on this page use that technique to save horizontal space.

-

4.1   Build From the Visual Studio IDE

+

4.1   Build From the Visual Studio IDE

  • From Visual Studio's File menu, select New > Project…

  • @@ -299,7 +299,7 @@ Return key.

    skip to the next step

-

4.2   Or, Build From the Command Prompt

+

4.2   Or, Build From the Command Prompt

From your computer's Start menu, if you are a Visual Studio 2005 user, select

@@ -325,7 +325,7 @@ echo 1 2 3 | example
-

4.3   Errors and Warnings

+

4.3   Errors and Warnings

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.5 Errors are another matter. If you're @@ -338,11 +338,11 @@ correctly identified the -

5   Prepare to Use a Boost Library Binary

+

5   Prepare to Use a Boost Library Binary

If you want to use any of the separately-compiled Boost libraries, you'll need to acquire library binaries.

-

5.1   Install Visual Studio Binaries

+

5.1   Install Visual Studio Binaries

The installers supplied by BoostPro Computing will download and install pre-compiled binaries into the lib\ subdirectory of the boost root, typically C:\Program Files\boost\boost_1_39_0\lib\. If you installed @@ -352,7 +352,7 @@ now.

skip to the next step

-

5.2   Or, Build Binaries From Source

+

5.2   Or, Build Binaries From Source

If you're using an earlier version of Visual C++, or a compiler from another vendor, you'll need to use Boost.Build to create your own binaries.

@@ -364,7 +364,7 @@ installing software. To use it, you'll need an executable called bjam.

-

5.2.1   Get bjam

+

5.2.1   Get bjam

bjam is the command-line tool that drives the Boost Build system. To build Boost binaries, you'll invoke bjam from the Boost root.

@@ -376,9 +376,10 @@ see the list of directories in your PATH, separated by semicolons, by typing “PATH” at the command prompt.

-

5.2.2   Identify Your Toolset

+

5.2.2   Identify Your Toolset

First, find the toolset corresponding to your compiler in the -following table.

+following table (an up-to-date list is always available in the +Boost.Build documentation).

Note

If you previously chose a toolset for the purposes of @@ -448,10 +449,6 @@ operating system.

- - - - @@ -481,7 +478,7 @@ are using the msvc or gcc toolsets, which have special version detection code) or auto-linking will fail.

-

5.2.3   Select a Build Directory

+

5.2.3   Select a Build Directory

Boost.Build will place all intermediate files it generates while building into the build directory. If your Boost root directory is writable, this step isn't strictly necessary: by @@ -489,13 +486,15 @@ default Boost.Build will create a

-

5.2.4   Invoke bjam

+

5.2.4   Invoke bjam

Change your current directory to the Boost root directory and invoke bjam as follows:

-bjam --build-dir=build-directory --toolset=toolset-name --build-type=complete stage
+bjam --build-dir=build-directory toolset=toolset-name --build-type=complete stage
 
-

For example, your session might look like this:4

+

For a complete description of these and other invocation options, +please see the Boost.Build documentation.

+

For example, your session might look like this:4

 C:\WINDOWS> cd C:\Program Files\boost\boost_1_39_0
 C:\Program Files\boost\boost_1_39_0> bjam ^
@@ -542,7 +541,7 @@ file by appending “>build.lo
 
-

5.3   Expected Build Output

+

5.3   Expected Build Output

During the process of building Boost libraries, you can expect to see some messages printed on the console. These may include

    @@ -566,7 +565,7 @@ look something like:

-

5.4   In Case of Build Errors

+

5.4   In Case of Build Errors

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 here. Install the relevant development @@ -574,17 +573,16 @@ packages for libz and libbz2 if you need those features. Other errors when building Boost libraries are cause for concern.

If it seems like the build system can't find your compiler and/or linker, consider setting up a user-config.jam file as described -in the Boost.Build documentation. If that isn't your problem or -the user-config.jam file doesn't work for you, please address -questions about configuring Boost for your compiler to the -Boost.Build mailing list.

+here. If that isn't your problem or the user-config.jam file +doesn't work for you, please address questions about configuring Boost +for your compiler to the Boost.Build mailing list.

-

6.3   Library Naming

+

6.3   Library Naming

Note

If, like Visual C++, your compiler supports auto-linking, @@ -676,7 +674,7 @@ following elements:

Prefix: except on Microsoft Windows, every Boost library name begins with this string. On Windows, only ordinary static libraries use the lib prefix; import libraries and DLLs do -not.6
+not.6
boost_regex
Library name: all boost library filenames begin with boost_.
-vc71
@@ -714,14 +712,14 @@ libraries.
- + - +
[6]This feature of STLPort is deprecated because it's +
[6]This feature of STLPort is deprecated because it's impossible to make it work transparently to the user; we don't recommend it.
Intel  
kylixBorland 
msvc Microsoft   using a special debug build of Python.
dbuilding a debug version of your code.7building a debug version of your code.7
p using the STLPort standard library rather than the default one supplied with your compiler.
nusing STLPort's deprecated “native iostreams” feature.8using STLPort's deprecated “native iostreams” feature.8
@@ -753,7 +751,7 @@ version number, will also be created.

-

6.4   Test Your Program

+

6.4   Test Your Program

To test our subject extraction, we'll filter the following text file. Copy it out of your browser and save it as jayne.txt:

@@ -775,7 +773,7 @@ Spoil Rock Hunter?”

-

7   Conclusion and Further Resources

+

7   Conclusion and Further Resources

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 @@ -832,7 +830,7 @@ used in the examples. -
[4]

In this example, the caret character ^ is a +

[4]

In this example, the caret character ^ is a way of continuing the command on multiple lines, and must be the final character used on the line to be continued (i.e. do not follow it with spaces). The command prompt responds with @@ -870,7 +868,7 @@ have any source code mechanism for suppressing warnings.

- @@ -879,7 +877,7 @@ same name.
[6]This convention distinguishes the static version of +
[6]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.
-
[7]These libraries were compiled without optimization +
[7]These libraries were compiled without optimization or inlining, with full debug symbols enabled, and without NDEBUG #defined. Although it's true that sometimes these choices don't affect binary compatibility with other @@ -889,7 +887,7 @@ compiled code, you can't count on that with Boost libraries.
-
[8]This feature of STLPort is deprecated because it's +
[8]This feature of STLPort is deprecated because it's impossible to make it work transparently to the user; we don't recommend it.