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