Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
doc: fix link to appveyor (and update text)
[simgrid.git] / doc / doxygen / module-msg.doc
index 6212e56..3ef2a6c 100644 (file)
@@ -1,7 +1,8 @@
 /**
-@defgroup MSG_API  MSG: Simple API for 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,12 +10,13 @@ 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.
+\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
@@ -27,7 +29,7 @@ may want to use one of the following:
    - \ref msg_VMs
    - \ref msg_synchro
    - \ref msg_trace_driven
-   - \ref MSG_examples
+   - \ref msg_examples
 
 */ 
 
@@ -36,7 +38,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
@@ -67,7 +69,7 @@ details).
 
 /** @defgroup msg_mailbox_management Mailbox Management Functions
  *  @ingroup MSG_API
- *  @brief Mailbox structure of MSG (#msg_mailbox_t) and associated functions.
+ *  @brief Functions associated to mailboxes.
  */
 
 /** @defgroup msg_task_usage Task Actions
@@ -91,13 +93,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