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.
11 #define USE_THE_INDEX_VARIABLE
18 #include "parse-options.h"
19 #include "fetch-pack.h"
22 #include "object-store.h"
24 #include "tree-walk.h"
25 #include "unpack-trees.h"
26 #include "transport.h"
29 #include "dir-iterator.h"
34 #include "run-command.h"
35 #include "connected.h"
37 #include "list-objects-filter-options.h"
40 #include "bundle-uri.h"
44 * - respect DB_ENVIRONMENT for .git/objects.
46 * Implementation notes:
47 * - dropping use-separate-remote and no-separate-remote compatibility
50 static const char * const builtin_clone_usage
[] = {
51 N_("git clone [<options>] [--] <repo> [<dir>]"),
55 static int option_no_checkout
, option_bare
, option_mirror
, option_single_branch
= -1;
56 static int option_local
= -1, option_no_hardlinks
, option_shared
;
57 static int option_no_tags
;
58 static int option_shallow_submodules
;
59 static int option_reject_shallow
= -1; /* unspecified */
60 static int config_reject_shallow
= -1; /* unspecified */
62 static char *option_template
, *option_depth
, *option_since
;
63 static char *option_origin
= NULL
;
64 static char *remote_name
= NULL
;
65 static char *option_branch
= NULL
;
66 static struct string_list option_not
= STRING_LIST_INIT_NODUP
;
67 static const char *real_git_dir
;
68 static char *option_upload_pack
= "git-upload-pack";
69 static int option_verbosity
;
70 static int option_progress
= -1;
71 static int option_sparse_checkout
;
72 static enum transport_family family
;
73 static struct string_list option_config
= STRING_LIST_INIT_NODUP
;
74 static struct string_list option_required_reference
= STRING_LIST_INIT_NODUP
;
75 static struct string_list option_optional_reference
= STRING_LIST_INIT_NODUP
;
76 static int option_dissociate
;
77 static int max_jobs
= -1;
78 static struct string_list option_recurse_submodules
= STRING_LIST_INIT_NODUP
;
79 static struct list_objects_filter_options filter_options
= LIST_OBJECTS_FILTER_INIT
;
80 static int option_filter_submodules
= -1; /* unspecified */
81 static int config_filter_submodules
= -1; /* unspecified */
82 static struct string_list server_options
= STRING_LIST_INIT_NODUP
;
83 static int option_remote_submodules
;
84 static const char *bundle_uri
;
86 static int recurse_submodules_cb(const struct option
*opt
,
87 const char *arg
, int unset
)
90 string_list_clear((struct string_list
*)opt
->value
, 0);
92 string_list_append((struct string_list
*)opt
->value
, arg
);
94 string_list_append((struct string_list
*)opt
->value
,
95 (const char *)opt
->defval
);
100 static struct option builtin_clone_options
[] = {
101 OPT__VERBOSITY(&option_verbosity
),
102 OPT_BOOL(0, "progress", &option_progress
,
103 N_("force progress reporting")),
104 OPT_BOOL(0, "reject-shallow", &option_reject_shallow
,
105 N_("don't clone shallow repository")),
106 OPT_BOOL('n', "no-checkout", &option_no_checkout
,
107 N_("don't create a checkout")),
108 OPT_BOOL(0, "bare", &option_bare
, N_("create a bare repository")),
109 OPT_HIDDEN_BOOL(0, "naked", &option_bare
,
110 N_("create a bare repository")),
111 OPT_BOOL(0, "mirror", &option_mirror
,
112 N_("create a mirror repository (implies bare)")),
113 OPT_BOOL('l', "local", &option_local
,
114 N_("to clone from a local repository")),
115 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks
,
116 N_("don't use local hardlinks, always copy")),
117 OPT_BOOL('s', "shared", &option_shared
,
118 N_("setup as shared repository")),
119 { OPTION_CALLBACK
, 0, "recurse-submodules", &option_recurse_submodules
,
120 N_("pathspec"), N_("initialize submodules in the clone"),
121 PARSE_OPT_OPTARG
, recurse_submodules_cb
, (intptr_t)"." },
122 OPT_ALIAS(0, "recursive", "recurse-submodules"),
123 OPT_INTEGER('j', "jobs", &max_jobs
,
124 N_("number of submodules cloned in parallel")),
125 OPT_STRING(0, "template", &option_template
, N_("template-directory"),
126 N_("directory from which templates will be used")),
127 OPT_STRING_LIST(0, "reference", &option_required_reference
, N_("repo"),
128 N_("reference repository")),
129 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference
,
130 N_("repo"), N_("reference repository")),
131 OPT_BOOL(0, "dissociate", &option_dissociate
,
132 N_("use --reference only while cloning")),
133 OPT_STRING('o', "origin", &option_origin
, N_("name"),
134 N_("use <name> instead of 'origin' to track upstream")),
135 OPT_STRING('b', "branch", &option_branch
, N_("branch"),
136 N_("checkout <branch> instead of the remote's HEAD")),
137 OPT_STRING('u', "upload-pack", &option_upload_pack
, N_("path"),
138 N_("path to git-upload-pack on the remote")),
139 OPT_STRING(0, "depth", &option_depth
, N_("depth"),
140 N_("create a shallow clone of that depth")),
141 OPT_STRING(0, "shallow-since", &option_since
, N_("time"),
142 N_("create a shallow clone since a specific time")),
143 OPT_STRING_LIST(0, "shallow-exclude", &option_not
, N_("revision"),
144 N_("deepen history of shallow clone, excluding rev")),
145 OPT_BOOL(0, "single-branch", &option_single_branch
,
146 N_("clone only one branch, HEAD or --branch")),
147 OPT_BOOL(0, "no-tags", &option_no_tags
,
148 N_("don't clone any tags, and make later fetches not to follow them")),
149 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules
,
150 N_("any cloned submodules will be shallow")),
151 OPT_STRING(0, "separate-git-dir", &real_git_dir
, N_("gitdir"),
152 N_("separate git dir from working tree")),
153 OPT_STRING_LIST('c', "config", &option_config
, N_("key=value"),
154 N_("set config inside the new repository")),
155 OPT_STRING_LIST(0, "server-option", &server_options
,
156 N_("server-specific"), N_("option to transmit")),
157 OPT_SET_INT('4', "ipv4", &family
, N_("use IPv4 addresses only"),
158 TRANSPORT_FAMILY_IPV4
),
159 OPT_SET_INT('6', "ipv6", &family
, N_("use IPv6 addresses only"),
160 TRANSPORT_FAMILY_IPV6
),
161 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
162 OPT_BOOL(0, "also-filter-submodules", &option_filter_submodules
,
163 N_("apply partial clone filters to submodules")),
164 OPT_BOOL(0, "remote-submodules", &option_remote_submodules
,
165 N_("any cloned submodules will use their remote-tracking branch")),
166 OPT_BOOL(0, "sparse", &option_sparse_checkout
,
167 N_("initialize sparse-checkout file to include only files at root")),
168 OPT_STRING(0, "bundle-uri", &bundle_uri
,
169 N_("uri"), N_("a URI for downloading bundles before fetching from origin remote")),
173 static const char *get_repo_path_1(struct strbuf
*path
, int *is_bundle
)
175 static char *suffix
[] = { "/.git", "", ".git/.git", ".git" };
176 static char *bundle_suffix
[] = { ".bundle", "" };
177 size_t baselen
= path
->len
;
181 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
182 strbuf_setlen(path
, baselen
);
183 strbuf_addstr(path
, suffix
[i
]);
184 if (stat(path
->buf
, &st
))
186 if (S_ISDIR(st
.st_mode
) && is_git_directory(path
->buf
)) {
189 } else if (S_ISREG(st
.st_mode
) && st
.st_size
> 8) {
190 /* Is it a "gitfile"? */
193 int len
, fd
= open(path
->buf
, O_RDONLY
);
196 len
= read_in_full(fd
, signature
, 8);
198 if (len
!= 8 || strncmp(signature
, "gitdir: ", 8))
200 dst
= read_gitfile(path
->buf
);
208 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
209 strbuf_setlen(path
, baselen
);
210 strbuf_addstr(path
, bundle_suffix
[i
]);
211 if (!stat(path
->buf
, &st
) && S_ISREG(st
.st_mode
)) {
220 static char *get_repo_path(const char *repo
, int *is_bundle
)
222 struct strbuf path
= STRBUF_INIT
;
226 strbuf_addstr(&path
, repo
);
227 raw
= get_repo_path_1(&path
, is_bundle
);
228 canon
= raw
? absolute_pathdup(raw
) : NULL
;
229 strbuf_release(&path
);
233 static int add_one_reference(struct string_list_item
*item
, void *cb_data
)
235 struct strbuf err
= STRBUF_INIT
;
236 int *required
= cb_data
;
237 char *ref_git
= compute_alternate_path(item
->string
, &err
);
244 _("info: Could not add alternate for '%s': %s\n"),
245 item
->string
, err
.buf
);
247 struct strbuf sb
= STRBUF_INIT
;
248 strbuf_addf(&sb
, "%s/objects", ref_git
);
249 add_to_alternates_file(sb
.buf
);
253 strbuf_release(&err
);
258 static void setup_reference(void)
261 for_each_string_list(&option_required_reference
,
262 add_one_reference
, &required
);
264 for_each_string_list(&option_optional_reference
,
265 add_one_reference
, &required
);
268 static void copy_alternates(struct strbuf
*src
, const char *src_repo
)
271 * Read from the source objects/info/alternates file
272 * and copy the entries to corresponding file in the
273 * destination repository with add_to_alternates_file().
274 * Both src and dst have "$path/objects/info/alternates".
276 * Instead of copying bit-for-bit from the original,
277 * we need to append to existing one so that the already
278 * created entry via "clone -s" is not lost, and also
279 * to turn entries with paths relative to the original
280 * absolute, so that they can be used in the new repository.
282 FILE *in
= xfopen(src
->buf
, "r");
283 struct strbuf line
= STRBUF_INIT
;
285 while (strbuf_getline(&line
, in
) != EOF
) {
287 if (!line
.len
|| line
.buf
[0] == '#')
289 if (is_absolute_path(line
.buf
)) {
290 add_to_alternates_file(line
.buf
);
293 abs_path
= mkpathdup("%s/objects/%s", src_repo
, line
.buf
);
294 if (!normalize_path_copy(abs_path
, abs_path
))
295 add_to_alternates_file(abs_path
);
297 warning("skipping invalid relative alternate: %s/%s",
301 strbuf_release(&line
);
305 static void mkdir_if_missing(const char *pathname
, mode_t mode
)
309 if (!mkdir(pathname
, mode
))
313 die_errno(_("failed to create directory '%s'"), pathname
);
314 else if (stat(pathname
, &st
))
315 die_errno(_("failed to stat '%s'"), pathname
);
316 else if (!S_ISDIR(st
.st_mode
))
317 die(_("%s exists and is not a directory"), pathname
);
320 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
,
321 const char *src_repo
)
323 int src_len
, dest_len
;
324 struct dir_iterator
*iter
;
326 struct strbuf realpath
= STRBUF_INIT
;
328 mkdir_if_missing(dest
->buf
, 0777);
330 iter
= dir_iterator_begin(src
->buf
, DIR_ITERATOR_PEDANTIC
);
333 die_errno(_("failed to start iterator over '%s'"), src
->buf
);
335 strbuf_addch(src
, '/');
337 strbuf_addch(dest
, '/');
338 dest_len
= dest
->len
;
340 while ((iter_status
= dir_iterator_advance(iter
)) == ITER_OK
) {
341 strbuf_setlen(src
, src_len
);
342 strbuf_addstr(src
, iter
->relative_path
);
343 strbuf_setlen(dest
, dest_len
);
344 strbuf_addstr(dest
, iter
->relative_path
);
346 if (S_ISLNK(iter
->st
.st_mode
))
347 die(_("symlink '%s' exists, refusing to clone with --local"),
348 iter
->relative_path
);
350 if (S_ISDIR(iter
->st
.st_mode
)) {
351 mkdir_if_missing(dest
->buf
, 0777);
355 /* Files that cannot be copied bit-for-bit... */
356 if (!fspathcmp(iter
->relative_path
, "info/alternates")) {
357 copy_alternates(src
, src_repo
);
361 if (unlink(dest
->buf
) && errno
!= ENOENT
)
362 die_errno(_("failed to unlink '%s'"), dest
->buf
);
363 if (!option_no_hardlinks
) {
364 strbuf_realpath(&realpath
, src
->buf
, 1);
365 if (!link(realpath
.buf
, dest
->buf
))
367 if (option_local
> 0)
368 die_errno(_("failed to create link '%s'"), dest
->buf
);
369 option_no_hardlinks
= 1;
371 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
372 die_errno(_("failed to copy file to '%s'"), dest
->buf
);
375 if (iter_status
!= ITER_DONE
) {
376 strbuf_setlen(src
, src_len
);
377 die(_("failed to iterate over '%s'"), src
->buf
);
380 strbuf_release(&realpath
);
383 static void clone_local(const char *src_repo
, const char *dest_repo
)
386 struct strbuf alt
= STRBUF_INIT
;
387 get_common_dir(&alt
, src_repo
);
388 strbuf_addstr(&alt
, "/objects");
389 add_to_alternates_file(alt
.buf
);
390 strbuf_release(&alt
);
392 struct strbuf src
= STRBUF_INIT
;
393 struct strbuf dest
= STRBUF_INIT
;
394 get_common_dir(&src
, src_repo
);
395 get_common_dir(&dest
, dest_repo
);
396 strbuf_addstr(&src
, "/objects");
397 strbuf_addstr(&dest
, "/objects");
398 copy_or_link_directory(&src
, &dest
, src_repo
);
399 strbuf_release(&src
);
400 strbuf_release(&dest
);
403 if (0 <= option_verbosity
)
404 fprintf(stderr
, _("done.\n"));
407 static const char *junk_work_tree
;
408 static int junk_work_tree_flags
;
409 static const char *junk_git_dir
;
410 static int junk_git_dir_flags
;
415 } junk_mode
= JUNK_LEAVE_NONE
;
417 static const char junk_leave_repo_msg
[] =
418 N_("Clone succeeded, but checkout failed.\n"
419 "You can inspect what was checked out with 'git status'\n"
420 "and retry with 'git restore --source=HEAD :/'\n");
422 static void remove_junk(void)
424 struct strbuf sb
= STRBUF_INIT
;
427 case JUNK_LEAVE_REPO
:
428 warning("%s", _(junk_leave_repo_msg
));
433 /* proceed to removal */
438 strbuf_addstr(&sb
, junk_git_dir
);
439 remove_dir_recursively(&sb
, junk_git_dir_flags
);
442 if (junk_work_tree
) {
443 strbuf_addstr(&sb
, junk_work_tree
);
444 remove_dir_recursively(&sb
, junk_work_tree_flags
);
449 static void remove_junk_on_signal(int signo
)
456 static struct ref
*find_remote_branch(const struct ref
*refs
, const char *branch
)
459 struct strbuf head
= STRBUF_INIT
;
460 strbuf_addstr(&head
, "refs/heads/");
461 strbuf_addstr(&head
, branch
);
462 ref
= find_ref_by_name(refs
, head
.buf
);
463 strbuf_release(&head
);
468 strbuf_addstr(&head
, "refs/tags/");
469 strbuf_addstr(&head
, branch
);
470 ref
= find_ref_by_name(refs
, head
.buf
);
471 strbuf_release(&head
);
476 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
477 struct refspec
*refspec
)
479 struct ref
*head
= copy_ref(find_ref_by_name(refs
, "HEAD"));
480 struct ref
*local_refs
= head
;
481 struct ref
**tail
= head
? &head
->next
: &local_refs
;
483 if (option_single_branch
) {
484 struct ref
*remote_head
= NULL
;
487 remote_head
= guess_remote_head(head
, refs
, 0);
491 remote_head
= copy_ref(find_remote_branch(refs
, option_branch
));
494 if (!remote_head
&& option_branch
)
495 warning(_("Could not find remote branch %s to clone."),
499 for (i
= 0; i
< refspec
->nr
; i
++)
500 get_fetch_map(remote_head
, &refspec
->items
[i
],
503 /* if --branch=tag, pull the requested tag explicitly */
504 get_fetch_map(remote_head
, tag_refspec
, &tail
, 0);
506 free_refs(remote_head
);
509 for (i
= 0; i
< refspec
->nr
; i
++)
510 get_fetch_map(refs
, &refspec
->items
[i
], &tail
, 0);
513 if (!option_mirror
&& !option_single_branch
&& !option_no_tags
)
514 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
519 static void write_remote_refs(const struct ref
*local_refs
)
523 struct ref_transaction
*t
;
524 struct strbuf err
= STRBUF_INIT
;
526 t
= ref_transaction_begin(&err
);
530 for (r
= local_refs
; r
; r
= r
->next
) {
533 if (ref_transaction_create(t
, r
->peer_ref
->name
, &r
->old_oid
,
538 if (initial_ref_transaction_commit(t
, &err
))
541 strbuf_release(&err
);
542 ref_transaction_free(t
);
545 static void write_followtags(const struct ref
*refs
, const char *msg
)
547 const struct ref
*ref
;
548 for (ref
= refs
; ref
; ref
= ref
->next
) {
549 if (!starts_with(ref
->name
, "refs/tags/"))
551 if (ends_with(ref
->name
, "^{}"))
553 if (!has_object_file_with_flags(&ref
->old_oid
,
555 OBJECT_INFO_SKIP_FETCH_OBJECT
))
557 update_ref(msg
, ref
->name
, &ref
->old_oid
, NULL
, 0,
558 UPDATE_REFS_DIE_ON_ERR
);
562 static const struct object_id
*iterate_ref_map(void *cb_data
)
564 struct ref
**rm
= cb_data
;
565 struct ref
*ref
= *rm
;
568 * Skip anything missing a peer_ref, which we are not
569 * actually going to write a ref for.
571 while (ref
&& !ref
->peer_ref
)
577 return &ref
->old_oid
;
580 static void update_remote_refs(const struct ref
*refs
,
581 const struct ref
*mapped_refs
,
582 const struct ref
*remote_head_points_at
,
583 const char *branch_top
,
585 struct transport
*transport
,
586 int check_connectivity
)
588 const struct ref
*rm
= mapped_refs
;
590 if (check_connectivity
) {
591 struct check_connected_options opt
= CHECK_CONNECTED_INIT
;
593 opt
.transport
= transport
;
594 opt
.progress
= transport
->progress
;
596 if (check_connected(iterate_ref_map
, &rm
, &opt
))
597 die(_("remote did not send all necessary objects"));
601 write_remote_refs(mapped_refs
);
602 if (option_single_branch
&& !option_no_tags
)
603 write_followtags(refs
, msg
);
606 if (remote_head_points_at
&& !option_bare
) {
607 struct strbuf head_ref
= STRBUF_INIT
;
608 strbuf_addstr(&head_ref
, branch_top
);
609 strbuf_addstr(&head_ref
, "HEAD");
610 if (create_symref(head_ref
.buf
,
611 remote_head_points_at
->peer_ref
->name
,
613 die(_("unable to update %s"), head_ref
.buf
);
614 strbuf_release(&head_ref
);
618 static void update_head(const struct ref
*our
, const struct ref
*remote
,
619 const char *unborn
, const char *msg
)
622 if (our
&& skip_prefix(our
->name
, "refs/heads/", &head
)) {
623 /* Local default branch link */
624 if (create_symref("HEAD", our
->name
, NULL
) < 0)
625 die(_("unable to update HEAD"));
627 update_ref(msg
, "HEAD", &our
->old_oid
, NULL
, 0,
628 UPDATE_REFS_DIE_ON_ERR
);
629 install_branch_config(0, head
, remote_name
, our
->name
);
632 struct commit
*c
= lookup_commit_reference(the_repository
,
634 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
635 update_ref(msg
, "HEAD", &c
->object
.oid
, NULL
, REF_NO_DEREF
,
636 UPDATE_REFS_DIE_ON_ERR
);
639 * We know remote HEAD points to a non-branch, or
640 * HEAD points to a branch but we don't know which one.
641 * Detach HEAD in all these cases.
643 update_ref(msg
, "HEAD", &remote
->old_oid
, NULL
, REF_NO_DEREF
,
644 UPDATE_REFS_DIE_ON_ERR
);
645 } else if (unborn
&& skip_prefix(unborn
, "refs/heads/", &head
)) {
647 * Unborn head from remote; same as "our" case above except
648 * that we have no ref to update.
650 if (create_symref("HEAD", unborn
, NULL
) < 0)
651 die(_("unable to update HEAD"));
653 install_branch_config(0, head
, remote_name
, unborn
);
657 static int git_sparse_checkout_init(const char *repo
)
659 struct child_process cmd
= CHILD_PROCESS_INIT
;
661 strvec_pushl(&cmd
.args
, "-C", repo
, "sparse-checkout", "set", NULL
);
664 * We must apply the setting in the current process
665 * for the later checkout to use the sparse-checkout file.
667 core_apply_sparse_checkout
= 1;
670 if (run_command(&cmd
)) {
671 error(_("failed to initialize sparse-checkout"));
678 static int checkout(int submodule_progress
, int filter_submodules
)
680 struct object_id oid
;
682 struct lock_file lock_file
= LOCK_INIT
;
683 struct unpack_trees_options opts
;
688 if (option_no_checkout
)
691 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, &oid
, NULL
);
693 warning(_("remote HEAD refers to nonexistent ref, "
694 "unable to checkout"));
697 if (!strcmp(head
, "HEAD")) {
698 if (advice_enabled(ADVICE_DETACHED_HEAD
))
699 detach_advice(oid_to_hex(&oid
));
702 if (!starts_with(head
, "refs/heads/"))
703 die(_("HEAD not found below refs/heads!"));
706 /* We need to be in the new work tree for the checkout */
709 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
711 memset(&opts
, 0, sizeof opts
);
715 opts
.preserve_ignored
= 0;
716 opts
.fn
= oneway_merge
;
717 opts
.verbose_update
= (option_verbosity
>= 0);
718 opts
.src_index
= &the_index
;
719 opts
.dst_index
= &the_index
;
720 init_checkout_metadata(&opts
.meta
, head
, &oid
, NULL
);
722 tree
= parse_tree_indirect(&oid
);
724 die(_("unable to parse commit %s"), oid_to_hex(&oid
));
726 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
727 if (unpack_trees(1, &t
, &opts
) < 0)
728 die(_("unable to checkout working tree"));
732 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
733 die(_("unable to write new index file"));
735 err
|= run_hooks_l("post-checkout", oid_to_hex(null_oid()),
736 oid_to_hex(&oid
), "1", NULL
);
738 if (!err
&& (option_recurse_submodules
.nr
> 0)) {
739 struct child_process cmd
= CHILD_PROCESS_INIT
;
740 strvec_pushl(&cmd
.args
, "submodule", "update", "--require-init",
741 "--recursive", NULL
);
743 if (option_shallow_submodules
== 1)
744 strvec_push(&cmd
.args
, "--depth=1");
747 strvec_pushf(&cmd
.args
, "--jobs=%d", max_jobs
);
749 if (submodule_progress
)
750 strvec_push(&cmd
.args
, "--progress");
752 if (option_verbosity
< 0)
753 strvec_push(&cmd
.args
, "--quiet");
755 if (option_remote_submodules
) {
756 strvec_push(&cmd
.args
, "--remote");
757 strvec_push(&cmd
.args
, "--no-fetch");
760 if (filter_submodules
&& filter_options
.choice
)
761 strvec_pushf(&cmd
.args
, "--filter=%s",
762 expand_list_objects_filter_spec(&filter_options
));
764 if (option_single_branch
>= 0)
765 strvec_push(&cmd
.args
, option_single_branch
?
767 "--no-single-branch");
770 err
= run_command(&cmd
);
776 static int git_clone_config(const char *k
, const char *v
, void *cb
)
778 if (!strcmp(k
, "clone.defaultremotename")) {
780 remote_name
= xstrdup(v
);
782 if (!strcmp(k
, "clone.rejectshallow"))
783 config_reject_shallow
= git_config_bool(k
, v
);
784 if (!strcmp(k
, "clone.filtersubmodules"))
785 config_filter_submodules
= git_config_bool(k
, v
);
787 return git_default_config(k
, v
, cb
);
790 static int write_one_config(const char *key
, const char *value
, void *data
)
793 * give git_clone_config a chance to write config values back to the
794 * environment, since git_config_set_multivar_gently only deals with
797 int apply_failed
= git_clone_config(key
, value
, data
);
801 return git_config_set_multivar_gently(key
,
802 value
? value
: "true",
803 CONFIG_REGEX_NONE
, 0);
806 static void write_config(struct string_list
*config
)
810 for (i
= 0; i
< config
->nr
; i
++) {
811 if (git_config_parse_parameter(config
->items
[i
].string
,
812 write_one_config
, NULL
) < 0)
813 die(_("unable to write parameters to config file"));
817 static void write_refspec_config(const char *src_ref_prefix
,
818 const struct ref
*our_head_points_at
,
819 const struct ref
*remote_head_points_at
,
820 struct strbuf
*branch_top
)
822 struct strbuf key
= STRBUF_INIT
;
823 struct strbuf value
= STRBUF_INIT
;
825 if (option_mirror
|| !option_bare
) {
826 if (option_single_branch
&& !option_mirror
) {
828 if (starts_with(our_head_points_at
->name
, "refs/tags/"))
829 strbuf_addf(&value
, "+%s:%s", our_head_points_at
->name
,
830 our_head_points_at
->name
);
832 strbuf_addf(&value
, "+%s:%s%s", our_head_points_at
->name
,
833 branch_top
->buf
, option_branch
);
834 } else if (remote_head_points_at
) {
835 const char *head
= remote_head_points_at
->name
;
836 if (!skip_prefix(head
, "refs/heads/", &head
))
837 BUG("remote HEAD points at non-head?");
839 strbuf_addf(&value
, "+%s:%s%s", remote_head_points_at
->name
,
840 branch_top
->buf
, head
);
843 * otherwise, the next "git fetch" will
844 * simply fetch from HEAD without updating
845 * any remote-tracking branch, which is what
849 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
->buf
);
851 /* Configure the remote */
853 strbuf_addf(&key
, "remote.%s.fetch", remote_name
);
854 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
858 strbuf_addf(&key
, "remote.%s.mirror", remote_name
);
859 git_config_set(key
.buf
, "true");
865 strbuf_release(&key
);
866 strbuf_release(&value
);
869 static void dissociate_from_references(void)
871 char *alternates
= git_pathdup("objects/info/alternates");
873 if (!access(alternates
, F_OK
)) {
874 struct child_process cmd
= CHILD_PROCESS_INIT
;
878 strvec_pushl(&cmd
.args
, "repack", "-a", "-d", NULL
);
879 if (run_command(&cmd
))
880 die(_("cannot repack to clean up"));
881 if (unlink(alternates
) && errno
!= ENOENT
)
882 die_errno(_("cannot unlink temporary alternates file"));
887 static int path_exists(const char *path
)
890 return !stat(path
, &sb
);
893 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
895 int is_bundle
= 0, is_local
;
896 int reject_shallow
= 0;
897 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
898 char *repo_to_free
= NULL
;
899 char *path
= NULL
, *dir
, *display_repo
= NULL
;
900 int dest_exists
, real_dest_exists
= 0;
901 const struct ref
*refs
, *remote_head
;
902 struct ref
*remote_head_points_at
= NULL
;
903 const struct ref
*our_head_points_at
;
904 char *unborn_head
= NULL
;
905 struct ref
*mapped_refs
= NULL
;
906 const struct ref
*ref
;
907 struct strbuf key
= STRBUF_INIT
;
908 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
909 struct transport
*transport
= NULL
;
910 const char *src_ref_prefix
= "refs/heads/";
911 struct remote
*remote
;
912 int err
= 0, complete_refs_before_fetch
= 1;
913 int submodule_progress
;
914 int filter_submodules
= 0;
916 struct transport_ls_refs_options transport_ls_refs_options
=
917 TRANSPORT_LS_REFS_OPTIONS_INIT
;
919 packet_trace_identity("clone");
921 git_config(git_clone_config
, NULL
);
923 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
924 builtin_clone_usage
, 0);
927 usage_msg_opt(_("Too many arguments."),
928 builtin_clone_usage
, builtin_clone_options
);
931 usage_msg_opt(_("You must specify a repository to clone."),
932 builtin_clone_usage
, builtin_clone_options
);
934 if (option_depth
|| option_since
|| option_not
.nr
)
936 if (option_single_branch
== -1)
937 option_single_branch
= deepen
? 1 : 0;
944 die(_("options '%s' and '%s' cannot be used together"), "--bare", "--separate-git-dir");
945 option_no_checkout
= 1;
948 if (bundle_uri
&& deepen
)
949 die(_("--bundle-uri is incompatible with --depth, --shallow-since, and --shallow-exclude"));
953 path
= get_repo_path(repo_name
, &is_bundle
);
956 repo
= repo_to_free
= absolute_pathdup(repo_name
);
957 } else if (strchr(repo_name
, ':')) {
959 display_repo
= transport_anonymize_url(repo
);
961 die(_("repository '%s' does not exist"), repo_name
);
963 /* no need to be strict, transport_set_option() will validate it again */
964 if (option_depth
&& atoi(option_depth
) < 1)
965 die(_("depth %s is not a positive number"), option_depth
);
968 dir
= xstrdup(argv
[1]);
970 dir
= git_url_basename(repo_name
, is_bundle
, option_bare
);
971 strip_dir_trailing_slashes(dir
);
973 dest_exists
= path_exists(dir
);
974 if (dest_exists
&& !is_empty_dir(dir
))
975 die(_("destination path '%s' already exists and is not "
976 "an empty directory."), dir
);
979 real_dest_exists
= path_exists(real_git_dir
);
980 if (real_dest_exists
&& !is_empty_dir(real_git_dir
))
981 die(_("repository path '%s' already exists and is not "
982 "an empty directory."), real_git_dir
);
986 strbuf_addf(&reflog_msg
, "clone: from %s",
987 display_repo
? display_repo
: repo
);
993 work_tree
= getenv("GIT_WORK_TREE");
994 if (work_tree
&& path_exists(work_tree
))
995 die(_("working tree '%s' already exists."), work_tree
);
998 if (option_bare
|| work_tree
)
999 git_dir
= xstrdup(dir
);
1002 git_dir
= mkpathdup("%s/.git", dir
);
1005 atexit(remove_junk
);
1006 sigchain_push_common(remove_junk_on_signal
);
1009 if (safe_create_leading_directories_const(work_tree
) < 0)
1010 die_errno(_("could not create leading directories of '%s'"),
1013 junk_work_tree_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1014 else if (mkdir(work_tree
, 0777))
1015 die_errno(_("could not create work tree dir '%s'"),
1017 junk_work_tree
= work_tree
;
1018 set_git_work_tree(work_tree
);
1022 if (real_dest_exists
)
1023 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1024 junk_git_dir
= real_git_dir
;
1027 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1028 junk_git_dir
= git_dir
;
1030 if (safe_create_leading_directories_const(git_dir
) < 0)
1031 die(_("could not create leading directories of '%s'"), git_dir
);
1033 if (0 <= option_verbosity
) {
1035 fprintf(stderr
, _("Cloning into bare repository '%s'...\n"), dir
);
1037 fprintf(stderr
, _("Cloning into '%s'...\n"), dir
);
1040 if (option_recurse_submodules
.nr
> 0) {
1041 struct string_list_item
*item
;
1042 struct strbuf sb
= STRBUF_INIT
;
1045 /* remove duplicates */
1046 string_list_sort(&option_recurse_submodules
);
1047 string_list_remove_duplicates(&option_recurse_submodules
, 0);
1050 * NEEDSWORK: In a multi-working-tree world, this needs to be
1051 * set in the per-worktree config.
1053 for_each_string_list_item(item
, &option_recurse_submodules
) {
1054 strbuf_addf(&sb
, "submodule.active=%s",
1056 string_list_append(&option_config
,
1057 strbuf_detach(&sb
, NULL
));
1060 if (!git_config_get_bool("submodule.stickyRecursiveClone", &val
) &&
1062 string_list_append(&option_config
, "submodule.recurse=true");
1064 if (option_required_reference
.nr
&&
1065 option_optional_reference
.nr
)
1066 die(_("clone --recursive is not compatible with "
1067 "both --reference and --reference-if-able"));
1068 else if (option_required_reference
.nr
) {
1069 string_list_append(&option_config
,
1070 "submodule.alternateLocation=superproject");
1071 string_list_append(&option_config
,
1072 "submodule.alternateErrorStrategy=die");
1073 } else if (option_optional_reference
.nr
) {
1074 string_list_append(&option_config
,
1075 "submodule.alternateLocation=superproject");
1076 string_list_append(&option_config
,
1077 "submodule.alternateErrorStrategy=info");
1081 init_db(git_dir
, real_git_dir
, option_template
, GIT_HASH_UNKNOWN
, NULL
,
1085 free((char *)git_dir
);
1086 git_dir
= real_git_dir
;
1090 * additional config can be injected with -c, make sure it's included
1091 * after init_db, which clears the entire config environment.
1093 write_config(&option_config
);
1096 * re-read config after init_db and write_config to pick up any config
1097 * injected by --template and --config, respectively.
1099 git_config(git_clone_config
, NULL
);
1102 * If option_reject_shallow is specified from CLI option,
1103 * ignore config_reject_shallow from git_clone_config.
1105 if (config_reject_shallow
!= -1)
1106 reject_shallow
= config_reject_shallow
;
1107 if (option_reject_shallow
!= -1)
1108 reject_shallow
= option_reject_shallow
;
1111 * If option_filter_submodules is specified from CLI option,
1112 * ignore config_filter_submodules from git_clone_config.
1114 if (config_filter_submodules
!= -1)
1115 filter_submodules
= config_filter_submodules
;
1116 if (option_filter_submodules
!= -1)
1117 filter_submodules
= option_filter_submodules
;
1120 * Exit if the user seems to be doing something silly with submodule
1121 * filter flags (but not with filter configs, as those should be
1124 if (option_filter_submodules
> 0 && !filter_options
.choice
)
1125 die(_("the option '%s' requires '%s'"),
1126 "--also-filter-submodules", "--filter");
1127 if (option_filter_submodules
> 0 && !option_recurse_submodules
.nr
)
1128 die(_("the option '%s' requires '%s'"),
1129 "--also-filter-submodules", "--recurse-submodules");
1132 * apply the remote name provided by --origin only after this second
1133 * call to git_config, to ensure it overrides all config-based values.
1135 if (option_origin
) {
1137 remote_name
= xstrdup(option_origin
);
1141 remote_name
= xstrdup("origin");
1143 if (!valid_remote_name(remote_name
))
1144 die(_("'%s' is not a valid remote name"), remote_name
);
1148 src_ref_prefix
= "refs/";
1149 strbuf_addstr(&branch_top
, src_ref_prefix
);
1151 git_config_set("core.bare", "true");
1153 strbuf_addf(&branch_top
, "refs/remotes/%s/", remote_name
);
1156 strbuf_addf(&key
, "remote.%s.url", remote_name
);
1157 git_config_set(key
.buf
, repo
);
1160 if (option_no_tags
) {
1161 strbuf_addf(&key
, "remote.%s.tagOpt", remote_name
);
1162 git_config_set(key
.buf
, "--no-tags");
1166 if (option_required_reference
.nr
|| option_optional_reference
.nr
)
1169 if (option_sparse_checkout
&& git_sparse_checkout_init(dir
))
1172 remote
= remote_get(remote_name
);
1174 refspec_appendf(&remote
->fetch
, "+%s*:%s*", src_ref_prefix
,
1177 path
= get_repo_path(remote
->url
[0], &is_bundle
);
1178 is_local
= option_local
!= 0 && path
&& !is_bundle
;
1181 warning(_("--depth is ignored in local clones; use file:// instead."));
1183 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1185 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1186 if (filter_options
.choice
)
1187 warning(_("--filter is ignored in local clones; use file:// instead."));
1188 if (!access(mkpath("%s/shallow", path
), F_OK
)) {
1190 die(_("source repository is shallow, reject to clone."));
1191 if (option_local
> 0)
1192 warning(_("source repository is shallow, ignoring --local"));
1196 if (option_local
> 0 && !is_local
)
1197 warning(_("--local is ignored"));
1199 transport
= transport_get(remote
, path
? path
: remote
->url
[0]);
1200 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
1201 transport
->family
= family
;
1202 transport
->cloning
= 1;
1205 struct bundle_header header
= BUNDLE_HEADER_INIT
;
1206 int fd
= read_bundle_header(path
, &header
);
1207 int has_filter
= header
.filter
.choice
!= LOFC_DISABLED
;
1211 bundle_header_release(&header
);
1213 die(_("cannot clone from filtered bundle"));
1216 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
1219 transport_set_option(transport
, TRANS_OPT_REJECT_SHALLOW
, "1");
1221 transport_set_option(transport
, TRANS_OPT_DEPTH
,
1224 transport_set_option(transport
, TRANS_OPT_DEEPEN_SINCE
,
1227 transport_set_option(transport
, TRANS_OPT_DEEPEN_NOT
,
1228 (const char *)&option_not
);
1229 if (option_single_branch
)
1230 transport_set_option(transport
, TRANS_OPT_FOLLOWTAGS
, "1");
1232 if (option_upload_pack
)
1233 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
1234 option_upload_pack
);
1236 if (server_options
.nr
)
1237 transport
->server_options
= &server_options
;
1239 if (filter_options
.choice
) {
1241 expand_list_objects_filter_spec(&filter_options
);
1242 transport_set_option(transport
, TRANS_OPT_LIST_OBJECTS_FILTER
,
1244 transport_set_option(transport
, TRANS_OPT_FROM_PROMISOR
, "1");
1247 if (transport
->smart_options
&& !deepen
&& !filter_options
.choice
)
1248 transport
->smart_options
->check_self_contained_and_connected
= 1;
1251 * Before fetching from the remote, download and install bundle
1252 * data from the --bundle-uri option.
1255 int has_heuristic
= 0;
1257 /* At this point, we need the_repository to match the cloned repo. */
1258 if (repo_init(the_repository
, git_dir
, work_tree
))
1259 warning(_("failed to initialize the repo, skipping bundle URI"));
1260 else if (fetch_bundle_uri(the_repository
, bundle_uri
, &has_heuristic
))
1261 warning(_("failed to fetch objects from bundle URI '%s'"),
1263 else if (has_heuristic
)
1264 git_config_set_gently("fetch.bundleuri", bundle_uri
);
1267 strvec_push(&transport_ls_refs_options
.ref_prefixes
, "HEAD");
1268 refspec_ref_prefixes(&remote
->fetch
,
1269 &transport_ls_refs_options
.ref_prefixes
);
1271 expand_ref_prefix(&transport_ls_refs_options
.ref_prefixes
,
1273 if (!option_no_tags
)
1274 strvec_push(&transport_ls_refs_options
.ref_prefixes
,
1277 refs
= transport_get_remote_refs(transport
, &transport_ls_refs_options
);
1280 mapped_refs
= wanted_peer_refs(refs
, &remote
->fetch
);
1284 * Populate transport->got_remote_bundle_uri and
1285 * transport->bundle_uri. We might get nothing.
1287 transport_get_remote_bundle_uri(transport
);
1289 if (transport
->bundles
&&
1290 hashmap_get_size(&transport
->bundles
->bundles
)) {
1291 /* At this point, we need the_repository to match the cloned repo. */
1292 if (repo_init(the_repository
, git_dir
, work_tree
))
1293 warning(_("failed to initialize the repo, skipping bundle URI"));
1294 else if (fetch_bundle_list(the_repository
,
1295 transport
->bundles
))
1296 warning(_("failed to fetch advertised bundles"));
1298 clear_bundle_list(transport
->bundles
);
1299 FREE_AND_NULL(transport
->bundles
);
1304 int hash_algo
= hash_algo_by_ptr(transport_get_hash_algo(transport
));
1307 * Now that we know what algorithm the remote side is using,
1308 * let's set ours to the same thing.
1310 initialize_repository_version(hash_algo
, 1);
1311 repo_set_hash_algo(the_repository
, hash_algo
);
1313 * transport_get_remote_refs() may return refs with null sha-1
1314 * in mapped_refs (see struct transport->get_refs_list
1315 * comment). In that case we need fetch it early because
1316 * remote_head code below relies on it.
1318 * for normal clones, transport_get_remote_refs() should
1319 * return reliable ref set, we can delay cloning until after
1320 * remote HEAD check.
1322 for (ref
= refs
; ref
; ref
= ref
->next
)
1323 if (is_null_oid(&ref
->old_oid
)) {
1324 complete_refs_before_fetch
= 0;
1328 if (!is_local
&& !complete_refs_before_fetch
) {
1329 if (transport_fetch_refs(transport
, mapped_refs
))
1330 die(_("remote transport reported error"));
1334 remote_head
= find_ref_by_name(refs
, "HEAD");
1335 remote_head_points_at
= guess_remote_head(remote_head
, mapped_refs
, 0);
1337 if (option_branch
) {
1338 our_head_points_at
= find_remote_branch(mapped_refs
, option_branch
);
1339 if (!our_head_points_at
)
1340 die(_("Remote branch %s not found in upstream %s"),
1341 option_branch
, remote_name
);
1342 } else if (remote_head_points_at
) {
1343 our_head_points_at
= remote_head_points_at
;
1344 } else if (remote_head
) {
1345 our_head_points_at
= NULL
;
1350 warning(_("You appear to have cloned an empty repository."));
1351 option_no_checkout
= 1;
1354 if (transport_ls_refs_options
.unborn_head_target
&&
1355 skip_prefix(transport_ls_refs_options
.unborn_head_target
,
1356 "refs/heads/", &branch
)) {
1357 unborn_head
= xstrdup(transport_ls_refs_options
.unborn_head_target
);
1359 branch
= git_default_branch_name(0);
1360 unborn_head
= xstrfmt("refs/heads/%s", branch
);
1364 * We may have selected a local default branch name "foo",
1365 * and even though the remote's HEAD does not point there,
1366 * it may still have a "foo" branch. If so, set it up so
1367 * that we can follow the usual checkout code later.
1369 * Note that for an empty repo we'll already have set
1370 * option_no_checkout above, which would work against us here.
1371 * But for an empty repo, find_remote_branch() can never find
1374 our_head_points_at
= find_remote_branch(mapped_refs
, branch
);
1377 write_refspec_config(src_ref_prefix
, our_head_points_at
,
1378 remote_head_points_at
, &branch_top
);
1380 if (filter_options
.choice
)
1381 partial_clone_register(remote_name
, &filter_options
);
1384 clone_local(path
, git_dir
);
1385 else if (mapped_refs
&& complete_refs_before_fetch
) {
1386 if (transport_fetch_refs(transport
, mapped_refs
))
1387 die(_("remote transport reported error"));
1390 update_remote_refs(refs
, mapped_refs
, remote_head_points_at
,
1391 branch_top
.buf
, reflog_msg
.buf
, transport
,
1394 update_head(our_head_points_at
, remote_head
, unborn_head
, reflog_msg
.buf
);
1397 * We want to show progress for recursive submodule clones iff
1398 * we did so for the main clone. But only the transport knows
1399 * the final decision for this flag, so we need to rescue the value
1400 * before we free the transport.
1402 submodule_progress
= transport
->progress
;
1404 transport_unlock_pack(transport
, 0);
1405 transport_disconnect(transport
);
1407 if (option_dissociate
) {
1408 close_object_store(the_repository
->objects
);
1409 dissociate_from_references();
1412 junk_mode
= JUNK_LEAVE_REPO
;
1413 err
= checkout(submodule_progress
, filter_submodules
);
1416 strbuf_release(&reflog_msg
);
1417 strbuf_release(&branch_top
);
1418 strbuf_release(&key
);
1419 free_refs(mapped_refs
);
1420 free_refs(remote_head_points_at
);
1425 junk_mode
= JUNK_LEAVE_ALL
;
1427 transport_ls_refs_options_release(&transport_ls_refs_options
);