public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
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
Cc: trintaeoitogc@gmail.com, rust-for-linux@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH V6 2/2] checkpatch: check format of Vec<String> in modules
Date: Sun, 23 Feb 2025 14:42:05 -0300	[thread overview]
Message-ID: <20250223174205.48404-3-trintaeoitogc@gmail.com> (raw)
In-Reply-To: <20250223174205.48404-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 | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 7b28ad331742..54e1893d13aa 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -2775,6 +2775,9 @@ sub process {
 	$realcnt = 0;
 	$linenr = 0;
 	$fixlinenr = -1;
+
+	my %array_parse_module;
+
 	foreach my $line (@lines) {
 		$linenr++;
 		$fixlinenr++;
@@ -3567,6 +3570,46 @@ 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 ($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);
+			}
+		}
+
+		#END OF ANALYZE FIELD
+		if ($line =~ /\]/) {
+			delete $array_parse_module{$key};
+		}
+
 #trailing whitespace
 		if ($line =~ /^\+.*\015/) {
 			my $herevet = "$here\n" . cat_vet($rawline) . "\n";
-- 
2.34.1


  parent reply	other threads:[~2025-02-23 17:42 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <GQqgXevDlPrbDVqybjdBe8eWBr-bsr56Nmbydqom2kJLDE2mrH7hfWC0ORBSY3Qz7yaBd3mIoy9TcKjNz96hzA==@protonmail.internalid>
2025-02-23 17:42 ` [PATCH V6 0/2] author field in module! macro should be a array Guilherme Giacomo Simoes
2025-02-23 17:42   ` [PATCH V6 1/2] rust: module: change author to an array Guilherme Giacomo Simoes
2025-02-24 22:07     ` Charalampos Mitrodimas
2025-03-04 12:09     ` Andreas Hindborg
2025-03-04 12:52     ` Alice Ryhl
2025-02-23 17:42   ` Guilherme Giacomo Simoes [this message]
2025-03-04 12:16     ` [PATCH V6 2/2] checkpatch: check format of Vec<String> in modules Andreas Hindborg
2025-03-04 20:50       ` Guilherme Giacomo Simoes
2025-03-04 21:00         ` Miguel Ojeda
2025-03-04 21:01           ` Miguel Ojeda
2025-03-05  7:53             ` Andreas Hindborg
2025-03-05 11:04               ` Miguel Ojeda
2025-03-05 11:08                 ` Andreas Hindborg
2025-03-06 16:18                 ` Guilherme Giacomo Simoes
2025-03-06 16:32                 ` Guilherme Giacomo Simoes
2025-03-06 16:33                   ` Miguel Ojeda
2025-03-06  1:59           ` Guilherme Giacomo Simoes
2025-03-06 11:39             ` Miguel Ojeda
2025-03-06 16:08               ` Guilherme Giacomo Simoes
2025-03-06 16:36                 ` Miguel Ojeda
2025-03-06 17:18                   ` Guilherme Giacomo Simoes
2025-03-06 17:19                     ` Miguel Ojeda
2025-03-04 11:59   ` [PATCH V6 0/2] author field in module! macro should be a array Andreas Hindborg

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=20250223174205.48404-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=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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox