X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=devtools%2Fcheckpatches.sh;h=32727746446c9ce73e1e07f8353f0f20cb964280;hb=e8af2f1f11c8f35430086806988d43ff78414ba5;hp=bf3114f954d04c75bd9f31017a47432b4b2f6e10;hpb=ff37ca5d3773b7c82ad9b3d7e212e8ae7d39fc1a;p=dpdk.git diff --git a/devtools/checkpatches.sh b/devtools/checkpatches.sh index bf3114f954..3272774644 100755 --- 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,\ @@ -43,13 +54,28 @@ print_usage () { END_OF_HELP } -check_forbidden_additions() { +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 \ - -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk - + -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 @@ -115,7 +141,7 @@ check () { # fi ! $verbose || printf '\nChecking forbidden tokens additions:\n' - report=$(check_forbidden_additions <"$tmpinput") + report=$(check_forbidden_additions "$tmpinput") if [ $? -ne 0 ] ; then $headline_printed || print_headline "$3" printf '%s\n' "$report"