This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Triton Repository". The branch, master has been updated via 10a0d73364d35cbd10ce5497fb338c5f7a653ba4 (commit) from e86d4d5217db1828d5cdfca1c019b27609278aac (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 10a0d73364d35cbd10ce5497fb338c5f7a653ba4 Author: Phil Carns <[email protected]> Date: Wed Aug 3 20:19:43 2011 -0500 ascidoc documentation on how to compile Triton ----------------------------------------------------------------------- Summary of changes: code/doc/compiling-triton.txt | 58 +++++++++++++++++++++++++++++++++++++++++ code/doc/module.mk.in | 3 +- 2 files changed, 60 insertions(+), 1 deletions(-) create mode 100644 code/doc/compiling-triton.txt Diff of changes: diff --git a/code/doc/compiling-triton.txt b/code/doc/compiling-triton.txt new file mode 100644 index 0000000..674baec --- /dev/null +++ b/code/doc/compiling-triton.txt @@ -0,0 +1,58 @@ +Compiling Triton +================ + +== Requirements + +* Linux +* Berkeley DB development libraries (package libdb4.8-dev or similar) +* Glaskow Haskell Compiler (package ghc6 or similar) +* MPI with support for MPI_THREAD_MULTIPLE (MPICH or OpenMPI) + +== Setting up the Haskell environment + +---- +# Download and compile necessary Haskell packages. This must only be +# done once as a normal user (not root). +cd code/maint/hs +./setup-hs-local +# Modify the langc package to support Aesop +./setup-langc +---- + +== Configuring Triton + +---- +# generate the configure script +cd code +./prepare +---- + +Triton supports VPATH builds as shown in the following example, although +you can also configure and build Triton in the source directory if you +prefer. If mpicc is not in your path then you will also have to provide +the --with-mpi=<path> argument to configure. + +---- +# create a build directory +mkdir build +# configure Triton +cd build +../code/configure +---- + +== Building Triton + +The Triton build supports the -j <level of concurrency> option to Make. + +The default makefile target will build the libtriton library, which +currently includes both client and server functionality. You can also +build a large collection of test programs using the "test" target. You can +also generate documenation using the "docs" target: + +---- +make -j 3 test +make -j 3 docs +---- + +This can take a long time to build completely, especially on slow systems. +The Aesop compilation speed is a known problem. diff --git a/code/doc/module.mk.in b/code/doc/module.mk.in index 2aa5c51..659b2ad 100644 --- a/code/doc/module.mk.in +++ b/code/doc/module.mk.in @@ -3,4 +3,5 @@ DIR := doc DOCSRC += $(DIR)/test.txt \ $(DIR)/fault-handling-overview.txt \ $(DIR)/fault-injection.txt \ - $(DIR)/pipelining.txt + $(DIR)/pipelining.txt \ + $(DIR)/compiling-triton.txt hooks/post-receive -- Triton Repository