Rust-for-Linux / linux

Adding support for the Rust language to the Linux kernel.
https://rust-for-linux.com
Other
3.83k stars 399 forks source link

Remove unneeded `kernel::prelude::*`s from doctests #1064

Closed ojeda closed 1 month ago

ojeda commented 4 months ago

In the kernel, Rust doctests implicitly include kernel::prelude::*. Thus remove it from all doctests from where it may make sense, and double-check they all still compile and pass by running them, e.g. under QEMU or with the KUnit script (see upcoming documentation about how to do so at https://lore.kernel.org/rust-for-linux/20240130075117.4137360-2-dirk.behme@de.bosch.com/).


This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes (including generating the documentation if changed, running the Rust doctests if changed, etc.), to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and to add a Suggested-by: tag and a Link: tag to this issue. Please see https://rust-for-linux.com/contributing for details.

Please take this issue only if you are new to the kernel development process and you would like to use it as a test to submit your first patch to the kernel. Please do not take it if you do not plan to make other contributions to the kernel.

nellshamrell commented 3 months ago

I would love to work on this issue this week.

ojeda commented 3 months ago

Of course, please feel free to -- thanks!

nellshamrell commented 3 months ago

Instances of kernel::prelude in doctests

Tested Examples

Untested Examples to possibly re-work

Note from zulip on linux/rust/macros/lib.rs

Other instances

Instances of kernel::{prelude::*, ...} in doctests

nellshamrell commented 2 months ago

A patch for this was submitted to the LKML :)

ojeda commented 1 month ago

This is now in mainline: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=4a2ae8805129

Thanks again!

nellshamrell commented 1 month ago

Amazing! Ty for the opportunity!