X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-receive-pack.txt;h=2f1a1f8ebb4ef8655f791bfb31ba6f032d3d9236;hb=ff3412ee1f74cc267e6d65c03c5fd8ea2214fbe7;hp=d3a835d4ba575c2173e6c6c7165968979a9cba9e;hpb=80bd6f3064a6009cd18a4dab9ce6d29681cec4af;p=git.git

diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt
index d3a835d4..2f1a1f8e 100644
--- a/Documentation/git-receive-pack.txt
+++ b/Documentation/git-receive-pack.txt
@@ -22,6 +22,55 @@ program pair is meant to be used to push updates to remote
 repository.  For pull operations, see 'git-fetch-pack' and
 'git-clone-pack'.
 
+The command allows for creation and fast forwarding of sha1 refs
+(heads/tags) on the remote end (strictly speaking, it is the
+local end receive-pack runs, but to the user who is sitting at
+the send-pack end, it is updating the remote.  Confused?)
+
+Before each ref is updated, if $GIT_DIR/hooks/update file exists
+and executable, it is called with three parameters:
+
+       $GIT_DIR/hooks/update refname sha1-old sha1-new
+
+The refname parameter is relative to $GIT_DIR; e.g. for the
+master head this is "refs/heads/master".  Two sha1 are the
+object names for the refname before and after the update.  Note
+that the hook is called before the refname is updated, so either
+sha1-old is 0{40} (meaning there is no such ref yet), or it
+should match what is recorded in refname.
+
+The hook should exit with non-zero status if it wants to
+disallow updating the named ref.  Otherwise it should exit with
+zero.
+
+Using this hook, it is easy to generate mails on updates to
+the local repository. This example script sends a mail with
+the commits pushed to the repository:
+
+	#!/bin/sh
+	# mail out commit update information.
+	if expr "$2" : '0*$' >/dev/null
+	then
+		echo "Created a new ref, with the following commits:"
+		git-rev-list --pretty "$2"
+	else
+		echo "New commits:"
+		git-rev-list --pretty "$3" "^$2"
+	fi |
+	mail -s "Changes to ref $1" commit-list@mydomain
+	exit 0
+
+Another hook $GIT_DIR/hooks/post-update, if exists and
+executable, is called with the list of refs that have been
+updated.  This can be used to implement repository wide cleanup
+task if needed.  The exit code from this hook invocation is
+ignored; the only thing left for git-receive-pack to do at that
+point is to exit itself anyway.  This hook can be used, for
+example, to run "git-update-server-info" if the repository is
+packed and is served via a dumb transport.
+
+	#!/bin/sh
+	exec git-update-server-info
 
 OPTIONS
 -------