Skip to contentSkip to conversation

FAILED: patch "[PATCH] rust: kbuild: workaround `rustdoc` doctests modifier bug" failed to apply to 6.12-stable tree

PATCH In review [email protected] 3 participants 7 messages Nov 8, 2025 – Nov 10, 2025

Subsystems (2)
lore
Share & tools
lore

[email protected]

author maintainer
#0 lore raw

The patch below does not apply to the 6.12-stable tree.
If someone wants it applied there, or to any other stable or longterm tree, then please email the backport, including the original git commit id to <[email protected]>.

To reproduce the conflict and resubmit, you may use the following commands:

git fetch https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/ linux-6.12.y
git checkout FETCH_HEAD
git cherry-pick -x fad472efab0a805dd939f017c5b8669a786a4bcf
# <resolve conflicts, build, test, etc.>
git commit -s
git send-email --to '<[email protected]>' --in-reply-to '2025110805-fame-viability-c333@gregkh' --subject-prefix 'PATCH 6.12.y' HEAD^..

Possible dependencies:

thanks,

greg k-h

------------------ original commit in Linus's tree ------------------

From fad472efab0a805dd939f017c5b8669a786a4bcf Mon Sep 17 00:00:00 2001
From: Miguel Ojeda <[email protected]>
Date: Sun, 2 Nov 2025 22:28:53 +0100
Subject: [PATCH] rust: kbuild: workaround rustdoc doctests modifier bug

The rustdoc modifiers bug [1] was fixed in Rust 1.90.0 [2], for which we added a workaround in commit abbf9a449441 ("rust: workaround rustdoc target modifiers bug").

However, rustdoc's doctest generation still has a similar issue [3], being fixed at [4], which does not affect us because we apply the workaround to both, and now, starting with Rust 1.91.0 (released 2025-10-30), -Zsanitizer is a target modifier too [5], which means we fail with:

RUSTDOC TK rust/kernel/lib.rs
error: mixing -Zsanitizer will cause an ABI mismatch in crate kernel
--> rust/kernel/lib.rs:3:1
|
3 | //! The kernel crate.
| ^
|
= help: the -Zsanitizer flag modifies the ABI so Rust crates compiled with different values of this flag cannot be used together safely = note: unset -Zsanitizer in this crate is incompatible with -Zsanitizer=kernel-address in dependency core
= help: set -Zsanitizer=kernel-address in this crate or unset -Zsanitizer in core
= help: if you are sure this will not cause problems, you may use -Cunsafe-allow-abi-mismatch=sanitizer to silence this error

A simple way around is to add the sanitizer to the list in the existing workaround (especially if we had not started to pass the sanitizer flags in the previous commit, since in that case that would not be necessary). However, that still applies the workaround in more cases than necessary.

Instead, only modify the doctests flags to ignore the check for sanitizers, so that it is more local (and thus the compiler keeps checking it for us in the normal rustdoc calls). Since the previous commit already treated the rustdoc calls as kernel objects, this should allow us in the future to easily remove this workaround when the time comes.

By the way, the -Cunsafe-allow-abi-mismatch flag overwrites previous ones rather than appending, so it needs to be all done in the same flag. Moreover, unknown modifiers are rejected, and thus we have to gate based on the version too.

Finally, -Zsanitizer-cfi-normalize-integers is not affected (in Rust 1.91.0), so it is not needed in the workaround for the moment.

rust/Makefile +4 -1
index a9fb9354b659..3e545c1a0ff4 100644
@@ -69,6 +69,9 @@ core-edition := $(if $(call rustc-min-version,108700),2024,2021)
 # the time being (https://github.com/rust-lang/rust/issues/144521).
 rustdoc_modifiers_workaround := $(if $(call rustc-min-version,108800),-Cunsafe-allow-abi-mismatch=fixed-x18)
 
+# Similarly, for doctests (https://github.com/rust-lang/rust/issues/146465).
+doctests_modifiers_workaround := $(rustdoc_modifiers_workaround)$(if $(call rustc-min-version,109100),$(comma)sanitizer)
+
 # `rustc` recognizes `--remap-path-prefix` since 1.26.0, but `rustdoc` only
 # since Rust 1.81.0. Moreover, `rustdoc` ICEs on out-of-tree builds since Rust
 # 1.82.0 (https://github.com/rust-lang/rust/issues/138520). Thus workaround both
@@ -236,7 +239,7 @@ quiet_cmd_rustdoc_test_kernel = RUSTDOC TK $<
 		--extern bindings --extern uapi \
 		--no-run --crate-name kernel -Zunstable-options \
 		--sysroot=/dev/null \
-		$(rustdoc_modifiers_workaround) \
+		$(doctests_modifiers_workaround) \
 		--test-builder $(objtree)/scripts/rustdoc_test_builder \
 		$< $(rustdoc_test_kernel_quiet); \
 	$(objtree)/scripts/rustdoc_test_gen
maintainer
#1 lore raw

PATCH 1/1 rust: kbuild: workaround `rustdoc` doctests modifier bug

From: Miguel Ojeda <[email protected]>

[ Upstream commit fad472efab0a805dd939f017c5b8669a786a4bcf ]

The rustdoc modifiers bug [1] was fixed in Rust 1.90.0 [2], for which we added a workaround in commit abbf9a449441 ("rust: workaround rustdoc target modifiers bug").

However, rustdoc's doctest generation still has a similar issue [3], being fixed at [4], which does not affect us because we apply the workaround to both, and now, starting with Rust 1.91.0 (released 2025-10-30), -Zsanitizer is a target modifier too [5], which means we fail with:

RUSTDOC TK rust/kernel/lib.rs
error: mixing -Zsanitizer will cause an ABI mismatch in crate kernel
--> rust/kernel/lib.rs:3:1
|
3 | //! The kernel crate.
| ^
|
= help: the -Zsanitizer flag modifies the ABI so Rust crates compiled with different values of this flag cannot be used together safely = note: unset -Zsanitizer in this crate is incompatible with -Zsanitizer=kernel-address in dependency core
= help: set -Zsanitizer=kernel-address in this crate or unset -Zsanitizer in core
= help: if you are sure this will not cause problems, you may use -Cunsafe-allow-abi-mismatch=sanitizer to silence this error

A simple way around is to add the sanitizer to the list in the existing workaround (especially if we had not started to pass the sanitizer flags in the previous commit, since in that case that would not be necessary). However, that still applies the workaround in more cases than necessary.

Instead, only modify the doctests flags to ignore the check for sanitizers, so that it is more local (and thus the compiler keeps checking it for us in the normal rustdoc calls). Since the previous commit already treated the rustdoc calls as kernel objects, this should allow us in the future to easily remove this workaround when the time comes.

By the way, the -Cunsafe-allow-abi-mismatch flag overwrites previous ones rather than appending, so it needs to be all done in the same flag. Moreover, unknown modifiers are rejected, and thus we have to gate based on the version too.

Finally, -Zsanitizer-cfi-normalize-integers is not affected (in Rust 1.91.0), so it is not needed in the workaround for the moment.

---
 rust/Makefile | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)
rust/Makefile +3 -1
index 07c13100000cd..bd1d21f116e30 100644
@@ -59,6 +59,8 @@ core-edition := $(if $(call rustc-min-version,108700),2024,2021)
 # the time being (https://github.com/rust-lang/rust/issues/144521).
 rustdoc_modifiers_workaround := $(if $(call rustc-min-version,108800),-Cunsafe-allow-abi-mismatch=fixed-x18)
 
+# Similarly, for doctests (https://github.com/rust-lang/rust/issues/146465).
+doctests_modifiers_workaround := $(rustdoc_modifiers_workaround)$(if $(call rustc-min-version,109100),$(comma)sanitizer)
 quiet_cmd_rustdoc = RUSTDOC $(if $(rustdoc_host),H, ) $<
       cmd_rustdoc = \
 	OBJTREE=$(abspath $(objtree)) \
@@ -183,7 +185,7 @@ quiet_cmd_rustdoc_test_kernel = RUSTDOC TK $<
 		--extern bindings --extern uapi \
 		--no-run --crate-name kernel -Zunstable-options \
 		--sysroot=/dev/null \
-		$(rustdoc_modifiers_workaround) \
+		$(doctests_modifiers_workaround) \
 		--test-builder $(objtree)/scripts/rustdoc_test_builder \
 		$< $(rustdoc_test_kernel_quiet); \
 	$(objtree)/scripts/rustdoc_test_gen
Signature · 1 line
2.51.0
#2 lore raw

Re: [PATCH 6.12.y] rust: kbuild: workaround `rustdoc` doctests modifier bug

Quoted 2 lines · Sasha Levin

[ added --remap-path-prefix comments missing in stable branch ]

Do you mean you added the patch that added that workaround? Which branch?

The resolution below does not show the comments, so I am confused. The resolution itself seems OK, but that line on the log plus not seeing the comments in the diff that are supposedly added somewhere else seems odd.

(I would add a new line here before quiet_cmd_rustdoc).

Thanks!

Cheers,
Miguel

#3 lore raw

Re: [PATCH 6.12.y] rust: kbuild: workaround `rustdoc` doctests modifier bug

Quoted 7 lines · Miguel Ojeda

Do you mean you added the patch that added that workaround? Which branch?

The resolution below does not show the comments, so I am confused. The resolution itself seems OK, but that line on the log plus not seeing the comments in the diff that are supposedly added somewhere else seems odd.

Or maybe the line means it is adding the comments here, because the stable branch misses them, but those comments are not in the resolution either (and I am not sure why we would add them here in this patch anyway).

Cheers,
Miguel

maintainer
#4 lore raw

Re: [PATCH 6.12.y] rust: kbuild: workaround `rustdoc` doctests modifier bug

In reply to Miguel Ojeda
Quoted 10 lines · Miguel Ojeda
Quoted 2 lines · Sasha Levin

[ added --remap-path-prefix comments missing in stable branch ]

Do you mean you added the patch that added that workaround? Which branch?

The resolution below does not show the comments, so I am confused. The resolution itself seems OK, but that line on the log plus not seeing the comments in the diff that are supposedly added somewhere else seems odd.

Sorry, it should have been s/added/removed - there's a comment upstream about --remap-path-prefix that doesn't exist in the 6.12 tree.

Signature · 2 lines
Thanks,
Sasha
#5 lore raw

Re: [PATCH 6.12.y] rust: kbuild: workaround `rustdoc` doctests modifier bug

Quoted 3 lines · Sasha Levin

Sorry, it should have been s/added/removed - there's a comment upstream about --remap-path-prefix that doesn't exist in the 6.12 tree.

Ah, so just adjusting context -- got it, thanks!

(I got confused because in the other Rust patch you said that, so I thought this was about something more involved.)

Cheers,
Miguel

#6 lore raw
In reply to [email protected]
Quoted 6 lines · On Sat, Nov 8, 2025 at 6:24 AM <[email protected]> wrote:

The patch below does not apply to the 6.12-stable tree.
If someone wants it applied there, or to any other stable or longterm tree, then please email the backport, including the original git commit id to <[email protected]>.

Quoted 8 lines

To reproduce the conflict and resubmit, you may use the following commands:

git fetch https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/ linux-6.12.y
git checkout FETCH_HEAD
git cherry-pick -x fad472efab0a805dd939f017c5b8669a786a4bcf
# <resolve conflicts, build, test, etc.>
git commit -s
git send-email --to '<[email protected]>' --in-reply-to '2025110805-fame-viability-c333@gregkh' --subject-prefix 'PATCH 6.12.y' HEAD^..

I replied in Sasha's sibling resolution -- there is something odd in the log which I would like to understand.

Cheers,
Miguel