Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Mention Debian package for bibtex2html in error msg
[simgrid.git] / buildtools / Cmake / GenerateDoc.cmake
index 39ba55b..8be3928 100644 (file)
@@ -46,8 +46,6 @@ 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}
-               COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
-               COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_HOME_DIRECTORY}/doc/html
                COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/<IMG/<IMG style=border:0px/g' | ${CMAKE_HOME_DIRECTORY}/tools/doxygen/fig2dev_postprocessor.pl > ${CMAKE_HOME_DIRECTORY}/doc/simgrid_modules.map
                WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
        )
@@ -83,8 +81,8 @@ 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
                
@@ -111,33 +109,27 @@ 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
-               COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${CMAKE_HOME_DIRECTORY}/doc/all.bib > ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html
-       )
-       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
-
-               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(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
 
-       foreach(file "publis_core publis_extern publis_intra")
-               ADD_CUSTOM_COMMAND(
-                       OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/${file}.html
-                       DEPENDS "${file}.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_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl ${file}
-               )
+               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/${file}.html)
-       endforeach(file "publis_core publis_extern publis_intra")
+       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)
 
@@ -148,7 +140,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)
 
@@ -159,7 +154,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
                        )
 
                
@@ -167,7 +163,7 @@ endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND IC
 
 ##############################################################################"
 
-message("-- Check individual TOCs")
+message(STATUS "Check individual TOCs")
 file(GLOB_RECURSE LISTE_GTUT
        "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour-*.doc"
 )
@@ -204,7 +200,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")
@@ -214,7 +210,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)  
@@ -254,10 +250,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)