From: Guilherme Giacomo Simoes <trintaeoitogc@gmail.com>
To: a.hindborg@kernel.org, alex.gaynor@gmail.com,
aliceryhl@google.com, apw@canonical.com, arnd@arndb.de,
aswinunni01@gmail.com, axboe@kernel.dk, benno.lossin@proton.me,
bhelgaas@google.com, bjorn3_gh@protonmail.com,
boqun.feng@gmail.com, dakr@kernel.org, dwaipayanray1@gmail.com,
ethan.twardy@gmail.com, fujita.tomonori@gmail.com,
gary@garyguo.net, gregkh@linuxfoundation.org, joe@perches.com,
lukas.bulwahn@gmail.com, ojeda@kernel.org, pbonzini@redhat.com,
tmgross@umich.edu, walmeida@microsoft.com, charmitro@posteo.net
Cc: trintaeoitogc@gmail.com, rust-for-linux@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: [PATCH V7 2/2] checkpatch: check format of Vec<String> in modules
Date: Fri, 7 Mar 2025 10:14:01 -0300 [thread overview]
Message-ID: <20250307131401.638820-3-trintaeoitogc@gmail.com> (raw)
In-Reply-To: <20250307131401.638820-1-trintaeoitogc@gmail.com>
Implement a check to ensure that the author, firmware, and alias fields
of the module! macro are properly formatted.
* If the array contains more than one value, enforce vertical
formatting.
* If the array contains only one value, it may be formatted on a single
line
Signed-off-by: Guilherme Giacomo Simoes <trintaeoitogc@gmail.com>
---
scripts/checkpatch.pl | 67 +++++++++++++++++++++++++++++++++++++++++++
1 file changed, 67 insertions(+)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 7b28ad331742..7c42c1a0ea6b 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2775,6 +2775,12 @@ sub process {
$realcnt = 0;
$linenr = 0;
$fixlinenr = -1;
+
+ my %array_parse_module;
+ my $expected_spaces;
+ my $spaces;
+ my $herevet_space_add;
+
foreach my $line (@lines) {
$linenr++;
$fixlinenr++;
@@ -3567,6 +3573,67 @@ sub process {
# ignore non-hunk lines and lines being removed
next if (!$hunk_line || $line =~ /^-/);
+# check if the field is about author, firmware or alias from module! macro and find malformed arrays
+ my $inline = 0;
+ my $key = "";
+ my $add_line = $line =~ /^\+/;
+
+ if ($line =~ /\b(authors|alias|firmware)\s*:\s*\[/) {
+ $inline = 1;
+ $array_parse_module{$1} = 1;
+ }
+
+ my @keys = keys %array_parse_module;
+ if (@keys) {
+ $key = $keys[0];
+ }
+
+ if (!$expected_spaces && (!$add_line && $key && !$inline)) {
+ if ($line =~ /^([\t ]+)(\s)/) {
+ $expected_spaces = $1;
+ }
+ }
+
+ if ($add_line && $key) {
+ my $herevet = "$here\n" . cat_vet($rawline) . "\n";
+
+ my $counter = () = $line =~ /"/g;
+ my $more_than_one = $counter > 2;
+ if ($more_than_one) {
+ WARN("ARRAY_MODULE_MACRO",
+ "Prefer each array element on a separate line\n". $herevet);
+ } elsif ($inline && $line !~ /\]/ && $line !~ /,/ && $line =~ /"/) {
+ WARN("ARRAY_MODULE_MACRO",
+ "Prefer declare ] on the same line\n" . $herevet);
+ } elsif (!$inline && $line =~ /\]/ && $line =~ /\"/) {
+ WARN("ARRAY_MODULE_MACRO",
+ "Prefer a new line after the last value and before ]\n" . $herevet);
+ } elsif ($inline && $line =~ /,/ && $line !~ /\]/) {
+ WARN("ARRAY_MODULE_MACRO",
+ "Prefer a new line after [\n" . $herevet);
+ }
+
+ if ($line =~ /^\+\s*([\t ]+)(\S)/) {
+ $spaces = $1;
+ $herevet_space_add = $herevet;
+ }
+ }
+
+ if ($expected_spaces && $spaces) {
+ if (length($spaces) != length($expected_spaces)) {
+ WARN("ARRAY_MODULE_MACRO",
+ "Prefer a align parameters\n" . $herevet_space_add);
+ }
+
+ $spaces = undef;
+ }
+
+ #END OF ANALYZE FIELD
+ if ($line =~ /\]/) {
+ delete $array_parse_module{$key};
+ $expected_spaces = undef;
+ }
+
#trailing whitespace
if ($line =~ /^\+.*\015/) {
my $herevet = "$here\n" . cat_vet($rawline) . "\n";
--
2.34.1
next prev parent reply other threads:[~2025-03-07 13:14 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-07 13:13 [PATCH V7 0/2] author field in module! macro should be a array Guilherme Giacomo Simoes
2025-03-07 13:14 ` [PATCH V7 1/2] rust: module: change author to an array Guilherme Giacomo Simoes
2025-03-07 13:26 ` Alice Ryhl
2025-03-07 15:43 ` Guilherme Giacomo Simoes
2025-03-07 16:24 ` Miguel Ojeda
2025-03-08 0:40 ` Guilherme Giacomo Simoes
2025-03-09 21:03 ` Miguel Ojeda
2025-03-10 11:53 ` Guilherme Giacomo Simoes
2025-03-07 13:14 ` Guilherme Giacomo Simoes [this message]
2025-03-08 18:30 ` [PATCH V7 2/2] checkpatch: check format of Vec<String> in modules Daniel Sedlak
2025-03-09 17:47 ` Guilherme Giacomo Simoes
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250307131401.638820-3-trintaeoitogc@gmail.com \
--to=trintaeoitogc@gmail.com \
--cc=a.hindborg@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=apw@canonical.com \
--cc=arnd@arndb.de \
--cc=aswinunni01@gmail.com \
--cc=axboe@kernel.dk \
--cc=benno.lossin@proton.me \
--cc=bhelgaas@google.com \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=charmitro@posteo.net \
--cc=dakr@kernel.org \
--cc=dwaipayanray1@gmail.com \
--cc=ethan.twardy@gmail.com \
--cc=fujita.tomonori@gmail.com \
--cc=gary@garyguo.net \
--cc=gregkh@linuxfoundation.org \
--cc=joe@perches.com \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=ojeda@kernel.org \
--cc=pbonzini@redhat.com \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
--cc=walmeida@microsoft.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.