[u/mrichter/AliRoot.git] / README_CMake


Note: The CMake build of AliRoot builds out-of-source

Steps to Build AliRoot with CMake :

1. Check out Aliroot source into any folder
	
	svn co http://alisoft.cern.ch/AliRoot/trunk ~/trunk

2. Create a new folder and set the environment variable ALICE_ROOT to point to it
	
	mkdir AliRoot
	cd AliRoot
	export ALICE_ROOT=`pwd`

3. Execute the following commands to build AliRoot

	cmake <Path to Source>

eg.	cmake ~/trunk
	make

4. In order to build addtional targets like THydjet and SHUTTLE add the following options to the cmake command

	cmake -DTHydjet=ON -DSHUTTLE=ON <path_to_source>

5. Static libraries can be built using

	make alilibs-static

6. Individual Modules can be built using

	make <Module>-all
	make <Module>-all-static 

eg.	make STEER-all STEER-all-static

7. Individual Packages can be built using

	make <Package>
	make <Package>-static

eg.	make STEERbase STEERbase-static

8. The code can be checked for the ALICE coding conventions on a package, module or class level using the following targets. 

  make check-all
  make <Module>-check-all
  make <Package>-check
  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

  The resulting violations will be written to the folder <Build_Directory>/<Module>/check/viols

9. To Build PARs the following targets can be used. The resulting packages will be created in the cmake build directory

  make par-all 
  make <Package>.par
  make <Module>-par-all   //build all par packages in the module

10. To test PARs after building run

  make test-par-all
  make test-<Package>
  make test-<Module>-par-all

!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
Commit	Line	Data
45526b5e	1
	2	Note: The CMake build of AliRoot builds out-of-source
	3
529dfa42	4	Steps to Build AliRoot with CMake :
dfa85384	5
45526b5e	6	1. Check out Aliroot source into any folder
	7
	8	svn co http://alisoft.cern.ch/AliRoot/trunk ~/trunk
529dfa42	9
45526b5e	10	2. Create a new folder and set the environment variable ALICE_ROOT to point to it
	11
	12	mkdir AliRoot
	13	cd AliRoot
	14	export ALICE_ROOT=`pwd`
529dfa42	15
529dfa42	16	3. Execute the following commands to build AliRoot
45526b5e	17
529f129e	18	cmake <Path to Source>
	19
	20	eg. cmake ~/trunk
529dfa42	21	make
529dfa42	22
45526b5e	23	4. In order to build addtional targets like THydjet and SHUTTLE add the following options to the cmake command
	24
	25	cmake -DTHydjet=ON -DSHUTTLE=ON <path_to_source>
	26
529f129e	27	5. Static libraries can be built using
	28
	29	make alilibs-static
	30
	31	6. Individual Modules can be built using
	32
	33	make <Module>-all
	34	make <Module>-all-static
	35
	36	eg. make STEER-all STEER-all-static
	37
	38	7. Individual Packages can be built using
	39
	40	make <Package>
	41	make <Package>-static
	42
	43	eg. make STEERbase STEERbase-static
529dfa42	44
811ffdcc	45	8. The code can be checked for the ALICE coding conventions on a package, module or class level using the following targets.
c2a2c0b8	46
	47	make check-all
	48	make <Module>-check-all
	49	make <Package>-check
8948a174	50	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
c2a2c0b8	51
811ffdcc	52	The resulting violations will be written to the folder <Build_Directory>/<Module>/check/viols
c2a2c0b8	53
6a9e2760	54	9. To Build PARs the following targets can be used. The resulting packages will be created in the cmake build directory
	55
	56	make par-all
	57	make <Package>.par
8948a174	58	make <Module>-par-all //build all par packages in the module
3a8dbb31	59
	60	10. To test PARs after building run
	61
	62	make test-par-all
	63	make test-<Package>
	64	make test-<Module>-par-all
6a9e2760	65
45526b5e	66	!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
529dfa42	67
dfa85384	68