[jboss-jira] [JBoss JIRA] (AS7-3992) Improve formatting of command line help
Paul Gier (JIRA)
jira-events at lists.jboss.org
Wed Aug 29 14:38:33 EDT 2012
[ https://issues.jboss.org/browse/AS7-3992?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12714683#comment-12714683 ]
Paul Gier commented on AS7-3992:
--------------------------------
{quote}I don't see any reason to mark them as deprecated.{quote}
Isn't one syntax preferred over the other? It seems like we should just pick either with or without the "=" as the recommended syntax, and only list this preferred syntax in the help to make it simpler. The other syntax would still be supported for compatibility, but just not listed in the standard help message if there is no reason to use it other than backwards compatibility.
> 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