devtools: check coverity and bugzilla tags
[dpdk.git] / devtools / checkpatches.sh
index d150353..b16bace 100755 (executable)
@@ -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
@@ -33,14 +34,7 @@ PREFER_KERNEL_TYPES,BIT_MACRO,CONST_STRUCT,\
 SPLIT_STRING,LONG_LINE_STRING,\
 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,7 @@ 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
 
        # svg figures must be included with wildcard extension
@@ -73,7 +67,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
@@ -96,6 +90,11 @@ check_experimental_tags() { # <patch>
                                "headers ("current_file")";
                        ret = 1;
                }
+               if ($1 != "+__rte_experimental" || $2 != "") {
+                       print "__rte_experimental must appear alone on the line" \
+                               " immediately preceding the return type of a function."
+                       ret = 1;
+               }
        }
        END {
                exit ret;
@@ -143,13 +142,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'
@@ -184,7 +186,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))