From d920d76f22d3d1d6f7af638f2159c633e907f2b7 Mon Sep 17 00:00:00 2001 From: Ben Hale Date: Thu, 20 Nov 2014 16:16:17 +0000 Subject: [PATCH] Polishing This change polishes up the submitted documentation. --- docs/framework-java_opts.md | 45 +++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/docs/framework-java_opts.md b/docs/framework-java_opts.md index 3f3602e80c..02e8237761 100644 --- a/docs/framework-java_opts.md +++ b/docs/framework-java_opts.md @@ -23,9 +23,9 @@ The framework can be configured by creating or modifying the [`config/java_opts. | Name | Description | ---- | ----------- | `from_environment` | Whether to append the value of the `JAVA_OPTS` environment variable to the collection of Java options -| `java_opts` | The Java options to use when running the application. All values are used without modification when invoking the JVM. The options are specified as a single YAML scalar in plain style or enclosed in single or double quotes. +| `java_opts` | The Java options to use when running the application. All values are used without modification when invoking the JVM. The options are specified as a single YAML scalar in plain style or enclosed in single or double quotes. -Any `JAVA_OPTS` from either the config file or environment variables that configure memory options will cause deployment to fail as they're not allowed. Memory options are configured by the buildpack and may not be modified. +Any `JAVA_OPTS` from either the config file or environment variables that configure memory options will cause deployment to fail as they're not allowed. Memory options are configured by the buildpack and may not be modified. ## Example ```yaml @@ -53,25 +53,26 @@ Setting any of the allowed memory settings may require a change to the [Memory W | Argument| Description | ------- | ----------- -| `-Xmn size` | The size of the heap for the young generation objects, known as the eden region. This could effect the total heap size [Memory Weightings]. -| `-XX:MaxDirectMemorySize=64m` | Upper limit on the maximum amount of allocatable direct buffer memory. This could effect the [Memory Weightings]. -| `-XX:+UseGCOverheadLimit` | Use a policy that limits the proportion of the VM's time that is spent in GC before an OutOfMemory error is thrown. Performance Options. -| `-XX:HeapDumpPath=./java_pid.hprof` | Path to directory or filename for heap dump. Manageable. -| `-XX:-HeapDumpOnOutOfMemoryError` | Dump heap to file when java.lang.OutOfMemoryError is thrown. Manageable. -| `-XX:OnError=";"` | Run user-defined commands on fatal error. -| `-XX:OnOutOfMemoryError=";"` | Run user-defined commands when an OutOfMemoryError is first thrown. -| `-XX:+UseLargePages` | Use large page memory. For details, see Java Support for Large Memory Pages. Debugging Options -| `-XX:LargePageSizeInBytes=4m` | Sets the large page size used for the Java heap. -| `-XX:MaxHeapFreeRatio=70` | Maximum percentage of heap free after GC to avoid shrinking. -| `-XX:MaxNewSize=size` | Maximum size of new generation (in bytes). Since 1.4, MaxNewSize is computed as a function of NewRatio. This could effect the total heap size [Memory Weightings]. -| `-XX:MinHeapFreeRatio=40` | Minimum percentage of heap free after GC to avoid expansion. -| `-XX:NewRatio=2` | Ratio of old/new generation heap sizes. 2 is equal to approximately 66%. -| `-XX:NewSize=2m` | Default size of new generation heap region (in bytes). This could effect the total heap size [Memory Weightings]. -| `-XX:ReservedCodeCacheSize=32m (aka -Xmaxjitcodesize)` - Java 8 Only | Reserved code cache size (in bytes) - maximum code cache size. This could effect the [Memory Weightings]. -| `-XX:SurvivorRatio=8` | Ratio of eden/survivor space size. Solaris only. -| `-XX:TargetSurvivorRatio=50` | Desired percentage of survivor space used after scavenge. -| `-XX:ThreadStackSize=512` | Thread Stack Size (in Kbytes). (0 means use default stack size) +| `-Xmn ` | Maximum size of young generation, known as the eden region. **This could effect the total heap size [Memory Weightings].** +| `-XX:+UseGCOverheadLimit` | Use a policy that limits the proportion of the VM's time that is spent in GC before an `java.lang.OutOfMemoryError` error is thrown. +| `-XX:+UseLargePages` | Use large page memory. For details, see [Java Support for Large Memory Pages]. +| `-XX:-HeapDumpOnOutOfMemoryError` | Dump heap to file when `java.lang.OutOfMemoryError` is thrown. +| `-XX:HeapDumpPath=` | Path to directory or filename for heap dump. +| `-XX:LargePageSizeInBytes=` | Sets the large page size used for the Java heap. +| `-XX:MaxDirectMemorySize=` | Upper limit on the maximum amount of allocatable direct buffer memory. **This could effect the [Memory Weightings].** +| `-XX:MaxHeapFreeRatio=` | Maximum percentage of heap free after GC to avoid shrinking. +| `-XX:MaxNewSize=` | Maximum size of new generation. Since `1.4`, `MaxNewSize` is computed as a function of `NewRatio`. **This could effect the total heap size [Memory Weightings].** +| `-XX:MinHeapFreeRatio=` | Minimum percentage of heap free after GC to avoid expansion. +| `-XX:NewRatio=` | Ratio of old/new generation sizes. 2 is equal to approximately 66%. +| `-XX:NewSize=` | Default size of new generation. **This could effect the total heap size [Memory Weightings].** +| `-XX:OnError=";"` | Run user-defined commands on fatal error. +| `-XX:OnOutOfMemoryError=";"` | Run user-defined commands when an `java.lang.OutOfMemoryError` is first thrown. +| `-XX:ReservedCodeCacheSize=` | _Java 8 Only_ Maximum code cache size. Also know as `-Xmaxjitcodesize`. **This could effect the [Memory Weightings].** +| `-XX:SurvivorRatio=` | Ratio of eden/survivor space. Solaris only. +| `-XX:TargetSurvivorRatio=` | Desired ratio of survivor space used after scavenge. +| `-XX:ThreadStackSize=` | Thread stack size. (0 means use default stack size). -[Memory Weightings]: jre-open_jdk_jre.md#memory-weightings -[Configuration and Extension]: ../README.md#configuration-and-extension [`config/java_opts.yml`]: ../config/java_opts.yml +[Configuration and Extension]: ../README.md#configuration-and-extension +[Java Support for Large Memory Pages]: http://www.oracle.com/technetwork/java/javase/tech/largememory-jsp-137182.html +[Memory Weightings]: jre-open_jdk_jre.md#memory-weightings