mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Ben Peart <>
Subject: [PATCH v1 3/3] read-cache: Add documentation for the post-indexchanged hook
Date: Fri,  8 Feb 2019 14:51:15 -0500	[thread overview]
Message-ID: <> (raw)
In-Reply-To: <>

From: Kevin Willford <>

Document the new post-indexchanged hook with information on when it is
called as well as the flags passed and what each of them mean.

Signed-off-by: Kevin Willford <>
Signed-off-by: Ben Peart <>
 Documentation/githooks.txt | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index 959044347e..9349cd8900 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -492,6 +492,24 @@ This hook is invoked by `git-p4 submit`. It takes no parameters and nothing
 from standard input. Exiting with non-zero status from this script prevent
 `git-p4 submit` from launching. Run `git-p4 submit --help` for details.
+This hook is invoked when the index is written in read-cache.c
+The first parameter passed to the hook is the indicator for the
+working directory being updated.  "1" meaning working directory
+was updated or "0" when the working directory was not updated.
+The second parameter passed to the hook is the indicator for whether
+or not the index was updated and the skip-worktree bit could have
+changed.  "1" meaning skip-worktree bits could have been updated
+and "0" meaning they were not.
+Only one parameter should be set to "1" when the hook runs.  The hook
+running passing "1", "1" should not be possible.
 Part of the linkgit:git[1] suite

  parent reply	other threads:[~2019-02-08 19:51 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-08 19:51 [PATCH v1 0/3] Add post-indexchanged hook Ben Peart
2019-02-08 19:51 ` [PATCH v1 1/3] read-cache: add " Ben Peart
2019-02-08 23:53   ` brian m. carlson
2019-02-12 17:39     ` Ben Peart
2019-02-08 19:51 ` [PATCH v1 2/3] read-cache: add test for " Ben Peart
2019-02-08 19:51 ` Ben Peart [this message]
2019-02-14 14:42 ` [PATCH v2] read-cache: add " Ben Peart
2019-02-14 16:28   ` Ramsay Jones
2019-02-14 20:33     ` Junio C Hamano
2019-02-15  0:14       ` Ben Peart
2019-02-15 17:50         ` Junio C Hamano
2019-02-15 18:02           ` Ben Peart
2019-02-15 17:59 ` [PATCH v3] read-cache: add post-index-change hook Ben Peart

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:

  List information:

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \ \ \ \ \ \

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).