| Message ID | 20250324210359.1199574-11-ojeda@kernel.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | None | expand |
diff --git a/.clippy.toml b/.clippy.toml index 815c94732ed7..adc32c88176c 100644 --- a/.clippy.toml +++ b/.clippy.toml @@ -9,3 +9,7 @@ disallowed-macros = [ # it here, see: https://github.com/rust-lang/rust-clippy/issues/11303. { path = "kernel::dbg", reason = "the `dbg!` macro is intended as a debugging tool" }, ] + +doc-valid-idents = [ + "KUnit", +] diff --git a/Makefile b/Makefile index 70bdbf2218fc..5d6baedc097f 100644 --- a/Makefile +++ b/Makefile @@ -477,6 +477,7 @@ export rust_common_flags := --edition=2021 \ -Wrust_2018_idioms \ -Wunreachable_pub \ -Wclippy::all \ + -Wclippy::doc_markdown \ -Wclippy::ignored_unit_patterns \ -Wclippy::mut_mut \ -Wclippy::needless_bitwise_bool \
Clippy supports the `doc_markdown` lint [1] since 2016 [2]: Checks for the presence of _, :: or camel-case words outside ticks in documentation. It is a very common note in Linux kernel reviews to mention that documentation is missing a Markdown code span, e.g.: /// Length of the data must be less than data_size. should have been: /// Length of the data must be less than `data_size`. This lint can identify some of those cases automatically for us. It also caught for us other typos or mis-documentation, such as a missing code block. Thus enable it, now that the tree is sufficiently clean. Relatedly, it would be nice to have something similar [3] even for comments (not just documentation), as well as for possible intra-doc links (which should also have less false positives). Link: https://rust-lang.github.io/rust-clippy/master/index.html#doc_markdown [1] Link: https://github.com/rust-lang/rust-clippy/commit/42bf37f49f49829507be4f2dfd6c5db9b8234b66 [2] Link: https://github.com/rust-lang/rust/issues/131510 [3] Link: https://lore.kernel.org/rust-for-linux/CANiq72=aVRMvOaU48DBLL=p+VoG3RvHK+K48XQhvHw3ARc0BNg@mail.gmail.com/ Signed-off-by: Miguel Ojeda <ojeda@kernel.org> --- .clippy.toml | 4 ++++ Makefile | 1 + 2 files changed, 5 insertions(+) -- 2.49.0