[Boost-bugs] [Boost C++ Libraries] #5786: Section 5.2 in Getting Started Guide is misleading

Subject: [Boost-bugs] [Boost C++ Libraries] #5786: Section 5.2 in Getting Started Guide is misleading
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2011-08-16 11:19:14

#5786: Section 5.2 in Getting Started Guide is misleading
--------------------------------------+-------------------------------------
 Reporter:  john.reynolds@…           |       Owner:  dave                 
     Type:  Bugs                      |      Status:  new                  
Milestone:  To Be Determined          |   Component:  Getting Started Guide
  Version:  Boost 1.47.0              |    Severity:  Problem              
 Keywords:  getting started           |  
--------------------------------------+-------------------------------------
 Section 5.2 of the Getting Started Guide: "Or, Simplified Build From
 Source" says to run:

 bootstrap

 .\b2

 This does work (except when it gets the toolchain wrong) and successfully
 builds boost, and the output does correctly list the include and library
 paths.

 However, it leaves boost in a state inconsistent with the instructions in
 Section 6.1 and 6.2. These have examples which assume the libraries are in
 the lib subdirectory of the boost root (which it looks like they are for
 pre-compiled builds), whereas the instructions in 5.2 leave them in the
 stage/lib subdirectory.

 There is an "install" option which puts the libraries in another location,
 but this isn't mentioned in the Getting Started Guide.

 Section 5.4 also doesn't mention that the paths are listed in the expected
 build output, so this is easy to miss if you are not specifically looking
 for it.

 This means that following the instructions for building from source in the
 Getting Started Guide doesn't work, as Section 6.4 will fail with link
 errors.

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/5786>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.