* [PATCH 0/8] Fix broken links
@ 2026-07-10 14:46 Antonin Godard
2026-07-10 14:46 ` [PATCH 1/8] conf.py: add linkcheck builder exclusions Antonin Godard
` (7 more replies)
0 siblings, 8 replies; 13+ messages in thread
From: Antonin Godard @ 2026-07-10 14:46 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni, Antonin Godard
Use the linkcheck builder to fix broken links. The first two patches add
some exclusion patterns, and the remaining ones fix the links. Specific
replacements are split in separate patches.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
Antonin Godard (8):
conf.py: add linkcheck builder exclusions
conf.py: add extra links known to be broken
migration-guides/release-notes-3.4.2.rst: fix a broken link
docs-wide: fix broken path links
ref-manual/classes.rst: replace obsolete mailing list thread
ref-manual/images.rst: update obsolete VMWare links
migration-guides/release-notes-5.0.rst: remove broken link
docs-wide: fix various broken links
documentation/conf.py | 23 +++++++++++++
documentation/dev-manual/new-recipe.rst | 2 +-
documentation/dev-manual/start.rst | 2 +-
documentation/dev-manual/x32-psabi.rst | 4 +--
documentation/migration-guides/migration-6.0.rst | 4 +--
.../migration-guides/release-notes-3.4.2.rst | 4 +--
.../migration-guides/release-notes-5.0.rst | 2 +-
.../migration-guides/release-notes-5.3.rst | 2 +-
.../migration-guides/release-notes-6.0.rst | 6 ++--
.../overview-manual/development-environment.rst | 4 +--
documentation/profile-manual/usage.rst | 38 ++++++++++------------
documentation/ref-manual/classes.rst | 11 +++----
documentation/ref-manual/faq.rst | 2 +-
documentation/ref-manual/images.rst | 5 +--
documentation/ref-manual/variables.rst | 14 ++++----
.../yocto-project-supported-features.rst | 2 +-
16 files changed, 69 insertions(+), 56 deletions(-)
---
base-commit: 0cd9c643c0185c60eb9aae90fe48c3597b1781d6
change-id: 20260710-linkcheck-7141a2ac36cf
^ permalink raw reply [flat|nested] 13+ messages in thread
* [PATCH 1/8] conf.py: add linkcheck builder exclusions
2026-07-10 14:46 [PATCH 0/8] Fix broken links Antonin Godard
@ 2026-07-10 14:46 ` Antonin Godard
2026-07-10 15:09 ` [docs] " Quentin Schulz
2026-07-10 14:46 ` [PATCH 2/8] conf.py: add extra links known to be broken Antonin Godard
` (6 subsequent siblings)
7 siblings, 1 reply; 13+ messages in thread
From: Antonin Godard @ 2026-07-10 14:46 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni, Antonin Godard
The linkcheck builder can be used to scout for broken links. By looking at
the output of:
grep -E -r --no-filename -o 'href="http.://[^/"]+' | sort | uniq -c | sort -nr
from the HTML output directory, exclude links that are too frequent.
Also remove docs.yoctoproject.org links are those should already be
validated when building the documentation.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/conf.py | 13 +++++++++++++
1 file changed, 13 insertions(+)
diff --git a/documentation/conf.py b/documentation/conf.py
index 7b201ebd6..aff01c1ed 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -143,6 +143,19 @@ suppress_warnings = ['epub.unknown_project_files']
# sphinx-copybutton configuration
copybutton_prompt_text = "$ "
+# When using the linkcheck builder, ignore the following links which are too
+# present in the docs, and self-references to yocto-docs which are already
+# checked.
+linkcheck_ignore = [
+ r'https?://nvd\.nist\.gov.*',
+ r'https?://docs\.yoctoproject\.org.*',
+ r'https?://git\.yoctoproject\.org.*',
+ r'https?://git\.openembedded\.org.*',
+ r'https?://downloads\.yoctoproject\.org.*',
+ r'https?://mirrors\.kernel\.org.*',
+ r'https?://mirrors\.edge\.kernel\.org.*'
+]
+
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
--
2.54.0
^ permalink raw reply related [flat|nested] 13+ messages in thread
* [PATCH 2/8] conf.py: add extra links known to be broken
2026-07-10 14:46 [PATCH 0/8] Fix broken links Antonin Godard
2026-07-10 14:46 ` [PATCH 1/8] conf.py: add linkcheck builder exclusions Antonin Godard
@ 2026-07-10 14:46 ` Antonin Godard
2026-07-10 15:13 ` [docs] " Quentin Schulz
2026-07-10 14:46 ` [PATCH 3/8] migration-guides/release-notes-3.4.2.rst: fix a broken link Antonin Godard
` (5 subsequent siblings)
7 siblings, 1 reply; 13+ messages in thread
From: Antonin Godard @ 2026-07-10 14:46 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni, Antonin Godard
Those links are broken, yet our documentation still has references to them
we want to keep, namely in release notes. Make the linkcheck ignore them.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/conf.py | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/documentation/conf.py b/documentation/conf.py
index aff01c1ed..a5b0add8f 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -156,6 +156,16 @@ linkcheck_ignore = [
r'https?://mirrors\.edge\.kernel\.org.*'
]
+# Those link are known to be dead, yet we want to keep them in our documentation
+# because they still hold value in the context in which they were used (e.g. in
+# release notes).
+linkcheck_ignore += [
+ r'https?://linuxkernelcves\.com.*',
+ r'https?://gpe\.linuxtogo\.org.*',
+ r'https?://jk\.ozlabs\.org/projects/patchwork.*',
+ r'https?://rlbl\.me/prelink.*',
+]
+
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
--
2.54.0
^ permalink raw reply related [flat|nested] 13+ messages in thread
* [PATCH 3/8] migration-guides/release-notes-3.4.2.rst: fix a broken link
2026-07-10 14:46 [PATCH 0/8] Fix broken links Antonin Godard
2026-07-10 14:46 ` [PATCH 1/8] conf.py: add linkcheck builder exclusions Antonin Godard
2026-07-10 14:46 ` [PATCH 2/8] conf.py: add extra links known to be broken Antonin Godard
@ 2026-07-10 14:46 ` Antonin Godard
2026-07-10 14:46 ` [PATCH 4/8] docs-wide: fix broken path links Antonin Godard
` (4 subsequent siblings)
7 siblings, 0 replies; 13+ messages in thread
From: Antonin Godard @ 2026-07-10 14:46 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni, Antonin Godard
Remove the extra '`'.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/migration-guides/release-notes-3.4.2.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/documentation/migration-guides/release-notes-3.4.2.rst b/documentation/migration-guides/release-notes-3.4.2.rst
index 51046b6aa..a8e05af24 100644
--- a/documentation/migration-guides/release-notes-3.4.2.rst
+++ b/documentation/migration-guides/release-notes-3.4.2.rst
@@ -239,4 +239,4 @@ yocto-docs
- Repository Location: :yocto_git:`/yocto-docs`
- Branch: :yocto_git:`honister </yocto-docs/log/?h=honister>`
- Tag: :yocto_git:`yocto-3.4.2 </yocto-docs/tag/?h=yocto-3.4.2>`
-- Git Revision: :yocto_git:`3061d3d62054a5c3b9e16bfce4bcd186fa7a23d2` </yocto-docs/commit/?3061d3d62054a5c3b9e16bfce4bcd186fa7a23d2>`
+- Git Revision: :yocto_git:`3061d3d62054a5c3b9e16bfce4bcd186fa7a23d2 </yocto-docs/commit/?3061d3d62054a5c3b9e16bfce4bcd186fa7a23d2>`
--
2.54.0
^ permalink raw reply related [flat|nested] 13+ messages in thread
* [PATCH 4/8] docs-wide: fix broken path links
2026-07-10 14:46 [PATCH 0/8] Fix broken links Antonin Godard
` (2 preceding siblings ...)
2026-07-10 14:46 ` [PATCH 3/8] migration-guides/release-notes-3.4.2.rst: fix a broken link Antonin Godard
@ 2026-07-10 14:46 ` Antonin Godard
2026-07-10 14:46 ` [PATCH 5/8] ref-manual/classes.rst: replace obsolete mailing list thread Antonin Godard
` (3 subsequent siblings)
7 siblings, 0 replies; 13+ messages in thread
From: Antonin Godard @ 2026-07-10 14:46 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni, Antonin Godard
Fix link that forget to add a leading '/', by looking at the output of
'grep -E -r --no-filename -o 'href="http.://[^/"]+' | sort | uniq' in
the HTML output.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/migration-guides/migration-6.0.rst | 4 ++--
documentation/migration-guides/release-notes-3.4.2.rst | 2 +-
documentation/migration-guides/release-notes-6.0.rst | 6 +++---
documentation/ref-manual/faq.rst | 2 +-
documentation/ref-manual/variables.rst | 6 +++---
5 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/documentation/migration-guides/migration-6.0.rst b/documentation/migration-guides/migration-6.0.rst
index eed4b16e7..5ad284600 100644
--- a/documentation/migration-guides/migration-6.0.rst
+++ b/documentation/migration-guides/migration-6.0.rst
@@ -77,7 +77,7 @@ Default :term:`INIT_MANAGER` definition changed to ``systemd``
--------------------------------------------------------------
The default definition of :term:`INIT_MANAGER` in the :oe_git:`defaultsetup.conf
-<openembedded-core/tree/meta/conf/distro/defaultsetup.conf>` file was changed
+</openembedded-core/tree/meta/conf/distro/defaultsetup.conf>` file was changed
from ``none`` to ``systemd``.
This means that users of the default distro setup (appearing as the ``nodistro``
@@ -243,7 +243,7 @@ See commit :oecore_rev:`cd9e7304481b24b27df61c03ad73496d18e4d47c` for more infor
All the :ref:`ref-classes-pkgconfig`-related variables, such as
:term:`PKG_CONFIG_PATH`, are no longer exported in
-:oe_git:`meta/conf/bitbake.conf <bitbake/tree/meta/conf/bitbake.conf>` with the
+:oe_git:`meta/conf/bitbake.conf </bitbake/tree/meta/conf/bitbake.conf>` with the
:ref:`export <bitbake:bitbake-user-manual/bitbake-user-manual-metadata:Exporting
Variables to the Environment>` directive.
diff --git a/documentation/migration-guides/release-notes-3.4.2.rst b/documentation/migration-guides/release-notes-3.4.2.rst
index a8e05af24..4e98aedb0 100644
--- a/documentation/migration-guides/release-notes-3.4.2.rst
+++ b/documentation/migration-guides/release-notes-3.4.2.rst
@@ -200,7 +200,7 @@ openembedded-core
meta-mingw
-- Repository Location: :yocto_git:`meta-mingw`
+- Repository Location: :yocto_git:`/meta-mingw`
- Branch: :yocto_git:`honister </meta-mingw/log/?h=honister>`
- Tag: :yocto_git:`yocto-3.4.2 </meta-mingw/tag/?h=yocto-3.4.2>`
- Git Revision: :yocto_git:`f5d761cbd5c957e4405c5d40b0c236d263c916a8 </meta-mingw/commit/?id=f5d761cbd5c957e4405c5d40b0c236d263c916a8>`
diff --git a/documentation/migration-guides/release-notes-6.0.rst b/documentation/migration-guides/release-notes-6.0.rst
index 9ef7e66d9..1ce7d5120 100644
--- a/documentation/migration-guides/release-notes-6.0.rst
+++ b/documentation/migration-guides/release-notes-6.0.rst
@@ -225,20 +225,20 @@ New Features / Enhancements in |yocto-ver|
(:oecore_rev:`722897f96d30e978b20e140419fb044d850f5c74`)
- The :oe_git:`no-static-libs.inc
- <openembedded-core/tree/meta/conf/distro/include/no-static-libs.inc>`
+ </openembedded-core/tree/meta/conf/distro/include/no-static-libs.inc>`
file, disabling most static libraries in various recipes, is now included
by default in the default distro setup (appearing as the ``nodistro``
:term:`DISTRO`) (:oecore_rev:`03fc931bfe9ea3fa9f33553e6020cbc067b24291`)
- The :oe_git:`security_flags.inc
- <openembedded-core/tree/meta/conf/distro/include/security_flags.inc>`
+ </openembedded-core/tree/meta/conf/distro/include/security_flags.inc>`
file, adding various security related flags to the default compiler and
linker, is now included by default in the default distro setup (appearing
as ``nodistro`` :term:`DISTRO`)
(:oecore_rev:`4c2d64c10a5b0437ab1ea04df22386f0f95124d1`)
- The :oe_git:`yocto-space-optimize.inc
- <openembedded-core/tree/meta/conf/distro/include/yocto-space-optimize.inc>`
+ </openembedded-core/tree/meta/conf/distro/include/yocto-space-optimize.inc>`
file, adding various space optimization tweaks, is now included by default
in the default distro setup (appearing as ``nodistro`` :term:`DISTRO`)
(:oecore_rev:`175fcf9fad699dd122680d3f6961af9bf8487046`)
diff --git a/documentation/ref-manual/faq.rst b/documentation/ref-manual/faq.rst
index adb5659b7..65d5db5d2 100644
--- a/documentation/ref-manual/faq.rst
+++ b/documentation/ref-manual/faq.rst
@@ -22,7 +22,7 @@ System` and :term:`BitBake`. The :term:`metadata` involved to build the
- :term:`OpenEmbedded-Core (OE-Core)`, which is hosted at
:oe_git:`/openembedded-core`.
-- :yocto_git:`meta-poky <meta-yocto/tree/meta-poky>`, which defines the
+- :yocto_git:`meta-poky </meta-yocto/tree/meta-poky>`, which defines the
``poky`` distro configuration file (:term:`DISTRO`).
.. note::
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 41d9638fb..12d2e335c 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2679,7 +2679,7 @@ system and gives an overview of their function and contents.
:term:`EFI_ARCH`
The CPU architecture name within EFI standard. Set in
:oe_git:`meta/conf/image-uefi.conf
- <openembedded-core/tree/meta/conf/image-uefi.conf>`.
+ </openembedded-core/tree/meta/conf/image-uefi.conf>`.
:term:`EFI_PROVIDER`
When building bootable images (i.e. where ``hddimg``, ``iso``, or
@@ -5031,7 +5031,7 @@ system and gives an overview of their function and contents.
You can also find more information by referencing the
``conf/templates/default/local.conf.sample.extended``
- configuration file in :yocto_git:`meta-poky <meta-yocto/tree/meta-poky>`, the :ref:`ref-classes-image`
+ configuration file in :yocto_git:`meta-poky </meta-yocto/tree/meta-poky>`, the :ref:`ref-classes-image`
class, and the :ref:`ref-classes-kernel` class to see how to use the
:term:`INITRAMFS_IMAGE` variable.
@@ -12241,7 +12241,7 @@ system and gives an overview of their function and contents.
For more information, see
``conf/templates/default/local.conf.sample`` in
- :yocto_git:`meta-poky <meta-yocto/tree/meta-poky>`.
+ :yocto_git:`meta-poky </meta-yocto/tree/meta-poky>`.
:term:`USERADD_DEPENDS`
Specifies a list of recipes that create users / groups (via
--
2.54.0
^ permalink raw reply related [flat|nested] 13+ messages in thread
* [PATCH 5/8] ref-manual/classes.rst: replace obsolete mailing list thread
2026-07-10 14:46 [PATCH 0/8] Fix broken links Antonin Godard
` (3 preceding siblings ...)
2026-07-10 14:46 ` [PATCH 4/8] docs-wide: fix broken path links Antonin Godard
@ 2026-07-10 14:46 ` Antonin Godard
2026-07-10 14:46 ` [PATCH 6/8] ref-manual/images.rst: update obsolete VMWare links Antonin Godard
` (2 subsequent siblings)
7 siblings, 0 replies; 13+ messages in thread
From: Antonin Godard @ 2026-07-10 14:46 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni, Antonin Godard
I found this one by looking at the archive of the link on
https://web.archive.org and then locating the thread on
lists.yoctoproject.org by its title.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/ref-manual/classes.rst | 7 ++-----
1 file changed, 2 insertions(+), 5 deletions(-)
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index f826bbdbc..02ff36178 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2053,11 +2053,8 @@ consider some further things about using RPM:
perform on-device upgrades.
You can find additional information on the effects of the package class
-at these two Yocto Project mailing list links:
-
-- :yocto_lists:`/pipermail/poky/2011-May/006362.html`
-
-- :yocto_lists:`/pipermail/poky/2011-May/006363.html`
+at this Yocto Project mailing list link:
+:yocto_lists:`/g/poky/topic/61292484#msg6286`
.. _ref-classes-package_deb:
--
2.54.0
^ permalink raw reply related [flat|nested] 13+ messages in thread
* [PATCH 6/8] ref-manual/images.rst: update obsolete VMWare links
2026-07-10 14:46 [PATCH 0/8] Fix broken links Antonin Godard
` (4 preceding siblings ...)
2026-07-10 14:46 ` [PATCH 5/8] ref-manual/classes.rst: replace obsolete mailing list thread Antonin Godard
@ 2026-07-10 14:46 ` Antonin Godard
2026-07-10 14:46 ` [PATCH 7/8] migration-guides/release-notes-5.0.rst: remove broken link Antonin Godard
2026-07-10 14:46 ` [PATCH 8/8] docs-wide: fix various broken links Antonin Godard
7 siblings, 0 replies; 13+ messages in thread
From: Antonin Godard @ 2026-07-10 14:46 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni, Antonin Godard
VMWare Player has been discontinued in 2024 so remove the link. What
seems to be remaining is VMWare Fusions and Workstation so provide that
link only.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/ref-manual/images.rst | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/documentation/ref-manual/images.rst b/documentation/ref-manual/images.rst
index 94e412de3..37694d11f 100644
--- a/documentation/ref-manual/images.rst
+++ b/documentation/ref-manual/images.rst
@@ -36,10 +36,7 @@ Here is a list of supported recipes:
- ``build-appliance-image``: An example virtual machine that contains
all the pieces required to run builds using the build system as well
as the build system itself. You can boot and run the image using
- either the `VMware
- Player <https://www.vmware.com/products/player/overview.html>`__ or
- `VMware
- Workstation <https://www.vmware.com/products/workstation/overview.html>`__.
+ `VMware Workstation <https://www.vmware.com/products/desktop-hypervisor/workstation-and-fusion>`__.
For more information on this image, see the :yocto_home:`Build
Appliance </software-item/build-appliance>` page
on the Yocto Project website.
--
2.54.0
^ permalink raw reply related [flat|nested] 13+ messages in thread
* [PATCH 7/8] migration-guides/release-notes-5.0.rst: remove broken link
2026-07-10 14:46 [PATCH 0/8] Fix broken links Antonin Godard
` (5 preceding siblings ...)
2026-07-10 14:46 ` [PATCH 6/8] ref-manual/images.rst: update obsolete VMWare links Antonin Godard
@ 2026-07-10 14:46 ` Antonin Godard
2026-07-10 14:46 ` [PATCH 8/8] docs-wide: fix various broken links Antonin Godard
7 siblings, 0 replies; 13+ messages in thread
From: Antonin Godard @ 2026-07-10 14:46 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni, Antonin Godard
https://no-color.org seems down, so remove the link.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/migration-guides/release-notes-5.0.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/documentation/migration-guides/release-notes-5.0.rst b/documentation/migration-guides/release-notes-5.0.rst
index 908f1f6a2..61ea4aa5a 100644
--- a/documentation/migration-guides/release-notes-5.0.rst
+++ b/documentation/migration-guides/release-notes-5.0.rst
@@ -217,7 +217,7 @@ New Features / Enhancements in 5.0
state directory (i.e., ``/run``).
- Allow to disable colored text output through the
- `NO_COLOR <https://no-color.org/>`__ environment variable.
+ ``NO_COLOR`` environment variable.
- ``git-make-shallow`` script: add support for Git's ``safe.bareRepository=explicit``
configuration setting.
--
2.54.0
^ permalink raw reply related [flat|nested] 13+ messages in thread
* [PATCH 8/8] docs-wide: fix various broken links
2026-07-10 14:46 [PATCH 0/8] Fix broken links Antonin Godard
` (6 preceding siblings ...)
2026-07-10 14:46 ` [PATCH 7/8] migration-guides/release-notes-5.0.rst: remove broken link Antonin Godard
@ 2026-07-10 14:46 ` Antonin Godard
7 siblings, 0 replies; 13+ messages in thread
From: Antonin Godard @ 2026-07-10 14:46 UTC (permalink / raw)
To: docs; +Cc: Thomas Petazzoni, Antonin Godard
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.
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
---
documentation/dev-manual/new-recipe.rst | 2 +-
documentation/dev-manual/start.rst | 2 +-
documentation/dev-manual/x32-psabi.rst | 4 +--
.../migration-guides/release-notes-5.3.rst | 2 +-
.../overview-manual/development-environment.rst | 4 +--
documentation/profile-manual/usage.rst | 38 ++++++++++------------
documentation/ref-manual/classes.rst | 4 +--
documentation/ref-manual/variables.rst | 8 ++---
.../yocto-project-supported-features.rst | 2 +-
9 files changed, 31 insertions(+), 35 deletions(-)
diff --git a/documentation/dev-manual/new-recipe.rst b/documentation/dev-manual/new-recipe.rst
index 5f42dd4df..6888bb46a 100644
--- a/documentation/dev-manual/new-recipe.rst
+++ b/documentation/dev-manual/new-recipe.rst
@@ -837,7 +837,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 4ea27fceb..8fa7f8f38 100644
--- a/documentation/dev-manual/start.rst
+++ b/documentation/dev-manual/start.rst
@@ -367,7 +367,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 <https://docs.docker.com/engine/install/#supported-platforms>`__"
+ Platforms <https://docs.docker.com/engine/install/#installation-procedures-for-supported-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 92b1f96fa..0a19d2823 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 <https://software.intel.com/en-us/node/628948>`__) is a native
+x32 processor-specific Application Binary Interface (:wikipedia:`x32
+psABI <X32_ABI>`) 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/migration-guides/release-notes-5.3.rst b/documentation/migration-guides/release-notes-5.3.rst
index 1655ca90f..fdc092e51 100644
--- a/documentation/migration-guides/release-notes-5.3.rst
+++ b/documentation/migration-guides/release-notes-5.3.rst
@@ -561,7 +561,7 @@ New Features / Enhancements in |yocto-ver|
:term:`IMAGE_EXTRA_PARTITION_FILES` variable for more information.
- The ``--diskid`` option was added to allow passing a :wikipedia:`MS-DOS
- </MS-DOS>` or :wikipedia:`GPT <GUID_Partition_Table>`-formatted
+ <MS-DOS>` or :wikipedia:`GPT <GUID_Partition_Table>`-formatted
disk IDs for a partition (for example: ``deadbeef-cafe-babe-f00d-cec2ea4eface``).
- SDK-related changes:
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst
index e1bb8b15d..0daaf1c1a 100644
--- a/documentation/overview-manual/development-environment.rst
+++ b/documentation/overview-manual/development-environment.rst
@@ -350,7 +350,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
@@ -474,7 +474,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 <https://git-scm.com/documentation>`__.
+`here <https://git-scm.com/docs>`__.
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 d17b256d0..f8de6848e 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) <https://linux.die.net/man/1/perf>`__.
+: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 <https://linux.die.net/man/1/perf-script-python>`__.
+Documentation on using the :manpage:`'perf script' Python
+binding <perf-script-python(1)>`.
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 <https://linux.die.net/man/1/perf-stat>`__.
+- The :manpage:`'perf stat' manual page <perf-stat(1)>`.
-- The `'perf record'
- manual page <https://linux.die.net/man/1/perf-record>`__.
+- The :manpage:`'perf record' manual page <perf-record(1)>`.
-- The `'perf report'
- manual page <https://linux.die.net/man/1/perf-report>`__.
+- The :manpage:`'perf report' manual page <perf-report(1)>`.
-- The `'perf probe' manual page <https://linux.die.net/man/1/perf-probe>`__.
+- The :manpage:`'perf probe' manual page <perf-probe(1)>`.
-- The `'perf script'
- manual page <https://linux.die.net/man/1/perf-script>`__.
+- The :manpage:`'perf script' manual page <perf-script(1)>`.
-- Documentation on using the `'perf script' Python
- binding <https://linux.die.net/man/1/perf-script-python>`__.
+- Documentation on using the :manpage:`'perf script' Python binding <perf-script-python(1)>`.
-- The top-level `perf(1) manual page <https://linux.die.net/man/1/perf>`__.
+- The top-level :manpage:`perf(1) manual page <perf(1)>`.
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 <https://sourceware.org/systemtap/tutorial/>`__ just prints a
+tutorial <https://sourceware.org/systemtap/tutorial.html>`__ 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 <https://sourceware.org/systemtap/langref/>`__
+Reference <https://sourceware.org/systemtap/langref.html>`__
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 <https://linux.die.net/man/1/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 02ff36178..2622be14f 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -2844,7 +2844,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 <https://github.com/pypa/setuptools/blob/main/CHANGES.rst#v5830>`__
+`deprecated <https://github.com/pypa/setuptools/blob/14cc4452199818e60cf01cd9cea96e90761abce7/NEWS.rst#v5830>`__
but still relatively common.
.. _ref-classes-setuptools3-base:
@@ -3100,7 +3100,7 @@ the :term:`SYSTEMD_BOOT_CFG`,
:term:`SYSTEMD_BOOT_TIMEOUT` variables.
You can also see the `Systemd-boot
-documentation <https://www.freedesktop.org/wiki/Software/systemd/systemd-boot/>`__
+documentation <https://systemd.io/BOOT/>`__
for more information.
.. _ref-classes-terminal:
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 12d2e335c..c1abd8693 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3786,7 +3786,7 @@ system and gives an overview of their function and contents.
source $loadaddr#bootscr-boot.cmd
More information can be found in the official U-Boot documentation:
- `U-Boot source command <https://docs.u-boot.org/en/latest/usage/cmd/source.html#fit-image.f>`__
+ `U-Boot source command <https://docs.u-boot.org/en/latest/usage/cmd/source.html#fit-image>`__
:term:`FONT_EXTRA_RDEPENDS`
When inheriting the :ref:`ref-classes-fontcache` class,
@@ -3953,7 +3953,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`
Deprecated in favor of :term:`USERMOD_PARAMS`. See
@@ -6436,7 +6436,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 <https://linux.die.net/man/5/modprobe.d>`__
+ Specifies :manpage:`modprobe.d(5)`
syntax lines for inclusion in the ``/etc/modprobe.d/modname.conf``
file.
@@ -12333,7 +12333,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
diff --git a/documentation/ref-manual/yocto-project-supported-features.rst b/documentation/ref-manual/yocto-project-supported-features.rst
index 021fca36b..d7229f1c2 100644
--- a/documentation/ref-manual/yocto-project-supported-features.rst
+++ b/documentation/ref-manual/yocto-project-supported-features.rst
@@ -72,7 +72,7 @@ Below is a list of primary tested features, their maintainer(s) and builder(s):
- Buildtools generation
- Collective effort
- buildtools
- * - `meta-agl-core <https://gerrit.automotivelinux.org/gerrit/AGL/meta-agl>`__
+ * - `meta-agl-core <https://git.automotivelinux.org/AGL/meta-agl/>`__
- meta-agl-core layer testing
- TBD
- meta-agl-core
--
2.54.0
^ permalink raw reply related [flat|nested] 13+ messages in thread
* Re: [docs] [PATCH 1/8] conf.py: add linkcheck builder exclusions
2026-07-10 14:46 ` [PATCH 1/8] conf.py: add linkcheck builder exclusions Antonin Godard
@ 2026-07-10 15:09 ` Quentin Schulz
2026-07-15 12:30 ` Antonin Godard
0 siblings, 1 reply; 13+ messages in thread
From: Quentin Schulz @ 2026-07-10 15:09 UTC (permalink / raw)
To: antonin.godard, docs; +Cc: Thomas Petazzoni
Hi Antonin,
On 7/10/26 4:46 PM, Antonin Godard via lists.yoctoproject.org wrote:
> The linkcheck builder can be used to scout for broken links. By looking at
> the output of:
>
> grep -E -r --no-filename -o 'href="http.://[^/"]+' | sort | uniq -c | sort -nr
>
> from the HTML output directory, exclude links that are too frequent.
Because they are too frequent it's impossible they are broken?
Considering you fix links that are in this list later in this series, I
don't think this holds. At least provide a proper justification because
"too frequent" doesn't make sense.
Cheers,
Quentin
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: [docs] [PATCH 2/8] conf.py: add extra links known to be broken
2026-07-10 14:46 ` [PATCH 2/8] conf.py: add extra links known to be broken Antonin Godard
@ 2026-07-10 15:13 ` Quentin Schulz
2026-07-15 12:30 ` Antonin Godard
0 siblings, 1 reply; 13+ messages in thread
From: Quentin Schulz @ 2026-07-10 15:13 UTC (permalink / raw)
To: antonin.godard, docs; +Cc: Thomas Petazzoni
Hi Antonin,
On 7/10/26 4:46 PM, Antonin Godard via lists.yoctoproject.org wrote:
> Those links are broken, yet our documentation still has references to them
> we want to keep, namely in release notes. Make the linkcheck ignore them.
>
> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
> ---
> documentation/conf.py | 10 ++++++++++
> 1 file changed, 10 insertions(+)
>
> diff --git a/documentation/conf.py b/documentation/conf.py
> index aff01c1ed..a5b0add8f 100644
> --- a/documentation/conf.py
> +++ b/documentation/conf.py
> @@ -156,6 +156,16 @@ linkcheck_ignore = [
> r'https?://mirrors\.edge\.kernel\.org.*'
> ]
>
> +# Those link are known to be dead, yet we want to keep them in our documentation
> +# because they still hold value in the context in which they were used (e.g. in
> +# release notes).
> +linkcheck_ignore += [
> + r'https?://linuxkernelcves\.com.*',
> + r'https?://gpe\.linuxtogo\.org.*',
> + r'https?://jk\.ozlabs\.org/projects/patchwork.*',
> + r'https?://rlbl\.me/prelink.*',
> +]
> +
How about we replace them with archive links instead? e.g. from
web.archive.org?
For patchwork, point at https://patchwork.ozlabs.org/project/patchwork/
instead maybe or https://github.com/getpatchwork/patchwork?
Cheers,
Quentin
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: [docs] [PATCH 1/8] conf.py: add linkcheck builder exclusions
2026-07-10 15:09 ` [docs] " Quentin Schulz
@ 2026-07-15 12:30 ` Antonin Godard
0 siblings, 0 replies; 13+ messages in thread
From: Antonin Godard @ 2026-07-15 12:30 UTC (permalink / raw)
To: quentin.schulz, docs; +Cc: Thomas Petazzoni
Hi,
On Fri Jul 10, 2026 at 5:09 PM CEST, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Antonin,
>
> On 7/10/26 4:46 PM, Antonin Godard via lists.yoctoproject.org wrote:
>> The linkcheck builder can be used to scout for broken links. By looking at
>> the output of:
>>
>> grep -E -r --no-filename -o 'href="http.://[^/"]+' | sort | uniq -c | sort -nr
>>
>> from the HTML output directory, exclude links that are too frequent.
>
> Because they are too frequent it's impossible they are broken?
> Considering you fix links that are in this list later in this series, I
> don't think this holds. At least provide a proper justification because
> "too frequent" doesn't make sense.
I see your point. I did not want to hammer those websites, that is all. I'll
drop this patch I think. Maybe I could add this but commented out, in case
someone also wants to apply those exclusions.
Antonin
^ permalink raw reply [flat|nested] 13+ messages in thread
* Re: [docs] [PATCH 2/8] conf.py: add extra links known to be broken
2026-07-10 15:13 ` [docs] " Quentin Schulz
@ 2026-07-15 12:30 ` Antonin Godard
0 siblings, 0 replies; 13+ messages in thread
From: Antonin Godard @ 2026-07-15 12:30 UTC (permalink / raw)
To: quentin.schulz, docs; +Cc: Thomas Petazzoni
Hi,
On Fri Jul 10, 2026 at 5:13 PM CEST, Quentin Schulz via lists.yoctoproject.org wrote:
> Hi Antonin,
>
> On 7/10/26 4:46 PM, Antonin Godard via lists.yoctoproject.org wrote:
>> Those links are broken, yet our documentation still has references to them
>> we want to keep, namely in release notes. Make the linkcheck ignore them.
>>
>> Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
>> ---
>> documentation/conf.py | 10 ++++++++++
>> 1 file changed, 10 insertions(+)
>>
>> diff --git a/documentation/conf.py b/documentation/conf.py
>> index aff01c1ed..a5b0add8f 100644
>> --- a/documentation/conf.py
>> +++ b/documentation/conf.py
>> @@ -156,6 +156,16 @@ linkcheck_ignore = [
>> r'https?://mirrors\.edge\.kernel\.org.*'
>> ]
>>
>> +# Those link are known to be dead, yet we want to keep them in our documentation
>> +# because they still hold value in the context in which they were used (e.g. in
>> +# release notes).
>> +linkcheck_ignore += [
>> + r'https?://linuxkernelcves\.com.*',
>> + r'https?://gpe\.linuxtogo\.org.*',
>> + r'https?://jk\.ozlabs\.org/projects/patchwork.*',
>> + r'https?://rlbl\.me/prelink.*',
>> +]
>> +
>
> How about we replace them with archive links instead? e.g. from
> web.archive.org?
>
> For patchwork, point at https://patchwork.ozlabs.org/project/patchwork/
> instead maybe or https://github.com/getpatchwork/patchwork?
Good point, I'll try and replace those in a separate series, thanks!
Antonin
^ permalink raw reply [flat|nested] 13+ messages in thread
end of thread, other threads:[~2026-07-15 12:30 UTC | newest]
Thread overview: 13+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-07-10 14:46 [PATCH 0/8] Fix broken links Antonin Godard
2026-07-10 14:46 ` [PATCH 1/8] conf.py: add linkcheck builder exclusions Antonin Godard
2026-07-10 15:09 ` [docs] " Quentin Schulz
2026-07-15 12:30 ` Antonin Godard
2026-07-10 14:46 ` [PATCH 2/8] conf.py: add extra links known to be broken Antonin Godard
2026-07-10 15:13 ` [docs] " Quentin Schulz
2026-07-15 12:30 ` Antonin Godard
2026-07-10 14:46 ` [PATCH 3/8] migration-guides/release-notes-3.4.2.rst: fix a broken link Antonin Godard
2026-07-10 14:46 ` [PATCH 4/8] docs-wide: fix broken path links Antonin Godard
2026-07-10 14:46 ` [PATCH 5/8] ref-manual/classes.rst: replace obsolete mailing list thread Antonin Godard
2026-07-10 14:46 ` [PATCH 6/8] ref-manual/images.rst: update obsolete VMWare links Antonin Godard
2026-07-10 14:46 ` [PATCH 7/8] migration-guides/release-notes-5.0.rst: remove broken link Antonin Godard
2026-07-10 14:46 ` [PATCH 8/8] docs-wide: fix various broken links Antonin Godard
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.