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

[Joe Wertz (JIRA)]

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

Joe Wertz edited comment on AS7-3992 at 8/31/12 5:50 AM:
---------------------------------------------------------

Come to find out, we do actually have a case where we need to either expand the width or do something else.

There are currently 3 versions of the 'Set domain config file' command. They're just not all next to each other so it slipped under the radar. 

{noformat}
    -c <config>                        Name of the domain configuration file 
                                       to use (default is "domain.xml")

    -c=<config>                        Name of the domain configuration file 
                                       to use (default is "domain.xml")

    --domain-config=<config>           Name of the domain configuration file 
                                       to use (default is "domain.xml")
{noformat}


I figured out a way to handle multiple-lines on the command side of the output and for comparison handled it this way. I'm not sure what standard-practice is for this scenario though. I've never actually seen it anywhere.

{noformat}
    -c <config>, -c=<config>,           Name of the domain configuration file 
         --domain-config=<config>       to use (default is "domain.xml")
{noformat}

Thoughts?

Edit: Grrr, meant to include this bit. If we extend the width to accommodate this case on a single line, the total would become 95 characters. I think that's on the edge of being too large. For perspective, the jboss-cli help uses 120, which I do think is too large even on my large rez screen.
                
      was (Author: Gonthim):
    Come to find out, we do actually have a case where we need to either expand the width or do something else.

There are currently 3 versions of the 'Set domain config file' command. They're just not all next to each other so it slipped under the radar. 

{noformat}
    -c <config>                        Name of the domain configuration file 
                                       to use (default is "domain.xml")

    -c=<config>                        Name of the domain configuration file 
                                       to use (default is "domain.xml")

    --domain-config=<config>           Name of the domain configuration file 
                                       to use (default is "domain.xml")
{noformat}


I figured out a way to handle multiple-lines on the command side of the output and for comparison handled it this way. I'm not sure what standard-practice is for this scenario though. I've never actually seen it anywhere.

{noformat}
    -c <config>, -c=<config>,           Name of the domain configuration file 
         --domain-config=<config>       to use (default is "domain.xml")
{noformat}

Thoughts?
                  
> 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