Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8293040: Argfile documentation for java launcher tool is confusing regarding usage of wildcards #22208

Closed

Conversation

sormuras
Copy link
Member

@sormuras sormuras commented Nov 18, 2024

Please review this improvement to the manual page covering the usage of wildcards in java's argfiles.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8293040: Argfile documentation for java launcher tool is confusing regarding usage of wildcards (Task - P4)

Reviewers

Reviewers without OpenJDK IDs

  • @wkorando (no known openjdk.org user name / role)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/22208/head:pull/22208
$ git checkout pull/22208

Update a local copy of the PR:
$ git checkout pull/22208
$ git pull https://git.openjdk.org/jdk.git pull/22208/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 22208

View PR using the GUI difftool:
$ git pr show -t 22208

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/22208.diff

Using Webrev

Link to Webrev Comment

Sorry, something went wrong.

…garding usage of wildcards

Improve the documentation covering the usage of wildcards in `java `'s argfiles.
@bridgekeeper
Copy link

bridgekeeper bot commented Nov 18, 2024

👋 Welcome back cstein! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented Nov 18, 2024

@sormuras This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8293040: Argfile documentation for java launcher tool is confusing regarding usage of wildcards

Reviewed-by: liach

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 15 new commits pushed to the master branch:

  • f636674: 8344247: Move objectWaiter field to VirtualThread instance
  • de6e013: 8344310: Remove Security Manager dependencies from javax.crypto and com.sun.crypto packages
  • 92271af: 8344058: Remove doPrivileged calls from macos platform sources in the java.desktop module
  • 70eb95f: 8344187: Remove SecurityManager and related calls from java.instrument
  • 922b12f: 8344078: Remove security manager dependency in java.nio
  • 2649406: 8344352: 32-bit builds crash after JDK-8305895
  • e9e4200: 8343125: Correct the documentation for TreeMap's getFloorEntry and getCeilingEntry
  • c59adf6: 8344330: Remove AccessController.doPrivileged() from jdk.charsets module
  • c4e7dc7: 8344389: 32-bit builds fail at CDS build time after JDK-8331497
  • d76b5b8: 8344253: Test java/util/Spliterator/SpliteratorTraversingAndSplittingTest.java failed
  • ... and 5 more: https://git.openjdk.org/jdk/compare/dfddbcaab886b9baa731cd748bb7f547e1903b64...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the rfr Pull request is ready for review label Nov 18, 2024
@openjdk
Copy link

openjdk bot commented Nov 18, 2024

@sormuras To determine the appropriate audience for reviewing this pull request, one or more labels corresponding to different subsystems will normally be applied automatically. However, no automatic labelling rule matches the changes in this pull request. In order to have an "RFR" email sent to the correct mailing list, you will need to add one or more applicable labels manually using the /label pull request command.

Applicable Labels
  • build
  • client
  • compiler
  • core-libs
  • graal
  • hotspot
  • hotspot-compiler
  • hotspot-gc
  • hotspot-jfr
  • hotspot-runtime
  • i18n
  • ide-support
  • javadoc
  • jdk
  • jmx
  • kulla
  • net
  • nio
  • security
  • serviceability
  • shenandoah

@sormuras
Copy link
Member Author

/label core-libs

@openjdk openjdk bot added the core-libs core-libs-dev@openjdk.org label Nov 18, 2024
@openjdk
Copy link

openjdk bot commented Nov 18, 2024

@sormuras
The core-libs label was successfully added.

@mlbridge
Copy link

mlbridge bot commented Nov 18, 2024

Webrevs

Copy link
Member

@liach liach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A straightforward example. Don't know which area this belongs to exactly, though.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 18, 2024
@sormuras
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Nov 18, 2024

Going to push as commit 5cb0d43.
Since your change was applied there have been 16 commits pushed to the master branch:

  • 8d43e0d: 8344331: SM cleanup in java.scripting
  • f636674: 8344247: Move objectWaiter field to VirtualThread instance
  • de6e013: 8344310: Remove Security Manager dependencies from javax.crypto and com.sun.crypto packages
  • 92271af: 8344058: Remove doPrivileged calls from macos platform sources in the java.desktop module
  • 70eb95f: 8344187: Remove SecurityManager and related calls from java.instrument
  • 922b12f: 8344078: Remove security manager dependency in java.nio
  • 2649406: 8344352: 32-bit builds crash after JDK-8305895
  • e9e4200: 8343125: Correct the documentation for TreeMap's getFloorEntry and getCeilingEntry
  • c59adf6: 8344330: Remove AccessController.doPrivileged() from jdk.charsets module
  • c4e7dc7: 8344389: 32-bit builds fail at CDS build time after JDK-8331497
  • ... and 6 more: https://git.openjdk.org/jdk/compare/dfddbcaab886b9baa731cd748bb7f547e1903b64...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Nov 18, 2024
@openjdk openjdk bot closed this Nov 18, 2024
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 18, 2024
@openjdk
Copy link

openjdk bot commented Nov 18, 2024

@sormuras Pushed as commit 5cb0d43.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

@jaikiran
Copy link
Member

Hello Christian, one part of the confusion noted in that linked issue https://bugs.openjdk.org/browse/JDK-8293040 is:

Wildcards (*) aren't allowed in these lists (such as specifying *.java).

is noted in the section which describes the contents of the argument files for java. As noted in the issue, this sentence doesn't appear to be conveying the right meaning because wildcard literal like -Xlog:gc*=info,heap*=info I believe is allowed in those files.

I see that the changes in this PR didn't address that sentence. Was that intentional?

@sormuras
Copy link
Member Author

No, that was an oversight. Good catch!

I will remove that sentence (second last bullet point) in favor of the augmented one (third bullet point) of this PR.

@sormuras sormuras deleted the JDK-8293040-java-manpage-wildcards branch November 19, 2024 06:09
Comment on lines +3076 to 3079
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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This expansion now seems to be in conflict with the later statement:

Wildcards (*) aren't allowed in these lists (such as specifying *.java).

?? To be honest I'm not sure what that later statement is actually trying to say.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Never mind I see now this was already flagged.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that sentence was trying to convey that the "wildcard literal * will be treated literally and the launcher will not attempt to expand it". I think this sentence can be removed altogether, given that this semantic is already explained a few sentences above by the change in this PR.

@sormuras
Copy link
Member Author

[...] I think this sentence can be removed altogether, given that this semantic is already explained a few sentences above by the change in this PR.

Filed #22236 to removed the sentence.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

None yet

5 participants