aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorIvan Orlov <ivanorlo@amazon.com>2014-11-25 12:39:23 -0800
committerKonstantin Boudnik <cos@apache.org>2014-12-01 11:43:24 -0800
commitb165d0c7f039f7797bb9941aebbb2094aef3be26 (patch)
tree4f2500b56db2a6528d1523419a9cdc03dae8f30d /README.md
parent10193c89f590fb4fc1fe988cd87c5755d0f69228 (diff)
BIGTOP-1527. Allow to fetch package's source code from Git
Signed-off-by: Konstantin Boudnik <cos@apache.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2c088cc7..17b7a4a2 100644
--- a/README.md
+++ b/README.md
@@ -149,6 +149,29 @@ project. The main page can be accessed from "project_root/target/site/index.htm
The source for the website is located in "project_root/src/site/".
+For Developers: Building a component from Git repository
+--------------------------------------------------------
+
+To fetch source from a Git repository you need to modify `bigtop.mk` and add the
+following fields to your package:
+
+* `_GIT_REPO` - SSH, HTTP or local path to Git repo.
+* `_GIT_REF` - branch, tag or commit hash to check out.
+
+Some packages have different names for source directory and source tarball
+(`hbase-0.98.5-src.tar.gz` contains `hbase-0.98.5` directory).
+By default source will be fetched in a directory named `_TARBALL_SRC`
+without `.t*` extension.
+To explicitly set directory name use the `_GIT_DIR` option.
+
+Example for HBase:
+
+
+```make
+HBASE_GIT_REPO=https://github.com/apache/hbase.git
+HBASE_GIT_REF=$(HBASE_PKG_VERSION)
+HBASE_GIT_DIR=hbase-$(HBASE_PKG_VERSION)
+```
Contact us