Skip to content

Commit d14af58

Browse files
authored
Merge pull request #12836 from jsquyres/pr/docs/dependency-versions
docs: add notes about dependency versions
2 parents f31a9be + 883030f commit d14af58

File tree

1 file changed

+41
-5
lines changed

1 file changed

+41
-5
lines changed

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

Lines changed: 41 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ system.
2323

2424
* This library is required; Open MPI will not build without it.
2525
* **Minimum version required:** |hwloc_min_version|
26+
27+
.. note:: While the minimum version of Hwloc will *work*, it may
28+
still have bugs and/or have less functionality as
29+
compared to later versions.
30+
31+
Other than the Hwloc restriction about v3.0.0 and beyond
32+
(see below), the Open MPI community generally recomends
33+
using the latest available version of Hwloc unless there
34+
is a specific reason not to.
35+
2636
* **Version embedded in Open MPI distribution:**
2737
|hwloc_embedded_version|
2838

@@ -62,11 +72,32 @@ system.
6272
* **Version embedded in Open MPI distribution:**
6373
|event_embedded_version|
6474

65-
* `PMIx <https://pmix.org/>`_
75+
.. note:: The Open MPI community has heavily tested Libevent
76+
|event_embedded_version|. Other versions should *work*,
77+
but |mdash| unlike Hwloc, OpenPMIx, and PRRTE |mdash|
78+
there is not much reason to upgrade to use a later
79+
version of Libevent.
80+
81+
* `OpenPMIx <https://docs.openpmix.org/>`_
6682

6783
* This library is required; Open MPI will not build without it.
6884
* **Minimum version required when building without PRRTE:**
6985
|pmix_min_version|
86+
87+
.. note:: While the minimum version of OpenPMIx will *work*, it
88+
may still have bugs and/or have less functionality as
89+
compared to later versions.
90+
91+
The Open MPI community generally recomends using the
92+
latest available version of OpenPMIx unless there is a
93+
specific reason not to.
94+
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+
70101
* **Minimum version required when building with PRRTE:** `See the
71102
PRRTE project documentation <https://docs.prrte.org/>`_.
72103
* **Version embedded in Open MPI distribution:**
@@ -77,10 +108,15 @@ system.
77108
* This library is optional in some environments. See below.
78109
* **Minimum version required:** |prte_min_version|
79110

80-
.. note:: While building Open MPI with PRRTE |prte_min_version|
81-
*works*, you will not get a fully-populated
82-
``mpirun(1)`` man page. The Open MPI community
83-
recommends that you use PRRTE version 3.0.1 or higher.
111+
.. note:: While the minimum version of PRRTE will *work*, it may
112+
still have bugs and/or have less functionality as
113+
compared to later versions. For example, if you build
114+
and run with |prte_min_version|, you will not get a
115+
fully-populated ``mpirun(1)`` man page.
116+
117+
The Open MPI community generally recomends using the
118+
latest available version of PRRTE unless there is a
119+
specific reason not to.
84120

85121
* **Version embedded in Open MPI distribution:**
86122
|prte_embedded_version|

0 commit comments

Comments
 (0)