Re: [jamboost] [BBv2 doc editorial] Tutorial

From: Vladimir Prus (ghost_at_[hidden])
Date: 2005-09-22 10:19:40

On Wednesday 21 September 2005 20:10, Andrey Melnikov wrote:
> Vladimir Prus wrote:
> > On Wednesday 21 September 2005 00:55, Andrey Melnikov wrote:
> >>The examples don't demonstrate the key BB features and don't have a big
> >>practical usage for a newbie.
> >
> > In fact, they was not meant to demonstrate everything. IMO, tutorial
> > should guide though basic tasks in a project (building, testing,
> > installing) so that user gets familiar with the tool.
>
> I don't see a big diffenence between "guide through" and "demonstrate".
> But the tasks should be really "basic".
>
> IMO the the following tasks are rather advanced and are required only if
> a user is going to support multiple toolsets and/or build configurations:
>
> - build variants

Undecided on this one. IMO, it's pretty important thing to mention early.

> - folder naming algorithm (chaining of free properties)

I'm not sure what's "chaning of free properties".

> - linking a single cpp file into many executables

Yes, it's not very important.

> - cleaning specific targets

Guess you're right.

> The tutorial can be much simpler and demonstrate more basic features.
>
> As the first step in improving, I suggest to remove the features I
> listed and move them to a more advanced chapter of the tutorial. Or even
> to the reference.
>
>
> ------
> Hello, world
>
> The simplest project that Boost.Build can construct is stored in
> example/hello/ directory. The project is described by a file called
> Jamroot that contains:
>
> exe hello : hello.cpp ;
>
> Now let's remove all the built products (hello.obj and hello.exe on
> Windows):
>
> bjam --clean
>
> To rebuild the exe, run
>
> bjam -a
>
> Boost.Build will rebuild all (hence "-a") the targets unconditionally.

I'd agree with all of those changes, except that I'm not sure about build 
variants.

- Volodya

-- 
Vladimir Prus
http://vladimir_prus.blogspot.com
Boost.Build V2: http://boost.org/boost-build2