diff --git a/doc/src/extending.xml b/doc/src/extending.xml index 3d0fda569..0ca2e8732 100644 --- a/doc/src/extending.xml +++ b/doc/src/extending.xml @@ -393,7 +393,7 @@ import type ; type.register VERBATIM : verbatim ; - The first parameter to type.register gives + The first parameter to type.register gives the name of the declared type. By convention, it's uppercase. The second parameter is the suffix for files of this type. So, if Boost.Build sees code.verbatim in a list of sources, it knows that it's of @@ -1031,8 +1031,8 @@ feature.compose <parallelism>fake : <library>/mpi//fake/<parallel
Main target rules - A main target rule (e.g “exe” - Or “lib”) creates a top-level target. It's quite likely that you'll want to declare your own and + A main target rule (e.g “exe” + Or “lib”) creates a top-level target. It's quite likely that you'll want to declare your own and there are two ways to do that. diff --git a/doc/src/overview.xml b/doc/src/overview.xml index 359376819..90b7c2722 100644 --- a/doc/src/overview.xml +++ b/doc/src/overview.xml @@ -462,7 +462,7 @@ actions create-file-from-another using tool-name : ... ; - The using rule is given the name of tool, and + The using rule is given the name of tool, and will make that tool available to Boost.Build. For example, using gcc ; @@ -478,7 +478,7 @@ using gcc ; For all the C++ compiler toolsets that Boost.Build supports out-of-the-box, the list of parameters to - using is the same: using is the same: toolset-name, version, invocation-command, and To configure several versions of a toolset, simply invoke the - using rule multiple times: + using rule multiple times: using gcc : 3.3 ; using gcc : 3.4 : g++-3.4 ; using gcc : 3.2 : g++-3.2 ; - Note that in the first call to using, the + Note that in the first call to using, the compiler found in the PATH will be used, and there is no need to explicitly specify the command. @@ -1109,7 +1109,8 @@ obj test.debug : test.cpp : <variant>debug ; files. Sometimes, you'll want to automatically construct the list of source files rather than having to spell it out manually, in which case you can use the - glob rule. Here are two examples: + glob rule. + Here are two examples: exe a : a.cpp ; # a.cpp is the only source file exe b : [ glob *.cpp ] ; # all .cpp files in this directory are sources @@ -1306,7 +1307,7 @@ exe hello : hello.cpp When no target is requested on the command line, all targets in the current project will be built. If a target should be built only by explicit request, this can be expressed by the - explicit rule: + explicit rule: explicit install_programs ; @@ -1326,7 +1327,7 @@ explicit install_programs ; Projects are named using the - project rule, which has the + project rule, which has the following syntax: project id : attributes ; @@ -1389,7 +1390,7 @@ project tennis Default value - Handling by the project + Handling by the project rule diff --git a/doc/src/reference.xml b/doc/src/reference.xml index b004580ea..937b578c0 100644 --- a/doc/src/reference.xml +++ b/doc/src/reference.xml @@ -126,7 +126,7 @@ boost-build build-system ; common syntax. - + glob The glob rule takes a list shell pattern @@ -178,7 +178,7 @@ ECHO [ glob-tree *.cpp : .svn ] ; - + explicit The explicit rule takes a single diff --git a/doc/src/tasks.xml b/doc/src/tasks.xml index 13a3ae312..d6419d4d8 100644 --- a/doc/src/tasks.xml +++ b/doc/src/tasks.xml @@ -211,7 +211,7 @@ lib helpers : helpers.cpp : : : <include>. ; Alias - The alias rule gives an alternative name to a + The alias rule gives an alternative name to a group of targets. For example, to give the name core to a group of three other targets with the following code: @@ -392,8 +392,8 @@ unit-test helpers_test : helpers_test.cpp helpers ; - The unit-test rule behaves like the - exe rule, but after the executable is created + The unit-test rule behaves like the + exe rule, but after the executable is created it is also run. If the executable returns an error code, the build system will also return an error and will try running the executable on the next invocation until it runs successfully. This behaviour ensures that you can @@ -506,22 +506,22 @@ boost-test(test-type) path - Three main target rules can be used for that. The make - rule allows you to construct a single file from any number - of source file, by running a command you specify. The - notfile rule allows you to run an arbitrary command, - without creating any files. And finaly, the generate - rule allows you to describe a transformation using + Three main target rules can be used for that. The make + rule allows you to construct a single file from any number + of source file, by running a command you specify. The + notfile rule allows you to run an arbitrary command, + without creating any files. And finaly, the generate + rule allows you to describe a transformation using Boost.Build's virtual targets. This is higher-level than the file names that - the make rule operates with and allows you to + the make rule operates with and allows you to create more than one target, create differently named targets depending on properties or use more than one tool. - The make rule is used when you want to create + The make rule is used when you want to create one file from a number of sources using some specific command. The - notfile is used to unconditionally run a + notfile is used to unconditionally run a command. @@ -551,7 +551,7 @@ actions in2out It could be that you just want to run some command unconditionally, and that command does not create any specific files. For that you can use the - notfile rule. For example: + notfile rule. For example: notfile echo_something : @echo ; actions echo @@ -559,7 +559,7 @@ actions echo echo "something" } - The only difference from the make rule is + The only difference from the make rule is that the name of the target is not considered a name of a file, so Boost.Build will unconditionally run the action. @@ -567,9 +567,9 @@ actions echo - The generate rule is used when you want to + The generate rule is used when you want to express transformations using Boost.Build's virtual targets, as opposed to - just filenames. The generate rule has the + just filenames. The generate rule has the standard main target rule signature, but you are required to specify the generating-rule property. The value of the property should be in the form @@ -628,7 +628,7 @@ rule generating-rule ( project name : property-set : sources * ) cpp-pch pch : pch.hpp ; exe main : main.cpp pch ; - You can use the c-pch rule if you want to + You can use the c-pch rule if you want to use the precompiled header in C programs. diff --git a/doc/src/tutorial.xml b/doc/src/tutorial.xml index a91926f04..91d87b4ce 100644 --- a/doc/src/tutorial.xml +++ b/doc/src/tutorial.xml @@ -498,9 +498,9 @@ alias foo : /other_project//bar/<link>static ; exe e1 : e1.cpp foo ; exe e10 : e10.cpp foo ; - The alias - rule is specifically used to rename a reference to a target and - possibly change the properties. + The alias rule is specifically + used to rename a reference to a target and possibly change the + properties.