git-checkout: rewording comments regarding detached HEAD.
[git/dscho.git] / git-clone.sh
blob3d388de62a9ee212c8f54f3a5dc9a8b823bc8934
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 die() {
12 echo >&2 "$@"
13 exit 1
16 usage() {
17 die "Usage: $0 [--template=<template_directory>] [--reference <reference-repo>] [--bare] [-l [-s]] [-q] [-u <upload-pack>] [--origin <name>] [--depth <n>] [-n] <repo> [<dir>]"
20 get_repo_base() {
21 (cd "$1" && (cd .git ; pwd)) 2> /dev/null
24 if [ -n "$GIT_SSL_NO_VERIFY" ]; then
25 curl_extra_args="-k"
28 http_fetch () {
29 # $1 = Remote, $2 = Local
30 curl -nsfL $curl_extra_args "$1" >"$2"
33 clone_dumb_http () {
34 # $1 - remote, $2 - local
35 cd "$2" &&
36 clone_tmp="$GIT_DIR/clone-tmp" &&
37 mkdir -p "$clone_tmp" || exit 1
38 if [ -n "$GIT_CURL_FTP_NO_EPSV" -o \
39 "`git-repo-config --bool http.noEPSV`" = true ]; then
40 curl_extra_args="${curl_extra_args} --disable-epsv"
42 http_fetch "$1/info/refs" "$clone_tmp/refs" ||
43 die "Cannot get remote repository information.
44 Perhaps git-update-server-info needs to be run there?"
45 while read sha1 refname
47 name=`expr "z$refname" : 'zrefs/\(.*\)'` &&
48 case "$name" in
49 *^*) continue;;
50 esac
51 case "$bare,$name" in
52 yes,* | ,heads/* | ,tags/*) ;;
53 *) continue ;;
54 esac
55 if test -n "$use_separate_remote" &&
56 branch_name=`expr "z$name" : 'zheads/\(.*\)'`
57 then
58 tname="remotes/$origin/$branch_name"
59 else
60 tname=$name
62 git-http-fetch -v -a -w "$tname" "$name" "$1/" || exit 1
63 done <"$clone_tmp/refs"
64 rm -fr "$clone_tmp"
65 http_fetch "$1/HEAD" "$GIT_DIR/REMOTE_HEAD" ||
66 rm -f "$GIT_DIR/REMOTE_HEAD"
69 # Read git-fetch-pack -k output and store the remote branches.
70 copy_refs='
71 use File::Path qw(mkpath);
72 use File::Basename qw(dirname);
73 my $git_dir = $ARGV[0];
74 my $use_separate_remote = $ARGV[1];
75 my $origin = $ARGV[2];
77 my $branch_top = ($use_separate_remote ? "remotes/$origin" : "heads");
78 my $tag_top = "tags";
80 sub store {
81 my ($sha1, $name, $top) = @_;
82 $name = "$git_dir/refs/$top/$name";
83 mkpath(dirname($name));
84 open O, ">", "$name";
85 print O "$sha1\n";
86 close O;
89 open FH, "<", "$git_dir/CLONE_HEAD";
90 while (<FH>) {
91 my ($sha1, $name) = /^([0-9a-f]{40})\s(.*)$/;
92 next if ($name =~ /\^\173/);
93 if ($name eq "HEAD") {
94 open O, ">", "$git_dir/REMOTE_HEAD";
95 print O "$sha1\n";
96 close O;
97 next;
99 if ($name =~ s/^refs\/heads\///) {
100 store($sha1, $name, $branch_top);
101 next;
103 if ($name =~ s/^refs\/tags\///) {
104 store($sha1, $name, $tag_top);
105 next;
108 close FH;
111 quiet=
112 local=no
113 use_local=no
114 local_shared=no
115 unset template
116 no_checkout=
117 upload_pack=
118 bare=
119 reference=
120 origin=
121 origin_override=
122 use_separate_remote=t
123 depth=
124 while
125 case "$#,$1" in
126 0,*) break ;;
127 *,-n|*,--no|*,--no-|*,--no-c|*,--no-ch|*,--no-che|*,--no-chec|\
128 *,--no-check|*,--no-checko|*,--no-checkou|*,--no-checkout)
129 no_checkout=yes ;;
130 *,--na|*,--nak|*,--nake|*,--naked|\
131 *,-b|*,--b|*,--ba|*,--bar|*,--bare) bare=yes ;;
132 *,-l|*,--l|*,--lo|*,--loc|*,--loca|*,--local) use_local=yes ;;
133 *,-s|*,--s|*,--sh|*,--sha|*,--shar|*,--share|*,--shared)
134 local_shared=yes; use_local=yes ;;
135 1,--template) usage ;;
136 *,--template)
137 shift; template="--template=$1" ;;
138 *,--template=*)
139 template="$1" ;;
140 *,-q|*,--quiet) quiet=-q ;;
141 *,--use-separate-remote) ;;
142 *,--no-separate-remote)
143 die "clones are always made with separate-remote layout" ;;
144 1,--reference) usage ;;
145 *,--reference)
146 shift; reference="$1" ;;
147 *,--reference=*)
148 reference=`expr "z$1" : 'z--reference=\(.*\)'` ;;
149 *,-o|*,--or|*,--ori|*,--orig|*,--origi|*,--origin)
150 case "$2" in
152 usage ;;
153 */*)
154 die "'$2' is not suitable for an origin name"
155 esac
156 git-check-ref-format "heads/$2" ||
157 die "'$2' is not suitable for a branch name"
158 test -z "$origin_override" ||
159 die "Do not give more than one --origin options."
160 origin_override=yes
161 origin="$2"; shift
163 1,-u|1,--upload-pack) usage ;;
164 *,-u|*,--upload-pack)
165 shift
166 upload_pack="--exec=$1" ;;
167 1,--depth) usage;;
168 *,--depth)
169 shift
170 depth="--depth=$1";;
171 *,-*) usage ;;
172 *) break ;;
173 esac
175 shift
176 done
178 repo="$1"
179 test -n "$repo" ||
180 die 'you must specify a repository to clone.'
182 # --bare implies --no-checkout and --no-separate-remote
183 if test yes = "$bare"
184 then
185 if test yes = "$origin_override"
186 then
187 die '--bare and --origin $origin options are incompatible.'
189 no_checkout=yes
190 use_separate_remote=
193 if test -z "$origin"
194 then
195 origin=origin
198 # Turn the source into an absolute path if
199 # it is local
200 if base=$(get_repo_base "$repo"); then
201 repo="$base"
202 local=yes
205 dir="$2"
206 # Try using "humanish" part of source repo if user didn't specify one
207 [ -z "$dir" ] && dir=$(echo "$repo" | sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
208 [ -e "$dir" ] && die "destination directory '$dir' already exists."
209 mkdir -p "$dir" &&
210 D=$(cd "$dir" && pwd) &&
211 trap 'err=$?; cd ..; rm -rf "$D"; exit $err' 0
212 case "$bare" in
213 yes)
214 GIT_DIR="$D" ;;
216 GIT_DIR="$D/.git" ;;
217 esac && export GIT_DIR && git-init-db ${template+"$template"} || usage
219 if test -n "$reference"
220 then
221 if test -d "$reference"
222 then
223 if test -d "$reference/.git/objects"
224 then
225 reference="$reference/.git"
227 reference=$(cd "$reference" && pwd)
228 echo "$reference/objects" >"$GIT_DIR/objects/info/alternates"
229 (cd "$reference" && tar cf - refs) |
230 (cd "$GIT_DIR/refs" &&
231 mkdir reference-tmp &&
232 cd reference-tmp &&
233 tar xf -)
234 else
235 die "reference repository '$reference' is not a local directory."
239 rm -f "$GIT_DIR/CLONE_HEAD"
241 # We do local magic only when the user tells us to.
242 case "$local,$use_local" in
243 yes,yes)
244 ( cd "$repo/objects" ) ||
245 die "-l flag seen but repository '$repo' is not local."
247 case "$local_shared" in
249 # See if we can hardlink and drop "l" if not.
250 sample_file=$(cd "$repo" && \
251 find objects -type f -print | sed -e 1q)
253 # objects directory should not be empty since we are cloning!
254 test -f "$repo/$sample_file" || exit
257 if ln "$repo/$sample_file" "$GIT_DIR/objects/sample" 2>/dev/null
258 then
260 fi &&
261 rm -f "$GIT_DIR/objects/sample" &&
262 cd "$repo" &&
263 find objects -depth -print | cpio -pumd$l "$GIT_DIR/" || exit 1
265 yes)
266 mkdir -p "$GIT_DIR/objects/info"
267 echo "$repo/objects" >> "$GIT_DIR/objects/info/alternates"
269 esac
270 git-ls-remote "$repo" >"$GIT_DIR/CLONE_HEAD" || exit 1
273 case "$repo" in
274 rsync://*)
275 case "$depth" in
276 "") ;;
277 *) die "shallow over rsync not supported" ;;
278 esac
279 rsync $quiet -av --ignore-existing \
280 --exclude info "$repo/objects/" "$GIT_DIR/objects/" ||
281 exit
282 # Look at objects/info/alternates for rsync -- http will
283 # support it natively and git native ones will do it on the
284 # remote end. Not having that file is not a crime.
285 rsync -q "$repo/objects/info/alternates" \
286 "$GIT_DIR/TMP_ALT" 2>/dev/null ||
287 rm -f "$GIT_DIR/TMP_ALT"
288 if test -f "$GIT_DIR/TMP_ALT"
289 then
290 ( cd "$D" &&
291 . git-parse-remote &&
292 resolve_alternates "$repo" <"$GIT_DIR/TMP_ALT" ) |
293 while read alt
295 case "$alt" in 'bad alternate: '*) die "$alt";; esac
296 case "$quiet" in
297 '') echo >&2 "Getting alternate: $alt" ;;
298 esac
299 rsync $quiet -av --ignore-existing \
300 --exclude info "$alt" "$GIT_DIR/objects" || exit
301 done
302 rm -f "$GIT_DIR/TMP_ALT"
304 git-ls-remote "$repo" >"$GIT_DIR/CLONE_HEAD" || exit 1
306 https://*|http://*|ftp://*)
307 case "$depth" in
308 "") ;;
309 *) die "shallow over http or ftp not supported" ;;
310 esac
311 if test -z "@@NO_CURL@@"
312 then
313 clone_dumb_http "$repo" "$D"
314 else
315 die "http transport not supported, rebuild Git with curl support"
319 case "$upload_pack" in
320 '') git-fetch-pack --all -k $quiet $depth "$repo" ;;
321 *) git-fetch-pack --all -k $quiet "$upload_pack" $depth "$repo" ;;
322 esac >"$GIT_DIR/CLONE_HEAD" ||
323 die "fetch-pack from '$repo' failed."
325 esac
327 esac
328 test -d "$GIT_DIR/refs/reference-tmp" && rm -fr "$GIT_DIR/refs/reference-tmp"
330 if test -f "$GIT_DIR/CLONE_HEAD"
331 then
332 # Read git-fetch-pack -k output and store the remote branches.
333 @@PERL@@ -e "$copy_refs" "$GIT_DIR" "$use_separate_remote" "$origin" ||
334 exit
337 cd "$D" || exit
339 if test -z "$bare" && test -f "$GIT_DIR/REMOTE_HEAD"
340 then
341 # a non-bare repository is always in separate-remote layout
342 remote_top="refs/remotes/$origin"
343 head_sha1=`cat "$GIT_DIR/REMOTE_HEAD"`
344 case "$head_sha1" in
345 'ref: refs/'*)
346 # Uh-oh, the remote told us (http transport done against
347 # new style repository with a symref HEAD).
348 # Ideally we should skip the guesswork but for now
349 # opt for minimum change.
350 head_sha1=`expr "z$head_sha1" : 'zref: refs/heads/\(.*\)'`
351 head_sha1=`cat "$GIT_DIR/$remote_top/$head_sha1"`
353 esac
355 # The name under $remote_top the remote HEAD seems to point at.
356 head_points_at=$(
358 echo "master"
359 cd "$GIT_DIR/$remote_top" &&
360 find . -type f -print | sed -e 's/^\.\///'
361 ) | (
362 done=f
363 while read name
365 test t = $done && continue
366 branch_tip=`cat "$GIT_DIR/$remote_top/$name"`
367 if test "$head_sha1" = "$branch_tip"
368 then
369 echo "$name"
370 done=t
372 done
376 # Write out remote.$origin config, and update our "$head_points_at".
377 case "$head_points_at" in
379 # Local default branch
380 git-symbolic-ref HEAD "refs/heads/$head_points_at" &&
382 # Tracking branch for the primary branch at the remote.
383 origin_track="$remote_top/$head_points_at" &&
384 git-update-ref HEAD "$head_sha1" &&
386 # Upstream URL
387 git-repo-config remote."$origin".url "$repo" &&
389 # Set up the mappings to track the remote branches.
390 git-repo-config remote."$origin".fetch \
391 "+refs/heads/*:$remote_top/*" '^$' &&
392 rm -f "refs/remotes/$origin/HEAD"
393 git-symbolic-ref "refs/remotes/$origin/HEAD" \
394 "refs/remotes/$origin/$head_points_at" &&
396 git-repo-config branch."$head_points_at".remote "$origin" &&
397 git-repo-config branch."$head_points_at".merge "refs/heads/$head_points_at"
398 esac
400 case "$no_checkout" in
402 test "z$quiet" = z && v=-v || v=
403 git-read-tree -m -u $v HEAD HEAD
404 esac
406 rm -f "$GIT_DIR/CLONE_HEAD" "$GIT_DIR/REMOTE_HEAD"
408 trap - 0