Re: [jamboost] Re: bjam docs foor boost developers?

From: Vladimir Prus (ghost_at_[hidden])
Date: 2004-01-30 03:00:19

Hi Jeremy,

> The main point I'd like to make is that when it comes to bjam docs,
> it would be nice if priority would be given to documenting those
> features that are used the most by the end user (in this case,
> the boost developer, not a bjam developer). 

Actually, with V2 the priority is given on a very simple basis: if user comes 
and say he does not understand something, priority for corresponding docs is 
raisen. So, easy way to change priority is to use V2 ;-)

> The current docs
> are full of interesting information about features that the average
> boost developer will never use, but are lacking in documentation
> for the basic features that one finds in every Jamfile.

Do you refer to V1 docs, or V2 docs found at 

http://boost.sourceforge.net/boost-build2/boost_build_v2.html

I'd say in latter interesting information about features is hidden quite deep.

> > Hmm... despite all said above I can hardly have time to expand docs
>
> for V2
>
> > testing system. The primary V2 docs issue for now is extender's
>
> manual and
>
> > even that does not progress as quickly as I'd like.
>
> I'm not familiar with this "extender's manual". What is it?

That's 

http://boost.sourceforge.net/boost-build2/doc/extending.html

and is intended to descrive how user can extend V2. There's was quite a bunch 
of questions like "how to add a new feature", "how to define my own variant", 
"how to support my custom tool" recently, that's why priority on this is 
high.

- Volodya