RFR: 8340133: Add concise usage message to the java executable [v7]
Alan Bateman
alanb at openjdk.org
Tue Nov 12 14:07:53 UTC 2024
On Mon, 11 Nov 2024 14:23:46 GMT, Alan Bateman <alanb at openjdk.org> wrote:
>> Jan Lahoda has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains 11 additional commits since the last revision:
>>
>> - Merge branch 'master' into JDK-8340133-2
>> - Using correct pplaceholders.
>> - Adjusting text as suggested.
>> - Cleaning up the concise message:
>> - using 2 spaces instead of 4,
>> - rewording the "for more use --help" part of the message as suggested to avoid the word "launcher".
>> - 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.
>> - Adjusting the concise help as suggested: 'using main class of a JAR archive' and '<JarFile>.jar'/'<SourceFile>.java'
>> - Adjusting the concise help based on review suggestions.
>> - Cleanup.
>> - Adjusting/improving the concise help.
>> - ... and 1 more: https://git.openjdk.org/jdk/compare/d7e57952...b4d7b493
>
> src/java.base/share/classes/sun/launcher/resources/launcher.properties line 241:
>
>> 239: \ -jar <jarfile>.jar to execute the main class of a JAR archive\n\
>> 240: \ -m <module>[/<mainclass>] to execute the main class of a module\n\
>> 241: \ <sourcefile>.java to compile and execute a source-file program\n\n\
>
> I'm not sure about the description of <mainclass>. It uses "compiled class", maybe you meant "compiled main class" or something else to connect it "<mainclass>"?
>
> "-jar <jarfile>.jar" may be confusing because the "java -help" uses "-java <jarfile">". I think the usages need to be the same.
> @AlanBateman I'd like to respectfully disagree that this was an improvement. If consistency was the important objection here, maybe it would have been better to update "java -help" to include the .jar?
I assume your disagreement is with Jan's latest update rather than my comment. My comment was just pointing out that it's confusing to use `-jar <jarfile>.jar` in one case and `-jar <jarfile>` in the other.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/21411#discussion_r1838159799
More information about the core-libs-dev
mailing list