Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
another example to teshsuite move
[simgrid.git] / examples / msg / README.doc
index 42597dd..9f9309a 100644 (file)
@@ -7,7 +7,6 @@ documentation, but it should remain readable directly.
  @brief Find the MSG example fitting your needs from the extensive set provided in the archive.
 
   - @ref msg_ex_basics
-  - @ref msg_ex_async
   - @ref msg_ex_process
   - @ref msg_ex_tracing
     - @ref msg_ex_tracing_user_variables
@@ -39,31 +38,6 @@ documentation, but it should remain readable directly.
    task to dispatch to a set of several Worker processes. It is fully
    commented in @ref msg_ex_master_worker.
 
-@section msg_ex_async Asynchronous communications
-
-In addition to the fully documented example of @ref
-MSG_ex_asynchronous_communications, there are several other examples
-shipped in the archive:
-  
- - <b>Basic asynchronous communications</b>. 
-   @ref examples/msg/async-wait/async-wait.c \n
-   Illustrates how to have non-blocking communications, that are
-   communications running in the background leaving the process free
-   to do something else during their completion. The main functions
-   involved are @ref MSG_task_isend, @ref MSG_task_irecv, and @ref
-   MSG_comm_wait.
- - <b>Waiting for all communications in a set</b>.
-   @ref examples/msg/async-waitall/async-waitall.c\n
-   The @ref MSG_comm_waitall function is useful when you want to block
-   until all activities in a given set have completed.
-   
- - <b>Waiting for the first completed communication in a set</b>.
-   @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>. 
@@ -71,19 +45,6 @@ shipped in the archive:
     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
-    thanks to the @ref MSG_process_suspend and @ref MSG_process_resume functions.
-
-  - <b>Kill processes</b>.
-    @ref examples/msg/process-kill/process-kill.c \n
-    Processes can forcefully stop other processes with the @ref MSG_process_kill function.
-     
-  - <b>Migrating processes</b>.
-    @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>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
@@ -129,8 +90,8 @@ options to see the task executions:
     displayed as arrows in a Gantt-chart visualization. Recommanded
     options to that extend:
     @verbatim -cfg=tracing:yes --cfg=tracing/msg/process:yes
-    @endverbatim     
-
+    @endverbatim 
+    
 TODO: These tracing examples should be integrated in the examples to
 not duplicate the C files. A full command line to see the result in
 the right tool (vite/FrameSoc) should be given along with some
@@ -182,18 +143,10 @@ TODO: show the XML files instead if it's what is interesting. On a "XML example
 The examples of this section demonstrate how to interact with the
 simulated storages.
 
-  - <b>Basic example</b>.
-    @ref examples/msg/io-storage/io-storage.c \n
-    All main storage and file functions are demoed.
-    
   - <b>File Management</b>. @ref examples/msg/io-file/io-file.c \n
     This example illustrates the use of operations on file
     (@ref MSG_file_open, @ref MSG_file_read, @ref MSG_file_write,
     or @ref MSG_file_close).
-    
-  - <b>Remote I/O</b>. @ref examples/msg/io-remote/io-remote.c \n
-    I/O operations can also be done in a remote, i.e. when the
-    accessed disk is not mounted on the caller's host.
 
 @section msg_ex_misc Miscellaneous
 
@@ -226,14 +179,7 @@ top of the example file).
 @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-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-platform/trace-platform.c