d7b68afbc208c0bd067b4073cff75644888b5ea9
   1git-receive-pack(1)
   2===================
   3
   4NAME
   5----
   6git-receive-pack - Receive what is pushed into the repository
   7
   8
   9SYNOPSIS
  10--------
  11[verse]
  12'git-receive-pack' [--quiet] <directory>
  13
  14DESCRIPTION
  15-----------
  16Invoked by 'git send-pack' and updates the repository with the
  17information fed from the remote end.
  18
  19This command is usually not invoked directly by the end user.
  20The UI for the protocol is on the 'git send-pack' side, and the
  21program pair is meant to be used to push updates to remote
  22repository.  For pull operations, see linkgit:git-fetch-pack[1].
  23
  24The command allows for creation and fast-forwarding of sha1 refs
  25(heads/tags) on the remote end (strictly speaking, it is the
  26local end 'git-receive-pack' runs, but to the user who is sitting at
  27the send-pack end, it is updating the remote.  Confused?)
  28
  29There are other real-world examples of using update and
  30post-update hooks found in the Documentation/howto directory.
  31
  32'git-receive-pack' honours the receive.denyNonFastForwards config
  33option, which tells it if updates to a ref should be denied if they
  34are not fast-forwards.
  35
  36OPTIONS
  37-------
  38--quiet::
  39        Print only error messages.
  40
  41<directory>::
  42        The repository to sync into.
  43
  44pre-receive Hook
  45----------------
  46Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists
  47and is executable, it will be invoked once with no parameters.  The
  48standard input of the hook will be one line per ref to be updated:
  49
  50       sha1-old SP sha1-new SP refname LF
  51
  52The refname value is relative to $GIT_DIR; e.g. for the master
  53head this is "refs/heads/master".  The two sha1 values before
  54each refname are the object names for the refname before and after
  55the update.  Refs to be created will have sha1-old equal to 0\{40},
  56while refs to be deleted will have sha1-new equal to 0\{40}, otherwise
  57sha1-old and sha1-new should be valid objects in the repository.
  58
  59This hook is called before any refname is updated and before any
  60fast-forward checks are performed.
  61
  62If the pre-receive hook exits with a non-zero exit status no updates
  63will be performed, and the update, post-receive and post-update
  64hooks will not be invoked either.  This can be useful to quickly
  65bail out if the update is not to be supported.
  66
  67update Hook
  68-----------
  69Before each ref is updated, if $GIT_DIR/hooks/update file exists
  70and is executable, it is invoked once per ref, with three parameters:
  71
  72       $GIT_DIR/hooks/update refname sha1-old sha1-new
  73
  74The refname parameter is relative to $GIT_DIR; e.g. for the master
  75head this is "refs/heads/master".  The two sha1 arguments are
  76the object names for the refname before and after the update.
  77Note that the hook is called before the refname is updated,
  78so either sha1-old is 0\{40} (meaning there is no such ref yet),
  79or it should match what is recorded in refname.
  80
  81The hook should exit with non-zero status if it wants to disallow
  82updating the named ref.  Otherwise it should exit with zero.
  83
  84Successful execution (a zero exit status) of this hook does not
  85ensure the ref will actually be updated, it is only a prerequisite.
  86As such it is not a good idea to send notices (e.g. email) from
  87this hook.  Consider using the post-receive hook instead.
  88
  89post-receive Hook
  90-----------------
  91After all refs were updated (or attempted to be updated), if any
  92ref update was successful, and if $GIT_DIR/hooks/post-receive
  93file exists and is executable, it will be invoked once with no
  94parameters.  The standard input of the hook will be one line
  95for each successfully updated ref:
  96
  97       sha1-old SP sha1-new SP refname LF
  98
  99The refname value is relative to $GIT_DIR; e.g. for the master
 100head this is "refs/heads/master".  The two sha1 values before
 101each refname are the object names for the refname before and after
 102the update.  Refs that were created will have sha1-old equal to
 1030\{40}, while refs that were deleted will have sha1-new equal to
 1040\{40}, otherwise sha1-old and sha1-new should be valid objects in
 105the repository.
 106
 107Using this hook, it is easy to generate mails describing the updates
 108to the repository.  This example script sends one mail message per
 109ref listing the commits pushed to the repository:
 110
 111        #!/bin/sh
 112        # mail out commit update information.
 113        while read oval nval ref
 114        do
 115                if expr "$oval" : '0*$' >/dev/null
 116                then
 117                        echo "Created a new ref, with the following commits:"
 118                        git rev-list --pretty "$nval"
 119                else
 120                        echo "New commits:"
 121                        git rev-list --pretty "$nval" "^$oval"
 122                fi |
 123                mail -s "Changes to ref $ref" commit-list@mydomain
 124        done
 125        exit 0
 126
 127The exit code from this hook invocation is ignored, however a
 128non-zero exit code will generate an error message.
 129
 130Note that it is possible for refname to not have sha1-new when this
 131hook runs.  This can easily occur if another user modifies the ref
 132after it was updated by 'git-receive-pack', but before the hook was able
 133to evaluate it.  It is recommended that hooks rely on sha1-new
 134rather than the current value of refname.
 135
 136post-update Hook
 137----------------
 138After all other processing, if at least one ref was updated, and
 139if $GIT_DIR/hooks/post-update file exists and is executable, then
 140post-update will be called with the list of refs that have been updated.
 141This can be used to implement any repository wide cleanup tasks.
 142
 143The exit code from this hook invocation is ignored; the only thing
 144left for 'git-receive-pack' to do at that point is to exit itself
 145anyway.
 146
 147This hook can be used, for example, to run `git update-server-info`
 148if the repository is packed and is served via a dumb transport.
 149
 150        #!/bin/sh
 151        exec git update-server-info
 152
 153
 154SEE ALSO
 155--------
 156linkgit:git-send-pack[1]
 157
 158GIT
 159---
 160Part of the linkgit:git[1] suite