Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid

[simgrid.git] / doc / module-msg.doc

diff --git a/doc/module-msg.doc b/doc/module-msg.doc
index 31ebd24..ab70142 100644 (file)
--- a/doc/module-msg.doc
+++ b/doc/module-msg.doc
@@ -19,6 +19,7 @@
    - \ref m_task_management
    - \ref msg_file_management
    - \ref msg_task_usage
+   - \ref msg_VMs
    - \ref msg_trace_driven
    - \ref msg_deprecated_functions
 
@@ -81,12 +82,29 @@ details).
  * \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Tasks" --> \endhtmlonly
  */
  
-/** @defgroup msg_task_usage Task Usage
+/** @defgroup msg_task_usage Task Actions
  *  @ingroup MSG_API
  *  @brief This section describes the functions that can be used
  *         by a process to execute, communicate or otherwise handle some task.
  */
 
+/** @defgroup msg_VMs VMs
+ *  @ingroup MSG_API
+ *  @brief This section describes the interface created to mimick IaaS clouds.
+ *
+ *  With it, you can create virtual machines to put your processes
+ *  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_file_management File Management Functions
  *  @ingroup MSG_API
  *  @brief This section describes the file structure of MSG
@@ -191,7 +209,7 @@ an external description of the deployment.
 
 <hr> 
 
-\dontinclude msg/icomms/peer.c
+\don'tinclude msg/icomms/peer.c
 
 \section MSG_ext_icomms_code Code of the application
 
@@ -254,7 +272,7 @@ This initializes MSG, runs a simulation, and free all data-structures created by
 
 \until end_of_main
 
-\dontinclude msg/icomms/peer2.c
+\don'tinclude msg/icomms/peer2.c
 
 \section MSG_ext_icomms_fct_Waitall Waitall function for sender
 
@@ -269,13 +287,13 @@ The MSG_comm_waitany() function return the place of the first message send or re
 
 \subsection MSG_ext_icomms_fct_Waitany_sender From a sender
 We can use this function to wait all sent messages.
-\dontinclude msg/icomms/peer3.c
+\don'tinclude msg/icomms/peer3.c
 \skipline Sender function
 \until end_of_sender
 
 \subsection MSG_ext_icomms_fct_Waitany_receiver From a receiver
 We can also wait for the arrival of all messages.
-\dontinclude msg/icomms/peer3.c
+\don'tinclude msg/icomms/peer3.c
 \skipline Receiver function
 \until end_of_receiver
 
@@ -303,7 +321,7 @@ and an external description of the deployment.
  
 <hr> 
 
-\dontinclude msg/masterslave/masterslave_forwarder.c
+\don'tinclude msg/masterslave/masterslave_forwarder.c
 
 \section MSG_ext_ms_code Code of the application
 
@@ -401,7 +419,7 @@ This initializes MSG, runs a simulation, and free all data-structures created by
        - \ref MSG_ext_ms_platform
        
        
-      \dontinclude lua/masterslave/master_slave.lua
+      \don'tinclude lua/masterslave/master_slave.lua
       
       \section MSG_ext_ms_code_lua Code of the application
       
@@ -454,7 +472,7 @@ This initializes MSG, runs a simulation, and free all data-structures created by
        - \ref MSG_ext_ms_core_lua
        
        
-      \dontinclude lua/console/master_slave_bypass.lua
+      \don'tinclude lua/console/master_slave_bypass.lua
       
       \section MSG_ext_ms_code_lua Code of the application