X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;ds=sidebyside;f=devtools%2Fcheckpatches.sh;h=c314d83a29d3196d9e8b854d64984d45cf64ff1c;hb=6018b5ac7477c6ba8fbf28128dd4ebbafbeaffd0;hp=27ab1252b73165267eff4b7918536090d1d83d75;hpb=5a3f804159bafdaa218daf4c08d1ed2d88781e17;p=dpdk.git diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index 27ab1252b7..c314d83a29 100755 --- a/devtools/checkpatches.sh +++ b/devtools/checkpatches.sh @@ -30,7 +30,7 @@ options="$options --show-types" options="$options --ignore=LINUX_VERSION_CODE,ENOSYS,\ FILE_PATH_CHANGES,MAINTAINERS_STYLE,SPDX_LICENSE_TAG,\ VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,\ -PREFER_KERNEL_TYPES,BIT_MACRO,CONST_STRUCT,\ +PREFER_KERNEL_TYPES,PREFER_FALLTHROUGH,BIT_MACRO,CONST_STRUCT,\ SPLIT_STRING,LONG_LINE_STRING,C99_COMMENT_TOLERANCE,\ LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\ NEW_TYPEDEFS,COMPARISON_TO_NULL" @@ -38,14 +38,14 @@ options="$options $DPDK_CHECKPATCH_OPTIONS" print_usage () { cat <<- END_OF_HELP - usage: $(basename $0) [-q] [-v] [-nX|-r range|patch1 [patch2] ...]] + usage: $(basename $0) [-h] [-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, latest git commits limited with -n option, or commits in the git range - specified with -r option (default: "origin/master.."). + specified with -r option (default: "origin/main.."). END_OF_HELP } @@ -69,16 +69,72 @@ check_forbidden_additions() { # -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ "$1" || res=1 + # check %l or %ll format specifier + awk -v FOLDERS='lib drivers app examples' \ + -v EXPRESSIONS='%ll*[xud]' \ + -v RET_ON_FAIL=1 \ + -v MESSAGE='Using %l format, prefer %PRI*64 if type is [u]int64_t' \ + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ + "$1" || res=1 + # forbid variable declaration inside "for" loop awk -v FOLDERS='.' \ - -v EXPRESSIONS='for *\\((char|u?int|unsigned|s?size_t)' \ + -v EXPRESSIONS='for[[:space:]]*\\((char|u?int|unsigned|s?size_t)' \ -v RET_ON_FAIL=1 \ -v MESSAGE='Declaring a variable inside for()' \ -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 + # refrain from new additions of 16/32/64 bits rte_atomicNN_xxx() + awk -v FOLDERS="lib drivers app examples" \ + -v EXPRESSIONS="rte_atomic[0-9][0-9]_.*\\\(" \ + -v RET_ON_FAIL=1 \ + -v MESSAGE='Using rte_atomicNN_xxx' \ + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ + "$1" || res=1 + + # refrain from new additions of rte_smp_[r/w]mb() + awk -v FOLDERS="lib drivers app examples" \ + -v EXPRESSIONS="rte_smp_(r|w)?mb\\\(" \ + -v RET_ON_FAIL=1 \ + -v MESSAGE='Using rte_smp_[r/w]mb' \ + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ + "$1" || res=1 + + # refrain from using compiler __sync_xxx builtins + awk -v FOLDERS="lib drivers app examples" \ + -v EXPRESSIONS="__sync_.*\\\(" \ + -v RET_ON_FAIL=1 \ + -v MESSAGE='Using __sync_xxx builtins' \ + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ + "$1" || res=1 + + # refrain from using compiler __atomic_thread_fence() + # It should be avoided on x86 for SMP case. + awk -v FOLDERS="lib drivers app examples" \ + -v EXPRESSIONS="__atomic_thread_fence\\\(" \ + -v RET_ON_FAIL=1 \ + -v MESSAGE='Using __atomic_thread_fence' \ + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ + "$1" || res=1 + + # forbid use of experimental build flag except in examples + awk -v FOLDERS='lib drivers app' \ + -v EXPRESSIONS='-DALLOW_EXPERIMENTAL_API allow_experimental_apis' \ + -v RET_ON_FAIL=1 \ + -v MESSAGE='Using experimental build flag for in-tree compilation' \ + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ + "$1" || res=1 + + # refrain from using RTE_LOG_REGISTER for drivers and libs + awk -v FOLDERS='lib drivers' \ + -v EXPRESSIONS='\\' \ + -v RET_ON_FAIL=1 \ + -v MESSAGE='Using RTE_LOG_REGISTER, prefer RTE_LOG_REGISTER_(DEFAULT|SUFFIX)' \ + -f $(dirname $(readlink -f $0))/check-forbidden-tokens.awk \ + "$1" || res=1 + + # SVG must be included with wildcard extension to allow conversion awk -v FOLDERS='doc' \ -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \ -v RET_ON_FAIL=1 \ @@ -158,8 +214,17 @@ check_internal_tags() { # return $res } +check_release_notes() { # + rel_notes_prefix=doc/guides/rel_notes/release_ + IFS=. read year month release < VERSION + current_rel_notes=${rel_notes_prefix}${year}_${month}.rst + + ! grep -e '^--- a/'$rel_notes_prefix -e '^+++ b/'$rel_notes_prefix "$1" | + grep -v $current_rel_notes +} + number=0 -range='origin/master..' +range='origin/main..' quiet=false verbose=false while getopts hn:qr:v ARG ; do @@ -249,6 +314,14 @@ check () { # ret=1 fi + ! $verbose || printf '\nChecking release notes updates:\n' + report=$(check_release_notes "$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