Re: [Boost-build] BBv2 documentation

From: Jared W. Robinson (jared.robinson_at_[hidden])
Date: 2005-11-14 11:37:24

On Sun, Nov 13, 2005 at 02:56:56PM -0600, Rene Rivera wrote:
> Also, <http://www.boost.org/tools/build/jam_src/index.html> describes the bjam 
> extensions. I'm personally planning on rewriting both of those into one set of 
> docs, in QuickBook, so that it can be directly integrated into the rest of the 
> Boost and BBv2 docs.

Somehow, I had missed reading that document. I figured something titled
"index.html" was merely a jumping-off point to the other docs in that
directory "Jam.html", etc. I was wrong.

> > There is also a lot of information spread out all over the place (BBv2 
> > docs, Wiki, Boost/Getting Started, jam_src/index.html, etc.) that should 
> > be in one place (this is part of the confusion).
> 
> But we have to be careful how we put those together because at some point it 
> starts looking scary for beginners to encounter a large document just to build 
> Boost.

There's a difference between building boost, and the BBv2 project. I
think BBv2 is becoming its own project, separate from Boost itself, with
a life of its own. Perhaps a more clear separation needs to be made so
that users aren't confused. Building Boost is certainly different from
understanding, using (in terms of writing Jamfiles) and extending BBv2.

> > Also, the BBv2 
> > documentation is difficult to access (www.boost.org -> Getting Started 
> > (Preparation) -> Boost.Build -> Boost.Build2 -> Documentation).
> 
> Well it's also available from <http://www.boost.org/doc/html/>. But I'm 
> failing to find a link to that any place obvious.

I would think that, at a minimum, BBv2 should be recognized as a
self-sufficient project (perhaps I am mistaking), and given a URL such
as http://www.boost.org/bjam or http://www.boost.org/buildtool or
something similar. 

- Jared