search

Rust-for-Linux / linux

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

Make CI disallow leftover debugging code #511

Open niklasmohrin opened 2 years ago

niklasmohrin commented 2 years ago

See https://github.com/Rust-for-Linux/linux/pull/483#discussion_r722518188

A CI job could ensure that there are no dbg! (or pr_info!, etc.) calls left in pushed code would be a nice addition to the test suite. I have three high level ideas for how to accomplish this, but I haven't checked the applicability of any of them:

  1. Use rust-analyzer to find all references of the disallowed methods
  2. I believe there are certain clippy lints similar to what we want (disallowed-methods or so, relatively new) that could potentially be used
  3. Just grep over all of the Rust code / all *.rs files

While the last option is probably simplest, it may not be the cleanest. (note that these are just my first ideas, anyone implementing this can of course diverge from them :D ).

bjorn3 commented 2 years ago

What about adding an option that will be enabled on CI replacing the definitions of these macros with compile_error!("some error message")?

niklasmohrin commented 2 years ago

What about adding an option that will be enabled on CI replacing the definitions of these macros with compile_error!("some error message")?

Good idea! It could be gated by a feature or env variable

riking commented 1 year ago

How about a checkpatch.pl rule?

bjorn3 commented 1 year ago

That would trigger on the pr_log! call in the dbg! definition too, right? Even if dbg! isn't called.

nbdd0121 commented 1 year ago

We just need to add #[rustc_diagnostic_item = "dbg_macro"] to our dbg macro and then enable clippy's dbg_macro lint.

(Alternatively I can add a similar lint to klint)