devtools: check use of compiler attributes

[dpdk.git] / devtools / checkpatches.sh

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index dbdf08e..c30ce64 100755 (executable)
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -6,9 +6,10 @@
 # - DPDK_CHECKPATCH_PATH
 # - DPDK_CHECKPATCH_CODESPELL
 # - DPDK_CHECKPATCH_LINE_LENGTH
-. $(dirname $(readlink -e $0))/load-devel-config
+# - DPDK_CHECKPATCH_OPTIONS
+. $(dirname $(readlink -f $0))/load-devel-config
 
-VALIDATE_NEW_API=$(dirname $(readlink -e $0))/check-symbol-change.sh
+VALIDATE_NEW_API=$(dirname $(readlink -f $0))/check-symbol-change.sh
 
 # Enable codespell by default. This can be overwritten from a config file.
 # Codespell can also be enabled by setting DPDK_CHECKPATCH_CODESPELL to a valid path
@@ -30,17 +31,10 @@ options="$options --ignore=LINUX_VERSION_CODE,\
 FILE_PATH_CHANGES,MAINTAINERS_STYLE,SPDX_LICENSE_TAG,\
 VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,\
 PREFER_KERNEL_TYPES,BIT_MACRO,CONST_STRUCT,\
-SPLIT_STRING,LONG_LINE_STRING,\
+SPLIT_STRING,LONG_LINE_STRING,C99_COMMENT_TOLERANCE,\
 LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
 NEW_TYPEDEFS,COMPARISON_TO_NULL"
-
-clean_tmp_files() {
-       if echo $tmpinput | grep -q '^checkpatches\.' ; then
-               rm -f "$tmpinput"
-       fi
-}
-
-trap "clean_tmp_files" INT
+options="$options $DPDK_CHECKPATCH_OPTIONS"
 
 print_usage () {
        cat <<- END_OF_HELP
@@ -64,7 +58,15 @@ check_forbidden_additions() { # <patch>
                -v EXPRESSIONS="rte_panic\\\( rte_exit\\\(" \
                -v RET_ON_FAIL=1 \
                -v MESSAGE='Using rte_panic/rte_exit' \
-               -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
+               "$1" || res=1
+
+       # refrain from using compiler attribute without defining a common macro
+       awk -v FOLDERS="lib drivers app examples" \
+               -v EXPRESSIONS="__attribute__" \
+               -v RET_ON_FAIL=1 \
+               -v MESSAGE='Using compiler attribute directly' \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
                "$1" || res=1
 
        # svg figures must be included with wildcard extension
@@ -73,7 +75,7 @@ check_forbidden_additions() { # <patch>
                -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
                -v RET_ON_FAIL=1 \
                -v MESSAGE='Using explicit .svg extension instead of .*' \
-               -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
+               -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \
                "$1" || res=1
 
        return $res
@@ -148,13 +150,16 @@ check () { # <patch> <commit> <title>
        ! $verbose || print_headline "$3"
        if [ -n "$1" ] ; then
                tmpinput=$1
-       elif [ -n "$2" ] ; then
-               tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
-               git format-patch --find-renames \
-               --no-stat --stdout -1 $commit > "$tmpinput"
        else
                tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
-               cat > "$tmpinput"
+               trap "rm -f '$tmpinput'" INT
+
+               if [ -n "$2" ] ; then
+                       git format-patch --find-renames \
+                       --no-stat --stdout -1 $commit > "$tmpinput"
+               else
+                       cat > "$tmpinput"
+               fi
        fi
 
        ! $verbose || printf 'Running checkpatch.pl:\n'
@@ -189,7 +194,10 @@ check () { # <patch> <commit> <title>
                ret=1
        fi
 
-       clean_tmp_files
+       if [ "$tmpinput" != "$1" ]; then
+               rm -f "$tmpinput"
+               trap - INT
+       fi
        [ $ret -eq 0 ] && return 0
 
        status=$(($status + 1))