linux-kernel - Re: [PATCH v2] sphinx: kernel_abi: fix performance regression with O=<dir>

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <da247b68-12aa-43ed-83f4-65503bf90c74@gmail.com>
Date: Fri, 18 Jul 2025 09:50:55 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
 Linux Doc Mailing List <linux-doc@...r.kernel.org>,
 Jonathan Corbet <corbet@....net>
Cc: linux-kernel@...r.kernel.org, Akira Yokosawa <akiyks@...il.com>
Subject: Re: [PATCH v2] sphinx: kernel_abi: fix performance regression with
 O=<dir>

On Thu, 17 Jul 2025 13:37:19 +0200, Mauro Carvalho Chehab wrote:
> The logic there which adds a dependency note to Sphinx cache
> is not taking into account that the build dir may not be
> the source dir. This causes a performance regression:
> 
> $ time make O=/tmp/foo SPHINXDIRS=admin-guide htmldocs
> 
> 	[OUTDATED]
> 	Added: set()
> 	Changed: {'abi-obsolete', 'abi-removed', 'abi-stable-files', 'abi-obsolete-files', 'abi-stable', 'abi', 'abi-removed-files', 'abi-testing-files', 'abi-testing', 'gpio/index', 'gpio/obsolete'}
> 	Removed: set()
> 	All docs count: 385
> 	Found docs count: 385
> 
> 	real    0m11,324s
> 	user    0m15,783s
> 	sys     0m1,164s
> 
> To get the root cause of the problem (ABI files reported as changed),
> I used this changeset:
> 
> 	diff --git a/Documentation/conf.py b/Documentation/conf.py
> 	index e8766e689c1b..ab486623bd8b 100644
> 	--- a/Documentation/conf.py
> 	+++ b/Documentation/conf.py
> 	@@ -571,3 +571,16 @@ def setup(app):
> 	     """Patterns need to be updated at init time on older Sphinx versions"""
> 
> 	     app.connect('config-inited', update_patterns)
> 	+    app.connect('env-get-outdated', on_outdated)
> 	+
> 	+def on_outdated(app, env, added, changed, removed):
> 	+    """Track cache outdated due to added/changed/removed files"""
> 	+    print("\n[OUTDATED]")
> 	+    print(f"Added: {added}")
> 	+    print(f"Changed: {changed}")
> 	+    print(f"Removed: {removed}")
> 	+    print(f"All docs count: {len(env.all_docs)}")
> 	+    print(f"Found docs count: {len(env.found_docs)}")
> 	+
> 	+    # Just return what we have
> 	+    return added | changed | removed
> 
> Reported-by: Akira Yokosawa <akiyks@...il.com>
> Closes: https://lore.kernel.org/linux-doc/c174f7c5-ec21-4eae-b1c3-f643cca90d9d@gmail.com/
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>

Tested-by: Akira Yokosawa <akiyks@...il.com>

Thanks!

> ---
> v2: updated description. No changes at the diff itself
> 
[...]