From: Martin Quinson <martin.quinson@loria.fr>
Date: Fri, 27 Jan 2017 16:41:24 +0000 (+0100)
Subject: document the new MSG example I recently added
X-Git-Tag: v3_15~509
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/120ccccaa823e43ad226caa1e22198f3ffff9f47

document the new MSG example I recently added
---

diff --git a/examples/msg/README.doc b/examples/msg/README.doc
index 1115a2250a..16878978b7 100644
--- a/examples/msg/README.doc
+++ b/examples/msg/README.doc
@@ -64,6 +64,12 @@ shipped in the archive:
    The @ref MSG_comm_waitany function is useful when you want to block
    until one activity of the set completes, no matter which terminates
    first.
+   
+ - <b>Yielding to other processes</b>.
+   @ref examples/msg/async-yield/async-yield.c\n
+   The @ref MSG_process_yield function interrupts the execution of the
+   current process, leaving a chance to run to the other processes
+   that are ready to run at the exact same timestamp
 
 @section msg_ex_process Acting on Processes
 
@@ -276,6 +282,7 @@ top of the example file).
 @example examples/msg/async-wait/async-wait.c
 @example examples/msg/async-waitall/async-waitall.c
 @example examples/msg/async-waitany/async-waitany.c
+@example examples/msg/async-yield/async-yield.c
 
 @example examples/msg/process-create/process-create.c
 @example examples/msg/process-suspend/process-suspend.c