Small documentation inaccuracies

From: Niklaus Giger (NiklausGiger_at_[hidden])
Date: 2005-01-25 03:41:56

Hi 

My experience with the test scripts ist that following sentence
test/test_system.html is wrong:
To debug a failed test, you should add "--preserve" option when invoking
test. On failure, the working directory will be copied to "failed_test"
directory in the current dir.

I would propose something like:
To debug a tests, you should set the environment variable "PRESERVE" option
to a non-empty value before invoking a test. If you want to debug only
failed tests, set the environment variable "PRESERVE_FAILURE" option. There
exist also analogous environment values "PRESERVE_PASS" and "PRESERVE_TEST".

Wrong spelling:
Plese correct "extention" -> "extension" in doc/src/extending.xml and
tools/borland.jam.

Some for "feauture" -> "feature" in doc/src/extending.xml.

Also I found it confusing that project.jam redefines the glob rule
(I am coming from the Perforce Jam, where I used path.glob quite a lot)
with a different parameter set.
E.g. in path.jam you find
rule glob ( dirs * : patterns + )
whereas project.jam gives
rule glob ( wildcards + )

I am unable to request a change as I think that the behaviour of
project.glob is too deeply routed in Boost.Jam.

It might be helpful if we could generate (may using a helper like
doxygen) a index of all rules with a short explanation and incorporate
this into the User Manual.

Best regards

Niklaus

-- 
Sparen beginnt mit GMX DSL: http://www.gmx.net/de/go/dsl