devtools: select patches to check with git range

[dpdk.git] / devtools / checkpatches.sh

diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh
index e97a4f2..6a01b39 100755 (executable)
--- a/devtools/checkpatches.sh
+++ b/devtools/checkpatches.sh
@@ -4,15 +4,26 @@
 
 # Load config options:
 # - DPDK_CHECKPATCH_PATH
+# - DPDK_CHECKPATCH_CODESPELL
 # - DPDK_CHECKPATCH_LINE_LENGTH
 . $(dirname $(readlink -e $0))/load-devel-config
 
 VALIDATE_NEW_API=$(dirname $(readlink -e $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
+# to a dictionary.txt file if dictionary.txt is not in the default location.
+codespell=${DPDK_CHECKPATCH_CODESPELL:-enable}
 length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
 
 # override default Linux options
 options="--no-tree"
+if [ "$codespell" = "enable" ] ; then
+    options="$options --codespell"
+elif [ -f "$codespell" ] ; then
+    options="$options --codespell"
+    options="$options --codespellfile $codespell"
+fi
 options="$options --max-line-length=$length"
 options="$options --show-types"
 options="$options --ignore=LINUX_VERSION_CODE,\
@@ -29,27 +40,54 @@ clean_tmp_files() {
        fi
 }
 
-trap "clean_tmp_files" SIGINT
+trap "clean_tmp_files" INT
 
 print_usage () {
        cat <<- END_OF_HELP
-       usage: $(basename $0) [-q] [-v] [-nX|patch1 [patch2] ...]]
+       usage: $(basename $0) [-q] [-v] [-nX|-r range|patch1 [patch2] ...]]
 
        Run Linux kernel checkpatch.pl with DPDK options.
        The environment variable DPDK_CHECKPATCH_PATH must be set.
 
        The patches to check can be from stdin, files specified on the command line,
-       or latest git commits limited with -n option (default limit: origin/master).
+       latest git commits limited with -n option, or commits in the git range
+       specified with -r option (default: "origin/master..").
        END_OF_HELP
 }
 
+check_forbidden_additions() { # <patch>
+       res=0
+
+       # refrain from new additions of rte_panic() and rte_exit()
+       # multiple folders and expressions are separated by spaces
+       awk -v FOLDERS="lib drivers" \
+               -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 \
+               "$1" || res=1
+
+       # svg figures must be included with wildcard extension
+       # because of png conversion for pdf docs
+       awk -v FOLDERS='doc' \
+               -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 \
+               "$1" || res=1
+
+       return $res
+}
+
 number=0
+range='origin/master..'
 quiet=false
 verbose=false
-while getopts hn:qv ARG ; do
+while getopts hn:qr:v ARG ; do
        case $ARG in
                n ) number=$OPTARG ;;
                q ) quiet=true ;;
+               r ) range=$OPTARG ;;
                v ) verbose=true ;;
                h ) print_usage ; exit 0 ;;
                ? ) print_usage ; exit 1 ;;
@@ -64,28 +102,35 @@ if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
        exit 1
 fi
 
+print_headline() { # <title>
+       printf '\n### %s\n\n' "$1"
+       headline_printed=true
+}
+
 total=0
 status=0
 
 check () { # <patch> <commit> <title>
        local ret=0
+       headline_printed=false
 
        total=$(($total + 1))
-       ! $verbose || printf '\n### %s\n\n' "$3"
+       ! $verbose || print_headline "$3"
        if [ -n "$1" ] ; then
                tmpinput=$1
        elif [ -n "$2" ] ; then
-               tmpinput=$(mktemp checkpatches.XXXXXX)
+               tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
                git format-patch --find-renames \
                --no-stat --stdout -1 $commit > "$tmpinput"
        else
-               tmpinput=$(mktemp checkpatches.XXXXXX)
+               tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
                cat > "$tmpinput"
        fi
 
+       ! $verbose || printf 'Running checkpatch.pl:\n'
        report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null)
        if [ $? -ne 0 ] ; then
-               $verbose || printf '\n### %s\n\n' "$3"
+               $headline_printed || print_headline "$3"
                printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p'
                ret=1
        fi
@@ -93,6 +138,15 @@ check () { # <patch> <commit> <title>
        ! $verbose || printf '\nChecking API additions/removals:\n'
        report=$($VALIDATE_NEW_API "$tmpinput")
        if [ $? -ne 0 ] ; then
+               $headline_printed || print_headline "$3"
+               printf '%s\n' "$report"
+               ret=1
+       fi
+
+       ! $verbose || printf '\nChecking forbidden tokens additions:\n'
+       report=$(check_forbidden_additions "$tmpinput")
+       if [ $? -ne 0 ] ; then
+               $headline_printed || print_headline "$3"
                printf '%s\n' "$report"
                ret=1
        fi
@@ -121,7 +175,7 @@ elif [ ! -t 0 ] ; then # stdin
        check '' '' "$subject"
 else
        if [ $number -eq 0 ] ; then
-               commits=$(git rev-list --reverse origin/master..)
+               commits=$(git rev-list --reverse $range)
        else
                commits=$(git rev-list --reverse --max-count=$number HEAD)
        fi