Re: [Boost-build] [doc] b2 headers

Subject: Re: [Boost-build] [doc] b2 headers
From: Steven Watanabe (watanabesj_at_[hidden])
Date: 2018-04-09 17:27:51

AMDG

On 04/09/2018 07:35 AM, Mateusz Loskot via Boost-build wrote:
> Hi,
> 
> TL;TR: A rant
> 
> 
> I've been looking for documentation about purpose of command
> 
> b2 headers
> 
> Greping for headers or modular inside  /tools/build/doc and
> /doc gives me nothing, so I blindly assume the unsearchable
> https://www.boost.org/build/ does not explain it either.
> 
> The magic of https://www.google.com/search?q="b2+headers"
> brought this page to my attention:
> https://www.boost.org/doc/libs/master/tools/boostdep/doc/html/
> where, to my surprise, I find one of best intro to the concept
> of modular Boost including very helpful explanation of the virtual
> /boost directory and role of b2 headers command.
> 
> Why this kind of information is presented in docs for somewhat
> exotic to Boost (end)users command, I have no idea.

  `b2 headers` is not really intended for end users.
It's only relevant when working from git as the
packaged releases have all the headers moved into
boost/ to begin with.  As a result, the obvious
places to put this documentation (the getting started
guide and `b2 --help` from $BOOST_ROOT) are not really
correct.

  b2 headers is discussed briefly here:
https://github.com/boostorg/boost/wiki/Getting-Started
which is about as good a location as anywhere.

  Also, most of the time, you don't need to care
about `b2 headers`.  Running b2 in $BOOST_ROOT
will build the headers in addition to putting
the libraries in stage/lib.  For internal use
such as Boost tests and examples, the necessary
headers will be created automatically.

> But, as long-time Boost.Build users, I dare to judge this is an
> excellent example of why peole hate this awesome build system :)
> 

In Christ,
Steven Watanabe