[Slapt-get-devel] slapt-src: a proposal of new format of the help message v2

Igor Murzov intergalactic.anonymous at gmail.com
Mon Jun 27 12:09:24 EDT 2011


> > I don't like formatting of the help message.
> 
> Can you provide more about what you don't like?
 
* Message starts with "--version |-v", but it's not specified that this is an 
argument to slapt-src. Also it's better to put some more useful options to the 
top of the message.

* Multiple usage decriptions:

  Usage: slapt-src [action] 
  Usage: slapt-src [option(s)] [action] [slackbuild(s)]

  If we place some argument in brackets, we state that this argument can be 
omitted. Than the first variant is obviously is the subset of the second 
variant. So why split it?

* Description of --update is not correct. Can we use --config option along with 
the --update action? It seems that we can, but help message misses this.

* > --config      |-c  - use the specified configuration file
 It is better to mention that correct usage of this option is --config=FILE. 

* > Usage: slapt-src [option(s)] [action] [slackbuild(s)]
 It is not specified which items below are actions and which are options

> > Actions:
> >  -u, --update        update local cache of remote slackbuilds
> 
> I think it is easier to find at a glance to have the long option first.

I don't think that "--update |-u" is a bad variant, but "-u, --update" is more 
common.


-- Igor


More information about the Slapt-get-devel mailing list