summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2020-09-03 12:37:07 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2020-09-03 12:37:07 -0700
commit2f1757e60af788904fcaa37d6d410f834fa3055f (patch)
tree9ceca81dddf8e0d212acc077090b83feebbd1a80
parentMerge branch 'pb/doc-sequence-editor-configuration' (diff)
parentdoc: clarify how exit status of post-checkout hook is used (diff)
downloadtgif-2f1757e60af788904fcaa37d6d410f834fa3055f.tar.xz
Merge branch 'jc/post-checkout-doc'
Doc update. * jc/post-checkout-doc: doc: clarify how exit status of post-checkout hook is used
-rw-r--r--Documentation/githooks.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index 31b601e4bc..cf95d6d02b 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -193,7 +193,9 @@ 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 switch` or `git checkout`.
+This hook cannot affect the outcome of `git switch` or `git checkout`,
+other than that the hook's exit status becomes the exit status of
+these two commands.
It is also run after linkgit:git-clone[1], unless the `--no-checkout` (`-n`) option is
used. The first parameter given to the hook is the null-ref, the second the