[jira] Commented: (CXF-3055) Refining help page for utilities, as well as expanding (adding) switches where necessary

["Robert Liguori (JIRA)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/CXF-3055?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12929195#action_12929195 ] 

Robert Liguori commented on CXF-3055:
-------------------------------------

Apache CXF 2.3.0 Command Usages Documentation and Implementation Analysis
This attached document identifies that there are currently three separately defined usage representations for the Apache CXF tools.  Ideally, all resources should be identical, and the source help (ie. file -h) needs to be accurate.  Also, there is the GNU standard, where if implemented correctly would encourage improvement/refinements to the options (i.e. -h and --help vs. -h and -help).  The GNU standard is listed at the end of each command section in the document to emphasize the importance of using this standard or a similar one in establishing the usage of commands (at least, in my opinion). 


> Refining help page for utilities, as well as expanding (adding) switches where necessary
> ----------------------------------------------------------------------------------------
>
>                 Key: CXF-3055
>                 URL: https://issues.apache.org/jira/browse/CXF-3055
>             Project: CXF
>          Issue Type: Improvement
>          Components: Tooling
>    Affects Versions: 2.3.0
>            Reporter: Robert Liguori
>            Priority: Minor
>   Original Estimate: 4h
>  Remaining Estimate: 4h
>
> Consider "JavaToWS.java" for the java2ws utility...
> -V and -verbose are added in this file as valid switches, however, only -verbose is shown in the java2ws help (java2ws -h).
> Consider adding "-V" to the help page of the java2ws utility.
> Also, consider adding the following (below) to the help and general functionality of scripts (i.e., wsdl2java, wsdl2js, java2js, java2ws, xsd2wsdl, wsdl2java, wsdl2soap, wsdl2corba, wsdl2service, wsdlvalidator), WHERE APPLICABLE:
> -h, -help, --help (see reference below)
> -v, -version, --version
> -V, -verbose
> -q, -quiet
> -cp, -classpath
> Thank you for the consideration.  Note: my comment isn't complete, it needs some more analysis to meet convention.
> Reference: http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces
> Note: subset of current options/switches for java2ws:
> ...
> -h    Display detailed information for options
> -v    Display the version of the tool.
> -verbose    Verbose mode
> -q    Quiet mode
> ...
> Could be something link this:
> ...
> -h, --help    Display detailed information for options
> -v, --version    Display the version of the tool.
> -V, --verbose    Verbose mode
> -q, --quiet    Quiet mode
> ...

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.