Documentation updates for 'GIT_WORK_TREE without GIT_DIR' historical usecase
[git/jnareb-git/bp-gitweb.git] / builtin / clone.c
blob61e0989b5ab8fffb16ec28e64c38b4fa236cb3ed
1 /*
2 * Builtin "git clone"
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
5 * 2008 Daniel Barkalow <barkalow@iabervon.org>
6 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
8 * Clone a repository into a different directory that does not yet exist.
9 */
11 #include "cache.h"
12 #include "parse-options.h"
13 #include "fetch-pack.h"
14 #include "refs.h"
15 #include "tree.h"
16 #include "tree-walk.h"
17 #include "unpack-trees.h"
18 #include "transport.h"
19 #include "strbuf.h"
20 #include "dir.h"
21 #include "pack-refs.h"
22 #include "sigchain.h"
23 #include "branch.h"
24 #include "remote.h"
25 #include "run-command.h"
28 * Overall FIXMEs:
29 * - respect DB_ENVIRONMENT for .git/objects.
31 * Implementation notes:
32 * - dropping use-separate-remote and no-separate-remote compatibility
35 static const char * const builtin_clone_usage[] = {
36 "git clone [options] [--] <repo> [<dir>]",
37 NULL
40 static int option_no_checkout, option_bare, option_mirror;
41 static int option_local, option_no_hardlinks, option_shared, option_recursive;
42 static char *option_template, *option_reference, *option_depth;
43 static char *option_origin = NULL;
44 static char *option_branch = NULL;
45 static char *option_upload_pack = "git-upload-pack";
46 static int option_verbosity;
47 static int option_progress;
49 static struct option builtin_clone_options[] = {
50 OPT__VERBOSITY(&option_verbosity),
51 OPT_BOOLEAN(0, "progress", &option_progress,
52 "force progress reporting"),
53 OPT_BOOLEAN('n', "no-checkout", &option_no_checkout,
54 "don't create a checkout"),
55 OPT_BOOLEAN(0, "bare", &option_bare, "create a bare repository"),
56 { OPTION_BOOLEAN, 0, "naked", &option_bare, NULL,
57 "create a bare repository",
58 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN },
59 OPT_BOOLEAN(0, "mirror", &option_mirror,
60 "create a mirror repository (implies bare)"),
61 OPT_BOOLEAN('l', "local", &option_local,
62 "to clone from a local repository"),
63 OPT_BOOLEAN(0, "no-hardlinks", &option_no_hardlinks,
64 "don't use local hardlinks, always copy"),
65 OPT_BOOLEAN('s', "shared", &option_shared,
66 "setup as shared repository"),
67 OPT_BOOLEAN(0, "recursive", &option_recursive,
68 "initialize submodules in the clone"),
69 OPT_BOOLEAN(0, "recurse_submodules", &option_recursive,
70 "initialize submodules in the clone"),
71 OPT_STRING(0, "template", &option_template, "path",
72 "path the template repository"),
73 OPT_STRING(0, "reference", &option_reference, "repo",
74 "reference repository"),
75 OPT_STRING('o', "origin", &option_origin, "branch",
76 "use <branch> instead of 'origin' to track upstream"),
77 OPT_STRING('b', "branch", &option_branch, "branch",
78 "checkout <branch> instead of the remote's HEAD"),
79 OPT_STRING('u', "upload-pack", &option_upload_pack, "path",
80 "path to git-upload-pack on the remote"),
81 OPT_STRING(0, "depth", &option_depth, "depth",
82 "create a shallow clone of that depth"),
84 OPT_END()
87 static const char *argv_submodule[] = {
88 "submodule", "update", "--init", "--recursive", NULL
91 static char *get_repo_path(const char *repo, int *is_bundle)
93 static char *suffix[] = { "/.git", ".git", "" };
94 static char *bundle_suffix[] = { ".bundle", "" };
95 struct stat st;
96 int i;
98 for (i = 0; i < ARRAY_SIZE(suffix); i++) {
99 const char *path;
100 path = mkpath("%s%s", repo, suffix[i]);
101 if (is_directory(path)) {
102 *is_bundle = 0;
103 return xstrdup(make_nonrelative_path(path));
107 for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
108 const char *path;
109 path = mkpath("%s%s", repo, bundle_suffix[i]);
110 if (!stat(path, &st) && S_ISREG(st.st_mode)) {
111 *is_bundle = 1;
112 return xstrdup(make_nonrelative_path(path));
116 return NULL;
119 static char *guess_dir_name(const char *repo, int is_bundle, int is_bare)
121 const char *end = repo + strlen(repo), *start;
122 char *dir;
125 * Strip trailing spaces, slashes and /.git
127 while (repo < end && (is_dir_sep(end[-1]) || isspace(end[-1])))
128 end--;
129 if (end - repo > 5 && is_dir_sep(end[-5]) &&
130 !strncmp(end - 4, ".git", 4)) {
131 end -= 5;
132 while (repo < end && is_dir_sep(end[-1]))
133 end--;
137 * Find last component, but be prepared that repo could have
138 * the form "remote.example.com:foo.git", i.e. no slash
139 * in the directory part.
141 start = end;
142 while (repo < start && !is_dir_sep(start[-1]) && start[-1] != ':')
143 start--;
146 * Strip .{bundle,git}.
148 if (is_bundle) {
149 if (end - start > 7 && !strncmp(end - 7, ".bundle", 7))
150 end -= 7;
151 } else {
152 if (end - start > 4 && !strncmp(end - 4, ".git", 4))
153 end -= 4;
156 if (is_bare) {
157 struct strbuf result = STRBUF_INIT;
158 strbuf_addf(&result, "%.*s.git", (int)(end - start), start);
159 dir = strbuf_detach(&result, NULL);
160 } else
161 dir = xstrndup(start, end - start);
163 * Replace sequences of 'control' characters and whitespace
164 * with one ascii space, remove leading and trailing spaces.
166 if (*dir) {
167 char *out = dir;
168 int prev_space = 1 /* strip leading whitespace */;
169 for (end = dir; *end; ++end) {
170 char ch = *end;
171 if ((unsigned char)ch < '\x20')
172 ch = '\x20';
173 if (isspace(ch)) {
174 if (prev_space)
175 continue;
176 prev_space = 1;
177 } else
178 prev_space = 0;
179 *out++ = ch;
181 *out = '\0';
182 if (out > dir && prev_space)
183 out[-1] = '\0';
185 return dir;
188 static void strip_trailing_slashes(char *dir)
190 char *end = dir + strlen(dir);
192 while (dir < end - 1 && is_dir_sep(end[-1]))
193 end--;
194 *end = '\0';
197 static void setup_reference(const char *repo)
199 const char *ref_git;
200 char *ref_git_copy;
202 struct remote *remote;
203 struct transport *transport;
204 const struct ref *extra;
206 ref_git = make_absolute_path(option_reference);
208 if (is_directory(mkpath("%s/.git/objects", ref_git)))
209 ref_git = mkpath("%s/.git", ref_git);
210 else if (!is_directory(mkpath("%s/objects", ref_git)))
211 die("reference repository '%s' is not a local directory.",
212 option_reference);
214 ref_git_copy = xstrdup(ref_git);
216 add_to_alternates_file(ref_git_copy);
218 remote = remote_get(ref_git_copy);
219 transport = transport_get(remote, ref_git_copy);
220 for (extra = transport_get_remote_refs(transport); extra;
221 extra = extra->next)
222 add_extra_ref(extra->name, extra->old_sha1, 0);
224 transport_disconnect(transport);
226 free(ref_git_copy);
229 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest)
231 struct dirent *de;
232 struct stat buf;
233 int src_len, dest_len;
234 DIR *dir;
236 dir = opendir(src->buf);
237 if (!dir)
238 die_errno("failed to open '%s'", src->buf);
240 if (mkdir(dest->buf, 0777)) {
241 if (errno != EEXIST)
242 die_errno("failed to create directory '%s'", dest->buf);
243 else if (stat(dest->buf, &buf))
244 die_errno("failed to stat '%s'", dest->buf);
245 else if (!S_ISDIR(buf.st_mode))
246 die("%s exists and is not a directory", dest->buf);
249 strbuf_addch(src, '/');
250 src_len = src->len;
251 strbuf_addch(dest, '/');
252 dest_len = dest->len;
254 while ((de = readdir(dir)) != NULL) {
255 strbuf_setlen(src, src_len);
256 strbuf_addstr(src, de->d_name);
257 strbuf_setlen(dest, dest_len);
258 strbuf_addstr(dest, de->d_name);
259 if (stat(src->buf, &buf)) {
260 warning ("failed to stat %s\n", src->buf);
261 continue;
263 if (S_ISDIR(buf.st_mode)) {
264 if (de->d_name[0] != '.')
265 copy_or_link_directory(src, dest);
266 continue;
269 if (unlink(dest->buf) && errno != ENOENT)
270 die_errno("failed to unlink '%s'", dest->buf);
271 if (!option_no_hardlinks) {
272 if (!link(src->buf, dest->buf))
273 continue;
274 if (option_local)
275 die_errno("failed to create link '%s'", dest->buf);
276 option_no_hardlinks = 1;
278 if (copy_file_with_time(dest->buf, src->buf, 0666))
279 die_errno("failed to copy file to '%s'", dest->buf);
281 closedir(dir);
284 static const struct ref *clone_local(const char *src_repo,
285 const char *dest_repo)
287 const struct ref *ret;
288 struct strbuf src = STRBUF_INIT;
289 struct strbuf dest = STRBUF_INIT;
290 struct remote *remote;
291 struct transport *transport;
293 if (option_shared)
294 add_to_alternates_file(src_repo);
295 else {
296 strbuf_addf(&src, "%s/objects", src_repo);
297 strbuf_addf(&dest, "%s/objects", dest_repo);
298 copy_or_link_directory(&src, &dest);
299 strbuf_release(&src);
300 strbuf_release(&dest);
303 remote = remote_get(src_repo);
304 transport = transport_get(remote, src_repo);
305 ret = transport_get_remote_refs(transport);
306 transport_disconnect(transport);
307 if (0 <= option_verbosity)
308 printf("done.\n");
309 return ret;
312 static const char *junk_work_tree;
313 static const char *junk_git_dir;
314 static pid_t junk_pid;
316 static void remove_junk(void)
318 struct strbuf sb = STRBUF_INIT;
319 if (getpid() != junk_pid)
320 return;
321 if (junk_git_dir) {
322 strbuf_addstr(&sb, junk_git_dir);
323 remove_dir_recursively(&sb, 0);
324 strbuf_reset(&sb);
326 if (junk_work_tree) {
327 strbuf_addstr(&sb, junk_work_tree);
328 remove_dir_recursively(&sb, 0);
329 strbuf_reset(&sb);
333 static void remove_junk_on_signal(int signo)
335 remove_junk();
336 sigchain_pop(signo);
337 raise(signo);
340 static struct ref *wanted_peer_refs(const struct ref *refs,
341 struct refspec *refspec)
343 struct ref *local_refs = NULL;
344 struct ref **tail = &local_refs;
346 get_fetch_map(refs, refspec, &tail, 0);
347 if (!option_mirror)
348 get_fetch_map(refs, tag_refspec, &tail, 0);
350 return local_refs;
353 static void write_remote_refs(const struct ref *local_refs)
355 const struct ref *r;
357 for (r = local_refs; r; r = r->next)
358 add_extra_ref(r->peer_ref->name, r->old_sha1, 0);
360 pack_refs(PACK_REFS_ALL);
361 clear_extra_refs();
364 int cmd_clone(int argc, const char **argv, const char *prefix)
366 int is_bundle = 0, is_local;
367 struct stat buf;
368 const char *repo_name, *repo, *work_tree, *git_dir;
369 char *path, *dir;
370 int dest_exists;
371 const struct ref *refs, *remote_head;
372 const struct ref *remote_head_points_at;
373 const struct ref *our_head_points_at;
374 struct ref *mapped_refs;
375 struct strbuf key = STRBUF_INIT, value = STRBUF_INIT;
376 struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
377 struct transport *transport = NULL;
378 char *src_ref_prefix = "refs/heads/";
379 int err = 0;
381 struct refspec *refspec;
382 const char *fetch_pattern;
384 junk_pid = getpid();
386 argc = parse_options(argc, argv, prefix, builtin_clone_options,
387 builtin_clone_usage, 0);
389 if (argc > 2)
390 usage_msg_opt("Too many arguments.",
391 builtin_clone_usage, builtin_clone_options);
393 if (argc == 0)
394 usage_msg_opt("You must specify a repository to clone.",
395 builtin_clone_usage, builtin_clone_options);
397 if (option_mirror)
398 option_bare = 1;
400 if (option_bare) {
401 if (option_origin)
402 die("--bare and --origin %s options are incompatible.",
403 option_origin);
404 option_no_checkout = 1;
407 if (!option_origin)
408 option_origin = "origin";
410 repo_name = argv[0];
412 path = get_repo_path(repo_name, &is_bundle);
413 if (path)
414 repo = xstrdup(make_nonrelative_path(repo_name));
415 else if (!strchr(repo_name, ':'))
416 repo = xstrdup(make_absolute_path(repo_name));
417 else
418 repo = repo_name;
419 is_local = path && !is_bundle;
420 if (is_local && option_depth)
421 warning("--depth is ignored in local clones; use file:// instead.");
423 if (argc == 2)
424 dir = xstrdup(argv[1]);
425 else
426 dir = guess_dir_name(repo_name, is_bundle, option_bare);
427 strip_trailing_slashes(dir);
429 dest_exists = !stat(dir, &buf);
430 if (dest_exists && !is_empty_dir(dir))
431 die("destination path '%s' already exists and is not "
432 "an empty directory.", dir);
434 strbuf_addf(&reflog_msg, "clone: from %s", repo);
436 if (option_bare)
437 work_tree = NULL;
438 else {
439 work_tree = getenv("GIT_WORK_TREE");
440 if (work_tree && !stat(work_tree, &buf))
441 die("working tree '%s' already exists.", work_tree);
444 if (option_bare || work_tree)
445 git_dir = xstrdup(dir);
446 else {
447 work_tree = dir;
448 git_dir = xstrdup(mkpath("%s/.git", dir));
451 if (!option_bare) {
452 junk_work_tree = work_tree;
453 if (safe_create_leading_directories_const(work_tree) < 0)
454 die_errno("could not create leading directories of '%s'",
455 work_tree);
456 if (!dest_exists && mkdir(work_tree, 0755))
457 die_errno("could not create work tree dir '%s'.",
458 work_tree);
459 set_git_work_tree(work_tree);
461 junk_git_dir = git_dir;
462 atexit(remove_junk);
463 sigchain_push_common(remove_junk_on_signal);
465 setenv(CONFIG_ENVIRONMENT, mkpath("%s/config", git_dir), 1);
467 if (safe_create_leading_directories_const(git_dir) < 0)
468 die("could not create leading directories of '%s'", git_dir);
469 set_git_dir(make_absolute_path(git_dir));
471 if (0 <= option_verbosity)
472 printf("Cloning into %s%s...\n",
473 option_bare ? "bare repository " : "", dir);
474 init_db(option_template, INIT_DB_QUIET);
477 * At this point, the config exists, so we do not need the
478 * environment variable. We actually need to unset it, too, to
479 * re-enable parsing of the global configs.
481 unsetenv(CONFIG_ENVIRONMENT);
483 git_config(git_default_config, NULL);
485 if (option_bare) {
486 if (option_mirror)
487 src_ref_prefix = "refs/";
488 strbuf_addstr(&branch_top, src_ref_prefix);
490 git_config_set("core.bare", "true");
491 } else {
492 strbuf_addf(&branch_top, "refs/remotes/%s/", option_origin);
495 strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top.buf);
497 if (option_mirror || !option_bare) {
498 /* Configure the remote */
499 strbuf_addf(&key, "remote.%s.fetch", option_origin);
500 git_config_set_multivar(key.buf, value.buf, "^$", 0);
501 strbuf_reset(&key);
503 if (option_mirror) {
504 strbuf_addf(&key, "remote.%s.mirror", option_origin);
505 git_config_set(key.buf, "true");
506 strbuf_reset(&key);
510 strbuf_addf(&key, "remote.%s.url", option_origin);
511 git_config_set(key.buf, repo);
512 strbuf_reset(&key);
514 if (option_reference)
515 setup_reference(git_dir);
517 fetch_pattern = value.buf;
518 refspec = parse_fetch_refspec(1, &fetch_pattern);
520 strbuf_reset(&value);
522 if (is_local) {
523 refs = clone_local(path, git_dir);
524 mapped_refs = wanted_peer_refs(refs, refspec);
525 } else {
526 struct remote *remote = remote_get(option_origin);
527 transport = transport_get(remote, remote->url[0]);
529 if (!transport->get_refs_list || !transport->fetch)
530 die("Don't know how to clone %s", transport->url);
532 transport_set_option(transport, TRANS_OPT_KEEP, "yes");
534 if (option_depth)
535 transport_set_option(transport, TRANS_OPT_DEPTH,
536 option_depth);
538 transport_set_verbosity(transport, option_verbosity, option_progress);
540 if (option_upload_pack)
541 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
542 option_upload_pack);
544 refs = transport_get_remote_refs(transport);
545 if (refs) {
546 mapped_refs = wanted_peer_refs(refs, refspec);
547 transport_fetch_refs(transport, mapped_refs);
551 if (refs) {
552 clear_extra_refs();
554 write_remote_refs(mapped_refs);
556 remote_head = find_ref_by_name(refs, "HEAD");
557 remote_head_points_at =
558 guess_remote_head(remote_head, mapped_refs, 0);
560 if (option_branch) {
561 struct strbuf head = STRBUF_INIT;
562 strbuf_addstr(&head, src_ref_prefix);
563 strbuf_addstr(&head, option_branch);
564 our_head_points_at =
565 find_ref_by_name(mapped_refs, head.buf);
566 strbuf_release(&head);
568 if (!our_head_points_at) {
569 warning("Remote branch %s not found in "
570 "upstream %s, using HEAD instead",
571 option_branch, option_origin);
572 our_head_points_at = remote_head_points_at;
575 else
576 our_head_points_at = remote_head_points_at;
578 else {
579 warning("You appear to have cloned an empty repository.");
580 our_head_points_at = NULL;
581 remote_head_points_at = NULL;
582 remote_head = NULL;
583 option_no_checkout = 1;
584 if (!option_bare)
585 install_branch_config(0, "master", option_origin,
586 "refs/heads/master");
589 if (remote_head_points_at && !option_bare) {
590 struct strbuf head_ref = STRBUF_INIT;
591 strbuf_addstr(&head_ref, branch_top.buf);
592 strbuf_addstr(&head_ref, "HEAD");
593 create_symref(head_ref.buf,
594 remote_head_points_at->peer_ref->name,
595 reflog_msg.buf);
598 if (our_head_points_at) {
599 /* Local default branch link */
600 create_symref("HEAD", our_head_points_at->name, NULL);
601 if (!option_bare) {
602 const char *head = skip_prefix(our_head_points_at->name,
603 "refs/heads/");
604 update_ref(reflog_msg.buf, "HEAD",
605 our_head_points_at->old_sha1,
606 NULL, 0, DIE_ON_ERR);
607 install_branch_config(0, head, option_origin,
608 our_head_points_at->name);
610 } else if (remote_head) {
611 /* Source had detached HEAD pointing somewhere. */
612 if (!option_bare) {
613 update_ref(reflog_msg.buf, "HEAD",
614 remote_head->old_sha1,
615 NULL, REF_NODEREF, DIE_ON_ERR);
616 our_head_points_at = remote_head;
618 } else {
619 /* Nothing to checkout out */
620 if (!option_no_checkout)
621 warning("remote HEAD refers to nonexistent ref, "
622 "unable to checkout.\n");
623 option_no_checkout = 1;
626 if (transport) {
627 transport_unlock_pack(transport);
628 transport_disconnect(transport);
631 if (!option_no_checkout) {
632 struct lock_file *lock_file = xcalloc(1, sizeof(struct lock_file));
633 struct unpack_trees_options opts;
634 struct tree *tree;
635 struct tree_desc t;
636 int fd;
638 /* We need to be in the new work tree for the checkout */
639 setup_work_tree();
641 fd = hold_locked_index(lock_file, 1);
643 memset(&opts, 0, sizeof opts);
644 opts.update = 1;
645 opts.merge = 1;
646 opts.fn = oneway_merge;
647 opts.verbose_update = (option_verbosity > 0);
648 opts.src_index = &the_index;
649 opts.dst_index = &the_index;
651 tree = parse_tree_indirect(our_head_points_at->old_sha1);
652 parse_tree(tree);
653 init_tree_desc(&t, tree->buffer, tree->size);
654 unpack_trees(1, &t, &opts);
656 if (write_cache(fd, active_cache, active_nr) ||
657 commit_locked_index(lock_file))
658 die("unable to write new index file");
660 err |= run_hook(NULL, "post-checkout", sha1_to_hex(null_sha1),
661 sha1_to_hex(our_head_points_at->old_sha1), "1",
662 NULL);
664 if (!err && option_recursive)
665 err = run_command_v_opt(argv_submodule, RUN_GIT_CMD);
668 strbuf_release(&reflog_msg);
669 strbuf_release(&branch_top);
670 strbuf_release(&key);
671 strbuf_release(&value);
672 junk_pid = 0;
673 return err;