linux-kernel - Re: [PATCH v5 2/2] checkpatch: warn on known non-plural rust doc headers and empty doc comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CANiq72kEPEcqqJmLEtT7=Ku5mseHe6Js_jptVQHMzRwfUzFtMQ@mail.gmail.com>
Date: Wed, 2 Oct 2024 13:56:00 +0200
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Patrick Miller <paddymills@...ton.me>
Cc: Andy Whitcroft <apw@...onical.com>, Joe Perches <joe@...ches.com>, 
	Dwaipayan Ray <dwaipayanray1@...il.com>, Lukas Bulwahn <lukas.bulwahn@...il.com>, 
	Miguel Ojeda <ojeda@...nel.org>, Alex Gaynor <alex.gaynor@...il.com>, 
	Wedson Almeida Filho <wedsonaf@...il.com>, Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>, 
	Björn Roy Baron <bjorn3_gh@...tonmail.com>, 
	Benno Lossin <benno.lossin@...ton.me>, Andreas Hindborg <a.hindborg@...sung.com>, 
	Alice Ryhl <aliceryhl@...gle.com>, Trevor Gross <tmgross@...ch.edu>, linux-kernel@...r.kernel.org, 
	rust-for-linux@...r.kernel.org, Hridesh MG <hridesh699@...il.com>
Subject: Re: [PATCH v5 2/2] checkpatch: warn on known non-plural rust doc
 headers and empty doc comments

On Wed, Oct 2, 2024 at 4:29 AM Patrick Miller <paddymills@...ton.me> wrote:
>
> Signed-off-by: Patrick Miller <paddymills@...ton.me>

These tags are typically placed before your Signed-off-by (tags after
it are usually the ones added by the next person handling the patch,
i.e. the next Signed-off-by).

> Co-developed-by: Hridesh MG <hridesh699@...il.com>

This tag requires a Signed-off-by -- please see:

    https://docs.kernel.org/process/submitting-patches.html#when-to-use-acked-by-cc-and-co-developed-by

> Suggested-by: Trevor
> Gross <tmgross@...ch.edu>

It seems like the patch has been wrapped in a couple places.

>   - merged Hridesh MG's patch[2] to check against consecutive rustdoc comments
>   - revised Hridesh MG's
>  patch to match against $prevrawline being new
>       or existing
>   - added fix to Hridesh MG's patch

It may be clearer and simpler (for attribution purposes) to avoid
merging them, and instead add a check in each patch (you can still
rebase Hridesh's into yours on top, so that you add it inside the
`realfile` condition etc.).

I would also include Hridesh's cleanup here too if we are doing
everything here. Something like:

#1: clean A
#2: add check for A
#3: clean B
#4: add check for B

> +# checks for rust files

We already have other checks for Rust files that are shared with other
languages. Perhaps we can be slightly more clear with "checks for Rust
files (only)" or "Rust-only checks" or "checks that only apply to Rust
files"?

Thanks!

Cheers,
Miguel