path: root/scripts
diff options
authorNicolas Palix <npalix@diku.dk>2010-06-06 17:15:01 +0200
committerMichal Marek <mmarek@suse.cz>2010-06-12 00:00:29 +0200
commit74425eee71eb44c9f370bd922f72282b69bb0eab (patch)
tree2ae2900a70a163653b1f734fd6eeb5d24a05e376 /scripts
parent64ffc9ff424c65adcffe7d590018cc75e2d5d42a (diff)
Add a target to use the Coccinelle checker
A 'coccicheck' target is added. It can be called with four different modes. Each one generates a different kind of output, i.e. context, patch, org, report, according to the corresponding mode to be activated. The new target calls the 'coccicheck' front-end in the 'scripts' directory with the MODE argument. Every SmPL file in the subdirectories of 'scripts/coccinelle' is then given to the front-end and applied to the entire source tree. The four modes behave as follows: 'report' generates a list in the following format: file:line:column-column: message 'patch' proposes a fix, when possible. 'context' highlights lines of interest and their context in a diff-like style. Lines of interest are indicated with '-'. 'org' generates a report in the Org mode format of Emacs. Signed-off-by: Nicolas Palix <npalix@diku.dk> Signed-off-by: Julia Lawall <julia@diku.dk> Acked-by: Sam Ravnborg <sam@ravnborg.org> Acked-by: Joerg Roedel <joerg.roedel@amd.com> Signed-off-by: Michal Marek <mmarek@suse.cz>
Diffstat (limited to 'scripts')
2 files changed, 57 insertions, 0 deletions
diff --git a/scripts/Makefile.help b/scripts/Makefile.help
new file mode 100644
index 00000000000..d03608f5db0
--- /dev/null
+++ b/scripts/Makefile.help
@@ -0,0 +1,3 @@
+ @echo ' coccicheck - Check with Coccinelle.'
diff --git a/scripts/coccicheck b/scripts/coccicheck
new file mode 100755
index 00000000000..037424b9ede
--- /dev/null
+++ b/scripts/coccicheck
@@ -0,0 +1,54 @@
+SPATCH="`which ${SPATCH:=spatch}`"
+if [ ! -x "$SPATCH" ]; then
+ echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
+ exit 1
+if [ "$MODE" = "" ] ; then
+ echo 'You have not explicitly specify the mode to use. Fallback to "report".'
+ echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
+ echo 'Available modes are: report, patch, context, org'
+ MODE="report"
+echo ''
+echo 'Please check for false positives in the output before submitting a patch.'
+echo 'When using "patch" mode, carefully review the patch before submitting it.'
+echo ''
+function coccinelle {
+ COCCI="$1"
+ DIR="$2"
+ OPT=`grep "Option" $COCCI | cut -d':' -f2`
+ FILE=`echo $COCCI | sed "s|$DIR/||"`
+ echo "Processing `basename $COCCI` with option(s) \"$OPT\""
+ echo 'Message example to submit a patch:'
+ sed -e '/\/\/\//!d' -e 's|^///||' $COCCI
+ echo ' The semantic patch that makes this change is available'
+ echo " in $FILE."
+ echo ''
+ echo ' More information about semantic patching is available at'
+ echo ' http://coccinelle.lip6.fr/'
+ echo ''
+# The option '-parse_cocci' can be used to syntaxically check the SmPL files.
+# $SPATCH -D $MODE -very_quiet -parse_cocci $COCCI $OPT > /dev/null
+ $SPATCH -D $MODE -very_quiet -sp_file $COCCI $OPT -dir $DIR
+if [ "$COCCI" = "" ] ; then
+ for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
+ coccinelle $f $srctree;
+ done
+ coccinelle $COCCI $srctree