From: Martin Quinson <martin.quinson@ens-rennes.fr>
Date: Mon, 17 Jun 2019 13:18:35 +0000 (+0200)
Subject: Various doc fixups
X-Git-Tag: v3.23~24
X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/6407c57e6664350e3d816ef5687e64acac2328b4?hp=5b7ec61264fae956708bce0eece8826296462313

Various doc fixups

- fix a borken link
- further ns-3 cosmetics
- fix RST formating in javadoc
- Remove dead functions from MSG doc
- Some VM "functions" are implemented as preprocessor defines

Why fixing it now? Because I have other things to do, of course.
---

diff --git a/docs/source/Configuring_SimGrid.rst b/docs/source/Configuring_SimGrid.rst
index 993f35cf79..1eb7edb09e 100644
--- a/docs/source/Configuring_SimGrid.rst
+++ b/docs/source/Configuring_SimGrid.rst
@@ -217,9 +217,9 @@ models for all existing resources.
     poorly modeled. This model is described in `A Network Model for
     Simulation of Grid Application
     <https://hal.inria.fr/inria-00071989/document>`_.
-  - **NS3** (only available if you compiled SimGrid accordingly):
+  - **ns-3** (only available if you compiled SimGrid accordingly):
     Use the packet-level network
-    simulators as network models (see :ref:`pls_ns3`).
+    simulators as network models (see :ref:`model_ns3`).
     This model can be :ref:`further configured <options_pls>`.
 
 - ``cpu/model``: specify the used CPU model.  We have only one model
@@ -417,15 +417,15 @@ meant to be detached as well.
 
 .. _options_pls:
 
-Configuring NS3
-^^^^^^^^^^^^^^^
+Configuring ns-3
+^^^^^^^^^^^^^^^^
 
-**Option** ``ns3/TcpModel`` **Default:** "default" (NS3 default)
+**Option** ``ns3/TcpModel`` **Default:** "default" (ns-3 default)
 
-When using NS3, there is an extra item ``ns3/TcpModel``, corresponding
+When using ns-3, there is an extra item ``ns3/TcpModel``, corresponding
 to the ``ns3::TcpL4Protocol::SocketType`` configuration item in
-NS3. The only valid values (enforced on the SimGrid side) are
-'default' (no change to the NS3 configuration), 'NewReno' or 'Reno' or
+ns-3. The only valid values (enforced on the SimGrid side) are
+'default' (no change to the ns-3 configuration), 'NewReno' or 'Reno' or
 'Tahoe'.
 
 Configuring the Storage model
diff --git a/docs/source/app_msg.rst b/docs/source/app_msg.rst
index 04a3514578..a7853f73a7 100644
--- a/docs/source/app_msg.rst
+++ b/docs/source/app_msg.rst
@@ -70,7 +70,6 @@ This describes the process structure :cpp:type:`msg_process_t` and the functions
 .. doxygenfunction:: MSG_process_create
 .. doxygenfunction:: MSG_process_create_with_arguments
 .. doxygenfunction:: MSG_process_create_with_environment
-.. doxygenfunction:: MSG_process_create_from_stdfunc
 .. doxygenfunction:: MSG_process_daemonize
 .. doxygenfunction:: MSG_process_detach
 .. doxygenfunction:: MSG_processes_as_dynar
@@ -83,7 +82,6 @@ This describes the process structure :cpp:type:`msg_process_t` and the functions
 .. doxygenfunction:: MSG_process_get_PPID
 .. doxygenfunction:: MSG_process_get_properties
 .. doxygenfunction:: MSG_process_get_property_value
-.. doxygenfunction:: MSG_process_get_smx_ctx
 .. doxygenfunction:: MSG_process_is_suspended
 .. doxygenfunction:: MSG_process_join
 .. doxygenfunction:: MSG_process_kill
@@ -172,8 +170,8 @@ Task structure of MSG :cpp:type:`msg_task_t` and associated functions.
 .. doxygenfunction:: MSG_task_receive_ext_bounded
 .. doxygenfunction:: MSG_task_receive_with_timeout
 .. doxygenfunction:: MSG_task_receive_with_timeout_bounded
-.. doxygenfunction:: MSG_task_recv
-.. doxygenfunction:: MSG_task_recv_bounded
+.. doxygendefine:: MSG_task_recv
+.. doxygendefine:: MSG_task_recv_bounded
 .. doxygenfunction:: MSG_task_send
 .. doxygenfunction:: MSG_task_send_bounded
 .. doxygenfunction:: MSG_task_send_with_timeout
@@ -243,7 +241,6 @@ into, and interact directly with the VMs to manage groups of
 processes.
 
 .. doxygentypedef:: msg_vm_t
-.. doxygenfunction:: MSG_vm_create
 .. doxygenfunction:: MSG_vm_create_core
 .. doxygenfunction:: MSG_vm_create_multicore
 .. doxygenfunction:: MSG_vm_destroy
diff --git a/src/bindings/java/org/simgrid/msg/ProcessKilledError.java b/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
index b9ebb49f34..9e8377ec49 100644
--- a/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
+++ b/src/bindings/java/org/simgrid/msg/ProcessKilledError.java
@@ -7,16 +7,19 @@ package org.simgrid.msg;
 
 /** Used internally to interrupt the user code when the process gets killed.
  *
+ * \rst
  * You can catch it for cleanups or to debug, but DO NOT BLOCK IT, or your simulation will segfault!
  *
- * <code>
- * try {
- *   getHost().off();
- * } catch (ProcessKilledError e) {
- *   e.printStackTrace();
- *   throw e;
- * }
- * </code>
+ * .. code-block:: java
+ *
+ *    try {
+ *      getHost().off();
+ *    } catch (ProcessKilledError e) {
+ *      e.printStackTrace();
+ *      throw e;
+ *    }
+ *
+ * \endrst
  */
 
 public class ProcessKilledError extends Error {