From: Junio C Hamano Date: Mon, 7 Sep 2009 22:45:48 +0000 (-0700) Subject: Merge branch 'maint' X-Git-Tag: v1.6.5-rc0~1 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/df01e7c5ee732cd6673de18743b42bf5234a5c76?ds=inline;hp=-c Merge branch 'maint' * maint: git-pull: do not mention --quiet and --verbose twice githooks.txt: put hooks into subsections --- df01e7c5ee732cd6673de18743b42bf5234a5c76 diff --combined Documentation/githooks.txt index c308d2943c,acc408d7e6..79f633e837 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@@ -26,8 -26,11 +26,11 @@@ executable by default This document describes the currently defined hooks. + HOOKS + ----- + 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 @@@ -43,7 -46,7 +46,7 @@@ The default 'applypatch-msg' hook, whe '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. @@@ -58,7 -61,7 +61,7 @@@ The default 'pre-applypatch' hook, whe '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. @@@ -67,7 -70,7 +70,7 @@@ This hook is meant primarily for notifi 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 @@@ -84,7 -87,7 +87,7 @@@ variable `GIT_EDITOR=:` if the command 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. @@@ -109,7 -112,7 +112,7 @@@ The sample `prepare-commit-msg` hook th 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 @@@ -126,7 -129,7 +129,7 @@@ The default 'commit-msg' hook, when ena "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. @@@ -135,14 -138,14 +138,14 @@@ This hook is meant primarily for notifi 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 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 +163,7 @@@ differences from the previous HEAD if d 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 @@@ -175,7 -178,7 +178,7 @@@ for an example of how to do this [[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. @@@ -204,7 -207,7 +207,7 @@@ for the user [[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. @@@ -247,7 -250,7 +250,7 @@@ 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. @@@ -277,7 -280,7 +280,7 @@@ emails [[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. @@@ -307,37 -310,8 +310,37 @@@ Both standard output and standard erro '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 - ----------- + ~~~~~~~~~~~ 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'