Skip to content

More docs updates #10762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
481 changes: 3 additions & 478 deletions docs/faq/general-tuning.rst

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion docs/faq/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,4 @@ that they are worth categorizing in an official way.
ompio
macos

tuning
general-tuning
2 changes: 1 addition & 1 deletion docs/faq/large-clusters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ as soon as possible.

This parameter can be included in the default MCA parameter file,
placed in the user's environment, or added to the ``mpirun`` command
line. See :ref:`this FAQ entry <faq-tuning-setting-mca-params-label>`
line. See :ref:`this FAQ entry <label-running-setting-mca-param-values>`
for more details on how to set MCA parameters.

/////////////////////////////////////////////////////////////////////////
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/ompio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,7 @@ perspective.
value). The value of ``io_ompio_bytes_per_agg`` could be
set by system administrators in the system-wide Open MPI
configuration file, or by users individually. See :ref:`this
FAQ item <faq-tuning-setting-mca-params-label>` on setting
FAQ item <label-running-setting-mca-param-values>` on setting
MCA parameters for details.

For more exhaustive tuning of I/O parameters, we recommend the
Expand Down
6 changes: 3 additions & 3 deletions docs/faq/running-mpi-apps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -743,8 +743,8 @@ Several notable options are:
:ref:`this FAQ entry for more details
<faq-running-mpi-apps-mpirun-host-label>`).
* ``-n``: Indicate the number of processes to start.
* ``--mca``: Set MCA parameters (see the :doc:`Run-Time Tuning FAQ
category </faq/tuning/>` for more details).
* ``--mca``: Set MCA parameters (see :ref:`how to set MCA params
<label-running-setting-mca-param-values>` for more details).
* ``--wdir DIRECTORY``: Set the working directory of the started
applications. If not supplied, the current working directory is
assumed (or ``$HOME``, if the current working directory does not
Expand Down Expand Up @@ -1320,7 +1320,7 @@ Yes.
The MCA parameter ``mpi_yield_when_idle`` controls whether an MPI
process runs in Aggressive or Degraded performance mode. Setting it
to 0 forces Aggressive mode; setting it to 1 forces Degraded mode (see
:ref:`this FAQ entry <faq-tuning-setting-mca-params-label>` to see how
:ref:`this FAQ entry <label-running-setting-mca-param-values>` to see how
to set MCA parameters).

Note that this value *only* affects the behavior of MPI processes when
Expand Down
10 changes: 7 additions & 3 deletions docs/faq/sysadmin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ network at a system level, such that when users invoke ``mpirun`` or
``mpiexec`` to launch their jobs, they will automatically only be using
the network meant for MPI jobs.

:doc:`See the run-time tuning FAQ category </faq/tuning>` for information on how to set global MCA parameters.
:ref:`See how to set MCA params
<label-running-setting-mca-param-values>` for information on how to
set global MCA parameters.

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

Expand Down Expand Up @@ -161,8 +163,10 @@ I have power users who will want to override my global MCA parameters; is this p

Absolutely.

:doc:`See the run-time tuning FAQ category </faq/tuning>` for information how to set MCA parameters, both at the
system level and on a per-user (or per-MPI-job) basis.
:ref:`See how to set MCA params
<label-running-setting-mca-param-values>` for information how to set
MCA parameters, both at the system level and on a per-user (or
per-MPI-job) basis.

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

Expand Down
13 changes: 0 additions & 13 deletions docs/faq/tuning.rst

This file was deleted.

38 changes: 19 additions & 19 deletions docs/man-openmpi/man1/ompi_info.1.rst
Original file line number Diff line number Diff line change
Expand Up @@ -163,65 +163,65 @@ more MCA parameters, use the ``--level`` command line option.
EXAMPLES
--------

Show the default output of options and listing of installed
components in a human-readable / prettyprint format:

.. code-block::

ompi_info

Show the default output of options and listing of installed
components in a human-readable / prettyprint format.
Show the default output of options and listing of installed components
in a machine-parsable format:

.. code-block::

ompi_info --parsable

Show the default output of options and listing of installed components
in a machine-parsable format.
Show the level 1 MCA parameters of the "tcp" BTL component in a
human-readable / prettyprint format:

.. code-block::

ompi_info --param btl tcp

Show the level 1 MCA parameters of the "tcp" BTL component in a
human-readable / prettyprint format.
Show the level 1 through level 6 MCA parameters of the "tcp" BTL
component in a human-readable / prettyprint format:

.. code-block::

ompi_info --param btl tcp --level 6

Show the level 1 through level 6 MCA parameters of the "tcp" BTL
component in a human-readable / prettyprint format.
Show the level 1 MCA parameters of the "tcp" BTL component in a
machine-parsable format:

.. code-block::

ompi_info --param btl tcp --parsable

Show the level 1 MCA parameters of the "tcp" BTL component in a
machine-parsable format.
Show the level 1 through level 3 MCA parameters of string type in a
human-readable / prettyprint format:

.. code-block::

ompi_info --type string --pretty-print --level 3

Show the level 3 MCA parameters of string type in a human-readable /
prettyprint format.
Show the "bindir" that Open MPI was configured with:

.. code-block::

ompi_info --path bindir

Show the "bindir" that Open MPI was configured with.
Show the version of Open MPI version numbers in a prettyprint format:

.. code-block::

ompi_info --version

Show the version of Open MPI version numbers in a prettyprint format.
Show *all* information about the Open MPI installation, including all
components that can be found, all the MCA parameters that they support
(i.e., levels 1 through 9), versions of Open MPI and the components,
etc.:

.. code-block::

ompi_info --all

Show *all* information about the Open MPI installation, including all
components that can be found, all the MCA parameters that they support
(i.e., levels 1 through 9), versions of Open MPI and the components,
etc.
1 change: 1 addition & 0 deletions docs/running-apps/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ but they can generally be broken down into two categories:

quickstart
pmix-and-prrte
tuning

localhost
ssh
Expand Down
2 changes: 2 additions & 0 deletions docs/running-apps/pmix-and-prrte.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _label-running-role-of-pmix-and-prte:

The role of PMIx and PRRTE
==========================

Expand Down
Loading