From 464257baf99200d1be1c053f15aa617056361e81 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 21 Nov 2025 12:05:28 +0100 Subject: [PATCH] docs: makefile: move rustdoc check to the build wrapper The makefile logic to detect if rust is enabled is not working the way it was expected: instead of using the current setup for CONFIG_RUST, it uses a cached version from a previous build. The root cause is that the current logic inside docs/Makefile uses a cached version of CONFIG_RUST, from the last time a non documentation target was executed. That's perfectly fine for Sphinx build, as it doesn't need to read or depend on any CONFIG_*. So, instead of relying at the cache, move the logic to the wrapper script and let it check the current content of .config, to verify if CONFIG_RUST was selected. Signed-off-by: Mauro Carvalho Chehab Signed-off-by: Jonathan Corbet Message-ID: --- Documentation/Makefile | 6 ----- tools/docs/sphinx-build-wrapper | 41 +++++++++++++++++++++++++-------- 2 files changed, 32 insertions(+), 15 deletions(-) diff --git a/Documentation/Makefile b/Documentation/Makefile index fda2bef8d9d8..e96ac6dcac4f 100644 --- a/Documentation/Makefile +++ b/Documentation/Makefile @@ -42,12 +42,6 @@ FONTS_CONF_DENY_VF ?= $(HOME)/deny-vf # User-friendly check for sphinx-build HAVE_SPHINX := $(shell if which $(SPHINXBUILD) >/dev/null 2>&1; then echo 1; else echo 0; fi) -ifneq ($(wildcard $(srctree)/.config),) -ifeq ($(CONFIG_RUST),y) - RUSTDOC=--rustdoc -endif -endif - ifeq ($(HAVE_SPHINX),0) .DEFAULT: diff --git a/tools/docs/sphinx-build-wrapper b/tools/docs/sphinx-build-wrapper index d4943d952e2a..7a5fcef25429 100755 --- a/tools/docs/sphinx-build-wrapper +++ b/tools/docs/sphinx-build-wrapper @@ -119,6 +119,29 @@ class SphinxBuilder: return path + def check_rust(self): + """ + Checks if Rust is enabled + """ + self.rustdoc = False + + config = os.path.join(self.srctree, ".config") + + if not os.path.isfile(config): + return + + re_rust = re.compile(r"CONFIG_RUST=(m|y)") + + try: + with open(config, "r", encoding="utf-8") as fp: + for line in fp: + if re_rust.match(line): + self.rustdoc = True + return + + except OSError as e: + print(f"Failed to open {config}", file=sys.stderr) + def get_sphinx_extra_opts(self, n_jobs): """ Get the number of jobs to be used for docs build passed via command @@ -236,6 +259,8 @@ class SphinxBuilder: self.get_sphinx_extra_opts(n_jobs) + self.check_rust() + # # If venv command line argument is specified, run Sphinx from venv # @@ -306,7 +331,7 @@ class SphinxBuilder: return subprocess.call(cmd, *args, **pwargs) - def handle_html(self, css, output_dir, rustdoc): + def handle_html(self, css, output_dir): """ Extra steps for HTML and epub output. @@ -327,7 +352,8 @@ class SphinxBuilder: except (OSError, IOError) as e: print(f"Warning: Failed to copy CSS: {e}", file=sys.stderr) - if rustdoc: + if self.rustdoc: + print("Building rust docs") if "MAKE" in self.env: cmd = [self.env["MAKE"]] else: @@ -622,7 +648,7 @@ class SphinxBuilder: shutil.rmtree(self.builddir, ignore_errors=True) def build(self, target, sphinxdirs=None, - theme=None, css=None, paper=None, deny_vf=None, rustdoc=False, + theme=None, css=None, paper=None, deny_vf=None, skip_sphinx=False): """ Build documentation using Sphinx. This is the core function of this @@ -671,7 +697,7 @@ class SphinxBuilder: args.extend(["-D", f"latex_elements.papersize={paper}paper"]) - if rustdoc: + if self.rustdoc: args.extend(["-t", "rustdoc"]) if not sphinxdirs: @@ -749,7 +775,7 @@ class SphinxBuilder: # Ensure that each html/epub output will have needed static files # if target in ["htmldocs", "epubdocs"]: - self.handle_html(css, output_dir, rustdoc) + self.handle_html(css, output_dir) # # Step 2: Some targets (PDF and info) require an extra step once @@ -804,9 +830,6 @@ def main(): parser.add_argument('--deny-vf', help="Configuration to deny variable fonts on pdf builds") - parser.add_argument('--rustdoc', action="store_true", - help="Enable rustdoc build. Requires CONFIG_RUST") - parser.add_argument("-v", "--verbose", action='store_true', help="place build in verbose mode") @@ -834,7 +857,7 @@ def main(): builder.build(args.target, sphinxdirs=args.sphinxdirs, theme=args.theme, css=args.css, paper=args.paper, - rustdoc=args.rustdoc, deny_vf=args.deny_vf, + deny_vf=args.deny_vf, skip_sphinx=args.skip_sphinx_build) if __name__ == "__main__":