X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/614c681fbb931bf120a2f4ddd6a0c682df021041..783573d576fa9ac43c007c6031bce185d882f92b:/examples/msg/README.doc
diff --git a/examples/msg/README.doc b/examples/msg/README.doc
index c2c9b0a08c..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
- Ping Pong: @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.
- Waiting for the first completed communication in a set.
- @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
- Creating processes.
@@ -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.
+ - Yielding to other processes.
+ @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
+
- Controling the process life cycle from the XML.
@ref examples/msg/process-startkilltime/process-startkilltime.c \n
You can specify a start time and a kill time in the deployment
@@ -133,7 +139,7 @@ options to see the task executions:
@endverbatim
TODO: These tracing examples should be integrated in the examples to
-not dupplicate the C files. A full command line to see the result in
+not duplicate the C files. A full command line to see the result in
the right tool (viva/vite/FrameSoc) should be given along with some
screenshots.
@@ -144,34 +150,30 @@ the platform file. The following examples illustrate this feature.
They have to be run with the following options:
@verbatim --cfg=tracing:yes --cfg=tracing/platform:yes
@endverbatim
-
+
- Attaching variables to Hosts.
- @ref examples/msg/trace-user-variables/trace-user-variables.c
-
+ @ref examples/msg/trace-host-user-variables/trace-host-user-variables.c
+
- Attaching variables to Links.
@ref examples/msg/trace-link-user-variables/trace-link-user-variables.c \n
The tricky part is that you have to know the name of the link you
want to enhance with a variable.
-
+
- Attaching variables to network Routes
- @ref examples/msg/trace-link-srcdst-user-variables/trace-link-srcdst-user-variables.c \n
+ @ref examples/msg/trace-route-user-variables/trace-route-user-variables.c \n
It is often easier to update a given variable for all links of a
given network path (identified by its source and destination
hosts) instead of knowing the name of each specific link.
-TODO: rename trace-user-variables to trace-host-user-variables
-
-TODO: rename trace-link-srcdst-user-variables to trace-route-user-variables
-
@section msg_ex_models Models-related examples
@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.
@@ -231,14 +233,6 @@ also the tesh files in the example directories for details.
@section msg_ex_apps Examples of Full Applications
- - Parallel Matrix Multiplication.
- @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.
-
- Chord P2P protocol.
@ref examples/msg/dht-chord/dht-chord.c \n
This example implements the well known Chord protocol,
@@ -273,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
@@ -292,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
@@ -305,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
*/