Skip to content

Commit 5cf9ea9

Browse files
committed
docs: specifically mention "Open PMIx" (vs. "PMIx")
In at least the required libraries page, specifically call out "Open PMIx" (i.e., the software library) instead of "PMIx" (i.e., the standard). Also update the URL to point to the OpenPMIx RTD docs. Signed-off-by: Jeff Squyres <[email protected]>
1 parent 9cc74ee commit 5cf9ea9

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

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

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ system.
7878
there is not much reason to upgrade to use a later
7979
version of Libevent.
8080

81-
* `PMIx <https://pmix.org/>`_
81+
* `Open PMIx <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:**
@@ -122,16 +122,16 @@ system.
122122
.. warning:: If you are building the PRRTE that is embedded in the
123123
Open MPI |ompi_ver| distribution:
124124

125-
* If you are also building the PMIx that is embedded in
125+
* If you are also building the Open PMIx that is embedded in
126126
the Open MPI |ompi_ver| distribution, that
127127
combination of packages is supported.
128128

129-
* If you are building against an external PMIx
130-
installation (i.e., a version of PMIx that is not
129+
* If you are building against an external Open PMIx
130+
installation (i.e., a version of Open PMIx that is not
131131
embedded in the Open MPI |ompi_ver| distribution),
132132
you should check `the PRRTE project documentation
133133
<https://docs.prrte.org/>`_ to see what minimum
134-
version of PMIx is required.
134+
version of Open PMIx is required.
135135

136136
* If your environment uses another MPI application launcher (e.g.,
137137
Slurm users can use the ``srun`` launcher to "direct launch" Open
@@ -177,11 +177,11 @@ These support libraries have dependencies upon each other:
177177

178178
The higher-level boxes depend on the lower-level boxes. Specifically:
179179

180-
* Open MPI depends on PRRTE, PMIx, Hwloc, and Libevent (i.e.,
180+
* Open MPI depends on PRRTE, Open PMIx, Hwloc, and Libevent (i.e.,
181181
everything).
182-
* PRRTE depends on PMIx, Hwloc, and Libevent (i.e., everything except
182+
* PRRTE depends on Open PMIx, Hwloc, and Libevent (i.e., everything except
183183
Open MPI).
184-
* PMIx depends on Hwloc and Libevent.
184+
* Open PMIx depends on Hwloc and Libevent.
185185
* Hwloc does not depend on anything.
186186
* Libevent does not depend on anything.
187187

@@ -201,7 +201,7 @@ consider if:
201201

202202
* Loading the Open MPI shared library causes the loading of Libevent
203203
shared library vA.B.C.
204-
* But then the subsequent loading of the PMIx shared library causes
204+
* But then the subsequent loading of the Open PMIx shared library causes
205205
the loading of Libevent shared library vX.Y.Z.
206206

207207
Since there are now two different versions of the Libevent shared
@@ -266,33 +266,33 @@ Build example 1
266266
#. ``configure`` will ignore the PRRTE library that is bundled in the
267267
Open MPI source tree and will use the PRRTE that is already
268268
installed in ``/usr/local``.
269-
#. ``configure`` will also ignore the bundled PMIx, Hwloc, and
269+
#. ``configure`` will also ignore the bundled Open PMIx, Hwloc, and
270270
Libevent libraries in the Open MPI source tree.
271271

272272
* If ``configure`` is unable to find header files and libraries for
273-
PMIx, Hwloc, and Libevent elsewhere on the build machine (i.e.,
274-
assumedly the same PMIx, Hwloc, and Libevent than the PRRTE in
273+
Open PMIx, Hwloc, and Libevent elsewhere on the build machine (i.e.,
274+
assumedly the same Open PMIx, Hwloc, and Libevent than the PRRTE in
275275
``/usr/local`` is using), this is an error: ``configure`` will
276276
abort, and therefore refuse to build Open MPI.
277277

278278
Build example 2
279279
^^^^^^^^^^^^^^^
280280

281281
``configure`` does *not* find PRRTE on the build machine, but *does*
282-
find PMIx development headers and libraries in ``/opt/local``. This
282+
find Open PMIx development headers and libraries in ``/opt/local``. This
283283
will cause the following to occur:
284284

285285
#. ``configure`` will set up to build the PRRTE library that is
286286
bundled in the Open MPI source tree.
287-
#. ``configure`` will ignore the PMIx library that is bundled in the
288-
Open MPI source tree and will use the PMIx that is already
287+
#. ``configure`` will ignore the Open PMIx library that is bundled in the
288+
Open MPI source tree and will use the Open PMIx that is already
289289
installed in ``/opt/local``.
290290
#. ``configure`` will also ignore the bundled Hwloc and Libevent
291291
libraries in the Open MPI source tree.
292292

293293
* If ``configure`` is unable to find header files and libraries for
294294
Hwloc and Libevent elsewhere on the build machine (i.e.,
295-
assumedly the same Hwloc and Libevent than the PMIx in
295+
assumedly the same Hwloc and Libevent than the Open PMIx in
296296
``/opt/local`` is using), this is an error: ``configure`` will
297297
abort, and therefore refuse to build Open MPI.
298298

@@ -303,7 +303,7 @@ Build example 3
303303
Libevent on the build machine. This will cause the following to
304304
occur:
305305

306-
#. ``configure`` will set up to build the PRRTE, PMIx, and Hwloc
306+
#. ``configure`` will set up to build the PRRTE, Open PMIx, and Hwloc
307307
libraries that are bundled in the Open MPI source tree.
308308
#. ``configure`` will ignore the Libevent library that is bundled in
309309
the Open MPI source tree and will use the Libevent that is already
@@ -435,10 +435,10 @@ your environment, you can use :ref:`command line options to override
435435
its default behavior
436436
<label-building-ompi-cli-options-required-support-libraries>`.
437437

438-
For example, if PMIx and/or PRRTE are installed such that the default
438+
For example, if Open PMIx and/or PRRTE are installed such that the default
439439
header file and linker search paths will not find them, you can
440440
provide command line options telling Open MPI's ``configure`` where to
441-
search. Here's an example ``configure`` invocation where PMIx and
441+
search. Here's an example ``configure`` invocation where Open PMIx and
442442
PRRTE have both been installed to ``/opt/open-mpi-stuff``:
443443

444444
.. code-block:: sh
@@ -480,7 +480,7 @@ versions of the required libraries.
480480
-----------------------------
481481

482482
If you are an Open MPI packager, we **strongly** suggest that your
483-
Open MPI package should not include Hwloc, Libevent, PMIx, or PRRTE.
483+
Open MPI package should not include Hwloc, Libevent, Open PMIx, or PRRTE.
484484
Instead, it should depend on external, independently-built versions of
485485
these packages.
486486

0 commit comments

Comments
 (0)