CONTENTS

  * HOW TO BUILD
  * HOW TO RUN REGRESSION TESTS
  * HOW TO BUILD SOURCE CODE DOCUMENTATION TREE (Doxygen)


=== HOW TO BUILD ===

  1. Install CMake (http://www.cmake.org/)

  2. Make sure Java 1.5 or later and the ant build tool is installed on your machine.

  3. Install the following libraries:
    - java 1.5+
    - ant
    - Boost version 1.34.1 (http://www.boost.org/)
    - log4cpp (http://log4cpp.sourceforge.net/)
    - expat (http://sourceforge.net/projects/expat)
    - lzo-2.02 (http://www.oberhumer.com/opensource/lzo/)

    HIGHLY RECOMMENDED (but non required):
    - tcmalloc (http://code.google.com/p/google-perftools/)

    NOTE: If tcmalloc is available on your system, install it.  Hypertable is
          very malloc intensive and tcmalloc provides a huge performance improvement.

  4. Checkout the source code.

    mkdir ~/src
    cd ~/src
    git clone git://72.51.43.91/pub/repos/hypertable.git
    ( or if you prefer, svn checkout http://hypertable.googlecode.com/svn/trunk hypertable )

  5. Build hypertable.jar

    cd ~/src/hypertable
    ant jar

  6. Create an install directory

    mkdir ~/hypertable

  7. Create a build directory

    mkdir -p ~/build/hypertable

  8. Configure the build. 

    cd ~/build/hypertable
    cmake -DCMAKE_BUILD_TYPE="Debug" -DCMAKE_INSTALL_PREFIX= ~/src/hypertable

  9. Build the software.

    make
    make install DESTDIR=<your_install_dir>

=== HOW TO RUN REGRESSION TESTS ===

1. Make sure software is built and installed according to 'HOW TO BUILD'

   NOTE: These instructions assume the installation directory is ~/hypertable

2. Make sure you have extended attributes enabled on the partition that holds the
   installation (e.g. ~/hypertable).  To do that, you need to add the user_xattr
   property to the relevant file systems in your /etc/fstab file. For example:

   /dev/hda3     /home     ext3     defaults,user_xattr     1 2

   You can then remount the affected partitions as follows:

   $ mount -o remount /home

3. Stop the servers

  *** Must be performed prior to running the regression tests each time **

  cd ~/hypertable
  ./test/stop-servers.sh

4. Start the servers.  The following example illustrates the use of the 'local'
   DFS broker, but can be changed to use any DFS broker (e.g. hadoop, kosmos, etc.)
   by replacing the 'local' keyword with the name of the broker you want to use.

  *** Must be performed prior to running the regression tests each time **

  cd ~/hypertable
  ./test/start-servers.sh local

  [ Expected output ... ]
  Successfully started DFSBroker (local)
  Successfully started Hyperspace
  Successfully started Hypertable.Master
  Successfully started Hypertable.RangeServer

5. Run the regression tests

  cd ~/build/hypertable
  make test


=== HOW TO BUILD SOURCE CODE DOCUMENTATION TREE (Doxygen) ===

1. Install the following libraries:
  - doxygen (http://www.stack.nl/~dimitri/doxygen/)
  - graphviz (http://www.graphviz.org/)

2. If you have doxygen installed on your system, then CMake should detect this and
   add a 'doc' target to the make file.  Building the source code documentation
   tree is just a matter of running the following commands:

   cd ~/build/hypertable
   make doc

The documentation tree will get generated under ~/build/hypertable/doc.  To view
the HTML docs, load the following file into a web browser:

  ~/build/hypertable/doc/html/index.html