X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fhooks.txt;h=f110162b0155b3b17bc3133c5f42504290c1de4d;hb=7680087e7c8125e7397aa5761f5c5ddbb02a8326;hp=50535a7983297e8ad1f3202bda13514dfc6b9e9d;hpb=46232915d5ac84fb033ad395bbf161c9645c42c9;p=git.git

diff --git a/Documentation/hooks.txt b/Documentation/hooks.txt
index 50535a798..f110162b0 100644
--- a/Documentation/hooks.txt
+++ b/Documentation/hooks.txt
@@ -87,6 +87,20 @@ parameter, and is invoked after a commit is made.
 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
 -----------
 
@@ -97,7 +111,8 @@ 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).
+(eg: permissions/ownership, ACLS, etc).  See contrib/hooks/setgitperms.perl
+for an example of how to do this.
 
 [[pre-receive]]
 pre-receive