Skip to content

8346477: Clarify the Java manpage in relation to the JVM's OnOutOfMemoryError flags #22802

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

8346477: Clarify the Java manpage in relation to the JVM's OnOutOfMemoryError flags #22802

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6af2e8
8346477: Clarify the Java manpage in relation to the JVM's OnOutOfMem…
dholmes-ora Dec 18, 2024
3c12483
Refine message based on Thomas's suggestions
dholmes-ora Dec 19, 2024
9a96417
Remove leftover sentence.
dholmes-ora Dec 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions src/java.base/share/man/java.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1292,10 +1292,15 @@ These `java` options control the runtime behavior of the Java HotSpot VM.

`-XX:OnOutOfMemoryError=`*string*
: Sets a custom command or a series of semicolon-separated commands to run
when an `OutOfMemoryError` exception is first thrown. If the string
when an `OutOfMemoryError` exception is first thrown by the JVM.
If the string
contains spaces, then it must be enclosed in quotation marks. For an
example of a command string, see the description of the `-XX:OnError`
option.
This applies only to `OutOfMemoryError` exceptions caused by Java Heap
exhaustion; it does not apply to `OutOfMemoryError` exceptions thrown
directly from Java code, nor by the JVM for other types of resource
exhaustion (such as native thread creation errors).

`-XX:+PrintCommandLineFlags`
: Enables printing of ergonomically selected JVM flags that appeared on the
Expand Down Expand Up @@ -2189,10 +2194,14 @@ perform extensive debugging.
`-XX:+HeapDumpOnOutOfMemoryError`
: Enables the dumping of the Java heap to a file in the current directory by
using the heap profiler (HPROF) when a `java.lang.OutOfMemoryError`
exception is thrown. You can explicitly set the heap dump file path and
exception is thrown by the JVM. You can explicitly set the heap dump file path and
name using the `-XX:HeapDumpPath` option. By default, this option is
disabled and the heap isn't dumped when an `OutOfMemoryError` exception is
thrown.
This applies only to `OutOfMemoryError` exceptions caused by Java Heap
exhaustion; it does not apply to `OutOfMemoryError` exceptions thrown
directly from Java code, nor by the JVM for other types of resource
exhaustion (such as native thread creation errors).

`-XX:HeapDumpPath=`*path*
: Sets the path and file name for writing the heap dump provided by the heap
Expand Down