X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=devtools%2Fcheckpatches.sh;h=42b833e0d7cdb15eabf9a0002a94755ef6fa31e4;hb=fba5af82adc8aad741e206161800fcb94a133ab7;hp=2cf2404ba0b154b687a757786fb44e9f080c56f3;hpb=abdd314151b304eeab08528555e884544151a2e4;p=dpdk.git diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index 2cf2404ba0..42b833e0d7 100755 --- 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,27 +31,21 @@ 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 - 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 } @@ -63,7 +58,15 @@ check_forbidden_additions() { # -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 @@ -72,19 +75,82 @@ check_forbidden_additions() { # -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 + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ + "$1" || res=1 + + return $res +} + +check_experimental_tags() { # + res=0 + + cat "$1" |awk ' + BEGIN { + current_file = ""; + ret = 0; + } + /^+++ b\// { + current_file = $2; + } + /^+.*__rte_experimental/ { + if (current_file ~ ".c$" ) { + print "Please only put __rte_experimental tags in " \ + "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; + }' || res=1 + + return $res +} + +check_internal_tags() { # + res=0 + + cat "$1" |awk ' + BEGIN { + current_file = ""; + ret = 0; + } + /^+++ b\// { + current_file = $2; + } + /^+.*__rte_internal/ { + if (current_file ~ ".c$" ) { + print "Please only put __rte_internal tags in " \ + "headers ("current_file")"; + ret = 1; + } + if ($1 != "+__rte_internal" || $2 != "") { + print "__rte_internal must appear alone on the line" \ + " immediately preceding the return type of" \ + " a function." + ret = 1; + } + } + END { + exit ret; + }' || 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 ;; @@ -115,13 +181,16 @@ check () { # ! $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' @@ -148,7 +217,26 @@ check () { # <patch> <commit> <title> ret=1 fi - clean_tmp_files + ! $verbose || printf '\nChecking __rte_experimental tags:\n' + report=$(check_experimental_tags "$tmpinput") + if [ $? -ne 0 ] ; then + $headline_printed || print_headline "$3" + printf '%s\n' "$report" + ret=1 + fi + + ! $verbose || printf '\nChecking __rte_internal tags:\n' + report=$(check_internal_tags "$tmpinput") + if [ $? -ne 0 ] ; then + $headline_printed || print_headline "$3" + printf '%s\n' "$report" + ret=1 + fi + + if [ "$tmpinput" != "$1" ]; then + rm -f "$tmpinput" + trap - INT + fi [ $ret -eq 0 ] && return 0 status=$(($status + 1)) @@ -172,7 +260,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