From ec19175401843cae408fc4ab3a298d54afb54c9f Mon Sep 17 00:00:00 2001 From: Ryan Williams Date: Mon, 15 Dec 2014 14:52:17 -0800 Subject: [SPARK-4668] Fix some documentation typos. Author: Ryan Williams Closes #3523 from ryan-williams/tweaks and squashes the following commits: d2eddaa [Ryan Williams] code review feedback ce27fc1 [Ryan Williams] CoGroupedRDD comment nit c6cfad9 [Ryan Williams] remove unnecessary if statement b74ea35 [Ryan Williams] comment fix b0221f0 [Ryan Williams] fix a gendered pronoun c71ffed [Ryan Williams] use names on a few boolean parameters 89954aa [Ryan Williams] clarify some comments in {Security,Shuffle}Manager e465dac [Ryan Williams] Saved building-spark.md with Dillinger.io 83e8358 [Ryan Williams] fix pom.xml typo dc4662b [Ryan Williams] typo fixes in tuning.md, configuration.md (cherry picked from commit 8176b7a02e6b62bbce194c3ce9802d58b7472101) Signed-off-by: Patrick Wendell Conflicts: pom.xml --- docs/building-spark.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) (limited to 'docs/building-spark.md') diff --git a/docs/building-spark.md b/docs/building-spark.md index 6cca2da8e8..72a9bfdf64 100644 --- a/docs/building-spark.md +++ b/docs/building-spark.md @@ -145,7 +145,21 @@ We use the scala-maven-plugin which supports incremental and continuous compilat mvn scala:cc -should run continuous compilation (i.e. wait for changes). However, this has not been tested extensively. +should run continuous compilation (i.e. wait for changes). However, this has not been tested +extensively. A couple of gotchas to note: +* it only scans the paths `src/main` and `src/test` (see +[docs](http://scala-tools.org/mvnsites/maven-scala-plugin/usage_cc.html)), so it will only work +from within certain submodules that have that structure. +* you'll typically need to run `mvn install` from the project root for compilation within +specific submodules to work; this is because submodules that depend on other submodules do so via +the `spark-parent` module). + +Thus, the full flow for running continuous-compilation of the `core` submodule may look more like: + ``` + $ mvn install + $ cd core + $ mvn scala:cc +``` # Using With IntelliJ IDEA -- cgit v1.2.3