From d3082b114130e8779984788debf56ed99383ad3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Mon, 13 Apr 2020 11:34:02 +0200 Subject: [PATCH 1/3] Three doc should not be built by default in public releases --- Documentation/doc/CMakeLists.txt | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Documentation/doc/CMakeLists.txt b/Documentation/doc/CMakeLists.txt index 4afa99ec635..df8c81710c4 100644 --- a/Documentation/doc/CMakeLists.txt +++ b/Documentation/doc/CMakeLists.txt @@ -339,6 +339,12 @@ else() endforeach() endif() +option(CGAL_BUILD_THREE_DOC "Build the documentation of the Three package" OFF) + +if (NOT CGAL_BUILD_THREE_DOC) + list(REMOVE_ITEM CGAL_DOC_PACKAGES "Three") +endif() + foreach(package ${CGAL_DOC_PACKAGES}) configure_doxygen_package(${package}) endforeach() From f1a126e1c8e31b46b9c5c368f5183f91c9fb2b85 Mon Sep 17 00:00:00 2001 From: Maxime Gimeno Date: Tue, 14 Apr 2020 09:58:14 +0200 Subject: [PATCH 2/3] Switch on for three in travis --- .travis/build_package.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.travis/build_package.sh b/.travis/build_package.sh index c55fc19b5a9..7fbe3c29aa2 100755 --- a/.travis/build_package.sh +++ b/.travis/build_package.sh @@ -11,7 +11,7 @@ function mytime { function build_examples { mkdir -p build-travis cd build-travis - mytime cmake -DCGAL_DIR="/usr/local/lib/cmake/CGAL" -DCMAKE_CXX_FLAGS="${CXX_FLAGS}" .. + mytime cmake -DCGAL_DIR="/usr/local/lib/cmake/CGAL" -DCMAKE_CXX_FLAGS="${CXX_FLAGS}" -DCGAL_BUILD_THREE_DOC=TRUE .. mytime make -j2 VERBOSE=1 } @@ -96,7 +96,7 @@ cd $ROOT cd $ROOT mkdir build_test cd build_test - mytime cmake -DCMAKE_INSTALL_PREFIX=install/ .. + mytime cmake -DCMAKE_INSTALL_PREFIX=install/ -DCGAL_BUILD_THREE_DOC=TRUE .. mytime make install # test install with minimal downstream example mkdir installtest @@ -110,7 +110,7 @@ cd $ROOT echo 'target_link_libraries(${PROJECT_NAME} CGAL::CGAL)' >> CMakeLists.txt echo '#include "CGAL/remove_outliers.h"' >> main.cpp cd build - mytime cmake -DCMAKE_INSTALL_PREFIX=../../install .. + mytime cmake -DCMAKE_INSTALL_PREFIX=../../install -DCGAL_BUILD_THREE_DOC=TRUE .. cd .. exit 0 fi From 75152e76d2427cfa32525a2a136d8bd84f492e1f Mon Sep 17 00:00:00 2001 From: Maxime Gimeno Date: Thu, 16 Apr 2020 12:06:50 +0200 Subject: [PATCH 3/3] Add switch in dependency script --- Installation/CMakeLists.txt | 2 +- Scripts/developer_scripts/cgal_check_dependencies.sh | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Installation/CMakeLists.txt b/Installation/CMakeLists.txt index 70270d33ee5..13ef48188f8 100644 --- a/Installation/CMakeLists.txt +++ b/Installation/CMakeLists.txt @@ -1183,7 +1183,7 @@ You must disable CGAL_ENABLE_CHECK_HEADERS.") # Build the doc set(DOC_DIR "${CMAKE_BINARY_DIR}/build_doc") file(MAKE_DIRECTORY "${DOC_DIR}") - execute_process(COMMAND "${CMAKE_COMMAND}" -DDOXYGEN_EXECUTABLE=${DOXYGEN_EXECUTABLE} "${CMAKE_SOURCE_DIR}/Documentation/doc" + execute_process(COMMAND "${CMAKE_COMMAND}" -DCGAL_BUILD_THREE_DOC=TRUE -DDOXYGEN_EXECUTABLE=${DOXYGEN_EXECUTABLE} "${CMAKE_SOURCE_DIR}/Documentation/doc" WORKING_DIRECTORY "${DOC_DIR}" ) execute_process(COMMAND "${CMAKE_COMMAND}" --build . --target "doc" diff --git a/Scripts/developer_scripts/cgal_check_dependencies.sh b/Scripts/developer_scripts/cgal_check_dependencies.sh index 65b989a8ca2..43ccc1966b9 100644 --- a/Scripts/developer_scripts/cgal_check_dependencies.sh +++ b/Scripts/developer_scripts/cgal_check_dependencies.sh @@ -30,7 +30,7 @@ do fi done -cmake -DCGAL_HEADER_ONLY=FALSE -DCGAL_ENABLE_CHECK_HEADERS=TRUE -DDOXYGEN_EXECUTABLE="$DOX_PATH" -DCGAL_COPY_DEPENDENCIES=TRUE -DCMAKE_CXX_FLAGS="-std=c++11" .. +cmake -DCGAL_HEADER_ONLY=FALSE -DCGAL_BUILD_THREE_DOC=TRUE -DCGAL_ENABLE_CHECK_HEADERS=TRUE -DDOXYGEN_EXECUTABLE="$DOX_PATH" -DCGAL_COPY_DEPENDENCIES=TRUE -DCMAKE_CXX_FLAGS="-std=c++11" .. if [ -n "$DO_CHECK_HEADERS" ]; then make -j$(nproc --all) -k check_headers fi