From 422ad517729365fa2197a70eadc1594b38723efc Mon Sep 17 00:00:00 2001 From: Rene Rivera Date: Mon, 1 Mar 2021 22:30:51 -0600 Subject: [PATCH] Fix reference to B2, both text and links. This updates the getting started docs to refer to the canonical B2 name. Also updates all the links to B2 documentation to point to the local tools/build sourced location. Hence making those links work in both off-line and on-line (versioned) versions of this documentation. --- .../detail/build-from-source-head.rst | 8 +++--- .../detail/build-from-source-tail.rst | 4 +-- getting_started/detail/conclusion.rst | 4 +-- getting_started/unix-variants.html | 23 ++++++++--------- getting_started/windows.html | 25 +++++++++---------- getting_started/windows.rst | 4 +-- 6 files changed, 32 insertions(+), 36 deletions(-) diff --git a/getting_started/detail/build-from-source-head.rst b/getting_started/detail/build-from-source-head.rst index f72fecb..d7d8d6a 100644 --- a/getting_started/detail/build-from-source-head.rst +++ b/getting_started/detail/build-from-source-head.rst @@ -15,7 +15,7 @@ install it. To do this: the directory where you want Boost.Build to be installed 4. Add *PREFIX*\ |/|\ ``bin`` to your PATH environment variable. -.. _Boost.Build: ../../tools/build/index.html +.. _Boost.Build: ../../tools/build/doc/html/index.html .. _Boost.Build documentation: Boost.Build_ .. _toolset: @@ -28,13 +28,13 @@ First, find the toolset corresponding to your compiler in the following table (an up-to-date list is always available `in the Boost.Build documentation`__). -__ https://boostorg.github.io/build/manual/develop/index.html#bbv2.reference.tools +__ ../../tools/build/doc/html/index.html#bbv2.reference.tools .. Note:: If you previously chose a toolset for the purposes of `building b2`_, you should assume it won't work and instead choose newly from the table below. -.. _building b2: ../../doc/html/bbv2/installation.html +.. _building b2: ../../tools/build/doc/html/index.html#bbv2.installation +-----------+--------------------+------------------------------------------------------------+ |Toolset |Vendor |Notes | @@ -109,5 +109,5 @@ invoke ``b2`` as follows: For a complete description of these and other invocation options, please see the `Boost.Build documentation`__. -__ http://www.boost.org/build/doc/html/bbv2/overview/invocation.html +__ ../../tools/build/doc/html/index.html#bbv2.overview.invocation diff --git a/getting_started/detail/build-from-source-tail.rst b/getting_started/detail/build-from-source-tail.rst index b05c6a5..e4719f8 100644 --- a/getting_started/detail/build-from-source-tail.rst +++ b/getting_started/detail/build-from-source-tail.rst @@ -68,6 +68,6 @@ If it seems like the build system can't find your compiler and/or linker, consider setting up a ``user-config.jam`` file as described `here`__. If that isn't your problem or the ``user-config.jam`` file doesn't work for you, please address questions about configuring Boost -for your compiler to the `Boost.Build mailing list`_. +for your compiler to the `Boost Users' mailing list`_. -__ http://www.boost.org/build/doc/html/bbv2/overview/configuration.html +__ ../../tools/build/doc/html/index.html#bbv2.overview.configuration diff --git a/getting_started/detail/conclusion.rst b/getting_started/detail/conclusion.rst index 44fb120..4f1a178 100644 --- a/getting_started/detail/conclusion.rst +++ b/getting_started/detail/conclusion.rst @@ -16,7 +16,6 @@ mailing list`_. * `Boost.Build reference manual`_ * `Boost Users' mailing list`_ -* `Boost.Build mailing list`_ * `Index of all Boost library documentation`_ .. _Index of all Boost library documentation: ../../libs/index.html @@ -29,7 +28,6 @@ mailing list`_. -- the Boost Developers -.. _Boost.Build reference manual: ../../tools/build/index.html +.. _Boost.Build reference manual: ../../tools/build/doc/html/index.html .. _Boost Users' mailing list: http://www.boost.org/more/mailing_lists.htm#users -.. _Boost.Build mailing list: http://www.boost.org/more/mailing_lists.htm#jamboost diff --git a/getting_started/unix-variants.html b/getting_started/unix-variants.html index 196f7b2..3c1107b 100644 --- a/getting_started/unix-variants.html +++ b/getting_started/unix-variants.html @@ -301,16 +301,16 @@ path in place of the Boost root directory.

5.2   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.

+need to use Boost.Build to create binaries.

You'll also use this method if you need a nonstandard build variant (see the -Boost.Build documentation for more details).

+Boost.Build documentation for more details).

5.2.1   Install Boost.Build

-

Boost.Build is a text-based system for developing, testing, and +

Boost.Build is a text-based system for developing, testing, and installing software. First, you'll need to build and install it. To do this:

    @@ -324,12 +324,12 @@ the directory where you want Boost.Build to be installed

    5.2.2   Identify Your Toolset

    First, find the toolset corresponding to your compiler in the -following table (an up-to-date list is always available in the +following table (an up-to-date list is always available in the Boost.Build documentation).

    Note

    If you previously chose a toolset for the purposes of -building b2, 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.

    @@ -356,7 +356,7 @@ Name - @@ -407,7 +407,7 @@ a hyphen, e.g. intel-9.0

    5.2.3   Select a Build Directory

    -

    Boost.Build will place all intermediate files it generates while +

    Boost.Build will place all intermediate files it generates while building into the build directory. If your Boost root directory is writable, this step isn't strictly necessary: by default Boost.Build will create a bin.v2/ subdirectory for that @@ -421,7 +421,7 @@ invoke b2 as follows:

    b2 --build-dir=build-directory toolset=toolset-name `` `` stage

    For a complete description of these and other invocation options, -please see the Boost.Build documentation.

    +please see the Boost.Build documentation.

    For example, your session might look like this:

     $ cd ~/boost_1_76_0
@@ -495,9 +495,9 @@ packages for libz and libbz2 if you need those features.  Other
 errors when building Boost libraries are cause for concern.
    
 
    If it seems like the build system can't find your compiler and/or
 linker, consider setting up a user-config.jam file as described
-here.  If that isn't your problem or the user-config.jam file
+here.  If that isn't your problem or the user-config.jam file
 doesn't work for you, please address questions about configuring Boost
-for your compiler to the Boost.Build mailing list.
    
+for your compiler to the Boost Users' mailing list.
    
 
 
 
@@ -778,9 +778,8 @@ 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 Boost Users'
 mailing list.
    
 
 
    
diff --git a/getting_started/windows.html b/getting_started/windows.html
index 2e05069..cdd630a 100644
--- a/getting_started/windows.html
+++ b/getting_started/windows.html
@@ -356,20 +356,20 @@ bootstrap

    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 +libraries. Please consult the Boost.Build documentation for a list of allowed options.

    5.2   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 +from another vendor, you'll need to use Boost.Build to create your own binaries.

    5.2.1   Install Boost.Build

    -

    Boost.Build is a text-based system for developing, testing, and +

    Boost.Build is a text-based system for developing, testing, and installing software. First, you'll need to build and install it. To do this:

      @@ -383,12 +383,12 @@ the directory where you want Boost.Build to be installed

      5.2.2   Identify Your Toolset

      First, find the toolset corresponding to your compiler in the -following table (an up-to-date list is always available in the +following table (an up-to-date list is always available in the Boost.Build documentation).

      Note

      If you previously chose a toolset for the purposes of -building b2, 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.

    como Comeau ComputingUsing this toolset may require configuring another +Using this toolset may require configuring another toolset to act as its backend.
    darwin
    @@ -415,7 +415,7 @@ Name - @@ -469,7 +469,7 @@ detection code) or auto-linki

    5.2.3   Select a Build Directory

    -

    Boost.Build will place all intermediate files it generates while +

    Boost.Build will place all intermediate files it generates while building into the build directory. If your Boost root directory is writable, this step isn't strictly necessary: by default Boost.Build will create a bin.v2/ subdirectory for that @@ -483,7 +483,7 @@ invoke b2 as follows:

    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.

    +please see the Boost.Build documentation.

    For example, your session might look like this:3

     C:\WINDOWS> cd C:\Program Files\boost\boost_1_76_0
@@ -495,7 +495,7 @@ More? --build-type=complete msvc stage
 More? and quotation marks (") in that line.
    
 
    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
+build only specific variants, please ask on the Boost Users' mailing
 list.
    
 
 
@@ -564,9 +564,9 @@ packages for libz and libbz2 if you need those features.  Other
 errors when building Boost libraries are cause for concern.
    
 
    If it seems like the build system can't find your compiler and/or
 linker, consider setting up a user-config.jam file as described
-here.  If that isn't your problem or the user-config.jam file
+here.  If that isn't your problem or the user-config.jam file
 doesn't work for you, please address questions about configuring Boost
-for your compiler to the Boost.Build mailing list.
    
+for your compiler to the Boost Users' mailing list.
    
 
 
 
@@ -848,9 +848,8 @@ 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 Boost Users'
 mailing list.
    
 
 
    
diff --git a/getting_started/windows.rst b/getting_started/windows.rst
index d1f4494..b11b542 100644
--- a/getting_started/windows.rst
+++ b/getting_started/windows.rst
@@ -183,7 +183,7 @@ command invokes Boost.Build to build the separately-compiled Boost
 libraries. Please consult the `Boost.Build documentation`__ for a list
 of allowed options.
 
-__ http://www.boost.org/build/doc/html/bbv2/overview/invocation.html
+__ ../../tools/build/doc/html/index.html#bbv2.overview.invocation
 
 Or, Build Binaries From Source
 ------------------------------
@@ -208,7 +208,7 @@ Be sure to read `this note`__ about the appearance of ``^``,
 
 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
+build only specific variants, please ask on the `Boost Users' mailing
 list`_.
 
 __ continuation_
    como Comeau ComputingUsing this toolset may require configuring another +Using this toolset may require configuring another toolset to act as its backend.
    darwin