Skip to content

Commit

Permalink
Fix documentation of the mca_base_component_show_load_errors MCA vari…
Browse files Browse the repository at this point in the history
…able

See #11877 (comment)
for context.

Signed-off-by: Jakub Klinkovský <j.l.k@gmx.com>
  • Loading branch information
lahwaacz committed Feb 23, 2024
1 parent cb00772 commit fc1c7ab
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
17 changes: 10 additions & 7 deletions docs/installing-open-mpi/configure-cli-options/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -289,15 +289,13 @@ be used with ``configure``:
you do not have support for Libfabric and will
automatically skip the ``ofi`` CM component.

* ``--disable-show-load-errors-by-default``:
* ``--with-show-load-errors=VALUE``:
Set the default value of the ``mca_base_component_show_load_errors``
MCA variable: the ``--enable`` form of this option sets the MCA
variable to true, the ``--disable`` form sets the MCA variable to
false. The MCA ``mca_base_component_show_load_errors`` variable can
still be overridden at run time via the usual MCA-variable-setting
MCA variable. The MCA ``mca_base_component_show_load_errors`` variable
can still be overridden at run time via the usual MCA-variable-setting
mechanisms; this configure option simply sets the default value.

The ``--disable`` form of this option is intended for Open MPI
The ``no``/``none`` value of this option is intended for Open MPI
packagers who tend to enable support for many different types of
networks and systems in their packages. For example, consider a
packager who includes support for both the FOO and BAR networks in
Expand All @@ -309,14 +307,19 @@ be used with ``configure``:
the FOO components failing to load because ``libFOO.so`` is not
available on their systems.

Conversely, system administrators tend to build an Open MPI that is
Conversely, the ``yes``/``all`` value of this option is intended for
system administrators who tend to build an Open MPI that is
targeted at their specific environment, and contains few (if any)
components that are not needed. In such cases, they might want
their users to be warned that the FOO network components failed to
load (e.g., if ``libFOO.so`` was mistakenly unavailable), because Open
MPI may otherwise silently failover to a slower network path for MPI
traffic.

.. note:: See the section on :ref:`common MCA parameters
<label-mca-common-parameters>` for details related to the
``mca_base_component_show_load_errors`` MCA variable.

* ``--with-platform=FILE``:
Load configure options for the build from ``FILE``. Options on the
command line that are not in ``FILE`` are also used. Options on the
Expand Down
4 changes: 3 additions & 1 deletion docs/mca.rst
Original file line number Diff line number Diff line change
Expand Up @@ -521,6 +521,8 @@ clearly contradict each other.

/////////////////////////////////////////////////////////////////////////

.. _label-mca-common-parameters:

Common MCA parameters
---------------------

Expand Down Expand Up @@ -593,7 +595,7 @@ presented here so that they can easily be found via internet searches:
.. important:: You can only use the "include" *or* the "exclude"
parameter |mdash| they are mutually exclusive from each
other.
* ``opal_mca_base_component_show_load_errors``: By default, Open MPI
* ``mca_base_component_show_load_errors``: By default, Open MPI
emits a warning message if it fails to open a DSO component at run
time. This typically happens when a shared library that the DSO
requires is not available.
Expand Down

0 comments on commit fc1c7ab

Please # to comment.