[PATCH 1/1] doc: harmonize Linux kernel documentation links
Heinrich Schuchardt
heinrich.schuchardt at canonical.com
Sun Jul 9 04:02:14 CEST 2023
Linux internally uses https://www.kernel.org/doc/html/latest/ for
documentation links. When referring to their documentation we should do the
same.
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
---
doc/develop/docstyle.rst | 2 +-
doc/usage/blkmap.rst | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/doc/develop/docstyle.rst b/doc/develop/docstyle.rst
index f9ba83a559..50506d6857 100644
--- a/doc/develop/docstyle.rst
+++ b/doc/develop/docstyle.rst
@@ -20,7 +20,7 @@ We apply the following rules:
* For documentation we use reStructured text conforming to the requirements
of `Sphinx <https://www.sphinx-doc.org>`_.
* For documentation within code we follow the Linux kernel guide
- `Writing kernel-doc comments <https://docs.kernel.org/doc-guide/kernel-doc.html>`_.
+ `Writing kernel-doc comments <https://www.kernel.org/doc/html/latest/doc-guide/kernel-doc.html>`_.
* We try to stick to 80 columns per line in documents.
* For tables we prefer simple tables over grid tables. We avoid list tables
as they make the reStructured text documents hard to read.
diff --git a/doc/usage/blkmap.rst b/doc/usage/blkmap.rst
index dbfa8e5aad..7337ea507a 100644
--- a/doc/usage/blkmap.rst
+++ b/doc/usage/blkmap.rst
@@ -19,7 +19,7 @@ wherever they might be located.
The implementation is loosely modeled on Linux's "Device Mapper"
subsystem, see `kernel documentation`_ for more information.
-.. _kernel documentation: https://docs.kernel.org/admin-guide/device-mapper/index.html
+.. _kernel documentation: https://www.kernel.org/doc/html/latest/admin-guide/device-mapper/index.html
Example: Netbooting an Ext4 Image
--
2.40.1
More information about the U-Boot
mailing list