Added definitions for a few words:
[git] / git-clone.sh
1 #!/bin/sh
2 #
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.
7
8 # See git-sh-setup why.
9 unset CDPATH
10
11 usage() {
12         echo >&2 "Usage: $0 [--use-separate-remote] [--reference <reference-repo>] [--bare] [-l [-s]] [-q] [-u <upload-pack>] [--origin <name>] [-n] <repo> [<dir>]"
13         exit 1
14 }
15
16 get_repo_base() {
17         (cd "$1" && (cd .git ; pwd)) 2> /dev/null
18 }
19
20 if [ -n "$GIT_SSL_NO_VERIFY" ]; then
21     curl_extra_args="-k"
22 fi
23
24 http_fetch () {
25         # $1 = Remote, $2 = Local
26         curl -nsfL $curl_extra_args "$1" >"$2"
27 }
28
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;
38         }
39         while read sha1 refname
40         do
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
51                 fi
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"
57 }
58
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];
66
67 my $branch_top = ($use_separate_remote ? "remotes/$origin" : "heads");
68 my $tag_top = "tags";
69
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;
77 }
78
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;
88         }
89         if ($name =~ s/^refs\/heads\///) {
90                 store($sha1, $name, $branch_top);
91                 next;
92         }
93         if ($name =~ s/^refs\/tags\///) {
94                 store($sha1, $name, $tag_top);
95                 next;
96         }
97 }
98 close FH;
99 '
100
101 quiet=
102 local=no
103 use_local=no
104 local_shared=no
105 no_checkout=
106 upload_pack=
107 bare=
108 reference=
109 origin=
110 origin_override=
111 use_separate_remote=
112 while
113         case "$#,$1" in
114         0,*) break ;;
115         *,-n|*,--no|*,--no-|*,--no-c|*,--no-ch|*,--no-che|*,--no-chec|\
116         *,--no-check|*,--no-checko|*,--no-checkou|*,--no-checkout)
117           no_checkout=yes ;;
118         *,--na|*,--nak|*,--nake|*,--naked|\
119         *,-b|*,--b|*,--ba|*,--bar|*,--bare) bare=yes ;;
120         *,-l|*,--l|*,--lo|*,--loc|*,--loca|*,--local) use_local=yes ;;
121         *,-s|*,--s|*,--sh|*,--sha|*,--shar|*,--share|*,--shared) 
122           local_shared=yes; use_local=yes ;;
123         *,-q|*,--quiet) quiet=-q ;;
124         *,--use-separate-remote)
125                 use_separate_remote=t ;;
126         1,--reference) usage ;;
127         *,--reference)
128                 shift; reference="$1" ;;
129         *,--reference=*)
130                 reference=`expr "$1" : '--reference=\(.*\)'` ;;
131         *,-o|*,--or|*,--ori|*,--orig|*,--origi|*,--origin)
132                 case "$2" in
133                 '')
134                     usage ;;
135                 */*)
136                     echo >&2 "'$2' is not suitable for an origin name"
137                     exit 1
138                 esac
139                 git-check-ref-format "heads/$2" || {
140                     echo >&2 "'$2' is not suitable for a branch name"
141                     exit 1
142                 }
143                 test -z "$origin_override" || {
144                     echo >&2 "Do not give more than one --origin options."
145                     exit 1
146                 }
147                 origin_override=yes
148                 origin="$2"; shift
149                 ;;
150         1,-u|1,--upload-pack) usage ;;
151         *,-u|*,--upload-pack)
152                 shift
153                 upload_pack="--exec=$1" ;;
154         *,-*) usage ;;
155         *) break ;;
156         esac
157 do
158         shift
159 done
160
161 repo="$1"
162 if test -z "$repo"
163 then
164     echo >&2 'you must specify a repository to clone.'
165     exit 1
166 fi
167
168 # --bare implies --no-checkout
169 if test yes = "$bare"
170 then
171         if test yes = "$origin_override"
172         then
173                 echo >&2 '--bare and --origin $origin options are incompatible.'
174                 exit 1
175         fi
176         if test t = "$use_separate_remote"
177         then
178                 echo >&2 '--bare and --use-separate-remote options are incompatible.'
179                 exit 1
180         fi
181         no_checkout=yes
182 fi
183
184 if test -z "$origin"
185 then
186         origin=origin
187 fi
188
189 # Turn the source into an absolute path if
190 # it is local
191 if base=$(get_repo_base "$repo"); then
192         repo="$base"
193         local=yes
194 fi
195
196 dir="$2"
197 # Try using "humanish" part of source repo if user didn't specify one
198 [ -z "$dir" ] && dir=$(echo "$repo" | sed -e 's|/$||' -e 's|:*/*\.git$||' -e 's|.*[/:]||g')
199 [ -e "$dir" ] && echo "$dir already exists." && usage
200 mkdir -p "$dir" &&
201 D=$(cd "$dir" && pwd) &&
202 trap 'err=$?; cd ..; rm -r "$D"; exit $err' exit
203 case "$bare" in
204 yes) GIT_DIR="$D" ;;
205 *) GIT_DIR="$D/.git" ;;
206 esac && export GIT_DIR && git-init-db || usage
207 case "$bare" in
208 yes)
209         GIT_DIR="$D" ;;
210 *)
211         GIT_DIR="$D/.git" ;;
212 esac
213
214 if test -n "$reference"
215 then
216         if test -d "$reference"
217         then
218                 if test -d "$reference/.git/objects"
219                 then
220                         reference="$reference/.git"
221                 fi
222                 reference=$(cd "$reference" && pwd)
223                 echo "$reference/objects" >"$GIT_DIR/objects/info/alternates"
224                 (cd "$reference" && tar cf - refs) |
225                 (cd "$GIT_DIR/refs" &&
226                  mkdir reference-tmp &&
227                  cd reference-tmp &&
228                  tar xf -)
229         else
230                 echo >&2 "$reference: not a local directory." && usage
231         fi
232 fi
233
234 rm -f "$GIT_DIR/CLONE_HEAD"
235
236 # We do local magic only when the user tells us to.
237 case "$local,$use_local" in
238 yes,yes)
239         ( cd "$repo/objects" ) || {
240                 echo >&2 "-l flag seen but $repo is not local."
241                 exit 1
242         }
243
244         case "$local_shared" in
245         no)
246             # See if we can hardlink and drop "l" if not.
247             sample_file=$(cd "$repo" && \
248                           find objects -type f -print | sed -e 1q)
249
250             # objects directory should not be empty since we are cloning!
251             test -f "$repo/$sample_file" || exit
252
253             l=
254             if ln "$repo/$sample_file" "$GIT_DIR/objects/sample" 2>/dev/null
255             then
256                     l=l
257             fi &&
258             rm -f "$GIT_DIR/objects/sample" &&
259             cd "$repo" &&
260             find objects -depth -print | cpio -pumd$l "$GIT_DIR/" || exit 1
261             ;;
262         yes)
263             mkdir -p "$GIT_DIR/objects/info"
264             {
265                 test -f "$repo/objects/info/alternates" &&
266                 cat "$repo/objects/info/alternates";
267                 echo "$repo/objects"
268             } >"$GIT_DIR/objects/info/alternates"
269             ;;
270         esac
271         git-ls-remote "$repo" >"$GIT_DIR/CLONE_HEAD"
272         ;;
273 *)
274         case "$repo" in
275         rsync://*)
276                 rsync $quiet -av --ignore-existing  \
277                         --exclude info "$repo/objects/" "$GIT_DIR/objects/" ||
278                 exit
279                 # Look at objects/info/alternates for rsync -- http will
280                 # support it natively and git native ones will do it on the
281                 # remote end.  Not having that file is not a crime.
282                 rsync -q "$repo/objects/info/alternates" \
283                         "$GIT_DIR/TMP_ALT" 2>/dev/null ||
284                         rm -f "$GIT_DIR/TMP_ALT"
285                 if test -f "$GIT_DIR/TMP_ALT"
286                 then
287                     ( cd "$D" &&
288                       . git-parse-remote &&
289                       resolve_alternates "$repo" <"$GIT_DIR/TMP_ALT" ) |
290                     while read alt
291                     do
292                         case "$alt" in 'bad alternate: '*) die "$alt";; esac
293                         case "$quiet" in
294                         '')     echo >&2 "Getting alternate: $alt" ;;
295                         esac
296                         rsync $quiet -av --ignore-existing  \
297                             --exclude info "$alt" "$GIT_DIR/objects" || exit
298                     done
299                     rm -f "$GIT_DIR/TMP_ALT"
300                 fi
301                 git-ls-remote "$repo" >"$GIT_DIR/CLONE_HEAD"
302                 ;;
303         http://*)
304                 if test -z "@@NO_CURL@@"
305                 then
306                         clone_dumb_http "$repo" "$D"
307                 else
308                         echo >&2 "http transport not supported, rebuild Git with curl support"
309                         exit 1
310                 fi
311                 ;;
312         *)
313                 cd "$D" && case "$upload_pack" in
314                 '') git-fetch-pack --all -k $quiet "$repo" ;;
315                 *) git-fetch-pack --all -k $quiet "$upload_pack" "$repo" ;;
316                 esac >"$GIT_DIR/CLONE_HEAD" || {
317                         echo >&2 "fetch-pack from '$repo' failed."
318                         exit 1
319                 }
320                 ;;
321         esac
322         ;;
323 esac
324 test -d "$GIT_DIR/refs/reference-tmp" && rm -fr "$GIT_DIR/refs/reference-tmp"
325
326 if test -f "$GIT_DIR/CLONE_HEAD"
327 then
328         # Read git-fetch-pack -k output and store the remote branches.
329         perl -e "$copy_refs" "$GIT_DIR" "$use_separate_remote" "$origin"
330 fi
331
332 cd "$D" || exit
333
334 if test -z "$bare" && test -f "$GIT_DIR/REMOTE_HEAD"
335 then
336         # Figure out which remote branch HEAD points at.
337         case "$use_separate_remote" in
338         '')     remote_top=refs/heads ;;
339         *)      remote_top="refs/remotes/$origin" ;;
340         esac
341
342         head_sha1=`cat "$GIT_DIR/REMOTE_HEAD"`
343         case "$head_sha1" in
344         'ref: refs/'*)
345                 # Uh-oh, the remote told us (http transport done against
346                 # new style repository with a symref HEAD).
347                 # Ideally we should skip the guesswork but for now
348                 # opt for minimum change.
349                 head_sha1=`expr "z$head_sha1" : 'zref: refs/heads/\(.*\)'`
350                 head_sha1=`cat "$GIT_DIR/$remote_top/$head_sha1"`
351                 ;;
352         esac
353
354         # The name under $remote_top the remote HEAD seems to point at.
355         head_points_at=$(
356                 (
357                         echo "master"
358                         cd "$GIT_DIR/$remote_top" &&
359                         find . -type f -print | sed -e 's/^\.\///'
360                 ) | (
361                 done=f
362                 while read name
363                 do
364                         test t = $done && continue
365                         branch_tip=`cat "$GIT_DIR/$remote_top/$name"`
366                         if test "$head_sha1" = "$branch_tip"
367                         then
368                                 echo "$name"
369                                 done=t
370                         fi
371                 done
372                 )
373         )
374
375         # Write out remotes/$origin file, and update our "$head_points_at".
376         case "$head_points_at" in
377         ?*)
378                 mkdir -p "$GIT_DIR/remotes" &&
379                 git-symbolic-ref HEAD "refs/heads/$head_points_at" &&
380                 case "$use_separate_remote" in
381                 t)      origin_track="$remote_top/$head_points_at"
382                         git-update-ref HEAD "$head_sha1" ;;
383                 *)      origin_track="$remote_top/$origin"
384                         git-update-ref "refs/heads/$origin" "$head_sha1" ;;
385                 esac &&
386                 echo >"$GIT_DIR/remotes/$origin" \
387                 "URL: $repo
388 Pull: refs/heads/$head_points_at:$origin_track" &&
389                 (cd "$GIT_DIR/$remote_top" && find . -type f -print) |
390                 while read dotslref
391                 do
392                         name=`expr "$dotslref" : './\(.*\)'` &&
393                         test "$use_separate_remote" = '' && {
394                                 test "$head_points_at" = "$name" ||
395                                 test "$origin" = "$name"
396                         } ||
397                         echo "Pull: refs/heads/${name}:$remote_top/${name}"
398                 done >>"$GIT_DIR/remotes/$origin" &&
399                 case "$use_separate_remote" in
400                 t)
401                         rm -f "refs/remotes/$origin/HEAD"
402                         git-symbolic-ref "refs/remotes/$origin/HEAD" \
403                                 "refs/remotes/$origin/$head_points_at"
404                 esac
405         esac
406
407         case "$no_checkout" in
408         '')
409                 git-read-tree -m -u -v HEAD HEAD
410         esac
411 fi
412 rm -f "$GIT_DIR/CLONE_HEAD" "$GIT_DIR/REMOTE_HEAD"
413
414 trap - exit
415