rust: clean and enable Clippy `doc_markdown` lint

Add missing space in sentence.

This was found using the Clippy doc_markdown lint, which we may want to enable.

Fixes cb5164ac43d0 ("drm/panic: Add a QR code panic screen")

Signed-off-by Miguel Ojeda <[email protected]>

---
  drivers/gpu/drm/drm_panic_qr.rs | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)

drivers/gpu/drm/drm_panic_qr.rs +1 -1

index ecd87e8ffe05..9bd4d131f033 100644
@@ -5,7 +5,7 @@
  //! It is called from a panic handler, so it should't allocate memory and
  //! does all the work on the stack or on the provided buffers. For
  //! simplification, it only supports low error correction, and applies the
-//! first mask (checkerboard). It will draw the smallest QRcode that can
+//! first mask (checkerboard). It will draw the smallest QR code that can
  //! contain the string passed as parameter. To get the most compact
  //! QR code, the start of the URL is encoded as binary, and the
  //! compressed kmsg is encoded as numeric.

Add missing Markdown code span.

This was found using the Clippy doc_markdown lint, which we may want to enable.

Fixes cb5164ac43d0 ("drm/panic: Add a QR code panic screen")

Signed-off-by Miguel Ojeda <[email protected]>

---
  drivers/gpu/drm/drm_panic_qr.rs | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)

drivers/gpu/drm/drm_panic_qr.rs +1 -1

index 9bd4d131f033..a8f832598c70 100644
@@ -914,7 +914,7 @@ fn draw_all(&mut self, data: impl Iterator<Item = u8>) {
  ///    will be encoded as binary segment, otherwise it will be encoded
  ///    efficiently as a numeric segment, and appended to the URL.
  /// * `data_len`: Length of the data, that needs to be encoded, must be less
-///    than data_size.
+///    than `data_size`.
  /// * `data_size`: Size of data buffer, it should be at least 4071 bytes to hold
  ///    a V40 QR code. It will then be overwritten with the QR code image.
  /// * `tmp`: A temporary buffer that the QR code encoder will use, to write the

Thanks, it looks good to me.

Reviewed-by Jocelyn Falempe <[email protected]>

You want to take the whole series in the rust tree?

Otherwise I can push the patch 1-2 to drm-misc-next if needed.

Quoted 5 lines · Jocelyn Falempe

Thanks, it looks good to me.

Reviewed-by Jocelyn Falempe <[email protected]>

Quoted 3 lines

You want to take the whole series in the rust tree?

Otherwise I can push the patch 1-2 to drm-misc-next if needed.

Please take them if possible, since others may want to take them through their tree anyway, plus it should have less conflicts if you change other bits, plus these are independent fixes anyway that can go in on their own whether or not the lint gets eventually enabled.

Thanks!

Cheers,
Miguel

rust/kernel/pci.rs +2 -0

+///
+/// [`pci_device_id`]: https://docs.kernel.org/PCI/pci.html#c.pci_device_id
 #[repr(transparent)]
 #[derive(Clone, Copy)]
 pub struct DeviceId(bindings::pci_device_id);

Wouldn't "([struct pci_device_id])" make more sense?

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

Not sure what you mean by this, but I think we need some way to disable it for some acronyms.

Reviewed-by Benno Lossin <[email protected]>

Quoted 3 lines · Benno Lossin

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.

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

Quoted 8 lines · Miguel Ojeda

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?

Quoted 8 lines · Miguel Ojeda

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?

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