X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/99149d9a7fb61c938c70478ae8196ec37876b17f..a451588d036aa6addbf51c71bbb670f81acfe319:/doc/doxygen/module-msg.doc

diff --git a/doc/doxygen/module-msg.doc b/doc/doxygen/module-msg.doc
index e2f57c05c9..5f3c420730 100644
--- a/doc/doxygen/module-msg.doc
+++ b/doc/doxygen/module-msg.doc
@@ -1,7 +1,8 @@
 /**
-@defgroup MSG_API  MSG: Simulate CSP Algorithms
+@defgroup MSG_API  MSG: Legacy handling of CSP algorithms
 @brief Simple programming environment
 
+
 MSG is a simple API to write algorithms organized with Concurrent
 Sequential Processes (CSP) that interact by exchanging messages. It
 constitutes a convenient simplification of the reality of distributed
@@ -9,25 +10,25 @@ systems. It can be used to build rather realistic simulations, but
 remains simple to use: most unpleasant technical elements can be
 abstracted away rather easily.
 
-If you are unsure, then you probably want to use MSG. Otherwise, you
-may want to use one of the following:
-
- - MSG in Java instead of C: @ref MSG_Java.
- - If you want to use DAGs: @ref SD_API.
- - If you want to study a MPI application: @ref SMPI_API.
-
-\section MSG_funct Offered functionalities
-   - \ref msg_simulation
-   - \ref m_process_management
-   - \ref m_host_management
-   - \ref m_task_management
-   - \ref msg_mailbox_management
+@warning MSG used to be the main API of SimGrid 3, but we are
+	 currently in the process of releasing SimGrid 4. The
+	 tentative release date is Summer 2018. So MSG is frozen and
+	 will probably never evolve. If you are starting a new
+	 project, you should consider S4U instead. Note that the
+	 support for MSG will not be removed from SimGrid before 2020
+	 at least.
+
+@section MSG_funct Offered functionalities
+   - @ref msg_simulation
+   - @ref m_process_management
+   - @ref m_host_management
+   - @ref m_task_management
+   - @ref msg_mailbox_management
    - @ref msg_file
-   - \ref msg_task_usage
-   - \ref msg_VMs
-   - \ref msg_synchro
-   - \ref msg_trace_driven
-   - \ref MSG_examples
+   - @ref msg_task_usage
+   - @ref msg_VMs
+   - @ref msg_synchro
+   - @ref msg_examples
 
 */ 
 
@@ -36,7 +37,7 @@ may want to use one of the following:
 @ingroup MSG_API
 @brief How to setup and control your simulation.
 
-The basic workflow is the following (check the \ref MSG_examples for
+The basic workflow is the following (check the @ref msg_examples for
 details).
 
  -# Initialize the library with #MSG_init
@@ -62,7 +63,7 @@ details).
 /** @defgroup m_task_management Task Management Functions
  *  @ingroup MSG_API
  *  @brief Task structure of MSG (#msg_task_t) and associated functions. See
- *         \ref msg_task_usage to see how to put the tasks in action.
+ *         @ref msg_task_usage to see how to put the tasks in action.
  */
 
 /** @defgroup msg_mailbox_management Mailbox Management Functions
@@ -91,13 +92,6 @@ details).
  *  into, and interact directly with the VMs to manage groups of
  *  processes.
  *
- *  This interface is highly experimental at this point. Testing is
- *  welcomed, but do not expect too much of it right now. Even the
- *  interfaces may be changed in future releases of SimGrid (although
- *  things are expected to stabilize nicely before SimGrid v3.8).
- *  There is no guaranty on the rest of SimGrid, and there is less
- *  than that on this part.
- *
  */
 
 /** @defgroup msg_storage_management Storage Management Functions
@@ -109,25 +103,3 @@ details).
     @ingroup MSG_API
     @brief MSG files (#msg_file_t) and associated functions, inspired from POSIX.
 */
-
-/**
-@defgroup msg_trace_driven Trace-driven simulations
-@ingroup MSG_API
-@brief This section describes the functions allowing to build trace-driven simulations.
-
-This is very handy when you want to test an algorithm or protocol that
-does nothing unless it receives some events from outside. For example,
-a P2P protocol reacts to requests from the user, but does nothing if
-there is no such event.
-
-In such situations, SimGrid allows to write your protocol in your C
-file, and the events to react to in a separate text file. Declare a
-function handling each of the events that you want to accept in your
-trace files, register them using #xbt_replay_action_register in your main,
-and then use #MSG_action_trace_run to launch the simulation. You can
-either have one trace file containing all your events, or a file per
-simulated process.
-
-Check the examples in <b>examples/msg/actions/actions.c</b> for details.
-
- */