Djam/u-boot
1
0
Fork 0
mirror of https://github.com/u-boot/u-boot.git synced 2025-04-30 16:35:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: harmonize Linux kernel documentation links

Browse source 
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@canonical.com>
This commit is contained in:
Heinrich Schuchardt 2023-07-09 04:00:06 +02:00
parent 0c95744bcc
commit fefb7e1e3d
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/develop/docstyle.rst
View file

@ -20,7 +20,7 @@ We apply the following rules:
* For documentation we use reStructured text conforming to the requirements * For documentation we use reStructured text conforming to the requirements
of `Sphinx <https://www.sphinx-doc.org>`_. of `Sphinx <https://www.sphinx-doc.org>`_.
* For documentation within code we follow the Linux kernel guide * 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. * We try to stick to 80 columns per line in documents.
* For tables we prefer simple tables over grid tables. We avoid list tables * For tables we prefer simple tables over grid tables. We avoid list tables
as they make the reStructured text documents hard to read. as they make the reStructured text documents hard to read.

2
doc/usage/blkmap.rst
View file

@ -19,7 +19,7 @@ wherever they might be located.
The implementation is loosely modeled on Linux's "Device Mapper" The implementation is loosely modeled on Linux's "Device Mapper"
subsystem, see `kernel documentation`_ for more information. 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 Example: Netbooting an Ext4 Image