Merge branch 'rs/pretty-wrap'

[git.git] / Documentation / githooks.txt

diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index acc408d7e621a5055322ff4157c43734a20ebce8..4cc3d1387fbdb60a2134a2e399fa46140939fe2f 100644 (file)
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -229,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


@@ -245,7 +245,7 @@ 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]]
 unannotated tags to be pushed.
 
 [[post-receive]]


@@ -310,6 +310,35 @@ 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
 ~~~~~~~~~~~