tools/cmake/Documentation.cmake

   1 ###
   2 ### Generate all parts of the documentation on non-Windows systems
   3 ###
   4 ###   - HTML with doxygen (reference and manual)
   5 ###   - Javadoc (reference)
   6 ###   - manpages (reference of tools)
   7 ###
   8 ###  This file is not loaded on windows
   9
  10 #### Generate the html documentation
  11 if (enable_documentation)
  12   find_package(Doxygen REQUIRED)
  13 else()
  14   find_package(Doxygen)
  15 endif()
  16
  17 find_path(FIG2DEV_PATH  NAMES fig2dev  PATHS NO_DEFAULT_PATHS)
  18
  19 if(enable_documentation)
  20   ADD_CUSTOM_TARGET(documentation
  21     COMMENT "Generating the SimGrid documentation..."
  22     DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen}
  23     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_BINARY_DIR}/doc/doxygen
  24     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_BINARY_DIR}/doc/example_lists
  25     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/doc/html
  26     COMMAND ${CMAKE_COMMAND} -E make_directory   ${CMAKE_BINARY_DIR}/doc/html
  27     COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_BINARY_DIR}/doc/xml
  28     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
  29     )
  30
  31   message(STATUS "Doxygen version: ${DOXYGEN_VERSION}")
  32
  33   # This is a workaround for older cmake versions (such as 2.8.7 on Ubuntu 12.04). These cmake versions do not provide
  34   # the DOXYGEN_VERSION variable and hence, building the documentation will always  fail. This code is the same as used
  35   # in the cmake library, version 3.
  36   if(DOXYGEN_EXECUTABLE)
  37     execute_process(COMMAND ${DOXYGEN_EXECUTABLE} "--version" OUTPUT_VARIABLE DOXYGEN_VERSION OUTPUT_STRIP_TRAILING_WHITESPACE)
  38   endif()
  39
  40   if(DOXYGEN_VERSION VERSION_LESS "1.8")
  41     ADD_CUSTOM_TARGET(error_doxygen
  42         COMMAND ${CMAKE_COMMAND} -E echo "Doxygen must be at least version 1.8 to generate documentation. Version found: ${DOXYGEN_VERSION}"
  43       COMMAND false
  44     )
  45     add_dependencies(documentation error_doxygen)
  46   endif()
  47
  48   configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_BINARY_DIR}/doc/Doxyfile @ONLY)
  49
  50   foreach(file ${DOC_FIGS})
  51     string(REPLACE ".fig" ".png" tmp_file ${file})
  52     string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/shared/fig/" "${CMAKE_BINARY_DIR}/doc/html/" tmp_file ${tmp_file})
  53     ADD_CUSTOM_COMMAND(TARGET documentation  COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng -S 4 ${file} ${tmp_file})
  54   endforeach()
  55
  56   foreach(file ${DOC_IMG})
  57     ADD_CUSTOM_COMMAND(TARGET documentation COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_BINARY_DIR}/doc/html/)
  58   endforeach()
  59
  60   ADD_CUSTOM_COMMAND(TARGET documentation
  61     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_BINARY_DIR}/doc/simgrid_modules.map
  62     COMMAND pwd
  63     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate the index files"
  64     COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_BINARY_DIR}/doc/doxygen/logcategories.doc
  65     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl ${CMAKE_HOME_DIRECTORY} > ${CMAKE_BINARY_DIR}/doc/doxygen/logcategories.doc
  66     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate list of files in examples/ for routing models"
  67     COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_BINARY_DIR}/doc/example_lists/
  68     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh Floyd > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_floyd
  69     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh Dijkstra > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_dijkstra
  70     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh DijkstraCache > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_dijkstra_cache
  71     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="None"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_none
  72     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Cluster"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_cluster
  73     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Vivaldi"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_vivaldi
  74     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh 'routing="Full"' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_routing_full
  75     COMMAND ${CMAKE_COMMAND} -E echo "XX Generate list of files in examples/ for XML tags"
  76     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh '<mount ' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_xmltag_mount
  77     COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/list_routing_models_examples.sh '<link_ctn ' > ${CMAKE_BINARY_DIR}/doc/example_lists/example_filelist_xmltag_linkctn
  78     COMMAND ${CMAKE_COMMAND} -E echo "XX Run doxygen"
  79     COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
  80     COMMAND ${CMAKE_COMMAND} -E remove ${CMAKE_BINARY_DIR}/doc/simgrid_modules.map
  81     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
  82     )
  83
  84 ### Fill in the "make gforge-sync" target ###
  85
  86 set(RSYNC_CMD rsync --verbose --cvs-exclude --compress --delete --delete-excluded --rsh=ssh --ignore-times --recursive --links --times --omit-dir-times --perms --chmod=a+rX,ug+w,o-w,Dg+s)
  87
  88 add_custom_target(gforge-sync
  89   COMMAND ssh scm.gforge.inria.fr mkdir -p -m 2775 /home/groups/simgrid/htdocs/simgrid/${release_version}/ || true
  90
  91   COMMAND ${RSYNC_CMD} doc/html/ scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/doc/ || true
  92
  93   COMMAND ${RSYNC_CMD} doc/html/simgrid_modules2.png doc/html/simgrid_modules.png /${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011.png
  94   /${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_2011_small.png scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/
  95
  96   COMMAND ${RSYNC_CMD} ${CMAKE_HOME_DIRECTORY}/src/surf/xml/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/
  97   COMMAND ${RSYNC_CMD} ${CMAKE_HOME_DIRECTORY}/src/surf/xml/simgrid.dtd scm.gforge.inria.fr:/home/groups/simgrid/htdocs/simgrid/${release_version}/simgrid.dtd
  98
  99   WORKING_DIRECTORY "${CMAKE_BINARY_DIR}"
 100   )
 101 add_dependencies(gforge-sync documentation)
 102
 103 else(enable_documentation)
 104   ADD_CUSTOM_TARGET(documentation
 105     COMMENT "The generation of the SimGrid documentation was disabled in cmake"
 106     )
 107 endif(enable_documentation)
 108
 109 if (Java_FOUND)
 110   find_path(JAVADOC_PATH  NAMES javadoc   PATHS NO_DEFAULT_PATHS)
 111   mark_as_advanced(JAVADOC_PATH)
 112
 113   ADD_CUSTOM_COMMAND(TARGET documentation
 114     COMMAND ${CMAKE_COMMAND} -E echo "XX Javadoc pass"
 115     COMMAND ${JAVADOC_PATH}/javadoc -quiet -d ${CMAKE_BINARY_DIR}/doc/html/javadoc/ ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*.java ${CMAKE_HOME_DIRECTORY}/src/bindings/java/org/simgrid/*/*.java
 116     WORKING_DIRECTORY ${CMAKE_BINARY_DIR}/doc
 117   )
 118 endif()
 119
 120 #### Generate the manpages
 121 if( NOT MANPAGE_DIR)
 122   set( MANPAGE_DIR ${CMAKE_BINARY_DIR}/manpages )
 123 endif()
 124
 125 add_custom_target(manpages ALL
 126   COMMAND ${CMAKE_COMMAND} -E make_directory ${MANPAGE_DIR}
 127   COMMAND pod2man ${CMAKE_HOME_DIRECTORY}/tools/simgrid_update_xml.pl > ${MANPAGE_DIR}/simgrid_update_xml.1
 128   COMMAND pod2man ${CMAKE_HOME_DIRECTORY}/doc/manpage/tesh.pod > ${MANPAGE_DIR}/tesh.1
 129   COMMENT "Generating manpages"
 130   )
 131 install(FILES
 132   ${MANPAGE_DIR}/simgrid_update_xml.1
 133   ${MANPAGE_DIR}/tesh.1
 134   ${CMAKE_HOME_DIRECTORY}/doc/manpage/smpicc.1
 135   ${CMAKE_HOME_DIRECTORY}/doc/manpage/smpicxx.1
 136   ${CMAKE_HOME_DIRECTORY}/doc/manpage/smpif90.1
 137   ${CMAKE_HOME_DIRECTORY}/doc/manpage/smpiff.1
 138   ${CMAKE_HOME_DIRECTORY}/doc/manpage/smpirun.1
 139   DESTINATION $ENV{DESTDIR}${CMAKE_INSTALL_PREFIX}/share/man/man1)