From a3ff2d592d10a66e48ab08baad136bd993241f11 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Thu, 27 Jan 2022 10:52:35 +0100 Subject: [PATCH] fix some doc issues --- docs/source/Release_Notes.rst | 1 + docs/source/Tutorial_Algorithms.rst | 2 +- docs/source/Tutorial_Model-checking.rst | 8 ++++++-- docs/source/app_s4u.rst | 4 ++-- examples/README.rst | 13 +++++++++++-- 5 files changed, 21 insertions(+), 7 deletions(-) diff --git a/docs/source/Release_Notes.rst b/docs/source/Release_Notes.rst index ebce0c2941..8f069ce658 100644 --- a/docs/source/Release_Notes.rst +++ b/docs/source/Release_Notes.rst @@ -436,6 +436,7 @@ maestro to handle the execution of such DAGs. This release finishes this work, which is presented in a new set of examples (examples/cpp/dag-*). The direct consequences on the code base of this new feature are: + * The SimDag API for the simulation of the scheduling of Directed Acyclic Graphs has been finally dropped. It was marked as deprecated for a couple of years. * The removal of SimDag led us to also remove the export to Jedule files that was tightly coupled to SimDag. The instrumentation of DAG simulation diff --git a/docs/source/Tutorial_Algorithms.rst b/docs/source/Tutorial_Algorithms.rst index 3e3498194e..af93ee55a9 100644 --- a/docs/source/Tutorial_Algorithms.rst +++ b/docs/source/Tutorial_Algorithms.rst @@ -924,7 +924,7 @@ and wait for its completion, as follows. exec = simgrid:.this_actor.exec_init(compute_cost) exec.set_tracing_category(category) - // exec.start() is optional here as wait() starts the activity on need + # exec.start() is optional here as wait() starts the activity on need exec->wait() You can shorten this code as follows: diff --git a/docs/source/Tutorial_Model-checking.rst b/docs/source/Tutorial_Model-checking.rst index a76da2081d..9bf4535c63 100644 --- a/docs/source/Tutorial_Model-checking.rst +++ b/docs/source/Tutorial_Model-checking.rst @@ -85,7 +85,9 @@ that uses the :ref:`S4U interface ` of SimGrid, but we provide a if you prefer (see below for details on using the MPI version). .. toggle-header:: - :header: Code of ``ndet-receive-s4u.cpp``: click here to open it, or `view it online `_ + :header: Code of ``ndet-receive-s4u.cpp``: click here to open + + You can also `view it online `_ .. literalinclude:: tuto_mc/ndet-receive-s4u.cpp :language: cpp @@ -249,7 +251,9 @@ If you prefer, you can use MPI instead of the SimGrid-specific interface. Inspec translation of ``ndet-receive-s4u.cpp`` to MPI. .. toggle-header:: - :header: Code of ``ndet-receive-mpi.c``: click here to open it, or `view it online `_ + :header: Code of ``ndet-receive-mpi.c``: click here to open + + You can also `view it online `_. .. literalinclude:: tuto_mc/ndet-receive-mpi.c :language: cpp diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index ee3d74b2d8..1cb35ad7eb 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -945,8 +945,8 @@ Interacting with the routing .. automethod:: simgrid.Engine.get_all_netpoints .. automethod:: simgrid.Engine.get_netzone_root - .. automethod:: simgrid.Engine.netpoint_by_name_or_null - .. automethod:: simgrid.Engine.netzone_by_name_or_null + .. automethod:: simgrid.Engine.netpoint_by_name + .. automethod:: simgrid.Engine.netzone_by_name .. automethod:: simgrid.Engine.set_netzone_root Signals diff --git a/examples/README.rst b/examples/README.rst index 86c5f8945e..48503e4398 100644 --- a/examples/README.rst +++ b/examples/README.rst @@ -216,7 +216,7 @@ Actors can move or be moved from a host to another very easily. It amounts to se .. example-tab:: examples/python/actor-migrate/actor-migrate.py - See also :py:func:`simgrid.this_actor.set_host()` and :py:func:`simgrid.Actor.set_host()`. + See also :py:func:`simgrid.this_actor.set_host()` and :py:func:`simgrid.Actor.host`. .. example-tab:: examples/c/actor-migrate/actor-migrate.c @@ -497,7 +497,7 @@ You can start executions on remote hosts, or even change the host on which they .. example-tab:: examples/python/exec-remote/exec-remote.py - See also :py:func:`simgrid.Exec.set_host()`. + See also :py:func:`simgrid.Exec.host`. .. example-tab:: examples/c/exec-remote/exec-remote.c @@ -1077,6 +1077,15 @@ Another well-known DHT protocol. .. showfile:: examples/c/dht-kademlia/node.c :language: cpp +Pastry +^^^^^^ + +Yet another well-known DHT protocol. + +.. tabs:: + + .. example-tab:: examples/c/dht-pastry/dht-pastry.c + .. _s4u_ex_clouds: Simulating Clouds -- 2.20.1