Misc doc improvements
[git/platforms.git] / git-clone.sh
blobde59904d56155faecedbd7cd4818a741dde43ffd
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/clone-tmp' &&
33 mkdir -p "$clone_tmp" || exit 1
34 http_fetch "$1/info/refs" "$clone_tmp/refs" || {
35 echo >&2 "Cannot get remote repository information.
36 Perhaps git-update-server-info needs to be run there?"
37 exit 1;
39 while read sha1 refname
41 name=`expr "z$refname" : 'zrefs/\(.*\)'` &&
42 case "$name" in
43 *^*) continue;;
44 esac
45 if test -n "$use_separate_remote" &&
46 branch_name=`expr "z$name" : 'zheads/\(.*\)'`
47 then
48 tname="remotes/$origin/$branch_name"
49 else
50 tname=$name
52 git-http-fetch -v -a -w "$tname" "$name" "$1/" || exit 1
53 done <"$clone_tmp/refs"
54 rm -fr "$clone_tmp"
55 http_fetch "$1/HEAD" "$GIT_DIR/REMOTE_HEAD" ||
56 rm -f "$GIT_DIR/REMOTE_HEAD"
59 # Read git-fetch-pack -k output and store the remote branches.
60 copy_refs='
61 use File::Path qw(mkpath);
62 use File::Basename qw(dirname);
63 my $git_dir = $ARGV[0];
64 my $use_separate_remote = $ARGV[1];
65 my $origin = $ARGV[2];
67 my $branch_top = ($use_separate_remote ? "remotes/$origin" : "heads");
68 my $tag_top = "tags";
70 sub store {
71 my ($sha1, $name, $top) = @_;
72 $name = "$git_dir/refs/$top/$name";
73 mkpath(dirname($name));
74 open O, ">", "$name";
75 print O "$sha1\n";
76 close O;
79 open FH, "<", "$git_dir/CLONE_HEAD";
80 while (<FH>) {
81 my ($sha1, $name) = /^([0-9a-f]{40})\s(.*)$/;
82 next if ($name =~ /\^\173/);
83 if ($name eq "HEAD") {
84 open O, ">", "$git_dir/REMOTE_HEAD";
85 print O "$sha1\n";
86 close O;
87 next;
89 if ($name =~ s/^refs\/heads\///) {
90 store($sha1, $name, $branch_top);
91 next;
93 if ($name =~ s/^refs\/tags\///) {
94 store($sha1, $name, $tag_top);
95 next;
98 close FH;
101 quiet=
102 local=no
103 use_local=no
104 local_shared=no
105 unset template
106 no_checkout=
107 upload_pack=
108 bare=
109 reference=
110 origin=
111 origin_override=
112 use_separate_remote=
113 while
114 case "$#,$1" in
115 0,*) break ;;
116 *,-n|*,--no|*,--no-|*,--no-c|*,--no-ch|*,--no-che|*,--no-chec|\
117 *,--no-check|*,--no-checko|*,--no-checkou|*,--no-checkout)
118 no_checkout=yes ;;
119 *,--na|*,--nak|*,--nake|*,--naked|\
120 *,-b|*,--b|*,--ba|*,--bar|*,--bare) bare=yes ;;
121 *,-l|*,--l|*,--lo|*,--loc|*,--loca|*,--local) use_local=yes ;;
122 *,-s|*,--s|*,--sh|*,--sha|*,--shar|*,--share|*,--shared)
123 local_shared=yes; use_local=yes ;;
124 1,--template) usage ;;
125 *,--template)
126 shift; template="--template=$1" ;;
127 *,--template=*)
128 template="$1" ;;
129 *,-q|*,--quiet) quiet=-q ;;
130 *,--use-separate-remote)
131 use_separate_remote=t ;;
132 1,--reference) usage ;;
133 *,--reference)
134 shift; reference="$1" ;;
135 *,--reference=*)
136 reference=`expr "$1" : '--reference=\(.*\)'` ;;
137 *,-o|*,--or|*,--ori|*,--orig|*,--origi|*,--origin)
138 case "$2" in
140 usage ;;
141 */*)
142 echo >&2 "'$2' is not suitable for an origin name"
143 exit 1
144 esac
145 git-check-ref-format "heads/$2" || {
146 echo >&2 "'$2' is not suitable for a branch name"
147 exit 1
149 test -z "$origin_override" || {
150 echo >&2 "Do not give more than one --origin options."
151 exit 1
153 origin_override=yes
154 origin="$2"; shift
156 1,-u|1,--upload-pack) usage ;;
157 *,-u|*,--upload-pack)
158 shift
159 upload_pack="--exec=$1" ;;
160 *,-*) usage ;;
161 *) break ;;
162 esac
164 shift
165 done
167 repo="$1"
168 if test -z "$repo"
169 then
170 echo >&2 'you must specify a repository to clone.'
171 exit 1
174 # --bare implies --no-checkout
175 if test yes = "$bare"
176 then
177 if test yes = "$origin_override"
178 then
179 echo >&2 '--bare and --origin $origin options are incompatible.'
180 exit 1
182 if test t = "$use_separate_remote"
183 then
184 echo >&2 '--bare and --use-separate-remote options are incompatible.'
185 exit 1
187 no_checkout=yes
190 if test -z "$origin"
191 then
192 origin=origin
195 # Turn the source into an absolute path if
196 # it is local
197 if base=$(get_repo_base "$repo"); then
198 repo="$base"
199 local=yes
202 dir="$2"
203 # Try using "humanish" part of source repo if user didn't specify one
204 [ -z "$dir" ] && dir=$(echo "$repo" | sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
205 [ -e "$dir" ] && echo "$dir already exists." && usage
206 mkdir -p "$dir" &&
207 D=$(cd "$dir" && pwd) &&
208 trap 'err=$?; cd ..; rm -r "$D"; exit $err' 0
209 case "$bare" in
210 yes) GIT_DIR="$D" ;;
211 *) GIT_DIR="$D/.git" ;;
212 esac && export GIT_DIR && git-init-db ${template+"$template"} || usage
213 case "$bare" in
214 yes)
215 GIT_DIR="$D" ;;
217 GIT_DIR="$D/.git" ;;
218 esac
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"
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"
305 http://*)
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 cd "$D" && 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"
334 cd "$D" || exit
336 if test -z "$bare" && test -f "$GIT_DIR/REMOTE_HEAD"
337 then
338 # Figure out which remote branch HEAD points at.
339 case "$use_separate_remote" in
340 '') remote_top=refs/heads ;;
341 *) remote_top="refs/remotes/$origin" ;;
342 esac
344 head_sha1=`cat "$GIT_DIR/REMOTE_HEAD"`
345 case "$head_sha1" in
346 'ref: refs/'*)
347 # Uh-oh, the remote told us (http transport done against
348 # new style repository with a symref HEAD).
349 # Ideally we should skip the guesswork but for now
350 # opt for minimum change.
351 head_sha1=`expr "z$head_sha1" : 'zref: refs/heads/\(.*\)'`
352 head_sha1=`cat "$GIT_DIR/$remote_top/$head_sha1"`
354 esac
356 # The name under $remote_top the remote HEAD seems to point at.
357 head_points_at=$(
359 echo "master"
360 cd "$GIT_DIR/$remote_top" &&
361 find . -type f -print | sed -e 's/^\.\///'
362 ) | (
363 done=f
364 while read name
366 test t = $done && continue
367 branch_tip=`cat "$GIT_DIR/$remote_top/$name"`
368 if test "$head_sha1" = "$branch_tip"
369 then
370 echo "$name"
371 done=t
373 done
377 # Write out remotes/$origin file, and update our "$head_points_at".
378 case "$head_points_at" in
380 mkdir -p "$GIT_DIR/remotes" &&
381 git-symbolic-ref HEAD "refs/heads/$head_points_at" &&
382 case "$use_separate_remote" in
383 t) origin_track="$remote_top/$head_points_at"
384 git-update-ref HEAD "$head_sha1" ;;
385 *) origin_track="$remote_top/$origin"
386 git-update-ref "refs/heads/$origin" "$head_sha1" ;;
387 esac &&
388 echo >"$GIT_DIR/remotes/$origin" \
389 "URL: $repo
390 Pull: refs/heads/$head_points_at:$origin_track" &&
391 (cd "$GIT_DIR/$remote_top" && find . -type f -print) |
392 while read dotslref
394 name=`expr "$dotslref" : './\(.*\)'` &&
395 test "$use_separate_remote" = '' && {
396 test "$head_points_at" = "$name" ||
397 test "$origin" = "$name"
398 } ||
399 echo "Pull: refs/heads/${name}:$remote_top/${name}"
400 done >>"$GIT_DIR/remotes/$origin" &&
401 case "$use_separate_remote" in
403 rm -f "refs/remotes/$origin/HEAD"
404 git-symbolic-ref "refs/remotes/$origin/HEAD" \
405 "refs/remotes/$origin/$head_points_at"
406 esac
407 esac
409 case "$no_checkout" in
411 git-read-tree -m -u -v HEAD HEAD
412 esac
414 rm -f "$GIT_DIR/CLONE_HEAD" "$GIT_DIR/REMOTE_HEAD"
416 trap - 0