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

Brian Stansberry (JIRA) jira-events at lists.jboss.org
Wed Aug 29 16:28:32 EDT 2012


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

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

+1 on space option first, and I say put --properties on the first line, either by widening or stealing 2 chars from the whitespace on the left.

BTW, the jreadline project's Terminal class lets you read the terminal width, thus allowing greater formatting flexibility. But I'm quite leery of adding that dependency to the process-controller module. It would only be used with --help, and the process exits after that completes so it's probably not a problem to add the dependency, but I'm still leery of doing it.
                
> 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