RFR: 8348515: Add docs for -XX:AOT* options in java man pages [v4]

John R Rose jrose at openjdk.org
Tue Jan 28 00:20:56 UTC 2025


On Mon, 27 Jan 2025 16:58:44 GMT, Ioi Lam <iklam at openjdk.org> wrote:

>> I added docs for the following options added by [JEP 483](https://openjdk.org/jeps/483)
>> 
>> - -XX:AOTCache
>> - -XX:AOTClassLinking
>> - -XX:AOTConfiguration
>> - -XX:AOTMode
>> 
>> For a (semi) rendered version, see https://github.com/iklam/jdk/blob/8348515-docs-for-aot-options/src/java.base/share/man/java.md#ahead-of-time-cache
>> 
>> (Some of the rendering by GitHub looks odd, but the java.1 and java.html pages produced by the build should look fine)
>
> Ioi Lam has updated the pull request incrementally with one additional commit since the last revision:
> 
>   @adinn comment - fixed typo

The command line flag `AOTCache` is well documented, but the use of "AOTCache" as a term of art in narrative text is wrong.  It should be "AOT cache".

For comparison, take any other camel-case flag like `StringTableSize` and ask yourself, would you like to read discussions (in email or man pages) of "the StringTableSize of the VM" or "the string table size of the VM"?  Or, we speak of the `LogFile` command line option, but when we say what it does, it controls the "VM's output log file", not the "VM's output LogFile".

(Oops, you just pushed; sorry about the late feedback.  I still think the change should be made.)

Also, the word "appication" is a typo.

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

PR Comment: https://git.openjdk.org/jdk/pull/23287#issuecomment-2617241243
PR Comment: https://git.openjdk.org/jdk/pull/23287#issuecomment-2617242380
PR Comment: https://git.openjdk.org/jdk/pull/23287#issuecomment-2617244071


More information about the hotspot-runtime-dev mailing list