Re: [PATCH 14/19] rust: provide proper code documentation titles

Trevor Gross
2024-09-29T04:56:26Z

On Wed, Sep 4, 2024 at 4:45 PM Miguel Ojeda <ojeda@kernel.org> wrote:
>
> Rust 1.82.0's Clippy is introducing [1][2] a new warn-by-default lint,
> `too_long_first_doc_paragraph` [3], which is intended to catch titles
> of code documentation items that are too long (likely because no title
> was provided and the item documentation starts with a paragraph).
>
> This lint does not currently trigger anywhere, but it does detect a couple
> cases we had in private cases if checking for private items gets enabled
> (which we will do in the next commit):

I think some words got flipped around, should this say something like
"...a couple private cases we had in case checking..."?

> error: first doc comment paragraph is too long
> --> rust/kernel/init/__internal.rs:18:1
> |
> 18 | / /// This is the module-internal type implementing `PinInit` and `Init`. It is unsafe to create this
> 19 | | /// type, since the closure needs to fulfill the same safety requirement as the
> 20 | | /// `__pinned_init`/`__init` functions.
> | |_
> |
> = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
> = note: `-D clippy::too-long-first-doc-paragraph` implied by `-D warnings`
> = help: to override `-D warnings` add `#[allow(clippy::too_long_first_doc_paragraph)]`
>
> error: first doc comment paragraph is too long
> --> rust/kernel/sync/arc/std_vendor.rs:3:1
> |
> 3 | / //! The contents of this file come from the Rust standard library, hosted in
> 4 | | //! the <https://github.com/rust-lang/rust> repository, licensed under
> 5 | | //! "Apache-2.0 OR MIT" and adapted for kernel use. For copyright details,
> 6 | | //! see <https://github.com/rust-lang/rust/blob/master/COPYRIGHT>.
> | |_
> |
> = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#too_long_first_doc_paragraph
>
> Thus clean the two instances we hit and enable the lint.
>
> In addition, since we have a second `std_vendor.rs` file with a similar
> header, do the same there too (even if that one does not trigger the lint,
> because it is `doc(hidden)`).
>
> Link: https://github.com/rust-lang/rust/pull/129531 [1]
> Link: https://github.com/rust-lang/rust-clippy/pull/12993 [2]
> Link: https://rust-lang.github.io/rust-clippy/master/index.html#/too_long_first_doc_paragraph [3]
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Trevor Gross <tmgross@umich.edu>