Re: [jamboost] Some help systems changes...

From: Vladimir Prus (ghost_at_[hidden])
Date: 2003-06-11 03:53:49

Rene Rivera wrote:
> Finally got around to finishing some changes I had worked on a while ago!
>
> As you'll notice from the print.jam commit I got the HTML output working.
> So it's now possible to get a somewhat formatted HTML page of any help
> request. For example to get the "class" docs do:
>
> bjam --help-output html --help class

Rene,
this is very cool! I've just produced help fro stlport module, for example. I 
wonder if it's possible to intergrate output of help system with the html 
docs we have already... there's another approach --- instruct the user to run 
help system for additional help, and I'm not sure which one is best.

> Enjoy.

Thanks :-)
I've a couple of comments, though. 
1. It's probably better to insert a link to 
http://docutils.sourceforge.net/rst.html
in doc.jam, so that everybody know where to look for syntax rules. If 
something is not supported yet, it's better be documented.
2. We *really* need a test, no matter how simple, for the --help option.
For a motivation: the option was broken recently, and nobody noticed for a 
week or even longer.

- Volodya