git-bundle.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-bundle(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-bundle(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>git-bundle -
 743    Move objects and refs by archive
 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 bundle</em> create [-q | --quiet | --progress]
 753                     [--version=&lt;version&gt;] &lt;file&gt; &lt;git-rev-list-args&gt;
 754 <em>git bundle</em> verify [-q | --quiet] &lt;file&gt;
 755 <em>git bundle</em> list-heads &lt;file&gt; [&lt;refname&gt;&#8230;]
 756 <em>git bundle</em> unbundle [--progress] &lt;file&gt; [&lt;refname&gt;&#8230;]</pre>
 757 <div class="attribution">
 758 </div></div>
 759 </div>
 760 </div>
 761 <div class="sect1">
 762 <h2 id="_description">DESCRIPTION</h2>
 763 <div class="sectionbody">
 764 <div class="paragraph"><p>Create, unpack, and manipulate "bundle" files. Bundles are used for
 765 the "offline" transfer of Git objects without an active "server"
 766 sitting on the other side of the network connection.</p></div>
 767 <div class="paragraph"><p>They can be used to create both incremental and full backups of a
 768 repository, and to relay the state of the references in one repository
 769 to another.</p></div>
 770 <div class="paragraph"><p>Git commands that fetch or otherwise "read" via protocols such as
 771 <code>ssh://</code> and <code>https://</code> can also operate on bundle files. It is
 772 possible <a href="git-clone.html">git-clone(1)</a> a new repository from a bundle, to use
 773 <a href="git-fetch.html">git-fetch(1)</a> to fetch from one, and to list the references
 774 contained within it with <a href="git-ls-remote.html">git-ls-remote(1)</a>. There&#8217;s no
 775 corresponding "write" support, i.e.a <em>git push</em> into a bundle is not
 776 supported.</p></div>
 777 <div class="paragraph"><p>See the "EXAMPLES" section below for examples of how to use bundles.</p></div>
 778 </div>
 779 </div>
 780 <div class="sect1">
 781 <h2 id="_bundle_format">BUNDLE FORMAT</h2>
 782 <div class="sectionbody">
 783 <div class="paragraph"><p>Bundles are <code>.pack</code> files (see <a href="git-pack-objects.html">git-pack-objects(1)</a>) with a
 784 header indicating what references are contained within the bundle.</p></div>
 785 <div class="paragraph"><p>Like the packed archive format itself bundles can either be
 786 self-contained, or be created using exclusions.
 787 See the "OBJECT PREREQUISITES" section below.</p></div>
 788 <div class="paragraph"><p>Bundles created using revision exclusions are "thin packs" created
 789 using the <code>--thin</code> option to <a href="git-pack-objects.html">git-pack-objects(1)</a>, and
 790 unbundled using the <code>--fix-thin</code> option to <a href="git-index-pack.html">git-index-pack(1)</a>.</p></div>
 791 <div class="paragraph"><p>There is no option to create a "thick pack" when using revision
 792 exclusions, and users should not be concerned about the difference. By
 793 using "thin packs", bundles created using exclusions are smaller in
 794 size. That they&#8217;re "thin" under the hood is merely noted here as a
 795 curiosity, and as a reference to other documentation.</p></div>
 796 <div class="paragraph"><p>See <a href="gitformat-bundle.html">gitformat-bundle(5)</a> for more details and the discussion of
 797 "thin pack" in <a href="gitformat-pack.html">gitformat-pack(5)</a> for further details.</p></div>
 798 </div>
 799 </div>
 800 <div class="sect1">
 801 <h2 id="_options">OPTIONS</h2>
 802 <div class="sectionbody">
 803 <div class="dlist"><dl>
 804 <dt class="hdlist1">
 805 create [options] &lt;file&gt; &lt;git-rev-list-args&gt;
 806 </dt>
 807 <dd>
 808 <p>
 809         Used to create a bundle named <em>file</em>.  This requires the
 810         <em>&lt;git-rev-list-args&gt;</em> arguments to define the bundle contents.
 811         <em>options</em> contains the options specific to the <em>git bundle create</em>
 812         subcommand. If <em>file</em> is <code>-</code>, the bundle is written to stdout.
 813 </p>
 814 </dd>
 815 <dt class="hdlist1">
 816 verify &lt;file&gt;
 817 </dt>
 818 <dd>
 819 <p>
 820         Used to check that a bundle file is valid and will apply
 821         cleanly to the current repository.  This includes checks on the
 822         bundle format itself as well as checking that the prerequisite
 823         commits exist and are fully linked in the current repository.
 824         Then, <em>git bundle</em> prints a list of missing commits, if any.
 825         Finally, information about additional capabilities, such as "object
 826         filter", is printed. See "Capabilities" in <a href="gitformat-bundle.html">gitformat-bundle(5)</a>
 827         for more information. The exit code is zero for success, but will
 828         be nonzero if the bundle file is invalid. If <em>file</em> is <code>-</code>, the
 829         bundle is read from stdin.
 830 </p>
 831 </dd>
 832 <dt class="hdlist1">
 833 list-heads &lt;file&gt;
 834 </dt>
 835 <dd>
 836 <p>
 837         Lists the references defined in the bundle.  If followed by a
 838         list of references, only references matching those given are
 839         printed out. If <em>file</em> is <code>-</code>, the bundle is read from stdin.
 840 </p>
 841 </dd>
 842 <dt class="hdlist1">
 843 unbundle &lt;file&gt;
 844 </dt>
 845 <dd>
 846 <p>
 847         Passes the objects in the bundle to <em>git index-pack</em>
 848         for storage in the repository, then prints the names of all
 849         defined references. If a list of references is given, only
 850         references matching those in the list are printed. This command is
 851         really plumbing, intended to be called only by <em>git fetch</em>.
 852         If <em>file</em> is <code>-</code>, the bundle is read from stdin.
 853 </p>
 854 </dd>
 855 <dt class="hdlist1">
 856 &lt;git-rev-list-args&gt;
 857 </dt>
 858 <dd>
 859 <p>
 860         A list of arguments, acceptable to <em>git rev-parse</em> and
 861         <em>git rev-list</em> (and containing a named ref, see SPECIFYING REFERENCES
 862         below), that specifies the specific objects and references
 863         to transport.  For example, <code>master~10..master</code> causes the
 864         current master reference to be packaged along with all objects
 865         added since its 10th ancestor commit.  There is no explicit
 866         limit to the number of references and objects that may be
 867         packaged.
 868 </p>
 869 </dd>
 870 <dt class="hdlist1">
 871 [&lt;refname&gt;&#8230;]
 872 </dt>
 873 <dd>
 874 <p>
 875         A list of references used to limit the references reported as
 876         available. This is principally of use to <em>git fetch</em>, which
 877         expects to receive only those references asked for and not
 878         necessarily everything in the pack (in this case, <em>git bundle</em> acts
 879         like <em>git fetch-pack</em>).
 880 </p>
 881 </dd>
 882 <dt class="hdlist1">
 883 --progress
 884 </dt>
 885 <dd>
 886 <p>
 887         Progress status is reported on the standard error stream
 888         by default when it is attached to a terminal, unless -q
 889         is specified. This flag forces progress status even if
 890         the standard error stream is not directed to a terminal.
 891 </p>
 892 </dd>
 893 <dt class="hdlist1">
 894 --version=&lt;version&gt;
 895 </dt>
 896 <dd>
 897 <p>
 898         Specify the bundle version.  Version 2 is the older format and can only be
 899         used with SHA-1 repositories; the newer version 3 contains capabilities that
 900         permit extensions. The default is the oldest supported format, based on the
 901         hash algorithm in use.
 902 </p>
 903 </dd>
 904 <dt class="hdlist1">
 905 -q
 906 </dt>
 907 <dt class="hdlist1">
 908 --quiet
 909 </dt>
 910 <dd>
 911 <p>
 912         This flag makes the command not to report its progress
 913         on the standard error stream.
 914 </p>
 915 </dd>
 916 </dl></div>
 917 </div>
 918 </div>
 919 <div class="sect1">
 920 <h2 id="_specifying_references">SPECIFYING REFERENCES</h2>
 921 <div class="sectionbody">
 922 <div class="paragraph"><p>Revisions must be accompanied by reference names to be packaged in a
 923 bundle.</p></div>
 924 <div class="paragraph"><p>More than one reference may be packaged, and more than one set of prerequisite objects can
 925 be specified.  The objects packaged are those not contained in the
 926 union of the prerequisites.</p></div>
 927 <div class="paragraph"><p>The <em>git bundle create</em> command resolves the reference names for you
 928 using the same rules as <code>git rev-parse --abbrev-ref=loose</code>. Each
 929 prerequisite can be specified explicitly (e.g. <code>^master~10</code>), or implicitly
 930 (e.g. <code>master~10..master</code>, <code>--since=10.days.ago master</code>).</p></div>
 931 <div class="paragraph"><p>All of these simple cases are OK (assuming we have a "master" and
 932 "next" branch):</p></div>
 933 <div class="listingblock">
 934 <div class="content">
 935 <pre><code>$ git bundle create master.bundle master
 936 $ echo master | git bundle create master.bundle --stdin
 937 $ git bundle create master-and-next.bundle master next
 938 $ (echo master; echo next) | git bundle create master-and-next.bundle --stdin</code></pre>
 939 </div></div>
 940 <div class="paragraph"><p>And so are these (and the same but omitted <code>--stdin</code> examples):</p></div>
 941 <div class="listingblock">
 942 <div class="content">
 943 <pre><code>$ git bundle create recent-master.bundle master~10..master
 944 $ git bundle create recent-updates.bundle master~10..master next~5..next</code></pre>
 945 </div></div>
 946 <div class="paragraph"><p>A revision name or a range whose right-hand-side cannot be resolved to
 947 a reference is not accepted:</p></div>
 948 <div class="listingblock">
 949 <div class="content">
 950 <pre><code>$ git bundle create HEAD.bundle $(git rev-parse HEAD)
 951 fatal: Refusing to create empty bundle.
 952 $ git bundle create master-yesterday.bundle master~10..master~5
 953 fatal: Refusing to create empty bundle.</code></pre>
 954 </div></div>
 955 </div>
 956 </div>
 957 <div class="sect1">
 958 <h2 id="_object_prerequisites">OBJECT PREREQUISITES</h2>
 959 <div class="sectionbody">
 960 <div class="paragraph"><p>When creating bundles it is possible to create a self-contained bundle
 961 that can be unbundled in a repository with no common history, as well
 962 as providing negative revisions to exclude objects needed in the
 963 earlier parts of the history.</p></div>
 964 <div class="paragraph"><p>Feeding a revision such as <code>new</code> to <code>git bundle create</code> will create a
 965 bundle file that contains all the objects reachable from the revision
 966 <code>new</code>. That bundle can be unbundled in any repository to obtain a full
 967 history that leads to the revision <code>new</code>:</p></div>
 968 <div class="listingblock">
 969 <div class="content">
 970 <pre><code>$ git bundle create full.bundle new</code></pre>
 971 </div></div>
 972 <div class="paragraph"><p>A revision range such as <code>old..new</code> will produce a bundle file that
 973 will require the revision <code>old</code> (and any objects reachable from it)
 974 to exist for the bundle to be "unbundle"-able:</p></div>
 975 <div class="listingblock">
 976 <div class="content">
 977 <pre><code>$ git bundle create full.bundle old..new</code></pre>
 978 </div></div>
 979 <div class="paragraph"><p>A self-contained bundle without any prerequisites can be extracted
 980 into anywhere, even into an empty repository, or be cloned from
 981 (i.e., <code>new</code>, but not <code>old..new</code>).</p></div>
 982 <div class="paragraph"><p>It is okay to err on the side of caution, causing the bundle file
 983 to contain objects already in the destination, as these are ignored
 984 when unpacking at the destination.</p></div>
 985 <div class="paragraph"><p>If you want to match <code>git clone --mirror</code>, which would include your
 986 refs such as <code>refs/remotes/*</code>, use <code>--all</code>.
 987 If you want to provide the same set of refs that a clone directly
 988 from the source repository would get, use <code>--branches --tags</code> for
 989 the <code>&lt;git-rev-list-args&gt;</code>.</p></div>
 990 <div class="paragraph"><p>The <em>git bundle verify</em> command can be used to check whether your
 991 recipient repository has the required prerequisite commits for a
 992 bundle.</p></div>
 993 </div>
 994 </div>
 995 <div class="sect1">
 996 <h2 id="_examples">EXAMPLES</h2>
 997 <div class="sectionbody">
 998 <div class="paragraph"><p>Assume you want to transfer the history from a repository R1 on machine A
 999 to another repository R2 on machine B.
1000 For whatever reason, direct connection between A and B is not allowed,
1001 but we can move data from A to B via some mechanism (CD, email, etc.).
1002 We want to update R2 with development made on the branch master in R1.</p></div>
1003 <div class="paragraph"><p>To bootstrap the process, you can first create a bundle that does not have
1004 any prerequisites. You can use a tag to remember up to what commit you last
1005 processed, in order to make it easy to later update the other repository
1006 with an incremental bundle:</p></div>
1007 <div class="listingblock">
1008 <div class="content">
1009 <pre><code>machineA$ cd R1
1010 machineA$ git bundle create file.bundle master
1011 machineA$ git tag -f lastR2bundle master</code></pre>
1012 </div></div>
1013 <div class="paragraph"><p>Then you transfer file.bundle to the target machine B. Because this
1014 bundle does not require any existing object to be extracted, you can
1015 create a new repository on machine B by cloning from it:</p></div>
1016 <div class="listingblock">
1017 <div class="content">
1018 <pre><code>machineB$ git clone -b master /home/me/tmp/file.bundle R2</code></pre>
1019 </div></div>
1020 <div class="paragraph"><p>This will define a remote called "origin" in the resulting repository that
1021 lets you fetch and pull from the bundle. The $GIT_DIR/config file in R2 will
1022 have an entry like this:</p></div>
1023 <div class="listingblock">
1024 <div class="content">
1025 <pre><code>[remote "origin"]
1026     url = /home/me/tmp/file.bundle
1027     fetch = refs/heads/*:refs/remotes/origin/*</code></pre>
1028 </div></div>
1029 <div class="paragraph"><p>To update the resulting mine.git repository, you can fetch or pull after
1030 replacing the bundle stored at /home/me/tmp/file.bundle with incremental
1031 updates.</p></div>
1032 <div class="paragraph"><p>After working some more in the original repository, you can create an
1033 incremental bundle to update the other repository:</p></div>
1034 <div class="listingblock">
1035 <div class="content">
1036 <pre><code>machineA$ cd R1
1037 machineA$ git bundle create file.bundle lastR2bundle..master
1038 machineA$ git tag -f lastR2bundle master</code></pre>
1039 </div></div>
1040 <div class="paragraph"><p>You then transfer the bundle to the other machine to replace
1041 /home/me/tmp/file.bundle, and pull from it.</p></div>
1042 <div class="listingblock">
1043 <div class="content">
1044 <pre><code>machineB$ cd R2
1045 machineB$ git pull</code></pre>
1046 </div></div>
1047 <div class="paragraph"><p>If you know up to what commit the intended recipient repository should
1048 have the necessary objects, you can use that knowledge to specify the
1049 prerequisites, giving a cut-off point to limit the revisions and objects that go
1050 in the resulting bundle. The previous example used the lastR2bundle tag
1051 for this purpose, but you can use any other options that you would give to
1052 the <a href="git-log.html">git-log(1)</a> command. Here are more examples:</p></div>
1053 <div class="paragraph"><p>You can use a tag that is present in both:</p></div>
1054 <div class="listingblock">
1055 <div class="content">
1056 <pre><code>$ git bundle create mybundle v1.0.0..master</code></pre>
1057 </div></div>
1058 <div class="paragraph"><p>You can use a prerequisite based on time:</p></div>
1059 <div class="listingblock">
1060 <div class="content">
1061 <pre><code>$ git bundle create mybundle --since=10.days master</code></pre>
1062 </div></div>
1063 <div class="paragraph"><p>You can use the number of commits:</p></div>
1064 <div class="listingblock">
1065 <div class="content">
1066 <pre><code>$ git bundle create mybundle -10 master</code></pre>
1067 </div></div>
1068 <div class="paragraph"><p>You can run <code>git-bundle verify</code> to see if you can extract from a bundle
1069 that was created with a prerequisite:</p></div>
1070 <div class="listingblock">
1071 <div class="content">
1072 <pre><code>$ git bundle verify mybundle</code></pre>
1073 </div></div>
1074 <div class="paragraph"><p>This will list what commits you must have in order to extract from the
1075 bundle and will error out if you do not have them.</p></div>
1076 <div class="paragraph"><p>A bundle from a recipient repository&#8217;s point of view is just like a
1077 regular repository which it fetches or pulls from. You can, for example, map
1078 references when fetching:</p></div>
1079 <div class="listingblock">
1080 <div class="content">
1081 <pre><code>$ git fetch mybundle master:localRef</code></pre>
1082 </div></div>
1083 <div class="paragraph"><p>You can also see what references it offers:</p></div>
1084 <div class="listingblock">
1085 <div class="content">
1086 <pre><code>$ git ls-remote mybundle</code></pre>
1087 </div></div>
1088 </div>
1089 </div>
1090 <div class="sect1">
1091 <h2 id="_file_format">FILE FORMAT</h2>
1092 <div class="sectionbody">
1093 <div class="paragraph"><p>See <a href="gitformat-bundle.html">gitformat-bundle(5)</a>.</p></div>
1094 </div>
1095 </div>
1096 <div class="sect1">
1097 <h2 id="_git">GIT</h2>
1098 <div class="sectionbody">
1099 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
1100 </div>
1101 </div>
1102 </div>
1103 <div id="footnotes"><hr /></div>
1104 <div id="footer">
1105 <div id="footer-text">
1106 Last updated
1107  2023-03-19 15:16:41 PDT
1108 </div>
1109 </div>
1110 </body>
1111 </html>