Autogenerated HTML docs for v1.7.5-rc1
[git/jnareb-git.git] / git-bundle.html
blob1a678a98eb4d952769b48b0430461b5c92ba9983
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
6 <meta name="generator" content="AsciiDoc 8.4.5" />
7 <title>git-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.5em;
122 margin-bottom: 1.5em;
124 div.admonitionblock {
125 margin-top: 2.5em;
126 margin-bottom: 2.5em;
129 div.content { /* Block element content. */
130 padding: 0;
133 /* Block element titles. */
134 div.title, caption.title {
135 color: #527bbd;
136 font-family: sans-serif;
137 font-weight: bold;
138 text-align: left;
139 margin-top: 1.0em;
140 margin-bottom: 0.5em;
142 div.title + * {
143 margin-top: 0;
146 td div.title:first-child {
147 margin-top: 0.0em;
149 div.content div.title:first-child {
150 margin-top: 0.0em;
152 div.content + div.title {
153 margin-top: 0.0em;
156 div.sidebarblock > div.content {
157 background: #ffffee;
158 border: 1px solid silver;
159 padding: 0.5em;
162 div.listingblock > div.content {
163 border: 1px solid silver;
164 background: #f4f4f4;
165 padding: 0.5em;
168 div.quoteblock {
169 padding-left: 2.0em;
170 margin-right: 10%;
172 div.quoteblock > div.attribution {
173 padding-top: 0.5em;
174 text-align: right;
177 div.verseblock {
178 padding-left: 2.0em;
179 margin-right: 10%;
181 div.verseblock > div.content {
182 white-space: pre;
184 div.verseblock > div.attribution {
185 padding-top: 0.75em;
186 text-align: left;
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div.verseblock + div.attribution {
190 text-align: left;
193 div.admonitionblock .icon {
194 vertical-align: top;
195 font-size: 1.1em;
196 font-weight: bold;
197 text-decoration: underline;
198 color: #527bbd;
199 padding-right: 0.5em;
201 div.admonitionblock td.content {
202 padding-left: 0.5em;
203 border-left: 2px solid silver;
206 div.exampleblock > div.content {
207 border-left: 2px solid silver;
208 padding: 0.5em;
211 div.imageblock div.content { padding-left: 0; }
212 span.image img { border-style: none; }
213 a.image:visited { color: white; }
215 dl {
216 margin-top: 0.8em;
217 margin-bottom: 0.8em;
219 dt {
220 margin-top: 0.5em;
221 margin-bottom: 0;
222 font-style: normal;
223 color: navy;
225 dd > *:first-child {
226 margin-top: 0.1em;
229 ul, ol {
230 list-style-position: outside;
232 ol.arabic {
233 list-style-type: decimal;
235 ol.loweralpha {
236 list-style-type: lower-alpha;
238 ol.upperalpha {
239 list-style-type: upper-alpha;
241 ol.lowerroman {
242 list-style-type: lower-roman;
244 ol.upperroman {
245 list-style-type: upper-roman;
248 div.compact ul, div.compact ol,
249 div.compact p, div.compact p,
250 div.compact div, div.compact div {
251 margin-top: 0.1em;
252 margin-bottom: 0.1em;
255 div.tableblock > table {
256 border: 3px solid #527bbd;
258 thead {
259 font-family: sans-serif;
260 font-weight: bold;
262 tfoot {
263 font-weight: bold;
265 td > div.verse {
266 white-space: pre;
268 p.table {
269 margin-top: 0;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div.tableblock > table[frame="void"] {
273 border-style: none;
275 div.tableblock > table[frame="hsides"] {
276 border-left-style: none;
277 border-right-style: none;
279 div.tableblock > table[frame="vsides"] {
280 border-top-style: none;
281 border-bottom-style: none;
285 div.hdlist {
286 margin-top: 0.8em;
287 margin-bottom: 0.8em;
289 div.hdlist tr {
290 padding-bottom: 15px;
292 dt.hdlist1.strong, td.hdlist1.strong {
293 font-weight: bold;
295 td.hdlist1 {
296 vertical-align: top;
297 font-style: normal;
298 padding-right: 0.8em;
299 color: navy;
301 td.hdlist2 {
302 vertical-align: top;
304 div.hdlist.compact tr {
305 margin: 0;
306 padding-bottom: 0;
309 .comment {
310 background: yellow;
313 @media print {
314 div#footer-badges { display: none; }
317 div#toctitle {
318 color: #527bbd;
319 font-family: sans-serif;
320 font-size: 1.1em;
321 font-weight: bold;
322 margin-top: 1.0em;
323 margin-bottom: 0.1em;
326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
327 margin-top: 0;
328 margin-bottom: 0;
330 div.toclevel2 {
331 margin-left: 2em;
332 font-size: 0.9em;
334 div.toclevel3 {
335 margin-left: 4em;
336 font-size: 0.9em;
338 div.toclevel4 {
339 margin-left: 6em;
340 font-size: 0.9em;
342 /* Overrides for manpage documents */
343 h1 {
344 padding-top: 0.5em;
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver;
347 border-bottom: 2px solid silver;
349 h2 {
350 border-style: none;
352 div.sectionbody {
353 margin-left: 5%;
356 @media print {
357 div#toc { display: none; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div.sidebar-content {
363 background: #ffffee;
364 border: 1px solid silver;
365 padding: 0.5em;
367 div.sidebar-title, div.image-title {
368 color: #527bbd;
369 font-family: sans-serif;
370 font-weight: bold;
371 margin-top: 0.0em;
372 margin-bottom: 0.5em;
375 div.listingblock div.content {
376 border: 1px solid silver;
377 background: #f4f4f4;
378 padding: 0.5em;
381 div.quoteblock-attribution {
382 padding-top: 0.5em;
383 text-align: right;
386 div.verseblock-content {
387 white-space: pre;
389 div.verseblock-attribution {
390 padding-top: 0.75em;
391 text-align: left;
394 div.exampleblock-content {
395 border-left: 2px solid silver;
396 padding-left: 0.5em;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc a:visited { color: blue; }
401 </style>
402 </head>
403 <body>
404 <div id="header">
405 <h1>
406 git-bundle(1) Manual Page
407 </h1>
408 <h2>NAME</h2>
409 <div class="sectionbody">
410 <p>git-bundle -
411 Move objects and refs by archive
412 </p>
413 </div>
414 </div>
415 <h2 id="_synopsis">SYNOPSIS</h2>
416 <div class="sectionbody">
417 <div class="verseblock">
418 <div class="verseblock-content"><em>git bundle</em> create &lt;file&gt; &lt;git-rev-list-args&gt;
419 <em>git bundle</em> verify &lt;file&gt;
420 <em>git bundle</em> list-heads &lt;file&gt; [&lt;refname&gt;&#8230;]
421 <em>git bundle</em> unbundle &lt;file&gt; [&lt;refname&gt;&#8230;]</div>
422 <div class="verseblock-attribution">
423 </div></div>
424 </div>
425 <h2 id="_description">DESCRIPTION</h2>
426 <div class="sectionbody">
427 <div class="paragraph"><p>Some workflows require that one or more branches of development on one
428 machine be replicated on another machine, but the two machines cannot
429 be directly connected, and therefore the interactive git protocols (git,
430 ssh, rsync, http) cannot be used. This command provides support for
431 <em>git fetch</em> and <em>git pull</em> to operate by packaging objects and references
432 in an archive at the originating machine, then importing those into
433 another repository using <em>git fetch</em> and <em>git pull</em>
434 after moving the archive by some means (e.g., by sneakernet). As no
435 direct connection between the repositories exists, the user must specify a
436 basis for the bundle that is held by the destination repository: the
437 bundle assumes that all objects in the basis are already in the
438 destination repository.</p></div>
439 </div>
440 <h2 id="_options">OPTIONS</h2>
441 <div class="sectionbody">
442 <div class="dlist"><dl>
443 <dt class="hdlist1">
444 create &lt;file&gt;
445 </dt>
446 <dd>
448 Used to create a bundle named <em>file</em>. This requires the
449 <em>git-rev-list-args</em> arguments to define the bundle contents.
450 </p>
451 </dd>
452 <dt class="hdlist1">
453 verify &lt;file&gt;
454 </dt>
455 <dd>
457 Used to check that a bundle file is valid and will apply
458 cleanly to the current repository. This includes checks on the
459 bundle format itself as well as checking that the prerequisite
460 commits exist and are fully linked in the current repository.
461 <em>git bundle</em> prints a list of missing commits, if any, and exits
462 with a non-zero status.
463 </p>
464 </dd>
465 <dt class="hdlist1">
466 list-heads &lt;file&gt;
467 </dt>
468 <dd>
470 Lists the references defined in the bundle. If followed by a
471 list of references, only references matching those given are
472 printed out.
473 </p>
474 </dd>
475 <dt class="hdlist1">
476 unbundle &lt;file&gt;
477 </dt>
478 <dd>
480 Passes the objects in the bundle to <em>git index-pack</em>
481 for storage in the repository, then prints the names of all
482 defined references. If a list of references is given, only
483 references matching those in the list are printed. This command is
484 really plumbing, intended to be called only by <em>git fetch</em>.
485 </p>
486 </dd>
487 <dt class="hdlist1">
488 &lt;git-rev-list-args&gt;
489 </dt>
490 <dd>
492 A list of arguments, acceptable to <em>git rev-parse</em> and
493 <em>git rev-list</em> (and containing a named ref, see SPECIFYING REFERENCES
494 below), that specifies the specific objects and references
495 to transport. For example, <tt>master&#126;10..master</tt> causes the
496 current master reference to be packaged along with all objects
497 added since its 10th ancestor commit. There is no explicit
498 limit to the number of references and objects that may be
499 packaged.
500 </p>
501 </dd>
502 <dt class="hdlist1">
503 [&lt;refname&gt;&#8230;]
504 </dt>
505 <dd>
507 A list of references used to limit the references reported as
508 available. This is principally of use to <em>git fetch</em>, which
509 expects to receive only those references asked for and not
510 necessarily everything in the pack (in this case, <em>git bundle</em> acts
511 like <em>git fetch-pack</em>).
512 </p>
513 </dd>
514 </dl></div>
515 </div>
516 <h2 id="_specifying_references">SPECIFYING REFERENCES</h2>
517 <div class="sectionbody">
518 <div class="paragraph"><p><em>git bundle</em> will only package references that are shown by
519 <em>git show-ref</em>: this includes heads, tags, and remote heads. References
520 such as <tt>master&#126;1</tt> cannot be packaged, but are perfectly suitable for
521 defining the basis. More than one reference may be packaged, and more
522 than one basis can be specified. The objects packaged are those not
523 contained in the union of the given bases. Each basis can be
524 specified explicitly (e.g. <tt>^master&#126;10</tt>), or implicitly (e.g.
525 <tt>master&#126;10..master</tt>, <tt>--since=10.days.ago master</tt>).</p></div>
526 <div class="paragraph"><p>It is very important that the basis used be held by the destination.
527 It is okay to err on the side of caution, causing the bundle file
528 to contain objects already in the destination, as these are ignored
529 when unpacking at the destination.</p></div>
530 </div>
531 <h2 id="_example">EXAMPLE</h2>
532 <div class="sectionbody">
533 <div class="paragraph"><p>Assume you want to transfer the history from a repository R1 on machine A
534 to another repository R2 on machine B.
535 For whatever reason, direct connection between A and B is not allowed,
536 but we can move data from A to B via some mechanism (CD, email, etc.).
537 We want to update R2 with development made on the branch master in R1.</p></div>
538 <div class="paragraph"><p>To bootstrap the process, you can first create a bundle that does not have
539 any basis. You can use a tag to remember up to what commit you last
540 processed, in order to make it easy to later update the other repository
541 with an incremental bundle:</p></div>
542 <div class="listingblock">
543 <div class="content">
544 <pre><tt>machineA$ cd R1
545 machineA$ git bundle create file.bundle master
546 machineA$ git tag -f lastR2bundle master</tt></pre>
547 </div></div>
548 <div class="paragraph"><p>Then you transfer file.bundle to the target machine B. If you are creating
549 the repository on machine B, then you can clone from the bundle as if it
550 were a remote repository instead of creating an empty repository and then
551 pulling or fetching objects from the bundle:</p></div>
552 <div class="listingblock">
553 <div class="content">
554 <pre><tt>machineB$ git clone /home/me/tmp/file.bundle R2</tt></pre>
555 </div></div>
556 <div class="paragraph"><p>This will define a remote called "origin" in the resulting repository that
557 lets you fetch and pull from the bundle. The $GIT_DIR/config file in R2 will
558 have an entry like this:</p></div>
559 <div class="listingblock">
560 <div class="content">
561 <pre><tt>[remote "origin"]
562 url = /home/me/tmp/file.bundle
563 fetch = refs/heads/*:refs/remotes/origin/*</tt></pre>
564 </div></div>
565 <div class="paragraph"><p>To update the resulting mine.git repository, you can fetch or pull after
566 replacing the bundle stored at /home/me/tmp/file.bundle with incremental
567 updates.</p></div>
568 <div class="paragraph"><p>After working some more in the original repository, you can create an
569 incremental bundle to update the other repository:</p></div>
570 <div class="listingblock">
571 <div class="content">
572 <pre><tt>machineA$ cd R1
573 machineA$ git bundle create file.bundle lastR2bundle..master
574 machineA$ git tag -f lastR2bundle master</tt></pre>
575 </div></div>
576 <div class="paragraph"><p>You then transfer the bundle to the other machine to replace
577 /home/me/tmp/file.bundle, and pull from it.</p></div>
578 <div class="listingblock">
579 <div class="content">
580 <pre><tt>machineB$ cd R2
581 machineB$ git pull</tt></pre>
582 </div></div>
583 <div class="paragraph"><p>If you know up to what commit the intended recipient repository should
584 have the necessary objects, you can use that knowledge to specify the
585 basis, giving a cut-off point to limit the revisions and objects that go
586 in the resulting bundle. The previous example used the lastR2bundle tag
587 for this purpose, but you can use any other options that you would give to
588 the <a href="git-log.html">git-log(1)</a> command. Here are more examples:</p></div>
589 <div class="paragraph"><p>You can use a tag that is present in both:</p></div>
590 <div class="listingblock">
591 <div class="content">
592 <pre><tt>$ git bundle create mybundle v1.0.0..master</tt></pre>
593 </div></div>
594 <div class="paragraph"><p>You can use a basis based on time:</p></div>
595 <div class="listingblock">
596 <div class="content">
597 <pre><tt>$ git bundle create mybundle --since=10.days master</tt></pre>
598 </div></div>
599 <div class="paragraph"><p>You can use the number of commits:</p></div>
600 <div class="listingblock">
601 <div class="content">
602 <pre><tt>$ git bundle create mybundle -10 master</tt></pre>
603 </div></div>
604 <div class="paragraph"><p>You can run <tt>git-bundle verify</tt> to see if you can extract from a bundle
605 that was created with a basis:</p></div>
606 <div class="listingblock">
607 <div class="content">
608 <pre><tt>$ git bundle verify mybundle</tt></pre>
609 </div></div>
610 <div class="paragraph"><p>This will list what commits you must have in order to extract from the
611 bundle and will error out if you do not have them.</p></div>
612 <div class="paragraph"><p>A bundle from a recipient repository&#8217;s point of view is just like a
613 regular repository which it fetches or pulls from. You can, for example, map
614 references when fetching:</p></div>
615 <div class="listingblock">
616 <div class="content">
617 <pre><tt>$ git fetch mybundle master:localRef</tt></pre>
618 </div></div>
619 <div class="paragraph"><p>You can also see what references it offers:</p></div>
620 <div class="listingblock">
621 <div class="content">
622 <pre><tt>$ git ls-remote mybundle</tt></pre>
623 </div></div>
624 </div>
625 <h2 id="_git">GIT</h2>
626 <div class="sectionbody">
627 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
628 </div>
629 <div id="footer">
630 <div id="footer-text">
631 Last updated 2011-03-15 23:30:13 UTC
632 </div>
633 </div>
634 </body>
635 </html>