Allow tracking branches to set up rebase by default.
[gitweb.git] / Documentation / git-bundle.txt
index 4ea9e85d5e7c9b9082c4892548ab798d23f30e6d..505ac056e6586e0b4b19e5a8bbbb4bef86b6faf0 100644 (file)
@@ -8,6 +8,7 @@ git-bundle - Move objects and refs by archive
 
 SYNOPSIS
 --------
+[verse]
 'git-bundle' create <file> [git-rev-list args]
 'git-bundle' verify <file>
 'git-bundle' list-heads <file> [refname...]
@@ -19,10 +20,10 @@ DESCRIPTION
 Some workflows require that one or more branches of development on one
 machine be replicated on another machine, but the two machines cannot
 be directly connected so the interactive git protocols (git, ssh,
-rsync, http) cannot be used.  This command provides suport for
+rsync, http) cannot be used.  This command provides support for
 git-fetch and git-pull to operate by packaging objects and references
 in an archive at the originating machine, then importing those into
-another repository using gitlink:git-fetch[1] and gitlink:git-pull[1]
+another repository using linkgit:git-fetch[1] and linkgit:git-pull[1]
 after moving the archive by some means (i.e., by sneakernet).  As no
 direct connection between repositories exists, the user must specify a
 basis for the bundle that is held by the destination repository: the
@@ -50,15 +51,15 @@ list-heads <file>::
        printed out.
 
 unbundle <file>::
-       Passes the objects in the bundle to gitlink:git-index-pack[1]
+       Passes the objects in the bundle to linkgit:git-index-pack[1]
        for storage in the repository, then prints the names of all
        defined references. If a reflist is given, only references
        matching those in the given list are printed. This command is
        really plumbing, intended to be called only by
-       gitlink:git-fetch[1].
+       linkgit:git-fetch[1].
 
 [git-rev-list-args...]::
-       A list of arguments, accepatble to git-rev-parse and
+       A list of arguments, acceptable to git-rev-parse and
        git-rev-list, that specify the specific objects and references
        to transport.  For example, "master~10..master" causes the
        current master reference to be packaged along with all objects
@@ -70,9 +71,9 @@ unbundle <file>::
 [refname...]::
        A list of references used to limit the references reported as
        available. This is principally of use to git-fetch, which
-       expects to recieve only those references asked for and not
+       expects to receive only those references asked for and not
        necessarily everything in the pack (in this case, git-bundle is
-       acting like gitlink:git-fetch-pack[1]).
+       acting like linkgit:git-fetch-pack[1]).
 
 SPECIFYING REFERENCES
 ---------------------
@@ -87,7 +88,7 @@ specified explicitly (e.g., ^master~10), or implicitly (e.g.,
 master~10..master, master --since=10.days.ago).
 
 It is very important that the basis used be held by the destination.
-It is ok to err on the side of conservatism, causing the bundle file
+It is okay to err on the side of conservatism, causing the bundle file
 to contain objects already in the destination as these are ignored
 when unpacking at the destination.
 
@@ -98,34 +99,68 @@ Assume two repositories exist as R1 on machine A, and R2 on machine B.
 For whatever reason, direct connection between A and B is not allowed,
 but we can move data from A to B via some mechanism (CD, email, etc).
 We want to update R2 with developments made on branch master in R1.
+
+To create the bundle you have to specify the basis. You have some options:
+
+- Without basis.
++
+This is useful when sending the whole history.
+
+------------
+$ git bundle create mybundle master
+------------
+
+- Using temporally tags.
++
 We set a tag in R1 (lastR2bundle) after the previous such transport,
 and move it afterwards to help build the bundle.
 
-in R1 on A:
+------------
 $ git-bundle create mybundle master ^lastR2bundle
 $ git tag -f lastR2bundle master
+------------
 
-(move mybundle from A to B by some mechanism)
+- Using a tag present in both repositories
 
-in R2 on B:
-$ git-bundle verify mybundle
-$ git-fetch mybundle  refspec
+------------
+$ git bundle create mybundle master ^v1.0.0
+------------
 
-where refspec is refInBundle:localRef
+- A basis based on time.
 
+------------
+$ git bundle create mybundle master --since=10.days.ago
+------------
+
+- With a limit on the number of commits
+
+------------
+$ git bundle create mybundle master -n 10
+------------
+
+Then you move mybundle from A to B, and in R2 on B:
+
+------------
+$ git-bundle verify mybundle
+$ git-fetch mybundle master:localRef
+------------
 
-Also, with something like this in your config:
+With something like this in the config in R2:
 
+------------------------
 [remote "bundle"]
     url = /home/me/tmp/file.bdl
     fetch = refs/heads/*:refs/remotes/origin/*
+------------------------
 
 You can first sneakernet the bundle file to ~/tmp/file.bdl and
-then these commands:
+then these commands on machine B:
 
+------------
 $ git ls-remote bundle
 $ git fetch bundle
 $ git pull bundle
+------------
 
 would treat it as if it is talking with a remote side over the
 network.
@@ -136,4 +171,4 @@ Written by Mark Levedahl <mdl123@verizon.net>
 
 GIT
 ---
-Part of the gitlink:git[7] suite
+Part of the linkgit:git[7] suite