From d8eeba98e8bf22e2e3cd0b75ccd32326a433b114 Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Wed, 28 May 2014 12:10:57 +0100 Subject: [PATCH] Add JAVA_OPTS advice to some docs --- README.adoc | 5 ++++- .../src/main/asciidoc/using-spring-boot.adoc | 13 +++++++++++-- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/README.adoc b/README.adoc index 5a7594a3bd..bd710a2808 100644 --- a/README.adoc +++ b/README.adoc @@ -101,7 +101,10 @@ v3.0.5 or above. You also need JDK 1.7 (although Boot applications can run on Ja ---- NOTE: You may need to increase the amount of memory available to Maven by setting -a `MAVEN_OPTS` environment variable with the value `-Xmx512m -XX:MaxPermSize=128m` +a `MAVEN_OPTS` environment variable with the value `-Xmx512m -XX:MaxPermSize=128m`. Remember +to set the corresponding property in your IDE as well if you are building and running +tests there (e.g. in Eclipse go to `Preferences->Java->Installed JREs` and edit the +JRE definition so that all processes are launched with those arguments). _Also see link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] if you wish to submit pull requests, and in particular please fill out the diff --git a/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc b/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc index bea0fdb819..3257719bc4 100644 --- a/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc +++ b/spring-boot-docs/src/main/asciidoc/using-spring-boot.adoc @@ -555,8 +555,6 @@ This allows you to attach a debugger to your packaged application: -jar target/myproject-0.0.1-SNAPSHOT.jar ---- - - [[using-boot-running-with-the-maven-plugin]] === Using the Maven plugin The Spring Boot Maven plugin includes a `run` goal which can be used to quickly compile @@ -568,7 +566,13 @@ resources for instant ``hot'' reload. $ mvn spring-boot:run ---- +Useful operating system environment variable: +``` +$ export MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=128M -Djava.security.egd=file:/dev/./urandom +``` + +(The "egd" setting is to speed up Tomcat startup by giving it a faster source of entropy for session keys.) [[using-boot-running-with-the-gradle-plugin]] === Using the Gradle plugin @@ -581,6 +585,11 @@ the `spring-boot-plugin` $ gradle bootRun ---- +Useful operating system environment variable: + +``` +$ export JAVA_OPTS=-Xmx1024m -XX:MaxPermSize=128M -Djava.security.egd=file:/dev/./urandom +``` [[using-boot-hot-swapping]]