summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorDavid Pursehouse <david.pursehouse@sonymobile.com>2013-05-07 10:55:59 +0100
committerDavid Pursehouse <david.pursehouse@sonymobile.com>2013-05-07 22:37:18 +0100
commit2ef27d87bbe52e49b135b5894849235c32479198 (patch)
treedd82426bcf4858783cd4ceecc0bdf30f1026369a /Documentation
parentec7849d3fb8d9968900be3d998ae6247e6fcfc75 (diff)
Update build instructions in developer documentation
The build now includes the documentation by default. Add an example of how to build without it. Also add an example of how to build without running tests. According to [1] it is recommended to always build with the `clean` target. Add this in the example. [1] https://groups.google.com/d/msg/repo-discuss/-eNRfFKi74s/ZuImeSLmCJAJ Change-Id: I909a8c45a59caf6a84e50ca3031566582f3faa93
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/dev-readme.txt16
1 files changed, 15 insertions, 1 deletions
diff --git a/Documentation/dev-readme.txt b/Documentation/dev-readme.txt
index 12eb1a7c46..2a9925b248 100644
--- a/Documentation/dev-readme.txt
+++ b/Documentation/dev-readme.txt
@@ -31,7 +31,21 @@ Building
From the command line:
----
- mvn package
+ mvn clean package
+----
+
+By default the build will run tests and build the documentation.
+
+To build without tests:
+
+----
+ mvn clean package -DskipTests
+----
+
+To build without documentation:
+
+----
+ mvn clean package -Dgerrit.documentation.skip
----
Output executable WAR will be placed in: