Merge branch 'rs/pretty-wrap'

[git.git] / Documentation / githooks.txt

diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index 1c736738ccc91b6929226a27e02716221ec3ef05..4cc3d1387fbdb60a2134a2e399fa46140939fe2f 100644 (file)
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -26,8 +26,11 @@ executable by default.
 
 This document describes the currently defined hooks.
 
 
 This document describes the currently defined hooks.
 

+HOOKS
+-----
+

 applypatch-msg
 applypatch-msg

---------------
+~~~~~~~~~~~~~~

 
 This hook is invoked by 'git-am' script.  It takes a single
 parameter, the name of the file that holds the proposed commit
 
 This hook is invoked by 'git-am' script.  It takes a single
 parameter, the name of the file that holds the proposed commit


@@ -43,7 +46,7 @@ The default 'applypatch-msg' hook, when enabled, runs the
 'commit-msg' hook, if the latter is enabled.
 
 pre-applypatch
 'commit-msg' hook, if the latter is enabled.
 
 pre-applypatch

---------------
+~~~~~~~~~~~~~~

 
 This hook is invoked by 'git-am'.  It takes no parameter, and is
 invoked after the patch is applied, but before a commit is made.
 
 This hook is invoked by 'git-am'.  It takes no parameter, and is
 invoked after the patch is applied, but before a commit is made.


@@ -58,7 +61,7 @@ The default 'pre-applypatch' hook, when enabled, runs the
 'pre-commit' hook, if the latter is enabled.
 
 post-applypatch
 'pre-commit' hook, if the latter is enabled.
 
 post-applypatch

----------------
+~~~~~~~~~~~~~~~

 
 This hook is invoked by 'git-am'.  It takes no parameter,
 and is invoked after the patch is applied and a commit is made.
 
 This hook is invoked by 'git-am'.  It takes no parameter,
 and is invoked after the patch is applied and a commit is made.


@@ -67,7 +70,7 @@ This hook is meant primarily for notification, and cannot affect
 the outcome of 'git-am'.
 
 pre-commit
 the outcome of 'git-am'.
 
 pre-commit

-----------
+~~~~~~~~~~

 
 This hook is invoked by 'git-commit', and can be bypassed
 with `\--no-verify` option.  It takes no parameter, and is
 
 This hook is invoked by 'git-commit', and can be bypassed
 with `\--no-verify` option.  It takes no parameter, and is


@@ -84,7 +87,7 @@ variable `GIT_EDITOR=:` if the command will not bring up an editor
 to modify the commit message.
 
 prepare-commit-msg
 to modify the commit message.
 
 prepare-commit-msg

-------------------
+~~~~~~~~~~~~~~~~~~

 
 This hook is invoked by 'git-commit' right after preparing the
 default log message, and before the editor is started.
 
 This hook is invoked by 'git-commit' right after preparing the
 default log message, and before the editor is started.


@@ -109,7 +112,7 @@ The sample `prepare-commit-msg` hook that comes with git comments
 out the `Conflicts:` part of a merge's commit message.
 
 commit-msg
 out the `Conflicts:` part of a merge's commit message.
 
 commit-msg

-----------
+~~~~~~~~~~

 
 This hook is invoked by 'git-commit', and can be bypassed
 with `\--no-verify` option.  It takes a single parameter, the
 
 This hook is invoked by 'git-commit', and can be bypassed
 with `\--no-verify` option.  It takes a single parameter, the


@@ -126,7 +129,7 @@ The default 'commit-msg' hook, when enabled, detects duplicate
 "Signed-off-by" lines, and aborts the commit if one is found.
 
 post-commit
 "Signed-off-by" lines, and aborts the commit if one is found.
 
 post-commit

------------
+~~~~~~~~~~~

 
 This hook is invoked by 'git-commit'.  It takes no
 parameter, and is invoked after a commit is made.
 
 This hook is invoked by 'git-commit'.  It takes no
 parameter, and is invoked after a commit is made.


@@ -135,14 +138,14 @@ This hook is meant primarily for notification, and cannot affect
 the outcome of 'git-commit'.
 
 pre-rebase
 the outcome of 'git-commit'.
 
 pre-rebase

-----------
+~~~~~~~~~~

 
 This hook is called by 'git-rebase' and can be used to prevent a branch
 from getting rebased.
 
 
 post-checkout
 
 This hook is called by 'git-rebase' and can be used to prevent a branch
 from getting rebased.
 
 
 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,
 
 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,


@@ -160,7 +163,7 @@ differences from the previous HEAD if different, or set working dir metadata
 properties.
 
 post-merge
 properties.
 
 post-merge

------------
+~~~~~~~~~~

 
 This hook is invoked by 'git-merge', which happens when a 'git-pull'
 is done on a local repository.  The hook takes a single parameter, a status
 
 This hook is invoked by 'git-merge', which happens when a 'git-pull'
 is done on a local repository.  The hook takes a single parameter, a status


@@ -175,7 +178,7 @@ for an example of how to do this.
 
 [[pre-receive]]
 pre-receive
 
 [[pre-receive]]
 pre-receive

------------
+~~~~~~~~~~~

 
 This hook is invoked by 'git-receive-pack' on the remote repository,
 which happens when a 'git-push' is done on a local repository.
 
 This hook is invoked by 'git-receive-pack' on the remote repository,
 which happens when a 'git-push' is done on a local repository.


@@ -204,7 +207,7 @@ for the user.
 
 [[update]]
 update
 
 [[update]]
 update

-------
+~~~~~~

 
 This hook is invoked by 'git-receive-pack' on the remote repository,
 which happens when a 'git-push' is done on a local repository.
 
 This hook is invoked by 'git-receive-pack' on the remote repository,
 which happens when a 'git-push' is done on a local repository.


@@ -226,7 +229,7 @@ from updating that ref.
 This hook can be used to prevent 'forced' update on certain refs by
 making sure that the object name is a commit object that is a
 descendant of the commit object named by the old object name.
 This hook can be used to prevent 'forced' update on certain refs by
 making sure that the object name is a commit object that is a
 descendant of the commit object named by the old object name.

-That is, to enforce a "fast forward only" policy.
+That is, to enforce a "fast-forward only" policy.

 
 It could also be used to log the old..new status.  However, it
 does not know the entire set of branches, so it would end up
 
 It could also be used to log the old..new status.  However, it
 does not know the entire set of branches, so it would end up


@@ -242,12 +245,12 @@ Both standard output and standard error output are forwarded to
 for the user.
 
 The default 'update' hook, when enabled--and with
 for the user.
 
 The default 'update' hook, when enabled--and with

-`hooks.allowunannotated` config option turned on--prevents
+`hooks.allowunannotated` config option unset or set to false--prevents

 unannotated tags to be pushed.
 
 [[post-receive]]
 post-receive
 unannotated tags to be pushed.
 
 [[post-receive]]
 post-receive

-------------
+~~~~~~~~~~~~

 
 This hook is invoked by 'git-receive-pack' on the remote repository,
 which happens when a 'git-push' is done on a local repository.
 
 This hook is invoked by 'git-receive-pack' on the remote repository,
 which happens when a 'git-push' is done on a local repository.


@@ -277,7 +280,7 @@ emails.
 
 [[post-update]]
 post-update
 
 [[post-update]]
 post-update

------------
+~~~~~~~~~~~

 
 This hook is invoked by 'git-receive-pack' on the remote repository,
 which happens when a 'git-push' is done on a local repository.
 
 This hook is invoked by 'git-receive-pack' on the remote repository,
 which happens when a 'git-push' is done on a local repository.


@@ -307,8 +310,37 @@ Both standard output and standard error output are forwarded to
 'git-send-pack' on the other end, so you can simply `echo` messages
 for the user.
 
 'git-send-pack' on the other end, so you can simply `echo` messages
 for the user.
 

+post-upload-pack
+----------------
+
+After upload-pack successfully finishes its operation, this hook is called
+for logging purposes.
+
+The hook is passed various pieces of information, one per line, from its
+standard input.  Currently the following items can be fed to the hook, but
+more types of information may be added in the future:
+
+want SHA-1::
+    40-byte hexadecimal object name the client asked to include in the
+    resulting pack.  Can occur one or more times in the input.
+
+have SHA-1::
+    40-byte hexadecimal object name the client asked to exclude from
+    the resulting pack, claiming to have them already.  Can occur zero
+    or more times in the input.
+
+time float::
+    Number of seconds spent for creating the packfile.
+
+size decimal::
+    Size of the resulting packfile in bytes.
+
+kind string:
+    Either "clone" (when the client did not give us any "have", and asked
+    for all our refs with "want"), or "fetch" (otherwise).
+

 pre-auto-gc
 pre-auto-gc

------------
+~~~~~~~~~~~

 
 This hook is invoked by 'git-gc --auto'. It takes no parameter, and
 exiting with non-zero status from this script causes the 'git-gc --auto'
 
 This hook is invoked by 'git-gc --auto'. It takes no parameter, and
 exiting with non-zero status from this script causes the 'git-gc --auto'