1#! /bin/sh 2 3# BSD LICENSE 4# 5# Copyright 2015 6WIND S.A. 6# 7# Redistribution and use in source and binary forms, with or without 8# modification, are permitted provided that the following conditions 9# are met: 10# 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 16# distribution. 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. 20# 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. 32 33# Load config options: 34# - DPDK_CHECKPATCH_PATH 35# - DPDK_CHECKPATCH_LINE_LENGTH 36. $(dirname $(readlink -e $0))/load-devel-config 37 38length=${DPDK_CHECKPATCH_LINE_LENGTH:-80} 39 40# override default Linux options 41options="--no-tree" 42options="$options --max-line-length=$length" 43options="$options --show-types" 44options="$options --ignore=LINUX_VERSION_CODE,FILE_PATH_CHANGES,\ 45VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,\ 46PREFER_KERNEL_TYPES,BIT_MACRO,CONST_STRUCT,\ 47SPLIT_STRING,LONG_LINE_STRING,\ 48LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\ 49NEW_TYPEDEFS,COMPARISON_TO_NULL" 50 51print_usage () { 52 cat <<- END_OF_HELP 53 usage: $(basename $0) [-q] [-v] [-nX|patch1 [patch2] ...]] 54 55 Run Linux kernel checkpatch.pl with DPDK options. 56 The environment variable DPDK_CHECKPATCH_PATH must be set. 57 58 The patches to check can be from stdin, files specified on the command line, 59 or latest git commits limited with -n option (default limit: origin/master). 60 END_OF_HELP 61} 62 63number=0 64quiet=false 65verbose=false 66while getopts hn:qv ARG ; do 67 case $ARG in 68 n ) number=$OPTARG ;; 69 q ) quiet=true ;; 70 v ) verbose=true ;; 71 h ) print_usage ; exit 0 ;; 72 ? ) print_usage ; exit 1 ;; 73 esac 74done 75shift $(($OPTIND - 1)) 76 77if [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then 78 print_usage >&2 79 echo 80 echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2 81 exit 1 82fi 83 84total=0 85status=0 86 87check () { # <patch> <commit> <title> 88 total=$(($total + 1)) 89 ! $verbose || printf '\n### %s\n\n' "$3" 90 if [ -n "$1" ] ; then 91 report=$($DPDK_CHECKPATCH_PATH $options "$1" 2>/dev/null) 92 elif [ -n "$2" ] ; then 93 report=$(git format-patch --find-renames --no-stat --stdout -1 $commit | 94 $DPDK_CHECKPATCH_PATH $options - 2>/dev/null) 95 else 96 report=$($DPDK_CHECKPATCH_PATH $options - 2>/dev/null) 97 fi 98 [ $? -ne 0 ] || return 0 99 $verbose || printf '\n### %s\n\n' "$3" 100 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p' 101 status=$(($status + 1)) 102} 103 104if [ -n "$1" ] ; then 105 for patch in "$@" ; do 106 # Subject can be on 2 lines 107 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch") 108 check "$patch" '' "$subject" 109 done 110elif [ ! -t 0 ] ; then # stdin 111 subject=$(while read header value ; do 112 if [ "$header" = 'Subject:' ] ; then 113 IFS= read next 114 continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p') 115 echo $value$continuation 116 break 117 fi 118 done) 119 check '' '' "$subject" 120else 121 if [ $number -eq 0 ] ; then 122 commits=$(git rev-list --reverse origin/master..) 123 else 124 commits=$(git rev-list --reverse --max-count=$number HEAD) 125 fi 126 for commit in $commits ; do 127 subject=$(git log --format='%s' -1 $commit) 128 check '' $commit "$subject" 129 done 130fi 131pass=$(($total - $status)) 132$quiet || printf '\n%d/%d valid patch' $pass $total 133$quiet || [ $pass -le 1 ] || printf 'es' 134$quiet || printf '\n' 135exit $status 136