RFR: 8344540: Remove superseded wildcard description from java manpage [v2]

David Holmes dholmes at openjdk.org
Thu Nov 21 04:46:16 UTC 2024


On Wed, 20 Nov 2024 11:20:38 GMT, Christian Stein <cstein at openjdk.org> wrote:

>> Please review this follow-up PR to improve `java`'s manpage section about wildcards in argument files: the confusing sentence is now removed.
>> 
>> This is a cleanup of commit https://github.com/openjdk/jdk/commit/5cb0d438231383d491b2fcca455d09af7f2ee016
>
> Christian Stein has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Update section as suggested

Can I also suggest some grammatical tweaks to the arg file section:

    The launcher doesn't expand wildcards that are present within an argument
    file. That means, an asterisk  `*` is passed on as-is to the starting VM.

There is an extra space after "asterisk". No comma needed after "means" and the asterisk character should be in parentheses e.g.

    file. That means an asterisk (`*`) is passed on as-is to the starting VM.



    For example `*.java` stays `*.java` and is not expanded to `Foo.java`,
    `Bar.java`, etc. like on some command line shell.

Suggestion

    For example `*.java` stays `*.java` and is not expanded to `Foo.java
    Bar.java ...`,  as would happen with some command line shells.

src/java.base/share/man/java.md line 283:

> 281: message. `@`-files are supported as they are specified in the command line.
> 282: Any wildcard literal `*` in the `JDK_JAVA_OPTIONS` environment variable
> 283: content isn't expanded and is passed as-is to the java launcher. In order to

Suggestion:

content isn't expanded and is passed as-is to the starting VM. In order to

The env var is not passed to the launcher but used by the launcher to set the args for the VM. Using "starting VM" is consistent with what was changed in the arg file section.

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

Changes requested by dholmes (Reviewer).

PR Review: https://git.openjdk.org/jdk/pull/22236#pullrequestreview-2450201052
PR Review Comment: https://git.openjdk.org/jdk/pull/22236#discussion_r1851307007


More information about the core-libs-dev mailing list