From 65d237b272ffe6f1e17fd6bce824fd97365f68ef Mon Sep 17 00:00:00 2001 From: Vladimir Prus Date: Wed, 26 Mar 2003 09:03:26 +0000 Subject: [PATCH] Improve installation docs. [SVN r18088] --- boost_build_v2.html | 76 +++++++++++++++++++++++++++++++----------- v2/boost_build_v2.html | 76 +++++++++++++++++++++++++++++++----------- 2 files changed, 112 insertions(+), 40 deletions(-) diff --git a/boost_build_v2.html b/boost_build_v2.html index 9d523a718..0bd3e69a3 100644 --- a/boost_build_v2.html +++ b/boost_build_v2.html @@ -22,12 +22,12 @@ div.alert { color: red } table { align: center; border: thin; } - + + - build request, build request expansion and directly requested targets + - conditional properties + -->

Installation

- When using package management or installers, Boost.Build is ready to work - instantly. In other case, two steps are required: + Assuming you're installing Boost.Build from sources, the following steps + are needed. All paths are given relatively to Boost.Build root directory, + which is the directory with the document you are reading. When using + Boost distribution, Boost.Build root is located at + $boost_root/tools/build.
    -
  1. Place the Boost.Jam binary, called "bjam", somewhere in your - PATH.
    2. +
  2. Go to "jam_src" directory and build Boost.Jam. Two convenient + scripts are provided, "build.sh" (for Unix systems) and "build.bat" + (for Windows). Run the appropriate one and Boost.Jam will be built to + directory bin.{platform_name}.. The Boost.Jam documentation has more details in + case you need them.
    3. + +
  3. Place the Boost.Jam binary, called "bjam" or "bjam.exe", somewhere + in your PATH.
    4. + +
  4. After that, you can go to "examples-v2" + directory and run bjam --version.
  5. - Specify the location of Boost.Build files. You can either set - environmental variable BOOST_BUILD_PATH, or create, at the - top of your project, a file called boost-build.jam, with a - single line: -
    -boost-build /path/to/boost.build ;
-
    - The directory "examples" in the distribution already has this file, - so you can build projects there and add new without doing anything. + Configure toolsets to use. Open new/user-config.jam file and + follow instructions there to specify what compiles/libraries you have + and where they are located. After that, you should be able to go to + examples-v2/hello, and run bjam there. A simple + application will be built. You can also play with other projects in + examples-v2. + +

    It is slighly better way is to copy new/user-config.jam + into one of the locations where it can be found (given in this table). This prevent you from + accidentally overwriting your config when updating.

-

To verify your installation, you can use bjam --version at - the command line.

+

When starting a new project which uses Boost.Build, you need to make + sure that build system can be found. There are two ways.

+ + + +

If you're trying to use Boost.Build V2 on Boost itself, please note + that when building Boost, V1 is used by default. You'd have to add + --v2 command line option to all "bjam" invocations.

Tutorial

@@ -786,6 +818,9 @@ boost-build /path/to/boost.build ; +

Features which are neither free nor incidental are called + base features.

+

TODO: document active features..

Feature Declaration

@@ -904,7 +939,8 @@ exe hello : hello.cpp : <toolset>yfc:<cxxflags>-disable-pointless-wa

Locations where those files a search are summarized below:

- +
diff --git a/v2/boost_build_v2.html b/v2/boost_build_v2.html index 9d523a718..0bd3e69a3 100644 --- a/v2/boost_build_v2.html +++ b/v2/boost_build_v2.html @@ -22,12 +22,12 @@ div.alert { color: red } table { align: center; border: thin; } - + + - build request, build request expansion and directly requested targets + - conditional properties + -->

Installation

- When using package management or installers, Boost.Build is ready to work - instantly. In other case, two steps are required: + Assuming you're installing Boost.Build from sources, the following steps + are needed. All paths are given relatively to Boost.Build root directory, + which is the directory with the document you are reading. When using + Boost distribution, Boost.Build root is located at + $boost_root/tools/build.
    -
  1. Place the Boost.Jam binary, called "bjam", somewhere in your - PATH.
    2. +
  2. Go to "jam_src" directory and build Boost.Jam. Two convenient + scripts are provided, "build.sh" (for Unix systems) and "build.bat" + (for Windows). Run the appropriate one and Boost.Jam will be built to + directory bin.{platform_name}.. The Boost.Jam documentation has more details in + case you need them.
    3. + +
  3. Place the Boost.Jam binary, called "bjam" or "bjam.exe", somewhere + in your PATH.
    4. + +
  4. After that, you can go to "examples-v2" + directory and run bjam --version.
  5. - Specify the location of Boost.Build files. You can either set - environmental variable BOOST_BUILD_PATH, or create, at the - top of your project, a file called boost-build.jam, with a - single line: -
    -boost-build /path/to/boost.build ;
-
    - The directory "examples" in the distribution already has this file, - so you can build projects there and add new without doing anything. + Configure toolsets to use. Open new/user-config.jam file and + follow instructions there to specify what compiles/libraries you have + and where they are located. After that, you should be able to go to + examples-v2/hello, and run bjam there. A simple + application will be built. You can also play with other projects in + examples-v2. + +

    It is slighly better way is to copy new/user-config.jam + into one of the locations where it can be found (given in this table). This prevent you from + accidentally overwriting your config when updating.

-

To verify your installation, you can use bjam --version at - the command line.

+

When starting a new project which uses Boost.Build, you need to make + sure that build system can be found. There are two ways.

+ + + +

If you're trying to use Boost.Build V2 on Boost itself, please note + that when building Boost, V1 is used by default. You'd have to add + --v2 command line option to all "bjam" invocations.

Tutorial

@@ -786,6 +818,9 @@ boost-build /path/to/boost.build ; +

Features which are neither free nor incidental are called + base features.

+

TODO: document active features..

Feature Declaration

@@ -904,7 +939,8 @@ exe hello : hello.cpp : <toolset>yfc:<cxxflags>-disable-pointless-wa

Locations where those files a search are summarized below:

-
search paths for configuration files
+
search paths for configuration files