Skip to content

Commit 3828aff

Browse files
committed
mpirun.1.rst: Describe --pmixmca and --prtemca
Describe these options and recomend that users use them when passing PMIx and PRRTE MCA parameters, respectively. Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit 05f6205)
1 parent 7f039ad commit 3828aff

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/man-openmpi/man1/mpirun.1.rst

+16-1
Original file line numberDiff line numberDiff line change
@@ -422,7 +422,22 @@ Setting MCA parameters:
422422

423423
* ``--mca <key> <value>``: Send arguments to various MCA modules. See
424424
the :ref:`Setting MCA Parameters
425-
<man1-mpirun-setting-mca-parameters>` section for mode details.
425+
<man1-mpirun-setting-mca-parameters>` section for more details.
426+
427+
.. note:: Open MPI will attempt to discern PMIx and PRRTE MCA
428+
parameters passed via ``--mca`` and handle them
429+
appropriately, but it may not always guess correctly. It
430+
is best to use ``--pmixmca`` and ``--prtemca`` when
431+
passing MCA parammeters to PMIx and PRRTE, respectively.
432+
433+
* ``--pmixmca <key> <value>``: Send arguments to MCA modules in the
434+
PMIx subsystem. See the :ref:`Setting MCA Parameters
435+
<man1-mpirun-setting-mca-parameters>` section for more details.
436+
437+
* ``--prtemca <key> <value>``: Send arguments to MCA modules in the
438+
PMIx Reference Runtime Environment (PRRTE) subsystem. See the
439+
:ref:`Setting MCA Parameters <man1-mpirun-setting-mca-parameters>`
440+
section for more details.
426441

427442
* ``--tune <tune_file>``: Specify a tune file to set arguments for
428443
various MCA modules and environment variables. See the :ref:`

0 commit comments

Comments
 (0)