X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/6cbe53bf038252d0c8896c0c2bb176a762880b94..67bdf5427542ebb33da6978c6ae422a763ea0ab3:/examples/msg/README.doc
diff --git a/examples/msg/README.doc b/examples/msg/README.doc
index 00c8f32a2d..203c2495d2 100644
--- a/examples/msg/README.doc
+++ b/examples/msg/README.doc
@@ -12,31 +12,17 @@ documentation, but it should remain readable directly.
- @ref msg_ex_tracing_user_variables
- @ref msg_ex_models
- @ref msg_ex_ns3
- - @ref msg_ex_io
- - @ref msg_ex_apps
- - @ref msg_ex_misc
-@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
- message back and forth.
- The tesh file laying in the directory show how to start the
- simulator binary, highlighting how to pass options to the simulators
- (as detailed in Section \ref options).
+@warning MSG was deprecated in SimGrid v3.18. These examples should be
+ converted to S4U in the next releases. You really should
+ consider using S4U in your next project.
- - Token Ring.
- @ref examples/msg/app-token-ring/app-token-ring.c\n
- Classical communication pattern, where a token is exchanged
- along a ring to reach every participant.
- The tesh file laying in the directory shows how to run the same
- example on different virtual platforms.
+@section msg_ex_basics Basic examples and features
- Master Workers.
@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.
+ task to dispatch to a set of several Worker processes.
@section msg_ex_process Acting on Processes
@@ -45,17 +31,6 @@ documentation, but it should remain readable directly.
Most processes are started from the deployment XML file, but they
can also be used with the @ref MSG_process_create() function.
- - 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
- file. See all *_d.xml files in this directory.
-
- - Using Pstates on a host
- @ref examples/msg/energy-pstate/energy-pstate.c\n
- Show how define a set of pstates for a host and how the current
- pstate can be accessed/changed with @ref MSG_get_host_current_power_peak and @ref MSG_set_host_pstate.
- See also the platform XML file for have a details on how to declare the CPU capacity for each pstate.
-
@section msg_ex_tracing Tracing and visualization features
Tracing can be activated by various configuration options which
@@ -65,13 +40,6 @@ are illustrated in these example. See also the
It is interesting to run the process-create example with the following
options to see the task executions:
- - Platform tracing.
- @ref examples/msg/trace-platform/trace-platform.c \n
- This program is a toy example just loading the platform, so that
- you can play with the platform visualization. Recommanded options:
- @verbatim --cfg=tracing:yes --cfg=tracing/categorized:yes
- @endverbatim
-
- Setting Categories.
@ref examples/msg/trace-categories/trace-categories.c \n
This example declares several tracing categories
@@ -144,36 +112,6 @@ TODO: merge the C files
TODO: show the XML files instead if it's what is interesting. On a "XML example files" page that does not exist yet.
-@subsection msg_ex_io Simulating disks and files
-
-The examples of this section demonstrate how to interact with the
-simulated storages.
-
- - File Management. @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).
-
- - Remote I/O. @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
-
- - Task priorities.
- @ref examples/msg/task-priority/task-priority.c \n
- Demonstrates the use of @ref MSG_task_set_priority to change the
- computation priority of a given task.
-
- - User-defined properties.
- @ref examples/msg/platform-properties/platform-properties.c \n
- Attaching arbitrary information to host, processes and
- such, and retrieving them with @ref MSG_host_get_properties,
- @ref MSG_host_get_property_value, @ref MSG_process_get_properties, and
- @ref MSG_process_get_property_value. Also make sure to read the
- platform and deployment XML files to see how to declare these data.
-
-TODO: Document the many other examples that we have
*/
As a human, you can stop reading at this point. The rest is garbage:
@@ -185,14 +123,10 @@ top of the example file).
/**
-@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/process-create/process-create.c
-@example examples/msg/process-startkilltime/process-startkilltime.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
@@ -202,12 +136,5 @@ top of the example file).
@example examples/msg/network-ns3/network-ns3.c
-@example examples/msg/io-storage/io-storage.c
-@example examples/msg/io-file/io-file.c
-@example examples/msg/io-remote/io-remote.c
-
-@example examples/msg/task-priority/task-priority.c
-@example examples/msg/platform-properties/platform-properties.c
-
*/