### Build the doc
if(NOT WIN32)
-include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateUserGuide.cmake)
-include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateRefGuide.cmake)
include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateDoc.cmake)
else(NOT WIN32)
include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateDocWin.cmake)
#### 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(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
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
+
+ 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}")
+
+ include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateUserGuide.cmake)
+ include(${CMAKE_HOME_DIRECTORY}/buildtools/Cmake/GenerateRefGuide.cmake)
+
+ 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
+ )
+
+ 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 Doxygen pass"
+ COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
+ 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
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)
+
+ ADD_CUSTOM_TARGET(error_doxygen
+ COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation"
+ COMMAND false
+ )
+
+ if(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
+ add_dependencies(simgrid_documentation error_doxygen)
+ else(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
+ add_dependencies(simgrid_documentation ref_guide)
+ add_dependencies(simgrid_documentation user_guide)
+ endif(DOXYGEN_MAJOR_VERSION STRLESS "2" AND DOXYGEN_MINOR_VERSION STRLESS "8")
+
+endif(DOXYGEN_PATH)
#### Generate the html documentation
-find_path(WGET_PATH NAMES wget.exe PATHS NO_DEFAULT_PATHS)
+find_path(WGET_PATH NAMES wget.exe PATHS NO_DEFAULT_PATHS)
find_path(NSIS_PATH NAMES makensis.exe PATHS NO_DEFAULT_PATHS)
message(STATUS "wget: ${WGET_PATH}")
message(STATUS "nsis: ${NSIS_PATH}")
if(WGET_PATH)
- ADD_CUSTOM_TARGET(simgrid_documentation
- COMMENT "Downloading the SimGrid documentation..."
- COMMAND ${WGET_PATH}/wget.exe -r -np -nH -nd http://simgrid.gforge.inria.fr/simgrid/${release_version}/doc/
- WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/html
- )
+ ADD_CUSTOM_TARGET(simgrid_documentation
+ COMMENT "Downloading the SimGrid documentation..."
+ COMMAND ${WGET_PATH}/wget.exe -r -np -nH -nd http://simgrid.gforge.inria.fr/simgrid/${release_version}/doc/
+ WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/html
+ )
endif(WGET_PATH)
if(NSIS_PATH)
ADD_CUSTOM_TARGET(nsis
- COMMENT "Generating the SimGrid installor for Windows..."
- DEPENDS simgrid simgrid gras graphicator tesh simgrid-colorizer simgrid_update_xml
- COMMAND ${NSIS_PATH}/makensis.exe simgrid.nsi
- WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/
+ COMMENT "Generating the SimGrid installor for Windows..."
+ DEPENDS simgrid simgrid gras graphicator tesh simgrid-colorizer simgrid_update_xml
+ COMMAND ${NSIS_PATH}/makensis.exe simgrid.nsi
+ WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/
)
endif(NSIS_PATH)
\ No newline at end of file
#### Generate the html documentation
-find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
-find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS)
-
-
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)
-if(DOXYGEN_PATH AND FIG2DEV_PATH)
-
- set(REFDOCSSOURCES "${source_doxygen}\n${REF_GUIDE_SOURCES}")
- string(REPLACE "\n" ";" REFDOCSSOURCES ${REFDOCSSOURCES})
+ set(REFDOCSSOURCES "${source_doxygen}\n${REF_GUIDE_SOURCES}")
+ string(REPLACE "\n" ";" REFDOCSSOURCES ${REFDOCSSOURCES})
- 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/ref_guide/doxygen/RefGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/RefGuideDoxyfile @ONLY)
-
- ADD_CUSTOM_TARGET(ref_guide
- COMMENT "Generating the SimGrid ref guide..."
- DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
- COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
- COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
- WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/
- )
-
- ADD_CUSTOM_COMMAND(TARGET ref_guide
- DEPENDS ${source_doxygen}
- COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/logcategories.doc
- COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/ref_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/ref_guide/html/" tmp_file ${tmp_file})
- ADD_CUSTOM_COMMAND(TARGET ref_guide
- COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
- )
- endforeach(file ${DOC_FIGS})
-
- foreach(file ${DOC_PNGS})
- ADD_CUSTOM_COMMAND(TARGET ref_guide
- COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/
- )
- endforeach(file ${DOC_PNGS})
-
- ADD_CUSTOM_COMMAND(TARGET ref_guide
- COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/
- )
-
- ADD_CUSTOM_COMMAND(TARGET ref_guide
+ 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/ref_guide/doxygen/RefGuideDoxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/RefGuideDoxyfile @ONLY)
+
+ ADD_CUSTOM_TARGET(ref_guide
+ COMMENT "Generating the SimGrid ref guide..."
+ DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
+ COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
+ COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html
+ WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/
+ )
+
+ ADD_CUSTOM_COMMAND(TARGET ref_guide
+ DEPENDS ${source_doxygen}
+ COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/logcategories.doc
+ COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/ref_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/ref_guide/html/" tmp_file ${tmp_file})
+ ADD_CUSTOM_COMMAND(TARGET ref_guide
+ COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file}
+ )
+ endforeach(file ${DOC_FIGS})
+
+ foreach(file ${DOC_PNGS})
+ ADD_CUSTOM_COMMAND(TARGET ref_guide
+ COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/
+ )
+ endforeach(file ${DOC_PNGS})
+
+ ADD_CUSTOM_COMMAND(TARGET ref_guide
+ COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/
+ )
+
+ ADD_CUSTOM_COMMAND(TARGET ref_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/<IMG/<IMG style=border:0px/g' | ${CMAKE_HOME_DIRECTORY}/tools/doxygen/fig2dev_postprocessor.pl > ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/simgrid_modules.map
- COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
- COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
- COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgridrefguide.tag index-API.doc
-
- COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
- COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
-
- COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/dir*
-
-
- WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen
- )
-
+ COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
+ COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
+ COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgridrefguide.tag index-API.doc
+
+ COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
+ COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
+
+ COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/html/dir*
+
+
+ WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen
+ )
+
else(DOXYGEN_PATH AND FIG2DEV_PATH)
- ADD_CUSTOM_TARGET(ref_guide
- COMMENT "Generating the SimGrid documentation..."
- )
+ ADD_CUSTOM_TARGET(ref_guide
+ COMMENT "Generating the SimGrid documentation..."
+ )
- ADD_CUSTOM_COMMAND(TARGET ref_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 ref_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(DOXYGEN_PATH AND FIG2DEV_PATH)
+
+endif(FIG2DEV_PATH)
##############################################################################"
#### Generate the html documentation for the user guide.
-find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
-find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS)
-
-
file(GLOB_RECURSE source_doxygen
"${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]"
"${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
"${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
)
-
-if(DOXYGEN_PATH AND FIG2DEV_PATH)
+if(FIG2DEV_PATH)
set(DOCSSOURCES "${source_doxygen}\n${USER_GUIDE_SOURCES}")
string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/user_guide/doxygen
)
-else(DOXYGEN_PATH AND FIG2DEV_PATH)
+else(FIG2DEV_PATH)
ADD_CUSTOM_TARGET(user_guide
COMMENT "Generating the SimGrid user guide..."
)
-endif(DOXYGEN_PATH AND FIG2DEV_PATH)
+endif(FIG2DEV_PATH)
##############################################################################"
