Skip to content

Commit 9d2a115

Browse files
da-liiisrowen
authored andcommitted
[MINOR][DOC] Documentation on JVM options for SBT
## What changes were proposed in this pull request? Documentation and .gitignore ## How was this patch tested? Manual test that SBT honors the settings in .jvmopts if present Closes apache#23615 from sadhen/impr/gitignore. Authored-by: Darcy Shen <[email protected]> Signed-off-by: Sean Owen <[email protected]>
1 parent 02d8ae3 commit 9d2a115

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,6 @@ spark-warehouse/
9494
*.Rproj.*
9595

9696
.Rproj.user
97+
98+
# For SBT
99+
.jvmopts

docs/building-spark.md

+8
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,14 @@ To avoid the overhead of launching sbt each time you need to re-compile, you can
138138
in interactive mode by running `build/sbt`, and then run all build commands at the command
139139
prompt.
140140

141+
### Setting up SBT's Memory Usage
142+
Configure the JVM options for SBT in `.jvmopts` at the project root, for example:
143+
144+
-Xmx2g
145+
-XX:ReservedCodeCacheSize=512m
146+
147+
For the meanings of these two options, please carefully read the [Setting up Maven's Memory Usage section](http://spark.apache.org/docs/latest/building-spark.html#setting-up-mavens-memory-usage).
148+
141149
## Speeding up Compilation
142150

143151
Developers who compile Spark frequently may want to speed up compilation; e.g., by using Zinc

0 commit comments

Comments
 (0)