aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-bundle.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2019-12-10 13:11:41 -0800
committerJunio C Hamano <gitster@pobox.com>2019-12-10 13:11:41 -0800
commit7c887142621106a303a321b51b1958112ed2bf24 (patch)
tree4a0d98cf14bb1c42b7c41490c369725af2565354 /Documentation/git-bundle.txt
parent5d9324e0f4210bb7d52bcb79efe3935703083f72 (diff)
parent0e40a73a4c768c220dabf14f173f33c87a4f4829 (diff)
downloadgit-7c887142621106a303a321b51b1958112ed2bf24.tar.gz
Merge branch 'po/bundle-doc-clonable'
Doc update. * po/bundle-doc-clonable: Doc: Bundle file usage
Diffstat (limited to 'Documentation/git-bundle.txt')
-rw-r--r--Documentation/git-bundle.txt23
1 files changed, 17 insertions, 6 deletions
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index ccada80a4a..d34b0964be 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -20,11 +20,14 @@ 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, and therefore the interactive Git protocols (git,
-ssh, 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 'git fetch' and 'git pull'
-after moving the archive by some means (e.g., by sneakernet). As no
+ssh, http) cannot be used.
+
+The 'git bundle' command packages objects and references in an archive
+at the originating machine, which can then be imported into another
+repository using 'git fetch', 'git pull', or 'git clone',
+after moving the archive by some means (e.g., by sneakernet).
+
+As no
direct connection between the repositories exists, the user must specify a
basis for the bundle that is held by the destination repository: the
bundle assumes that all objects in the basis are already in the
@@ -35,7 +38,7 @@ OPTIONS
create [options] <file> <git-rev-list-args>::
Used to create a bundle named 'file'. This requires the
- 'git-rev-list-args' arguments to define the bundle contents.
+ '<git-rev-list-args>' arguments to define the bundle contents.
'options' contains the options specific to the 'git bundle create'
subcommand.
@@ -121,6 +124,14 @@ It is okay to err on the side of caution, causing the bundle file
to contain objects already in the destination, as these are ignored
when unpacking at the destination.
+`git clone` can use any bundle created without negative refspecs
+(e.g., `new`, but not `old..new`).
+If you want to match `git clone --mirror`, which would include your
+refs such as `refs/remotes/*`, use `--all`.
+If you want to provide the same set of refs that a clone directly
+from the source repository would get, use `--branches --tags` for
+the `<git-rev-list-args>`.
+
EXAMPLES
--------