.clippy.toml | 4 ++++ Makefile | 1 + drivers/gpu/drm/drm_panic_qr.rs | 4 ++-- rust/kernel/alloc.rs | 4 ++-- rust/kernel/alloc/allocator_test.rs | 2 +- rust/kernel/dma.rs | 2 +- rust/kernel/of.rs | 2 +- rust/kernel/pci.rs | 15 +++++++++------ rust/kernel/platform.rs | 9 +++++---- rust/kernel/task.rs | 4 ++-- 10 files changed, 28 insertions(+), 19 deletions(-)
This is how it would look like -- I am not sure how many false positives
we will get, so I marked the last commit as RFC and perhaps we just want
this lint as an opt-in in e.g. `W=2`.
However, so far, we only got one ("KUnit"), plus a couple others that
are in C side comments that were copied, and thus someone may want to
keep them exactly in sync. So it seems pretty OK so far.
Another question is whether we want to commit to something like the
global list in `.clippy.toml`.
Anyway, please take a look -- the other commits should probably be
picked even if we do not enable the lint.
Thanks!
Miguel Ojeda (10):
drm/panic: add missing space
drm/panic: add missing Markdown code span
rust: alloc: add missing Markdown code spans
rust: alloc: add missing Markdown code span
rust: dma: add missing Markdown code span
rust: of: add missing Markdown code span
rust: pci: fix docs related to missing Markdown code spans
rust: platform: fix docs related to missing Markdown code spans
rust: task: add missing Markdown code spans and intra-doc links
rust: kbuild: enable `doc_markdown` Clippy lint
.clippy.toml | 4 ++++
Makefile | 1 +
drivers/gpu/drm/drm_panic_qr.rs | 4 ++--
rust/kernel/alloc.rs | 4 ++--
rust/kernel/alloc/allocator_test.rs | 2 +-
rust/kernel/dma.rs | 2 +-
rust/kernel/of.rs | 2 +-
rust/kernel/pci.rs | 15 +++++++++------
rust/kernel/platform.rs | 9 +++++----
rust/kernel/task.rs | 4 ++--
10 files changed, 28 insertions(+), 19 deletions(-)
--
2.49.0
On Mon, Mar 24, 2025 at 10:04 PM Miguel Ojeda <ojeda@kernel.org> wrote: > > rust: alloc: add missing Markdown code spans > rust: alloc: add missing Markdown code span > rust: dma: add missing Markdown code span > rust: pci: fix docs related to missing Markdown code spans > rust: platform: fix docs related to missing Markdown code spans > rust: task: add missing Markdown code spans and intra-doc links Applied to `rust-next`-- thanks everyone! I picked the ones Acked by Greg and Danilo (thanks!), plus Jocelyn picked the drm/panic ones a while ago. So now only the `of` one is pending, but there are new cases coming, so I may send another version of the series to clean them and possibly enable the lint. Cheers, Miguel
On Mon, Mar 24, 2025 at 10:04 PM Miguel Ojeda <ojeda@kernel.org> wrote: > > rust: alloc: add missing Markdown code spans > rust: alloc: add missing Markdown code span > rust: dma: add missing Markdown code span > rust: of: add missing Markdown code span > rust: pci: fix docs related to missing Markdown code spans > rust: platform: fix docs related to missing Markdown code spans > rust: task: add missing Markdown code spans and intra-doc links Abdiel, Danilo, Rob, Saravana, Greg, Rafael: anything against me picking these ones up? If you would like to pick them up through your respective trees, then that is great too. Thanks! Cheers, Miguel
On 21.05.2025 16:01, Miguel Ojeda wrote: > On Mon, Mar 24, 2025 at 10:04 PM Miguel Ojeda <ojeda@kernel.org> wrote: >> >> rust: alloc: add missing Markdown code spans >> rust: alloc: add missing Markdown code span >> rust: dma: add missing Markdown code span >> rust: of: add missing Markdown code span >> rust: pci: fix docs related to missing Markdown code spans >> rust: platform: fix docs related to missing Markdown code spans >> rust: task: add missing Markdown code spans and intra-doc links > > Abdiel, Danilo, Rob, Saravana, Greg, Rafael: anything against me > picking these ones up? Acked-by: Danilo Krummrich <dakr@kernel.org>
On Wed, May 21, 2025 at 04:01:28PM +0200, Miguel Ojeda wrote: > On Mon, Mar 24, 2025 at 10:04 PM Miguel Ojeda <ojeda@kernel.org> wrote: > > > > rust: alloc: add missing Markdown code spans > > rust: alloc: add missing Markdown code span > > rust: dma: add missing Markdown code span > > rust: of: add missing Markdown code span > > rust: pci: fix docs related to missing Markdown code spans > > rust: platform: fix docs related to missing Markdown code spans > > rust: task: add missing Markdown code spans and intra-doc links > > Abdiel, Danilo, Rob, Saravana, Greg, Rafael: anything against me > picking these ones up? No objection from me for you to take these through the rust tree: Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
On Mon Mar 24, 2025 at 10:03 PM CET, Miguel Ojeda wrote:
> This is how it would look like -- I am not sure how many false positives
> we will get, so I marked the last commit as RFC and perhaps we just want
> this lint as an opt-in in e.g. `W=2`.
I think we should try. If it's too much trouble, we can disable it
again.
> However, so far, we only got one ("KUnit"), plus a couple others that
> are in C side comments that were copied, and thus someone may want to
> keep them exactly in sync. So it seems pretty OK so far.
>
> Another question is whether we want to commit to something like the
> global list in `.clippy.toml`.
Not sure what you mean by this, but I think we need some way to disable
it for some acronyms.
> Anyway, please take a look -- the other commits should probably be
> picked even if we do not enable the lint.
For the entire series:
Reviewed-by: Benno Lossin <benno.lossin@proton.me>
---
Cheers,
Benno
> Thanks!
>
> Miguel Ojeda (10):
> drm/panic: add missing space
> drm/panic: add missing Markdown code span
> rust: alloc: add missing Markdown code spans
> rust: alloc: add missing Markdown code span
> rust: dma: add missing Markdown code span
> rust: of: add missing Markdown code span
> rust: pci: fix docs related to missing Markdown code spans
> rust: platform: fix docs related to missing Markdown code spans
> rust: task: add missing Markdown code spans and intra-doc links
> rust: kbuild: enable `doc_markdown` Clippy lint
>
> .clippy.toml | 4 ++++
> Makefile | 1 +
> drivers/gpu/drm/drm_panic_qr.rs | 4 ++--
> rust/kernel/alloc.rs | 4 ++--
> rust/kernel/alloc/allocator_test.rs | 2 +-
> rust/kernel/dma.rs | 2 +-
> rust/kernel/of.rs | 2 +-
> rust/kernel/pci.rs | 15 +++++++++------
> rust/kernel/platform.rs | 9 +++++----
> rust/kernel/task.rs | 4 ++--
> 10 files changed, 28 insertions(+), 19 deletions(-)
>
> --
> 2.49.0
On Mon, Mar 24, 2025 at 11:59 PM Benno Lossin <benno.lossin@proton.me> wrote: > > Not sure what you mean by this, but I think we need some way to disable > it for some acronyms. I meant that maintaining the list in that file (i.e. globally) could be a bit painful if we get a lot of terms, but I guess we can find workarounds for that if it gets bad. > Reviewed-by: Benno Lossin <benno.lossin@proton.me> Thanks! Cheers, Miguel
On Tue Mar 25, 2025 at 12:09 AM CET, Miguel Ojeda wrote: > On Mon, Mar 24, 2025 at 11:59 PM Benno Lossin <benno.lossin@proton.me> wrote: >> >> Not sure what you mean by this, but I think we need some way to disable >> it for some acronyms. > > I meant that maintaining the list in that file (i.e. globally) could > be a bit painful if we get a lot of terms, but I guess we can find > workarounds for that if it gets bad. I think we can just see if it's a problem. If we keep each term on its own line, merging should be easy. --- Cheers, Benno
© 2016 - 2025 Red Hat, Inc.