From 2ccd814ab842a14cc6d408bf8596cc46967c991b Mon Sep 17 00:00:00 2001 From: Arnaud Giersch Date: Fri, 25 Jun 2021 13:05:17 +0200 Subject: [PATCH] More trivial fixes for docs. Remove reference to Mutex/Semaphore ctor and dtor, since they are not public. --- docs/source/Platform_routing.rst | 3 +++ docs/source/app_s4u.rst | 10 +++------- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/source/Platform_routing.rst b/docs/source/Platform_routing.rst index 527de66f7d..6a25bfd80f 100644 --- a/docs/source/Platform_routing.rst +++ b/docs/source/Platform_routing.rst @@ -27,6 +27,7 @@ platform. .. |tree_img| image:: img/zone_tree.svg :width: 45% + Circles represent processing units and squares represent network routers. Bold lines represent communication links. The zone "AS2" models the core of a national network interconnecting a small flat cluster (AS4) and a larger hierarchical cluster (AS5), a @@ -126,6 +127,7 @@ the 2 new gateway parameters in the syntax of :ref:`pf_tag_zoneroute`. A zone is not a physical resource, just a collection of resources (including other zones). Consequently, you need to describe the gateway, i.e. the physical resource inside the zone used for the route. It gives you 4 parameters to describe a zoneRoute: + - src: The object of source zone - dst: The object of destination zone - gw_src: Gateway inside src zone. A Host (or router) belonging to src zone. @@ -156,6 +158,7 @@ involved in the communication. As we stated earlier, each zone implements a different strategy, defined through the ``routing=`` parameter. + - **Full**: all routes must be explicitly given using the :ref:`pf_tag_route` and :ref:`pf_tag_link_ctn` tags (this :ref:`routing model ` is both simple and inefficient :). It is OK to not diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index f1756f7d74..cf0783ee5f 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -1327,7 +1327,7 @@ using :cpp:func:`Comm::sendto() `. .. group-tab:: C++ - .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() + .. doxygenfunction:: simgrid::s4u::Host::get_englobing_zone() const .. doxygenfunction:: simgrid::s4u::Host::get_netpoint() const .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< Link * > &links, double *latency) const .. doxygenfunction:: simgrid::s4u::Host::route_to(const Host *dest, std::vector< kernel::resource::LinkImpl * > &links, double *latency) const @@ -1998,8 +1998,8 @@ Life cycle .. doxygenfunction:: simgrid::s4u::Exec::start .. doxygenfunction:: simgrid::s4u::Exec::test .. doxygenfunction:: simgrid::s4u::Exec::wait - .. doxygenfunction:: simgrid::s4u::Exec::wait_any(std::vector< ExecPtr >& execs) - .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(std::vector< ExecPtr >& execs, double timeout) + .. doxygenfunction:: simgrid::s4u::Exec::wait_any(const std::vector< ExecPtr >& execs) + .. doxygenfunction:: simgrid::s4u::Exec::wait_any_for(const std::vector< ExecPtr >& execs, double timeout) .. doxygenfunction:: simgrid::s4u::Exec::wait_for .. group-tab:: Python @@ -2100,9 +2100,7 @@ Basic management .. doxygentypedef:: MutexPtr - .. doxygenfunction:: simgrid::s4u::Mutex::Mutex(kernel::activity::MutexImpl *mutex) .. doxygenfunction:: simgrid::s4u::Mutex::create() - .. doxygenfunction:: simgrid::s4u::Mutex::~Mutex() .. group-tab:: C @@ -2256,8 +2254,6 @@ Basic management #include .. doxygentypedef:: SemaphorePtr - .. doxygenfunction:: simgrid::s4u::Semaphore::Semaphore(unsigned int initial_capacity) - .. doxygenfunction:: simgrid::s4u::Semaphore::~Semaphore() .. doxygenfunction:: simgrid::s4u::Semaphore::create(unsigned int initial_capacity) .. group-tab:: C -- 2.20.1