Documentation: updates to "Everyday GIT"
[git/gitweb.git] / git-clone.sh
blob24b119537bf5ed926235aabfceb8e4526af6f77a
1 #!/bin/sh
3 # Copyright (c) 2005, Linus Torvalds
4 # Copyright (c) 2005, Junio C Hamano
5 #
6 # Clone a repository into a different directory that does not yet exist.
8 # See git-sh-setup why.
9 unset CDPATH
11 usage() {
12 echo >&2 "Usage: $0 [--template=<template_directory>] [--use-separate-remote] [--reference <reference-repo>] [--bare] [-l [-s]] [-q] [-u <upload-pack>] [--origin <name>] [-n] <repo> [<dir>]"
13 exit 1
16 get_repo_base() {
17 (cd "$1" && (cd .git ; pwd)) 2> /dev/null
20 if [ -n "$GIT_SSL_NO_VERIFY" ]; then
21 curl_extra_args="-k"
24 http_fetch () {
25 # $1 = Remote, $2 = Local
26 curl -nsfL $curl_extra_args "$1" >"$2"
29 clone_dumb_http () {
30 # $1 - remote, $2 - local
31 cd "$2" &&
32 clone_tmp="$GIT_DIR/clone-tmp" &&
33 mkdir -p "$clone_tmp" || exit 1
34 if [ -n "$GIT_CURL_FTP_NO_EPSV" -o \
35 "`git-repo-config --bool http.noEPSV`" = true ]; then
36 curl_extra_args="${curl_extra_args} --disable-epsv"
38 http_fetch "$1/info/refs" "$clone_tmp/refs" || {
39 echo >&2 "Cannot get remote repository information.
40 Perhaps git-update-server-info needs to be run there?"
41 exit 1;
43 while read sha1 refname
45 name=`expr "z$refname" : 'zrefs/\(.*\)'` &&
46 case "$name" in
47 *^*) continue;;
48 esac
49 if test -n "$use_separate_remote" &&
50 branch_name=`expr "z$name" : 'zheads/\(.*\)'`
51 then
52 tname="remotes/$origin/$branch_name"
53 else
54 tname=$name
56 git-http-fetch -v -a -w "$tname" "$name" "$1/" || exit 1
57 done <"$clone_tmp/refs"
58 rm -fr "$clone_tmp"
59 http_fetch "$1/HEAD" "$GIT_DIR/REMOTE_HEAD" ||
60 rm -f "$GIT_DIR/REMOTE_HEAD"
63 # Read git-fetch-pack -k output and store the remote branches.
64 copy_refs='
65 use File::Path qw(mkpath);
66 use File::Basename qw(dirname);
67 my $git_dir = $ARGV[0];
68 my $use_separate_remote = $ARGV[1];
69 my $origin = $ARGV[2];
71 my $branch_top = ($use_separate_remote ? "remotes/$origin" : "heads");
72 my $tag_top = "tags";
74 sub store {
75 my ($sha1, $name, $top) = @_;
76 $name = "$git_dir/refs/$top/$name";
77 mkpath(dirname($name));
78 open O, ">", "$name";
79 print O "$sha1\n";
80 close O;
83 open FH, "<", "$git_dir/CLONE_HEAD";
84 while (<FH>) {
85 my ($sha1, $name) = /^([0-9a-f]{40})\s(.*)$/;
86 next if ($name =~ /\^\173/);
87 if ($name eq "HEAD") {
88 open O, ">", "$git_dir/REMOTE_HEAD";
89 print O "$sha1\n";
90 close O;
91 next;
93 if ($name =~ s/^refs\/heads\///) {
94 store($sha1, $name, $branch_top);
95 next;
97 if ($name =~ s/^refs\/tags\///) {
98 store($sha1, $name, $tag_top);
99 next;
102 close FH;
105 quiet=
106 local=no
107 use_local=no
108 local_shared=no
109 unset template
110 no_checkout=
111 upload_pack=
112 bare=
113 reference=
114 origin=
115 origin_override=
116 use_separate_remote=
117 while
118 case "$#,$1" in
119 0,*) break ;;
120 *,-n|*,--no|*,--no-|*,--no-c|*,--no-ch|*,--no-che|*,--no-chec|\
121 *,--no-check|*,--no-checko|*,--no-checkou|*,--no-checkout)
122 no_checkout=yes ;;
123 *,--na|*,--nak|*,--nake|*,--naked|\
124 *,-b|*,--b|*,--ba|*,--bar|*,--bare) bare=yes ;;
125 *,-l|*,--l|*,--lo|*,--loc|*,--loca|*,--local) use_local=yes ;;
126 *,-s|*,--s|*,--sh|*,--sha|*,--shar|*,--share|*,--shared)
127 local_shared=yes; use_local=yes ;;
128 1,--template) usage ;;
129 *,--template)
130 shift; template="--template=$1" ;;
131 *,--template=*)
132 template="$1" ;;
133 *,-q|*,--quiet) quiet=-q ;;
134 *,--use-separate-remote)
135 use_separate_remote=t ;;
136 1,--reference) usage ;;
137 *,--reference)
138 shift; reference="$1" ;;
139 *,--reference=*)
140 reference=`expr "z$1" : 'z--reference=\(.*\)'` ;;
141 *,-o|*,--or|*,--ori|*,--orig|*,--origi|*,--origin)
142 case "$2" in
144 usage ;;
145 */*)
146 echo >&2 "'$2' is not suitable for an origin name"
147 exit 1
148 esac
149 git-check-ref-format "heads/$2" || {
150 echo >&2 "'$2' is not suitable for a branch name"
151 exit 1
153 test -z "$origin_override" || {
154 echo >&2 "Do not give more than one --origin options."
155 exit 1
157 origin_override=yes
158 origin="$2"; shift
160 1,-u|1,--upload-pack) usage ;;
161 *,-u|*,--upload-pack)
162 shift
163 upload_pack="--exec=$1" ;;
164 *,-*) usage ;;
165 *) break ;;
166 esac
168 shift
169 done
171 repo="$1"
172 if test -z "$repo"
173 then
174 echo >&2 'you must specify a repository to clone.'
175 exit 1
178 # --bare implies --no-checkout
179 if test yes = "$bare"
180 then
181 if test yes = "$origin_override"
182 then
183 echo >&2 '--bare and --origin $origin options are incompatible.'
184 exit 1
186 if test t = "$use_separate_remote"
187 then
188 echo >&2 '--bare and --use-separate-remote options are incompatible.'
189 exit 1
191 no_checkout=yes
194 if test -z "$origin"
195 then
196 origin=origin
199 # Turn the source into an absolute path if
200 # it is local
201 if base=$(get_repo_base "$repo"); then
202 repo="$base"
203 local=yes
206 dir="$2"
207 # Try using "humanish" part of source repo if user didn't specify one
208 [ -z "$dir" ] && dir=$(echo "$repo" | sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
209 [ -e "$dir" ] && echo "$dir already exists." && usage
210 mkdir -p "$dir" &&
211 D=$(cd "$dir" && pwd) &&
212 trap 'err=$?; cd ..; rm -rf "$D"; exit $err' 0
213 case "$bare" in
214 yes)
215 GIT_DIR="$D" ;;
217 GIT_DIR="$D/.git" ;;
218 esac && export GIT_DIR && git-init-db ${template+"$template"} || usage
220 if test -n "$reference"
221 then
222 if test -d "$reference"
223 then
224 if test -d "$reference/.git/objects"
225 then
226 reference="$reference/.git"
228 reference=$(cd "$reference" && pwd)
229 echo "$reference/objects" >"$GIT_DIR/objects/info/alternates"
230 (cd "$reference" && tar cf - refs) |
231 (cd "$GIT_DIR/refs" &&
232 mkdir reference-tmp &&
233 cd reference-tmp &&
234 tar xf -)
235 else
236 echo >&2 "$reference: not a local directory." && usage
240 rm -f "$GIT_DIR/CLONE_HEAD"
242 # We do local magic only when the user tells us to.
243 case "$local,$use_local" in
244 yes,yes)
245 ( cd "$repo/objects" ) || {
246 echo >&2 "-l flag seen but $repo is not local."
247 exit 1
250 case "$local_shared" in
252 # See if we can hardlink and drop "l" if not.
253 sample_file=$(cd "$repo" && \
254 find objects -type f -print | sed -e 1q)
256 # objects directory should not be empty since we are cloning!
257 test -f "$repo/$sample_file" || exit
260 if ln "$repo/$sample_file" "$GIT_DIR/objects/sample" 2>/dev/null
261 then
263 fi &&
264 rm -f "$GIT_DIR/objects/sample" &&
265 cd "$repo" &&
266 find objects -depth -print | cpio -pumd$l "$GIT_DIR/" || exit 1
268 yes)
269 mkdir -p "$GIT_DIR/objects/info"
270 echo "$repo/objects" >> "$GIT_DIR/objects/info/alternates"
272 esac
273 git-ls-remote "$repo" >"$GIT_DIR/CLONE_HEAD" || exit 1
276 case "$repo" in
277 rsync://*)
278 rsync $quiet -av --ignore-existing \
279 --exclude info "$repo/objects/" "$GIT_DIR/objects/" ||
280 exit
281 # Look at objects/info/alternates for rsync -- http will
282 # support it natively and git native ones will do it on the
283 # remote end. Not having that file is not a crime.
284 rsync -q "$repo/objects/info/alternates" \
285 "$GIT_DIR/TMP_ALT" 2>/dev/null ||
286 rm -f "$GIT_DIR/TMP_ALT"
287 if test -f "$GIT_DIR/TMP_ALT"
288 then
289 ( cd "$D" &&
290 . git-parse-remote &&
291 resolve_alternates "$repo" <"$GIT_DIR/TMP_ALT" ) |
292 while read alt
294 case "$alt" in 'bad alternate: '*) die "$alt";; esac
295 case "$quiet" in
296 '') echo >&2 "Getting alternate: $alt" ;;
297 esac
298 rsync $quiet -av --ignore-existing \
299 --exclude info "$alt" "$GIT_DIR/objects" || exit
300 done
301 rm -f "$GIT_DIR/TMP_ALT"
303 git-ls-remote "$repo" >"$GIT_DIR/CLONE_HEAD" || exit 1
305 https://*|http://*|ftp://*)
306 if test -z "@@NO_CURL@@"
307 then
308 clone_dumb_http "$repo" "$D"
309 else
310 echo >&2 "http transport not supported, rebuild Git with curl support"
311 exit 1
315 case "$upload_pack" in
316 '') git-fetch-pack --all -k $quiet "$repo" ;;
317 *) git-fetch-pack --all -k $quiet "$upload_pack" "$repo" ;;
318 esac >"$GIT_DIR/CLONE_HEAD" || {
319 echo >&2 "fetch-pack from '$repo' failed."
320 exit 1
323 esac
325 esac
326 test -d "$GIT_DIR/refs/reference-tmp" && rm -fr "$GIT_DIR/refs/reference-tmp"
328 if test -f "$GIT_DIR/CLONE_HEAD"
329 then
330 # Read git-fetch-pack -k output and store the remote branches.
331 @@PERL@@ -e "$copy_refs" "$GIT_DIR" "$use_separate_remote" "$origin" ||
332 exit
335 cd "$D" || exit
337 if test -z "$bare" && test -f "$GIT_DIR/REMOTE_HEAD"
338 then
339 # Figure out which remote branch HEAD points at.
340 case "$use_separate_remote" in
341 '') remote_top=refs/heads ;;
342 *) remote_top="refs/remotes/$origin" ;;
343 esac
345 head_sha1=`cat "$GIT_DIR/REMOTE_HEAD"`
346 case "$head_sha1" in
347 'ref: refs/'*)
348 # Uh-oh, the remote told us (http transport done against
349 # new style repository with a symref HEAD).
350 # Ideally we should skip the guesswork but for now
351 # opt for minimum change.
352 head_sha1=`expr "z$head_sha1" : 'zref: refs/heads/\(.*\)'`
353 head_sha1=`cat "$GIT_DIR/$remote_top/$head_sha1"`
355 esac
357 # The name under $remote_top the remote HEAD seems to point at.
358 head_points_at=$(
360 echo "master"
361 cd "$GIT_DIR/$remote_top" &&
362 find . -type f -print | sed -e 's/^\.\///'
363 ) | (
364 done=f
365 while read name
367 test t = $done && continue
368 branch_tip=`cat "$GIT_DIR/$remote_top/$name"`
369 if test "$head_sha1" = "$branch_tip"
370 then
371 echo "$name"
372 done=t
374 done
378 # Write out remotes/$origin file, and update our "$head_points_at".
379 case "$head_points_at" in
381 mkdir -p "$GIT_DIR/remotes" &&
382 git-symbolic-ref HEAD "refs/heads/$head_points_at" &&
383 case "$use_separate_remote" in
384 t) origin_track="$remote_top/$head_points_at"
385 git-update-ref HEAD "$head_sha1" ;;
386 *) origin_track="$remote_top/$origin"
387 git-update-ref "refs/heads/$origin" "$head_sha1" ;;
388 esac &&
389 echo >"$GIT_DIR/remotes/$origin" \
390 "URL: $repo
391 Pull: refs/heads/$head_points_at:$origin_track" &&
392 (cd "$GIT_DIR/$remote_top" && find . -type f -print) |
393 while read dotslref
395 name=`expr "$dotslref" : './\(.*\)'`
396 if test "z$head_points_at" = "z$name"
397 then
398 continue
400 if test "$use_separate_remote" = '' &&
401 test "z$origin" = "z$name"
402 then
403 continue
405 echo "Pull: refs/heads/${name}:$remote_top/${name}"
406 done >>"$GIT_DIR/remotes/$origin" &&
407 case "$use_separate_remote" in
409 rm -f "refs/remotes/$origin/HEAD"
410 git-symbolic-ref "refs/remotes/$origin/HEAD" \
411 "refs/remotes/$origin/$head_points_at"
412 esac
413 esac
415 case "$no_checkout" in
417 test "z$quiet" = z && v=-v || v=
418 git-read-tree -m -u $v HEAD HEAD
419 esac
421 rm -f "$GIT_DIR/CLONE_HEAD" "$GIT_DIR/REMOTE_HEAD"
423 trap - 0