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

Paul Gier (JIRA) jira-events at lists.jboss.org
Wed Aug 29 15:40:32 EDT 2012


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

Paul Gier commented on AS7-3992:
--------------------------------

{quote}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.{quote}
Ok, in that case I agree with the suggested format for putting them on a single line, with the space option before the equals option, just because using a space for option arguments seems to be a more common convention in command line tools.
{noformat}
    -b <value>, -b=<value>              Set system property jboss.bind.address
                                        to the given value
{noformat}
The only combined option I see which might be longer than the current space is the "-P <url>" option.  I'm ok with either making the space a little larger, or keeping that option on multiple lines.
{noformat}
    -P <url>, -P=<url>                  Load system properties from the given 
                                        url

    --properties=<url>                  Load system properties from the given 
                                        url
{noformat}

                
> 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