diff mbox series

[2/8] conf.py: add extra links known to be broken

Message ID 20260710-linkcheck-v1-2-999168371d5e@bootlin.com
State New
Headers show
Series Fix broken links | expand

Commit Message

Antonin Godard July 10, 2026, 2:46 p.m. UTC
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(+)

Comments

Quentin Schulz July 10, 2026, 3:13 p.m. UTC | #1
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
diff mbox series

Patch

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