From 9fa4ee7c1af35f0096a0da47d3fd74ef5fc73ff5 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Mon, 19 Jan 2026 17:23:19 +0100 Subject: [PATCH] docs: add kabi modules documentation Place kernel abi modules documentation at Linux Kernel docs. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: --- Documentation/tools/kabi.rst | 13 +++++++++++++ Documentation/tools/kabi_helpers.rst | 11 +++++++++++ Documentation/tools/kabi_parser.rst | 10 ++++++++++ Documentation/tools/kabi_regex.rst | 10 ++++++++++ Documentation/tools/kabi_symbols.rst | 10 ++++++++++ Documentation/tools/python.rst | 1 + 6 files changed, 55 insertions(+) create mode 100644 Documentation/tools/kabi.rst create mode 100644 Documentation/tools/kabi_helpers.rst create mode 100644 Documentation/tools/kabi_parser.rst create mode 100644 Documentation/tools/kabi_regex.rst create mode 100644 Documentation/tools/kabi_symbols.rst diff --git a/Documentation/tools/kabi.rst b/Documentation/tools/kabi.rst new file mode 100644 index 0000000000000..92812a20fcf72 --- /dev/null +++ b/Documentation/tools/kabi.rst @@ -0,0 +1,13 @@ +.. SPDX-License-Identifier: GPL-2.0 + +===================================== +Kernel ABI documentation tool modules +===================================== + +.. toctree:: + :maxdepth: 2 + + kabi_parser + kabi_regex + kabi_symbols + kabi_helpers diff --git a/Documentation/tools/kabi_helpers.rst b/Documentation/tools/kabi_helpers.rst new file mode 100644 index 0000000000000..5c6ec60815007 --- /dev/null +++ b/Documentation/tools/kabi_helpers.rst @@ -0,0 +1,11 @@ +.. SPDX-License-Identifier: GPL-2.0 + +================= +Ancillary classes +================= + +.. automodule:: lib.python.abi.helpers + :members: + :member-order: bysource + :show-inheritance: + :undoc-members: diff --git a/Documentation/tools/kabi_parser.rst b/Documentation/tools/kabi_parser.rst new file mode 100644 index 0000000000000..95826da21b3d8 --- /dev/null +++ b/Documentation/tools/kabi_parser.rst @@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0 + +===================================== +Kernel ABI documentation parser class +===================================== + +.. automodule:: lib.python.abi.abi_parser + :members: + :show-inheritance: + :undoc-members: diff --git a/Documentation/tools/kabi_regex.rst b/Documentation/tools/kabi_regex.rst new file mode 100644 index 0000000000000..bfc3a0d91c47f --- /dev/null +++ b/Documentation/tools/kabi_regex.rst @@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============================= +ABI regex search symbol class +============================= + +.. automodule:: lib.python.abi.abi_regex + :members: + :show-inheritance: + :undoc-members: diff --git a/Documentation/tools/kabi_symbols.rst b/Documentation/tools/kabi_symbols.rst new file mode 100644 index 0000000000000..c75a9380f89fd --- /dev/null +++ b/Documentation/tools/kabi_symbols.rst @@ -0,0 +1,10 @@ +.. SPDX-License-Identifier: GPL-2.0 + +========================================= +System ABI documentation validation class +========================================= + +.. automodule:: lib.python.abi.system_symbols + :members: + :show-inheritance: + :undoc-members: diff --git a/Documentation/tools/python.rst b/Documentation/tools/python.rst index e826787ce9dd6..978298fba6d30 100644 --- a/Documentation/tools/python.rst +++ b/Documentation/tools/python.rst @@ -8,3 +8,4 @@ Python libraries :maxdepth: 4 kdoc + kabi -- 2.47.3