superrob1500
/
mirror-linux
mirror of https://github.com/torvalds/linux
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: admin-guide/abi: split files from symbols 

Now that get_abi has gained support for filtering its output,
split ABI symbols from files at the html output.

That makes pages smaller and easier to navigate.

As an additional bonus, as it will paralelize files handling,
it gives an additional performance improvement.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/30e3cf2a8aeef23ca889de60a90f7de141e0dc0e.1739182025.git.mchehab+huawei@kernel.org
pull/1183/head
Mauro Carvalho Chehab 2025-02-10 11:18:10 +01:00 committed by Jonathan Corbet
parent 5d7871d77f
commit 4bb2dbd757
10 changed files with 53 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/admin-guide/abi-obsolete-files.rst Normal file
View File

@ -0,0 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0
Obsolete ABI Files
==================
.. kernel-abi:: obsolete
:no-symbols:

1
Documentation/admin-guide/abi-obsolete.rst
View File

@ -10,3 +10,4 @@ The description of the interface will document the reason why it is
obsolete and when it can be expected to be removed.
.. kernel-abi:: obsolete
:no-files:

6
Documentation/admin-guide/abi-readme-file.rst Normal file
View File

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

7
Documentation/admin-guide/abi-removed-files.rst Normal file
View File

@ -0,0 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0
Removed ABI Files
=================
.. kernel-abi:: removed
:no-symbols:

1
Documentation/admin-guide/abi-removed.rst
View File

@ -4,3 +4,4 @@ ABI removed symbols
===================
.. kernel-abi:: removed
:no-files:

7
Documentation/admin-guide/abi-stable-files.rst Normal file
View File

@ -0,0 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0
Stable ABI Files
================
.. kernel-abi:: stable
:no-symbols:

1
Documentation/admin-guide/abi-stable.rst
View File

@ -13,3 +13,4 @@ Most interfaces (like syscalls) are expected to never change and always
be available.
.. kernel-abi:: stable
:no-files:

7
Documentation/admin-guide/abi-testing-files.rst Normal file
View File

@ -0,0 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0
Testing ABI Files
=================
.. kernel-abi:: testing
:no-symbols:

1
Documentation/admin-guide/abi-testing.rst
View File

@ -19,3 +19,4 @@ name to the description of these interfaces, so that the kernel
developers can easily notify them if any changes occur.
.. kernel-abi:: testing
:no-files:

15
Documentation/admin-guide/abi.rst
View File

@ -4,6 +4,9 @@
Linux ABI description
=====================
ABI symbols
-----------
.. toctree::
:maxdepth: 2
@ -11,3 +14,15 @@ Linux ABI description
abi-testing
abi-obsolete
abi-removed
ABI files
---------
.. toctree::
:maxdepth: 2
abi-readme-file
abi-stable-files
abi-testing-files
abi-obsolete-files
abi-removed-files