Merge branch 'actor-yield' of github.com:Takishipp/simgrid into actor-yield

[simgrid.git] / examples / s4u / README.doc

diff --git a/examples/s4u/README.doc b/examples/s4u/README.doc
index 96691c5..f626d7e 100644 (file)
--- a/examples/s4u/README.doc
+++ b/examples/s4u/README.doc
@@ -25,7 +25,7 @@ documentation, but it should remain readable directly.
     @ref examples/s4u/actor-create/s4u-actor-create_d.xml \n
     Shows how to start your actors to populate your simulation.
 
-  - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.c\n
+  - <b>Ping Pong</b>: @ref examples/s4u/app-pingpong/s4u-app-pingpong.cpp\n
     This simple example just sends one message back and forth.
     The tesh file laying in the directory show how to start the simulator binary, highlighting how to pass options to 
     the simulators (as detailed in Section \ref options). 
@@ -101,6 +101,12 @@ documentation, but it should remain readable directly.
     @ref examples/s4u/actor-migration/s4u-actor-migration.cpp \n
     Actors can move or be moved from a host to another with the @ref migrate method.
 
+  - <b>Yielding to other actor</b>.
+    @ref examples/s4u/actor-yield/s4u-actor-yield.c\n
+    The @ref yield function interrupts the execution of the
+    current actor, leaving a chance to run to the other actor
+    that are ready to run at the exact same timestamp
+
 @section s4u_ex_synchro Inter-Actor Synchronization 
 
  - <b>Mutex: </b> @ref examples/s4u/mutex/s4u-mutex.cpp \n