1 #### Generate the manpages
2 if( NOT MANPAGE_DIRECTORY )
3 set( MANPAGE_DIRECTORY /usr/share/man/man1 )
4 endif( NOT MANPAGE_DIRECTORY)
6 set(MANPAGES doc/simgrid_update_xml.1)
8 add_custom_command(OUTPUT doc/simgrid_update_xml.1
9 COMMAND pod2man tools/simgrid_update_xml.pl > doc/simgrid_update_xml.1
10 COMMENT "Generating manpage for simgrid_update_xml"
14 #### Generate the html documentation
17 set(BIBTEX2HTML_PATH ${BIBTEX2HTML})
19 find_path(BIBTEX2HTML_PATH NAMES bibtex2html PATHS NO_DEFAULT_PATHS)
22 find_path(FIG2DEV_PATH NAMES fig2dev PATHS NO_DEFAULT_PATHS)
23 find_path(DOXYGEN_PATH NAMES doxygen PATHS NO_DEFAULT_PATHS)
24 find_path(BIBTOOL_PATH NAMES bibtool PATHS NO_DEFAULT_PATHS)
25 find_path(ICONV_PATH NAMES iconv PATHS NO_DEFAULT_PATHS)
27 ### Check whether the bibtex2html that we found is the one that Arnaud requires
28 exec_program("${BIBTEX2HTML_PATH}/bibtex2html -version" OUTPUT_VARIABLE OUTPUT_BIBTEX2HTML_VERSION)
29 STRING(REPLACE "[-bibtex]" "" OUTPUT_BIBTEX2HTML_VERSION_2 ${OUTPUT_BIBTEX2HTML_VERSION})
31 file(GLOB_RECURSE source_doxygen
32 "${CMAKE_HOME_DIRECTORY}/tools/gras/*.[chl]"
33 "${CMAKE_HOME_DIRECTORY}/src/*.[chl]"
34 "${CMAKE_HOME_DIRECTORY}/include/*.[chl]"
37 if(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # wrong version
38 SET(GOOD_BIBTEX2HTML_VERSION 0)
39 else(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION}) # good version
40 SET(GOOD_BIBTEX2HTML_VERSION 1)
41 endif(${OUTPUT_BIBTEX2HTML_VERSION_2} STREQUAL ${OUTPUT_BIBTEX2HTML_VERSION})
43 if(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
45 string(REGEX REPLACE ";.*logcategories.doc" "" LISTE_DEUX "${LISTE_DEUX}")
47 #DOC_SOURCE=doc/*.doc, defined in DefinePackage
48 set(DOCSSOURCES "${source_doxygen}\n${DOC_SOURCE}")
49 string(REPLACE "\n" ";" DOCSSOURCES ${DOCSSOURCES})
53 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo.png
54 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/simgrid_logo_small.png
55 ${CMAKE_HOME_DIRECTORY}/doc/webcruft/poster_thumbnail.png
58 configure_file(${CMAKE_HOME_DIRECTORY}/doc/Doxyfile.in ${CMAKE_HOME_DIRECTORY}/doc/Doxyfile @ONLY)
59 configure_file(${CMAKE_HOME_DIRECTORY}/doc/footer.html.in ${CMAKE_HOME_DIRECTORY}/doc/footer.html @ONLY)
61 ADD_CUSTOM_TARGET(simgrid_documentation
62 COMMENT "Generating the SimGrid documentation..."
63 DEPENDS ${DOC_SOURCES} ${DOC_FIGS} ${source_doxygen} ${DOC_bib} ${MANPAGES}
64 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
65 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc
69 OUTPUT ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
70 DEPENDS ${source_doxygen}
71 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
72 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/xbt_log_extract_hierarchy.pl > ${CMAKE_HOME_DIRECTORY}/doc/logcategories.doc
73 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}
76 foreach(file ${DOC_FIGS})
77 string(REPLACE ".fig" ".png" tmp_file ${file})
78 string(REPLACE "${CMAKE_HOME_DIRECTORY}/doc/fig/" "${CMAKE_HOME_DIRECTORY}/doc/html/" tmp_file ${tmp_file})
79 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
80 COMMAND ${FIG2DEV_PATH}/fig2dev -Lpng ${file} ${tmp_file}
82 endforeach(file ${DOC_FIGS})
84 foreach(file ${DOC_PNGS})
85 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
86 COMMAND ${CMAKE_COMMAND} -E copy ${file} ${CMAKE_HOME_DIRECTORY}/doc/html/
88 endforeach(file ${DOC_PNGS})
90 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
91 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot_thn.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
92 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/webcruft/Paje_MSG_screenshot.jpg ${CMAKE_HOME_DIRECTORY}/doc/html/
93 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_configuration.png ${CMAKE_HOME_DIRECTORY}/doc/html/
94 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/triva-graph_visualization.png ${CMAKE_HOME_DIRECTORY}/doc/html/
95 COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_HOME_DIRECTORY}/doc/simgrid.css ${CMAKE_HOME_DIRECTORY}/doc/html/
98 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
99 COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
100 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
101 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgrid.tag index-API.doc
102 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/toc_create.pl FAQ.doc index.doc contrib.doc gtut-introduction.doc history.doc
104 COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
105 COMMAND ${DOXYGEN_PATH}/doxygen Doxyfile
107 COMMAND ${CMAKE_COMMAND} -E echo "XX Post-processing Doxygen result"
108 COMMAND ${CMAKE_COMMAND} -E remove -f ${CMAKE_HOME_DIRECTORY}/doc/html/dir*
109 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/doxygen_postprocesser.pl
110 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_php.pl index.php.in html/index.html index.php
112 COMMAND ${CMAKE_COMMAND} -E echo "XX Create shortcuts pages"
113 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
114 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__GRAS__API.html'>Grid Reality And Simulation.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/gras.html
116 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
117 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__AMOK__API.html'>Advanced Metacomputing Overlay Kit.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/amok.html
119 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
120 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__MSG__API.html'>Meta SimGrid.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/msg.html
122 COMMAND ${CMAKE_COMMAND} -E echo \"<html><META HTTP-EQUIV='Refresh' content='0;URL=http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>\" > ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
123 COMMAND ${CMAKE_COMMAND} -E echo \"<center><h2><br><a href='http://simgrid.gforge.inria.fr/doc/group__SD__API.html'>DAG Simulator.</a></h2></center></html>\" >> ${CMAKE_HOME_DIRECTORY}/doc/html/simdag.html
124 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
127 ADD_CUSTOM_TARGET(bib_files
128 DEPENDS ${CMAKE_HOME_DIRECTORY}/doc/all.bib
129 COMMAND ${CMAKE_COMMAND} -E remove_directory ${CMAKE_HOME_DIRECTORY}/doc/html
130 COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_HOME_DIRECTORY}/doc/html
131 COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_core.bib publis_extern.bib publis_intra.bib"
132 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"core\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_core.bib
133 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"extern\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_extern.bib
134 COMMAND ${BIBTOOL_PATH}/bibtool -- 'select.by.string={category \"intra\"}' -- 'preserve.key.case={on}' -- 'preserve.keys={on}' all.bib -o publis_intra.bib
136 COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_count.html"
137 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_table_count.pl < ${CMAKE_HOME_DIRECTORY}/doc/all.bib > ${CMAKE_HOME_DIRECTORY}/doc/publis_count.html
139 COMMAND ${CMAKE_COMMAND} -E echo "XX Generate publis_core.html publis_extern.html publis_intra.html"
140 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_core
141 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_extern
142 COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/bibtex2html_wrapper.pl publis_intra
144 WORKING_DIRECTORY ${CMAKE_HOME_DIRECTORY}/doc/
147 add_dependencies(simgrid_documentation bib_files)
149 else(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
151 ADD_CUSTOM_TARGET(simgrid_documentation
152 COMMENT "Generating the SimGrid documentation..."
155 if(NOT GOOD_BIBTEX2HTML_VERSION) # wrong version
156 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
157 COMMAND ${CMAKE_COMMAND} -E echo "This is not the good bibtex2html program !!!"
158 COMMAND ${CMAKE_COMMAND} -E echo "You can download it from:"
159 COMMAND ${CMAKE_COMMAND} -E echo " ftp://ftp-sop.inria.fr/epidaure/Softs/bibtex2html/bibtex2html-1.02.tar.gz"
160 COMMAND ${CMAKE_COMMAND} -E echo "There is also an unofficial Debian/Ubuntu package, see:"
161 COMMAND ${CMAKE_COMMAND} -E echo " http://www.loria.fr/~lnussbau/bibtex2html/README"
163 endif(NOT GOOD_BIBTEX2HTML_VERSION)
165 ADD_CUSTOM_COMMAND(TARGET simgrid_documentation
166 COMMAND ${CMAKE_COMMAND} -E echo "DOXYGEN_PATH = ${DOXYGEN_PATH}"
167 COMMAND ${CMAKE_COMMAND} -E echo "FIG2DEV_PATH = ${FIG2DEV_PATH}"
168 COMMAND ${CMAKE_COMMAND} -E echo "BIBTOOL_PATH = ${BIBTOOL_PATH}"
169 COMMAND ${CMAKE_COMMAND} -E echo "BIBTEX2HTML_PATH = ${BIBTEX2HTML_PATH}"
170 COMMAND ${CMAKE_COMMAND} -E echo "ICONV_PATH = ${ICONV_PATH}"
171 COMMAND ${CMAKE_COMMAND} -E echo "IN ORDER TO GENERATE THE DOCUMENTATION YOU NEED ALL TOOLS !!!"
172 COMMAND ${CMAKE_COMMAND} -E echo "FAIL TO MAKE SIMGRID DOCUMENTATION see previous messages for details ..."
177 endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND ICONV_PATH AND GOOD_BIBTEX2HTML_VERSION)
179 ##############################################################################"
181 message(STATUS "Check individual TOCs")
182 file(GLOB_RECURSE LISTE_GTUT
183 "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour-*.doc"
185 foreach(file_name ${LISTE_GTUT})
186 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
187 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
189 file(READ "${file_name}" file_content)
190 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
191 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
192 string(REPLACE "\n" ";" file_content "${file_content}")
194 foreach(line ${file_content})
195 string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}")
196 string(REGEX MATCH ".*_toc.*" line3 "${line}")
197 if(line2 AND NOT line3)
198 string(REPLACE "\\section " "" line2 ${line2})
199 string(REPLACE "\\subsection " "subsection" line2 ${line2})
200 string(REPLACE "\\subsubsection " "subsubsection" line2 ${line2})
201 string(REGEX REPLACE " .*" "" line2 ${line2})
202 set(line2 " - \\ref ${line2}")
203 string(REPLACE " - \\ref subsection" " - \\ref " line2 ${line2})
204 string(REPLACE " - \\ref subsubsection" " - \\ref " line2 ${line2})
205 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
206 endif(line2 AND NOT line3)
207 endforeach(line ${file_content})
209 foreach(line ${valeur_line})
210 string(REGEX MATCH ".*ref.*" line_ok ${line})
212 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line_ok}\n")
214 endforeach(line ${valeur_line})
216 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
218 message(STATUS "Wrong toc for ${file_name}. Should be:")
219 file(READ "${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" file_content)
220 message("${file_content}")
221 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
223 endforeach(file_name ${LISTE_GTUT})
225 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)
226 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
228 message(STATUS "Check main TOC")
230 foreach(file_name ${LISTE_GTUT})
231 file(READ "${file_name}" file_content)
232 string(REGEX MATCH "Table of Contents.*<hr>" valeur_line "${file_content}")
233 string(REPLACE "\n" ";" valeur_line "${valeur_line}")
234 string(REPLACE "\n" ";" file_content "${file_content}")
236 foreach(line ${file_content})
237 string(REGEX MATCH ".*@page.*" line2 "${line}")
239 string(REPLACE "@page " "" line2 "${line2}")
240 string(REGEX REPLACE " .*" "" line2 "${line2}")
241 set(line2 " - \\ref ${line2}")
242 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "${line2}\n")
244 endforeach(line ${file_content})
246 foreach(line ${valeur_line})
247 string(REGEX MATCH ".*toc.*" line1 "${line}")
248 string(REGEX MATCH ".*<hr>.*" line2 "${line}")
249 string(REGEX MATCH "^[ ]*$" line3 "${line}")
250 string(REGEX MATCH "Table of Contents" line4 "${line}")
251 if(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
252 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc " ${line}\n")
253 endif(NOT line1 AND NOT line2 AND NOT line3 AND NOT line4)
254 endforeach(line ${valeur_line})
255 endforeach(file_name ${LISTE_GTUT})
257 file(READ "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour.doc" file_content)
258 string(REPLACE "\n" ";" file_content "${file_content}")
259 foreach(line ${file_content})
260 string(REGEX MATCH "^[ ]+.*\\ref" line1 "${line}")
262 file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "${line}\n")
264 endforeach(line ${file_content})
266 exec_program("${CMAKE_COMMAND} -E compare_files ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc" OUTPUT_VARIABLE compare_files)
268 message(STATUS "Wrong toc for gtut-tour.doc Right one is in tmp.realtoc")
269 exec_program("diff -u ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc")
271 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc)
274 file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc)