Save username -> Full Name <email@addr.es> map file
[gitweb.git] / Documentation / hooks.txt
index 45809ba13ae6ee2ae120e002f126732918ceac8e..4ad1920ec10cf4b7733ebeae1424f003cc3fe9eb 100644 (file)
@@ -1,6 +1,5 @@
-Hooks used by GIT
+Hooks used by git
 =================
-v0.99.6, Sep 2005
 
 Hooks are little scripts you can place in `$GIT_DIR/hooks`
 directory to trigger action at certain points.  When
@@ -56,11 +55,11 @@ the outcome of `git-applypatch`.
 pre-commit
 ----------
 
-This hook is invoked by `git-commit-script`, and can be bypassed
-with `--no-verify` option.  It takes no parameter, and is
+This hook is invoked by `git-commit`, and can be bypassed
+with `\--no-verify` option.  It takes no parameter, and is
 invoked before obtaining the proposed commit log message and
 making a commit.  Exiting with non-zero status from this script
-causes the `git-commit-script` to abort.
+causes the `git-commit` to abort.
 
 The default pre-commit hook, when enabled, catches introduction
 of lines with trailing whitespaces and aborts the commit when
@@ -69,10 +68,10 @@ a such line is found.
 commit-msg
 ----------
 
-This hook is invoked by `git-commit-script`, and can be bypassed
-with `--no-verify` option.  It takes a single parameter, the
+This hook is invoked by `git-commit`, and can be bypassed
+with `\--no-verify` option.  It takes a single parameter, the
 name of the file that holds the proposed commit log message.
-Exiting with non-zero status causes the `git-commit-script` to
+Exiting with non-zero status causes the `git-commit` to
 abort.
 
 The hook is allowed to edit the message file in place, and can
@@ -86,11 +85,11 @@ Signed-off-by: lines, and aborts the commit when one is found.
 post-commit
 -----------
 
-This hook is invoked by `git-commit-script`.  It takes no
+This hook is invoked by `git-commit`.  It takes no
 parameter, and is invoked after a commit is made.
 
 This hook is meant primarily for notification, and cannot affect
-the outcome of `git-commit-script`.
+the outcome of `git-commit`.
 
 The default post-commit hook, when enabled, demonstrates how to
 send out a commit notification e-mail.
@@ -112,6 +111,10 @@ Another use suggested on the mailing list is to use this hook to
 implement access control which is finer grained than the one
 based on filesystem group.
 
+The standard output of this hook is sent to /dev/null; if you
+want to report something to the git-send-pack on the other end,
+you can redirect your output to your stderr.
+
 post-update
 -----------
 
@@ -126,3 +129,7 @@ the outcome of `git-receive-pack`.
 The default post-update hook, when enabled, runs
 `git-update-server-info` to keep the information used by dumb
 transport up-to-date.
+
+The standard output of this hook is sent to /dev/null; if you
+want to report something to the git-send-pack on the other end,
+you can redirect your output to your stderr.