From 95280bf16f1ef21b2b925eabd50deb93bbc1f1ed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johan=20Andr=C3=A9n?= Date: Thu, 28 Jul 2016 13:18:14 +0200 Subject: [PATCH] =readme Updated the contributing doc with sbt memory heap config (#21055) * Updated the contributing doc with sbt memory heap config * huge -> large --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abcc9848d2..69e21e379d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -85,6 +85,8 @@ The TL;DR; of the above very precise workflow version is: 4. Keep polishing it until received enough LGTM 5. Profit! +Note that the Akka sbt project is large, so `sbt` needs to be run with lots of heap (1-2 Gb). This can be specified using a command line argument `sbt -mem 2048` or in the environment variable `SBT_OPTS` but then as a regular JVM memory flag, for example `SBT_OPTS=-Xmx2G`, on some platforms you can also edit the global defaults for sbt in `/usr/local/etc/sbtopts`. + ## The `validatePullRequest` task The Akka build includes a special task called `validatePullRequest` which investigates the changes made as well as dirty