[PATCH 15/27] docs: sphinx/kernel_abi: use AbiParser directly
From: Mauro Carvalho Chehab
Date: Mon Feb 10 2025 - 05:20:19 EST
Instead of running get_abi.py script, import AbiParser class and
handle messages directly there using an interactor. This shold save some
memory, as there's no need to exec python inside the Sphinx python
extension.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
---
Documentation/sphinx/kernel_abi.py | 29 ++++++++++++++++-------------
scripts/lib/abi/abi_parser.py | 2 +-
2 files changed, 17 insertions(+), 14 deletions(-)
diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py
index f314b888d3de..f7b22abebcf4 100644
--- a/Documentation/sphinx/kernel_abi.py
+++ b/Documentation/sphinx/kernel_abi.py
@@ -34,7 +34,6 @@ u"""
import os
import re
-import subprocess
import sys
from docutils import nodes
@@ -43,6 +42,11 @@ from docutils.parsers.rst import directives, Directive
from sphinx.util.docutils import switch_source_input
from sphinx.util import logging
+srctree = os.path.abspath(os.environ["srctree"])
+sys.path.insert(0, os.path.join(srctree, "scripts/lib/abi"))
+
+from abi_parser import AbiParser
+
__version__ = "1.0"
@@ -66,7 +70,7 @@ class KernelCmd(Directive):
logger = logging.getLogger('kernel_abi')
option_spec = {
- "debug" : directives.flag,
+ "debug": directives.flag,
}
def run(self):
@@ -74,20 +78,19 @@ class KernelCmd(Directive):
if not doc.settings.file_insertion_enabled:
raise self.warning("docutils: file insertion disabled")
- srctree = os.path.abspath(os.environ["srctree"])
+ path = os.path.join(srctree, "Documentation", self.arguments[0])
+ parser = AbiParser(path, logger=self.logger)
+ parser.parse_abi()
+ parser.check_issues()
- args = [
- os.path.join(srctree, 'scripts/get_abi.py'),
- '-D', os.path.join(srctree, 'Documentation', self.arguments[0]),
- 'rest',
- '--enable-lineno',
- ]
+ msg = ""
+ for m in parser.doc(enable_lineno=True, show_file=True):
+ msg += m
- lines = subprocess.check_output(args, cwd=os.path.dirname(doc.current_source)).decode('utf-8')
- nodeList = self.nestedParse(lines, self.arguments[0])
- return nodeList
+ node = self.nested_parse(msg, self.arguments[0])
+ return node
- def nestedParse(self, lines, fname):
+ def nested_parse(self, lines, fname):
env = self.state.document.settings.env
content = ViewList()
node = nodes.section()
diff --git a/scripts/lib/abi/abi_parser.py b/scripts/lib/abi/abi_parser.py
index 960e27161c26..57c125fd40a5 100644
--- a/scripts/lib/abi/abi_parser.py
+++ b/scripts/lib/abi/abi_parser.py
@@ -427,7 +427,7 @@ class AbiParser:
return new_desc + "\n\n"
- def doc(self, enable_lineno, output_in_txt, show_file=False):
+ def doc(self, enable_lineno, output_in_txt=False, show_file=False):
"""Print ABI at stdout"""
part = None
--
2.48.1