From 0bbb4189d0b5d6f016d2de8bb770acf5bdacd542 Mon Sep 17 00:00:00 2001 From: Ben Hutchings Date: Mon, 16 Sep 2024 00:07:04 +0200 Subject: [PATCH] Documentation: Use relative source filenames in ABI documentation Currently the ABI documentation files contain absolute source filenames, which makes them unreproducible if the build directory can vary. Remove the source base directory ($srctree) from the source filenames shown in the documentation. Signed-off-by: Ben Hutchings Gbp-Pq: Topic bugfix/all Gbp-Pq: Name documentation-use-relative-source-paths-in-abi-documentation.patch --- Documentation/sphinx/kernel_abi.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Documentation/sphinx/kernel_abi.py b/Documentation/sphinx/kernel_abi.py index 5911bd0d796..b52b4c8842c 100644 --- a/Documentation/sphinx/kernel_abi.py +++ b/Documentation/sphinx/kernel_abi.py @@ -103,6 +103,7 @@ class KernelCmd(Directive): lines = code_block + "\n\n" line_regex = re.compile(r"^\.\. LINENO (\S+)\#([0-9]+)$") + srctree = os.path.abspath(os.environ["srctree"]) ln = 0 n = 0 f = fname @@ -127,7 +128,7 @@ class KernelCmd(Directive): # sphinx counts lines from 0 ln = int(match.group(2)) - 1 else: - content.append(line, f, ln) + content.append(line, os.path.relpath(f, srctree), ln) kernellog.info(self.state.document.settings.env.app, "%s: parsed %i lines" % (fname, n)) -- 2.30.2