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_TESTS_COVERAGE:BOOL=OFF*: Analyze test coverage using gcov (only for gcc)
  23 - *WITH_BOOST_ATOMIC:BOOL=OFF*: Use boost atomics (only for boost >= 1.54)
  24 - *WITH_ASAN:BOOL=OFF*: compile libcds with AddressSanitizer instrumentation
  25 - *WITH_TSAN:BOOL=OFF*: compile libcds with ThreadSanitizer instrumentation
  26
  27 Packaging
  28 ----------
  29
  30 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:
  31
  32 - *RPM*: redhat-based linux distribs
  33 - *DEB*: debian-based linux distribs
  34 - *TGZ*: simple "*tgz*" archive with library and headers
  35 - *NSYS*: windows installer package (NSYS should be installed)
  36
  37 "Live" building and packaging example
  38 ----------
  39 - git clone https://github.com/khizmax/libcds.git
  40 - mkdir libcds-release
  41 - cd libcds-release
  42 - cmake -DWITH\_TESTS=ON -DCMAKE\_BUILD_TYPE=RELEASE ../libcds
  43 ```
  44     -- The C compiler identification is GNU 4.8.3
  45     -- The CXX compiler identification is GNU 4.8.3
  46     ...
  47     -- Found Threads: TRUE
  48     -- Boost version: 1.54.0
  49     -- Found the following Boost libraries:
  50     --   system
  51     --   thread
  52     Build type -- RELEASE
  53     -- Configuring done
  54     -- Generating done
  55     -- Build files have been written to: <...>/libcds-release
  56 ```
  57 - make -j4
  58 ```
  59     Scanning dependencies of target cds
  60     Scanning dependencies of target test-common
  61     Scanning dependencies of target cds-s
  62     Scanning dependencies of target test-hdr-offsetof
  63     [  1%] Building CXX object CMakeFiles/cds-s.dir/src/hp_gc.cpp.o
  64     ...
  65     [100%] Built target test-hdr
  66     gmake: выход из каталога «/home/kel/projects_cds/libcds-debug»
  67 ```
  68
  69 - ctest
  70 ```
  71     Test project /home/kel/projects_cds/libcds-debug
  72         Start 1: test-hdr
  73     1/7 Test #1: test-hdr .........................   Passed  1352.24 sec
  74         Start 2: cdsu-misc
  75     2/7 Test #2: cdsu-misc ........................   Passed    0.00 sec
  76         Start 3: cdsu-map
  77     ...
  78 ```
  79
  80 - cpack -G RPM
  81 ```
  82     CPack: Create package using RPM
  83     CPack: Install projects
  84     CPack: - Run preinstall target for: cds
  85     CPack: - Install project: cds
  86     CPack: -   Install component: devel
  87     CPack: -   Install component: lib
  88     CPack: Create package
  89     CPackRPM:Debug: Adding /usr/local to builtin omit list.
  90     CPackRPM: Will use GENERATED spec file: /home/kel/projects_cds/libcds-debug/_CPack_Packages/Linux/RPM/SPECS/cds-devel.spec
  91     CPackRPM: Will use GENERATED spec file: /home/kel/projects_cds/libcds-debug/_CPack_Packages/Linux/RPM/SPECS/cds-lib.spec
  92     CPack: - package: /home/kel/projects_cds/libcds-debug/cds-2.1.0-1-devel.rpm generated.
  93     CPack: - package: /home/kel/projects_cds/libcds-debug/cds-2.1.0-1-lib.rpm generated.
  94 ```
  95
  96 Future development
  97 ----------
  98 - CDash: use CI system