From 97b493885bbd94a55b17341d9bc92254866655c6 Mon Sep 17 00:00:00 2001 From: William Zhang Date: Fri, 3 Mar 2023 13:55:44 -0800 Subject: [PATCH] doc: Add links to disable-io-romio option Added links to other documents explaining ROMIO and describe it being a deprecated option similar to --enable-mca-no-build Signed-off-by: William Zhang --- docs/installing-open-mpi/configure-cli-options/mpi.rst | 5 ++++- docs/mca.rst | 6 ++++++ docs/tuning-apps/mpi-io/romio.rst | 6 ++++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/installing-open-mpi/configure-cli-options/mpi.rst b/docs/installing-open-mpi/configure-cli-options/mpi.rst index 0aa082f3e89..150b0f80949 100644 --- a/docs/installing-open-mpi/configure-cli-options/mpi.rst +++ b/docs/installing-open-mpi/configure-cli-options/mpi.rst @@ -75,7 +75,10 @@ MPI API behaviors that can be used with ``configure``: component * ``--disable-io-romio``: - Disable the ROMIO MPI-IO component + Disable the :ref:`ROMIO MPI-IO ` component + from being compiled. This is a deprecated mechanism; it is effectively + the same as adding ``io-romio341`` to the list of items passed to + ``--enable-mca-no-build``. * ``--with-io-romio-flags=FLAGS``: Pass ``FLAGS`` to the ROMIO distribution configuration script. This diff --git a/docs/mca.rst b/docs/mca.rst index cac08953940..f92b2da12c0 100644 --- a/docs/mca.rst +++ b/docs/mca.rst @@ -68,6 +68,8 @@ The following *projects* exist in Open MPI |ompi_ver|: See :ref:`the role of PMIx and PRRTE ` for more information. +.. _label-mca-frameworks: + Frameworks ^^^^^^^^^^ @@ -94,6 +96,8 @@ between different versions of Open MPI. You can use the :ref:`ompi_info(1) ` command to see the full list of frameworks that are included in Open MPI |ompi_ver|. +.. _label-mca-components: + Components ^^^^^^^^^^ @@ -111,6 +115,8 @@ not all of them may be present or available on your system. You can use the :ref:`ompi_info(1) ` command to see what components are included in Open MPI |ompi_ver| on your system. +.. _label-mca-modules: + Modules ^^^^^^^ diff --git a/docs/tuning-apps/mpi-io/romio.rst b/docs/tuning-apps/mpi-io/romio.rst index bc329e4fb0e..601633abfbb 100644 --- a/docs/tuning-apps/mpi-io/romio.rst +++ b/docs/tuning-apps/mpi-io/romio.rst @@ -1,6 +1,12 @@ +.. _label-romio-reference: + ROMIO ===== ROMIO is an implementation of the MPI I/O functions defined in version two of the Message Passing Interface specification. It has been ported over to Open MPI from `MPICH `_. + +It is utilized through the ``romio341`` :ref:`component +` as an implementation of +the ``io`` :ref:`framework `