From 7c01d3ba356f1b006d2a45a4695640750e277cb9 Mon Sep 17 00:00:00 2001 From: "Adam J. Stewart" Date: Mon, 20 Feb 2023 01:21:18 -0700 Subject: Fix broken links in docs (#35582) --- lib/spack/docs/.gitignore | 1 + lib/spack/docs/build_systems/pythonpackage.rst | 2 +- lib/spack/docs/build_systems/wafpackage.rst | 4 +--- lib/spack/docs/config_yaml.rst | 2 +- lib/spack/docs/contribution_guide.rst | 4 ++-- lib/spack/docs/getting_started.rst | 10 +++++----- lib/spack/docs/packaging_guide.rst | 6 +++--- lib/spack/llnl/util/multiproc.py | 2 +- 8 files changed, 15 insertions(+), 16 deletions(-) diff --git a/lib/spack/docs/.gitignore b/lib/spack/docs/.gitignore index 1624dfeaea..d481aa0923 100644 --- a/lib/spack/docs/.gitignore +++ b/lib/spack/docs/.gitignore @@ -5,3 +5,4 @@ llnl*.rst _build .spack-env spack.lock +_spack_root diff --git a/lib/spack/docs/build_systems/pythonpackage.rst b/lib/spack/docs/build_systems/pythonpackage.rst index bac4c894ff..807af44ed9 100644 --- a/lib/spack/docs/build_systems/pythonpackage.rst +++ b/lib/spack/docs/build_systems/pythonpackage.rst @@ -366,7 +366,7 @@ If the ``pyproject.toml`` lists ``mesonpy`` as the ``build-backend``, it uses the meson build system. Meson uses the default ``pyproject.toml`` keys to list dependencies. -See https://meson-python.readthedocs.io/en/latest/usage/start.html +See https://meson-python.readthedocs.io/en/latest/tutorials/introduction.html for more information. """ diff --git a/lib/spack/docs/build_systems/wafpackage.rst b/lib/spack/docs/build_systems/wafpackage.rst index 5c79fb8b99..c9bbf8bb5a 100644 --- a/lib/spack/docs/build_systems/wafpackage.rst +++ b/lib/spack/docs/build_systems/wafpackage.rst @@ -58,9 +58,7 @@ Testing ``WafPackage`` also provides ``test`` and ``installtest`` methods, which are run after the ``build`` and ``install`` phases, respectively. By default, these phases do nothing, but you can override them to -run package-specific unit tests. For example, the -`py-py2cairo `_ -package uses: +run package-specific unit tests. .. code-block:: python diff --git a/lib/spack/docs/config_yaml.rst b/lib/spack/docs/config_yaml.rst index f20099a113..b1e7a1d249 100644 --- a/lib/spack/docs/config_yaml.rst +++ b/lib/spack/docs/config_yaml.rst @@ -222,7 +222,7 @@ and location. (See the *Configuration settings* section of ``man ccache`` to learn more about the default settings and how to change them). Please note that we currently disable ccache's ``hash_dir`` feature to avoid an issue with the stage directory (see -https://github.com/LLNL/spack/pull/3761#issuecomment-294352232). +https://github.com/spack/spack/pull/3761#issuecomment-294352232). ----------------------- ``shared_linking:type`` diff --git a/lib/spack/docs/contribution_guide.rst b/lib/spack/docs/contribution_guide.rst index 2fba387e0b..8933f590d7 100644 --- a/lib/spack/docs/contribution_guide.rst +++ b/lib/spack/docs/contribution_guide.rst @@ -118,7 +118,7 @@ make another change, test that change, etc. We use `pytest `_ as our tests framework, and these types of arguments are just passed to the ``pytest`` command underneath. See `the pytest docs -`_ +`_ for more details on test selection syntax. ``spack unit-test`` has a few special options that can help you @@ -147,7 +147,7 @@ you want to know about. For example, to see just the tests in You can also combine any of these options with a ``pytest`` keyword search. See the `pytest usage docs -`_: +`_ for more details on test selection syntax. For example, to see the names of all tests that have "spec" or "concretize" somewhere in their names: diff --git a/lib/spack/docs/getting_started.rst b/lib/spack/docs/getting_started.rst index 253b0e41e5..b2193fe1fd 100644 --- a/lib/spack/docs/getting_started.rst +++ b/lib/spack/docs/getting_started.rst @@ -21,7 +21,7 @@ be present on the machine where Spack is run: :header-rows: 1 These requirements can be easily installed on most modern Linux systems; -on macOS, the Command Line Tools package is required, and a full XCode suite +on macOS, the Command Line Tools package is required, and a full XCode suite may be necessary for some packages such as Qt and apple-gl. Spack is designed to run on HPC platforms like Cray. Not all packages should be expected to work on all platforms. @@ -1506,7 +1506,7 @@ Spack On Windows Windows support for Spack is currently under development. While this work is still in an early stage, it is currently possible to set up Spack and perform a few operations on Windows. This section will guide -you through the steps needed to install Spack and start running it on a fresh Windows machine. +you through the steps needed to install Spack and start running it on a fresh Windows machine. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Step 1: Install prerequisites @@ -1516,7 +1516,7 @@ To use Spack on Windows, you will need the following packages: Required: * Microsoft Visual Studio -* Python +* Python * Git Optional: @@ -1547,8 +1547,8 @@ Intel Fortran """"""""""""" For Fortran-based packages on Windows, we strongly recommend Intel's oneAPI Fortran compilers. -The suite is free to download from Intel's website, located at -https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/fortran-compiler.html#gs.70t5tw. +The suite is free to download from Intel's website, located at +https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/fortran-compiler.html. The executable of choice for Spack will be Intel's Beta Compiler, ifx, which supports the classic compiler's (ifort's) frontend and runtime libraries by using LLVM. diff --git a/lib/spack/docs/packaging_guide.rst b/lib/spack/docs/packaging_guide.rst index 4ebb62da07..9997d5ea06 100644 --- a/lib/spack/docs/packaging_guide.rst +++ b/lib/spack/docs/packaging_guide.rst @@ -1392,7 +1392,7 @@ Go ^^ Go isn't a VCS, it is a programming language with a builtin command, -`go get `_, +`go get `_, that fetches packages and their dependencies automatically. The destination directory will be the standard stage source path. @@ -2117,7 +2117,7 @@ dynamic loader where to find its dependencies at runtime. You may be familiar with `LD_LIBRARY_PATH `_ on Linux or `DYLD_LIBRARY_PATH -`_ +`_ on Mac OS X. RPATH is similar to these paths, in that it tells the loader where to find libraries. Unlike them, it is embedded in the binary and not set in each user's environment. @@ -2429,7 +2429,7 @@ package, and a `canonical hash `_ of the ``package.py`` recipes). ``test`` dependencies do not affect the package hash, as they are only used to construct a test environment *after* building and installing a given package installation. Older versions of Spack did not include -build dependencies in the hash, but this has been +build dependencies in the hash, but this has been `fixed `_ as of |Spack v0.18|_. .. |Spack v0.18| replace:: Spack ``v0.18`` diff --git a/lib/spack/llnl/util/multiproc.py b/lib/spack/llnl/util/multiproc.py index 6c27441746..d67427218f 100644 --- a/lib/spack/llnl/util/multiproc.py +++ b/lib/spack/llnl/util/multiproc.py @@ -18,7 +18,7 @@ class Barrier: Python 2 doesn't have multiprocessing barriers so we implement this. - See http://greenteapress.com/semaphores/downey08semaphores.pdf, p. 41. + See https://greenteapress.com/semaphores/LittleBookOfSemaphores.pdf, p. 41. """ def __init__(self, n, timeout=None): -- cgit v1.2.3-60-g2f50