2 Note: The CMake build of AliRoot builds out-of-source
4 Steps to Build AliRoot with CMake :
6 1. Check out Aliroot source into a folder (usually specified by the environment variable ALICE)
9 svn co https://alisoft.cern.ch/AliRoot/trunk AliRoot
11 Note: Please use https:// if you want to be able to commit changes to the SVN repository.
13 2. Set the environment variable ALICE_ROOT to point to the source you have checked out
16 export ALICE_ROOT=`pwd`
19 3. Create a new folder where the build will take place. It must be different from the source directory!
25 4. Optionally specify the place for installation using the environment variable ALICE_INSTALL.
26 It you do not specify it, "make install" will put lib, bin and include in ALICE_ROOT
28 5. Optionally specify the location of Geant3 using the environment variable GEANT3DIR
30 6. Execute the following commands to configure the build
35 Note: Some files CMakeLists.txt will be created in the source tree, so you need write access there. This
36 is a temporary situation that will change soon.
39 cmake -DCMAKE_BUILD_TYPE=DEBUG $ALICE_ROOT
40 to compile AliRoot in Debug configuration (-g compiler flags).
42 To change the configuration later on you can either
43 edit cache variable CMAKE_BUILD_TYPE using 'ccmake' command ('None' value for default configuration),
45 or setup default configuration (-O -g flags are setting up) by running
48 6b. To compile AliRoot in Release mode (-03 flag) run
49 cmake -DCMAKE_BUILD_TYPE=Release $ALICE_ROOT
52 cmake -DCMAKE_BUILD_TYPE=RelRelWithDebInfo $ALICE_ROOT
53 allows to compile AliRoot with -g -O2 options.
55 Please note! The default values for these flags change with different compilers.
56 If CMake does not know your compiler, the contents will be empty.
59 7. Build and install AliRoot. Note that the parralel build is fully operational with CMake.
64 If you make changes in the source tree, it is enough to do
71 9. In order to build addtional targets like THydjet and SHUTTLE add the following options to the cmake command
73 cmake -DTHydjet=ON -DSHUTTLE=ON <path_to_source>
75 10. Static libraries can be built using
79 11. Individual Modules can be built using
82 make <Module>-all-static
84 eg. make STEER-all STEER-all-static
86 12. Individual Packages can be built using
91 eg. make STEERbase STEERbase-static
93 13. The code can be checked for the ALICE coding conventions on a package, module or class level using the following targets.
96 make <Module>-check-all
98 make <Module>-<ClassName>-check // To use this run cmake with -DCLASSCHECK="YES" option. It is turned off by default since it bloats the Makefile and slows down the internal makefile rule checking
100 The resulting violations will be written to the folder <Build_Directory>/<Module>/check/viols
102 14. To Build PARs the following targets can be used. The resulting packages will be created in the cmake build directory
106 make <Module>-par-all //build all par packages in the module
108 15. To test PARs after building run
112 make test-<Module>-par-all
114 !IMPORTANT! - Make sure your source folder is clean. If you used the old make system to build aliroot run make clean in the source directory before you run cmake