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

coccicheck: add support for requring a coccinelle version 



Enable Coccinelle SmPL patches to require a specific version of
Coccinelle. In the event that the version does not match we just
inform the user, if the user asked to go through all SmPL patches
we just inform them of the need for a new version of coccinelle for
the SmPL patch and continue on with the rest.

This uses the simple kernel scripts/ld-version.sh to create a weight
on the version provided by spatch. The -dirty attribute is ignored if
supplied, the benefit of scripts/ld-version.sh is it has a long history
and well tested.

While at it, document the // Options stuff as well.

v4: Document // Options and // Requires as well on
    Documentation/coccinelle.txt.

Signed-off-by: default avatarLuis R. Rodriguez <mcgrof@kernel.org>
Acked-by: default avatarNicolas Palix <nicolas.palix@imag.fr>
Signed-off-by: default avatarMichal Marek <mmarek@suse.com>
parent dd951fc1

Documentation/coccinelle.txt

+19 −0
Original line number Diff line number Diff line
@@ -277,6 +277,25 @@ thus active by default. However, by indexing the code with 
one of these tools, and according to the cocci file used,

spatch could proceed the entire code base more quickly.



 SmPL patch specific options

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



SmPL patches can have their own requirements for options passed

to Coccinelle. SmPL patch specific options can be provided by

providing them at the top of the SmPL patch, for instance:



// Options: --no-includes --include-headers



 SmPL patch Coccinelle requirements

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



As Coccinelle features get added some more advanced SmPL patches

may require newer versions of Coccinelle. If an SmPL patch requires

at least a version of Coccinelle, this can be specified as follows,

as an example if requiring at least Coccinelle >= 1.0.5:



// Requires: 1.0.5



 Proposing new semantic patches

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

scripts/coccicheck

+14 −0
Original line number Diff line number Diff line
@@ -5,6 +5,7 @@ 
# version 1.0.0-rc11.

#



DIR="$(dirname $(readlink -f $0))/.."

SPATCH="`which ${SPATCH:=spatch}`"



if [ ! -x "$SPATCH" ]; then
@@ -12,6 +13,9 @@ if [ ! -x "$SPATCH" ]; then 
    exit 1

fi



SPATCH_VERSION=$($SPATCH --version | head -1 | awk '{print $3}')

SPATCH_VERSION_NUM=$(echo $SPATCH_VERSION | ${DIR}/scripts/ld-version.sh)



USE_JOBS="no"

$SPATCH --help | grep "\-\-jobs" > /dev/null && USE_JOBS="yes"
@@ -171,6 +175,16 @@ coccinelle () { 
    COCCI="$1"



    OPT=`grep "Option" $COCCI | cut -d':' -f2`

    REQ=`grep "Requires" $COCCI | cut -d':' -f2 | sed "s| ||"`

    REQ_NUM=$(echo $REQ | ${DIR}/scripts/ld-version.sh)

    if [ "$REQ_NUM" != "0" ] ; then

	    if [ "$SPATCH_VERSION_NUM" -lt "$REQ_NUM" ] ; then

		    echo "Skipping coccinele SmPL patch: $COCCI"

		    echo "You have coccinelle:           $SPATCH_VERSION"

		    echo "This SmPL patch requires:      $REQ"

		    return

	    fi

    fi



#   The option '--parse-cocci' can be used to syntactically check the SmPL files.

#

CRA Git | Maintained and supported by SUSTech CRA and CCSE