The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Andrew Jones <andrew.jones@linux.dev>
To: linux-kernel@vger.kernel.org
Cc: apw@canonical.com, joe@perches.com, dwaipayanray1@gmail.com,
	lukas.bulwahn@gmail.com, andriy.shevchenko@linux.intel.com
Subject: [PATCH] checkpatch: warn on uppercase N/Y/M as Kconfig tristate literals
Date: Wed, 13 May 2026 15:57:45 -0500	[thread overview]
Message-ID: <20260513205745.636737-1-andrew.jones@linux.dev> (raw)

Kconfig tristate literals are always lowercase ('n', 'y', 'm') and
uppercase N/Y/M are not Kconfig reserved words. Since undefined
symbols evaluate to 'n', writing 'default Y' or 'default M' silently
produces 'n' instead of 'y'/'m'. 'default N' happens to produce the
right value but is still invalid syntax.

Add a warning for N/Y/M in Kconfig expressions found by following
the same preprocessing logic used by the Kconfig parser itself.

This new warning was inspired by work done for [1].

Link: https://bugzilla.kernel.org/show_bug.cgi?id=216748 [1]
Assisted-by: Claude:claude-sonnet-4-6
Signed-off-by: Andrew Jones <andrew.jones@linux.dev>
---

Fixes such as [2] have already been posted for a few uses.
[2] https://lore.kernel.org/lkml/20260513162758.365972-1-andriy.shevchenko@linux.intel.com/

 scripts/checkpatch.pl | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index 3727156e4cca..aae6c3e7aa51 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -3732,6 +3732,21 @@ sub process {
 			}
 		}
 
+# check for uppercase N/Y/M used as Kconfig tristate literals
+		if ($realfile =~ /Kconfig/ &&
+		    $line =~ /^\+\s*(?:default|def_bool|def_tristate|select|imply|depends\s+on|visible\s+if|range|if)\s+(.+)$/) {
+			my $expr = $1;
+			$expr =~ s/#.*//;		# strip inline comments
+			$expr =~ s/\$\(.*\)//g;	# strip $(macro) expansions
+			$expr =~ s/"[^"]*"//g;		# strip "quoted strings"
+			$expr =~ s/'[^']*'//g;		# strip 'quoted strings'
+			for my $tok (split /[^A-Za-z0-9_]+/, $expr) {
+				next unless ($tok eq 'Y' || $tok eq 'M' || $tok eq 'N');
+				WARN("KCONFIG_TRISTATE_UPPERCASE",
+				     "'$tok' is probably not what you want here; Kconfig tristate literals are always lowercase ('n', 'y', 'm')\n" . $herecurr);
+			}
+		}
+
 # check MAINTAINERS entries
 		if ($realfile =~ /^MAINTAINERS$/) {
 # check MAINTAINERS entries for the right form
-- 
2.43.0


             reply	other threads:[~2026-05-13 20:58 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-05-13 20:57 Andrew Jones [this message]
2026-05-13 21:03 ` [PATCH] checkpatch: warn on uppercase N/Y/M as Kconfig tristate literals Andy Shevchenko

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=20260513205745.636737-1-andrew.jones@linux.dev \
    --to=andrew.jones@linux.dev \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=apw@canonical.com \
    --cc=dwaipayanray1@gmail.com \
    --cc=joe@perches.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.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