]> Pileus Git - ~andy/git/blob - builtin/clone.c
Merge branch 'ms/remote-tracking-branches-in-doc'
[~andy/git] / builtin / clone.c
1 /*
2  * Builtin "git clone"
3  *
4  * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
5  *               2008 Daniel Barkalow <barkalow@iabervon.org>
6  * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
7  *
8  * Clone a repository into a different directory that does not yet exist.
9  */
10
11 #include "builtin.h"
12 #include "parse-options.h"
13 #include "fetch-pack.h"
14 #include "refs.h"
15 #include "tree.h"
16 #include "tree-walk.h"
17 #include "unpack-trees.h"
18 #include "transport.h"
19 #include "strbuf.h"
20 #include "dir.h"
21 #include "sigchain.h"
22 #include "branch.h"
23 #include "remote.h"
24 #include "run-command.h"
25 #include "connected.h"
26
27 /*
28  * Overall FIXMEs:
29  *  - respect DB_ENVIRONMENT for .git/objects.
30  *
31  * Implementation notes:
32  *  - dropping use-separate-remote and no-separate-remote compatibility
33  *
34  */
35 static const char * const builtin_clone_usage[] = {
36         N_("git clone [options] [--] <repo> [<dir>]"),
37         NULL
38 };
39
40 static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
41 static int option_local = -1, option_no_hardlinks, option_shared, option_recursive;
42 static char *option_template, *option_depth;
43 static char *option_origin = NULL;
44 static char *option_branch = NULL;
45 static const char *real_git_dir;
46 static char *option_upload_pack = "git-upload-pack";
47 static int option_verbosity;
48 static int option_progress = -1;
49 static struct string_list option_config;
50 static struct string_list option_reference;
51
52 static int opt_parse_reference(const struct option *opt, const char *arg, int unset)
53 {
54         struct string_list *option_reference = opt->value;
55         if (!arg)
56                 return -1;
57         string_list_append(option_reference, arg);
58         return 0;
59 }
60
61 static struct option builtin_clone_options[] = {
62         OPT__VERBOSITY(&option_verbosity),
63         OPT_BOOL(0, "progress", &option_progress,
64                  N_("force progress reporting")),
65         OPT_BOOLEAN('n', "no-checkout", &option_no_checkout,
66                     N_("don't create a checkout")),
67         OPT_BOOLEAN(0, "bare", &option_bare, N_("create a bare repository")),
68         { OPTION_BOOLEAN, 0, "naked", &option_bare, NULL,
69                 N_("create a bare repository"),
70                 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
71         OPT_BOOLEAN(0, "mirror", &option_mirror,
72                     N_("create a mirror repository (implies bare)")),
73         OPT_BOOL('l', "local", &option_local,
74                 N_("to clone from a local repository")),
75         OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks,
76                     N_("don't use local hardlinks, always copy")),
77         OPT_BOOLEAN('s', "shared", &option_shared,
78                     N_("setup as shared repository")),
79         OPT_BOOLEAN(0, "recursive", &option_recursive,
80                     N_("initialize submodules in the clone")),
81         OPT_BOOLEAN(0, "recurse-submodules", &option_recursive,
82                     N_("initialize submodules in the clone")),
83         OPT_STRING(0, "template", &option_template, N_("template-directory"),
84                    N_("directory from which templates will be used")),
85         OPT_CALLBACK(0 , "reference", &option_reference, N_("repo"),
86                      N_("reference repository"), &opt_parse_reference),
87         OPT_STRING('o', "origin", &option_origin, N_("name"),
88                    N_("use <name> instead of 'origin' to track upstream")),
89         OPT_STRING('b', "branch", &option_branch, N_("branch"),
90                    N_("checkout <branch> instead of the remote's HEAD")),
91         OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
92                    N_("path to git-upload-pack on the remote")),
93         OPT_STRING(0, "depth", &option_depth, N_("depth"),
94                     N_("create a shallow clone of that depth")),
95         OPT_BOOL(0, "single-branch", &option_single_branch,
96                     N_("clone only one branch, HEAD or --branch")),
97         OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
98                    N_("separate git dir from working tree")),
99         OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
100                         N_("set config inside the new repository")),
101         OPT_END()
102 };
103
104 static const char *argv_submodule[] = {
105         "submodule", "update", "--init", "--recursive", NULL
106 };
107
108 static char *get_repo_path(const char *repo, int *is_bundle)
109 {
110         static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
111         static char *bundle_suffix[] = { ".bundle", "" };
112         struct stat st;
113         int i;
114
115         for (i = 0; i < ARRAY_SIZE(suffix); i++) {
116                 const char *path;
117                 path = mkpath("%s%s", repo, suffix[i]);
118                 if (stat(path, &st))
119                         continue;
120                 if (S_ISDIR(st.st_mode) && is_git_directory(path)) {
121                         *is_bundle = 0;
122                         return xstrdup(absolute_path(path));
123                 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
124                         /* Is it a "gitfile"? */
125                         char signature[8];
126                         int len, fd = open(path, O_RDONLY);
127                         if (fd < 0)
128                                 continue;
129                         len = read_in_full(fd, signature, 8);
130                         close(fd);
131                         if (len != 8 || strncmp(signature, "gitdir: ", 8))
132                                 continue;
133                         path = read_gitfile(path);
134                         if (path) {
135                                 *is_bundle = 0;
136                                 return xstrdup(absolute_path(path));
137                         }
138                 }
139         }
140
141         for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
142                 const char *path;
143                 path = mkpath("%s%s", repo, bundle_suffix[i]);
144                 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
145                         *is_bundle = 1;
146                         return xstrdup(absolute_path(path));
147                 }
148         }
149
150         return NULL;
151 }
152
153 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
154 {
155         const char *end = repo + strlen(repo), *start;
156         char *dir;
157
158         /*
159          * Strip trailing spaces, slashes and /.git
160          */
161         while (repo < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
162                 end--;
163         if (end - repo > 5 && is_dir_sep(end[-5]) &&
164             !strncmp(end - 4, ".git", 4)) {
165                 end -= 5;
166                 while (repo < end && is_dir_sep(end[-1]))
167                         end--;
168         }
169
170         /*
171          * Find last component, but be prepared that repo could have
172          * the form  "remote.example.com:foo.git", i.e. no slash
173          * in the directory part.
174          */
175         start = end;
176         while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
177                 start--;
178
179         /*
180          * Strip .{bundle,git}.
181          */
182         if (is_bundle) {
183                 if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
184                         end -= 7;
185         } else {
186                 if (end - start > 4 && !strncmp(end - 4, ".git", 4))
187                         end -= 4;
188         }
189
190         if (is_bare) {
191                 struct strbuf result = STRBUF_INIT;
192                 strbuf_addf(&result, "%.*s.git", (int)(end - start), start);
193                 dir = strbuf_detach(&result, NULL);
194         } else
195                 dir = xstrndup(start, end - start);
196         /*
197          * Replace sequences of 'control' characters and whitespace
198          * with one ascii space, remove leading and trailing spaces.
199          */
200         if (*dir) {
201                 char *out = dir;
202                 int prev_space = 1 /* strip leading whitespace */;
203                 for (end = dir; *end; ++end) {
204                         char ch = *end;
205                         if ((unsigned char)ch < '\x20')
206                                 ch = '\x20';
207                         if (isspace(ch)) {
208                                 if (prev_space)
209                                         continue;
210                                 prev_space = 1;
211                         } else
212                                 prev_space = 0;
213                         *out++ = ch;
214                 }
215                 *out = '\0';
216                 if (out > dir && prev_space)
217                         out[-1] = '\0';
218         }
219         return dir;
220 }
221
222 static void strip_trailing_slashes(char *dir)
223 {
224         char *end = dir + strlen(dir);
225
226         while (dir < end - 1 && is_dir_sep(end[-1]))
227                 end--;
228         *end = '\0';
229 }
230
231 static int add_one_reference(struct string_list_item *item, void *cb_data)
232 {
233         char *ref_git;
234         const char *repo;
235         struct strbuf alternate = STRBUF_INIT;
236
237         /* Beware: read_gitfile(), real_path() and mkpath() return static buffer */
238         ref_git = xstrdup(real_path(item->string));
239
240         repo = read_gitfile(ref_git);
241         if (!repo)
242                 repo = read_gitfile(mkpath("%s/.git", ref_git));
243         if (repo) {
244                 free(ref_git);
245                 ref_git = xstrdup(repo);
246         }
247
248         if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
249                 char *ref_git_git = mkpathdup("%s/.git", ref_git);
250                 free(ref_git);
251                 ref_git = ref_git_git;
252         } else if (!is_directory(mkpath("%s/objects", ref_git)))
253                 die(_("reference repository '%s' is not a local repository."),
254                     item->string);
255
256         strbuf_addf(&alternate, "%s/objects", ref_git);
257         add_to_alternates_file(alternate.buf);
258         strbuf_release(&alternate);
259         free(ref_git);
260         return 0;
261 }
262
263 static void setup_reference(void)
264 {
265         for_each_string_list(&option_reference, add_one_reference, NULL);
266 }
267
268 static void copy_alternates(struct strbuf *src, struct strbuf *dst,
269                             const char *src_repo)
270 {
271         /*
272          * Read from the source objects/info/alternates file
273          * and copy the entries to corresponding file in the
274          * destination repository with add_to_alternates_file().
275          * Both src and dst have "$path/objects/info/alternates".
276          *
277          * Instead of copying bit-for-bit from the original,
278          * we need to append to existing one so that the already
279          * created entry via "clone -s" is not lost, and also
280          * to turn entries with paths relative to the original
281          * absolute, so that they can be used in the new repository.
282          */
283         FILE *in = fopen(src->buf, "r");
284         struct strbuf line = STRBUF_INIT;
285
286         while (strbuf_getline(&line, in, '\n') != EOF) {
287                 char *abs_path, abs_buf[PATH_MAX];
288                 if (!line.len || line.buf[0] == '#')
289                         continue;
290                 if (is_absolute_path(line.buf)) {
291                         add_to_alternates_file(line.buf);
292                         continue;
293                 }
294                 abs_path = mkpath("%s/objects/%s", src_repo, line.buf);
295                 normalize_path_copy(abs_buf, abs_path);
296                 add_to_alternates_file(abs_buf);
297         }
298         strbuf_release(&line);
299         fclose(in);
300 }
301
302 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
303                                    const char *src_repo, int src_baselen)
304 {
305         struct dirent *de;
306         struct stat buf;
307         int src_len, dest_len;
308         DIR *dir;
309
310         dir = opendir(src->buf);
311         if (!dir)
312                 die_errno(_("failed to open '%s'"), src->buf);
313
314         if (mkdir(dest->buf, 0777)) {
315                 if (errno != EEXIST)
316                         die_errno(_("failed to create directory '%s'"), dest->buf);
317                 else if (stat(dest->buf, &buf))
318                         die_errno(_("failed to stat '%s'"), dest->buf);
319                 else if (!S_ISDIR(buf.st_mode))
320                         die(_("%s exists and is not a directory"), dest->buf);
321         }
322
323         strbuf_addch(src, '/');
324         src_len = src->len;
325         strbuf_addch(dest, '/');
326         dest_len = dest->len;
327
328         while ((de = readdir(dir)) != NULL) {
329                 strbuf_setlen(src, src_len);
330                 strbuf_addstr(src, de->d_name);
331                 strbuf_setlen(dest, dest_len);
332                 strbuf_addstr(dest, de->d_name);
333                 if (stat(src->buf, &buf)) {
334                         warning (_("failed to stat %s\n"), src->buf);
335                         continue;
336                 }
337                 if (S_ISDIR(buf.st_mode)) {
338                         if (de->d_name[0] != '.')
339                                 copy_or_link_directory(src, dest,
340                                                        src_repo, src_baselen);
341                         continue;
342                 }
343
344                 /* Files that cannot be copied bit-for-bit... */
345                 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
346                         copy_alternates(src, dest, src_repo);
347                         continue;
348                 }
349
350                 if (unlink(dest->buf) && errno != ENOENT)
351                         die_errno(_("failed to unlink '%s'"), dest->buf);
352                 if (!option_no_hardlinks) {
353                         if (!link(src->buf, dest->buf))
354                                 continue;
355                         if (option_local > 0)
356                                 die_errno(_("failed to create link '%s'"), dest->buf);
357                         option_no_hardlinks = 1;
358                 }
359                 if (copy_file_with_time(dest->buf, src->buf, 0666))
360                         die_errno(_("failed to copy file to '%s'"), dest->buf);
361         }
362         closedir(dir);
363 }
364
365 static void clone_local(const char *src_repo, const char *dest_repo)
366 {
367         if (option_shared) {
368                 struct strbuf alt = STRBUF_INIT;
369                 strbuf_addf(&alt, "%s/objects", src_repo);
370                 add_to_alternates_file(alt.buf);
371                 strbuf_release(&alt);
372         } else {
373                 struct strbuf src = STRBUF_INIT;
374                 struct strbuf dest = STRBUF_INIT;
375                 strbuf_addf(&src, "%s/objects", src_repo);
376                 strbuf_addf(&dest, "%s/objects", dest_repo);
377                 copy_or_link_directory(&src, &dest, src_repo, src.len);
378                 strbuf_release(&src);
379                 strbuf_release(&dest);
380         }
381
382         if (0 <= option_verbosity)
383                 printf(_("done.\n"));
384 }
385
386 static const char *junk_work_tree;
387 static const char *junk_git_dir;
388 static pid_t junk_pid;
389 static enum {
390         JUNK_LEAVE_NONE,
391         JUNK_LEAVE_REPO,
392         JUNK_LEAVE_ALL
393 } junk_mode = JUNK_LEAVE_NONE;
394
395 static const char junk_leave_repo_msg[] =
396 N_("Clone succeeded, but checkout failed.\n"
397    "You can inspect what was checked out with 'git status'\n"
398    "and retry the checkout with 'git checkout -f HEAD'\n");
399
400 static void remove_junk(void)
401 {
402         struct strbuf sb = STRBUF_INIT;
403
404         switch (junk_mode) {
405         case JUNK_LEAVE_REPO:
406                 warning("%s", _(junk_leave_repo_msg));
407                 /* fall-through */
408         case JUNK_LEAVE_ALL:
409                 return;
410         default:
411                 /* proceed to removal */
412                 break;
413         }
414
415         if (getpid() != junk_pid)
416                 return;
417         if (junk_git_dir) {
418                 strbuf_addstr(&sb, junk_git_dir);
419                 remove_dir_recursively(&sb, 0);
420                 strbuf_reset(&sb);
421         }
422         if (junk_work_tree) {
423                 strbuf_addstr(&sb, junk_work_tree);
424                 remove_dir_recursively(&sb, 0);
425                 strbuf_reset(&sb);
426         }
427 }
428
429 static void remove_junk_on_signal(int signo)
430 {
431         remove_junk();
432         sigchain_pop(signo);
433         raise(signo);
434 }
435
436 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
437 {
438         struct ref *ref;
439         struct strbuf head = STRBUF_INIT;
440         strbuf_addstr(&head, "refs/heads/");
441         strbuf_addstr(&head, branch);
442         ref = find_ref_by_name(refs, head.buf);
443         strbuf_release(&head);
444
445         if (ref)
446                 return ref;
447
448         strbuf_addstr(&head, "refs/tags/");
449         strbuf_addstr(&head, branch);
450         ref = find_ref_by_name(refs, head.buf);
451         strbuf_release(&head);
452
453         return ref;
454 }
455
456 static struct ref *wanted_peer_refs(const struct ref *refs,
457                 struct refspec *refspec)
458 {
459         struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
460         struct ref *local_refs = head;
461         struct ref **tail = head ? &head->next : &local_refs;
462
463         if (option_single_branch) {
464                 struct ref *remote_head = NULL;
465
466                 if (!option_branch)
467                         remote_head = guess_remote_head(head, refs, 0);
468                 else {
469                         local_refs = NULL;
470                         tail = &local_refs;
471                         remote_head = copy_ref(find_remote_branch(refs, option_branch));
472                 }
473
474                 if (!remote_head && option_branch)
475                         warning(_("Could not find remote branch %s to clone."),
476                                 option_branch);
477                 else {
478                         get_fetch_map(remote_head, refspec, &tail, 0);
479
480                         /* if --branch=tag, pull the requested tag explicitly */
481                         get_fetch_map(remote_head, tag_refspec, &tail, 0);
482                 }
483         } else
484                 get_fetch_map(refs, refspec, &tail, 0);
485
486         if (!option_mirror && !option_single_branch)
487                 get_fetch_map(refs, tag_refspec, &tail, 0);
488
489         return local_refs;
490 }
491
492 static void write_remote_refs(const struct ref *local_refs)
493 {
494         const struct ref *r;
495
496         lock_packed_refs(LOCK_DIE_ON_ERROR);
497
498         for (r = local_refs; r; r = r->next) {
499                 if (!r->peer_ref)
500                         continue;
501                 add_packed_ref(r->peer_ref->name, r->old_sha1);
502         }
503
504         if (commit_packed_refs())
505                 die_errno("unable to overwrite old ref-pack file");
506 }
507
508 static void write_followtags(const struct ref *refs, const char *msg)
509 {
510         const struct ref *ref;
511         for (ref = refs; ref; ref = ref->next) {
512                 if (prefixcmp(ref->name, "refs/tags/"))
513                         continue;
514                 if (!suffixcmp(ref->name, "^{}"))
515                         continue;
516                 if (!has_sha1_file(ref->old_sha1))
517                         continue;
518                 update_ref(msg, ref->name, ref->old_sha1,
519                            NULL, 0, DIE_ON_ERR);
520         }
521 }
522
523 static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
524 {
525         struct ref **rm = cb_data;
526         struct ref *ref = *rm;
527
528         /*
529          * Skip anything missing a peer_ref, which we are not
530          * actually going to write a ref for.
531          */
532         while (ref && !ref->peer_ref)
533                 ref = ref->next;
534         /* Returning -1 notes "end of list" to the caller. */
535         if (!ref)
536                 return -1;
537
538         hashcpy(sha1, ref->old_sha1);
539         *rm = ref->next;
540         return 0;
541 }
542
543 static void update_remote_refs(const struct ref *refs,
544                                const struct ref *mapped_refs,
545                                const struct ref *remote_head_points_at,
546                                const char *branch_top,
547                                const char *msg,
548                                struct transport *transport)
549 {
550         const struct ref *rm = mapped_refs;
551
552         if (0 <= option_verbosity)
553                 printf(_("Checking connectivity... "));
554         if (check_everything_connected_with_transport(iterate_ref_map,
555                                                       0, &rm, transport))
556                 die(_("remote did not send all necessary objects"));
557         if (0 <= option_verbosity)
558                 printf(_("done\n"));
559
560         if (refs) {
561                 write_remote_refs(mapped_refs);
562                 if (option_single_branch)
563                         write_followtags(refs, msg);
564         }
565
566         if (remote_head_points_at && !option_bare) {
567                 struct strbuf head_ref = STRBUF_INIT;
568                 strbuf_addstr(&head_ref, branch_top);
569                 strbuf_addstr(&head_ref, "HEAD");
570                 create_symref(head_ref.buf,
571                               remote_head_points_at->peer_ref->name,
572                               msg);
573         }
574 }
575
576 static void update_head(const struct ref *our, const struct ref *remote,
577                         const char *msg)
578 {
579         if (our && !prefixcmp(our->name, "refs/heads/")) {
580                 /* Local default branch link */
581                 create_symref("HEAD", our->name, NULL);
582                 if (!option_bare) {
583                         const char *head = skip_prefix(our->name, "refs/heads/");
584                         update_ref(msg, "HEAD", our->old_sha1, NULL, 0, DIE_ON_ERR);
585                         install_branch_config(0, head, option_origin, our->name);
586                 }
587         } else if (our) {
588                 struct commit *c = lookup_commit_reference(our->old_sha1);
589                 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
590                 update_ref(msg, "HEAD", c->object.sha1,
591                            NULL, REF_NODEREF, DIE_ON_ERR);
592         } else if (remote) {
593                 /*
594                  * We know remote HEAD points to a non-branch, or
595                  * HEAD points to a branch but we don't know which one.
596                  * Detach HEAD in all these cases.
597                  */
598                 update_ref(msg, "HEAD", remote->old_sha1,
599                            NULL, REF_NODEREF, DIE_ON_ERR);
600         }
601 }
602
603 static int checkout(void)
604 {
605         unsigned char sha1[20];
606         char *head;
607         struct lock_file *lock_file;
608         struct unpack_trees_options opts;
609         struct tree *tree;
610         struct tree_desc t;
611         int err = 0, fd;
612
613         if (option_no_checkout)
614                 return 0;
615
616         head = resolve_refdup("HEAD", sha1, 1, NULL);
617         if (!head) {
618                 warning(_("remote HEAD refers to nonexistent ref, "
619                           "unable to checkout.\n"));
620                 return 0;
621         }
622         if (!strcmp(head, "HEAD")) {
623                 if (advice_detached_head)
624                         detach_advice(sha1_to_hex(sha1));
625         } else {
626                 if (prefixcmp(head, "refs/heads/"))
627                         die(_("HEAD not found below refs/heads!"));
628         }
629         free(head);
630
631         /* We need to be in the new work tree for the checkout */
632         setup_work_tree();
633
634         lock_file = xcalloc(1, sizeof(struct lock_file));
635         fd = hold_locked_index(lock_file, 1);
636
637         memset(&opts, 0, sizeof opts);
638         opts.update = 1;
639         opts.merge = 1;
640         opts.fn = oneway_merge;
641         opts.verbose_update = (option_verbosity >= 0);
642         opts.src_index = &the_index;
643         opts.dst_index = &the_index;
644
645         tree = parse_tree_indirect(sha1);
646         parse_tree(tree);
647         init_tree_desc(&t, tree->buffer, tree->size);
648         if (unpack_trees(1, &t, &opts) < 0)
649                 die(_("unable to checkout working tree"));
650
651         if (write_cache(fd, active_cache, active_nr) ||
652             commit_locked_index(lock_file))
653                 die(_("unable to write new index file"));
654
655         err |= run_hook(NULL, "post-checkout", sha1_to_hex(null_sha1),
656                         sha1_to_hex(sha1), "1", NULL);
657
658         if (!err && option_recursive)
659                 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
660
661         return err;
662 }
663
664 static int write_one_config(const char *key, const char *value, void *data)
665 {
666         return git_config_set_multivar(key, value ? value : "true", "^$", 0);
667 }
668
669 static void write_config(struct string_list *config)
670 {
671         int i;
672
673         for (i = 0; i < config->nr; i++) {
674                 if (git_config_parse_parameter(config->items[i].string,
675                                                write_one_config, NULL) < 0)
676                         die("unable to write parameters to config file");
677         }
678 }
679
680 static void write_refspec_config(const char* src_ref_prefix,
681                 const struct ref* our_head_points_at,
682                 const struct ref* remote_head_points_at, struct strbuf* branch_top)
683 {
684         struct strbuf key = STRBUF_INIT;
685         struct strbuf value = STRBUF_INIT;
686
687         if (option_mirror || !option_bare) {
688                 if (option_single_branch && !option_mirror) {
689                         if (option_branch) {
690                                 if (strstr(our_head_points_at->name, "refs/tags/"))
691                                         strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
692                                                 our_head_points_at->name);
693                                 else
694                                         strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
695                                                 branch_top->buf, option_branch);
696                         } else if (remote_head_points_at) {
697                                 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
698                                                 branch_top->buf,
699                                                 skip_prefix(remote_head_points_at->name, "refs/heads/"));
700                         }
701                         /*
702                          * otherwise, the next "git fetch" will
703                          * simply fetch from HEAD without updating
704                          * any remote-tracking branch, which is what
705                          * we want.
706                          */
707                 } else {
708                         strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
709                 }
710                 /* Configure the remote */
711                 if (value.len) {
712                         strbuf_addf(&key, "remote.%s.fetch", option_origin);
713                         git_config_set_multivar(key.buf, value.buf, "^$", 0);
714                         strbuf_reset(&key);
715
716                         if (option_mirror) {
717                                 strbuf_addf(&key, "remote.%s.mirror", option_origin);
718                                 git_config_set(key.buf, "true");
719                                 strbuf_reset(&key);
720                         }
721                 }
722         }
723
724         strbuf_release(&key);
725         strbuf_release(&value);
726 }
727
728 int cmd_clone(int argc, const char **argv, const char *prefix)
729 {
730         int is_bundle = 0, is_local;
731         struct stat buf;
732         const char *repo_name, *repo, *work_tree, *git_dir;
733         char *path, *dir;
734         int dest_exists;
735         const struct ref *refs, *remote_head;
736         const struct ref *remote_head_points_at;
737         const struct ref *our_head_points_at;
738         struct ref *mapped_refs;
739         const struct ref *ref;
740         struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
741         struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
742         struct transport *transport = NULL;
743         const char *src_ref_prefix = "refs/heads/";
744         struct remote *remote;
745         int err = 0, complete_refs_before_fetch = 1;
746
747         struct refspec *refspec;
748         const char *fetch_pattern;
749
750         junk_pid = getpid();
751
752         packet_trace_identity("clone");
753         argc = parse_options(argc, argv, prefix, builtin_clone_options,
754                              builtin_clone_usage, 0);
755
756         if (argc > 2)
757                 usage_msg_opt(_("Too many arguments."),
758                         builtin_clone_usage, builtin_clone_options);
759
760         if (argc == 0)
761                 usage_msg_opt(_("You must specify a repository to clone."),
762                         builtin_clone_usage, builtin_clone_options);
763
764         if (option_single_branch == -1)
765                 option_single_branch = option_depth ? 1 : 0;
766
767         if (option_mirror)
768                 option_bare = 1;
769
770         if (option_bare) {
771                 if (option_origin)
772                         die(_("--bare and --origin %s options are incompatible."),
773                             option_origin);
774                 if (real_git_dir)
775                         die(_("--bare and --separate-git-dir are incompatible."));
776                 option_no_checkout = 1;
777         }
778
779         if (!option_origin)
780                 option_origin = "origin";
781
782         repo_name = argv[0];
783
784         path = get_repo_path(repo_name, &is_bundle);
785         if (path)
786                 repo = xstrdup(absolute_path(repo_name));
787         else if (!strchr(repo_name, ':'))
788                 die(_("repository '%s' does not exist"), repo_name);
789         else
790                 repo = repo_name;
791         is_local = option_local != 0 && path && !is_bundle;
792         if (is_local && option_depth)
793                 warning(_("--depth is ignored in local clones; use file:// instead."));
794         if (option_local > 0 && !is_local)
795                 warning(_("--local is ignored"));
796
797         if (argc == 2)
798                 dir = xstrdup(argv[1]);
799         else
800                 dir = guess_dir_name(repo_name, is_bundle, option_bare);
801         strip_trailing_slashes(dir);
802
803         dest_exists = !stat(dir, &buf);
804         if (dest_exists && !is_empty_dir(dir))
805                 die(_("destination path '%s' already exists and is not "
806                         "an empty directory."), dir);
807
808         strbuf_addf(&reflog_msg, "clone: from %s", repo);
809
810         if (option_bare)
811                 work_tree = NULL;
812         else {
813                 work_tree = getenv("GIT_WORK_TREE");
814                 if (work_tree && !stat(work_tree, &buf))
815                         die(_("working tree '%s' already exists."), work_tree);
816         }
817
818         if (option_bare || work_tree)
819                 git_dir = xstrdup(dir);
820         else {
821                 work_tree = dir;
822                 git_dir = mkpathdup("%s/.git", dir);
823         }
824
825         if (!option_bare) {
826                 junk_work_tree = work_tree;
827                 if (safe_create_leading_directories_const(work_tree) < 0)
828                         die_errno(_("could not create leading directories of '%s'"),
829                                   work_tree);
830                 if (!dest_exists && mkdir(work_tree, 0777))
831                         die_errno(_("could not create work tree dir '%s'."),
832                                   work_tree);
833                 set_git_work_tree(work_tree);
834         }
835         junk_git_dir = git_dir;
836         atexit(remove_junk);
837         sigchain_push_common(remove_junk_on_signal);
838
839         if (safe_create_leading_directories_const(git_dir) < 0)
840                 die(_("could not create leading directories of '%s'"), git_dir);
841
842         set_git_dir_init(git_dir, real_git_dir, 0);
843         if (real_git_dir) {
844                 git_dir = real_git_dir;
845                 junk_git_dir = real_git_dir;
846         }
847
848         if (0 <= option_verbosity) {
849                 if (option_bare)
850                         printf(_("Cloning into bare repository '%s'...\n"), dir);
851                 else
852                         printf(_("Cloning into '%s'...\n"), dir);
853         }
854         init_db(option_template, INIT_DB_QUIET);
855         write_config(&option_config);
856
857         git_config(git_default_config, NULL);
858
859         if (option_bare) {
860                 if (option_mirror)
861                         src_ref_prefix = "refs/";
862                 strbuf_addstr(&branch_top, src_ref_prefix);
863
864                 git_config_set("core.bare", "true");
865         } else {
866                 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
867         }
868
869         strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
870         strbuf_addf(&key, "remote.%s.url", option_origin);
871         git_config_set(key.buf, repo);
872         strbuf_reset(&key);
873
874         if (option_reference.nr)
875                 setup_reference();
876
877         fetch_pattern = value.buf;
878         refspec = parse_fetch_refspec(1, &fetch_pattern);
879
880         strbuf_reset(&value);
881
882         remote = remote_get(option_origin);
883         transport = transport_get(remote, remote->url[0]);
884
885         if (!is_local) {
886                 if (!transport->get_refs_list || !transport->fetch)
887                         die(_("Don't know how to clone %s"), transport->url);
888
889                 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
890
891                 if (option_depth)
892                         transport_set_option(transport, TRANS_OPT_DEPTH,
893                                              option_depth);
894                 if (option_single_branch)
895                         transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
896
897                 transport_set_verbosity(transport, option_verbosity, option_progress);
898
899                 if (option_upload_pack)
900                         transport_set_option(transport, TRANS_OPT_UPLOADPACK,
901                                              option_upload_pack);
902
903                 if (transport->smart_options && !option_depth)
904                         transport->smart_options->check_self_contained_and_connected = 1;
905         }
906
907         refs = transport_get_remote_refs(transport);
908
909         if (refs) {
910                 mapped_refs = wanted_peer_refs(refs, refspec);
911                 /*
912                  * transport_get_remote_refs() may return refs with null sha-1
913                  * in mapped_refs (see struct transport->get_refs_list
914                  * comment). In that case we need fetch it early because
915                  * remote_head code below relies on it.
916                  *
917                  * for normal clones, transport_get_remote_refs() should
918                  * return reliable ref set, we can delay cloning until after
919                  * remote HEAD check.
920                  */
921                 for (ref = refs; ref; ref = ref->next)
922                         if (is_null_sha1(ref->old_sha1)) {
923                                 complete_refs_before_fetch = 0;
924                                 break;
925                         }
926
927                 if (!is_local && !complete_refs_before_fetch)
928                         transport_fetch_refs(transport, mapped_refs);
929
930                 remote_head = find_ref_by_name(refs, "HEAD");
931                 remote_head_points_at =
932                         guess_remote_head(remote_head, mapped_refs, 0);
933
934                 if (option_branch) {
935                         our_head_points_at =
936                                 find_remote_branch(mapped_refs, option_branch);
937
938                         if (!our_head_points_at)
939                                 die(_("Remote branch %s not found in upstream %s"),
940                                     option_branch, option_origin);
941                 }
942                 else
943                         our_head_points_at = remote_head_points_at;
944         }
945         else {
946                 warning(_("You appear to have cloned an empty repository."));
947                 mapped_refs = NULL;
948                 our_head_points_at = NULL;
949                 remote_head_points_at = NULL;
950                 remote_head = NULL;
951                 option_no_checkout = 1;
952                 if (!option_bare)
953                         install_branch_config(0, "master", option_origin,
954                                               "refs/heads/master");
955         }
956
957         write_refspec_config(src_ref_prefix, our_head_points_at,
958                         remote_head_points_at, &branch_top);
959
960         if (is_local)
961                 clone_local(path, git_dir);
962         else if (refs && complete_refs_before_fetch)
963                 transport_fetch_refs(transport, mapped_refs);
964
965         update_remote_refs(refs, mapped_refs, remote_head_points_at,
966                            branch_top.buf, reflog_msg.buf, transport);
967
968         update_head(our_head_points_at, remote_head, reflog_msg.buf);
969
970         transport_unlock_pack(transport);
971         transport_disconnect(transport);
972
973         junk_mode = JUNK_LEAVE_REPO;
974         err = checkout();
975
976         strbuf_release(&reflog_msg);
977         strbuf_release(&branch_top);
978         strbuf_release(&key);
979         strbuf_release(&value);
980         junk_mode = JUNK_LEAVE_ALL;
981         return err;
982 }