Re: [Boost-build] Documentation for --build_type option

Subject: Re: [Boost-build] Documentation for --build_type option
From: Edward Diener (eldiener_at_[hidden])
Date: 2010-06-03 00:01:43

On 6/2/2010 8:30 PM, Steven Watanabe wrote:
> AMDG
>
> Edward Diener wrote:
>> On 6/2/2010 2:52 PM, Rene Rivera wrote:
>>> On 6/2/2010 1:37 PM, Edward Diener wrote:
>>>> On 6/2/2010 12:17 PM, Rene Rivera wrote:
>>>>> On 6/2/2010 10:55 AM, Edward Diener wrote:
>>>>>> The documentation for the --build_type option appears to be missing
>>>>>> from
>>>>>> the online documentation at
>>>>>> http://www.boost.org/boost-build2/doc/html/index.html .
>>>>>
>>>>> That's because it's not a Boost Build option. It's only a building
>>>>> Boost
>>>>> C++ Libraries option.
>>
>> If 'bjam --help' shows the documentation for --build_type IMO it needs
>> to be documented as a bjam parameter in the Boost Build documentation.
>
> As Rene has already said, --build-type has nothing to
> do with Boost.Build proper.
>
>> When I run 'bjam --help' using bjam 3.1.17, I see absolutely nothing
>> for --build_type.
>
> It's the first thing listed under Other Options when you run
> bjam --help in the root of the Boost distribution. It won't
> show up if you run bjam elsewhere, because it only applies
> to building the Boost libraries.

OK, I see it now.

Figuring any of this out, for someone who did not know it such as I, 
sure seems arcane to me. The "Getting Started" documented mentions it 
and links the end-use to Boost Build online documentation. But its not 
in the Boost Build online documentation, even in the area which lists 
the bjam command line syntax. Then I am told I need to run bjam --help 
to see it, but I must be running this from a Boost directory tree 
otherwise it will not show up because its a bjam option which only 
applies to Boost libraries. I must be naive but I thought bjam existed 
primarily to build Boost. Now I gather that since bjam can be used to 
build any software project there are options which apply to only Boost 
and options which apply to all other projects for which bjam can be used.