Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Various corrections in docs.
authorArnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Fri, 9 Jul 2021 08:51:25 +0000 (10:51 +0200)
committerArnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Fri, 9 Jul 2021 12:29:29 +0000 (14:29 +0200)
docs/source/Plugins.rst
docs/source/Tutorial_Algorithms.rst
docs/source/Tutorial_MPI_Applications.rst
docs/source/app_msg.rst
docs/source/app_s4u.rst
examples/README.rst
include/simgrid/s4u/Link.hpp

index 620da83..5bc1614 100644 (file)
@@ -98,7 +98,6 @@ Partial list of existing signals in s4u:
   :cpp:member:`Link::on_communication_state_change <simgrid::s4u::Link::on_communication_state_change>`
 - :cpp:member:`NetZone::on_creation <simgrid::s4u::NetZone::on_creation>`
   :cpp:member:`NetZone::on_seal <simgrid::s4u::NetZone::on_seal>`
-  :cpp:member:`NetZone::on_route_creation <simgrid::s4u::NetZone::on_route_creation>`
 - :cpp:member:`VirtualMachine::on_start <simgrid::s4u::VirtualMachine::on_start>`
   :cpp:member:`VirtualMachine::on_started <simgrid::s4u::VirtualMachine::on_started>`
   :cpp:member:`VirtualMachine::on_suspend <simgrid::s4u::VirtualMachine::on_suspend>`
index 028038e..424d211 100644 (file)
@@ -201,7 +201,7 @@ This time, we have all parts: once the program is compiled, we can
 execute it as follows. Note how the XBT_INFO() requests turned into
 informative messages.
 
-.. "WARNING: Over dedent has detected" is expected here as we remove the $ marker this way
+.. "WARNING: non-whitespace stripped by dedent" is expected here as we remove the $ marker this way
 
 .. literalinclude:: ../../examples/cpp/app-masterworkers/s4u-app-masterworkers.tesh
    :language: shell
index 982f816..04fe43a 100644 (file)
@@ -539,7 +539,7 @@ The computing part of this example is the matrix multiplication routine
 
 .. literalinclude:: /tuto_smpi/gemm_mpi.cpp
    :language: cpp
-   :lines: 4-19
+   :lines: 9-24
 
 .. code-block:: shell
 
index 0e5a943..973bb16 100644 (file)
@@ -180,7 +180,7 @@ Communications
 ==============
 
 .. doxygentypedef:: msg_comm_t
-
+.. doxygentypedef:: const_msg_comm_t
 .. doxygenfunction:: MSG_comm_destroy
 .. doxygenfunction:: MSG_comm_get_status
 .. doxygenfunction:: MSG_comm_get_task
@@ -244,7 +244,7 @@ processes.
 
 NetZone Management
 ==================
-Network Zone (:cpp:class:`msg_file_t`) and associated functions.
+Network Zone (:cpp:type:`msg_netzone_t`) and associated functions.
 
 .. doxygentypedef:: msg_netzone_t
 .. doxygenfunction:: MSG_zone_get_by_name
@@ -360,7 +360,6 @@ Package org.simgrid.msg
 
    Class org.simgrid.msg.As <java/org/simgrid/msg/As>
    Class org.simgrid.msg.Comm <java/org/simgrid/msg/Comm>
-   Class org.simgrid.msg.File <java/org/simgrid/msg/File>
    Class org.simgrid.msg.Host <java/org/simgrid/msg/Host>
    Class org.simgrid.msg.HostFailureException <java/org/simgrid/msg/HostFailureException>
    Class org.simgrid.msg.HostNotFoundException <java/org/simgrid/msg/HostNotFoundException>
@@ -372,8 +371,6 @@ Package org.simgrid.msg
    Class org.simgrid.msg.ProcessKilledError <java/org/simgrid/msg/ProcessKilledError>
    Class org.simgrid.msg.ProcessNotFoundException <java/org/simgrid/msg/ProcessNotFoundException>
    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>
    Class org.simgrid.msg.Task <java/org/simgrid/msg/Task>
    Class org.simgrid.msg.TaskCancelledException <java/org/simgrid/msg/TaskCancelledException>
    Class org.simgrid.msg.TimeoutException <java/org/simgrid/msg/TimeoutException>
index 7802af7..93f5e51 100644 (file)
@@ -1360,6 +1360,8 @@ Signals
 =============
 
 .. doxygenclass:: simgrid::s4u::Link
+.. doxygenclass:: simgrid::s4u::SplitDuplexLink
+.. doxygenclass:: simgrid::s4u::LinkInRoute
 
 Basic management
 ----------------
@@ -1613,9 +1615,9 @@ Routing data
 
    .. group-tab:: C++
 
-      .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
       .. doxygenfunction:: simgrid::s4u::NetZone::add_component(kernel::routing::NetPoint *elm)
       .. doxygenfunction:: simgrid::s4u::NetZone::add_route
+      .. doxygenfunction:: simgrid::s4u::NetZone::add_bypass_route
       .. doxygenfunction:: simgrid::s4u::NetZone::get_children() const
       .. doxygenfunction:: simgrid::s4u::NetZone::get_parent() const
 
@@ -1631,7 +1633,6 @@ Signals
   .. group-tab:: C++
 
      .. doxygenvariable:: simgrid::s4u::NetZone::on_creation
-     .. doxygenvariable:: simgrid::s4u::NetZone::on_route_creation
      .. doxygenvariable:: simgrid::s4u::NetZone::on_seal
 
 .. _API_s4u_VirtualMachine:
index 0b3252c..a562127 100644 (file)
@@ -1089,11 +1089,3 @@ SimGrid is slower and may be less robust when MC is enabled.
 .. |br| raw:: html
 
    <br />
-
-.. |cpp| image:: /img/lang_cpp.png
-   :align: middle
-   :width: 12
-
-.. |py| image:: /img/lang_python.png
-   :align: middle
-   :width: 12
index bcacca0..2ea809b 100644 (file)
@@ -176,12 +176,12 @@ public:
 
 /**
  * @beginrst
- * Another encapsulation for using links in the :cpp:function:: NetZone::add_route
+ * Another encapsulation for using links in the :cpp:func:`NetZone::add_route`
  *
  * When adding a route with split-duplex links, you need to specify the direction of the link
  * so SimGrid can know exactly which physical link to insert in the route.
  *
- * For shared/fat-pipe links, use the Direction::NONE since they don't have
+ * For shared/fat-pipe links, use the :cpp:enum:`Direction::NONE` since they don't have
  * the concept of UP/DOWN links.
  * @endrst
  */