Improve commit-msg messages and autosquash

Problem reported by Michal Nazarewicz in Bug#19337.
* build-aux/git-hooks/commit-msg: Add "commit message" to
diagnostics.  Distinguish better between tabs and other
unprintable chars in diagnostics.  Don't complain if a prefix
"fixup! " or "squash! " makes a summary line too long.

diff --git a/ChangeLog b/ChangeLog
index 4a7b5900efad300d3ad78a0b15e9ce9cb960645d..d4a4f2889b04a8732a03cb5d91a775a2343ad275 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2014-12-11  Paul Eggert  <eggert@cs.ucla.edu>
+
+       Improve commit-msg messages and autosquash
+       Problem reported by Michal Nazarewicz in Bug#19337.
+       * build-aux/git-hooks/commit-msg: Add "commit message" to
+       diagnostics.  Distinguish better between tabs and other
+       unprintable chars in diagnostics.  Don't complain if a prefix
+       "fixup! " or "squash! " makes a summary line too long.
+
 2014-12-08  Paul Eggert  <eggert@cs.ucla.edu>
 
        Port commit-message checking to FreeBSD 9.

diff --git a/build-aux/git-hooks/commit-msg b/build-aux/git-hooks/commit-msg
index f407881b0db0b5536581b71aa7c30b86c7d51fff..d2a0c59dace577996e2747df6c886e07e9aad037 100755 (executable)
--- a/build-aux/git-hooks/commit-msg
+++ b/build-aux/git-hooks/commit-msg
@@ -49,7 +49,7 @@ exec $awk '
   /^#/ { next }
 
   !/^.*$/ {
-    print "Invalid character (not UTF-8)"
+    print "Invalid character (not UTF-8) in commit message"
     status = 1
   }
 
@@ -57,39 +57,50 @@ exec $awk '
 
   { nlines++ }
 
-  nlines == 1 && /^[[:space:]]/ {
-    print "White space at start of first line"
-    status = 1
-  }
+  nlines == 1 {
+    # Ignore special markers used by "git rebase --autosquash".
+    if (! sub(/^fixup! /, ""))
+      sub(/^squash! /, "")
 
-  nlines == 2 && /[^[:space:]]/ {
-    print "Nonempty second line"
-    status = 1
+    if (/^[[:space:]]/) {
+      print "White space at start of commit message'\''s first line"
+      status = 1
+    }
   }
 
-  /[^[:print:]]/ {
-    print "Unprintable character; please use spaces instead of tabs"
+  nlines == 2 && /[^[:space:]]/ {
+    print "Nonempty second line in commit message"
     status = 1
   }
 
   72 < length && /[[:space:]]/ {
-    print "Line longer than 72 characters"
+    print "Line longer than 72 characters in commit message"
     status = 1
   }
 
   140 < length {
-    print "Word longer than 140 characters"
+    print "Word longer than 140 characters in commit message"
     status = 1
   }
 
   /^Signed-off-by: / {
-    print "'\''Signed-off-by:'\'' present"
+    print "'\''Signed-off-by:'\'' in commit message"
+    status = 1
+  }
+
+  /[^[:print:]]/ {
+    if (gsub(/\t/, "")) {
+      print "Tab in commit message; please use spaces instead"
+    }
+    if (/[^[:print:]]/) {
+      print "Unprintable character in commit message"
+    }
     status = 1
   }
 
   END {
     if (nlines == 0) {
-      print "Empty change log entry"
+      print "Empty commit message"
       status = 1
     }
     exit status