X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c5c1970d1789e6fd9ca264d279a86abd8621bd5d..bca34544d743e984cc9a66edc89df4c7b9905bff:/buildtools/Cmake/GenerateDoc.cmake diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index ae81f04f02..bcae064765 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -1,30 +1,19 @@ #### Generate the whole html documentation -find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS) -find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS) - -if(DOXYGEN_PATH) - - execute_process(COMMAND ${DOXYGEN_PATH}/doxygen --version OUTPUT_VARIABLE DOXYGEN_VERSION ) - string(REGEX MATCH "^[0-9]" DOXYGEN_MAJOR_VERSION "${DOXYGEN_VERSION}") - string(REGEX MATCH "^[0-9].[0-9]" DOXYGEN_MINOR_VERSION "${DOXYGEN_VERSION}") - string(REGEX MATCH "^[0-9].[0-9].[0-9]" DOXYGEN_PATCH_VERSION "${DOXYGEN_VERSION}") - string(REGEX REPLACE "^${DOXYGEN_MINOR_VERSION}." "" DOXYGEN_PATCH_VERSION "${DOXYGEN_PATCH_VERSION}") - string(REGEX REPLACE "^${DOXYGEN_MAJOR_VERSION}." "" DOXYGEN_MINOR_VERSION "${DOXYGEN_MINOR_VERSION}") - message(STATUS "Doxygen version : ${DOXYGEN_MAJOR_VERSION}.${DOXYGEN_MINOR_VERSION}.${DOXYGEN_PATCH_VERSION}") - - include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateUserGuide.cmake) - include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateRefGuide.cmake) - include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateDevGuide.cmake) +if (enable_documentation) + find_package(Doxygen REQUIRED) + set(DocAll "ALL") +else() + find_package(Doxygen) +endif() - set(DOC_PNGS - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png - ) +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) - configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) +if(DOXYGEN_FOUND) - ADD_CUSTOM_TARGET(simgrid_documentation + 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 @@ -32,20 +21,57 @@ if(DOXYGEN_PATH) WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc ) - foreach(file ${DOC_PNGS}) - ADD_CUSTOM_COMMAND( - TARGET simgrid_documentation - COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/ - ) - endforeach(file ${DOC_PNGS}) + message(STATUS "Doxygen version: ${DOXYGEN_VERSION}") + + # This is a workaround for older cmake versions + # (such as 2.8.7 on Ubuntu 12.04). These cmake versions do not provide the + # DOXYGEN_VERSION variable and hence, building the documentation will always + # fail. This code is the same as used in the cmake library, version 3. + if(DOXYGEN_EXECUTABLE) + execute_process(COMMAND ${DOXYGEN_EXECUTABLE} "--version" OUTPUT_VARIABLE DOXYGEN_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE) + endif() - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/ + if(DOXYGEN_VERSION VERSION_LESS "1.8") + ADD_CUSTOM_TARGET(error_doxygen + COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation. Version found: ${DOXYGEN_VERSION}" + COMMAND false ) - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation - COMMAND ${CMAKE_COMMAND} -E echo "XX Doxygen pass" - COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile + add_dependencies(doc error_doxygen) + endif() + + configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) + + foreach(file ${DOC_FIGS}) + string(REPLACE ".fig" ".png" tmp_file ${file}) + string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file}) + ADD_CUSTOM_COMMAND(TARGET doc + COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} + ) + endforeach() + + foreach(file ${DOC_IMG}) + ADD_CUSTOM_COMMAND( + TARGET doc + COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/ + ) + endforeach() + + ADD_CUSTOM_COMMAND(TARGET doc + COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/ ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map + 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_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_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_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 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc ) @@ -60,157 +86,34 @@ if(DOXYGEN_PATH) COMMAND ${CMAKE_COMMAND} -E rename ${CMAKE_HOME_DIRECTORY}/doc/latex/refman.pdf ${CMAKE_HOME_DIRECTORY}/doc/latex/simgrid_documentation.pdf WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/latex/ ) - add_dependencies(pdf simgrid_documentation) + add_dependencies(pdf doc) - ADD_CUSTOM_TARGET(error_doxygen - COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation" - COMMAND false - ) - if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8") - add_dependencies(simgrid_documentation error_doxygen) - else() - add_dependencies(simgrid_documentation ref_guide) - add_dependencies(simgrid_documentation user_guide) - add_dependencies(simgrid_documentation dev_guide) - endif() -endif() ############################################# ### Fill in the "make sync-gforge" target ### ############################################# -### TODO: LBO: CHECK IF CORRECT -add_custom_target(sync-gforge-doc - COMMAND chmod g+rw -R doc/ - COMMAND chmod a+rX -R doc/ - COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true - COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/ || true - COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/ || true - COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/ || true - COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true - COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html/ || true - COMMAND ssh scm.gforge.inria.fr mkdir /home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html/ || true - - COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times - doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true - - COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times - doc/user_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/user_guide/html/ || true +set(RSYNC_CMD rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --times --omit-dir-times --perms --chmod=a+rX,ug+w,o-w,Dg+s) - COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times - doc/ref_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ref_guide/html || true +add_custom_target(sync-gforge-doc + COMMAND ssh scm.gforge.inria.fr mkdir -p -m 2775 /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true - COMMAND rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --perms --times --omit-dir-times - doc/dev_guide/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/dev_guide/html || true + COMMAND ${RSYNC_CMD} doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true - COMMAND scp doc/user_guide/html/simgrid_modules2.png doc/user_guide/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png + COMMAND ${RSYNC_CMD} doc/html/simgrid_modules2.png doc/html/simgrid_modules.png doc/webcruft/simgrid_logo_2011.png doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/ + WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}" ) -add_dependencies(sync-gforge-doc simgrid_documentation) +add_dependencies(sync-gforge-doc doc) add_custom_target(sync-gforge-dtd - COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd - COMMAND scp src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd + COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd + COMMAND ${RSYNC_CMD} src/surf/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid.dtd WORKING_DIRECTORY "${CMAKE_HOME_DIRECTORY}" ) -##############################################################################" -# GTUT FILES - -#message(STATUS "Check individual TOCs") - -#foreach(file_name ${LISTE_GTUT}) -# file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc) -# file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc) -# -# file(READ "${file_name}" file_content) -# string(REGEX MATCH "Table of Contents.*
" valeur_line "${file_content}") -# string(REPLACE "\n" ";" valeur_line "${valeur_line}") -# string(REPLACE "\n" ";" file_content "${file_content}") -# -# file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "\n") # make sure it exists -# foreach(line ${file_content}) -# string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}") -# string(REGEX MATCH ".*_toc.*" line3 "${line}") -# if(line2 AND NOT line3) -# string(REPLACE "\\section " "" line2 ${line2}) -# string(REPLACE "\\subsection " "subsection" line2 ${line2}) -# string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2}) -# string(REGEX REPLACE " .*" "" line2 ${line2}) -# set(line2 " - \\ref ${line2}") -# string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2}) -# string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2}) -# file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "${line2}\n") -# endif() -# endforeach(line ${file_content}) -# -# file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc "\n") # make sure it exists -# foreach(line ${valeur_line}) -# string(REGEX MATCH ".*ref.*" line_ok ${line}) -# if(line_ok) -# file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc "${line_ok}\n") -# endif() -# endforeach(line ${valeur_line}) -# -# exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc" OUTPUT_VARIABLE compare_files) -# if(compare_files) -# message(STATUS "Wrong toc for ${file_name}. Should be:") -# file(READ "${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc" file_content) -# message("${file_content}") -# exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc") -# endif() -#endforeach(file_name ${LISTE_GTUT}) -# -#file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc) -#file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc) -# -#message(STATUS "Check main TOC") -# -#foreach(file_name ${LISTE_GTUT}) -# file(READ "${file_name}" file_content) -# string(REGEX MATCH "Table of Contents.*
" valeur_line "${file_content}") -# string(REPLACE "\n" ";" valeur_line "${valeur_line}") -# string(REPLACE "\n" ";" file_content "${file_content}") -# -# foreach(line ${file_content}) -# string(REGEX MATCH ".*@page.*" line2 "${line}") -# if(line2) -# string(REPLACE "@page " "" line2 "${line2}") -# string(REGEX REPLACE " .*" "" line2 "${line2}") -# set(line2 " - \\ref ${line2}") -# file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc "${line2}\n") -# endif() -# endforeach(line ${file_content}) -# -# foreach(line ${valeur_line}) -# string(REGEX MATCH ".*toc.*" line1 "${line}") -# string(REGEX MATCH ".*
.*" line2 "${line}") -# string(REGEX MATCH "^[ ]*$" line3 "${line}") -# string(REGEX MATCH "Table of Contents" line4 "${line}") -# if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4) -# file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc " ${line}\n") -# endif() -# endforeach(line ${valeur_line}) -#endforeach(file_name ${LISTE_GTUT}) -# -#file(READ "${CMAKE_HOME_DIRECTORY}/doc/doxygen/gtut-tour.doc" file_content) -#string(REPLACE "\n" ";" file_content "${file_content}") -#foreach(line ${file_content}) -# string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}") -# if(line1) -# file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc "${line}\n") -# endif() -#endforeach(line ${file_content}) -# -#exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc" OUTPUT_VARIABLE compare_files) -#if(compare_files) -# message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc") -# exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc") -#else() -# file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.realtoc) -#endif() -# -#file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/doxygen/tmp.curtoc) \ No newline at end of file +endif() +