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,LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\ 48NEW_TYPEDEFS,COMPARISON_TO_NULL" 49 50print_usage () { 51 cat <<- END_OF_HELP 52 usage: $(basename $0) [-q] [-v] [-nX|patch1 [patch2] ...]] 53 54 Run Linux kernel checkpatch.pl with DPDK options. 55 The environment variable DPDK_CHECKPATCH_PATH must be set. 56 57 The patches to check can be from stdin, files specified on the command line, 58 or latest git commits limited with -n option (default limit: origin/master). 59 END_OF_HELP 60} 61 62number=0 63quiet=false 64verbose=false 65while getopts hn:qv ARG ; do 66 case $ARG in 67 n ) number=$OPTARG ;; 68 q ) quiet=true ;; 69 v ) verbose=true ;; 70 h ) print_usage ; exit 0 ;; 71 ? ) print_usage ; exit 1 ;; 72 esac 73done 74shift $(($OPTIND - 1)) 75 76if [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then 77 print_usage >&2 78 echo 79 echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2 80 exit 1 81fi 82 83total=0 84status=0 85 86check () { # <patch> <commit> <title> 87 total=$(($total + 1)) 88 ! $verbose || printf '\n### %s\n\n' "$3" 89 if [ -n "$1" ] ; then 90 report=$($DPDK_CHECKPATCH_PATH $options "$1" 2>/dev/null) 91 elif [ -n "$2" ] ; then 92 report=$(git format-patch --no-stat --stdout -1 $commit | 93 $DPDK_CHECKPATCH_PATH $options - 2>/dev/null) 94 else 95 report=$($DPDK_CHECKPATCH_PATH $options - 2>/dev/null) 96 fi 97 [ $? -ne 0 ] || return 0 98 $verbose || printf '\n### %s\n\n' "$3" 99 printf '%s\n' "$report" | sed -n '1,/^total:.*lines checked$/p' 100 status=$(($status + 1)) 101} 102 103if [ -n "$1" ] ; then 104 for patch in "$@" ; do 105 # Subject can be on 2 lines 106 subject=$(sed '/^Subject: */!d;s///;N;s,\n[[:space:]]\+, ,;s,\n.*,,;q' "$patch") 107 check "$patch" '' "$subject" 108 done 109elif [ ! -t 0 ] ; then # stdin 110 subject=$(while read header value ; do 111 if [ "$header" = 'Subject:' ] ; then 112 IFS= read next 113 continuation=$(echo "$next" | sed -n 's,^[[:space:]]\+, ,p') 114 echo $value$continuation 115 break 116 fi 117 done) 118 check '' '' "$subject" 119else 120 if [ $number -eq 0 ] ; then 121 commits=$(git rev-list --reverse origin/master..) 122 else 123 commits=$(git rev-list --reverse --max-count=$number HEAD) 124 fi 125 for commit in $commits ; do 126 subject=$(git log --format='%s' -1 $commit) 127 check '' $commit "$subject" 128 done 129fi 130pass=$(($total - $status)) 131$quiet || printf '\n%d/%d valid patch' $pass $total 132$quiet || [ $pass -le 1 ] || printf 'es' 133$quiet || printf '\n' 134exit $status 135