5 # Copyright 2016 6WIND S.A.
7 # Redistribution and use in source and binary forms, with or without
8 # modification, are permitted provided that the following conditions
11 # * Redistributions of source code must retain the above copyright
12 # notice, this list of conditions and the following disclaimer.
13 # * Redistributions in binary form must reproduce the above copyright
14 # notice, this list of conditions and the following disclaimer in
15 # the documentation and/or other materials provided with the
17 # * Neither the name of 6WIND S.A. nor the names of its
18 # contributors may be used to endorse or promote products derived
19 # from this software without specific prior written permission.
21 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 # Check commit logs (headlines and references)
35 # If any doubt about the formatting, please check in the most recent history:
36 # git log --format='%>|(15)%cr %s' --reverse | grep -i <pattern>
38 if [ "$1" = '-h' -o "$1" = '--help' ] ; then
40 usage: $(basename $0) [-h] [range]
42 Check commit log formatting.
43 The git range can be specified as a "git log" option,
44 e.g. -1 to check only the latest commit.
45 The default range starts from origin/master to HEAD.
50 range=${1:-origin/master..}
52 commits=$(git log --format='%h' $range)
53 headlines=$(git log --format='%s' $range)
54 bodylines=$(git log --format='%b' $range)
55 fixes=$(git log --format='%h %s' $range | grep -i ': *fix' | cut -d' ' -f1)
56 tags=$(git log --format='%b' $range | grep -i -e 'by *:' -e 'fix.*:')
57 bytag='\(Reported\|Suggested\|Signed-off\|Acked\|Reviewed\|Tested\)-by:'
59 # check headline format (spacing, no punctuation, no code)
60 bad=$(echo "$headlines" | grep --color=always \
71 [ -z "$bad" ] || printf "Wrong headline format:\n$bad\n"
73 # check headline label for common typos
74 bad=$(echo "$headlines" | grep --color=always \
81 [ -z "$bad" ] || printf "Wrong headline label:\n$bad\n"
83 # check headline lowercase for first words
84 bad=$(echo "$headlines" | grep --color=always \
88 [ -z "$bad" ] || printf "Wrong headline uppercase:\n$bad\n"
90 # check headline uppercase (Rx/Tx, VF, L2, MAC, Linux, ARM...)
91 bad=$(echo "$headlines" | grep -E --color=always \
92 -e '\<(rx|tx|RX|TX)\>' \
101 -e ':.*\<freebsd\>' \
104 -e ':.*\<tile-gx\>' \
109 [ -z "$bad" ] || printf "Wrong headline lowercase:\n$bad\n"
111 # check headline length (60 max)
112 bad=$(echo "$headlines" |
113 awk 'length>60 {print}' |
115 [ -z "$bad" ] || printf "Headline too long:\n$bad\n"
117 # check body lines length (75 max)
118 bad=$(echo "$bodylines" | grep -v '^Fixes:' |
119 awk 'length>75 {print}' |
121 [ -z "$bad" ] || printf "Line too long:\n$bad\n"
123 # check starting commit message with "It"
124 bad=$(for commit in $commits ; do
125 firstbodyline=$(git log --format='%b' -1 $commit | head -n1)
126 echo "$firstbodyline" | grep --color=always -ie '^It '
127 done | sed 's,^,\t,')
128 [ -z "$bad" ] || printf "Wrong beginning of commit message:\n$bad\n"
130 # check tags spelling
132 grep -v "^$bytag [^,]* <.*@.*>$" |
133 grep -v '^Fixes: [0-9a-f]\{7\}[0-9a-f]* (".*")$' |
135 [ -z "$bad" ] || printf "Wrong tag:\n$bad\n"
137 # check blank line after last Fixes: tag
138 bad=$(echo "$bodylines" |
139 sed -n 'N;/\nFixes:/D;/\n$/D;/^Fixes:/P' |
141 [ -z "$bad" ] || printf "Missing blank line after 'Fixes' tag:\n$bad\n"
143 # check missing Fixes: tag
144 bad=$(for fix in $fixes ; do
145 git log --format='%b' -1 $fix | grep -q '^Fixes: ' ||
146 git log --format='\t%s' -1 $fix
148 [ -z "$bad" ] || printf "Missing 'Fixes' tag:\n$bad\n"
150 # check Fixes: reference
153 fixtags=$(echo "$tags" | grep '^Fixes: ')
154 bad=$(for fixtag in $fixtags ; do
155 hash=$(echo "$fixtag" | sed 's,^Fixes: \([0-9a-f]*\).*,\1,')
156 if git branch --contains $hash | grep -q '^\*' ; then
157 good="Fixes: $hash "$(git log --format='("%s")' -1 $hash 2>&-)
159 good="reference not in current branch"
161 printf "$fixtag" | grep -v "^$good$"
162 done | sed 's,^,\t,')
163 [ -z "$bad" ] || printf "Wrong 'Fixes' reference:\n$bad\n"