boost/more
1
0
Fork 0
mirror of https://github.com/boostorg/more.git synced 2025-03-23 13:10:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix internal link to BBv2 docs so that it works even when browsing in the filesystem.

Browse Source 
Clarify the meaning of 'stage'.
Fix up table presentation.
Improve the wording of the windows version name caveat.


[SVN r37661]
This commit is contained in:
Dave Abrahams 2007-05-11 02:18:12 +00:00
parent 04b1ade274
commit 9f9413090a
7 changed files with 36 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
getting_started/detail/build-from-source-tail.rst
View File

@ -2,8 +2,9 @@
.. Software License, Version 1.0. (See accompanying
.. file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
Boost.Build will place the Boost binaries in the ``stage``\ |/|
subdirectory of your `build directory`_.
Building the special ``stage`` target places Boost
library binaries in the ``stage``\ |/| subdirectory of your `build
directory`_.
.. Note:: ``bjam`` is case-sensitive; it is important that all the
parts shown in **bold** type above be entirely lower-case.

8
getting_started/detail/common-windows.rst
View File

@ -24,10 +24,10 @@
**lib**\ |//| .....................\ *precompiled library binaries*
.. |windows-version-name-caveat| replace:: Unless you are using the
msvc or gcc toolsets (which have special version detection code)
**you must append a version number even if you only have one
version installed**, or `auto-linking`_ will fail.
.. |windows-version-name-caveat| replace:: **On Windows, append a version
number even if you only have one version installed** (unless you
are using the msvc or gcc toolsets, which have special version
detection code) or `auto-linking`_ will fail.
.. |command-line tool| replace:: `command-line tool`_

2
getting_started/detail/conclusion.rst
View File

@ -31,7 +31,7 @@ mailing list`_.
-- the Boost Developers
.. _Boost.Build reference manual: ../../tools/build/v2
.. _Boost.Build reference manual: ../../tools/build/v2/index.html
.. _Boost.Jam reference manual: `Boost.Jam`_
.. _Boost Users' mailing list: ../../more/mailing_lists.htm#users
.. _Boost.Build Wiki: http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost.Build_V2

19
getting_started/unix-variants.html
View File

@ -39,7 +39,7 @@
</li>
<li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id23">5&nbsp;&nbsp;&nbsp;Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
<li><a class="reference internal" href="#easy-build-and-install" id="id24">5.1&nbsp;&nbsp;&nbsp;Easy Build and Install</a></li>
<li><a class="reference internal" href="#or-custom-build-and-install" id="id25">5.2&nbsp;&nbsp;&nbsp;Or, Custom Build and Install</a><ul class="auto-toc">
<li><a class="reference internal" href="#or-build-custom-binaries" id="id25">5.2&nbsp;&nbsp;&nbsp;Or, Build Custom Binaries</a><ul class="auto-toc">
<li><a class="reference internal" href="#get-bjam" id="id26">5.2.1&nbsp;&nbsp;&nbsp;Get <tt class="docutils literal"><span class="pre">bjam</span></tt></a></li>
<li><a class="reference internal" href="#identify-your-toolset" id="id27">5.2.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></li>
<li><a class="reference internal" href="#select-a-build-directory" id="id28">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></li>
@ -284,8 +284,8 @@ prefix, so you can henceforth use that directory as an <tt class="docutils liter
path in place of the Boost root directory.</p>
<p><a class="reference internal" href="#link-your-program-to-a-boost-library"><em>skip to the next step</em></a></p>
</div>
<div class="section" id="or-custom-build-and-install">
<h2><a class="toc-backref" href="#id25">5.2&nbsp;&nbsp;&nbsp;Or, Custom Build and Install</a></h2>
<div class="section" id="or-build-custom-binaries">
<h2><a class="toc-backref" href="#id25">5.2&nbsp;&nbsp;&nbsp;Or, Build Custom Binaries</a></h2>
<p>If you're using a compiler other than your system's default, you'll
need to use <a class="reference external" href="../../tools/build/index.html">Boost.Build</a> to create binaries. You'll also
use this method if you need a nonstandard build variant (see the
@ -316,7 +316,7 @@ following table.</p>
<a class="reference external" href="../../doc/html/jam/building.html">building bjam</a>, you should assume it won't work and instead
choose newly from the table below.</p>
</div>
<table border="1" class="docutils">
<table border="1" class="docutils table">
<colgroup>
<col width="18%" />
<col width="33%" />
@ -426,13 +426,14 @@ bjam <strong>--build-dir=</strong><a class="reference internal" href="#id10"><em
<p>For example, your session might look like this:</p>
<pre class="literal-block">
$ cd ~/<tt class="docutils literal"><span class="pre">boost_1_34_0</span></tt>
$ bjam <strong>--build-dir=</strong>/tmp/build-boost <strong>--toolset=</strong>gcc
$ bjam <strong>--build-dir=</strong>/tmp/build-boost <strong>--toolset=</strong>gcc stage
</pre>
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
<p>Boost.Build will place the Boost binaries in the <tt class="docutils literal"><span class="pre">stage</span></tt><tt class="docutils literal"><span class="pre">/</span></tt>
subdirectory of your <a class="reference internal" href="#build-directory">build directory</a>.</p>
<p>Building the special <tt class="docutils literal"><span class="pre">stage</span></tt> target places Boost
library binaries in the <tt class="docutils literal"><span class="pre">stage</span></tt><tt class="docutils literal"><span class="pre">/</span></tt> subdirectory of your <a class="reference internal" href="#build-directory">build
directory</a>.</p>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last"><tt class="docutils literal"><span class="pre">bjam</span></tt> is case-sensitive; it is important that all the
@ -585,7 +586,7 @@ of <tt class="docutils literal"><span class="pre">-mt</span></tt>.</dd>
interoperability with other compiled code. For each such
feature, a single letter is added to the tag:</p>
<blockquote>
<table border="1" class="docutils">
<table border="1" class="docutils table">
<colgroup>
<col width="6%" />
<col width="94%" />
@ -697,7 +698,7 @@ If you can't find what you need, or there's anything we can do to
make this document clearer, please post it to the <a class="reference external" href="../../more/mailing_lists.htm#users">Boost Users'
mailing list</a>.</p>
<ul class="simple">
<li><a class="reference external" href="../../tools/build/v2">Boost.Build reference manual</a></li>
<li><a class="reference external" href="../../tools/build/v2/index.html">Boost.Build reference manual</a></li>
<li><a class="reference external" href="../../tools/jam/index.html">Boost.Jam reference manual</a></li>
<li><a class="reference external" href="../../more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
<li><a class="reference external" href="../../more/mailing_lists.htm#jamboost">Boost.Build mailing list</a></li>

6
getting_started/unix-variants.rst
View File

@ -125,8 +125,8 @@ path in place of the Boost root directory.
__ `Link Your Program to a Boost Library`_
Or, Custom Build and Install
----------------------------
Or, Build Custom Binaries
-------------------------
If you're using a compiler other than your system's default, you'll
need to use Boost.Build_ to create binaries. You'll also
@ -140,7 +140,7 @@ For example, your session might look like this:
.. parsed-literal::
$ cd ~/|boost_ver|
$ bjam **--build-dir=**\ /tmp/build-boost **--toolset=**\ gcc
$ bjam **--build-dir=**\ /tmp/build-boost **--toolset=**\ gcc stage
.. include:: detail/build-from-source-tail.rst

25
getting_started/windows.html
View File

@ -37,7 +37,7 @@ not supported—they may or may not work.</p>
</li>
<li><a class="reference internal" href="#prepare-to-use-a-boost-library-binary" id="id29">5&nbsp;&nbsp;&nbsp;Prepare to Use a Boost Library Binary</a><ul class="auto-toc">
<li><a class="reference internal" href="#install-visual-studio-2005-or-net-2003-binaries" id="id30">5.1&nbsp;&nbsp;&nbsp;Install Visual Studio (2005 or .NET 2003) Binaries</a></li>
<li><a class="reference internal" href="#or-build-and-install-binaries-from-source" id="id31">5.2&nbsp;&nbsp;&nbsp;Or, Build and Install Binaries From Source</a><ul class="auto-toc">
<li><a class="reference internal" href="#or-build-binaries-from-source" id="id31">5.2&nbsp;&nbsp;&nbsp;Or, Build Binaries From Source</a><ul class="auto-toc">
<li><a class="reference internal" href="#get-bjam" id="id32">5.2.1&nbsp;&nbsp;&nbsp;Get <tt class="docutils literal"><span class="pre">bjam</span></tt></a></li>
<li><a class="reference internal" href="#identify-your-toolset" id="id33">5.2.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></li>
<li><a class="reference internal" href="#select-a-build-directory" id="id34">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></li>
@ -348,8 +348,8 @@ step. Otherwise, please run the installer again and install them
now.</p>
<p><a class="reference internal" href="#link-your-program-to-a-boost-library"><em>skip to the next step</em></a></p>
</div>
<div class="section" id="or-build-and-install-binaries-from-source">
<h2><a class="toc-backref" href="#id31">5.2&nbsp;&nbsp;&nbsp;Or, Build and Install Binaries From Source</a></h2>
<div class="section" id="or-build-binaries-from-source">
<h2><a class="toc-backref" href="#id31">5.2&nbsp;&nbsp;&nbsp;Or, Build Binaries From Source</a></h2>
<p>If you're using an earlier version of Visual C++, or a compiler
from another vendor, you'll need to use <a class="reference external" href="../../tools/build/index.html">Boost.Build</a> to create your
own binaries.</p>
@ -379,7 +379,7 @@ following table.</p>
<a class="reference external" href="../../doc/html/jam/building.html">building bjam</a>, you should assume it won't work and instead
choose newly from the table below.</p>
</div>
<table border="1" class="docutils">
<table border="1" class="docutils table">
<colgroup>
<col width="18%" />
<col width="33%" />
@ -469,10 +469,10 @@ Boost.</td>
<p>If you have multiple versions of a particular compiler installed,
you can append the version number to the toolset name, preceded by
a hyphen, e.g. <tt class="docutils literal"><span class="pre">intel-9.0</span></tt> or
<tt class="docutils literal"><span class="pre">borland-5.4.3</span></tt>. Unless you are using the
msvc or gcc toolsets (which have special version detection code)
<strong>you must append a version number even if you only have one
version installed</strong>, or <a class="reference internal" href="#auto-linking">auto-linking</a> will fail.</p>
<tt class="docutils literal"><span class="pre">borland-5.4.3</span></tt>. <strong>On Windows, append a version
number even if you only have one version installed</strong> (unless you
are using the msvc or gcc toolsets, which have special version
detection code) or <a class="reference internal" href="#auto-linking">auto-linking</a> will fail.</p>
</div>
<div class="section" id="select-a-build-directory">
<span id="id12"></span><span id="build-directory"></span><h3><a class="toc-backref" href="#id34">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></h3>
@ -499,8 +499,9 @@ More? <strong>--toolset=</strong>msvc stage
<!-- Copyright David Abrahams 2006. Distributed under the Boost -->
<!-- Software License, Version 1.0. (See accompanying -->
<!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
<p>Boost.Build will place the Boost binaries in the <tt class="docutils literal"><span class="pre">stage</span></tt><tt class="docutils literal"><span class="pre">\</span></tt>
subdirectory of your <a class="reference internal" href="#build-directory">build directory</a>.</p>
<p>Building the special <tt class="docutils literal"><span class="pre">stage</span></tt> target places Boost
library binaries in the <tt class="docutils literal"><span class="pre">stage</span></tt><tt class="docutils literal"><span class="pre">\</span></tt> subdirectory of your <a class="reference internal" href="#build-directory">build
directory</a>.</p>
<div class="note">
<p class="first admonition-title">Note</p>
<p class="last"><tt class="docutils literal"><span class="pre">bjam</span></tt> is case-sensitive; it is important that all the
@ -669,7 +670,7 @@ of <tt class="docutils literal"><span class="pre">-mt</span></tt>.</dd>
interoperability with other compiled code. For each such
feature, a single letter is added to the tag:</p>
<blockquote>
<table border="1" class="docutils">
<table border="1" class="docutils table">
<colgroup>
<col width="6%" />
<col width="94%" />
@ -763,7 +764,7 @@ If you can't find what you need, or there's anything we can do to
make this document clearer, please post it to the <a class="reference external" href="../../more/mailing_lists.htm#users">Boost Users'
mailing list</a>.</p>
<ul class="simple">
<li><a class="reference external" href="../../tools/build/v2">Boost.Build reference manual</a></li>
<li><a class="reference external" href="../../tools/build/v2/index.html">Boost.Build reference manual</a></li>
<li><a class="reference external" href="../../tools/jam/index.html">Boost.Jam reference manual</a></li>
<li><a class="reference external" href="../../more/mailing_lists.htm#users">Boost Users' mailing list</a></li>
<li><a class="reference external" href="../../more/mailing_lists.htm#jamboost">Boost.Build mailing list</a></li>

4
getting_started/windows.rst
View File

@ -186,8 +186,8 @@ now.
__ `Link Your Program to a Boost Library`_
Or, Build and Install Binaries From Source
------------------------------------------
Or, Build Binaries From Source
------------------------------
If you're using an earlier version of Visual C++, or a compiler
from another vendor, you'll need to use Boost.Build_ to create your