Skip to content

Commit

Permalink
docs: update a bunch of old/stale web links
Browse files Browse the repository at this point in the history
"make linkcheck" showed a bunch of stale links; fix most of them.

Also fix one RST minor error in the ULFM doc.

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
  • Loading branch information
jsquyres committed Mar 15, 2022
1 parent 5ae147d commit c0857ad
Show file tree
Hide file tree
Showing 11 changed files with 26 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/faq/debugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -538,7 +538,7 @@ There are two cases:
<https://valgrind.org/docs/valgrind2007.pdf>`_.
For an evaluation of various internal implementation alternatives of Shadow Memory, please see
`Building Workload Characterization Tools with Valgrind
<https://www.valgrind.org/njn/pubs/shadow-memory2007-talk.ppt>`_.
<https://valgrind.org/docs/iiswc2006.pdf>`_.


Further information and performance data with the NAS Parallel
Expand Down
14 changes: 5 additions & 9 deletions docs/faq/fault-tolerance.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
Fault Tolerance
===============

.. TODO Hello world
/////////////////////////////////////////////////////////////////////////

What is "fault tolerance"?
--------------------------

The phrase "fault tolerance" means many things to many
people. Typical definitions range from user processes dumping vital
state to disk periodically to checkpoint/restart of running processes
to elaborate recreate-process-state-from-incremental-pieces schemes to
... (you get the idea).
people. Typical definitions include user processes dumping vital
state to disk periodically, checkpoint/restart of running processes,
elaborate recreate-process-state-from-incremental-pieces schemes,
and many others.

In the scope of Open MPI, we typically define "fault tolerance" to
mean the ability to recover from one or more component failures in a
Expand Down Expand Up @@ -99,7 +95,7 @@ links below:
* `MPI Forum's Fault Tolerance Working Group <https://github.com/mpiwg-ft/ft-issues/wiki>`_
* Fault Tolerant MPI Prototype:
* `Development / code <https://bitbucket.org/icldistcomp/ulfm2>`_
* `Information and support <http://fault-tolerance.org/>`_
* `Information and support <https://fault-tolerance.org/>`_

Support for other types of resilience (e.g., :ref:`data reliability <faq-ft-data-reliability-label>`,
checkpoint) has been deprecated over the years
Expand Down
9 changes: 6 additions & 3 deletions docs/faq/running-mpi-apps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -762,9 +762,12 @@ Several notable options are:
How do I use the ``--hostfile`` option to ``mpirun``?
-----------------------------------------------------
.. error:: TODO For cross reference, this is the PRRTE man page section
about ``--hostfile``:
https://github.com/openpmix/prrte/blame/master/src/tools/prte/prte-map.1.md#L236
.. error:: TODO For cross reference, this is the PRRTE man page
section about ``--hostfile``:
https://github.com/openpmix/prrte/blob/b70a6f1a8d424e396c40c999a656b04e76cc0f91/src/tools/prte/prte-map.1.md?plain=1#L236
A subsequent commit removed this markdown file; the commit
message refers to moving the markdown file to another git
repo, but I didn't chase down where it went.
The ``--hostfile`` option to ``mpirun`` takes a filename that lists
hosts on which to launch MPI processes.
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/sysadmin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ to tweak are:
parameters in *levels*, as defined by the MPI_T interface from
the MPI standard. You will need to specify ``--level 9`` (or
``--all``) to show *all* MCA parameters. `See this blog entry
<http://blogs.cisco.com/performance/open-mpi-and-the-mpi-3-mpi_t-interface>`_
<https://blogs.cisco.com/performance/open-mpi-and-the-mpi-3-mpi_t-interface>`_
for further information.

.. code-block:: sh
Expand Down
9 changes: 4 additions & 5 deletions docs/features/ulfm.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ execution environment up and running.
This implementation produces the three supplementary error codes and
five supplementary interfaces defined in the communicator section of
the `ULFM chapter
<http://fault-tolerance.org/wp-content/uploads/2012/10/20170221-ft.pdf>`_
<https://fault-tolerance.org/wp-content/uploads/2012/10/20170221-ft.pdf>`_
standard draft document.

* ``MPIX_ERR_PROC_FAILED`` when a process failure prevents the
Expand Down Expand Up @@ -95,7 +95,7 @@ please use:
J. Dongarra: Post-failure recovery of MPI communication
capability: Design and rationale. IJHPCA 27(3): 244-254 (2013).*

Available from: http://journals.sagepub.com/doi/10.1177/1094342013488238.
Available from: https://journals.sagepub.com/doi/10.1177/1094342013488238.

Building ULFM support in Open MPI
---------------------------------
Expand Down Expand Up @@ -522,9 +522,8 @@ joe@mycomputer.example.com!). Visit these pages to subscribe to the
lists: https://groups.google.com/forum/#!forum/ulfm

When submitting questions and problems, be sure to include as much
extra information as possible. This web page details all the
information that we request in order to provide assistance:
http://www.open-mpi.org/community/help/
extra information as possible. See the :doc:`Getting help
</getting-help>` section for more details.

Thanks for your time.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ can be used with ``configure``:
memory copies (optionally using hardware offload), potentially
increasing bandwidth for large messages sent between messages on the
same server. See `the Knem web site
<https://knem.gforge.inria.fr/>`_ for details.
<https://knem.gitlabpages.inria.fr/>`_ for details.

* ``--with-libfabric=DIR``:
Specify the directory where the OpenFabrics Interfaces ``libfabric``
Expand Down
2 changes: 1 addition & 1 deletion docs/networking/cuda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ you use the latest version of Open MPI for best support.

Open MPI offers two flavors of CUDA support:

#. Via `UCX <https://www.openucx.org/>`_.
#. Via `UCX <https://openucx.org/>`_.

This is the preferred mechanism. Since UCX will be providing the
CUDA support, it is important to ensure that UCX itself is built
Expand Down
4 changes: 2 additions & 2 deletions docs/networking/ib-and-roce.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ supported via the UCX (``ucx``) PML.
What is UCX?
------------

`UCX <https://www.openucx.org/>`_ is an open-source optimized
`UCX <https://openucx.org/>`_ is an open-source optimized
communication library which supports multiple networks, including
RoCE, InfiniBand, uGNI, TCP, shared memory, and others. UCX
mixes-and-matches transports and protocols which are available on the
Expand Down Expand Up @@ -98,7 +98,7 @@ any Open MPI component. For example:
mainly uses environment variables for run-time tuning
|mdash| not Open MPI MCA parameters. Consult `the UCX
documentation
<https://www.openucx.org/documentation/>`_ for details
<https://openucx.org/documentation/>`_ for details
about what environment variables are available.

/////////////////////////////////////////////////////////////////////////
Expand Down
2 changes: 1 addition & 1 deletion docs/news/news-v1.x.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1634,7 +1634,7 @@ Open MPI version 1.5.0
:Date: 10 Oct 2010

- Added "knem" support: direct process-to-process copying for shared
memory message passing. See https://runtime.bordeaux.inria.fr/knem/
memory message passing. See https://knem.gitlabpages.inria.fr/
and the README file for more details.
- Updated shared library versioning scheme and linking style of MPI
applications. The MPI application ABI has been broken from the
Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/networks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Miscellaneous network notes
``knem`` Linux kernel module is not loaded, the ``knem`` support is (by
default) silently deactivated during Open MPI jobs.

See https://knem.gforge.inria.fr/ for details on Knem.
See https://knem.gitlabpages.inria.fr/ for details on Knem.

* Linux Cross-Memory Attach (CMA) or XPMEM is used by the ``sm`` shared
memory BTL when the CMA/XPMEM libraries are installed,
Expand Down
3 changes: 3 additions & 0 deletions docs/running-apps/gridengine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,9 @@ hosts are established successfully or not.
emailed Dave Love on 31 Dec 2021 to ask if this is still the
correct URL.

Update March 2022: it doesn't look like this web site is good any
more. Perhaps use https://github.com/grisu48/gridengine instead...?

Various Grid Engine documentation with pointers to more is available
at `the Son of GridEngine site <http://arc.liv.ac.uk/sge/>`_, and
configuration instructions can be found at `the Son of GridEngine
Expand Down

0 comments on commit c0857ad

Please sign in to comment.