Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
improve the doc of how to select the right algorithm
authorMartin Quinson <martin.quinson@ens-rennes.fr>
Thu, 8 Jun 2023 09:07:12 +0000 (11:07 +0200)
committerMartin Quinson <martin.quinson@ens-rennes.fr>
Tue, 13 Jun 2023 06:53:13 +0000 (08:53 +0200)
docs/source/Configuring_SimGrid.rst

index 45a12bc..a908b1e 100644 (file)
@@ -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: