Skip to content

Commit d273822

Browse files
committed
docs: minor tweaks
Update a little phraseology about "required support libraries". Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
1 parent d0c8ca9 commit d273822

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

docs/installing-open-mpi/configure-cli-options/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ below.
1515
installation
1616
networking
1717
runtime
18-
support-libraries
18+
required-support-libraries
1919
mpi
2020
oshmem
2121
misc

docs/installing-open-mpi/configure-cli-options/support-libraries.rst renamed to docs/installing-open-mpi/configure-cli-options/required-support-libraries.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
.. _label-building-ompi-cli-options-support-libraries:
1+
.. _label-building-ompi-cli-options-required-support-libraries:
22

3-
Support libraries
4-
^^^^^^^^^^^^^^^^^
3+
CLI Options for required support libraries
4+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
55

6-
:ref:`See this section <label-install-required-support-libraries>` for
7-
information about the CLI options for the support libraries described
8-
in this section.
9-
10-
The following are command line options for the support libraries that
11-
are used by Open MPI that can be used with ``configure``:
6+
The following ``configure`` command line options are for Open MPI's
7+
:ref:`required support libraries
8+
<label-install-required-support-libraries>`
129

1310
* ``--with-hwloc[=VALUE]``:
1411
* ``--with-libevent[=VALUE]``:
1512
* ``--with-pmix[=VALUE]``:
1613
* ``--with-prrte[=VALUE]``: These four options specify where to find
17-
the headers and libraries for the Hwloc, Libevent, PMIx, and PRRTE
18-
libraries, respectively. The following ``VALUE``\s are permitted:
14+
the headers and libraries for the `Hwloc
15+
<https://www.open-mpi.org/projects/hwloc/>`_, `Libevent
16+
<https://libevent.org/>`_, `PMIx <https://openpmix.github.io/>`_,
17+
and `PRRTE <https://github.com/openpmix/prrte>`_ libraries,
18+
respectively. The following ``VALUE``\s are permitted:
1919

2020
* ``external``: Use an external installation (rely on default
2121
compiler and linker paths to find it). ``configure`` will abort

docs/installing-open-mpi/packagers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ ensure that your package is correctly relying on the
3232
independently-built and installed versions.
3333

3434
:ref:`See this section
35-
<label-building-ompi-cli-options-support-libraries>` for more
35+
<label-building-ompi-cli-options-required-support-libraries>` for more
3636
information about the required support library ``--with-FOO`` command
3737
line options.
3838

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Open MPI requires the following support libraries with the minimum listed versio
3737
| support.
3838
* | Open MPI can use the copy of PRRTE embedded in its source code
3939
| tree, or compile/link against an external PRRTE installation.
40-
| :ref:`See this section for details about how to specify each method <label-building-ompi-cli-options-support-libraries>`.
40+
| :ref:`See this section for details about how to specify each method <label-building-ompi-cli-options-required-support-libraries>`.
4141
4242
Since these support libraries are fundamental to Open MPI's operation
4343
and not universally available in all environments, they are directly
@@ -198,7 +198,7 @@ Overriding ``configure`` behavior
198198
If ``configure``'s default searching behavior is not sufficient for
199199
your environment, you can use :ref:`command line options to override
200200
its default behavior
201-
<label-building-ompi-cli-options-support-libraries>`.
201+
<label-building-ompi-cli-options-required-support-libraries>`.
202202

203203
For example, if PMIx and/or PRRTE are installed such that the default
204204
header file and linker search paths will not find them, you can

0 commit comments

Comments
 (0)