diff --git a/doc/src/faq.xml b/doc/src/faq.xml index fe1bd5a81..551e22e25 100644 --- a/doc/src/faq.xml +++ b/doc/src/faq.xml @@ -30,7 +30,7 @@ Use conditional requirements or indirect conditional requirements. See - . + . diff --git a/doc/src/howto.xml b/doc/src/howto.xml index 4a8b892b3..bd128a321 100644 --- a/doc/src/howto.xml +++ b/doc/src/howto.xml @@ -9,20 +9,20 @@ If you've just found out about Boost.Build V2 and want to know if it will work for you, start with . You can continue with . When you're ready to try Boost.Build + linkend="bbv2.overview" />. When you're ready to try Boost.Build in practice, go to . If you are about to use Boost.Build on your project, or already using it and have a problem, look at . + "bbv2.overview"/>. If you're trying to build a project which uses Boost.Build, see and then read about - . + . diff --git a/doc/src/advanced.xml b/doc/src/overview.xml similarity index 97% rename from doc/src/advanced.xml rename to doc/src/overview.xml index 8d194742a..20977b0a3 100644 --- a/doc/src/advanced.xml +++ b/doc/src/overview.xml @@ -2,7 +2,7 @@ - + Overview @@ -57,32 +57,32 @@ - How to configure + How to configure Boost.Build - How to declare targets in + How to declare targets in Jamfiles - How the build process + How the build process works Some Basics about the Boost.Jam language. See . + "bbv2.overview.jam_language"/>. -
+
Boost.Jam Language @@ -245,7 +245,7 @@ import module : rule ; unqualified names. - + Sometimes, you'd need to specify the actual command lines to be used when creating targets. In jam language, you use named actions to do this. For example: @@ -293,7 +293,7 @@ actions create-file-from-another
-
+
Configuration @@ -491,7 +491,7 @@ using gcc : 3.4 : g++-3.4 ;
-
+
Invocation To invoke Boost.Build, type bjam on the command line. Three kinds @@ -523,7 +523,7 @@ using gcc : 3.4 : g++-3.4 ; -
+
Examples To build all targets defined in Jamfile in the current directory with default properties, run: @@ -546,7 +546,7 @@ bjam toolset=gcc variant=debug optimization=space
-
+
Options Boost.Build recognizes the following command line options. @@ -688,13 +688,13 @@ bjam toolset=gcc variant=debug optimization=space
-
+
Properties In the simplest case, the build is performed with a single set of properties, that you specify on the command line with elements in the form feature=value. - The complete list of features can be found in . + The complete list of features can be found in . The most common features are summarized below. @@ -842,7 +842,7 @@ bjam include=static,shared -
+
Targets All command line elements that are neither options nor properties are the names of the @@ -852,10 +852,10 @@ bjam include=static,shared
-
+
Declaring Targets - + A Main target is a user-defined named entity that can be built, for example an executable file. Declaring a main target is usually done using one of the main @@ -989,7 +989,7 @@ exe b : [ glob *.cpp ] ; # all .cpp files in this directory are sources considered relative to the source directory — which is typically the directory where the Jamfile is located, but can be changed as described in . + "bbv2.overview.projects.attributes.projectrule"/>. @@ -1021,7 +1021,7 @@ exe c : c.cpp /boost/program_options//program_options ;
-
+
Requirements requirements Requirements are the properties that should always be present when @@ -1030,7 +1030,7 @@ exe c : c.cpp /boost/program_options//program_options ; exe hello : hello.cpp : <include>/opt/boost <define>MY_DEBUG ; There is a number of other features, listed in - . For example if + . For example if a library can only be built statically, or a file can't be compiled with optimization due to a compiler bug, one can use @@ -1039,7 +1039,7 @@ obj main : main.cpp : <optimization>off ; - Sometimes, particular relationships need to be maintained + Sometimes, particular relationships need to be maintained among a target's build properties. This can be achieved with conditional requirements. For example, you might want to set @@ -1067,7 +1067,7 @@ lib network : network.cpp - + A more powerful variant of conditional requirements is indirect conditional requirements. You can provide a rule that will be called with the current build properties and can compute additional properties @@ -1184,7 +1184,7 @@ explicit install_programs ;
-
+
Projects As mentioned before, targets are grouped into projects, @@ -1244,7 +1244,7 @@ project tennis documentation; you almost *had* to get it wrong once. --> - + The default values for those attributes are given in the table below. @@ -1372,7 +1372,7 @@ project tennis of material. -->
-
+
The Build Process When you've described your targets, you want Boost.Build to run the @@ -1405,7 +1405,7 @@ project tennis -
+
Build Request @@ -1423,7 +1423,7 @@ bjam app1 lib1//lib1 toolset=gcc variant=debug optimization=full bjam app1 lib1//lib1 gcc debug optimization=full The complete syntax, which has some additional shortcuts, is - described in . + described in .
diff --git a/doc/src/reference.xml b/doc/src/reference.xml index f0009fea2..4141ec16d 100644 --- a/doc/src/reference.xml +++ b/doc/src/reference.xml @@ -158,7 +158,7 @@ ECHO [ glob-tree *.cpp : .svn ] ; project Declares project id and attributes, including - project requirements. See . + project requirements. See . @@ -235,7 +235,7 @@ path-constant DATA : data/a.txt ;
-
+
Builtin features This section documents the features that are built-in into @@ -299,7 +299,7 @@ path-constant DATA : data/a.txt ; - + link @@ -314,7 +314,7 @@ path-constant DATA : data/a.txt ; - + runtime linking runtime-link @@ -1399,7 +1399,7 @@ using stlport : version : Build process The general overview of the build process was given in the - user documentation. + user documentation. This section provides additional details, and some specific rules. @@ -1631,7 +1631,7 @@ exe a : a.cpp Features of this kind are propagated to dependencies. That is, if a main target is built using a + "bbv2.overview.targets.main">main target is built using a propagated property, the build systems attempts to use the same property when building any of its dependencies as part of that main diff --git a/doc/src/standalone.xml b/doc/src/standalone.xml index be5743dfd..dde41b0db 100644 --- a/doc/src/standalone.xml +++ b/doc/src/standalone.xml @@ -11,7 +11,7 @@ - + diff --git a/doc/src/tasks.xml b/doc/src/tasks.xml index 0d7549988..2b3e68bd1 100644 --- a/doc/src/tasks.xml +++ b/doc/src/tasks.xml @@ -12,7 +12,7 @@ This section describes main targets types that Boost.Build supports out-of-the-box. Unless otherwise noted, all mentioned main target rules have - the common signature, described in . + the common signature, described in .
@@ -537,7 +537,7 @@ actions in2out If you run bjam and file.out does not exist, Boost.Build will run the in2out command to create that file. For more details on specifying actions, see . + linkend="bbv2.overview.jam_language.actions"/>. @@ -725,7 +725,7 @@ exe app : app.cpp : <implicit-dependency>parser ; When using gcc, you first need to specify your cross compiler - in user-config.jam (see ), + in user-config.jam (see ), for example: using gcc : arm : arm-none-linux-gnueabi-g++ ; diff --git a/doc/src/tutorial.xml b/doc/src/tutorial.xml index b63fac3a3..19c387efa 100644 --- a/doc/src/tutorial.xml +++ b/doc/src/tutorial.xml @@ -285,7 +285,7 @@ top/ information More details can be found in - . + . diff --git a/doc/src/userman.xml b/doc/src/userman.xml index 437852136..a431800ba 100644 --- a/doc/src/userman.xml +++ b/doc/src/userman.xml @@ -11,7 +11,7 @@ - + diff --git a/doc/src/v1_vs_v2.xml b/doc/src/v1_vs_v2.xml index 482b61cf8..91b639cf5 100644 --- a/doc/src/v1_vs_v2.xml +++ b/doc/src/v1_vs_v2.xml @@ -16,7 +16,7 @@ some of the syntax was changed, and some new important features were added. This chapter describes most of the changes. -
+
Configuration In V1, toolsets were configured by environment variables. If you @@ -25,12 +25,12 @@ toolset. In V2, toolsets are configured by the using, and you can easily configure several versions of a toolset. See for details. + linkend="bbv2.overview.configuration"/> for details.
-
+
Writing Jamfiles Probably one of the most important differences in V2 Jamfiles is @@ -38,7 +38,7 @@ requirements (for example, a common #include path), it was necessary to manually write the requirements or use a helper rule or template target. In V2, the common properties can be specified with the requirements project - attribute, as documented in . + attribute, as documented in . Usage requirements @@ -54,7 +54,7 @@ The difference between lib and dll targets in V1 is completely eliminated in V2. There's only one library target type, lib, which can create either static or shared libraries depending on the value of the - <link> + <link> feature. If your target should be only built in one way, you can add <link>shared or <link>static to its requirements. @@ -77,7 +77,7 @@ exe a : a.cpp ../foo//bar ;
-
+
Build process The command line syntax in V2 is completely different. For example @@ -92,7 +92,7 @@ bjam toolset=msvc variant=release some_target bjam msvc release some_target - See the reference for a + See the reference for a complete description of the syntax.