8348890: Fix docs for -XX:AOT* options in java man page

[iklam]

Some problems in the -XX:AOT* docs are found after JDK-8348515 was integrated. See @rose00 comments in #23287

• The default of AOTClassLinking is incorrect
• "AOTCache" should be changed to "AOT cache" in the descriptive text
• There are some typos

Rendered text:

• https://github.com/iklam/jdk/blob/8348890-fix-xx-aot-docs-in-man-page/src/java.base/share/man/java.md#ahead-of-time-cache

---

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-8348890: Fix docs for -XX:AOT* options in java man page (Bug - P4)

Reviewers

• John R Rose (@rose00 - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 23343

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[iklam]

/label hotspot-runtime

[bridgekeeper]

👋 Welcome back iklam! 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]

@iklam 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:

8348890: Fix docs for -XX:AOT* options in java man page

Reviewed-by: jrose

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 42 new commits pushed to the master branch:

• d589a82: 8349101: Problemlist HeadlessMalfunctionTest.java
• f05c53c: 8347949: Currency method to stream available Currencies
• cc775b1: 8348648: Unnecessary Hashtable usage in javax.swing.text.html.CSS.LengthUnit
• 06ebb17: 8349002: GenShen: Deadlock during shutdown
• 1ac2d6e: 8349009: JVM fails to start when AOTClassLinking is used with unverifiable old classes
• 0cae888: 8349003: NativeCallStack::print_on() output is unreadable
• fdfb68c: 8344168: Change Unsafe base offset from int to long
• 5d5b294: 8349070: Fix riscv and ppc build errors caused by JDK-8343767
• 3f8a875: 8348880: Replace ConcurrentMap with AtomicReferenceArray for ZoneOffset.QUARTER_CACHE
• fac63d4: 8348668: Prevent first resource cleanup in confined arena from escaping
• ... and 32 more: https://git.openjdk.org/jdk/compare/9f4d3de442a846c503dac52de4a757e5b5638e73...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]

@iklam
The hotspot-runtime label was successfully added.

[mlbridge]

Webrevs

• 01: Full - Incremental (0f189a50)
• 00: Full (e4d2a9a9)

[rose00]

s/Cache/cache/ here also

[iklam]

Fixed.

[rose00]

of the following
+application configuration options/data/states/conditions:

(Or something specific like that.)

[iklam]

Actually the AOT cache is more permissive with changes in command-line arguments. However, the three items below are absolute requirements that must be met. That's why I discuss the command-line option compatibility in the "loading of an AOT cache can fail for a number of reasons ..." section below. See the rendered text in https://github.com/iklam/jdk/blob/8348890-fix-xx-aot-docs-in-man-page/src/java.base/share/man/java.md#ahead-of-time-cache

[rose00]

Maybe add "The main class may be changed."

[iklam]

You can change the main class or parameters to the application and will still be able to use the cache, although if you execute new code that was cover during the training run then you will have less benefit from the cache.

[iklam]

Thanks @rose00 for the review
/integrate

[openjdk]

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

• 8986cb2: 8331873: Improve/expand info in New API In on Help page
• d589a82: 8349101: Problemlist HeadlessMalfunctionTest.java
• f05c53c: 8347949: Currency method to stream available Currencies
• cc775b1: 8348648: Unnecessary Hashtable usage in javax.swing.text.html.CSS.LengthUnit
• 06ebb17: 8349002: GenShen: Deadlock during shutdown
• 1ac2d6e: 8349009: JVM fails to start when AOTClassLinking is used with unverifiable old classes
• 0cae888: 8349003: NativeCallStack::print_on() output is unreadable
• fdfb68c: 8344168: Change Unsafe base offset from int to long
• 5d5b294: 8349070: Fix riscv and ppc build errors caused by JDK-8343767
• 3f8a875: 8348880: Replace ConcurrentMap with AtomicReferenceArray for ZoneOffset.QUARTER_CACHE
• ... and 33 more: https://git.openjdk.org/jdk/compare/9f4d3de442a846c503dac52de4a757e5b5638e73...master

Your commit was automatically rebased without conflicts.

[openjdk]

@iklam Pushed as commit cdc84ac.

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