AliHLTJET module
[u/mrichter/AliRoot.git] / HLT / README
index 6507f2d..8af0689 100644 (file)
@@ -1,6 +1,9 @@
 Package: ALICE HLT
 
-This package implements the ALICE High Level Trigger analysis framework.
+This package implements the ALICE High Level Trigger analysis framework
+and analysis component libraries. All files are property of and copyright
+by the ALICE HLT Project unless stated differently.
+
 All contributions are under the terms of the 
 GNU General Public License as published by the Free Software 
 Foundation. Also see files AUTHORS and THANKS.
@@ -13,13 +16,13 @@ Comments, bug reports, suggestions welcome!
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 + 1. Overview
 + 2. Requirements
-+ 3. Setting up a version retrieved from CVS
++ 3. Setting up a version retrieved from SVN
 + 4. Modifying a distributed package
 + 5. Installation
 + 6. Documentation
 + 7. Further information
 + 8. Reporting bugs/Asking for support
-+ 9. Committing to the AliRoot CVS
++ 9. Committing to the AliRoot SVN
 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 1. Overview
@@ -43,6 +46,8 @@ of the AliRoot compilation.
 
  - \b TRD: The HLT code for TRD
 
+ - \b MUON: The HLT code for MUON
+
 2. Requirements
 ===============
 The package needs both ROOT and AliRoot. Both must be set up in the
@@ -50,7 +55,7 @@ usual way (ROOTSYS, ALICE_ROOT, library locations evtl. specified in
 LD_LIBRARY_PATH, ...). Actually, the BASE and SampleLib modules are
 not dependend on AliRoot. The TPCLib does.
 
-To set up a version retrieved from CVS, autoconf 2.57, automake 1.6
+To set up a version retrieved from SVN, autoconf 2.57, automake 1.6
 ,and libtool 1.4 or higher versions are required. Thats the versions
 which come with the Scientific Linux CERN 3. The same applies if
 you want to change the Makefiles.
@@ -58,11 +63,11 @@ you want to change the Makefiles.
 If your GNU build tools are too old, ask the maintainers for a distributed
 package.  
 
-3. Setting up a version retrieved from CVS
+3. Setting up a version retrieved from SVN
 ==========================================
 Skip this section if you have started from the tar ball.
 
-A version checked out from CVS requires a few steps to set up the Makefiles.
+A version checked out from SVN requires a few steps to set up the Makefiles.
 Go to the directory and run
 
   autoreconf -i -f
@@ -132,10 +137,38 @@ To install all libraries in the AliRoot lib dir:
 Some important options (all options are on by default):
 
   --disable-sample           # disable compilation the sample library
+  --disable-util             # disable compilation the util library
   --disable-tpc              # disable compilation the TPC library
   --disable-phos             # disable compilation the PHOS library
   --disable-trd              # disable compilation the TRD library
+  --disable-dimuon           # disable compilation the MUON library
   --disable-aliroot-logging  # disable logging
+  --disable-doc                     # disable creation of doxygen documentation
+  --disable-strict           # disable strict coding conventions and compilation flags
+
+
+All detector libraries (including sample and util lib) require AliRoot,
+compilation is disabled if no working AliRoot version was found. This can
+occur even if an AliRoot version is set up correctly since the configure
+script checks for the usability of the AliRoot libraries (mainly STEER and
+the ones it depends on). If new dependencies are introduced, the check
+might fail.
+
+Compilation of detector libraries can be forced by the switch
+
+  --enable-detector, e.g. --enable-phos
+
+Compilation can also be forced by typing 'make' in the detector
+sub-directory.
+Debugging (default disabled)
+
+  --enable-debug             # enable debugging: symbols & messages
+
+Optimization (default -O2)
+
+  --disable-optimization     # disable compiler optimization
+  --enable-optimization<=l>  # enable compiler optimization level l
 
 5.5 External packages
 ---------------------
@@ -180,30 +213,33 @@ A wiki with detailed information is set up at
 
 8. Reporting bugs/Asking for support
 ====================================
-Please include the following information into your request:
+Please include the following information into your report/request:
  - config.log from your build directory
  - output of the make process. Note: Redirect BOTH the stdout and stderr
-   channel to a log file. Redirection depends on the shell you are using:
-    bash: make 2>&1 | tee make.log 
-    csh: make |& tee make.log
+   channel to a log file. Redirection depends on the shell you are using:     <br>
+    bash: make 2>&1 | tee make.log                                            <br>
+    csh: make |& tee make.log                                                 <br>
    The 'tee' command just duplicates the output.
  - history of the commands you are using for compilation
    history > history.log
 
-9. Committing to the AliRoot CVS
+9. Committing to the AliRoot SVN
 ================================
 For development of HLT analysis code check out a HEAD version from the 
 repository and implement your code. 
 
 For committing do:
  - 1. make sure that the code changes are correct                    <br><tt>
-      cvs diff | less                                                </tt><br>
+      svn diff | less                                                </tt><br>
       \b Remember to restore all temporary changes you made (e.g. log level)
- - 2. cvs update
+ - 2. svn update
  - 3. correct merging conflicts
  - 4. compile and test your code again
- - 5. send the whole HLT module except the build sub-directories to
+ - 5. depending on where you changes are send the whole HLT module except the build
+      sub-directories or your HLT sub- directory to
       Matthias.Richter@ift.uib.no
+      Please include a message/description for the check in
  - 6. you will get a notification when the code is committed, right after that
-      you must either do another cvs update or check out the complete module
-      again in order to have the right CVS information.
+      you must either do another svn update or check out the complete module
+      again in order to have the right SVN information. Please check that your
+      code has been correctly committed.