X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/c7b463c9c17665403d001fc59cb649551e93d950..1290a5bf942b9018ab6e3e626655e55abeb36142:/buildtools/Cmake/GenerateUserGuide.cmake diff --git a/buildtools/Cmake/GenerateUserGuide.cmake b/buildtools/Cmake/GenerateUserGuide.cmake index 5bee891ccd..124fdd2e49 100644 --- a/buildtools/Cmake/GenerateUserGuide.cmake +++ b/buildtools/Cmake/GenerateUserGuide.cmake @@ -1,216 +1,209 @@ #### Generate the html documentation for the user guide. file(GLOB_RECURSE source_doxygen - "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]" - "${CMAKE_HOME_DIRECTORY}/src/*.[chl]" - "${CMAKE_HOME_DIRECTORY}/include/*.[chl]" -) + "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]" + "${CMAKE_HOME_DIRECTORY}/src/*.[chl]" + "${CMAKE_HOME_DIRECTORY}/include/*.[chl]" + ) if(FIG2DEV_PATH) + set(DOC_PNGS + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png + ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png + ) + + configure_file(${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/UserGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/UserGuideDoxyfile @ONLY) + + ADD_CUSTOM_TARGET(user_guide + COMMENT "Generating the SimGrid user guide..." + DEPENDS ${USER_GUIDE_SOURCES} ${DOC_FIGS} ${source_doxygen} + COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html + COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen + ) + + ADD_CUSTOM_COMMAND(TARGET user_guide + DEPENDS ${source_doxygen} + COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_HOME_DIRECTORY}/doc/user_guide/logcategories.doc + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/logcategories.doc + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY} + ) + + foreach(file ${DOC_FIGS}) + string(REPLACE ".fig" ".png" tmp_file ${file}) + string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/" tmp_file ${tmp_file}) + ADD_CUSTOM_COMMAND(TARGET user_guide + COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} + ) + endforeach(file ${DOC_FIGS}) + + foreach(file ${DOC_PNGS}) + ADD_CUSTOM_COMMAND(TARGET user_guide + COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ + ) + endforeach(file ${DOC_PNGS}) + + ADD_CUSTOM_COMMAND(TARGET user_guide + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ + COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ + ) + + ADD_CUSTOM_COMMAND(TARGET user_guide + 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/user_guide/doxygen/simgrid_modules.map + COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" + COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile + + COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass" + COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile + + COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/dir* + + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen + ) - set(DOCSSOURCES "${source_doxygen}\n${USER_GUIDE_SOURCES}") - string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES}) - - - set(DOC_PNGS - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_01.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_02.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_03.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_04.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_05.png - ${CMAKE_HOME_DIRECTORY}/doc/webcruft/win_install_06.png - ) - - configure_file(${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/UserGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/UserGuideDoxyfile @ONLY) - - ADD_CUSTOM_TARGET(user_guide - COMMENT "Generating the SimGrid user guide..." - DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} - COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html - COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen - ) - - ADD_CUSTOM_COMMAND(TARGET user_guide - DEPENDS ${source_doxygen} - COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/logcategories.doc - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY} - ) - - foreach(file ${DOC_FIGS}) - string(REPLACE ".fig" ".png" tmp_file ${file}) - string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/" tmp_file ${tmp_file}) - ADD_CUSTOM_COMMAND(TARGET user_guide - COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file} - ) - endforeach(file ${DOC_FIGS}) - - foreach(file ${DOC_PNGS}) - ADD_CUSTOM_COMMAND(TARGET user_guide - COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ - ) - endforeach(file ${DOC_PNGS}) - - ADD_CUSTOM_COMMAND(TARGET user_guide - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/AS_hierarchy.png ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ - COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/ - ) - - ADD_CUSTOM_COMMAND(TARGET user_guide - 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/user_guide/doxygen/simgrid_modules.map - COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" - COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgriduserguide.tag index-API.doc - - COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass" - COMMAND ${DOXYGEN_PATH}/doxygen UserGuideDoxyfile - - COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/user_guide/html/dir* - - WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen - ) - else(FIG2DEV_PATH) - ADD_CUSTOM_TARGET(user_guide - COMMENT "Generating the SimGrid user guide..." - ) + ADD_CUSTOM_TARGET(user_guide + COMMENT "Generating the SimGrid user guide..." + ) - ADD_CUSTOM_COMMAND(TARGET user_guide - COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}" - COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}" - COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!" - COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..." - COMMAND false - ) + ADD_CUSTOM_COMMAND(TARGET user_guide + COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}" + COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}" + COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!" + COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..." + COMMAND false + ) - endif(FIG2DEV_PATH) ##############################################################################" -message(STATUS "Check individual TOCs") -set(LISTE_GTUT - doc/user_guide/doxygen/gtut-tour-00-install.doc - doc/user_guide/doxygen/gtut-tour-01-bones.doc - doc/user_guide/doxygen/gtut-tour-02-simple.doc - doc/user_guide/doxygen/gtut-tour-03-args.doc - doc/user_guide/doxygen/gtut-tour-04-callback.doc - doc/user_guide/doxygen/gtut-tour-05-globals.doc - doc/user_guide/doxygen/gtut-tour-06-logs.doc - doc/user_guide/doxygen/gtut-tour-07-timers.doc - doc/user_guide/doxygen/gtut-tour-08-exceptions.doc - doc/user_guide/doxygen/gtut-tour-09-simpledata.doc - doc/user_guide/doxygen/gtut-tour-10-rpc.doc - doc/user_guide/doxygen/gtut-tour-11-explicitwait.doc - doc/user_guide/doxygen/gtut-tour-recap-messages.doc - doc/user_guide/doxygen/gtut-tour-12-staticstruct.doc - doc/user_guide/doxygen/gtut-tour-13-pointers.doc - doc/user_guide/doxygen/gtut-tour-14-dynar.doc - doc/user_guide/doxygen/gtut-tour-15-manualdatadef.doc - doc/user_guide/doxygen/gtut-tour-16-exchangecb.doc -) - -foreach(file_name ${LISTE_GTUT}) - file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.curtoc) - file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen/tmp.realtoc) - - file(READ "${file_name}" file_content) - string(REGEX MATCH "Table of Contents.*