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_COMPATIBILITY_MACROS
15 #include "parse-options.h"
16 #include "fetch-pack.h"
19 #include "object-store.h"
21 #include "tree-walk.h"
22 #include "unpack-trees.h"
23 #include "transport.h"
26 #include "dir-iterator.h"
31 #include "run-command.h"
32 #include "connected.h"
34 #include "list-objects-filter-options.h"
40 * - respect DB_ENVIRONMENT for .git/objects.
42 * Implementation notes:
43 * - dropping use-separate-remote and no-separate-remote compatibility
46 static const char * const builtin_clone_usage
[] = {
47 N_("git clone [<options>] [--] <repo> [<dir>]"),
51 static int option_no_checkout
, option_bare
, option_mirror
, option_single_branch
= -1;
52 static int option_local
= -1, option_no_hardlinks
, option_shared
;
53 static int option_no_tags
;
54 static int option_shallow_submodules
;
55 static int option_reject_shallow
= -1; /* unspecified */
56 static int config_reject_shallow
= -1; /* unspecified */
58 static char *option_template
, *option_depth
, *option_since
;
59 static char *option_origin
= NULL
;
60 static char *remote_name
= NULL
;
61 static char *option_branch
= NULL
;
62 static struct string_list option_not
= STRING_LIST_INIT_NODUP
;
63 static const char *real_git_dir
;
64 static char *option_upload_pack
= "git-upload-pack";
65 static int option_verbosity
;
66 static int option_progress
= -1;
67 static int option_sparse_checkout
;
68 static enum transport_family family
;
69 static struct string_list option_config
= STRING_LIST_INIT_NODUP
;
70 static struct string_list option_required_reference
= STRING_LIST_INIT_NODUP
;
71 static struct string_list option_optional_reference
= STRING_LIST_INIT_NODUP
;
72 static int option_dissociate
;
73 static int max_jobs
= -1;
74 static struct string_list option_recurse_submodules
= STRING_LIST_INIT_NODUP
;
75 static struct list_objects_filter_options filter_options
;
76 static int option_filter_submodules
= -1; /* unspecified */
77 static int config_filter_submodules
= -1; /* unspecified */
78 static struct string_list server_options
= STRING_LIST_INIT_NODUP
;
79 static int option_remote_submodules
;
81 static int recurse_submodules_cb(const struct option
*opt
,
82 const char *arg
, int unset
)
85 string_list_clear((struct string_list
*)opt
->value
, 0);
87 string_list_append((struct string_list
*)opt
->value
, arg
);
89 string_list_append((struct string_list
*)opt
->value
,
90 (const char *)opt
->defval
);
95 static struct option builtin_clone_options
[] = {
96 OPT__VERBOSITY(&option_verbosity
),
97 OPT_BOOL(0, "progress", &option_progress
,
98 N_("force progress reporting")),
99 OPT_BOOL(0, "reject-shallow", &option_reject_shallow
,
100 N_("don't clone shallow repository")),
101 OPT_BOOL('n', "no-checkout", &option_no_checkout
,
102 N_("don't create a checkout")),
103 OPT_BOOL(0, "bare", &option_bare
, N_("create a bare repository")),
104 OPT_HIDDEN_BOOL(0, "naked", &option_bare
,
105 N_("create a bare repository")),
106 OPT_BOOL(0, "mirror", &option_mirror
,
107 N_("create a mirror repository (implies bare)")),
108 OPT_BOOL('l', "local", &option_local
,
109 N_("to clone from a local repository")),
110 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks
,
111 N_("don't use local hardlinks, always copy")),
112 OPT_BOOL('s', "shared", &option_shared
,
113 N_("setup as shared repository")),
114 { OPTION_CALLBACK
, 0, "recurse-submodules", &option_recurse_submodules
,
115 N_("pathspec"), N_("initialize submodules in the clone"),
116 PARSE_OPT_OPTARG
, recurse_submodules_cb
, (intptr_t)"." },
117 OPT_ALIAS(0, "recursive", "recurse-submodules"),
118 OPT_INTEGER('j', "jobs", &max_jobs
,
119 N_("number of submodules cloned in parallel")),
120 OPT_STRING(0, "template", &option_template
, N_("template-directory"),
121 N_("directory from which templates will be used")),
122 OPT_STRING_LIST(0, "reference", &option_required_reference
, N_("repo"),
123 N_("reference repository")),
124 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference
,
125 N_("repo"), N_("reference repository")),
126 OPT_BOOL(0, "dissociate", &option_dissociate
,
127 N_("use --reference only while cloning")),
128 OPT_STRING('o', "origin", &option_origin
, N_("name"),
129 N_("use <name> instead of 'origin' to track upstream")),
130 OPT_STRING('b', "branch", &option_branch
, N_("branch"),
131 N_("checkout <branch> instead of the remote's HEAD")),
132 OPT_STRING('u', "upload-pack", &option_upload_pack
, N_("path"),
133 N_("path to git-upload-pack on the remote")),
134 OPT_STRING(0, "depth", &option_depth
, N_("depth"),
135 N_("create a shallow clone of that depth")),
136 OPT_STRING(0, "shallow-since", &option_since
, N_("time"),
137 N_("create a shallow clone since a specific time")),
138 OPT_STRING_LIST(0, "shallow-exclude", &option_not
, N_("revision"),
139 N_("deepen history of shallow clone, excluding rev")),
140 OPT_BOOL(0, "single-branch", &option_single_branch
,
141 N_("clone only one branch, HEAD or --branch")),
142 OPT_BOOL(0, "no-tags", &option_no_tags
,
143 N_("don't clone any tags, and make later fetches not to follow them")),
144 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules
,
145 N_("any cloned submodules will be shallow")),
146 OPT_STRING(0, "separate-git-dir", &real_git_dir
, N_("gitdir"),
147 N_("separate git dir from working tree")),
148 OPT_STRING_LIST('c', "config", &option_config
, N_("key=value"),
149 N_("set config inside the new repository")),
150 OPT_STRING_LIST(0, "server-option", &server_options
,
151 N_("server-specific"), N_("option to transmit")),
152 OPT_SET_INT('4', "ipv4", &family
, N_("use IPv4 addresses only"),
153 TRANSPORT_FAMILY_IPV4
),
154 OPT_SET_INT('6', "ipv6", &family
, N_("use IPv6 addresses only"),
155 TRANSPORT_FAMILY_IPV6
),
156 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
157 OPT_BOOL(0, "also-filter-submodules", &option_filter_submodules
,
158 N_("apply partial clone filters to submodules")),
159 OPT_BOOL(0, "remote-submodules", &option_remote_submodules
,
160 N_("any cloned submodules will use their remote-tracking branch")),
161 OPT_BOOL(0, "sparse", &option_sparse_checkout
,
162 N_("initialize sparse-checkout file to include only files at root")),
166 static const char *get_repo_path_1(struct strbuf
*path
, int *is_bundle
)
168 static char *suffix
[] = { "/.git", "", ".git/.git", ".git" };
169 static char *bundle_suffix
[] = { ".bundle", "" };
170 size_t baselen
= path
->len
;
174 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
175 strbuf_setlen(path
, baselen
);
176 strbuf_addstr(path
, suffix
[i
]);
177 if (stat(path
->buf
, &st
))
179 if (S_ISDIR(st
.st_mode
) && is_git_directory(path
->buf
)) {
182 } else if (S_ISREG(st
.st_mode
) && st
.st_size
> 8) {
183 /* Is it a "gitfile"? */
186 int len
, fd
= open(path
->buf
, O_RDONLY
);
189 len
= read_in_full(fd
, signature
, 8);
191 if (len
!= 8 || strncmp(signature
, "gitdir: ", 8))
193 dst
= read_gitfile(path
->buf
);
201 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
202 strbuf_setlen(path
, baselen
);
203 strbuf_addstr(path
, bundle_suffix
[i
]);
204 if (!stat(path
->buf
, &st
) && S_ISREG(st
.st_mode
)) {
213 static char *get_repo_path(const char *repo
, int *is_bundle
)
215 struct strbuf path
= STRBUF_INIT
;
219 strbuf_addstr(&path
, repo
);
220 raw
= get_repo_path_1(&path
, is_bundle
);
221 canon
= raw
? absolute_pathdup(raw
) : NULL
;
222 strbuf_release(&path
);
226 static int add_one_reference(struct string_list_item
*item
, void *cb_data
)
228 struct strbuf err
= STRBUF_INIT
;
229 int *required
= cb_data
;
230 char *ref_git
= compute_alternate_path(item
->string
, &err
);
237 _("info: Could not add alternate for '%s': %s\n"),
238 item
->string
, err
.buf
);
240 struct strbuf sb
= STRBUF_INIT
;
241 strbuf_addf(&sb
, "%s/objects", ref_git
);
242 add_to_alternates_file(sb
.buf
);
246 strbuf_release(&err
);
251 static void setup_reference(void)
254 for_each_string_list(&option_required_reference
,
255 add_one_reference
, &required
);
257 for_each_string_list(&option_optional_reference
,
258 add_one_reference
, &required
);
261 static void copy_alternates(struct strbuf
*src
, const char *src_repo
)
264 * Read from the source objects/info/alternates file
265 * and copy the entries to corresponding file in the
266 * destination repository with add_to_alternates_file().
267 * Both src and dst have "$path/objects/info/alternates".
269 * Instead of copying bit-for-bit from the original,
270 * we need to append to existing one so that the already
271 * created entry via "clone -s" is not lost, and also
272 * to turn entries with paths relative to the original
273 * absolute, so that they can be used in the new repository.
275 FILE *in
= xfopen(src
->buf
, "r");
276 struct strbuf line
= STRBUF_INIT
;
278 while (strbuf_getline(&line
, in
) != EOF
) {
280 if (!line
.len
|| line
.buf
[0] == '#')
282 if (is_absolute_path(line
.buf
)) {
283 add_to_alternates_file(line
.buf
);
286 abs_path
= mkpathdup("%s/objects/%s", src_repo
, line
.buf
);
287 if (!normalize_path_copy(abs_path
, abs_path
))
288 add_to_alternates_file(abs_path
);
290 warning("skipping invalid relative alternate: %s/%s",
294 strbuf_release(&line
);
298 static void mkdir_if_missing(const char *pathname
, mode_t mode
)
302 if (!mkdir(pathname
, mode
))
306 die_errno(_("failed to create directory '%s'"), pathname
);
307 else if (stat(pathname
, &st
))
308 die_errno(_("failed to stat '%s'"), pathname
);
309 else if (!S_ISDIR(st
.st_mode
))
310 die(_("%s exists and is not a directory"), pathname
);
313 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
,
314 const char *src_repo
)
316 int src_len
, dest_len
;
317 struct dir_iterator
*iter
;
319 struct strbuf realpath
= STRBUF_INIT
;
321 mkdir_if_missing(dest
->buf
, 0777);
323 iter
= dir_iterator_begin(src
->buf
, DIR_ITERATOR_PEDANTIC
);
326 die_errno(_("failed to start iterator over '%s'"), src
->buf
);
328 strbuf_addch(src
, '/');
330 strbuf_addch(dest
, '/');
331 dest_len
= dest
->len
;
333 while ((iter_status
= dir_iterator_advance(iter
)) == ITER_OK
) {
334 strbuf_setlen(src
, src_len
);
335 strbuf_addstr(src
, iter
->relative_path
);
336 strbuf_setlen(dest
, dest_len
);
337 strbuf_addstr(dest
, iter
->relative_path
);
339 if (S_ISLNK(iter
->st
.st_mode
))
340 die(_("symlink '%s' exists, refusing to clone with --local"),
341 iter
->relative_path
);
343 if (S_ISDIR(iter
->st
.st_mode
)) {
344 mkdir_if_missing(dest
->buf
, 0777);
348 /* Files that cannot be copied bit-for-bit... */
349 if (!fspathcmp(iter
->relative_path
, "info/alternates")) {
350 copy_alternates(src
, src_repo
);
354 if (unlink(dest
->buf
) && errno
!= ENOENT
)
355 die_errno(_("failed to unlink '%s'"), dest
->buf
);
356 if (!option_no_hardlinks
) {
357 strbuf_realpath(&realpath
, src
->buf
, 1);
358 if (!link(realpath
.buf
, dest
->buf
))
360 if (option_local
> 0)
361 die_errno(_("failed to create link '%s'"), dest
->buf
);
362 option_no_hardlinks
= 1;
364 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
365 die_errno(_("failed to copy file to '%s'"), dest
->buf
);
368 if (iter_status
!= ITER_DONE
) {
369 strbuf_setlen(src
, src_len
);
370 die(_("failed to iterate over '%s'"), src
->buf
);
373 strbuf_release(&realpath
);
376 static void clone_local(const char *src_repo
, const char *dest_repo
)
379 struct strbuf alt
= STRBUF_INIT
;
380 get_common_dir(&alt
, src_repo
);
381 strbuf_addstr(&alt
, "/objects");
382 add_to_alternates_file(alt
.buf
);
383 strbuf_release(&alt
);
385 struct strbuf src
= STRBUF_INIT
;
386 struct strbuf dest
= STRBUF_INIT
;
387 get_common_dir(&src
, src_repo
);
388 get_common_dir(&dest
, dest_repo
);
389 strbuf_addstr(&src
, "/objects");
390 strbuf_addstr(&dest
, "/objects");
391 copy_or_link_directory(&src
, &dest
, src_repo
);
392 strbuf_release(&src
);
393 strbuf_release(&dest
);
396 if (0 <= option_verbosity
)
397 fprintf(stderr
, _("done.\n"));
400 static const char *junk_work_tree
;
401 static int junk_work_tree_flags
;
402 static const char *junk_git_dir
;
403 static int junk_git_dir_flags
;
408 } junk_mode
= JUNK_LEAVE_NONE
;
410 static const char junk_leave_repo_msg
[] =
411 N_("Clone succeeded, but checkout failed.\n"
412 "You can inspect what was checked out with 'git status'\n"
413 "and retry with 'git restore --source=HEAD :/'\n");
415 static void remove_junk(void)
417 struct strbuf sb
= STRBUF_INIT
;
420 case JUNK_LEAVE_REPO
:
421 warning("%s", _(junk_leave_repo_msg
));
426 /* proceed to removal */
431 strbuf_addstr(&sb
, junk_git_dir
);
432 remove_dir_recursively(&sb
, junk_git_dir_flags
);
435 if (junk_work_tree
) {
436 strbuf_addstr(&sb
, junk_work_tree
);
437 remove_dir_recursively(&sb
, junk_work_tree_flags
);
442 static void remove_junk_on_signal(int signo
)
449 static struct ref
*find_remote_branch(const struct ref
*refs
, const char *branch
)
452 struct strbuf head
= STRBUF_INIT
;
453 strbuf_addstr(&head
, "refs/heads/");
454 strbuf_addstr(&head
, branch
);
455 ref
= find_ref_by_name(refs
, head
.buf
);
456 strbuf_release(&head
);
461 strbuf_addstr(&head
, "refs/tags/");
462 strbuf_addstr(&head
, branch
);
463 ref
= find_ref_by_name(refs
, head
.buf
);
464 strbuf_release(&head
);
469 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
470 struct refspec
*refspec
)
472 struct ref
*head
= copy_ref(find_ref_by_name(refs
, "HEAD"));
473 struct ref
*local_refs
= head
;
474 struct ref
**tail
= head
? &head
->next
: &local_refs
;
476 if (option_single_branch
) {
477 struct ref
*remote_head
= NULL
;
480 remote_head
= guess_remote_head(head
, refs
, 0);
484 remote_head
= copy_ref(find_remote_branch(refs
, option_branch
));
487 if (!remote_head
&& option_branch
)
488 warning(_("Could not find remote branch %s to clone."),
492 for (i
= 0; i
< refspec
->nr
; i
++)
493 get_fetch_map(remote_head
, &refspec
->items
[i
],
496 /* if --branch=tag, pull the requested tag explicitly */
497 get_fetch_map(remote_head
, tag_refspec
, &tail
, 0);
501 for (i
= 0; i
< refspec
->nr
; i
++)
502 get_fetch_map(refs
, &refspec
->items
[i
], &tail
, 0);
505 if (!option_mirror
&& !option_single_branch
&& !option_no_tags
)
506 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
511 static void write_remote_refs(const struct ref
*local_refs
)
515 struct ref_transaction
*t
;
516 struct strbuf err
= STRBUF_INIT
;
518 t
= ref_transaction_begin(&err
);
522 for (r
= local_refs
; r
; r
= r
->next
) {
525 if (ref_transaction_create(t
, r
->peer_ref
->name
, &r
->old_oid
,
530 if (initial_ref_transaction_commit(t
, &err
))
533 strbuf_release(&err
);
534 ref_transaction_free(t
);
537 static void write_followtags(const struct ref
*refs
, const char *msg
)
539 const struct ref
*ref
;
540 for (ref
= refs
; ref
; ref
= ref
->next
) {
541 if (!starts_with(ref
->name
, "refs/tags/"))
543 if (ends_with(ref
->name
, "^{}"))
545 if (!has_object_file_with_flags(&ref
->old_oid
,
547 OBJECT_INFO_SKIP_FETCH_OBJECT
))
549 update_ref(msg
, ref
->name
, &ref
->old_oid
, NULL
, 0,
550 UPDATE_REFS_DIE_ON_ERR
);
554 static const struct object_id
*iterate_ref_map(void *cb_data
)
556 struct ref
**rm
= cb_data
;
557 struct ref
*ref
= *rm
;
560 * Skip anything missing a peer_ref, which we are not
561 * actually going to write a ref for.
563 while (ref
&& !ref
->peer_ref
)
569 return &ref
->old_oid
;
572 static void update_remote_refs(const struct ref
*refs
,
573 const struct ref
*mapped_refs
,
574 const struct ref
*remote_head_points_at
,
575 const char *branch_top
,
577 struct transport
*transport
,
578 int check_connectivity
)
580 const struct ref
*rm
= mapped_refs
;
582 if (check_connectivity
) {
583 struct check_connected_options opt
= CHECK_CONNECTED_INIT
;
585 opt
.transport
= transport
;
586 opt
.progress
= transport
->progress
;
588 if (check_connected(iterate_ref_map
, &rm
, &opt
))
589 die(_("remote did not send all necessary objects"));
593 write_remote_refs(mapped_refs
);
594 if (option_single_branch
&& !option_no_tags
)
595 write_followtags(refs
, msg
);
598 if (remote_head_points_at
&& !option_bare
) {
599 struct strbuf head_ref
= STRBUF_INIT
;
600 strbuf_addstr(&head_ref
, branch_top
);
601 strbuf_addstr(&head_ref
, "HEAD");
602 if (create_symref(head_ref
.buf
,
603 remote_head_points_at
->peer_ref
->name
,
605 die(_("unable to update %s"), head_ref
.buf
);
606 strbuf_release(&head_ref
);
610 static void update_head(const struct ref
*our
, const struct ref
*remote
,
611 const char *unborn
, const char *msg
)
614 if (our
&& skip_prefix(our
->name
, "refs/heads/", &head
)) {
615 /* Local default branch link */
616 if (create_symref("HEAD", our
->name
, NULL
) < 0)
617 die(_("unable to update HEAD"));
619 update_ref(msg
, "HEAD", &our
->old_oid
, NULL
, 0,
620 UPDATE_REFS_DIE_ON_ERR
);
621 install_branch_config(0, head
, remote_name
, our
->name
);
624 struct commit
*c
= lookup_commit_reference(the_repository
,
626 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
627 update_ref(msg
, "HEAD", &c
->object
.oid
, NULL
, REF_NO_DEREF
,
628 UPDATE_REFS_DIE_ON_ERR
);
631 * We know remote HEAD points to a non-branch, or
632 * HEAD points to a branch but we don't know which one.
633 * Detach HEAD in all these cases.
635 update_ref(msg
, "HEAD", &remote
->old_oid
, NULL
, REF_NO_DEREF
,
636 UPDATE_REFS_DIE_ON_ERR
);
637 } else if (unborn
&& skip_prefix(unborn
, "refs/heads/", &head
)) {
639 * Unborn head from remote; same as "our" case above except
640 * that we have no ref to update.
642 if (create_symref("HEAD", unborn
, NULL
) < 0)
643 die(_("unable to update HEAD"));
645 install_branch_config(0, head
, remote_name
, unborn
);
649 static int git_sparse_checkout_init(const char *repo
)
651 struct strvec argv
= STRVEC_INIT
;
653 strvec_pushl(&argv
, "-C", repo
, "sparse-checkout", "set", NULL
);
656 * We must apply the setting in the current process
657 * for the later checkout to use the sparse-checkout file.
659 core_apply_sparse_checkout
= 1;
661 if (run_command_v_opt(argv
.v
, RUN_GIT_CMD
)) {
662 error(_("failed to initialize sparse-checkout"));
670 static int checkout(int submodule_progress
, int filter_submodules
)
672 struct object_id oid
;
674 struct lock_file lock_file
= LOCK_INIT
;
675 struct unpack_trees_options opts
;
680 if (option_no_checkout
)
683 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, &oid
, NULL
);
685 warning(_("remote HEAD refers to nonexistent ref, "
686 "unable to checkout"));
689 if (!strcmp(head
, "HEAD")) {
690 if (advice_enabled(ADVICE_DETACHED_HEAD
))
691 detach_advice(oid_to_hex(&oid
));
694 if (!starts_with(head
, "refs/heads/"))
695 die(_("HEAD not found below refs/heads!"));
698 /* We need to be in the new work tree for the checkout */
701 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
703 memset(&opts
, 0, sizeof opts
);
707 opts
.preserve_ignored
= 0;
708 opts
.fn
= oneway_merge
;
709 opts
.verbose_update
= (option_verbosity
>= 0);
710 opts
.src_index
= &the_index
;
711 opts
.dst_index
= &the_index
;
712 init_checkout_metadata(&opts
.meta
, head
, &oid
, NULL
);
714 tree
= parse_tree_indirect(&oid
);
716 die(_("unable to parse commit %s"), oid_to_hex(&oid
));
718 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
719 if (unpack_trees(1, &t
, &opts
) < 0)
720 die(_("unable to checkout working tree"));
724 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
725 die(_("unable to write new index file"));
727 err
|= run_hooks_l("post-checkout", oid_to_hex(null_oid()),
728 oid_to_hex(&oid
), "1", NULL
);
730 if (!err
&& (option_recurse_submodules
.nr
> 0)) {
731 struct strvec args
= STRVEC_INIT
;
732 strvec_pushl(&args
, "submodule", "update", "--require-init", "--recursive", NULL
);
734 if (option_shallow_submodules
== 1)
735 strvec_push(&args
, "--depth=1");
738 strvec_pushf(&args
, "--jobs=%d", max_jobs
);
740 if (submodule_progress
)
741 strvec_push(&args
, "--progress");
743 if (option_verbosity
< 0)
744 strvec_push(&args
, "--quiet");
746 if (option_remote_submodules
) {
747 strvec_push(&args
, "--remote");
748 strvec_push(&args
, "--no-fetch");
751 if (filter_submodules
&& filter_options
.choice
)
752 strvec_pushf(&args
, "--filter=%s",
753 expand_list_objects_filter_spec(&filter_options
));
755 if (option_single_branch
>= 0)
756 strvec_push(&args
, option_single_branch
?
758 "--no-single-branch");
760 err
= run_command_v_opt(args
.v
, RUN_GIT_CMD
);
767 static int git_clone_config(const char *k
, const char *v
, void *cb
)
769 if (!strcmp(k
, "clone.defaultremotename")) {
771 remote_name
= xstrdup(v
);
773 if (!strcmp(k
, "clone.rejectshallow"))
774 config_reject_shallow
= git_config_bool(k
, v
);
775 if (!strcmp(k
, "clone.filtersubmodules"))
776 config_filter_submodules
= git_config_bool(k
, v
);
778 return git_default_config(k
, v
, cb
);
781 static int write_one_config(const char *key
, const char *value
, void *data
)
784 * give git_clone_config a chance to write config values back to the
785 * environment, since git_config_set_multivar_gently only deals with
788 int apply_failed
= git_clone_config(key
, value
, data
);
792 return git_config_set_multivar_gently(key
,
793 value
? value
: "true",
794 CONFIG_REGEX_NONE
, 0);
797 static void write_config(struct string_list
*config
)
801 for (i
= 0; i
< config
->nr
; i
++) {
802 if (git_config_parse_parameter(config
->items
[i
].string
,
803 write_one_config
, NULL
) < 0)
804 die(_("unable to write parameters to config file"));
808 static void write_refspec_config(const char *src_ref_prefix
,
809 const struct ref
*our_head_points_at
,
810 const struct ref
*remote_head_points_at
,
811 struct strbuf
*branch_top
)
813 struct strbuf key
= STRBUF_INIT
;
814 struct strbuf value
= STRBUF_INIT
;
816 if (option_mirror
|| !option_bare
) {
817 if (option_single_branch
&& !option_mirror
) {
819 if (starts_with(our_head_points_at
->name
, "refs/tags/"))
820 strbuf_addf(&value
, "+%s:%s", our_head_points_at
->name
,
821 our_head_points_at
->name
);
823 strbuf_addf(&value
, "+%s:%s%s", our_head_points_at
->name
,
824 branch_top
->buf
, option_branch
);
825 } else if (remote_head_points_at
) {
826 const char *head
= remote_head_points_at
->name
;
827 if (!skip_prefix(head
, "refs/heads/", &head
))
828 BUG("remote HEAD points at non-head?");
830 strbuf_addf(&value
, "+%s:%s%s", remote_head_points_at
->name
,
831 branch_top
->buf
, head
);
834 * otherwise, the next "git fetch" will
835 * simply fetch from HEAD without updating
836 * any remote-tracking branch, which is what
840 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
->buf
);
842 /* Configure the remote */
844 strbuf_addf(&key
, "remote.%s.fetch", remote_name
);
845 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
849 strbuf_addf(&key
, "remote.%s.mirror", remote_name
);
850 git_config_set(key
.buf
, "true");
856 strbuf_release(&key
);
857 strbuf_release(&value
);
860 static void dissociate_from_references(void)
862 static const char* argv
[] = { "repack", "-a", "-d", NULL
};
863 char *alternates
= git_pathdup("objects/info/alternates");
865 if (!access(alternates
, F_OK
)) {
866 if (run_command_v_opt(argv
, RUN_GIT_CMD
|RUN_COMMAND_NO_STDIN
))
867 die(_("cannot repack to clean up"));
868 if (unlink(alternates
) && errno
!= ENOENT
)
869 die_errno(_("cannot unlink temporary alternates file"));
874 static int path_exists(const char *path
)
877 return !stat(path
, &sb
);
880 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
882 int is_bundle
= 0, is_local
;
883 int reject_shallow
= 0;
884 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
885 char *path
= NULL
, *dir
, *display_repo
= NULL
;
886 int dest_exists
, real_dest_exists
= 0;
887 const struct ref
*refs
, *remote_head
;
888 struct ref
*remote_head_points_at
= NULL
;
889 const struct ref
*our_head_points_at
;
890 char *unborn_head
= NULL
;
891 struct ref
*mapped_refs
= NULL
;
892 const struct ref
*ref
;
893 struct strbuf key
= STRBUF_INIT
;
894 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
895 struct transport
*transport
= NULL
;
896 const char *src_ref_prefix
= "refs/heads/";
897 struct remote
*remote
;
898 int err
= 0, complete_refs_before_fetch
= 1;
899 int submodule_progress
;
900 int filter_submodules
= 0;
902 struct transport_ls_refs_options transport_ls_refs_options
=
903 TRANSPORT_LS_REFS_OPTIONS_INIT
;
905 packet_trace_identity("clone");
907 git_config(git_clone_config
, NULL
);
909 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
910 builtin_clone_usage
, 0);
913 usage_msg_opt(_("Too many arguments."),
914 builtin_clone_usage
, builtin_clone_options
);
917 usage_msg_opt(_("You must specify a repository to clone."),
918 builtin_clone_usage
, builtin_clone_options
);
920 if (option_depth
|| option_since
|| option_not
.nr
)
922 if (option_single_branch
== -1)
923 option_single_branch
= deepen
? 1 : 0;
930 die(_("options '%s' and '%s %s' cannot be used together"),
931 "--bare", "--origin", option_origin
);
933 die(_("options '%s' and '%s' cannot be used together"), "--bare", "--separate-git-dir");
934 option_no_checkout
= 1;
939 path
= get_repo_path(repo_name
, &is_bundle
);
942 repo
= absolute_pathdup(repo_name
);
943 } else if (strchr(repo_name
, ':')) {
945 display_repo
= transport_anonymize_url(repo
);
947 die(_("repository '%s' does not exist"), repo_name
);
949 /* no need to be strict, transport_set_option() will validate it again */
950 if (option_depth
&& atoi(option_depth
) < 1)
951 die(_("depth %s is not a positive number"), option_depth
);
954 dir
= xstrdup(argv
[1]);
956 dir
= git_url_basename(repo_name
, is_bundle
, option_bare
);
957 strip_dir_trailing_slashes(dir
);
959 dest_exists
= path_exists(dir
);
960 if (dest_exists
&& !is_empty_dir(dir
))
961 die(_("destination path '%s' already exists and is not "
962 "an empty directory."), dir
);
965 real_dest_exists
= path_exists(real_git_dir
);
966 if (real_dest_exists
&& !is_empty_dir(real_git_dir
))
967 die(_("repository path '%s' already exists and is not "
968 "an empty directory."), real_git_dir
);
972 strbuf_addf(&reflog_msg
, "clone: from %s",
973 display_repo
? display_repo
: repo
);
979 work_tree
= getenv("GIT_WORK_TREE");
980 if (work_tree
&& path_exists(work_tree
))
981 die(_("working tree '%s' already exists."), work_tree
);
984 if (option_bare
|| work_tree
)
985 git_dir
= xstrdup(dir
);
988 git_dir
= mkpathdup("%s/.git", dir
);
992 sigchain_push_common(remove_junk_on_signal
);
995 if (safe_create_leading_directories_const(work_tree
) < 0)
996 die_errno(_("could not create leading directories of '%s'"),
999 junk_work_tree_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1000 else if (mkdir(work_tree
, 0777))
1001 die_errno(_("could not create work tree dir '%s'"),
1003 junk_work_tree
= work_tree
;
1004 set_git_work_tree(work_tree
);
1008 if (real_dest_exists
)
1009 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1010 junk_git_dir
= real_git_dir
;
1013 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1014 junk_git_dir
= git_dir
;
1016 if (safe_create_leading_directories_const(git_dir
) < 0)
1017 die(_("could not create leading directories of '%s'"), git_dir
);
1019 if (0 <= option_verbosity
) {
1021 fprintf(stderr
, _("Cloning into bare repository '%s'...\n"), dir
);
1023 fprintf(stderr
, _("Cloning into '%s'...\n"), dir
);
1026 if (option_recurse_submodules
.nr
> 0) {
1027 struct string_list_item
*item
;
1028 struct strbuf sb
= STRBUF_INIT
;
1031 /* remove duplicates */
1032 string_list_sort(&option_recurse_submodules
);
1033 string_list_remove_duplicates(&option_recurse_submodules
, 0);
1036 * NEEDSWORK: In a multi-working-tree world, this needs to be
1037 * set in the per-worktree config.
1039 for_each_string_list_item(item
, &option_recurse_submodules
) {
1040 strbuf_addf(&sb
, "submodule.active=%s",
1042 string_list_append(&option_config
,
1043 strbuf_detach(&sb
, NULL
));
1046 if (!git_config_get_bool("submodule.stickyRecursiveClone", &val
) &&
1048 string_list_append(&option_config
, "submodule.recurse=true");
1050 if (option_required_reference
.nr
&&
1051 option_optional_reference
.nr
)
1052 die(_("clone --recursive is not compatible with "
1053 "both --reference and --reference-if-able"));
1054 else if (option_required_reference
.nr
) {
1055 string_list_append(&option_config
,
1056 "submodule.alternateLocation=superproject");
1057 string_list_append(&option_config
,
1058 "submodule.alternateErrorStrategy=die");
1059 } else if (option_optional_reference
.nr
) {
1060 string_list_append(&option_config
,
1061 "submodule.alternateLocation=superproject");
1062 string_list_append(&option_config
,
1063 "submodule.alternateErrorStrategy=info");
1067 init_db(git_dir
, real_git_dir
, option_template
, GIT_HASH_UNKNOWN
, NULL
,
1071 free((char *)git_dir
);
1072 git_dir
= real_git_dir
;
1076 * additional config can be injected with -c, make sure it's included
1077 * after init_db, which clears the entire config environment.
1079 write_config(&option_config
);
1082 * re-read config after init_db and write_config to pick up any config
1083 * injected by --template and --config, respectively.
1085 git_config(git_clone_config
, NULL
);
1088 * If option_reject_shallow is specified from CLI option,
1089 * ignore config_reject_shallow from git_clone_config.
1091 if (config_reject_shallow
!= -1)
1092 reject_shallow
= config_reject_shallow
;
1093 if (option_reject_shallow
!= -1)
1094 reject_shallow
= option_reject_shallow
;
1097 * If option_filter_submodules is specified from CLI option,
1098 * ignore config_filter_submodules from git_clone_config.
1100 if (config_filter_submodules
!= -1)
1101 filter_submodules
= config_filter_submodules
;
1102 if (option_filter_submodules
!= -1)
1103 filter_submodules
= option_filter_submodules
;
1106 * Exit if the user seems to be doing something silly with submodule
1107 * filter flags (but not with filter configs, as those should be
1110 if (option_filter_submodules
> 0 && !filter_options
.choice
)
1111 die(_("the option '%s' requires '%s'"),
1112 "--also-filter-submodules", "--filter");
1113 if (option_filter_submodules
> 0 && !option_recurse_submodules
.nr
)
1114 die(_("the option '%s' requires '%s'"),
1115 "--also-filter-submodules", "--recurse-submodules");
1118 * apply the remote name provided by --origin only after this second
1119 * call to git_config, to ensure it overrides all config-based values.
1121 if (option_origin
) {
1123 remote_name
= xstrdup(option_origin
);
1127 remote_name
= xstrdup("origin");
1129 if (!valid_remote_name(remote_name
))
1130 die(_("'%s' is not a valid remote name"), remote_name
);
1134 src_ref_prefix
= "refs/";
1135 strbuf_addstr(&branch_top
, src_ref_prefix
);
1137 git_config_set("core.bare", "true");
1139 strbuf_addf(&branch_top
, "refs/remotes/%s/", remote_name
);
1142 strbuf_addf(&key
, "remote.%s.url", remote_name
);
1143 git_config_set(key
.buf
, repo
);
1146 if (option_no_tags
) {
1147 strbuf_addf(&key
, "remote.%s.tagOpt", remote_name
);
1148 git_config_set(key
.buf
, "--no-tags");
1152 if (option_required_reference
.nr
|| option_optional_reference
.nr
)
1155 if (option_sparse_checkout
&& git_sparse_checkout_init(dir
))
1158 remote
= remote_get(remote_name
);
1160 refspec_appendf(&remote
->fetch
, "+%s*:%s*", src_ref_prefix
,
1163 path
= get_repo_path(remote
->url
[0], &is_bundle
);
1164 is_local
= option_local
!= 0 && path
&& !is_bundle
;
1167 warning(_("--depth is ignored in local clones; use file:// instead."));
1169 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1171 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1172 if (filter_options
.choice
)
1173 warning(_("--filter is ignored in local clones; use file:// instead."));
1174 if (!access(mkpath("%s/shallow", path
), F_OK
)) {
1176 die(_("source repository is shallow, reject to clone."));
1177 if (option_local
> 0)
1178 warning(_("source repository is shallow, ignoring --local"));
1182 if (option_local
> 0 && !is_local
)
1183 warning(_("--local is ignored"));
1185 transport
= transport_get(remote
, path
? path
: remote
->url
[0]);
1186 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
1187 transport
->family
= family
;
1188 transport
->cloning
= 1;
1191 struct bundle_header header
= BUNDLE_HEADER_INIT
;
1192 int fd
= read_bundle_header(path
, &header
);
1193 int has_filter
= header
.filter
.choice
!= LOFC_DISABLED
;
1197 bundle_header_release(&header
);
1199 die(_("cannot clone from filtered bundle"));
1202 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
1205 transport_set_option(transport
, TRANS_OPT_REJECT_SHALLOW
, "1");
1207 transport_set_option(transport
, TRANS_OPT_DEPTH
,
1210 transport_set_option(transport
, TRANS_OPT_DEEPEN_SINCE
,
1213 transport_set_option(transport
, TRANS_OPT_DEEPEN_NOT
,
1214 (const char *)&option_not
);
1215 if (option_single_branch
)
1216 transport_set_option(transport
, TRANS_OPT_FOLLOWTAGS
, "1");
1218 if (option_upload_pack
)
1219 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
1220 option_upload_pack
);
1222 if (server_options
.nr
)
1223 transport
->server_options
= &server_options
;
1225 if (filter_options
.choice
) {
1227 expand_list_objects_filter_spec(&filter_options
);
1228 transport_set_option(transport
, TRANS_OPT_LIST_OBJECTS_FILTER
,
1230 transport_set_option(transport
, TRANS_OPT_FROM_PROMISOR
, "1");
1233 if (transport
->smart_options
&& !deepen
&& !filter_options
.choice
)
1234 transport
->smart_options
->check_self_contained_and_connected
= 1;
1237 strvec_push(&transport_ls_refs_options
.ref_prefixes
, "HEAD");
1238 refspec_ref_prefixes(&remote
->fetch
,
1239 &transport_ls_refs_options
.ref_prefixes
);
1241 expand_ref_prefix(&transport_ls_refs_options
.ref_prefixes
,
1243 if (!option_no_tags
)
1244 strvec_push(&transport_ls_refs_options
.ref_prefixes
,
1247 refs
= transport_get_remote_refs(transport
, &transport_ls_refs_options
);
1250 mapped_refs
= wanted_peer_refs(refs
, &remote
->fetch
);
1253 int hash_algo
= hash_algo_by_ptr(transport_get_hash_algo(transport
));
1256 * Now that we know what algorithm the remote side is using,
1257 * let's set ours to the same thing.
1259 initialize_repository_version(hash_algo
, 1);
1260 repo_set_hash_algo(the_repository
, hash_algo
);
1262 * transport_get_remote_refs() may return refs with null sha-1
1263 * in mapped_refs (see struct transport->get_refs_list
1264 * comment). In that case we need fetch it early because
1265 * remote_head code below relies on it.
1267 * for normal clones, transport_get_remote_refs() should
1268 * return reliable ref set, we can delay cloning until after
1269 * remote HEAD check.
1271 for (ref
= refs
; ref
; ref
= ref
->next
)
1272 if (is_null_oid(&ref
->old_oid
)) {
1273 complete_refs_before_fetch
= 0;
1277 if (!is_local
&& !complete_refs_before_fetch
) {
1278 if (transport_fetch_refs(transport
, mapped_refs
))
1279 die(_("remote transport reported error"));
1283 remote_head
= find_ref_by_name(refs
, "HEAD");
1284 remote_head_points_at
= guess_remote_head(remote_head
, mapped_refs
, 0);
1286 if (option_branch
) {
1287 our_head_points_at
= find_remote_branch(mapped_refs
, option_branch
);
1288 if (!our_head_points_at
)
1289 die(_("Remote branch %s not found in upstream %s"),
1290 option_branch
, remote_name
);
1291 } else if (remote_head_points_at
) {
1292 our_head_points_at
= remote_head_points_at
;
1293 } else if (remote_head
) {
1294 our_head_points_at
= NULL
;
1299 warning(_("You appear to have cloned an empty repository."));
1300 option_no_checkout
= 1;
1303 if (transport_ls_refs_options
.unborn_head_target
&&
1304 skip_prefix(transport_ls_refs_options
.unborn_head_target
,
1305 "refs/heads/", &branch
)) {
1306 unborn_head
= xstrdup(transport_ls_refs_options
.unborn_head_target
);
1308 branch
= git_default_branch_name(0);
1309 unborn_head
= xstrfmt("refs/heads/%s", branch
);
1313 * We may have selected a local default branch name "foo",
1314 * and even though the remote's HEAD does not point there,
1315 * it may still have a "foo" branch. If so, set it up so
1316 * that we can follow the usual checkout code later.
1318 * Note that for an empty repo we'll already have set
1319 * option_no_checkout above, which would work against us here.
1320 * But for an empty repo, find_remote_branch() can never find
1323 our_head_points_at
= find_remote_branch(mapped_refs
, branch
);
1326 write_refspec_config(src_ref_prefix
, our_head_points_at
,
1327 remote_head_points_at
, &branch_top
);
1329 if (filter_options
.choice
)
1330 partial_clone_register(remote_name
, &filter_options
);
1333 clone_local(path
, git_dir
);
1334 else if (mapped_refs
&& complete_refs_before_fetch
) {
1335 if (transport_fetch_refs(transport
, mapped_refs
))
1336 die(_("remote transport reported error"));
1339 update_remote_refs(refs
, mapped_refs
, remote_head_points_at
,
1340 branch_top
.buf
, reflog_msg
.buf
, transport
,
1343 update_head(our_head_points_at
, remote_head
, unborn_head
, reflog_msg
.buf
);
1346 * We want to show progress for recursive submodule clones iff
1347 * we did so for the main clone. But only the transport knows
1348 * the final decision for this flag, so we need to rescue the value
1349 * before we free the transport.
1351 submodule_progress
= transport
->progress
;
1353 transport_unlock_pack(transport
, 0);
1354 transport_disconnect(transport
);
1356 if (option_dissociate
) {
1357 close_object_store(the_repository
->objects
);
1358 dissociate_from_references();
1361 junk_mode
= JUNK_LEAVE_REPO
;
1362 err
= checkout(submodule_progress
, filter_submodules
);
1365 strbuf_release(&reflog_msg
);
1366 strbuf_release(&branch_top
);
1367 strbuf_release(&key
);
1368 free_refs(mapped_refs
);
1369 free_refs(remote_head_points_at
);
1374 junk_mode
= JUNK_LEAVE_ALL
;
1376 transport_ls_refs_options_release(&transport_ls_refs_options
);