# 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)
tags=$(git log --format='%b' --reverse $range | grep -i -e 'by *:' -e 'fix.*:')
bytag='\(Reported\|Suggested\|Signed-off\|Acked\|Reviewed\|Tested\)-by:'
+failure=false
+
# check headline format (spacing, no punctuation, no code)
bad=$(echo "$headlines" | grep --color=always \
-e ' ' \
-e ':[^ ]' \
-e ' :' \
| sed 's,^,\t,')
-[ -z "$bad" ] || printf "Wrong headline format:\n$bad\n"
+[ -z "$bad" ] || { printf "Wrong headline format:\n$bad\n" && failure=true;}
# check headline prefix when touching only drivers, e.g. net/<driver name>
bad=$(for commit in $commits ; do
echo "$headline" | grep -v "^$drv"
fi
done | sed 's,^,\t,')
-[ -z "$bad" ] || printf "Wrong headline prefix:\n$bad\n"
+[ -z "$bad" ] || { printf "Wrong headline prefix:\n$bad\n" && failure=true;}
# check headline label for common typos
bad=$(echo "$headlines" | grep --color=always \
-e 'test-pmd' \
-e '^bond:' \
| sed 's,^,\t,')
-[ -z "$bad" ] || printf "Wrong headline label:\n$bad\n"
+[ -z "$bad" ] || { printf "Wrong headline label:\n$bad\n" && failure=true;}
# check headline lowercase for first words
bad=$(echo "$headlines" | grep --color=always \
-e '^.*[[:upper:]].*:' \
-e ': *[[:upper:]]' \
| sed 's,^,\t,')
-[ -z "$bad" ] || printf "Wrong headline uppercase:\n$bad\n"
+[ -z "$bad" ] || { printf "Wrong headline uppercase:\n$bad\n" && failure=true;}
# check headline case (Rx/Tx, VF, L2, MAC, Linux ...)
IFS='
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
+ [ -z "$bad_word" ] || { printf "Wrong headline case:\n\
+ \"$bad_line\": $bad_word --> $word\n" && failure=true;}
done
done
bad=$(echo "$headlines" |
awk 'length>60 {print}' |
sed 's,^,\t,')
-[ -z "$bad" ] || printf "Headline too long:\n$bad\n"
+[ -z "$bad" ] || { printf "Headline too long:\n$bad\n" && failure=true;}
# check body lines length (75 max)
bad=$(echo "$bodylines" | grep -v '^Fixes:' |
awk 'length>75 {print}' |
sed 's,^,\t,')
-[ -z "$bad" ] || printf "Line too long:\n$bad\n"
+[ -z "$bad" ] || { printf "Line too long:\n$bad\n" && failure=true;}
# check starting commit message with "It"
bad=$(for commit in $commits ; do
firstbodyline=$(git log --format='%b' -1 $commit | head -n1)
echo "$firstbodyline" | grep --color=always -ie '^It '
done | sed 's,^,\t,')
-[ -z "$bad" ] || printf "Wrong beginning of commit message:\n$bad\n"
+[ -z "$bad" ] || { printf "Wrong beginning of commit message:\n$bad\n"\
+ && failure=true;}
# check tags spelling
bad=$(echo "$tags" |
grep -v "^$bytag [^,]* <.*@.*>$" |
grep -v '^Fixes: [0-9a-f]\{7\}[0-9a-f]* (".*")$' |
sed 's,^.,\t&,')
-[ -z "$bad" ] || printf "Wrong tag:\n$bad\n"
+[ -z "$bad" ] || { printf "Wrong tag:\n$bad\n" && failure=true;}
# check missing Coverity issue: tag
bad=$(for commit in $commits; do
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"
+[ -z "$bad" ] || { printf "Missing 'Coverity issue:' tag:\n$bad\n"\
+ && failure=true;}
# check missing Bugzilla ID: tag
bad=$(for commit in $commits; do
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"
+[ -z "$bad" ] || { printf "Missing 'Bugzilla ID:' tag:\n$bad\n"\
+ && failure=true;}
# check missing Fixes: tag
bad=$(for fix in $fixes ; do
git log --format='%b' -1 $fix | grep -q '^Fixes: ' ||
git log --format='\t%s' -1 $fix
done)
-[ -z "$bad" ] || printf "Missing 'Fixes' tag:\n$bad\n"
+[ -z "$bad" ] || { printf "Missing 'Fixes' tag:\n$bad\n" && failure=true;}
# check Fixes: reference
fixtags=$(echo "$tags" | grep '^Fixes: ')
fi
printf "$fixtag" | grep -v "^$good$"
done | sed 's,^,\t,')
-[ -z "$bad" ] || printf "Wrong 'Fixes' reference:\n$bad\n"
+[ -z "$bad" ] || { printf "Wrong 'Fixes' reference:\n$bad\n" && failure=true;}
# 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='\t%s' -1 $fix
done)
-[ -z "$bad" ] || printf "Is it candidate for Cc: stable@dpdk.org backport?\n$bad\n"
+[ -z "$bad" ] || { printf "Is it candidate for Cc: stable@dpdk.org backport?\n$bad\n"\
+ && failure=true;}
+
+total=$(echo "$commits" | wc -l)
+if $failure ; then
+ printf "\nInvalid patch(es) found - checked $total patch"
+else
+ printf "\n$total/$total valid patch"
+fi
+[ $total -le 1 ] || printf 'es'
+printf '\n'
+$failure && exit 1 || exit 0
git.droids-corp.org / dpdk.git / blobdiff