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">
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">
10 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
12 border: 1px solid red;
17 margin: 1em 5% 1em 5%;
22 text-decoration: underline
;
42 h1
, h2
, h3
, h4
, h5
, h6
{
44 font-family: sans-serif
;
51 border-bottom: 2px solid silver
;
69 border: 1px solid silver
;
88 font-family: sans-serif
;
94 span#revnumber
, span#revdate
, span#revremark
{
95 font-family: sans-serif
;
99 font-family: sans-serif
;
101 border-top: 2px solid silver
;
107 padding-bottom: 0.5em;
111 padding-bottom: 0.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
{
122 margin-bottom: 1.5em;
124 div
.admonitionblock
{
126 margin-bottom: 2.5em;
129 div
.content
{ /* Block element content. */
133 /* Block element titles. */
134 div
.title
, caption
.title
{
136 font-family: sans-serif
;
140 margin-bottom: 0.5em;
146 td div
.title:first-child
{
149 div
.content div
.title:first-child
{
152 div
.content
+ div
.title
{
156 div
.sidebarblock
> div
.content
{
158 border: 1px solid silver
;
162 div
.listingblock
> div
.content
{
163 border: 1px solid silver
;
172 div
.quoteblock
> div
.attribution
{
181 div
.verseblock
> div
.content
{
184 div
.verseblock
> div
.attribution
{
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
189 div
.verseblock
+ div
.attribution
{
193 div
.admonitionblock
.icon
{
197 text-decoration: underline
;
199 padding-right: 0.5em;
201 div
.admonitionblock td
.content
{
203 border-left: 2px solid silver
;
206 div
.exampleblock
> div
.content
{
207 border-left: 2px solid silver
;
211 div
.imageblock div
.content
{ padding-left: 0; }
212 span
.image img
{ border-style: none
; }
213 a
.image:visited
{ color: white
; }
217 margin-bottom: 0.8em;
230 list-style-position: outside
;
233 list-style-type: decimal
;
236 list-style-type: lower-alpha
;
239 list-style-type: upper-alpha
;
242 list-style-type: lower-roman
;
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
{
252 margin-bottom: 0.1em;
255 div
.tableblock
> table
{
256 border: 3px solid
#527bbd;
259 font-family: sans-serif
;
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
272 div
.tableblock
> table
[frame
="void"] {
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
;
287 margin-bottom: 0.8em;
290 padding-bottom: 15px;
292 dt
.hdlist1
.strong
, td
.hdlist1
.strong
{
298 padding-right: 0.8em;
304 div
.hdlist
.compact tr
{
314 div#footer-badges
{ display: none
; }
319 font-family: sans-serif
;
323 margin-bottom: 0.1em;
326 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
342 /* Overrides for manpage documents */
345 padding-bottom: 0.5em;
346 border-top: 2px solid silver
;
347 border-bottom: 2px solid silver
;
357 div#toc
{ display: none
; }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
362 div
.sidebar-content
{
364 border: 1px solid silver
;
367 div
.sidebar-title
, div
.image-title
{
369 font-family: sans-serif
;
372 margin-bottom: 0.5em;
375 div
.listingblock div
.content
{
376 border: 1px solid silver
;
381 div
.quoteblock-attribution
{
386 div
.verseblock-content
{
389 div
.verseblock-attribution
{
394 div
.exampleblock-content
{
395 border-left: 2px solid silver
;
399 /* IE6 sets dynamically generated links as visited. */
400 div#toc
a:visited
{ color: blue
; }
406 git-bundle(
1) Manual Page
409 <div class=
"sectionbody">
411 Move objects and refs by archive
415 <h2 id=
"_synopsis">SYNOPSIS
</h2>
416 <div class=
"sectionbody">
417 <div class=
"verseblock">
418 <div class=
"verseblock-content"><em>git bundle
</em> create
<file
> <git-rev-list-args
>
419 <em>git bundle
</em> verify
<file
>
420 <em>git bundle
</em> list-heads
<file
> [
<refname
>…]
421 <em>git bundle
</em> unbundle
<file
> [
<refname
>…]
</div>
422 <div class=
"verseblock-attribution">
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>
440 <h2 id=
"_options">OPTIONS
</h2>
441 <div class=
"sectionbody">
442 <div class=
"dlist"><dl>
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.
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.
466 list-heads
<file
>
470 Lists the references defined in the bundle. If followed by a
471 list of references, only references matching those given are
476 unbundle
<file
>
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>.
488 <git-rev-list-args
>
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
~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
503 [
<refname
>…]
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>).
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
~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
~10</tt>), or implicitly (e.g.
525 <tt>master
~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>
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>
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>
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>
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
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>
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>
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>
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>
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>
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>
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
’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>
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>
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>
630 <div id=
"footer-text">
631 Last updated
2011-
03-
15 23:
30:
13 UTC