Code

git-notify: Truncate summary after 50 characters
authorHolger Weiss <holger@zedat.fu-berlin.de>
Sat, 24 Oct 2009 20:53:55 +0000 (22:53 +0200)
committerHolger Weiss <holger@zedat.fu-berlin.de>
Sat, 24 Oct 2009 20:53:55 +0000 (22:53 +0200)
If the first line of a commit message is longer than 50 characters,
truncate it before adding the resulting string to the subject line of a
notification.  This makes sure the subject line won't get too long
(unless the commit author name is unusually long, which we don't check).
The Git User's Manual recommends keeping the first line of a commit
message shorter than that, anyway:

| Though not required, it's a good idea to begin the commit message with
| a single short (less than 50 character) line summarizing the change,
| followed by a blank line and then a more thorough description.  Tools
| that turn commits into email, for example, use the first line on the
| Subject line and the rest of the commit in the body.

[ http://www.kernel.org/pub/software/scm/git/docs/user-manual.html ]

tools/git-notify

index 9ab012e34d36a7847b335ffcf2b5a3010ef6ab99..39abd66e173e219d831fd765181c27cacdb0824b 100755 (executable)
@@ -127,6 +127,20 @@ sub git_rev_list(@)
     return $revlist;
 }
 
+# truncate the given string if it exceeds the specified number of characters
+sub truncate_str($$)
+{
+    my ($str, $max) = @_;
+
+    if (length($str) > $max)
+    {
+        $str = substr($str, 0, $max);
+        $str =~ s/\s+\S+$//;
+        $str .= " ...";
+    }
+    return $str;
+}
+
 # right-justify the left column of "left: right" elements, omit undefined elements
 sub format_table(@)
 {
@@ -338,7 +352,7 @@ sub send_commit_notice($$)
     }
 
     mail_notification($commitlist_address,
-        $info{"author_name"} . ": " . ${$info{"log"}}[0],
+        $info{"author_name"} . ": " . truncate_str(${$info{"log"}}[0], 50),
         "text/plain; charset=UTF-8", @notice);
     $sent_notices++;
 }