From: Martin Quinson Date: Tue, 19 Apr 2011 13:51:06 +0000 (+0200) Subject: fix TOCs in GRAS tutorial X-Git-Tag: v3.6_beta2~8 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/b031f70c51caae219e7d46e9bada476964d1228b fix TOCs in GRAS tutorial --- diff --git a/buildtools/Cmake/GenerateDoc.cmake b/buildtools/Cmake/GenerateDoc.cmake index b357380e0f..c4e84c4afa 100644 --- a/buildtools/Cmake/GenerateDoc.cmake +++ b/buildtools/Cmake/GenerateDoc.cmake @@ -179,9 +179,27 @@ endif(DOXYGEN_PATH AND FIG2DEV_PATH AND BIBTOOL_PATH AND BIBTEX2HTML_PATH AND IC ##############################################################################" message(STATUS "Check individual TOCs") -file(GLOB_RECURSE LISTE_GTUT - "${CMAKE_HOME_DIRECTORY}/doc/gtut-tour-*.doc" +set(LISTE_GTUT + doc/gtut-tour-00-install.doc + doc/gtut-tour-01-bones.doc + doc/gtut-tour-02-simple.doc + doc/gtut-tour-03-args.doc + doc/gtut-tour-04-callback.doc + doc/gtut-tour-05-globals.doc + doc/gtut-tour-06-logs.doc + doc/gtut-tour-07-timers.doc + doc/gtut-tour-08-exceptions.doc + doc/gtut-tour-09-simpledata.doc + doc/gtut-tour-10-rpc.doc + doc/gtut-tour-11-explicitwait.doc + doc/gtut-tour-recap-messages.doc + doc/gtut-tour-12-staticstruct.doc + doc/gtut-tour-13-pointers.doc + doc/gtut-tour-14-dynar.doc + doc/gtut-tour-15-manualdatadef.doc + doc/gtut-tour-16-exchangecb.doc ) + foreach(file_name ${LISTE_GTUT}) file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc) file(REMOVE ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc) @@ -190,7 +208,8 @@ foreach(file_name ${LISTE_GTUT}) string(REGEX MATCH "Table of Contents.*
" valeur_line "${file_content}") string(REPLACE "\n" ";" valeur_line "${valeur_line}") string(REPLACE "\n" ";" file_content "${file_content}") - + + file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.realtoc "\n") # make sure it exists foreach(line ${file_content}) string(REGEX MATCH "[\\]s?u?b?s?u?b?section.*" line2 "${line}") string(REGEX MATCH ".*_toc.*" line3 "${line}") @@ -206,6 +225,7 @@ foreach(file_name ${LISTE_GTUT}) endif(line2 AND NOT line3) endforeach(line ${file_content}) + file(APPEND ${CMAKE_HOME_DIRECTORY}/doc/tmp.curtoc "\n") # make sure it exists foreach(line ${valeur_line}) string(REGEX MATCH ".*ref.*" line_ok ${line}) if(line_ok) diff --git a/doc/gtut-tour-00-install.doc b/doc/gtut-tour-00-install.doc new file mode 100644 index 0000000000..de0bca4ac3 --- /dev/null +++ b/doc/gtut-tour-00-install.doc @@ -0,0 +1,16 @@ + +/** +@page GRAS_tut_tour_install Lesson 0: Installing GRAS + +Since GRAS is technically part of the SimGrid project, you have to install +SimGrid to install GRAS. Doing so is explained in the relevant FAQ section +(\ref faq_installation). + +Newcommers should install the stable release from the tarball, since the +snapshots may suffer from (additionnal;) stability issues. Only go for the +git if you really need features not present in the stable releases yet (or +if you plan to help us improving the tool, what is always welcomed). + +Proceed to \ref GRAS_tut_tour_setup. + +*/ diff --git a/doc/gtut-tour-13-pointers.doc b/doc/gtut-tour-13-pointers.doc index 4e03372596..3c0f6a9500 100644 --- a/doc/gtut-tour-13-pointers.doc +++ b/doc/gtut-tour-13-pointers.doc @@ -7,9 +7,15 @@ long otherwise, the lesson is organized as a FAQ, with little examples of how to do things. \section GRAS_tut_tour_pointers_toc Table of Contents + - \ref GRAS_tut_tour_pointers_intro + - \ref GRAS_tut_tour_pointers_use + - \ref GRAS_tut_tour_pointers_recap - \ref GRAS_tut_tour_pointers_cste
+\section GRAS_tut_tour_pointers_intro Introduction to pointers in datadesc +\section GRAS_tut_tour_pointers_use Using pointers in datadesc +\section GRAS_tut_tour_pointers_recap Recapping everything \section GRAS_tut_tour_pointers_cste How to have constants in parsed structures? diff --git a/doc/gtut-tour-recap-messages.doc b/doc/gtut-tour-recap-messages.doc index 71269d94df..2f34294933 100644 --- a/doc/gtut-tour-recap-messages.doc +++ b/doc/gtut-tour-recap-messages.doc @@ -9,7 +9,6 @@ - \ref GRAS_tut_tour_message_recaping_rpc3 - \ref GRAS_tut_tour_message_recaping_rpc4 - \ref GRAS_tut_tour_message_recaping_rpc5 - - - \ref GRAS_tut_tour_message_recaping_rpc_aside1 - \ref GRAS_tut_tour_message_recaping_rpc_aside2 - \ref GRAS_tut_tour_message_recaping_rpc_aside3 diff --git a/doc/gtut-tour.doc b/doc/gtut-tour.doc index 5cb74e5ad0..150509ce4a 100644 --- a/doc/gtut-tour.doc +++ b/doc/gtut-tour.doc @@ -29,120 +29,128 @@ all features available in GRAS. Part 1: Bases - - \ref GRAS_tut_tour_install - - - \ref GRAS_tut_tour_setup - - \ref GRAS_tut_tour_setup_C - - \ref GRAS_tut_tour_setup_plat - - \ref GRAS_tut_tour_setup_deploy - - \ref GRAS_tut_tour_setup_glue - - \ref GRAS_tut_tour_setup_make - - \ref GRAS_tut_tour_setup_start + - \ref GRAS_tut_tour_install + + - \ref GRAS_tut_tour_setup + - \ref GRAS_tut_tour_setup_C + - \ref GRAS_tut_tour_setup_plat + - \ref GRAS_tut_tour_setup_deploy + - \ref GRAS_tut_tour_setup_glue + - \ref GRAS_tut_tour_setup_make + - \ref GRAS_tut_tour_setup_start Part 2: Message passing - - \ref GRAS_tut_tour_simpleexchange - - \ref GRAS_tut_tour_simpleexchange_msgtype - - \ref GRAS_tut_tour_simpleexchange_socks - - \ref GRAS_tut_tour_simpleexchange_exchange - - \ref GRAS_tut_tour_simpleexchange_recaping - - - \ref GRAS_tut_tour_args - - \ref GRAS_tut_tour_args_use - - \ref GRAS_tut_tour_args_sg - - \ref GRAS_tut_tour_args_recap + - \ref GRAS_tut_tour_simpleexchange + - \ref GRAS_tut_tour_simpleexchange_msgtype + - \ref GRAS_tut_tour_simpleexchange_socks + - \ref GRAS_tut_tour_simpleexchange_exchange + - \ref GRAS_tut_tour_simpleexchange_recaping + + - \ref GRAS_tut_tour_args + - \ref GRAS_tut_tour_args_use + - \ref GRAS_tut_tour_args_sg + - \ref GRAS_tut_tour_args_recap + + - \ref GRAS_tut_tour_callbacks + - \ref GRAS_tut_tour_callbacks_declare + - \ref GRAS_tut_tour_callbacks_attach + - \ref GRAS_tut_tour_callbacks_handle + - \ref GRAS_tut_tour_callback_recap - - \ref GRAS_tut_tour_callbacks - - \ref GRAS_tut_tour_callbacks_declare - - \ref GRAS_tut_tour_callbacks_attach - - \ref GRAS_tut_tour_callbacks_handle - - \ref GRAS_tut_tour_callback_recap + - \ref GRAS_tut_tour_globals + - \ref GRAS_tut_tour_globals_intro + - \ref GRAS_tut_tour_globals_use + - \ref GRAS_tut_tour_callback_pitfall + - \ref GRAS_tut_tour_callback_recap - - \ref GRAS_tut_tour_globals - - \ref GRAS_tut_tour_globals_intro - - \ref GRAS_tut_tour_globals_use - - \ref GRAS_tut_tour_callback_pitfall - - \ref GRAS_tut_tour_callback_recap - - - \ref GRAS_tut_tour_logs - - \ref GRAS_tut_tour_logs_intro - - \ref GRAS_tut_tour_logs_practice - - \ref GRAS_tut_tour_logs_recap - - \ref GRAS_tut_tour_logs_config - - - \ref GRAS_tut_tour_timers - - \ref GRAS_tut_tour_timers_intro - - \ref GRAS_tut_tour_timers_use - - \ref GRAS_tut_tour_timers_recap + - \ref GRAS_tut_tour_logs + - \ref GRAS_tut_tour_logs_intro + - \ref GRAS_tut_tour_logs_practice + - \ref GRAS_tut_tour_logs_recap + - \ref GRAS_tut_tour_logs_config + - \ref GRAS_tut_tour_logs_config_prio + - \ref GRAS_tut_tour_logs_config_layout + + - \ref GRAS_tut_tour_timers + - \ref GRAS_tut_tour_timers_intro + - \ref GRAS_tut_tour_timers_use + - \ref GRAS_tut_tour_timers_recap + + - \ref GRAS_tut_tour_exceptions + - \ref GRAS_tut_tour_exceptions_intro + - \ref GRAS_tut_tour_exceptions_use + - \ref GRAS_tut_tour_exceptions_recap - - \ref GRAS_tut_tour_exceptions - - \ref GRAS_tut_tour_exceptions_intro - - \ref GRAS_tut_tour_exceptions_use - - \ref GRAS_tut_tour_exceptions_recap - - - \ref GRAS_tut_tour_simpledata - - \ref GRAS_tut_tour_simpledata_intro - - \ref GRAS_tut_tour_simpledata_intro_conv - - \ref GRAS_tut_tour_simpledata_intro_gras - - \ref GRAS_tut_tour_simpledata_use - - \ref GRAS_tut_tour_simpledata_example - - \ref GRAS_tut_tour_simpledata_recap + - \ref GRAS_tut_tour_simpledata + - \ref GRAS_tut_tour_simpledata_intro + - \ref GRAS_tut_tour_simpledata_intro_conv + - \ref GRAS_tut_tour_simpledata_intro_gras + - \ref GRAS_tut_tour_simpledata_use + - \ref GRAS_tut_tour_simpledata_example + - \ref GRAS_tut_tour_simpledata_recap - - \ref GRAS_tut_tour_rpc - - \ref GRAS_tut_tour_rpc_intro - - \ref GRAS_tut_tour_rpc_use - - \ref GRAS_tut_tour_rpc_use_declare - - \ref GRAS_tut_tour_rpc_use_i2a_cb - - \ref GRAS_tut_tour_rpc_use_a2i_cb - - \ref GRAS_tut_tour_rpc_use_rest - - \ref GRAS_tut_tour_rpc_recap + - \ref GRAS_tut_tour_rpc + - \ref GRAS_tut_tour_rpc_intro + - \ref GRAS_tut_tour_rpc_use + - \ref GRAS_tut_tour_rpc_use_declare + - \ref GRAS_tut_tour_rpc_use_i2a_cb + - \ref GRAS_tut_tour_rpc_use_a2i_cb + - \ref GRAS_tut_tour_rpc_use_rest + - \ref GRAS_tut_tour_rpc_recap - - \ref GRAS_tut_tour_explicitwait - - \ref GRAS_tut_tour_explicitwait_intro - - \ref GRAS_tut_tour_explicitwait_use - - \ref GRAS_tut_tour_explicitwait_algo - - \ref GRAS_tut_tour_explicitwait_code - - \ref GRAS_tut_tour_explicitwait_recap + - \ref GRAS_tut_tour_explicitwait + - \ref GRAS_tut_tour_explicitwait_intro + - \ref GRAS_tut_tour_explicitwait_use + - \ref GRAS_tut_tour_explicitwait_algo + - \ref GRAS_tut_tour_explicitwait_code + - \ref GRAS_tut_tour_explicitwait_code_msg + - \ref GRAS_tut_tour_explicitwait_code_cb + - \ref GRAS_tut_tour_explicitwait_code_api + - \ref GRAS_tut_tour_explicitwait_code_smain + - \ref GRAS_tut_tour_explicitwait_code_cmain + - \ref GRAS_tut_tour_explicitwait_recap - - \ref GRAS_tut_tour_message_recaping - - \ref GRAS_tut_tour_message_recaping_intro - - \ref GRAS_tut_tour_message_recaping_rpc - - \ref GRAS_tut_tour_message_recaping_rpc1 - - \ref GRAS_tut_tour_message_recaping_rpc2 - - \ref GRAS_tut_tour_message_recaping_rpc3 - - \ref GRAS_tut_tour_message_recaping_rpc4 - - \ref GRAS_tut_tour_message_recaping_rpc5 - - \ref GRAS_tut_tour_message_recaping_rpc_aside1 - - \ref GRAS_tut_tour_message_recaping_rpc_aside2 - - \ref GRAS_tut_tour_message_recaping_rpc_aside3 - - \ref GRAS_tut_tour_message_recaping_sync + - \ref GRAS_tut_tour_message_recaping + - \ref GRAS_tut_tour_message_recaping_intro + - \ref GRAS_tut_tour_message_recaping_rpc + - \ref GRAS_tut_tour_message_recaping_rpc1 + - \ref GRAS_tut_tour_message_recaping_rpc2 + - \ref GRAS_tut_tour_message_recaping_rpc3 + - \ref GRAS_tut_tour_message_recaping_rpc4 + - \ref GRAS_tut_tour_message_recaping_rpc5 + - \ref GRAS_tut_tour_message_recaping_rpc_aside1 + - \ref GRAS_tut_tour_message_recaping_rpc_aside2 + - \ref GRAS_tut_tour_message_recaping_rpc_aside3 + - \ref GRAS_tut_tour_message_recaping_sync Part 3: Data description - - \ref GRAS_tut_tour_staticstruct Automatic parsing of static data types - - \ref GRAS_tut_tour_staticstruct_intro - - \ref GRAS_tut_tour_staticstruct_use - - \ref GRAS_tut_tour_staticstruct_recap + - \ref GRAS_tut_tour_staticstruct + - \ref GRAS_tut_tour_staticstruct_intro + - \ref GRAS_tut_tour_staticstruct_use + - \ref GRAS_tut_tour_staticstruct_recap - - \ref GRAS_tut_tour_pointers Automatic parsing of datatypes containing pointers - - \ref GRAS_tut_tour_pointers_intro - - \ref GRAS_tut_tour_pointers_use - - \ref GRAS_tut_tour_pointers_recap + - \ref GRAS_tut_tour_pointers + - \ref GRAS_tut_tour_pointers_intro + - \ref GRAS_tut_tour_pointers_use + - \ref GRAS_tut_tour_pointers_recap + - \ref GRAS_tut_tour_pointers_cste - - \ref GRAS_tut_tour_dynar Exchanging dynars (and matrices) - - \ref GRAS_tut_tour_dynar_intro - - \ref GRAS_tut_tour_dynar_use - - \ref GRAS_tut_tour_dynar_recap + - \ref GRAS_tut_tour_dynar + - \ref GRAS_tut_tour_dynar_intro + - \ref GRAS_tut_tour_dynar_use + - \ref GRAS_tut_tour_dynar_recap - - \ref GRAS_tut_tour_manualdatadef Manual data description: the full power - - \ref GRAS_tut_tour_manualdatadef_intro - - \ref GRAS_tut_tour_manualdatadef_use - - \ref GRAS_tut_tour_manualdatadef_recap + - \ref GRAS_tut_tour_manualdatadef + - \ref GRAS_tut_tour_manualdatadef_intro + - \ref GRAS_tut_tour_manualdatadef_use + - \ref GRAS_tut_tour_manualdatadef_recap - - \ref GRAS_tut_tour_exchangecb Exchange callbacks: yes you can - - \ref GRAS_tut_tour_exchangecb_intro - - \ref GRAS_tut_tour_exchangecb_use - - \ref GRAS_tut_tour_exchangecb_recap + - \ref GRAS_tut_tour_exchangecb + - \ref GRAS_tut_tour_exchangecb_intro + - \ref GRAS_tut_tour_exchangecb_use + - \ref GRAS_tut_tour_exchangecb_recap Part 4: Advanced topics @@ -158,20 +166,4 @@ of missi^W lessons I want to add: -*/ - -/** -@page GRAS_tut_tour_install Lesson 0: Installing GRAS - -Since GRAS is technically part of the SimGrid project, you have to install -SimGrid to install GRAS. Doing so is explained in the relevant FAQ section -(\ref faq_installation). - -Newcommers should install the stable release from the tarball, since the cvs -snapshots may suffer from (additionnal;) stability issues. Only go for the -CVS if you really need features not present in the stable releases yet (or -if you plan to help us improving the tool, what is always welcomed). - -Proceed to \ref GRAS_tut_tour_setup. - */