blame-options.txt: place each -L option variation on its own line
[git.git] / builtin / clone.c
blobb6ffc6b4feb2dc56d8239cbfcea7d6467a652e6d
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 "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"
28 * Overall FIXMEs:
29 * - respect DB_ENVIRONMENT for .git/objects.
31 * Implementation notes:
32 * - dropping use-separate-remote and no-separate-remote compatibility
35 static const char * const builtin_clone_usage[] = {
36 N_("git clone [options] [--] <repo> [<dir>]"),
37 NULL
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;
52 static int opt_parse_reference(const struct option *opt, const char *arg, int unset)
54 struct string_list *option_reference = opt->value;
55 if (!arg)
56 return -1;
57 string_list_append(option_reference, arg);
58 return 0;
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()
104 static const char *argv_submodule[] = {
105 "submodule", "update", "--init", "--recursive", NULL
108 static char *get_repo_path(const char *repo, int *is_bundle)
110 static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
111 static char *bundle_suffix[] = { ".bundle", "" };
112 struct stat st;
113 int i;
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));
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));
150 return NULL;
153 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
155 const char *end = repo + strlen(repo), *start;
156 char *dir;
159 * Strip trailing spaces, slashes and /.git
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--;
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.
175 start = end;
176 while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
177 start--;
180 * Strip .{bundle,git}.
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;
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);
197 * Replace sequences of 'control' characters and whitespace
198 * with one ascii space, remove leading and trailing spaces.
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;
215 *out = '\0';
216 if (out > dir && prev_space)
217 out[-1] = '\0';
219 return dir;
222 static void strip_trailing_slashes(char *dir)
224 char *end = dir + strlen(dir);
226 while (dir < end - 1 && is_dir_sep(end[-1]))
227 end--;
228 *end = '\0';
231 static int add_one_reference(struct string_list_item *item, void *cb_data)
233 char *ref_git;
234 const char *repo;
235 struct strbuf alternate = STRBUF_INIT;
237 /* Beware: read_gitfile(), real_path() and mkpath() return static buffer */
238 ref_git = xstrdup(real_path(item->string));
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);
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);
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;
263 static void setup_reference(void)
265 for_each_string_list(&option_reference, add_one_reference, NULL);
268 static void copy_alternates(struct strbuf *src, struct strbuf *dst,
269 const char *src_repo)
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".
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.
283 FILE *in = fopen(src->buf, "r");
284 struct strbuf line = STRBUF_INIT;
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;
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);
298 strbuf_release(&line);
299 fclose(in);
302 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
303 const char *src_repo, int src_baselen)
305 struct dirent *de;
306 struct stat buf;
307 int src_len, dest_len;
308 DIR *dir;
310 dir = opendir(src->buf);
311 if (!dir)
312 die_errno(_("failed to open '%s'"), src->buf);
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);
323 strbuf_addch(src, '/');
324 src_len = src->len;
325 strbuf_addch(dest, '/');
326 dest_len = dest->len;
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;
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;
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;
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;
359 if (copy_file_with_time(dest->buf, src->buf, 0666))
360 die_errno(_("failed to copy file to '%s'"), dest->buf);
362 closedir(dir);
365 static void clone_local(const char *src_repo, const char *dest_repo)
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);
382 if (0 <= option_verbosity)
383 printf(_("done.\n"));
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;
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");
400 static void remove_junk(void)
402 struct strbuf sb = STRBUF_INIT;
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;
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);
422 if (junk_work_tree) {
423 strbuf_addstr(&sb, junk_work_tree);
424 remove_dir_recursively(&sb, 0);
425 strbuf_reset(&sb);
429 static void remove_junk_on_signal(int signo)
431 remove_junk();
432 sigchain_pop(signo);
433 raise(signo);
436 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
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);
445 if (ref)
446 return ref;
448 strbuf_addstr(&head, "refs/tags/");
449 strbuf_addstr(&head, branch);
450 ref = find_ref_by_name(refs, head.buf);
451 strbuf_release(&head);
453 return ref;
456 static struct ref *wanted_peer_refs(const struct ref *refs,
457 struct refspec *refspec)
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;
463 if (option_single_branch) {
464 struct ref *remote_head = NULL;
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));
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);
480 /* if --branch=tag, pull the requested tag explicitly */
481 get_fetch_map(remote_head, tag_refspec, &tail, 0);
483 } else
484 get_fetch_map(refs, refspec, &tail, 0);
486 if (!option_mirror && !option_single_branch)
487 get_fetch_map(refs, tag_refspec, &tail, 0);
489 return local_refs;
492 static void write_remote_refs(const struct ref *local_refs)
494 const struct ref *r;
496 for (r = local_refs; r; r = r->next) {
497 if (!r->peer_ref)
498 continue;
499 add_packed_ref(r->peer_ref->name, r->old_sha1);
502 pack_refs(PACK_REFS_ALL);
505 static void write_followtags(const struct ref *refs, const char *msg)
507 const struct ref *ref;
508 for (ref = refs; ref; ref = ref->next) {
509 if (prefixcmp(ref->name, "refs/tags/"))
510 continue;
511 if (!suffixcmp(ref->name, "^{}"))
512 continue;
513 if (!has_sha1_file(ref->old_sha1))
514 continue;
515 update_ref(msg, ref->name, ref->old_sha1,
516 NULL, 0, DIE_ON_ERR);
520 static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
522 struct ref **rm = cb_data;
523 struct ref *ref = *rm;
526 * Skip anything missing a peer_ref, which we are not
527 * actually going to write a ref for.
529 while (ref && !ref->peer_ref)
530 ref = ref->next;
531 /* Returning -1 notes "end of list" to the caller. */
532 if (!ref)
533 return -1;
535 hashcpy(sha1, ref->old_sha1);
536 *rm = ref->next;
537 return 0;
540 static void update_remote_refs(const struct ref *refs,
541 const struct ref *mapped_refs,
542 const struct ref *remote_head_points_at,
543 const char *branch_top,
544 const char *msg)
546 const struct ref *rm = mapped_refs;
548 if (check_everything_connected(iterate_ref_map, 0, &rm))
549 die(_("remote did not send all necessary objects"));
551 if (refs) {
552 write_remote_refs(mapped_refs);
553 if (option_single_branch)
554 write_followtags(refs, msg);
557 if (remote_head_points_at && !option_bare) {
558 struct strbuf head_ref = STRBUF_INIT;
559 strbuf_addstr(&head_ref, branch_top);
560 strbuf_addstr(&head_ref, "HEAD");
561 create_symref(head_ref.buf,
562 remote_head_points_at->peer_ref->name,
563 msg);
567 static void update_head(const struct ref *our, const struct ref *remote,
568 const char *msg)
570 if (our && !prefixcmp(our->name, "refs/heads/")) {
571 /* Local default branch link */
572 create_symref("HEAD", our->name, NULL);
573 if (!option_bare) {
574 const char *head = skip_prefix(our->name, "refs/heads/");
575 update_ref(msg, "HEAD", our->old_sha1, NULL, 0, DIE_ON_ERR);
576 install_branch_config(0, head, option_origin, our->name);
578 } else if (our) {
579 struct commit *c = lookup_commit_reference(our->old_sha1);
580 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
581 update_ref(msg, "HEAD", c->object.sha1,
582 NULL, REF_NODEREF, DIE_ON_ERR);
583 } else if (remote) {
585 * We know remote HEAD points to a non-branch, or
586 * HEAD points to a branch but we don't know which one.
587 * Detach HEAD in all these cases.
589 update_ref(msg, "HEAD", remote->old_sha1,
590 NULL, REF_NODEREF, DIE_ON_ERR);
594 static int checkout(void)
596 unsigned char sha1[20];
597 char *head;
598 struct lock_file *lock_file;
599 struct unpack_trees_options opts;
600 struct tree *tree;
601 struct tree_desc t;
602 int err = 0, fd;
604 if (option_no_checkout)
605 return 0;
607 head = resolve_refdup("HEAD", sha1, 1, NULL);
608 if (!head) {
609 warning(_("remote HEAD refers to nonexistent ref, "
610 "unable to checkout.\n"));
611 return 0;
613 if (!strcmp(head, "HEAD")) {
614 if (advice_detached_head)
615 detach_advice(sha1_to_hex(sha1));
616 } else {
617 if (prefixcmp(head, "refs/heads/"))
618 die(_("HEAD not found below refs/heads!"));
620 free(head);
622 /* We need to be in the new work tree for the checkout */
623 setup_work_tree();
625 lock_file = xcalloc(1, sizeof(struct lock_file));
626 fd = hold_locked_index(lock_file, 1);
628 memset(&opts, 0, sizeof opts);
629 opts.update = 1;
630 opts.merge = 1;
631 opts.fn = oneway_merge;
632 opts.verbose_update = (option_verbosity >= 0);
633 opts.src_index = &the_index;
634 opts.dst_index = &the_index;
636 tree = parse_tree_indirect(sha1);
637 parse_tree(tree);
638 init_tree_desc(&t, tree->buffer, tree->size);
639 if (unpack_trees(1, &t, &opts) < 0)
640 die(_("unable to checkout working tree"));
642 if (write_cache(fd, active_cache, active_nr) ||
643 commit_locked_index(lock_file))
644 die(_("unable to write new index file"));
646 err |= run_hook(NULL, "post-checkout", sha1_to_hex(null_sha1),
647 sha1_to_hex(sha1), "1", NULL);
649 if (!err && option_recursive)
650 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
652 return err;
655 static int write_one_config(const char *key, const char *value, void *data)
657 return git_config_set_multivar(key, value ? value : "true", "^$", 0);
660 static void write_config(struct string_list *config)
662 int i;
664 for (i = 0; i < config->nr; i++) {
665 if (git_config_parse_parameter(config->items[i].string,
666 write_one_config, NULL) < 0)
667 die("unable to write parameters to config file");
671 static void write_refspec_config(const char* src_ref_prefix,
672 const struct ref* our_head_points_at,
673 const struct ref* remote_head_points_at, struct strbuf* branch_top)
675 struct strbuf key = STRBUF_INIT;
676 struct strbuf value = STRBUF_INIT;
678 if (option_mirror || !option_bare) {
679 if (option_single_branch && !option_mirror) {
680 if (option_branch) {
681 if (strstr(our_head_points_at->name, "refs/tags/"))
682 strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
683 our_head_points_at->name);
684 else
685 strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
686 branch_top->buf, option_branch);
687 } else if (remote_head_points_at) {
688 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
689 branch_top->buf,
690 skip_prefix(remote_head_points_at->name, "refs/heads/"));
693 * otherwise, the next "git fetch" will
694 * simply fetch from HEAD without updating
695 * any remote tracking branch, which is what
696 * we want.
698 } else {
699 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
701 /* Configure the remote */
702 if (value.len) {
703 strbuf_addf(&key, "remote.%s.fetch", option_origin);
704 git_config_set_multivar(key.buf, value.buf, "^$", 0);
705 strbuf_reset(&key);
707 if (option_mirror) {
708 strbuf_addf(&key, "remote.%s.mirror", option_origin);
709 git_config_set(key.buf, "true");
710 strbuf_reset(&key);
715 strbuf_release(&key);
716 strbuf_release(&value);
719 int cmd_clone(int argc, const char **argv, const char *prefix)
721 int is_bundle = 0, is_local;
722 struct stat buf;
723 const char *repo_name, *repo, *work_tree, *git_dir;
724 char *path, *dir;
725 int dest_exists;
726 const struct ref *refs, *remote_head;
727 const struct ref *remote_head_points_at;
728 const struct ref *our_head_points_at;
729 struct ref *mapped_refs;
730 const struct ref *ref;
731 struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
732 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
733 struct transport *transport = NULL;
734 const char *src_ref_prefix = "refs/heads/";
735 struct remote *remote;
736 int err = 0, complete_refs_before_fetch = 1;
738 struct refspec *refspec;
739 const char *fetch_pattern;
741 junk_pid = getpid();
743 packet_trace_identity("clone");
744 argc = parse_options(argc, argv, prefix, builtin_clone_options,
745 builtin_clone_usage, 0);
747 if (argc > 2)
748 usage_msg_opt(_("Too many arguments."),
749 builtin_clone_usage, builtin_clone_options);
751 if (argc == 0)
752 usage_msg_opt(_("You must specify a repository to clone."),
753 builtin_clone_usage, builtin_clone_options);
755 if (option_single_branch == -1)
756 option_single_branch = option_depth ? 1 : 0;
758 if (option_mirror)
759 option_bare = 1;
761 if (option_bare) {
762 if (option_origin)
763 die(_("--bare and --origin %s options are incompatible."),
764 option_origin);
765 if (real_git_dir)
766 die(_("--bare and --separate-git-dir are incompatible."));
767 option_no_checkout = 1;
770 if (!option_origin)
771 option_origin = "origin";
773 repo_name = argv[0];
775 path = get_repo_path(repo_name, &is_bundle);
776 if (path)
777 repo = xstrdup(absolute_path(repo_name));
778 else if (!strchr(repo_name, ':'))
779 die(_("repository '%s' does not exist"), repo_name);
780 else
781 repo = repo_name;
782 is_local = option_local != 0 && path && !is_bundle;
783 if (is_local && option_depth)
784 warning(_("--depth is ignored in local clones; use file:// instead."));
785 if (option_local > 0 && !is_local)
786 warning(_("--local is ignored"));
788 if (argc == 2)
789 dir = xstrdup(argv[1]);
790 else
791 dir = guess_dir_name(repo_name, is_bundle, option_bare);
792 strip_trailing_slashes(dir);
794 dest_exists = !stat(dir, &buf);
795 if (dest_exists && !is_empty_dir(dir))
796 die(_("destination path '%s' already exists and is not "
797 "an empty directory."), dir);
799 strbuf_addf(&reflog_msg, "clone: from %s", repo);
801 if (option_bare)
802 work_tree = NULL;
803 else {
804 work_tree = getenv("GIT_WORK_TREE");
805 if (work_tree && !stat(work_tree, &buf))
806 die(_("working tree '%s' already exists."), work_tree);
809 if (option_bare || work_tree)
810 git_dir = xstrdup(dir);
811 else {
812 work_tree = dir;
813 git_dir = mkpathdup("%s/.git", dir);
816 if (!option_bare) {
817 junk_work_tree = work_tree;
818 if (safe_create_leading_directories_const(work_tree) < 0)
819 die_errno(_("could not create leading directories of '%s'"),
820 work_tree);
821 if (!dest_exists && mkdir(work_tree, 0777))
822 die_errno(_("could not create work tree dir '%s'."),
823 work_tree);
824 set_git_work_tree(work_tree);
826 junk_git_dir = git_dir;
827 atexit(remove_junk);
828 sigchain_push_common(remove_junk_on_signal);
830 if (safe_create_leading_directories_const(git_dir) < 0)
831 die(_("could not create leading directories of '%s'"), git_dir);
833 set_git_dir_init(git_dir, real_git_dir, 0);
834 if (real_git_dir) {
835 git_dir = real_git_dir;
836 junk_git_dir = real_git_dir;
839 if (0 <= option_verbosity) {
840 if (option_bare)
841 printf(_("Cloning into bare repository '%s'...\n"), dir);
842 else
843 printf(_("Cloning into '%s'...\n"), dir);
845 init_db(option_template, INIT_DB_QUIET);
846 write_config(&option_config);
848 git_config(git_default_config, NULL);
850 if (option_bare) {
851 if (option_mirror)
852 src_ref_prefix = "refs/";
853 strbuf_addstr(&branch_top, src_ref_prefix);
855 git_config_set("core.bare", "true");
856 } else {
857 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
860 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
861 strbuf_addf(&key, "remote.%s.url", option_origin);
862 git_config_set(key.buf, repo);
863 strbuf_reset(&key);
865 if (option_reference.nr)
866 setup_reference();
868 fetch_pattern = value.buf;
869 refspec = parse_fetch_refspec(1, &fetch_pattern);
871 strbuf_reset(&value);
873 remote = remote_get(option_origin);
874 transport = transport_get(remote, remote->url[0]);
876 if (!is_local) {
877 if (!transport->get_refs_list || !transport->fetch)
878 die(_("Don't know how to clone %s"), transport->url);
880 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
882 if (option_depth)
883 transport_set_option(transport, TRANS_OPT_DEPTH,
884 option_depth);
885 if (option_single_branch)
886 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
888 transport_set_verbosity(transport, option_verbosity, option_progress);
890 if (option_upload_pack)
891 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
892 option_upload_pack);
895 refs = transport_get_remote_refs(transport);
897 if (refs) {
898 mapped_refs = wanted_peer_refs(refs, refspec);
900 * transport_get_remote_refs() may return refs with null sha-1
901 * in mapped_refs (see struct transport->get_refs_list
902 * comment). In that case we need fetch it early because
903 * remote_head code below relies on it.
905 * for normal clones, transport_get_remote_refs() should
906 * return reliable ref set, we can delay cloning until after
907 * remote HEAD check.
909 for (ref = refs; ref; ref = ref->next)
910 if (is_null_sha1(ref->old_sha1)) {
911 complete_refs_before_fetch = 0;
912 break;
915 if (!is_local && !complete_refs_before_fetch)
916 transport_fetch_refs(transport, mapped_refs);
918 remote_head = find_ref_by_name(refs, "HEAD");
919 remote_head_points_at =
920 guess_remote_head(remote_head, mapped_refs, 0);
922 if (option_branch) {
923 our_head_points_at =
924 find_remote_branch(mapped_refs, option_branch);
926 if (!our_head_points_at)
927 die(_("Remote branch %s not found in upstream %s"),
928 option_branch, option_origin);
930 else
931 our_head_points_at = remote_head_points_at;
933 else {
934 warning(_("You appear to have cloned an empty repository."));
935 mapped_refs = NULL;
936 our_head_points_at = NULL;
937 remote_head_points_at = NULL;
938 remote_head = NULL;
939 option_no_checkout = 1;
940 if (!option_bare)
941 install_branch_config(0, "master", option_origin,
942 "refs/heads/master");
945 write_refspec_config(src_ref_prefix, our_head_points_at,
946 remote_head_points_at, &branch_top);
948 if (is_local)
949 clone_local(path, git_dir);
950 else if (refs && complete_refs_before_fetch)
951 transport_fetch_refs(transport, mapped_refs);
953 update_remote_refs(refs, mapped_refs, remote_head_points_at,
954 branch_top.buf, reflog_msg.buf);
956 update_head(our_head_points_at, remote_head, reflog_msg.buf);
958 transport_unlock_pack(transport);
959 transport_disconnect(transport);
961 junk_mode = JUNK_LEAVE_REPO;
962 err = checkout();
964 strbuf_release(&reflog_msg);
965 strbuf_release(&branch_top);
966 strbuf_release(&key);
967 strbuf_release(&value);
968 junk_mode = JUNK_LEAVE_ALL;
969 return err;