mirror of
https://github.com/boostorg/build.git
synced 2026-02-15 13:02:11 +00:00
Merge Boost.Build from trunk.
[SVN r72443]
This commit is contained in:
@@ -15,13 +15,14 @@ if [ os.on-windows ]
|
||||
package.install boost-build-engine boost-build
|
||||
: # properties
|
||||
: # binaries
|
||||
bjam$(ext)
|
||||
b2$(ext) bjam$(ext)
|
||||
;
|
||||
|
||||
local e1 = [ path.glob-tree $(SELF)/example : * : . .svn ] ;
|
||||
local e2 ;
|
||||
for e in $(e1)
|
||||
{
|
||||
e = [ path.native $(e) ] ;
|
||||
if [ CHECK_IF_FILE $(e) ]
|
||||
{
|
||||
e2 += $(e) ;
|
||||
|
||||
@@ -6,20 +6,22 @@ REM Distributed under the Boost Software License, Version 1.0.
|
||||
REM (See accompanying file LICENSE_1_0.txt or http://www.boost.org/LICENSE_1_0.txt)
|
||||
|
||||
ECHO Bootstrapping the build engine
|
||||
if exist ".\engine\src\bin.ntx86\bjam.exe" del engine\src\bin.ntx86\bjam.exe
|
||||
if exist ".\engine\src\bin.ntx86_64\bjam.exe" del engine\src\bin.ntx86_64\bjam.exe
|
||||
cd engine\src
|
||||
if exist ".\engine\bin.ntx86\bjam.exe" del engine\bin.ntx86\bjam.exe
|
||||
if exist ".\engine\bin.ntx86_64\bjam.exe" del engine\bin.ntx86_64\bjam.exe
|
||||
cd engine
|
||||
|
||||
call .\build.bat %* > ..\..\bootstrap.log
|
||||
@ECHO OFF
|
||||
cd ..\..
|
||||
cd ..
|
||||
|
||||
if exist ".\engine\src\bin.ntx86\bjam.exe" (
|
||||
copy .\engine\src\bin.ntx86\bjam.exe . > nul
|
||||
if exist ".\engine\bin.ntx86\b2.exe" (
|
||||
copy .\engine\bin.ntx86\b2.exe . > nul
|
||||
copy .\engine\bin.ntx86\bjam.exe . > nul
|
||||
goto :bjam_built)
|
||||
|
||||
if exist ".\engine\src\bin.ntx86_64\bjam.exe" (
|
||||
copy .\engine\src\bin.ntx86_64\bjam.exe . > nul
|
||||
if exist ".\engine\bin.ntx86_64\b2.exe" (
|
||||
copy .\engine\bin.ntx86_64\b2.exe . > nul
|
||||
copy .\engine\bin.ntx86_64\bjam.exe . > nul
|
||||
goto :bjam_built)
|
||||
|
||||
goto :bjam_failure
|
||||
@@ -29,7 +31,7 @@ goto :bjam_failure
|
||||
ECHO.
|
||||
ECHO Bootstrapping is done. To build, run:
|
||||
ECHO.
|
||||
ECHO .\bjam --prefix=DIR install
|
||||
ECHO .\b2 --prefix=DIR install
|
||||
ECHO.
|
||||
|
||||
goto :end
|
||||
|
||||
@@ -55,7 +55,7 @@ my_dir="."
|
||||
|
||||
# Determine the toolset, if not already decided
|
||||
if test "x$TOOLSET" = x; then
|
||||
guessed_toolset=`$my_dir/engine/src/build.sh --guess-toolset`
|
||||
guessed_toolset=`$my_dir/engine/build.sh --guess-toolset`
|
||||
case $guessed_toolset in
|
||||
acc | darwin | gcc | como | mipspro | pathscale | pgi | qcc | vacpp )
|
||||
TOOLSET=$guessed_toolset
|
||||
@@ -96,7 +96,7 @@ rm -f config.log
|
||||
if test "x$BJAM" = x; then
|
||||
echo -n "Bootstrapping the build engine with toolset $TOOLSET... "
|
||||
pwd=`pwd`
|
||||
(cd "$my_dir/engine/src" && ./build.sh "$TOOLSET") > bootstrap.log 2>&1
|
||||
(cd "$my_dir/engine" && ./build.sh "$TOOLSET") > bootstrap.log 2>&1
|
||||
if [ $? -ne 0 ]; then
|
||||
echo
|
||||
echo "Failed to bootstrap the build engine"
|
||||
@@ -104,16 +104,17 @@ if test "x$BJAM" = x; then
|
||||
exit 1
|
||||
fi
|
||||
cd "$pwd"
|
||||
arch=`cd $my_dir/engine/src && ./bootstrap/jam0 -d0 -f build.jam --toolset=$TOOLSET --toolset-root= --show-locate-target && cd ..`
|
||||
BJAM="$my_dir/engine/src/$arch/bjam"
|
||||
echo "engine/src/$arch/bjam"
|
||||
arch=`cd $my_dir/engine && ./bootstrap/jam0 -d0 -f build.jam --toolset=$TOOLSET --toolset-root= --show-locate-target && cd ..`
|
||||
BJAM="$my_dir/engine/$arch/b2"
|
||||
echo "engine/$arch/bjam"
|
||||
cp "$BJAM" .
|
||||
cp "$my_dir/engine/$arch/bjam" .
|
||||
fi
|
||||
|
||||
cat << EOF
|
||||
|
||||
Bootstrapping is done. To build and install, run:
|
||||
|
||||
./bjam install --prefix=<DIR>
|
||||
./b2 install --prefix=<DIR>
|
||||
|
||||
EOF
|
||||
|
||||
@@ -543,14 +543,15 @@ local rule should-clean-project ( project )
|
||||
#
|
||||
################################################################################
|
||||
|
||||
{
|
||||
{
|
||||
if --version in $(.argv)
|
||||
{
|
||||
version.print ;
|
||||
EXIT ;
|
||||
}
|
||||
|
||||
|
||||
|
||||
version.verify-engine-version ;
|
||||
|
||||
load-configuration-files ;
|
||||
|
||||
local extra-properties ;
|
||||
@@ -771,7 +772,6 @@ local rule should-clean-project ( project )
|
||||
# Prepare valid XML header and footer with some basic info.
|
||||
local nl = "
|
||||
" ;
|
||||
local jam = [ version.jam ] ;
|
||||
local os = [ modules.peek : OS OSPLAT JAMUNAME ] "" ;
|
||||
local timestamp = [ modules.peek : JAMDATE ] ;
|
||||
local cwd = [ PWD ] ;
|
||||
@@ -780,7 +780,6 @@ local rule should-clean-project ( project )
|
||||
.header on $(xml-file) =
|
||||
"<?xml version=\"1.0\" encoding=\"utf-8\"?>"
|
||||
"$(nl)<build format=\"1.0\" version=\"$(bb-version)\">"
|
||||
"$(nl) <jam version=\"$(jam:J=.)\" />"
|
||||
"$(nl) <os name=\"$(os[1])\" platform=\"$(os[2])\"><![CDATA[$(os[3-]:J= )]]></os>"
|
||||
"$(nl) <timestamp><![CDATA[$(timestamp)]]></timestamp>"
|
||||
"$(nl) <directory><![CDATA[$(cwd)]]></directory>"
|
||||
|
||||
@@ -17,6 +17,8 @@ import sequence ;
|
||||
import property ;
|
||||
import property-set ;
|
||||
import "class" : new ;
|
||||
import common ;
|
||||
import path ;
|
||||
|
||||
rule log-summary ( )
|
||||
{
|
||||
@@ -185,12 +187,9 @@ rule builds ( metatarget-reference : properties * : what ? : retry ? )
|
||||
# should never be called by users.
|
||||
rule set-log-file ( log-file )
|
||||
{
|
||||
# FIXME: remove this check as soon as Boost regression tests
|
||||
# start using trunk bjam
|
||||
if FILE_OPEN in [ RULENAMES ]
|
||||
{
|
||||
.log-fd = [ FILE_OPEN $(log-file) : "w" ] ;
|
||||
}
|
||||
path.makedirs [ path.parent $(log-file) ] ;
|
||||
|
||||
.log-fd = [ FILE_OPEN $(log-file) : "w" ] ;
|
||||
}
|
||||
|
||||
# Frontend rules
|
||||
|
||||
@@ -433,7 +433,8 @@ rule initialize (
|
||||
|
||||
# Import rules common to all project modules from project-rules module,
|
||||
# defined at the end of this file.
|
||||
modules.clone-rules project-rules $(module-name) ;
|
||||
local rules = [ RULENAMES project-rules ] ;
|
||||
IMPORT project-rules : $(rules) : $(module-name) : $(rules) ;
|
||||
|
||||
local jamroot ;
|
||||
|
||||
@@ -881,15 +882,16 @@ module project-rules
|
||||
# expect the module to be found even though the directory is not in
|
||||
# BOOST_BUILD_PATH.
|
||||
local x = [ modules.peek : BOOST_BUILD_PATH ] ;
|
||||
local caller = [ modules.binding $(__name__) ] ;
|
||||
modules.poke : BOOST_BUILD_PATH : $(caller:D) $(x) ;
|
||||
local caller = [ CALLER_MODULE ] ;
|
||||
local caller-location = [ modules.binding $(caller) ] ;
|
||||
modules.poke : BOOST_BUILD_PATH : $(caller-location:D) $(x) ;
|
||||
toolset.using $(1) : $(2) : $(3) : $(4) : $(5) : $(6) : $(7) : $(8) : $(9) ;
|
||||
modules.poke : BOOST_BUILD_PATH : $(x) ;
|
||||
|
||||
# The above might have clobbered .current-project. Restore the correct
|
||||
# value.
|
||||
modules.poke project : .current-project
|
||||
: [ project.target $(__name__) ] ;
|
||||
: [ project.target $(caller) ] ;
|
||||
}
|
||||
|
||||
import modules ;
|
||||
@@ -913,7 +915,8 @@ module project-rules
|
||||
import path ;
|
||||
import project ;
|
||||
|
||||
local attributes = [ project.attributes $(__name__) ] ;
|
||||
local caller = [ CALLER_MODULE ] ;
|
||||
local attributes = [ project.attributes $(caller) ] ;
|
||||
if $(id)
|
||||
{
|
||||
$(attributes).set id : $(id) ;
|
||||
@@ -991,7 +994,8 @@ module project-rules
|
||||
)
|
||||
{
|
||||
import project ;
|
||||
local p = [ project.target $(__name__) ] ;
|
||||
local caller = [ CALLER_MODULE ] ;
|
||||
local p = [ project.target $(caller) ] ;
|
||||
$(p).add-constant $(name) : $(value) ;
|
||||
}
|
||||
|
||||
@@ -1005,20 +1009,26 @@ module project-rules
|
||||
)
|
||||
{
|
||||
import project ;
|
||||
local p = [ project.target $(__name__) ] ;
|
||||
local caller = [ CALLER_MODULE ] ;
|
||||
local p = [ project.target $(caller) ] ;
|
||||
$(p).add-constant $(name) : $(value) : path ;
|
||||
}
|
||||
|
||||
rule use-project ( id : where )
|
||||
{
|
||||
import modules ;
|
||||
# See comment in 'load' for explanation.
|
||||
.used-projects += $(id) $(where) ;
|
||||
local caller = [ CALLER_MODULE ] ;
|
||||
modules.poke $(caller) : .used-projects :
|
||||
[ modules.peek $(caller) : .used-projects ]
|
||||
$(id) $(where) ;
|
||||
}
|
||||
|
||||
rule build-project ( dir )
|
||||
{
|
||||
import project ;
|
||||
local attributes = [ project.attributes $(__name__) ] ;
|
||||
local caller = [ CALLER_MODULE ] ;
|
||||
local attributes = [ project.attributes $(caller) ] ;
|
||||
|
||||
local now = [ $(attributes).get projects-to-build ] ;
|
||||
$(attributes).set projects-to-build : $(now) $(dir) ;
|
||||
|
||||
@@ -6,26 +6,44 @@
|
||||
import errors ;
|
||||
import numbers ;
|
||||
|
||||
major = "2011" ;
|
||||
minor = "04" ;
|
||||
|
||||
rule boost-build ( )
|
||||
{
|
||||
return "V2 (Milestone 12)" ;
|
||||
return "$(major).$(minor)-svn" ;
|
||||
}
|
||||
|
||||
|
||||
rule jam ( )
|
||||
{
|
||||
local v = [ modules.peek : JAM_VERSION ] ;
|
||||
return $(v:J=.) ;
|
||||
}
|
||||
|
||||
|
||||
rule print ( )
|
||||
{
|
||||
ECHO "Boost.Build" [ boost-build ] ;
|
||||
ECHO "Boost.Jam" [ jam ] ;
|
||||
if [ verify-engine-version ]
|
||||
{
|
||||
ECHO "Boost.Build" [ boost-build ] ;
|
||||
}
|
||||
}
|
||||
|
||||
rule verify-engine-version ( )
|
||||
{
|
||||
local v = [ modules.peek : JAM_VERSION ] ;
|
||||
|
||||
if $(v[1]) != $(major) || $(v[2]) != $(minor)
|
||||
{
|
||||
local argv = [ modules.peek : ARGV ] ;
|
||||
local e = $(argv[1]) ;
|
||||
local l = [ modules.binding version ] ;
|
||||
l = $(l:D) ;
|
||||
l = $(l:D) ;
|
||||
ECHO "warning: mismatched versions of Boost.Build engine and core" ;
|
||||
ECHO "warning: Boost.Build engine ($(e)) is $(v:J=.)" ;
|
||||
ECHO "warning: Boost.Build core (at $(l)) is" [ boost-build ] ;
|
||||
}
|
||||
else
|
||||
{
|
||||
return true ;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
# Utility rule for testing whether all elements in a sequence are equal to 0.
|
||||
#
|
||||
|
||||
@@ -15,6 +15,7 @@ boostbook userman : src/standalone.xml
|
||||
<implicit-dependency>jam_docs
|
||||
<dependency>jam_docs
|
||||
<xsl:param>boost.root=../../../../..
|
||||
<xsl:param>boost.defaults=Boost
|
||||
;
|
||||
|
||||
xml jam_docs : bjam.qbk ;
|
||||
|
||||
@@ -22,7 +22,7 @@
|
||||
<listitem>
|
||||
<simpara>
|
||||
Run either <command>.\bootstrap.bat</command> (on Windows), or
|
||||
<command>./bootstrap.sh</command> (on other operating systmes).
|
||||
<command>./bootstrap.sh</command> (on other operating systems).
|
||||
</simpara>
|
||||
</listitem>
|
||||
|
||||
@@ -52,7 +52,7 @@
|
||||
<filename><replaceable>PREFIX</replaceable>/share/boost-build/examples/hello</filename>
|
||||
to a different directory, then change to that directory and run:
|
||||
<screen><filename><replaceable>PREFIX</replaceable>/bin/bjam</filename></screen>
|
||||
A simple executable should be build.
|
||||
A simple executable should be built.
|
||||
</para>
|
||||
|
||||
<!--
|
||||
|
||||
@@ -118,6 +118,14 @@ boost-build build-system ;
|
||||
file must be compiled with special properties.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><literal>preprocessed</literal></term>
|
||||
<indexterm><primary>preprocessed</primary></indexterm>
|
||||
|
||||
<listitem><para>Creates an preprocessed source file. The arguments follow the
|
||||
<link linkend="bbv2.main-target-rule-syntax">common syntax</link>.</para></listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><literal>glob</literal></term>
|
||||
|
||||
@@ -266,6 +274,7 @@ path-constant DATA : data/a.txt ;
|
||||
|
||||
<variablelist>
|
||||
<varlistentry><term><literal>variant</literal></term>
|
||||
<indexterm><primary>variant</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
<para>
|
||||
@@ -321,6 +330,7 @@ path-constant DATA : data/a.txt ;
|
||||
|
||||
<varlistentry id="bbv2.overview.builtins.features.link">
|
||||
<term><literal>link</literal></term>
|
||||
<indexterm><primary>link</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
|
||||
@@ -356,6 +366,7 @@ path-constant DATA : data/a.txt ;
|
||||
|
||||
<varlistentry>
|
||||
<term><literal>threading</literal></term>
|
||||
<indexterm><primary>threading</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
|
||||
@@ -373,7 +384,9 @@ path-constant DATA : data/a.txt ;
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry><term><literal>source</literal></term>
|
||||
<varlistentry>
|
||||
<term><literal>source</literal></term>
|
||||
<indexterm><primary>source</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
<simpara>
|
||||
@@ -388,7 +401,9 @@ path-constant DATA : data/a.txt ;
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry><term><literal>library</literal></term>
|
||||
<varlistentry>
|
||||
<term><literal>library</literal></term>
|
||||
<indexterm><primary>library</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
<simpara>
|
||||
@@ -404,6 +419,7 @@ path-constant DATA : data/a.txt ;
|
||||
|
||||
<varlistentry><term><anchor id="bbv2.builtin.features.dependency"/>
|
||||
<literal>dependency</literal></term>
|
||||
<indexterm><primary>dependency</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
<simpara>
|
||||
@@ -442,6 +458,7 @@ path-constant DATA : data/a.txt ;
|
||||
|
||||
<varlistentry><term><anchor id="bbv2.builtin.features.use"/>
|
||||
<literal>use</literal></term>
|
||||
<indexterm><primary>use</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
<simpara>
|
||||
@@ -460,8 +477,10 @@ path-constant DATA : data/a.txt ;
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry><term><anchor id="bbv2.reference.features.dll-path"/>
|
||||
<literal>dll-path</literal></term>
|
||||
<varlistentry>
|
||||
<term><anchor id="bbv2.reference.features.dll-path"/>
|
||||
<literal>dll-path</literal></term>
|
||||
<indexterm><primary>dll-path</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
<simpara>
|
||||
@@ -473,7 +492,9 @@ path-constant DATA : data/a.txt ;
|
||||
</simpara>
|
||||
</listitem></varlistentry>
|
||||
|
||||
<varlistentry><term><literal>hardcode-dll-paths</literal></term>
|
||||
<varlistentry>
|
||||
<term><literal>hardcode-dll-paths</literal></term>
|
||||
<indexterm><primary>hardcode-dll-paths</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
<simpara>
|
||||
@@ -514,6 +535,7 @@ path-constant DATA : data/a.txt ;
|
||||
|
||||
<varlistentry>
|
||||
<term><literal>include</literal></term>
|
||||
<indexterm><primary>include</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
<simpara>
|
||||
@@ -523,6 +545,21 @@ path-constant DATA : data/a.txt ;
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<term><literal>define</literal></term>
|
||||
<indexterm><primary>define</primary></indexterm>
|
||||
|
||||
<listitem>
|
||||
<simpara>
|
||||
Specifies an preprocessor symbol that should be defined on the command
|
||||
line. You may either specify just the symbol, which will be defined
|
||||
without any value, or both the symbol and the value, separated by
|
||||
equal sign.
|
||||
</simpara>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
|
||||
<varlistentry><term><literal>warnings</literal></term>
|
||||
<listitem>
|
||||
<simpara>
|
||||
@@ -864,6 +901,7 @@ 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 2010—10.0</para></listitem>
|
||||
<listitem><para>Visual Studio 2008—9.0</para></listitem>
|
||||
<listitem><para>Visual Studio 2005—8.0</para></listitem>
|
||||
<listitem><para>Visual Studio .NET 2003—7.1</para></listitem>
|
||||
@@ -1413,6 +1451,314 @@ using stlport : <optional><replaceable>version</replaceable></optional> : <repla
|
||||
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Documentation tools</title>
|
||||
|
||||
<para>Boost.Build support for the Boost documentation tools is
|
||||
documented below.
|
||||
</para>
|
||||
|
||||
<section id="bbv2.reference.tools.doc.xsltproc">
|
||||
<title>xsltproc</title>
|
||||
<indexterm><primary>xsltproc</primary></indexterm>
|
||||
|
||||
<para>To use xsltproc, you first need to configure it using the following syntax:</para>
|
||||
<programlisting>
|
||||
using xsltproc : <optional><replaceable>xsltproc</replaceable></optional> ;
|
||||
</programlisting>
|
||||
<para>
|
||||
Where <replaceable>xsltproc</replaceable> is the xsltproc executable.
|
||||
If <replaceable>xsltproc</replaceable> is not specified, and the
|
||||
variable XSLTPROC is set, the value of XSLTPROC will be used.
|
||||
Otherwise, xsltproc will be searched for in PATH.
|
||||
</para>
|
||||
|
||||
|
||||
&option_list_intro;
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>xsl:param</primary></indexterm>
|
||||
<term><literal>xsl:param</literal></term>
|
||||
<listitem>
|
||||
<para>Values should have the form
|
||||
<replaceable>name</replaceable>=<replaceable>value</replaceable></para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>xsl:path</primary></indexterm>
|
||||
<term><literal>xsl:path</literal></term>
|
||||
<listitem>
|
||||
<para>Sets an additional search path for xi:include elements.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>catalog</primary></indexterm>
|
||||
<term><literal>catalog</literal></term>
|
||||
<listitem>
|
||||
<para>A catalog file used to rewrite remote URL's to a local copy.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
<para>The xsltproc module provides the following rules. Note that
|
||||
these operate on jam targets and are intended to be used by another
|
||||
toolset, such as boostbook, rather than directly by users.
|
||||
</para>
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>xslt</primary></indexterm>
|
||||
<term><literal>xslt</literal></term>
|
||||
<listitem>
|
||||
<programlisting>
|
||||
rule xslt ( target : source stylesheet : properties * )
|
||||
</programlisting>
|
||||
<para>Runs xsltproc to create a single output file.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>xslt-dir</primary></indexterm>
|
||||
<term><literal>xslt-dir</literal></term>
|
||||
<listitem>
|
||||
<programlisting>
|
||||
rule xslt-dir ( target : source stylesheet : properties * : dirname )
|
||||
</programlisting>
|
||||
<para>Runs xsltproc to create multiple outputs in a directory.
|
||||
<literal>dirname</literal> is unused, but exists for
|
||||
historical reasons. The output directory is determined from the
|
||||
target.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="bbv2.reference.tools.doc.boostbook">
|
||||
<title>boostbook</title>
|
||||
<indexterm><primary>boostbook</primary><secondary>module</secondary></indexterm>
|
||||
|
||||
<para>To use boostbook, you first need to configure it using the following syntax:</para>
|
||||
<programlisting>
|
||||
using boostbook : <optional><replaceable>docbook-xsl-dir</replaceable></optional> : <optional><replaceable>docbook-dtd-dir</replaceable></optional> : <optional><replaceable>boostbook-dir</replaceable></optional> ;
|
||||
</programlisting>
|
||||
<para>
|
||||
<replaceable>docbook-xsl-dir</replaceable> is the DocBook XSL stylesheet
|
||||
directory. If not provided, we use DOCBOOK_XSL_DIR from the environment
|
||||
(if available) or look in standard locations. Otherwise, we let the
|
||||
XML processor load the stylesheets remotely.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<replaceable>docbook-dtd-dir</replaceable> is the DocBook DTD directory.
|
||||
If not provided, we use DOCBOOK_DTD_DIR From the environment (if
|
||||
available) or look in standard locations. Otherwise, we let the XML
|
||||
processor load the DTD remotely.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
<replaceable>boostbook-dir</replaceable> is the BoostBook directory
|
||||
with the DTD and XSL subdirs.
|
||||
</para>
|
||||
|
||||
<para>The boostbook module depends on xsltproc. For pdf or ps output,
|
||||
it also depends on fop.
|
||||
</para>
|
||||
|
||||
&option_list_intro;
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>format</primary></indexterm>
|
||||
<indexterm><primary>html</primary></indexterm>
|
||||
<indexterm><primary>xhtml</primary></indexterm>
|
||||
<indexterm><primary>htmlhelp</primary></indexterm>
|
||||
<indexterm><primary>onehtml</primary></indexterm>
|
||||
<indexterm><primary>man</primary></indexterm>
|
||||
<indexterm><primary>pdf</primary></indexterm>
|
||||
<indexterm><primary>ps</primary></indexterm>
|
||||
<indexterm><primary>docbook</primary></indexterm>
|
||||
<indexterm><primary>fo</primary></indexterm>
|
||||
<indexterm><primary>tests</primary></indexterm>
|
||||
<term><literal>format</literal></term>
|
||||
<listitem>
|
||||
<para>
|
||||
<emphasis role="bold">Allowed values:</emphasis>
|
||||
<literal>html</literal>, <literal>xhtml</literal>,
|
||||
<literal>htmlhelp</literal>, <literal>onehtml</literal>,
|
||||
<literal>man</literal>, <literal>pdf</literal>,
|
||||
<literal>ps</literal>, <literal>docbook</literal>,
|
||||
<literal>fo</literal>, <literal>tests</literal>.
|
||||
</para>
|
||||
|
||||
|
||||
<para>The <literal>format</literal> feature determines the type
|
||||
of output produced by the boostbook rule.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
<para>The boostbook module defines a rule for creating a target
|
||||
following the common syntax.</para>
|
||||
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>boostbook</primary><secondary>rule</secondary></indexterm>
|
||||
<term><literal>boostbook</literal></term>
|
||||
<listitem>
|
||||
<programlisting>
|
||||
rule boostbook ( target-name : sources * : requirements * : default-build * )
|
||||
</programlisting>
|
||||
<para>Creates a boostbook target.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="bbv2.reference.tools.doc.doxygen">
|
||||
<title>doxygen</title>
|
||||
<indexterm><primary>doxygen</primary></indexterm>
|
||||
|
||||
<para>To use doxygen, you first need to configure it using the following syntax:</para>
|
||||
<programlisting>
|
||||
using doxygen : <optional><replaceable>name</replaceable></optional> ;
|
||||
</programlisting>
|
||||
<para>
|
||||
<replaceable>name</replaceable> is the doxygen command.
|
||||
If it is not specified, it will be found in the PATH.
|
||||
</para>
|
||||
|
||||
<para>The doxygen module depends on the boostbook module when
|
||||
generating BoostBook XML.
|
||||
</para>
|
||||
|
||||
&option_list_intro;
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>doxygen:param</primary></indexterm>
|
||||
<term><literal>doxygen:param</literal></term>
|
||||
<listitem>
|
||||
<para>All the values of <literal>doxygen:param</literal>
|
||||
are added to the doxyfile.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>prefix</primary></indexterm>
|
||||
<term><literal>prefix</literal></term>
|
||||
<listitem>
|
||||
<para>Specifies the common prefix of all headers
|
||||
when generating BoostBook XML. Everything before
|
||||
this will be stripped off.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>reftitle</primary></indexterm>
|
||||
<term><literal>reftitle</literal></term>
|
||||
<listitem>
|
||||
<para>Specifies the title of the library-reference section,
|
||||
when generating BoostBook XML.</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>doxygen:xml-imagedir</primary></indexterm>
|
||||
<term><literal>doxygen:xml-imagedir</literal></term>
|
||||
<listitem>
|
||||
<para>When generating BoostBook XML, specifies the
|
||||
directory in which to place the images generated
|
||||
from LaTex formulae.</para>
|
||||
<warning><para>The path is interpreted relative to the
|
||||
current working directory, not relative to the Jamfile.
|
||||
This is necessary to match the behavior of BoostBook.
|
||||
</para></warning>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
<para>The doxygen module defines a rule for creating a target
|
||||
following the common syntax.</para>
|
||||
|
||||
<variablelist>
|
||||
|
||||
<varlistentry>
|
||||
<indexterm><primary>doxygen</primary><secondary>rule</secondary></indexterm>
|
||||
<term><literal>doxygen</literal></term>
|
||||
<listitem>
|
||||
<programlisting>
|
||||
rule doxygen ( target : sources * : requirements * : default-build * : usage-requirements * )
|
||||
</programlisting>
|
||||
<para>Creates a doxygen target. If the target name
|
||||
ends with .html, then this will generate an html
|
||||
directory. Otherwise it will generate BoostBook XML.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
|
||||
</variablelist>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="bbv2.reference.tools.doc.quickbook">
|
||||
<title>quickbook</title>
|
||||
<indexterm><primary>quickbook</primary></indexterm>
|
||||
|
||||
<para>The quickbook module provides a generator to convert from
|
||||
Quickbook to BoostBook XML.</para>
|
||||
|
||||
<para>To use quickbook, you first need to configure it using the following syntax:</para>
|
||||
<programlisting>
|
||||
using quickbook : <optional><replaceable>command</replaceable></optional> ;
|
||||
</programlisting>
|
||||
<para>
|
||||
<replaceable>command</replaceable> is the quickbook executable.
|
||||
If it is not specified, Boost.Build will compile it from source.
|
||||
If it is unable to find the source it will search for a quickbook
|
||||
executable in PATH.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="bbv2.reference.tools.doc.fop">
|
||||
<title>fop</title>
|
||||
<indexterm><primary>fop</primary></indexterm>
|
||||
|
||||
<para>The fop module provides generators to convert from
|
||||
XSL formatting objects to Postscript and PDF.</para>
|
||||
|
||||
<para>To use fop, you first need to configure it using the following syntax:</para>
|
||||
<programlisting>
|
||||
using fop : <optional><replaceable>fop-command</replaceable></optional> : <optional><replaceable>java-home</replaceable></optional> : <optional><replaceable>java</replaceable></optional> ;
|
||||
</programlisting>
|
||||
<para>
|
||||
<replaceable>fop-command</replaceable> is the command to run fop.
|
||||
If it is not specified, Boost.Build will search for it in PATH and
|
||||
FOP_HOME.
|
||||
</para>
|
||||
<para>
|
||||
Either <replaceable>java-home</replaceable> or
|
||||
<replaceable>java</replaceable>
|
||||
can be used to specify where to find java.
|
||||
</para>
|
||||
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
</section>
|
||||
|
||||
<section id="bbv2.reference.buildprocess">
|
||||
|
||||
@@ -118,7 +118,8 @@ rule boost-build ( dir ? )
|
||||
}
|
||||
|
||||
|
||||
if [ MATCH .*(bjam).* : $(ARGV[1]:BL) ]
|
||||
if [ MATCH .*(b2).* : $(ARGV[1]:BL) ]
|
||||
|| [ MATCH .*(bjam).* : $(ARGV[1]:BL) ]
|
||||
|| $(BOOST_ROOT) # A temporary measure so Jam works with Boost.Build v1.
|
||||
{
|
||||
# We attempt to load "boost-build.jam" by searching from the current
|
||||
|
Before Width: | Height: | Size: 766 B After Width: | Height: | Size: 766 B |
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user