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