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

Add more documentation.

Browse Source 
[SVN r18297]
This commit is contained in:
Vladimir Prus
2003-04-24 09:48:33 +00:00
parent e540ddb202
commit 2af4fe66b6
10 changed files with 458 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
boost_build_v2.html
View File

@@ -31,21 +31,12 @@
<body>
<p><a href="../../index.htm"><img class="banner" height="86" width="277"
alt="C++ Boost" src="../../c++boost.gif"></a></p>
alt="C++ Boost" src="c++boost.gif"></a></p>
<h1>Boost.Build v2 user manual<br class="clear">
</h1>
<hr>
<div class="alert">
This preliminary reference is intended to document everything currently
implemeneted, but is not yet ready for any practical use.
</div>
<br>
<br>
<hr>
<dl class="page-index">
<dt><a href="#sec-tutorial">Tutorial</a></dt>

BIN
c++boost.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.6 KiB

58
doc/development_plan.html Normal file
View File

@@ -0,0 +1,58 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1st March 2002), see www.w3.org">
<meta name="generator" content="Microsoft FrontPage 5.0">
<meta http-equiv="Content-Type" content=
"text/html; charset=windows-1252">
<!-- tidy options: &dash;&dash;tidy-mark false -i -wrap 78 !-->
<title>Boost Build System V2</title>
</head>
<body bgcolor="#FFFFFF" text="#000000">
<img src="../c++boost.gif" alt="c++boost.gif (8819 bytes)" align="center"
width="277" height="86">
<h1>Boost Build Development Plan</h1>
<ul>
<li>
<b>Milestone 2</b> (October 25, 2002)
<p>Boost buildable with gcc and also usable as part of another
project.</p></li>
<li><b>Milestone 3</b> (April 24, 2003) <p>Two gcc versions and two
other compilers are supported. Some other tools (e.g. lex and BoostBook)
are implemented.</li>
<li><b>Milestone 4</b> (TBD) <p>Complete testing framework for Boost.
</li>
<li><b>Alpha</b> (TBD) <p>Optimization. Using buildable tools:
consider using bison, which is itself build with Boost.Build.</li>
<li><b>Beta</b> (TBD) <p>Feature-complete milestone.</li>
<li><b>2.0 Release</b> (TBD) <p>Bugfixes</li>
</ul>
<hr>
<p>&copy; Copyright Vladimir Prus 2002-2003. Permission to
copy, use, modify, sell and distribute this document is granted provided
this copyright notice appears in all copies. This document is provided
"as is" without express or implied warranty, and with no claim as to its
suitability for any purpose.</p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan
-->26 Apr, 2003
<!--webbot bot="Timestamp" endspan i-checksum="13972"
-->
</p>
</body>
</html>

64
doc/tools.html Normal file
View File

@@ -0,0 +1,64 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1st March 2002), see www.w3.org">
<meta name="generator" content="Microsoft FrontPage 5.0">
<meta http-equiv="Content-Type" content=
"text/html; charset=windows-1252">
<!-- tidy options: &dash;&dash;tidy-mark false -i -wrap 78 !-->
<title>Boost Build System V2 &mdash; supported tools</title>
</head>
<body bgcolor="#FFFFFF" text="#000000">
<img src="c++boost.gif" alt="c++boost.gif (8819 bytes)" align="center"
width="277" height="86">
<h1>Boost Build System V2 &mdash; supported tools</h1>
<h2>Compilers</h2>
<p>The following compilers pass Boost.Build tests:
<ul>
<li>gcc (various versions), on Linux, NT, and Cygwin.
<li>msvc (various version), on NT and Cygwin.
<li>borland, on NT and Cygwin.
</ul>
<h2>Libraries</h2>
<p>Some important libraries have special support in Boost.Build:
<ul>
<li>STLPort &mdash; on gcc.
<li>QT, including the <tt>moc</tt> and <tt>uic</tt> tools &mdash; on gcc.
</ul>
<h2>Other tools</h2>
<ul>
<li>Parser/lexer generators <tt>bison</tt> and <tt>lex</tt>.
<li>XSLT processor <tt>xsltproc</tt>.
<li>The Apache FOP tool.
<li>BoostBook documentation format.
</ul>
<hr>
<p>&copy; Copyright Vladimir Prus 2003. Permission to
copy, use, modify, sell and distribute this document is granted provided
this copyright notice appears in all copies. This document is provided
"as is" without express or implied warranty, and with no claim as to its
suitability for any purpose.</p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan
-->26 Apr, 2003
<!--webbot bot="Timestamp" endspan i-checksum="13972"
-->
</p>
</body>
</html>

106
index_v2.html Normal file
View File

@@ -0,0 +1,106 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1st March 2002), see www.w3.org">
<meta name="generator" content="Microsoft FrontPage 5.0">
<meta http-equiv="Content-Type" content=
"text/html; charset=windows-1252">
<!-- tidy options: &dash;&dash;tidy-mark false -i -wrap 78 !-->
<title>Boost Build System V2</title>
</head>
<body bgcolor="#FFFFFF" text="#000000">
<img src="c++boost.gif" alt="c++boost.gif (8819 bytes)" align="center"
width="277" height="86">
<h1>Boost Build System V2</h1>
<h2><a name="synopsis">Synopsis</a></h2>
<p>Boost.Build is a system for large project software construction, which
is simple to use and powerfull. Boost.Build V2 is an onging project to
rewrite Boost.Build, improving design and making it more extensible. The
distinguishing features are:</p>
<ul>
<li><b>Simple and high level target description language</b>. In most cases
name of target and list of sources is enough.
</li>
<li><b>Variant builds</b>. You can build with your choice of basic variants
(e.g. debug, release, profile...), toolsets (e.g. gcc and msvc) and
specific properties (e.g. inlining off) from a
single command invocation.</li>
<li><b>Portability</b>. ``Feature Normalization'' allows to fine-tune targets
independently from the toolset used, and modular toolset descriptions
are employed to generate actual build instructions.
</li>
<li><b>Multi-project builds</b>. Several projects can be combined and
built together, with dependencies correctly tracked. Typically, the
setting (like include paths and defines) needed to use other project will
be handled automatically.
<li><b>Extensibility</b>. New file types and tools can be easily added</li>
</ul>
<h2>Documentation</h2>
<p>The user manual, which includes installation instructions, tuturial and
initial reference is available <a href="boost_build_v2.html">here</a>.
<h2><a name="status">Status</a></h2>
<p>
Enough of the core functionality is implemented to allow practical use on
medium-size projects. Several compilers and tools are supported, the
full list is available <a href="doc/tools.html">here</a>.
<!--
<p>
Of course, there are some issues you might run into, which are described
<a href="doc/issues.html">here</a>. --> The list of features still to be implemented
is outlined in the <a href="doc/development_plan.html">develepment
plan</a>.
<h2 id="download">Dowloading</h2>
<p>The most up-to-date sources are available in <tt>tools/build</tt> directory
of Boost CVS. Please use &quot;Boost CVS Repository&quot; section in the
<a href="http://www.boost.org/more/download.html">download instructions</a>.
<p>Boost.Build releases are also available from
<a href="???">SourceForce download page</a>.
<p>The installation is described in <a href="boost_build_v2.html">user manual</a>.
<h2>Feedback</h2>
<p>Should you have any questions or comments, we'd be glad to hear them.
Post everything to the <a
href="http://groups.yahoo.com/group/jamboost">jamboost</a> mailing list.
<p>If you'd like to help with development, there's a separate
<a href="hacking.txt">guidelines document</a>.
<hr>
<p>&copy; Copyright David Abrahams and Vladimir Prus 2002. Permission to
copy, use, modify, sell and distribute this document is granted provided
this copyright notice appears in all copies. This document is provided
"as is" without express or implied warranty, and with no claim as to its
suitability for any purpose.</p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan
-->10 Oct, 2002
<!--webbot bot="Timestamp" endspan i-checksum="13972"
-->
</p>
</body>
</html>

11
v2/boost_build_v2.html
View File

@@ -31,21 +31,12 @@
<body>
<p><a href="../../index.htm"><img class="banner" height="86" width="277"
alt="C++ Boost" src="../../c++boost.gif"></a></p>
alt="C++ Boost" src="c++boost.gif"></a></p>
<h1>Boost.Build v2 user manual<br class="clear">
</h1>
<hr>
<div class="alert">
This preliminary reference is intended to document everything currently
implemeneted, but is not yet ready for any practical use.
</div>
<br>
<br>
<hr>
<dl class="page-index">
<dt><a href="#sec-tutorial">Tutorial</a></dt>

BIN
v2/c++boost.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.6 KiB

58
v2/doc/development_plan.html Normal file
View File

@@ -0,0 +1,58 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1st March 2002), see www.w3.org">
<meta name="generator" content="Microsoft FrontPage 5.0">
<meta http-equiv="Content-Type" content=
"text/html; charset=windows-1252">
<!-- tidy options: &dash;&dash;tidy-mark false -i -wrap 78 !-->
<title>Boost Build System V2</title>
</head>
<body bgcolor="#FFFFFF" text="#000000">
<img src="../c++boost.gif" alt="c++boost.gif (8819 bytes)" align="center"
width="277" height="86">
<h1>Boost Build Development Plan</h1>
<ul>
<li>
<b>Milestone 2</b> (October 25, 2002)
<p>Boost buildable with gcc and also usable as part of another
project.</p></li>
<li><b>Milestone 3</b> (April 24, 2003) <p>Two gcc versions and two
other compilers are supported. Some other tools (e.g. lex and BoostBook)
are implemented.</li>
<li><b>Milestone 4</b> (TBD) <p>Complete testing framework for Boost.
</li>
<li><b>Alpha</b> (TBD) <p>Optimization. Using buildable tools:
consider using bison, which is itself build with Boost.Build.</li>
<li><b>Beta</b> (TBD) <p>Feature-complete milestone.</li>
<li><b>2.0 Release</b> (TBD) <p>Bugfixes</li>
</ul>
<hr>
<p>&copy; Copyright Vladimir Prus 2002-2003. Permission to
copy, use, modify, sell and distribute this document is granted provided
this copyright notice appears in all copies. This document is provided
"as is" without express or implied warranty, and with no claim as to its
suitability for any purpose.</p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan
-->26 Apr, 2003
<!--webbot bot="Timestamp" endspan i-checksum="13972"
-->
</p>
</body>
</html>

64
v2/doc/tools.html Normal file
View File

@@ -0,0 +1,64 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1st March 2002), see www.w3.org">
<meta name="generator" content="Microsoft FrontPage 5.0">
<meta http-equiv="Content-Type" content=
"text/html; charset=windows-1252">
<!-- tidy options: &dash;&dash;tidy-mark false -i -wrap 78 !-->
<title>Boost Build System V2 &mdash; supported tools</title>
</head>
<body bgcolor="#FFFFFF" text="#000000">
<img src="c++boost.gif" alt="c++boost.gif (8819 bytes)" align="center"
width="277" height="86">
<h1>Boost Build System V2 &mdash; supported tools</h1>
<h2>Compilers</h2>
<p>The following compilers pass Boost.Build tests:
<ul>
<li>gcc (various versions), on Linux, NT, and Cygwin.
<li>msvc (various version), on NT and Cygwin.
<li>borland, on NT and Cygwin.
</ul>
<h2>Libraries</h2>
<p>Some important libraries have special support in Boost.Build:
<ul>
<li>STLPort &mdash; on gcc.
<li>QT, including the <tt>moc</tt> and <tt>uic</tt> tools &mdash; on gcc.
</ul>
<h2>Other tools</h2>
<ul>
<li>Parser/lexer generators <tt>bison</tt> and <tt>lex</tt>.
<li>XSLT processor <tt>xsltproc</tt>.
<li>The Apache FOP tool.
<li>BoostBook documentation format.
</ul>
<hr>
<p>&copy; Copyright Vladimir Prus 2003. Permission to
copy, use, modify, sell and distribute this document is granted provided
this copyright notice appears in all copies. This document is provided
"as is" without express or implied warranty, and with no claim as to its
suitability for any purpose.</p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan
-->26 Apr, 2003
<!--webbot bot="Timestamp" endspan i-checksum="13972"
-->
</p>
</body>
</html>

106
v2/index_v2.html Normal file
View File

@@ -0,0 +1,106 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content=
"HTML Tidy for Linux/x86 (vers 1st March 2002), see www.w3.org">
<meta name="generator" content="Microsoft FrontPage 5.0">
<meta http-equiv="Content-Type" content=
"text/html; charset=windows-1252">
<!-- tidy options: &dash;&dash;tidy-mark false -i -wrap 78 !-->
<title>Boost Build System V2</title>
</head>
<body bgcolor="#FFFFFF" text="#000000">
<img src="c++boost.gif" alt="c++boost.gif (8819 bytes)" align="center"
width="277" height="86">
<h1>Boost Build System V2</h1>
<h2><a name="synopsis">Synopsis</a></h2>
<p>Boost.Build is a system for large project software construction, which
is simple to use and powerfull. Boost.Build V2 is an onging project to
rewrite Boost.Build, improving design and making it more extensible. The
distinguishing features are:</p>
<ul>
<li><b>Simple and high level target description language</b>. In most cases
name of target and list of sources is enough.
</li>
<li><b>Variant builds</b>. You can build with your choice of basic variants
(e.g. debug, release, profile...), toolsets (e.g. gcc and msvc) and
specific properties (e.g. inlining off) from a
single command invocation.</li>
<li><b>Portability</b>. ``Feature Normalization'' allows to fine-tune targets
independently from the toolset used, and modular toolset descriptions
are employed to generate actual build instructions.
</li>
<li><b>Multi-project builds</b>. Several projects can be combined and
built together, with dependencies correctly tracked. Typically, the
setting (like include paths and defines) needed to use other project will
be handled automatically.
<li><b>Extensibility</b>. New file types and tools can be easily added</li>
</ul>
<h2>Documentation</h2>
<p>The user manual, which includes installation instructions, tuturial and
initial reference is available <a href="boost_build_v2.html">here</a>.
<h2><a name="status">Status</a></h2>
<p>
Enough of the core functionality is implemented to allow practical use on
medium-size projects. Several compilers and tools are supported, the
full list is available <a href="doc/tools.html">here</a>.
<!--
<p>
Of course, there are some issues you might run into, which are described
<a href="doc/issues.html">here</a>. --> The list of features still to be implemented
is outlined in the <a href="doc/development_plan.html">develepment
plan</a>.
<h2 id="download">Dowloading</h2>
<p>The most up-to-date sources are available in <tt>tools/build</tt> directory
of Boost CVS. Please use &quot;Boost CVS Repository&quot; section in the
<a href="http://www.boost.org/more/download.html">download instructions</a>.
<p>Boost.Build releases are also available from
<a href="???">SourceForce download page</a>.
<p>The installation is described in <a href="boost_build_v2.html">user manual</a>.
<h2>Feedback</h2>
<p>Should you have any questions or comments, we'd be glad to hear them.
Post everything to the <a
href="http://groups.yahoo.com/group/jamboost">jamboost</a> mailing list.
<p>If you'd like to help with development, there's a separate
<a href="hacking.txt">guidelines document</a>.
<hr>
<p>&copy; Copyright David Abrahams and Vladimir Prus 2002. Permission to
copy, use, modify, sell and distribute this document is granted provided
this copyright notice appears in all copies. This document is provided
"as is" without express or implied warranty, and with no claim as to its
suitability for any purpose.</p>
<p>Revised
<!--webbot bot="Timestamp" s-type="EDITED" s-format="%d %B, %Y" startspan
-->10 Oct, 2002
<!--webbot bot="Timestamp" endspan i-checksum="13972"
-->
</p>
</body>
</html>