X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/66a04c68ab4c5135a15505ca5484eb8c4e7cdca6..be088cd19b02f621c210cdfc937a16dcd4f571b4:/buildtools/Cmake/GenerateDoc.cmake diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index b6d5c3139c..6d9769e318 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -1,53 +1,73 @@ #### Generate the whole html documentation -find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS) +find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS) +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) -execute_process( - COMMAND ${DOXYGEN_PATH}/doxygen --version - RESULT_VARIABLE DOXYGEN_VERSION - ) -message(STATUS "${DOXYGEN_PATH}/doxygen --version Doxygen version : ${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}") - set(DOC_PNGS - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png - ) - - configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY) - - 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 - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc - ) - add_dependencies(simgrid_documentation ref_guide) - add_dependencies(simgrid_documentation user_guide) - 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}) - - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/ - ) - - ADD_CUSTOM_COMMAND(TARGET simgrid_documentation - COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" - COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc - ) - -endif(DOXYGEN_PATH) -ADD_CUSTOM_TARGET(pdf + + 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 + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc + ) + + 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}") + + if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8") + ADD_CUSTOM_TARGET(error_doxygen + COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation" + COMMAND false + ) + + add_dependencies(simgrid_documentation 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 simgrid_documentation + COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} + ) + endforeach() + + foreach(file ${DOC_IMG}) + ADD_CUSTOM_COMMAND( + TARGET simgrid_documentation + COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/ + ) + endforeach() + + ADD_CUSTOM_COMMAND(TARGET simgrid_documentation + 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_PATH}/doxygen 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_PATH}/doxygen 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/msg/*.java + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc + ) + + ADD_CUSTOM_TARGET(pdf COMMAND ${CMAKE_COMMAND} -E echo "XX First pass simgrid_documentation.pdf" COMMAND make clean COMMAND make pdf || true @@ -56,7 +76,34 @@ ADD_CUSTOM_TARGET(pdf COMMAND make pdf || true COMMAND ${CMAKE_COMMAND} -E echo "XX Write Simgrid_documentation.pdf" 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 simgrid_documentation) + + +endif() + +############################################# +### Fill in the "make sync-gforge" target ### +############################################# + +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) + +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_CMD} doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true + + 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_custom_target(sync-gforge-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}" + ) +