Autogenerated HTML docs for v1.7.7-237-g34c44
[git/jnareb-git.git] / git-bundle.html
bloba091868d530f588a81a69a5841944c7378555c3e
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-bundle(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-bundle(1) Manual Page
574 </h1>
575 <h2>NAME</h2>
576 <div class="sectionbody">
577 <p>git-bundle -
578 Move objects and refs by archive
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 bundle</em> create &lt;file&gt; &lt;git-rev-list-args&gt;
587 <em>git bundle</em> verify &lt;file&gt;
588 <em>git bundle</em> list-heads &lt;file&gt; [&lt;refname&gt;&#8230;]
589 <em>git bundle</em> unbundle &lt;file&gt; [&lt;refname&gt;&#8230;]</div>
590 <div class="verseblock-attribution">
591 </div></div>
592 </div>
593 <h2 id="_description">DESCRIPTION</h2>
594 <div class="sectionbody">
595 <div class="paragraph"><p>Some workflows require that one or more branches of development on one
596 machine be replicated on another machine, but the two machines cannot
597 be directly connected, and therefore the interactive git protocols (git,
598 ssh, rsync, http) cannot be used. This command provides support for
599 <em>git fetch</em> and <em>git pull</em> to operate by packaging objects and references
600 in an archive at the originating machine, then importing those into
601 another repository using <em>git fetch</em> and <em>git pull</em>
602 after moving the archive by some means (e.g., by sneakernet). As no
603 direct connection between the repositories exists, the user must specify a
604 basis for the bundle that is held by the destination repository: the
605 bundle assumes that all objects in the basis are already in the
606 destination repository.</p></div>
607 </div>
608 <h2 id="_options">OPTIONS</h2>
609 <div class="sectionbody">
610 <div class="dlist"><dl>
611 <dt class="hdlist1">
612 create &lt;file&gt;
613 </dt>
614 <dd>
616 Used to create a bundle named <em>file</em>. This requires the
617 <em>git-rev-list-args</em> arguments to define the bundle contents.
618 </p>
619 </dd>
620 <dt class="hdlist1">
621 verify &lt;file&gt;
622 </dt>
623 <dd>
625 Used to check that a bundle file is valid and will apply
626 cleanly to the current repository. This includes checks on the
627 bundle format itself as well as checking that the prerequisite
628 commits exist and are fully linked in the current repository.
629 <em>git bundle</em> prints a list of missing commits, if any, and exits
630 with a non-zero status.
631 </p>
632 </dd>
633 <dt class="hdlist1">
634 list-heads &lt;file&gt;
635 </dt>
636 <dd>
638 Lists the references defined in the bundle. If followed by a
639 list of references, only references matching those given are
640 printed out.
641 </p>
642 </dd>
643 <dt class="hdlist1">
644 unbundle &lt;file&gt;
645 </dt>
646 <dd>
648 Passes the objects in the bundle to <em>git index-pack</em>
649 for storage in the repository, then prints the names of all
650 defined references. If a list of references is given, only
651 references matching those in the list are printed. This command is
652 really plumbing, intended to be called only by <em>git fetch</em>.
653 </p>
654 </dd>
655 <dt class="hdlist1">
656 &lt;git-rev-list-args&gt;
657 </dt>
658 <dd>
660 A list of arguments, acceptable to <em>git rev-parse</em> and
661 <em>git rev-list</em> (and containing a named ref, see SPECIFYING REFERENCES
662 below), that specifies the specific objects and references
663 to transport. For example, <tt>master&#126;10..master</tt> causes the
664 current master reference to be packaged along with all objects
665 added since its 10th ancestor commit. There is no explicit
666 limit to the number of references and objects that may be
667 packaged.
668 </p>
669 </dd>
670 <dt class="hdlist1">
671 [&lt;refname&gt;&#8230;]
672 </dt>
673 <dd>
675 A list of references used to limit the references reported as
676 available. This is principally of use to <em>git fetch</em>, which
677 expects to receive only those references asked for and not
678 necessarily everything in the pack (in this case, <em>git bundle</em> acts
679 like <em>git fetch-pack</em>).
680 </p>
681 </dd>
682 </dl></div>
683 </div>
684 <h2 id="_specifying_references">SPECIFYING REFERENCES</h2>
685 <div class="sectionbody">
686 <div class="paragraph"><p><em>git bundle</em> will only package references that are shown by
687 <em>git show-ref</em>: this includes heads, tags, and remote heads. References
688 such as <tt>master&#126;1</tt> cannot be packaged, but are perfectly suitable for
689 defining the basis. More than one reference may be packaged, and more
690 than one basis can be specified. The objects packaged are those not
691 contained in the union of the given bases. Each basis can be
692 specified explicitly (e.g. <tt>^master&#126;10</tt>), or implicitly (e.g.
693 <tt>master&#126;10..master</tt>, <tt>--since=10.days.ago master</tt>).</p></div>
694 <div class="paragraph"><p>It is very important that the basis used be held by the destination.
695 It is okay to err on the side of caution, causing the bundle file
696 to contain objects already in the destination, as these are ignored
697 when unpacking at the destination.</p></div>
698 </div>
699 <h2 id="_example">EXAMPLE</h2>
700 <div class="sectionbody">
701 <div class="paragraph"><p>Assume you want to transfer the history from a repository R1 on machine A
702 to another repository R2 on machine B.
703 For whatever reason, direct connection between A and B is not allowed,
704 but we can move data from A to B via some mechanism (CD, email, etc.).
705 We want to update R2 with development made on the branch master in R1.</p></div>
706 <div class="paragraph"><p>To bootstrap the process, you can first create a bundle that does not have
707 any basis. You can use a tag to remember up to what commit you last
708 processed, in order to make it easy to later update the other repository
709 with an incremental bundle:</p></div>
710 <div class="listingblock">
711 <div class="content">
712 <pre><tt>machineA$ cd R1
713 machineA$ git bundle create file.bundle master
714 machineA$ git tag -f lastR2bundle master</tt></pre>
715 </div></div>
716 <div class="paragraph"><p>Then you transfer file.bundle to the target machine B. If you are creating
717 the repository on machine B, then you can clone from the bundle as if it
718 were a remote repository instead of creating an empty repository and then
719 pulling or fetching objects from the bundle:</p></div>
720 <div class="listingblock">
721 <div class="content">
722 <pre><tt>machineB$ git clone /home/me/tmp/file.bundle R2</tt></pre>
723 </div></div>
724 <div class="paragraph"><p>This will define a remote called "origin" in the resulting repository that
725 lets you fetch and pull from the bundle. The $GIT_DIR/config file in R2 will
726 have an entry like this:</p></div>
727 <div class="listingblock">
728 <div class="content">
729 <pre><tt>[remote "origin"]
730 url = /home/me/tmp/file.bundle
731 fetch = refs/heads/*:refs/remotes/origin/*</tt></pre>
732 </div></div>
733 <div class="paragraph"><p>To update the resulting mine.git repository, you can fetch or pull after
734 replacing the bundle stored at /home/me/tmp/file.bundle with incremental
735 updates.</p></div>
736 <div class="paragraph"><p>After working some more in the original repository, you can create an
737 incremental bundle to update the other repository:</p></div>
738 <div class="listingblock">
739 <div class="content">
740 <pre><tt>machineA$ cd R1
741 machineA$ git bundle create file.bundle lastR2bundle..master
742 machineA$ git tag -f lastR2bundle master</tt></pre>
743 </div></div>
744 <div class="paragraph"><p>You then transfer the bundle to the other machine to replace
745 /home/me/tmp/file.bundle, and pull from it.</p></div>
746 <div class="listingblock">
747 <div class="content">
748 <pre><tt>machineB$ cd R2
749 machineB$ git pull</tt></pre>
750 </div></div>
751 <div class="paragraph"><p>If you know up to what commit the intended recipient repository should
752 have the necessary objects, you can use that knowledge to specify the
753 basis, giving a cut-off point to limit the revisions and objects that go
754 in the resulting bundle. The previous example used the lastR2bundle tag
755 for this purpose, but you can use any other options that you would give to
756 the <a href="git-log.html">git-log(1)</a> command. Here are more examples:</p></div>
757 <div class="paragraph"><p>You can use a tag that is present in both:</p></div>
758 <div class="listingblock">
759 <div class="content">
760 <pre><tt>$ git bundle create mybundle v1.0.0..master</tt></pre>
761 </div></div>
762 <div class="paragraph"><p>You can use a basis based on time:</p></div>
763 <div class="listingblock">
764 <div class="content">
765 <pre><tt>$ git bundle create mybundle --since=10.days master</tt></pre>
766 </div></div>
767 <div class="paragraph"><p>You can use the number of commits:</p></div>
768 <div class="listingblock">
769 <div class="content">
770 <pre><tt>$ git bundle create mybundle -10 master</tt></pre>
771 </div></div>
772 <div class="paragraph"><p>You can run <tt>git-bundle verify</tt> to see if you can extract from a bundle
773 that was created with a basis:</p></div>
774 <div class="listingblock">
775 <div class="content">
776 <pre><tt>$ git bundle verify mybundle</tt></pre>
777 </div></div>
778 <div class="paragraph"><p>This will list what commits you must have in order to extract from the
779 bundle and will error out if you do not have them.</p></div>
780 <div class="paragraph"><p>A bundle from a recipient repository&#8217;s point of view is just like a
781 regular repository which it fetches or pulls from. You can, for example, map
782 references when fetching:</p></div>
783 <div class="listingblock">
784 <div class="content">
785 <pre><tt>$ git fetch mybundle master:localRef</tt></pre>
786 </div></div>
787 <div class="paragraph"><p>You can also see what references it offers:</p></div>
788 <div class="listingblock">
789 <div class="content">
790 <pre><tt>$ git ls-remote mybundle</tt></pre>
791 </div></div>
792 </div>
793 <h2 id="_git">GIT</h2>
794 <div class="sectionbody">
795 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
796 </div>
797 </div>
798 <div id="footnotes"><hr /></div>
799 <div id="footer">
800 <div id="footer-text">
801 Last updated 2011-09-21 23:01:14 PDT
802 </div>
803 </div>
804 </body>
805 </html>