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"
39 * - respect DB_ENVIRONMENT for .git/objects.
41 * Implementation notes:
42 * - dropping use-separate-remote and no-separate-remote compatibility
45 static const char * const builtin_clone_usage
[] = {
46 N_("git clone [<options>] [--] <repo> [<dir>]"),
50 static int option_no_checkout
, option_bare
, option_mirror
, option_single_branch
= -1;
51 static int option_local
= -1, option_no_hardlinks
, option_shared
;
52 static int option_no_tags
;
53 static int option_shallow_submodules
;
54 static int option_reject_shallow
= -1; /* unspecified */
55 static int config_reject_shallow
= -1; /* unspecified */
57 static char *option_template
, *option_depth
, *option_since
;
58 static char *option_origin
= NULL
;
59 static char *remote_name
= NULL
;
60 static char *option_branch
= NULL
;
61 static struct string_list option_not
= STRING_LIST_INIT_NODUP
;
62 static const char *real_git_dir
;
63 static char *option_upload_pack
= "git-upload-pack";
64 static int option_verbosity
;
65 static int option_progress
= -1;
66 static int option_sparse_checkout
;
67 static enum transport_family family
;
68 static struct string_list option_config
= STRING_LIST_INIT_NODUP
;
69 static struct string_list option_required_reference
= STRING_LIST_INIT_NODUP
;
70 static struct string_list option_optional_reference
= STRING_LIST_INIT_NODUP
;
71 static int option_dissociate
;
72 static int max_jobs
= -1;
73 static struct string_list option_recurse_submodules
= STRING_LIST_INIT_NODUP
;
74 static struct list_objects_filter_options filter_options
;
75 static struct string_list server_options
= STRING_LIST_INIT_NODUP
;
76 static int option_remote_submodules
;
78 static int recurse_submodules_cb(const struct option
*opt
,
79 const char *arg
, int unset
)
82 string_list_clear((struct string_list
*)opt
->value
, 0);
84 string_list_append((struct string_list
*)opt
->value
, arg
);
86 string_list_append((struct string_list
*)opt
->value
,
87 (const char *)opt
->defval
);
92 static struct option builtin_clone_options
[] = {
93 OPT__VERBOSITY(&option_verbosity
),
94 OPT_BOOL(0, "progress", &option_progress
,
95 N_("force progress reporting")),
96 OPT_BOOL(0, "reject-shallow", &option_reject_shallow
,
97 N_("don't clone shallow repository")),
98 OPT_BOOL('n', "no-checkout", &option_no_checkout
,
99 N_("don't create a checkout")),
100 OPT_BOOL(0, "bare", &option_bare
, N_("create a bare repository")),
101 OPT_HIDDEN_BOOL(0, "naked", &option_bare
,
102 N_("create a bare repository")),
103 OPT_BOOL(0, "mirror", &option_mirror
,
104 N_("create a mirror repository (implies bare)")),
105 OPT_BOOL('l', "local", &option_local
,
106 N_("to clone from a local repository")),
107 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks
,
108 N_("don't use local hardlinks, always copy")),
109 OPT_BOOL('s', "shared", &option_shared
,
110 N_("setup as shared repository")),
111 { OPTION_CALLBACK
, 0, "recurse-submodules", &option_recurse_submodules
,
112 N_("pathspec"), N_("initialize submodules in the clone"),
113 PARSE_OPT_OPTARG
, recurse_submodules_cb
, (intptr_t)"." },
114 OPT_ALIAS(0, "recursive", "recurse-submodules"),
115 OPT_INTEGER('j', "jobs", &max_jobs
,
116 N_("number of submodules cloned in parallel")),
117 OPT_STRING(0, "template", &option_template
, N_("template-directory"),
118 N_("directory from which templates will be used")),
119 OPT_STRING_LIST(0, "reference", &option_required_reference
, N_("repo"),
120 N_("reference repository")),
121 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference
,
122 N_("repo"), N_("reference repository")),
123 OPT_BOOL(0, "dissociate", &option_dissociate
,
124 N_("use --reference only while cloning")),
125 OPT_STRING('o', "origin", &option_origin
, N_("name"),
126 N_("use <name> instead of 'origin' to track upstream")),
127 OPT_STRING('b', "branch", &option_branch
, N_("branch"),
128 N_("checkout <branch> instead of the remote's HEAD")),
129 OPT_STRING('u', "upload-pack", &option_upload_pack
, N_("path"),
130 N_("path to git-upload-pack on the remote")),
131 OPT_STRING(0, "depth", &option_depth
, N_("depth"),
132 N_("create a shallow clone of that depth")),
133 OPT_STRING(0, "shallow-since", &option_since
, N_("time"),
134 N_("create a shallow clone since a specific time")),
135 OPT_STRING_LIST(0, "shallow-exclude", &option_not
, N_("revision"),
136 N_("deepen history of shallow clone, excluding rev")),
137 OPT_BOOL(0, "single-branch", &option_single_branch
,
138 N_("clone only one branch, HEAD or --branch")),
139 OPT_BOOL(0, "no-tags", &option_no_tags
,
140 N_("don't clone any tags, and make later fetches not to follow them")),
141 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules
,
142 N_("any cloned submodules will be shallow")),
143 OPT_STRING(0, "separate-git-dir", &real_git_dir
, N_("gitdir"),
144 N_("separate git dir from working tree")),
145 OPT_STRING_LIST('c', "config", &option_config
, N_("key=value"),
146 N_("set config inside the new repository")),
147 OPT_STRING_LIST(0, "server-option", &server_options
,
148 N_("server-specific"), N_("option to transmit")),
149 OPT_SET_INT('4', "ipv4", &family
, N_("use IPv4 addresses only"),
150 TRANSPORT_FAMILY_IPV4
),
151 OPT_SET_INT('6', "ipv6", &family
, N_("use IPv6 addresses only"),
152 TRANSPORT_FAMILY_IPV6
),
153 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
154 OPT_BOOL(0, "remote-submodules", &option_remote_submodules
,
155 N_("any cloned submodules will use their remote-tracking branch")),
156 OPT_BOOL(0, "sparse", &option_sparse_checkout
,
157 N_("initialize sparse-checkout file to include only files at root")),
161 static const char *get_repo_path_1(struct strbuf
*path
, int *is_bundle
)
163 static char *suffix
[] = { "/.git", "", ".git/.git", ".git" };
164 static char *bundle_suffix
[] = { ".bundle", "" };
165 size_t baselen
= path
->len
;
169 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
170 strbuf_setlen(path
, baselen
);
171 strbuf_addstr(path
, suffix
[i
]);
172 if (stat(path
->buf
, &st
))
174 if (S_ISDIR(st
.st_mode
) && is_git_directory(path
->buf
)) {
177 } else if (S_ISREG(st
.st_mode
) && st
.st_size
> 8) {
178 /* Is it a "gitfile"? */
181 int len
, fd
= open(path
->buf
, O_RDONLY
);
184 len
= read_in_full(fd
, signature
, 8);
186 if (len
!= 8 || strncmp(signature
, "gitdir: ", 8))
188 dst
= read_gitfile(path
->buf
);
196 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
197 strbuf_setlen(path
, baselen
);
198 strbuf_addstr(path
, bundle_suffix
[i
]);
199 if (!stat(path
->buf
, &st
) && S_ISREG(st
.st_mode
)) {
208 static char *get_repo_path(const char *repo
, int *is_bundle
)
210 struct strbuf path
= STRBUF_INIT
;
214 strbuf_addstr(&path
, repo
);
215 raw
= get_repo_path_1(&path
, is_bundle
);
216 canon
= raw
? absolute_pathdup(raw
) : NULL
;
217 strbuf_release(&path
);
221 static int add_one_reference(struct string_list_item
*item
, void *cb_data
)
223 struct strbuf err
= STRBUF_INIT
;
224 int *required
= cb_data
;
225 char *ref_git
= compute_alternate_path(item
->string
, &err
);
232 _("info: Could not add alternate for '%s': %s\n"),
233 item
->string
, err
.buf
);
235 struct strbuf sb
= STRBUF_INIT
;
236 strbuf_addf(&sb
, "%s/objects", ref_git
);
237 add_to_alternates_file(sb
.buf
);
241 strbuf_release(&err
);
246 static void setup_reference(void)
249 for_each_string_list(&option_required_reference
,
250 add_one_reference
, &required
);
252 for_each_string_list(&option_optional_reference
,
253 add_one_reference
, &required
);
256 static void copy_alternates(struct strbuf
*src
, const char *src_repo
)
259 * Read from the source objects/info/alternates file
260 * and copy the entries to corresponding file in the
261 * destination repository with add_to_alternates_file().
262 * Both src and dst have "$path/objects/info/alternates".
264 * Instead of copying bit-for-bit from the original,
265 * we need to append to existing one so that the already
266 * created entry via "clone -s" is not lost, and also
267 * to turn entries with paths relative to the original
268 * absolute, so that they can be used in the new repository.
270 FILE *in
= xfopen(src
->buf
, "r");
271 struct strbuf line
= STRBUF_INIT
;
273 while (strbuf_getline(&line
, in
) != EOF
) {
275 if (!line
.len
|| line
.buf
[0] == '#')
277 if (is_absolute_path(line
.buf
)) {
278 add_to_alternates_file(line
.buf
);
281 abs_path
= mkpathdup("%s/objects/%s", src_repo
, line
.buf
);
282 if (!normalize_path_copy(abs_path
, abs_path
))
283 add_to_alternates_file(abs_path
);
285 warning("skipping invalid relative alternate: %s/%s",
289 strbuf_release(&line
);
293 static void mkdir_if_missing(const char *pathname
, mode_t mode
)
297 if (!mkdir(pathname
, mode
))
301 die_errno(_("failed to create directory '%s'"), pathname
);
302 else if (stat(pathname
, &st
))
303 die_errno(_("failed to stat '%s'"), pathname
);
304 else if (!S_ISDIR(st
.st_mode
))
305 die(_("%s exists and is not a directory"), pathname
);
308 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
,
309 const char *src_repo
)
311 int src_len
, dest_len
;
312 struct dir_iterator
*iter
;
315 struct strbuf realpath
= STRBUF_INIT
;
317 mkdir_if_missing(dest
->buf
, 0777);
319 flags
= DIR_ITERATOR_PEDANTIC
| DIR_ITERATOR_FOLLOW_SYMLINKS
;
320 iter
= dir_iterator_begin(src
->buf
, flags
);
323 die_errno(_("failed to start iterator over '%s'"), src
->buf
);
325 strbuf_addch(src
, '/');
327 strbuf_addch(dest
, '/');
328 dest_len
= dest
->len
;
330 while ((iter_status
= dir_iterator_advance(iter
)) == ITER_OK
) {
331 strbuf_setlen(src
, src_len
);
332 strbuf_addstr(src
, iter
->relative_path
);
333 strbuf_setlen(dest
, dest_len
);
334 strbuf_addstr(dest
, iter
->relative_path
);
336 if (S_ISDIR(iter
->st
.st_mode
)) {
337 mkdir_if_missing(dest
->buf
, 0777);
341 /* Files that cannot be copied bit-for-bit... */
342 if (!fspathcmp(iter
->relative_path
, "info/alternates")) {
343 copy_alternates(src
, src_repo
);
347 if (unlink(dest
->buf
) && errno
!= ENOENT
)
348 die_errno(_("failed to unlink '%s'"), dest
->buf
);
349 if (!option_no_hardlinks
) {
350 strbuf_realpath(&realpath
, src
->buf
, 1);
351 if (!link(realpath
.buf
, dest
->buf
))
353 if (option_local
> 0)
354 die_errno(_("failed to create link '%s'"), dest
->buf
);
355 option_no_hardlinks
= 1;
357 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
358 die_errno(_("failed to copy file to '%s'"), dest
->buf
);
361 if (iter_status
!= ITER_DONE
) {
362 strbuf_setlen(src
, src_len
);
363 die(_("failed to iterate over '%s'"), src
->buf
);
366 strbuf_release(&realpath
);
369 static void clone_local(const char *src_repo
, const char *dest_repo
)
372 struct strbuf alt
= STRBUF_INIT
;
373 get_common_dir(&alt
, src_repo
);
374 strbuf_addstr(&alt
, "/objects");
375 add_to_alternates_file(alt
.buf
);
376 strbuf_release(&alt
);
378 struct strbuf src
= STRBUF_INIT
;
379 struct strbuf dest
= STRBUF_INIT
;
380 get_common_dir(&src
, src_repo
);
381 get_common_dir(&dest
, dest_repo
);
382 strbuf_addstr(&src
, "/objects");
383 strbuf_addstr(&dest
, "/objects");
384 copy_or_link_directory(&src
, &dest
, src_repo
);
385 strbuf_release(&src
);
386 strbuf_release(&dest
);
389 if (0 <= option_verbosity
)
390 fprintf(stderr
, _("done.\n"));
393 static const char *junk_work_tree
;
394 static int junk_work_tree_flags
;
395 static const char *junk_git_dir
;
396 static int junk_git_dir_flags
;
401 } junk_mode
= JUNK_LEAVE_NONE
;
403 static const char junk_leave_repo_msg
[] =
404 N_("Clone succeeded, but checkout failed.\n"
405 "You can inspect what was checked out with 'git status'\n"
406 "and retry with 'git restore --source=HEAD :/'\n");
408 static void remove_junk(void)
410 struct strbuf sb
= STRBUF_INIT
;
413 case JUNK_LEAVE_REPO
:
414 warning("%s", _(junk_leave_repo_msg
));
419 /* proceed to removal */
424 strbuf_addstr(&sb
, junk_git_dir
);
425 remove_dir_recursively(&sb
, junk_git_dir_flags
);
428 if (junk_work_tree
) {
429 strbuf_addstr(&sb
, junk_work_tree
);
430 remove_dir_recursively(&sb
, junk_work_tree_flags
);
435 static void remove_junk_on_signal(int signo
)
442 static struct ref
*find_remote_branch(const struct ref
*refs
, const char *branch
)
445 struct strbuf head
= STRBUF_INIT
;
446 strbuf_addstr(&head
, "refs/heads/");
447 strbuf_addstr(&head
, branch
);
448 ref
= find_ref_by_name(refs
, head
.buf
);
449 strbuf_release(&head
);
454 strbuf_addstr(&head
, "refs/tags/");
455 strbuf_addstr(&head
, branch
);
456 ref
= find_ref_by_name(refs
, head
.buf
);
457 strbuf_release(&head
);
462 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
463 struct refspec
*refspec
)
465 struct ref
*head
= copy_ref(find_ref_by_name(refs
, "HEAD"));
466 struct ref
*local_refs
= head
;
467 struct ref
**tail
= head
? &head
->next
: &local_refs
;
469 if (option_single_branch
) {
470 struct ref
*remote_head
= NULL
;
473 remote_head
= guess_remote_head(head
, refs
, 0);
477 remote_head
= copy_ref(find_remote_branch(refs
, option_branch
));
480 if (!remote_head
&& option_branch
)
481 warning(_("Could not find remote branch %s to clone."),
485 for (i
= 0; i
< refspec
->nr
; i
++)
486 get_fetch_map(remote_head
, &refspec
->items
[i
],
489 /* if --branch=tag, pull the requested tag explicitly */
490 get_fetch_map(remote_head
, tag_refspec
, &tail
, 0);
494 for (i
= 0; i
< refspec
->nr
; i
++)
495 get_fetch_map(refs
, &refspec
->items
[i
], &tail
, 0);
498 if (!option_mirror
&& !option_single_branch
&& !option_no_tags
)
499 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
504 static void write_remote_refs(const struct ref
*local_refs
)
508 struct ref_transaction
*t
;
509 struct strbuf err
= STRBUF_INIT
;
511 t
= ref_transaction_begin(&err
);
515 for (r
= local_refs
; r
; r
= r
->next
) {
518 if (ref_transaction_create(t
, r
->peer_ref
->name
, &r
->old_oid
,
523 if (initial_ref_transaction_commit(t
, &err
))
526 strbuf_release(&err
);
527 ref_transaction_free(t
);
530 static void write_followtags(const struct ref
*refs
, const char *msg
)
532 const struct ref
*ref
;
533 for (ref
= refs
; ref
; ref
= ref
->next
) {
534 if (!starts_with(ref
->name
, "refs/tags/"))
536 if (ends_with(ref
->name
, "^{}"))
538 if (!has_object_file_with_flags(&ref
->old_oid
,
540 OBJECT_INFO_SKIP_FETCH_OBJECT
))
542 update_ref(msg
, ref
->name
, &ref
->old_oid
, NULL
, 0,
543 UPDATE_REFS_DIE_ON_ERR
);
547 static const struct object_id
*iterate_ref_map(void *cb_data
)
549 struct ref
**rm
= cb_data
;
550 struct ref
*ref
= *rm
;
553 * Skip anything missing a peer_ref, which we are not
554 * actually going to write a ref for.
556 while (ref
&& !ref
->peer_ref
)
562 return &ref
->old_oid
;
565 static void update_remote_refs(const struct ref
*refs
,
566 const struct ref
*mapped_refs
,
567 const struct ref
*remote_head_points_at
,
568 const char *branch_top
,
570 struct transport
*transport
,
571 int check_connectivity
)
573 const struct ref
*rm
= mapped_refs
;
575 if (check_connectivity
) {
576 struct check_connected_options opt
= CHECK_CONNECTED_INIT
;
578 opt
.transport
= transport
;
579 opt
.progress
= transport
->progress
;
581 if (check_connected(iterate_ref_map
, &rm
, &opt
))
582 die(_("remote did not send all necessary objects"));
586 write_remote_refs(mapped_refs
);
587 if (option_single_branch
&& !option_no_tags
)
588 write_followtags(refs
, msg
);
591 if (remote_head_points_at
&& !option_bare
) {
592 struct strbuf head_ref
= STRBUF_INIT
;
593 strbuf_addstr(&head_ref
, branch_top
);
594 strbuf_addstr(&head_ref
, "HEAD");
595 if (create_symref(head_ref
.buf
,
596 remote_head_points_at
->peer_ref
->name
,
598 die(_("unable to update %s"), head_ref
.buf
);
599 strbuf_release(&head_ref
);
603 static void update_head(const struct ref
*our
, const struct ref
*remote
,
607 if (our
&& skip_prefix(our
->name
, "refs/heads/", &head
)) {
608 /* Local default branch link */
609 if (create_symref("HEAD", our
->name
, NULL
) < 0)
610 die(_("unable to update HEAD"));
612 update_ref(msg
, "HEAD", &our
->old_oid
, NULL
, 0,
613 UPDATE_REFS_DIE_ON_ERR
);
614 install_branch_config(0, head
, remote_name
, our
->name
);
617 struct commit
*c
= lookup_commit_reference(the_repository
,
619 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
620 update_ref(msg
, "HEAD", &c
->object
.oid
, NULL
, REF_NO_DEREF
,
621 UPDATE_REFS_DIE_ON_ERR
);
624 * We know remote HEAD points to a non-branch, or
625 * HEAD points to a branch but we don't know which one.
626 * Detach HEAD in all these cases.
628 update_ref(msg
, "HEAD", &remote
->old_oid
, NULL
, REF_NO_DEREF
,
629 UPDATE_REFS_DIE_ON_ERR
);
633 static int git_sparse_checkout_init(const char *repo
)
635 struct strvec argv
= STRVEC_INIT
;
637 strvec_pushl(&argv
, "-C", repo
, "sparse-checkout", "set", NULL
);
640 * We must apply the setting in the current process
641 * for the later checkout to use the sparse-checkout file.
643 core_apply_sparse_checkout
= 1;
645 if (run_command_v_opt(argv
.v
, RUN_GIT_CMD
)) {
646 error(_("failed to initialize sparse-checkout"));
654 static int checkout(int submodule_progress
)
656 struct object_id oid
;
658 struct lock_file lock_file
= LOCK_INIT
;
659 struct unpack_trees_options opts
;
664 if (option_no_checkout
)
667 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, &oid
, NULL
);
669 warning(_("remote HEAD refers to nonexistent ref, "
670 "unable to checkout.\n"));
673 if (!strcmp(head
, "HEAD")) {
674 if (advice_enabled(ADVICE_DETACHED_HEAD
))
675 detach_advice(oid_to_hex(&oid
));
678 if (!starts_with(head
, "refs/heads/"))
679 die(_("HEAD not found below refs/heads!"));
682 /* We need to be in the new work tree for the checkout */
685 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
687 memset(&opts
, 0, sizeof opts
);
691 opts
.preserve_ignored
= 0;
692 opts
.fn
= oneway_merge
;
693 opts
.verbose_update
= (option_verbosity
>= 0);
694 opts
.src_index
= &the_index
;
695 opts
.dst_index
= &the_index
;
696 init_checkout_metadata(&opts
.meta
, head
, &oid
, NULL
);
698 tree
= parse_tree_indirect(&oid
);
700 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
701 if (unpack_trees(1, &t
, &opts
) < 0)
702 die(_("unable to checkout working tree"));
706 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
707 die(_("unable to write new index file"));
709 err
|= run_hooks_l("post-checkout", oid_to_hex(null_oid()),
710 oid_to_hex(&oid
), "1", NULL
);
712 if (!err
&& (option_recurse_submodules
.nr
> 0)) {
713 struct strvec args
= STRVEC_INIT
;
714 strvec_pushl(&args
, "submodule", "update", "--require-init", "--recursive", NULL
);
716 if (option_shallow_submodules
== 1)
717 strvec_push(&args
, "--depth=1");
720 strvec_pushf(&args
, "--jobs=%d", max_jobs
);
722 if (submodule_progress
)
723 strvec_push(&args
, "--progress");
725 if (option_verbosity
< 0)
726 strvec_push(&args
, "--quiet");
728 if (option_remote_submodules
) {
729 strvec_push(&args
, "--remote");
730 strvec_push(&args
, "--no-fetch");
733 if (option_single_branch
>= 0)
734 strvec_push(&args
, option_single_branch
?
736 "--no-single-branch");
738 err
= run_command_v_opt(args
.v
, RUN_GIT_CMD
);
745 static int git_clone_config(const char *k
, const char *v
, void *cb
)
747 if (!strcmp(k
, "clone.defaultremotename")) {
749 remote_name
= xstrdup(v
);
751 if (!strcmp(k
, "clone.rejectshallow"))
752 config_reject_shallow
= git_config_bool(k
, v
);
754 return git_default_config(k
, v
, cb
);
757 static int write_one_config(const char *key
, const char *value
, void *data
)
760 * give git_clone_config a chance to write config values back to the
761 * environment, since git_config_set_multivar_gently only deals with
764 int apply_failed
= git_clone_config(key
, value
, data
);
768 return git_config_set_multivar_gently(key
,
769 value
? value
: "true",
770 CONFIG_REGEX_NONE
, 0);
773 static void write_config(struct string_list
*config
)
777 for (i
= 0; i
< config
->nr
; i
++) {
778 if (git_config_parse_parameter(config
->items
[i
].string
,
779 write_one_config
, NULL
) < 0)
780 die(_("unable to write parameters to config file"));
784 static void write_refspec_config(const char *src_ref_prefix
,
785 const struct ref
*our_head_points_at
,
786 const struct ref
*remote_head_points_at
,
787 struct strbuf
*branch_top
)
789 struct strbuf key
= STRBUF_INIT
;
790 struct strbuf value
= STRBUF_INIT
;
792 if (option_mirror
|| !option_bare
) {
793 if (option_single_branch
&& !option_mirror
) {
795 if (starts_with(our_head_points_at
->name
, "refs/tags/"))
796 strbuf_addf(&value
, "+%s:%s", our_head_points_at
->name
,
797 our_head_points_at
->name
);
799 strbuf_addf(&value
, "+%s:%s%s", our_head_points_at
->name
,
800 branch_top
->buf
, option_branch
);
801 } else if (remote_head_points_at
) {
802 const char *head
= remote_head_points_at
->name
;
803 if (!skip_prefix(head
, "refs/heads/", &head
))
804 BUG("remote HEAD points at non-head?");
806 strbuf_addf(&value
, "+%s:%s%s", remote_head_points_at
->name
,
807 branch_top
->buf
, head
);
810 * otherwise, the next "git fetch" will
811 * simply fetch from HEAD without updating
812 * any remote-tracking branch, which is what
816 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
->buf
);
818 /* Configure the remote */
820 strbuf_addf(&key
, "remote.%s.fetch", remote_name
);
821 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
825 strbuf_addf(&key
, "remote.%s.mirror", remote_name
);
826 git_config_set(key
.buf
, "true");
832 strbuf_release(&key
);
833 strbuf_release(&value
);
836 static void dissociate_from_references(void)
838 static const char* argv
[] = { "repack", "-a", "-d", NULL
};
839 char *alternates
= git_pathdup("objects/info/alternates");
841 if (!access(alternates
, F_OK
)) {
842 if (run_command_v_opt(argv
, RUN_GIT_CMD
|RUN_COMMAND_NO_STDIN
))
843 die(_("cannot repack to clean up"));
844 if (unlink(alternates
) && errno
!= ENOENT
)
845 die_errno(_("cannot unlink temporary alternates file"));
850 static int path_exists(const char *path
)
853 return !stat(path
, &sb
);
856 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
858 int is_bundle
= 0, is_local
;
859 int reject_shallow
= 0;
860 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
861 char *path
= NULL
, *dir
, *display_repo
= NULL
;
862 int dest_exists
, real_dest_exists
= 0;
863 const struct ref
*refs
, *remote_head
;
864 struct ref
*remote_head_points_at
= NULL
;
865 const struct ref
*our_head_points_at
;
866 struct ref
*mapped_refs
= NULL
;
867 const struct ref
*ref
;
868 struct strbuf key
= STRBUF_INIT
;
869 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
870 struct transport
*transport
= NULL
;
871 const char *src_ref_prefix
= "refs/heads/";
872 struct remote
*remote
;
873 int err
= 0, complete_refs_before_fetch
= 1;
874 int submodule_progress
;
876 struct transport_ls_refs_options transport_ls_refs_options
=
877 TRANSPORT_LS_REFS_OPTIONS_INIT
;
879 packet_trace_identity("clone");
881 git_config(git_clone_config
, NULL
);
883 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
884 builtin_clone_usage
, 0);
887 usage_msg_opt(_("Too many arguments."),
888 builtin_clone_usage
, builtin_clone_options
);
891 usage_msg_opt(_("You must specify a repository to clone."),
892 builtin_clone_usage
, builtin_clone_options
);
894 if (option_depth
|| option_since
|| option_not
.nr
)
896 if (option_single_branch
== -1)
897 option_single_branch
= deepen
? 1 : 0;
904 die(_("options '%s' and '%s %s' cannot be used together"),
905 "--bare", "--origin", option_origin
);
907 die(_("options '%s' and '%s' cannot be used together"), "--bare", "--separate-git-dir");
908 option_no_checkout
= 1;
913 path
= get_repo_path(repo_name
, &is_bundle
);
916 repo
= absolute_pathdup(repo_name
);
917 } else if (strchr(repo_name
, ':')) {
919 display_repo
= transport_anonymize_url(repo
);
921 die(_("repository '%s' does not exist"), repo_name
);
923 /* no need to be strict, transport_set_option() will validate it again */
924 if (option_depth
&& atoi(option_depth
) < 1)
925 die(_("depth %s is not a positive number"), option_depth
);
928 dir
= xstrdup(argv
[1]);
930 dir
= git_url_basename(repo_name
, is_bundle
, option_bare
);
931 strip_dir_trailing_slashes(dir
);
933 dest_exists
= path_exists(dir
);
934 if (dest_exists
&& !is_empty_dir(dir
))
935 die(_("destination path '%s' already exists and is not "
936 "an empty directory."), dir
);
939 real_dest_exists
= path_exists(real_git_dir
);
940 if (real_dest_exists
&& !is_empty_dir(real_git_dir
))
941 die(_("repository path '%s' already exists and is not "
942 "an empty directory."), real_git_dir
);
946 strbuf_addf(&reflog_msg
, "clone: from %s",
947 display_repo
? display_repo
: repo
);
953 work_tree
= getenv("GIT_WORK_TREE");
954 if (work_tree
&& path_exists(work_tree
))
955 die(_("working tree '%s' already exists."), work_tree
);
958 if (option_bare
|| work_tree
)
959 git_dir
= xstrdup(dir
);
962 git_dir
= mkpathdup("%s/.git", dir
);
966 sigchain_push_common(remove_junk_on_signal
);
969 if (safe_create_leading_directories_const(work_tree
) < 0)
970 die_errno(_("could not create leading directories of '%s'"),
973 junk_work_tree_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
974 else if (mkdir(work_tree
, 0777))
975 die_errno(_("could not create work tree dir '%s'"),
977 junk_work_tree
= work_tree
;
978 set_git_work_tree(work_tree
);
982 if (real_dest_exists
)
983 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
984 junk_git_dir
= real_git_dir
;
987 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
988 junk_git_dir
= git_dir
;
990 if (safe_create_leading_directories_const(git_dir
) < 0)
991 die(_("could not create leading directories of '%s'"), git_dir
);
993 if (0 <= option_verbosity
) {
995 fprintf(stderr
, _("Cloning into bare repository '%s'...\n"), dir
);
997 fprintf(stderr
, _("Cloning into '%s'...\n"), dir
);
1000 if (option_recurse_submodules
.nr
> 0) {
1001 struct string_list_item
*item
;
1002 struct strbuf sb
= STRBUF_INIT
;
1005 /* remove duplicates */
1006 string_list_sort(&option_recurse_submodules
);
1007 string_list_remove_duplicates(&option_recurse_submodules
, 0);
1010 * NEEDSWORK: In a multi-working-tree world, this needs to be
1011 * set in the per-worktree config.
1013 for_each_string_list_item(item
, &option_recurse_submodules
) {
1014 strbuf_addf(&sb
, "submodule.active=%s",
1016 string_list_append(&option_config
,
1017 strbuf_detach(&sb
, NULL
));
1020 if (!git_config_get_bool("submodule.stickyRecursiveClone", &val
) &&
1022 string_list_append(&option_config
, "submodule.recurse=true");
1024 if (option_required_reference
.nr
&&
1025 option_optional_reference
.nr
)
1026 die(_("clone --recursive is not compatible with "
1027 "both --reference and --reference-if-able"));
1028 else if (option_required_reference
.nr
) {
1029 string_list_append(&option_config
,
1030 "submodule.alternateLocation=superproject");
1031 string_list_append(&option_config
,
1032 "submodule.alternateErrorStrategy=die");
1033 } else if (option_optional_reference
.nr
) {
1034 string_list_append(&option_config
,
1035 "submodule.alternateLocation=superproject");
1036 string_list_append(&option_config
,
1037 "submodule.alternateErrorStrategy=info");
1041 init_db(git_dir
, real_git_dir
, option_template
, GIT_HASH_UNKNOWN
, NULL
,
1045 free((char *)git_dir
);
1046 git_dir
= real_git_dir
;
1050 * additional config can be injected with -c, make sure it's included
1051 * after init_db, which clears the entire config environment.
1053 write_config(&option_config
);
1056 * re-read config after init_db and write_config to pick up any config
1057 * injected by --template and --config, respectively.
1059 git_config(git_clone_config
, NULL
);
1062 * If option_reject_shallow is specified from CLI option,
1063 * ignore config_reject_shallow from git_clone_config.
1065 if (config_reject_shallow
!= -1)
1066 reject_shallow
= config_reject_shallow
;
1067 if (option_reject_shallow
!= -1)
1068 reject_shallow
= option_reject_shallow
;
1071 * apply the remote name provided by --origin only after this second
1072 * call to git_config, to ensure it overrides all config-based values.
1074 if (option_origin
!= NULL
)
1075 remote_name
= xstrdup(option_origin
);
1077 if (remote_name
== NULL
)
1078 remote_name
= xstrdup("origin");
1080 if (!valid_remote_name(remote_name
))
1081 die(_("'%s' is not a valid remote name"), remote_name
);
1085 src_ref_prefix
= "refs/";
1086 strbuf_addstr(&branch_top
, src_ref_prefix
);
1088 git_config_set("core.bare", "true");
1090 strbuf_addf(&branch_top
, "refs/remotes/%s/", remote_name
);
1093 strbuf_addf(&key
, "remote.%s.url", remote_name
);
1094 git_config_set(key
.buf
, repo
);
1097 if (option_no_tags
) {
1098 strbuf_addf(&key
, "remote.%s.tagOpt", remote_name
);
1099 git_config_set(key
.buf
, "--no-tags");
1103 if (option_required_reference
.nr
|| option_optional_reference
.nr
)
1106 if (option_sparse_checkout
&& git_sparse_checkout_init(dir
))
1109 remote
= remote_get(remote_name
);
1111 refspec_appendf(&remote
->fetch
, "+%s*:%s*", src_ref_prefix
,
1114 transport
= transport_get(remote
, remote
->url
[0]);
1115 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
1116 transport
->family
= family
;
1118 path
= get_repo_path(remote
->url
[0], &is_bundle
);
1119 is_local
= option_local
!= 0 && path
&& !is_bundle
;
1122 warning(_("--depth is ignored in local clones; use file:// instead."));
1124 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1126 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1127 if (filter_options
.choice
)
1128 warning(_("--filter is ignored in local clones; use file:// instead."));
1129 if (!access(mkpath("%s/shallow", path
), F_OK
)) {
1131 die(_("source repository is shallow, reject to clone."));
1132 if (option_local
> 0)
1133 warning(_("source repository is shallow, ignoring --local"));
1137 if (option_local
> 0 && !is_local
)
1138 warning(_("--local is ignored"));
1139 transport
->cloning
= 1;
1141 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
1144 transport_set_option(transport
, TRANS_OPT_REJECT_SHALLOW
, "1");
1146 transport_set_option(transport
, TRANS_OPT_DEPTH
,
1149 transport_set_option(transport
, TRANS_OPT_DEEPEN_SINCE
,
1152 transport_set_option(transport
, TRANS_OPT_DEEPEN_NOT
,
1153 (const char *)&option_not
);
1154 if (option_single_branch
)
1155 transport_set_option(transport
, TRANS_OPT_FOLLOWTAGS
, "1");
1157 if (option_upload_pack
)
1158 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
1159 option_upload_pack
);
1161 if (server_options
.nr
)
1162 transport
->server_options
= &server_options
;
1164 if (filter_options
.choice
) {
1166 expand_list_objects_filter_spec(&filter_options
);
1167 transport_set_option(transport
, TRANS_OPT_LIST_OBJECTS_FILTER
,
1169 transport_set_option(transport
, TRANS_OPT_FROM_PROMISOR
, "1");
1172 if (transport
->smart_options
&& !deepen
&& !filter_options
.choice
)
1173 transport
->smart_options
->check_self_contained_and_connected
= 1;
1176 strvec_push(&transport_ls_refs_options
.ref_prefixes
, "HEAD");
1177 refspec_ref_prefixes(&remote
->fetch
,
1178 &transport_ls_refs_options
.ref_prefixes
);
1180 expand_ref_prefix(&transport_ls_refs_options
.ref_prefixes
,
1182 if (!option_no_tags
)
1183 strvec_push(&transport_ls_refs_options
.ref_prefixes
,
1186 refs
= transport_get_remote_refs(transport
, &transport_ls_refs_options
);
1189 mapped_refs
= wanted_peer_refs(refs
, &remote
->fetch
);
1192 int hash_algo
= hash_algo_by_ptr(transport_get_hash_algo(transport
));
1195 * Now that we know what algorithm the remote side is using,
1196 * let's set ours to the same thing.
1198 initialize_repository_version(hash_algo
, 1);
1199 repo_set_hash_algo(the_repository
, hash_algo
);
1201 * transport_get_remote_refs() may return refs with null sha-1
1202 * in mapped_refs (see struct transport->get_refs_list
1203 * comment). In that case we need fetch it early because
1204 * remote_head code below relies on it.
1206 * for normal clones, transport_get_remote_refs() should
1207 * return reliable ref set, we can delay cloning until after
1208 * remote HEAD check.
1210 for (ref
= refs
; ref
; ref
= ref
->next
)
1211 if (is_null_oid(&ref
->old_oid
)) {
1212 complete_refs_before_fetch
= 0;
1216 if (!is_local
&& !complete_refs_before_fetch
) {
1217 if (transport_fetch_refs(transport
, mapped_refs
))
1218 die(_("remote transport reported error"));
1221 remote_head
= find_ref_by_name(refs
, "HEAD");
1222 remote_head_points_at
=
1223 guess_remote_head(remote_head
, mapped_refs
, 0);
1225 if (option_branch
) {
1226 our_head_points_at
=
1227 find_remote_branch(mapped_refs
, option_branch
);
1229 if (!our_head_points_at
)
1230 die(_("Remote branch %s not found in upstream %s"),
1231 option_branch
, remote_name
);
1234 our_head_points_at
= remote_head_points_at
;
1241 die(_("Remote branch %s not found in upstream %s"),
1242 option_branch
, remote_name
);
1244 warning(_("You appear to have cloned an empty repository."));
1245 our_head_points_at
= NULL
;
1246 remote_head_points_at
= NULL
;
1248 option_no_checkout
= 1;
1250 if (transport_ls_refs_options
.unborn_head_target
&&
1251 skip_prefix(transport_ls_refs_options
.unborn_head_target
,
1252 "refs/heads/", &branch
)) {
1253 ref
= transport_ls_refs_options
.unborn_head_target
;
1254 transport_ls_refs_options
.unborn_head_target
= NULL
;
1255 create_symref("HEAD", ref
, reflog_msg
.buf
);
1257 branch
= git_default_branch_name(0);
1258 ref
= xstrfmt("refs/heads/%s", branch
);
1262 install_branch_config(0, branch
, remote_name
, ref
);
1267 write_refspec_config(src_ref_prefix
, our_head_points_at
,
1268 remote_head_points_at
, &branch_top
);
1270 if (filter_options
.choice
)
1271 partial_clone_register(remote_name
, &filter_options
);
1274 clone_local(path
, git_dir
);
1275 else if (mapped_refs
&& complete_refs_before_fetch
) {
1276 if (transport_fetch_refs(transport
, mapped_refs
))
1277 die(_("remote transport reported error"));
1280 update_remote_refs(refs
, mapped_refs
, remote_head_points_at
,
1281 branch_top
.buf
, reflog_msg
.buf
, transport
,
1284 update_head(our_head_points_at
, remote_head
, reflog_msg
.buf
);
1287 * We want to show progress for recursive submodule clones iff
1288 * we did so for the main clone. But only the transport knows
1289 * the final decision for this flag, so we need to rescue the value
1290 * before we free the transport.
1292 submodule_progress
= transport
->progress
;
1294 transport_unlock_pack(transport
, 0);
1295 transport_disconnect(transport
);
1297 if (option_dissociate
) {
1298 close_object_store(the_repository
->objects
);
1299 dissociate_from_references();
1302 junk_mode
= JUNK_LEAVE_REPO
;
1303 err
= checkout(submodule_progress
);
1306 strbuf_release(&reflog_msg
);
1307 strbuf_release(&branch_top
);
1308 strbuf_release(&key
);
1309 free_refs(mapped_refs
);
1310 free_refs(remote_head_points_at
);
1314 junk_mode
= JUNK_LEAVE_ALL
;
1316 strvec_clear(&transport_ls_refs_options
.ref_prefixes
);
1317 free(transport_ls_refs_options
.unborn_head_target
);