]> git.hungrycats.org Git - linux/commit
rust: doc: disable doc inlining for all prelude items
authorGary Guo <gary@garyguo.net>
Mon, 20 Apr 2026 16:16:36 +0000 (17:16 +0100)
committerMiguel Ojeda <ojeda@kernel.org>
Tue, 19 May 2026 22:47:24 +0000 (00:47 +0200)
commit6c77b5f4d72487cfd1db4b84f3792761cbce72ea
treec592d04fe05002f16dc992946cd7272075edbc82
parent5200f5f493f79f14bbdc349e402a40dfb32f23c8
rust: doc: disable doc inlining for all prelude items

Somehow the rustdoc heuristics determined that a large chunk of the items
found in prelude should have documentation inlined. This bloats the
generated documentation size.

Also, for crates that optimize documentation with `cfg(doc)`, as the
documentation inlining makes use of the metadata compiled by just rustc, it
will not pick up the `cfg(doc)` attributes from the inlined documentation.
pin-init for example optimizes tuple/fn rendering using the nightly
fake_variadic feature [1], but this is missing from the inlined version
[2].

Thus, mark all prelude items as `#[doc(no_inline)]`.

Link: https://rust.docs.kernel.org/next/pin_init/trait.Zeroable.html#impl-Zeroable-for-(J,)
Link: https://rust.docs.kernel.org/next/kernel/prelude/trait.Zeroable.html#impl-Zeroable-for-(J,)
Signed-off-by: Gary Guo <gary@garyguo.net>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Link: https://patch.msgid.link/20260420161636.1790502-1-gary@kernel.org
[ Reworded for typo. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/kernel/prelude.rs