Coccinelle: Improve user information with a new kind of comment
[cascardo/linux.git] / scripts / coccicheck
1 #!/bin/sh
2
3 SPATCH="`which ${SPATCH:=spatch}`"
4
5 if [ "$C" = "1" -o "$C" = "2" ]; then
6     ONLINE=1
7
8 # This requires Coccinelle >= 0.2.3
9 #    FLAGS="-ignore_unknown_options -very_quiet"
10 #    OPTIONS=$*
11
12 # Workaround for Coccinelle < 0.2.3
13     FLAGS="-I $srctree/include -very_quiet"
14     shift $(( $# - 1 ))
15     OPTIONS=$1
16 else
17     ONLINE=0
18     FLAGS="-very_quiet"
19 fi
20
21 if [ ! -x "$SPATCH" ]; then
22     echo 'spatch is part of the Coccinelle project and is available at http://coccinelle.lip6.fr/'
23     exit 1
24 fi
25
26 if [ "$MODE" = "" ] ; then
27     if [ "$ONLINE" = "0" ] ; then
28         echo 'You have not explicitly specified the mode to use. Fallback to "report".'
29         echo 'You can specify the mode with "make coccicheck MODE=<mode>"'
30         echo 'Available modes are: report, patch, context, org'
31     fi
32     MODE="report"
33 fi
34
35 if [ "$ONLINE" = "0" ] ; then
36     echo ''
37     echo 'Please check for false positives in the output before submitting a patch.'
38     echo 'When using "patch" mode, carefully review the patch before submitting it.'
39     echo ''
40 fi
41
42 coccinelle () {
43     COCCI="$1"
44
45     OPT=`grep "Option" $COCCI | cut -d':' -f2`
46
47 #   The option '-parse_cocci' can be used to syntaxically check the SmPL files.
48 #
49 #    $SPATCH -D $MODE $FLAGS -parse_cocci $COCCI $OPT > /dev/null
50
51     if [ "$ONLINE" = "0" ] ; then
52
53         FILE=`echo $COCCI | sed "s|$srctree/||"`
54
55         echo "Processing `basename $COCCI`"
56         echo "with option(s) \"$OPT\""
57         echo ''
58         echo 'Message example to submit a patch:'
59
60         sed -ne 's|^///||p' $COCCI
61
62         echo ' The semantic patch that makes this change is available'
63         echo " in $FILE."
64         echo ''
65         echo ' More information about semantic patching is available at'
66         echo ' http://coccinelle.lip6.fr/'
67         echo ''
68
69         if [ "`sed -ne 's|^//#||p' $COCCI`" ] ; then
70             echo 'Semantic patch information:'
71             sed -ne 's|^//#||p' $COCCI
72             echo ''
73         fi
74
75         $SPATCH -D $MODE $FLAGS -sp_file $COCCI $OPT -dir $srctree || exit 1
76     else
77         $SPATCH -D $MODE $FLAGS -sp_file $COCCI $OPT $OPTIONS || exit 1
78     fi
79
80 }
81
82 if [ "$COCCI" = "" ] ; then
83     for f in `find $srctree/scripts/coccinelle/ -name '*.cocci' -type f | sort`; do
84         coccinelle $f
85     done
86 else
87     coccinelle $COCCI
88 fi