Re: [jamboost] --help-options / --help-usage

From: Rene Rivera (grafik.list_at_[hidden])
Date: 2005-07-06 18:54:46

Andrey Melnikov wrote:
> Vladimir Prus wrote:
>>On Wednesday 06 July 2005 18:39, Rene Rivera wrote:
>>
>>>* --help; This help message.
>>>* --help-project; Information on building for this project.
>>>* --help-command; Command line syntax and available options.
>>>* --help-doc; How to control the output of this help text.
>>>* --help-internal; Boost.Build implementation details.
>>
>>Ok, this looks fine.
> 
> Do we really need these "*" and ";" ? In all programs I've seen it would 
> be just
> 
> --help This help message.
> --help-project Information on building for this project.
> --help-command Command line syntax and available options.
> --help-doc How to control the output of this help text.
> --help-internal Boost.Build implementation details.

Need is very relative in this case. The "*" are there because it is 
trying to represent the equivalent HTML structure, of an unordered list, 
which is what it constructs internally. And prints out as either text or 
HTML. As for the alignment, it's not easy to do that in bjam so I'm not 
sure it's worth the effort.

> Also despite "--help This help message." line is widely used, it doesn't 
> serve any purpose and can be removed. It's just like distributing 
> drivers for a CDROM drive on CDs :)

Good point :-)

-- 
-- Grafik - Don't Assume Anything
-- Redshift Software, Inc. - http://redshift-software.com
-- rrivera/acm.org - grafik/redshift-software.com
-- 102708583/icq - grafikrobot/aim - Grafik/jabber.org