X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=devtools%2Fcheckpatches.sh;h=8e2beee16f8ff569364b553e56dd19389c737269;hb=4a4a20c4775b578379fc964952b0bbcff1ac88d6;hp=2bb5458964acd0687d19b3f77f56adbb96818d3d;hpb=515e92ebb6b1cc29756fa5a6067655a24468a4d1;p=dpdk.git diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index 2bb5458964..8e2beee16f 100755 --- a/devtools/checkpatches.sh +++ b/devtools/checkpatches.sh @@ -1,73 +1,125 @@ #! /bin/sh - -# BSD LICENSE -# +# SPDX-License-Identifier: BSD-3-Clause # Copyright 2015 6WIND S.A. -# -# Redistribution and use in source and binary forms, with or without -# modification, are permitted provided that the following conditions -# are met: -# -# * Redistributions of source code must retain the above copyright -# notice, this list of conditions and the following disclaimer. -# * Redistributions in binary form must reproduce the above copyright -# notice, this list of conditions and the following disclaimer in -# the documentation and/or other materials provided with the -# distribution. -# * Neither the name of 6WIND S.A. nor the names of its -# contributors may be used to endorse or promote products derived -# from this software without specific prior written permission. -# -# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. # Load config options: # - 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 -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 +# 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,\ -FILE_PATH_CHANGES,MAINTAINERS_STYLE,\ +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,\ LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\ NEW_TYPEDEFS,COMPARISON_TO_NULL" +options="$options $DPDK_CHECKPATCH_OPTIONS" + +clean_tmp_files() { + if echo $tmpinput | grep -q '^checkpatches\.' ; then + rm -f "$tmpinput" + fi +} + +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() { # + 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 -f $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 -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 +} + 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 ;; @@ -82,23 +134,66 @@ if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then exit 1 fi +print_headline() { # + 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 - report=$($DPDK_CHECKPATCH_PATH $options "$1" 2>/dev/null) + tmpinput=$1 elif [ -n "$2" ] ; then - report=$(git format-patch --find-renames --no-stat --stdout -1 $commit | - $DPDK_CHECKPATCH_PATH $options - 2>/dev/null) + tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX) + git format-patch --find-renames \ + --no-stat --stdout -1 $commit > "$tmpinput" else - report=$($DPDK_CHECKPATCH_PATH $options - 2>/dev/null) + 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 + $headline_printed || print_headline "$3" + printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p' + ret=1 + fi + + ! $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 - [ $? -ne 0 ] || return 0 - $verbose || printf '\n### %s\n\n' "$3" - printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p' + + ! $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 + + clean_tmp_files + [ $ret -eq 0 ] && return 0 + status=$(($status + 1)) } @@ -120,7 +215,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