git-receive-pack.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>git-receive-pack(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 git-receive-pack(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-receive-pack -
 743    Receive what is pushed into the repository
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content"><em>git receive-pack</em> &lt;git-dir&gt;</pre>
 753 <div class="attribution">
 754 </div></div>
 755 </div>
 756 </div>
 757 <div class="sect1">
 758 <h2 id="_description">DESCRIPTION</h2>
 759 <div class="sectionbody">
 760 <div class="paragraph"><p>Invoked by <em>git send-pack</em> and updates the repository with the
 761 information fed from the remote end.</p></div>
 762 <div class="paragraph"><p>This command is usually not invoked directly by the end user.
 763 The UI for the protocol is on the <em>git send-pack</em> side, and the
 764 program pair is meant to be used to push updates to a remote
 765 repository.  For pull operations, see <a href="git-fetch-pack.html">git-fetch-pack(1)</a>.</p></div>
 766 <div class="paragraph"><p>The command allows for the creation and fast-forwarding of sha1 refs
 767 (heads/tags) on the remote end (strictly speaking, it is the
 768 local end <em>git-receive-pack</em> runs, but to the user who is sitting at
 769 the send-pack end, it is updating the remote.  Confused?)</p></div>
 770 <div class="paragraph"><p>There are other real-world examples of using update and
 771 post-update hooks found in the Documentation/howto directory.</p></div>
 772 <div class="paragraph"><p><em>git-receive-pack</em> honours the receive.denyNonFastForwards config
 773 option, which tells it if updates to a ref should be denied if they
 774 are not fast-forwards.</p></div>
 775 <div class="paragraph"><p>A number of other receive.* config options are available to tweak
 776 its behavior, see <a href="git-config.html">git-config(1)</a>.</p></div>
 777 </div>
 778 </div>
 779 <div class="sect1">
 780 <h2 id="_options">OPTIONS</h2>
 781 <div class="sectionbody">
 782 <div class="dlist"><dl>
 783 <dt class="hdlist1">
 784 &lt;git-dir&gt;
 785 </dt>
 786 <dd>
 787 <p>
 788         The repository to sync into.
 789 </p>
 790 </dd>
 791 <dt class="hdlist1">
 792 --http-backend-info-refs
 793 </dt>
 794 <dd>
 795 <p>
 796         Used by <a href="git-http-backend.html">git-http-backend(1)</a> to serve up
 797         <code>$GIT_URL/info/refs?service=git-receive-pack</code> requests. See
 798         <code>--http-backend-info-refs</code> in <a href="git-upload-pack.html">git-upload-pack(1)</a>.
 799 </p>
 800 </dd>
 801 </dl></div>
 802 </div>
 803 </div>
 804 <div class="sect1">
 805 <h2 id="_pre_receive_hook">PRE-RECEIVE HOOK</h2>
 806 <div class="sectionbody">
 807 <div class="paragraph"><p>Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists
 808 and is executable, it will be invoked once with no parameters.  The
 809 standard input of the hook will be one line per ref to be updated:</p></div>
 810 <div class="literalblock">
 811 <div class="content">
 812 <pre><code>sha1-old SP sha1-new SP refname LF</code></pre>
 813 </div></div>
 814 <div class="paragraph"><p>The refname value is relative to $GIT_DIR; e.g. for the master
 815 head this is "refs/heads/master".  The two sha1 values before
 816 each refname are the object names for the refname before and after
 817 the update.  Refs to be created will have sha1-old equal to 0{40},
 818 while refs to be deleted will have sha1-new equal to 0{40}, otherwise
 819 sha1-old and sha1-new should be valid objects in the repository.</p></div>
 820 <div class="paragraph"><p>When accepting a signed push (see <a href="git-push.html">git-push(1)</a>), the signed
 821 push certificate is stored in a blob and an environment variable
 822 <code>GIT_PUSH_CERT</code> can be consulted for its object name.  See the
 823 description of <code>post-receive</code> hook for an example.  In addition, the
 824 certificate is verified using GPG and the result is exported with
 825 the following environment variables:</p></div>
 826 <div class="dlist"><dl>
 827 <dt class="hdlist1">
 828 <code>GIT_PUSH_CERT_SIGNER</code>
 829 </dt>
 830 <dd>
 831 <p>
 832         The name and the e-mail address of the owner of the key that
 833         signed the push certificate.
 834 </p>
 835 </dd>
 836 <dt class="hdlist1">
 837 <code>GIT_PUSH_CERT_KEY</code>
 838 </dt>
 839 <dd>
 840 <p>
 841         The GPG key ID of the key that signed the push certificate.
 842 </p>
 843 </dd>
 844 <dt class="hdlist1">
 845 <code>GIT_PUSH_CERT_STATUS</code>
 846 </dt>
 847 <dd>
 848 <p>
 849         The status of GPG verification of the push certificate,
 850         using the same mnemonic as used in <code>%G?</code> format of <code>git log</code>
 851         family of commands (see <a href="git-log.html">git-log(1)</a>).
 852 </p>
 853 </dd>
 854 <dt class="hdlist1">
 855 <code>GIT_PUSH_CERT_NONCE</code>
 856 </dt>
 857 <dd>
 858 <p>
 859         The nonce string the process asked the signer to include
 860         in the push certificate.  If this does not match the value
 861         recorded on the "nonce" header in the push certificate, it
 862         may indicate that the certificate is a valid one that is
 863         being replayed from a separate "git push" session.
 864 </p>
 865 </dd>
 866 <dt class="hdlist1">
 867 <code>GIT_PUSH_CERT_NONCE_STATUS</code>
 868 </dt>
 869 <dd>
 870 <div class="dlist"><dl>
 871 <dt class="hdlist1">
 872 <code>UNSOLICITED</code>
 873 </dt>
 874 <dd>
 875 <p>
 876         "git push --signed" sent a nonce when we did not ask it to
 877         send one.
 878 </p>
 879 </dd>
 880 <dt class="hdlist1">
 881 <code>MISSING</code>
 882 </dt>
 883 <dd>
 884 <p>
 885         "git push --signed" did not send any nonce header.
 886 </p>
 887 </dd>
 888 <dt class="hdlist1">
 889 <code>BAD</code>
 890 </dt>
 891 <dd>
 892 <p>
 893         "git push --signed" sent a bogus nonce.
 894 </p>
 895 </dd>
 896 <dt class="hdlist1">
 897 <code>OK</code>
 898 </dt>
 899 <dd>
 900 <p>
 901         "git push --signed" sent the nonce we asked it to send.
 902 </p>
 903 </dd>
 904 <dt class="hdlist1">
 905 <code>SLOP</code>
 906 </dt>
 907 <dd>
 908 <p>
 909         "git push --signed" sent a nonce different from what we
 910         asked it to send now, but in a previous session.  See
 911         <code>GIT_PUSH_CERT_NONCE_SLOP</code> environment variable.
 912 </p>
 913 </dd>
 914 </dl></div>
 915 </dd>
 916 <dt class="hdlist1">
 917 <code>GIT_PUSH_CERT_NONCE_SLOP</code>
 918 </dt>
 919 <dd>
 920 <p>
 921         "git push --signed" sent a nonce different from what we
 922         asked it to send now, but in a different session whose
 923         starting time is different by this many seconds from the
 924         current session.  Only meaningful when
 925         <code>GIT_PUSH_CERT_NONCE_STATUS</code> says <code>SLOP</code>.
 926         Also read about <code>receive.certNonceSlop</code> variable in
 927         <a href="git-config.html">git-config(1)</a>.
 928 </p>
 929 </dd>
 930 </dl></div>
 931 <div class="paragraph"><p>This hook is called before any refname is updated and before any
 932 fast-forward checks are performed.</p></div>
 933 <div class="paragraph"><p>If the pre-receive hook exits with a non-zero exit status no updates
 934 will be performed, and the update, post-receive and post-update
 935 hooks will not be invoked either.  This can be useful to quickly
 936 bail out if the update is not to be supported.</p></div>
 937 <div class="paragraph"><p>See the notes on the quarantine environment below.</p></div>
 938 </div>
 939 </div>
 940 <div class="sect1">
 941 <h2 id="_update_hook">UPDATE HOOK</h2>
 942 <div class="sectionbody">
 943 <div class="paragraph"><p>Before each ref is updated, if $GIT_DIR/hooks/update file exists
 944 and is executable, it is invoked once per ref, with three parameters:</p></div>
 945 <div class="literalblock">
 946 <div class="content">
 947 <pre><code>$GIT_DIR/hooks/update refname sha1-old sha1-new</code></pre>
 948 </div></div>
 949 <div class="paragraph"><p>The refname parameter is relative to $GIT_DIR; e.g. for the master
 950 head this is "refs/heads/master".  The two sha1 arguments are
 951 the object names for the refname before and after the update.
 952 Note that the hook is called before the refname is updated,
 953 so either sha1-old is 0{40} (meaning there is no such ref yet),
 954 or it should match what is recorded in refname.</p></div>
 955 <div class="paragraph"><p>The hook should exit with non-zero status if it wants to disallow
 956 updating the named ref.  Otherwise it should exit with zero.</p></div>
 957 <div class="paragraph"><p>Successful execution (a zero exit status) of this hook does not
 958 ensure the ref will actually be updated, it is only a prerequisite.
 959 As such it is not a good idea to send notices (e.g. email) from
 960 this hook.  Consider using the post-receive hook instead.</p></div>
 961 </div>
 962 </div>
 963 <div class="sect1">
 964 <h2 id="_post_receive_hook">POST-RECEIVE HOOK</h2>
 965 <div class="sectionbody">
 966 <div class="paragraph"><p>After all refs were updated (or attempted to be updated), if any
 967 ref update was successful, and if $GIT_DIR/hooks/post-receive
 968 file exists and is executable, it will be invoked once with no
 969 parameters.  The standard input of the hook will be one line
 970 for each successfully updated ref:</p></div>
 971 <div class="literalblock">
 972 <div class="content">
 973 <pre><code>sha1-old SP sha1-new SP refname LF</code></pre>
 974 </div></div>
 975 <div class="paragraph"><p>The refname value is relative to $GIT_DIR; e.g. for the master
 976 head this is "refs/heads/master".  The two sha1 values before
 977 each refname are the object names for the refname before and after
 978 the update.  Refs that were created will have sha1-old equal to
 979 0{40}, while refs that were deleted will have sha1-new equal to
 980 0{40}, otherwise sha1-old and sha1-new should be valid objects in
 981 the repository.</p></div>
 982 <div class="paragraph"><p>The <code>GIT_PUSH_CERT*</code> environment variables can be inspected, just as
 983 in <code>pre-receive</code> hook, after accepting a signed push.</p></div>
 984 <div class="paragraph"><p>Using this hook, it is easy to generate mails describing the updates
 985 to the repository.  This example script sends one mail message per
 986 ref listing the commits pushed to the repository, and logs the push
 987 certificates of signed pushes with good signatures to a logger
 988 service:</p></div>
 989 <div class="listingblock">
 990 <div class="content">
 991 <pre><code>#!/bin/sh
 992 # mail out commit update information.
 993 while read oval nval ref
 994 do
 995         if expr "$oval" : '0*$' &gt;/dev/null
 996         then
 997                 echo "Created a new ref, with the following commits:"
 998                 git rev-list --pretty "$nval"
 999         else
1000                 echo "New commits:"
1001                 git rev-list --pretty "$nval" "^$oval"
1002         fi |
1003         mail -s "Changes to ref $ref" commit-list@mydomain
1004 done
1005 # log signed push certificate, if any
1006 if test -n "${GIT_PUSH_CERT-}" &amp;&amp; test ${GIT_PUSH_CERT_STATUS} = G
1007 then
1008         (
1009                 echo expected nonce is ${GIT_PUSH_NONCE}
1010                 git cat-file blob ${GIT_PUSH_CERT}
1011         ) | mail -s "push certificate from $GIT_PUSH_CERT_SIGNER" push-log@mydomain
1012 fi
1013 exit 0</code></pre>
1014 </div></div>
1015 <div class="paragraph"><p>The exit code from this hook invocation is ignored, however a
1016 non-zero exit code will generate an error message.</p></div>
1017 <div class="paragraph"><p>Note that it is possible for refname to not have sha1-new when this
1018 hook runs.  This can easily occur if another user modifies the ref
1019 after it was updated by <em>git-receive-pack</em>, but before the hook was able
1020 to evaluate it.  It is recommended that hooks rely on sha1-new
1021 rather than the current value of refname.</p></div>
1022 </div>
1023 </div>
1024 <div class="sect1">
1025 <h2 id="_post_update_hook">POST-UPDATE HOOK</h2>
1026 <div class="sectionbody">
1027 <div class="paragraph"><p>After all other processing, if at least one ref was updated, and
1028 if $GIT_DIR/hooks/post-update file exists and is executable, then
1029 post-update will be called with the list of refs that have been updated.
1030 This can be used to implement any repository wide cleanup tasks.</p></div>
1031 <div class="paragraph"><p>The exit code from this hook invocation is ignored; the only thing
1032 left for <em>git-receive-pack</em> to do at that point is to exit itself
1033 anyway.</p></div>
1034 <div class="paragraph"><p>This hook can be used, for example, to run <code>git update-server-info</code>
1035 if the repository is packed and is served via a dumb transport.</p></div>
1036 <div class="listingblock">
1037 <div class="content">
1038 <pre><code>#!/bin/sh
1039 exec git update-server-info</code></pre>
1040 </div></div>
1041 </div>
1042 </div>
1043 <div class="sect1">
1044 <h2 id="_quarantine_environment">QUARANTINE ENVIRONMENT</h2>
1045 <div class="sectionbody">
1046 <div class="paragraph"><p>When <code>receive-pack</code> takes in objects, they are placed into a temporary
1047 "quarantine" directory within the <code>$GIT_DIR/objects</code> directory and
1048 migrated into the main object store only after the <code>pre-receive</code> hook
1049 has completed. If the push fails before then, the temporary directory is
1050 removed entirely.</p></div>
1051 <div class="paragraph"><p>This has a few user-visible effects and caveats:</p></div>
1052 <div class="olist arabic"><ol class="arabic">
1053 <li>
1054 <p>
1055 Pushes which fail due to problems with the incoming pack, missing
1056      objects, or due to the <code>pre-receive</code> hook will not leave any
1057      on-disk data. This is usually helpful to prevent repeated failed
1058      pushes from filling up your disk, but can make debugging more
1059      challenging.
1060 </p>
1061 </li>
1062 <li>
1063 <p>
1064 Any objects created by the <code>pre-receive</code> hook will be created in
1065      the quarantine directory (and migrated only if it succeeds).
1066 </p>
1067 </li>
1068 <li>
1069 <p>
1070 The <code>pre-receive</code> hook MUST NOT update any refs to point to
1071      quarantined objects. Other programs accessing the repository will
1072      not be able to see the objects (and if the pre-receive hook fails,
1073      those refs would become corrupted). For safety, any ref updates
1074      from within <code>pre-receive</code> are automatically rejected.
1075 </p>
1076 </li>
1077 </ol></div>
1078 </div>
1079 </div>
1080 <div class="sect1">
1081 <h2 id="_see_also">SEE ALSO</h2>
1082 <div class="sectionbody">
1083 <div class="paragraph"><p><a href="git-send-pack.html">git-send-pack(1)</a>, <a href="gitnamespaces.html">gitnamespaces(7)</a></p></div>
1084 </div>
1085 </div>
1086 <div class="sect1">
1087 <h2 id="_git">GIT</h2>
1088 <div class="sectionbody">
1089 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1090 </div>
1091 </div>
1092 </div>
1093 <div id="footnotes"><hr /></div>
1094 <div id="footer">
1095 <div id="footer-text">
1096 Last updated
1097  2023-10-23 14:43:46 PDT
1098 </div>
1099 </div>
1100 </body>
1101 </html>