document new option

[simgrid.git] / docs / source / app_msg.rst

diff --git a/docs/source/app_msg.rst b/docs/source/app_msg.rst
index 511b907..0e5a943 100644 (file)
--- a/docs/source/app_msg.rst
+++ b/docs/source/app_msg.rst
@@ -9,7 +9,10 @@ The MSG Interface (legacy interface)
    the process of releasing SimGrid 4. 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.
+   be removed from SimGrid before 2020Q4 or 2021Q1.
+
+   This interface is disabled by default. Pass -Denable_msg=ON to
+   cmake if you still need it.
 
 MSG is a simple API to write algorithms organized with Concurrent
 Sequential Processes (CSP) that interact by exchanging messages. It
@@ -44,10 +47,9 @@ The basic workflow is the following:
 .. doxygendefine:: MSG_init
 .. doxygenfunction:: MSG_launch_application
 .. doxygenfunction:: MSG_main
-.. doxygenfunction:: MSG_set_function
 
-Process Management Functions
-============================
+Process Management
+==================
 
 This describes the process structure :cpp:type:`msg_process_t` and the functions for managing it.
 
@@ -90,26 +92,24 @@ This describes the process structure :cpp:type:`msg_process_t` and the functions
 .. doxygenfunction:: MSG_process_unref
 .. doxygenfunction:: MSG_process_yield
 
-Host Management Functions
-=========================
+Host Management
+===============
 
 .. doxygentypedef:: msg_host_t
 .. doxygenfunction:: MSG_host_by_name
 .. doxygenfunction:: MSG_get_host_by_name
 .. doxygenfunction:: MSG_get_host_number
-.. doxygenfunction:: MSG_host_get_attached_storage_lists
 .. doxygenfunction:: MSG_host_get_core_number
 .. doxygenfunction:: MSG_host_get_data
-.. doxygenfunction:: MSG_host_get_mounted_storage_list
 .. doxygenfunction:: MSG_host_get_name
 .. doxygenfunction:: MSG_host_get_nb_pstates
+.. doxygenfunction:: MSG_host_get_load
 .. doxygenfunction:: MSG_host_get_power_peak_at
 .. doxygenfunction:: MSG_host_get_process_list
 .. doxygenfunction:: MSG_host_get_properties
 .. doxygenfunction:: MSG_host_get_property_value
 .. doxygenfunction:: MSG_host_get_pstate
 .. doxygenfunction:: MSG_host_get_speed
-.. doxygenfunction:: MSG_host_is_off
 .. doxygenfunction:: MSG_host_is_on
 .. doxygenfunction:: MSG_host_off
 .. doxygenfunction:: MSG_host_on
@@ -119,12 +119,13 @@ Host Management Functions
 .. doxygenfunction:: MSG_host_set_property_value
 .. doxygenfunction:: MSG_host_set_pstate
 
-Task Management Functions
-=========================
+Task Management
+===============
 
 Task structure of MSG :cpp:type:`msg_task_t` and associated functions.
 
 .. doxygentypedef:: msg_task_t
+.. doxygentypedef:: const_msg_task_t
 .. doxygendefine:: MSG_TASK_UNINITIALIZED
 
 .. doxygenfunction:: MSG_parallel_task_create
@@ -153,8 +154,6 @@ Task structure of MSG :cpp:type:`msg_task_t` and associated functions.
 .. doxygenfunction:: MSG_task_listen_from
 .. doxygenfunction:: MSG_task_receive
 .. doxygenfunction:: MSG_task_receive_bounded
-.. doxygenfunction:: MSG_task_receive_ext
-.. doxygenfunction:: MSG_task_receive_ext_bounded
 .. doxygenfunction:: MSG_task_receive_with_timeout
 .. doxygenfunction:: MSG_task_receive_with_timeout_bounded
 .. doxygendefine:: MSG_task_recv
@@ -166,15 +165,14 @@ Task structure of MSG :cpp:type:`msg_task_t` and associated functions.
 .. doxygenfunction:: MSG_task_set_bound
 .. doxygenfunction:: MSG_task_set_bytes_amount
 .. doxygenfunction:: MSG_task_set_category
-.. doxygenfunction:: MSG_task_set_copy_callback
 .. doxygenfunction:: MSG_task_set_data
 .. doxygenfunction:: MSG_task_set_flops_amount
 .. doxygenfunction:: MSG_task_set_name
 .. doxygenfunction:: MSG_task_set_priority
 
                   
-Mailbox Management Functions
-============================
+Mailbox Management
+==================
 
 .. doxygenfunction:: MSG_mailbox_set_async
 
@@ -192,8 +190,8 @@ Communications
 .. doxygenfunction:: MSG_comm_waitall
 .. doxygenfunction:: MSG_comm_waitany
 
-Explicit Synchronization Functions
-==================================
+Explicit Synchronization
+========================
 
 Explicit synchronization mechanisms: semaphores (:cpp:type:`msg_sem_t`) and friends.
 
@@ -244,25 +242,8 @@ processes.
 .. doxygenfunction:: MSG_vm_start
 .. doxygenfunction:: MSG_vm_suspend
 
-Storage Management Functions
-============================
-Storage structure of MSG (:cpp:type:`msg_storage_t`) and associated functions, inspired from POSIX.
-
-.. doxygentypedef:: msg_storage_t
-.. doxygenfunction:: MSG_storage_get_by_name
-.. doxygenfunction:: MSG_storage_get_data
-.. doxygenfunction:: MSG_storage_get_host
-.. doxygenfunction:: MSG_storage_get_name
-.. doxygenfunction:: MSG_storage_get_properties
-.. doxygenfunction:: MSG_storage_get_property_value
-.. doxygenfunction:: MSG_storage_read
-.. doxygenfunction:: MSG_storages_as_dynar
-.. doxygenfunction:: MSG_storage_set_data
-.. doxygenfunction:: MSG_storage_set_property_value
-.. doxygenfunction:: MSG_storage_write
-
-Zone Management Functions
-=========================
+NetZone Management
+==================
 Network Zone (:cpp:class:`msg_file_t`) and associated functions.
 
 .. doxygentypedef:: msg_netzone_t
@@ -277,7 +258,7 @@ Network Zone (:cpp:class:`msg_file_t`) and associated functions.
 Java bindings
 *************
 
-This section describes jMSG, the Java API to Simgrid. This API mimicks 
+This section describes jMSG, the Java API to Simgrid. This API mimics 
 :ref:`MSG <MSG_doc>`, which is a simple yet somehow realistic interface.
 The full reference documentation is provided at the end of this page.
 
@@ -390,7 +371,6 @@ Package org.simgrid.msg
    Class org.simgrid.msg.Process <java/org/simgrid/msg/Process>
    Class org.simgrid.msg.ProcessKilledError <java/org/simgrid/msg/ProcessKilledError>
    Class org.simgrid.msg.ProcessNotFoundException <java/org/simgrid/msg/ProcessNotFoundException>
-   Class org.simgrid.msg.RngStream <java/org/simgrid/msg/RngStream>
    Class org.simgrid.msg.Semaphore <java/org/simgrid/msg/Semaphore>
    Class org.simgrid.msg.Storage <java/org/simgrid/msg/Storage>
    Class org.simgrid.msg.StorageNotFoundException <java/org/simgrid/msg/StorageNotFoundException>