aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-clone.txt
diff options
context:
space:
mode:
authorDerrick Stolee <derrickstolee@github.com>2022-08-09 13:11:41 +0000
committerJunio C Hamano <gitster@pobox.com>2022-08-10 14:07:37 -0700
commit55568919616429fbc209880cf189a3adaceb6093 (patch)
treead443684968b415f4be585093bbc320e98671c5e /Documentation/git-clone.txt
parent53a50892be20a91fb0dcf572a641ce2a79af1a38 (diff)
downloadgit-55568919616429fbc209880cf189a3adaceb6093.tar.gz
clone: add --bundle-uri option
Cloning a remote repository is one of the most expensive operations in Git. The server can spend a lot of CPU time generating a pack-file for the client's request. The amount of data can clog the network for a long time, and the Git protocol is not resumable. For users with poor network connections or are located far away from the origin server, this can be especially painful. Add a new '--bundle-uri' option to 'git clone' to bootstrap a clone from a bundle. If the user is aware of a bundle server, then they can tell Git to bootstrap the new repository with these bundles before fetching the remaining objects from the origin server. Reviewed-by: Josh Steadmon <steadmon@google.com> Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-clone.txt')
-rw-r--r--Documentation/git-clone.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 632bd1348e..60fedf7eb5 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -323,6 +323,12 @@ or `--mirror` is given)
for `host.xz:foo/.git`). Cloning into an existing directory
is only allowed if the directory is empty.
+--bundle-uri=<uri>::
+ Before fetching from the remote, fetch a bundle from the given
+ `<uri>` and unbundle the data into the local repository. The refs
+ in the bundle will be stored under the hidden `refs/bundle/*`
+ namespace.
+
:git-clone: 1
include::urls.txt[]