Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make room for the other lessons on data description
authormquinson <mquinson@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Tue, 1 Aug 2006 01:56:13 +0000 (01:56 +0000)
committermquinson <mquinson@48e7efb5-ca39-0410-a469-dd3cf9ba447f>
Tue, 1 Aug 2006 01:56:13 +0000 (01:56 +0000)
git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@2673 48e7efb5-ca39-0410-a469-dd3cf9ba447f

doc/Doxyfile.in
doc/gtut-main.doc
doc/gtut-tour-11-staticstruct.doc [new file with mode: 0644]
doc/gtut-tour-12-pointers.doc [new file with mode: 0644]
doc/gtut-tour-13-dynar.doc [new file with mode: 0644]
doc/gtut-tour-14-manualdatadef.doc [new file with mode: 0644]
doc/gtut-tour-15-exchangecb.doc [new file with mode: 0644]
doc/gtut-tour.doc

index b2cfb6f..70103aa 100644 (file)
@@ -419,7 +419,12 @@ INPUT                  = @srcdir@/index.doc \
                                @srcdir@/gtut-tour-08-exceptions.doc \
                                @srcdir@/gtut-tour-09-simpledata.doc \
                                @srcdir@/gtut-tour-10-rpc.doc \
-                        \
+                               @srcdir@/gtut-tour-11-staticstruct.doc \
+                               @srcdir@/gtut-tour-12-pointers.doc \
+                               @srcdir@/gtut-tour-13-dynar.doc \
+                               @srcdir@/gtut-tour-14-manualdatadef.doc \
+                               @srcdir@/gtut-tour-15-exchangecb.doc \
+                         \
                          ./logcategories.doc \
                         \
                          @top_srcdir@/include/ \
index 73273f4..d5be11b 100644 (file)
@@ -17,16 +17,26 @@ This section constitutes a tutorial to the GRAS programming environment.
    explains how to install the framework and setup your own projects. Then,
    an example distributed application is builded incrementaly to show the
    several aspects of the framework.
-   - \ref GRAS_tut_tour_install
-   - \ref GRAS_tut_tour_setup
-   - \ref GRAS_tut_tour_simpleexchange
-   - \ref GRAS_tut_tour_args
-   - \ref GRAS_tut_tour_callbacks
-   - \ref GRAS_tut_tour_globals
-   - \ref GRAS_tut_tour_logs
-   - \ref GRAS_tut_tour_timers
-   - \ref GRAS_tut_tour_exceptions
-   - \ref GRAS_tut_tour_rpc
+   - Part 1: Bases
+     - \ref GRAS_tut_tour_install
+     - \ref GRAS_tut_tour_setup
+   - Part 2: Message passing
+     - \ref GRAS_tut_tour_simpleexchange
+     - \ref GRAS_tut_tour_args
+     - \ref GRAS_tut_tour_callbacks
+     - \ref GRAS_tut_tour_globals
+     - \ref GRAS_tut_tour_logs
+     - \ref GRAS_tut_tour_timers
+     - \ref GRAS_tut_tour_exceptions
+     - \ref GRAS_tut_tour_simpledata
+     - \ref GRAS_tut_tour_rpc
+   - Part 3: Data description
+     - \ref GRAS_tut_tour_staticstruct
+     - \ref GRAS_tut_tour_pointers
+     - \ref GRAS_tut_tour_dynar
+     - \ref GRAS_tut_tour_manualdatadef
+     - \ref GRAS_tut_tour_exchangecb
+   - Part 4: Advanced topics (TODO)
 
     \htmlonly <!-- 
       DOXYGEN_NAVBAR_LABEL="Tutorial"
diff --git a/doc/gtut-tour-11-staticstruct.doc b/doc/gtut-tour-11-staticstruct.doc
new file mode 100644 (file)
index 0000000..07f72c6
--- /dev/null
@@ -0,0 +1,26 @@
+/**
+@page GRAS_tut_tour_staticstruct Lesson 11: Defining static structures (TODO)
+
+\section GRAS_tut_tour_staticstruct_toc Table of Contents
+ - \ref GRAS_tut_tour_staticstruct_intro
+ - \ref GRAS_tut_tour_staticstruct_use
+ - \ref GRAS_tut_tour_staticstruct_recap
+   
+<hr>
+
+\section GRAS_tut_tour_staticstruct_intro Introduction
+
+
+\section GRAS_tut_tour_staticstruct_use Defining static structure to GRAS
+
+
+\section GRAS_tut_tour_staticstruct_recap Recapping everything together
+
+The program now reads:
+\include 11-staticstruct.c
+
+Which produces the expected output:
+\include 11-staticstruct.output
+
+
+*/
diff --git a/doc/gtut-tour-12-pointers.doc b/doc/gtut-tour-12-pointers.doc
new file mode 100644 (file)
index 0000000..ef275bf
--- /dev/null
@@ -0,0 +1,26 @@
+/**
+@page GRAS_tut_tour_pointers Lesson 12: Defining structure containing pointers (TODO)
+
+\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
+   
+<hr>
+
+\section GRAS_tut_tour_pointers_intro Introduction
+
+
+\section GRAS_tut_tour_pointers_use Defining structure containing pointers
+
+
+\section GRAS_tut_tour_pointers_recap Recapping everything together
+
+The program now reads:
+\include 12-pointers.c
+
+Which produces the expected output:
+\include 12-pointers.output
+
+
+*/
diff --git a/doc/gtut-tour-13-dynar.doc b/doc/gtut-tour-13-dynar.doc
new file mode 100644 (file)
index 0000000..835bdbb
--- /dev/null
@@ -0,0 +1,26 @@
+/**
+@page GRAS_tut_tour_dynar Lesson 13: Exchanging aggregate datatypes such as dynar (TODO)
+
+\section GRAS_tut_tour_dynar_toc Table of Contents
+ - \ref GRAS_tut_tour_dynar_intro
+ - \ref GRAS_tut_tour_dynar_use
+ - \ref GRAS_tut_tour_dynar_recap
+   
+<hr>
+
+\section GRAS_tut_tour_dynar_intro Introduction
+
+
+\section GRAS_tut_tour_dynar_use Defining structure containing dynars
+
+
+\section GRAS_tut_tour_dynar_recap Recapping everything together
+
+The program now reads:
+\include 13-dynar.c
+
+Which produces the expected output:
+\include 13-dynar.output
+
+
+*/
diff --git a/doc/gtut-tour-14-manualdatadef.doc b/doc/gtut-tour-14-manualdatadef.doc
new file mode 100644 (file)
index 0000000..2fcb6e4
--- /dev/null
@@ -0,0 +1,26 @@
+/**
+@page GRAS_tut_tour_manualdatadef Lesson 14: Manual data definition (TODO)
+
+\section GRAS_tut_tour_manualdatadef_toc Table of Contents
+ - \ref GRAS_tut_tour_manualdatadef_intro
+ - \ref GRAS_tut_tour_manualdatadef_use
+ - \ref GRAS_tut_tour_manualdatadef_recap
+   
+<hr>
+
+\section GRAS_tut_tour_manualdatadef_intro Introduction
+
+
+\section GRAS_tut_tour_manualdatadef_use Defining data manually
+
+
+\section GRAS_tut_tour_manualdatadef_recap Recapping everything together
+
+The program now reads:
+\include 14-manualdatadef.c
+
+Which produces the expected output:
+\include 14-manualdatadef.output
+
+
+*/
diff --git a/doc/gtut-tour-15-exchangecb.doc b/doc/gtut-tour-15-exchangecb.doc
new file mode 100644 (file)
index 0000000..4ff5d18
--- /dev/null
@@ -0,0 +1,26 @@
+/**
+@page GRAS_tut_tour_exchangecb Lesson 15: Advanced topics on data definition (TODO)
+
+\section GRAS_tut_tour_exchangecb_toc Table of Contents
+ - \ref GRAS_tut_tour_exchangecb_intro
+ - \ref GRAS_tut_tour_exchangecb_use
+ - \ref GRAS_tut_tour_exchangecb_recap
+   
+<hr>
+
+\section GRAS_tut_tour_exchangecb_intro Introduction
+
+
+\section GRAS_tut_tour_exchangecb_use Using exchange callbacks
+
+
+\section GRAS_tut_tour_exchangecb_recap Recapping everything together
+
+The program now reads:
+\include 15-exchangecb.c
+
+Which produces the expected output:
+\include 15-exchangecb.output
+
+
+*/
index bb4e7fd..d62f182 100644 (file)
@@ -18,6 +18,11 @@ all features available in GRAS.
       DOXYGEN_NAVBAR_CHILD "8: Exceptions"=GRAS_tut_tour_exceptions.html
       DOXYGEN_NAVBAR_CHILD "9: Simple data"=GRAS_tut_tour_simpledata.html
       DOXYGEN_NAVBAR_CHILD "10: RPC"=GRAS_tut_tour_rpc.html
+      DOXYGEN_NAVBAR_CHILD "11: Static data"=GRAS_tut_tour_staticstruct.html
+      DOXYGEN_NAVBAR_CHILD "12: Pointers"=GRAS_tut_tour_pointers.html
+      DOXYGEN_NAVBAR_CHILD "13: Dynars"=GRAS_tut_tour_dynars.html
+      DOXYGEN_NAVBAR_CHILD "14: Manual data definition"=GRAS_tut_tour_manualdatadef.html
+      DOXYGEN_NAVBAR_CHILD "15: Advanced data definition"=GRAS_tut_tour_exchangecb.html
     --> \endhtmlonly
 
 <b>Part 1: Bases</b>
@@ -75,6 +80,9 @@ all features available in GRAS.
      
    - \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
       
@@ -83,18 +91,38 @@ all features available in GRAS.
       - \ref GRAS_tut_tour_rpc_use
       - \ref GRAS_tut_tour_rpc_recap
   
+<b>Part 3: Data description</b>
+
+   - \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_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_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_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_exchangecb Exchange callbacks: yes you can
+      - \ref GRAS_tut_tour_exchangecb_intro
+      - \ref GRAS_tut_tour_exchangecb_use
+      - \ref GRAS_tut_tour_exchangecb_recap
+
+<b>Part 4: Advanced topics</b>
+
 Unfortunately, the tour is not terminated yet, but I already know the kind
 of missi^W lessons I want to add:
 
-<b>Part 3: Data description</b>
-   - Exchanging simple data through ping-pong
-   - Automatic parsing of static data types
-   - Automatic parsing of datatypes containing pointers
-   - Exchanging dynars (and matrices)
-   - Manual data description: the full power
-   - Exchange callbacks: yes you can
-     
-<b>Part 4: Advanced topics</b>
    - Computation virtualization
    - Splitting in several files (logs, datadesc)
    - Debugging GRAS programs