From 035a84e96754938309cfadec5d3bf1a75b3988f4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ion=20Gazta=C3=B1aga?= Date: Thu, 13 Aug 2026 01:25:13 +0200 Subject: [PATCH] Update Getting Started for 1.93.0 --- getting_started/detail/release-variables.rst | 8 +- getting_started/index.html | 4 +- getting_started/unix-variants.html | 124 ++++++++-------- getting_started/windows.html | 146 +++++++++---------- 4 files changed, 141 insertions(+), 141 deletions(-) diff --git a/getting_started/detail/release-variables.rst b/getting_started/detail/release-variables.rst index bd69529..5a7270f 100644 --- a/getting_started/detail/release-variables.rst +++ b/getting_started/detail/release-variables.rst @@ -5,8 +5,8 @@ .. This file contains all the definitions that need to be updated .. for each new release of Boost. -.. |boost-version-number| replace:: 92 -.. |boost_ver| replace:: ``boost_1_92_0`` -.. |boost_ver-bold| replace:: **boost_1_92_0** +.. |boost-version-number| replace:: 93 +.. |boost_ver| replace:: ``boost_1_93_0`` +.. |boost_ver-bold| replace:: **boost_1_93_0** -.. _sf-download: http://www.boost.org/users/history/version_1_92_0.html +.. _sf-download: http://www.boost.org/users/history/version_1_93_0.html diff --git a/getting_started/index.html b/getting_started/index.html index cd99cd6..aea82cf 100644 --- a/getting_started/index.html +++ b/getting_started/index.html @@ -1,9 +1,9 @@ - + - + Boost Getting Started diff --git a/getting_started/unix-variants.html b/getting_started/unix-variants.html index c7ff719..0b89001 100644 --- a/getting_started/unix-variants.html +++ b/getting_started/unix-variants.html @@ -1,11 +1,11 @@ - + - -Boost Getting Started on Unix Variants + +Boost Getting Started on Unix Variants @@ -28,47 +28,47 @@ .. _Cygwin: http://www.cygwin.com .. _MinGW: http://mingw.org -->
-

Index

+

Index

-

1   Get Boost

+

1   Get Boost

The most reliable way to get a copy of Boost is to download a -distribution from SourceForge:

+distribution from SourceForge:

    -
  1. Download boost_1_82_0.tar.bz2.

    +
  2. Download boost_1_93_0.tar.bz2.

  3. In the directory where you want to put the Boost installation, execute

    -tar --bzip2 -xf /path/to/boost_1_82_0.tar.bz2
    +tar --bzip2 -xf /path/to/boost_1_93_0.tar.bz2
     
@@ -79,19 +79,19 @@ library packages, however you may need to adapt these instructions if you use third-party packages, because their creators usually choose to break Boost up into several packages, reorganize the directory structure of the Boost distribution, -and/or rename the library binaries.1 If you have +and/or rename the library binaries.1 If you have any trouble, we suggest using an official Boost distribution -from SourceForge.

+from SourceForge.

-

2   The Boost Distribution

+

2   The Boost Distribution

This is a sketch of the resulting directory structure:

-boost_1_82_0/ .................The “boost root directory”
+boost_1_93_0/ .................The “boost root directory”
    index.htm .........A copy of www.boost.org starts here
    boost/ .........................All Boost Header files
    `` ``
@@ -136,7 +136,7 @@ anything you can use in these directories.

It's important to note the following:

    -
  1. The path to the boost root directory (often /usr/local/boost_1_82_0) is +

  2. The path to the boost root directory (often /usr/local/boost_1_93_0) is sometimes referred to as $BOOST_ROOT in documentation and mailing lists .

  3. @@ -166,7 +166,7 @@ contains a subset of the Boost documentation. Start with
    -

    3   Header-Only Libraries

    +

    3   Header-Only Libraries

    The first thing many people want to know is, “how do I build Boost?” The good news is that often, there's nothing to build.

    @@ -220,7 +220,7 @@ necessary.
    -

    4   Build a Simple Program Using Boost

    +

    4   Build a Simple Program Using Boost

    To keep things simple, let's start by using a header-only library. The following program reads a sequence of integers from standard input, uses Boost.Lambda to multiply each number by three, and @@ -244,7 +244,7 @@ int main()

    Now, in the directory where you saved example.cpp, issue the following command:

    -c++ -I path/to/boost_1_82_0 example.cpp -o example
    +c++ -I path/to/boost_1_93_0 example.cpp -o example
     

    To test the result, type:

    @@ -254,10 +254,10 @@ echo 1 2 3 | ./example
     
     
     
    -

    4.1   Errors and Warnings

    +

    4.1   Errors and Warnings

    Don't be alarmed if you see compiler warnings originating in Boost headers. We try to eliminate them, but doing so isn't always -practical.3 Errors are another matter. If you're +practical.3 Errors are another matter. If you're seeing compilation errors at this point in the tutorial, check to be sure you've copied the example program correctly and that you've correctly identified the Boost root directory.

    @@ -267,15 +267,15 @@ correctly identified the -

    5   Prepare to Use a Boost Library Binary

    +

    5   Prepare to Use a Boost Library Binary

    If you want to use any of the separately-compiled Boost libraries, you'll need to acquire library binaries.

    -

    5.1   Easy Build and Install

    +

    5.1   Easy Build and Install

    Issue the following commands in the shell (don't type $; that represents the shell's prompt):

    -$ cd path/to/boost_1_82_0
    +$ cd path/to/boost_1_93_0
     $ ./bootstrap.sh --help
     

    Select your configuration options and invoke ./bootstrap.sh again @@ -299,7 +299,7 @@ path in place of the Boost root directory.

    skip to the next step

    -

    5.2   Or, Build Custom Binaries

    +

    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.

    You'll also @@ -309,7 +309,7 @@ use this method if you need a nonstandard build variant (see the

    -

    5.2.1   Install Boost.Build

    +

    5.2.1   Install Boost.Build

    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:

    @@ -322,7 +322,7 @@ the directory where you want Boost.Build to be installed
-

5.2.2   Identify Your Toolset

+

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 Boost.Build documentation).

@@ -406,7 +406,7 @@ a hyphen, e.g. intel-9.0borland-5.4.3. `` ``

-

5.2.3   Select a Build Directory

+

5.2.3   Select a Build Directory

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 @@ -414,17 +414,17 @@ default Boost.Build will create a bin.v2/ subd purpose in your current working directory.

-

5.2.4   Invoke b2

+

5.2.4   Invoke b2

Change your current directory to the Boost root directory and invoke b2 as follows:

-b2 --build-dir=build-directory toolset=toolset-name `` `` stage
+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.

For example, your session might look like this:

-$ cd ~/boost_1_82_0
+$ cd ~/boost_1_93_0
 $ 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”.

@@ -463,7 +463,7 @@ file by appending “>build.log -

5.3   Expected Build Output

+

5.3   Expected Build Output

During the process of building Boost libraries, you can expect to see some messages printed on the console. These may include

    @@ -487,7 +487,7 @@ look something like:

-

5.4   In Case of Build Errors

+

5.4   In Case of Build Errors

The only error messages you see when building Boost—if any—should be related to the IOStreams library's support of zip and bzip2 formats as described here. Install the relevant development @@ -504,7 +504,7 @@ for your compiler to the -

6   Link Your Program to a Boost Library

+

6   Link Your Program to a Boost Library

To demonstrate linking with a Boost binary library, we'll use the following simple program that extracts the subject lines from emails. It uses the Boost.Regex library, which has a @@ -540,14 +540,14 @@ project.

  1. You can specify the full path to each library:

    -$ c++ -I path/to/boost_1_82_0 example.cpp -o example \
    +$ c++ -I path/to/boost_1_93_0 example.cpp -o example \
        ~/boost/stage/lib/libboost_regex-gcc34-mt-d-1_36.a
     
  2. -
  3. You can separately specify a directory to search (with -Ldirectory) and a library name to search for (with -llibrary,2 dropping the filename's leading lib and trailing +

  4. You can separately specify a directory to search (with -Ldirectory) and a library name to search for (with -llibrary,2 dropping the filename's leading lib and trailing suffix (.a in this case):

    -$ c++ -I path/to/boost_1_82_0 example.cpp -o example \
    +$ c++ -I path/to/boost_1_93_0 example.cpp -o example \
        -L~/boost/stage/lib/ -lboost_regex-gcc34-mt-d-1_36
     

    As you can see, this method is just as terse as method A for one @@ -562,7 +562,7 @@ automatically for you unless you pass a special option such as

    In both cases above, the bold text is what you'd add to the command lines we explored earlier.

    -

    6.1   Library Naming

    +

    6.1   Library Naming

    @@ -577,7 +577,7 @@ following elements:

    Prefix: except on Microsoft Windows, every Boost library name begins with this string. On Windows, only ordinary static libraries use the lib prefix; import libraries and DLLs do -not.4
    +not.4
    boost_regex
    Library name: all boost library filenames begin with boost_.
    -vc71
    @@ -620,7 +620,7 @@ libraries. python-debugging=on d -building a debug version of your code.5 +building a debug version of your code.5 variant=debug p @@ -728,7 +728,7 @@ version number, will also be created.
    -

    6.2   Test Your Program

    +

    6.2   Test Your Program

    To test our subject extraction, we'll filter the following text file. Copy it out of your browser and save it as jayne.txt:

    @@ -768,7 +768,7 @@ Spoil Rock Hunter?”

-

7   Conclusion and Further Resources

+

7   Conclusion and Further Resources

This concludes your introduction to Boost and to integrating it with your programs. As you start using Boost in earnest, there are surely a few additional points you'll wish we had covered. One day @@ -793,7 +793,7 @@ mailing list.

- @@ -802,7 +802,7 @@ to the -
[1]If developers of Boost packages would like to work +
[1]If developers of Boost packages would like to work with us to make sure these instructions can be used with their packages, we'd be glad to help. Please make your interest known to the Boost developers' list.
[2]That option is a dash followed by a lowercase “L” +
[2]That option is a dash followed by a lowercase “L” character, which looks very much like a numeral 1 in some fonts.
@@ -812,7 +812,7 @@ character, which looks very much like a numeral 1 in some fonts. -
[3]Remember that warnings are specific to each compiler +
[3]Remember that warnings are specific to each compiler implementation. The developer of a given Boost library might not have access to your compiler. Also, some warnings are extremely difficult to eliminate in generic code, to the point @@ -823,7 +823,7 @@ have any source code mechanism for suppressing warnings.
- @@ -832,7 +832,7 @@ same name.
[4]This convention distinguishes the static version of +
[4]This convention distinguishes the static version of a Boost library from the import library for an identically-configured Boost DLL, which would otherwise have the same name.
- - + @@ -816,7 +816,7 @@ version number, will also be created.
-

6.4   Test Your Program

+

6.4   Test Your Program

To test our subject extraction, we'll filter the following text file. Copy it out of your browser and save it as jayne.txt:

@@ -838,7 +838,7 @@ Spoil Rock Hunter?”

-

7   Conclusion and Further Resources

+

7   Conclusion and Further Resources

This concludes your introduction to Boost and to integrating it with your programs. As you start using Boost in earnest, there are surely a few additional points you'll wish we had covered. One day @@ -863,8 +863,8 @@ mailing list.

[5]These libraries were compiled without optimization +
[5]These libraries were compiled without optimization or inlining, with full debug symbols enabled, and without NDEBUG #defined. Although it's true that sometimes these choices don't affect binary compatibility with other diff --git a/getting_started/windows.html b/getting_started/windows.html index e4717c1..cdaaf30 100644 --- a/getting_started/windows.html +++ b/getting_started/windows.html @@ -1,9 +1,9 @@ - + - + Boost Getting Started on Windows @@ -24,54 +24,54 @@ variants. Other command shells, such as
-

Index

+

Index

-

1   Get Boost

+

1   Get Boost

The most reliable way to get a copy of Boost is to -download boost_1_82_0.7z or boost_1_82_0.zip and unpack it to install a complete Boost -distribution.1

+download boost_1_93_0.7z or boost_1_93_0.zip and unpack it to install a complete Boost +distribution.1

-

2   The Boost Distribution

+

2   The Boost Distribution

This is a sketch of the resulting directory structure:

-boost_1_82_0\ .................The “boost root directory”
+boost_1_93_0\ .................The “boost root directory”
    index.htm .........A copy of www.boost.org starts here
    boost\ .........................All Boost Header files
    lib\ .....................precompiled library binaries
@@ -116,7 +116,7 @@ anything you can use in these directories.

It's important to note the following:

    -
  1. The path to the boost root directory (often C:\Program Files\boost\boost_1_82_0) is +

  2. The path to the boost root directory (often C:\Program Files\boost\boost_1_93_0) is sometimes referred to as $BOOST_ROOT in documentation and mailing lists .

  3. @@ -151,7 +151,7 @@ contains a subset of the Boost documentation. Start with
    -

    3   Header-Only Libraries

    +

    3   Header-Only Libraries

    The first thing many people want to know is, “how do I build Boost?” The good news is that often, there's nothing to build.

    @@ -205,7 +205,7 @@ necessary.
    -

    4   Build a Simple Program Using Boost

    +

    4   Build a Simple Program Using Boost

    To keep things simple, let's start by using a header-only library. The following program reads a sequence of integers from standard input, uses Boost.Lambda to multiply each number by three, and @@ -254,14 +254,14 @@ cd path\to\some\directory

    followed by Return. For example,

    -cd C:\Program Files\boost\boost_1_82_0
    +cd C:\Program Files\boost\boost_1_93_0
     

    Long commands can be continued across several lines by typing a caret (^) at the end of all but the last line. Some examples on this page use that technique to save horizontal space.

    -

    4.1   Build From the Visual Studio IDE

    +

    4.1   Build From the Visual Studio IDE

    • From Visual Studio's File menu, select New > Project…

    • @@ -279,12 +279,12 @@ select Properties from the resulting pop-up menu

    • In Configuration Properties > C/C++ > General > Additional Include Directories, enter the path to the Boost root directory, for example

      -

      C:\Program Files\boost\boost_1_82_0

      +

      C:\Program Files\boost\boost_1_93_0

    • In Configuration Properties > C/C++ > Precompiled Headers, change Use Precompiled Header (/Yu) to Not Using Precompiled -Headers.2

      +Headers.2

    • Replace the contents of the example.cpp generated by the IDE with the example code above.

      @@ -302,7 +302,7 @@ Return key.

      skip to the next step

    -

    4.3   Errors and Warnings

    +

    4.3   Errors and Warnings

    Don't be alarmed if you see compiler warnings originating in Boost headers. We try to eliminate them, but doing so isn't always -practical.4 Errors are another matter. If you're +practical.4 Errors are another matter. If you're seeing compilation errors at this point in the tutorial, check to be sure you've copied the example program correctly and that you've correctly identified the Boost root directory.

    @@ -341,11 +341,11 @@ correctly identified the -

    5   Prepare to Use a Boost Library Binary

    +

    5   Prepare to Use a Boost Library Binary

    If you want to use any of the separately-compiled Boost libraries, you'll need to acquire library binaries.

    -

    5.1   Simplified Build From Source

    +

    5.1   Simplified Build From Source

    If you wish to build from source with Visual C++, you can use a simple build procedure described in this section. Open the command prompt and change your current directory to the Boost root directory. Then, type @@ -360,7 +360,7 @@ libraries. Please consult the -

    5.2   Or, Build Binaries From Source

    +

    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 own binaries.

    @@ -368,7 +368,7 @@ own binaries.

    -

    5.2.1   Install Boost.Build

    +

    5.2.1   Install Boost.Build

    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:

    @@ -381,7 +381,7 @@ the directory where you want Boost.Build to be installed
-

5.2.2   Identify Your Toolset

+

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 Boost.Build documentation).

@@ -468,7 +468,7 @@ are using the msvc or gcc toolsets, which have special version detection code) or auto-linking will fail.

-

5.2.3   Select a Build Directory

+

5.2.3   Select a Build Directory

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 @@ -476,18 +476,18 @@ default Boost.Build will create a bin.v2/ subd purpose in your current working directory.

-

5.2.4   Invoke b2

+

5.2.4   Invoke b2

Change your current directory to the Boost root directory and invoke b2 as follows:

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

-

For example, your session might look like this:3

+

For example, your session might look like this:3

-C:\WINDOWS> cd C:\Program Files\boost\boost_1_82_0
-C:\Program Files\boost\boost_1_82_0> b2 ^
+C:\WINDOWS> cd C:\Program Files\boost\boost_1_93_0
+C:\Program Files\boost\boost_1_93_0> b2 ^
 More? --build-dir="C:\Documents and Settings\dave\build-boost" ^
 More? --build-type=complete msvc stage
 
@@ -532,7 +532,7 @@ file by appending “>build.log -

5.3   Expected Build Output

+

5.3   Expected Build Output

During the process of building Boost libraries, you can expect to see some messages printed on the console. These may include

    @@ -556,7 +556,7 @@ look something like:

-

5.4   In Case of Build Errors

+

5.4   In Case of Build Errors

The only error messages you see when building Boost—if any—should be related to the IOStreams library's support of zip and bzip2 formats as described here. Install the relevant development @@ -573,7 +573,7 @@ for your compiler to the -

6   Link Your Program to a Boost Library

+

6   Link Your Program to a Boost Library

To demonstrate linking with a Boost binary library, we'll use the following simple program that extracts the subject lines from emails. It uses the Boost.Regex library, which has a @@ -618,7 +618,7 @@ GCC users should refer to the -

6.1   Link From Within the Visual Studio IDE

+

6.1   Link From Within the Visual Studio IDE

Starting with the header-only example project we created earlier:

    @@ -626,24 +626,24 @@ earlier:

    select Properties from the resulting pop-up menu
  1. In Configuration Properties > Linker > Additional Library Directories, enter the path to the Boost binaries, -e.g. C:\Program Files\boost\boost_1_82_0\lib\.
  2. +e.g. C:\Program Files\boost\boost_1_93_0\lib\.
  3. From the Build menu, select Build Solution.

skip to the next step

-

6.3   Library Naming

+

6.3   Library Naming

Note

If, like Visual C++, your compiler supports auto-linking, @@ -665,7 +665,7 @@ following elements:

Prefix: except on Microsoft Windows, every Boost library name begins with this string. On Windows, only ordinary static libraries use the lib prefix; import libraries and DLLs do -not.5
+not.5
boost_regex
Library name: all boost library filenames begin with boost_.
-vc71
@@ -708,7 +708,7 @@ libraries.
python-debugging=on
dbuilding a debug version of your code.6building a debug version of your code.6 variant=debug
p
- @@ -873,7 +873,7 @@ built-in decompression as it can be painfully slow for large archives.
[1]We recommend -downloading boost_1_82_0.7z and using 7-Zip to decompress +
[1]We recommend +downloading boost_1_93_0.7z and using 7-Zip to decompress it. We no longer recommend .zip files for Boost because they are twice as large as the equivalent .7z files. We don't recommend using Windows' built-in decompression as it can be painfully slow for large archives.
- @@ -882,7 +882,7 @@ used in the examples.
[2]There's no problem using Boost with precompiled headers; +
[2]There's no problem using Boost with precompiled headers; these instructions merely avoid precompiled headers because it would require Visual Studio-specific changes to the source code used in the examples.
-
[3]

In this example, the caret character ^ is a +

[3]

In this example, the caret character ^ is a way of continuing the command on multiple lines, and must be the final character used on the line to be continued (i.e. do not follow it with spaces). The command prompt responds with @@ -909,7 +909,7 @@ command-line argument contains spaces, as in

-
[4]Remember that warnings are specific to each compiler +
[4]Remember that warnings are specific to each compiler implementation. The developer of a given Boost library might not have access to your compiler. Also, some warnings are extremely difficult to eliminate in generic code, to the point @@ -920,7 +920,7 @@ have any source code mechanism for suppressing warnings.
- @@ -929,7 +929,7 @@ same name.
[5]This convention distinguishes the static version of +
[5]This convention distinguishes the static version of a Boost library from the import library for an identically-configured Boost DLL, which would otherwise have the same name.
-
[6]These libraries were compiled without optimization +
[6]These libraries were compiled without optimization or inlining, with full debug symbols enabled, and without NDEBUG #defined. Although it's true that sometimes these choices don't affect binary compatibility with other