remote: add get-url subcommand
[git.git] / builtin / clone.c
bloba72ff7e0098da9c89f6000e724ea097e3403601f
1 /*
2 * Builtin "git clone"
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
8 * Clone a repository into a different directory that does not yet exist.
9 */
11 #include "builtin.h"
12 #include "lockfile.h"
13 #include "parse-options.h"
14 #include "fetch-pack.h"
15 #include "refs.h"
16 #include "tree.h"
17 #include "tree-walk.h"
18 #include "unpack-trees.h"
19 #include "transport.h"
20 #include "strbuf.h"
21 #include "dir.h"
22 #include "sigchain.h"
23 #include "branch.h"
24 #include "remote.h"
25 #include "run-command.h"
26 #include "connected.h"
29 * Overall FIXMEs:
30 * - respect DB_ENVIRONMENT for .git/objects.
32 * Implementation notes:
33 * - dropping use-separate-remote and no-separate-remote compatibility
36 static const char * const builtin_clone_usage[] = {
37 N_("git clone [<options>] [--] <repo> [<dir>]"),
38 NULL
41 static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
42 static int option_local = -1, option_no_hardlinks, option_shared, option_recursive;
43 static char *option_template, *option_depth;
44 static char *option_origin = NULL;
45 static char *option_branch = NULL;
46 static const char *real_git_dir;
47 static char *option_upload_pack = "git-upload-pack";
48 static int option_verbosity;
49 static int option_progress = -1;
50 static struct string_list option_config;
51 static struct string_list option_reference;
52 static int option_dissociate;
54 static struct option builtin_clone_options[] = {
55 OPT__VERBOSITY(&option_verbosity),
56 OPT_BOOL(0, "progress", &option_progress,
57 N_("force progress reporting")),
58 OPT_BOOL('n', "no-checkout", &option_no_checkout,
59 N_("don't create a checkout")),
60 OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
61 OPT_HIDDEN_BOOL(0, "naked", &option_bare,
62 N_("create a bare repository")),
63 OPT_BOOL(0, "mirror", &option_mirror,
64 N_("create a mirror repository (implies bare)")),
65 OPT_BOOL('l', "local", &option_local,
66 N_("to clone from a local repository")),
67 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
68 N_("don't use local hardlinks, always copy")),
69 OPT_BOOL('s', "shared", &option_shared,
70 N_("setup as shared repository")),
71 OPT_BOOL(0, "recursive", &option_recursive,
72 N_("initialize submodules in the clone")),
73 OPT_BOOL(0, "recurse-submodules", &option_recursive,
74 N_("initialize submodules in the clone")),
75 OPT_STRING(0, "template", &option_template, N_("template-directory"),
76 N_("directory from which templates will be used")),
77 OPT_STRING_LIST(0, "reference", &option_reference, N_("repo"),
78 N_("reference repository")),
79 OPT_BOOL(0, "dissociate", &option_dissociate,
80 N_("use --reference only while cloning")),
81 OPT_STRING('o', "origin", &option_origin, N_("name"),
82 N_("use <name> instead of 'origin' to track upstream")),
83 OPT_STRING('b', "branch", &option_branch, N_("branch"),
84 N_("checkout <branch> instead of the remote's HEAD")),
85 OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
86 N_("path to git-upload-pack on the remote")),
87 OPT_STRING(0, "depth", &option_depth, N_("depth"),
88 N_("create a shallow clone of that depth")),
89 OPT_BOOL(0, "single-branch", &option_single_branch,
90 N_("clone only one branch, HEAD or --branch")),
91 OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
92 N_("separate git dir from working tree")),
93 OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
94 N_("set config inside the new repository")),
95 OPT_END()
98 static const char *argv_submodule[] = {
99 "submodule", "update", "--init", "--recursive", NULL
102 static char *get_repo_path(const char *repo, int *is_bundle)
104 static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
105 static char *bundle_suffix[] = { ".bundle", "" };
106 struct stat st;
107 int i;
109 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
110 const char *path;
111 path = mkpath("%s%s", repo, suffix[i]);
112 if (stat(path, &st))
113 continue;
114 if (S_ISDIR(st.st_mode) && is_git_directory(path)) {
115 *is_bundle = 0;
116 return xstrdup(absolute_path(path));
117 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
118 /* Is it a "gitfile"? */
119 char signature[8];
120 int len, fd = open(path, O_RDONLY);
121 if (fd < 0)
122 continue;
123 len = read_in_full(fd, signature, 8);
124 close(fd);
125 if (len != 8 || strncmp(signature, "gitdir: ", 8))
126 continue;
127 path = read_gitfile(path);
128 if (path) {
129 *is_bundle = 0;
130 return xstrdup(absolute_path(path));
135 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
136 const char *path;
137 path = mkpath("%s%s", repo, bundle_suffix[i]);
138 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
139 *is_bundle = 1;
140 return xstrdup(absolute_path(path));
144 return NULL;
147 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
149 const char *end = repo + strlen(repo), *start;
150 size_t len;
151 char *dir;
154 * Strip trailing spaces, slashes and /.git
156 while (repo < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
157 end--;
158 if (end - repo > 5 && is_dir_sep(end[-5]) &&
159 !strncmp(end - 4, ".git", 4)) {
160 end -= 5;
161 while (repo < end && is_dir_sep(end[-1]))
162 end--;
166 * Find last component, but be prepared that repo could have
167 * the form "remote.example.com:foo.git", i.e. no slash
168 * in the directory part.
170 start = end;
171 while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
172 start--;
175 * Strip .{bundle,git}.
177 strip_suffix(start, is_bundle ? ".bundle" : ".git" , &len);
179 if (is_bare)
180 dir = xstrfmt("%.*s.git", (int)len, start);
181 else
182 dir = xstrndup(start, len);
184 * Replace sequences of 'control' characters and whitespace
185 * with one ascii space, remove leading and trailing spaces.
187 if (*dir) {
188 char *out = dir;
189 int prev_space = 1 /* strip leading whitespace */;
190 for (end = dir; *end; ++end) {
191 char ch = *end;
192 if ((unsigned char)ch < '\x20')
193 ch = '\x20';
194 if (isspace(ch)) {
195 if (prev_space)
196 continue;
197 prev_space = 1;
198 } else
199 prev_space = 0;
200 *out++ = ch;
202 *out = '\0';
203 if (out > dir && prev_space)
204 out[-1] = '\0';
206 return dir;
209 static void strip_trailing_slashes(char *dir)
211 char *end = dir + strlen(dir);
213 while (dir < end - 1 && is_dir_sep(end[-1]))
214 end--;
215 *end = '\0';
218 static int add_one_reference(struct string_list_item *item, void *cb_data)
220 char *ref_git;
221 const char *repo;
222 struct strbuf alternate = STRBUF_INIT;
224 /* Beware: read_gitfile(), real_path() and mkpath() return static buffer */
225 ref_git = xstrdup(real_path(item->string));
227 repo = read_gitfile(ref_git);
228 if (!repo)
229 repo = read_gitfile(mkpath("%s/.git", ref_git));
230 if (repo) {
231 free(ref_git);
232 ref_git = xstrdup(repo);
235 if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
236 char *ref_git_git = mkpathdup("%s/.git", ref_git);
237 free(ref_git);
238 ref_git = ref_git_git;
239 } else if (!is_directory(mkpath("%s/objects", ref_git)))
240 die(_("reference repository '%s' is not a local repository."),
241 item->string);
243 if (!access(mkpath("%s/shallow", ref_git), F_OK))
244 die(_("reference repository '%s' is shallow"), item->string);
246 if (!access(mkpath("%s/info/grafts", ref_git), F_OK))
247 die(_("reference repository '%s' is grafted"), item->string);
249 strbuf_addf(&alternate, "%s/objects", ref_git);
250 add_to_alternates_file(alternate.buf);
251 strbuf_release(&alternate);
252 free(ref_git);
253 return 0;
256 static void setup_reference(void)
258 for_each_string_list(&option_reference, add_one_reference, NULL);
261 static void copy_alternates(struct strbuf *src, struct strbuf *dst,
262 const char *src_repo)
265 * Read from the source objects/info/alternates file
266 * and copy the entries to corresponding file in the
267 * destination repository with add_to_alternates_file().
268 * Both src and dst have "$path/objects/info/alternates".
270 * Instead of copying bit-for-bit from the original,
271 * we need to append to existing one so that the already
272 * created entry via "clone -s" is not lost, and also
273 * to turn entries with paths relative to the original
274 * absolute, so that they can be used in the new repository.
276 FILE *in = fopen(src->buf, "r");
277 struct strbuf line = STRBUF_INIT;
279 while (strbuf_getline(&line, in, '\n') != EOF) {
280 char *abs_path;
281 if (!line.len || line.buf[0] == '#')
282 continue;
283 if (is_absolute_path(line.buf)) {
284 add_to_alternates_file(line.buf);
285 continue;
287 abs_path = mkpathdup("%s/objects/%s", src_repo, line.buf);
288 normalize_path_copy(abs_path, abs_path);
289 add_to_alternates_file(abs_path);
290 free(abs_path);
292 strbuf_release(&line);
293 fclose(in);
296 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
297 const char *src_repo, int src_baselen)
299 struct dirent *de;
300 struct stat buf;
301 int src_len, dest_len;
302 DIR *dir;
304 dir = opendir(src->buf);
305 if (!dir)
306 die_errno(_("failed to open '%s'"), src->buf);
308 if (mkdir(dest->buf, 0777)) {
309 if (errno != EEXIST)
310 die_errno(_("failed to create directory '%s'"), dest->buf);
311 else if (stat(dest->buf, &buf))
312 die_errno(_("failed to stat '%s'"), dest->buf);
313 else if (!S_ISDIR(buf.st_mode))
314 die(_("%s exists and is not a directory"), dest->buf);
317 strbuf_addch(src, '/');
318 src_len = src->len;
319 strbuf_addch(dest, '/');
320 dest_len = dest->len;
322 while ((de = readdir(dir)) != NULL) {
323 strbuf_setlen(src, src_len);
324 strbuf_addstr(src, de->d_name);
325 strbuf_setlen(dest, dest_len);
326 strbuf_addstr(dest, de->d_name);
327 if (stat(src->buf, &buf)) {
328 warning (_("failed to stat %s\n"), src->buf);
329 continue;
331 if (S_ISDIR(buf.st_mode)) {
332 if (de->d_name[0] != '.')
333 copy_or_link_directory(src, dest,
334 src_repo, src_baselen);
335 continue;
338 /* Files that cannot be copied bit-for-bit... */
339 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
340 copy_alternates(src, dest, src_repo);
341 continue;
344 if (unlink(dest->buf) && errno != ENOENT)
345 die_errno(_("failed to unlink '%s'"), dest->buf);
346 if (!option_no_hardlinks) {
347 if (!link(src->buf, dest->buf))
348 continue;
349 if (option_local > 0)
350 die_errno(_("failed to create link '%s'"), dest->buf);
351 option_no_hardlinks = 1;
353 if (copy_file_with_time(dest->buf, src->buf, 0666))
354 die_errno(_("failed to copy file to '%s'"), dest->buf);
356 closedir(dir);
359 static void clone_local(const char *src_repo, const char *dest_repo)
361 if (option_shared) {
362 struct strbuf alt = STRBUF_INIT;
363 strbuf_addf(&alt, "%s/objects", src_repo);
364 add_to_alternates_file(alt.buf);
365 strbuf_release(&alt);
366 } else {
367 struct strbuf src = STRBUF_INIT;
368 struct strbuf dest = STRBUF_INIT;
369 strbuf_addf(&src, "%s/objects", src_repo);
370 strbuf_addf(&dest, "%s/objects", dest_repo);
371 copy_or_link_directory(&src, &dest, src_repo, src.len);
372 strbuf_release(&src);
373 strbuf_release(&dest);
376 if (0 <= option_verbosity)
377 fprintf(stderr, _("done.\n"));
380 static const char *junk_work_tree;
381 static const char *junk_git_dir;
382 static enum {
383 JUNK_LEAVE_NONE,
384 JUNK_LEAVE_REPO,
385 JUNK_LEAVE_ALL
386 } junk_mode = JUNK_LEAVE_NONE;
388 static const char junk_leave_repo_msg[] =
389 N_("Clone succeeded, but checkout failed.\n"
390 "You can inspect what was checked out with 'git status'\n"
391 "and retry the checkout with 'git checkout -f HEAD'\n");
393 static void remove_junk(void)
395 struct strbuf sb = STRBUF_INIT;
397 switch (junk_mode) {
398 case JUNK_LEAVE_REPO:
399 warning("%s", _(junk_leave_repo_msg));
400 /* fall-through */
401 case JUNK_LEAVE_ALL:
402 return;
403 default:
404 /* proceed to removal */
405 break;
408 if (junk_git_dir) {
409 strbuf_addstr(&sb, junk_git_dir);
410 remove_dir_recursively(&sb, 0);
411 strbuf_reset(&sb);
413 if (junk_work_tree) {
414 strbuf_addstr(&sb, junk_work_tree);
415 remove_dir_recursively(&sb, 0);
416 strbuf_reset(&sb);
420 static void remove_junk_on_signal(int signo)
422 remove_junk();
423 sigchain_pop(signo);
424 raise(signo);
427 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
429 struct ref *ref;
430 struct strbuf head = STRBUF_INIT;
431 strbuf_addstr(&head, "refs/heads/");
432 strbuf_addstr(&head, branch);
433 ref = find_ref_by_name(refs, head.buf);
434 strbuf_release(&head);
436 if (ref)
437 return ref;
439 strbuf_addstr(&head, "refs/tags/");
440 strbuf_addstr(&head, branch);
441 ref = find_ref_by_name(refs, head.buf);
442 strbuf_release(&head);
444 return ref;
447 static struct ref *wanted_peer_refs(const struct ref *refs,
448 struct refspec *refspec)
450 struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
451 struct ref *local_refs = head;
452 struct ref **tail = head ? &head->next : &local_refs;
454 if (option_single_branch) {
455 struct ref *remote_head = NULL;
457 if (!option_branch)
458 remote_head = guess_remote_head(head, refs, 0);
459 else {
460 local_refs = NULL;
461 tail = &local_refs;
462 remote_head = copy_ref(find_remote_branch(refs, option_branch));
465 if (!remote_head && option_branch)
466 warning(_("Could not find remote branch %s to clone."),
467 option_branch);
468 else {
469 get_fetch_map(remote_head, refspec, &tail, 0);
471 /* if --branch=tag, pull the requested tag explicitly */
472 get_fetch_map(remote_head, tag_refspec, &tail, 0);
474 } else
475 get_fetch_map(refs, refspec, &tail, 0);
477 if (!option_mirror && !option_single_branch)
478 get_fetch_map(refs, tag_refspec, &tail, 0);
480 return local_refs;
483 static void write_remote_refs(const struct ref *local_refs)
485 const struct ref *r;
487 lock_packed_refs(LOCK_DIE_ON_ERROR);
489 for (r = local_refs; r; r = r->next) {
490 if (!r->peer_ref)
491 continue;
492 add_packed_ref(r->peer_ref->name, r->old_sha1);
495 if (commit_packed_refs())
496 die_errno("unable to overwrite old ref-pack file");
499 static void write_followtags(const struct ref *refs, const char *msg)
501 const struct ref *ref;
502 for (ref = refs; ref; ref = ref->next) {
503 if (!starts_with(ref->name, "refs/tags/"))
504 continue;
505 if (ends_with(ref->name, "^{}"))
506 continue;
507 if (!has_sha1_file(ref->old_sha1))
508 continue;
509 update_ref(msg, ref->name, ref->old_sha1,
510 NULL, 0, UPDATE_REFS_DIE_ON_ERR);
514 static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
516 struct ref **rm = cb_data;
517 struct ref *ref = *rm;
520 * Skip anything missing a peer_ref, which we are not
521 * actually going to write a ref for.
523 while (ref && !ref->peer_ref)
524 ref = ref->next;
525 /* Returning -1 notes "end of list" to the caller. */
526 if (!ref)
527 return -1;
529 hashcpy(sha1, ref->old_sha1);
530 *rm = ref->next;
531 return 0;
534 static void update_remote_refs(const struct ref *refs,
535 const struct ref *mapped_refs,
536 const struct ref *remote_head_points_at,
537 const char *branch_top,
538 const char *msg,
539 struct transport *transport,
540 int check_connectivity)
542 const struct ref *rm = mapped_refs;
544 if (check_connectivity) {
545 if (transport->progress)
546 fprintf(stderr, _("Checking connectivity... "));
547 if (check_everything_connected_with_transport(iterate_ref_map,
548 0, &rm, transport))
549 die(_("remote did not send all necessary objects"));
550 if (transport->progress)
551 fprintf(stderr, _("done.\n"));
554 if (refs) {
555 write_remote_refs(mapped_refs);
556 if (option_single_branch)
557 write_followtags(refs, msg);
560 if (remote_head_points_at && !option_bare) {
561 struct strbuf head_ref = STRBUF_INIT;
562 strbuf_addstr(&head_ref, branch_top);
563 strbuf_addstr(&head_ref, "HEAD");
564 create_symref(head_ref.buf,
565 remote_head_points_at->peer_ref->name,
566 msg);
570 static void update_head(const struct ref *our, const struct ref *remote,
571 const char *msg)
573 const char *head;
574 if (our && skip_prefix(our->name, "refs/heads/", &head)) {
575 /* Local default branch link */
576 create_symref("HEAD", our->name, NULL);
577 if (!option_bare) {
578 update_ref(msg, "HEAD", our->old_sha1, NULL, 0,
579 UPDATE_REFS_DIE_ON_ERR);
580 install_branch_config(0, head, option_origin, our->name);
582 } else if (our) {
583 struct commit *c = lookup_commit_reference(our->old_sha1);
584 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
585 update_ref(msg, "HEAD", c->object.sha1,
586 NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
587 } else if (remote) {
589 * We know remote HEAD points to a non-branch, or
590 * HEAD points to a branch but we don't know which one.
591 * Detach HEAD in all these cases.
593 update_ref(msg, "HEAD", remote->old_sha1,
594 NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
598 static int checkout(void)
600 unsigned char sha1[20];
601 char *head;
602 struct lock_file *lock_file;
603 struct unpack_trees_options opts;
604 struct tree *tree;
605 struct tree_desc t;
606 int err = 0;
608 if (option_no_checkout)
609 return 0;
611 head = resolve_refdup("HEAD", RESOLVE_REF_READING, sha1, NULL);
612 if (!head) {
613 warning(_("remote HEAD refers to nonexistent ref, "
614 "unable to checkout.\n"));
615 return 0;
617 if (!strcmp(head, "HEAD")) {
618 if (advice_detached_head)
619 detach_advice(sha1_to_hex(sha1));
620 } else {
621 if (!starts_with(head, "refs/heads/"))
622 die(_("HEAD not found below refs/heads!"));
624 free(head);
626 /* We need to be in the new work tree for the checkout */
627 setup_work_tree();
629 lock_file = xcalloc(1, sizeof(struct lock_file));
630 hold_locked_index(lock_file, 1);
632 memset(&opts, 0, sizeof opts);
633 opts.update = 1;
634 opts.merge = 1;
635 opts.fn = oneway_merge;
636 opts.verbose_update = (option_verbosity >= 0);
637 opts.src_index = &the_index;
638 opts.dst_index = &the_index;
640 tree = parse_tree_indirect(sha1);
641 parse_tree(tree);
642 init_tree_desc(&t, tree->buffer, tree->size);
643 if (unpack_trees(1, &t, &opts) < 0)
644 die(_("unable to checkout working tree"));
646 if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
647 die(_("unable to write new index file"));
649 err |= run_hook_le(NULL, "post-checkout", sha1_to_hex(null_sha1),
650 sha1_to_hex(sha1), "1", NULL);
652 if (!err && option_recursive)
653 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
655 return err;
658 static int write_one_config(const char *key, const char *value, void *data)
660 return git_config_set_multivar(key, value ? value : "true", "^$", 0);
663 static void write_config(struct string_list *config)
665 int i;
667 for (i = 0; i < config->nr; i++) {
668 if (git_config_parse_parameter(config->items[i].string,
669 write_one_config, NULL) < 0)
670 die("unable to write parameters to config file");
674 static void write_refspec_config(const char *src_ref_prefix,
675 const struct ref *our_head_points_at,
676 const struct ref *remote_head_points_at,
677 struct strbuf *branch_top)
679 struct strbuf key = STRBUF_INIT;
680 struct strbuf value = STRBUF_INIT;
682 if (option_mirror || !option_bare) {
683 if (option_single_branch && !option_mirror) {
684 if (option_branch) {
685 if (starts_with(our_head_points_at->name, "refs/tags/"))
686 strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
687 our_head_points_at->name);
688 else
689 strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
690 branch_top->buf, option_branch);
691 } else if (remote_head_points_at) {
692 const char *head = remote_head_points_at->name;
693 if (!skip_prefix(head, "refs/heads/", &head))
694 die("BUG: remote HEAD points at non-head?");
696 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
697 branch_top->buf, head);
700 * otherwise, the next "git fetch" will
701 * simply fetch from HEAD without updating
702 * any remote-tracking branch, which is what
703 * we want.
705 } else {
706 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
708 /* Configure the remote */
709 if (value.len) {
710 strbuf_addf(&key, "remote.%s.fetch", option_origin);
711 git_config_set_multivar(key.buf, value.buf, "^$", 0);
712 strbuf_reset(&key);
714 if (option_mirror) {
715 strbuf_addf(&key, "remote.%s.mirror", option_origin);
716 git_config_set(key.buf, "true");
717 strbuf_reset(&key);
722 strbuf_release(&key);
723 strbuf_release(&value);
726 static void dissociate_from_references(void)
728 static const char* argv[] = { "repack", "-a", "-d", NULL };
730 if (run_command_v_opt(argv, RUN_GIT_CMD|RUN_COMMAND_NO_STDIN))
731 die(_("cannot repack to clean up"));
732 if (unlink(git_path("objects/info/alternates")) && errno != ENOENT)
733 die_errno(_("cannot unlink temporary alternates file"));
736 int cmd_clone(int argc, const char **argv, const char *prefix)
738 int is_bundle = 0, is_local;
739 struct stat buf;
740 const char *repo_name, *repo, *work_tree, *git_dir;
741 char *path, *dir;
742 int dest_exists;
743 const struct ref *refs, *remote_head;
744 const struct ref *remote_head_points_at;
745 const struct ref *our_head_points_at;
746 struct ref *mapped_refs;
747 const struct ref *ref;
748 struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
749 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
750 struct transport *transport = NULL;
751 const char *src_ref_prefix = "refs/heads/";
752 struct remote *remote;
753 int err = 0, complete_refs_before_fetch = 1;
755 struct refspec *refspec;
756 const char *fetch_pattern;
758 packet_trace_identity("clone");
759 argc = parse_options(argc, argv, prefix, builtin_clone_options,
760 builtin_clone_usage, 0);
762 if (argc > 2)
763 usage_msg_opt(_("Too many arguments."),
764 builtin_clone_usage, builtin_clone_options);
766 if (argc == 0)
767 usage_msg_opt(_("You must specify a repository to clone."),
768 builtin_clone_usage, builtin_clone_options);
770 if (option_single_branch == -1)
771 option_single_branch = option_depth ? 1 : 0;
773 if (option_mirror)
774 option_bare = 1;
776 if (option_bare) {
777 if (option_origin)
778 die(_("--bare and --origin %s options are incompatible."),
779 option_origin);
780 if (real_git_dir)
781 die(_("--bare and --separate-git-dir are incompatible."));
782 option_no_checkout = 1;
785 if (!option_origin)
786 option_origin = "origin";
788 repo_name = argv[0];
790 path = get_repo_path(repo_name, &is_bundle);
791 if (path)
792 repo = xstrdup(absolute_path(repo_name));
793 else if (!strchr(repo_name, ':'))
794 die(_("repository '%s' does not exist"), repo_name);
795 else
796 repo = repo_name;
798 /* no need to be strict, transport_set_option() will validate it again */
799 if (option_depth && atoi(option_depth) < 1)
800 die(_("depth %s is not a positive number"), option_depth);
802 if (argc == 2)
803 dir = xstrdup(argv[1]);
804 else
805 dir = guess_dir_name(repo_name, is_bundle, option_bare);
806 strip_trailing_slashes(dir);
808 dest_exists = !stat(dir, &buf);
809 if (dest_exists && !is_empty_dir(dir))
810 die(_("destination path '%s' already exists and is not "
811 "an empty directory."), dir);
813 strbuf_addf(&reflog_msg, "clone: from %s", repo);
815 if (option_bare)
816 work_tree = NULL;
817 else {
818 work_tree = getenv("GIT_WORK_TREE");
819 if (work_tree && !stat(work_tree, &buf))
820 die(_("working tree '%s' already exists."), work_tree);
823 if (option_bare || work_tree)
824 git_dir = xstrdup(dir);
825 else {
826 work_tree = dir;
827 git_dir = mkpathdup("%s/.git", dir);
830 atexit(remove_junk);
831 sigchain_push_common(remove_junk_on_signal);
833 if (!option_bare) {
834 if (safe_create_leading_directories_const(work_tree) < 0)
835 die_errno(_("could not create leading directories of '%s'"),
836 work_tree);
837 if (!dest_exists && mkdir(work_tree, 0777))
838 die_errno(_("could not create work tree dir '%s'"),
839 work_tree);
840 junk_work_tree = work_tree;
841 set_git_work_tree(work_tree);
844 junk_git_dir = git_dir;
845 if (safe_create_leading_directories_const(git_dir) < 0)
846 die(_("could not create leading directories of '%s'"), git_dir);
848 set_git_dir_init(git_dir, real_git_dir, 0);
849 if (real_git_dir) {
850 git_dir = real_git_dir;
851 junk_git_dir = real_git_dir;
854 if (0 <= option_verbosity) {
855 if (option_bare)
856 fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
857 else
858 fprintf(stderr, _("Cloning into '%s'...\n"), dir);
860 init_db(option_template, INIT_DB_QUIET);
861 write_config(&option_config);
863 git_config(git_default_config, NULL);
865 if (option_bare) {
866 if (option_mirror)
867 src_ref_prefix = "refs/";
868 strbuf_addstr(&branch_top, src_ref_prefix);
870 git_config_set("core.bare", "true");
871 } else {
872 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
875 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
876 strbuf_addf(&key, "remote.%s.url", option_origin);
877 git_config_set(key.buf, repo);
878 strbuf_reset(&key);
880 if (option_reference.nr)
881 setup_reference();
882 else if (option_dissociate) {
883 warning(_("--dissociate given, but there is no --reference"));
884 option_dissociate = 0;
887 fetch_pattern = value.buf;
888 refspec = parse_fetch_refspec(1, &fetch_pattern);
890 strbuf_reset(&value);
892 remote = remote_get(option_origin);
893 transport = transport_get(remote, remote->url[0]);
894 transport_set_verbosity(transport, option_verbosity, option_progress);
896 path = get_repo_path(remote->url[0], &is_bundle);
897 is_local = option_local != 0 && path && !is_bundle;
898 if (is_local) {
899 if (option_depth)
900 warning(_("--depth is ignored in local clones; use file:// instead."));
901 if (!access(mkpath("%s/shallow", path), F_OK)) {
902 if (option_local > 0)
903 warning(_("source repository is shallow, ignoring --local"));
904 is_local = 0;
907 if (option_local > 0 && !is_local)
908 warning(_("--local is ignored"));
909 transport->cloning = 1;
911 if (!transport->get_refs_list || (!is_local && !transport->fetch))
912 die(_("Don't know how to clone %s"), transport->url);
914 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
916 if (option_depth)
917 transport_set_option(transport, TRANS_OPT_DEPTH,
918 option_depth);
919 if (option_single_branch)
920 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
922 if (option_upload_pack)
923 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
924 option_upload_pack);
926 if (transport->smart_options && !option_depth)
927 transport->smart_options->check_self_contained_and_connected = 1;
929 refs = transport_get_remote_refs(transport);
931 if (refs) {
932 mapped_refs = wanted_peer_refs(refs, refspec);
934 * transport_get_remote_refs() may return refs with null sha-1
935 * in mapped_refs (see struct transport->get_refs_list
936 * comment). In that case we need fetch it early because
937 * remote_head code below relies on it.
939 * for normal clones, transport_get_remote_refs() should
940 * return reliable ref set, we can delay cloning until after
941 * remote HEAD check.
943 for (ref = refs; ref; ref = ref->next)
944 if (is_null_sha1(ref->old_sha1)) {
945 complete_refs_before_fetch = 0;
946 break;
949 if (!is_local && !complete_refs_before_fetch)
950 transport_fetch_refs(transport, mapped_refs);
952 remote_head = find_ref_by_name(refs, "HEAD");
953 remote_head_points_at =
954 guess_remote_head(remote_head, mapped_refs, 0);
956 if (option_branch) {
957 our_head_points_at =
958 find_remote_branch(mapped_refs, option_branch);
960 if (!our_head_points_at)
961 die(_("Remote branch %s not found in upstream %s"),
962 option_branch, option_origin);
964 else
965 our_head_points_at = remote_head_points_at;
967 else {
968 if (option_branch)
969 die(_("Remote branch %s not found in upstream %s"),
970 option_branch, option_origin);
972 warning(_("You appear to have cloned an empty repository."));
973 mapped_refs = NULL;
974 our_head_points_at = NULL;
975 remote_head_points_at = NULL;
976 remote_head = NULL;
977 option_no_checkout = 1;
978 if (!option_bare)
979 install_branch_config(0, "master", option_origin,
980 "refs/heads/master");
983 write_refspec_config(src_ref_prefix, our_head_points_at,
984 remote_head_points_at, &branch_top);
986 if (is_local)
987 clone_local(path, git_dir);
988 else if (refs && complete_refs_before_fetch)
989 transport_fetch_refs(transport, mapped_refs);
991 update_remote_refs(refs, mapped_refs, remote_head_points_at,
992 branch_top.buf, reflog_msg.buf, transport, !is_local);
994 update_head(our_head_points_at, remote_head, reflog_msg.buf);
996 transport_unlock_pack(transport);
997 transport_disconnect(transport);
999 if (option_dissociate)
1000 dissociate_from_references();
1002 junk_mode = JUNK_LEAVE_REPO;
1003 err = checkout();
1005 strbuf_release(&reflog_msg);
1006 strbuf_release(&branch_top);
1007 strbuf_release(&key);
1008 strbuf_release(&value);
1009 junk_mode = JUNK_LEAVE_ALL;
1011 free(refspec);
1012 return err;