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.
14 #include "parse-options.h"
15 #include "fetch-pack.h"
19 #include "tree-walk.h"
20 #include "unpack-trees.h"
21 #include "transport.h"
27 #include "run-command.h"
28 #include "connected.h"
30 #include "list-objects-filter-options.h"
31 #include "object-store.h"
35 * - respect DB_ENVIRONMENT for .git/objects.
37 * Implementation notes:
38 * - dropping use-separate-remote and no-separate-remote compatibility
41 static const char * const builtin_clone_usage
[] = {
42 N_("git clone [<options>] [--] <repo> [<dir>]"),
46 static int option_no_checkout
, option_bare
, option_mirror
, option_single_branch
= -1;
47 static int option_local
= -1, option_no_hardlinks
, option_shared
;
48 static int option_no_tags
;
49 static int option_shallow_submodules
;
51 static char *option_template
, *option_depth
, *option_since
;
52 static char *option_origin
= NULL
;
53 static char *option_branch
= NULL
;
54 static struct string_list option_not
= STRING_LIST_INIT_NODUP
;
55 static const char *real_git_dir
;
56 static char *option_upload_pack
= "git-upload-pack";
57 static int option_verbosity
;
58 static int option_progress
= -1;
59 static enum transport_family family
;
60 static struct string_list option_config
= STRING_LIST_INIT_NODUP
;
61 static struct string_list option_required_reference
= STRING_LIST_INIT_NODUP
;
62 static struct string_list option_optional_reference
= STRING_LIST_INIT_NODUP
;
63 static int option_dissociate
;
64 static int max_jobs
= -1;
65 static struct string_list option_recurse_submodules
= STRING_LIST_INIT_NODUP
;
66 static struct list_objects_filter_options filter_options
;
68 static int recurse_submodules_cb(const struct option
*opt
,
69 const char *arg
, int unset
)
72 string_list_clear((struct string_list
*)opt
->value
, 0);
74 string_list_append((struct string_list
*)opt
->value
, arg
);
76 string_list_append((struct string_list
*)opt
->value
,
77 (const char *)opt
->defval
);
82 static struct option builtin_clone_options
[] = {
83 OPT__VERBOSITY(&option_verbosity
),
84 OPT_BOOL(0, "progress", &option_progress
,
85 N_("force progress reporting")),
86 OPT_BOOL('n', "no-checkout", &option_no_checkout
,
87 N_("don't create a checkout")),
88 OPT_BOOL(0, "bare", &option_bare
, N_("create a bare repository")),
89 OPT_HIDDEN_BOOL(0, "naked", &option_bare
,
90 N_("create a bare repository")),
91 OPT_BOOL(0, "mirror", &option_mirror
,
92 N_("create a mirror repository (implies bare)")),
93 OPT_BOOL('l', "local", &option_local
,
94 N_("to clone from a local repository")),
95 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks
,
96 N_("don't use local hardlinks, always copy")),
97 OPT_BOOL('s', "shared", &option_shared
,
98 N_("setup as shared repository")),
99 { OPTION_CALLBACK
, 0, "recursive", &option_recurse_submodules
,
100 N_("pathspec"), N_("initialize submodules in the clone"),
101 PARSE_OPT_OPTARG
| PARSE_OPT_HIDDEN
, recurse_submodules_cb
,
103 { OPTION_CALLBACK
, 0, "recurse-submodules", &option_recurse_submodules
,
104 N_("pathspec"), N_("initialize submodules in the clone"),
105 PARSE_OPT_OPTARG
, recurse_submodules_cb
, (intptr_t)"." },
106 OPT_INTEGER('j', "jobs", &max_jobs
,
107 N_("number of submodules cloned in parallel")),
108 OPT_STRING(0, "template", &option_template
, N_("template-directory"),
109 N_("directory from which templates will be used")),
110 OPT_STRING_LIST(0, "reference", &option_required_reference
, N_("repo"),
111 N_("reference repository")),
112 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference
,
113 N_("repo"), N_("reference repository")),
114 OPT_BOOL(0, "dissociate", &option_dissociate
,
115 N_("use --reference only while cloning")),
116 OPT_STRING('o', "origin", &option_origin
, N_("name"),
117 N_("use <name> instead of 'origin' to track upstream")),
118 OPT_STRING('b', "branch", &option_branch
, N_("branch"),
119 N_("checkout <branch> instead of the remote's HEAD")),
120 OPT_STRING('u', "upload-pack", &option_upload_pack
, N_("path"),
121 N_("path to git-upload-pack on the remote")),
122 OPT_STRING(0, "depth", &option_depth
, N_("depth"),
123 N_("create a shallow clone of that depth")),
124 OPT_STRING(0, "shallow-since", &option_since
, N_("time"),
125 N_("create a shallow clone since a specific time")),
126 OPT_STRING_LIST(0, "shallow-exclude", &option_not
, N_("revision"),
127 N_("deepen history of shallow clone, excluding rev")),
128 OPT_BOOL(0, "single-branch", &option_single_branch
,
129 N_("clone only one branch, HEAD or --branch")),
130 OPT_BOOL(0, "no-tags", &option_no_tags
,
131 N_("don't clone any tags, and make later fetches not to follow them")),
132 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules
,
133 N_("any cloned submodules will be shallow")),
134 OPT_STRING(0, "separate-git-dir", &real_git_dir
, N_("gitdir"),
135 N_("separate git dir from working tree")),
136 OPT_STRING_LIST('c', "config", &option_config
, N_("key=value"),
137 N_("set config inside the new repository")),
138 OPT_SET_INT('4', "ipv4", &family
, N_("use IPv4 addresses only"),
139 TRANSPORT_FAMILY_IPV4
),
140 OPT_SET_INT('6', "ipv6", &family
, N_("use IPv6 addresses only"),
141 TRANSPORT_FAMILY_IPV6
),
142 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
146 static const char *get_repo_path_1(struct strbuf
*path
, int *is_bundle
)
148 static char *suffix
[] = { "/.git", "", ".git/.git", ".git" };
149 static char *bundle_suffix
[] = { ".bundle", "" };
150 size_t baselen
= path
->len
;
154 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
155 strbuf_setlen(path
, baselen
);
156 strbuf_addstr(path
, suffix
[i
]);
157 if (stat(path
->buf
, &st
))
159 if (S_ISDIR(st
.st_mode
) && is_git_directory(path
->buf
)) {
162 } else if (S_ISREG(st
.st_mode
) && st
.st_size
> 8) {
163 /* Is it a "gitfile"? */
166 int len
, fd
= open(path
->buf
, O_RDONLY
);
169 len
= read_in_full(fd
, signature
, 8);
171 if (len
!= 8 || strncmp(signature
, "gitdir: ", 8))
173 dst
= read_gitfile(path
->buf
);
181 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
182 strbuf_setlen(path
, baselen
);
183 strbuf_addstr(path
, bundle_suffix
[i
]);
184 if (!stat(path
->buf
, &st
) && S_ISREG(st
.st_mode
)) {
193 static char *get_repo_path(const char *repo
, int *is_bundle
)
195 struct strbuf path
= STRBUF_INIT
;
199 strbuf_addstr(&path
, repo
);
200 raw
= get_repo_path_1(&path
, is_bundle
);
201 canon
= raw
? absolute_pathdup(raw
) : NULL
;
202 strbuf_release(&path
);
206 static char *guess_dir_name(const char *repo
, int is_bundle
, int is_bare
)
208 const char *end
= repo
+ strlen(repo
), *start
, *ptr
;
215 start
= strstr(repo
, "://");
222 * Skip authentication data. The stripping does happen
223 * greedily, such that we strip up to the last '@' inside
226 for (ptr
= start
; ptr
< end
&& !is_dir_sep(*ptr
); ptr
++) {
232 * Strip trailing spaces, slashes and /.git
234 while (start
< end
&& (is_dir_sep(end
[-1]) || isspace(end
[-1])))
236 if (end
- start
> 5 && is_dir_sep(end
[-5]) &&
237 !strncmp(end
- 4, ".git", 4)) {
239 while (start
< end
&& is_dir_sep(end
[-1]))
244 * Strip trailing port number if we've got only a
245 * hostname (that is, there is no dir separator but a
246 * colon). This check is required such that we do not
247 * strip URI's like '/foo/bar:2222.git', which should
248 * result in a dir '2222' being guessed due to backwards
251 if (memchr(start
, '/', end
- start
) == NULL
252 && memchr(start
, ':', end
- start
) != NULL
) {
254 while (start
< ptr
&& isdigit(ptr
[-1]) && ptr
[-1] != ':')
256 if (start
< ptr
&& ptr
[-1] == ':')
261 * Find last component. To remain backwards compatible we
262 * also regard colons as path separators, such that
263 * cloning a repository 'foo:bar.git' would result in a
264 * directory 'bar' being guessed.
267 while (start
< ptr
&& !is_dir_sep(ptr
[-1]) && ptr
[-1] != ':')
272 * Strip .{bundle,git}.
275 strip_suffix_mem(start
, &len
, is_bundle
? ".bundle" : ".git");
277 if (!len
|| (len
== 1 && *start
== '/'))
278 die(_("No directory name could be guessed.\n"
279 "Please specify a directory on the command line"));
282 dir
= xstrfmt("%.*s.git", (int)len
, start
);
284 dir
= xstrndup(start
, len
);
286 * Replace sequences of 'control' characters and whitespace
287 * with one ascii space, remove leading and trailing spaces.
291 int prev_space
= 1 /* strip leading whitespace */;
292 for (end
= dir
; *end
; ++end
) {
294 if ((unsigned char)ch
< '\x20')
305 if (out
> dir
&& prev_space
)
311 static void strip_trailing_slashes(char *dir
)
313 char *end
= dir
+ strlen(dir
);
315 while (dir
< end
- 1 && is_dir_sep(end
[-1]))
320 static int add_one_reference(struct string_list_item
*item
, void *cb_data
)
322 struct strbuf err
= STRBUF_INIT
;
323 int *required
= cb_data
;
324 char *ref_git
= compute_alternate_path(item
->string
, &err
);
331 _("info: Could not add alternate for '%s': %s\n"),
332 item
->string
, err
.buf
);
334 struct strbuf sb
= STRBUF_INIT
;
335 strbuf_addf(&sb
, "%s/objects", ref_git
);
336 add_to_alternates_file(sb
.buf
);
340 strbuf_release(&err
);
345 static void setup_reference(void)
348 for_each_string_list(&option_required_reference
,
349 add_one_reference
, &required
);
351 for_each_string_list(&option_optional_reference
,
352 add_one_reference
, &required
);
355 static void copy_alternates(struct strbuf
*src
, struct strbuf
*dst
,
356 const char *src_repo
)
359 * Read from the source objects/info/alternates file
360 * and copy the entries to corresponding file in the
361 * destination repository with add_to_alternates_file().
362 * Both src and dst have "$path/objects/info/alternates".
364 * Instead of copying bit-for-bit from the original,
365 * we need to append to existing one so that the already
366 * created entry via "clone -s" is not lost, and also
367 * to turn entries with paths relative to the original
368 * absolute, so that they can be used in the new repository.
370 FILE *in
= xfopen(src
->buf
, "r");
371 struct strbuf line
= STRBUF_INIT
;
373 while (strbuf_getline(&line
, in
) != EOF
) {
375 if (!line
.len
|| line
.buf
[0] == '#')
377 if (is_absolute_path(line
.buf
)) {
378 add_to_alternates_file(line
.buf
);
381 abs_path
= mkpathdup("%s/objects/%s", src_repo
, line
.buf
);
382 if (!normalize_path_copy(abs_path
, abs_path
))
383 add_to_alternates_file(abs_path
);
385 warning("skipping invalid relative alternate: %s/%s",
389 strbuf_release(&line
);
393 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
,
394 const char *src_repo
, int src_baselen
)
398 int src_len
, dest_len
;
401 dir
= opendir(src
->buf
);
403 die_errno(_("failed to open '%s'"), src
->buf
);
405 if (mkdir(dest
->buf
, 0777)) {
407 die_errno(_("failed to create directory '%s'"), dest
->buf
);
408 else if (stat(dest
->buf
, &buf
))
409 die_errno(_("failed to stat '%s'"), dest
->buf
);
410 else if (!S_ISDIR(buf
.st_mode
))
411 die(_("%s exists and is not a directory"), dest
->buf
);
414 strbuf_addch(src
, '/');
416 strbuf_addch(dest
, '/');
417 dest_len
= dest
->len
;
419 while ((de
= readdir(dir
)) != NULL
) {
420 strbuf_setlen(src
, src_len
);
421 strbuf_addstr(src
, de
->d_name
);
422 strbuf_setlen(dest
, dest_len
);
423 strbuf_addstr(dest
, de
->d_name
);
424 if (stat(src
->buf
, &buf
)) {
425 warning (_("failed to stat %s\n"), src
->buf
);
428 if (S_ISDIR(buf
.st_mode
)) {
429 if (de
->d_name
[0] != '.')
430 copy_or_link_directory(src
, dest
,
431 src_repo
, src_baselen
);
435 /* Files that cannot be copied bit-for-bit... */
436 if (!strcmp(src
->buf
+ src_baselen
, "/info/alternates")) {
437 copy_alternates(src
, dest
, src_repo
);
441 if (unlink(dest
->buf
) && errno
!= ENOENT
)
442 die_errno(_("failed to unlink '%s'"), dest
->buf
);
443 if (!option_no_hardlinks
) {
444 if (!link(src
->buf
, dest
->buf
))
446 if (option_local
> 0)
447 die_errno(_("failed to create link '%s'"), dest
->buf
);
448 option_no_hardlinks
= 1;
450 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
451 die_errno(_("failed to copy file to '%s'"), dest
->buf
);
456 static void clone_local(const char *src_repo
, const char *dest_repo
)
459 struct strbuf alt
= STRBUF_INIT
;
460 get_common_dir(&alt
, src_repo
);
461 strbuf_addstr(&alt
, "/objects");
462 add_to_alternates_file(alt
.buf
);
463 strbuf_release(&alt
);
465 struct strbuf src
= STRBUF_INIT
;
466 struct strbuf dest
= STRBUF_INIT
;
467 get_common_dir(&src
, src_repo
);
468 get_common_dir(&dest
, dest_repo
);
469 strbuf_addstr(&src
, "/objects");
470 strbuf_addstr(&dest
, "/objects");
471 copy_or_link_directory(&src
, &dest
, src_repo
, src
.len
);
472 strbuf_release(&src
);
473 strbuf_release(&dest
);
476 if (0 <= option_verbosity
)
477 fprintf(stderr
, _("done.\n"));
480 static const char *junk_work_tree
;
481 static int junk_work_tree_flags
;
482 static const char *junk_git_dir
;
483 static int junk_git_dir_flags
;
488 } junk_mode
= JUNK_LEAVE_NONE
;
490 static const char junk_leave_repo_msg
[] =
491 N_("Clone succeeded, but checkout failed.\n"
492 "You can inspect what was checked out with 'git status'\n"
493 "and retry the checkout with 'git checkout -f HEAD'\n");
495 static void remove_junk(void)
497 struct strbuf sb
= STRBUF_INIT
;
500 case JUNK_LEAVE_REPO
:
501 warning("%s", _(junk_leave_repo_msg
));
506 /* proceed to removal */
511 strbuf_addstr(&sb
, junk_git_dir
);
512 remove_dir_recursively(&sb
, junk_git_dir_flags
);
515 if (junk_work_tree
) {
516 strbuf_addstr(&sb
, junk_work_tree
);
517 remove_dir_recursively(&sb
, junk_work_tree_flags
);
522 static void remove_junk_on_signal(int signo
)
529 static struct ref
*find_remote_branch(const struct ref
*refs
, const char *branch
)
532 struct strbuf head
= STRBUF_INIT
;
533 strbuf_addstr(&head
, "refs/heads/");
534 strbuf_addstr(&head
, branch
);
535 ref
= find_ref_by_name(refs
, head
.buf
);
536 strbuf_release(&head
);
541 strbuf_addstr(&head
, "refs/tags/");
542 strbuf_addstr(&head
, branch
);
543 ref
= find_ref_by_name(refs
, head
.buf
);
544 strbuf_release(&head
);
549 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
550 struct refspec_item
*refspec
)
552 struct ref
*head
= copy_ref(find_ref_by_name(refs
, "HEAD"));
553 struct ref
*local_refs
= head
;
554 struct ref
**tail
= head
? &head
->next
: &local_refs
;
556 if (option_single_branch
) {
557 struct ref
*remote_head
= NULL
;
560 remote_head
= guess_remote_head(head
, refs
, 0);
564 remote_head
= copy_ref(find_remote_branch(refs
, option_branch
));
567 if (!remote_head
&& option_branch
)
568 warning(_("Could not find remote branch %s to clone."),
571 get_fetch_map(remote_head
, refspec
, &tail
, 0);
573 /* if --branch=tag, pull the requested tag explicitly */
574 get_fetch_map(remote_head
, tag_refspec
, &tail
, 0);
577 get_fetch_map(refs
, refspec
, &tail
, 0);
579 if (!option_mirror
&& !option_single_branch
&& !option_no_tags
)
580 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
585 static void write_remote_refs(const struct ref
*local_refs
)
589 struct ref_transaction
*t
;
590 struct strbuf err
= STRBUF_INIT
;
592 t
= ref_transaction_begin(&err
);
596 for (r
= local_refs
; r
; r
= r
->next
) {
599 if (ref_transaction_create(t
, r
->peer_ref
->name
, &r
->old_oid
,
604 if (initial_ref_transaction_commit(t
, &err
))
607 strbuf_release(&err
);
608 ref_transaction_free(t
);
611 static void write_followtags(const struct ref
*refs
, const char *msg
)
613 const struct ref
*ref
;
614 for (ref
= refs
; ref
; ref
= ref
->next
) {
615 if (!starts_with(ref
->name
, "refs/tags/"))
617 if (ends_with(ref
->name
, "^{}"))
619 if (!has_object_file(&ref
->old_oid
))
621 update_ref(msg
, ref
->name
, &ref
->old_oid
, NULL
, 0,
622 UPDATE_REFS_DIE_ON_ERR
);
626 static int iterate_ref_map(void *cb_data
, struct object_id
*oid
)
628 struct ref
**rm
= cb_data
;
629 struct ref
*ref
= *rm
;
632 * Skip anything missing a peer_ref, which we are not
633 * actually going to write a ref for.
635 while (ref
&& !ref
->peer_ref
)
637 /* Returning -1 notes "end of list" to the caller. */
641 oidcpy(oid
, &ref
->old_oid
);
646 static void update_remote_refs(const struct ref
*refs
,
647 const struct ref
*mapped_refs
,
648 const struct ref
*remote_head_points_at
,
649 const char *branch_top
,
651 struct transport
*transport
,
652 int check_connectivity
)
654 const struct ref
*rm
= mapped_refs
;
656 if (check_connectivity
) {
657 struct check_connected_options opt
= CHECK_CONNECTED_INIT
;
659 opt
.transport
= transport
;
660 opt
.progress
= transport
->progress
;
662 if (check_connected(iterate_ref_map
, &rm
, &opt
))
663 die(_("remote did not send all necessary objects"));
667 write_remote_refs(mapped_refs
);
668 if (option_single_branch
&& !option_no_tags
)
669 write_followtags(refs
, msg
);
672 if (remote_head_points_at
&& !option_bare
) {
673 struct strbuf head_ref
= STRBUF_INIT
;
674 strbuf_addstr(&head_ref
, branch_top
);
675 strbuf_addstr(&head_ref
, "HEAD");
676 if (create_symref(head_ref
.buf
,
677 remote_head_points_at
->peer_ref
->name
,
679 die(_("unable to update %s"), head_ref
.buf
);
680 strbuf_release(&head_ref
);
684 static void update_head(const struct ref
*our
, const struct ref
*remote
,
688 if (our
&& skip_prefix(our
->name
, "refs/heads/", &head
)) {
689 /* Local default branch link */
690 if (create_symref("HEAD", our
->name
, NULL
) < 0)
691 die(_("unable to update HEAD"));
693 update_ref(msg
, "HEAD", &our
->old_oid
, NULL
, 0,
694 UPDATE_REFS_DIE_ON_ERR
);
695 install_branch_config(0, head
, option_origin
, our
->name
);
698 struct commit
*c
= lookup_commit_reference(&our
->old_oid
);
699 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
700 update_ref(msg
, "HEAD", &c
->object
.oid
, NULL
, REF_NO_DEREF
,
701 UPDATE_REFS_DIE_ON_ERR
);
704 * We know remote HEAD points to a non-branch, or
705 * HEAD points to a branch but we don't know which one.
706 * Detach HEAD in all these cases.
708 update_ref(msg
, "HEAD", &remote
->old_oid
, NULL
, REF_NO_DEREF
,
709 UPDATE_REFS_DIE_ON_ERR
);
713 static int checkout(int submodule_progress
)
715 struct object_id oid
;
717 struct lock_file lock_file
= LOCK_INIT
;
718 struct unpack_trees_options opts
;
723 if (option_no_checkout
)
726 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, &oid
, NULL
);
728 warning(_("remote HEAD refers to nonexistent ref, "
729 "unable to checkout.\n"));
732 if (!strcmp(head
, "HEAD")) {
733 if (advice_detached_head
)
734 detach_advice(oid_to_hex(&oid
));
736 if (!starts_with(head
, "refs/heads/"))
737 die(_("HEAD not found below refs/heads!"));
741 /* We need to be in the new work tree for the checkout */
744 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
746 memset(&opts
, 0, sizeof opts
);
749 opts
.fn
= oneway_merge
;
750 opts
.verbose_update
= (option_verbosity
>= 0);
751 opts
.src_index
= &the_index
;
752 opts
.dst_index
= &the_index
;
754 tree
= parse_tree_indirect(&oid
);
756 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
757 if (unpack_trees(1, &t
, &opts
) < 0)
758 die(_("unable to checkout working tree"));
760 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
761 die(_("unable to write new index file"));
763 err
|= run_hook_le(NULL
, "post-checkout", sha1_to_hex(null_sha1
),
764 oid_to_hex(&oid
), "1", NULL
);
766 if (!err
&& (option_recurse_submodules
.nr
> 0)) {
767 struct argv_array args
= ARGV_ARRAY_INIT
;
768 argv_array_pushl(&args
, "submodule", "update", "--init", "--recursive", NULL
);
770 if (option_shallow_submodules
== 1)
771 argv_array_push(&args
, "--depth=1");
774 argv_array_pushf(&args
, "--jobs=%d", max_jobs
);
776 if (submodule_progress
)
777 argv_array_push(&args
, "--progress");
779 if (option_verbosity
< 0)
780 argv_array_push(&args
, "--quiet");
782 err
= run_command_v_opt(args
.argv
, RUN_GIT_CMD
);
783 argv_array_clear(&args
);
789 static int write_one_config(const char *key
, const char *value
, void *data
)
791 return git_config_set_multivar_gently(key
,
792 value
? value
: "true",
793 CONFIG_REGEX_NONE
, 0);
796 static void write_config(struct string_list
*config
)
800 for (i
= 0; i
< config
->nr
; i
++) {
801 if (git_config_parse_parameter(config
->items
[i
].string
,
802 write_one_config
, NULL
) < 0)
803 die(_("unable to write parameters to config file"));
807 static void write_refspec_config(const char *src_ref_prefix
,
808 const struct ref
*our_head_points_at
,
809 const struct ref
*remote_head_points_at
,
810 struct strbuf
*branch_top
)
812 struct strbuf key
= STRBUF_INIT
;
813 struct strbuf value
= STRBUF_INIT
;
815 if (option_mirror
|| !option_bare
) {
816 if (option_single_branch
&& !option_mirror
) {
818 if (starts_with(our_head_points_at
->name
, "refs/tags/"))
819 strbuf_addf(&value
, "+%s:%s", our_head_points_at
->name
,
820 our_head_points_at
->name
);
822 strbuf_addf(&value
, "+%s:%s%s", our_head_points_at
->name
,
823 branch_top
->buf
, option_branch
);
824 } else if (remote_head_points_at
) {
825 const char *head
= remote_head_points_at
->name
;
826 if (!skip_prefix(head
, "refs/heads/", &head
))
827 BUG("remote HEAD points at non-head?");
829 strbuf_addf(&value
, "+%s:%s%s", remote_head_points_at
->name
,
830 branch_top
->buf
, head
);
833 * otherwise, the next "git fetch" will
834 * simply fetch from HEAD without updating
835 * any remote-tracking branch, which is what
839 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
->buf
);
841 /* Configure the remote */
843 strbuf_addf(&key
, "remote.%s.fetch", option_origin
);
844 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
848 strbuf_addf(&key
, "remote.%s.mirror", option_origin
);
849 git_config_set(key
.buf
, "true");
855 strbuf_release(&key
);
856 strbuf_release(&value
);
859 static void dissociate_from_references(void)
861 static const char* argv
[] = { "repack", "-a", "-d", NULL
};
862 char *alternates
= git_pathdup("objects/info/alternates");
864 if (!access(alternates
, F_OK
)) {
865 if (run_command_v_opt(argv
, RUN_GIT_CMD
|RUN_COMMAND_NO_STDIN
))
866 die(_("cannot repack to clean up"));
867 if (unlink(alternates
) && errno
!= ENOENT
)
868 die_errno(_("cannot unlink temporary alternates file"));
873 static int dir_exists(const char *path
)
876 return !stat(path
, &sb
);
879 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
881 int is_bundle
= 0, is_local
;
882 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
885 const struct ref
*refs
, *remote_head
;
886 const struct ref
*remote_head_points_at
;
887 const struct ref
*our_head_points_at
;
888 struct ref
*mapped_refs
;
889 const struct ref
*ref
;
890 struct strbuf key
= STRBUF_INIT
, value
= STRBUF_INIT
;
891 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
892 struct transport
*transport
= NULL
;
893 const char *src_ref_prefix
= "refs/heads/";
894 struct remote
*remote
;
895 int err
= 0, complete_refs_before_fetch
= 1;
896 int submodule_progress
;
898 struct refspec_item refspec
;
900 fetch_if_missing
= 0;
902 packet_trace_identity("clone");
903 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
904 builtin_clone_usage
, 0);
907 usage_msg_opt(_("Too many arguments."),
908 builtin_clone_usage
, builtin_clone_options
);
911 usage_msg_opt(_("You must specify a repository to clone."),
912 builtin_clone_usage
, builtin_clone_options
);
914 if (option_depth
|| option_since
|| option_not
.nr
)
916 if (option_single_branch
== -1)
917 option_single_branch
= deepen
? 1 : 0;
924 die(_("--bare and --origin %s options are incompatible."),
927 die(_("--bare and --separate-git-dir are incompatible."));
928 option_no_checkout
= 1;
932 option_origin
= "origin";
936 path
= get_repo_path(repo_name
, &is_bundle
);
938 repo
= absolute_pathdup(repo_name
);
939 else if (!strchr(repo_name
, ':'))
940 die(_("repository '%s' does not exist"), repo_name
);
944 /* no need to be strict, transport_set_option() will validate it again */
945 if (option_depth
&& atoi(option_depth
) < 1)
946 die(_("depth %s is not a positive number"), option_depth
);
949 dir
= xstrdup(argv
[1]);
951 dir
= guess_dir_name(repo_name
, is_bundle
, option_bare
);
952 strip_trailing_slashes(dir
);
954 dest_exists
= dir_exists(dir
);
955 if (dest_exists
&& !is_empty_dir(dir
))
956 die(_("destination path '%s' already exists and is not "
957 "an empty directory."), dir
);
959 strbuf_addf(&reflog_msg
, "clone: from %s", repo
);
964 work_tree
= getenv("GIT_WORK_TREE");
965 if (work_tree
&& dir_exists(work_tree
))
966 die(_("working tree '%s' already exists."), work_tree
);
969 if (option_bare
|| work_tree
)
970 git_dir
= xstrdup(dir
);
973 git_dir
= mkpathdup("%s/.git", dir
);
977 sigchain_push_common(remove_junk_on_signal
);
980 if (safe_create_leading_directories_const(work_tree
) < 0)
981 die_errno(_("could not create leading directories of '%s'"),
984 junk_work_tree_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
985 else if (mkdir(work_tree
, 0777))
986 die_errno(_("could not create work tree dir '%s'"),
988 junk_work_tree
= work_tree
;
989 set_git_work_tree(work_tree
);
993 if (dir_exists(real_git_dir
))
994 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
995 junk_git_dir
= real_git_dir
;
998 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
999 junk_git_dir
= git_dir
;
1001 if (safe_create_leading_directories_const(git_dir
) < 0)
1002 die(_("could not create leading directories of '%s'"), git_dir
);
1004 if (0 <= option_verbosity
) {
1006 fprintf(stderr
, _("Cloning into bare repository '%s'...\n"), dir
);
1008 fprintf(stderr
, _("Cloning into '%s'...\n"), dir
);
1011 if (option_recurse_submodules
.nr
> 0) {
1012 struct string_list_item
*item
;
1013 struct strbuf sb
= STRBUF_INIT
;
1015 /* remove duplicates */
1016 string_list_sort(&option_recurse_submodules
);
1017 string_list_remove_duplicates(&option_recurse_submodules
, 0);
1020 * NEEDSWORK: In a multi-working-tree world, this needs to be
1021 * set in the per-worktree config.
1023 for_each_string_list_item(item
, &option_recurse_submodules
) {
1024 strbuf_addf(&sb
, "submodule.active=%s",
1026 string_list_append(&option_config
,
1027 strbuf_detach(&sb
, NULL
));
1030 if (option_required_reference
.nr
&&
1031 option_optional_reference
.nr
)
1032 die(_("clone --recursive is not compatible with "
1033 "both --reference and --reference-if-able"));
1034 else if (option_required_reference
.nr
) {
1035 string_list_append(&option_config
,
1036 "submodule.alternateLocation=superproject");
1037 string_list_append(&option_config
,
1038 "submodule.alternateErrorStrategy=die");
1039 } else if (option_optional_reference
.nr
) {
1040 string_list_append(&option_config
,
1041 "submodule.alternateLocation=superproject");
1042 string_list_append(&option_config
,
1043 "submodule.alternateErrorStrategy=info");
1047 init_db(git_dir
, real_git_dir
, option_template
, INIT_DB_QUIET
);
1050 git_dir
= real_git_dir
;
1052 write_config(&option_config
);
1054 git_config(git_default_config
, NULL
);
1058 src_ref_prefix
= "refs/";
1059 strbuf_addstr(&branch_top
, src_ref_prefix
);
1061 git_config_set("core.bare", "true");
1063 strbuf_addf(&branch_top
, "refs/remotes/%s/", option_origin
);
1066 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
.buf
);
1067 strbuf_addf(&key
, "remote.%s.url", option_origin
);
1068 git_config_set(key
.buf
, repo
);
1071 if (option_no_tags
) {
1072 strbuf_addf(&key
, "remote.%s.tagOpt", option_origin
);
1073 git_config_set(key
.buf
, "--no-tags");
1077 if (option_required_reference
.nr
|| option_optional_reference
.nr
)
1080 refspec_item_init_or_die(&refspec
, value
.buf
, REFSPEC_FETCH
);
1082 strbuf_reset(&value
);
1084 remote
= remote_get(option_origin
);
1085 transport
= transport_get(remote
, remote
->url
[0]);
1086 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
1087 transport
->family
= family
;
1089 path
= get_repo_path(remote
->url
[0], &is_bundle
);
1090 is_local
= option_local
!= 0 && path
&& !is_bundle
;
1093 warning(_("--depth is ignored in local clones; use file:// instead."));
1095 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1097 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1098 if (filter_options
.choice
)
1099 warning(_("--filter is ignored in local clones; use file:// instead."));
1100 if (!access(mkpath("%s/shallow", path
), F_OK
)) {
1101 if (option_local
> 0)
1102 warning(_("source repository is shallow, ignoring --local"));
1106 if (option_local
> 0 && !is_local
)
1107 warning(_("--local is ignored"));
1108 transport
->cloning
= 1;
1110 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
1113 transport_set_option(transport
, TRANS_OPT_DEPTH
,
1116 transport_set_option(transport
, TRANS_OPT_DEEPEN_SINCE
,
1119 transport_set_option(transport
, TRANS_OPT_DEEPEN_NOT
,
1120 (const char *)&option_not
);
1121 if (option_single_branch
)
1122 transport_set_option(transport
, TRANS_OPT_FOLLOWTAGS
, "1");
1124 if (option_upload_pack
)
1125 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
1126 option_upload_pack
);
1128 if (filter_options
.choice
) {
1129 transport_set_option(transport
, TRANS_OPT_LIST_OBJECTS_FILTER
,
1130 filter_options
.filter_spec
);
1131 transport_set_option(transport
, TRANS_OPT_FROM_PROMISOR
, "1");
1134 if (transport
->smart_options
&& !deepen
&& !filter_options
.choice
)
1135 transport
->smart_options
->check_self_contained_and_connected
= 1;
1137 refs
= transport_get_remote_refs(transport
, NULL
);
1140 mapped_refs
= wanted_peer_refs(refs
, &refspec
);
1142 * transport_get_remote_refs() may return refs with null sha-1
1143 * in mapped_refs (see struct transport->get_refs_list
1144 * comment). In that case we need fetch it early because
1145 * remote_head code below relies on it.
1147 * for normal clones, transport_get_remote_refs() should
1148 * return reliable ref set, we can delay cloning until after
1149 * remote HEAD check.
1151 for (ref
= refs
; ref
; ref
= ref
->next
)
1152 if (is_null_oid(&ref
->old_oid
)) {
1153 complete_refs_before_fetch
= 0;
1157 if (!is_local
&& !complete_refs_before_fetch
)
1158 transport_fetch_refs(transport
, mapped_refs
);
1160 remote_head
= find_ref_by_name(refs
, "HEAD");
1161 remote_head_points_at
=
1162 guess_remote_head(remote_head
, mapped_refs
, 0);
1164 if (option_branch
) {
1165 our_head_points_at
=
1166 find_remote_branch(mapped_refs
, option_branch
);
1168 if (!our_head_points_at
)
1169 die(_("Remote branch %s not found in upstream %s"),
1170 option_branch
, option_origin
);
1173 our_head_points_at
= remote_head_points_at
;
1177 die(_("Remote branch %s not found in upstream %s"),
1178 option_branch
, option_origin
);
1180 warning(_("You appear to have cloned an empty repository."));
1182 our_head_points_at
= NULL
;
1183 remote_head_points_at
= NULL
;
1185 option_no_checkout
= 1;
1187 install_branch_config(0, "master", option_origin
,
1188 "refs/heads/master");
1191 write_refspec_config(src_ref_prefix
, our_head_points_at
,
1192 remote_head_points_at
, &branch_top
);
1194 if (filter_options
.choice
)
1195 partial_clone_register("origin", &filter_options
);
1198 clone_local(path
, git_dir
);
1199 else if (refs
&& complete_refs_before_fetch
)
1200 transport_fetch_refs(transport
, mapped_refs
);
1202 update_remote_refs(refs
, mapped_refs
, remote_head_points_at
,
1203 branch_top
.buf
, reflog_msg
.buf
, transport
,
1204 !is_local
&& !filter_options
.choice
);
1206 update_head(our_head_points_at
, remote_head
, reflog_msg
.buf
);
1209 * We want to show progress for recursive submodule clones iff
1210 * we did so for the main clone. But only the transport knows
1211 * the final decision for this flag, so we need to rescue the value
1212 * before we free the transport.
1214 submodule_progress
= transport
->progress
;
1216 transport_unlock_pack(transport
);
1217 transport_disconnect(transport
);
1219 if (option_dissociate
) {
1220 close_all_packs(the_repository
->objects
);
1221 dissociate_from_references();
1224 junk_mode
= JUNK_LEAVE_REPO
;
1225 fetch_if_missing
= 1;
1226 err
= checkout(submodule_progress
);
1228 strbuf_release(&reflog_msg
);
1229 strbuf_release(&branch_top
);
1230 strbuf_release(&key
);
1231 strbuf_release(&value
);
1232 junk_mode
= JUNK_LEAVE_ALL
;
1234 refspec_item_clear(&refspec
);