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.
11 #define USE_THE_INDEX_COMPATIBILITY_MACROS
15 #include "parse-options.h"
16 #include "fetch-pack.h"
19 #include "object-store.h"
21 #include "tree-walk.h"
22 #include "unpack-trees.h"
23 #include "transport.h"
29 #include "run-command.h"
30 #include "connected.h"
32 #include "list-objects-filter-options.h"
33 #include "object-store.h"
37 * - respect DB_ENVIRONMENT for .git/objects.
39 * Implementation notes:
40 * - dropping use-separate-remote and no-separate-remote compatibility
43 static const char * const builtin_clone_usage[] = {
44 N_("git clone [<options>] [--] <repo> [<dir>]"),
48 static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
49 static int option_local = -1, option_no_hardlinks, option_shared;
50 static int option_no_tags;
51 static int option_shallow_submodules;
53 static char *option_template, *option_depth, *option_since;
54 static char *option_origin = NULL;
55 static char *option_branch = NULL;
56 static struct string_list option_not = STRING_LIST_INIT_NODUP;
57 static const char *real_git_dir;
58 static char *option_upload_pack = "git-upload-pack";
59 static int option_verbosity;
60 static int option_progress = -1;
61 static enum transport_family family;
62 static struct string_list option_config = STRING_LIST_INIT_NODUP;
63 static struct string_list option_required_reference = STRING_LIST_INIT_NODUP;
64 static struct string_list option_optional_reference = STRING_LIST_INIT_NODUP;
65 static int option_dissociate;
66 static int max_jobs = -1;
67 static struct string_list option_recurse_submodules = STRING_LIST_INIT_NODUP;
68 static struct list_objects_filter_options filter_options;
69 static struct string_list server_options = STRING_LIST_INIT_NODUP;
70 static int option_remote_submodules;
72 static int recurse_submodules_cb(const struct option *opt,
73 const char *arg, int unset)
76 string_list_clear((struct string_list *)opt->value, 0);
78 string_list_append((struct string_list *)opt->value, arg);
80 string_list_append((struct string_list *)opt->value,
81 (const char *)opt->defval);
86 static struct option builtin_clone_options[] = {
87 OPT__VERBOSITY(&option_verbosity),
88 OPT_BOOL(0, "progress", &option_progress,
89 N_("force progress reporting")),
90 OPT_BOOL('n', "no-checkout", &option_no_checkout,
91 N_("don't create a checkout")),
92 OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
93 OPT_HIDDEN_BOOL(0, "naked", &option_bare,
94 N_("create a bare repository")),
95 OPT_BOOL(0, "mirror", &option_mirror,
96 N_("create a mirror repository (implies bare)")),
97 OPT_BOOL('l', "local", &option_local,
98 N_("to clone from a local repository")),
99 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
100 N_("don't use local hardlinks, always copy")),
101 OPT_BOOL('s', "shared", &option_shared,
102 N_("setup as shared repository")),
103 OPT_ALIAS(0, "recursive", "recurse-submodules"),
104 { OPTION_CALLBACK, 0, "recurse-submodules", &option_recurse_submodules,
105 N_("pathspec"), N_("initialize submodules in the clone"),
106 PARSE_OPT_OPTARG, recurse_submodules_cb, (intptr_t)"." },
107 OPT_INTEGER('j', "jobs", &max_jobs,
108 N_("number of submodules cloned in parallel")),
109 OPT_STRING(0, "template", &option_template, N_("template-directory"),
110 N_("directory from which templates will be used")),
111 OPT_STRING_LIST(0, "reference", &option_required_reference, N_("repo"),
112 N_("reference repository")),
113 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference,
114 N_("repo"), N_("reference repository")),
115 OPT_BOOL(0, "dissociate", &option_dissociate,
116 N_("use --reference only while cloning")),
117 OPT_STRING('o', "origin", &option_origin, N_("name"),
118 N_("use <name> instead of 'origin' to track upstream")),
119 OPT_STRING('b', "branch", &option_branch, N_("branch"),
120 N_("checkout <branch> instead of the remote's HEAD")),
121 OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
122 N_("path to git-upload-pack on the remote")),
123 OPT_STRING(0, "depth", &option_depth, N_("depth"),
124 N_("create a shallow clone of that depth")),
125 OPT_STRING(0, "shallow-since", &option_since, N_("time"),
126 N_("create a shallow clone since a specific time")),
127 OPT_STRING_LIST(0, "shallow-exclude", &option_not, N_("revision"),
128 N_("deepen history of shallow clone, excluding rev")),
129 OPT_BOOL(0, "single-branch", &option_single_branch,
130 N_("clone only one branch, HEAD or --branch")),
131 OPT_BOOL(0, "no-tags", &option_no_tags,
132 N_("don't clone any tags, and make later fetches not to follow them")),
133 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules,
134 N_("any cloned submodules will be shallow")),
135 OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
136 N_("separate git dir from working tree")),
137 OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
138 N_("set config inside the new repository")),
139 OPT_STRING_LIST(0, "server-option", &server_options,
140 N_("server-specific"), N_("option to transmit")),
141 OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
142 TRANSPORT_FAMILY_IPV4),
143 OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
144 TRANSPORT_FAMILY_IPV6),
145 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
146 OPT_BOOL(0, "remote-submodules", &option_remote_submodules,
147 N_("any cloned submodules will use their remote-tracking branch")),
151 static const char *get_repo_path_1(struct strbuf *path, int *is_bundle)
153 static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
154 static char *bundle_suffix[] = { ".bundle", "" };
155 size_t baselen = path->len;
159 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
160 strbuf_setlen(path, baselen);
161 strbuf_addstr(path, suffix[i]);
162 if (stat(path->buf, &st))
164 if (S_ISDIR(st.st_mode) && is_git_directory(path->buf)) {
167 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
168 /* Is it a "gitfile"? */
171 int len, fd = open(path->buf, O_RDONLY);
174 len = read_in_full(fd, signature, 8);
176 if (len != 8 || strncmp(signature, "gitdir: ", 8))
178 dst = read_gitfile(path->buf);
186 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
187 strbuf_setlen(path, baselen);
188 strbuf_addstr(path, bundle_suffix[i]);
189 if (!stat(path->buf, &st) && S_ISREG(st.st_mode)) {
198 static char *get_repo_path(const char *repo, int *is_bundle)
200 struct strbuf path = STRBUF_INIT;
204 strbuf_addstr(&path, repo);
205 raw = get_repo_path_1(&path, is_bundle);
206 canon = raw ? absolute_pathdup(raw) : NULL;
207 strbuf_release(&path);
211 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
213 const char *end = repo + strlen(repo), *start, *ptr;
220 start = strstr(repo, "://");
227 * Skip authentication data. The stripping does happen
228 * greedily, such that we strip up to the last '@' inside
231 for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
237 * Strip trailing spaces, slashes and /.git
239 while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
241 if (end - start > 5 && is_dir_sep(end[-5]) &&
242 !strncmp(end - 4, ".git", 4)) {
244 while (start < end && is_dir_sep(end[-1]))
249 * Strip trailing port number if we've got only a
250 * hostname (that is, there is no dir separator but a
251 * colon). This check is required such that we do not
252 * strip URI's like '/foo/bar:2222.git', which should
253 * result in a dir '2222' being guessed due to backwards
256 if (memchr(start, '/', end - start) == NULL
257 && memchr(start, ':', end - start) != NULL) {
259 while (start < ptr && isdigit(ptr[-1]) && ptr[-1] != ':')
261 if (start < ptr && ptr[-1] == ':')
266 * Find last component. To remain backwards compatible we
267 * also regard colons as path separators, such that
268 * cloning a repository 'foo:bar.git' would result in a
269 * directory 'bar' being guessed.
272 while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
277 * Strip .{bundle,git}.
280 strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
282 if (!len || (len == 1 && *start == '/'))
283 die(_("No directory name could be guessed.\n"
284 "Please specify a directory on the command line"));
287 dir = xstrfmt("%.*s.git", (int)len, start);
289 dir = xstrndup(start, len);
291 * Replace sequences of 'control' characters and whitespace
292 * with one ascii space, remove leading and trailing spaces.
296 int prev_space = 1 /* strip leading whitespace */;
297 for (end = dir; *end; ++end) {
299 if ((unsigned char)ch < '\x20')
310 if (out > dir && prev_space)
316 static void strip_trailing_slashes(char *dir)
318 char *end = dir + strlen(dir);
320 while (dir < end - 1 && is_dir_sep(end[-1]))
325 static int add_one_reference(struct string_list_item *item, void *cb_data)
327 struct strbuf err = STRBUF_INIT;
328 int *required = cb_data;
329 char *ref_git = compute_alternate_path(item->string, &err);
336 _("info: Could not add alternate for '%s': %s\n"),
337 item->string, err.buf);
339 struct strbuf sb = STRBUF_INIT;
340 strbuf_addf(&sb, "%s/objects", ref_git);
341 add_to_alternates_file(sb.buf);
345 strbuf_release(&err);
350 static void setup_reference(void)
353 for_each_string_list(&option_required_reference,
354 add_one_reference, &required);
356 for_each_string_list(&option_optional_reference,
357 add_one_reference, &required);
360 static void copy_alternates(struct strbuf *src, const char *src_repo)
363 * Read from the source objects/info/alternates file
364 * and copy the entries to corresponding file in the
365 * destination repository with add_to_alternates_file().
366 * Both src and dst have "$path/objects/info/alternates".
368 * Instead of copying bit-for-bit from the original,
369 * we need to append to existing one so that the already
370 * created entry via "clone -s" is not lost, and also
371 * to turn entries with paths relative to the original
372 * absolute, so that they can be used in the new repository.
374 FILE *in = xfopen(src->buf, "r");
375 struct strbuf line = STRBUF_INIT;
377 while (strbuf_getline(&line, in) != EOF) {
379 if (!line.len || line.buf[0] == '#')
381 if (is_absolute_path(line.buf)) {
382 add_to_alternates_file(line.buf);
385 abs_path = mkpathdup("%s/objects/%s", src_repo, line.buf);
386 if (!normalize_path_copy(abs_path, abs_path))
387 add_to_alternates_file(abs_path);
389 warning("skipping invalid relative alternate: %s/%s",
393 strbuf_release(&line);
397 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
398 const char *src_repo, int src_baselen)
402 int src_len, dest_len;
405 dir = opendir(src->buf);
407 die_errno(_("failed to open '%s'"), src->buf);
409 if (mkdir(dest->buf, 0777)) {
411 die_errno(_("failed to create directory '%s'"), dest->buf);
412 else if (stat(dest->buf, &buf))
413 die_errno(_("failed to stat '%s'"), dest->buf);
414 else if (!S_ISDIR(buf.st_mode))
415 die(_("%s exists and is not a directory"), dest->buf);
418 strbuf_addch(src, '/');
420 strbuf_addch(dest, '/');
421 dest_len = dest->len;
423 while ((de = readdir(dir)) != NULL) {
424 strbuf_setlen(src, src_len);
425 strbuf_addstr(src, de->d_name);
426 strbuf_setlen(dest, dest_len);
427 strbuf_addstr(dest, de->d_name);
428 if (stat(src->buf, &buf)) {
429 warning (_("failed to stat %s\n"), src->buf);
432 if (S_ISDIR(buf.st_mode)) {
433 if (de->d_name[0] != '.')
434 copy_or_link_directory(src, dest,
435 src_repo, src_baselen);
439 /* Files that cannot be copied bit-for-bit... */
440 if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
441 copy_alternates(src, src_repo);
445 if (unlink(dest->buf) && errno != ENOENT)
446 die_errno(_("failed to unlink '%s'"), dest->buf);
447 if (!option_no_hardlinks) {
448 if (!link(src->buf, dest->buf))
450 if (option_local > 0)
451 die_errno(_("failed to create link '%s'"), dest->buf);
452 option_no_hardlinks = 1;
454 if (copy_file_with_time(dest->buf, src->buf, 0666))
455 die_errno(_("failed to copy file to '%s'"), dest->buf);
460 static void clone_local(const char *src_repo, const char *dest_repo)
463 struct strbuf alt = STRBUF_INIT;
464 get_common_dir(&alt, src_repo);
465 strbuf_addstr(&alt, "/objects");
466 add_to_alternates_file(alt.buf);
467 strbuf_release(&alt);
469 struct strbuf src = STRBUF_INIT;
470 struct strbuf dest = STRBUF_INIT;
471 get_common_dir(&src, src_repo);
472 get_common_dir(&dest, dest_repo);
473 strbuf_addstr(&src, "/objects");
474 strbuf_addstr(&dest, "/objects");
475 copy_or_link_directory(&src, &dest, src_repo, src.len);
476 strbuf_release(&src);
477 strbuf_release(&dest);
480 if (0 <= option_verbosity)
481 fprintf(stderr, _("done.\n"));
484 static const char *junk_work_tree;
485 static int junk_work_tree_flags;
486 static const char *junk_git_dir;
487 static int junk_git_dir_flags;
492 } junk_mode = JUNK_LEAVE_NONE;
494 static const char junk_leave_repo_msg[] =
495 N_("Clone succeeded, but checkout failed.\n"
496 "You can inspect what was checked out with 'git status'\n"
497 "and retry with 'git restore --source=HEAD :/'\n");
499 static void remove_junk(void)
501 struct strbuf sb = STRBUF_INIT;
504 case JUNK_LEAVE_REPO:
505 warning("%s", _(junk_leave_repo_msg));
510 /* proceed to removal */
515 strbuf_addstr(&sb, junk_git_dir);
516 remove_dir_recursively(&sb, junk_git_dir_flags);
519 if (junk_work_tree) {
520 strbuf_addstr(&sb, junk_work_tree);
521 remove_dir_recursively(&sb, junk_work_tree_flags);
526 static void remove_junk_on_signal(int signo)
533 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
536 struct strbuf head = STRBUF_INIT;
537 strbuf_addstr(&head, "refs/heads/");
538 strbuf_addstr(&head, branch);
539 ref = find_ref_by_name(refs, head.buf);
540 strbuf_release(&head);
545 strbuf_addstr(&head, "refs/tags/");
546 strbuf_addstr(&head, branch);
547 ref = find_ref_by_name(refs, head.buf);
548 strbuf_release(&head);
553 static struct ref *wanted_peer_refs(const struct ref *refs,
554 struct refspec *refspec)
556 struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
557 struct ref *local_refs = head;
558 struct ref **tail = head ? &head->next : &local_refs;
560 if (option_single_branch) {
561 struct ref *remote_head = NULL;
564 remote_head = guess_remote_head(head, refs, 0);
568 remote_head = copy_ref(find_remote_branch(refs, option_branch));
571 if (!remote_head && option_branch)
572 warning(_("Could not find remote branch %s to clone."),
576 for (i = 0; i < refspec->nr; i++)
577 get_fetch_map(remote_head, &refspec->items[i],
580 /* if --branch=tag, pull the requested tag explicitly */
581 get_fetch_map(remote_head, tag_refspec, &tail, 0);
585 for (i = 0; i < refspec->nr; i++)
586 get_fetch_map(refs, &refspec->items[i], &tail, 0);
589 if (!option_mirror && !option_single_branch && !option_no_tags)
590 get_fetch_map(refs, tag_refspec, &tail, 0);
595 static void write_remote_refs(const struct ref *local_refs)
599 struct ref_transaction *t;
600 struct strbuf err = STRBUF_INIT;
602 t = ref_transaction_begin(&err);
606 for (r = local_refs; r; r = r->next) {
609 if (ref_transaction_create(t, r->peer_ref->name, &r->old_oid,
614 if (initial_ref_transaction_commit(t, &err))
617 strbuf_release(&err);
618 ref_transaction_free(t);
621 static void write_followtags(const struct ref *refs, const char *msg)
623 const struct ref *ref;
624 for (ref = refs; ref; ref = ref->next) {
625 if (!starts_with(ref->name, "refs/tags/"))
627 if (ends_with(ref->name, "^{}"))
629 if (!has_object_file(&ref->old_oid))
631 update_ref(msg, ref->name, &ref->old_oid, NULL, 0,
632 UPDATE_REFS_DIE_ON_ERR);
636 static int iterate_ref_map(void *cb_data, struct object_id *oid)
638 struct ref **rm = cb_data;
639 struct ref *ref = *rm;
642 * Skip anything missing a peer_ref, which we are not
643 * actually going to write a ref for.
645 while (ref && !ref->peer_ref)
647 /* Returning -1 notes "end of list" to the caller. */
651 oidcpy(oid, &ref->old_oid);
656 static void update_remote_refs(const struct ref *refs,
657 const struct ref *mapped_refs,
658 const struct ref *remote_head_points_at,
659 const char *branch_top,
661 struct transport *transport,
662 int check_connectivity,
665 const struct ref *rm = mapped_refs;
667 if (check_connectivity) {
668 struct check_connected_options opt = CHECK_CONNECTED_INIT;
670 opt.transport = transport;
671 opt.progress = transport->progress;
672 opt.check_refs_only = !!check_refs_only;
674 if (check_connected(iterate_ref_map, &rm, &opt))
675 die(_("remote did not send all necessary objects"));
679 write_remote_refs(mapped_refs);
680 if (option_single_branch && !option_no_tags)
681 write_followtags(refs, msg);
684 if (remote_head_points_at && !option_bare) {
685 struct strbuf head_ref = STRBUF_INIT;
686 strbuf_addstr(&head_ref, branch_top);
687 strbuf_addstr(&head_ref, "HEAD");
688 if (create_symref(head_ref.buf,
689 remote_head_points_at->peer_ref->name,
691 die(_("unable to update %s"), head_ref.buf);
692 strbuf_release(&head_ref);
696 static void update_head(const struct ref *our, const struct ref *remote,
700 if (our && skip_prefix(our->name, "refs/heads/", &head)) {
701 /* Local default branch link */
702 if (create_symref("HEAD", our->name, NULL) < 0)
703 die(_("unable to update HEAD"));
705 update_ref(msg, "HEAD", &our->old_oid, NULL, 0,
706 UPDATE_REFS_DIE_ON_ERR);
707 install_branch_config(0, head, option_origin, our->name);
710 struct commit *c = lookup_commit_reference(the_repository,
712 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
713 update_ref(msg, "HEAD", &c->object.oid, NULL, REF_NO_DEREF,
714 UPDATE_REFS_DIE_ON_ERR);
717 * We know remote HEAD points to a non-branch, or
718 * HEAD points to a branch but we don't know which one.
719 * Detach HEAD in all these cases.
721 update_ref(msg, "HEAD", &remote->old_oid, NULL, REF_NO_DEREF,
722 UPDATE_REFS_DIE_ON_ERR);
726 static int checkout(int submodule_progress)
728 struct object_id oid;
730 struct lock_file lock_file = LOCK_INIT;
731 struct unpack_trees_options opts;
736 if (option_no_checkout)
739 head = resolve_refdup("HEAD", RESOLVE_REF_READING, &oid, NULL);
741 warning(_("remote HEAD refers to nonexistent ref, "
742 "unable to checkout.\n"));
745 if (!strcmp(head, "HEAD")) {
746 if (advice_detached_head)
747 detach_advice(oid_to_hex(&oid));
749 if (!starts_with(head, "refs/heads/"))
750 die(_("HEAD not found below refs/heads!"));
754 /* We need to be in the new work tree for the checkout */
757 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
759 memset(&opts, 0, sizeof opts);
763 opts.fn = oneway_merge;
764 opts.verbose_update = (option_verbosity >= 0);
765 opts.src_index = &the_index;
766 opts.dst_index = &the_index;
768 tree = parse_tree_indirect(&oid);
770 init_tree_desc(&t, tree->buffer, tree->size);
771 if (unpack_trees(1, &t, &opts) < 0)
772 die(_("unable to checkout working tree"));
774 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
775 die(_("unable to write new index file"));
777 err |= run_hook_le(NULL, "post-checkout", sha1_to_hex(null_sha1),
778 oid_to_hex(&oid), "1", NULL);
780 if (!err && (option_recurse_submodules.nr > 0)) {
781 struct argv_array args = ARGV_ARRAY_INIT;
782 argv_array_pushl(&args, "submodule", "update", "--init", "--recursive", NULL);
784 if (option_shallow_submodules == 1)
785 argv_array_push(&args, "--depth=1");
788 argv_array_pushf(&args, "--jobs=%d", max_jobs);
790 if (submodule_progress)
791 argv_array_push(&args, "--progress");
793 if (option_verbosity < 0)
794 argv_array_push(&args, "--quiet");
796 if (option_remote_submodules) {
797 argv_array_push(&args, "--remote");
798 argv_array_push(&args, "--no-fetch");
801 err = run_command_v_opt(args.argv, RUN_GIT_CMD);
802 argv_array_clear(&args);
808 static int write_one_config(const char *key, const char *value, void *data)
810 return git_config_set_multivar_gently(key,
811 value ? value : "true",
812 CONFIG_REGEX_NONE, 0);
815 static void write_config(struct string_list *config)
819 for (i = 0; i < config->nr; i++) {
820 if (git_config_parse_parameter(config->items[i].string,
821 write_one_config, NULL) < 0)
822 die(_("unable to write parameters to config file"));
826 static void write_refspec_config(const char *src_ref_prefix,
827 const struct ref *our_head_points_at,
828 const struct ref *remote_head_points_at,
829 struct strbuf *branch_top)
831 struct strbuf key = STRBUF_INIT;
832 struct strbuf value = STRBUF_INIT;
834 if (option_mirror || !option_bare) {
835 if (option_single_branch && !option_mirror) {
837 if (starts_with(our_head_points_at->name, "refs/tags/"))
838 strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
839 our_head_points_at->name);
841 strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
842 branch_top->buf, option_branch);
843 } else if (remote_head_points_at) {
844 const char *head = remote_head_points_at->name;
845 if (!skip_prefix(head, "refs/heads/", &head))
846 BUG("remote HEAD points at non-head?");
848 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
849 branch_top->buf, head);
852 * otherwise, the next "git fetch" will
853 * simply fetch from HEAD without updating
854 * any remote-tracking branch, which is what
858 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
860 /* Configure the remote */
862 strbuf_addf(&key, "remote.%s.fetch", option_origin);
863 git_config_set_multivar(key.buf, value.buf, "^$", 0);
867 strbuf_addf(&key, "remote.%s.mirror", option_origin);
868 git_config_set(key.buf, "true");
874 strbuf_release(&key);
875 strbuf_release(&value);
878 static void dissociate_from_references(void)
880 static const char* argv[] = { "repack", "-a", "-d", NULL };
881 char *alternates = git_pathdup("objects/info/alternates");
883 if (!access(alternates, F_OK)) {
884 if (run_command_v_opt(argv, RUN_GIT_CMD|RUN_COMMAND_NO_STDIN))
885 die(_("cannot repack to clean up"));
886 if (unlink(alternates) && errno != ENOENT)
887 die_errno(_("cannot unlink temporary alternates file"));
892 static int dir_exists(const char *path)
895 return !stat(path, &sb);
898 int cmd_clone(int argc, const char **argv, const char *prefix)
900 int is_bundle = 0, is_local;
901 const char *repo_name, *repo, *work_tree, *git_dir;
904 const struct ref *refs, *remote_head;
905 const struct ref *remote_head_points_at;
906 const struct ref *our_head_points_at;
907 struct ref *mapped_refs;
908 const struct ref *ref;
909 struct strbuf key = STRBUF_INIT;
910 struct strbuf default_refspec = STRBUF_INIT;
911 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
912 struct transport *transport = NULL;
913 const char *src_ref_prefix = "refs/heads/";
914 struct remote *remote;
915 int err = 0, complete_refs_before_fetch = 1;
916 int submodule_progress;
918 struct argv_array ref_prefixes = ARGV_ARRAY_INIT;
920 fetch_if_missing = 0;
922 packet_trace_identity("clone");
923 argc = parse_options(argc, argv, prefix, builtin_clone_options,
924 builtin_clone_usage, 0);
927 usage_msg_opt(_("Too many arguments."),
928 builtin_clone_usage, builtin_clone_options);
931 usage_msg_opt(_("You must specify a repository to clone."),
932 builtin_clone_usage, builtin_clone_options);
934 if (option_depth || option_since || option_not.nr)
936 if (option_single_branch == -1)
937 option_single_branch = deepen ? 1 : 0;
944 die(_("--bare and --origin %s options are incompatible."),
947 die(_("--bare and --separate-git-dir are incompatible."));
948 option_no_checkout = 1;
952 option_origin = "origin";
956 path = get_repo_path(repo_name, &is_bundle);
958 repo = absolute_pathdup(repo_name);
959 else if (!strchr(repo_name, ':'))
960 die(_("repository '%s' does not exist"), repo_name);
964 /* no need to be strict, transport_set_option() will validate it again */
965 if (option_depth && atoi(option_depth) < 1)
966 die(_("depth %s is not a positive number"), option_depth);
969 dir = xstrdup(argv[1]);
971 dir = guess_dir_name(repo_name, is_bundle, option_bare);
972 strip_trailing_slashes(dir);
974 dest_exists = dir_exists(dir);
975 if (dest_exists && !is_empty_dir(dir))
976 die(_("destination path '%s' already exists and is not "
977 "an empty directory."), dir);
979 strbuf_addf(&reflog_msg, "clone: from %s", repo);
984 work_tree = getenv("GIT_WORK_TREE");
985 if (work_tree && dir_exists(work_tree))
986 die(_("working tree '%s' already exists."), work_tree);
989 if (option_bare || work_tree)
990 git_dir = xstrdup(dir);
993 git_dir = mkpathdup("%s/.git", dir);
997 sigchain_push_common(remove_junk_on_signal);
1000 if (safe_create_leading_directories_const(work_tree) < 0)
1001 die_errno(_("could not create leading directories of '%s'"),
1004 junk_work_tree_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1005 else if (mkdir(work_tree, 0777))
1006 die_errno(_("could not create work tree dir '%s'"),
1008 junk_work_tree = work_tree;
1009 set_git_work_tree(work_tree);
1013 if (dir_exists(real_git_dir))
1014 junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1015 junk_git_dir = real_git_dir;
1018 junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1019 junk_git_dir = git_dir;
1021 if (safe_create_leading_directories_const(git_dir) < 0)
1022 die(_("could not create leading directories of '%s'"), git_dir);
1024 if (0 <= option_verbosity) {
1026 fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
1028 fprintf(stderr, _("Cloning into '%s'...\n"), dir);
1031 if (option_recurse_submodules.nr > 0) {
1032 struct string_list_item *item;
1033 struct strbuf sb = STRBUF_INIT;
1035 /* remove duplicates */
1036 string_list_sort(&option_recurse_submodules);
1037 string_list_remove_duplicates(&option_recurse_submodules, 0);
1040 * NEEDSWORK: In a multi-working-tree world, this needs to be
1041 * set in the per-worktree config.
1043 for_each_string_list_item(item, &option_recurse_submodules) {
1044 strbuf_addf(&sb, "submodule.active=%s",
1046 string_list_append(&option_config,
1047 strbuf_detach(&sb, NULL));
1050 if (option_required_reference.nr &&
1051 option_optional_reference.nr)
1052 die(_("clone --recursive is not compatible with "
1053 "both --reference and --reference-if-able"));
1054 else if (option_required_reference.nr) {
1055 string_list_append(&option_config,
1056 "submodule.alternateLocation=superproject");
1057 string_list_append(&option_config,
1058 "submodule.alternateErrorStrategy=die");
1059 } else if (option_optional_reference.nr) {
1060 string_list_append(&option_config,
1061 "submodule.alternateLocation=superproject");
1062 string_list_append(&option_config,
1063 "submodule.alternateErrorStrategy=info");
1067 init_db(git_dir, real_git_dir, option_template, INIT_DB_QUIET);
1070 git_dir = real_git_dir;
1072 write_config(&option_config);
1074 git_config(git_default_config, NULL);
1078 src_ref_prefix = "refs/";
1079 strbuf_addstr(&branch_top, src_ref_prefix);
1081 git_config_set("core.bare", "true");
1083 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
1086 strbuf_addf(&key, "remote.%s.url", option_origin);
1087 git_config_set(key.buf, repo);
1090 if (option_no_tags) {
1091 strbuf_addf(&key, "remote.%s.tagOpt", option_origin);
1092 git_config_set(key.buf, "--no-tags");
1096 if (option_required_reference.nr || option_optional_reference.nr)
1099 remote = remote_get(option_origin);
1101 strbuf_addf(&default_refspec, "+%s*:%s*", src_ref_prefix,
1103 refspec_append(&remote->fetch, default_refspec.buf);
1105 transport = transport_get(remote, remote->url[0]);
1106 transport_set_verbosity(transport, option_verbosity, option_progress);
1107 transport->family = family;
1109 path = get_repo_path(remote->url[0], &is_bundle);
1110 is_local = option_local != 0 && path && !is_bundle;
1113 warning(_("--depth is ignored in local clones; use file:// instead."));
1115 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1117 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1118 if (filter_options.choice)
1119 warning(_("--filter is ignored in local clones; use file:// instead."));
1120 if (!access(mkpath("%s/shallow", path), F_OK)) {
1121 if (option_local > 0)
1122 warning(_("source repository is shallow, ignoring --local"));
1126 if (option_local > 0 && !is_local)
1127 warning(_("--local is ignored"));
1128 transport->cloning = 1;
1130 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
1133 transport_set_option(transport, TRANS_OPT_DEPTH,
1136 transport_set_option(transport, TRANS_OPT_DEEPEN_SINCE,
1139 transport_set_option(transport, TRANS_OPT_DEEPEN_NOT,
1140 (const char *)&option_not);
1141 if (option_single_branch)
1142 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1144 if (option_upload_pack)
1145 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
1146 option_upload_pack);
1148 if (server_options.nr)
1149 transport->server_options = &server_options;
1151 if (filter_options.choice) {
1152 struct strbuf expanded_filter_spec = STRBUF_INIT;
1153 expand_list_objects_filter_spec(&filter_options,
1154 &expanded_filter_spec);
1155 transport_set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER,
1156 expanded_filter_spec.buf);
1157 transport_set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1158 strbuf_release(&expanded_filter_spec);
1161 if (transport->smart_options && !deepen && !filter_options.choice)
1162 transport->smart_options->check_self_contained_and_connected = 1;
1165 argv_array_push(&ref_prefixes, "HEAD");
1166 refspec_ref_prefixes(&remote->fetch, &ref_prefixes);
1168 expand_ref_prefix(&ref_prefixes, option_branch);
1169 if (!option_no_tags)
1170 argv_array_push(&ref_prefixes, "refs/tags/");
1172 refs = transport_get_remote_refs(transport, &ref_prefixes);
1175 mapped_refs = wanted_peer_refs(refs, &remote->fetch);
1177 * transport_get_remote_refs() may return refs with null sha-1
1178 * in mapped_refs (see struct transport->get_refs_list
1179 * comment). In that case we need fetch it early because
1180 * remote_head code below relies on it.
1182 * for normal clones, transport_get_remote_refs() should
1183 * return reliable ref set, we can delay cloning until after
1184 * remote HEAD check.
1186 for (ref = refs; ref; ref = ref->next)
1187 if (is_null_oid(&ref->old_oid)) {
1188 complete_refs_before_fetch = 0;
1192 if (!is_local && !complete_refs_before_fetch)
1193 transport_fetch_refs(transport, mapped_refs);
1195 remote_head = find_ref_by_name(refs, "HEAD");
1196 remote_head_points_at =
1197 guess_remote_head(remote_head, mapped_refs, 0);
1199 if (option_branch) {
1200 our_head_points_at =
1201 find_remote_branch(mapped_refs, option_branch);
1203 if (!our_head_points_at)
1204 die(_("Remote branch %s not found in upstream %s"),
1205 option_branch, option_origin);
1208 our_head_points_at = remote_head_points_at;
1212 die(_("Remote branch %s not found in upstream %s"),
1213 option_branch, option_origin);
1215 warning(_("You appear to have cloned an empty repository."));
1217 our_head_points_at = NULL;
1218 remote_head_points_at = NULL;
1220 option_no_checkout = 1;
1222 install_branch_config(0, "master", option_origin,
1223 "refs/heads/master");
1226 write_refspec_config(src_ref_prefix, our_head_points_at,
1227 remote_head_points_at, &branch_top);
1229 if (filter_options.choice)
1230 partial_clone_register(option_origin, &filter_options);
1233 clone_local(path, git_dir);
1234 else if (refs && complete_refs_before_fetch)
1235 transport_fetch_refs(transport, mapped_refs);
1237 update_remote_refs(refs, mapped_refs, remote_head_points_at,
1238 branch_top.buf, reflog_msg.buf, transport,
1239 !is_local, filter_options.choice);
1241 update_head(our_head_points_at, remote_head, reflog_msg.buf);
1244 * We want to show progress for recursive submodule clones iff
1245 * we did so for the main clone. But only the transport knows
1246 * the final decision for this flag, so we need to rescue the value
1247 * before we free the transport.
1249 submodule_progress = transport->progress;
1251 transport_unlock_pack(transport);
1252 transport_disconnect(transport);
1254 if (option_dissociate) {
1255 close_object_store(the_repository->objects);
1256 dissociate_from_references();
1259 junk_mode = JUNK_LEAVE_REPO;
1260 fetch_if_missing = 1;
1261 err = checkout(submodule_progress);
1263 strbuf_release(&reflog_msg);
1264 strbuf_release(&branch_top);
1265 strbuf_release(&key);
1266 strbuf_release(&default_refspec);
1267 junk_mode = JUNK_LEAVE_ALL;
1269 argv_array_clear(&ref_prefixes);