RFR: 8189102: All tools should support -?, -h and --help

Lindenmaier, Goetz goetz.lindenmaier at sap.com
Mon Nov 20 11:57:11 UTC 2017


Hi Robert, 

thanks for looking at my change.

I'm fine with listing the flags in a different order, but 
it's ambiguous. Java itslef lists "-? -h --help" therefore
I chose this for most of the tools, too.
But just tell me how to put it.
Below, I list all the option help messages for the 
tools on linux. --help-extra is quite consistent.

Best regards,
  Goetz.
  
  
 --help-extra, -X             Print help on extra options
 --help-extra, -X
 --help-extra, -X      Print help on non-standard options and exit
 -X                   print help on extra options to the output stream
 --help-extra  print help on extra options to the output stream
 --help-extra                         Print help on extra options           
 --help-extra           Give help on extra options


-? -h --help               display this help message
-? -h --help              display this help message
-h, --help (Print this help message.)
-?, --help                   Print this help message
-? -h --help                 Print this help message
--help, -h, -?  Display command line options and exit
-? -h --help                     Print this help message
-h -? --help                  Print this help message
-? -h --help
-? -h --help          : display this help message and exit
-? -h --help       :  display this help message and exit
-? -h --help      print this help message and exit
-? | -h | --help     to print this help message
jmap -? -h --help  to print this help message
usage: jps [-? -h --help]
-? -h --help to print this help message
-? -h --help  Prints this help message.
-? -h --help print this help message
-? -h --help          Print this synopsis of standard options and exit
Use "keytool -? -h or --help" for all available commands
--help        print this help message to the output stream
-?, -h, --help                       Print this help message
-h, --help, -?                        Print this help message
-?, -h, --help                       Print this help message
-? -h --help         Print this help message and exit
-?, -h, --help                  print this help message
-?, -h, --help                print this help message
-? -h --help           Print this help message
-?, -h, --help[:compat]    Give this, or optionally the compatibility, help
[-? -h --help]              Print this help message
jstatd -?|-h|--help


> -----Original Message-----
> From: Robert Field [mailto:robert.field at oracle.com]
> Sent: Freitag, 17. November 2017 20:07
> To: Lindenmaier, Goetz <goetz.lindenmaier at sap.com>
> Cc: core-libs-dev at openjdk.java.net; compiler-dev at openjdk.java.net;
> serviceability-dev (serviceability-dev at openjdk.java.net) <serviceability-
> dev at openjdk.java.net>
> Subject: Re: RFR: 8189102: All tools should support -?, -h and --help
> 
> JShell changes —
> 
> The code change is fine.
> 
> The help change in the properties file is not consistent with the other items,
> note:        --help-extra, -X      Print help on…
>       so this should be:      —help, -h, -?
> Or, if there is a tool-wide standard, then the —help-extra entry should be
> changed.
> 
> The tests of “—help” should be updated to include the now documented “-
> h” and “-?”
> 
> As Jon noted, the _ja and _zh_CN properties should not be touched.
> 
> -Robert
> 
> > On Nov 17, 2017, at 3:23 AM, Lindenmaier, Goetz
> <goetz.lindenmaier at sap.com> wrote:
> >
> > Hi,
> >
> > please review this change. I also filed a CSR for this:
> > http://cr.openjdk.java.net/~goetz/wr17/8189102-
> helpMessage/webrev.02/
> > Bug: https://bugs.openjdk.java.net/browse/JDK-8189102
> > CSR: https://bugs.openjdk.java.net/browse/JDK-8191477
> >
> > See the webrev for a detailed description of the changes.
> >
> > If required, I'll make break-out changes to be reviewed separately.
> >
> > I had posted a RFR before, but improved the change to
> > give a more complete overview of currently supported flags
> > for the CSR:
> > http://mail.openjdk.java.net/pipermail/hotspot-dev/2017-
> October/028615.html
> >
> > Best regards,
> >  Goetz.
> >



More information about the serviceability-dev mailing list