2 # SPDX-License-Identifier: BSD-3-Clause
3 # Copyright 2015 6WIND S.A.
6 # - DPDK_CHECKPATCH_PATH
7 # - DPDK_CHECKPATCH_CODESPELL
8 # - DPDK_CHECKPATCH_LINE_LENGTH
9 . $(dirname $(readlink -e $0))/load-devel-config
11 VALIDATE_NEW_API=$(dirname $(readlink -e $0))/check-symbol-change.sh
13 # Enable codespell by default. This can be overwritten from a config file.
14 # Codespell can also be enabled by setting DPDK_CHECKPATCH_CODESPELL to a valid path
15 # to a dictionary.txt file if dictionary.txt is not in the default location.
16 codespell=${DPDK_CHECKPATCH_CODESPELL:-enable}
17 length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
19 # override default Linux options
21 if [ "$codespell" = "enable" ] ; then
22 options="$options --codespell"
23 elif [ -f "$codespell" ] ; then
24 options="$options --codespell"
25 options="$options --codespellfile $codespell"
27 options="$options --max-line-length=$length"
28 options="$options --show-types"
29 options="$options --ignore=LINUX_VERSION_CODE,\
30 FILE_PATH_CHANGES,MAINTAINERS_STYLE,SPDX_LICENSE_TAG,\
31 VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,\
32 PREFER_KERNEL_TYPES,BIT_MACRO,CONST_STRUCT,\
33 SPLIT_STRING,LONG_LINE_STRING,\
34 LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
35 NEW_TYPEDEFS,COMPARISON_TO_NULL"
38 if echo $tmpinput | grep -q '^checkpatches\.' ; then
43 trap "clean_tmp_files" INT
47 usage: $(basename $0) [-q] [-v] [-nX|patch1 [patch2] ...]]
49 Run Linux kernel checkpatch.pl with DPDK options.
50 The environment variable DPDK_CHECKPATCH_PATH must be set.
52 The patches to check can be from stdin, files specified on the command line,
53 or latest git commits limited with -n option (default limit: origin/master).
57 check_forbidden_additions() { # <patch>
60 # refrain from new additions of rte_panic() and rte_exit()
61 # multiple folders and expressions are separated by spaces
62 awk -v FOLDERS="lib drivers" \
63 -v EXPRESSIONS="rte_panic\\\( rte_exit\\\(" \
65 -v MESSAGE='Using rte_panic/rte_exit' \
66 -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
69 # svg figures must be included with wildcard extension
70 # because of png conversion for pdf docs
71 awk -v FOLDERS='doc' \
72 -v EXPRESSIONS='::[[:space:]]*[^[:space:]]*\\.svg' \
74 -v MESSAGE='Using explicit .svg extension instead of .*' \
75 -f $(dirname $(readlink -e $0))/check-forbidden-tokens.awk \
84 while getopts hn:qv ARG ; do
89 h ) print_usage ; exit 0 ;;
90 ? ) print_usage ; exit 1 ;;
93 shift $(($OPTIND - 1))
95 if [ ! -f "$DPDK_CHECKPATCH_PATH" ] || [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
98 echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2
102 print_headline() { # <title>
103 printf '\n### %s\n\n' "$1"
104 headline_printed=true
110 check () { # <patch> <commit> <title>
112 headline_printed=false
114 total=$(($total + 1))
115 ! $verbose || print_headline "$3"
116 if [ -n "$1" ] ; then
118 elif [ -n "$2" ] ; then
119 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
120 git format-patch --find-renames \
121 --no-stat --stdout -1 $commit > "$tmpinput"
123 tmpinput=$(mktemp -t dpdk.checkpatches.XXXXXX)
127 ! $verbose || printf 'Running checkpatch.pl:\n'
128 report=$($DPDK_CHECKPATCH_PATH $options "$tmpinput" 2>/dev/null)
129 if [ $? -ne 0 ] ; then
130 $headline_printed || print_headline "$3"
131 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p'
135 ! $verbose || printf '\nChecking API additions/removals:\n'
136 report=$($VALIDATE_NEW_API "$tmpinput")
137 if [ $? -ne 0 ] ; then
138 $headline_printed || print_headline "$3"
139 printf '%s\n' "$report"
143 ! $verbose || printf '\nChecking forbidden tokens additions:\n'
144 report=$(check_forbidden_additions "$tmpinput")
145 if [ $? -ne 0 ] ; then
146 $headline_printed || print_headline "$3"
147 printf '%s\n' "$report"
152 [ $ret -eq 0 ] && return 0
154 status=$(($status + 1))
157 if [ -n "$1" ] ; then
158 for patch in "$@" ; do
159 # Subject can be on 2 lines
160 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch")
161 check "$patch" '' "$subject"
163 elif [ ! -t 0 ] ; then # stdin
164 subject=$(while read header value ; do
165 if [ "$header" = 'Subject:' ] ; then
167 continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p')
168 echo $value$continuation
172 check '' '' "$subject"
174 if [ $number -eq 0 ] ; then
175 commits=$(git rev-list --reverse origin/master..)
177 commits=$(git rev-list --reverse --max-count=$number HEAD)
179 for commit in $commits ; do
180 subject=$(git log --format='%s' -1 $commit)
181 check '' $commit "$subject"
184 pass=$(($total - $status))
185 $quiet || printf '\n%d/%d valid patch' $pass $total
186 $quiet || [ $pass -le 1 ] || printf 'es'
187 $quiet || printf '\n'