X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b4e1ff1d7acc7cbbd793877dbd2603801d705c6c..6dd4ce8fb4a20019776994322c57b4ed11756f8f:/buildtools/Cmake/GenerateDoc.cmake diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index bda480e43d..90cbac4002 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -1,3 +1,19 @@ +#### Generate the manpages +if( NOT MANPAGE_DIRECTORY ) + set( MANPAGE_DIRECTORY /usr/share/man/man1 ) +endif( NOT MANPAGE_DIRECTORY) + +set(MANPAGES doc/simgrid_update_xml.1) + +add_custom_command(OUTPUT doc/simgrid_update_xml.1 + COMMAND pod2man tools/simgrid_update_xml.pl > doc/simgrid_update_xml.1 + COMMENT "Generating manpage for simgrid_update_xml" +) +install(FILES ${MANPAGES} + DESTINATION $ENV{DESTDIR}${CMAKE_INSTALL_PREFIX}/share/man/man1/) + +#### Generate the html documentation + if(BIBTEX2HTML) set(BIBTEX2HTML_PATH ${BIBTEX2HTML}) else(BIBTEX2HTML) @@ -45,7 +61,7 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV ADD_CUSTOM_TARGET(simgrid_documentation COMMENT "Generating the SimGrid documentation..." - DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} + DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} ${DOC_bib} ${MANPAGES} 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 ) @@ -91,9 +107,9 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV 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_HOME_DIRECTORY}/tools/doxygen/index_php.pl index.php.in html/index.html index.php + 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 @@ -140,7 +156,10 @@ else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICO 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" + COMMAND ${CMAKE_COMMAND} -E echo "You can download it from:" + COMMAND ${CMAKE_COMMAND} -E echo " ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz" + COMMAND ${CMAKE_COMMAND} -E echo "There is also an unofficial Debian/Ubuntu package, see:" + COMMAND ${CMAKE_COMMAND} -E echo " http://www.loria.fr/~lnussbau/bibtex2html/README" ) endif(NOT GOOD_BIBTEX2HTML_VERSION) @@ -151,7 +170,8 @@ else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICO 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 ... + COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..." + COMMAND false ) @@ -160,9 +180,27 @@ endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND IC ##############################################################################" message(STATUS "Check individual TOCs") -file(GLOB_RECURSE LISTE_GTUT - "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour-*.doc" +set(LISTE_GTUT + doc/gtut-tour-00-install.doc + doc/gtut-tour-01-bones.doc + doc/gtut-tour-02-simple.doc + doc/gtut-tour-03-args.doc + doc/gtut-tour-04-callback.doc + doc/gtut-tour-05-globals.doc + doc/gtut-tour-06-logs.doc + doc/gtut-tour-07-timers.doc + doc/gtut-tour-08-exceptions.doc + doc/gtut-tour-09-simpledata.doc + doc/gtut-tour-10-rpc.doc + doc/gtut-tour-11-explicitwait.doc + doc/gtut-tour-recap-messages.doc + doc/gtut-tour-12-staticstruct.doc + doc/gtut-tour-13-pointers.doc + doc/gtut-tour-14-dynar.doc + doc/gtut-tour-15-manualdatadef.doc + doc/gtut-tour-16-exchangecb.doc ) + foreach(file_name ${LISTE_GTUT}) file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc) file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc) @@ -171,7 +209,8 @@ foreach(file_name ${LISTE_GTUT}) 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/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}") @@ -187,6 +226,7 @@ foreach(file_name ${LISTE_GTUT}) endif(line2 AND NOT line3) endforeach(line ${file_content}) + file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists foreach(line ${valeur_line}) string(REGEX MATCH ".*ref.*" line_ok ${line}) if(line_ok) @@ -252,4 +292,4 @@ else(compare_files) file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc) endif(compare_files) -file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc) \ No newline at end of file +file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)