You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@reef.apache.org by do...@apache.org on 2017/06/27 21:00:14 UTC
reef git commit: [Documentation] Clarify behavior of build commands
Repository: reef
Updated Branches:
refs/heads/master 2f8c76b81 -> ed40479e1
[Documentation] Clarify behavior of build commands
This change clarifies the behavior of build/test/check
commands when executed from individual project directories
vs from root directory of REEF project.
Pull request:
This closes #1318
Project: http://git-wip-us.apache.org/repos/asf/reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/reef/commit/ed40479e
Tree: http://git-wip-us.apache.org/repos/asf/reef/tree/ed40479e
Diff: http://git-wip-us.apache.org/repos/asf/reef/diff/ed40479e
Branch: refs/heads/master
Commit: ed40479e1c7a7c3a38bbcb583d48bcd1255acf6a
Parents: 2f8c76b
Author: Mariia Mykhailova <mi...@gmail.com>
Authored: Mon Jun 26 13:19:51 2017 -0700
Committer: Doug Service <do...@apache.org>
Committed: Tue Jun 27 20:55:54 2017 +0000
----------------------------------------------------------------------
lang/java/BUILD.md | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/reef/blob/ed40479e/lang/java/BUILD.md
----------------------------------------------------------------------
diff --git a/lang/java/BUILD.md b/lang/java/BUILD.md
index 4687530..b3633fa 100644
--- a/lang/java/BUILD.md
+++ b/lang/java/BUILD.md
@@ -38,13 +38,15 @@ Build Instructions
The REEF unit tests require a number of open files which is greater than the default open file limit on a number of Linux distributions such as Ubuntu 16.04/16.10. This limit is controlled in the shell by the "ulimit -n" command
-The Java side of REEF is built using Apache Maven. To build and run tests, execute:
+The Java side of REEF is built using Apache Maven. All commands given below for building the code, running the tests or performing individual code quality checks can be used in two ways: when executed from the root directory of REEF project, they will build/run tests/checks on all Java projects in order of their dependencies, and when executed from an individual project's directory (for example, `/lang/java/reef-common`), they will build/run tests/checks on that project only.
+
+To build and run tests, execute:
mvn clean install
REEF integration tests can take a while (~30 minutes on a modern multi-core machine), it may be faster to run one of the commands below which skips these tests.
-To perform build alone without tests in a multithreaded mode, execute
+To perform build alone without tests in a multithreaded mode, execute:
mvn -TC1 -DskipTests clean install