Skip to content

Commit 9fa4ee7

Browse files
mchehabJonathan Corbet
authored andcommitted
docs: add kabi modules documentation
Place kernel abi modules documentation at Linux Kernel docs. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <ddc02f11d64fdfc0d8d3e3e0967e041b5172da6c.1768838938.git.mchehab+huawei@kernel.org>
1 parent 333f602 commit 9fa4ee7

6 files changed

Lines changed: 55 additions & 0 deletions

File tree

Documentation/tools/kabi.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=====================================
4+
Kernel ABI documentation tool modules
5+
=====================================
6+
7+
.. toctree::
8+
:maxdepth: 2
9+
10+
kabi_parser
11+
kabi_regex
12+
kabi_symbols
13+
kabi_helpers
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=================
4+
Ancillary classes
5+
=================
6+
7+
.. automodule:: lib.python.abi.helpers
8+
:members:
9+
:member-order: bysource
10+
:show-inheritance:
11+
:undoc-members:
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=====================================
4+
Kernel ABI documentation parser class
5+
=====================================
6+
7+
.. automodule:: lib.python.abi.abi_parser
8+
:members:
9+
:show-inheritance:
10+
:undoc-members:

Documentation/tools/kabi_regex.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=============================
4+
ABI regex search symbol class
5+
=============================
6+
7+
.. automodule:: lib.python.abi.abi_regex
8+
:members:
9+
:show-inheritance:
10+
:undoc-members:
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. SPDX-License-Identifier: GPL-2.0
2+
3+
=========================================
4+
System ABI documentation validation class
5+
=========================================
6+
7+
.. automodule:: lib.python.abi.system_symbols
8+
:members:
9+
:show-inheritance:
10+
:undoc-members:

Documentation/tools/python.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Python libraries
88
:maxdepth: 4
99

1010
kdoc
11+
kabi

0 commit comments

Comments
 (0)