Merge pull request #44 from eugenyk/master
[libcds.git] / build / cmake / readme.md
1 Building library with CMake
2 ===============
3
4 CDS suports both in-source and out-of-source cmake build types. Now project uses:
5
6 - CMake: general cross-platform building
7 - CTest: all unit tests can be run in a standard way by *ctest* command
8 - CPack: for making rpm/deb/nsys etc. packages
9
10 Compiling and testing
11 ----------
12 **Building out-of-source in "RELEASE" mode ("DEBUG" is default)**
13
14 - Wherever create empty directory for building, for instance *libcds-debug*  
15 - Prepare: *cmake -DCMAKE_BUILD_TYPE=RELEASE <path to the project's root directory with CMakeLists.txt>*
16 - Compile: *make -j4*
17 - As a result you'll see shared and static cds libraries in the build directory
18
19 After using command *cmake -L <path to the project's root directory with CMakeLists.txt>* one can see some additional variables, that can activate additional features:
20
21 - *WITH_TESTS:BOOL=OFF*: if you want to build library with unit testing support use *-DWITH_TESTS=ON* on prepare step. Be careful with this flag, because compile time will dramatically increase
22 - *WITH_BOOST_ATOMIC:BOOL=OFF*: Use boost atomics (only for boost >= 1.54)
23 - ...  
24
25 Packaging
26 ----------
27
28 In order to package library *CPack* is used, command *cpack -G <Generator>* should create correspondent packages for particular operating system. Now the project supports building the following package types:
29
30 - *RPM*: redhat-based linux distribs        
31 - *DEB*: debian-based linux distribs
32 - *TGZ*: simple "*tgz*" archive with library and headers
33 - *NSYS*: windows installer package (NSYS should be installed)   
34   
35 "Live" building and packaging example
36 ----------
37 - git clone https://github.com/khizmax/libcds.git
38 - mkdir libcds-release
39 - cd libcds-release
40 - cmake -DWITH\_TESTS=ON -DCMAKE\_BUILD_TYPE=RELEASE ../libcds
41
42     -- The C compiler identification is GNU 4.8.3
43     -- The CXX compiler identification is GNU 4.8.3
44     ...
45     -- Found Threads: TRUE
46     -- Boost version: 1.54.0
47     -- Found the following Boost libraries:
48     --   system
49     --   thread
50     Build type -- RELEASE
51     -- Configuring done
52     -- Generating done
53     -- Build files have been written to: <...>/libcds-release
54     
55 - make -j4
56   
57     Scanning dependencies of target cds
58     Scanning dependencies of target test-common
59     Scanning dependencies of target cds-s
60     Scanning dependencies of target test-hdr-offsetof
61     [  1%] Building CXX object CMakeFiles/cds-s.dir/src/hp_gc.cpp.o
62     ...
63     [100%] Built target test-hdr
64     gmake: выход из каталога «/home/kel/projects_cds/libcds-debug»
65         
66 - ctest
67
68     Test project /home/kel/projects_cds/libcds-debug
69         Start 1: test-hdr
70     1/7 Test #1: test-hdr .........................   Passed  1352.24 sec
71         Start 2: cdsu-misc
72     2/7 Test #2: cdsu-misc ........................   Passed    0.00 sec
73         Start 3: cdsu-map
74     ...
75     
76 - cpack -G RPM
77
78     CPack: Create package using RPM
79     CPack: Install projects
80     CPack: - Run preinstall target for: cds
81     CPack: - Install project: cds
82     CPack: -   Install component: devel
83     CPack: -   Install component: lib
84     CPack: Create package
85     CPackRPM:Debug: Adding /usr/local to builtin omit list.
86     CPackRPM: Will use GENERATED spec file: /home/kel/projects_cds/libcds-debug/_CPack_Packages/Linux/RPM/SPECS/cds-devel.spec
87     CPackRPM: Will use GENERATED spec file: /home/kel/projects_cds/libcds-debug/_CPack_Packages/Linux/RPM/SPECS/cds-lib.spec
88     CPack: - package: /home/kel/projects_cds/libcds-debug/cds-2.1.0-1-devel.rpm generated.
89     CPack: - package: /home/kel/projects_cds/libcds-debug/cds-2.1.0-1-lib.rpm generated.
90   
91 Future development
92 ----------
93 - CDash: use CI system