5 # Copyright 2015 6WIND S.A.
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions
11 # * Redistributions of source code must retain the above copyright
12 # notice, this list of conditions and the following disclaimer.
13 # * Redistributions in binary form must reproduce the above copyright
14 # notice, this list of conditions and the following disclaimer in
15 # the documentation and/or other materials provided with the
17 # * Neither the name of 6WIND S.A. nor the names of its
18 # contributors may be used to endorse or promote products derived
19 # from this software without specific prior written permission.
21 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 # Load config options:
34 # - DPDK_CHECKPATCH_PATH
35 # - DPDK_CHECKPATCH_LINE_LENGTH
36 . $(dirname $(readlink -e $0))/load-devel-config
38 length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
40 # override default Linux options
42 options="$options --max-line-length=$length"
43 options="$options --show-types"
44 options="$options --ignore=LINUX_VERSION_CODE,FILE_PATH_CHANGES,\
45 VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,PREFER_KERNEL_TYPES,BIT_MACRO,\
46 SPLIT_STRING,LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
47 NEW_TYPEDEFS,COMPARISON_TO_NULL"
51 usage: $(basename $0) [-q] [-v] [-nX|patch1 [patch2] ...]]
53 Run Linux kernel checkpatch.pl with DPDK options.
54 The environment variable DPDK_CHECKPATCH_PATH must be set.
56 The patches to check can be from files specified on the command line,
57 or latest git commits limited with -n option (default limit: origin/master).
64 while getopts hn:qv ARG ; do
67 q ) quiet=true && options="$options --no-summary" ;;
69 h ) print_usage ; exit 0 ;;
70 ? ) print_usage ; exit 1 ;;
73 shift $(($OPTIND - 1))
75 if [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
78 echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2
85 check () { # <patch> <commit> <title>
87 ! $verbose || printf '\n### %s\n\n' "$3"
89 report=$($DPDK_CHECKPATCH_PATH $options "$1" 2>/dev/null)
90 elif [ -n "$2" ] ; then
91 report=$(git format-patch --no-stat --stdout -1 $commit |
92 $DPDK_CHECKPATCH_PATH $options - 2>/dev/null)
94 [ $? -ne 0 ] || continue
95 $verbose || printf '\n### %s\n\n' "$3"
96 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p'
97 status=$(($status + 1))
100 if [ -z "$1" ] ; then
101 if [ $number -eq 0 ] ; then
102 commits=$(git rev-list --reverse origin/master..)
104 commits=$(git rev-list --reverse --max-count=$number HEAD)
106 for commit in $commits ; do
107 subject=$(git log --format='%s' -1 $commit)
108 check '' $commit "$subject"
111 for patch in "$@" ; do
112 subject=$(sed -n 's,^Subject: ,,p' "$patch")
113 check "$patch" '' "$subject"
116 pass=$(($total - $status))
117 $quiet || printf '\n%d/%d valid patch' $pass $total
118 $quiet || [ $pass -le 1 ] || printf 'es'
119 $quiet || printf '\n'