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>
This commit is contained in:
Mauro Carvalho Chehab 2025-02-11 06:57:57 +01:00 committed by Jonathan Corbet
parent 6a0c4b61e1
commit de61d6515b
4 changed files with 5 additions and 9 deletions

View File

@ -1,4 +1,5 @@
This directory attempts to document the ABI between the Linux kernel and
This part of the documentation inside Documentation/ABI directory
attempts to document the ABI between the Linux kernel and
userspace, and the relative stability of these interfaces. Due to the
everchanging nature of Linux, and the differing maturity levels, these
interfaces should be used by userspace programs in different ways.

View File

@ -1,6 +0,0 @@
.. SPDX-License-Identifier: GPL-2.0
ABI README
==========
.. kernel-abi:: README

View File

@ -4,6 +4,8 @@
Linux ABI description
=====================
.. kernel-abi:: README
ABI symbols
-----------
@ -21,7 +23,6 @@ ABI files
.. toctree::
:maxdepth: 2
abi-readme-file
abi-stable-files
abi-testing-files
abi-obsolete-files

View File

@ -266,7 +266,7 @@ class AbiParser:
def parse_readme(self, nametag, fname):
"""Parse ABI README file"""
nametag["what"] = ["ABI file contents"]
nametag["what"] = ["Introduction"]
nametag["path"] = "README"
with open(fname, "r", encoding="utf8", errors="backslashreplace") as fp:
for line in fp: