updated git doc

[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-receive-pack.xml

<?xml version="1.0" encoding="UTF-8"?>\r
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
\r
<article lang="en" id="git-receive-pack(1)">\r
<articleinfo>\r
    <title>git-receive-pack(1)</title>\r
<indexterm>\r
<primary>git-receive-pack(1)</primary>\r
</indexterm>\r
</articleinfo>\r
<simplesect id="_name">\r
<title>NAME</title>\r
<simpara>git-receive-pack - Receive what is pushed into the repository</simpara>\r
</simplesect>\r
<simplesect id="_synopsis">\r
<title>SYNOPSIS</title>\r
<blockquote>\r
<literallayout><emphasis>git-receive-pack</emphasis> &lt;directory&gt;</literallayout>\r
</blockquote>\r
</simplesect>\r
<simplesect id="_description">\r
<title>DESCRIPTION</title>\r
<simpara>Invoked by <emphasis>git send-pack</emphasis> and updates the repository with the\r
information fed from the remote end.</simpara>\r
<simpara>This command is usually not invoked directly by the end user.\r
The UI for the protocol is on the <emphasis>git send-pack</emphasis> side, and the\r
program pair is meant to be used to push updates to remote\r
repository.  For pull operations, see <xref linkend="git-fetch-pack(1)" />.</simpara>\r
<simpara>The command allows for creation and fast-forwarding of sha1 refs\r
(heads/tags) on the remote end (strictly speaking, it is the\r
local end <emphasis>git-receive-pack</emphasis> runs, but to the user who is sitting at\r
the send-pack end, it is updating the remote.  Confused?)</simpara>\r
<simpara>There are other real-world examples of using update and\r
post-update hooks found in the Documentation/howto directory.</simpara>\r
<simpara><emphasis>git-receive-pack</emphasis> honours the receive.denyNonFastForwards config\r
option, which tells it if updates to a ref should be denied if they\r
are not fast-forwards.</simpara>\r
</simplesect>\r
<simplesect id="_options">\r
<title>OPTIONS</title>\r
<variablelist>\r
<varlistentry>\r
<term>\r
&lt;directory&gt;\r
</term>\r
<listitem>\r
<simpara>\r
        The repository to sync into.\r
</simpara>\r
</listitem>\r
</varlistentry>\r
</variablelist>\r
</simplesect>\r
<simplesect id="_pre_receive_hook">\r
<title>pre-receive Hook</title>\r
<simpara>Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists\r
and is executable, it will be invoked once with no parameters.  The\r
standard input of the hook will be one line per ref to be updated:</simpara>\r
<literallayout class="monospaced">sha1-old SP sha1-new SP refname LF</literallayout>\r
<simpara>The refname value is relative to $GIT_DIR; e.g. for the master\r
head this is "refs/heads/master".  The two sha1 values before\r
each refname are the object names for the refname before and after\r
the update.  Refs to be created will have sha1-old equal to 0{40},\r
while refs to be deleted will have sha1-new equal to 0{40}, otherwise\r
sha1-old and sha1-new should be valid objects in the repository.</simpara>\r
<simpara>This hook is called before any refname is updated and before any\r
fast-forward checks are performed.</simpara>\r
<simpara>If the pre-receive hook exits with a non-zero exit status no updates\r
will be performed, and the update, post-receive and post-update\r
hooks will not be invoked either.  This can be useful to quickly\r
bail out if the update is not to be supported.</simpara>\r
</simplesect>\r
<simplesect id="_update_hook">\r
<title>update Hook</title>\r
<simpara>Before each ref is updated, if $GIT_DIR/hooks/update file exists\r
and is executable, it is invoked once per ref, with three parameters:</simpara>\r
<literallayout class="monospaced">$GIT_DIR/hooks/update refname sha1-old sha1-new</literallayout>\r
<simpara>The refname parameter is relative to $GIT_DIR; e.g. for the master\r
head this is "refs/heads/master".  The two sha1 arguments are\r
the object names for the refname before and after the update.\r
Note that the hook is called before the refname is updated,\r
so either sha1-old is 0{40} (meaning there is no such ref yet),\r
or it should match what is recorded in refname.</simpara>\r
<simpara>The hook should exit with non-zero status if it wants to disallow\r
updating the named ref.  Otherwise it should exit with zero.</simpara>\r
<simpara>Successful execution (a zero exit status) of this hook does not\r
ensure the ref will actually be updated, it is only a prerequisite.\r
As such it is not a good idea to send notices (e.g. email) from\r
this hook.  Consider using the post-receive hook instead.</simpara>\r
</simplesect>\r
<simplesect id="_post_receive_hook">\r
<title>post-receive Hook</title>\r
<simpara>After all refs were updated (or attempted to be updated), if any\r
ref update was successful, and if $GIT_DIR/hooks/post-receive\r
file exists and is executable, it will be invoked once with no\r
parameters.  The standard input of the hook will be one line\r
for each successfully updated ref:</simpara>\r
<literallayout class="monospaced">sha1-old SP sha1-new SP refname LF</literallayout>\r
<simpara>The refname value is relative to $GIT_DIR; e.g. for the master\r
head this is "refs/heads/master".  The two sha1 values before\r
each refname are the object names for the refname before and after\r
the update.  Refs that were created will have sha1-old equal to\r
0{40}, while refs that were deleted will have sha1-new equal to\r
0{40}, otherwise sha1-old and sha1-new should be valid objects in\r
the repository.</simpara>\r
<simpara>Using this hook, it is easy to generate mails describing the updates\r
to the repository.  This example script sends one mail message per\r
ref listing the commits pushed to the repository:</simpara>\r
<literallayout class="monospaced">#!/bin/sh\r
# mail out commit update information.\r
while read oval nval ref\r
do\r
        if expr "$oval" : '0*$' &gt;/dev/null\r
        then\r
                echo "Created a new ref, with the following commits:"\r
                git rev-list --pretty "$nval"\r
        else\r
                echo "New commits:"\r
                git rev-list --pretty "$nval" "^$oval"\r
        fi |\r
        mail -s "Changes to ref $ref" commit-list@mydomain\r
done\r
exit 0</literallayout>\r
<simpara>The exit code from this hook invocation is ignored, however a\r
non-zero exit code will generate an error message.</simpara>\r
<simpara>Note that it is possible for refname to not have sha1-new when this\r
hook runs.  This can easily occur if another user modifies the ref\r
after it was updated by <emphasis>git-receive-pack</emphasis>, but before the hook was able\r
to evaluate it.  It is recommended that hooks rely on sha1-new\r
rather than the current value of refname.</simpara>\r
</simplesect>\r
<simplesect id="_post_update_hook">\r
<title>post-update Hook</title>\r
<simpara>After all other processing, if at least one ref was updated, and\r
if $GIT_DIR/hooks/post-update file exists and is executable, then\r
post-update will be called with the list of refs that have been updated.\r
This can be used to implement any repository wide cleanup tasks.</simpara>\r
<simpara>The exit code from this hook invocation is ignored; the only thing\r
left for <emphasis>git-receive-pack</emphasis> to do at that point is to exit itself\r
anyway.</simpara>\r
<simpara>This hook can be used, for example, to run <emphasis>git update-server-info</emphasis>\r
if the repository is packed and is served via a dumb transport.</simpara>\r
<literallayout class="monospaced">#!/bin/sh\r
exec git update-server-info</literallayout>\r
</simplesect>\r
<simplesect id="_see_also">\r
<title>SEE ALSO</title>\r
<simpara><xref linkend="git-send-pack(1)" />, <xref linkend="gitnamespaces(7)" /></simpara>\r
</simplesect>\r
<simplesect id="_git">\r
<title>GIT</title>\r
<simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
</simplesect>\r
</article>\r