diff --git a/doc/src/faq.xml b/doc/src/faq.xml index 551e22e25..3fe482345 100644 --- a/doc/src/faq.xml +++ b/doc/src/faq.xml @@ -13,7 +13,7 @@ This is not possible, since Jamfile does not have "current" value of any feature, be it toolset, build variant or anything else. For a single - invocation of bjam, any given main target can be + run of Boost.Build, any given main target can be built with several property sets. For example, user can request two build variants on the command line. Or one library is built as shared when used from one application, and as static when used from another. Each Jamfile diff --git a/doc/src/install.xml b/doc/src/install.xml index afae46aa1..ea41d32e6 100644 --- a/doc/src/install.xml +++ b/doc/src/install.xml @@ -29,7 +29,7 @@ Run - ./bjam install --prefix=PREFIX + ./b2 install --prefix=PREFIX where PREFIX is a directory where you want Boost.Build to be installed. @@ -51,7 +51,7 @@ Now that Boost.Build is installed, you can try some of examples. Copy PREFIX/share/boost-build/examples/hello to a different directory, then change to that directory and run: -PREFIX/bin/bjam +PREFIX/bin/b2 A simple executable should be built. diff --git a/doc/src/overview.xml b/doc/src/overview.xml index 048898867..e3cab4bb5 100644 --- a/doc/src/overview.xml +++ b/doc/src/overview.xml @@ -17,12 +17,12 @@ Boost.Build actually consists of two parts - Boost.Jam, a build engine with its own interpreted language, and Boost.Build itself, implemented in Boost.Jam's language. The chain of events when you type - bjam on the command line is as follows: + b2 on the command line is as follows: - Boost.Jam tries to find Boost.Build and loads the top-level module. - The exact process is described in @@ -134,7 +134,7 @@ exe a : a.cpp ; all build files are parsed, Boost.Build considers properties requested on the command line. Supposed you have invoked Boost.Build with: -bjam toolset=gcc toolset=msvc +b2 toolset=gcc toolset=msvc In that case, the metatarget will be called twice, once with toolset=gcc and once with toolset=msvc. Both invocations will produce concrete @@ -325,7 +325,7 @@ rule test ( ) import module ; import module : rule ; - The first form imports the specified bjam module. All rules from that + The first form imports the specified module. All rules from that module are made available using the qualified name: module.rule. The second form imports the specified rules only, and they can be called using @@ -581,7 +581,7 @@ using gcc : 3.4 : g++-3.4 ;
Invocation - To invoke Boost.Build, type bjam on the command line. Three kinds + To invoke Boost.Build, type b2 on the command line. Three kinds of command-line tokens are accepted, in any order: @@ -615,20 +615,20 @@ using gcc : 3.4 : g++-3.4 ; To build all targets defined in Jamfile in the current directory with default properties, run: -bjam +b2 To build specific targets, specify them on the command line: -bjam lib1 subproject//lib2 +b2 lib1 subproject//lib2 To request a certain value for some property, add property=value to the command line: -bjam toolset=gcc variant=debug optimization=space +b2 toolset=gcc variant=debug optimization=space
@@ -951,7 +951,7 @@ bjam toolset=gcc variant=debug optimization=space once for each specified value of a feature. For example, if you use -bjam link=static link=shared threading=single threading=multi +b2 link=static link=shared threading=single threading=multi Then a total of 4 builds will be performed. For convenience, @@ -959,13 +959,13 @@ bjam link=static link=shared threading=single threading=multi you can separate the values with commands, for example: -bjam link=static,shared threading=single,multi +b2 link=static,shared threading=single,multi The comma has special meaning only if the feature has a fixed set of values, so -bjam include=static,shared +b2 include=static,shared is not treated specially. @@ -1299,7 +1299,7 @@ exe hello : hello.cpp optimization. When referring to an inline main target, its declared name must be prefixed by its parent target's name and two dots. In the example above, to build only helpers, one should run - bjam hello..helpers. + b2 hello..helpers. When no target is requested on the command line, all targets in the @@ -1541,7 +1541,7 @@ project tennis The command line specifies which targets to build and with which properties. For example: -bjam app1 lib1//lib1 toolset=gcc variant=debug optimization=full +b2 app1 lib1//lib1 toolset=gcc variant=debug optimization=full would build two targets, "app1" and "lib1//lib1" with the specified properties. You can refer to any targets, using @@ -1549,7 +1549,7 @@ bjam app1 lib1//lib1 toolset=gcc variant=debug optimization=full properties. Some of the properties are very common, and for them the name of the property can be omitted. For example, the above can be written as: -bjam app1 lib1//lib1 gcc debug optimization=full +b2 app1 lib1//lib1 gcc debug optimization=full The complete syntax, which has some additional shortcuts, is described in . @@ -1640,7 +1640,7 @@ bjam app1 lib1//lib1 gcc debug optimization=full
Building a Project Often, a user builds a complete project, not just one main - target. In fact, invoking bjam without + target. In fact, invoking b2 without arguments diff --git a/doc/src/reference.xml b/doc/src/reference.xml index 80775aace..adac357c7 100644 --- a/doc/src/reference.xml +++ b/doc/src/reference.xml @@ -45,7 +45,7 @@ rule boost-build ( location ? ) boost-build build-system ; - In this case, running bjam anywhere in the project tree will + In this case, running b2 anywhere in the project tree will automatically find the build system. The default bootstrap.jam, after loading some standard @@ -227,13 +227,13 @@ constant VERSION : 1.34.0 ; Same as constant except that the value is treated as path relative to Jamfile location. For example, - if bjam is invoked in the current directory, + if b2 is invoked in the current directory, and Jamfile in helper subdirectory has: path-constant DATA : data/a.txt ; then the variable DATA will be set to - helper/data/a.txt, and if bjam + helper/data/a.txt, and if b2 is invoked from the helper directory, then the variable DATA will be set to data/a.txt. diff --git a/doc/src/tasks.xml b/doc/src/tasks.xml index 2b3e68bd1..a54c1b7ea 100644 --- a/doc/src/tasks.xml +++ b/doc/src/tasks.xml @@ -476,8 +476,8 @@ boost-test(test-type) path - It is possible to process the list of tests, the output of bjam during - command run, and the presense/absense of the *.test + It is possible to process the list of tests, Boost.Build output + and the presense/absense of the *.test files created when test passes into human-readable status table of tests. Such processing utilities are not included in Boost.Build. @@ -534,7 +534,7 @@ actions in2out in2out $(<) $(>) } - If you run bjam and file.out does + If you run b2 and file.out does not exist, Boost.Build will run the in2out command to create that file. For more details on specifying actions, see . @@ -735,7 +735,7 @@ using gcc : arm : arm-none-linux-gnueabi-g++ ; just request that this compiler version to be used: -bjam toolset=gcc-arm +b2 toolset=gcc-arm @@ -745,9 +745,9 @@ bjam toolset=gcc-arm # On windows box -bjam toolset=gcc-arm target-os=linux +b2 toolset=gcc-arm target-os=linux # On Linux box -bjam toolset=gcc-mingw target-os=windows +b2 toolset=gcc-mingw target-os=windows For the complete list of allowed opeating system names, please see the documentation for diff --git a/doc/src/tutorial.xml b/doc/src/tutorial.xml index 3763471df..cfe70cde4 100644 --- a/doc/src/tutorial.xml +++ b/doc/src/tutorial.xml @@ -35,13 +35,13 @@ exe hello : hello.cpp ; Even with this simple setup, you can do some interesting things. First of - all, just invoking bjam will build the hello + all, just invoking b2 will build the hello executable by compiling and linking hello.cpp . By default, debug variant is built. Now, to build the release variant of hello, invoke -bjam release +b2 release Note that debug and release variants are created in different directories, @@ -56,7 +56,7 @@ exe hello2 : hello.cpp ; Now let us build both the debug and release variants of our project again: -bjam debug release +b2 debug release Note that two variants of hello2 are linked. Since we @@ -66,7 +66,7 @@ bjam debug release let us remove all the built products: -bjam --clean debug release +b2 --clean debug release It is also possible to build or clean specific targets. The following two @@ -74,8 +74,8 @@ bjam --clean debug release hello2. -bjam hello2 -bjam --clean hello2 +b2 hello2 +b2 --clean hello2
@@ -102,7 +102,7 @@ bjam --clean hello2 builds the project's release variant with inlining disabled and debug symbols enabled: -bjam release inlining=off debug-symbols=on +b2 release inlining=off debug-symbols=on @@ -116,12 +116,12 @@ bjam release inlining=off debug-symbols=on The and that we have seen - in bjam invocations are just a shorthand way to specify + in b2 invocations are just a shorthand way to specify values of the variant feature. For example, the command above could also have been written this way: -bjam variant=release inlining=off debug-symbols=on +b2 variant=release inlining=off debug-symbols=on @@ -170,7 +170,7 @@ exe hello When hello is built, the two requirements specified above will always be present. If the build request given on the - bjam command-line explictly contradicts a target's + b2 command-line explictly contradicts a target's requirements, the target requirements usually override (or, in the case of “free”” features like <include>, @@ -289,7 +289,7 @@ top/ - Invoking bjam without explicitly specifying + Invoking b2 without explicitly specifying any targets on the command line builds the project rooted in the current directory. Building a project does not automatically cause its subprojects to be built unless the parent project's @@ -352,7 +352,7 @@ exe app : app.cpp ../util/foo//bar ; Suppose we build app with: -bjam app optimization=full define=USE_ASM +b2 app optimization=full define=USE_ASM Which properties will be used to build foo? The answer is that some features are @@ -448,7 +448,7 @@ project shared, and to build a static library, the value should be static. You can request a static build either on the command line: - bjam link=static + b2 link=static or in the library's requirements: lib l : l.cpp : <link>static ; @@ -472,7 +472,7 @@ project exe important : main.cpp helpers/<link>static ; - No matter what arguments are specified on the bjam + No matter what arguments are specified on the b2 command line, important will only be linked with the static version of helpers.