summaryrefslogtreecommitdiff
path: root/tools
diff options
context:
space:
mode:
authorThomas Weißschuh <linux@weissschuh.net>2026-01-18 00:26:24 +0100
committerJonathan Corbet <corbet@lwn.net>2026-01-23 11:27:22 -0700
commitffb569d59c253399efb2345ddfefe7929cd7e2a8 (patch)
tree8e1702fc067aae66c20bcdcf9448457f6d8292b3 /tools
parent6f9a96cc96ea405e0f80fede761dc415e33364c7 (diff)
tools/docs: sphinx-build-wrapper: only generate rust docs when requested
When the user explicitly specifies SPHINXDIRS to build a specific subdirectory it is unexpected that the rust docs are also generated. Especially as their generation may dominate the execution time. Only generate the rust docs when they are part of the SPHINXDIRS requested by the user. 'rust/rustdocs' is not considered, as it is not a valid SPHINXDIRS anyways. Signed-off-by: Thomas Weißschuh <linux@weissschuh.net> Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Tested-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <20260118-docs-spurious-rust-v1-4-998e14b9ed9e@weissschuh.net>
Diffstat (limited to 'tools')
-rwxr-xr-xtools/docs/sphinx-build-wrapper7
1 files changed, 5 insertions, 2 deletions
diff --git a/tools/docs/sphinx-build-wrapper b/tools/docs/sphinx-build-wrapper
index 04eb300dab4a..78ff7ac202ef 100755
--- a/tools/docs/sphinx-build-wrapper
+++ b/tools/docs/sphinx-build-wrapper
@@ -119,12 +119,15 @@ class SphinxBuilder:
return path
- def check_rust(self):
+ def check_rust(self, sphinxdirs):
"""
Checks if Rust is enabled
"""
config = os.path.join(self.srctree, ".config")
+ if not {'.', 'rust'}.intersection(sphinxdirs):
+ return False
+
if not os.path.isfile(config):
return False
@@ -691,7 +694,7 @@ class SphinxBuilder:
args.extend(["-D", f"latex_elements.papersize={paper}paper"])
- rustdoc = self.check_rust()
+ rustdoc = self.check_rust(sphinxdirs_list)
if rustdoc:
args.extend(["-t", "rustdoc"])