You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@atlas.apache.org by ma...@apache.org on 2017/01/19 15:41:28 UTC

[2/2] incubator-atlas git commit: ATLAS-1000: updated build instructions in README.txt

ATLAS-1000: updated build instructions in README.txt

(cherry picked from commit dc17ca943d9dabb9247753798f873bb1925552ea)


Project: http://git-wip-us.apache.org/repos/asf/incubator-atlas/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-atlas/commit/2139e287
Tree: http://git-wip-us.apache.org/repos/asf/incubator-atlas/tree/2139e287
Diff: http://git-wip-us.apache.org/repos/asf/incubator-atlas/diff/2139e287

Branch: refs/heads/master
Commit: 2139e2879852d3c4a9551c83e0d84df515ffca14
Parents: 100fee3
Author: Madhan Neethiraj <ma...@apache.org>
Authored: Thu Jan 19 07:30:49 2017 -0800
Committer: Madhan Neethiraj <ma...@apache.org>
Committed: Thu Jan 19 07:40:40 2017 -0800

----------------------------------------------------------------------
 README.txt | 24 ++++++++++++++++++++----
 1 file changed, 20 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-atlas/blob/2139e287/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
index 778bc93..3b59ac0 100755
--- a/README.txt
+++ b/README.txt
@@ -42,17 +42,33 @@ http://incubator.apache.org/projects/atlas.html
 Build Process
 =============
 
-1. Check out the code from GIT repository
+1. Get Atlas sources to your local directory, for example with following commands
+   $ cd <your-local-directory>
    $ git clone https://github.com/apache/incubator-atlas.git
+   $ cd incubator-atlas
 
-2. Execute the following commands to build Apache Atlas
+2. Checkout the branch or tag you would like to build
+   # to checkout a branch
+     $ git checkout <branch>
+
+   # to checkout a tag
+     $ git checkout tags/<tag>
+
+3. Execute the following commands to build Apache Atlas
 
-   $ cd incubator-atlas
    $ export MAVEN_OPTS="-Xms2g -Xmx2g -XX:MaxPermSize=512M"
    $ mvn clean install
+
+   # currently few tests might fail in some environments
+   # (timing issue?), the community is reviewing and updating
+   # such tests.
+   #
+   # if you see test failures, please run the following command:
+      $ mvn clean -DskipTests install
+
    $ mvn clean package -Pdist
 
-3. After the above build commands successfully complete, you should see the following files
+4. After above build commands successfully complete, you should see the following files
 
    webapp/target/atlas-webapp-<version>.war
    addons/falcon-bridge/target/falcon-bridge-<version>.jar