X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7fdd9d11419684606beb08a8a7bc673955eb08af..cab107a617d2c5a0d760bd68bcd245d558347bea:/doc/gtut-tour.doc
diff --git a/doc/gtut-tour.doc b/doc/gtut-tour.doc
index 9d6db8f782..0288a1c290 100644
--- a/doc/gtut-tour.doc
+++ b/doc/gtut-tour.doc
@@ -1,6 +1,5 @@
-
-/**
-@page GRAS_tut_tour GRAS initiatic tour
+/** @defgroup GRAS_tut_tour Initiatic tour
+ @ingroup GRAS_tut
During this tour, you will learn all you need to write your own GRAS
applications, from the installation of the framework to the use of (almost)
@@ -16,9 +15,21 @@ all features available in GRAS.
DOXYGEN_NAVBAR_CHILD "6: Logs"=GRAS_tut_tour_logs.html
DOXYGEN_NAVBAR_CHILD "7: Timers"=GRAS_tut_tour_timers.html
DOXYGEN_NAVBAR_CHILD "8: Exceptions"=GRAS_tut_tour_exceptions.html
- DOXYGEN_NAVBAR_CHILD "9: RPC"=GRAS_tut_tour_rpc.html
+ DOXYGEN_NAVBAR_CHILD "9: Data exchange"=GRAS_tut_tour_simpledata.html
+ DOXYGEN_NAVBAR_CHILD "10: RPC"=GRAS_tut_tour_rpc.html
+ DOXYGEN_NAVBAR_CHILD "11: Explicit wait"=GRAS_tut_tour_explicitwait.html
+ DOXYGEN_NAVBAR_CHILD "Recapping part 1"=GRAS_tut_tour_message_recaping.html
+ DOXYGEN_NAVBAR_CHILD "12: Static data definition"=GRAS_tut_tour_staticstruct.html
+ DOXYGEN_NAVBAR_CHILD "13: Pointers definition"=GRAS_tut_tour_pointers.html
+ DOXYGEN_NAVBAR_CHILD "14: Dynars definition"=GRAS_tut_tour_dynar.html
+ DOXYGEN_NAVBAR_CHILD "15: Manual data definition"=GRAS_tut_tour_manualdatadef.html
+ DOXYGEN_NAVBAR_CHILD "16: Advanced data definition"=GRAS_tut_tour_exchangecb.html
--> \endhtmlonly
+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
@@ -26,18 +37,20 @@ all features available in GRAS.
- \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_callbacks
- \ref GRAS_tut_tour_callbacks_declare
- \ref GRAS_tut_tour_callbacks_attach
@@ -49,58 +62,107 @@ all features available in GRAS.
- \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_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_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_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
+
+Part 3: Data description
+
+ - \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
+ - \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
+ - \ref GRAS_tut_tour_dynar_intro
+ - \ref GRAS_tut_tour_dynar_use
+ - \ref GRAS_tut_tour_dynar_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
+ - \ref GRAS_tut_tour_exchangecb_intro
+ - \ref GRAS_tut_tour_exchangecb_use
+ - \ref GRAS_tut_tour_exchangecb_recap
+
+Part 4: Advanced topics
+
+Unfortunately, the tour is not terminated yet, but I already know the kind
+of missi^W lessons I want to add:
+
+ - Computation virtualization
+ - Splitting in several files (logs, datadesc)
+ - Debugging GRAS programs
+ - Doing proper GRAS modules
+
-\section GRAS_tut_tour_todo TODO
-
-Unfortunately, the tour is not terminated yet, and here are some ideas of
-missing missi^W lessons:
-
-- Lesson 10: Exchanging simple data through ping-pong
-- Lesson 11: More complex data description (automatic parsing, manual
- description) and example. May need more than one lesson.
-
-- Lesson 12: Splitting in several files
-
-- Lesson 13: Debuging GRAS programs
-
-- Lesson 14: Doing proper modules
-
-*/
-
-/**
-@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).
*/