checkpatch: add --fix option to include linux checks
PATCH v3 1/1 checkpatch: add --fix option to include linux checks
Add fix option to INCLUDE_LINUX and ARCH_INCLUDE_LINUX checks to replace asm includes.
Macros of type:
#include <asm/percpu.h>
#include <asm/processor.h>
are corrected to:
#include <linux/percpu.h>
#include <linux/processor.h>
---
Changes in v3:
- Add --fix option to ARCH_INCLUDE_LINUX check
Changes in v2:
- Use \Q..\E quoting
- Use @ as regex delimiter
scripts/checkpatch.pl | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)
scripts/checkpatch.pl +10 -4
@@ -5558,11 +5558,17 @@ sub process { my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; if ($asminclude > 0) { if ($realfile =~ m{^arch/}) { - CHK("ARCH_INCLUDE_LINUX", - "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); + if (CHK("ARCH_INCLUDE_LINUX", + "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s@\Q<asm/$file>\E@<linux/$file>@; + } } else { - WARN("INCLUDE_LINUX", - "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); + if (WARN("INCLUDE_LINUX", + "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s@\Q<asm/$file>\E@<linux/$file>@; + } } } }
Signature · 6 lines
2.27.0 _______________________________________________ Linux-kernel-mentees mailing list [email protected] https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 8 lines · Dwaipayan Ray
Add fix option to
INCLUDE_LINUXandARCH_INCLUDE_LINUXchecks to replace asm includes.Macros of type:
#include <asm/percpu.h>
#include <asm/processor.h>
Quoted 5 lines
are corrected to:
#include <linux/percpu.h>
#include <linux/processor.h>Signed-off-by Dwaipayan Ray <[email protected]>
Dwaipayan, can you run this rule from checkpatch.pl on all files in the current linux-next tree and share all findings with me?
Maybe, we can fix a few places and improve the rule.
Lukas
Quoted 38 lines
---
Changes in v3:
- Add --fix option toARCH_INCLUDE_LINUXcheckChanges in v2:
- Use \Q..\E quoting
- Use @ as regex delimiterscripts/checkpatch.pl | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-)scripts/checkpatch.pl +10
-5@@ -5558,11 +5558,17 @@ sub process { my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; if ($asminclude > 0) { if ($realfile =~ m{^arch/}) { - CHK("ARCH_INCLUDE_LINUX", - "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); + if (CHK("ARCH_INCLUDE_LINUX", + "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s@\Q<asm/$file>\E@<linux/$file>@; + } } else { - WARN("INCLUDE_LINUX", - "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); + if (WARN("INCLUDE_LINUX", + "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr) && + $fix) { + $fixed[$fixlinenr] =~ s@\Q<asm/$file>\E@<linux/$file>@; + } } } } --
Quoted 2 lines
2.27.0
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees
Quoted 7 lines
Dwaipayan, can you run this rule from checkpatch.pl on all files in the current linux-next tree and share all findings with me?
Maybe, we can fix a few places and improve the rule.
Lukas
Hi,
I am actually a bit confused here. I couldn't find any particular place in documentation which demarcates where to include asm or linux headers. As far as my understanding, include/linux headers are meant to be architecture independent.
There are several places in the kernel tree which use the <asm/*> headers. Checkpatch emits warnings for the following headers in kernel/ :
kernel/dma/swiotlb.c:43:#include <asm/io.h> kernel/exit.c:69:#include <asm/mmu_context.h> kernel/fork.c:103:#include <asm/mmu_context.h> kernel/irq_work.c:21:#include <asm/processor.h> kernel/module-internal.h:9:#include <asm/module.h> kernel/module.c:45:#include <asm/mmu_context.h> kernel/resource.c:27:#include <asm/io.h> kernel/power/snapshot.c:36:#include <asm/mmu_context.h> kernel/power/snapshot.c:38:#include <asm/io.h> kernel/sys.c:73:#include <asm/io.h> kernel/sysctl.c:78:#include <asm/processor.h> kernel/sysctl.c:81:#include <asm/nmi.h> kernel/sysctl.c:83:#include <asm/io.h> kernel/time/timer.c:52:#include <asm/io.h>
drivers/ had yet a more number of such uses.
I am not entirely sure that changing them will break more stuff or not. It would be great to have your opinions on this as experienced kernel programmers.
Thank you,
Dwaipayan.
_______________________________________________
Linux-kernel-mentees mailing list
[email protected]
https://lists.linuxfoundation.org/mailman/listinfo/linux-kernel-mentees