Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: ABI: move README contents to the top

The ABI documentation looks a little bit better if it starts
with the contents of the README is placed at the beginning.

Move it to the beginning of the ABI chapter. While here, improve
the README text and change the title that will be shown at the
html/pdf output to be coherent with both ABI file contents and
with the generated documentation output.

Suggested-by: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/20250211055809.1898623-1-mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
de61d651 6a0c4b61

+5 -9
+2 -1
Documentation/ABI/README
··· 1 - This directory attempts to document the ABI between the Linux kernel and 1 + This part of the documentation inside Documentation/ABI directory 2 + attempts to document the ABI between the Linux kernel and 2 3 userspace, and the relative stability of these interfaces. Due to the 3 4 everchanging nature of Linux, and the differing maturity levels, these 4 5 interfaces should be used by userspace programs in different ways.
-6
Documentation/admin-guide/abi-readme-file.rst
··· 1 - .. SPDX-License-Identifier: GPL-2.0 2 - 3 - ABI README 4 - ========== 5 - 6 - .. kernel-abi:: README
+2 -1
Documentation/admin-guide/abi.rst
··· 4 4 Linux ABI description 5 5 ===================== 6 6 7 + .. kernel-abi:: README 8 + 7 9 ABI symbols 8 10 ----------- 9 11 ··· 23 21 .. toctree:: 24 22 :maxdepth: 2 25 23 26 - abi-readme-file 27 24 abi-stable-files 28 25 abi-testing-files 29 26 abi-obsolete-files
+1 -1
scripts/lib/abi/abi_parser.py
··· 266 266 def parse_readme(self, nametag, fname): 267 267 """Parse ABI README file""" 268 268 269 - nametag["what"] = ["ABI file contents"] 269 + nametag["what"] = ["Introduction"] 270 270 nametag["path"] = "README" 271 271 with open(fname, "r", encoding="utf8", errors="backslashreplace") as fp: 272 272 for line in fp: