a few smell in pastry, including a nasty one

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

diff --git a/examples/msg/README.doc b/examples/msg/README.doc
index cdf812b..baefe26 100644 (file)
--- a/examples/msg/README.doc
+++ b/examples/msg/README.doc
@@ -6,7 +6,7 @@ documentation, but it should remain readable directly.
  @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
@@ -60,13 +60,18 @@ 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>. 
+    @ref examples/msg/process-create/process-create.c \n
+    Most processes are started from the deployment XML file, but they
+    can also be used with the @ref MSG_process_create() function.
+
   - <b>Suspend and Resume processes</b>.
     @ref examples/msg/process-suspend/process-suspend.c \n
     Processes can be suspended and resumed during their executions
@@ -85,18 +90,14 @@ shipped in the archive:
     You can specify a start time and a kill time in the deployment
     file. See all *_d.xml files in this directory.
 
-TODO: add an example using @ref MSG_process_create()
-
 @section msg_ex_tracing Tracing and visualization features
 
 Tracing can be activated by various configuration options which
 are illustrated in these example. See also the 
 @ref tracing_tracing_options "full list of options related to tracing".
 
-  - <b>Basic example</b>. @ref examples/msg/trace-simple/trace-simple.c \n
-    In this very simple program, each process creates, executes,
-    and destroy a task. Recommanded options:
-    @verbatim --cfg=tracing:yes --cfg=tracing/uncategorized:yes @endverbatim
+It is interesting to run the process-create example with the following
+options to see the task executions:
 
   - <b>Platform tracing</b>.
     @ref examples/msg/trace-platform/trace-platform.c \n
@@ -163,10 +164,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.
   
@@ -268,28 +269,27 @@ 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/process-create/process-create.c
 @example examples/msg/process-suspend/process-suspend.c
 @example examples/msg/process-kill/process-kill.c
 @example examples/msg/process-migration/process-migration.c
 @example examples/msg/process-startkilltime/process-startkilltime.c
 
-@example examples/msg/trace-simple/trace-simple.c
 @example examples/msg/trace-platform/trace-platform.c
 @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,10 +301,10 @@ top of the example file).
 @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
                         
 */