sha1-name: mark get_oid() error messages for translation
[git.git] / builtin / clone.c
blob0fc89ae2b9c77d420153c8bef6680d3324cdf5ad
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 #define USE_THE_INDEX_COMPATIBILITY_MACROS
12 #include "builtin.h"
13 #include "config.h"
14 #include "lockfile.h"
15 #include "parse-options.h"
16 #include "fetch-pack.h"
17 #include "refs.h"
18 #include "refspec.h"
19 #include "object-store.h"
20 #include "tree.h"
21 #include "tree-walk.h"
22 #include "unpack-trees.h"
23 #include "transport.h"
24 #include "strbuf.h"
25 #include "dir.h"
26 #include "dir-iterator.h"
27 #include "iterator.h"
28 #include "sigchain.h"
29 #include "branch.h"
30 #include "remote.h"
31 #include "run-command.h"
32 #include "connected.h"
33 #include "packfile.h"
34 #include "list-objects-filter-options.h"
37 * Overall FIXMEs:
38 * - respect DB_ENVIRONMENT for .git/objects.
40 * Implementation notes:
41 * - dropping use-separate-remote and no-separate-remote compatibility
44 static const char * const builtin_clone_usage[] = {
45 N_("git clone [<options>] [--] <repo> [<dir>]"),
46 NULL
49 static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
50 static int option_local = -1, option_no_hardlinks, option_shared;
51 static int option_no_tags;
52 static int option_shallow_submodules;
53 static int deepen;
54 static char *option_template, *option_depth, *option_since;
55 static char *option_origin = NULL;
56 static char *option_branch = NULL;
57 static struct string_list option_not = STRING_LIST_INIT_NODUP;
58 static const char *real_git_dir;
59 static char *option_upload_pack = "git-upload-pack";
60 static int option_verbosity;
61 static int option_progress = -1;
62 static int option_sparse_checkout;
63 static enum transport_family family;
64 static struct string_list option_config = STRING_LIST_INIT_NODUP;
65 static struct string_list option_required_reference = STRING_LIST_INIT_NODUP;
66 static struct string_list option_optional_reference = STRING_LIST_INIT_NODUP;
67 static int option_dissociate;
68 static int max_jobs = -1;
69 static struct string_list option_recurse_submodules = STRING_LIST_INIT_NODUP;
70 static struct list_objects_filter_options filter_options;
71 static struct string_list server_options = STRING_LIST_INIT_NODUP;
72 static int option_remote_submodules;
74 static int recurse_submodules_cb(const struct option *opt,
75 const char *arg, int unset)
77 if (unset)
78 string_list_clear((struct string_list *)opt->value, 0);
79 else if (arg)
80 string_list_append((struct string_list *)opt->value, arg);
81 else
82 string_list_append((struct string_list *)opt->value,
83 (const char *)opt->defval);
85 return 0;
88 static struct option builtin_clone_options[] = {
89 OPT__VERBOSITY(&option_verbosity),
90 OPT_BOOL(0, "progress", &option_progress,
91 N_("force progress reporting")),
92 OPT_BOOL('n', "no-checkout", &option_no_checkout,
93 N_("don't create a checkout")),
94 OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
95 OPT_HIDDEN_BOOL(0, "naked", &option_bare,
96 N_("create a bare repository")),
97 OPT_BOOL(0, "mirror", &option_mirror,
98 N_("create a mirror repository (implies bare)")),
99 OPT_BOOL('l', "local", &option_local,
100 N_("to clone from a local repository")),
101 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
102 N_("don't use local hardlinks, always copy")),
103 OPT_BOOL('s', "shared", &option_shared,
104 N_("setup as shared repository")),
105 OPT_ALIAS(0, "recursive", "recurse-submodules"),
106 { OPTION_CALLBACK, 0, "recurse-submodules", &option_recurse_submodules,
107 N_("pathspec"), N_("initialize submodules in the clone"),
108 PARSE_OPT_OPTARG, recurse_submodules_cb, (intptr_t)"." },
109 OPT_INTEGER('j', "jobs", &max_jobs,
110 N_("number of submodules cloned in parallel")),
111 OPT_STRING(0, "template", &option_template, N_("template-directory"),
112 N_("directory from which templates will be used")),
113 OPT_STRING_LIST(0, "reference", &option_required_reference, N_("repo"),
114 N_("reference repository")),
115 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference,
116 N_("repo"), N_("reference repository")),
117 OPT_BOOL(0, "dissociate", &option_dissociate,
118 N_("use --reference only while cloning")),
119 OPT_STRING('o', "origin", &option_origin, N_("name"),
120 N_("use <name> instead of 'origin' to track upstream")),
121 OPT_STRING('b', "branch", &option_branch, N_("branch"),
122 N_("checkout <branch> instead of the remote's HEAD")),
123 OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
124 N_("path to git-upload-pack on the remote")),
125 OPT_STRING(0, "depth", &option_depth, N_("depth"),
126 N_("create a shallow clone of that depth")),
127 OPT_STRING(0, "shallow-since", &option_since, N_("time"),
128 N_("create a shallow clone since a specific time")),
129 OPT_STRING_LIST(0, "shallow-exclude", &option_not, N_("revision"),
130 N_("deepen history of shallow clone, excluding rev")),
131 OPT_BOOL(0, "single-branch", &option_single_branch,
132 N_("clone only one branch, HEAD or --branch")),
133 OPT_BOOL(0, "no-tags", &option_no_tags,
134 N_("don't clone any tags, and make later fetches not to follow them")),
135 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules,
136 N_("any cloned submodules will be shallow")),
137 OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
138 N_("separate git dir from working tree")),
139 OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
140 N_("set config inside the new repository")),
141 OPT_STRING_LIST(0, "server-option", &server_options,
142 N_("server-specific"), N_("option to transmit")),
143 OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
144 TRANSPORT_FAMILY_IPV4),
145 OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
146 TRANSPORT_FAMILY_IPV6),
147 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
148 OPT_BOOL(0, "remote-submodules", &option_remote_submodules,
149 N_("any cloned submodules will use their remote-tracking branch")),
150 OPT_BOOL(0, "sparse", &option_sparse_checkout,
151 N_("initialize sparse-checkout file to include only files at root")),
152 OPT_END()
155 static const char *get_repo_path_1(struct strbuf *path, int *is_bundle)
157 static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
158 static char *bundle_suffix[] = { ".bundle", "" };
159 size_t baselen = path->len;
160 struct stat st;
161 int i;
163 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
164 strbuf_setlen(path, baselen);
165 strbuf_addstr(path, suffix[i]);
166 if (stat(path->buf, &st))
167 continue;
168 if (S_ISDIR(st.st_mode) && is_git_directory(path->buf)) {
169 *is_bundle = 0;
170 return path->buf;
171 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
172 /* Is it a "gitfile"? */
173 char signature[8];
174 const char *dst;
175 int len, fd = open(path->buf, O_RDONLY);
176 if (fd < 0)
177 continue;
178 len = read_in_full(fd, signature, 8);
179 close(fd);
180 if (len != 8 || strncmp(signature, "gitdir: ", 8))
181 continue;
182 dst = read_gitfile(path->buf);
183 if (dst) {
184 *is_bundle = 0;
185 return dst;
190 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
191 strbuf_setlen(path, baselen);
192 strbuf_addstr(path, bundle_suffix[i]);
193 if (!stat(path->buf, &st) && S_ISREG(st.st_mode)) {
194 *is_bundle = 1;
195 return path->buf;
199 return NULL;
202 static char *get_repo_path(const char *repo, int *is_bundle)
204 struct strbuf path = STRBUF_INIT;
205 const char *raw;
206 char *canon;
208 strbuf_addstr(&path, repo);
209 raw = get_repo_path_1(&path, is_bundle);
210 canon = raw ? absolute_pathdup(raw) : NULL;
211 strbuf_release(&path);
212 return canon;
215 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
217 const char *end = repo + strlen(repo), *start, *ptr;
218 size_t len;
219 char *dir;
222 * Skip scheme.
224 start = strstr(repo, "://");
225 if (start == NULL)
226 start = repo;
227 else
228 start += 3;
231 * Skip authentication data. The stripping does happen
232 * greedily, such that we strip up to the last '@' inside
233 * the host part.
235 for (ptr = start; ptr < end && !is_dir_sep(*ptr); ptr++) {
236 if (*ptr == '@')
237 start = ptr + 1;
241 * Strip trailing spaces, slashes and /.git
243 while (start < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
244 end--;
245 if (end - start > 5 && is_dir_sep(end[-5]) &&
246 !strncmp(end - 4, ".git", 4)) {
247 end -= 5;
248 while (start < end && is_dir_sep(end[-1]))
249 end--;
253 * Strip trailing port number if we've got only a
254 * hostname (that is, there is no dir separator but a
255 * colon). This check is required such that we do not
256 * strip URI's like '/foo/bar:2222.git', which should
257 * result in a dir '2222' being guessed due to backwards
258 * compatibility.
260 if (memchr(start, '/', end - start) == NULL
261 && memchr(start, ':', end - start) != NULL) {
262 ptr = end;
263 while (start < ptr && isdigit(ptr[-1]) && ptr[-1] != ':')
264 ptr--;
265 if (start < ptr && ptr[-1] == ':')
266 end = ptr - 1;
270 * Find last component. To remain backwards compatible we
271 * also regard colons as path separators, such that
272 * cloning a repository 'foo:bar.git' would result in a
273 * directory 'bar' being guessed.
275 ptr = end;
276 while (start < ptr && !is_dir_sep(ptr[-1]) && ptr[-1] != ':')
277 ptr--;
278 start = ptr;
281 * Strip .{bundle,git}.
283 len = end - start;
284 strip_suffix_mem(start, &len, is_bundle ? ".bundle" : ".git");
286 if (!len || (len == 1 && *start == '/'))
287 die(_("No directory name could be guessed.\n"
288 "Please specify a directory on the command line"));
290 if (is_bare)
291 dir = xstrfmt("%.*s.git", (int)len, start);
292 else
293 dir = xstrndup(start, len);
295 * Replace sequences of 'control' characters and whitespace
296 * with one ascii space, remove leading and trailing spaces.
298 if (*dir) {
299 char *out = dir;
300 int prev_space = 1 /* strip leading whitespace */;
301 for (end = dir; *end; ++end) {
302 char ch = *end;
303 if ((unsigned char)ch < '\x20')
304 ch = '\x20';
305 if (isspace(ch)) {
306 if (prev_space)
307 continue;
308 prev_space = 1;
309 } else
310 prev_space = 0;
311 *out++ = ch;
313 *out = '\0';
314 if (out > dir && prev_space)
315 out[-1] = '\0';
317 return dir;
320 static void strip_trailing_slashes(char *dir)
322 char *end = dir + strlen(dir);
324 while (dir < end - 1 && is_dir_sep(end[-1]))
325 end--;
326 *end = '\0';
329 static int add_one_reference(struct string_list_item *item, void *cb_data)
331 struct strbuf err = STRBUF_INIT;
332 int *required = cb_data;
333 char *ref_git = compute_alternate_path(item->string, &err);
335 if (!ref_git) {
336 if (*required)
337 die("%s", err.buf);
338 else
339 fprintf(stderr,
340 _("info: Could not add alternate for '%s': %s\n"),
341 item->string, err.buf);
342 } else {
343 struct strbuf sb = STRBUF_INIT;
344 strbuf_addf(&sb, "%s/objects", ref_git);
345 add_to_alternates_file(sb.buf);
346 strbuf_release(&sb);
349 strbuf_release(&err);
350 free(ref_git);
351 return 0;
354 static void setup_reference(void)
356 int required = 1;
357 for_each_string_list(&option_required_reference,
358 add_one_reference, &required);
359 required = 0;
360 for_each_string_list(&option_optional_reference,
361 add_one_reference, &required);
364 static void copy_alternates(struct strbuf *src, const char *src_repo)
367 * Read from the source objects/info/alternates file
368 * and copy the entries to corresponding file in the
369 * destination repository with add_to_alternates_file().
370 * Both src and dst have "$path/objects/info/alternates".
372 * Instead of copying bit-for-bit from the original,
373 * we need to append to existing one so that the already
374 * created entry via "clone -s" is not lost, and also
375 * to turn entries with paths relative to the original
376 * absolute, so that they can be used in the new repository.
378 FILE *in = xfopen(src->buf, "r");
379 struct strbuf line = STRBUF_INIT;
381 while (strbuf_getline(&line, in) != EOF) {
382 char *abs_path;
383 if (!line.len || line.buf[0] == '#')
384 continue;
385 if (is_absolute_path(line.buf)) {
386 add_to_alternates_file(line.buf);
387 continue;
389 abs_path = mkpathdup("%s/objects/%s", src_repo, line.buf);
390 if (!normalize_path_copy(abs_path, abs_path))
391 add_to_alternates_file(abs_path);
392 else
393 warning("skipping invalid relative alternate: %s/%s",
394 src_repo, line.buf);
395 free(abs_path);
397 strbuf_release(&line);
398 fclose(in);
401 static void mkdir_if_missing(const char *pathname, mode_t mode)
403 struct stat st;
405 if (!mkdir(pathname, mode))
406 return;
408 if (errno != EEXIST)
409 die_errno(_("failed to create directory '%s'"), pathname);
410 else if (stat(pathname, &st))
411 die_errno(_("failed to stat '%s'"), pathname);
412 else if (!S_ISDIR(st.st_mode))
413 die(_("%s exists and is not a directory"), pathname);
416 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
417 const char *src_repo)
419 int src_len, dest_len;
420 struct dir_iterator *iter;
421 int iter_status;
422 unsigned int flags;
424 mkdir_if_missing(dest->buf, 0777);
426 flags = DIR_ITERATOR_PEDANTIC | DIR_ITERATOR_FOLLOW_SYMLINKS;
427 iter = dir_iterator_begin(src->buf, flags);
429 if (!iter)
430 die_errno(_("failed to start iterator over '%s'"), src->buf);
432 strbuf_addch(src, '/');
433 src_len = src->len;
434 strbuf_addch(dest, '/');
435 dest_len = dest->len;
437 while ((iter_status = dir_iterator_advance(iter)) == ITER_OK) {
438 strbuf_setlen(src, src_len);
439 strbuf_addstr(src, iter->relative_path);
440 strbuf_setlen(dest, dest_len);
441 strbuf_addstr(dest, iter->relative_path);
443 if (S_ISDIR(iter->st.st_mode)) {
444 mkdir_if_missing(dest->buf, 0777);
445 continue;
448 /* Files that cannot be copied bit-for-bit... */
449 if (!fspathcmp(iter->relative_path, "info/alternates")) {
450 copy_alternates(src, src_repo);
451 continue;
454 if (unlink(dest->buf) && errno != ENOENT)
455 die_errno(_("failed to unlink '%s'"), dest->buf);
456 if (!option_no_hardlinks) {
457 if (!link(real_path(src->buf), dest->buf))
458 continue;
459 if (option_local > 0)
460 die_errno(_("failed to create link '%s'"), dest->buf);
461 option_no_hardlinks = 1;
463 if (copy_file_with_time(dest->buf, src->buf, 0666))
464 die_errno(_("failed to copy file to '%s'"), dest->buf);
467 if (iter_status != ITER_DONE) {
468 strbuf_setlen(src, src_len);
469 die(_("failed to iterate over '%s'"), src->buf);
473 static void clone_local(const char *src_repo, const char *dest_repo)
475 if (option_shared) {
476 struct strbuf alt = STRBUF_INIT;
477 get_common_dir(&alt, src_repo);
478 strbuf_addstr(&alt, "/objects");
479 add_to_alternates_file(alt.buf);
480 strbuf_release(&alt);
481 } else {
482 struct strbuf src = STRBUF_INIT;
483 struct strbuf dest = STRBUF_INIT;
484 get_common_dir(&src, src_repo);
485 get_common_dir(&dest, dest_repo);
486 strbuf_addstr(&src, "/objects");
487 strbuf_addstr(&dest, "/objects");
488 copy_or_link_directory(&src, &dest, src_repo);
489 strbuf_release(&src);
490 strbuf_release(&dest);
493 if (0 <= option_verbosity)
494 fprintf(stderr, _("done.\n"));
497 static const char *junk_work_tree;
498 static int junk_work_tree_flags;
499 static const char *junk_git_dir;
500 static int junk_git_dir_flags;
501 static enum {
502 JUNK_LEAVE_NONE,
503 JUNK_LEAVE_REPO,
504 JUNK_LEAVE_ALL
505 } junk_mode = JUNK_LEAVE_NONE;
507 static const char junk_leave_repo_msg[] =
508 N_("Clone succeeded, but checkout failed.\n"
509 "You can inspect what was checked out with 'git status'\n"
510 "and retry with 'git restore --source=HEAD :/'\n");
512 static void remove_junk(void)
514 struct strbuf sb = STRBUF_INIT;
516 switch (junk_mode) {
517 case JUNK_LEAVE_REPO:
518 warning("%s", _(junk_leave_repo_msg));
519 /* fall-through */
520 case JUNK_LEAVE_ALL:
521 return;
522 default:
523 /* proceed to removal */
524 break;
527 if (junk_git_dir) {
528 strbuf_addstr(&sb, junk_git_dir);
529 remove_dir_recursively(&sb, junk_git_dir_flags);
530 strbuf_reset(&sb);
532 if (junk_work_tree) {
533 strbuf_addstr(&sb, junk_work_tree);
534 remove_dir_recursively(&sb, junk_work_tree_flags);
536 strbuf_release(&sb);
539 static void remove_junk_on_signal(int signo)
541 remove_junk();
542 sigchain_pop(signo);
543 raise(signo);
546 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
548 struct ref *ref;
549 struct strbuf head = STRBUF_INIT;
550 strbuf_addstr(&head, "refs/heads/");
551 strbuf_addstr(&head, branch);
552 ref = find_ref_by_name(refs, head.buf);
553 strbuf_release(&head);
555 if (ref)
556 return ref;
558 strbuf_addstr(&head, "refs/tags/");
559 strbuf_addstr(&head, branch);
560 ref = find_ref_by_name(refs, head.buf);
561 strbuf_release(&head);
563 return ref;
566 static struct ref *wanted_peer_refs(const struct ref *refs,
567 struct refspec *refspec)
569 struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
570 struct ref *local_refs = head;
571 struct ref **tail = head ? &head->next : &local_refs;
573 if (option_single_branch) {
574 struct ref *remote_head = NULL;
576 if (!option_branch)
577 remote_head = guess_remote_head(head, refs, 0);
578 else {
579 local_refs = NULL;
580 tail = &local_refs;
581 remote_head = copy_ref(find_remote_branch(refs, option_branch));
584 if (!remote_head && option_branch)
585 warning(_("Could not find remote branch %s to clone."),
586 option_branch);
587 else {
588 int i;
589 for (i = 0; i < refspec->nr; i++)
590 get_fetch_map(remote_head, &refspec->items[i],
591 &tail, 0);
593 /* if --branch=tag, pull the requested tag explicitly */
594 get_fetch_map(remote_head, tag_refspec, &tail, 0);
596 } else {
597 int i;
598 for (i = 0; i < refspec->nr; i++)
599 get_fetch_map(refs, &refspec->items[i], &tail, 0);
602 if (!option_mirror && !option_single_branch && !option_no_tags)
603 get_fetch_map(refs, tag_refspec, &tail, 0);
605 return local_refs;
608 static void write_remote_refs(const struct ref *local_refs)
610 const struct ref *r;
612 struct ref_transaction *t;
613 struct strbuf err = STRBUF_INIT;
615 t = ref_transaction_begin(&err);
616 if (!t)
617 die("%s", err.buf);
619 for (r = local_refs; r; r = r->next) {
620 if (!r->peer_ref)
621 continue;
622 if (ref_transaction_create(t, r->peer_ref->name, &r->old_oid,
623 0, NULL, &err))
624 die("%s", err.buf);
627 if (initial_ref_transaction_commit(t, &err))
628 die("%s", err.buf);
630 strbuf_release(&err);
631 ref_transaction_free(t);
634 static void write_followtags(const struct ref *refs, const char *msg)
636 const struct ref *ref;
637 for (ref = refs; ref; ref = ref->next) {
638 if (!starts_with(ref->name, "refs/tags/"))
639 continue;
640 if (ends_with(ref->name, "^{}"))
641 continue;
642 if (!has_object_file(&ref->old_oid))
643 continue;
644 update_ref(msg, ref->name, &ref->old_oid, NULL, 0,
645 UPDATE_REFS_DIE_ON_ERR);
649 static int iterate_ref_map(void *cb_data, struct object_id *oid)
651 struct ref **rm = cb_data;
652 struct ref *ref = *rm;
655 * Skip anything missing a peer_ref, which we are not
656 * actually going to write a ref for.
658 while (ref && !ref->peer_ref)
659 ref = ref->next;
660 /* Returning -1 notes "end of list" to the caller. */
661 if (!ref)
662 return -1;
664 oidcpy(oid, &ref->old_oid);
665 *rm = ref->next;
666 return 0;
669 static void update_remote_refs(const struct ref *refs,
670 const struct ref *mapped_refs,
671 const struct ref *remote_head_points_at,
672 const char *branch_top,
673 const char *msg,
674 struct transport *transport,
675 int check_connectivity,
676 int check_refs_only)
678 const struct ref *rm = mapped_refs;
680 if (check_connectivity) {
681 struct check_connected_options opt = CHECK_CONNECTED_INIT;
683 opt.transport = transport;
684 opt.progress = transport->progress;
685 opt.check_refs_only = !!check_refs_only;
687 if (check_connected(iterate_ref_map, &rm, &opt))
688 die(_("remote did not send all necessary objects"));
691 if (refs) {
692 write_remote_refs(mapped_refs);
693 if (option_single_branch && !option_no_tags)
694 write_followtags(refs, msg);
697 if (remote_head_points_at && !option_bare) {
698 struct strbuf head_ref = STRBUF_INIT;
699 strbuf_addstr(&head_ref, branch_top);
700 strbuf_addstr(&head_ref, "HEAD");
701 if (create_symref(head_ref.buf,
702 remote_head_points_at->peer_ref->name,
703 msg) < 0)
704 die(_("unable to update %s"), head_ref.buf);
705 strbuf_release(&head_ref);
709 static void update_head(const struct ref *our, const struct ref *remote,
710 const char *msg)
712 const char *head;
713 if (our && skip_prefix(our->name, "refs/heads/", &head)) {
714 /* Local default branch link */
715 if (create_symref("HEAD", our->name, NULL) < 0)
716 die(_("unable to update HEAD"));
717 if (!option_bare) {
718 update_ref(msg, "HEAD", &our->old_oid, NULL, 0,
719 UPDATE_REFS_DIE_ON_ERR);
720 install_branch_config(0, head, option_origin, our->name);
722 } else if (our) {
723 struct commit *c = lookup_commit_reference(the_repository,
724 &our->old_oid);
725 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
726 update_ref(msg, "HEAD", &c->object.oid, NULL, REF_NO_DEREF,
727 UPDATE_REFS_DIE_ON_ERR);
728 } else if (remote) {
730 * We know remote HEAD points to a non-branch, or
731 * HEAD points to a branch but we don't know which one.
732 * Detach HEAD in all these cases.
734 update_ref(msg, "HEAD", &remote->old_oid, NULL, REF_NO_DEREF,
735 UPDATE_REFS_DIE_ON_ERR);
739 static int git_sparse_checkout_init(const char *repo)
741 struct argv_array argv = ARGV_ARRAY_INIT;
742 int result = 0;
743 argv_array_pushl(&argv, "-C", repo, "sparse-checkout", "init", NULL);
746 * We must apply the setting in the current process
747 * for the later checkout to use the sparse-checkout file.
749 core_apply_sparse_checkout = 1;
751 if (run_command_v_opt(argv.argv, RUN_GIT_CMD)) {
752 error(_("failed to initialize sparse-checkout"));
753 result = 1;
756 argv_array_clear(&argv);
757 return result;
760 static int checkout(int submodule_progress)
762 struct object_id oid;
763 char *head;
764 struct lock_file lock_file = LOCK_INIT;
765 struct unpack_trees_options opts;
766 struct tree *tree;
767 struct tree_desc t;
768 int err = 0;
770 if (option_no_checkout)
771 return 0;
773 head = resolve_refdup("HEAD", RESOLVE_REF_READING, &oid, NULL);
774 if (!head) {
775 warning(_("remote HEAD refers to nonexistent ref, "
776 "unable to checkout.\n"));
777 return 0;
779 if (!strcmp(head, "HEAD")) {
780 if (advice_detached_head)
781 detach_advice(oid_to_hex(&oid));
782 } else {
783 if (!starts_with(head, "refs/heads/"))
784 die(_("HEAD not found below refs/heads!"));
786 free(head);
788 /* We need to be in the new work tree for the checkout */
789 setup_work_tree();
791 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
793 memset(&opts, 0, sizeof opts);
794 opts.update = 1;
795 opts.merge = 1;
796 opts.clone = 1;
797 opts.fn = oneway_merge;
798 opts.verbose_update = (option_verbosity >= 0);
799 opts.src_index = &the_index;
800 opts.dst_index = &the_index;
802 tree = parse_tree_indirect(&oid);
803 parse_tree(tree);
804 init_tree_desc(&t, tree->buffer, tree->size);
805 if (unpack_trees(1, &t, &opts) < 0)
806 die(_("unable to checkout working tree"));
808 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
809 die(_("unable to write new index file"));
811 err |= run_hook_le(NULL, "post-checkout", oid_to_hex(&null_oid),
812 oid_to_hex(&oid), "1", NULL);
814 if (!err && (option_recurse_submodules.nr > 0)) {
815 struct argv_array args = ARGV_ARRAY_INIT;
816 argv_array_pushl(&args, "submodule", "update", "--require-init", "--recursive", NULL);
818 if (option_shallow_submodules == 1)
819 argv_array_push(&args, "--depth=1");
821 if (max_jobs != -1)
822 argv_array_pushf(&args, "--jobs=%d", max_jobs);
824 if (submodule_progress)
825 argv_array_push(&args, "--progress");
827 if (option_verbosity < 0)
828 argv_array_push(&args, "--quiet");
830 if (option_remote_submodules) {
831 argv_array_push(&args, "--remote");
832 argv_array_push(&args, "--no-fetch");
835 err = run_command_v_opt(args.argv, RUN_GIT_CMD);
836 argv_array_clear(&args);
839 return err;
842 static int write_one_config(const char *key, const char *value, void *data)
844 return git_config_set_multivar_gently(key,
845 value ? value : "true",
846 CONFIG_REGEX_NONE, 0);
849 static void write_config(struct string_list *config)
851 int i;
853 for (i = 0; i < config->nr; i++) {
854 if (git_config_parse_parameter(config->items[i].string,
855 write_one_config, NULL) < 0)
856 die(_("unable to write parameters to config file"));
860 static void write_refspec_config(const char *src_ref_prefix,
861 const struct ref *our_head_points_at,
862 const struct ref *remote_head_points_at,
863 struct strbuf *branch_top)
865 struct strbuf key = STRBUF_INIT;
866 struct strbuf value = STRBUF_INIT;
868 if (option_mirror || !option_bare) {
869 if (option_single_branch && !option_mirror) {
870 if (option_branch) {
871 if (starts_with(our_head_points_at->name, "refs/tags/"))
872 strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
873 our_head_points_at->name);
874 else
875 strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
876 branch_top->buf, option_branch);
877 } else if (remote_head_points_at) {
878 const char *head = remote_head_points_at->name;
879 if (!skip_prefix(head, "refs/heads/", &head))
880 BUG("remote HEAD points at non-head?");
882 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
883 branch_top->buf, head);
886 * otherwise, the next "git fetch" will
887 * simply fetch from HEAD without updating
888 * any remote-tracking branch, which is what
889 * we want.
891 } else {
892 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
894 /* Configure the remote */
895 if (value.len) {
896 strbuf_addf(&key, "remote.%s.fetch", option_origin);
897 git_config_set_multivar(key.buf, value.buf, "^$", 0);
898 strbuf_reset(&key);
900 if (option_mirror) {
901 strbuf_addf(&key, "remote.%s.mirror", option_origin);
902 git_config_set(key.buf, "true");
903 strbuf_reset(&key);
908 strbuf_release(&key);
909 strbuf_release(&value);
912 static void dissociate_from_references(void)
914 static const char* argv[] = { "repack", "-a", "-d", NULL };
915 char *alternates = git_pathdup("objects/info/alternates");
917 if (!access(alternates, F_OK)) {
918 if (run_command_v_opt(argv, RUN_GIT_CMD|RUN_COMMAND_NO_STDIN))
919 die(_("cannot repack to clean up"));
920 if (unlink(alternates) && errno != ENOENT)
921 die_errno(_("cannot unlink temporary alternates file"));
923 free(alternates);
926 static int path_exists(const char *path)
928 struct stat sb;
929 return !stat(path, &sb);
932 int cmd_clone(int argc, const char **argv, const char *prefix)
934 int is_bundle = 0, is_local;
935 const char *repo_name, *repo, *work_tree, *git_dir;
936 char *path, *dir;
937 int dest_exists;
938 const struct ref *refs, *remote_head;
939 const struct ref *remote_head_points_at;
940 const struct ref *our_head_points_at;
941 struct ref *mapped_refs;
942 const struct ref *ref;
943 struct strbuf key = STRBUF_INIT;
944 struct strbuf default_refspec = STRBUF_INIT;
945 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
946 struct transport *transport = NULL;
947 const char *src_ref_prefix = "refs/heads/";
948 struct remote *remote;
949 int err = 0, complete_refs_before_fetch = 1;
950 int submodule_progress;
952 struct argv_array ref_prefixes = ARGV_ARRAY_INIT;
954 packet_trace_identity("clone");
955 argc = parse_options(argc, argv, prefix, builtin_clone_options,
956 builtin_clone_usage, 0);
958 if (argc > 2)
959 usage_msg_opt(_("Too many arguments."),
960 builtin_clone_usage, builtin_clone_options);
962 if (argc == 0)
963 usage_msg_opt(_("You must specify a repository to clone."),
964 builtin_clone_usage, builtin_clone_options);
966 if (option_depth || option_since || option_not.nr)
967 deepen = 1;
968 if (option_single_branch == -1)
969 option_single_branch = deepen ? 1 : 0;
971 if (option_mirror)
972 option_bare = 1;
974 if (option_bare) {
975 if (option_origin)
976 die(_("--bare and --origin %s options are incompatible."),
977 option_origin);
978 if (real_git_dir)
979 die(_("--bare and --separate-git-dir are incompatible."));
980 option_no_checkout = 1;
983 if (!option_origin)
984 option_origin = "origin";
986 repo_name = argv[0];
988 path = get_repo_path(repo_name, &is_bundle);
989 if (path)
990 repo = absolute_pathdup(repo_name);
991 else if (!strchr(repo_name, ':'))
992 die(_("repository '%s' does not exist"), repo_name);
993 else
994 repo = repo_name;
996 /* no need to be strict, transport_set_option() will validate it again */
997 if (option_depth && atoi(option_depth) < 1)
998 die(_("depth %s is not a positive number"), option_depth);
1000 if (argc == 2)
1001 dir = xstrdup(argv[1]);
1002 else
1003 dir = guess_dir_name(repo_name, is_bundle, option_bare);
1004 strip_trailing_slashes(dir);
1006 dest_exists = path_exists(dir);
1007 if (dest_exists && !is_empty_dir(dir))
1008 die(_("destination path '%s' already exists and is not "
1009 "an empty directory."), dir);
1011 strbuf_addf(&reflog_msg, "clone: from %s", repo);
1013 if (option_bare)
1014 work_tree = NULL;
1015 else {
1016 work_tree = getenv("GIT_WORK_TREE");
1017 if (work_tree && path_exists(work_tree))
1018 die(_("working tree '%s' already exists."), work_tree);
1021 if (option_bare || work_tree)
1022 git_dir = xstrdup(dir);
1023 else {
1024 work_tree = dir;
1025 git_dir = mkpathdup("%s/.git", dir);
1028 atexit(remove_junk);
1029 sigchain_push_common(remove_junk_on_signal);
1031 if (!option_bare) {
1032 if (safe_create_leading_directories_const(work_tree) < 0)
1033 die_errno(_("could not create leading directories of '%s'"),
1034 work_tree);
1035 if (dest_exists)
1036 junk_work_tree_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1037 else if (mkdir(work_tree, 0777))
1038 die_errno(_("could not create work tree dir '%s'"),
1039 work_tree);
1040 junk_work_tree = work_tree;
1041 set_git_work_tree(work_tree);
1044 if (real_git_dir) {
1045 if (path_exists(real_git_dir))
1046 junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1047 junk_git_dir = real_git_dir;
1048 } else {
1049 if (dest_exists)
1050 junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1051 junk_git_dir = git_dir;
1053 if (safe_create_leading_directories_const(git_dir) < 0)
1054 die(_("could not create leading directories of '%s'"), git_dir);
1056 if (0 <= option_verbosity) {
1057 if (option_bare)
1058 fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
1059 else
1060 fprintf(stderr, _("Cloning into '%s'...\n"), dir);
1063 if (option_recurse_submodules.nr > 0) {
1064 struct string_list_item *item;
1065 struct strbuf sb = STRBUF_INIT;
1067 /* remove duplicates */
1068 string_list_sort(&option_recurse_submodules);
1069 string_list_remove_duplicates(&option_recurse_submodules, 0);
1072 * NEEDSWORK: In a multi-working-tree world, this needs to be
1073 * set in the per-worktree config.
1075 for_each_string_list_item(item, &option_recurse_submodules) {
1076 strbuf_addf(&sb, "submodule.active=%s",
1077 item->string);
1078 string_list_append(&option_config,
1079 strbuf_detach(&sb, NULL));
1082 if (option_required_reference.nr &&
1083 option_optional_reference.nr)
1084 die(_("clone --recursive is not compatible with "
1085 "both --reference and --reference-if-able"));
1086 else if (option_required_reference.nr) {
1087 string_list_append(&option_config,
1088 "submodule.alternateLocation=superproject");
1089 string_list_append(&option_config,
1090 "submodule.alternateErrorStrategy=die");
1091 } else if (option_optional_reference.nr) {
1092 string_list_append(&option_config,
1093 "submodule.alternateLocation=superproject");
1094 string_list_append(&option_config,
1095 "submodule.alternateErrorStrategy=info");
1099 init_db(git_dir, real_git_dir, option_template, INIT_DB_QUIET);
1101 if (real_git_dir)
1102 git_dir = real_git_dir;
1104 write_config(&option_config);
1106 git_config(git_default_config, NULL);
1108 if (option_bare) {
1109 if (option_mirror)
1110 src_ref_prefix = "refs/";
1111 strbuf_addstr(&branch_top, src_ref_prefix);
1113 git_config_set("core.bare", "true");
1114 } else {
1115 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
1118 strbuf_addf(&key, "remote.%s.url", option_origin);
1119 git_config_set(key.buf, repo);
1120 strbuf_reset(&key);
1122 if (option_no_tags) {
1123 strbuf_addf(&key, "remote.%s.tagOpt", option_origin);
1124 git_config_set(key.buf, "--no-tags");
1125 strbuf_reset(&key);
1128 if (option_required_reference.nr || option_optional_reference.nr)
1129 setup_reference();
1131 if (option_sparse_checkout && git_sparse_checkout_init(repo))
1132 return 1;
1134 remote = remote_get(option_origin);
1136 strbuf_addf(&default_refspec, "+%s*:%s*", src_ref_prefix,
1137 branch_top.buf);
1138 refspec_append(&remote->fetch, default_refspec.buf);
1140 transport = transport_get(remote, remote->url[0]);
1141 transport_set_verbosity(transport, option_verbosity, option_progress);
1142 transport->family = family;
1144 path = get_repo_path(remote->url[0], &is_bundle);
1145 is_local = option_local != 0 && path && !is_bundle;
1146 if (is_local) {
1147 if (option_depth)
1148 warning(_("--depth is ignored in local clones; use file:// instead."));
1149 if (option_since)
1150 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1151 if (option_not.nr)
1152 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1153 if (filter_options.choice)
1154 warning(_("--filter is ignored in local clones; use file:// instead."));
1155 if (!access(mkpath("%s/shallow", path), F_OK)) {
1156 if (option_local > 0)
1157 warning(_("source repository is shallow, ignoring --local"));
1158 is_local = 0;
1161 if (option_local > 0 && !is_local)
1162 warning(_("--local is ignored"));
1163 transport->cloning = 1;
1165 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
1167 if (option_depth)
1168 transport_set_option(transport, TRANS_OPT_DEPTH,
1169 option_depth);
1170 if (option_since)
1171 transport_set_option(transport, TRANS_OPT_DEEPEN_SINCE,
1172 option_since);
1173 if (option_not.nr)
1174 transport_set_option(transport, TRANS_OPT_DEEPEN_NOT,
1175 (const char *)&option_not);
1176 if (option_single_branch)
1177 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1179 if (option_upload_pack)
1180 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
1181 option_upload_pack);
1183 if (server_options.nr)
1184 transport->server_options = &server_options;
1186 if (filter_options.choice) {
1187 const char *spec =
1188 expand_list_objects_filter_spec(&filter_options);
1189 transport_set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER,
1190 spec);
1191 transport_set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1194 if (transport->smart_options && !deepen && !filter_options.choice)
1195 transport->smart_options->check_self_contained_and_connected = 1;
1198 argv_array_push(&ref_prefixes, "HEAD");
1199 refspec_ref_prefixes(&remote->fetch, &ref_prefixes);
1200 if (option_branch)
1201 expand_ref_prefix(&ref_prefixes, option_branch);
1202 if (!option_no_tags)
1203 argv_array_push(&ref_prefixes, "refs/tags/");
1205 refs = transport_get_remote_refs(transport, &ref_prefixes);
1207 if (refs) {
1208 mapped_refs = wanted_peer_refs(refs, &remote->fetch);
1210 * transport_get_remote_refs() may return refs with null sha-1
1211 * in mapped_refs (see struct transport->get_refs_list
1212 * comment). In that case we need fetch it early because
1213 * remote_head code below relies on it.
1215 * for normal clones, transport_get_remote_refs() should
1216 * return reliable ref set, we can delay cloning until after
1217 * remote HEAD check.
1219 for (ref = refs; ref; ref = ref->next)
1220 if (is_null_oid(&ref->old_oid)) {
1221 complete_refs_before_fetch = 0;
1222 break;
1225 if (!is_local && !complete_refs_before_fetch)
1226 transport_fetch_refs(transport, mapped_refs);
1228 remote_head = find_ref_by_name(refs, "HEAD");
1229 remote_head_points_at =
1230 guess_remote_head(remote_head, mapped_refs, 0);
1232 if (option_branch) {
1233 our_head_points_at =
1234 find_remote_branch(mapped_refs, option_branch);
1236 if (!our_head_points_at)
1237 die(_("Remote branch %s not found in upstream %s"),
1238 option_branch, option_origin);
1240 else
1241 our_head_points_at = remote_head_points_at;
1243 else {
1244 if (option_branch)
1245 die(_("Remote branch %s not found in upstream %s"),
1246 option_branch, option_origin);
1248 warning(_("You appear to have cloned an empty repository."));
1249 mapped_refs = NULL;
1250 our_head_points_at = NULL;
1251 remote_head_points_at = NULL;
1252 remote_head = NULL;
1253 option_no_checkout = 1;
1254 if (!option_bare)
1255 install_branch_config(0, "master", option_origin,
1256 "refs/heads/master");
1259 write_refspec_config(src_ref_prefix, our_head_points_at,
1260 remote_head_points_at, &branch_top);
1262 if (filter_options.choice)
1263 partial_clone_register(option_origin, &filter_options);
1265 if (is_local)
1266 clone_local(path, git_dir);
1267 else if (refs && complete_refs_before_fetch)
1268 transport_fetch_refs(transport, mapped_refs);
1270 update_remote_refs(refs, mapped_refs, remote_head_points_at,
1271 branch_top.buf, reflog_msg.buf, transport,
1272 !is_local, filter_options.choice);
1274 update_head(our_head_points_at, remote_head, reflog_msg.buf);
1277 * We want to show progress for recursive submodule clones iff
1278 * we did so for the main clone. But only the transport knows
1279 * the final decision for this flag, so we need to rescue the value
1280 * before we free the transport.
1282 submodule_progress = transport->progress;
1284 transport_unlock_pack(transport);
1285 transport_disconnect(transport);
1287 if (option_dissociate) {
1288 close_object_store(the_repository->objects);
1289 dissociate_from_references();
1292 junk_mode = JUNK_LEAVE_REPO;
1293 err = checkout(submodule_progress);
1295 strbuf_release(&reflog_msg);
1296 strbuf_release(&branch_top);
1297 strbuf_release(&key);
1298 strbuf_release(&default_refspec);
1299 junk_mode = JUNK_LEAVE_ALL;
1301 argv_array_clear(&ref_prefixes);
1302 return err;