]> www.infradead.org Git - users/jedix/linux-maple.git/commit
docs: ABI: move README contents to the top
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tue, 11 Feb 2025 05:57:57 +0000 (06:57 +0100)
committerJonathan Corbet <corbet@lwn.net>
Thu, 13 Feb 2025 16:47:44 +0000 (09:47 -0700)
commitde61d6515baece4610e401d9d7c18cac6bd77198
treee350a41a90e077a83ef0d07ffdf829e72e657fc2
parent6a0c4b61e13f9ab1d6395823fb06b0763eb370bd
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>
Documentation/ABI/README
Documentation/admin-guide/abi-readme-file.rst [deleted file]
Documentation/admin-guide/abi.rst
scripts/lib/abi/abi_parser.py