From: navarrop Date: Thu, 2 Dec 2010 10:40:38 +0000 (+0000) Subject: Remove variable enable_doc. X-Git-Tag: v3.6_beta2~1044 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/a37684dd40935e1c18856a7f77f8d1a2caeb2875 Remove variable enable_doc. By default create target simgrid_documentation but if tools are not available, it makes an error when user want to generate doc. git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@8868 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- diff --git a/CMakeLists.txt b/CMakeLists.txt index 38839a66c9..1b418756e2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -144,9 +144,7 @@ else(WIN32) endif(WIN32) ### Build the doc -if(enable_doc) - include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateDoc.cmake) -endif(enable_doc) +include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateDoc.cmake) ### Make Simgrid.jar and Java examples if(HAVE_JAVA) diff --git a/buildtools/Cmake/DefinePackages.cmake b/buildtools/Cmake/DefinePackages.cmake index fc7158282e..fe291cd8b6 100644 --- a/buildtools/Cmake/DefinePackages.cmake +++ b/buildtools/Cmake/DefinePackages.cmake @@ -601,7 +601,52 @@ set(DOC_SOURCES doc/module-xbt.doc doc/people.doc doc/publis.doc + + doc/gtut-files/01-bones.c + doc/gtut-files/01-bones.output + doc/gtut-files/02-simple.c + doc/gtut-files/02-simple.output + doc/gtut-files/03-args.c + doc/gtut-files/03-args.output + doc/gtut-files/03-args.xml + doc/gtut-files/04-callback.c + doc/gtut-files/04-callback.output + doc/gtut-files/05-globals.c + doc/gtut-files/05-globals.output + doc/gtut-files/06-logs.c + doc/gtut-files/06-logs.output + doc/gtut-files/06-logs.output.error + doc/gtut-files/06-logs.output.fmt + doc/gtut-files/06-logs.output.fmt-bt + doc/gtut-files/06-logs.output.verbose + doc/gtut-files/07-timers.c + doc/gtut-files/07-timers.output + doc/gtut-files/08-exceptions.c + doc/gtut-files/08-exceptions.output + doc/gtut-files/09-datatype-dump.c + doc/gtut-files/09-simpledata.c + doc/gtut-files/09-simpledata.output + doc/gtut-files/10-rpc.c + doc/gtut-files/10-rpc.output + doc/gtut-files/11-explicitwait.c + doc/gtut-files/11-explicitwait.output + doc/gtut-files/11-explicitwait.xml + doc/gtut-files/gtut-platform-3nodes.xml + doc/gtut-files/gtut-platform.xml + doc/gtut-files/Makefile + doc/gtut-files/README + doc/gtut-files/test.xml + + doc/webcruft/awstats_logo3.png + doc/webcruft/Paje_MSG_screenshot.jpg + doc/webcruft/Paje_MSG_screenshot_thn.jpg + doc/webcruft/poster_thumbnail.png + doc/webcruft/robots.txt + doc/webcruft/simgrid_logo.png + doc/webcruft/simgrid_logo_small.png + doc/Doxyfile.in + tools/doxygen/bibtex2html_table_count.pl tools/doxygen/doxygen_postprocesser.pl tools/doxygen/index_create.pl @@ -611,6 +656,7 @@ set(DOC_SOURCES tools/doxygen/index_php.pl tools/doxygen/xbt_log_extract_hierarchy.pl ) + set(DOC_FIGS ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules.fig ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules2.fig diff --git a/buildtools/Cmake/Distrib.cmake b/buildtools/Cmake/Distrib.cmake index 8795e1db15..2e277a8116 100644 --- a/buildtools/Cmake/Distrib.cmake +++ b/buildtools/Cmake/Distrib.cmake @@ -207,7 +207,6 @@ endif(HAVE_RUBY) ### Fill in the "make dist-dir" target ### ########################################## -if(enable_doc) add_custom_target(dist-dir COMMENT "Generating the distribution directory" COMMAND test -e simgrid-${release_version}/ && chmod -R a+w simgrid-${release_version}/ || true @@ -217,12 +216,6 @@ add_custom_target(dist-dir COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_HOME_DIRECTORY}/doc/html/ simgrid-${release_version}/doc/html/ ) add_dependencies(dist-dir simgrid_documentation) -else(enable_doc) -add_custom_target(dist-dir - COMMAND ${CMAKE_COMMAND} -E echo "Please enable the doc to generate the doc" - COMMAND I_said_PLEASE_ENABLE_THE_DOC_GENERATION_BEFORE_BUILDING_AN_ARCHIVE -) -endif(enable_doc) set(dirs_in_tarball "") foreach(file ${source_to_pack}) diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index eee4ab99d5..389ff95624 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -1,9 +1,7 @@ -message("\tBIBTEX2HTML : ${BIBTEX2HTML}") - if(BIBTEX2HTML) -set(BIBTEX2HTML_PATH ${BIBTEX2HTML}) + set(BIBTEX2HTML_PATH ${BIBTEX2HTML}) else(BIBTEX2HTML) -find_path(BIBTEX2HTML_PATH NAMES bibtex2html PATHS NO_DEFAULT_PATHS) + find_path(BIBTEX2HTML_PATH NAMES bibtex2html PATHS NO_DEFAULT_PATHS) endif(BIBTEX2HTML) find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS) @@ -11,33 +9,23 @@ find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS) find_path(BIBTOOL_PATH NAMES bibtool PATHS NO_DEFAULT_PATHS) find_path(ICONV_PATH NAMES iconv PATHS NO_DEFAULT_PATHS) -message("\tFIG2DEV_PATH : ${FIG2DEV_PATH}") -message("\tDOXYGEN_PATH : ${DOXYGEN_PATH}") -message("\tBIBTOOL_PATH : ${BIBTOOL_PATH}") -message("\tICONV_PATH : ${ICONV_PATH}") -message("\tBIBTEX2HTML_PATH : ${BIBTEX2HTML_PATH}") - ### Check whether the bibtex2html that we found is the one that Arnaud requires exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE OUTPUT_BIBTEX2HTML_VERSION) STRING(REPLACE "[-bibtex]" "" OUTPUT_BIBTEX2HTML_VERSION_2 ${OUTPUT_BIBTEX2HTML_VERSION}) -if(BIBTEX2HTML_PATH) - if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version - message("\nERROR --> NEED to set bibtex2html path with \"ccmake ./\" or with \"cmake -DBIBTEX2HTML= ./\"") - message("\nTake care having install the good bibtex2html \n\t(download it : ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz)") - message(FATAL_ERROR "\n") - endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) -endif(BIBTEX2HTML_PATH) - - file(GLOB_RECURSE source_doxygen "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]" "${CMAKE_HOME_DIRECTORY}/src/*.[chl]" "${CMAKE_HOME_DIRECTORY}/include/*.[chl]" ) +if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version + SET(GOOD_BIBTEX2HTML_VERSION 0) +else(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # good version + SET(GOOD_BIBTEX2HTML_VERSION 1) +endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) -if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH) +if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION) string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}") @@ -51,20 +39,15 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png ) - message("WARNING = ${WARNING}") - message("srcdir = ${srcdir}") - message("top_srcdir = ${top_srcdir}") configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) - ADD_CUSTOM_TARGET(simgrid_documentation ALL + ADD_CUSTOM_TARGET(simgrid_documentation COMMENT "Generating the SimGrid documentation..." DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html - COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc ) @@ -104,15 +87,15 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc - COMMAND ${CMAKE_COMMAND} -E echo XX Second Doxygen pass + COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile - COMMAND ${CMAKE_COMMAND} -E echo XX Post-processing Doxygen result + COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result" COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir* COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_php.pl index.php.in html/index.html index.php COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl - COMMAND ${CMAKE_COMMAND} -E echo XX Create shortcuts pages + COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages" COMMAND ${CMAKE_COMMAND} -E echo \"\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html COMMAND ${CMAKE_COMMAND} -E echo \"


Grid Reality And Simulation.

\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html @@ -155,10 +138,33 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV add_dependencies(simgrid_documentation ${CMAKE_HOME_DIRECTORY}/doc/${file}.html) endforeach(file "publis_core publis_extern publis_intra") -else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH) - message(FATAL_ERROR "You asked to regenerate the documentation, but you are missing some build-dependencies. Please install them, or change enable_doc to OFF") +else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION) + + ADD_CUSTOM_TARGET(simgrid_documentation + COMMENT "Generating the SimGrid documentation..." + ) + + if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version + ADD_CUSTOM_COMMAND(TARGET simgrid_documentation + COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!" + COMMAND ${CMAKE_COMMAND} -E echo "You can download it from : ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz" + ) + endif(NOT GOOD_BIBTEX2HTML_VERSION) + + ADD_CUSTOM_COMMAND(TARGET simgrid_documentation + COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}" + COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}" + COMMAND ${CMAKE_COMMAND} -E echo "BIBTOOL_PATH = ${BIBTOOL_PATH}" + COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH = ${BIBTEX2HTML_PATH}" + COMMAND ${CMAKE_COMMAND} -E echo "ICONV_PATH = ${ICONV_PATH}" + COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!" + COMMAND FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ... + ) + + +endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION) -endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH) +##############################################################################" message("Check individual TOCs") file(GLOB_RECURSE LISTE_GTUT diff --git a/buildtools/Cmake/Option.cmake b/buildtools/Cmake/Option.cmake index 4c657c8edd..2a7deea2dd 100644 --- a/buildtools/Cmake/Option.cmake +++ b/buildtools/Cmake/Option.cmake @@ -34,7 +34,6 @@ set(enable_lua off CACHE TYPE INTERNAL FORCE) set(enable_ruby off CACHE TYPE INTERNAL FORCE) endif(WIN32 OR APPLE) -option(enable_doc "Whether we should rebuild the documentation" off) option(enable_compile_optimizations "" on) option(enable_compile_warnings "Whether compilation warnings should be turned into errors." off) option(enable_maintainer_mode "Whether flex and flexml files should be rebuilt." off) @@ -46,7 +45,6 @@ option(enable_memcheck "Enable memcheck." off) option(enable_print_message "Enable print message during config." off) option(enable_model-checking "" off) option(enable_lib_static "" off) -option(GRAS_IS_BROKEN "Set some tests are broken" off) if(enable_supernovae AND enable_model-checking) set(enable_model-checking false CACHE TYPE INTERNAL FORCE) diff --git a/buildtools/Cmake/PrintArgs.cmake b/buildtools/Cmake/PrintArgs.cmake index 2b4cc5cc36..1c8cdb499d 100644 --- a/buildtools/Cmake/PrintArgs.cmake +++ b/buildtools/Cmake/PrintArgs.cmake @@ -198,7 +198,6 @@ message(" Model checking : ${enable_model-checking}") message(" Tracing mode : ${enable_tracing}") message(" Latency bound : ${enable_latency_bound_tracking}") message(" Graphviz mode : ${HAVE_GRAPHVIZ}") -message(" Build SG doc : ${enable_doc}") message("") message(" Simgrid dependencies: ${SIMGRID_DEP}") message(" Gras dependencies : ${GRAS_DEP}") diff --git a/buildtools/Cmake/Supernovae.cmake b/buildtools/Cmake/Supernovae.cmake index ec2ac12043..8708389447 100644 --- a/buildtools/Cmake/Supernovae.cmake +++ b/buildtools/Cmake/Supernovae.cmake @@ -66,7 +66,7 @@ if (PERL_EXECUTABLE AND enable_supernovae) # I need supernovae and can use it ${CMAKE_CURRENT_BINARY_DIR}/src/supernovae_smpi.c) else(PERL_EXECUTABLE AND enable_supernovae) # I need supernovae and can use it if (enable_supernovae) - message(You need Perl to activate supernovae) + message("You need Perl to activate supernovae") set(enable_supernovae 0) endif(enable_supernovae) endif(PERL_EXECUTABLE AND enable_supernovae) # I need supernovae and can use it