boost/build
2
0
Fork 0
mirror of https://github.com/boostorg/build.git synced 2026-02-16 01:12:13 +00:00
Code Issues Projects Releases Wiki Activity

Rename advanced.xml to overview.xml, to reduce confusion.

Browse Source 
[SVN r55715]
This commit is contained in:
Vladimir Prus
2009-08-22 08:42:34 +00:00
parent 9f84f695dd
commit 0f454eb2aa
9 changed files with 49 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
v2/doc/src/faq.xml
View File

@@ -30,7 +30,7 @@
<listitem>
<simpara>
Use conditional requirements or indirect conditional requirements. See
<xref linkend="bbv2.advanced.targets.requirements.conditional"/>.
<xref linkend="bbv2.overview.targets.requirements.conditional"/>.
</simpara>
</listitem>
<listitem>

6
v2/doc/src/howto.xml
View File

@@ -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 <xref linkend=
"bbv2.tutorial" />. You can continue with <xref
linkend="bbv2.advanced" />. When you're ready to try Boost.Build
linkend="bbv2.overview" />. When you're ready to try Boost.Build
in practice, go to <xref linkend="bbv2.installation"/>.
</para>
<para>
If you are about to use Boost.Build on your project, or already
using it and have a problem, look at <xref linkend=
"bbv2.advanced"/>.
"bbv2.overview"/>.
</para>
<para>
If you're trying to build a project which uses Boost.Build,
see <xref linkend="bbv2.installation"/> and then read about
<xref linkend="bbv2.advanced.invocation"/>.
<xref linkend="bbv2.overview.invocation"/>.
</para>
<para>

52
v2/doc/src/advanced.xml → v2/doc/src/overview.xml
View File

@@ -2,7 +2,7 @@
<!DOCTYPE chapter PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
<chapter id="bbv2.advanced">
<chapter id="bbv2.overview">
<title>Overview</title>
<para>
@@ -57,32 +57,32 @@
<itemizedlist>
<listitem>
<para>
<link linkend="bbv2.advanced.configuration">How to configure
<link linkend="bbv2.overview.configuration">How to configure
Boost.Build</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="bbv2.advanced.targets">How to declare targets in
<link linkend="bbv2.overview.targets">How to declare targets in
Jamfiles</link>
</para>
</listitem>
<listitem>
<para>
<link linkend="bbv2.advanced.build_process">How the build process
<link linkend="bbv2.overview.build_process">How the build process
works</link>
</para>
</listitem>
<listitem>
<para>
Some Basics about the Boost.Jam language. See <xref linkend=
"bbv2.advanced.jam_language"/>.
"bbv2.overview.jam_language"/>.
</para>
</listitem>
</itemizedlist>
</para>
<section id="bbv2.advanced.jam_language">
<section id="bbv2.overview.jam_language">
<title>Boost.Jam Language</title>
<para>
@@ -245,7 +245,7 @@ import <replaceable>module</replaceable> : <replaceable>rule</replaceable> ;
unqualified names.
</para>
<para id="bbv2.advanced.jam_language.actions">
<para id="bbv2.overview.jam_language.actions">
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
</para>
</section>
<section id="bbv2.advanced.configuration">
<section id="bbv2.overview.configuration">
<title>Configuration</title>
<para>
@@ -491,7 +491,7 @@ using gcc : 3.4 : g++-3.4 ;
</section>
<section id="bbv2.advanced.invocation">
<section id="bbv2.overview.invocation">
<title>Invocation</title>
<para>To invoke Boost.Build, type <command>bjam</command> on the command line. Three kinds
@@ -523,7 +523,7 @@ using gcc : 3.4 : g++-3.4 ;
</varlistentry>
</variablelist>
<section id="bbv2.advanced.invocation.examples">
<section id="bbv2.overview.invocation.examples">
<title>Examples</title>
<para>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
</para>
</section>
<section id="bbv2.advanced.invocation.options">
<section id="bbv2.overview.invocation.options">
<title>Options</title>
<para>Boost.Build recognizes the following command line options.</para>
@@ -688,13 +688,13 @@ bjam toolset=gcc variant=debug optimization=space
</variablelist>
</section>
<section id="bbv2.advanced.invocation.properties">
<section id="bbv2.overview.invocation.properties">
<title>Properties</title>
<para>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
<command><replaceable>feature</replaceable>=<replaceable>value</replaceable></command>.
The complete list of features can be found in <xref linkend="bbv2.advanced.builtins.features"/>.
The complete list of features can be found in <xref linkend="bbv2.overview.builtins.features"/>.
The most common features are summarized below.</para>
<table>
@@ -842,7 +842,7 @@ bjam include=static,shared
</section>
<section id="bbv2.advanced.invocation.targets">
<section id="bbv2.overview.invocation.targets">
<title>Targets</title>
<para>All command line elements that are neither options nor properties are the names of the
@@ -852,10 +852,10 @@ bjam include=static,shared
</section>
<section id="bbv2.advanced.targets">
<section id="bbv2.overview.targets">
<title>Declaring Targets</title>
<para id="bbv2.advanced.targets.main">
<para id="bbv2.overview.targets.main">
A <firstterm>Main target</firstterm> 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&#x200A;&#x2014;&#x200A;which is typically
the directory where the Jamfile is located, but can be changed as
described in <xref linkend=
"bbv2.advanced.projects.attributes.projectrule"/>.
"bbv2.overview.projects.attributes.projectrule"/>.
</para>
<para>
@@ -1021,7 +1021,7 @@ exe c : c.cpp /boost/program_options//program_options ;
</para>
</section>
<section id="bbv2.advanced.targets.requirements">
<section id="bbv2.overview.targets.requirements">
<title>Requirements</title>
<indexterm><primary>requirements</primary></indexterm>
<para>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 : &lt;include&gt;/opt/boost &lt;define&gt;MY_DEBUG ;
</programlisting>
There is a number of other features, listed in
<xref linkend="bbv2.advanced.builtins.features"/>. For example if
<xref linkend="bbv2.overview.builtins.features"/>. 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
<programlisting>
@@ -1039,7 +1039,7 @@ obj main : main.cpp : &lt;optimization&gt;off ;
</programlisting>
</para>
<para id="bbv2.advanced.targets.requirements.conditional">Sometimes, particular relationships need to be maintained
<para id="bbv2.overview.targets.requirements.conditional">Sometimes, particular relationships need to be maintained
among a target's build properties. This can be achieved with
<firstterm>conditional
requirements</firstterm>. For example, you might want to set
@@ -1067,7 +1067,7 @@ lib network : network.cpp
</programlisting>
</para>
<para id="bbv2.advanced.targets.requirements.indirect">
<para id="bbv2.overview.targets.requirements.indirect">
A more powerful variant of conditional requirements
is <firstterm>indirect conditional requirements</firstterm>.
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 ;</programlisting>
</section>
</section>
<section id="bbv2.advanced.projects">
<section id="bbv2.overview.projects">
<title>Projects</title>
<para>As mentioned before, targets are grouped into projects,
@@ -1244,7 +1244,7 @@ project tennis
documentation; you almost *had* to get it wrong once.
-->
<para id="bbv2.advanced.projects.attributes.projectrule">
<para id="bbv2.overview.projects.attributes.projectrule">
The default values for those attributes are
given in the table below.
@@ -1372,7 +1372,7 @@ project tennis
of material. -->
</section>
<section id="bbv2.advanced.build_process">
<section id="bbv2.overview.build_process">
<title>The Build Process</title>
<para>When you've described your targets, you want Boost.Build to run the
@@ -1405,7 +1405,7 @@ project tennis
</para>
</tip>
<section id="bbv2.advanced.build_request">
<section id="bbv2.overview.build_request">
<title>Build Request</title>
<para>
@@ -1423,7 +1423,7 @@ bjam app1 lib1//lib1 toolset=gcc variant=debug optimization=full
bjam app1 lib1//lib1 gcc debug optimization=full
</programlisting>
The complete syntax, which has some additional shortcuts, is
described in <xref linkend="bbv2.advanced.invocation"/>.
described in <xref linkend="bbv2.overview.invocation"/>.
</para>
</section>

12
v2/doc/src/reference.xml
View File

@@ -158,7 +158,7 @@ ECHO [ glob-tree *.cpp : .svn ] ;
<term><literal>project</literal></term>
<listitem><para>Declares project id and attributes, including
project requirements. See <xref linkend="bbv2.advanced.projects"/>.
project requirements. See <xref linkend="bbv2.overview.projects"/>.
</para></listitem>
</varlistentry>
@@ -235,7 +235,7 @@ path-constant DATA : data/a.txt ;
</section>
<section id="bbv2.advanced.builtins.features">
<section id="bbv2.overview.builtins.features">
<title>Builtin features</title>
<para>This section documents the features that are built-in into
@@ -299,7 +299,7 @@ path-constant DATA : data/a.txt ;
</listitem>
</varlistentry>
<varlistentry id="bbv2.advanced.builtins.features.link">
<varlistentry id="bbv2.overview.builtins.features.link">
<term><literal>link</literal></term>
<listitem>
@@ -314,7 +314,7 @@ path-constant DATA : data/a.txt ;
</listitem>
</varlistentry>
<varlistentry id="bbv2.advanced.builtins.features.runtime-link">
<varlistentry id="bbv2.overview.builtins.features.runtime-link">
<indexterm><primary>runtime linking</primary></indexterm>
<term><literal>runtime-link</literal></term>
@@ -1399,7 +1399,7 @@ using stlport : <optional><replaceable>version</replaceable></optional> : <repla
<title>Build process</title>
<para>The general overview of the build process was given in the
<link linkend="bbv2.advanced.build_process">user documentation</link>.
<link linkend="bbv2.overview.build_process">user documentation</link>.
This section provides additional details, and some specific rules.
</para>
@@ -1631,7 +1631,7 @@ exe a : a.cpp
<para>Features of this kind are
propagated to dependencies. That is, if a <link linkend=
"bbv2.advanced.targets.main">main target</link> is built using a
"bbv2.overview.targets.main">main target</link> 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

2
v2/doc/src/standalone.xml
View File

@@ -11,7 +11,7 @@
<xi:include href="howto.xml"/>
<xi:include href="install.xml"/>
<xi:include href="tutorial.xml"/>
<xi:include href="advanced.xml"/>
<xi:include href="overview.xml"/>
<xi:include href="tasks.xml"/>
<xi:include href="reference.xml"/>
<xi:include href="extending.xml"/>

6
v2/doc/src/tasks.xml
View File

@@ -12,7 +12,7 @@
<para>
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 <xref linkend="bbv2.advanced.targets"/>.
the common signature, described in <xref linkend="bbv2.overview.targets"/>.
</para>
<section id="bbv2.tasks.programs">
@@ -537,7 +537,7 @@ actions in2out
If you run <command>bjam</command> and <filename>file.out</filename> does
not exist, Boost.Build will run the <command>in2out</command> command to
create that file. For more details on specifying actions, see <xref
linkend="bbv2.advanced.jam_language.actions"/>.
linkend="bbv2.overview.jam_language.actions"/>.
</para>
<para>
@@ -725,7 +725,7 @@ exe app : app.cpp : &lt;implicit-dependency&gt;parser ;
<para>
When using gcc, you first need to specify your cross compiler
in <filename>user-config.jam</filename> (see <xref linkend="bbv2.advanced.configuration"/>),
in <filename>user-config.jam</filename> (see <xref linkend="bbv2.overview.configuration"/>),
for example:</para>
<programlisting>
using gcc : arm : arm-none-linux-gnueabi-g++ ;

2
v2/doc/src/tutorial.xml
View File

@@ -285,7 +285,7 @@ top/
information</para>
</footnote>
More details can be found in
<xref linkend= "bbv2.advanced.projects"/>.
<xref linkend= "bbv2.overview.projects"/>.
</para>
<para>

2
v2/doc/src/userman.xml
View File

@@ -11,7 +11,7 @@
<xi:include href="howto.xml"/>
<xi:include href="install.xml"/>
<xi:include href="tutorial.xml"/>
<xi:include href="advanced.xml"/>
<xi:include href="overview.xml"/>
<xi:include href="tasks.xml"/>
<xi:include href="reference.xml"/>
<xi:include href="extending.xml"/>

14
v2/doc/src/v1_vs_v2.xml
View File

@@ -16,7 +16,7 @@
some of the syntax was changed, and some new important features were
added. This chapter describes most of the changes.</para>
<section id="bbv2.advanced.differences_to_v1.configuration">
<section id="bbv2.overview.differences_to_v1.configuration">
<title>Configuration</title>
<para>In V1, toolsets were configured by environment variables. If you
@@ -25,12 +25,12 @@
toolset. In V2, toolsets are configured by the
<functionname>using</functionname>, and you can easily configure several
versions of a toolset. See <xref
linkend="bbv2.advanced.configuration"/> for details.
linkend="bbv2.overview.configuration"/> for details.
</para>
</section>
<section id="bbv2.advanced.differences_to_v1.jamfiles">
<section id="bbv2.overview.differences_to_v1.jamfiles">
<title>Writing Jamfiles</title>
<para>Probably one of the most important differences in V2 Jamfiles is
@@ -38,7 +38,7 @@
requirements (for example, a common <code>#include</code> 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 <code>requirements</code> project
attribute, as documented in <xref linkend="bbv2.advanced.projects"/>.
attribute, as documented in <xref linkend="bbv2.overview.projects"/>.
</para>
<para><link linkend="bbv2.tutorial.libs">Usage requirements</link>
@@ -54,7 +54,7 @@
<para>The difference between <code>lib</code> and <code>dll</code> targets in V1 is completely
eliminated in V2. There's only one library target type, <code>lib</code>, which can create
either static or shared libraries depending on the value of the
<link linkend="bbv2.advanced.builtins.features.link"><varname>&lt;link&gt;</varname>
<link linkend="bbv2.overview.builtins.features.link"><varname>&lt;link&gt;</varname>
feature</link>. If your target should be only built in one way<!--"variant" has a different meaning here-->, you
can add <code>&lt;link&gt;shared</code> or <code>&lt;link&gt;static</code> to its requirements.
</para>
@@ -77,7 +77,7 @@ exe a : a.cpp ../foo//bar ;
</section>
<section id="bbv2.advanced.differences_to_v1.build_process">
<section id="bbv2.overview.differences_to_v1.build_process">
<title>Build process</title>
<para>The command line syntax in V2 is completely different. For example
@@ -92,7 +92,7 @@ bjam toolset=msvc variant=release some_target
<programlisting>
bjam msvc release some_target
</programlisting>
See <link linkend="bbv2.advanced.invocation">the reference</link> for a
See <link linkend="bbv2.overview.invocation">the reference</link> for a
complete description of the syntax.
</para>