Merge branch 'nd/narrow' (early part) into jc/add-i-t-a
[gitweb.git] / contrib / hooks / post-receive-email
index 7511ea0797286453051c15765c4b795ac577cc0d..28a3c0e46ecf9951f3f42a025a288a65c70e0424 100644 (file)
 # hooks.emailprefix
 #   All emails have their subjects prefixed with this prefix, or "[SCM]"
 #   if emailprefix is unset, to aid filtering
+# hooks.showrev
+#   The shell command used to format each revision in the email, with
+#   "%s" replaced with the commit id.  Defaults to "git rev-list -1
+#   --pretty %s", displaying the commit id, author, date and log
+#   message.  To list full patches separated by a blank line, you
+#   could set this to "git show -C %s; echo".
 #
 # Notes
 # -----
@@ -202,11 +208,12 @@ generate_email_header()
 
 generate_email_footer()
 {
+       SPACE=" "
        cat <<-EOF
 
 
        hooks/post-receive
-       --
+       --${SPACE}
        $projectdesc
        EOF
 }
@@ -223,13 +230,7 @@ generate_create_branch_email()
        echo ""
 
        echo $LOGBEGIN
-       # This shows all log entries that are not already covered by
-       # another ref - i.e. commits that are now accessible from this
-       # ref that were previously not accessible
-       # (see generate_update_branch_email for the explanation of this
-       # command)
-       git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
-       git rev-list --pretty --stdin $newrev
+       show_new_revisions
        echo $LOGEND
 }
 
@@ -248,24 +249,24 @@ generate_update_branch_email()
        # In this case we want to issue an email containing only revisions
        # 3, 4, and N.  Given (almost) by
        #
-       #  git-rev-list N ^O --not --all
+       #  git rev-list N ^O --not --all
        #
        # The reason for the "almost", is that the "--not --all" will take
        # precedence over the "N", and effectively will translate to
        #
-       #  git-rev-list N ^O ^X ^N
+       #  git rev-list N ^O ^X ^N
        #
-       # So, we need to build up the list more carefully.  git-rev-parse
-       # will generate a list of revs that may be fed into git-rev-list.
+       # So, we need to build up the list more carefully.  git rev-parse
+       # will generate a list of revs that may be fed into git rev-list.
        # We can get it to make the "--not --all" part and then filter out
        # the "^N" with:
        #
-       #  git-rev-parse --not --all | grep -v N
+       #  git rev-parse --not --all | grep -v N
        #
-       # Then, using the --stdin switch to git-rev-list we have effectively
+       # Then, using the --stdin switch to git rev-list we have effectively
        # manufactured
        #
-       #  git-rev-list N ^O ^X
+       #  git rev-list N ^O ^X
        #
        # This leaves a problem when someone else updates the repository
        # while this script is running.  Their new value of the ref we're
@@ -274,10 +275,10 @@ generate_update_branch_email()
        # all of our commits.  What we really want is to exclude the current
        # value of $refname from the --not list, rather than N itself.  So:
        #
-       #  git-rev-parse --not --all | grep -v $(git-rev-parse $refname)
+       #  git rev-parse --not --all | grep -v $(git rev-parse $refname)
        #
        # Get's us to something pretty safe (apart from the small time
-       # between refname being read, and git-rev-parse running - for that,
+       # between refname being read, and git rev-parse running - for that,
        # I give up)
        #
        #
@@ -295,7 +296,7 @@ generate_update_branch_email()
        # As above, we need to take into account the presence of X; if
        # another branch is already in the repository and points at some of
        # the revisions that we are about to output - we don't want them.
-       # The solution is as before: git-rev-parse output filtered.
+       # The solution is as before: git rev-parse output filtered.
        #
        # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N
        #
@@ -305,7 +306,7 @@ generate_update_branch_email()
        # for a branch update.  Therefore we still want to output revisions
        # that have been output on a tag email.
        #
-       # Luckily, git-rev-parse includes just the tool.  Instead of using
+       # Luckily, git rev-parse includes just the tool.  Instead of using
        # "--all" we use "--branches"; this has the added benefit that
        # "remotes/" will be ignored as well.
 
@@ -389,8 +390,7 @@ generate_update_branch_email()
 
                echo ""
                echo $LOGBEGIN
-               git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
-               git rev-list --pretty --stdin $oldrev..$newrev
+               show_new_revisions
 
                # XXX: Need a way of detecting whether git rev-list actually
                # outputted anything, so that we can issue a "no new
@@ -454,7 +454,7 @@ generate_update_atag_email()
 #
 generate_atag_email()
 {
-       # Use git-for-each-ref to pull out the individual fields from the
+       # Use git for-each-ref to pull out the individual fields from the
        # tag
        eval $(git for-each-ref --shell --format='
        tagobject=%(*objectname)
@@ -567,12 +567,12 @@ generate_general_email()
        echo ""
        if [ "$newrev_type" = "commit" ]; then
                echo $LOGBEGIN
-               git show --no-color --root -s $newrev
+               git show --no-color --root -s --pretty=medium $newrev
                echo $LOGEND
        else
                # What can we do here?  The tag marks an object that is not
                # a commit, so there is no log for us to display.  It's
-               # probably not wise to output git-cat-file as it could be a
+               # probably not wise to output git cat-file as it could be a
                # binary blob.  We'll just say how big it is
                echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."
        fi
@@ -590,6 +590,45 @@ generate_delete_general_email()
        echo $LOGEND
 }
 
+
+# --------------- Miscellaneous utilities
+
+#
+# Show new revisions as the user would like to see them in the email.
+#
+show_new_revisions()
+{
+       # This shows all log entries that are not already covered by
+       # another ref - i.e. commits that are now accessible from this
+       # ref that were previously not accessible
+       # (see generate_update_branch_email for the explanation of this
+       # command)
+
+       # Revision range passed to rev-list differs for new vs. updated
+       # branches.
+       if [ "$change_type" = create ]
+       then
+               # Show all revisions exclusive to this (new) branch.
+               revspec=$newrev
+       else
+               # Branch update; show revisions not part of $oldrev.
+               revspec=$oldrev..$newrev
+       fi
+
+       git rev-parse --not --branches | grep -v $(git rev-parse $refname) |
+       if [ -z "$custom_showrev" ]
+       then
+               git rev-list --pretty --stdin $revspec
+       else
+               git rev-list --stdin $revspec |
+               while read onerev
+               do
+                       eval $(printf "$custom_showrev" $onerev)
+               done
+       fi
+}
+
+
 send_mail()
 {
        if [ -n "$envelopesender" ]; then
@@ -622,10 +661,11 @@ then
        projectdesc="UNNAMED PROJECT"
 fi
 
-recipients=$(git repo-config hooks.mailinglist)
-announcerecipients=$(git repo-config hooks.announcelist)
-envelopesender=$(git-repo-config hooks.envelopesender)
-emailprefix=$(git-repo-config hooks.emailprefix || echo '[SCM] ')
+recipients=$(git config hooks.mailinglist)
+announcerecipients=$(git config hooks.announcelist)
+envelopesender=$(git config hooks.envelopesender)
+emailprefix=$(git config hooks.emailprefix || echo '[SCM] ')
+custom_showrev=$(git config hooks.showrev)
 
 # --- Main loop
 # Allow dual mode: run from the command line just like the update hook, or