Skip to content

Commit 883030f

Browse files
committed
docs: specifically mention "OpenPMIx" (vs. "PMIx")
Also update the URL to point to the OpenPMIx RTD docs, and add a clarification that we used the term "PMIx" heavily throughout the rest of the docs to refer to "OpenPMIx". Signed-off-by: Jeff Squyres <[email protected]>
1 parent 3253f8f commit 883030f

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/installing-open-mpi/required-support-libraries.rst

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,24 +74,30 @@ system.
7474

7575
.. note:: The Open MPI community has heavily tested Libevent
7676
|event_embedded_version|. Other versions should *work*,
77-
but |mdash| unlike Hwloc, Open PMIx, and PRRTE |mdash|
77+
but |mdash| unlike Hwloc, OpenPMIx, and PRRTE |mdash|
7878
there is not much reason to upgrade to use a later
7979
version of Libevent.
8080

81-
* `PMIx <https://pmix.org/>`_
81+
* `OpenPMIx <https://docs.openpmix.org/>`_
8282

8383
* This library is required; Open MPI will not build without it.
8484
* **Minimum version required when building without PRRTE:**
8585
|pmix_min_version|
8686

87-
.. note:: While the minimum version of Open PMIx will *work*, it
87+
.. note:: While the minimum version of OpenPMIx will *work*, it
8888
may still have bugs and/or have less functionality as
8989
compared to later versions.
9090

9191
The Open MPI community generally recomends using the
92-
latest available version of Open PMIx unless there is a
92+
latest available version of OpenPMIx unless there is a
9393
specific reason not to.
9494

95+
.. note:: While `OpenPMIx <https://docs.openpmix.org/>`_ is the
96+
formal name of the software that implements the `PMIx
97+
<https://pmix.org/>`_ standard, the term "PMIx" is used
98+
extensively throughout this documentation to refer to
99+
the OpenPMIx software package.
100+
95101
* **Minimum version required when building with PRRTE:** `See the
96102
PRRTE project documentation <https://docs.prrte.org/>`_.
97103
* **Version embedded in Open MPI distribution:**

0 commit comments

Comments
 (0)