Autogenerated HTML docs for v1.7.4.1-176-g501cc
[git/jnareb-git.git] / git-receive-pack.html
blob5ceca06e8a752f76e21c0084c316d9129f18b32e
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.4.5" />
7 <title>git-receive-pack(1)</title>
8 <style type="text/css">
9 /* Debug borders */
10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
12 border: 1px solid red;
16 body {
17 margin: 1em 5% 1em 5%;
20 a {
21 color: blue;
22 text-decoration: underline;
24 a:visited {
25 color: fuchsia;
28 em {
29 font-style: italic;
30 color: navy;
33 strong {
34 font-weight: bold;
35 color: #083194;
38 tt {
39 color: navy;
42 h1, h2, h3, h4, h5, h6 {
43 color: #527bbd;
44 font-family: sans-serif;
45 margin-top: 1.2em;
46 margin-bottom: 0.5em;
47 line-height: 1.3;
50 h1, h2, h3 {
51 border-bottom: 2px solid silver;
53 h2 {
54 padding-top: 0.5em;
56 h3 {
57 float: left;
59 h3 + * {
60 clear: left;
63 div.sectionbody {
64 font-family: serif;
65 margin-left: 0;
68 hr {
69 border: 1px solid silver;
72 p {
73 margin-top: 0.5em;
74 margin-bottom: 0.5em;
77 ul, ol, li > p {
78 margin-top: 0;
81 pre {
82 padding: 0;
83 margin: 0;
86 span#author {
87 color: #527bbd;
88 font-family: sans-serif;
89 font-weight: bold;
90 font-size: 1.1em;
92 span#email {
94 span#revnumber, span#revdate, span#revremark {
95 font-family: sans-serif;
98 div#footer {
99 font-family: sans-serif;
100 font-size: small;
101 border-top: 2px solid silver;
102 padding-top: 0.5em;
103 margin-top: 4.0em;
105 div#footer-text {
106 float: left;
107 padding-bottom: 0.5em;
109 div#footer-badges {
110 float: right;
111 padding-bottom: 0.5em;
114 div#preamble {
115 margin-top: 1.5em;
116 margin-bottom: 1.5em;
118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
120 div.admonitionblock {
121 margin-top: 1.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-receive-pack(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-receive-pack -
411 Receive what is pushed into the repository
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="paragraph"><p><em>git-receive-pack</em> &lt;directory&gt;</p></div>
418 </div>
419 <h2 id="_description">DESCRIPTION</h2>
420 <div class="sectionbody">
421 <div class="paragraph"><p>Invoked by <em>git send-pack</em> and updates the repository with the
422 information fed from the remote end.</p></div>
423 <div class="paragraph"><p>This command is usually not invoked directly by the end user.
424 The UI for the protocol is on the <em>git send-pack</em> side, and the
425 program pair is meant to be used to push updates to remote
426 repository. For pull operations, see <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.</p></div>
427 <div class="paragraph"><p>The command allows for creation and fast-forwarding of sha1 refs
428 (heads/tags) on the remote end (strictly speaking, it is the
429 local end <em>git-receive-pack</em> runs, but to the user who is sitting at
430 the send-pack end, it is updating the remote. Confused?)</p></div>
431 <div class="paragraph"><p>There are other real-world examples of using update and
432 post-update hooks found in the Documentation/howto directory.</p></div>
433 <div class="paragraph"><p><em>git-receive-pack</em> honours the receive.denyNonFastForwards config
434 option, which tells it if updates to a ref should be denied if they
435 are not fast-forwards.</p></div>
436 </div>
437 <h2 id="_options">OPTIONS</h2>
438 <div class="sectionbody">
439 <div class="dlist"><dl>
440 <dt class="hdlist1">
441 &lt;directory&gt;
442 </dt>
443 <dd>
445 The repository to sync into.
446 </p>
447 </dd>
448 </dl></div>
449 </div>
450 <h2 id="_pre_receive_hook">pre-receive Hook</h2>
451 <div class="sectionbody">
452 <div class="paragraph"><p>Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists
453 and is executable, it will be invoked once with no parameters. The
454 standard input of the hook will be one line per ref to be updated:</p></div>
455 <div class="literalblock">
456 <div class="content">
457 <pre><tt>sha1-old SP sha1-new SP refname LF</tt></pre>
458 </div></div>
459 <div class="paragraph"><p>The refname value is relative to $GIT_DIR; e.g. for the master
460 head this is "refs/heads/master". The two sha1 values before
461 each refname are the object names for the refname before and after
462 the update. Refs to be created will have sha1-old equal to 0{40},
463 while refs to be deleted will have sha1-new equal to 0{40}, otherwise
464 sha1-old and sha1-new should be valid objects in the repository.</p></div>
465 <div class="paragraph"><p>This hook is called before any refname is updated and before any
466 fast-forward checks are performed.</p></div>
467 <div class="paragraph"><p>If the pre-receive hook exits with a non-zero exit status no updates
468 will be performed, and the update, post-receive and post-update
469 hooks will not be invoked either. This can be useful to quickly
470 bail out if the update is not to be supported.</p></div>
471 </div>
472 <h2 id="_update_hook">update Hook</h2>
473 <div class="sectionbody">
474 <div class="paragraph"><p>Before each ref is updated, if $GIT_DIR/hooks/update file exists
475 and is executable, it is invoked once per ref, with three parameters:</p></div>
476 <div class="literalblock">
477 <div class="content">
478 <pre><tt>$GIT_DIR/hooks/update refname sha1-old sha1-new</tt></pre>
479 </div></div>
480 <div class="paragraph"><p>The refname parameter is relative to $GIT_DIR; e.g. for the master
481 head this is "refs/heads/master". The two sha1 arguments are
482 the object names for the refname before and after the update.
483 Note that the hook is called before the refname is updated,
484 so either sha1-old is 0{40} (meaning there is no such ref yet),
485 or it should match what is recorded in refname.</p></div>
486 <div class="paragraph"><p>The hook should exit with non-zero status if it wants to disallow
487 updating the named ref. Otherwise it should exit with zero.</p></div>
488 <div class="paragraph"><p>Successful execution (a zero exit status) of this hook does not
489 ensure the ref will actually be updated, it is only a prerequisite.
490 As such it is not a good idea to send notices (e.g. email) from
491 this hook. Consider using the post-receive hook instead.</p></div>
492 </div>
493 <h2 id="_post_receive_hook">post-receive Hook</h2>
494 <div class="sectionbody">
495 <div class="paragraph"><p>After all refs were updated (or attempted to be updated), if any
496 ref update was successful, and if $GIT_DIR/hooks/post-receive
497 file exists and is executable, it will be invoked once with no
498 parameters. The standard input of the hook will be one line
499 for each successfully updated ref:</p></div>
500 <div class="literalblock">
501 <div class="content">
502 <pre><tt>sha1-old SP sha1-new SP refname LF</tt></pre>
503 </div></div>
504 <div class="paragraph"><p>The refname value is relative to $GIT_DIR; e.g. for the master
505 head this is "refs/heads/master". The two sha1 values before
506 each refname are the object names for the refname before and after
507 the update. Refs that were created will have sha1-old equal to
508 0{40}, while refs that were deleted will have sha1-new equal to
509 0{40}, otherwise sha1-old and sha1-new should be valid objects in
510 the repository.</p></div>
511 <div class="paragraph"><p>Using this hook, it is easy to generate mails describing the updates
512 to the repository. This example script sends one mail message per
513 ref listing the commits pushed to the repository:</p></div>
514 <div class="literalblock">
515 <div class="content">
516 <pre><tt>#!/bin/sh
517 # mail out commit update information.
518 while read oval nval ref
520 if expr "$oval" : '0*$' &gt;/dev/null
521 then
522 echo "Created a new ref, with the following commits:"
523 git rev-list --pretty "$nval"
524 else
525 echo "New commits:"
526 git rev-list --pretty "$nval" "^$oval"
527 fi |
528 mail -s "Changes to ref $ref" commit-list@mydomain
529 done
530 exit 0</tt></pre>
531 </div></div>
532 <div class="paragraph"><p>The exit code from this hook invocation is ignored, however a
533 non-zero exit code will generate an error message.</p></div>
534 <div class="paragraph"><p>Note that it is possible for refname to not have sha1-new when this
535 hook runs. This can easily occur if another user modifies the ref
536 after it was updated by <em>git-receive-pack</em>, but before the hook was able
537 to evaluate it. It is recommended that hooks rely on sha1-new
538 rather than the current value of refname.</p></div>
539 </div>
540 <h2 id="_post_update_hook">post-update Hook</h2>
541 <div class="sectionbody">
542 <div class="paragraph"><p>After all other processing, if at least one ref was updated, and
543 if $GIT_DIR/hooks/post-update file exists and is executable, then
544 post-update will be called with the list of refs that have been updated.
545 This can be used to implement any repository wide cleanup tasks.</p></div>
546 <div class="paragraph"><p>The exit code from this hook invocation is ignored; the only thing
547 left for <em>git-receive-pack</em> to do at that point is to exit itself
548 anyway.</p></div>
549 <div class="paragraph"><p>This hook can be used, for example, to run <tt>git update-server-info</tt>
550 if the repository is packed and is served via a dumb transport.</p></div>
551 <div class="literalblock">
552 <div class="content">
553 <pre><tt>#!/bin/sh
554 exec git update-server-info</tt></pre>
555 </div></div>
556 </div>
557 <h2 id="_see_also">SEE ALSO</h2>
558 <div class="sectionbody">
559 <div class="paragraph"><p><a href="git-send-pack.html">git-send-pack(1)</a></p></div>
560 </div>
561 <h2 id="_author">Author</h2>
562 <div class="sectionbody">
563 <div class="paragraph"><p>Written by Linus Torvalds &lt;<a href="mailto:torvalds@osdl.org">torvalds@osdl.org</a>&gt;</p></div>
564 </div>
565 <h2 id="_documentation">Documentation</h2>
566 <div class="sectionbody">
567 <div class="paragraph"><p>Documentation by Junio C Hamano.</p></div>
568 </div>
569 <h2 id="_git">GIT</h2>
570 <div class="sectionbody">
571 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
572 </div>
573 <div id="footer">
574 <div id="footer-text">
575 Last updated 2010-01-21 17:44:19 UTC
576 </div>
577 </div>
578 </body>
579 </html>