Merge Boost.Build branding changes:

https://svn.boost.org/trac/boost/changeset/72773 https://svn.boost.org/trac/boost/changeset/72793 Authorized by Beman. [SVN r72866]
2025-01-13 02:10:08 +08:00 · 2011-07-03 08:08:57 +00:00 · 2011-07-03 08:08:57 +00:00 · b5a8d6ee46
commit b5a8d6ee46
parent 70181f9350
7 changed files with 47 additions and 47 deletions
--- a/getting_started/detail/build-from-source-head.rst
+++ b/getting_started/detail/build-from-source-head.rst
@ -11,7 +11,7 @@ install it. To do this:

 1. Go to the directory ``tools``\ |/|\ ``build``\ |/|\ ``v2``\ |/|.
 2. Run ``bootstrap.bat``
-3. Run ``bjam install --prefix=``\ *PREFIX* where *PREFIX* is
+3. Run ``b2 install --prefix=``\ *PREFIX* where *PREFIX* is
   the directory where you want Boost.Build to be installed
 4. Add *PREFIX*\ |/|\ ``bin`` to your PATH environment variable.

@ -31,10 +31,10 @@ Boost.Build documentation`__).
 __ http://www.boost.org/boost-build2/doc/html/bbv2/reference/tools.html

 .. Note:: If you previously chose a toolset for the purposes of
-  `building bjam`_, you should assume it won't work and instead
+  `building b2`_, you should assume it won't work and instead
  choose newly from the table below.

-.. _building bjam: ../../doc/html/bbv2/installation.html
+.. _building b2: ../../doc/html/bbv2/installation.html

 +-----------+--------------------+-----------------------------+
 |Toolset    |Vendor              |Notes                        |
@ -102,18 +102,18 @@ directory is writable, this step isn't strictly necessary: by
 default Boost.Build will create a ``bin.v2/`` subdirectory for that
 purpose in your current working directory.

-Invoke ``bjam``
+Invoke ``b2``
 ...............

 .. |build-directory| replace:: *build-directory*
 .. |toolset-name| replace:: *toolset-name*

 Change your current directory to the Boost root directory and
-invoke ``bjam`` as follows:
+invoke ``b2`` as follows:

 .. parsed-literal::

-  bjam **--build-dir=**\ |build-directory|_ **toolset=**\ |toolset-name|_ |build-type-complete| stage
+  b2 **--build-dir=**\ |build-directory|_ **toolset=**\ |toolset-name|_ |build-type-complete| stage

 For a complete description of these and other invocation options,
 please see the `Boost.Build documentation`__.
--- a/getting_started/detail/build-from-source-tail.rst
+++ b/getting_started/detail/build-from-source-tail.rst
@ -5,15 +5,15 @@
 Building the special ``stage`` target places Boost
 library binaries in the ``stage``\ |/|\ ``lib``\ |/| subdirectory of
 the Boost tree.  To use a different directory pass the
-``--stagedir=``\ *directory* option to ``bjam``.
+``--stagedir=``\ *directory* option to ``b2``.

-.. Note:: ``bjam`` is case-sensitive; it is important that all the
+.. Note:: ``b2`` is case-sensitive; it is important that all the
   parts shown in **bold** type above be entirely lower-case.

 For a description of other options you can pass when invoking
-``bjam``, type::
+``b2``, type::

-  bjam --help
+  b2 --help

 In particular, to limit the amount of time spent building, you may
 be interested in:
--- a/getting_started/detail/distro.rst
+++ b/getting_started/detail/distro.rst
@ -20,7 +20,7 @@ This is a sketch of the resulting directory structure:
      **array**\ |//|
                      *…more libraries…*
    **status**\ |//| .........................\ *Boost-wide test suite*
-    **tools**\ |//| ...........\ *Utilities, e.g. bjam, quickbook, bcp*
+    **tools**\ |//| ...........\ *Utilities, e.g. Boost.Build, quickbook, bcp*
    **more**\ |//| ..........................\ *Policy documents, etc.*
    **doc**\ |//| ...............\ *A subset of all Boost library docs*

--- a/getting_started/unix-variants.html
+++ b/getting_started/unix-variants.html
@ -43,7 +43,7 @@
 <li><a class="reference internal" href="#install-boost-build" id="id27">5.2.1&nbsp;&nbsp;&nbsp;Install Boost.Build</a></li>
 <li><a class="reference internal" href="#identify-your-toolset" id="id28">5.2.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></li>
 <li><a class="reference internal" href="#select-a-build-directory" id="id29">5.2.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></li>
-<li><a class="reference internal" href="#invoke-bjam" id="id30">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">bjam</tt></a></li>
+<li><a class="reference internal" href="#invoke-b2" id="id30">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">b2</tt></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#expected-build-output" id="id31">5.3&nbsp;&nbsp;&nbsp;Expected Build Output</a></li>
@ -102,7 +102,7 @@ from <a class="reference external" href="http://www.boost.org/users/history/vers
     <strong>array</strong><strong>/</strong>
                     <em>…more libraries…</em>
   <strong>status</strong><strong>/</strong> .........................<em>Boost-wide test suite</em>
-   <strong>tools</strong><strong>/</strong> ...........<em>Utilities, e.g. bjam, quickbook, bcp</em>
+   <strong>tools</strong><strong>/</strong> ...........<em>Utilities, e.g. Boost.Build, quickbook, bcp</em>
   <strong>more</strong><strong>/</strong> ..........................<em>Policy documents, etc.</em>
   <strong>doc</strong><strong>/</strong> ...............<em>A subset of all Boost library docs</em>
 </pre>
@ -282,7 +282,7 @@ least use</p>
 <tt class="docutils literal"><span class="pre">--show-libraries</span></tt> and <tt class="docutils literal"><span class="pre">--with-libraries=</span></tt><em>library-name-list</em> options to limit the
 long wait you'll experience if you build everything.  Finally,</p>
 <pre class="literal-block">
-<strong>$</strong> ./bjam install
+<strong>$</strong> ./b2 install
 </pre>
 <p>will leave Boost binaries in the <tt class="docutils literal">lib/</tt> subdirectory of your
 installation prefix.  You will also find a copy of the Boost
@ -314,7 +314,7 @@ install it. To do this:</p>
 <ol class="arabic simple">
 <li>Go to the directory <tt class="docutils literal">tools</tt><tt class="docutils literal">/</tt><tt class="docutils literal">build</tt><tt class="docutils literal">/</tt><tt class="docutils literal">v2</tt><tt class="docutils literal">/</tt>.</li>
 <li>Run <tt class="docutils literal">bootstrap.bat</tt></li>
-<li>Run <tt class="docutils literal">bjam install <span class="pre">--prefix=</span></tt><em>PREFIX</em> where <em>PREFIX</em> is
+<li>Run <tt class="docutils literal">b2 install <span class="pre">--prefix=</span></tt><em>PREFIX</em> where <em>PREFIX</em> is
 the directory where you want Boost.Build to be installed</li>
 <li>Add <em>PREFIX</em><tt class="docutils literal">/</tt><tt class="docutils literal">bin</tt> to your PATH environment variable.</li>
 </ol>
@ -327,7 +327,7 @@ Boost.Build documentation</a>).</p>
 <div class="note">
 <p class="first admonition-title">Note</p>
 <p class="last">If you previously chose a toolset for the purposes of
-<a class="reference external" href="../../doc/html/bbv2/installation.html">building bjam</a>, you should assume it won't work and instead
+<a class="reference external" href="../../doc/html/bbv2/installation.html">building b2</a>, you should assume it won't work and instead
 choose newly from the table below.</p>
 </div>
 <table border="1" class="docutils">
@ -426,19 +426,19 @@ directory is writable, this step isn't strictly necessary: by
 default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subdirectory for that
 purpose in your current working directory.</p>
 </div>
-<div class="section" id="invoke-bjam">
-<h3><a class="toc-backref" href="#id30">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">bjam</tt></a></h3>
+<div class="section" id="invoke-b2">
+<h3><a class="toc-backref" href="#id30">5.2.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">b2</tt></a></h3>
 <p>Change your current directory to the Boost root directory and
-invoke <tt class="docutils literal">bjam</tt> as follows:</p>
+invoke <tt class="docutils literal">b2</tt> as follows:</p>
 <pre class="literal-block">
-bjam <strong>--build-dir=</strong><a class="reference internal" href="#id10"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <tt class="docutils literal"> </tt> stage
+b2 <strong>--build-dir=</strong><a class="reference internal" href="#id10"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <tt class="docutils literal"> </tt> stage
 </pre>
 <p>For a complete description of these and other invocation options,
 please see the <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html">Boost.Build documentation</a>.</p>
 <p>For example, your session might look like this:</p>
 <pre class="literal-block">
 $ cd ~/<tt class="docutils literal">boost_1_47_0</tt>
-$ bjam <strong>--build-dir=</strong>/tmp/build-boost <strong>toolset=</strong>gcc stage
+$ b2 <strong>--build-dir=</strong>/tmp/build-boost <strong>toolset=</strong>gcc stage
 </pre>
 <p>That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “<tt class="docutils literal"><span class="pre">--build-type=complete</span></tt>”.</p>
 <!-- Copyright David Abrahams 2006. Distributed under the Boost -->
@ -447,16 +447,16 @@ $ bjam <strong>--build-dir=</strong>/tmp/build-boost <strong>toolset=</strong>gc
 <p>Building the special <tt class="docutils literal">stage</tt> target places Boost
 library binaries in the <tt class="docutils literal">stage</tt><tt class="docutils literal">/</tt><tt class="docutils literal">lib</tt><tt class="docutils literal">/</tt> subdirectory of
 the Boost tree.  To use a different directory pass the
-<tt class="docutils literal"><span class="pre">--stagedir=</span></tt><em>directory</em> option to <tt class="docutils literal">bjam</tt>.</p>
+<tt class="docutils literal"><span class="pre">--stagedir=</span></tt><em>directory</em> option to <tt class="docutils literal">b2</tt>.</p>
 <div class="note">
 <p class="first admonition-title">Note</p>
-<p class="last"><tt class="docutils literal">bjam</tt> is case-sensitive; it is important that all the
+<p class="last"><tt class="docutils literal">b2</tt> is case-sensitive; it is important that all the
 parts shown in <strong>bold</strong> type above be entirely lower-case.</p>
 </div>
 <p>For a description of other options you can pass when invoking
-<tt class="docutils literal">bjam</tt>, type:</p>
+<tt class="docutils literal">b2</tt>, type:</p>
 <pre class="literal-block">
-bjam --help
+b2 --help
 </pre>
 <p>In particular, to limit the amount of time spent building, you may
 be interested in:</p>
--- a/getting_started/unix-variants.rst
+++ b/getting_started/unix-variants.rst
@ -113,7 +113,7 @@ long wait you'll experience if you build everything.  Finally,

 .. parsed-literal::

-  **$** ./bjam install
+  **$** ./b2 install

 will leave Boost binaries in the ``lib/`` subdirectory of your
 installation prefix.  You will also find a copy of the Boost
@ -150,7 +150,7 @@ For example, your session might look like this:
 .. parsed-literal::

   $ cd ~/|boost_ver|
-   $ bjam **--build-dir=**\ /tmp/build-boost **toolset=**\ gcc stage
+   $ b2 **--build-dir=**\ /tmp/build-boost **toolset=**\ gcc stage

 That will build static and shared non-debug multi-threaded variants of the libraries. To build all variants, pass the additional option, “``--build-type=complete``”.

--- a/getting_started/windows.html
+++ b/getting_started/windows.html
@ -42,7 +42,7 @@ not supported—they may or may not work.</p>
 <li><a class="reference internal" href="#install-boost-build" id="id39">5.3.1&nbsp;&nbsp;&nbsp;Install Boost.Build</a></li>
 <li><a class="reference internal" href="#identify-your-toolset" id="id40">5.3.2&nbsp;&nbsp;&nbsp;Identify Your Toolset</a></li>
 <li><a class="reference internal" href="#select-a-build-directory" id="id41">5.3.3&nbsp;&nbsp;&nbsp;Select a Build Directory</a></li>
-<li><a class="reference internal" href="#invoke-bjam" id="id42">5.3.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">bjam</tt></a></li>
+<li><a class="reference internal" href="#invoke-b2" id="id42">5.3.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">b2</tt></a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#expected-build-output" id="id43">5.4&nbsp;&nbsp;&nbsp;Expected Build Output</a></li>
@ -94,7 +94,7 @@ distribution.<a class="footnote-reference" href="#zip" id="id2"><sup>1</sup></a>
     <strong>array</strong><strong>\</strong>
                     <em>…more libraries…</em>
   <strong>status</strong><strong>\</strong> .........................<em>Boost-wide test suite</em>
-   <strong>tools</strong><strong>\</strong> ...........<em>Utilities, e.g. bjam, quickbook, bcp</em>
+   <strong>tools</strong><strong>\</strong> ...........<em>Utilities, e.g. Boost.Build, quickbook, bcp</em>
   <strong>more</strong><strong>\</strong> ..........................<em>Policy documents, etc.</em>
   <strong>doc</strong><strong>\</strong> ...............<em>A subset of all Boost library docs</em>
 </pre>
@ -367,12 +367,12 @@ and change your current directory to the Boost root directory. Then, type
 the following commands:</p>
 <pre class="literal-block">
 bootstrap
-.\bjam
+.\b2
 </pre>
 <p>The first command prepares the Boost.Build system for use. The second
 command invokes Boost.Build to build the separately-compiled Boost
 libraries. Please consult the <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/overview/invocation.html">Boost.Build documentation</a> for a list
-of options that can be passed to <tt class="docutils literal">bjam</tt>.</p>
+of allowed options.</p>
 </div>
 <div class="section" id="or-build-binaries-from-source">
 <h2><a class="toc-backref" href="#id38">5.3&nbsp;&nbsp;&nbsp;Or, Build Binaries From Source</a></h2>
@ -395,7 +395,7 @@ install it. To do this:</p>
 <ol class="arabic simple">
 <li>Go to the directory <tt class="docutils literal">tools</tt><tt class="docutils literal">\</tt><tt class="docutils literal">build</tt><tt class="docutils literal">\</tt><tt class="docutils literal">v2</tt><tt class="docutils literal">\</tt>.</li>
 <li>Run <tt class="docutils literal">bootstrap.bat</tt></li>
-<li>Run <tt class="docutils literal">bjam install <span class="pre">--prefix=</span></tt><em>PREFIX</em> where <em>PREFIX</em> is
+<li>Run <tt class="docutils literal">b2 install <span class="pre">--prefix=</span></tt><em>PREFIX</em> where <em>PREFIX</em> is
 the directory where you want Boost.Build to be installed</li>
 <li>Add <em>PREFIX</em><tt class="docutils literal">\</tt><tt class="docutils literal">bin</tt> to your PATH environment variable.</li>
 </ol>
@ -408,7 +408,7 @@ Boost.Build documentation</a>).</p>
 <div class="note">
 <p class="first admonition-title">Note</p>
 <p class="last">If you previously chose a toolset for the purposes of
-<a class="reference external" href="../../doc/html/bbv2/installation.html">building bjam</a>, you should assume it won't work and instead
+<a class="reference external" href="../../doc/html/bbv2/installation.html">building b2</a>, you should assume it won't work and instead
 choose newly from the table below.</p>
 </div>
 <table border="1" class="docutils">
@ -510,25 +510,25 @@ directory is writable, this step isn't strictly necessary: by
 default Boost.Build will create a <tt class="docutils literal">bin.v2/</tt> subdirectory for that
 purpose in your current working directory.</p>
 </div>
-<div class="section" id="invoke-bjam">
-<h3><a class="toc-backref" href="#id42">5.3.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">bjam</tt></a></h3>
+<div class="section" id="invoke-b2">
+<h3><a class="toc-backref" href="#id42">5.3.4&nbsp;&nbsp;&nbsp;Invoke <tt class="docutils literal">b2</tt></a></h3>
 <p>Change your current directory to the Boost root directory and
-invoke <tt class="docutils literal">bjam</tt> as follows:</p>
+invoke <tt class="docutils literal">b2</tt> as follows:</p>
 <pre class="literal-block">
-bjam <strong>--build-dir=</strong><a class="reference internal" href="#id13"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <strong>--build-type=complete</strong> stage
+b2 <strong>--build-dir=</strong><a class="reference internal" href="#id13"><em>build-directory</em></a> <strong>toolset=</strong><a class="reference internal" href="#toolset-name"><em>toolset-name</em></a> <strong>--build-type=complete</strong> stage
 </pre>
 <p>For a complete description of these and other invocation options,
 please see the <a class="reference external" href="http://www.boost.org/boost-build2/doc/html/bbv2/advanced/invocation.html">Boost.Build documentation</a>.</p>
 <p>For example, your session might look like this:<a class="footnote-reference" href="#continuation" id="id15"><sup>4</sup></a></p>
 <pre class="literal-block">
 C:\WINDOWS&gt; cd <tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_47_0</tt>
-<tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_47_0</tt>&gt; bjam <strong>^</strong>
+<tt class="docutils literal"><span class="pre">C:\Program</span> Files\boost\</tt><tt class="docutils literal">boost_1_47_0</tt>&gt; b2 <strong>^</strong>
 More? <strong>--build-dir=</strong>&quot;C:\Documents and Settings\dave\build-boost&quot; <strong>^</strong>
 More? <strong>--build-type=complete</strong> <strong>msvc</strong> stage
 </pre>
 <p>Be sure to read <a class="reference internal" href="#continuation">this note</a> about the appearance of <tt class="docutils literal">^</tt>,
 <tt class="docutils literal">More?</tt> and quotation marks (<tt class="docutils literal">&quot;</tt>) in that line.</p>
-<p>The option “<strong>--build-type=complete</strong>” causes <tt class="docutils literal">bjam</tt> to build
+<p>The option “<strong>--build-type=complete</strong>” causes Boost.Build to build
 all supported variants of the libraries.  For instructions on how to
 build only specific variants, please ask on the <a class="reference external" href="http://www.boost.org/more/mailing_lists.htm#jamboost">Boost.Build mailing
 list</a>.</p>
@ -538,16 +538,16 @@ list</a>.</p>
 <p>Building the special <tt class="docutils literal">stage</tt> target places Boost
 library binaries in the <tt class="docutils literal">stage</tt><tt class="docutils literal">\</tt><tt class="docutils literal">lib</tt><tt class="docutils literal">\</tt> subdirectory of
 the Boost tree.  To use a different directory pass the
-<tt class="docutils literal"><span class="pre">--stagedir=</span></tt><em>directory</em> option to <tt class="docutils literal">bjam</tt>.</p>
+<tt class="docutils literal"><span class="pre">--stagedir=</span></tt><em>directory</em> option to <tt class="docutils literal">b2</tt>.</p>
 <div class="note">
 <p class="first admonition-title">Note</p>
-<p class="last"><tt class="docutils literal">bjam</tt> is case-sensitive; it is important that all the
+<p class="last"><tt class="docutils literal">b2</tt> is case-sensitive; it is important that all the
 parts shown in <strong>bold</strong> type above be entirely lower-case.</p>
 </div>
 <p>For a description of other options you can pass when invoking
-<tt class="docutils literal">bjam</tt>, type:</p>
+<tt class="docutils literal">b2</tt>, type:</p>
 <pre class="literal-block">
-bjam --help
+b2 --help
 </pre>
 <p>In particular, to limit the amount of time spent building, you may
 be interested in:</p>
--- a/getting_started/windows.rst
+++ b/getting_started/windows.rst
@ -208,12 +208,12 @@ and change your current directory to the Boost root directory. Then, type
 the following commands::

  bootstrap
-  .\bjam
+  .\b2

 The first command prepares the Boost.Build system for use. The second
 command invokes Boost.Build to build the separately-compiled Boost
 libraries. Please consult the `Boost.Build documentation`__ for a list
-of options that can be passed to ``bjam``.
+of allowed options.

 __ http://www.boost.org/boost-build2/doc/html/bbv2/overview/invocation.html

@ -239,14 +239,14 @@ For example, your session might look like this: [#continuation]_
 .. parsed-literal::

   C:\\WINDOWS> cd |default-root|
-   |default-root|> bjam **^**
+   |default-root|> b2 **^**
   More? **--build-dir=**\ "C:\\Documents and Settings\\dave\\build-boost" **^**
   More? **--build-type=complete** **msvc** stage

 Be sure to read `this note`__ about the appearance of ``^``,
 ``More?`` and quotation marks (``"``) in that line.

-The option “\ **--build-type=complete**\ ” causes ``bjam`` to build
+The option “\ **--build-type=complete**\ ” causes Boost.Build to build
 all supported variants of the libraries.  For instructions on how to
 build only specific variants, please ask on the `Boost.Build mailing
 list`_.