Re: [jamboost] V2 Wiki

From: Vladimir Prus (ghost_at_[hidden])
Date: 2004-10-13 05:43:20

Toon Knapen wrote:

> > The idea is that all users can easily add howtos, and comments there. The
> > relevant material will be periodically moved to the main documentation.
> > The V2 home page is also updated with the link to Wiki.
>
> I've added already soth. to the wiki. First I added a small section on
> compiling bjam (which is not IMO in the bjamv2 documentation)
>
> Next I am for a long time already hungry for some kind of reference.
> 1) A reference on the bjam-language.
> The bjam language IMO is not very well documented and it would be nice
> to see some kind of reference of all
> _ control flow constructs that can be used in bjam (if-else),
> _ what the builtin datatypes are (lists)
> _ and how they can be manipulated (what is the difference between
> 'list+' and 'list*'),
> _ what the function calling convention is
> _ and are rules similar to functions ..

Yea, I though that for example docs can give a body of a small function and 
then walk though each construct describing what it does.

A quick table of syntax construct, a table of variable indexing modes 
( $(var[1]) $(var[-1) etc) and maybe something else can follow.

> Probably all this information can be found in some Perforce Jam
> documents. And if there are perforce jam documents that describe this,
> is this still valid for bjam syntax? If there are such documents and it
> would be good to summerise them on our wiki I would be more than happy
> to do that.

The index.html in jam_src and the Jam.html there are mostly up-to-date.

> 2) and a reference on BoostBuild rules that can be used
> Similar to the Jambase.html in the perforce-jam documentation but then
> targeted to the boost-build audience.

Concerning the "lib" rule, I've just expanded the official docs. I needed that 
because I've made the finishing touches on the interface and wanted to write 
down everything. I'll post a separate message about this.

Thanks,
Volodya