From 09fbe226fa273c513d62c272b9895c03bd5a6d38 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Paul=20B=C3=A9daride?= Date: Wed, 4 Jun 2014 17:40:08 +0200 Subject: [PATCH] Add enable_documentation option --- buildtools/Cmake/GenerateDoc.cmake | 19 ++++++++++++------- buildtools/Cmake/Option.cmake | 1 + buildtools/Cmake/PrintArgs.cmake | 1 + buildtools/jenkins/run.sh | 10 +++++----- buildtools/jenkins/run_DynamicAnalysis.sh | 6 +++--- buildtools/jenkins/runmingw.sh | 2 +- 6 files changed, 23 insertions(+), 16 deletions(-) diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index fb465a7568..408f20839e 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -1,13 +1,19 @@ #### Generate the whole html documentation -find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS) +if (enable_documentation) + find_package(Doxygen REQUIRED) + set(DocAll "ALL") +else() + find_package(Doxygen) +endif() + find_path(JAVADOC_PATH NAMES javadoc PATHS NO_DEFAULT_PATHS) find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS) mark_as_advanced(JAVADOC_PATH) -if(DOXYGEN_PATH) +if(DOXYGEN_FOUND) - ADD_CUSTOM_TARGET(doc + ADD_CUSTOM_TARGET(doc ${DocAll} COMMENT "Generating the SimGrid documentation..." DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html @@ -15,7 +21,6 @@ if(DOXYGEN_PATH) WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc ) - execute_process(COMMAND ${DOXYGEN_PATH}/doxygen --version OUTPUT_VARIABLE DOXYGEN_VERSION ) message(STATUS "Doxygen version: ${DOXYGEN_VERSION}") if(DOXYGEN_VERSION VERSION_LESS "1.8") @@ -49,13 +54,13 @@ if(DOXYGEN_PATH) COMMAND pwd COMMAND ${CMAKE_COMMAND} -E tar czf html/msg-tuto-src.tgz msg-tuto-src/ COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen" - COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile + COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files" - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/doxygen/logcategories.doc COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen again" - COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile + COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map COMMAND ${CMAKE_COMMAND} -E echo "XX Javadoc pass" COMMAND ${JAVADOC_PATH}/javadoc -quiet -d ${CMAKE_HOME_DIRECTORY}/doc/html/javadoc/ ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*.java ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*/*.java diff --git a/buildtools/Cmake/Option.cmake b/buildtools/Cmake/Option.cmake index d8325ea17a..a3f0dae05f 100644 --- a/buildtools/Cmake/Option.cmake +++ b/buildtools/Cmake/Option.cmake @@ -16,6 +16,7 @@ mark_as_advanced(pipol_user) option(release "Whether Release Mode is activated (disable tests on experimental parts)" on) option(enable_compile_optimizations "Whether to produce efficient code for the SimGrid library" on) +option(enable_documentation "Whether to produce documentation" on) option(enable_gtnets "Whether gtnets model is activated." off) option(enable_ns3 "Whether ns3 model is activated." off) option(enable_java "Whether the Java bindings are activated." off) diff --git a/buildtools/Cmake/PrintArgs.cmake b/buildtools/Cmake/PrintArgs.cmake index 09c6b3df0a..cf3c58b24d 100644 --- a/buildtools/Cmake/PrintArgs.cmake +++ b/buildtools/Cmake/PrintArgs.cmake @@ -120,6 +120,7 @@ if(enable_java) endif() message("") message(" Maintainer mode .....: ${enable_maintainer_mode}") +message(" Documentation........: ${enable_documentation}") message(" Model checking ......: ${HAVE_MC}") message(" Tracing mode ........: ${enable_tracing}") message(" Jedule mode ........: ${enable_jedule}") diff --git a/buildtools/jenkins/run.sh b/buildtools/jenkins/run.sh index c95277c216..1771a5ccf1 100755 --- a/buildtools/jenkins/run.sh +++ b/buildtools/jenkins/run.sh @@ -22,11 +22,11 @@ cd $WORKSPACE/build export PATH=./lib/:../../lib:$PATH if test "$(uname -o)" = "Msys" -then +then #$NUMBER_OF_PROCESSORS should be already set on win if [ -z "$NUMBER_OF_PROCESSORS" ]; then NUMBER_OF_PROCESSORS=1 - fi + fi cmake -G "MSYS Makefiles" $WORKSPACE || die 1 "Failed to do the first cmake - Halting" @@ -57,17 +57,17 @@ else if [ "$build_mode" = "Debug" ] then - cmake -Denable_coverage=OFF -Denable_java=ON -Denable_model-checking=OFF -Denable_lua=ON -Denable_compile_optimizations=ON -Denable_smpi=ON -Denable_smpi_MPICH3_testsuite=ON -Denable_compile_warnings=ON . + cmake -Denable_documentation=OFF -Denable_coverage=OFF -Denable_java=ON -Denable_model-checking=OFF -Denable_lua=ON -Denable_compile_optimizations=ON -Denable_smpi=ON -Denable_smpi_MPICH3_testsuite=ON -Denable_compile_warnings=ON . fi if [ "$build_mode" = "ModelChecker" ] then - cmake -Denable_coverage=OFF -Denable_java=ON -Denable_smpi=ON -Denable_model-checking=ON -Denable_lua=ON -Denable_compile_optimizations=OFF -Denable_compile_warnings=ON . + cmake -Denable_documentation=OFF -Denable_coverage=OFF -Denable_java=ON -Denable_smpi=ON -Denable_model-checking=ON -Denable_lua=ON -Denable_compile_optimizations=OFF -Denable_compile_warnings=ON . fi if [ "$build_mode" = "DynamicAnalysis" ] then - cmake -Denable_lua=OFF -Denable_java=ON -Denable_tracing=ON -Denable_smpi=ON -Denable_compile_optimizations=OFF -Denable_compile_warnings=ON -Denable_lib_static=OFF -Denable_model-checking=OFF -Denable_latency_bound_tracking=OFF -Denable_gtnets=OFF -Denable_jedule=OFF -Denable_mallocators=OFF -Denable_memcheck=ON . + cmake -Denable_documentation=OFF -Denable_lua=OFF -Denable_java=ON -Denable_tracing=ON -Denable_smpi=ON -Denable_compile_optimizations=OFF -Denable_compile_warnings=ON -Denable_lib_static=OFF -Denable_model-checking=OFF -Denable_latency_bound_tracking=OFF -Denable_gtnets=OFF -Denable_jedule=OFF -Denable_mallocators=OFF -Denable_memcheck=ON . fi [ $? -eq 0 ] || die 5 "Failed to perform the Cmake for $build_mode - Halting" diff --git a/buildtools/jenkins/run_DynamicAnalysis.sh b/buildtools/jenkins/run_DynamicAnalysis.sh index 0d05047396..0c4070ec2e 100755 --- a/buildtools/jenkins/run_DynamicAnalysis.sh +++ b/buildtools/jenkins/run_DynamicAnalysis.sh @@ -18,7 +18,7 @@ mkdir $WORKSPACE/memcheck cd $WORKSPACE/build -cmake -Denable_lua=OFF -Denable_tracing=ON -Denable_smpi=ON -Denable_smpi_MPICH3_testsuite=OFF -Denable_compile_optimizations=OFF -Denable_compile_warnings=ON -Denable_lib_static=OFF -Denable_model-checking=OFF -Denable_latency_bound_tracking=OFF -Denable_gtnets=OFF -Denable_jedule=OFF -Denable_mallocators=OFF -Denable_memcheck_xml=ON $WORKSPACE +cmake -Denable_documentation=OFF -Denable_lua=OFF -Denable_tracing=ON -Denable_smpi=ON -Denable_smpi_MPICH3_testsuite=OFF -Denable_compile_optimizations=OFF -Denable_compile_warnings=ON -Denable_lib_static=OFF -Denable_model-checking=OFF -Denable_latency_bound_tracking=OFF -Denable_gtnets=OFF -Denable_jedule=OFF -Denable_mallocators=OFF -Denable_memcheck_xml=ON $WORKSPACE make ctest -D ExperimentalStart @@ -34,7 +34,7 @@ fi make clean -cmake -Denable_lua=OFF -Denable_tracing=ON -Denable_smpi=ON -Denable_smpi_MPICH3_testsuite=ON -Denable_compile_optimizations=OFF -Denable_compile_warnings=ON -Denable_lib_static=OFF -Denable_model-checking=OFF -Denable_latency_bound_tracking=OFF -Denable_gtnets=OFF -Denable_jedule=OFF -Denable_mallocators=OFF -Denable_memcheck=OFF -Denable_memcheck_xml=OFF -Denable_coverage=ON $WORKSPACE +cmake -Denable_documentation=OFF -Denable_lua=OFF -Denable_tracing=ON -Denable_smpi=ON -Denable_smpi_MPICH3_testsuite=ON -Denable_compile_optimizations=OFF -Denable_compile_warnings=ON -Denable_lib_static=OFF -Denable_model-checking=OFF -Denable_latency_bound_tracking=OFF -Denable_gtnets=OFF -Denable_jedule=OFF -Denable_mallocators=OFF -Denable_memcheck=OFF -Denable_memcheck_xml=OFF -Denable_coverage=ON $WORKSPACE make ctest -D ExperimentalStart @@ -44,7 +44,7 @@ ctest -D ExperimentalTest ctest -D ExperimentalCoverage if [ -f Testing/TAG ] ; then - /usr/local/gcovr-3.1/scripts/gcovr -r .. --xml-pretty -o $WORKSPACE/xml_coverage.xml + /usr/local/gcovr-3.1/scripts/gcovr -r .. --xml-pretty -o $WORKSPACE/xml_coverage.xml xsltproc $WORKSPACE/buildtools/jenkins/ctest2junit.xsl Testing/`head -n 1 < Testing/TAG`/Test.xml > CTestResults_memcheck.xml mv CTestResults_memcheck.xml $WORKSPACE fi diff --git a/buildtools/jenkins/runmingw.sh b/buildtools/jenkins/runmingw.sh index dc901e89f5..27cad0bc00 100755 --- a/buildtools/jenkins/runmingw.sh +++ b/buildtools/jenkins/runmingw.sh @@ -16,7 +16,7 @@ fi if [ "$build_mode" = "ModelChecker" ] then -cmake -G "MSYS Makefiles" -Denable_model-checking=ON -Denable_compile_optimizations=OFF .. +cmake -G "MSYS Makefiles" -Denable_documentation=OFF -Denable_model-checking=ON -Denable_compile_optimizations=OFF .. fi make -- 2.20.1