Merge pull request #1478 from Sreekala-Gopakumar/1477HeapDumpError

Change -XX:[+|-]HeapDumpOnOutOfMemory option name
eclipse-openj9 · Jan 31, 2025 · f9735c7 · f9735c7
2 parents 3551b9f + 819554d
commit f9735c7
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/docs/cmdline_migration.md b/docs/cmdline_migration.md
@@ -52,7 +52,7 @@ You can use the following command-line options in OpenJ9, just as you did in Hot
 | ![Start of content that applies to Java 16 plus](cr/java16plus.png) [`-XX:DiagnoseSyncOnValueBasedClasses=<number>`](xxdiagnosesynconvaluebasedclasses.md) | Configure warnings for value-based classes. |
 | [`-XX:[+|-]DisableExplicitGC`](xxdisableexplicitgc.md)           | Enables or disables explicit `System.gc()` calls. (Alias for [`-Xdisableexplicitgc` / `-Xenableexplicitgc`](xenableexplicitgc.md))                       |
 | [`-XX:[+|-]ExitOnOutOfMemoryError`](xxexitonoutofmemoryerror.md) | Triggers VM shutdown on out-of-memory conditions.                                                                                            |
-| [`-XX:[+|-]HeapDumpOnOutOfMemory`](xxheapdumponoutofmemory.md)   | Enables or disables dumps on out-of-memory conditions.                                                                                          |
+| [`-XX:[+|-]HeapDumpOnOutOfMemoryError`](xxheapdumponoutofmemoryerror.md)   | Enables or disables dumps on out-of-memory conditions.                                                                                          |
 | [`-XX:HeapDumpPath`](xxheapdumppath.md)                          | Specifies a directory for all VM dumps including heap dumps, javacores, and system dumps. (Alias for [`-Xdump:directory`](xdump.md#syntax))  |
 | [`-XX:[+|-]IgnoreUnrecognizedVMOptions`](xxignoreunrecognizedvmoptions.md) | Specifies whether to ignore unrecognized top-level VM options. |                                                                    |
 | [`-XX:InitialHeapSize`](xxinitialheapsize.md)                    | Sets the initial size of the heap. (Alias for [`-Xms`](xms.md))                                                                              |

diff --git a/docs/xxheapdumponoutofmemory.md → docs/xxheapdumponoutofmemoryerror.md b/docs/xxheapdumponoutofmemory.md → docs/xxheapdumponoutofmemoryerror.md
@@ -21,19 +21,19 @@
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 OR GPL-2.0-only WITH OpenJDK-assembly-exception-1.0
 -->
 
-# -XX:\[+|-\]HeapDumpOnOutOfMemory
+# -XX:\[+|-\]HeapDumpOnOutOfMemoryError
 
 This HotSpot option is recognized by Eclipse OpenJ9&trade;. You can use the option to to disable Java&trade;, heap, snap, and system dumps on out-of-memory conditions, which are enabled by default.
 
 ## Syntax
 
-        -XX:[+|-]HeapDumpOnOutOfMemory
+        -XX:[+|-]HeapDumpOnOutOfMemoryError
 
 | Setting                      | Effect  | Default                                                                        |
 |------------------------------|---------|:------------------------------------------------------------------------------:|
-| `-XX:+HeapDumpOnOutOfMemory` | Enable  | :fontawesome-solid-check:{: .yes aria-hidden="true"}<span class="sr-only">yes</span> |
-| `-XX:-HeapDumpOnOutOfMemory` | Disable |                                                                                |
+| `-XX:+HeapDumpOnOutOfMemoryError` | Enable  | :fontawesome-solid-check:{: .yes aria-hidden="true"}<span class="sr-only">yes</span> |
+| `-XX:-HeapDumpOnOutOfMemoryError` | Disable |                                                                                |
 
 
-<!-- ==== END OF TOPIC ==== xxheapdumponoutofmemory.md ==== -->
+<!-- ==== END OF TOPIC ==== xxheapdumponoutofmemoryerror.md ==== -->
 
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -414,7 +414,7 @@ nav:
             - "-XX:[+|-]HandleSIGABRT"                                           : xxhandlesigabrt.md
             - "-XX:[+|-]HandleSIGUSR2"                                           : xxhandlesigusr2.md
             - "-XX:[+|-]HandleSIGXFSZ"                                           : xxhandlesigxfsz.md
-            - "-XX:[+|-]HeapDumpOnOutOfMemory"                                   : xxheapdumponoutofmemory.md
+            - "-XX:[+|-]HeapDumpOnOutOfMemoryError"                              : xxheapdumponoutofmemoryerror.md
             - "-XX:HeapDumpPath"                                                 : xxheapdumppath.md
             - "-XX:[+|-]HeapManagementMXBeanCompatibility"                       : xxheapmanagementmxbeancompatibility.md
             - "-XX:[+|-]IdleTuningCompactOnIdle"                                 : xxidletuningcompactonidle.md