X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=Documentation%2Fhooks.txt;h=f110162b0155b3b17bc3133c5f42504290c1de4d;hb=4356736571c6845cb446e4a7c9d645868e558ca0;hp=58b954759610ca272b72a05db0cd14e2868ff301;hpb=e4b2890773706d0340371571914f8f24036840e6;p=git.git

diff --git a/Documentation/hooks.txt b/Documentation/hooks.txt
index 58b954759..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
 -----------