Skip to content

Commit

Permalink
docs: specifically mention "OpenPMIx" (vs. "PMIx")
Browse files Browse the repository at this point in the history
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]>
(cherry picked from commit 883030f)
  • Loading branch information
jsquyres committed Oct 28, 2024
1 parent 602ba23 commit ed4b3a3
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/installing-open-mpi/required-support-libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,24 +74,30 @@ system.

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

* `PMIx <https://pmix.org/>`_
* `OpenPMIx <https://docs.openpmix.org/>`_

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

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

The Open MPI community generally recomends using the
latest available version of Open PMIx unless there is a
latest available version of OpenPMIx unless there is a
specific reason not to.

.. note:: While `OpenPMIx <https://docs.openpmix.org/>`_ is the
formal name of the software that implements the `PMIx
<https://pmix.org/>`_ standard, the term "PMIx" is used
extensively throughout this documentation to refer to
the OpenPMIx software package.

* **Minimum version required when building with PRRTE:** `See the
PRRTE project documentation <https://docs.prrte.org/>`_.
* **Version embedded in Open MPI distribution:**
Expand Down

0 comments on commit ed4b3a3

Please sign in to comment.