linux-kernel - Re: [PATCH v3 2/2 RESEND] checkpatch: warn on empty rust 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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <67il2JOf-dSurc3O-294W5k5mS-kf1FtFxKzXlxHHykGmIvIkfPel_pPe2LGX04HSnTg85LwEdU4Zz2VCrfXgIl5KVItUm5vPhbtkThc3BM=@proton.me>
Date: Mon, 30 Sep 2024 02:41:42 +0000
From: Patrick Miller <paddymills@...ton.me>
To: Trevor Gross <tmgross@...ch.edu>
Cc: Hridesh MG <hridesh699@...il.com>, linux-kernel@...r.kernel.org, rust-for-linux@...r.kernel.org, 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>
Subject: Re: [PATCH v3 2/2 RESEND] checkpatch: warn on empty rust doc comments






On Sunday, September 29th, 2024 at 6:15 PM, Trevor Gross <tmgross@...ch.edu> wrote:

> 

> 

> On Sun, Sep 29, 2024 at 7:16 AM Hridesh MG hridesh699@...il.com wrote:
> 

> > diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
> > index 39032224d504..c75bc3927bf6 100755
> > --- a/scripts/checkpatch.pl
> > +++ b/scripts/checkpatch.pl
> > @@ -3884,6 +3884,13 @@ sub process {
> > }
> > }
> > 

> > +# check for consecutive empty /// lines in .rs files
> > + if ($realfile =~ /\.rs$/ &&
> > + $rawline =~ /^\+\s*\/\/\/$/ && $prevrawline =~ /^\+\s*\/\/\/$/) {
> > + WARN("RUST_DOC_EMPTY",
> > + "avoid using consecutive empty rustdoc comments\n" . $herecurr);
> > + }
> > +
> 

> 

> We got a request to add a rust-specific block in another patchset [1].
> It would probably be good to coordinate here and have a patch adding
> an empty block, to be used by both of these changes.
> 

> [1]: https://lore.kernel.org/rust-for-linux/a9112679-b251-4b98-b55e-e8aabf82ad46@proton.me/

After the latest revision of my patch [1], I split the if statement so that
there is a parent check for rust files for future rust patch checks. So,
this would perfectly fit within that block.

Do you want me to add your code and credit you in my patch? 


[1]: https://lore.kernel.org/rust-for-linux/20240914181618.837227-2-paddymills@proton.me/

Download attachment "signature.asc" of type "application/pgp-signature" (250 bytes)