Permalink
Browse files

RTSQL-4. Ensure compilation instructions work.

Final corrections to COMPILING.txt for use on other machines.
  • Loading branch information...
1 parent 012f325 commit 36e978c024ad3b91c55c771302f356d5b8f5138c @kimballa kimballa committed Mar 14, 2011
Showing with 25 additions and 7 deletions.
  1. +24 −6 COMPILING.txt
  2. +1 −1 bin/flumebase
View
@@ -6,7 +6,7 @@
FlumeBase is a Java application with a maven-based build process.
BUILD SYSTEM REQUIREMENTS:
- * Maven 2.0+
+ * Maven 2.0.9+
* Java 1.6+
* git
* Linux, or other POSIX-like environment (e.g. cygwin)
@@ -27,28 +27,44 @@ Apache Thrift can be downloaded from http://incubator.apache.org/thrift.
Download the 0.5.0 release of Thrift, untar it, and build it with
./configure && make && sudo make install.
+
+You may need to download some of Thrift's build dependencies first. See
+http://wiki.apache.org/thrift/ThriftRequirements (and the links at the
+bottom of that page) for instructions on installing all Thrift build
+requirements.
+
Correct installation can be verified with the following commands:
- aaron@sailboat:~$ which thrift
+ $ which thrift
/usr/local/bin/thrift
- aaron@sailboat:~$ thrift -version
+ $ thrift -version
Thrift version 0.5.0
+ If you run 'thrift --help', you should verify that 'java'
+ is listed in the "Available generators" section.
+
Installing the maven-thrift-plugin:
To integrate thrift in the Maven build, a specific plugin must be
downloaded from github.com/odiago/maven-thrift-plugin. Clone the
-repository (git clone http://github.com/odiago/maven-thrift-plugin)
-and run:
+repository, build, and install the plugin by running the following:
- cd path/to/maven-thrift-plugin
+ git clone git://github.com/odiago/maven-thrift-plugin.git
+ cd maven-thrift-plugin
git checkout maven-thrift-plugin-0.1.10
mvn package
mvn install:install-file -Dfile=target/maven-thrift-plugin-0.1.10.jar \
-DpomFile=./pom.xml -Dpackaging=maven-plugin -Dversion=0.1.10
+RUNTIME PREREQUISITES:
+
+ FlumeBase requires Cloudera Flume 0.9.3 and Hadoop 0.20. These can
+be installed from Cloudera's Distribution for Hadoop version 3b4 (CDH3B4).
+Installation instructions for CDH are available at
+http://archive.cloudera.com.
+
BUILDING FLUMEBASE:
@@ -61,6 +77,8 @@ Unit tests can be executed by running:
mvn test
+(This is done as a sub-step of 'mvn package'.)
+
More thorough (longer-running) integration tests are available at:
mvn integration-test
View
@@ -82,7 +82,7 @@ add_to_classpath "${LIB_DIR}"
if [ ! -z "${FLUME_HOME}" -a -d "${FLUME_HOME}/lib" ]; then
add_to_classpath "${FLUME_HOME}/lib"
else
- echo "Warning: Couldn't find Flume installation. Make sure $$FLUME_HOME is set."
+ echo "Warning: Couldn't find Flume installation. Make sure \$FLUME_HOME is set."
exit 1
fi

0 comments on commit 36e978c

Please sign in to comment.