Include note about MAVEN_OPTS

This commit is contained in:
Phillip Webb 2013-08-26 10:48:26 -07:00
parent f7b69fd009
commit 63f80d0ec1
2 changed files with 10 additions and 4 deletions

View File

@ -39,6 +39,9 @@ can be build using the standard maven command:
$ mvn clean install $ mvn clean install
> **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`
If you are rebuilding often, you might also want to skip the tests until you are ready If you are rebuilding often, you might also want to skip the tests until you are ready
to submit a pull request: to submit a pull request:
@ -79,9 +82,9 @@ from the `file` menu.
Maven is well supported by most Java IDEs. Refer to you vendor documentation. Maven is well supported by most Java IDEs. Refer to you vendor documentation.
### Integration tests ### Integration tests
The sample application are used as integration tests during the build (when you The sample application are used as integration tests during the build (when you
`mvn install`). Due to the fact that they make use of the `spring-boot-maven-plugin` `mvn install`). Due to the fact that they make use of the `spring-boot-maven-plugin`
they cannot be called directly, and so instead are launched via the they cannot be called directly, and so instead are launched via the
`maven-invoker-plugin`. If you encounter build failures running the integration tests, `maven-invoker-plugin`. If you encounter build failures running the integration tests,
check the `build.log` file in the appropriate sample directory. check the `build.log` file in the appropriate sample directory.

View File

@ -232,6 +232,9 @@ latest and greatest, Spring Boot can be
$ mvn clean install $ mvn clean install
> **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`
_Also see [CONTRIBUTING.md](CONTRIBUTING.md) if you wish to submit pull requests._ _Also see [CONTRIBUTING.md](CONTRIBUTING.md) if you wish to submit pull requests._
## Further Reading ## Further Reading