Skip to content

Commit b22e299

Browse files
jsquyresjsquyres
committed
SQUASHME: Suggestions from Jeff Sq
Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
1 parent 724305b commit b22e299

38 files changed

+218
-224
lines changed

‎docs/app-debug/mpir-tools.rst

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,27 +13,29 @@ This specification has been replaced by the PMIx tools API that is part of the
1313
`OpenPMIx project <https://openpmix.github.io/>`_.
1414

1515
Debuggers and tools which use the legacy MPIR specification can
16-
continue functioning correctly with the *MPIR shim module* described
17-
in this section.
16+
continue functioning correctly with the `MPIR shim module
17+
<https://github.com/hpc/mpir-to-pmix-guide>`_ described in this
18+
section.
1819

1920
Obtaining Application Process Mapping Information
2021
-------------------------------------------------
2122

22-
The *MPIR shim module* is a stand-alone module which can be used by
23-
debuggers and tools that still utilize the legacy MPIR interface to
24-
attach to parallel MPI applications. The debugger or tool launches
25-
the shim module as an intermediate process between it and the
26-
application's :ref:`mpirun(1) <man1-mpirun>` command.
23+
The `MPIR shim module <https://github.com/hpc/mpir-to-pmix-guide>`_ is
24+
a stand-alone module which can be used by debuggers and tools that
25+
still utilize the legacy MPIR interface to attach to parallel MPI
26+
applications. The debugger or tool launches the shim module as an
27+
intermediate process between it and the application's :ref:`mpirun(1)
28+
<man1-mpirun>` command.
2729

2830
The MPIR shim module implements the ``MPIR_Breakpoint`` function, as a
2931
hook where debuggers and tools can set a breakpoint to read the MPIR
3032
processing mapping when it is available.
3133

3234
Instructions for use of the shim module are available at
33-
`<https://github.com/hpc/mpir-to-pmix-guide/blob/master/README.md>`_.
35+
https://github.com/hpc/mpir-to-pmix-guide/blob/master/README.md.
3436

35-
You may need to build this module before you can use it. The source code for this
36-
module can be downloaded from
37+
You may need to build this shim module before you can use it. The
38+
source code for this module can be downloaded from
3739
`MPIR to PMIx Shim repository <https://github.com/hpc/mpir-to-pmix-guide>`_.
3840

3941
Once you have the MPIR shim module built and installed, follow the

‎docs/app-debug/parallel-debug.rst

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,23 @@
11
Using Parallel Debuggers to Debug Open MPI Applications
22
=======================================================
33

4-
Open MPI supports the TotalView API for attaching to parallel processes, which
5-
several parallel debuggers support (e.g., DDT, fx2).
6-
As part of v1.2.4 (released in September 2007), Open MPI also supports
7-
the TotalView API for viewing message queues in running MPI processes.
8-
94
Debugging with TotalView
105
~~~~~~~~~~~~~~~~~~~~~~~~
116

12-
This has changed with different releases of TotalView and Open MPI; it
13-
is best to consult TotalView's documentation for how you should debug
14-
Open MPI applications with TotalView.
7+
Debugging MPI applications has changed with different releases of
8+
TotalView and Open MPI; it is best to consult TotalView's
9+
documentation for how you should debug Open MPI applications with
10+
TotalView.
11+
12+
Starting with Open MPI v5.0.0, debugging with Totalview requires the
13+
use of the MPIR shim module to attach to MPI processes. See the
14+
:ref:`using MPIR-based tools with Open MPI section
15+
<using-mpir-based-tools-label>` for instructions on building and
16+
installing the MPIR shim module.
1517

16-
As of Open MPI 5.0, debugging with Totalview requires the use of the MPIR
17-
shim module. See the
18-
:ref:`using MPIR-based tools with Open MPI section <using-mpir-based-tools-label>`
19-
for instructions on building and installing the MPIR shim module.
18+
Once TotalView is attached to Open MPI processes, it can also view
19+
Open MPI's message queues (for some transports), which can aid in
20+
debugging.
2021

2122
.. note:: The integration of Open MPI message queue support is
2223
problematic with 64-bit versions of TotalView prior to v8.3:
@@ -30,12 +31,11 @@ for instructions on building and installing the MPIR shim module.
3031
There are two workarounds:
3132

3233
* Use a 32-bit version of TotalView
33-
* Upgrade to TotalView v8.3
34+
* Upgrade to TotalView v8.3 or later
3435

3536
Debugging with DDT
3637
~~~~~~~~~~~~~~~~~~
3738

38-
This has changed with different releases of DDT and Open MPI; it is
39-
best to consult DDT's documentation for how you should debug Open MPI
40-
applications with DDT.
41-
39+
Debugging MPI application with DDT has changed with different releases
40+
of DDT and Open MPI; it is best to consult DDT's documentation for how
41+
you should debug Open MPI applications with DDT.

‎docs/building-apps/index.rst

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,13 @@ Open MPI "wrapper" compilers.
1313
removed-mpi-constructs
1414
deprecation-warnings
1515
building-static-apps
16-
building-multithreaded-apps
17-
building-heterogeneous-apps
18-
dynamic-loading
19-
fork-system-popen
2016

21-
.. warning:: Open MPI does not attempt to interface to other MPI
22-
implementations, nor executables that were compiled for them.
23-
MPI applications need to be compiled and linked with Open MPI in order to
24-
run under Open MPI.
17+
.. warning:: Open MPI does not attempt to interoperate with other MPI
18+
implementations, nor executables that were compiled for
19+
them. MPI applications need to be compiled and linked
20+
with Open MPI in order to run under Open MPI.
2521

26-
See the :doc:`section on Open MPI's version numbering scheme </version-numbering>`
27-
for information about binary compatibility between different versions of
28-
Open MPI for applications compiled with another version.
22+
See the :doc:`section on Open MPI's version numbering
23+
scheme </version-numbering>` for information about binary
24+
compatibility between different versions of Open MPI for
25+
applications compiled with another version.

‎docs/installing-open-mpi/compilers-and-flags.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,4 +150,3 @@ runtime libraries with Open MPI:
150150
.. code-block::
151151
152152
shell$ ./configure CC=icc CXX=icpc FC=ifort LDFLAGS=-Wc,-static-intel ...
153-

‎docs/tuning-apps/custom-components.rst renamed to ‎docs/installing-open-mpi/custom-components.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _tuning-custom-components:
1+
.. _installing-custom-components-label:
22

33
Installing custom components
44
============================
@@ -31,4 +31,3 @@ run MPI jobs, then you need to ensure that it is visible on all nodes
3131
filesystem installs, or by installing them in a directory that is
3232
visible to all nodes via a networked filesystem). Open MPI does not
3333
automatically send components to remote nodes when MPI jobs are run.
34-

‎docs/installing-open-mpi/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Building and installing Open MPI
1717
configure-output-summary
1818
make-targets
1919
installation-location
20+
custom-components
2021
updating
2122
packagers
2223
sysadmins

‎docs/installing-open-mpi/installation-location.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ nodes without using a password, etc.).
1616
Regardless of whether Open MPI is installed on a shared / networked
1717
filesystem or independently on each node, it is usually easiest if
1818
Open MPI is available in the same filesystem path on every node.
19-
For example, if you install Open MPI to ``/opt/openmpi-$ver_current`` on
20-
one node, ensure that it is available in ``/opt/openmpi-$ver_current``
19+
For example, if you install Open MPI to ``/opt/openmpi-|ompi_ver|`` on
20+
one node, ensure that it is available in ``/opt/openmpi-|ompi_ver|``
2121
on *all* nodes.
2222

2323
.. important:: For simplicity, the Open MPI team *strongly* recommends
@@ -313,5 +313,3 @@ error) in some cases, and definitely does not work in other cases.
313313
There's unfortunately little that we can do about this |mdash| it's a
314314
compiler compatibility issue, and one that compiler authors have
315315
little incentive to resolve.
316-
317-

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,8 +234,9 @@ on Mac OS because:
234234
tarballs).
235235
#. In MacOS, it is common for `Homebrew <https://brew.sh/>`_ or
236236
`MacPorts <https://www.macports.org/>`_ to install:
237-
* hwloc and/or Libevent
238-
* gcc and gfortran
237+
238+
* `Hardware Locality <https://www.open-mpi.org/projects/hwloc/>`_
239+
* `Libevent <https://libevent.org/>`_
239240

240241
For example, as of July 2019, Homebrew:
241242

‎docs/installing-open-mpi/supported-systems.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,3 @@ resources.
6565

6666
That being said, :doc:`contributions are always welcome!
6767
</contributing>`.
68-

‎docs/installing-open-mpi/sysadmins.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,9 @@ Open MPI installation, Open MPI will
131131
simply open the new plugin at run-time |mdash| your applications do not need
132132
to be recompiled or re-linked.
133133

134+
:ref:`See this section <installing-custom-components-label>` for more
135+
details.
136+
134137
Upgrading network hardware with a global Open MPI installation
135138
--------------------------------------------------------------
136139

@@ -166,4 +169,3 @@ per-user basis in two important ways:
166169
experiment with new components without destabilizing Open MPI for the rest
167170
of the users on the system. Or power users can download 3rd party components
168171
(perhaps even research-quality components) without affecting other users.
169-

0 commit comments

Comments
 (0)