linux/Documentation/sphinx
Mauro Carvalho Chehab 2b16b71a05 sphinx: kernel_abi: fix performance regression with O=<dir>
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@gmail.com>
Closes: https://lore.kernel.org/linux-doc/c174f7c5-ec21-4eae-b1c3-f643cca90d9d@gmail.com/
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Tested-by: Akira Yokosawa <akiyks@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/e25673d87357457bc54ee863e97ff8f75956580d.1752752211.git.mchehab+huawei@kernel.org
2025-07-24 08:36:17 -06:00
..
templates docs/sphinx: Fix TOC scroll hack for the home page 2024-01-23 14:33:13 -07:00
automarkup.py docs: sphinx: avoid using the deprecated node.set_class() 2025-06-21 13:18:03 -06:00
cdomain.py docs: sphinx: add missing SPDX tags 2025-06-25 12:39:17 -06:00
kernel_abi.py sphinx: kernel_abi: fix performance regression with O=<dir> 2025-07-24 08:36:17 -06:00
kernel_feat.py docs: extensions: don't use utf-8 syntax for descriptions 2025-02-13 11:33:32 -07:00
kernel_include.py docs: sphinx: add missing SPDX tags 2025-06-25 12:39:17 -06:00
kerneldoc-preamble.sty docs: kerneldoc-preamble.sty: Suppress extra spaces in CJK literal blocks 2024-09-05 14:16:41 -06:00
kerneldoc.py docs: kdoc: Remove a Python 2 comment 2025-07-08 08:06:25 -06:00
kfigure.py docs: sphinx: add missing SPDX tags 2025-06-25 12:39:17 -06:00
load_config.py docs: sphinx: add missing SPDX tags 2025-06-25 12:39:17 -06:00
maintainers_include.py docs: extensions: don't use utf-8 syntax for descriptions 2025-02-13 11:33:32 -07:00
min_requirements.txt docs: sphinx: add missing SPDX tags 2025-06-25 12:39:17 -06:00
parallel-wrapper.sh docs: Fix empty parallelism argument 2020-02-25 03:11:04 -07:00
parse-headers.pl docs: sphinx: add missing SPDX tags 2025-06-25 12:39:17 -06:00
requirements.txt docs: sphinx: add missing SPDX tags 2025-06-25 12:39:17 -06:00
rstFlatTable.py docs: sphinx: add missing SPDX tags 2025-06-25 12:39:17 -06:00
translations.py docs: translations: use attribute to store current language 2024-02-21 13:41:37 -07:00