Removed old goals from CMakeLists, docfix
authorkhizmax <libcds.dev@gmail.com>
Mon, 30 May 2016 20:46:12 +0000 (23:46 +0300)
committerkhizmax <libcds.dev@gmail.com>
Mon, 30 May 2016 20:46:12 +0000 (23:46 +0300)
CMakeLists.txt
build/cmake/readme.md
cds/details/defs.h
doxygen/cds.doxy
readme.md

index 50a7af6035d1b2ff68a1cd8b09d1953a406d0beb..bcb8143993d183134a0586854f76aeca14cd6c85 100644 (file)
@@ -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)
index 65f13d767b0acc6b7a613146ba06155f39d2d254..5d769e4d65428f3cec8dbb765014d25cc3d97e89 100644 (file)
@@ -39,7 +39,7 @@ In order to package library *CPack* is used, command *cpack -G <Generator>* 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 <Generator>* 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 <Generator>* 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 <Generator>* 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 <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.
-  
+```
+
 Future development
 ----------
 - CDash: use CI system
\ No newline at end of file
index c2fe82d5f04f5c0b271989e5f862adefee0b9310..30bbf4c33b11a67dfd0c18d2603c8e101bdc65f2 100644 (file)
     - <a href="http://www.boost.org/">boost library</a> 1.51 and above. You should create environment variable
         \p BOOST_PATH containing full path to \p boost root directory (for example, <tt>C:\\libs\\boost_1_57_0</tt>).
 
-   Open solution file <tt>cds\projects\vcX\cds.sln</tt> 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 <tt>cds\projects\vc14\cds.sln</tt> with Microsoft VisualStudio 2015.
+   The solution contains \p cds project and a lot of test projects. Just build the library using solution.
 
    <b>Warning</b>: 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:
    \par *NIX build
 
    For Unix-like systems GCC and Clang compilers are supported.
-   Use GCC 4.8+ compiler or Clang 3.3+ to build <b>cds</b> library. The distributive contains
-   makefile and <tt>build.sh</tt> script in <tt>build</tt> directory.
-   The <tt>build/sample</tt> directory contains sample scripts for different operating systems and
-   processor architectures.
-   The <tt>build.sh</tt> script supports the following options:
-   - <tt>-c toolset</tt> - Toolset name, possible values: <tt>gcc</tt> (default), <tt>clang</tt>, <tt>icc</tt>
-   - <tt>-x compiler</tt> - C++ compiler name (e.g. g++, g++-4.5 and so on)
-   - <tt>-p arch</tt> - processor architecture; possible values for arch are: x86, amd64 (x86_64), sparc, ia64, ppc64
-   - <tt>-o OStype</tt> - OS family; possible values for OStype are: linux, sunos (solaris), hpux, mingw
-   - <tt>-D define</tt> additional defines
-   - <tt>-b bits</tt> - bits to build, accepts 64, 32
-   - <tt>-l "options"</tt> - extra linker options (in quotes)
-   - <tt>-z "options"</tt> - extra compiler options (in quotes)
-   - <tt>--with-boost path</tt> - path to boost include
-   - <tt>--debug-cxx-options "options"</tt> - extra compiler options for debug target
-   - <tt>--debug-ld-options "options"</tt> - extra linker options for debug target
-   - <tt>--release-cxx-options "options"</tt> - extra compiler options for release target
-   - <tt>--release-ld-options "optons"</tt> - extra linker options for release target
-   - <tt>--clean</tt> - clean all before building
-   - <tt>--debug-test</tt> - make unit test in debug mode; by defalt release unit test generated
-   - <tt>--amd64-use-128bit</tt> - compile with supporting 128bit (16byte) CAS on amd64 (for am64 only)
+   Use GCC 4.8+ compiler or Clang 3.3+ to build <b>cds</b> library with CMake.
+   See accompanying file <tt>/build/cmake/readme.md</tt> for more info.
 
    @note Important for GCC compiler: all your projects that use \p libcds must be compiled with <b>-fno-strict-aliasing</b>
    compiler flag.
index 297ca0dcc320017e2d9bc148a707ef54bb376b6b..509da7300436c90d93525323a2cc91d985a3ffd4 100644 (file)
@@ -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. 
index afd1ff9739181d8ac30a383eb96aad1870bf8968..19c5c484a454409d7a29fb79bf2846451e094bf3 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -40,6 +40,10 @@ Download the latest release from http://sourceforge.net/projects/libcds/files/
 \r
 See online doxygen-generated doc here: http://libcds.sourceforge.net/doc/cds-api/index.html\r
 \r
+**How to build**\r
+   - *nix: [use CMake](build/cmake/readme.md)\r
+   - Windows: use MS Visual C++ 2015 project\r
+\r
 **Pull request requirements**\r
 - Pull-request to *master* branch will be unconditionally rejected\r
 - *integration* branch is intended for pull-request. Usually, *integration* branch is the same as *master*\r