When all checks are completed on the specified commit logs, the script
indicates if all are valid, or if there were some failures.
Signed-off-by: Ciara Power <ciara.po...@intel.com>
Acked-by: Ferruh Yigit <ferruh.yi...@intel.com>
---
v2: Added appropriate exit codes based on failure status.
---
devtools/check-git-log.sh | 45 +++++++++++++++++++++++++--------------
1 file changed, 29 insertions(+), 16 deletions(-)
diff --git a/devtools/check-git-log.sh b/devtools/check-git-log.sh
index 5220765b9..eca8506d9 100755
--- a/devtools/check-git-log.sh
+++ b/devtools/check-git-log.sh
@@ -70,7 +70,7 @@ bad=$(echo "$headlines" | grep --color=always \
-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
@@ -88,7 +88,7 @@ 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 \
@@ -98,14 +98,14 @@ 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='
@@ -118,9 +118,8 @@ for word in $(cat $words); do
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
@@ -128,27 +127,28 @@ 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
@@ -157,7 +157,8 @@ 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
@@ -166,14 +167,15 @@ 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: ')
@@ -186,11 +188,22 @@ bad=$(for fixtag in $fixtags ; do
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: sta...@dpdk.org for fixes
bad=$(for fix in $stablefixes ; do
git log --format='%b' -1 $fix | grep -qi '^Cc: *sta...@dpdk.org' ||
git log --format='\t%s' -1 $fix
done)
-[ -z "$bad" ] || printf "Is it candidate for Cc: sta...@dpdk.org
backport?\n$bad\n"
+[ -z "$bad" ] || { printf "Is it candidate for Cc: sta...@dpdk.org
backport?\n$bad\n"\
+ && failure=true;}
+
+total=$(echo "$commits" | wc -l)
+if [ -n "$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'
+[ -n "$failure" ] && exit 1 || exit 0
--
2.17.1
