Document OpenJDK memory size configuration

Glyn Normington · Glyn Normington · commit fb75d64cc43e · 2013-06-24T11:31:08.000+01:00
[#52140727]
diff --git a/docs/container-java-main.md b/docs/container-java-main.md
@@ -3,10 +3,10 @@ The Java Main Class Container allows applications that provide a class with a `m
 
 <table>
   <tr>
-    <td><strong>Detection Criteria:</strong></td><td><tt>Main-Class</tt> attribute set in <tt>META-INF/MANIFEST.MF</tt> or <tt>java_main_class</tt> set</td>
+    <td><strong>Detection Criteria</strong></td><td><tt>Main-Class</tt> attribute set in <tt>META-INF/MANIFEST.MF</tt> or <tt>java_main_class</tt> set</td>
   </tr>
   <tr>
-    <td><strong>Tags:</strong></td><td><tt>java-main</tt></td>
+    <td><strong>Tags</strong></td><td><tt>java-main</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/container-tomcat.md b/docs/container-tomcat.md
@@ -3,10 +3,10 @@ The Tomcat Container allows web application to be run.  These applications are r
 
 <table>
   <tr>
-    <td><strong>Detection Criterion:</strong></td><td>Existence of a <tt>WEB-INF/</tt> folder in the application directory</td>
+    <td><strong>Detection Criterion</strong></td><td>Existence of a <tt>WEB-INF/</tt> folder in the application directory</td>
   </tr>
   <tr>
-    <td><strong>Tags:</strong></td><td><tt>tomcat-&lang;version&rang;</tt></td>
+    <td><strong>Tags</strong></td><td><tt>tomcat-&lang;version&rang;</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/framework-java_opts.md b/docs/framework-java_opts.md
@@ -3,10 +3,10 @@ The `JAVA_OPTS` Framework contributes arbitrary Java options to the application
 	
 <table>
   <tr>
-    <td><strong>Detection Criterion:</strong></td><td><ptt>java_opts</tt> set</td>
+    <td><strong>Detection Criterion</strong></td><td><ptt>java_opts</tt> set</td>
   </tr>
   <tr>
-    <td><strong>Tags:</strong></td><td><tt>java-opts</tt></td>
+    <td><strong>Tags</strong></td><td><tt>java-opts</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
diff --git a/docs/jre-openjdk.md b/docs/jre-openjdk.md
@@ -6,10 +6,10 @@ The OpenJDK JRE provides Java runtimes from the [OpenJDK][openjdk] project.  Ver
 
 <table>
   <tr>
-    <td><strong>Detection Criterion:</strong></td><td>Unconditional</td>
+    <td><strong>Detection Criterion</strong></td><td>Unconditional</td>
   </tr>
   <tr>
-    <td><strong>Tags:</strong></td><td><tt>openjdk-&lang;version&rang;</tt></td>
+    <td><strong>Tags</strong></td><td><tt>openjdk-&lang;version&rang;</tt></td>
   </tr>
 </table>
 Tags are printed to standard output by the buildpack detect script
@@ -29,21 +29,19 @@ The JRE can be configured by modifying the [`config/openjdk.yml`][openjdk_yml] f
 
 ### Memory
 
+The following properties may be specified in [`config/openjdk.yml`][openjdk_yml].
+
 | Name | Description
 | ---- | -----------
-| `java.heap.size` | The Java maximum heap size to use. For example, a value of `64m` will result in the java command line option `-Xmx64m`. Values containing whitespace are rejected with an error, but all others values appear without modification on the java command line appended to `-Xmx`.
-| `java.metaspace.size` | The Java maximum Metaspace size to use. This is applicable to versions of OpenJDK from 1.8 onwards. For example, a value of `128m` will result in the java command line option `-XX:MaxMetaspaceSize=128m`. Values containing whitespace are rejected with an error, but all others values appear without modification on the java command line appended to `-XX:MaxMetaspaceSize=`.
-| `java.permgen.size` | The Java maximum PermGen size to use. This is applicable to versions of OpenJDK earlier than 1.8. For example, a value of `128m` will result in the java command line option `-XX:MaxPermSize=128m`. Values containing whitespace are rejected with an error, but all others values appear without modification on the java command line appended to `-XX:MaxPermSize=`.
-| `java.stack.size` | The Java stack size to use. For example, a value of `256k` will result in the java command line option `-Xss256k`. Values containing whitespace are rejected with an error, but all others values appear without modification on the java command line appended to `-Xss`.
+| `heap` | The Java maximum heap size to use. For example, a value of `64m` will result in the java command line option `-Xmx64m`. Values containing whitespace are rejected with an error, but all others values appear without modification on the java command line appended to `-Xmx`.
+| `metaspace` | The Java maximum Metaspace size to use. This is applicable to versions of OpenJDK from 1.8 onwards. For example, a value of `128m` will result in the java command line option `-XX:MaxMetaspaceSize=128m`. Values containing whitespace are rejected with an error, but all others values appear without modification on the java command line appended to `-XX:MaxMetaspaceSize=`.
+| `permgen` | The Java maximum PermGen size to use. This is applicable to versions of OpenJDK earlier than 1.8. For example, a value of `128m` will result in the java command line option `-XX:MaxPermSize=128m`. Values containing whitespace are rejected with an error, but all others values appear without modification on the java command line appended to `-XX:MaxPermSize=`.
+| `stack` | The Java stack size to use. For example, a value of `256k` will result in the java command line option `-Xss256k`. Values containing whitespace are rejected with an error, but all others values appear without modification on the java command line appended to `-Xss`.
 
 #### Default Memory Sizes
 
 If some memory sizes are not specified using the above properties, default values are provided. For maximum heap, Metaspace, or PermGen size, the default value is based on a proportion of the total memory specified when the application was pushed. For stack size, the default value is one megabyte.
 
 If any memory sizes are specified which are not equal to the default value, the proportionate defaults are adjusted accordingly. The default stack size is never adjusted from the default value.
 
-#### OpenJDK Memory Heuristics
-
-The calculation of default memory sizes for OpenJDK is configured via YAML files in the buildpack's `config` directory.
-
-The configuration contains a weighting between `0` and `1` corresponding to a proportion of the total memory specified when the application was pushed. The weightings should add up to `1`.
+The default memory size proportions are configured in the `memory_heuristics` section of [`config/openjdk.yml`][openjdk_yml]. Each memory size is given a weighting between `0` and `1` corresponding to a proportion of the total memory specified when the application was pushed. The weightings should add up to `1`.
