From 5a8fe6a7fac97dfbd471e4fee0f07db8c50065f2 Mon Sep 17 00:00:00 2001 From: khizmax Date: Mon, 30 May 2016 23:46:12 +0300 Subject: [PATCH] Removed old goals from CMakeLists, docfix --- CMakeLists.txt | 1 - build/cmake/readme.md | 19 +++++++++++-------- cds/details/defs.h | 28 ++++------------------------ doxygen/cds.doxy | 2 +- readme.md | 4 ++++ 5 files changed, 20 insertions(+), 34 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 50a7af60..bcb81439 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -92,7 +92,6 @@ install(DIRECTORY ${PROJECT_SOURCE_DIR}/cds DESTINATION include COMPONENT ${HEAD if(WITH_TESTS) enable_testing() - add_subdirectory(${PROJECT_SOURCE_DIR}/tests) add_subdirectory(${PROJECT_SOURCE_DIR}/test) message(STATUS "Build tests: activated") endif(WITH_TESTS) diff --git a/build/cmake/readme.md b/build/cmake/readme.md index 65f13d76..5d769e4d 100644 --- a/build/cmake/readme.md +++ b/build/cmake/readme.md @@ -39,7 +39,7 @@ In order to package library *CPack* is used, command *cpack -G * shou - 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 ... @@ -52,9 +52,9 @@ In order to package library *CPack* is used, command *cpack -G * shou -- Configuring done -- Generating done -- Build files have been written to: <...>/libcds-release - +``` - make -j4 - +``` Scanning dependencies of target cds Scanning dependencies of target test-common Scanning dependencies of target cds-s @@ -63,9 +63,10 @@ In order to package library *CPack* is used, command *cpack -G * shou ... [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 @@ -73,9 +74,10 @@ In order to package library *CPack* is used, command *cpack -G * shou 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 @@ -88,7 +90,8 @@ In order to package library *CPack* is used, command *cpack -G * 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. - +``` + Future development ---------- - CDash: use CI system \ No newline at end of file diff --git a/cds/details/defs.h b/cds/details/defs.h index c2fe82d5..30bbf4c3 100644 --- a/cds/details/defs.h +++ b/cds/details/defs.h @@ -176,9 +176,8 @@ - boost library 1.51 and above. You should create environment variable \p BOOST_PATH containing full path to \p boost root directory (for example, C:\\libs\\boost_1_57_0). - Open solution file cds\projects\vcX\cds.sln where \p vcX is the version of - Microsoft Visual C++ you use: vc12 for MS VC 2013 Update 4, vc14 for MS VC 2015. The solution - contains \p cds project and a lot of test projects. Just build the library using solution. + Open solution file cds\projects\vc14\cds.sln with Microsoft VisualStudio 2015. + The solution contains \p cds project and a lot of test projects. Just build the library using solution. Warning: the solution depends on \p BOOST_PATH environment variable that specifies full path to \p boost library root directory. The test projects search \p boost libraries in: @@ -188,27 +187,8 @@ \par *NIX build For Unix-like systems GCC and Clang compilers are supported. - Use GCC 4.8+ compiler or Clang 3.3+ to build cds library. The distributive contains - makefile and build.sh script in build directory. - The build/sample directory contains sample scripts for different operating systems and - processor architectures. - The build.sh script supports the following options: - - -c toolset - Toolset name, possible values: gcc (default), clang, icc - - -x compiler - C++ compiler name (e.g. g++, g++-4.5 and so on) - - -p arch - processor architecture; possible values for arch are: x86, amd64 (x86_64), sparc, ia64, ppc64 - - -o OStype - OS family; possible values for OStype are: linux, sunos (solaris), hpux, mingw - - -D define additional defines - - -b bits - bits to build, accepts 64, 32 - - -l "options" - extra linker options (in quotes) - - -z "options" - extra compiler options (in quotes) - - --with-boost path - path to boost include - - --debug-cxx-options "options" - extra compiler options for debug target - - --debug-ld-options "options" - extra linker options for debug target - - --release-cxx-options "options" - extra compiler options for release target - - --release-ld-options "optons" - extra linker options for release target - - --clean - clean all before building - - --debug-test - make unit test in debug mode; by defalt release unit test generated - - --amd64-use-128bit - compile with supporting 128bit (16byte) CAS on amd64 (for am64 only) + Use GCC 4.8+ compiler or Clang 3.3+ to build cds library with CMake. + See accompanying file /build/cmake/readme.md for more info. @note Important for GCC compiler: all your projects that use \p libcds must be compiled with -fno-strict-aliasing compiler flag. diff --git a/doxygen/cds.doxy b/doxygen/cds.doxy index 297ca0dc..509da730 100644 --- a/doxygen/cds.doxy +++ b/doxygen/cds.doxy @@ -69,7 +69,7 @@ OUTPUT_LANGUAGE = English BRIEF_MEMBER_DESC = YES -MARKDOWN_SUPPORT = NO +MARKDOWN_SUPPORT = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. diff --git a/readme.md b/readme.md index afd1ff97..19c5c484 100644 --- a/readme.md +++ b/readme.md @@ -40,6 +40,10 @@ Download the latest release from http://sourceforge.net/projects/libcds/files/ See online doxygen-generated doc here: http://libcds.sourceforge.net/doc/cds-api/index.html +**How to build** + - *nix: [use CMake](build/cmake/readme.md) + - Windows: use MS Visual C++ 2015 project + **Pull request requirements** - Pull-request to *master* branch will be unconditionally rejected - *integration* branch is intended for pull-request. Usually, *integration* branch is the same as *master* -- 2.34.1