linux-kernel - Re: [PATCH 01/22] rust: init: disable doctests

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <87h647a7rd.fsf@kernel.org>
Date: Wed, 05 Mar 2025 15:09:58 +0100
From: Andreas Hindborg <a.hindborg@...nel.org>
To: "Benno Lossin" <benno.lossin@...ton.me>
Cc: "Miguel Ojeda" <ojeda@...nel.org>,  "Alex Gaynor"
 <alex.gaynor@...il.com>,  "Boqun Feng" <boqun.feng@...il.com>,  "Gary Guo"
 <gary@...yguo.net>,  Björn Roy Baron
 <bjorn3_gh@...tonmail.com>,  "Alice
 Ryhl" <aliceryhl@...gle.com>,  "Trevor Gross" <tmgross@...ch.edu>,
  "Danilo Krummrich" <dakr@...nel.org>,  <rust-for-linux@...r.kernel.org>,
  <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH 01/22] rust: init: disable doctests

"Benno Lossin" <benno.lossin@...ton.me> writes:

> On Wed Mar 5, 2025 at 9:51 AM CET, Andreas Hindborg wrote:
>> "Benno Lossin" <benno.lossin@...ton.me> writes:
>>
>>> This is the first commit in a series that splits off the pin-init crate
>>> from the kernel crate.
>>
>> I recently learned that using imperative mode in the commit message is
>> preferred [1]. You might want to consider that for next spin.
>
> Thanks for pointing that out, any suggestions for this concrete case? I
> wasn't able to come up with an imperative statement.

I would drop the first paragraph entirely, since the subject is 01/22
and the cover letter provides plenty of context.

  The build system cannot handle doctests in the kernel crate in files
  outside of `rust/kernel/`. Subsequent commits will move files out
  of that directory, but will still compile them as part of the kernel
  crate. Thus, ignore all doctests in the to-be-moved files.

  Leave tests disabled until they are separated into their
  own crate and they stop causing breakage.

Not sure if it is better? More robot for sure 🤖

This part from the original is not correct:?

  since then the doctests of that new crate will be handled as normal
  host doctests.

The build system will not run those tests when they are not in the
kernel crate?

Best regards,
Andreas Hindborg