diff --git a/getting_started/detail/build-from-source-head.rst b/getting_started/detail/build-from-source-head.rst index 276f6f5..f031648 100644 --- a/getting_started/detail/build-from-source-head.rst +++ b/getting_started/detail/build-from-source-head.rst @@ -6,7 +6,7 @@ Boost.Build_ is a text-based system for developing, testing, and installing software. To use it, you'll need an executable called ``bjam``. -.. |precompiled-bjam| replace:: pre-compiled ``bjam`` executables +.. |precompiled-bjam| replace:: download a pre-built ``bjam`` executable .. _precompiled-bjam: http://sourceforge.net/project/showfiles.php?group_id=7586&package_id=72941 @@ -22,12 +22,15 @@ Get ``bjam`` system. To build Boost binaries, you'll invoke ``bjam`` from the Boost root. -Boost provides |precompiled-bjam|_ for a variety of platforms. +We suggest you |precompiled-bjam|_ for your platform. Alternatively, you can build ``bjam`` yourself using `these instructions`__. __ `building bjam`_ +Move the ``bjam`` executable into a directory in your PATH. You can +see the list of directories in your PATH, separated by |pathsep|\ s, +by typing “\ |path|\ ” at the command prompt. .. _toolset: .. _toolset-name: @@ -123,4 +126,4 @@ 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 diff --git a/getting_started/detail/build-from-source-tail.rst b/getting_started/detail/build-from-source-tail.rst index 5a07b71..c8377ad 100644 --- a/getting_started/detail/build-from-source-tail.rst +++ b/getting_started/detail/build-from-source-tail.rst @@ -23,6 +23,11 @@ be interested in: * choosing a specific build variant by adding ``release`` or ``debug`` to the command line. +.. Note:: 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 “``>build.log 2>&1``” to your command line. + Expected Build Output --------------------- diff --git a/getting_started/detail/common-unix.rst b/getting_started/detail/common-unix.rst index c1cdf49..09ad5d8 100644 --- a/getting_started/detail/common-unix.rst +++ b/getting_started/detail/common-unix.rst @@ -20,5 +20,8 @@ .. |command-line tool| replace:: command-line tool +.. |pathsep| replace:: colon + +.. |path| replace:: ``echo $PATH`` .. include:: common.rst diff --git a/getting_started/detail/common-windows.rst b/getting_started/detail/common-windows.rst index fa0102c..75ba004 100644 --- a/getting_started/detail/common-windows.rst +++ b/getting_started/detail/common-windows.rst @@ -31,4 +31,8 @@ .. |command-line tool| replace:: `command-line tool`_ +.. |pathsep| replace:: semicolon + +.. |path| replace:: ``PATH`` + .. include:: common.rst diff --git a/getting_started/index.html b/getting_started/index.html index c8b8021..86a98dd 100644 --- a/getting_started/index.html +++ b/getting_started/index.html @@ -3,7 +3,7 @@ - + Boost Getting Started diff --git a/getting_started/unix-variants.html b/getting_started/unix-variants.html index f536074..9627600 100644 --- a/getting_started/unix-variants.html +++ b/getting_started/unix-variants.html @@ -3,7 +3,7 @@ - + Boost Getting Started on Unix Variants @@ -302,9 +302,12 @@ installing software. To use it, you'll need an executable called

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

-

Boost provides pre-compiled bjam executables for a variety of platforms. +

We suggest you download a pre-built bjam executable for your platform. Alternatively, you can build bjam yourself using these instructions.

+

Move the bjam executable into a directory in your PATH. You can +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

@@ -421,18 +424,14 @@ purpose in your current working directory.

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   stage

For example, your session might look like this:

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

That will build static and shared non-debug multi-threaded variations of the libraries. To build all variations:

-
-$ cd ~/boost_1_37_0
-$ bjam --build-dir=/tmp/build-boost --toolset=gcc --build-type=complete 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``”.

@@ -457,6 +456,13 @@ be interested in:

  • choosing a specific build variant by adding release or debug to the command line.
    • +
    +

    Note

    +

    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 “``>build.log 2>&1``” to your command line.

    +
    diff --git a/getting_started/unix-variants.rst b/getting_started/unix-variants.rst index f87eacb..548343e 100644 --- a/getting_started/unix-variants.rst +++ b/getting_started/unix-variants.rst @@ -142,12 +142,7 @@ For example, your session might look like this: $ cd ~/|boost_ver| $ bjam **--build-dir=**\ /tmp/build-boost **--toolset=**\ gcc stage -That will build static and shared non-debug multi-threaded variations of the libraries. To build all variations: - -.. parsed-literal:: - - $ cd ~/|boost_ver| - $ bjam **--build-dir=**\ /tmp/build-boost **--toolset=**\ gcc **--build-type=complete** 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``”. .. include:: detail/build-from-source-tail.rst @@ -237,6 +232,8 @@ Spoil Rock Hunter?” .. [#lowercase-l] That option is a dash followed by a lowercase “L” character, which looks very much like a numeral 1 in some fonts. +.. |build-type-complete| replace:: `` `` + .. include:: detail/common-footnotes.rst .. include:: detail/release-variables.rst .. include:: detail/common-unix.rst diff --git a/getting_started/windows.html b/getting_started/windows.html index 6274efb..a5cd5f6 100644 --- a/getting_started/windows.html +++ b/getting_started/windows.html @@ -3,7 +3,7 @@ - + Boost Getting Started on Windows @@ -60,14 +60,16 @@ not supported—they may or may not work.

    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 Boost downloads or the installer provided by BoostPro Computing. 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 Boost.Regex binaries when given the option.

    +

    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 +Boost downloads or the installer provided by BoostPro +Computing. 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 Boost.Regex +binaries when given the option.

    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 boost_1_37_0.7z or boost_1_37_0.zip and unpack it to install a complete Boost @@ -341,7 +343,7 @@ correctly identified the

    5.1   Install Visual Studio Binaries

    -

    The installers will download and +

    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_37_0\lib\. If you installed all variants of the Boost.Regex binary, you're done with this @@ -366,9 +368,12 @@ installing software. To use it, you'll need an executable called

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

    -

    Boost provides pre-compiled bjam executables for a variety of platforms. +

    We suggest you download a pre-built bjam executable for your platform. Alternatively, you can build bjam yourself using these instructions.

    +

    Move the bjam executable into a directory in your PATH. You can +see the list of directories in your PATH, separated by semicolons, +by typing “PATH” at the command prompt.

    5.2.2   Identify Your Toolset

    @@ -488,25 +493,21 @@ purpose in your current working directory.

    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

     C:\WINDOWS> cd C:\Program Files\boost\boost_1_37_0
 C:\Program Files\boost\boost_1_37_0> bjam ^
 More? --build-dir="C:\Documents and Settings\dave\build-boost" ^
-More? --toolset=msvc stage
+More? --toolset= --build-type=complete msvc stage

    Be sure to read this note about the appearance of ^, More? and quotation marks (") in that line.

    -

    The above example session will build static and shared non-debug multi-threaded -variations of the libraries. To build all variations:

    -
    -C:\WINDOWS> cd C:\Program Files\boost\boost_1_37_0
-C:\Program Files\boost\boost_1_37_0> bjam ^
-More? --build-dir="C:\Documents and Settings\dave\build-boost" ^
-More? --toolset=msvc --build-type=complete stage
-
    +

    The option “--build-type=complete” causes bjam to build +all supported variants of the libraries. For instructions on how to +build only specific variants, please ask on the Boost.Build mailing +list.

    @@ -531,6 +532,13 @@ be interested in:

  • choosing a specific build variant by adding release or debug to the command line.
    • +
    +

    Note

    +

    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 “``>build.log 2>&1``” to your command line.

    +
    diff --git a/getting_started/windows.rst b/getting_started/windows.rst index dab2cb2..6026dd7 100644 --- a/getting_started/windows.rst +++ b/getting_started/windows.rst @@ -35,14 +35,16 @@ __ ../../index.htm 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 `Boost downloads`_ or the installer_ provided by `BoostPro Computing`_. 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 Boost.Regex_ binaries when given the option. +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 +`Boost downloads`_ or the installer_ provided by `BoostPro +Computing`_. 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 Boost.Regex_ +binaries when given the option. .. _`Boost website version of this Getting Started guide`: http://www.boost.org/doc/libs/1_36_0/more/getting_started/index.html @@ -186,7 +188,7 @@ To test the result, type: Install Visual Studio Binaries ------------------------------ -The installers will download and +The installers supplied by BoostPro Computing will download and install pre-compiled binaries into the ``lib\`` subdirectory of the boost root, typically |default-root|\ ``\lib\``. If you installed all variants of the Boost.Regex_ binary, you're done with this @@ -213,20 +215,15 @@ For example, your session might look like this: [#continuation]_ C:\\WINDOWS> cd |default-root| |default-root|> bjam **^** More? **--build-dir=**\ "C:\\Documents and Settings\\dave\\build-boost" **^** - More? **--toolset=**\ msvc stage + More? **--toolset=**\ **--build-type=complete** msvc stage Be sure to read `this note`__ about the appearance of ``^``, ``More?`` and quotation marks (``"``) in that line. -The above example session will build static and shared non-debug multi-threaded -variations of the libraries. To build all variations: - -.. parsed-literal:: - - C:\\WINDOWS> cd |default-root| - |default-root|> bjam **^** - More? **--build-dir=**\ "C:\\Documents and Settings\\dave\\build-boost" **^** - More? **--toolset=**\ msvc **--build-type=complete** stage +The option “\ **--build-type=complete**\ ” causes ``bjam`` to build +all supported variants of the libraries. For instructions on how to +build only specific variants, please ask on the `Boost.Build mailing +list`_. __ continuation_ @@ -355,6 +352,7 @@ Spoil Rock Hunter?” .. _`boost.zip`: `sf-download`_ +.. |build-type-complete| replace:: **--build-type=complete** .. include:: detail/common-footnotes.rst .. include:: detail/release-variables.rst