Skip to content

Commit be2a6e5

Browse files
committed
doc: Add links to disable-io-romio option
Added links to other documents explaining ROMIO Signed-off-by: William Zhang <wilzhang@amazon.com>
1 parent 3889b48 commit be2a6e5

File tree

3 files changed

+15
-1
lines changed

3 files changed

+15
-1
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,9 @@ MPI API behaviors that can be used with ``configure``:
7575
component
7676

7777
* ``--disable-io-romio``:
78-
Disable the ROMIO MPI-IO component
78+
Disable the :ref:`ROMIO MPI-IO <label-romio-reference>` component
79+
from being compiled.This is an outdated mechanism and functions
80+
similarly to ``--enable-mca-no-build`` for the romio341 component.
7981

8082
* ``--with-io-romio-flags=FLAGS``:
8183
Pass ``FLAGS`` to the ROMIO distribution configuration script. This

docs/mca.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ The following *projects* exist in Open MPI |ompi_ver|:
6868
See :ref:`the role of PMIx and PRRTE
6969
<label-running-role-of-pmix-and-prte>` for more information.
7070

71+
.. _label-mca-frameworks:
72+
7173
Frameworks
7274
^^^^^^^^^^
7375

@@ -94,6 +96,8 @@ between different versions of Open MPI. You can use the
9496
:ref:`ompi_info(1) <man1-ompi_info>` command to see the full list of
9597
frameworks that are included in Open MPI |ompi_ver|.
9698

99+
.. _label-mca-components:
100+
97101
Components
98102
^^^^^^^^^^
99103

@@ -111,6 +115,8 @@ not all of them may be present or available on your system. You can
111115
use the :ref:`ompi_info(1) <man1-ompi_info>` command to see what
112116
components are included in Open MPI |ompi_ver| on your system.
113117

118+
.. _label-mca-modules:
119+
114120
Modules
115121
^^^^^^^
116122

docs/tuning-apps/mpi-io/romio.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
1+
.. _label-romio-reference:
2+
13
ROMIO
24
=====
35

46
ROMIO is an implementation of the MPI I/O functions defined in version
57
two of the Message Passing Interface specification. It has been
68
ported over to Open MPI from `MPICH <https://mpich.org/>`_.
9+
10+
It is utilized through the ``romio341`` :ref:`component
11+
<label-mca-components>` as an implementation of
12+
the ``io`` :ref:`framework <label-mca-frameworks>`

0 commit comments

Comments
 (0)