X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/29b5da45efed507007ff56b9783fa4ac077d0466..50e15ee7582a4a76c2a8536ac6ed42a88eec58a6:/buildtools/Cmake/GenerateDoc.cmake diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index eee4ab99d5..b357380e0f 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -1,9 +1,22 @@ -message("\tBIBTEX2HTML : ${BIBTEX2HTML}") +#### 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" +) + + +#### Generate the html documentation 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 +24,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 +54,14 @@ 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 + configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @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 - + 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 ) @@ -99,20 +96,20 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV ) ADD_CUSTOM_COMMAND(TARGET simgrid_documentation + COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile - COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass" 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_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 @@ -127,40 +124,61 @@ if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ ) - - ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html - DEPENDS all.bib + ADD_CUSTOM_TARGET(bib_files + DEPENDS ${CMAKE_HOME_DIRECTORY}/doc/all.bib + COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html + COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html + COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_core.bib publis_extern.bib publis_intra.bib" + COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"core\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_core.bib + COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"extern\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_extern.bib + COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"intra\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_intra.bib + + COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_count.html" COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${CMAKE_HOME_DIRECTORY}/doc/all.bib > ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html + + COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_core.html publis_extern.html publis_intra.html" + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_core + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_extern + COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_intra + + WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ ) - add_dependencies(simgrid_documentation ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html) - ADD_CUSTOM_COMMAND( - OUTPUT publis_core.bib publis_extern.bib publis_intra.bib - DEPENDS all.bib + add_dependencies(simgrid_documentation bib_files) + +else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION) - COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "core"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_core.bib - COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "extern"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_extern.bib - COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category "intra"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' ${CMAKE_HOME_DIRECTORY}/doc/all.bib -o ${CMAKE_HOME_DIRECTORY}/doc/publis_intra.bib - ) + ADD_CUSTOM_TARGET(simgrid_documentation + COMMENT "Generating the SimGrid documentation..." + ) - foreach(file "publis_core publis_extern publis_intra") - ADD_CUSTOM_COMMAND( - OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/${file}.html - DEPENDS "${file}.bib" - - COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl ${file} - ) + 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:" + 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) - 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") + 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 ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..." + COMMAND false + ) + + +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") +message(STATUS "Check individual TOCs") file(GLOB_RECURSE LISTE_GTUT "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour-*.doc" ) @@ -197,7 +215,7 @@ foreach(file_name ${LISTE_GTUT}) exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files) if(compare_files) - message("Wrong toc for ${file_name}. Should be:") + message(STATUS "Wrong toc for ${file_name}. Should be:") file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content) message("${file_content}") exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc") @@ -207,7 +225,7 @@ endforeach(file_name ${LISTE_GTUT}) file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc) file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc) -message("Check main TOC") +message(STATUS "Check main TOC") foreach(file_name ${LISTE_GTUT}) file(READ "${file_name}" file_content) @@ -247,10 +265,10 @@ endforeach(line ${file_content}) exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files) if(compare_files) - message("Wrong toc for gtut-tour.doc Right one is in tmp.realtoc") + message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc") exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc") 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)