From: Paul Gortmaker <paul.gortmaker@windriver.com>
To: Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Jiri Slaby <jslaby@suse.cz>
Cc: <linux-kernel@vger.kernel.org>,
Paul Gortmaker <paul.gortmaker@windriver.com>,
Joe Perches <joe@perches.com>, Andy Whitcroft <apw@canonical.com>,
Arnd Bergmann <arnd@arndb.de>,
Geert Uytterhoeven <geert@linux-m68k.org>
Subject: [PATCH 4/4] checkpatch: only allow COMPILE_TEST in Kconfig dependency lines
Date: Thu, 4 Jul 2013 01:39:13 -0400 [thread overview]
Message-ID: <1372916353-24050-5-git-send-email-paul.gortmaker@windriver.com> (raw)
In-Reply-To: <1372916353-24050-1-git-send-email-paul.gortmaker@windriver.com>
The option CONFIG_COMPILE_TEST, added in commit 4bb1667255a
("build some drivers only when compile-testing") is meant to
give a middle ground[1] between those who want the widest compile
coverage possible (e.g. building sparc drivers for mips) and
those who want dependencies to represent real world systems
(e.g. don't allow me to see OMAP options when building x86).
As such, this addition is meant to be used in dependency lines,
properly or'd in with the real world hardware dependency. Those
who select it, get wide compile coverage. Those who do not, get
real world dependencies that match where the hardware is available
and/or where the driver is useful.
With that in mind, it is clear that this is _not_ to be used in
any C code with "#ifdef CONFIG_COMPILE_TEST" etc. However there
will (and already has been) instances of people thinking this is
an OK practice[2]. So teach checkpatch to spot them as an error.
[1] https://lkml.org/lkml/2013/3/7/456
[2] https://lkml.org/lkml/2013/7/1/641
Cc: Joe Perches <joe@perches.com>
Cc: Andy Whitcroft <apw@canonical.com>
Cc: Arnd Bergmann <arnd@arndb.de>
Cc: Geert Uytterhoeven <geert@linux-m68k.org>
Cc: Jiri Slaby <jslaby@suse.cz>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: Paul Gortmaker <paul.gortmaker@windriver.com>
---
scripts/checkpatch.pl | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index b954de5..c0871a3 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -1922,6 +1922,12 @@ sub process {
"Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
}
+# disallow the addition of CONFIG_COMPILE_TEST in #if(def).
+ if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_COMPILE_TEST\b/) {
+ ERROR("CONFIG_COMPILE_TEST",
+ "Use of COMPILE_TEST is only allowed in Kconfig dependency lines.\n");
+ }
+
# check for RCS/CVS revision markers
if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
WARN("CVS_KEYWORD",
--
1.8.1.2
next prev parent reply other threads:[~2013-07-04 5:41 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-07-04 5:39 [RFC PATCH 0/4] CONFIG_COMPILE_TEST: additional examples and checkpatch rule Paul Gortmaker
2013-07-04 5:39 ` [PATCH 1/4] usb: limit OMAP related USB options to OMAP2PLUS platforms Paul Gortmaker
2013-07-08 7:56 ` Felipe Balbi
2013-07-04 5:39 ` [PATCH 2/4] power: make goldfish_battery depend on GOLDFISH || COMPILE_TEST Paul Gortmaker
2013-08-09 20:32 ` Anton Vorontsov
2013-07-04 5:39 ` [PATCH 3/4] video: make goldfish video " Paul Gortmaker
2013-07-04 5:39 ` Paul Gortmaker [this message]
2013-07-04 8:10 ` [PATCH 4/4] checkpatch: only allow COMPILE_TEST in Kconfig dependency lines Geert Uytterhoeven
2013-07-04 8:55 ` Arnd Bergmann
2013-07-04 15:41 ` Joe Perches
2013-07-04 17:09 ` Paul Gortmaker
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=1372916353-24050-5-git-send-email-paul.gortmaker@windriver.com \
--to=paul.gortmaker@windriver.com \
--cc=apw@canonical.com \
--cc=arnd@arndb.de \
--cc=geert@linux-m68k.org \
--cc=gregkh@linuxfoundation.org \
--cc=joe@perches.com \
--cc=jslaby@suse.cz \
--cc=linux-kernel@vger.kernel.org \
/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.