Autogenerated HTML docs for v1.7.7-419-g87009
[git/jnareb-git.git] / git-receive-pack.html
blob574be8ebe22442fdd80f039a04cedb468f394e5d
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.5.2" />
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.0em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.0em;
126 margin-bottom: 2.0em;
127 margin-right: 10%;
128 color: #606060;
131 div.content { /* Block element content. */
132 padding: 0;
135 /* Block element titles. */
136 div.title, caption.title {
137 color: #527bbd;
138 font-family: sans-serif;
139 font-weight: bold;
140 text-align: left;
141 margin-top: 1.0em;
142 margin-bottom: 0.5em;
144 div.title + * {
145 margin-top: 0;
148 td div.title:first-child {
149 margin-top: 0.0em;
151 div.content div.title:first-child {
152 margin-top: 0.0em;
154 div.content + div.title {
155 margin-top: 0.0em;
158 div.sidebarblock > div.content {
159 background: #ffffee;
160 border: 1px solid silver;
161 padding: 0.5em;
164 div.listingblock > div.content {
165 border: 1px solid silver;
166 background: #f4f4f4;
167 padding: 0.5em;
170 div.quoteblock, div.verseblock {
171 padding-left: 1.0em;
172 margin-left: 1.0em;
173 margin-right: 10%;
174 border-left: 5px solid #dddddd;
175 color: #777777;
178 div.quoteblock > div.attribution {
179 padding-top: 0.5em;
180 text-align: right;
183 div.verseblock > div.content {
184 white-space: pre;
186 div.verseblock > div.attribution {
187 padding-top: 0.75em;
188 text-align: left;
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 div.verseblock + div.attribution {
192 text-align: left;
195 div.admonitionblock .icon {
196 vertical-align: top;
197 font-size: 1.1em;
198 font-weight: bold;
199 text-decoration: underline;
200 color: #527bbd;
201 padding-right: 0.5em;
203 div.admonitionblock td.content {
204 padding-left: 0.5em;
205 border-left: 3px solid #dddddd;
208 div.exampleblock > div.content {
209 border-left: 3px solid #dddddd;
210 padding-left: 0.5em;
213 div.imageblock div.content { padding-left: 0; }
214 span.image img { border-style: none; }
215 a.image:visited { color: white; }
217 dl {
218 margin-top: 0.8em;
219 margin-bottom: 0.8em;
221 dt {
222 margin-top: 0.5em;
223 margin-bottom: 0;
224 font-style: normal;
225 color: navy;
227 dd > *:first-child {
228 margin-top: 0.1em;
231 ul, ol {
232 list-style-position: outside;
234 ol.arabic {
235 list-style-type: decimal;
237 ol.loweralpha {
238 list-style-type: lower-alpha;
240 ol.upperalpha {
241 list-style-type: upper-alpha;
243 ol.lowerroman {
244 list-style-type: lower-roman;
246 ol.upperroman {
247 list-style-type: upper-roman;
250 div.compact ul, div.compact ol,
251 div.compact p, div.compact p,
252 div.compact div, div.compact div {
253 margin-top: 0.1em;
254 margin-bottom: 0.1em;
257 div.tableblock > table {
258 border: 3px solid #527bbd;
260 thead, p.table.header {
261 font-family: sans-serif;
262 font-weight: bold;
264 tfoot {
265 font-weight: bold;
267 td > div.verse {
268 white-space: pre;
270 p.table {
271 margin-top: 0;
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 div.tableblock > table[frame="void"] {
275 border-style: none;
277 div.tableblock > table[frame="hsides"] {
278 border-left-style: none;
279 border-right-style: none;
281 div.tableblock > table[frame="vsides"] {
282 border-top-style: none;
283 border-bottom-style: none;
287 div.hdlist {
288 margin-top: 0.8em;
289 margin-bottom: 0.8em;
291 div.hdlist tr {
292 padding-bottom: 15px;
294 dt.hdlist1.strong, td.hdlist1.strong {
295 font-weight: bold;
297 td.hdlist1 {
298 vertical-align: top;
299 font-style: normal;
300 padding-right: 0.8em;
301 color: navy;
303 td.hdlist2 {
304 vertical-align: top;
306 div.hdlist.compact tr {
307 margin: 0;
308 padding-bottom: 0;
311 .comment {
312 background: yellow;
315 .footnote, .footnoteref {
316 font-size: 0.8em;
319 span.footnote, span.footnoteref {
320 vertical-align: super;
323 #footnotes {
324 margin: 20px 0 20px 0;
325 padding: 7px 0 0 0;
328 #footnotes div.footnote {
329 margin: 0 0 5px 0;
332 #footnotes hr {
333 border: none;
334 border-top: 1px solid silver;
335 height: 1px;
336 text-align: left;
337 margin-left: 0;
338 width: 20%;
339 min-width: 100px;
343 @media print {
344 div#footer-badges { display: none; }
347 div#toc {
348 margin-bottom: 2.5em;
351 div#toctitle {
352 color: #527bbd;
353 font-family: sans-serif;
354 font-size: 1.1em;
355 font-weight: bold;
356 margin-top: 1.0em;
357 margin-bottom: 0.1em;
360 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
361 margin-top: 0;
362 margin-bottom: 0;
364 div.toclevel2 {
365 margin-left: 2em;
366 font-size: 0.9em;
368 div.toclevel3 {
369 margin-left: 4em;
370 font-size: 0.9em;
372 div.toclevel4 {
373 margin-left: 6em;
374 font-size: 0.9em;
376 /* Overrides for manpage documents */
377 h1 {
378 padding-top: 0.5em;
379 padding-bottom: 0.5em;
380 border-top: 2px solid silver;
381 border-bottom: 2px solid silver;
383 h2 {
384 border-style: none;
386 div.sectionbody {
387 margin-left: 5%;
390 @media print {
391 div#toc { display: none; }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
396 div.sidebar-content {
397 background: #ffffee;
398 border: 1px solid silver;
399 padding: 0.5em;
401 div.sidebar-title, div.image-title {
402 color: #527bbd;
403 font-family: sans-serif;
404 font-weight: bold;
405 margin-top: 0.0em;
406 margin-bottom: 0.5em;
409 div.listingblock div.content {
410 border: 1px solid silver;
411 background: #f4f4f4;
412 padding: 0.5em;
415 div.quoteblock-attribution {
416 padding-top: 0.5em;
417 text-align: right;
420 div.verseblock-content {
421 white-space: pre;
423 div.verseblock-attribution {
424 padding-top: 0.75em;
425 text-align: left;
428 div.exampleblock-content {
429 border-left: 3px solid #dddddd;
430 padding-left: 0.5em;
433 /* IE6 sets dynamically generated links as visited. */
434 div#toc a:visited { color: blue; }
435 </style>
436 <script type="text/javascript">
437 /*<![CDATA[*/
438 window.onload = function(){asciidoc.footnotes();}
439 var asciidoc = { // Namespace.
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
448 * Table Of Content generator
449 * Version: 0.4
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
459 toc: function (toclevels) {
461 function getText(el) {
462 var text = "";
463 for (var i = el.firstChild; i != null; i = i.nextSibling) {
464 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
465 text += i.data;
466 else if (i.firstChild != null)
467 text += getText(i);
469 return text;
472 function TocEntry(el, text, toclevel) {
473 this.element = el;
474 this.text = text;
475 this.toclevel = toclevel;
478 function tocEntries(el, toclevels) {
479 var result = new Array;
480 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
484 var iterate = function (el) {
485 for (var i = el.firstChild; i != null; i = i.nextSibling) {
486 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
487 var mo = re.exec(i.tagName);
488 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
489 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
491 iterate(i);
495 iterate(el);
496 return result;
499 var toc = document.getElementById("toc");
500 var entries = tocEntries(document.getElementById("content"), toclevels);
501 for (var i = 0; i < entries.length; ++i) {
502 var entry = entries[i];
503 if (entry.element.id == "")
504 entry.element.id = "_toc_" + i;
505 var a = document.createElement("a");
506 a.href = "#" + entry.element.id;
507 a.appendChild(document.createTextNode(entry.text));
508 var div = document.createElement("div");
509 div.appendChild(a);
510 div.className = "toclevel" + entry.toclevel;
511 toc.appendChild(div);
513 if (entries.length == 0)
514 toc.parentNode.removeChild(toc);
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
526 footnotes: function () {
527 var cont = document.getElementById("content");
528 var noteholder = document.getElementById("footnotes");
529 var spans = cont.getElementsByTagName("span");
530 var refs = {};
531 var n = 0;
532 for (i=0; i<spans.length; i++) {
533 if (spans[i].className == "footnote") {
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
537 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
538 noteholder.innerHTML +=
539 "<div class='footnote' id='_footnote_" + n + "'>" +
540 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
541 n + "</a>. " + note + "</div>";
542 spans[i].innerHTML =
543 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
544 "' title='View footnote' class='footnote'>" + n + "</a>]";
545 var id =spans[i].getAttribute("id");
546 if (id != null) refs["#"+id] = n;
549 if (n == 0)
550 noteholder.parentNode.removeChild(noteholder);
551 else {
552 // Process footnoterefs.
553 for (i=0; i<spans.length; i++) {
554 if (spans[i].className == "footnoteref") {
555 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
556 href = href.match(/#.*/)[0]; // Because IE return full URL.
557 n = refs[href];
558 spans[i].innerHTML =
559 "[<a href='#_footnote_" + n +
560 "' title='View footnote' class='footnote'>" + n + "</a>]";
567 /*]]>*/
568 </script>
569 </head>
570 <body>
571 <div id="header">
572 <h1>
573 git-receive-pack(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-receive-pack -
578 Receive what is pushed into the repository
579 </p>
580 </div>
581 </div>
582 <div id="content">
583 <h2 id="_synopsis">SYNOPSIS</h2>
584 <div class="sectionbody">
585 <div class="verseblock">
586 <div class="verseblock-content"><em>git-receive-pack</em> &lt;directory&gt;</div>
587 <div class="verseblock-attribution">
588 </div></div>
589 </div>
590 <h2 id="_description">DESCRIPTION</h2>
591 <div class="sectionbody">
592 <div class="paragraph"><p>Invoked by <em>git send-pack</em> and updates the repository with the
593 information fed from the remote end.</p></div>
594 <div class="paragraph"><p>This command is usually not invoked directly by the end user.
595 The UI for the protocol is on the <em>git send-pack</em> side, and the
596 program pair is meant to be used to push updates to remote
597 repository. For pull operations, see <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.</p></div>
598 <div class="paragraph"><p>The command allows for creation and fast-forwarding of sha1 refs
599 (heads/tags) on the remote end (strictly speaking, it is the
600 local end <em>git-receive-pack</em> runs, but to the user who is sitting at
601 the send-pack end, it is updating the remote. Confused?)</p></div>
602 <div class="paragraph"><p>There are other real-world examples of using update and
603 post-update hooks found in the Documentation/howto directory.</p></div>
604 <div class="paragraph"><p><em>git-receive-pack</em> honours the receive.denyNonFastForwards config
605 option, which tells it if updates to a ref should be denied if they
606 are not fast-forwards.</p></div>
607 </div>
608 <h2 id="_options">OPTIONS</h2>
609 <div class="sectionbody">
610 <div class="dlist"><dl>
611 <dt class="hdlist1">
612 &lt;directory&gt;
613 </dt>
614 <dd>
616 The repository to sync into.
617 </p>
618 </dd>
619 </dl></div>
620 </div>
621 <h2 id="_pre_receive_hook">pre-receive Hook</h2>
622 <div class="sectionbody">
623 <div class="paragraph"><p>Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists
624 and is executable, it will be invoked once with no parameters. The
625 standard input of the hook will be one line per ref to be updated:</p></div>
626 <div class="literalblock">
627 <div class="content">
628 <pre><tt>sha1-old SP sha1-new SP refname LF</tt></pre>
629 </div></div>
630 <div class="paragraph"><p>The refname value is relative to $GIT_DIR; e.g. for the master
631 head this is "refs/heads/master". The two sha1 values before
632 each refname are the object names for the refname before and after
633 the update. Refs to be created will have sha1-old equal to 0{40},
634 while refs to be deleted will have sha1-new equal to 0{40}, otherwise
635 sha1-old and sha1-new should be valid objects in the repository.</p></div>
636 <div class="paragraph"><p>This hook is called before any refname is updated and before any
637 fast-forward checks are performed.</p></div>
638 <div class="paragraph"><p>If the pre-receive hook exits with a non-zero exit status no updates
639 will be performed, and the update, post-receive and post-update
640 hooks will not be invoked either. This can be useful to quickly
641 bail out if the update is not to be supported.</p></div>
642 </div>
643 <h2 id="_update_hook">update Hook</h2>
644 <div class="sectionbody">
645 <div class="paragraph"><p>Before each ref is updated, if $GIT_DIR/hooks/update file exists
646 and is executable, it is invoked once per ref, with three parameters:</p></div>
647 <div class="literalblock">
648 <div class="content">
649 <pre><tt>$GIT_DIR/hooks/update refname sha1-old sha1-new</tt></pre>
650 </div></div>
651 <div class="paragraph"><p>The refname parameter is relative to $GIT_DIR; e.g. for the master
652 head this is "refs/heads/master". The two sha1 arguments are
653 the object names for the refname before and after the update.
654 Note that the hook is called before the refname is updated,
655 so either sha1-old is 0{40} (meaning there is no such ref yet),
656 or it should match what is recorded in refname.</p></div>
657 <div class="paragraph"><p>The hook should exit with non-zero status if it wants to disallow
658 updating the named ref. Otherwise it should exit with zero.</p></div>
659 <div class="paragraph"><p>Successful execution (a zero exit status) of this hook does not
660 ensure the ref will actually be updated, it is only a prerequisite.
661 As such it is not a good idea to send notices (e.g. email) from
662 this hook. Consider using the post-receive hook instead.</p></div>
663 </div>
664 <h2 id="_post_receive_hook">post-receive Hook</h2>
665 <div class="sectionbody">
666 <div class="paragraph"><p>After all refs were updated (or attempted to be updated), if any
667 ref update was successful, and if $GIT_DIR/hooks/post-receive
668 file exists and is executable, it will be invoked once with no
669 parameters. The standard input of the hook will be one line
670 for each successfully updated ref:</p></div>
671 <div class="literalblock">
672 <div class="content">
673 <pre><tt>sha1-old SP sha1-new SP refname LF</tt></pre>
674 </div></div>
675 <div class="paragraph"><p>The refname value is relative to $GIT_DIR; e.g. for the master
676 head this is "refs/heads/master". The two sha1 values before
677 each refname are the object names for the refname before and after
678 the update. Refs that were created will have sha1-old equal to
679 0{40}, while refs that were deleted will have sha1-new equal to
680 0{40}, otherwise sha1-old and sha1-new should be valid objects in
681 the repository.</p></div>
682 <div class="paragraph"><p>Using this hook, it is easy to generate mails describing the updates
683 to the repository. This example script sends one mail message per
684 ref listing the commits pushed to the repository:</p></div>
685 <div class="literalblock">
686 <div class="content">
687 <pre><tt>#!/bin/sh
688 # mail out commit update information.
689 while read oval nval ref
691 if expr "$oval" : '0*$' &gt;/dev/null
692 then
693 echo "Created a new ref, with the following commits:"
694 git rev-list --pretty "$nval"
695 else
696 echo "New commits:"
697 git rev-list --pretty "$nval" "^$oval"
698 fi |
699 mail -s "Changes to ref $ref" commit-list@mydomain
700 done
701 exit 0</tt></pre>
702 </div></div>
703 <div class="paragraph"><p>The exit code from this hook invocation is ignored, however a
704 non-zero exit code will generate an error message.</p></div>
705 <div class="paragraph"><p>Note that it is possible for refname to not have sha1-new when this
706 hook runs. This can easily occur if another user modifies the ref
707 after it was updated by <em>git-receive-pack</em>, but before the hook was able
708 to evaluate it. It is recommended that hooks rely on sha1-new
709 rather than the current value of refname.</p></div>
710 </div>
711 <h2 id="_post_update_hook">post-update Hook</h2>
712 <div class="sectionbody">
713 <div class="paragraph"><p>After all other processing, if at least one ref was updated, and
714 if $GIT_DIR/hooks/post-update file exists and is executable, then
715 post-update will be called with the list of refs that have been updated.
716 This can be used to implement any repository wide cleanup tasks.</p></div>
717 <div class="paragraph"><p>The exit code from this hook invocation is ignored; the only thing
718 left for <em>git-receive-pack</em> to do at that point is to exit itself
719 anyway.</p></div>
720 <div class="paragraph"><p>This hook can be used, for example, to run <tt>git update-server-info</tt>
721 if the repository is packed and is served via a dumb transport.</p></div>
722 <div class="literalblock">
723 <div class="content">
724 <pre><tt>#!/bin/sh
725 exec git update-server-info</tt></pre>
726 </div></div>
727 </div>
728 <h2 id="_see_also">SEE ALSO</h2>
729 <div class="sectionbody">
730 <div class="paragraph"><p><a href="git-send-pack.html">git-send-pack(1)</a>, <a href="gitnamespaces.html">gitnamespaces(7)</a></p></div>
731 </div>
732 <h2 id="_git">GIT</h2>
733 <div class="sectionbody">
734 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
735 </div>
736 </div>
737 <div id="footnotes"><hr /></div>
738 <div id="footer">
739 <div id="footer-text">
740 Last updated 2011-09-21 23:01:14 PDT
741 </div>
742 </div>
743 </body>
744 </html>