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