Re: [jamboost] Status of Boostbook BBv2

From: Vladimir Prus (ghost_at_[hidden])
Date: 2004-06-07 02:37:58

Hi Michael,

> It would seem like now would be a good time to contribute toolset
> documentation to BBv2. It was intending at least to make a start with the
> <toolset>intel-linux
>
> With this in mind I had a quick look at the build/v2/doc directory and
> found that there is both the ordinary HTML documentation and also Boostbook
> in source. From the CVS commits it looks like both are fairly up to date.
>
> Should new toolset documentation be in Boostbook source format?

Yes, Boostbook is now the official documentation format. 

I wonder how toolset docs are to be related with online help. After all, the 
original intention was that "bjam --help msvc.init" could produce help for 
the msvc module.... OTOH, it's not possible to produce docbook output right 
now and we still need docs, so I guess you can go ahead.

> While setting up Boostbook I stumbled across a bug. The 'doc/catalog.xml'
> file is not overwritten once it has already been created. Therefore
> changing DTD XSL or directory location specification in user-config (or
> environment variables) is ineffective once bjam has been run once.

This is very unfurtunate thing. The story is: it was reported as bug. I've 
found that some other jam variant has a builtin IFUSED which could help. Doug 
asked how he can see implementation of this builting. I've looked at the code 
and could not find it. The original author said to me he might have removed 
the builtin, but has not yet replied to a question asking if he found a 
better way.

- Volodya