Merge https://github.com/prati0100/git-gui
[git] / Documentation / githooks.txt
1 githooks(5)
2 ===========
3
4 NAME
5 ----
6 githooks - Hooks used by Git
7
8 SYNOPSIS
9 --------
10 $GIT_DIR/hooks/* (or \`git config core.hooksPath`/*)
11
12
13 DESCRIPTION
14 -----------
15
16 Hooks are programs you can place in a hooks directory to trigger
17 actions at certain points in git's execution. Hooks that don't have
18 the executable bit set are ignored.
19
20 By default the hooks directory is `$GIT_DIR/hooks`, but that can be
21 changed via the `core.hooksPath` configuration variable (see
22 linkgit:git-config[1]).
23
24 Before Git invokes a hook, it changes its working directory to either
25 $GIT_DIR in a bare repository or the root of the working tree in a non-bare
26 repository. An exception are hooks triggered during a push ('pre-receive',
27 'update', 'post-receive', 'post-update', 'push-to-checkout') which are always
28 executed in $GIT_DIR.
29
30 Hooks can get their arguments via the environment, command-line
31 arguments, and stdin. See the documentation for each hook below for
32 details.
33
34 `git init` may copy hooks to the new repository, depending on its
35 configuration. See the "TEMPLATE DIRECTORY" section in
36 linkgit:git-init[1] for details. When the rest of this document refers
37 to "default hooks" it's talking about the default template shipped
38 with Git.
39
40 The currently supported hooks are described below.
41
42 HOOKS
43 -----
44
45 applypatch-msg
46 ~~~~~~~~~~~~~~
47
48 This hook is invoked by linkgit:git-am[1].  It takes a single
49 parameter, the name of the file that holds the proposed commit
50 log message.  Exiting with a non-zero status causes `git am` to abort
51 before applying the patch.
52
53 The hook is allowed to edit the message file in place, and can
54 be used to normalize the message into some project standard
55 format. It can also be used to refuse the commit after inspecting
56 the message file.
57
58 The default 'applypatch-msg' hook, when enabled, runs the
59 'commit-msg' hook, if the latter is enabled.
60
61 pre-applypatch
62 ~~~~~~~~~~~~~~
63
64 This hook is invoked by linkgit:git-am[1].  It takes no parameter, and is
65 invoked after the patch is applied, but before a commit is made.
66
67 If it exits with non-zero status, then the working tree will not be
68 committed after applying the patch.
69
70 It can be used to inspect the current working tree and refuse to
71 make a commit if it does not pass certain test.
72
73 The default 'pre-applypatch' hook, when enabled, runs the
74 'pre-commit' hook, if the latter is enabled.
75
76 post-applypatch
77 ~~~~~~~~~~~~~~~
78
79 This hook is invoked by linkgit:git-am[1].  It takes no parameter,
80 and is invoked after the patch is applied and a commit is made.
81
82 This hook is meant primarily for notification, and cannot affect
83 the outcome of `git am`.
84
85 pre-commit
86 ~~~~~~~~~~
87
88 This hook is invoked by linkgit:git-commit[1], and can be bypassed
89 with the `--no-verify` option.  It takes no parameters, and is
90 invoked before obtaining the proposed commit log message and
91 making a commit.  Exiting with a non-zero status from this script
92 causes the `git commit` command to abort before creating a commit.
93
94 The default 'pre-commit' hook, when enabled, catches introduction
95 of lines with trailing whitespaces and aborts the commit when
96 such a line is found.
97
98 All the `git commit` hooks are invoked with the environment
99 variable `GIT_EDITOR=:` if the command will not bring up an editor
100 to modify the commit message.
101
102 The default 'pre-commit' hook, when enabled--and with the
103 `hooks.allownonascii` config option unset or set to false--prevents
104 the use of non-ASCII filenames.
105
106 pre-merge-commit
107 ~~~~~~~~~~~~~~~~
108
109 This hook is invoked by linkgit:git-merge[1], and can be bypassed
110 with the `--no-verify` option.  It takes no parameters, and is
111 invoked after the merge has been carried out successfully and before
112 obtaining the proposed commit log message to
113 make a commit.  Exiting with a non-zero status from this script
114 causes the `git merge` command to abort before creating a commit.
115
116 The default 'pre-merge-commit' hook, when enabled, runs the
117 'pre-commit' hook, if the latter is enabled.
118
119 This hook is invoked with the environment variable
120 `GIT_EDITOR=:` if the command will not bring up an editor
121 to modify the commit message.
122
123 If the merge cannot be carried out automatically, the conflicts
124 need to be resolved and the result committed separately (see
125 linkgit:git-merge[1]). At that point, this hook will not be executed,
126 but the 'pre-commit' hook will, if it is enabled.
127
128 prepare-commit-msg
129 ~~~~~~~~~~~~~~~~~~
130
131 This hook is invoked by linkgit:git-commit[1] right after preparing the
132 default log message, and before the editor is started.
133
134 It takes one to three parameters.  The first is the name of the file
135 that contains the commit log message.  The second is the source of the commit
136 message, and can be: `message` (if a `-m` or `-F` option was
137 given); `template` (if a `-t` option was given or the
138 configuration option `commit.template` is set); `merge` (if the
139 commit is a merge or a `.git/MERGE_MSG` file exists); `squash`
140 (if a `.git/SQUASH_MSG` file exists); or `commit`, followed by
141 a commit SHA-1 (if a `-c`, `-C` or `--amend` option was given).
142
143 If the exit status is non-zero, `git commit` will abort.
144
145 The purpose of the hook is to edit the message file in place, and
146 it is not suppressed by the `--no-verify` option.  A non-zero exit
147 means a failure of the hook and aborts the commit.  It should not
148 be used as replacement for pre-commit hook.
149
150 The sample `prepare-commit-msg` hook that comes with Git removes the
151 help message found in the commented portion of the commit template.
152
153 commit-msg
154 ~~~~~~~~~~
155
156 This hook is invoked by linkgit:git-commit[1] and linkgit:git-merge[1], and can be
157 bypassed with the `--no-verify` option.  It takes a single parameter,
158 the name of the file that holds the proposed commit log message.
159 Exiting with a non-zero status causes the command to abort.
160
161 The hook is allowed to edit the message file in place, and can be used
162 to normalize the message into some project standard format. It
163 can also be used to refuse the commit after inspecting the message
164 file.
165
166 The default 'commit-msg' hook, when enabled, detects duplicate
167 "Signed-off-by" lines, and aborts the commit if one is found.
168
169 post-commit
170 ~~~~~~~~~~~
171
172 This hook is invoked by linkgit:git-commit[1]. It takes no parameters, and is
173 invoked after a commit is made.
174
175 This hook is meant primarily for notification, and cannot affect
176 the outcome of `git commit`.
177
178 pre-rebase
179 ~~~~~~~~~~
180
181 This hook is called by linkgit:git-rebase[1] and can be used to prevent a
182 branch from getting rebased.  The hook may be called with one or
183 two parameters.  The first parameter is the upstream from which
184 the series was forked.  The second parameter is the branch being
185 rebased, and is not set when rebasing the current branch.
186
187 post-checkout
188 ~~~~~~~~~~~~~
189
190 This hook is invoked when a linkgit:git-checkout[1] or
191 linkgit:git-switch[1] is run after having updated the
192 worktree.  The hook is given three parameters: the ref of the previous HEAD,
193 the ref of the new HEAD (which may or may not have changed), and a flag
194 indicating whether the checkout was a branch checkout (changing branches,
195 flag=1) or a file checkout (retrieving a file from the index, flag=0).
196 This hook cannot affect the outcome of `git switch` or `git checkout`,
197 other than that the hook's exit status becomes the exit status of
198 these two commands.
199
200 It is also run after linkgit:git-clone[1], unless the `--no-checkout` (`-n`) option is
201 used. The first parameter given to the hook is the null-ref, the second the
202 ref of the new HEAD and the flag is always 1. Likewise for `git worktree add`
203 unless `--no-checkout` is used.
204
205 This hook can be used to perform repository validity checks, auto-display
206 differences from the previous HEAD if different, or set working dir metadata
207 properties.
208
209 post-merge
210 ~~~~~~~~~~
211
212 This hook is invoked by linkgit:git-merge[1], which happens when a `git pull`
213 is done on a local repository.  The hook takes a single parameter, a status
214 flag specifying whether or not the merge being done was a squash merge.
215 This hook cannot affect the outcome of `git merge` and is not executed,
216 if the merge failed due to conflicts.
217
218 This hook can be used in conjunction with a corresponding pre-commit hook to
219 save and restore any form of metadata associated with the working tree
220 (e.g.: permissions/ownership, ACLS, etc).  See contrib/hooks/setgitperms.perl
221 for an example of how to do this.
222
223 pre-push
224 ~~~~~~~~
225
226 This hook is called by linkgit:git-push[1] and can be used to prevent
227 a push from taking place.  The hook is called with two parameters
228 which provide the name and location of the destination remote, if a
229 named remote is not being used both values will be the same.
230
231 Information about what is to be pushed is provided on the hook's standard
232 input with lines of the form:
233
234   <local ref> SP <local sha1> SP <remote ref> SP <remote sha1> LF
235
236 For instance, if the command +git push origin master:foreign+ were run the
237 hook would receive a line like the following:
238
239   refs/heads/master 67890 refs/heads/foreign 12345
240
241 although the full, 40-character SHA-1s would be supplied.  If the foreign ref
242 does not yet exist the `<remote SHA-1>` will be 40 `0`.  If a ref is to be
243 deleted, the `<local ref>` will be supplied as `(delete)` and the `<local
244 SHA-1>` will be 40 `0`.  If the local commit was specified by something other
245 than a name which could be expanded (such as `HEAD~`, or a SHA-1) it will be
246 supplied as it was originally given.
247
248 If this hook exits with a non-zero status, `git push` will abort without
249 pushing anything.  Information about why the push is rejected may be sent
250 to the user by writing to standard error.
251
252 [[pre-receive]]
253 pre-receive
254 ~~~~~~~~~~~
255
256 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
257 `git push` and updates reference(s) in its repository.
258 Just before starting to update refs on the remote repository, the
259 pre-receive hook is invoked.  Its exit status determines the success
260 or failure of the update.
261
262 This hook executes once for the receive operation. It takes no
263 arguments, but for each ref to be updated it receives on standard
264 input a line of the format:
265
266   <old-value> SP <new-value> SP <ref-name> LF
267
268 where `<old-value>` is the old object name stored in the ref,
269 `<new-value>` is the new object name to be stored in the ref and
270 `<ref-name>` is the full name of the ref.
271 When creating a new ref, `<old-value>` is 40 `0`.
272
273 If the hook exits with non-zero status, none of the refs will be
274 updated. If the hook exits with zero, updating of individual refs can
275 still be prevented by the <<update,'update'>> hook.
276
277 Both standard output and standard error output are forwarded to
278 `git send-pack` on the other end, so you can simply `echo` messages
279 for the user.
280
281 The number of push options given on the command line of
282 `git push --push-option=...` can be read from the environment
283 variable `GIT_PUSH_OPTION_COUNT`, and the options themselves are
284 found in `GIT_PUSH_OPTION_0`, `GIT_PUSH_OPTION_1`,...
285 If it is negotiated to not use the push options phase, the
286 environment variables will not be set. If the client selects
287 to use push options, but doesn't transmit any, the count variable
288 will be set to zero, `GIT_PUSH_OPTION_COUNT=0`.
289
290 See the section on "Quarantine Environment" in
291 linkgit:git-receive-pack[1] for some caveats.
292
293 [[update]]
294 update
295 ~~~~~~
296
297 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
298 `git push` and updates reference(s) in its repository.
299 Just before updating the ref on the remote repository, the update hook
300 is invoked.  Its exit status determines the success or failure of
301 the ref update.
302
303 The hook executes once for each ref to be updated, and takes
304 three parameters:
305
306  - the name of the ref being updated,
307  - the old object name stored in the ref,
308  - and the new object name to be stored in the ref.
309
310 A zero exit from the update hook allows the ref to be updated.
311 Exiting with a non-zero status prevents `git receive-pack`
312 from updating that ref.
313
314 This hook can be used to prevent 'forced' update on certain refs by
315 making sure that the object name is a commit object that is a
316 descendant of the commit object named by the old object name.
317 That is, to enforce a "fast-forward only" policy.
318
319 It could also be used to log the old..new status.  However, it
320 does not know the entire set of branches, so it would end up
321 firing one e-mail per ref when used naively, though.  The
322 <<post-receive,'post-receive'>> hook is more suited to that.
323
324 In an environment that restricts the users' access only to git
325 commands over the wire, this hook can be used to implement access
326 control without relying on filesystem ownership and group
327 membership. See linkgit:git-shell[1] for how you might use the login
328 shell to restrict the user's access to only git commands.
329
330 Both standard output and standard error output are forwarded to
331 `git send-pack` on the other end, so you can simply `echo` messages
332 for the user.
333
334 The default 'update' hook, when enabled--and with
335 `hooks.allowunannotated` config option unset or set to false--prevents
336 unannotated tags to be pushed.
337
338 [[proc-receive]]
339 proc-receive
340 ~~~~~~~~~~~~
341
342 This hook is invoked by linkgit:git-receive-pack[1].  If the server has
343 set the multi-valued config variable `receive.procReceiveRefs`, and the
344 commands sent to 'receive-pack' have matching reference names, these
345 commands will be executed by this hook, instead of by the internal
346 `execute_commands()` function.  This hook is responsible for updating
347 the relevant references and reporting the results back to 'receive-pack'.
348
349 This hook executes once for the receive operation.  It takes no
350 arguments, but uses a pkt-line format protocol to communicate with
351 'receive-pack' to read commands, push-options and send results.  In the
352 following example for the protocol, the letter 'S' stands for
353 'receive-pack' and the letter 'H' stands for this hook.
354
355     # Version and features negotiation.
356     S: PKT-LINE(version=1\0push-options atomic...)
357     S: flush-pkt
358     H: PKT-LINE(version=1\0push-options...)
359     H: flush-pkt
360
361     # Send commands from server to the hook.
362     S: PKT-LINE(<old-oid> <new-oid> <ref>)
363     S: ... ...
364     S: flush-pkt
365     # Send push-options only if the 'push-options' feature is enabled.
366     S: PKT-LINE(push-option)
367     S: ... ...
368     S: flush-pkt
369
370     # Receive result from the hook.
371     # OK, run this command successfully.
372     H: PKT-LINE(ok <ref>)
373     # NO, I reject it.
374     H: PKT-LINE(ng <ref> <reason>)
375     # Fall through, let 'receive-pack' to execute it.
376     H: PKT-LINE(ok <ref>)
377     H: PKT-LINE(option fall-through)
378     # OK, but has an alternate reference.  The alternate reference name
379     # and other status can be given in option directives.
380     H: PKT-LINE(ok <ref>)
381     H: PKT-LINE(option refname <refname>)
382     H: PKT-LINE(option old-oid <old-oid>)
383     H: PKT-LINE(option new-oid <new-oid>)
384     H: PKT-LINE(option forced-update)
385     H: ... ...
386     H: flush-pkt
387
388 Each command for the 'proc-receive' hook may point to a pseudo-reference
389 and always has a zero-old as its old-oid, while the 'proc-receive' hook
390 may update an alternate reference and the alternate reference may exist
391 already with a non-zero old-oid.  For this case, this hook will use
392 "option" directives to report extended attributes for the reference given
393 by the leading "ok" directive.
394
395 The report of the commands of this hook should have the same order as
396 the input.  The exit status of the 'proc-receive' hook only determines
397 the success or failure of the group of commands sent to it, unless
398 atomic push is in use.
399
400 [[post-receive]]
401 post-receive
402 ~~~~~~~~~~~~
403
404 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
405 `git push` and updates reference(s) in its repository.
406 It executes on the remote repository once after all the refs have
407 been updated.
408
409 This hook executes once for the receive operation.  It takes no
410 arguments, but gets the same information as the
411 <<pre-receive,'pre-receive'>>
412 hook does on its standard input.
413
414 This hook does not affect the outcome of `git receive-pack`, as it
415 is called after the real work is done.
416
417 This supersedes the <<post-update,'post-update'>> hook in that it gets
418 both old and new values of all the refs in addition to their
419 names.
420
421 Both standard output and standard error output are forwarded to
422 `git send-pack` on the other end, so you can simply `echo` messages
423 for the user.
424
425 The default 'post-receive' hook is empty, but there is
426 a sample script `post-receive-email` provided in the `contrib/hooks`
427 directory in Git distribution, which implements sending commit
428 emails.
429
430 The number of push options given on the command line of
431 `git push --push-option=...` can be read from the environment
432 variable `GIT_PUSH_OPTION_COUNT`, and the options themselves are
433 found in `GIT_PUSH_OPTION_0`, `GIT_PUSH_OPTION_1`,...
434 If it is negotiated to not use the push options phase, the
435 environment variables will not be set. If the client selects
436 to use push options, but doesn't transmit any, the count variable
437 will be set to zero, `GIT_PUSH_OPTION_COUNT=0`.
438
439 [[post-update]]
440 post-update
441 ~~~~~~~~~~~
442
443 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
444 `git push` and updates reference(s) in its repository.
445 It executes on the remote repository once after all the refs have
446 been updated.
447
448 It takes a variable number of parameters, each of which is the
449 name of ref that was actually updated.
450
451 This hook is meant primarily for notification, and cannot affect
452 the outcome of `git receive-pack`.
453
454 The 'post-update' hook can tell what are the heads that were pushed,
455 but it does not know what their original and updated values are,
456 so it is a poor place to do log old..new. The
457 <<post-receive,'post-receive'>> hook does get both original and
458 updated values of the refs. You might consider it instead if you need
459 them.
460
461 When enabled, the default 'post-update' hook runs
462 `git update-server-info` to keep the information used by dumb
463 transports (e.g., HTTP) up to date.  If you are publishing
464 a Git repository that is accessible via HTTP, you should
465 probably enable this hook.
466
467 Both standard output and standard error output are forwarded to
468 `git send-pack` on the other end, so you can simply `echo` messages
469 for the user.
470
471 reference-transaction
472 ~~~~~~~~~~~~~~~~~~~~~
473
474 This hook is invoked by any Git command that performs reference
475 updates. It executes whenever a reference transaction is prepared,
476 committed or aborted and may thus get called multiple times.
477
478 The hook takes exactly one argument, which is the current state the
479 given reference transaction is in:
480
481     - "prepared": All reference updates have been queued to the
482       transaction and references were locked on disk.
483
484     - "committed": The reference transaction was committed and all
485       references now have their respective new value.
486
487     - "aborted": The reference transaction was aborted, no changes
488       were performed and the locks have been released.
489
490 For each reference update that was added to the transaction, the hook
491 receives on standard input a line of the format:
492
493   <old-value> SP <new-value> SP <ref-name> LF
494
495 The exit status of the hook is ignored for any state except for the
496 "prepared" state. In the "prepared" state, a non-zero exit status will
497 cause the transaction to be aborted. The hook will not be called with
498 "aborted" state in that case.
499
500 push-to-checkout
501 ~~~~~~~~~~~~~~~~
502
503 This hook is invoked by linkgit:git-receive-pack[1] when it reacts to
504 `git push` and updates reference(s) in its repository, and when
505 the push tries to update the branch that is currently checked out
506 and the `receive.denyCurrentBranch` configuration variable is set to
507 `updateInstead`.  Such a push by default is refused if the working
508 tree and the index of the remote repository has any difference from
509 the currently checked out commit; when both the working tree and the
510 index match the current commit, they are updated to match the newly
511 pushed tip of the branch.  This hook is to be used to override the
512 default behaviour.
513
514 The hook receives the commit with which the tip of the current
515 branch is going to be updated.  It can exit with a non-zero status
516 to refuse the push (when it does so, it must not modify the index or
517 the working tree).  Or it can make any necessary changes to the
518 working tree and to the index to bring them to the desired state
519 when the tip of the current branch is updated to the new commit, and
520 exit with a zero status.
521
522 For example, the hook can simply run `git read-tree -u -m HEAD "$1"`
523 in order to emulate `git fetch` that is run in the reverse direction
524 with `git push`, as the two-tree form of `git read-tree -u -m` is
525 essentially the same as `git switch` or `git checkout`
526 that switches branches while
527 keeping the local changes in the working tree that do not interfere
528 with the difference between the branches.
529
530
531 pre-auto-gc
532 ~~~~~~~~~~~
533
534 This hook is invoked by `git gc --auto` (see linkgit:git-gc[1]). It
535 takes no parameter, and exiting with non-zero status from this script
536 causes the `git gc --auto` to abort.
537
538 post-rewrite
539 ~~~~~~~~~~~~
540
541 This hook is invoked by commands that rewrite commits
542 (linkgit:git-commit[1] when called with `--amend` and
543 linkgit:git-rebase[1]; however, full-history (re)writing tools like
544 linkgit:git-fast-import[1] or
545 https://github.com/newren/git-filter-repo[git-filter-repo] typically
546 do not call it!).  Its first argument denotes the command it was
547 invoked by: currently one of `amend` or `rebase`.  Further
548 command-dependent arguments may be passed in the future.
549
550 The hook receives a list of the rewritten commits on stdin, in the
551 format
552
553   <old-sha1> SP <new-sha1> [ SP <extra-info> ] LF
554
555 The 'extra-info' is again command-dependent.  If it is empty, the
556 preceding SP is also omitted.  Currently, no commands pass any
557 'extra-info'.
558
559 The hook always runs after the automatic note copying (see
560 "notes.rewrite.<command>" in linkgit:git-config[1]) has happened, and
561 thus has access to these notes.
562
563 The following command-specific comments apply:
564
565 rebase::
566         For the 'squash' and 'fixup' operation, all commits that were
567         squashed are listed as being rewritten to the squashed commit.
568         This means that there will be several lines sharing the same
569         'new-sha1'.
570 +
571 The commits are guaranteed to be listed in the order that they were
572 processed by rebase.
573
574 sendemail-validate
575 ~~~~~~~~~~~~~~~~~~
576
577 This hook is invoked by linkgit:git-send-email[1].  It takes a single parameter,
578 the name of the file that holds the e-mail to be sent.  Exiting with a
579 non-zero status causes `git send-email` to abort before sending any
580 e-mails.
581
582 fsmonitor-watchman
583 ~~~~~~~~~~~~~~~~~~
584
585 This hook is invoked when the configuration option `core.fsmonitor` is
586 set to `.git/hooks/fsmonitor-watchman` or `.git/hooks/fsmonitor-watchmanv2`
587 depending on the version of the hook to use.
588
589 Version 1 takes two arguments, a version (1) and the time in elapsed
590 nanoseconds since midnight, January 1, 1970.
591
592 Version 2 takes two arguments, a version (2) and a token that is used
593 for identifying changes since the token. For watchman this would be
594 a clock id. This version must output to stdout the new token followed
595 by a NUL before the list of files.
596
597 The hook should output to stdout the list of all files in the working
598 directory that may have changed since the requested time.  The logic
599 should be inclusive so that it does not miss any potential changes.
600 The paths should be relative to the root of the working directory
601 and be separated by a single NUL.
602
603 It is OK to include files which have not actually changed.  All changes
604 including newly-created and deleted files should be included. When
605 files are renamed, both the old and the new name should be included.
606
607 Git will limit what files it checks for changes as well as which
608 directories are checked for untracked files based on the path names
609 given.
610
611 An optimized way to tell git "all files have changed" is to return
612 the filename `/`.
613
614 The exit status determines whether git will use the data from the
615 hook to limit its search.  On error, it will fall back to verifying
616 all files and folders.
617
618 p4-changelist
619 ~~~~~~~~~~~~~
620
621 This hook is invoked by `git-p4 submit`.
622
623 The `p4-changelist` hook is executed after the changelist
624 message has been edited by the user. It can be bypassed with the
625 `--no-verify` option. It takes a single parameter, the name
626 of the file that holds the proposed changelist text. Exiting
627 with a non-zero status causes the command to abort.
628
629 The hook is allowed to edit the changelist file and can be used
630 to normalize the text into some project standard format. It can
631 also be used to refuse the Submit after inspect the message file.
632
633 Run `git-p4 submit --help` for details.
634
635 p4-prepare-changelist
636 ~~~~~~~~~~~~~~~~~~~~~
637
638 This hook is invoked by `git-p4 submit`.
639
640 The `p4-prepare-changelist` hook is executed right after preparing
641 the default changelist message and before the editor is started.
642 It takes one parameter, the name of the file that contains the
643 changelist text. Exiting with a non-zero status from the script
644 will abort the process.
645
646 The purpose of the hook is to edit the message file in place,
647 and it is not supressed by the `--no-verify` option. This hook
648 is called even if `--prepare-p4-only` is set.
649
650 Run `git-p4 submit --help` for details.
651
652 p4-post-changelist
653 ~~~~~~~~~~~~~~~~~~
654
655 This hook is invoked by `git-p4 submit`.
656
657 The `p4-post-changelist` hook is invoked after the submit has
658 successfully occured in P4. It takes no parameters and is meant
659 primarily for notification and cannot affect the outcome of the
660 git p4 submit action.
661
662 Run `git-p4 submit --help` for details.
663
664 p4-pre-submit
665 ~~~~~~~~~~~~~
666
667 This hook is invoked by `git-p4 submit`. It takes no parameters and nothing
668 from standard input. Exiting with non-zero status from this script prevent
669 `git-p4 submit` from launching. It can be bypassed with the `--no-verify`
670 command line option. Run `git-p4 submit --help` for details.
671
672
673
674 post-index-change
675 ~~~~~~~~~~~~~~~~~
676
677 This hook is invoked when the index is written in read-cache.c
678 do_write_locked_index.
679
680 The first parameter passed to the hook is the indicator for the
681 working directory being updated.  "1" meaning working directory
682 was updated or "0" when the working directory was not updated.
683
684 The second parameter passed to the hook is the indicator for whether
685 or not the index was updated and the skip-worktree bit could have
686 changed.  "1" meaning skip-worktree bits could have been updated
687 and "0" meaning they were not.
688
689 Only one parameter should be set to "1" when the hook runs.  The hook
690 running passing "1", "1" should not be possible.
691
692 GIT
693 ---
694 Part of the linkgit:git[1] suite