RFR: 8340133: Investigate if the java launcher could give hints about JShell [v4]

Kevin Bourrillion duke at openjdk.org
Mon Oct 21 16:10:25 UTC 2024


On Mon, 21 Oct 2024 09:41:50 GMT, Jan Lahoda <jlahoda at openjdk.org> wrote:

>> Currently, running `java` without any parameters will lead to an output that is a full `--help`, which is over 100 lines (on my computer at least), and it feels overwhelming. And many people might actually want to run JShell/REPL, not the `java` launcher, but it is difficult find out about JShell.
>> 
>> The proposal herein is to print a much shorter help, together with a pointer to JShell, when the launcher does not know what to do. I.e. there is nothing specified to start, and no option like `--help` is specified. In particular, on my machine, it prints:
>> 
>> openjdk 24-internal 2025-03-18
>> 
>> Usage: java [java options...] <application> [application arguments...]
>> 
>> Where <application> is one of:
>>   <mainclass>                to execute the main method of a compiled class
>>   -jar <jarfile>.jar         to execute the main class of a JAR archive
>>   -m <module>[/<mainclass>]  to execute the main class of a module
>>   <sourcefile>.java          to compile and execute a source-file program
>> 
>> Where key java options include:
>>   --class-path <class path>
>>       a ":"-separated list of directories and JAR archives to search for class files
>>   --module-path <module path>
>>       a ":"-separated list of directories and JAR archives to search for modules
>> 
>> For more details about this launcher:   java --help
>> For an interactive Java environment:    jshell
>> 
>> 
>> Hopefully, this may be easier both for people trying to run something, and for people that are really looking for JShell.
>> 
>> What do you think?
>> 
>> Thanks!
>
> Jan Lahoda has updated the pull request incrementally with two additional commits since the last revision:
> 
>  - Using lowercase for the keys in the help, using 'source-file' program instead of 'single-file' program.
>  - Using an enum instead of booleans, as suggested.

I agree! A suuuuper nit-pick is we have three spaces between columns at the end, but two spaces between columns seemed like enough above. Sorry :-)

-------------

PR Comment: https://git.openjdk.org/jdk/pull/21411#issuecomment-2427110618


More information about the core-libs-dev mailing list