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

classic Classic list List threaded Threaded
7 messages Options
Reply | Threaded
Open this post in threaded view
|

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

Lindenmaier, Goetz
Hi

The tools in jdk should all show the same behavior wrt. help flags.
This change normalizes the help flags of a row of the tools in the jdk.
Java accepts -?, -h and --help, thus I changed the tools to support
these, too.  Some tools exited with '1' after displaying the help message,
I turned this to '0'.

Maybe this is not the right mailing list for this, please advise.

Please review this change. I please need a sponsor.
http://cr.openjdk.java.net/~goetz/wr17/8189102-helpMessage/webrev.01/

In detail, this fixes the help message of the following tools:
jar          -? -h --help;  added -?.
jarsigner    -? -h --help;  added --help. -help accepted but not documented.
javac        -?    --help;  added -?. Removed -help. -h is taken for other purpose
javadoc      -? -h --help;  added -h -?. Removed -help
javap        -? -h --help;  added -h. -help accepted but no more documented.
jcmd         -? -h --help;  added -? --help. -help accepted but no more documented. Changed return value to '0'
jdb          -? -h --help;  added -? -h --help. -help accepted but no more documented.
jdeprscan    -? -h --help;  added -?
jinfo        -? -h --help;  added -? --help. -help accepted but no more documented.
jjs             -h --help;  Replaced -help by --help. Adding more not straight forward.
jps          -? -h --help;  added -? --help. -help accepted but no more documented.
jshell       -? -h --help;  added -?
jstat        -? -h --help;  added -h --help. -help accepted but no more documented.

Best regards,
  Goetz.
Reply | Threaded
Open this post in threaded view
|

Re: RFR(M): 8189102: All tools should support -?, -h and --help

joe darcy
Hi Goetz,

Note that a change like this require a CSR request for the command line
updates and return code modification. The review should also occur on
aliases where the various tools are discussed, for example, javac is
discussed on compiler-dev and several other tools are discussed on
core-libs-dev.

Thanks,

-Joe


On 10/11/2017 1:06 PM, Lindenmaier, Goetz wrote:

> Hi
>
> The tools in jdk should all show the same behavior wrt. help flags.
> This change normalizes the help flags of a row of the tools in the jdk.
> Java accepts -?, -h and --help, thus I changed the tools to support
> these, too.  Some tools exited with '1' after displaying the help message,
> I turned this to '0'.
>
> Maybe this is not the right mailing list for this, please advise.
>
> Please review this change. I please need a sponsor.
> http://cr.openjdk.java.net/~goetz/wr17/8189102-helpMessage/webrev.01/
>
> In detail, this fixes the help message of the following tools:
> jar          -? -h --help;  added -?.
> jarsigner    -? -h --help;  added --help. -help accepted but not documented.
> javac        -?    --help;  added -?. Removed -help. -h is taken for other purpose
> javadoc      -? -h --help;  added -h -?. Removed -help
> javap        -? -h --help;  added -h. -help accepted but no more documented.
> jcmd         -? -h --help;  added -? --help. -help accepted but no more documented. Changed return value to '0'
> jdb          -? -h --help;  added -? -h --help. -help accepted but no more documented.
> jdeprscan    -? -h --help;  added -?
> jinfo        -? -h --help;  added -? --help. -help accepted but no more documented.
> jjs             -h --help;  Replaced -help by --help. Adding more not straight forward.
> jps          -? -h --help;  added -? --help. -help accepted but no more documented.
> jshell       -? -h --help;  added -?
> jstat        -? -h --help;  added -h --help. -help accepted but no more documented.
>
> Best regards,
>    Goetz.

Reply | Threaded
Open this post in threaded view
|

Re: RFR(M): 8189102: All tools should support -?, -h and --help

David Holmes
On 12/10/2017 6:10 AM, joe darcy wrote:
> Hi Goetz,
>
> Note that a change like this require a CSR request for the command line
> updates and return code modification. The review should also occur on
> aliases where the various tools are discussed, for example, javac is
> discussed on compiler-dev and several other tools are discussed on
> core-libs-dev.

And none of the tools/launchers fall under hotspot directly. Some may be
serviceability ...

David

> Thanks,
>
> -Joe
>
>
> On 10/11/2017 1:06 PM, Lindenmaier, Goetz wrote:
>> Hi
>>
>> The tools in jdk should all show the same behavior wrt. help flags.
>> This change normalizes the help flags of a row of the tools in the jdk.
>> Java accepts -?, -h and --help, thus I changed the tools to support
>> these, too.  Some tools exited with '1' after displaying the help
>> message,
>> I turned this to '0'.
>>
>> Maybe this is not the right mailing list for this, please advise.
>>
>> Please review this change. I please need a sponsor.
>> http://cr.openjdk.java.net/~goetz/wr17/8189102-helpMessage/webrev.01/
>>
>> In detail, this fixes the help message of the following tools:
>> jar          -? -h --help;  added -?.
>> jarsigner    -? -h --help;  added --help. -help accepted but not
>> documented.
>> javac        -?    --help;  added -?. Removed -help. -h is taken for
>> other purpose
>> javadoc      -? -h --help;  added -h -?. Removed -help
>> javap        -? -h --help;  added -h. -help accepted but no more
>> documented.
>> jcmd         -? -h --help;  added -? --help. -help accepted but no
>> more documented. Changed return value to '0'
>> jdb          -? -h --help;  added -? -h --help. -help accepted but no
>> more documented.
>> jdeprscan    -? -h --help;  added -?
>> jinfo        -? -h --help;  added -? --help. -help accepted but no
>> more documented.
>> jjs             -h --help;  Replaced -help by --help. Adding more not
>> straight forward.
>> jps          -? -h --help;  added -? --help. -help accepted but no
>> more documented.
>> jshell       -? -h --help;  added -?
>> jstat        -? -h --help;  added -h --help. -help accepted but no
>> more documented.
>>
>> Best regards,
>>    Goetz.
>
Reply | Threaded
Open this post in threaded view
|

Re: RFR(M): 8189102: All tools should support -?, -h and --help

Vladimir Kozlov
In reply to this post by Lindenmaier, Goetz
You missed AOT tool jaotc:

http://hg.openjdk.java.net/jdk10/hs/file/44117bc2bedf/src/jdk.aot/share/classes/jdk.tools.jaotc/src/jdk/tools/jaotc/Options.java#l230

     }, new Option("  --help                     Print this usage message", false, "--help", "-h", "-?") {

Vladimir

On 10/11/17 1:06 PM, Lindenmaier, Goetz wrote:

> Hi
>
> The tools in jdk should all show the same behavior wrt. help flags.
> This change normalizes the help flags of a row of the tools in the jdk.
> Java accepts -?, -h and --help, thus I changed the tools to support
> these, too.  Some tools exited with '1' after displaying the help message,
> I turned this to '0'.
>
> Maybe this is not the right mailing list for this, please advise.
>
> Please review this change. I please need a sponsor.
> http://cr.openjdk.java.net/~goetz/wr17/8189102-helpMessage/webrev.01/
>
> In detail, this fixes the help message of the following tools:
> jar          -? -h --help;  added -?.
> jarsigner    -? -h --help;  added --help. -help accepted but not documented.
> javac        -?    --help;  added -?. Removed -help. -h is taken for other purpose
> javadoc      -? -h --help;  added -h -?. Removed -help
> javap        -? -h --help;  added -h. -help accepted but no more documented.
> jcmd         -? -h --help;  added -? --help. -help accepted but no more documented. Changed return value to '0'
> jdb          -? -h --help;  added -? -h --help. -help accepted but no more documented.
> jdeprscan    -? -h --help;  added -?
> jinfo        -? -h --help;  added -? --help. -help accepted but no more documented.
> jjs             -h --help;  Replaced -help by --help. Adding more not straight forward.
> jps          -? -h --help;  added -? --help. -help accepted but no more documented.
> jshell       -? -h --help;  added -?
> jstat        -? -h --help;  added -h --help. -help accepted but no more documented.
>
> Best regards,
>    Goetz.
>
Reply | Threaded
Open this post in threaded view
|

RE: RFR(M): 8189102: All tools should support -?, -h and --help

Lindenmaier, Goetz
Hi Vladimir,

added that for jaotc, thanks!

Best regards,
  Goetz.

> -----Original Message-----
> From: hotspot-dev [mailto:[hidden email]] On
> Behalf Of Vladimir Kozlov
> Sent: Donnerstag, 12. Oktober 2017 01:04
> To: [hidden email]
> Subject: Re: RFR(M): 8189102: All tools should support -?, -h and --help
>
> You missed AOT tool jaotc:
>
> http://hg.openjdk.java.net/jdk10/hs/file/44117bc2bedf/src/jdk.aot/share/cl
> asses/jdk.tools.jaotc/src/jdk/tools/jaotc/Options.java#l230
>
>      }, new Option("  --help                     Print this usage message", false, "--help",
> "-h", "-?") {
>
> Vladimir
>
> On 10/11/17 1:06 PM, Lindenmaier, Goetz wrote:
> > Hi
> >
> > The tools in jdk should all show the same behavior wrt. help flags.
> > This change normalizes the help flags of a row of the tools in the jdk.
> > Java accepts -?, -h and --help, thus I changed the tools to support
> > these, too.  Some tools exited with '1' after displaying the help message,
> > I turned this to '0'.
> >
> > Maybe this is not the right mailing list for this, please advise.
> >
> > Please review this change. I please need a sponsor.
> > http://cr.openjdk.java.net/~goetz/wr17/8189102-
> helpMessage/webrev.01/
> >
> > In detail, this fixes the help message of the following tools:
> > jar          -? -h --help;  added -?.
> > jarsigner    -? -h --help;  added --help. -help accepted but not documented.
> > javac        -?    --help;  added -?. Removed -help. -h is taken for other
> purpose
> > javadoc      -? -h --help;  added -h -?. Removed -help
> > javap        -? -h --help;  added -h. -help accepted but no more documented.
> > jcmd         -? -h --help;  added -? --help. -help accepted but no more
> documented. Changed return value to '0'
> > jdb          -? -h --help;  added -? -h --help. -help accepted but no more
> documented.
> > jdeprscan    -? -h --help;  added -?
> > jinfo        -? -h --help;  added -? --help. -help accepted but no more
> documented.
> > jjs             -h --help;  Replaced -help by --help. Adding more not straight
> forward.
> > jps          -? -h --help;  added -? --help. -help accepted but no more
> documented.
> > jshell       -? -h --help;  added -?
> > jstat        -? -h --help;  added -h --help. -help accepted but no more
> documented.
> >
> > Best regards,
> >    Goetz.
> >
Reply | Threaded
Open this post in threaded view
|

RE: RFR(M): 8189102: All tools should support -?, -h and --help

Lindenmaier, Goetz
In reply to this post by Lindenmaier, Goetz
Hi,

I prepared a fifth webrev for this change.  Please review.

It incorporates the changes requested by the CSR reviewers
(not to remove docuemtation of '-help' where is was documented
before) and the changes proposed by Kumar:
http://cr.openjdk.java.net/~goetz/wr17/8189102-helpMessage/webrev.05/

See also the information in the webrev  itself, there are also patch files
with the incremental builds.

This change contains fixes for some langtool tests.
I ran the following test suites on it:
hotspot, jdk, langtools, nashorn, jaxp, most of them on
all the platforms we build.

Best regards,
  Goetz.




> -----Original Message-----
> From: Lindenmaier, Goetz
> Sent: Mittwoch, 11. Oktober 2017 22:07
> To: hotspot-dev developers <[hidden email]>
> Subject: RFR(M): 8189102: All tools should support -?, -h and --help
>
> Hi
>
> The tools in jdk should all show the same behavior wrt. help flags.
> This change normalizes the help flags of a row of the tools in the jdk.
> Java accepts -?, -h and --help, thus I changed the tools to support
> these, too.  Some tools exited with '1' after displaying the help message,
> I turned this to '0'.
>
> Maybe this is not the right mailing list for this, please advise.
>
> Please review this change. I please need a sponsor.
> http://cr.openjdk.java.net/~goetz/wr17/8189102-helpMessage/webrev.01/
>
> In detail, this fixes the help message of the following tools:
> jar          -? -h --help;  added -?.
> jarsigner    -? -h --help;  added --help. -help accepted but not documented.
> javac        -?    --help;  added -?. Removed -help. -h is taken for other purpose
> javadoc      -? -h --help;  added -h -?. Removed -help
> javap        -? -h --help;  added -h. -help accepted but no more documented.
> jcmd         -? -h --help;  added -? --help. -help accepted but no more
> documented. Changed return value to '0'
> jdb          -? -h --help;  added -? -h --help. -help accepted but no more
> documented.
> jdeprscan    -? -h --help;  added -?
> jinfo        -? -h --help;  added -? --help. -help accepted but no more
> documented.
> jjs             -h --help;  Replaced -help by --help. Adding more not straight
> forward.
> jps          -? -h --help;  added -? --help. -help accepted but no more
> documented.
> jshell       -? -h --help;  added -?
> jstat        -? -h --help;  added -h --help. -help accepted but no more
> documented.
>
> Best regards,
>   Goetz.
Reply | Threaded
Open this post in threaded view
|

Re: RFR(M): 8189102: All tools should support -?, -h and --help

Vladimir Kozlov
jaotc change is good.

Thanks,
Vladimir

On 12/7/17 2:59 AM, Lindenmaier, Goetz wrote:

> Hi,
>
> I prepared a fifth webrev for this change.  Please review.
>
> It incorporates the changes requested by the CSR reviewers
> (not to remove docuemtation of '-help' where is was documented
> before) and the changes proposed by Kumar:
> http://cr.openjdk.java.net/~goetz/wr17/8189102-helpMessage/webrev.05/
>
> See also the information in the webrev  itself, there are also patch files
> with the incremental builds.
>
> This change contains fixes for some langtool tests.
> I ran the following test suites on it:
> hotspot, jdk, langtools, nashorn, jaxp, most of them on
> all the platforms we build.
>
> Best regards,
>    Goetz.
>
>
>
>
>> -----Original Message-----
>> From: Lindenmaier, Goetz
>> Sent: Mittwoch, 11. Oktober 2017 22:07
>> To: hotspot-dev developers <[hidden email]>
>> Subject: RFR(M): 8189102: All tools should support -?, -h and --help
>>
>> Hi
>>
>> The tools in jdk should all show the same behavior wrt. help flags.
>> This change normalizes the help flags of a row of the tools in the jdk.
>> Java accepts -?, -h and --help, thus I changed the tools to support
>> these, too.  Some tools exited with '1' after displaying the help message,
>> I turned this to '0'.
>>
>> Maybe this is not the right mailing list for this, please advise.
>>
>> Please review this change. I please need a sponsor.
>> http://cr.openjdk.java.net/~goetz/wr17/8189102-helpMessage/webrev.01/
>>
>> In detail, this fixes the help message of the following tools:
>> jar          -? -h --help;  added -?.
>> jarsigner    -? -h --help;  added --help. -help accepted but not documented.
>> javac        -?    --help;  added -?. Removed -help. -h is taken for other purpose
>> javadoc      -? -h --help;  added -h -?. Removed -help
>> javap        -? -h --help;  added -h. -help accepted but no more documented.
>> jcmd         -? -h --help;  added -? --help. -help accepted but no more
>> documented. Changed return value to '0'
>> jdb          -? -h --help;  added -? -h --help. -help accepted but no more
>> documented.
>> jdeprscan    -? -h --help;  added -?
>> jinfo        -? -h --help;  added -? --help. -help accepted but no more
>> documented.
>> jjs             -h --help;  Replaced -help by --help. Adding more not straight
>> forward.
>> jps          -? -h --help;  added -? --help. -help accepted but no more
>> documented.
>> jshell       -? -h --help;  added -?
>> jstat        -? -h --help;  added -h --help. -help accepted but no more
>> documented.
>>
>> Best regards,
>>    Goetz.