[jboss-jira] [JBoss JIRA] (AS7-3992) Improve formatting of command line help

Brian Stansberry (JIRA) jira-events at lists.jboss.org
Tue Aug 28 21:49:14 EDT 2012


    [ https://issues.jboss.org/browse/AS7-3992?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12714424#comment-12714424 ] 

Brian Stansberry commented on AS7-3992:
---------------------------------------

I don't see any reason to mark them as deprecated. We should probably change any docs that say that they are. There's nothing particularly wrong with -b <value>.

BTW, the formatting of the help text tries to limit the width of each line, so taking more width for the key will require some thinking about that.
                
> Improve formatting of command line help
> ---------------------------------------
>
>                 Key: AS7-3992
>                 URL: https://issues.jboss.org/browse/AS7-3992
>             Project: Application Server 7
>          Issue Type: Enhancement
>          Components: Scripts
>    Affects Versions: 7.1.0.Final
>            Reporter: Paul Gier
>            Assignee: Joe Wertz
>
> For command line parameters where there is both a short or a long version of the same option, the short and long version should be comma separated.  This is similar to how many command line tools display help or in man pages.
> Current output:
> {noformat}
>     -h                                  Display this message and exit
>     --help                              Display this message and exit
> {noformat}
> Suggested output:
> {noformat}
>     -h, --help                          Display this message and exit
> {noformat}

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.jboss.org/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        


More information about the jboss-jira mailing list