From c0857ad08fd63c76b2e27771ab309c1d945d4404 Mon Sep 17 00:00:00 2001 From: Jeff Squyres Date: Sun, 13 Mar 2022 08:02:29 -0400 Subject: [PATCH] docs: update a bunch of old/stale web links "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 --- docs/faq/debugging.rst | 2 +- docs/faq/fault-tolerance.rst | 14 +++++--------- docs/faq/running-mpi-apps.rst | 9 ++++++--- docs/faq/sysadmin.rst | 2 +- docs/features/ulfm.rst | 9 ++++----- .../configure-cli-options/networking.rst | 2 +- docs/networking/cuda.rst | 2 +- docs/networking/ib-and-roce.rst | 4 ++-- docs/news/news-v1.x.rst | 2 +- docs/release-notes/networks.rst | 2 +- docs/running-apps/gridengine.rst | 3 +++ 11 files changed, 26 insertions(+), 25 deletions(-) diff --git a/docs/faq/debugging.rst b/docs/faq/debugging.rst index 1f74c0b66e0..65a19150da8 100644 --- a/docs/faq/debugging.rst +++ b/docs/faq/debugging.rst @@ -538,7 +538,7 @@ There are two cases: `_. For an evaluation of various internal implementation alternatives of Shadow Memory, please see `Building Workload Characterization Tools with Valgrind - `_. + `_. Further information and performance data with the NAS Parallel diff --git a/docs/faq/fault-tolerance.rst b/docs/faq/fault-tolerance.rst index 099a51296e9..245cfe0b1ac 100644 --- a/docs/faq/fault-tolerance.rst +++ b/docs/faq/fault-tolerance.rst @@ -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 @@ -99,7 +95,7 @@ links below: * `MPI Forum's Fault Tolerance Working Group `_ * Fault Tolerant MPI Prototype: * `Development / code `_ - * `Information and support `_ + * `Information and support `_ Support for other types of resilience (e.g., :ref:`data reliability `, checkpoint) has been deprecated over the years diff --git a/docs/faq/running-mpi-apps.rst b/docs/faq/running-mpi-apps.rst index 673db026d3c..30295d701d6 100644 --- a/docs/faq/running-mpi-apps.rst +++ b/docs/faq/running-mpi-apps.rst @@ -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. diff --git a/docs/faq/sysadmin.rst b/docs/faq/sysadmin.rst index eb17a2f6fd7..f6963c6b769 100644 --- a/docs/faq/sysadmin.rst +++ b/docs/faq/sysadmin.rst @@ -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 - `_ + `_ for further information. .. code-block:: sh diff --git a/docs/features/ulfm.rst b/docs/features/ulfm.rst index 202a13f5f5d..00148bb6872 100644 --- a/docs/features/ulfm.rst +++ b/docs/features/ulfm.rst @@ -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 -`_ +`_ standard draft document. * ``MPIX_ERR_PROC_FAILED`` when a process failure prevents the @@ -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 --------------------------------- @@ -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 +` section for more details. Thanks for your time. diff --git a/docs/installing-open-mpi/configure-cli-options/networking.rst b/docs/installing-open-mpi/configure-cli-options/networking.rst index 6c00faedebb..3bb9c1f8561 100644 --- a/docs/installing-open-mpi/configure-cli-options/networking.rst +++ b/docs/installing-open-mpi/configure-cli-options/networking.rst @@ -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 - `_ for details. + `_ for details. * ``--with-libfabric=DIR``: Specify the directory where the OpenFabrics Interfaces ``libfabric`` diff --git a/docs/networking/cuda.rst b/docs/networking/cuda.rst index 4b4869f47e9..e9601b1bbed 100644 --- a/docs/networking/cuda.rst +++ b/docs/networking/cuda.rst @@ -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 `_. +#. Via `UCX `_. This is the preferred mechanism. Since UCX will be providing the CUDA support, it is important to ensure that UCX itself is built diff --git a/docs/networking/ib-and-roce.rst b/docs/networking/ib-and-roce.rst index 7239fe4f0ab..42ee2c61291 100644 --- a/docs/networking/ib-and-roce.rst +++ b/docs/networking/ib-and-roce.rst @@ -19,7 +19,7 @@ supported via the UCX (``ucx``) PML. What is UCX? ------------ -`UCX `_ is an open-source optimized +`UCX `_ 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 @@ -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 - `_ for details + `_ for details about what environment variables are available. ///////////////////////////////////////////////////////////////////////// diff --git a/docs/news/news-v1.x.rst b/docs/news/news-v1.x.rst index d72e6b405f5..bab85fbc521 100644 --- a/docs/news/news-v1.x.rst +++ b/docs/news/news-v1.x.rst @@ -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 diff --git a/docs/release-notes/networks.rst b/docs/release-notes/networks.rst index 15a108f8b46..c959fabd204 100644 --- a/docs/release-notes/networks.rst +++ b/docs/release-notes/networks.rst @@ -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, diff --git a/docs/running-apps/gridengine.rst b/docs/running-apps/gridengine.rst index 1412f472a67..5103627c354 100644 --- a/docs/running-apps/gridengine.rst +++ b/docs/running-apps/gridengine.rst @@ -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 `_, and configuration instructions can be found at `the Son of GridEngine