devtools: summarize git log check
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.power@intel.com> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
This commit is contained in:
Ciara Power
Thomas Monjalon
parent
b1214d9882
commit
a8354c99a9
|
|
@ -55,6 +55,8 @@ stablefixes=$($selfdir/git-log-fixes.sh $range | sed '/(N\/A)$/d' | cut -d' ' -
|
|||
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 ' ' \
|
||||
|
|
@ -67,7 +69,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
|
||||
|
|
@ -85,7 +87,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 \
|
||||
|
|
@ -95,14 +97,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='
|
||||
|
|
@ -115,9 +117,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
|
||||
|
||||
|
|
@ -125,27 +126,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
|
||||
|
|
@ -154,7 +156,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
|
||||
|
|
@ -163,14 +166,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: ')
|
||||
|
|
@ -183,11 +187,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: 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
|
||||
|
|
|
|||
Loading…
Reference in a new issue