Skip to contentSkip to conversation

checkpatch: add --fix option to IS_ENABLED_CONFIG check

PATCH In review Dwaipayan Ray 2 participants 4 messages Dec 7, 2020 – Dec 10, 2020 Checkpatch

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 checkpatch: add --fix option to IS_ENABLED_CONFIG check

Documentation/process/coding-style.rst specifies the use of IS_ENABLED macro:

Within code, where possible, use the IS_ENABLED macro to convert a Kconfig symbol into a C boolean expression, and use it in a normal C conditional:

	if (IS_ENABLED(CONFIG_SOMETHING)) {
		...
	}

checkpatch correspondingly has a check for IS_ENABLED() without CONFIG_<FOO>.
Add a --fix option to the check to automatically correct the argument.

Macros like:
#if IS_ENABLED(THERMAL)

is corrected to:
#if IS_ENABLED(CONFIG_THERMAL)

---
 scripts/checkpatch.pl | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +5 -2
index 7b086d1cd6c2..751cd13622b9 100755
@@ -6877,8 +6877,11 @@ sub process {
 
 # check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
 		if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
-			WARN("IS_ENABLED_CONFIG",
-			     "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
+			if (WARN("IS_ENABLED_CONFIG",
+				 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr) &&
+			    $fix) {
+				$fixed[$fixlinenr] =~ s/\bIS_ENABLED\s*\(\s*(\w+)\s*\)/IS_ENABLED(${CONFIG_}$1)/;
+			}
 		}
 
 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
Signature · 6 lines
2.27.0

_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
#1 lore raw
Quoted 45 lines · Dwaipayan Ray

Documentation/process/coding-style.rst specifies the use of IS_ENABLED macro:

Within code, where possible, use the IS_ENABLED macro to convert a Kconfig symbol into a C boolean expression, and use it in a normal C conditional:

        if (IS_ENABLED(CONFIG_SOMETHING)) {
                ...
        }

checkpatch correspondingly has a check for IS_ENABLED() without CONFIG_<FOO>.
Add a --fix option to the check to automatically correct the argument.

Macros like:
#if IS_ENABLED(THERMAL)

is corrected to:
#if IS_ENABLED(CONFIG_THERMAL)

---
 scripts/checkpatch.pl | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +5 -3
index 7b086d1cd6c2..751cd13622b9 100755
@@ -6877,8 +6877,11 @@ sub process {
 
 # check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
                if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
-                       WARN("IS_ENABLED_CONFIG",
-                            "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
+                       if (WARN("IS_ENABLED_CONFIG",
+                                "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr) &&
+                           $fix) {
+                               $fixed[$fixlinenr] =~ s/\bIS_ENABLED\s*\(\s*(\w+)\s*\)/IS_ENABLED(${CONFIG_}$1)/;
+                       }
                }
 
 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
--
Quoted 1 line

2.27.0

Hi Lukas,
You probably missed this patch.
If you are okay with it could I send it off to LKML?

Thank you,
Dwaipayan.
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

#2 lore raw
Quoted 45 lines · Dwaipayan Ray
Quoted 43 lines · Dwaipayan Ray

Documentation/process/coding-style.rst specifies the use of IS_ENABLED macro:

Within code, where possible, use the IS_ENABLED macro to convert a Kconfig symbol into a C boolean expression, and use it in a normal C conditional:

        if (IS_ENABLED(CONFIG_SOMETHING)) {
                ...
        }

checkpatch correspondingly has a check for IS_ENABLED() without CONFIG_<FOO>.
Add a --fix option to the check to automatically correct the argument.

Macros like:
#if IS_ENABLED(THERMAL)

is corrected to:
#if IS_ENABLED(CONFIG_THERMAL)

---
 scripts/checkpatch.pl | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)
scripts/checkpatch.pl +5 -2
index 7b086d1cd6c2..751cd13622b9 100755
@@ -6877,8 +6877,11 @@ sub process {
 
 # check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
                if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
-                       WARN("IS_ENABLED_CONFIG",
-                            "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
+                       if (WARN("IS_ENABLED_CONFIG",
+                                "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr) &&
+                           $fix) {
+                               $fixed[$fixlinenr] =~ s/\bIS_ENABLED\s*\(\s*(\w+)\s*\)/IS_ENABLED(${CONFIG_}$1)/;
+                       }
                }
 
Quoted 8 lines
Quoted 3 lines
scripts/checkpatch.pl +0 -1
 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
--

2.27.0

Hi Lukas,
You probably missed this patch.
If you are okay with it could I send it off to LKML?

Yes, sure, send it to Joe and LKML.

I ran as quick rough estimation: grep -e "\sIS_ENABLED" . -R | grep -v CONFIG

I think:

./lib/crypto/chacha20poly1305-selftest.c: for (total_len = POLY1305_DIGEST_SIZE; IS_ENABLED(DEBUG_CHACHA20POLY1305_SLOW_CHUNK_TEST)

could be fixed, is that right?

Lukas
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees

#3 lore raw
Quoted 10 lines

I ran as quick rough estimation: grep -e "\sIS_ENABLED" . -R | grep -v CONFIG

I think:

./lib/crypto/chacha20poly1305-selftest.c: for (total_len = POLY1305_DIGEST_SIZE; IS_ENABLED(DEBUG_CHACHA20POLY1305_SLOW_CHUNK_TEST)

could be fixed, is that right?

Yes, I think so. There were patches of this kind to correct those uses. Evidently without CONFIG_ prefix the code could be skipped. But some of those cases might be intentional as pointed here:

https://www.mail-archive.com/[email protected]/msg2184352.html

Thank you,
Dwaipayan.
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees