From 1e6a12f5bd206be547c832ddea4ad51c2625a43f Mon Sep 17 00:00:00 2001 From: Edward Diener Date: Fri, 29 Apr 2016 07:58:50 -0400 Subject: [PATCH 1/5] Documentation fixes, largely grammar and spelling corrections. --- doc/src/overview.xml | 12 ++++++------ doc/src/reference.xml | 39 ++++++++++++++++++++++----------------- doc/src/tasks.xml | 14 +++++++------- doc/src/tutorial.xml | 16 ++++++++-------- 4 files changed, 43 insertions(+), 38 deletions(-) diff --git a/doc/src/overview.xml b/doc/src/overview.xml index 1c2310b96..04c1c7754 100644 --- a/doc/src/overview.xml +++ b/doc/src/overview.xml @@ -107,7 +107,7 @@ a.o: a.c add_program ("a", "a.c") - This is a function call that creates the targets necessary to create a executable file + This is a function call that creates the targets necessary to create an executable file from the source file a.c. Depending on configured properties, different command lines may be used. However, add_program is higher-level, but rather thin level. All targets are created immediately when the build description @@ -675,10 +675,10 @@ b2 toolset=gcc variant=debug optimization=space Changes the build directories for all project roots being built. When this option is specified, all Jamroot files must declare a project name. - The build directory for the project root will be computed by concatanating + The build directory for the project root will be computed by concatenating the value of the option, the project name specified in Jamroot, and the build dir specified in Jamroot - (or bin, if none is specified). + (or bin.v2, if none is specified). The option is primarily useful when building from read-only @@ -782,12 +782,12 @@ b2 toolset=gcc variant=debug optimization=space - Enable cummulative debugging levels from 1 to n. Values are: + Enable cumulative debugging levels from 1 to n. Values are: Show the actions taken for building targets, as they are executed (the default). Show "quiet" actions and display all action text, as they are executed. Show dependency analysis, and target/source timestamps/paths. - Show arguments and timming of shell invocations. + Show arguments and timing of shell invocations. Show rule invocations and variable expansions. Show directory/header file/archive scans, and attempts at binding to targets. Show variable settings. @@ -1595,7 +1595,7 @@ b2 app1 lib1//lib1 gcc debug optimization=full Selecting the main target alternative to use. For each alternative we look how many properties are present both in alternative's requirements, and in build request. The - alternative with large number of matching properties is selected. + alternative with largest number of matching properties is selected. Determining "common" properties. diff --git a/doc/src/reference.xml b/doc/src/reference.xml index a66eb75a6..6c7e31540 100644 --- a/doc/src/reference.xml +++ b/doc/src/reference.xml @@ -50,7 +50,7 @@ boost-build build-system ; automatically find the build system. The default bootstrap.jam, after loading some standard - definitions, loads two site-config.jam and user-config.jam. + definitions, loads both site-config.jam and user-config.jam. @@ -165,7 +165,7 @@ lib tools : [ glob *.cpp ] ; It is possible to also pass a second argument—the list of exclude patterns. The result will then include the list of - files patching any of include patterns, and not matching any + files matching any of include patterns, and not matching any of the exclude patterns. For example: lib tools : [ glob *.cpp : file_to_exclude.cpp bad*.cpp ] ; @@ -561,13 +561,15 @@ path-constant DATA : data/a.txt ; cflags cxxflags + compileflags linkflags The value of those features is passed without modification to the - corresponding tools. For cflags that is both the C and - C++ compilers, for cxxflags that is the C++ compiler + corresponding tools. For cflags that is C compiler, + for cxxflags that is the C++ compiler, + for compileflags that is both the C and C++ compilers, and for linkflags that is the linker. The features are handy when you are trying to do something special that cannot be achieved by a higher-level feature in Boost.Build. @@ -672,7 +674,7 @@ path-constant DATA : data/a.txt ; Allowed values: on, off. The debug-symbols feature specifies if - produced object files, executables and libraries should include + produced object files, executables, and libraries should include debug information. Typically, the value of this feature is implicitly set by the variant feature, but it can be explicitly @@ -686,8 +688,8 @@ path-constant DATA : data/a.txt ; Allowed values: on, off. - The runtime-debugging feature specifies if - produced object files, executables and libraries should include + The runtime-debugging feature specifies that, + if produced, object files, executables, and libraries should include behaviour useful only for debugging, such as asserts. Typically, the value of this feature is implicitly set by the variant feature, but it can be explicitly @@ -937,7 +939,7 @@ using gcc : &toolset_ops; ; Specifies the archiver command that is used to produce static libraries. Normally, it is autodetected using gcc -print-prog-name option or defaulted to ar, - but in some cases you might want to override it, for example to expliitly + but in some cases you might want to override it, for example to explicitly use a system version instead of one included with gcc. @@ -949,7 +951,7 @@ using gcc : &toolset_ops; ; Specifies the ranlib command that is used to generated symbol table for static libraries. Normally, it is autodetected using gcc -print-prog-name option or defaulted to ranlib, - but in some cases you might want to override it, for example to expliitly + but in some cases you might want to override it, for example to explicitly use a system version instead of one included with gcc. @@ -1021,6 +1023,9 @@ using gcc : &toolset_ops; ; C++ command-line tools on Microsoft Windows. The supported products and versions of command line tools are listed below: + Visual Studio 2015—14.0 + Visual Studio 2013—12.0 + Visual Studio 2012—11.0 Visual Studio 2010—10.0 Visual Studio 2008—9.0 Visual Studio 2005—8.0 @@ -1058,7 +1063,7 @@ using msvc : &toolset_ops; ; The command that compiles assembler sources. If not specified, ml will be used. The command will be invoked after the setup script was executed and adjusted - the PATH variable. + by the PATH variable. @@ -1067,7 +1072,7 @@ using msvc : &toolset_ops; ; The command that compiles C and C++ sources. If not specified, cl will be used. The command will be invoked after the setup script was executed and adjusted - the PATH variable. + by the PATH variable. @@ -1084,7 +1089,7 @@ using msvc : &toolset_ops; ; The command that compiles Microsoft COM interface definition files. If not specified, midl will be used. The command will be invoked after the setup script was - executed and adjusted the PATH variable. + executed and adjusted by the PATH variable. @@ -1094,7 +1099,7 @@ using msvc : &toolset_ops; ; The command that links executables and dynamic libraries. If not specified, link will be used. The command will be invoked after the setup script was executed - and adjusted the PATH variable. + and adjusted by the PATH variable. @@ -1103,7 +1108,7 @@ using msvc : &toolset_ops; ; The command that compiles Microsoft message catalog files. If not specified, mc will be used. The command will be invoked after the setup script was - executed and adjusted the PATH variable. + executed and adjusted by the PATH variable. @@ -1112,7 +1117,7 @@ using msvc : &toolset_ops; ; The command that compiles resource files. If not specified, rc will be used. The command will be - invoked after the setup script was executed and adjusted the + invoked after the setup script was executed and adjusted by the PATH variable. @@ -1443,7 +1448,7 @@ using cw : &toolset_ops; ; The command that compiles C and C++ sources. If not specified, mwcc will be used. The command will be invoked after the setup script was - executed and adjusted the PATH variable. + executed and adjusted by the PATH variable. @@ -1454,7 +1459,7 @@ using cw : &toolset_ops; ; libraries. If not specified, mwld will be used. The command will be invoked after the setup script was - executed and adjusted the PATH variable. + executed and adjusted by the PATH variable. diff --git a/doc/src/tasks.xml b/doc/src/tasks.xml index 8ff82f0b8..a4a357986 100644 --- a/doc/src/tasks.xml +++ b/doc/src/tasks.xml @@ -520,7 +520,7 @@ unit-test helpers_test By default, the executable is run directly. Sometimes, it is desirable to run the executable using some helper command. You - should use the this property to specify the name of the helper + should use this property to specify the name of the helper command. For example, if you write: unit-test helpers_test @@ -530,7 +530,7 @@ unit-test helpers_test The command used to run the executable will be: -valgrind bin/$toolset/debug/helpers_test +valgrind bin.v2/$toolset/debug/helpers_test @@ -575,7 +575,7 @@ unit-test helpers_test Boost.Build's virtual targets. This is higher-level than the file names that 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. + properties, or use more than one tool. @@ -764,7 +764,7 @@ exe main : main.cpp pch ; "parser.y". The latter source is converted into "parser.c" and "parser.h". Then, if "app.cpp" includes "parser.h", Boost.Build will detect this dependency. Moreover, since "parser.h" will be generated into a build - directory, the path to that directory will automatically added to include + directory, the path to that directory will automatically be added to the include path. @@ -800,14 +800,14 @@ using gcc : arm : arm-none-linux-gnueabi-g++ ; After that, if the host and target os are the same, for example Linux, you can - just request that this compiler version to be used: + just request that this compiler version be used: b2 toolset=gcc-arm - If you want to target different operating system from the host, you need + If you want to target a different operating system from the host, you need to additionally specify the value for the target-os feature, for example: @@ -823,7 +823,7 @@ b2 toolset=gcc-mingw target-os=windows - When using the msvc compiler, it's only possible to cross-compiler to a 64-bit system + When using the msvc compiler, it's only possible to cross-compile to a 64-bit system on a 32-bit host. Please see for details. diff --git a/doc/src/tutorial.xml b/doc/src/tutorial.xml index 3227a6718..727c912cc 100644 --- a/doc/src/tutorial.xml +++ b/doc/src/tutorial.xml @@ -179,7 +179,7 @@ exe hello See - augments) the build request. + augment) the build request. @@ -280,8 +280,8 @@ top/ in their requirements, too. Of course, any project can add include paths to those specified by its parents. Many - features will be overridden, - rather than added-to, in subprojects. See for more information @@ -384,7 +384,7 @@ project lib foo : foo.cpp ; Usage requirements are applied not to the target being declared but to its - dependants. In this case, <include>. will be + dependents. In this case, <include>. will be applied to all targets that directly depend on foo. @@ -417,7 +417,7 @@ exe app : app.cpp /library-example/foo//bar ; If you want all applications in some project to link to a certain - library, you can avoid having to specify it directly the sources of + library, you can avoid having to specify directly the sources of every target by using the <library> property. For example, if /boost/filesystem//fs should be linked to all applications in your project, you can add @@ -433,7 +433,7 @@ project
- Static and shared libaries + Static and shared libraries Libraries can be either static, which means they are @@ -621,8 +621,8 @@ lib lib2 exe app : app.cpp ../util/lib2//lib2 ; As with any target, the alternative selected depends on the properties - propagated from lib2's dependants. If we build the - release and debug versions of app will be linked + propagated from lib2's dependents. If we build the + release and debug versions of app it will be linked with lib2_release.a and lib2_debug.a , respectively. From ef4c1035109eacc6f29da7eceb1bc668aba52427 Mon Sep 17 00:00:00 2001 From: Edward Diener Date: Fri, 29 Apr 2016 08:17:11 -0400 Subject: [PATCH 2/5] Remove syntactical change previously made. --- doc/src/reference.xml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/src/reference.xml b/doc/src/reference.xml index 6c7e31540..752cb57fa 100644 --- a/doc/src/reference.xml +++ b/doc/src/reference.xml @@ -1063,7 +1063,7 @@ using msvc : &toolset_ops; ; The command that compiles assembler sources. If not specified, ml will be used. The command will be invoked after the setup script was executed and adjusted - by the PATH variable. + the PATH variable. @@ -1072,7 +1072,7 @@ using msvc : &toolset_ops; ; The command that compiles C and C++ sources. If not specified, cl will be used. The command will be invoked after the setup script was executed and adjusted - by the PATH variable. + the PATH variable. @@ -1089,7 +1089,7 @@ using msvc : &toolset_ops; ; The command that compiles Microsoft COM interface definition files. If not specified, midl will be used. The command will be invoked after the setup script was - executed and adjusted by the PATH variable. + executed and adjusted the PATH variable. @@ -1099,7 +1099,7 @@ using msvc : &toolset_ops; ; The command that links executables and dynamic libraries. If not specified, link will be used. The command will be invoked after the setup script was executed - and adjusted by the PATH variable. + and adjusted the PATH variable. @@ -1108,7 +1108,7 @@ using msvc : &toolset_ops; ; The command that compiles Microsoft message catalog files. If not specified, mc will be used. The command will be invoked after the setup script was - executed and adjusted by the PATH variable. + executed and adjusted the PATH variable. @@ -1117,7 +1117,7 @@ using msvc : &toolset_ops; ; The command that compiles resource files. If not specified, rc will be used. The command will be - invoked after the setup script was executed and adjusted by the + invoked after the setup script was executed and adjusted the PATH variable. @@ -1448,7 +1448,7 @@ using cw : &toolset_ops; ; The command that compiles C and C++ sources. If not specified, mwcc will be used. The command will be invoked after the setup script was - executed and adjusted by the PATH variable. + executed and adjusted the PATH variable. @@ -1459,7 +1459,7 @@ using cw : &toolset_ops; ; libraries. If not specified, mwld will be used. The command will be invoked after the setup script was - executed and adjusted by the PATH variable. + executed and adjusted the PATH variable. From f7e019c8ade42d53fe1e35bd779fbd4d9370e9e6 Mon Sep 17 00:00:00 2001 From: Edward Diener Date: Fri, 29 Apr 2016 12:55:51 -0400 Subject: [PATCH 3/5] Corrected terminology in the documentation. --- doc/src/overview.xml | 2 +- doc/src/reference.xml | 4 ++-- doc/src/tasks.xml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/src/overview.xml b/doc/src/overview.xml index 04c1c7754..37bae1c96 100644 --- a/doc/src/overview.xml +++ b/doc/src/overview.xml @@ -678,7 +678,7 @@ b2 toolset=gcc variant=debug optimization=space The build directory for the project root will be computed by concatenating the value of the option, the project name specified in Jamroot, and the build dir specified in Jamroot - (or bin.v2, if none is specified). + (or bin, if none is specified). The option is primarily useful when building from read-only diff --git a/doc/src/reference.xml b/doc/src/reference.xml index 752cb57fa..b312112d4 100644 --- a/doc/src/reference.xml +++ b/doc/src/reference.xml @@ -688,8 +688,8 @@ path-constant DATA : data/a.txt ; Allowed values: on, off. - The runtime-debugging feature specifies that, - if produced, object files, executables, and libraries should include + The runtime-debugging feature specifies + whether produced object files, executables, and libraries should include behaviour useful only for debugging, such as asserts. Typically, the value of this feature is implicitly set by the variant feature, but it can be explicitly diff --git a/doc/src/tasks.xml b/doc/src/tasks.xml index a4a357986..48f611a28 100644 --- a/doc/src/tasks.xml +++ b/doc/src/tasks.xml @@ -530,7 +530,7 @@ unit-test helpers_test The command used to run the executable will be: -valgrind bin.v2/$toolset/debug/helpers_test +valgrind bin/$toolset/debug/helpers_test From 6f8ed92ce93381348e5fecf0bdc8575d22c5c9c3 Mon Sep 17 00:00:00 2001 From: Edward Diener Date: Fri, 29 Apr 2016 15:57:49 -0400 Subject: [PATCH 4/5] Removed erroneous documentation fix. --- doc/src/reference.xml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/src/reference.xml b/doc/src/reference.xml index b312112d4..535e78d7b 100644 --- a/doc/src/reference.xml +++ b/doc/src/reference.xml @@ -561,15 +561,13 @@ path-constant DATA : data/a.txt ; cflags cxxflags - compileflags linkflags The value of those features is passed without modification to the - corresponding tools. For cflags that is C compiler, - for cxxflags that is the C++ compiler, - for compileflags that is both the C and C++ compilers, + corresponding tools. For cflags that is both the C and + C++ compilers, for cxxflags that is the C++ compiler, and for linkflags that is the linker. The features are handy when you are trying to do something special that cannot be achieved by a higher-level feature in Boost.Build. From d0f83a8cb538ed42d8ea23c792221a98c9ae2de5 Mon Sep 17 00:00:00 2001 From: Edward Diener Date: Sat, 30 Apr 2016 12:59:12 -0400 Subject: [PATCH 5/5] Remove grammatical fix. --- doc/src/tutorial.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/src/tutorial.xml b/doc/src/tutorial.xml index 727c912cc..e36ac1402 100644 --- a/doc/src/tutorial.xml +++ b/doc/src/tutorial.xml @@ -280,8 +280,8 @@ top/ in their requirements, too. Of course, any project can add include paths to those specified by its parents. Many - features will be overridden in, - rather than added-to, subprojects. See for more information