From e146cbbc73e10fecfb7f1c26e8567a5a2873c51b Mon Sep 17 00:00:00 2001 From: Antonin Godard Date: Fri, 10 Jul 2026 16:46:55 +0200 Subject: [PATCH] docs-wide: fix various broken links Fix various broken links found using the linkcheck builder, in various places of the documentation. For most, the replacing link is the equivalent new link. (From yocto-docs rev: 5f708a1bc31ae94dd3513615b0ce079aa7897628) Signed-off-by: Antonin Godard (cherry picked from commit 358519ca6406a89fee42c45dcaf63a37a374f33c) [AG: fix conflict in variables.rst, due to changes to new variables in master] Signed-off-by: Antonin Godard Signed-off-by: Paul Barker --- documentation/dev-manual/new-recipe.rst | 2 +- documentation/dev-manual/start.rst | 2 +- documentation/dev-manual/x32-psabi.rst | 4 +- .../development-environment.rst | 4 +- documentation/profile-manual/usage.rst | 38 +++++++++---------- documentation/ref-manual/classes.rst | 4 +- documentation/ref-manual/variables.rst | 6 +-- 7 files changed, 28 insertions(+), 32 deletions(-) diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst index 8695684e48..e539bde995 100644 --- a/documentation/dev-manual/new-recipe.rst +++ b/documentation/dev-manual/new-recipe.rst @@ -825,7 +825,7 @@ different ways: - *systemd:* System Management Daemon (systemd) was designed to replace SysVinit and to provide enhanced management of services. For more information on systemd, see the systemd homepage at - https://freedesktop.org/wiki/Software/systemd/. + https://systemd.io/. To enable a service using systemd, your recipe needs to inherit the :ref:`ref-classes-systemd` class. See the ``systemd.bbclass`` file diff --git a/documentation/dev-manual/start.rst b/documentation/dev-manual/start.rst index 41d65583a7..aa9e00d828 100644 --- a/documentation/dev-manual/start.rst +++ b/documentation/dev-manual/start.rst @@ -357,7 +357,7 @@ as your Yocto Project build host: Depending on your build host, you might have to install different software to support Docker containers. Go to the Docker installation page and read about the platform requirements in "`Supported - Platforms `__" + Platforms `__" your build host needs to run containers. #. *Choose What To Install:* Depending on whether or not your build host diff --git a/documentation/dev-manual/x32-psabi.rst b/documentation/dev-manual/x32-psabi.rst index 92b1f96fa4..0a19d28233 100644 --- a/documentation/dev-manual/x32-psabi.rst +++ b/documentation/dev-manual/x32-psabi.rst @@ -3,8 +3,8 @@ Using x32 psABI *************** -x32 processor-specific Application Binary Interface (`x32 -psABI `__) is a native +x32 processor-specific Application Binary Interface (:wikipedia:`x32 +psABI `) is a native 32-bit processor-specific ABI for Intel 64 (x86-64) architectures. An ABI defines the calling conventions between functions in a processing environment. The interface determines what registers are used and what diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 34da8e3a3d..8a48d16989 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst @@ -365,7 +365,7 @@ commands. .. note:: - For more information on Git, see - https://git-scm.com/documentation. + https://git-scm.com/docs. - If you need to download Git, it is recommended that you add Git to your system through your distribution's "software store" (e.g. for @@ -496,7 +496,7 @@ you can manage with a small set of basic operations and workflows once you understand the basic philosophy behind Git. You do not have to be an expert in Git to be functional. A good place to look for instruction on a minimal set of Git commands is -`here `__. +`here `__. The following list of Git commands briefly describes some basic Git operations as a way to get started. As with any set of commands, this diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 17be149580..d67487fe14 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst @@ -39,7 +39,7 @@ other tools when it seems useful to do so. The coverage below details some of the most common ways you'll likely want to apply the tool; full documentation can be found either within the tool itself or in the manual pages at -`perf(1) `__. +:manpage:`perf(1)`. perf Setup ---------- @@ -869,8 +869,8 @@ goes a little way to support the idea mentioned previously that given the right kind of trace data, higher-level profiling-type summaries can be derived from it. -Documentation on using the `'perf script' Python -binding `__. +Documentation on using the :manpage:`'perf script' Python +binding `. System-Wide Tracing and Profiling ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1150,23 +1150,19 @@ perf Documentation Online versions of the manual pages for the commands discussed in this section can be found here: -- The `'perf stat' manual page `__. +- The :manpage:`'perf stat' manual page `. -- The `'perf record' - manual page `__. +- The :manpage:`'perf record' manual page `. -- The `'perf report' - manual page `__. +- The :manpage:`'perf report' manual page `. -- The `'perf probe' manual page `__. +- The :manpage:`'perf probe' manual page `. -- The `'perf script' - manual page `__. +- The :manpage:`'perf script' manual page `. -- Documentation on using the `'perf script' Python - binding `__. +- Documentation on using the :manpage:`'perf script' Python binding `. -- The top-level `perf(1) manual page `__. +- The top-level :manpage:`perf(1) manual page `. Normally, you should be able to open the manual pages via perf itself e.g. ``perf help`` or ``perf help record``. @@ -1781,7 +1777,7 @@ gather / print / aggregate data extracted from the context they end up being called under. For example, this probe from the `SystemTap -tutorial `__ just prints a +tutorial `__ just prints a line every time any process on the system runs ``open()`` on a file. For each line, it prints the executable name of the program that opened the file, along with its PID, and the name of the file it opened (or tried to open), which it @@ -1957,7 +1953,7 @@ SystemTap Documentation ----------------------- The SystemTap language reference can be found here: `SystemTap Language -Reference `__ +Reference `__ Links to other SystemTap documents, tutorials, and examples can be found here: `SystemTap documentation @@ -2388,7 +2384,7 @@ first part of the filenames:: The report shows each event that was found in the blktrace data, along with a summary of the overall block I/O traffic during the run. You can look at the -`blkparse `__ manual page to learn the +:manpage:`blkparse(1)` manual page to learn the meaning of each field displayed in the trace listing. Live Mode @@ -2588,14 +2584,14 @@ blktrace Documentation Online versions of the manual pages for the commands discussed in this section can be found here: -- https://linux.die.net/man/8/blktrace +- :manpage:`blktrace(8)` -- https://linux.die.net/man/1/blkparse +- :manpage:`blkparse(1)` -- https://linux.die.net/man/8/btrace +- :manpage:`btrace(8)` The above manual pages, along with manuals for the other blktrace utilities (``btt``, ``blkiomon``, etc) can be found in the ``/doc`` directory of the blktrace tools git repository:: - $ git clone git://git.kernel.dk/blktrace.git + $ git clone https://git.kernel.org/pub/scm/linux/kernel/git/axboe/blktrace.git diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index eb63aa3a29..67f4c291dd 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst @@ -2997,7 +2997,7 @@ Python version 3.x extensions that use build systems based on ``setuptools`` ``pyproject.toml`` format). Unlike :ref:`ref-classes-setuptools3`, this uses the traditional ``setup.py`` ``build`` and ``install`` commands and not wheels. This use of ``setuptools`` like this is -`deprecated `__ +`deprecated `__ but still relatively common. .. _ref-classes-setuptools3-base: @@ -3262,7 +3262,7 @@ the :term:`SYSTEMD_BOOT_CFG`, :term:`SYSTEMD_BOOT_TIMEOUT` variables. You can also see the `Systemd-boot -documentation `__ +documentation `__ for more information. .. _ref-classes-terminal: diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index b02ee8440a..94f2eeca2a 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3564,7 +3564,7 @@ system and gives an overview of their function and contents. GROUPADD_PARAM:${PN} = "-g 880 group1; -g 890 group2" For information on the standard Linux shell command - ``groupadd``, see https://linux.die.net/man/8/groupadd. + ``groupadd``, see :manpage:`groupadd(8)`. :term:`GROUPMEMS_PARAM` When inheriting the :ref:`ref-classes-useradd` class, @@ -5906,7 +5906,7 @@ system and gives an overview of their function and contents. See the :term:`KERNEL_MODULE_AUTOLOAD` variable for more information. :term:`module_conf` - Specifies `modprobe.d `__ + Specifies :manpage:`modprobe.d(5)` syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf`` file. @@ -10578,7 +10578,7 @@ system and gives an overview of their function and contents. For information on the standard Linux shell command ``useradd``, see - https://linux.die.net/man/8/useradd. + :manpage:`useradd(8)`. :term:`USERADD_UID_TABLES` Specifies a password file to use for obtaining static user