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

[Weijun Wang]

Hi Goetz

I would just remove it.

Thanks
Max

> On Nov 22, 2017, at 2:53 PM, Lindenmaier, Goetz <goetz.lindenmaier at sap.com> wrote:
> 
> Hi Max, 
> 
> while removing the comments from the k-tools, I saw this:
> 
> --- a/src/java.security.jgss/windows/classes/sun/security/krb5/internal/tools/Klist.java	Tue Oct 10 14:39:45 2017 +0200
> +++ b/src/java.security.jgss/windows/classes/sun/security/krb5/internal/tools/Klist.java	Tue Nov 21 13:09:17 2017 +0100
> @@ -356,7 +358,6 @@
>         System.out.println("\t-t \t shows keytab entry timestamps");
>         System.out.println("\t-K \t shows keytab entry key value");
>         System.out.println("\t-e \t shows keytab entry key type");
> -        System.out.println("\nUsage: java sun.security.krb5.tools.Klist " +
> -                           "-help for help.");
> +        System.out.println("\n-? -h --help print this help message and exit");
>     }
> }
> 
> I don't think the old comment is in the original program :) and anyways, -help
> is not supported by Klist.  It prints the usage called with the flag, but just because
> it prints it on any wrong flag.
> 
> So should I replace the comment here?
> Or at least remove it?
> 
> Best regards,
>  Goetz
> 
>> -----Original Message-----
>> From: Weijun Wang [mailto:weijun.wang at oracle.com]
>> Sent: Monday, November 20, 2017 3:49 PM
>> 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
>> 
>> Hi Goetz
>> 
>> I understand your intention.
>> 
>> If the reason is that one day every tool will switch to this new style, please at
>> least do not include kinit, klist and ktab. These Windows-only commands are
>> meant to emulate MIT krb5 tools with the same names and we need to keep
>> the option (and maybe the help screen) as similar as possible.
>> 
>> I am OK with supporting the --help option undocumented.
>> 
>> Thanks
>> Max
>> 
>>> On Nov 20, 2017, at 9:46 PM, Lindenmaier, Goetz
>> <goetz.lindenmaier at sap.com> wrote:
>>> 
>>> Hi Max,
>>> 
>>> I think there are so many tools mixing both kinds of
>>> options, that it's rather a gain if all at least document
>>> the same, up to date help message, than if the documentation
>>> is skipped for some.
>>> 
>>> After my change, all the help messages are quite similar.
>>> I updated them to use the same wording while trying to
>>> keep the sentence structure in accordance with the other
>>> documented flags, see below.
>>> 
>>> Best regards,
>>> Goetz.
>>> 
>>> 
>>> 
>>> -? -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: Weijun Wang [mailto:weijun.wang at oracle.com]
>>>> Sent: Sonntag, 19. November 2017 01:28
>>>> 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
>>>> 
>>>> I am OK with all commands supporting --help, but I am not sure if every
>> tool
>>>> should show it on the help screen if the tools's other options are still using
>>>> the old single-"-" style. It looks like the tools are half-converted.
>>>> 
>>>> Is there a timetable to add "--" support to all tools?
>>>> 
>>>> Thanks
>>>> Max
>>>> 
>>>>> On Nov 17, 2017, at 7:23 PM, 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.
>>>>> 
>>> 
>