Documentation/git-receive-pack.txt

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