linux-kernel - Re: [PATCH] rust: kbuild: clean output before running `rustdoc`

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <CANiq72kbsj5nJCZOo_jh8YzsiX8RgOKVAF=x8vDYbFjoCh6mjg@mail.gmail.com>
Date: Tue, 12 Aug 2025 21:53:19 +0200
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Miguel Ojeda <ojeda@...nel.org>
Cc: Alex Gaynor <alex.gaynor@...il.com>, Masahiro Yamada <masahiroy@...nel.org>, 
	Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>, 
	Björn Roy Baron <bjorn3_gh@...tonmail.com>, 
	Benno Lossin <lossin@...nel.org>, Andreas Hindborg <a.hindborg@...nel.org>, 
	Alice Ryhl <aliceryhl@...gle.com>, Trevor Gross <tmgross@...ch.edu>, 
	Danilo Krummrich <dakr@...nel.org>, rust-for-linux@...r.kernel.org, 
	Nathan Chancellor <nathan@...nel.org>, Nicolas Schier <nicolas@...sle.eu>, linux-kbuild@...r.kernel.org, 
	linux-kernel@...r.kernel.org, patches@...ts.linux.dev, stable@...r.kernel.org, 
	Daniel Almeida <daniel.almeida@...labora.com>
Subject: Re: [PATCH] rust: kbuild: clean output before running `rustdoc`

On Sat, Jul 26, 2025 at 3:34 PM Miguel Ojeda <ojeda@...nel.org> wrote:
>
> `rustdoc` can get confused when generating documentation into a folder
> that contains generated files from other `rustdoc` versions.
>
> For instance, running something like:
>
>     rustup default 1.78.0
>     make LLVM=1 rustdoc
>     rustup default 1.88.0
>     make LLVM=1 rustdoc
>
> may generate errors like:
>
>     error: couldn't generate documentation: invalid template: last line expected to start with a comment
>       |
>       = note: failed to create or modify "./Documentation/output/rust/rustdoc/src-files.js"
>
> Thus just always clean the output folder before generating the
> documentation -- we are anyway regenerating it every time the `rustdoc`
> target gets called, at least for the time being.
>
> Cc: stable@...r.kernel.org # Needed in 6.12.y and later (Rust is pinned in older LTSs).
> Reported-by: Daniel Almeida <daniel.almeida@...labora.com>
> Closes: https://rust-for-linux.zulipchat.com/#narrow/channel/288089/topic/x/near/527201113
> Signed-off-by: Miguel Ojeda <ojeda@...nel.org>

Applied to `rust-fixes` -- thanks everyone!

Cheers,
Miguel