summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab+huawei@kernel.org>2025-02-10 11:18:01 +0100
committerJonathan Corbet <corbet@lwn.net>2025-02-10 11:19:56 -0700
commit9d7ec8867960d731143280eb86d21a994fffb3de (patch)
tree984842ea5b98a94f6fed7b9ed7b8941468a79c2e
parent6b48bea16848dd7c771411db3dcc01b3bc4dd4c2 (diff)
docs: use get_abi.py for ABI generation
Use the new script instead of the old one when generating ABI docs. For now, execute it via exec. Future changes will better integrate it by using the class defined there directly. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/e7fcb121c0612c94f6f54f0d742cd3a26a46cd7d.1739182025.git.mchehab+huawei@kernel.org
-rw-r--r--Documentation/admin-guide/abi-obsolete.rst1
-rw-r--r--Documentation/admin-guide/abi-removed.rst1
-rw-r--r--Documentation/admin-guide/abi-stable.rst1
-rw-r--r--Documentation/admin-guide/abi-testing.rst1
-rw-r--r--Documentation/sphinx/kernel_abi.py10
5 files changed, 3 insertions, 11 deletions
diff --git a/Documentation/admin-guide/abi-obsolete.rst b/Documentation/admin-guide/abi-obsolete.rst
index b655615917f1..6d4d9ab7b8c3 100644
--- a/Documentation/admin-guide/abi-obsolete.rst
+++ b/Documentation/admin-guide/abi-obsolete.rst
@@ -10,4 +10,3 @@ The description of the interface will document the reason why it is
obsolete and when it can be expected to be removed.
.. kernel-abi:: ABI/obsolete
- :rst:
diff --git a/Documentation/admin-guide/abi-removed.rst b/Documentation/admin-guide/abi-removed.rst
index ba941c1af178..9fc78af6f077 100644
--- a/Documentation/admin-guide/abi-removed.rst
+++ b/Documentation/admin-guide/abi-removed.rst
@@ -4,4 +4,3 @@ ABI removed symbols
===================
.. kernel-abi:: ABI/removed
- :rst:
diff --git a/Documentation/admin-guide/abi-stable.rst b/Documentation/admin-guide/abi-stable.rst
index 5d738f345333..c47c2a295865 100644
--- a/Documentation/admin-guide/abi-stable.rst
+++ b/Documentation/admin-guide/abi-stable.rst
@@ -13,4 +13,3 @@ Most interfaces (like syscalls) are expected to never change and always
be available.
.. kernel-abi:: ABI/stable
- :rst:
diff --git a/Documentation/admin-guide/abi-testing.rst b/Documentation/admin-guide/abi-testing.rst
index a867e6578bf7..40b31985e587 100644
--- a/Documentation/admin-guide/abi-testing.rst
+++ b/Documentation/admin-guide/abi-testing.rst
@@ -19,4 +19,3 @@ name to the description of these interfaces, so that the kernel
developers can easily notify them if any changes occur.
.. kernel-abi:: ABI/testing
- :rst:
diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py
index 38653f5706c0..f314b888d3de 100644
--- a/Documentation/sphinx/kernel_abi.py
+++ b/Documentation/sphinx/kernel_abi.py
@@ -14,7 +14,7 @@ u"""
:license: GPL Version 2, June 1991 see Linux/COPYING for details.
The ``kernel-abi`` (:py:class:`KernelCmd`) directive calls the
- scripts/get_abi.pl script to parse the Kernel ABI files.
+ scripts/get_abi.py script to parse the Kernel ABI files.
Overview of directive's argument and options.
@@ -67,7 +67,6 @@ class KernelCmd(Directive):
option_spec = {
"debug" : directives.flag,
- "rst" : directives.unchanged
}
def run(self):
@@ -78,15 +77,12 @@ class KernelCmd(Directive):
srctree = os.path.abspath(os.environ["srctree"])
args = [
- os.path.join(srctree, 'scripts/get_abi.pl'),
+ os.path.join(srctree, 'scripts/get_abi.py'),
+ '-D', os.path.join(srctree, 'Documentation', self.arguments[0]),
'rest',
'--enable-lineno',
- '--dir', os.path.join(srctree, 'Documentation', self.arguments[0]),
]
- if 'rst' in self.options:
- args.append('--rst-source')
-
lines = subprocess.check_output(args, cwd=os.path.dirname(doc.current_source)).decode('utf-8')
nodeList = self.nestedParse(lines, self.arguments[0])
return nodeList