From 3bb518ecf562e755957fff1ba9f57fe2277072f7 Mon Sep 17 00:00:00 2001 From: Martin Quinson Date: Thu, 8 Jun 2023 11:07:12 +0200 Subject: [PATCH] improve the doc of how to select the right algorithm --- docs/source/Configuring_SimGrid.rst | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/docs/source/Configuring_SimGrid.rst b/docs/source/Configuring_SimGrid.rst index 45a12bce01..a908b1e018 100644 --- a/docs/source/Configuring_SimGrid.rst +++ b/docs/source/Configuring_SimGrid.rst @@ -1329,12 +1329,9 @@ existing MPI libraries. The ``smpi/coll-selector`` item can be used to select the decision logic either of the OpenMPI or the MPICH libraries. (By default SMPI uses naive version of collective operations.) -Each collective operation can be manually selected with a -``smpi/collective_name:algo_name``. Available algorithms are listed in -:ref:`SMPI_use_colls`. - -.. TODO:: All available collective algorithms will be made available - via the ``smpirun --help-coll`` command. +Each collective operation can be manually selected with a ``smpi/collective_name:algo_name``. For example, if you want to use +the Bruck algorithm for the Alltoall algorithm, you should use ``--cfg=smpi/alltoall:bruck`` on the command-line of smpirun. The +reference of all available algorithms are listed in :ref:`SMPI_use_colls`. .. _cfg=smpi/barrier-collectives: -- 2.20.1