scripts/checkpatches.sh

   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 . scripts/load-devel-config.sh
  37 if [ ! -x "$DPDK_CHECKPATCH_PATH" ] ; then
  38         echo 'Cannot execute DPDK_CHECKPATCH_PATH' >&2
  39         exit 1
  40 fi
  41
  42 length=${DPDK_CHECKPATCH_LINE_LENGTH:-80}
  43
  44 # override default Linux options
  45 options="--no-tree"
  46 options="$options --max-line-length=$length"
  47 options="$options --show-types"
  48 options="$options --ignore=LINUX_VERSION_CODE,FILE_PATH_CHANGES,\
  49 VOLATILE,PREFER_PACKED,PREFER_ALIGNED,PREFER_PRINTF,PREFER_KERNEL_TYPES,\
  50 SPLIT_STRING,LINE_SPACING,PARENTHESIS_ALIGNMENT,NETWORKING_BLOCK_COMMENT_STYLE,\
  51 NEW_TYPEDEFS,COMPARISON_TO_NULL"
  52
  53 print_usage () {
  54         echo "usage: $(basename $0) [-q] [-v] [patch1 [patch2] ...]]"
  55 }
  56
  57 quiet=false
  58 verbose=false
  59 while getopts hqv ARG ; do
  60         case $ARG in
  61                 q ) quiet=true ;;
  62                 v ) verbose=true ;;
  63                 h ) print_usage ; exit 0 ;;
  64                 ? ) print_usage ; exit 1 ;;
  65         esac
  66 done
  67 shift $(($OPTIND - 1))
  68
  69 status=0
  70 for p in "$@" ; do
  71         ! $verbose || printf '\n### %s\n\n' "$p"
  72         report=$($DPDK_CHECKPATCH_PATH $options "$p" 2>/dev/null)
  73         [ $? -ne 0 ] || continue
  74         $verbose || printf '\n### %s\n\n' "$p"
  75         printf '%s\n' "$report" | head -n -6
  76         status=$(($status + 1))
  77 done
  78 pass=$(($# - $status))
  79 $quiet || printf '%d/%d valid patch' $pass $#
  80 $quiet || [ $pass -le 1 ] || printf 'es'
  81 $quiet || printf '\n'
  82 exit $status