From 8a0cae963c6b86cfb07da906af22bff7b55624db Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau Date: Mon, 13 Jun 2022 16:41:26 +0200 Subject: Use new option when only build cpp documentation - useful when performing user version also --- .circleci/config.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to '.circleci/config.yml') diff --git a/.circleci/config.yml b/.circleci/config.yml index f6a875dd..3e99896a 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -48,7 +48,7 @@ jobs: python: docker: - - image: gudhi/ci_for_gudhi:latest + - image: gudhi/doxygen_for_gudhi:latest steps: - checkout - run: @@ -58,7 +58,7 @@ jobs: git submodule update mkdir build cd build - cmake -DUSER_VERSION_DIR=version .. + cmake -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON -DUSER_VERSION_DIR=version .. make user_version cd version cmake -DCMAKE_BUILD_TYPE=Release -DWITH_GUDHI_EXAMPLE=OFF -DWITH_GUDHI_UTILITIES=OFF -DWITH_GUDHI_PYTHON=ON -DPython_ADDITIONAL_VERSIONS=3 . @@ -89,12 +89,12 @@ jobs: git submodule update mkdir build cd build - cmake -DCMAKE_BUILD_TYPE=Release -DWITH_GUDHI_EXAMPLE=OFF -DWITH_GUDHI_TEST=OFF -DWITH_GUDHI_UTILITIES=OFF -DWITH_GUDHI_PYTHON=OFF -DUSER_VERSION_DIR=version .. + cmake -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON -DUSER_VERSION_DIR=version .. make user_version cd version mkdir build cd build - cmake -DCMAKE_BUILD_TYPE=Release -DWITH_GUDHI_EXAMPLE=OFF -DWITH_GUDHI_TEST=OFF -DWITH_GUDHI_UTILITIES=OFF -DWITH_GUDHI_PYTHON=OFF .. + cmake -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON .. make doxygen 2>&1 | tee dox.log grep warning dox.log cp dox.log html/ -- cgit v1.2.3 From c8dc6c9a247f1eb541cea90dfc6f9bfb3e0d576e Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau Date: Wed, 15 Jun 2022 08:35:25 +0200 Subject: Docker image mix between doxygen/python --- .circleci/config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to '.circleci/config.yml') diff --git a/.circleci/config.yml b/.circleci/config.yml index 3e99896a..e2997145 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -48,7 +48,7 @@ jobs: python: docker: - - image: gudhi/doxygen_for_gudhi:latest + - image: gudhi/ci_for_gudhi:latest steps: - checkout - run: @@ -79,7 +79,7 @@ jobs: doxygen: docker: - - image: gudhi/ci_for_gudhi:latest + - image: gudhi/doxygen_for_gudhi:latest steps: - checkout - run: -- cgit v1.2.3 From e31556d04e4a957dd38b3e52e91e1a6cedd47f65 Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau Date: Wed, 29 Jun 2022 10:07:04 +0200 Subject: doxygen logs are now in doxygen.log file (cf. Doxyfile.in). grep and cp the correct file --- .circleci/config.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to '.circleci/config.yml') diff --git a/.circleci/config.yml b/.circleci/config.yml index e2997145..64e7fbb1 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -95,9 +95,9 @@ jobs: mkdir build cd build cmake -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON .. - make doxygen 2>&1 | tee dox.log - grep warning dox.log - cp dox.log html/ + make doxygen 2>&1 + grep warning doxygen.log + cp doxygen.log html/ cp -R html /tmp/doxygen - store_artifacts: -- cgit v1.2.3 From 17f68bb5be7a68fab17510740d2bdc28b70decea Mon Sep 17 00:00:00 2001 From: Vincent Rouvreau Date: Thu, 30 Jun 2022 11:30:12 +0200 Subject: code review: rename option WITH_GUDHI_THIRD_PARTY --- .circleci/config.yml | 8 ++++---- .github/for_maintainers/tests_strategy.md | 5 +++++ CMakeLists.txt | 4 ++-- src/CMakeLists.txt | 4 ++-- src/cmake/modules/GUDHI_options.cmake | 4 ++-- src/common/doc/installation.h | 4 ++-- 6 files changed, 17 insertions(+), 12 deletions(-) (limited to '.circleci/config.yml') diff --git a/.circleci/config.yml b/.circleci/config.yml index 64e7fbb1..82ad19db 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -58,7 +58,7 @@ jobs: git submodule update mkdir build cd build - cmake -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON -DUSER_VERSION_DIR=version .. + cmake -DWITH_GUDHI_THIRD_PARTY=OFF -DUSER_VERSION_DIR=version .. make user_version cd version cmake -DCMAKE_BUILD_TYPE=Release -DWITH_GUDHI_EXAMPLE=OFF -DWITH_GUDHI_UTILITIES=OFF -DWITH_GUDHI_PYTHON=ON -DPython_ADDITIONAL_VERSIONS=3 . @@ -89,13 +89,13 @@ jobs: git submodule update mkdir build cd build - cmake -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON -DUSER_VERSION_DIR=version .. + cmake -DWITH_GUDHI_THIRD_PARTY=OFF -DUSER_VERSION_DIR=version .. make user_version cd version mkdir build cd build - cmake -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON .. - make doxygen 2>&1 + cmake -DWITH_GUDHI_THIRD_PARTY=OFF .. + make doxygen grep warning doxygen.log cp doxygen.log html/ cp -R html /tmp/doxygen diff --git a/.github/for_maintainers/tests_strategy.md b/.github/for_maintainers/tests_strategy.md index c25acf9b..01248d3a 100644 --- a/.github/for_maintainers/tests_strategy.md +++ b/.github/for_maintainers/tests_strategy.md @@ -4,6 +4,11 @@ This document tries to sum up the tests strategy that has been put in place for The aim is to help maintainers to anticipate third parties modifications, updates. +## CMake options + +[CMake GUDHI options](../../src/cmake/modules/GUDHI_options.cmake) allows to activate/deactivate what should be built and tested. +Note the special option `WITH_GUDHI_THIRD_PARTY` that, when set to `OFF`, accelerates doxygen documentation generation or `user_version` for instance. + ## Builds ### Linux diff --git a/CMakeLists.txt b/CMakeLists.txt index 1164eaab..6c233459 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -15,7 +15,7 @@ set(GUDHI_PYTHON_PATH "src/python") include(GUDHI_submodules) -if (NOT WITH_GUDHI_CPP_DOCUMENTATION_ONLY) +if (WITH_GUDHI_THIRD_PARTY) # For third parties libraries management - To be done last as CGAL updates CMAKE_MODULE_PATH include(GUDHI_third_party_libraries NO_POLICY_SCOPE) endif() @@ -56,7 +56,7 @@ foreach(GUDHI_MODULE ${GUDHI_MODULES}) endforeach() endforeach() -if (NOT WITH_GUDHI_CPP_DOCUMENTATION_ONLY) +if (WITH_GUDHI_THIRD_PARTY) add_subdirectory(src/GudhUI) endif() diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index d2f12e5f..f9f77ef7 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -14,7 +14,7 @@ set(GUDHI_PYTHON_PATH "python") include(GUDHI_submodules) -if (NOT WITH_GUDHI_CPP_DOCUMENTATION_ONLY) +if (WITH_GUDHI_THIRD_PARTY) # For third parties libraries management - To be done last as CGAL updates CMAKE_MODULE_PATH include(GUDHI_third_party_libraries NO_POLICY_SCOPE) endif() @@ -71,7 +71,7 @@ foreach(GUDHI_MODULE ${GUDHI_MODULES}) endforeach() endforeach() -if (NOT WITH_GUDHI_CPP_DOCUMENTATION_ONLY) +if (WITH_GUDHI_THIRD_PARTY) add_subdirectory(GudhUI) endif() diff --git a/src/cmake/modules/GUDHI_options.cmake b/src/cmake/modules/GUDHI_options.cmake index 6655d605..fe328169 100644 --- a/src/cmake/modules/GUDHI_options.cmake +++ b/src/cmake/modules/GUDHI_options.cmake @@ -3,9 +3,9 @@ option(WITH_GUDHI_EXAMPLE "Activate/deactivate examples compilation and installa option(WITH_GUDHI_PYTHON "Activate/deactivate python module compilation and installation" ON) option(WITH_GUDHI_TEST "Activate/deactivate examples compilation and installation" ON) option(WITH_GUDHI_UTILITIES "Activate/deactivate utilities compilation and installation" ON) -option(WITH_GUDHI_CPP_DOCUMENTATION_ONLY "Build only the GUDHI C++ documentation (with doxygen)." OFF) +option(WITH_GUDHI_THIRD_PARTY "Activate/deactivate third party libraries cmake detection. When set to OFF, it is usefull for doxygen or user_version i.e." ON) -if (WITH_GUDHI_CPP_DOCUMENTATION_ONLY) +if (NOT WITH_GUDHI_THIRD_PARTY) set (WITH_GUDHI_BENCHMARK OFF) set (WITH_GUDHI_EXAMPLE OFF) set (WITH_GUDHI_PYTHON OFF) diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index b97142b6..c17855b6 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -43,13 +43,13 @@ make \endverbatim * * \subsection documentationgeneration C++ documentation * To generate the C++ documentation, the doxygen program - * is required. Run the following command in a terminal: + * is required (version ≥ 1.9.3 is advised). Run the following command in a terminal: * \verbatim make doxygen \endverbatim * Documentation will be generated in a folder named html. * * In case there is not a full setup present and only the documentation should be build the following command sequence * can be used: -\verbatim cmake -DWITH_GUDHI_CPP_DOCUMENTATION_ONLY=ON .. +\verbatim cmake -DWITH_GUDHI_THIRD_PARTY=OFF .. make doxygen\endverbatim * * \subsection helloworld Hello world ! -- cgit v1.2.3