From 466f188952918914db8c4124caa1b196cef505be Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Fri, 29 Jan 2021 20:07:44 +0100 Subject: [PATCH] Fix a few broken references and other warnings in the doc --- docs/source/Configuring_SimGrid.rst | 8 ++++---- docs/source/Plugins.rst | 6 ++---- docs/source/_ext/autodoxy.py | 8 ++++++-- docs/source/app_s4u.rst | 6 +++--- docs/source/outcomes.rst | 2 ++ docs/source/platform_howtos.rst | 2 +- include/simgrid/s4u/Actor.hpp | 2 +- src/s4u/s4u_Actor.cpp | 2 ++ 8 files changed, 21 insertions(+), 15 deletions(-) diff --git a/docs/source/Configuring_SimGrid.rst b/docs/source/Configuring_SimGrid.rst index d7f4ae9170..d420c7155b 100644 --- a/docs/source/Configuring_SimGrid.rst +++ b/docs/source/Configuring_SimGrid.rst @@ -877,10 +877,10 @@ Configuring the Tracing ----------------------- The :ref:`tracing subsystem ` can be configured in -several different ways depending on the nature of the simulator (MSG, -SimDag, SMPI) and the kind of traces that need to be obtained. See the +several different ways depending on the used interface (S4U, SMPI, SimDag) +and the kind of traces that needs to be obtained. See the :ref:`Tracing Configuration Options subsection -` to get a detailed description of each +` for a full description of each configuration option. We detail here a simple way to get the traces working for you, even if @@ -1553,7 +1553,7 @@ to a file). This section explains how to configure this logging features. You can also refer to the documentation of the :ref:`programmer's interface `, that allows to produce messages from your code. -Most of the time, the logging mechanism is configured at runtime using the ``--log`` command-line argument, even if you can also use :ref:`xbt_log_control_set()` to control it from +Most of the time, the logging mechanism is configured at runtime using the ``--log`` command-line argument, even if you can also use :c:func:`xbt_log_control_set()` to control it from your program. To pass configure more than one setting, you can either pass several ``--log`` arguments, or separate your settings with spaces, that must be quoted accordingly. In practice, the following is equivalent to the above settings: ``--log=root.thresh:error --log=s4u_host.thresh:debug``. diff --git a/docs/source/Plugins.rst b/docs/source/Plugins.rst index 2b9f596f11..1b91547c0e 100644 --- a/docs/source/Plugins.rst +++ b/docs/source/Plugins.rst @@ -59,12 +59,10 @@ Partial list of existing signals in s4u: :cpp:member:`Actor::on_resume ` :cpp:member:`Actor::on_sleep ` :cpp:member:`Actor::on_wake_up ` - :cpp:member:`Actor::on_migration_start ` - :cpp:member:`Actor::on_migration_end ` + :cpp:member:`Actor::on_host_change ` :cpp:member:`Actor::on_termination ` :cpp:member:`Actor::on_destruction ` -- :cpp:member:`Comm::on_sender_start ` - :cpp:member:`Comm::on_receiver_start ` +- :cpp:member:`Comm::on_start ` :cpp:member:`Comm::on_completion ` - :cpp:member:`Engine::on_platform_creation ` :cpp:member:`Engine::on_platform_created ` diff --git a/docs/source/_ext/autodoxy.py b/docs/source/_ext/autodoxy.py index e607ba9140..0a854cabd5 100644 --- a/docs/source/_ext/autodoxy.py +++ b/docs/source/_ext/autodoxy.py @@ -536,16 +536,20 @@ class DoxygenVariableDocumenter(DoxygenDocumenter): rtype_el_ref = rtype_el.find('ref') if rtype_el_ref is not None: rtype = text(rtype_el) + text(rtype_el_ref) + tail(rtype_el_ref) +# print(" --> rtype_el: {} rtype_el_ref: {}".format(text(rtype_el), text(rtype_el_ref))) else: rtype = rtype_el.text -# print("rtype: {}".format(rtype)) + print("rtype: {}".format(rtype)) signame = (rtype and (rtype + ' ') or '') + self.klassname + "::" + self.objname - return fix_namespaces(self.format_template_name() + signame) + res = fix_namespaces(self.format_template_name() + signame) +# print("formatted name: {}".format(res)) + return res def get_doc(self, encoding=None): # This method is called with 1 parameter in Sphinx 2.x and 2 parameters in Sphinx 1.x detaileddescription = self.object.find('detaileddescription') doc = [format_xml_paragraph(detaileddescription)] +# print ("doc: {}".format(doc)) return doc def format_template_name(self): diff --git a/docs/source/app_s4u.rst b/docs/source/app_s4u.rst index 3cf6cdb6c4..cb5611e24a 100644 --- a/docs/source/app_s4u.rst +++ b/docs/source/app_s4u.rst @@ -1466,7 +1466,7 @@ Signals .. group-tab:: C++ .. autodoxyvar:: simgrid::s4u::Link::on_bandwidth_change - .. cpp:var:: xbt::signal Link::on_communicate + .. autodoxyvar:: simgrid::s4u::Link::on_communicate .. autodoxyvar:: simgrid::s4u::Link::on_communication_state_change .. autodoxyvar:: simgrid::s4u::Link::on_creation .. autodoxyvar:: simgrid::s4u::Link::on_destruction @@ -1938,8 +1938,8 @@ Signals .. group-tab:: C++ - .. cpp:var:: xbt::signal Exec::on_completion - .. cpp:var:: xbt::signal Exec::on_start + .. autodoxyvar:: simgrid::s4u::Exec::on_start + .. autodoxyvar:: simgrid::s4u::Exec::on_completion .. _API_s4u_Io: diff --git a/docs/source/outcomes.rst b/docs/source/outcomes.rst index 441ec3d8a2..b5af5ecd47 100644 --- a/docs/source/outcomes.rst +++ b/docs/source/outcomes.rst @@ -32,6 +32,8 @@ its own appender. For more information, please refer to the :ref:`programmer's interface ` to learn how to produce messages from your code, or to :ref:`logging_config` to see how to change the settings at runtime. +.. _outcome_vizu: + Graphical and statistical logging ********************************* diff --git a/docs/source/platform_howtos.rst b/docs/source/platform_howtos.rst index e7dc6206e9..a191b0a800 100644 --- a/docs/source/platform_howtos.rst +++ b/docs/source/platform_howtos.rst @@ -245,7 +245,7 @@ So the final platform for our example becomes : -.. _understanding_lv08 +.. _understanding_lv08: Understanding the default TCP model *********************************** diff --git a/include/simgrid/s4u/Actor.hpp b/include/simgrid/s4u/Actor.hpp index 1aa38353ac..3b3502115e 100644 --- a/include/simgrid/s4u/Actor.hpp +++ b/include/simgrid/s4u/Actor.hpp @@ -78,7 +78,7 @@ public: /** Signal to others that an actor wakes up for a sleep **/ static xbt::signal on_wake_up; /** Signal to others that an actor is has been migrated to another host **/ - static xbt::signal on_host_change; + static xbt::signal on_host_change; #ifndef DOXYGEN static xbt::signal on_migration_start; // XBT_ATTRIB_DEPRECATED_v329 static xbt::signal on_migration_end; // XBT_ATTRIB_DEPRECATED_v329 diff --git a/src/s4u/s4u_Actor.cpp b/src/s4u/s4u_Actor.cpp index b206885dcc..858f69e54a 100644 --- a/src/s4u/s4u_Actor.cpp +++ b/src/s4u/s4u_Actor.cpp @@ -32,8 +32,10 @@ xbt::signal s4u::Actor::on_suspend; xbt::signal s4u::Actor::on_resume; xbt::signal s4u::Actor::on_sleep; xbt::signal s4u::Actor::on_wake_up; +#ifndef DOXYGEN xbt::signal s4u::Actor::on_migration_start; // XBT_ATTRIB_DEPRECATED_v329 xbt::signal s4u::Actor::on_migration_end; // XBT_ATTRIB_DEPRECATED_v329 +#endif xbt::signal s4u::Actor::on_host_change; xbt::signal s4u::Actor::on_termination; xbt::signal s4u::Actor::on_destruction; -- 2.20.1