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)
open-mpi · Dec 2, 2024 · 3828aff · 3828aff
1 parent 7f039ad
commit 3828aff
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/docs/man-openmpi/man1/mpirun.1.rst b/docs/man-openmpi/man1/mpirun.1.rst
@@ -422,7 +422,22 @@ Setting MCA parameters:
 
 * ``--mca <key> <value>``: Send arguments to various MCA modules.  See
   the :ref:`Setting MCA Parameters
-  <man1-mpirun-setting-mca-parameters>` section for mode details.
+  <man1-mpirun-setting-mca-parameters>` section for more details.
+
+  .. note:: Open MPI will attempt to discern PMIx and PRRTE MCA
+            parameters passed via ``--mca`` and handle them
+            appropriately, but it may not always guess correctly.  It
+            is best to use ``--pmixmca`` and ``--prtemca`` when
+            passing MCA parammeters to PMIx and PRRTE, respectively.
+
+* ``--pmixmca <key> <value>``: Send arguments to MCA modules in the
+  PMIx subsystem.  See the :ref:`Setting MCA Parameters
+  <man1-mpirun-setting-mca-parameters>` section for more details.
+
+* ``--prtemca <key> <value>``: Send arguments to MCA modules in the
+  PMIx Reference Runtime Environment (PRRTE) subsystem.  See the
+  :ref:`Setting MCA Parameters <man1-mpirun-setting-mca-parameters>`
+  section for more details.
 
 * ``--tune <tune_file>``: Specify a tune file to set arguments for
   various MCA modules and environment variables.  See the :ref:`