ring: introduce RTS ring mode
[dpdk.git] / devtools / check-git-log.sh
index f6a35d2..4e65be0 100755 (executable)
@@ -1,34 +1,6 @@
 #! /bin/sh
-
-# BSD LICENSE
-#
+# SPDX-License-Identifier: BSD-3-Clause
 # Copyright 2016 6WIND S.A.
-#
-# Redistribution and use in source and binary forms, with or without
-# modification, are permitted provided that the following conditions
-# are met:
-#
-#   * Redistributions of source code must retain the above copyright
-#     notice, this list of conditions and the following disclaimer.
-#   * Redistributions in binary form must reproduce the above copyright
-#     notice, this list of conditions and the following disclaimer in
-#     the documentation and/or other materials provided with the
-#     distribution.
-#   * Neither the name of 6WIND S.A. nor the names of its
-#     contributors may be used to endorse or promote products derived
-#     from this software without specific prior written permission.
-#
-# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 # Check commit logs (headlines and references)
 #
@@ -47,7 +19,7 @@ if [ "$1" = '-h' -o "$1" = '--help' ] ; then
        exit
 fi
 
-selfdir=$(dirname $(readlink -e $0))
+selfdir=$(dirname $(readlink -f $0))
 range=${1:-origin/master..}
 # convert -N to HEAD~N.. in order to comply with git-log-fixes.sh getopts
 if printf -- $range | grep -q '^-[0-9]\+' ; then
@@ -87,7 +59,7 @@ bad=$(for commit in $commits ; do
        if [ $(echo "$drvgrp" | wc -l) -gt 1 ] ; then
                echo "$headline" | grep -v '^drivers:'
        elif [ $(echo "$drv" | wc -l) -gt 1 ] ; then
-               echo "$headline" | grep -v "^$drvgrp"
+               echo "$headline" | grep -v "^drivers/$drvgrp"
        else
                echo "$headline" | grep -v "^$drv"
        fi
@@ -106,43 +78,27 @@ bad=$(echo "$headlines" | grep --color=always \
 
 # check headline lowercase for first words
 bad=$(echo "$headlines" | grep --color=always \
-       -e '^.*[A-Z].*:' \
-       -e ': *[A-Z]' \
+       -e '^.*[[:upper:]].*:' \
+       -e ': *[[:upper:]]' \
        | sed 's,^,\t,')
 [ -z "$bad" ] || printf "Wrong headline uppercase:\n$bad\n"
 
-# check headline uppercase (Rx/Tx, VF, L2, MAC, Linux, ARM...)
-bad=$(echo "$headlines" | grep -E --color=always \
-       -e ':.*\<(rx|tx|RX|TX)\>' \
-       -e ':.*\<[pv]f\>' \
-       -e ':.*\<[hsf]w\>' \
-       -e ':.*\<l[234]\>' \
-       -e ':.*\<api\>' \
-       -e ':.*\<arm\>' \
-       -e ':.*\<armv7\>' \
-       -e ':.*\<armv8\>' \
-       -e ':.*\<dma\>' \
-       -e ':.*\<freebsd\>' \
-       -e ':.*\<linux\>' \
-       -e ':.*\<lro\>' \
-       -e ':.*\<mac\>' \
-       -e ':.*\<mtu\>' \
-       -e ':.*\<nic\>' \
-       -e ':.*\<numa\>' \
-       -e ':.*\<pci\>' \
-       -e ':.*\<pmd\>' \
-       -e ':.*\<rss\>' \
-       -e ':.*\<tile-gx\>' \
-       -e ':.*\<tilegx\>' \
-       -e ':.*\<vlan\>' \
-       | sed 's,^,\t,')
-[ -z "$bad" ] || printf "Wrong headline lowercase:\n$bad\n"
-
-# special case check for VMDq to give good error message
-bad=$(echo "$headlines" | grep -E --color=always \
-       -e '\<(vmdq|VMDQ)\>' \
-       | sed 's,^,\t,')
-[ -z "$bad" ] || printf "Wrong headline capitalization, use 'VMDq':\n$bad\n"
+# check headline case (Rx/Tx, VF, L2, MAC, Linux ...)
+IFS='
+'
+words="$selfdir/words-case.txt"
+for word in $(cat $words); do
+       bad=$(echo "$headlines" | grep -iw $word | grep -v $word)
+       if [ "$word" = "Tx" ]; then
+               bad=$(echo $bad | grep -v 'OCTEON\ TX')
+       fi
+       for bad_line in $bad; do
+               bad_word=$(echo $bad_line | cut -d":" -f2 | grep -io $word)
+               if [ -n "$bad_word" ]; then
+                       printf "Wrong headline case:\n\"$bad_line\": $bad_word --> $word\n"
+               fi
+       done
+done
 
 # check headline length (60 max)
 bad=$(echo "$headlines" |
@@ -170,11 +126,23 @@ bad=$(echo "$tags" |
        sed 's,^.,\t&,')
 [ -z "$bad" ] || printf "Wrong tag:\n$bad\n"
 
-# check blank line after last Fixes: tag
-bad=$(echo "$bodylines" |
-       sed -n 'N;/\nFixes:/D;/\n$/D;/^Fixes:/P' |
-       sed 's,^.,\t&,')
-[ -z "$bad" ] || printf "Missing blank line after 'Fixes' tag:\n$bad\n"
+# check missing Coverity issue: tag
+bad=$(for commit in $commits; do
+       body=$(git log --format='%b' -1 $commit)
+       echo "$body" | grep -qi coverity || continue
+       echo "$body" | grep -q '^Coverity issue:' && continue
+       git log --format='\t%s' -1 $commit
+done)
+[ -z "$bad" ] || printf "Missing 'Coverity issue:' tag:\n$bad\n"
+
+# check missing Bugzilla ID: tag
+bad=$(for commit in $commits; do
+       body=$(git log --format='%b' -1 $commit)
+       echo "$body" | grep -qi bugzilla || continue
+       echo "$body" | grep -q '^Bugzilla ID:' && continue
+       git log --format='\t%s' -1 $commit
+done)
+[ -z "$bad" ] || printf "Missing 'Bugzilla ID:' tag:\n$bad\n"
 
 # check missing Fixes: tag
 bad=$(for fix in $fixes ; do
@@ -184,8 +152,6 @@ done)
 [ -z "$bad" ] || printf "Missing 'Fixes' tag:\n$bad\n"
 
 # check Fixes: reference
-IFS='
-'
 fixtags=$(echo "$tags" | grep '^Fixes: ')
 bad=$(for fixtag in $fixtags ; do
        hash=$(echo "$fixtag" | sed 's,^Fixes: \([0-9a-f]*\).*,\1,')
@@ -198,9 +164,9 @@ bad=$(for fixtag in $fixtags ; do
 done | sed 's,^,\t,')
 [ -z "$bad" ] || printf "Wrong 'Fixes' reference:\n$bad\n"
 
-# check CC:stable for fixes
+# check Cc: stable@dpdk.org for fixes
 bad=$(for fix in $stablefixes ; do
-       git log --format='%b' -1 $fix | grep -qi '^CC: *stable@dpdk.org' ||
+       git log --format='%b' -1 $fix | grep -qi '^Cc: *stable@dpdk.org' ||
                git log --format='\t%s' -1 $fix
 done)
-[ -z "$bad" ] || printf "Should CC: stable@dpdk.org\n$bad\n"
+[ -z "$bad" ] || printf "Is it candidate for Cc: stable@dpdk.org backport?\n$bad\n"