Commit 5c384dba authored by Luis R. Rodriguez's avatar Luis R. Rodriguez Committed by Michal Marek
Browse files

coccicheck: replace --very-quiet with --quiet when debugging 



When debugging (using --profile or --show-trying) you want to
avoid supressing output,  use --quiet instead. While at it, extend
documentation for SPFLAGS use.

For instance one can use:

$ export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci
$ make coccicheck DEBUG_FILE="poo.err" MODE=report SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c

Expand Documentation/coccinelle.txt as well.

v4: expand Documentation/coccinelle.txt
v3: rebased, resolve conflicts, expand Documentation/coccinelle.txt
v2: use egrep instead of the *"=--option"* check, this doesn't work for
    disjunctions.

Signed-off-by: default avatarLuis R. Rodriguez <mcgrof@kernel.org>
Acked-by: default avatarJulia Lawall <julia.lawall@lip6.fr>
Signed-off-by: default avatarMichal Marek <mmarek@suse.com>
parent be1fa900

Documentation/coccinelle.txt

+12 −0
Original line number Diff line number Diff line
@@ -175,6 +175,18 @@ instance: 
    make coccicheck COCCI=scripts/coccinelle/free/kfree.cocci MODE=report DEBUG_FILE=cocci.err

    cat cocci.err



You can use SPFLAGS to add debugging flags, for instance you may want to

add both --profile --show-trying to SPFLAGS when debugging. For instance

you may want to use:



    rm -f err.log

    export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci

    make coccicheck DEBUG_FILE="err.log" MODE=report SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c



err.log will now have the profiling information, while stdout will

provide some progress information as Coccinelle moves forward with

work.



DEBUG_FILE support is only supported when using coccinelle >= 1.2.



 Additional flags

scripts/coccicheck

+21 −0
Original line number Diff line number Diff line
@@ -32,6 +32,27 @@ fi 


FLAGS="--very-quiet"



# You can use SPFLAGS to append extra arguments to coccicheck or override any

# heuristics done in this file as Coccinelle accepts the last options when

# options conflict.

#

# A good example for use of SPFLAGS is if you want to debug your cocci script,

# you can for instance use the following:

#

# $ export COCCI=scripts/coccinelle/misc/irqf_oneshot.cocci

# $ make coccicheck MODE=report DEBUG_FILE="all.err" SPFLAGS="--profile --show-trying" M=./drivers/mfd/arizona-irq.c

#

# "--show-trying" should show you what rule is being processed as it goes to

# stdout, you do not need a debug file for that. The profile output will be

# be sent to stdout, if you provide a DEBUG_FILE the profiling data can be

# inspected there.

#

# --profile will not output if --very-quiet is used, so avoid it.

echo $SPFLAGS | egrep -e "--profile|--show-trying" 2>&1 > /dev/null

if [ $? -eq 0 ]; then

	FLAGS="--quiet"

fi



# spatch only allows include directories with the syntax "-I include"

# while gcc also allows "-Iinclude" and "-include include"

COCCIINCLUDE=${LINUXINCLUDE//-I/-I }

CRA Git | Maintained and supported by SUSTech CRA and CCSE