Adds iterable HP map parameters

[libcds.git] / build / cmake / readme.md

diff --git a/build/cmake/readme.md b/build/cmake/readme.md
index 65f13d767b0acc6b7a613146ba06155f39d2d254..6a5aa6a165e92a963fa762d3f03a7ef16628b018 100644 (file)
--- a/build/cmake/readme.md
+++ b/build/cmake/readme.md
@@ -11,17 +11,25 @@ Compiling and testing
 ----------
 **Building out-of-source in "RELEASE" mode ("DEBUG" is default)**
 
 ----------
 **Building out-of-source in "RELEASE" mode ("DEBUG" is default)**
 

-- Wherever create empty directory for building, for instance *libcds-debug*  
-- Prepare: *cmake -DCMAKE_BUILD_TYPE=RELEASE <path to the project's root directory with CMakeLists.txt>*
-- Compile: *make -j4*
+- Wherever create empty directory for building, for instance `libcds-debug`
+- Prepare: `cmake -DCMAKE_BUILD_TYPE=RELEASE <path to the project's root directory with CMakeLists.txt>`
+- Compile: `make -j4`

 - As a result you'll see shared and static cds libraries in the build directory
 
 - As a result you'll see shared and static cds libraries in the build directory
 

-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:
+**Warning**: We strongly recommend not to use static cds library. Static library is not tested and not maintained. You can use it on own risk.
+
+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:
+
+- `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
+- `WITH_TESTS_COVERAGE:BOOL=OFF`: Analyze test coverage using gcov (only for gcc)
+- `WITH_BOOST_ATOMIC:BOOL=OFF`: Use boost atomics (only for boost >= 1.54)
+- `WITH_ASAN:BOOL=OFF`: compile libcds with AddressSanitizer instrumentation
+- `WITH_TSAN:BOOL=OFF`: compile libcds with ThreadSanitizer instrumentation
+
+Additional gtest hints (for unit and stress tests only):
+- `GTEST_INCLUDE_DIRS=path`: gives full `path` to gtest include dir. 
+- `GTEST_LIBRARY=path`: gives full `path` to `libgtest.a`.

 
 

-- *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
-- *WITH_TESTS_COVERAGE:BOOL=OFF*: Analyze test coverage using gcov (only for gcc)
-- *WITH_BOOST_ATOMIC:BOOL=OFF*: Use boost atomics (only for boost >= 1.54)
-- ...  

 
 Packaging
 ----------
 
 Packaging
 ----------


@@ -35,11 +43,11 @@ In order to package library *CPack* is used, command *cpack -G <Generator>* shou
   
 "Live" building and packaging example
 ----------
   
 "Live" building and packaging example
 ----------

-- git clone https://github.com/khizmax/libcds.git
-- mkdir libcds-release
-- cd libcds-release
-- cmake -DWITH\_TESTS=ON -DCMAKE\_BUILD_TYPE=RELEASE ../libcds
-
+- `git clone https://github.com/khizmax/libcds.git`
+- `mkdir libcds-release`
+- `cd libcds-release`
+- `cmake -DWITH\_TESTS=ON -DCMAKE\_BUILD_TYPE=RELEASE ../libcds`
+```

     -- The C compiler identification is GNU 4.8.3
     -- The CXX compiler identification is GNU 4.8.3
     ...
     -- The C compiler identification is GNU 4.8.3
     -- The CXX compiler identification is GNU 4.8.3
     ...


@@ -52,9 +60,9 @@ In order to package library *CPack* is used, command *cpack -G <Generator>* shou
     -- Configuring done
     -- Generating done
     -- Build files have been written to: <...>/libcds-release
     -- Configuring done
     -- Generating done
     -- Build files have been written to: <...>/libcds-release

-    
-- make -j4
-  
+``` 
+- `make -j4`
+```

     Scanning dependencies of target cds
     Scanning dependencies of target test-common
     Scanning dependencies of target cds-s
     Scanning dependencies of target cds
     Scanning dependencies of target test-common
     Scanning dependencies of target cds-s


@@ -62,10 +70,10 @@ In order to package library *CPack* is used, command *cpack -G <Generator>* shou
     [  1%] Building CXX object CMakeFiles/cds-s.dir/src/hp_gc.cpp.o
     ...
     [100%] Built target test-hdr
     [  1%] Building CXX object CMakeFiles/cds-s.dir/src/hp_gc.cpp.o
     ...
     [100%] Built target test-hdr

-    gmake: выход из каталога «/home/kel/projects_cds/libcds-debug»
-        
-- ctest
+```

 
 

+- `ctest`
+```

     Test project /home/kel/projects_cds/libcds-debug
         Start 1: test-hdr
     1/7 Test #1: test-hdr .........................   Passed  1352.24 sec
     Test project /home/kel/projects_cds/libcds-debug
         Start 1: test-hdr
     1/7 Test #1: test-hdr .........................   Passed  1352.24 sec


@@ -73,9 +81,10 @@ In order to package library *CPack* is used, command *cpack -G <Generator>* shou
     2/7 Test #2: cdsu-misc ........................   Passed    0.00 sec
         Start 3: cdsu-map
     ...
     2/7 Test #2: cdsu-misc ........................   Passed    0.00 sec
         Start 3: cdsu-map
     ...

-    
-- cpack -G RPM
+```

 
 

+- `cpack -G RPM`
+```

     CPack: Create package using RPM
     CPack: Install projects
     CPack: - Run preinstall target for: cds
     CPack: Create package using RPM
     CPack: Install projects
     CPack: - Run preinstall target for: cds


@@ -88,7 +97,8 @@ In order to package library *CPack* is used, command *cpack -G <Generator>* shou
     CPackRPM: Will use GENERATED spec file: /home/kel/projects_cds/libcds-debug/_CPack_Packages/Linux/RPM/SPECS/cds-lib.spec
     CPack: - package: /home/kel/projects_cds/libcds-debug/cds-2.1.0-1-devel.rpm generated.
     CPack: - package: /home/kel/projects_cds/libcds-debug/cds-2.1.0-1-lib.rpm generated.
     CPackRPM: Will use GENERATED spec file: /home/kel/projects_cds/libcds-debug/_CPack_Packages/Linux/RPM/SPECS/cds-lib.spec
     CPack: - package: /home/kel/projects_cds/libcds-debug/cds-2.1.0-1-devel.rpm generated.
     CPack: - package: /home/kel/projects_cds/libcds-debug/cds-2.1.0-1-lib.rpm generated.

-  
+```
+

 Future development
 ----------
 - CDash: use CI system
\ No newline at end of file
 Future development
 ----------
 - CDash: use CI system
\ No newline at end of file