git-svn: info --url [path]

[git.git] / Documentation / hooks.txt

diff --git a/Documentation/hooks.txt b/Documentation/hooks.txt
index aabb9750fddbc28091c46780ccf7b835b62b04c7..f110162b0155b3b17bc3133c5f42504290c1de4d 100644 (file)
--- a/Documentation/hooks.txt
+++ b/Documentation/hooks.txt
@@ -12,11 +12,10 @@ This document describes the currently defined hooks.
 applypatch-msg
 --------------
 
 applypatch-msg
 --------------
 

-This hook is invoked by `git-applypatch` script, which is
-typically invoked by `git-applymbox`.  It takes a single
+This hook is invoked by `git-am` script.  It takes a single

 parameter, the name of the file that holds the proposed commit
 log message.  Exiting with non-zero status causes
 parameter, the name of the file that holds the proposed commit
 log message.  Exiting with non-zero status causes

-`git-applypatch` to abort before applying the patch.
+`git-am` to abort before applying the patch.

 
 The hook is allowed to edit the message file in place, and can
 be used to normalize the message into some project standard
 
 The hook is allowed to edit the message file in place, and can
 be used to normalize the message into some project standard


@@ -29,8 +28,7 @@ The default 'applypatch-msg' hook, when enabled, runs the
 pre-applypatch
 --------------
 
 pre-applypatch
 --------------
 

-This hook is invoked by `git-applypatch` script, which is
-typically invoked by `git-applymbox`.  It takes no parameter,
+This hook is invoked by `git-am`.  It takes no parameter,

 and is invoked after the patch is applied, but before a commit
 is made.  Exiting with non-zero status causes the working tree
 after application of the patch not committed.
 and is invoked after the patch is applied, but before a commit
 is made.  Exiting with non-zero status causes the working tree
 after application of the patch not committed.


@@ -44,12 +42,11 @@ The default 'pre-applypatch' hook, when enabled, runs the
 post-applypatch
 ---------------
 
 post-applypatch
 ---------------
 

-This hook is invoked by `git-applypatch` script, which is
-typically invoked by `git-applymbox`.  It takes no parameter,
+This hook is invoked by `git-am`.  It takes no parameter,

 and is invoked after the patch is applied and a commit is made.
 
 This hook is meant primarily for notification, and cannot affect
 and is invoked after the patch is applied and a commit is made.
 
 This hook is meant primarily for notification, and cannot affect

-the outcome of `git-applypatch`.
+the outcome of `git-am`.

 
 pre-commit
 ----------
 
 pre-commit
 ----------


@@ -90,6 +87,33 @@ parameter, and is invoked after a commit is made.
 This hook is meant primarily for notification, and cannot affect
 the outcome of `git-commit`.
 
 This hook is meant primarily for notification, and cannot affect
 the outcome of `git-commit`.
 

+post-checkout
+-----------
+
+This hook is invoked when a `git-checkout` is run after having updated the
+worktree.  The hook is given three parameters: the ref of the previous HEAD,
+the ref of the new HEAD (which may or may not have changed), and a flag
+indicating whether the checkout was a branch checkout (changing branches,
+flag=1) or a file checkout (retrieving a file from the index, flag=0).
+This hook cannot affect the outcome of `git-checkout`.
+
+This hook can be used to perform repository validity checks, auto-display
+differences from the previous HEAD if different, or set working dir metadata
+properties.
+
+post-merge
+-----------
+
+This hook is invoked by `git-merge`, which happens when a `git pull`
+is done on a local repository.  The hook takes a single parameter, a status
+flag specifying whether or not the merge being done was a squash merge.
+This hook cannot affect the outcome of `git-merge`.
+
+This hook can be used in conjunction with a corresponding pre-commit hook to
+save and restore any form of metadata associated with the working tree
+(eg: permissions/ownership, ACLS, etc).  See contrib/hooks/setgitperms.perl
+for an example of how to do this.
+

 [[pre-receive]]
 pre-receive
 -----------
 [[pre-receive]]
 pre-receive
 -----------


@@ -179,7 +203,7 @@ hook does on its standard input.
 This hook does not affect the outcome of `git-receive-pack`, as it
 is called after the real work is done.
 
 This hook does not affect the outcome of `git-receive-pack`, as it
 is called after the real work is done.
 

-This supersedes the <<post-update,'post-update'>> hook in that it get's
+This supersedes the <<post-update,'post-update'>> hook in that it gets

 both old and new values of all the refs in addition to their
 names.
 
 both old and new values of all the refs in addition to their
 names.