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

Brian Stansberry (JIRA) jira-events at lists.jboss.org
Wed Aug 29 14:46:33 EDT 2012


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

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

I no longer have a preference for one over the other. At some point long ago I bought into an argument that -b= was better. But after a couple years of using AS7, I haven't seen any particular harm in the old syntax. And people have used the "-b <value>" syntax for a nearly a decade.

If we remove --help coverage of things we actually support, particularly ones that people commonly use, there will almost certainly be usability JIRAs complaining about the missing items.
                
> 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
For more information on JIRA, see: http://www.atlassian.com/software/jira


More information about the jboss-jira mailing list