summaryrefslogtreecommitdiffstats
path: root/githooks.html
diff options
context:
space:
mode:
authorJunio C Hamano <junio@kernel.org>2010-01-21 17:46:43 +0000
committerJunio C Hamano <junio@kernel.org>2010-01-21 17:46:43 +0000
commit1aa40d2e3f5186afb805e7020577acb9f5f78b89 (patch)
tree72812d480799e16b94f9cfed423b8d7d45c7fb4f /githooks.html
parenta9701f0184382d8de7380c56558718915905746a (diff)
downloadgit-htmldocs-1aa40d2e3f5186afb805e7020577acb9f5f78b89.tar.gz
Autogenerated HTML docs for v1.6.6.1-383-g5a9f
Diffstat (limited to 'githooks.html')
-rw-r--r--githooks.html66
1 files changed, 33 insertions, 33 deletions
diff --git a/githooks.html b/githooks.html
index 324911ad7..982eaacff 100644
--- a/githooks.html
+++ b/githooks.html
@@ -326,7 +326,7 @@ githooks(5) Manual Page
<div class="sectionbody">
<div class="para"><p>Hooks are little scripts you can place in <tt>$GIT_DIR/hooks</tt>
directory to trigger action at certain points. When
-<em>git-init</em> is run, a handful of example hooks are copied into the
+<em>git init</em> is run, a handful of example hooks are copied into the
<tt>hooks</tt> directory of the new repository, but by default they are
all disabled. To enable a hook, rename it by removing its <tt>.sample</tt>
suffix.</p></div>
@@ -345,10 +345,10 @@ executable by default.</td>
<h2 id="_hooks">HOOKS</h2>
<div class="sectionbody">
<h3 id="_applypatch_msg">applypatch-msg</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked by <em>git-am</em> script. It takes a single
+<div class="para"><p>This hook is invoked by <em>git am</em> script. It takes a single
parameter, the name of the file that holds the proposed commit
log message. Exiting with non-zero status causes
-<em>git-am</em> to abort before applying the patch.</p></div>
+<em>git am</em> to abort before applying the patch.</p></div>
<div class="para"><p>The hook is allowed to edit the message file in place, and can
be used to normalize the message into some project standard
format (if the project has one). It can also be used to refuse
@@ -356,7 +356,7 @@ the commit after inspecting the message file.</p></div>
<div class="para"><p>The default <em>applypatch-msg</em> hook, when enabled, runs the
<em>commit-msg</em> hook, if the latter is enabled.</p></div>
<h3 id="_pre_applypatch">pre-applypatch</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked by <em>git-am</em>. It takes no parameter, and is
+<div class="para"><p>This hook is invoked by <em>git am</em>. It takes no parameter, and is
invoked after the patch is applied, but before a commit is made.</p></div>
<div class="para"><p>If it exits with non-zero status, then the working tree will not be
committed after applying the patch.</p></div>
@@ -365,24 +365,24 @@ make a commit if it does not pass certain test.</p></div>
<div class="para"><p>The default <em>pre-applypatch</em> hook, when enabled, runs the
<em>pre-commit</em> hook, if the latter is enabled.</p></div>
<h3 id="_post_applypatch">post-applypatch</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked by <em>git-am</em>. It takes no parameter,
+<div class="para"><p>This hook is invoked by <em>git am</em>. It takes no parameter,
and is invoked after the patch is applied and a commit is made.</p></div>
<div class="para"><p>This hook is meant primarily for notification, and cannot affect
-the outcome of <em>git-am</em>.</p></div>
+the outcome of <em>git am</em>.</p></div>
<h3 id="_pre_commit">pre-commit</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked by <em>git-commit</em>, and can be bypassed
+<div class="para"><p>This hook is invoked by <em>git commit</em>, and can be bypassed
with <tt>--no-verify</tt> option. It takes no parameter, and is
invoked before obtaining the proposed commit log message and
making a commit. Exiting with non-zero status from this script
-causes the <em>git-commit</em> to abort.</p></div>
+causes the <em>git commit</em> to abort.</p></div>
<div class="para"><p>The default <em>pre-commit</em> hook, when enabled, catches introduction
of lines with trailing whitespaces and aborts the commit when
such a line is found.</p></div>
-<div class="para"><p>All the <em>git-commit</em> hooks are invoked with the environment
+<div class="para"><p>All the <em>git commit</em> hooks are invoked with the environment
variable <tt>GIT_EDITOR=:</tt> if the command will not bring up an editor
to modify the commit message.</p></div>
<h3 id="_prepare_commit_msg">prepare-commit-msg</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked by <em>git-commit</em> right after preparing the
+<div class="para"><p>This hook is invoked by <em>git commit</em> right after preparing the
default log message, and before the editor is started.</p></div>
<div class="para"><p>It takes one to three parameters. The first is the name of the file
that contains the commit log message. The second is the source of the commit
@@ -392,7 +392,7 @@ configuration option <tt>commit.template</tt> is set); <tt>merge</tt> (if the
commit is a merge or a <tt>.git/MERGE_MSG</tt> file exists); <tt>squash</tt>
(if a <tt>.git/SQUASH_MSG</tt> file exists); or <tt>commit</tt>, followed by
a commit SHA1 (if a <tt>-c</tt>, <tt>-C</tt> or <tt>--amend</tt> option was given).</p></div>
-<div class="para"><p>If the exit status is non-zero, <em>git-commit</em> will abort.</p></div>
+<div class="para"><p>If the exit status is non-zero, <em>git commit</em> will abort.</p></div>
<div class="para"><p>The purpose of the hook is to edit the message file in place, and
it is not suppressed by the <tt>--no-verify</tt> option. A non-zero exit
means a failure of the hook and aborts the commit. It should not
@@ -400,10 +400,10 @@ be used as replacement for pre-commit hook.</p></div>
<div class="para"><p>The sample <tt>prepare-commit-msg</tt> hook that comes with git comments
out the <tt>Conflicts:</tt> part of a merge's commit message.</p></div>
<h3 id="_commit_msg">commit-msg</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked by <em>git-commit</em>, and can be bypassed
+<div class="para"><p>This hook is invoked by <em>git commit</em>, and can be bypassed
with <tt>--no-verify</tt> option. It takes a single parameter, the
name of the file that holds the proposed commit log message.
-Exiting with non-zero status causes the <em>git-commit</em> to
+Exiting with non-zero status causes the <em>git commit</em> to
abort.</p></div>
<div class="para"><p>The hook is allowed to edit the message file in place, and can
be used to normalize the message into some project standard
@@ -412,31 +412,31 @@ the commit after inspecting the message file.</p></div>
<div class="para"><p>The default <em>commit-msg</em> hook, when enabled, detects duplicate
"Signed-off-by" lines, and aborts the commit if one is found.</p></div>
<h3 id="_post_commit">post-commit</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked by <em>git-commit</em>. It takes no
+<div class="para"><p>This hook is invoked by <em>git commit</em>. It takes no
parameter, and is invoked after a commit is made.</p></div>
<div class="para"><p>This hook is meant primarily for notification, and cannot affect
-the outcome of <em>git-commit</em>.</p></div>
+the outcome of <em>git commit</em>.</p></div>
<h3 id="_pre_rebase">pre-rebase</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is called by <em>git-rebase</em> and can be used to prevent a branch
+<div class="para"><p>This hook is called by <em>git rebase</em> and can be used to prevent a branch
from getting rebased.</p></div>
<h3 id="_post_checkout">post-checkout</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked when a <em>git-checkout</em> is run after having updated the
+<div class="para"><p>This hook is invoked when a <em>git checkout</em> is run after having updated the
worktree. The hook is given three parameters: the ref of the previous HEAD,
the ref of the new HEAD (which may or may not have changed), and a flag
indicating whether the checkout was a branch checkout (changing branches,
flag=1) or a file checkout (retrieving a file from the index, flag=0).
-This hook cannot affect the outcome of <em>git-checkout</em>.</p></div>
-<div class="para"><p>It is also run after <em>git-clone</em>, unless the --no-checkout (-n) option is
+This hook cannot affect the outcome of <em>git checkout</em>.</p></div>
+<div class="para"><p>It is also run after <em>git clone</em>, unless the --no-checkout (-n) option is
used. The first parameter given to the hook is the null-ref, the second the
ref of the new HEAD and the flag is always 1.</p></div>
<div class="para"><p>This hook can be used to perform repository validity checks, auto-display
differences from the previous HEAD if different, or set working dir metadata
properties.</p></div>
<h3 id="_post_merge">post-merge</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked by <em>git-merge</em>, which happens when a <em>git-pull</em>
+<div class="para"><p>This hook is invoked by <em>git merge</em>, which happens when a <em>git pull</em>
is done on a local repository. The hook takes a single parameter, a status
flag specifying whether or not the merge being done was a squash merge.
-This hook cannot affect the outcome of <em>git-merge</em> and is not executed,
+This hook cannot affect the outcome of <em>git merge</em> and is not executed,
if the merge failed due to conflicts.</p></div>
<div class="para"><p>This hook can be used in conjunction with a corresponding pre-commit hook to
save and restore any form of metadata associated with the working tree
@@ -444,7 +444,7 @@ save and restore any form of metadata associated with the working tree
for an example of how to do this.</p></div>
<h3 id="pre-receive">pre-receive</h3><div style="clear:left"></div>
<div class="para"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
-which happens when a <em>git-push</em> is done on a local repository.
+which happens when a <em>git push</em> is done on a local repository.
Just before starting to update refs on the remote repository, the
pre-receive hook is invoked. Its exit status determines the success
or failure of the update.</p></div>
@@ -463,11 +463,11 @@ When creating a new ref, <tt>&lt;old-value&gt;</tt> is 40 <tt>0</tt>.</p></div>
updated. If the hook exits with zero, updating of individual refs can
still be prevented by the <a href="#update"><em>update</em></a> hook.</p></div>
<div class="para"><p>Both standard output and standard error output are forwarded to
-<em>git-send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
+<em>git send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
for the user.</p></div>
<h3 id="update">update</h3><div style="clear:left"></div>
<div class="para"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
-which happens when a <em>git-push</em> is done on a local repository.
+which happens when a <em>git push</em> is done on a local repository.
Just before updating the ref on the remote repository, the update hook
is invoked. Its exit status determines the success or failure of
the ref update.</p></div>
@@ -505,14 +505,14 @@ firing one e-mail per ref when used naively, though. The
implement access control which is finer grained than the one
based on filesystem group.</p></div>
<div class="para"><p>Both standard output and standard error output are forwarded to
-<em>git-send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
+<em>git send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
for the user.</p></div>
<div class="para"><p>The default <em>update</em> hook, when enabled--and with
<tt>hooks.allowunannotated</tt> config option unset or set to false--prevents
unannotated tags to be pushed.</p></div>
<h3 id="post-receive">post-receive</h3><div style="clear:left"></div>
<div class="para"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
-which happens when a <em>git-push</em> is done on a local repository.
+which happens when a <em>git push</em> is done on a local repository.
It executes on the remote repository once after all the refs have
been updated.</p></div>
<div class="para"><p>This hook executes once for the receive operation. It takes no
@@ -525,7 +525,7 @@ is called after the real work is done.</p></div>
both old and new values of all the refs in addition to their
names.</p></div>
<div class="para"><p>Both standard output and standard error output are forwarded to
-<em>git-send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
+<em>git send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
for the user.</p></div>
<div class="para"><p>The default <em>post-receive</em> hook is empty, but there is
a sample script <tt>post-receive-email</tt> provided in the <tt>contrib/hooks</tt>
@@ -533,7 +533,7 @@ directory in git distribution, which implements sending commit
emails.</p></div>
<h3 id="post-update">post-update</h3><div style="clear:left"></div>
<div class="para"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
-which happens when a <em>git-push</em> is done on a local repository.
+which happens when a <em>git push</em> is done on a local repository.
It executes on the remote repository once after all the refs have
been updated.</p></div>
<div class="para"><p>It takes a variable number of parameters, each of which is the
@@ -547,16 +547,16 @@ so it is a poor place to do log old..new. The
updated values of the refs. You might consider it instead if you need
them.</p></div>
<div class="para"><p>When enabled, the default <em>post-update</em> hook runs
-<em>git-update-server-info</em> to keep the information used by dumb
+<em>git update-server-info</em> to keep the information used by dumb
transports (e.g., HTTP) up-to-date. If you are publishing
a git repository that is accessible via HTTP, you should
probably enable this hook.</p></div>
<div class="para"><p>Both standard output and standard error output are forwarded to
-<em>git-send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
+<em>git send-pack</em> on the other end, so you can simply <tt>echo</tt> messages
for the user.</p></div>
<h3 id="_pre_auto_gc">pre-auto-gc</h3><div style="clear:left"></div>
-<div class="para"><p>This hook is invoked by <em>git-gc --auto</em>. It takes no parameter, and
-exiting with non-zero status from this script causes the <em>git-gc --auto</em>
+<div class="para"><p>This hook is invoked by <em>git gc --auto</em>. It takes no parameter, and
+exiting with non-zero status from this script causes the <em>git gc --auto</em>
to abort.</p></div>
</div>
<h2 id="_git">GIT</h2>
@@ -565,7 +565,7 @@ to abort.</p></div>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2009-12-11 06:00:54 UTC
+Last updated 2010-01-21 17:44:42 UTC
</div>
</div>
</body>