From 6949ee0de587d02bb6fad672d8df825dc3d0e61e Mon Sep 17 00:00:00 2001 From: Arnaud Giersch Date: Fri, 25 Jun 2021 10:03:59 +0200 Subject: [PATCH] Minor fixes in doc. --- docs/source/Configuring_SimGrid.rst | 17 ++++++++++++----- docs/source/Platform_cpp.rst | 2 +- docs/source/app_smpi.rst | 4 ++-- src/msg/msg_task.cpp | 2 +- 4 files changed, 16 insertions(+), 9 deletions(-) diff --git a/docs/source/Configuring_SimGrid.rst b/docs/source/Configuring_SimGrid.rst index 26a3fccbfd..7b895d4478 100644 --- a/docs/source/Configuring_SimGrid.rst +++ b/docs/source/Configuring_SimGrid.rst @@ -942,7 +942,7 @@ which value is either: Configuring the Tracing ----------------------- -The :ref:`tracing subsystem ` can be configured in +The :ref:`tracing subsystem ` can be configured in 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 @@ -1323,11 +1323,11 @@ Each collective operation can be manually selected with a .. TODO:: All available collective algorithms will be made available via the ``smpirun --help-coll`` command. +.. _cfg=smpi/finalization-barrier: + Add a barrier in MPI_Finalize ............................. -.. _cfg=smpi/finalization-barrier: - **Option** ``smpi/finalization-barrier`` **default:** off By default, SMPI processes are destroyed as soon as soon as their code ends, @@ -1341,6 +1341,9 @@ It might affect the total timing by the cost of a barrier. .. _cfg=smpi/errors-are-fatal: +Render MPI errors non-fatal +........................... + **Option** ``smpi/errors-are-fatal`` **default:** on By default, SMPI processes will crash if a MPI error code is returned. MPI allows @@ -1350,14 +1353,18 @@ This can ease debugging by going after the first reported error. .. _cfg=smpi/pedantic: +Disable pedantic MPI errors +........................... + **Option** ``smpi/pedantic`` **default:** on By default, SMPI will report all errors it finds in MPI codes. Some of these errors may not be considered as errors by all developers. This flag can be turned off to avoid reporting some usually harmless mistakes. Concerned errors list (will be expanded in the future): - - Calling MPI_Win_fence only once in a program, hence just opening an epoch without - ever closing it. + + - Calling MPI_Win_fence only once in a program, hence just opening an epoch without + ever closing it. .. _cfg=smpi/iprobe: diff --git a/docs/source/Platform_cpp.rst b/docs/source/Platform_cpp.rst index 965b344800..cbbd33bbf3 100644 --- a/docs/source/Platform_cpp.rst +++ b/docs/source/Platform_cpp.rst @@ -111,7 +111,7 @@ connected through a shared link. .. _platform_cpp_beyond: Beyond the XML: the power of C++ platforms -************** +****************************************** This section describes one of the advantages of using C++ code to write your platforms. diff --git a/docs/source/app_smpi.rst b/docs/source/app_smpi.rst index b6febf7c3e..513bfa1be7 100644 --- a/docs/source/app_smpi.rst +++ b/docs/source/app_smpi.rst @@ -129,8 +129,8 @@ Some shortcuts are available: - ``-gdb`` is equivalent to ``-wrapper "gdb --args" -keep-temps``, to run within gdb debugger - ``-lldb`` is equivalent to ``-wrapper "lldb --" -keep-temps``, to run within lldb debugger -- ``-vgdb`` is equivalent to ``-wrapper "valgrind --vgdb=yes --vgdb-error=0" --keep-temps``, to run within valgrind and allow to attach a debugger +- ``-vgdb`` is equivalent to ``-wrapper "valgrind --vgdb=yes --vgdb-error=0" -keep-temps``, + to run within valgrind and allow to attach a debugger To help locate bottlenecks and largest allocations in the simulated application, the -analyze flag can be passed to smpirun. It will activate diff --git a/src/msg/msg_task.cpp b/src/msg/msg_task.cpp index 7cd74c2ea7..1718beb7bf 100644 --- a/src/msg/msg_task.cpp +++ b/src/msg/msg_task.cpp @@ -778,7 +778,7 @@ void MSG_task_set_bound(msg_task_t task, double bound) * (or with #TRACE_category_with_color). * * @beginrst - * See :ref:`outcomes_vizu` for details on how to trace the (categorized) resource utilization. + * See :ref:`outcome_vizu` for details on how to trace the (categorized) resource utilization. * @endrst * * @param task the task that is going to be categorized -- 2.20.1