Skip to content

Commit 3253f8f

Browse files
committed
docs: add notes about dependency versions
In general, recommend using the latest versions of Hwloc, Open PMIx, and PRRTE. Signed-off-by: Jeff Squyres <[email protected]>
1 parent f31a9be commit 3253f8f

File tree

1 file changed

+34
-4
lines changed

1 file changed

+34
-4
lines changed

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

Lines changed: 34 additions & 4 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,26 @@ system.
6272
* **Version embedded in Open MPI distribution:**
6373
|event_embedded_version|
6474

75+
.. note:: The Open MPI community has heavily tested Libevent
76+
|event_embedded_version|. Other versions should *work*,
77+
but |mdash| unlike Hwloc, Open PMIx, and PRRTE |mdash|
78+
there is not much reason to upgrade to use a later
79+
version of Libevent.
80+
6581
* `PMIx <https://pmix.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 Open PMIx 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 Open PMIx unless there is a
93+
specific reason not to.
94+
7095
* **Minimum version required when building with PRRTE:** `See the
7196
PRRTE project documentation <https://docs.prrte.org/>`_.
7297
* **Version embedded in Open MPI distribution:**
@@ -77,10 +102,15 @@ system.
77102
* This library is optional in some environments. See below.
78103
* **Minimum version required:** |prte_min_version|
79104

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.
105+
.. note:: While the minimum version of PRRTE will *work*, it may
106+
still have bugs and/or have less functionality as
107+
compared to later versions. For example, if you build
108+
and run with |prte_min_version|, you will not get a
109+
fully-populated ``mpirun(1)`` man page.
110+
111+
The Open MPI community generally recomends using the
112+
latest available version of PRRTE unless there is a
113+
specific reason not to.
84114

85115
* **Version embedded in Open MPI distribution:**
86116
|prte_embedded_version|

0 commit comments

Comments
 (0)