devtools: standardize script arguments

[dpdk.git] / devtools / check-git-log.sh

diff --git a/devtools/check-git-log.sh b/devtools/check-git-log.sh
index 85d67fb..e5b4302 100755 (executable)
--- a/devtools/check-git-log.sh
+++ b/devtools/check-git-log.sh
@@ -7,23 +7,44 @@
 # If any doubt about the formatting, please check in the most recent history:
 #      git log --format='%>|(15)%cr   %s' --reverse | grep -i <pattern>
 
-if [ "$1" = '-h' -o "$1" = '--help' ] ; then
+print_usage () {
        cat <<- END_OF_HELP
-       usage: $(basename $0) [-h] [range]
+       usage: $(basename $0) [-h] [-nX|-r range]
 
        Check commit log formatting.
-       The git range can be specified as a "git log" option,
-       e.g. -1 to check only the latest commit.
-       The default range starts from origin/master to HEAD.
+       The git commits to be checked can be specified as a "git log" option,
+       by latest git commits limited with -n option, or commits in the git
+       range specified with -r option.
+       e.g. To check only the last commit, ‘-n1’ or ‘-r@~..’ is used.
+       If no range provided, default is origin/master..HEAD.
        END_OF_HELP
-       exit
-fi
+}
 
 selfdir=$(dirname $(readlink -f $0))
+# The script caters for two formats, the new preferred format, and the old
+# format to ensure backward compatibility.
+# The new format is aligned with the format of the checkpatches script,
+# and allows for specifying the patches to check by passing -nX or -r range.
+# The old format allows for specifying patches by passing -X or range
+# as the first argument.
 range=${1:-origin/master..}
+
+if [ "$range" = '--help' ] ; then
+       print_usage
+       exit 0
 # convert -N to HEAD~N.. in order to comply with git-log-fixes.sh getopts
-if printf -- $range | grep -q '^-[0-9]\+' ; then
-       range="HEAD$(printf -- $range | sed 's,^-,~,').."
+elif printf -- "$range" | grep -q '^-[0-9]\+' ; then
+       range="HEAD$(printf -- "$range" | sed 's,^-,~,').."
+else
+       while getopts hr:n: ARG ; do
+               case $ARG in
+                       n ) range="HEAD~$OPTARG.." ;;
+                       r ) range=$OPTARG ;;
+                       h ) print_usage ; exit 0 ;;
+                       ? ) print_usage ; exit 1 ;;
+               esac
+       done
+       shift $(($OPTIND - 1))
 fi
 
 commits=$(git log --format='%h' --reverse $range)
@@ -83,50 +104,22 @@ bad=$(echo "$headlines" | grep --color=always \
        | 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 ':.*\<crc\>' \
-       -e ':.*\<dma\>' \
-       -e ':.*\<eeprom\>' \
-       -e ':.*\<freebsd\>' \
-       -e ':.*\<iova\>' \
-       -e ':.*\<linux\>' \
-       -e ':.*\<lro\>' \
-       -e ':.*\<lsc\>' \
-       -e ':.*\<mac\>' \
-       -e ':.*\<mss\>' \
-       -e ':.*\<mtu\>' \
-       -e ':.*\<nic\>' \
-       -e ':.*\<nvm\>' \
-       -e ':.*\<numa\>' \
-       -e ':.*\<pci\>' \
-       -e ':.*\<phy\>' \
-       -e ':.*\<pmd\>' \
-       -e ':.*\<rss\>' \
-       -e ':.*\<sctp\>' \
-       -e ':.*\<tso\>' \
-       -e ':.*\<udp\>' \
-       -e ':.*\<[Vv]lan\>' \
-       -e ':.*\<vdpa\>' \
-       -e ':.*\<vsi\>' \
-       | grep \
-       -v ':.*\<OCTEON\ TX\>' \
-       | 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" |
@@ -154,6 +147,24 @@ bad=$(echo "$tags" |
        sed 's,^.,\t&,')
 [ -z "$bad" ] || printf "Wrong 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
        git log --format='%b' -1 $fix | grep -q '^Fixes: ' ||
@@ -162,8 +173,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,')