Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
list the new examples in the doc
authorFrederic Suter <frederic.suter@cc.in2p3.fr>
Fri, 10 Mar 2017 14:38:02 +0000 (15:38 +0100)
committerFrederic Suter <frederic.suter@cc.in2p3.fr>
Fri, 10 Mar 2017 14:38:02 +0000 (15:38 +0100)
examples/s4u/README.doc

index f80cb81..9cdcf7a 100644 (file)
@@ -15,23 +15,32 @@ documentation, but it should remain readable directly.
 
   - @ref s4u_ex_basics
   - @ref s4u_ex_synchro
 
   - @ref s4u_ex_basics
   - @ref s4u_ex_synchro
-                   
+
 @section s4u_ex_basics Basics of SimGrid simulation
 
 @section s4u_ex_basics Basics of SimGrid simulation
 
-  - <b>Launching actors</b>
-    Shows how to start your actors to populate your simulation\n
-    @ref examples/s4u/launching/s4u_launching.cpp and @ref examples/s4u/launching/deployment.xml
+  - <b>Launching actors:</b> @ref examples/s4u/launching/s4u_launching.cpp and 
+    @ref examples/s4u/launching/deployment.xml \n
+    Shows how to start your actors to populate your simulation.
+
+  - <b>Token ring:</b> @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n
+    Shows how to implement a classical communication pattern, where a token is exchanged along a ring to reach every
+    participant.
+
+  - <b>Master Workers:</b> @ref examples/s4u/app-token-ring/s4u_app-token-ring.cpp \n
+    Another good old example, where one Master process has a bunch of task to dispatch to a set of several Worker 
+    processes. 
 
 @section s4u_ex_synchro Inter-Actor Synchronization 
 
 
 @section s4u_ex_synchro Inter-Actor Synchronization 
 
- - <b>Mutex.</b>
-   Shows how to use simgrid::s4u::Mutex synchronization objects\n
-   @ref examples/s4u/mutex/s4u_mutex.cpp
-                        
+ - <b>Mutex: </b> @ref examples/s4u/mutex/s4u_mutex.cpp \n
+   Shows how to use simgrid::s4u::Mutex synchronization objects.
+   
 */
 
 /**
 @example examples/s4u/launching/s4u_launching.cpp
 */
 
 /**
 @example examples/s4u/launching/s4u_launching.cpp
+@example examples/s4u/app-token-ring/s4u_app-token-ring.cpp
+@example examples/s4u/app-master-worker/s4u_app-master-worker.cpp
 @example examples/s4u/launching/deployment.xml
 
 @example examples/s4u/mutex/s4u_mutex.cpp
 @example examples/s4u/launching/deployment.xml
 
 @example examples/s4u/mutex/s4u_mutex.cpp