clone.c 27.2 KB
Newer Older
D
Daniel Barkalow 已提交
1 2 3 4 5 6 7 8 9 10
/*
 * Builtin "git clone"
 *
 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
 *		 2008 Daniel Barkalow <barkalow@iabervon.org>
 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
 *
 * Clone a repository into a different directory that does not yet exist.
 */

S
Stephen Boyd 已提交
11
#include "builtin.h"
D
Daniel Barkalow 已提交
12 13 14 15 16 17 18 19 20
#include "parse-options.h"
#include "fetch-pack.h"
#include "refs.h"
#include "tree.h"
#include "tree-walk.h"
#include "unpack-trees.h"
#include "transport.h"
#include "strbuf.h"
#include "dir.h"
21
#include "sigchain.h"
22
#include "branch.h"
J
Jay Soffian 已提交
23
#include "remote.h"
24
#include "run-command.h"
25
#include "connected.h"
D
Daniel Barkalow 已提交
26 27 28 29 30 31 32 33 34 35

/*
 * Overall FIXMEs:
 *  - respect DB_ENVIRONMENT for .git/objects.
 *
 * Implementation notes:
 *  - dropping use-separate-remote and no-separate-remote compatibility
 *
 */
static const char * const builtin_clone_usage[] = {
36
	N_("git clone [options] [--] <repo> [<dir>]"),
D
Daniel Barkalow 已提交
37 38 39
	NULL
};

40
static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
41
static int option_local = -1, option_no_hardlinks, option_shared, option_recursive;
42
static char *option_template, *option_depth;
D
Daniel Barkalow 已提交
43
static char *option_origin = NULL;
44
static char *option_branch = NULL;
45
static const char *real_git_dir;
D
Daniel Barkalow 已提交
46
static char *option_upload_pack = "git-upload-pack";
47
static int option_verbosity;
48
static int option_progress = -1;
49
static struct string_list option_config;
50 51 52 53 54 55 56 57 58 59
static struct string_list option_reference;

static int opt_parse_reference(const struct option *opt, const char *arg, int unset)
{
	struct string_list *option_reference = opt->value;
	if (!arg)
		return -1;
	string_list_append(option_reference, arg);
	return 0;
}
D
Daniel Barkalow 已提交
60 61

static struct option builtin_clone_options[] = {
62
	OPT__VERBOSITY(&option_verbosity),
63
	OPT_BOOL(0, "progress", &option_progress,
64
		 N_("force progress reporting")),
65 66
	OPT_BOOL('n', "no-checkout", &option_no_checkout,
		 N_("don't create a checkout")),
67 68 69
	OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
	OPT_HIDDEN_BOOL(0, "naked", &option_bare,
			N_("create a bare repository")),
70 71
	OPT_BOOL(0, "mirror", &option_mirror,
		 N_("create a mirror repository (implies bare)")),
72
	OPT_BOOL('l', "local", &option_local,
73
		N_("to clone from a local repository")),
74
	OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
75
		    N_("don't use local hardlinks, always copy")),
76
	OPT_BOOL('s', "shared", &option_shared,
77
		    N_("setup as shared repository")),
78
	OPT_BOOL(0, "recursive", &option_recursive,
79
		    N_("initialize submodules in the clone")),
80
	OPT_BOOL(0, "recurse-submodules", &option_recursive,
81 82 83 84 85 86 87 88 89 90 91 92 93
		    N_("initialize submodules in the clone")),
	OPT_STRING(0, "template", &option_template, N_("template-directory"),
		   N_("directory from which templates will be used")),
	OPT_CALLBACK(0 , "reference", &option_reference, N_("repo"),
		     N_("reference repository"), &opt_parse_reference),
	OPT_STRING('o', "origin", &option_origin, N_("name"),
		   N_("use <name> instead of 'origin' to track upstream")),
	OPT_STRING('b', "branch", &option_branch, N_("branch"),
		   N_("checkout <branch> instead of the remote's HEAD")),
	OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
		   N_("path to git-upload-pack on the remote")),
	OPT_STRING(0, "depth", &option_depth, N_("depth"),
		    N_("create a shallow clone of that depth")),
94
	OPT_BOOL(0, "single-branch", &option_single_branch,
95 96 97 98 99
		    N_("clone only one branch, HEAD or --branch")),
	OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
		   N_("separate git dir from working tree")),
	OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
			N_("set config inside the new repository")),
D
Daniel Barkalow 已提交
100 101 102
	OPT_END()
};

103 104 105 106
static const char *argv_submodule[] = {
	"submodule", "update", "--init", "--recursive", NULL
};

D
Daniel Barkalow 已提交
107 108
static char *get_repo_path(const char *repo, int *is_bundle)
{
109
	static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
D
Daniel Barkalow 已提交
110 111 112 113 114 115 116
	static char *bundle_suffix[] = { ".bundle", "" };
	struct stat st;
	int i;

	for (i = 0; i < ARRAY_SIZE(suffix); i++) {
		const char *path;
		path = mkpath("%s%s", repo, suffix[i]);
117 118
		if (stat(path, &st))
			continue;
119
		if (S_ISDIR(st.st_mode) && is_git_directory(path)) {
D
Daniel Barkalow 已提交
120
			*is_bundle = 0;
121
			return xstrdup(absolute_path(path));
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
		} else if (S_ISREG(st.st_mode) && st.st_size > 8) {
			/* Is it a "gitfile"? */
			char signature[8];
			int len, fd = open(path, O_RDONLY);
			if (fd < 0)
				continue;
			len = read_in_full(fd, signature, 8);
			close(fd);
			if (len != 8 || strncmp(signature, "gitdir: ", 8))
				continue;
			path = read_gitfile(path);
			if (path) {
				*is_bundle = 0;
				return xstrdup(absolute_path(path));
			}
D
Daniel Barkalow 已提交
137 138 139 140 141 142 143 144
		}
	}

	for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
		const char *path;
		path = mkpath("%s%s", repo, bundle_suffix[i]);
		if (!stat(path, &st) && S_ISREG(st.st_mode)) {
			*is_bundle = 1;
145
			return xstrdup(absolute_path(path));
D
Daniel Barkalow 已提交
146 147 148 149 150 151
		}
	}

	return NULL;
}

152
static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
D
Daniel Barkalow 已提交
153
{
154
	const char *end = repo + strlen(repo), *start;
155
	char *dir;
156 157

	/*
158
	 * Strip trailing spaces, slashes and /.git
159
	 */
160
	while (repo < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
		end--;
	if (end - repo > 5 && is_dir_sep(end[-5]) &&
	    !strncmp(end - 4, ".git", 4)) {
		end -= 5;
		while (repo < end && is_dir_sep(end[-1]))
			end--;
	}

	/*
	 * Find last component, but be prepared that repo could have
	 * the form  "remote.example.com:foo.git", i.e. no slash
	 * in the directory part.
	 */
	start = end;
	while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
		start--;

	/*
	 * Strip .{bundle,git}.
	 */
	if (is_bundle) {
		if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
			end -= 7;
	} else {
		if (end - start > 4 && !strncmp(end - 4, ".git", 4))
			end -= 4;
D
Daniel Barkalow 已提交
187 188
	}

189
	if (is_bare) {
190 191
		struct strbuf result = STRBUF_INIT;
		strbuf_addf(&result, "%.*s.git", (int)(end - start), start);
192
		dir = strbuf_detach(&result, NULL);
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
	} else
		dir = xstrndup(start, end - start);
	/*
	 * Replace sequences of 'control' characters and whitespace
	 * with one ascii space, remove leading and trailing spaces.
	 */
	if (*dir) {
		char *out = dir;
		int prev_space = 1 /* strip leading whitespace */;
		for (end = dir; *end; ++end) {
			char ch = *end;
			if ((unsigned char)ch < '\x20')
				ch = '\x20';
			if (isspace(ch)) {
				if (prev_space)
					continue;
				prev_space = 1;
			} else
				prev_space = 0;
			*out++ = ch;
		}
		*out = '\0';
		if (out > dir && prev_space)
			out[-1] = '\0';
217
	}
218
	return dir;
D
Daniel Barkalow 已提交
219 220
}

221 222 223 224 225 226 227 228 229
static void strip_trailing_slashes(char *dir)
{
	char *end = dir + strlen(dir);

	while (dir < end - 1 && is_dir_sep(end[-1]))
		end--;
	*end = '\0';
}

230
static int add_one_reference(struct string_list_item *item, void *cb_data)
D
Daniel Barkalow 已提交
231
{
232
	char *ref_git;
233
	const char *repo;
234
	struct strbuf alternate = STRBUF_INIT;
D
Daniel Barkalow 已提交
235

236
	/* Beware: read_gitfile(), real_path() and mkpath() return static buffer */
237
	ref_git = xstrdup(real_path(item->string));
238 239 240 241 242 243 244 245 246 247

	repo = read_gitfile(ref_git);
	if (!repo)
		repo = read_gitfile(mkpath("%s/.git", ref_git));
	if (repo) {
		free(ref_git);
		ref_git = xstrdup(repo);
	}

	if (!repo && is_directory(mkpath("%s/.git/objects", ref_git))) {
248
		char *ref_git_git = mkpathdup("%s/.git", ref_git);
249 250 251
		free(ref_git);
		ref_git = ref_git_git;
	} else if (!is_directory(mkpath("%s/objects", ref_git)))
252
		die(_("reference repository '%s' is not a local repository."),
253
		    item->string);
D
Daniel Barkalow 已提交
254

255 256 257 258 259 260
	if (!access(mkpath("%s/shallow", ref_git), F_OK))
		die(_("reference repository '%s' is shallow"), item->string);

	if (!access(mkpath("%s/info/grafts", ref_git), F_OK))
		die(_("reference repository '%s' is grafted"), item->string);

261 262 263 264
	strbuf_addf(&alternate, "%s/objects", ref_git);
	add_to_alternates_file(alternate.buf);
	strbuf_release(&alternate);
	free(ref_git);
265 266
	return 0;
}
D
Daniel Barkalow 已提交
267

268 269 270
static void setup_reference(void)
{
	for_each_string_list(&option_reference, add_one_reference, NULL);
D
Daniel Barkalow 已提交
271 272
}

273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
static void copy_alternates(struct strbuf *src, struct strbuf *dst,
			    const char *src_repo)
{
	/*
	 * Read from the source objects/info/alternates file
	 * and copy the entries to corresponding file in the
	 * destination repository with add_to_alternates_file().
	 * Both src and dst have "$path/objects/info/alternates".
	 *
	 * Instead of copying bit-for-bit from the original,
	 * we need to append to existing one so that the already
	 * created entry via "clone -s" is not lost, and also
	 * to turn entries with paths relative to the original
	 * absolute, so that they can be used in the new repository.
	 */
	FILE *in = fopen(src->buf, "r");
	struct strbuf line = STRBUF_INIT;

	while (strbuf_getline(&line, in, '\n') != EOF) {
		char *abs_path, abs_buf[PATH_MAX];
		if (!line.len || line.buf[0] == '#')
			continue;
		if (is_absolute_path(line.buf)) {
			add_to_alternates_file(line.buf);
			continue;
		}
		abs_path = mkpath("%s/objects/%s", src_repo, line.buf);
		normalize_path_copy(abs_buf, abs_path);
		add_to_alternates_file(abs_buf);
	}
	strbuf_release(&line);
	fclose(in);
}

static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
				   const char *src_repo, int src_baselen)
D
Daniel Barkalow 已提交
309 310 311 312 313 314
{
	struct dirent *de;
	struct stat buf;
	int src_len, dest_len;
	DIR *dir;

315
	dir = opendir(src->buf);
D
Daniel Barkalow 已提交
316
	if (!dir)
317
		die_errno(_("failed to open '%s'"), src->buf);
D
Daniel Barkalow 已提交
318

319
	if (mkdir(dest->buf, 0777)) {
D
Daniel Barkalow 已提交
320
		if (errno != EEXIST)
321
			die_errno(_("failed to create directory '%s'"), dest->buf);
322
		else if (stat(dest->buf, &buf))
323
			die_errno(_("failed to stat '%s'"), dest->buf);
D
Daniel Barkalow 已提交
324
		else if (!S_ISDIR(buf.st_mode))
325
			die(_("%s exists and is not a directory"), dest->buf);
D
Daniel Barkalow 已提交
326 327
	}

328 329 330 331
	strbuf_addch(src, '/');
	src_len = src->len;
	strbuf_addch(dest, '/');
	dest_len = dest->len;
D
Daniel Barkalow 已提交
332 333

	while ((de = readdir(dir)) != NULL) {
334 335 336 337 338
		strbuf_setlen(src, src_len);
		strbuf_addstr(src, de->d_name);
		strbuf_setlen(dest, dest_len);
		strbuf_addstr(dest, de->d_name);
		if (stat(src->buf, &buf)) {
339
			warning (_("failed to stat %s\n"), src->buf);
D
Daniel Barkalow 已提交
340 341 342 343
			continue;
		}
		if (S_ISDIR(buf.st_mode)) {
			if (de->d_name[0] != '.')
344 345 346 347 348 349 350 351
				copy_or_link_directory(src, dest,
						       src_repo, src_baselen);
			continue;
		}

		/* Files that cannot be copied bit-for-bit... */
		if (!strcmp(src->buf + src_baselen, "/info/alternates")) {
			copy_alternates(src, dest, src_repo);
D
Daniel Barkalow 已提交
352 353 354
			continue;
		}

355
		if (unlink(dest->buf) && errno != ENOENT)
356
			die_errno(_("failed to unlink '%s'"), dest->buf);
357
		if (!option_no_hardlinks) {
358
			if (!link(src->buf, dest->buf))
359
				continue;
360
			if (option_local > 0)
361
				die_errno(_("failed to create link '%s'"), dest->buf);
362
			option_no_hardlinks = 1;
D
Daniel Barkalow 已提交
363
		}
364
		if (copy_file_with_time(dest->buf, src->buf, 0666))
365
			die_errno(_("failed to copy file to '%s'"), dest->buf);
D
Daniel Barkalow 已提交
366
	}
367
	closedir(dir);
D
Daniel Barkalow 已提交
368 369
}

370
static void clone_local(const char *src_repo, const char *dest_repo)
D
Daniel Barkalow 已提交
371
{
372 373 374 375 376 377 378 379
	if (option_shared) {
		struct strbuf alt = STRBUF_INIT;
		strbuf_addf(&alt, "%s/objects", src_repo);
		add_to_alternates_file(alt.buf);
		strbuf_release(&alt);
	} else {
		struct strbuf src = STRBUF_INIT;
		struct strbuf dest = STRBUF_INIT;
380 381
		strbuf_addf(&src, "%s/objects", src_repo);
		strbuf_addf(&dest, "%s/objects", dest_repo);
382
		copy_or_link_directory(&src, &dest, src_repo, src.len);
383 384
		strbuf_release(&src);
		strbuf_release(&dest);
D
Daniel Barkalow 已提交
385 386
	}

387
	if (0 <= option_verbosity)
388
		fprintf(stderr, _("done.\n"));
D
Daniel Barkalow 已提交
389 390 391 392
}

static const char *junk_work_tree;
static const char *junk_git_dir;
393
static pid_t junk_pid;
394
static enum {
395 396 397 398 399 400 401 402 403
	JUNK_LEAVE_NONE,
	JUNK_LEAVE_REPO,
	JUNK_LEAVE_ALL
} junk_mode = JUNK_LEAVE_NONE;

static const char junk_leave_repo_msg[] =
N_("Clone succeeded, but checkout failed.\n"
   "You can inspect what was checked out with 'git status'\n"
   "and retry the checkout with 'git checkout -f HEAD'\n");
D
Daniel Barkalow 已提交
404 405 406

static void remove_junk(void)
{
407
	struct strbuf sb = STRBUF_INIT;
408 409 410 411 412 413 414 415 416 417 418 419

	switch (junk_mode) {
	case JUNK_LEAVE_REPO:
		warning("%s", _(junk_leave_repo_msg));
		/* fall-through */
	case JUNK_LEAVE_ALL:
		return;
	default:
		/* proceed to removal */
		break;
	}

D
Daniel Barkalow 已提交
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
	if (getpid() != junk_pid)
		return;
	if (junk_git_dir) {
		strbuf_addstr(&sb, junk_git_dir);
		remove_dir_recursively(&sb, 0);
		strbuf_reset(&sb);
	}
	if (junk_work_tree) {
		strbuf_addstr(&sb, junk_work_tree);
		remove_dir_recursively(&sb, 0);
		strbuf_reset(&sb);
	}
}

static void remove_junk_on_signal(int signo)
{
	remove_junk();
437
	sigchain_pop(signo);
D
Daniel Barkalow 已提交
438 439 440
	raise(signo);
}

441 442 443 444 445 446 447 448
static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
{
	struct ref *ref;
	struct strbuf head = STRBUF_INIT;
	strbuf_addstr(&head, "refs/heads/");
	strbuf_addstr(&head, branch);
	ref = find_ref_by_name(refs, head.buf);
	strbuf_release(&head);
449 450 451 452 453 454 455 456 457

	if (ref)
		return ref;

	strbuf_addstr(&head, "refs/tags/");
	strbuf_addstr(&head, branch);
	ref = find_ref_by_name(refs, head.buf);
	strbuf_release(&head);

458 459 460
	return ref;
}

461 462
static struct ref *wanted_peer_refs(const struct ref *refs,
		struct refspec *refspec)
D
Daniel Barkalow 已提交
463
{
J
Jeff King 已提交
464 465 466
	struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
	struct ref *local_refs = head;
	struct ref **tail = head ? &head->next : &local_refs;
D
Daniel Barkalow 已提交
467

468 469 470 471 472
	if (option_single_branch) {
		struct ref *remote_head = NULL;

		if (!option_branch)
			remote_head = guess_remote_head(head, refs, 0);
473 474 475 476 477
		else {
			local_refs = NULL;
			tail = &local_refs;
			remote_head = copy_ref(find_remote_branch(refs, option_branch));
		}
478 479 480 481

		if (!remote_head && option_branch)
			warning(_("Could not find remote branch %s to clone."),
				option_branch);
482
		else {
483
			get_fetch_map(remote_head, refspec, &tail, 0);
484 485 486 487

			/* if --branch=tag, pull the requested tag explicitly */
			get_fetch_map(remote_head, tag_refspec, &tail, 0);
		}
488 489 490 491
	} else
		get_fetch_map(refs, refspec, &tail, 0);

	if (!option_mirror && !option_single_branch)
492
		get_fetch_map(refs, tag_refspec, &tail, 0);
D
Daniel Barkalow 已提交
493

494 495 496 497 498 499 500
	return local_refs;
}

static void write_remote_refs(const struct ref *local_refs)
{
	const struct ref *r;

501 502
	lock_packed_refs(LOCK_DIE_ON_ERROR);

J
Jeff King 已提交
503 504 505
	for (r = local_refs; r; r = r->next) {
		if (!r->peer_ref)
			continue;
506
		add_packed_ref(r->peer_ref->name, r->old_sha1);
J
Jeff King 已提交
507
	}
J
Johan Herland 已提交
508

509 510
	if (commit_packed_refs())
		die_errno("unable to overwrite old ref-pack file");
D
Daniel Barkalow 已提交
511 512
}

513 514 515 516
static void write_followtags(const struct ref *refs, const char *msg)
{
	const struct ref *ref;
	for (ref = refs; ref; ref = ref->next) {
517
		if (!starts_with(ref->name, "refs/tags/"))
518
			continue;
519
		if (ends_with(ref->name, "^{}"))
520 521 522 523
			continue;
		if (!has_sha1_file(ref->old_sha1))
			continue;
		update_ref(msg, ref->name, ref->old_sha1,
524
			   NULL, 0, UPDATE_REFS_DIE_ON_ERR);
525 526 527
	}
}

528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
static int iterate_ref_map(void *cb_data, unsigned char sha1[20])
{
	struct ref **rm = cb_data;
	struct ref *ref = *rm;

	/*
	 * Skip anything missing a peer_ref, which we are not
	 * actually going to write a ref for.
	 */
	while (ref && !ref->peer_ref)
		ref = ref->next;
	/* Returning -1 notes "end of list" to the caller. */
	if (!ref)
		return -1;

	hashcpy(sha1, ref->old_sha1);
	*rm = ref->next;
	return 0;
}

548 549 550 551
static void update_remote_refs(const struct ref *refs,
			       const struct ref *mapped_refs,
			       const struct ref *remote_head_points_at,
			       const char *branch_top,
552
			       const char *msg,
553
			       struct transport *transport,
554
			       int check_connectivity)
555
{
556 557
	const struct ref *rm = mapped_refs;

558
	if (check_connectivity) {
559
		if (transport->progress)
560
			fprintf(stderr, _("Checking connectivity... "));
561 562
		if (check_everything_connected_with_transport(iterate_ref_map,
							      0, &rm, transport))
563
			die(_("remote did not send all necessary objects"));
564
		if (transport->progress)
565
			fprintf(stderr, _("done.\n"));
566
	}
567

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
	if (refs) {
		write_remote_refs(mapped_refs);
		if (option_single_branch)
			write_followtags(refs, msg);
	}

	if (remote_head_points_at && !option_bare) {
		struct strbuf head_ref = STRBUF_INIT;
		strbuf_addstr(&head_ref, branch_top);
		strbuf_addstr(&head_ref, "HEAD");
		create_symref(head_ref.buf,
			      remote_head_points_at->peer_ref->name,
			      msg);
	}
}

584 585 586
static void update_head(const struct ref *our, const struct ref *remote,
			const char *msg)
{
587 588
	const char *head;
	if (our && skip_prefix(our->name, "refs/heads/", &head)) {
589 590 591
		/* Local default branch link */
		create_symref("HEAD", our->name, NULL);
		if (!option_bare) {
592 593
			update_ref(msg, "HEAD", our->old_sha1, NULL, 0,
				   UPDATE_REFS_DIE_ON_ERR);
594 595
			install_branch_config(0, head, option_origin, our->name);
		}
596 597 598 599
	} else if (our) {
		struct commit *c = lookup_commit_reference(our->old_sha1);
		/* --branch specifies a non-branch (i.e. tags), detach HEAD */
		update_ref(msg, "HEAD", c->object.sha1,
600
			   NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
601 602 603
	} else if (remote) {
		/*
		 * We know remote HEAD points to a non-branch, or
604
		 * HEAD points to a branch but we don't know which one.
605 606 607
		 * Detach HEAD in all these cases.
		 */
		update_ref(msg, "HEAD", remote->old_sha1,
608
			   NULL, REF_NODEREF, UPDATE_REFS_DIE_ON_ERR);
609 610 611
	}
}

612 613 614 615 616 617 618 619
static int checkout(void)
{
	unsigned char sha1[20];
	char *head;
	struct lock_file *lock_file;
	struct unpack_trees_options opts;
	struct tree *tree;
	struct tree_desc t;
620
	int err = 0;
621 622 623 624 625 626 627 628 629 630

	if (option_no_checkout)
		return 0;

	head = resolve_refdup("HEAD", sha1, 1, NULL);
	if (!head) {
		warning(_("remote HEAD refers to nonexistent ref, "
			  "unable to checkout.\n"));
		return 0;
	}
631 632 633 634
	if (!strcmp(head, "HEAD")) {
		if (advice_detached_head)
			detach_advice(sha1_to_hex(sha1));
	} else {
635
		if (!starts_with(head, "refs/heads/"))
636 637 638 639 640 641 642 643
			die(_("HEAD not found below refs/heads!"));
	}
	free(head);

	/* We need to be in the new work tree for the checkout */
	setup_work_tree();

	lock_file = xcalloc(1, sizeof(struct lock_file));
644
	hold_locked_index(lock_file, 1);
645 646 647 648 649

	memset(&opts, 0, sizeof opts);
	opts.update = 1;
	opts.merge = 1;
	opts.fn = oneway_merge;
650
	opts.verbose_update = (option_verbosity >= 0);
651 652 653 654 655 656
	opts.src_index = &the_index;
	opts.dst_index = &the_index;

	tree = parse_tree_indirect(sha1);
	parse_tree(tree);
	init_tree_desc(&t, tree->buffer, tree->size);
657 658
	if (unpack_trees(1, &t, &opts) < 0)
		die(_("unable to checkout working tree"));
659

660
	if (write_locked_index(&the_index, lock_file, COMMIT_LOCK))
661 662
		die(_("unable to write new index file"));

663 664
	err |= run_hook_le(NULL, "post-checkout", sha1_to_hex(null_sha1),
			   sha1_to_hex(sha1), "1", NULL);
665 666 667 668 669 670 671

	if (!err && option_recursive)
		err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);

	return err;
}

672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687
static int write_one_config(const char *key, const char *value, void *data)
{
	return git_config_set_multivar(key, value ? value : "true", "^$", 0);
}

static void write_config(struct string_list *config)
{
	int i;

	for (i = 0; i < config->nr; i++) {
		if (git_config_parse_parameter(config->items[i].string,
					       write_one_config, NULL) < 0)
			die("unable to write parameters to config file");
	}
}

688 689 690 691
static void write_refspec_config(const char *src_ref_prefix,
		const struct ref *our_head_points_at,
		const struct ref *remote_head_points_at,
		struct strbuf *branch_top)
692 693 694 695 696 697 698
{
	struct strbuf key = STRBUF_INIT;
	struct strbuf value = STRBUF_INIT;

	if (option_mirror || !option_bare) {
		if (option_single_branch && !option_mirror) {
			if (option_branch) {
699
				if (starts_with(our_head_points_at->name, "refs/tags/"))
700 701 702 703 704 705
					strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
						our_head_points_at->name);
				else
					strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
						branch_top->buf, option_branch);
			} else if (remote_head_points_at) {
706 707 708 709
				const char *head = remote_head_points_at->name;
				if (!skip_prefix(head, "refs/heads/", &head))
					die("BUG: remote HEAD points at non-head?");

710
				strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
711
						branch_top->buf, head);
712 713 714 715
			}
			/*
			 * otherwise, the next "git fetch" will
			 * simply fetch from HEAD without updating
716
			 * any remote-tracking branch, which is what
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739
			 * we want.
			 */
		} else {
			strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
		}
		/* Configure the remote */
		if (value.len) {
			strbuf_addf(&key, "remote.%s.fetch", option_origin);
			git_config_set_multivar(key.buf, value.buf, "^$", 0);
			strbuf_reset(&key);

			if (option_mirror) {
				strbuf_addf(&key, "remote.%s.mirror", option_origin);
				git_config_set(key.buf, "true");
				strbuf_reset(&key);
			}
		}
	}

	strbuf_release(&key);
	strbuf_release(&value);
}

D
Daniel Barkalow 已提交
740 741
int cmd_clone(int argc, const char **argv, const char *prefix)
{
742
	int is_bundle = 0, is_local;
D
Daniel Barkalow 已提交
743 744 745
	struct stat buf;
	const char *repo_name, *repo, *work_tree, *git_dir;
	char *path, *dir;
746
	int dest_exists;
D
Daniel Barkalow 已提交
747
	const struct ref *refs, *remote_head;
748 749
	const struct ref *remote_head_points_at;
	const struct ref *our_head_points_at;
D
Daniel Barkalow 已提交
750
	struct ref *mapped_refs;
751
	const struct ref *ref;
752 753
	struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
	struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
754
	struct transport *transport = NULL;
755
	const char *src_ref_prefix = "refs/heads/";
756
	struct remote *remote;
757
	int err = 0, complete_refs_before_fetch = 1;
D
Daniel Barkalow 已提交
758

759 760
	struct refspec *refspec;
	const char *fetch_pattern;
D
Daniel Barkalow 已提交
761 762 763

	junk_pid = getpid();

J
Jeff King 已提交
764
	packet_trace_identity("clone");
765
	argc = parse_options(argc, argv, prefix, builtin_clone_options,
D
Daniel Barkalow 已提交
766 767
			     builtin_clone_usage, 0);

J
Jonathan Nieder 已提交
768
	if (argc > 2)
769
		usage_msg_opt(_("Too many arguments."),
J
Jonathan Nieder 已提交
770 771
			builtin_clone_usage, builtin_clone_options);

D
Daniel Barkalow 已提交
772
	if (argc == 0)
773
		usage_msg_opt(_("You must specify a repository to clone."),
J
Jonathan Nieder 已提交
774
			builtin_clone_usage, builtin_clone_options);
D
Daniel Barkalow 已提交
775

776 777 778
	if (option_single_branch == -1)
		option_single_branch = option_depth ? 1 : 0;

779 780 781
	if (option_mirror)
		option_bare = 1;

D
Daniel Barkalow 已提交
782 783
	if (option_bare) {
		if (option_origin)
784
			die(_("--bare and --origin %s options are incompatible."),
D
Daniel Barkalow 已提交
785
			    option_origin);
786 787
		if (real_git_dir)
			die(_("--bare and --separate-git-dir are incompatible."));
D
Daniel Barkalow 已提交
788 789 790 791 792 793 794 795 796 797
		option_no_checkout = 1;
	}

	if (!option_origin)
		option_origin = "origin";

	repo_name = argv[0];

	path = get_repo_path(repo_name, &is_bundle);
	if (path)
798
		repo = xstrdup(absolute_path(repo_name));
D
Daniel Barkalow 已提交
799
	else if (!strchr(repo_name, ':'))
800
		die(_("repository '%s' does not exist"), repo_name);
D
Daniel Barkalow 已提交
801 802 803
	else
		repo = repo_name;

804 805 806 807
	/* no need to be strict, transport_set_option() will validate it again */
	if (option_depth && atoi(option_depth) < 1)
		die(_("depth %s is not a positive number"), option_depth);

D
Daniel Barkalow 已提交
808 809 810
	if (argc == 2)
		dir = xstrdup(argv[1]);
	else
811
		dir = guess_dir_name(repo_name, is_bundle, option_bare);
812
	strip_trailing_slashes(dir);
D
Daniel Barkalow 已提交
813

814 815
	dest_exists = !stat(dir, &buf);
	if (dest_exists && !is_empty_dir(dir))
816 817
		die(_("destination path '%s' already exists and is not "
			"an empty directory."), dir);
D
Daniel Barkalow 已提交
818 819 820 821 822 823 824 825

	strbuf_addf(&reflog_msg, "clone: from %s", repo);

	if (option_bare)
		work_tree = NULL;
	else {
		work_tree = getenv("GIT_WORK_TREE");
		if (work_tree && !stat(work_tree, &buf))
826
			die(_("working tree '%s' already exists."), work_tree);
D
Daniel Barkalow 已提交
827 828 829 830 831 832
	}

	if (option_bare || work_tree)
		git_dir = xstrdup(dir);
	else {
		work_tree = dir;
833
		git_dir = mkpathdup("%s/.git", dir);
D
Daniel Barkalow 已提交
834 835 836 837
	}

	if (!option_bare) {
		junk_work_tree = work_tree;
838
		if (safe_create_leading_directories_const(work_tree) < 0)
839
			die_errno(_("could not create leading directories of '%s'"),
840
				  work_tree);
841
		if (!dest_exists && mkdir(work_tree, 0777))
842
			die_errno(_("could not create work tree dir '%s'."),
843
				  work_tree);
D
Daniel Barkalow 已提交
844 845 846 847
		set_git_work_tree(work_tree);
	}
	junk_git_dir = git_dir;
	atexit(remove_junk);
848
	sigchain_push_common(remove_junk_on_signal);
D
Daniel Barkalow 已提交
849

850
	if (safe_create_leading_directories_const(git_dir) < 0)
851
		die(_("could not create leading directories of '%s'"), git_dir);
852 853

	set_git_dir_init(git_dir, real_git_dir, 0);
854
	if (real_git_dir) {
855
		git_dir = real_git_dir;
856 857
		junk_git_dir = real_git_dir;
	}
D
Daniel Barkalow 已提交
858

859 860
	if (0 <= option_verbosity) {
		if (option_bare)
861
			fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
862
		else
863
			fprintf(stderr, _("Cloning into '%s'...\n"), dir);
864
	}
865
	init_db(option_template, INIT_DB_QUIET);
866
	write_config(&option_config);
D
Daniel Barkalow 已提交
867

J
Junio C Hamano 已提交
868
	git_config(git_default_config, NULL);
D
Daniel Barkalow 已提交
869 870

	if (option_bare) {
871 872
		if (option_mirror)
			src_ref_prefix = "refs/";
873
		strbuf_addstr(&branch_top, src_ref_prefix);
D
Daniel Barkalow 已提交
874 875 876

		git_config_set("core.bare", "true");
	} else {
877
		strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
878
	}
D
Daniel Barkalow 已提交
879

880
	strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
881 882 883 884
	strbuf_addf(&key, "remote.%s.url", option_origin);
	git_config_set(key.buf, repo);
	strbuf_reset(&key);

885 886
	if (option_reference.nr)
		setup_reference();
887

888 889 890 891
	fetch_pattern = value.buf;
	refspec = parse_fetch_refspec(1, &fetch_pattern);

	strbuf_reset(&value);
D
Daniel Barkalow 已提交
892

893 894
	remote = remote_get(option_origin);
	transport = transport_get(remote, remote->url[0]);
895 896 897 898 899 900 901 902 903 904 905 906 907
	path = get_repo_path(remote->url[0], &is_bundle);
	is_local = option_local != 0 && path && !is_bundle;
	if (is_local) {
		if (option_depth)
			warning(_("--depth is ignored in local clones; use file:// instead."));
		if (!access(mkpath("%s/shallow", path), F_OK)) {
			if (option_local > 0)
				warning(_("source repository is shallow, ignoring --local"));
			is_local = 0;
		}
	}
	if (option_local > 0 && !is_local)
		warning(_("--local is ignored"));
908
	transport->cloning = 1;
D
Daniel Barkalow 已提交
909

J
Jeff King 已提交
910 911
	if (!transport->get_refs_list || (!is_local && !transport->fetch))
		die(_("Don't know how to clone %s"), transport->url);
912

J
Jeff King 已提交
913
	transport_set_option(transport, TRANS_OPT_KEEP, "yes");
D
Daniel Barkalow 已提交
914

J
Jeff King 已提交
915 916 917 918 919
	if (option_depth)
		transport_set_option(transport, TRANS_OPT_DEPTH,
				     option_depth);
	if (option_single_branch)
		transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
D
Daniel Barkalow 已提交
920

J
Jeff King 已提交
921
	transport_set_verbosity(transport, option_verbosity, option_progress);
D
Daniel Barkalow 已提交
922

J
Jeff King 已提交
923 924 925
	if (option_upload_pack)
		transport_set_option(transport, TRANS_OPT_UPLOADPACK,
				     option_upload_pack);
926

J
Jeff King 已提交
927 928
	if (transport->smart_options && !option_depth)
		transport->smart_options->check_self_contained_and_connected = 1;
D
Daniel Barkalow 已提交
929

930
	refs = transport_get_remote_refs(transport);
D
Daniel Barkalow 已提交
931

932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
	if (refs) {
		mapped_refs = wanted_peer_refs(refs, refspec);
		/*
		 * transport_get_remote_refs() may return refs with null sha-1
		 * in mapped_refs (see struct transport->get_refs_list
		 * comment). In that case we need fetch it early because
		 * remote_head code below relies on it.
		 *
		 * for normal clones, transport_get_remote_refs() should
		 * return reliable ref set, we can delay cloning until after
		 * remote HEAD check.
		 */
		for (ref = refs; ref; ref = ref->next)
			if (is_null_sha1(ref->old_sha1)) {
				complete_refs_before_fetch = 0;
				break;
			}
949

950 951
		if (!is_local && !complete_refs_before_fetch)
			transport_fetch_refs(transport, mapped_refs);
D
Daniel Barkalow 已提交
952

953
		remote_head = find_ref_by_name(refs, "HEAD");
954 955 956 957 958
		remote_head_points_at =
			guess_remote_head(remote_head, mapped_refs, 0);

		if (option_branch) {
			our_head_points_at =
959
				find_remote_branch(mapped_refs, option_branch);
960

961 962 963
			if (!our_head_points_at)
				die(_("Remote branch %s not found in upstream %s"),
				    option_branch, option_origin);
964 965 966
		}
		else
			our_head_points_at = remote_head_points_at;
967 968
	}
	else {
969 970 971 972
		if (option_branch)
			die(_("Remote branch %s not found in upstream %s"),
					option_branch, option_origin);

973
		warning(_("You appear to have cloned an empty repository."));
974
		mapped_refs = NULL;
975 976
		our_head_points_at = NULL;
		remote_head_points_at = NULL;
977 978
		remote_head = NULL;
		option_no_checkout = 1;
979
		if (!option_bare)
980
			install_branch_config(0, "master", option_origin,
981
					      "refs/heads/master");
982
	}
D
Daniel Barkalow 已提交
983

984 985 986
	write_refspec_config(src_ref_prefix, our_head_points_at,
			remote_head_points_at, &branch_top);

987 988
	if (is_local)
		clone_local(path, git_dir);
989
	else if (refs && complete_refs_before_fetch)
990
		transport_fetch_refs(transport, mapped_refs);
D
Daniel Barkalow 已提交
991

992
	update_remote_refs(refs, mapped_refs, remote_head_points_at,
993
			   branch_top.buf, reflog_msg.buf, transport, !is_local);
D
Daniel Barkalow 已提交
994

995
	update_head(our_head_points_at, remote_head, reflog_msg.buf);
996

997 998
	transport_unlock_pack(transport);
	transport_disconnect(transport);
999

1000
	junk_mode = JUNK_LEAVE_REPO;
1001
	err = checkout();
D
Daniel Barkalow 已提交
1002 1003

	strbuf_release(&reflog_msg);
1004 1005 1006
	strbuf_release(&branch_top);
	strbuf_release(&key);
	strbuf_release(&value);
1007
	junk_mode = JUNK_LEAVE_ALL;
1008 1009

	free(refspec);
1010
	return err;
D
Daniel Barkalow 已提交
1011
}