diff options
| author | Mauro Carvalho Chehab <mchehab+huawei@kernel.org> | 2025-02-11 08:57:57 +0300 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2025-02-13 19:47:44 +0300 |
| commit | de61d6515baece4610e401d9d7c18cac6bd77198 (patch) | |
| tree | e350a41a90e077a83ef0d07ffdf829e72e657fc2 /scripts/lib/abi/abi_parser.py | |
| parent | 6a0c4b61e13f9ab1d6395823fb06b0763eb370bd (diff) | |
| download | linux-de61d6515baece4610e401d9d7c18cac6bd77198.tar.xz | |
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>
Diffstat (limited to 'scripts/lib/abi/abi_parser.py')
| -rw-r--r-- | scripts/lib/abi/abi_parser.py | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/scripts/lib/abi/abi_parser.py b/scripts/lib/abi/abi_parser.py index f08de6d3bf7c..66a738013ce1 100644 --- a/scripts/lib/abi/abi_parser.py +++ b/scripts/lib/abi/abi_parser.py @@ -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: |