Skip to contentSkip to conversation

drm/panic: remove spurious empty line to clean warning

PATCH Applied Miguel Ojeda 4 participants 7 messages Nov 25, 2024 – Dec 10, 2024

Subsystems (4)
lore
Share & tools
lore

Miguel Ojeda

author maintainer
#0 lore raw

PATCH 1/1 drm/panic: remove spurious empty line to clean warning

Clippy in the upcoming Rust 1.83.0 spots a spurious empty line since the clippy::empty_line_after_doc_comments warning is now enabled by default given it is part of the suspicious group [1]:

    error: empty line after doc comment
       --> drivers/gpu/drm/drm_panic_qr.rs:931:1
        |
    931 | / /// They must remain valid for the duration of the function call.
    932 | |
        | |_
    933 |   #[no_mangle]
    934 | / pub unsafe extern "C" fn drm_panic_qr_generate(
    935 | |     url: *const i8,
    936 | |     data: *mut u8,
    937 | |     data_len: usize,
    ...   |
    940 | |     tmp_size: usize,
    941 | | ) -> u8 {
        | |_______- the comment documents this function
        |
        = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
        = note: `-D clippy::empty-line-after-doc-comments` implied by `-D warnings`
        = help: to override `-D warnings` add `#[allow(clippy::empty_line_after_doc_comments)]`
        = help: if the empty line is unintentional remove it

Thus remove the empty line.

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

---
I added the Fixes and stable tags since it would be nice to keep the 6.12 LTS Clippy-clean (since that one is the first that supports several Rust compilers).

 drivers/gpu/drm/drm_panic_qr.rs | 1 -
 1 file changed, 1 deletion(-)
drivers/gpu/drm/drm_panic_qr.rs +0 -1
index 09500cddc009..ef2d490965ba 100644
@@ -929,7 +929,6 @@ fn draw_all(&mut self, data: impl Iterator<Item = u8>) {
 /// * `tmp` must be valid for reading and writing for `tmp_size` bytes.
 ///
 /// They must remain valid for the duration of the function call.
-
 #[no_mangle]
 pub unsafe extern "C" fn drm_panic_qr_generate(
     url: *const i8,

base-commit: b7ed2b6f4e8d7f64649795e76ee9db67300de8eb --
2.47.0

Reviewed-by on v1 1/1
#1 lore raw
Quoted 25 lines · Miguel Ojeda

Clippy in the upcoming Rust 1.83.0 spots a spurious empty line since the clippy::empty_line_after_doc_comments warning is now enabled by default given it is part of the suspicious group [1]:

     error: empty line after doc comment
        --> drivers/gpu/drm/drm_panic_qr.rs:931:1
         |
     931 | / /// They must remain valid for the duration of the function call.
     932 | |
         | |_
     933 |   #[no_mangle]
     934 | / pub unsafe extern "C" fn drm_panic_qr_generate(
     935 | |     url: *const i8,
     936 | |     data: *mut u8,
     937 | |     data_len: usize,
     ...   |
     940 | |     tmp_size: usize,
     941 | | ) -> u8 {
         | |_______- the comment documents this function
         |
         = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
         = note: `-D clippy::empty-line-after-doc-comments` implied by `-D warnings`
         = help: to override `-D warnings` add `#[allow(clippy::empty_line_after_doc_comments)]`
         = help: if the empty line is unintentional remove it
Quoted 1 line

Thus remove the empty line.

Thanks for this patch, it looks good to me.

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

---
I added the Fixes and stable tags since it would be nice to keep the 6.12 LTS Clippy-clean (since that one is the first that supports several Rust compilers).

  drivers/gpu/drm/drm_panic_qr.rs | 1 -
  1 file changed, 1 deletion(-)
drivers/gpu/drm/drm_panic_qr.rs +0 -1
index 09500cddc009..ef2d490965ba 100644
@@ -929,7 +929,6 @@ fn draw_all(&mut self, data: impl Iterator<Item = u8>) {
  /// * `tmp` must be valid for reading and writing for `tmp_size` bytes.
  ///
  /// They must remain valid for the duration of the function call.
-
  #[no_mangle]
  pub unsafe extern "C" fn drm_panic_qr_generate(
      url: *const i8,

base-commit: b7ed2b6f4e8d7f64649795e76ee9db67300de8eb --
2.47.0

#3 lore raw
Quoted 8 lines · Miguel Ojeda
Quoted 4 lines · Jocelyn Falempe

Thanks for this patch, it looks good to me.

Thanks Jocelyn. I thought DRM would pick this one -- should I pick it through rust-fixes?

You can merge it through rust-fixes. I have another patch [1] under review that touches this file, but it shouldn't conflict, as the changes are far from this line.

How do you test clippy, so I can check I won't introduce another warning with this series?

[1]: https://patchwork.freedesktop.org/series/142175/

Best regards,

Quoted 4 lines

Cheers,
Miguel

#4 lore raw
Quoted 4 lines · Jocelyn Falempe

You can merge it through rust-fixes. I have another patch [1] under review that touches this file, but it shouldn't conflict, as the changes are far from this line.

Sounds good, thanks! (But of course please feel free to merge fixes through DRM)

Quoted 2 lines

How do you test clippy, so I can check I won't introduce another warning with this series?

With CLIPPY=1, please see:

https://docs.kernel.org/rust/general-information.html#extra-lints

Cheers,
Miguel

#5 lore raw
Quoted 7 lines · Miguel Ojeda
Quoted 4 lines · Jocelyn Falempe

You can merge it through rust-fixes. I have another patch [1] under review that touches this file, but it shouldn't conflict, as the changes are far from this line.

Sounds good, thanks! (But of course please feel free to merge fixes through DRM)

Yeah I think once rust lands in drm the patches should land through drm trees, or we'll have a bit of a mess. Of course with rust expert reviews/acks where needed.
-Sima

Quoted 9 lines
Quoted 2 lines

How do you test clippy, so I can check I won't introduce another warning with this series?

With CLIPPY=1, please see:

https://docs.kernel.org/rust/general-information.html#extra-lints

Cheers,
Miguel

Signature · 3 lines
Simona Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch
Applied
#6 lore raw
In reply to Miguel Ojeda
Quoted 26 lines · Miguel Ojeda

Clippy in the upcoming Rust 1.83.0 spots a spurious empty line since the clippy::empty_line_after_doc_comments warning is now enabled by default given it is part of the suspicious group [1]:

    error: empty line after doc comment
       --> drivers/gpu/drm/drm_panic_qr.rs:931:1
        |
    931 | / /// They must remain valid for the duration of the function call.
    932 | |
        | |_
    933 |   #[no_mangle]
    934 | / pub unsafe extern "C" fn drm_panic_qr_generate(
    935 | |     url: *const i8,
    936 | |     data: *mut u8,
    937 | |     data_len: usize,
    ...   |
    940 | |     tmp_size: usize,
    941 | | ) -> u8 {
        | |_______- the comment documents this function
        |
        = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#empty_line_after_doc_comments
        = note: `-D clippy::empty-line-after-doc-comments` implied by `-D warnings`
        = help: to override `-D warnings` add `#[allow(clippy::empty_line_after_doc_comments)]`
        = help: if the empty line is unintentional remove it
Quoted 6 lines

Thus remove the empty line.

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

Applied to rust-fixes -- thanks!

Cheers,
Miguel