boost/build
2
0
Fork 0
mirror of https://github.com/boostorg/build.git synced 2026-02-14 00:32:11 +00:00
Code Issues Projects Releases Wiki Activity

Merge #127: Documentation fixes, largely grammar and spelling corrections

Browse Source
This commit is contained in:
Vladimir Prus
2016-05-17 16:13:15 +03:00
parent 24f97b090f d0f83a8cb5
commit e3311b23f0
4 changed files with 28 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/src/overview.xml
View File

@@ -107,7 +107,7 @@ a.o: a.c
<programlisting>
add_program ("a", "a.c")
</programlisting>
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 <filename>a.c</filename>. Depending on configured properties,
different command lines may be used. However, <code>add_program</code> is higher-level,
but rather thin level. All targets are created immediately when the build description
@@ -675,7 +675,7 @@ b2 toolset=gcc variant=debug optimization=space
<listitem>
<para>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>--build-dir</option> option, the project name
specified in Jamroot, and the build dir specified in Jamroot
(or <literal>bin</literal>, if none is specified).
@@ -782,12 +782,12 @@ b2 toolset=gcc variant=debug optimization=space
<varlistentry>
<term><option>-d <replaceable>N</replaceable></option></term>
<listitem>
<para>Enable cummulative debugging levels from 1 to n. Values are:
<para>Enable cumulative debugging levels from 1 to n. Values are:
<orderedlist>
<listitem>Show the actions taken for building targets, as they are executed (the default).</listitem>
<listitem>Show "quiet" actions and display all action text, as they are executed.</listitem>
<listitem>Show dependency analysis, and target/source timestamps/paths.</listitem>
<listitem>Show arguments and timming of shell invocations.</listitem>
<listitem>Show arguments and timing of shell invocations.</listitem>
<listitem>Show rule invocations and variable expansions.</listitem>
<listitem>Show directory/header file/archive scans, and attempts at binding to targets.</listitem>
<listitem>Show variable settings.</listitem>
@@ -1595,7 +1595,7 @@ b2 app1 lib1//lib1 gcc debug optimization=full
<listitem><para>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.
</para></listitem>
<listitem><para>Determining "common" properties.

19
doc/src/reference.xml
View File

@@ -50,7 +50,7 @@ boost-build build-system ;
automatically find the build system.</para>
<para>The default <filename>bootstrap.jam</filename>, after loading some standard
definitions, loads two <filename>site-config.jam</filename> and <filename>user-config.jam</filename>.</para>
definitions, loads both <filename>site-config.jam</filename> and <filename>user-config.jam</filename>.</para>
</section>
@@ -165,7 +165,7 @@ lib tools : [ glob *.cpp ] ;
</programlisting>
It is possible to also pass a second argument&#x2014;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:
<programlisting>
lib tools : [ glob *.cpp : file_to_exclude.cpp bad*.cpp ] ;
@@ -567,7 +567,7 @@ path-constant DATA : data/a.txt ;
<simpara>
The value of those features is passed without modification to the
corresponding tools. For <code>cflags</code> that is both the C and
C++ compilers, for <code>cxxflags</code> that is the C++ compiler
C++ compilers, for <code>cxxflags</code> that is the C++ compiler,
and for <code>linkflags</code> 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 +672,7 @@ path-constant DATA : data/a.txt ;
<para><emphasis role="bold">Allowed values:</emphasis> <literal>on</literal>, <literal>off</literal>.</para>
<para>The <literal>debug-symbols</literal> 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
<literal>variant</literal> feature, but it can be explicitly
@@ -686,8 +686,8 @@ path-constant DATA : data/a.txt ;
<listitem>
<para><emphasis role="bold">Allowed values:</emphasis> <literal>on</literal>, <literal>off</literal>.</para>
<para>The <literal>runtime-debugging</literal> feature specifies if
produced object files, executables and libraries should include
<para>The <literal>runtime-debugging</literal> 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
<literal>variant</literal> feature, but it can be explicitly
@@ -937,7 +937,7 @@ using gcc : &toolset_ops; ;</programlisting>
<para>Specifies the archiver command that is used to produce static
libraries. Normally, it is autodetected using gcc
<command>-print-prog-name</command> option or defaulted to <command>ar</command>,
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.</para>
</listitem>
</varlistentry>
@@ -949,7 +949,7 @@ using gcc : &toolset_ops; ;</programlisting>
<para>Specifies the ranlib command that is used to generated symbol table
for static libraries. Normally, it is autodetected using gcc
<command>-print-prog-name</command> option or defaulted to <command>ranlib</command>,
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.</para>
</listitem>
</varlistentry>
@@ -1021,6 +1021,9 @@ using gcc : &toolset_ops; ;</programlisting>
C++</ulink> command-line tools on Microsoft Windows. The supported
products and versions of command line tools are listed below:</para>
<itemizedlist>
<listitem><para>Visual Studio 2015&#x2014;14.0</para></listitem>
<listitem><para>Visual Studio 2013&#x2014;12.0</para></listitem>
<listitem><para>Visual Studio 2012&#x2014;11.0</para></listitem>
<listitem><para>Visual Studio 2010&#x2014;10.0</para></listitem>
<listitem><para>Visual Studio 2008&#x2014;9.0</para></listitem>
<listitem><para>Visual Studio 2005&#x2014;8.0</para></listitem>

12
doc/src/tasks.xml
View File

@@ -520,7 +520,7 @@ unit-test helpers_test
<para>
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:
<programlisting>
unit-test 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 <code language="jam">make</code> 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.
</para>
<para>
@@ -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.
</para>
@@ -800,14 +800,14 @@ using gcc : arm : arm-none-linux-gnueabi-g++ ;
</programlisting>
<para>
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:
</para>
<screen>
b2 toolset=gcc-arm
</screen>
<para>
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 <code>target-os</code> feature, for
example:
</para>
@@ -823,7 +823,7 @@ b2 toolset=gcc-mingw <emphasis role="bold">target-os=windows</emphasis>
</para>
<para>
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 <xref linkend="v2.reference.tools.compiler.msvc.64"/> for
details.
</para>

12
doc/src/tutorial.xml
View File

@@ -179,7 +179,7 @@ exe hello
See <xref linkend="bbv2.reference.features.attributes"/>
</para>
</footnote>
augments) the build request.
augment) the build request.
</para>
<tip>
@@ -384,7 +384,7 @@ project
lib foo : foo.cpp ;</programlisting>
Usage requirements are applied not to the target being declared but to its
dependants. In this case, <literal>&lt;include&gt;.</literal> will be
dependents. In this case, <literal>&lt;include&gt;.</literal> will be
applied to all targets that directly depend on <filename>foo</filename>.
</para>
@@ -417,7 +417,7 @@ exe app : app.cpp /library-example/foo//bar ;</programlisting>
<tip>
<para>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 <varname>&lt;library&gt;</varname> property.
For example, if <filename>/boost/filesystem//fs</filename> should be
linked to all applications in your project, you can add
@@ -433,7 +433,7 @@ project
</section>
<section id="bbv2.tutorial.linkage">
<title>Static and shared libaries</title>
<title>Static and shared libraries</title>
<para>
Libraries can be either <emphasis>static</emphasis>, which means they are
@@ -621,8 +621,8 @@ lib lib2
exe app : app.cpp ../util/lib2//lib2 ;</programlisting>
As with any target, the alternative selected depends on the properties
propagated from <filename>lib2</filename>'s dependants. If we build the
release and debug versions of <filename>app</filename> will be linked
propagated from <filename>lib2</filename>'s dependents. If we build the
release and debug versions of <filename>app</filename> it will be linked
with <filename>lib2_release.a</filename> and <filename>lib2_debug.a
</filename>, respectively.
</para>