X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fa566f5efbd82018b1cf560e2453eb846c49c173..ab695d4806ab6096bc0bf1b669cbc14d63e50bc3:/examples/msg/README.doc

diff --git a/examples/msg/README.doc b/examples/msg/README.doc
index 639f786334..522000bacc 100644
--- a/examples/msg/README.doc
+++ b/examples/msg/README.doc
@@ -2,11 +2,11 @@ This file follows the Doxygen syntax to be included in the
 documentation, but it should remain readable directly.
 
 /** 
- @defgroup MSG_examples MSG examples
+ @defgroup msg_examples MSG examples
  @ingroup MSG_API
  @brief Find the MSG example fitting your needs from the extensive set provided in the archive.
 
-  - @ref msg_ex_basic
+  - @ref msg_ex_basics
   - @ref msg_ex_async
   - @ref msg_ex_process
   - @ref msg_ex_tracing
@@ -18,7 +18,7 @@ documentation, but it should remain readable directly.
   - @ref msg_ex_apps
   - @ref msg_ex_misc
 		    
-@section msg_ex_basic Basic examples and features
+@section msg_ex_basics Basic examples and features
 
  - <b>Ping Pong</b>: @ref examples/msg/app-pingpong/app-pingpong.c\n
    It's hard to think of a simpler example: it is just sending one
@@ -38,7 +38,7 @@ documentation, but it should remain readable directly.
    @ref examples/msg/app-masterworker/app-masterworker.c\n
    Another good old example, where one Master process has a bunch of
    task to dispatch to a set of several Worker processes. It is fully
-   commented in @ref MSG_ex_master_worker.
+   commented in @ref msg_ex_master_worker.
 
 @section msg_ex_async Asynchronous communications
 
@@ -60,11 +60,11 @@ shipped in the archive:
    until all activities in a given set have completed.
    
  - <b>Waiting for the first completed communication in a set</b>.
-   @ref examples/msg/async-waitall/async-waitany.c\n
+   @ref examples/msg/async-waitany/async-waitany.c\n
    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.
-
+   
 @section msg_ex_process Acting on Processes
 
   - <b>Creating processes</b>. 
@@ -85,6 +85,12 @@ shipped in the archive:
     @ref examples/msg/process-migration/process-migration.c \n
     Processes can move or be moved from a host to another with the @ref MSG_process_migrate function.
     
+  - <b>Yielding to other processes</b>.
+    @ref examples/msg/process-yield/process-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
+
   - <b>Controling the process life cycle from the XML</b>.
     @ref examples/msg/process-startkilltime/process-startkilltime.c \n
     You can specify a start time and a kill time in the deployment
@@ -164,10 +170,10 @@ They have to be run with the following options:
 @subsection msg_ex_ns3 NS3 as a SimGrid Network Model
 
 This example demonstrates how to use the bindings to the Network
-Simulator, as explained in @ref pls. The most
+Simulator, as explained in @ref pls_ns3. The most
 interesting is probably not the C files since they are unchanged from
 the other simulations, but the associated files, such as the platform
-file to see how to declare a platform to be used with the PLS bindings
+file to see how to declare a platform to be used with the ns-3 bindings
 of SimGrid and the tesh file to see how to actually start a simulation
 in these settings.
   
@@ -227,14 +233,6 @@ also the tesh files in the example directories for details.
 
 @section msg_ex_apps Examples of Full Applications
  
-  - <b>Parallel Matrix Multiplication</b>.
-    @ref examples/msg/app-pmm/app-pmm.c \n
-    This little application multiplies two matrices in parallel. Each
-    of the 9 processes computes a sub-block of the result, with the
-    sub-blocks of the input matrices exchanged between the processes. \n
-    This is a classical assignment in MPI lectures, here implemented
-    in MSG.
-
   - <b>Chord P2P protocol</b>.
     @ref examples/msg/dht-chord/dht-chord.c \n
     This example implements the well known Chord protocol,
@@ -269,14 +267,14 @@ top of the example file).
 
 
 /**
-@defgroup MSG_ex_examples ignored
 @example examples/msg/app-pingpong/app-pingpong.c        
 @example examples/msg/app-token-ring/app-token-ring.c    
 @example examples/msg/app-masterworker/app-masterworker.c
 
 @example examples/msg/async-wait/async-wait.c
 @example examples/msg/async-waitall/async-waitall.c
-@example examples/msg/async-waitall/async-waitany.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
@@ -288,9 +286,9 @@ top of the example file).
 @example examples/msg/trace-categories/trace-categories.c
 @example examples/msg/trace-masterworker/trace-masterworker.c
 @example examples/msg/trace-process-migration/trace-process-migration.c
-@example examples/msg/trace-user-variables/trace-user-variables.c
+@example examples/msg/trace-host-user-variables/trace-host-user-variables.c
 @example examples/msg/trace-link-user-variables/trace-link-user-variables.c
-@example examples/msg/trace-link-srcdst-user-variables/trace-link-srcdst-user-variables.c
+@example examples/msg/trace-route-user-variables/trace-route-user-variables.c
 
 @example examples/msg/network-ns3/network-ns3.c
 
@@ -301,11 +299,10 @@ top of the example file).
 @example examples/msg/actions-comm/actions-comm.c
 @example examples/msg/actions-storage/actions-storage.c
 
-@example examples/msg/app-pmm/app-pmm.c
-@example examples/msg/dht-chord
+@example examples/msg/dht-chord/dht-chord.c
 
 @example examples/msg/task-priority/task-priority.c
-@example examples/msg/properties/properties.c
+@example examples/msg/platform-properties/platform-properties.c
 			 
 */