Autogenerated HTML docs for v1.7.1
[git/jnareb-git.git] / git-receive-pack.html
blob406d0da09eab127d49f3754218e796bbced62b4d
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.2.5" />
7 <style type="text/css">
8 /* Debug borders */
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
11 border: 1px solid red;
15 body {
16 margin: 1em 5% 1em 5%;
19 a {
20 color: blue;
21 text-decoration: underline;
23 a:visited {
24 color: fuchsia;
27 em {
28 font-style: italic;
31 strong {
32 font-weight: bold;
35 tt {
36 color: navy;
39 h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
47 h1, h2, h3 {
48 border-bottom: 2px solid silver;
50 h2 {
51 padding-top: 0.5em;
53 h3 {
54 float: left;
56 h3 + * {
57 clear: left;
60 div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
65 hr {
66 border: 1px solid silver;
69 p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
74 pre {
75 padding: 0;
76 margin: 0;
79 span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
83 font-size: 1.1em;
85 span#email {
87 span#revision {
88 font-family: sans-serif;
91 div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
98 div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
102 div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
107 div#preamble,
108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110 div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
115 div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
120 div.content { /* Block element content. */
121 padding: 0;
124 /* Block element titles. */
125 div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
132 div.title + * {
133 margin-top: 0;
136 td div.title:first-child {
137 margin-top: 0.0em;
139 div.content div.title:first-child {
140 margin-top: 0.0em;
142 div.content + div.title {
143 margin-top: 0.0em;
146 div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
152 div.listingblock {
153 margin-right: 0%;
155 div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
161 div.quoteblock > div.content {
162 padding-left: 2.0em;
165 div.attribution {
166 text-align: right;
168 div.verseblock + div.attribution {
169 text-align: left;
172 div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
180 div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
185 div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
190 div.verseblock div.content {
191 white-space: pre;
194 div.imageblock div.content { padding-left: 0; }
195 div.imageblock img { border: 1px solid silver; }
196 span.image img { border-style: none; }
198 dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
202 dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
207 dd > *:first-child {
208 margin-top: 0;
211 ul, ol {
212 list-style-position: outside;
214 div.olist2 ol {
215 list-style-type: lower-alpha;
218 div.tableblock > table {
219 border: 3px solid #527bbd;
221 thead {
222 font-family: sans-serif;
223 font-weight: bold;
225 tfoot {
226 font-weight: bold;
229 div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
233 div.hlist td {
234 padding-bottom: 5px;
236 td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
241 td.hlist2 {
242 vertical-align: top;
245 @media print {
246 div#footer-badges { display: none; }
249 div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
262 div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
266 div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
270 div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
274 include1::./stylesheets/xhtml11-manpage.css[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
282 div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
289 div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
295 div.quoteblock-content {
296 padding-left: 2.0em;
299 div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc a:visited { color: blue; }
306 </style>
307 <title>git-receive-pack(1)</title>
308 </head>
309 <body>
310 <div id="header">
311 <h1>
312 git-receive-pack(1) Manual Page
313 </h1>
314 <h2>NAME</h2>
315 <div class="sectionbody">
316 <p>git-receive-pack -
317 Receive what is pushed into the repository
318 </p>
319 </div>
320 </div>
321 <h2>SYNOPSIS</h2>
322 <div class="sectionbody">
323 <div class="para"><p><em>git-receive-pack</em> &lt;directory&gt;</p></div>
324 </div>
325 <h2 id="_description">DESCRIPTION</h2>
326 <div class="sectionbody">
327 <div class="para"><p>Invoked by <em>git send-pack</em> and updates the repository with the
328 information fed from the remote end.</p></div>
329 <div class="para"><p>This command is usually not invoked directly by the end user.
330 The UI for the protocol is on the <em>git send-pack</em> side, and the
331 program pair is meant to be used to push updates to remote
332 repository. For pull operations, see <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.</p></div>
333 <div class="para"><p>The command allows for creation and fast-forwarding of sha1 refs
334 (heads/tags) on the remote end (strictly speaking, it is the
335 local end <em>git-receive-pack</em> runs, but to the user who is sitting at
336 the send-pack end, it is updating the remote. Confused?)</p></div>
337 <div class="para"><p>There are other real-world examples of using update and
338 post-update hooks found in the Documentation/howto directory.</p></div>
339 <div class="para"><p><em>git-receive-pack</em> honours the receive.denyNonFastForwards config
340 option, which tells it if updates to a ref should be denied if they
341 are not fast-forwards.</p></div>
342 </div>
343 <h2 id="_options">OPTIONS</h2>
344 <div class="sectionbody">
345 <div class="vlist"><dl>
346 <dt>
347 &lt;directory&gt;
348 </dt>
349 <dd>
351 The repository to sync into.
352 </p>
353 </dd>
354 </dl></div>
355 </div>
356 <h2 id="_pre_receive_hook">pre-receive Hook</h2>
357 <div class="sectionbody">
358 <div class="para"><p>Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists
359 and is executable, it will be invoked once with no parameters. The
360 standard input of the hook will be one line per ref to be updated:</p></div>
361 <div class="literalblock">
362 <div class="content">
363 <pre><tt>sha1-old SP sha1-new SP refname LF</tt></pre>
364 </div></div>
365 <div class="para"><p>The refname value is relative to $GIT_DIR; e.g. for the master
366 head this is "refs/heads/master". The two sha1 values before
367 each refname are the object names for the refname before and after
368 the update. Refs to be created will have sha1-old equal to 0{40},
369 while refs to be deleted will have sha1-new equal to 0{40}, otherwise
370 sha1-old and sha1-new should be valid objects in the repository.</p></div>
371 <div class="para"><p>This hook is called before any refname is updated and before any
372 fast-forward checks are performed.</p></div>
373 <div class="para"><p>If the pre-receive hook exits with a non-zero exit status no updates
374 will be performed, and the update, post-receive and post-update
375 hooks will not be invoked either. This can be useful to quickly
376 bail out if the update is not to be supported.</p></div>
377 </div>
378 <h2 id="_update_hook">update Hook</h2>
379 <div class="sectionbody">
380 <div class="para"><p>Before each ref is updated, if $GIT_DIR/hooks/update file exists
381 and is executable, it is invoked once per ref, with three parameters:</p></div>
382 <div class="literalblock">
383 <div class="content">
384 <pre><tt>$GIT_DIR/hooks/update refname sha1-old sha1-new</tt></pre>
385 </div></div>
386 <div class="para"><p>The refname parameter is relative to $GIT_DIR; e.g. for the master
387 head this is "refs/heads/master". The two sha1 arguments are
388 the object names for the refname before and after the update.
389 Note that the hook is called before the refname is updated,
390 so either sha1-old is 0{40} (meaning there is no such ref yet),
391 or it should match what is recorded in refname.</p></div>
392 <div class="para"><p>The hook should exit with non-zero status if it wants to disallow
393 updating the named ref. Otherwise it should exit with zero.</p></div>
394 <div class="para"><p>Successful execution (a zero exit status) of this hook does not
395 ensure the ref will actually be updated, it is only a prerequisite.
396 As such it is not a good idea to send notices (e.g. email) from
397 this hook. Consider using the post-receive hook instead.</p></div>
398 </div>
399 <h2 id="_post_receive_hook">post-receive Hook</h2>
400 <div class="sectionbody">
401 <div class="para"><p>After all refs were updated (or attempted to be updated), if any
402 ref update was successful, and if $GIT_DIR/hooks/post-receive
403 file exists and is executable, it will be invoked once with no
404 parameters. The standard input of the hook will be one line
405 for each successfully updated ref:</p></div>
406 <div class="literalblock">
407 <div class="content">
408 <pre><tt>sha1-old SP sha1-new SP refname LF</tt></pre>
409 </div></div>
410 <div class="para"><p>The refname value is relative to $GIT_DIR; e.g. for the master
411 head this is "refs/heads/master". The two sha1 values before
412 each refname are the object names for the refname before and after
413 the update. Refs that were created will have sha1-old equal to
414 0{40}, while refs that were deleted will have sha1-new equal to
415 0{40}, otherwise sha1-old and sha1-new should be valid objects in
416 the repository.</p></div>
417 <div class="para"><p>Using this hook, it is easy to generate mails describing the updates
418 to the repository. This example script sends one mail message per
419 ref listing the commits pushed to the repository:</p></div>
420 <div class="literalblock">
421 <div class="content">
422 <pre><tt>#!/bin/sh
423 # mail out commit update information.
424 while read oval nval ref
426 if expr "$oval" : '0*$' &gt;/dev/null
427 then
428 echo "Created a new ref, with the following commits:"
429 git rev-list --pretty "$nval"
430 else
431 echo "New commits:"
432 git rev-list --pretty "$nval" "^$oval"
433 fi |
434 mail -s "Changes to ref $ref" commit-list@mydomain
435 done
436 exit 0</tt></pre>
437 </div></div>
438 <div class="para"><p>The exit code from this hook invocation is ignored, however a
439 non-zero exit code will generate an error message.</p></div>
440 <div class="para"><p>Note that it is possible for refname to not have sha1-new when this
441 hook runs. This can easily occur if another user modifies the ref
442 after it was updated by <em>git-receive-pack</em>, but before the hook was able
443 to evaluate it. It is recommended that hooks rely on sha1-new
444 rather than the current value of refname.</p></div>
445 </div>
446 <h2 id="_post_update_hook">post-update Hook</h2>
447 <div class="sectionbody">
448 <div class="para"><p>After all other processing, if at least one ref was updated, and
449 if $GIT_DIR/hooks/post-update file exists and is executable, then
450 post-update will be called with the list of refs that have been updated.
451 This can be used to implement any repository wide cleanup tasks.</p></div>
452 <div class="para"><p>The exit code from this hook invocation is ignored; the only thing
453 left for <em>git-receive-pack</em> to do at that point is to exit itself
454 anyway.</p></div>
455 <div class="para"><p>This hook can be used, for example, to run <tt>git update-server-info</tt>
456 if the repository is packed and is served via a dumb transport.</p></div>
457 <div class="literalblock">
458 <div class="content">
459 <pre><tt>#!/bin/sh
460 exec git update-server-info</tt></pre>
461 </div></div>
462 </div>
463 <h2 id="_see_also">SEE ALSO</h2>
464 <div class="sectionbody">
465 <div class="para"><p><a href="git-send-pack.html">git-send-pack(1)</a></p></div>
466 </div>
467 <h2 id="_author">Author</h2>
468 <div class="sectionbody">
469 <div class="para"><p>Written by Linus Torvalds &lt;torvalds@osdl.org&gt;</p></div>
470 </div>
471 <h2 id="_documentation">Documentation</h2>
472 <div class="sectionbody">
473 <div class="para"><p>Documentation by Junio C Hamano.</p></div>
474 </div>
475 <h2 id="_git">GIT</h2>
476 <div class="sectionbody">
477 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
478 </div>
479 <div id="footer">
480 <div id="footer-text">
481 Last updated 2010-04-24 02:56:04 UTC
482 </div>
483 </div>
484 </body>
485 </html>