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"
38 * - respect DB_ENVIRONMENT for .git/objects.
40 * Implementation notes:
41 * - dropping use-separate-remote and no-separate-remote compatibility
44 static const char * const builtin_clone_usage
[] = {
45 N_("git clone [<options>] [--] <repo> [<dir>]"),
49 static int option_no_checkout
, option_bare
, option_mirror
, option_single_branch
= -1;
50 static int option_local
= -1, option_no_hardlinks
, option_shared
;
51 static int option_no_tags
;
52 static int option_shallow_submodules
;
53 static int option_reject_shallow
= -1; /* unspecified */
54 static int config_reject_shallow
= -1; /* unspecified */
56 static char *option_template
, *option_depth
, *option_since
;
57 static char *option_origin
= NULL
;
58 static char *remote_name
= NULL
;
59 static char *option_branch
= NULL
;
60 static struct string_list option_not
= STRING_LIST_INIT_NODUP
;
61 static const char *real_git_dir
;
62 static char *option_upload_pack
= "git-upload-pack";
63 static int option_verbosity
;
64 static int option_progress
= -1;
65 static int option_sparse_checkout
;
66 static enum transport_family family
;
67 static struct string_list option_config
= STRING_LIST_INIT_NODUP
;
68 static struct string_list option_required_reference
= STRING_LIST_INIT_NODUP
;
69 static struct string_list option_optional_reference
= STRING_LIST_INIT_NODUP
;
70 static int option_dissociate
;
71 static int max_jobs
= -1;
72 static struct string_list option_recurse_submodules
= STRING_LIST_INIT_NODUP
;
73 static struct list_objects_filter_options filter_options
;
74 static struct string_list server_options
= STRING_LIST_INIT_NODUP
;
75 static int option_remote_submodules
;
77 static int recurse_submodules_cb(const struct option
*opt
,
78 const char *arg
, int unset
)
81 string_list_clear((struct string_list
*)opt
->value
, 0);
83 string_list_append((struct string_list
*)opt
->value
, arg
);
85 string_list_append((struct string_list
*)opt
->value
,
86 (const char *)opt
->defval
);
91 static struct option builtin_clone_options
[] = {
92 OPT__VERBOSITY(&option_verbosity
),
93 OPT_BOOL(0, "progress", &option_progress
,
94 N_("force progress reporting")),
95 OPT_BOOL(0, "reject-shallow", &option_reject_shallow
,
96 N_("don't clone shallow repository")),
97 OPT_BOOL('n', "no-checkout", &option_no_checkout
,
98 N_("don't create a checkout")),
99 OPT_BOOL(0, "bare", &option_bare
, N_("create a bare repository")),
100 OPT_HIDDEN_BOOL(0, "naked", &option_bare
,
101 N_("create a bare repository")),
102 OPT_BOOL(0, "mirror", &option_mirror
,
103 N_("create a mirror repository (implies bare)")),
104 OPT_BOOL('l', "local", &option_local
,
105 N_("to clone from a local repository")),
106 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks
,
107 N_("don't use local hardlinks, always copy")),
108 OPT_BOOL('s', "shared", &option_shared
,
109 N_("setup as shared repository")),
110 { OPTION_CALLBACK
, 0, "recurse-submodules", &option_recurse_submodules
,
111 N_("pathspec"), N_("initialize submodules in the clone"),
112 PARSE_OPT_OPTARG
, recurse_submodules_cb
, (intptr_t)"." },
113 OPT_ALIAS(0, "recursive", "recurse-submodules"),
114 OPT_INTEGER('j', "jobs", &max_jobs
,
115 N_("number of submodules cloned in parallel")),
116 OPT_STRING(0, "template", &option_template
, N_("template-directory"),
117 N_("directory from which templates will be used")),
118 OPT_STRING_LIST(0, "reference", &option_required_reference
, N_("repo"),
119 N_("reference repository")),
120 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference
,
121 N_("repo"), N_("reference repository")),
122 OPT_BOOL(0, "dissociate", &option_dissociate
,
123 N_("use --reference only while cloning")),
124 OPT_STRING('o', "origin", &option_origin
, N_("name"),
125 N_("use <name> instead of 'origin' to track upstream")),
126 OPT_STRING('b', "branch", &option_branch
, N_("branch"),
127 N_("checkout <branch> instead of the remote's HEAD")),
128 OPT_STRING('u', "upload-pack", &option_upload_pack
, N_("path"),
129 N_("path to git-upload-pack on the remote")),
130 OPT_STRING(0, "depth", &option_depth
, N_("depth"),
131 N_("create a shallow clone of that depth")),
132 OPT_STRING(0, "shallow-since", &option_since
, N_("time"),
133 N_("create a shallow clone since a specific time")),
134 OPT_STRING_LIST(0, "shallow-exclude", &option_not
, N_("revision"),
135 N_("deepen history of shallow clone, excluding rev")),
136 OPT_BOOL(0, "single-branch", &option_single_branch
,
137 N_("clone only one branch, HEAD or --branch")),
138 OPT_BOOL(0, "no-tags", &option_no_tags
,
139 N_("don't clone any tags, and make later fetches not to follow them")),
140 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules
,
141 N_("any cloned submodules will be shallow")),
142 OPT_STRING(0, "separate-git-dir", &real_git_dir
, N_("gitdir"),
143 N_("separate git dir from working tree")),
144 OPT_STRING_LIST('c', "config", &option_config
, N_("key=value"),
145 N_("set config inside the new repository")),
146 OPT_STRING_LIST(0, "server-option", &server_options
,
147 N_("server-specific"), N_("option to transmit")),
148 OPT_SET_INT('4', "ipv4", &family
, N_("use IPv4 addresses only"),
149 TRANSPORT_FAMILY_IPV4
),
150 OPT_SET_INT('6', "ipv6", &family
, N_("use IPv6 addresses only"),
151 TRANSPORT_FAMILY_IPV6
),
152 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
153 OPT_BOOL(0, "remote-submodules", &option_remote_submodules
,
154 N_("any cloned submodules will use their remote-tracking branch")),
155 OPT_BOOL(0, "sparse", &option_sparse_checkout
,
156 N_("initialize sparse-checkout file to include only files at root")),
160 static const char *get_repo_path_1(struct strbuf
*path
, int *is_bundle
)
162 static char *suffix
[] = { "/.git", "", ".git/.git", ".git" };
163 static char *bundle_suffix
[] = { ".bundle", "" };
164 size_t baselen
= path
->len
;
168 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
169 strbuf_setlen(path
, baselen
);
170 strbuf_addstr(path
, suffix
[i
]);
171 if (stat(path
->buf
, &st
))
173 if (S_ISDIR(st
.st_mode
) && is_git_directory(path
->buf
)) {
176 } else if (S_ISREG(st
.st_mode
) && st
.st_size
> 8) {
177 /* Is it a "gitfile"? */
180 int len
, fd
= open(path
->buf
, O_RDONLY
);
183 len
= read_in_full(fd
, signature
, 8);
185 if (len
!= 8 || strncmp(signature
, "gitdir: ", 8))
187 dst
= read_gitfile(path
->buf
);
195 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
196 strbuf_setlen(path
, baselen
);
197 strbuf_addstr(path
, bundle_suffix
[i
]);
198 if (!stat(path
->buf
, &st
) && S_ISREG(st
.st_mode
)) {
207 static char *get_repo_path(const char *repo
, int *is_bundle
)
209 struct strbuf path
= STRBUF_INIT
;
213 strbuf_addstr(&path
, repo
);
214 raw
= get_repo_path_1(&path
, is_bundle
);
215 canon
= raw
? absolute_pathdup(raw
) : NULL
;
216 strbuf_release(&path
);
220 static int add_one_reference(struct string_list_item
*item
, void *cb_data
)
222 struct strbuf err
= STRBUF_INIT
;
223 int *required
= cb_data
;
224 char *ref_git
= compute_alternate_path(item
->string
, &err
);
231 _("info: Could not add alternate for '%s': %s\n"),
232 item
->string
, err
.buf
);
234 struct strbuf sb
= STRBUF_INIT
;
235 strbuf_addf(&sb
, "%s/objects", ref_git
);
236 add_to_alternates_file(sb
.buf
);
240 strbuf_release(&err
);
245 static void setup_reference(void)
248 for_each_string_list(&option_required_reference
,
249 add_one_reference
, &required
);
251 for_each_string_list(&option_optional_reference
,
252 add_one_reference
, &required
);
255 static void copy_alternates(struct strbuf
*src
, const char *src_repo
)
258 * Read from the source objects/info/alternates file
259 * and copy the entries to corresponding file in the
260 * destination repository with add_to_alternates_file().
261 * Both src and dst have "$path/objects/info/alternates".
263 * Instead of copying bit-for-bit from the original,
264 * we need to append to existing one so that the already
265 * created entry via "clone -s" is not lost, and also
266 * to turn entries with paths relative to the original
267 * absolute, so that they can be used in the new repository.
269 FILE *in
= xfopen(src
->buf
, "r");
270 struct strbuf line
= STRBUF_INIT
;
272 while (strbuf_getline(&line
, in
) != EOF
) {
274 if (!line
.len
|| line
.buf
[0] == '#')
276 if (is_absolute_path(line
.buf
)) {
277 add_to_alternates_file(line
.buf
);
280 abs_path
= mkpathdup("%s/objects/%s", src_repo
, line
.buf
);
281 if (!normalize_path_copy(abs_path
, abs_path
))
282 add_to_alternates_file(abs_path
);
284 warning("skipping invalid relative alternate: %s/%s",
288 strbuf_release(&line
);
292 static void mkdir_if_missing(const char *pathname
, mode_t mode
)
296 if (!mkdir(pathname
, mode
))
300 die_errno(_("failed to create directory '%s'"), pathname
);
301 else if (stat(pathname
, &st
))
302 die_errno(_("failed to stat '%s'"), pathname
);
303 else if (!S_ISDIR(st
.st_mode
))
304 die(_("%s exists and is not a directory"), pathname
);
307 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
,
308 const char *src_repo
)
310 int src_len
, dest_len
;
311 struct dir_iterator
*iter
;
314 struct strbuf realpath
= STRBUF_INIT
;
316 mkdir_if_missing(dest
->buf
, 0777);
318 flags
= DIR_ITERATOR_PEDANTIC
| DIR_ITERATOR_FOLLOW_SYMLINKS
;
319 iter
= dir_iterator_begin(src
->buf
, flags
);
322 die_errno(_("failed to start iterator over '%s'"), src
->buf
);
324 strbuf_addch(src
, '/');
326 strbuf_addch(dest
, '/');
327 dest_len
= dest
->len
;
329 while ((iter_status
= dir_iterator_advance(iter
)) == ITER_OK
) {
330 strbuf_setlen(src
, src_len
);
331 strbuf_addstr(src
, iter
->relative_path
);
332 strbuf_setlen(dest
, dest_len
);
333 strbuf_addstr(dest
, iter
->relative_path
);
335 if (S_ISDIR(iter
->st
.st_mode
)) {
336 mkdir_if_missing(dest
->buf
, 0777);
340 /* Files that cannot be copied bit-for-bit... */
341 if (!fspathcmp(iter
->relative_path
, "info/alternates")) {
342 copy_alternates(src
, src_repo
);
346 if (unlink(dest
->buf
) && errno
!= ENOENT
)
347 die_errno(_("failed to unlink '%s'"), dest
->buf
);
348 if (!option_no_hardlinks
) {
349 strbuf_realpath(&realpath
, src
->buf
, 1);
350 if (!link(realpath
.buf
, dest
->buf
))
352 if (option_local
> 0)
353 die_errno(_("failed to create link '%s'"), dest
->buf
);
354 option_no_hardlinks
= 1;
356 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
357 die_errno(_("failed to copy file to '%s'"), dest
->buf
);
360 if (iter_status
!= ITER_DONE
) {
361 strbuf_setlen(src
, src_len
);
362 die(_("failed to iterate over '%s'"), src
->buf
);
365 strbuf_release(&realpath
);
368 static void clone_local(const char *src_repo
, const char *dest_repo
)
371 struct strbuf alt
= STRBUF_INIT
;
372 get_common_dir(&alt
, src_repo
);
373 strbuf_addstr(&alt
, "/objects");
374 add_to_alternates_file(alt
.buf
);
375 strbuf_release(&alt
);
377 struct strbuf src
= STRBUF_INIT
;
378 struct strbuf dest
= STRBUF_INIT
;
379 get_common_dir(&src
, src_repo
);
380 get_common_dir(&dest
, dest_repo
);
381 strbuf_addstr(&src
, "/objects");
382 strbuf_addstr(&dest
, "/objects");
383 copy_or_link_directory(&src
, &dest
, src_repo
);
384 strbuf_release(&src
);
385 strbuf_release(&dest
);
388 if (0 <= option_verbosity
)
389 fprintf(stderr
, _("done.\n"));
392 static const char *junk_work_tree
;
393 static int junk_work_tree_flags
;
394 static const char *junk_git_dir
;
395 static int junk_git_dir_flags
;
400 } junk_mode
= JUNK_LEAVE_NONE
;
402 static const char junk_leave_repo_msg
[] =
403 N_("Clone succeeded, but checkout failed.\n"
404 "You can inspect what was checked out with 'git status'\n"
405 "and retry with 'git restore --source=HEAD :/'\n");
407 static void remove_junk(void)
409 struct strbuf sb
= STRBUF_INIT
;
412 case JUNK_LEAVE_REPO
:
413 warning("%s", _(junk_leave_repo_msg
));
418 /* proceed to removal */
423 strbuf_addstr(&sb
, junk_git_dir
);
424 remove_dir_recursively(&sb
, junk_git_dir_flags
);
427 if (junk_work_tree
) {
428 strbuf_addstr(&sb
, junk_work_tree
);
429 remove_dir_recursively(&sb
, junk_work_tree_flags
);
434 static void remove_junk_on_signal(int signo
)
441 static struct ref
*find_remote_branch(const struct ref
*refs
, const char *branch
)
444 struct strbuf head
= STRBUF_INIT
;
445 strbuf_addstr(&head
, "refs/heads/");
446 strbuf_addstr(&head
, branch
);
447 ref
= find_ref_by_name(refs
, head
.buf
);
448 strbuf_release(&head
);
453 strbuf_addstr(&head
, "refs/tags/");
454 strbuf_addstr(&head
, branch
);
455 ref
= find_ref_by_name(refs
, head
.buf
);
456 strbuf_release(&head
);
461 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
462 struct refspec
*refspec
)
464 struct ref
*head
= copy_ref(find_ref_by_name(refs
, "HEAD"));
465 struct ref
*local_refs
= head
;
466 struct ref
**tail
= head
? &head
->next
: &local_refs
;
468 if (option_single_branch
) {
469 struct ref
*remote_head
= NULL
;
472 remote_head
= guess_remote_head(head
, refs
, 0);
476 remote_head
= copy_ref(find_remote_branch(refs
, option_branch
));
479 if (!remote_head
&& option_branch
)
480 warning(_("Could not find remote branch %s to clone."),
484 for (i
= 0; i
< refspec
->nr
; i
++)
485 get_fetch_map(remote_head
, &refspec
->items
[i
],
488 /* if --branch=tag, pull the requested tag explicitly */
489 get_fetch_map(remote_head
, tag_refspec
, &tail
, 0);
493 for (i
= 0; i
< refspec
->nr
; i
++)
494 get_fetch_map(refs
, &refspec
->items
[i
], &tail
, 0);
497 if (!option_mirror
&& !option_single_branch
&& !option_no_tags
)
498 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
503 static void write_remote_refs(const struct ref
*local_refs
)
507 struct ref_transaction
*t
;
508 struct strbuf err
= STRBUF_INIT
;
510 t
= ref_transaction_begin(&err
);
514 for (r
= local_refs
; r
; r
= r
->next
) {
517 if (ref_transaction_create(t
, r
->peer_ref
->name
, &r
->old_oid
,
522 if (initial_ref_transaction_commit(t
, &err
))
525 strbuf_release(&err
);
526 ref_transaction_free(t
);
529 static void write_followtags(const struct ref
*refs
, const char *msg
)
531 const struct ref
*ref
;
532 for (ref
= refs
; ref
; ref
= ref
->next
) {
533 if (!starts_with(ref
->name
, "refs/tags/"))
535 if (ends_with(ref
->name
, "^{}"))
537 if (!has_object_file_with_flags(&ref
->old_oid
,
539 OBJECT_INFO_SKIP_FETCH_OBJECT
))
541 update_ref(msg
, ref
->name
, &ref
->old_oid
, NULL
, 0,
542 UPDATE_REFS_DIE_ON_ERR
);
546 static const struct object_id
*iterate_ref_map(void *cb_data
)
548 struct ref
**rm
= cb_data
;
549 struct ref
*ref
= *rm
;
552 * Skip anything missing a peer_ref, which we are not
553 * actually going to write a ref for.
555 while (ref
&& !ref
->peer_ref
)
561 return &ref
->old_oid
;
564 static void update_remote_refs(const struct ref
*refs
,
565 const struct ref
*mapped_refs
,
566 const struct ref
*remote_head_points_at
,
567 const char *branch_top
,
569 struct transport
*transport
,
570 int check_connectivity
)
572 const struct ref
*rm
= mapped_refs
;
574 if (check_connectivity
) {
575 struct check_connected_options opt
= CHECK_CONNECTED_INIT
;
577 opt
.transport
= transport
;
578 opt
.progress
= transport
->progress
;
580 if (check_connected(iterate_ref_map
, &rm
, &opt
))
581 die(_("remote did not send all necessary objects"));
585 write_remote_refs(mapped_refs
);
586 if (option_single_branch
&& !option_no_tags
)
587 write_followtags(refs
, msg
);
590 if (remote_head_points_at
&& !option_bare
) {
591 struct strbuf head_ref
= STRBUF_INIT
;
592 strbuf_addstr(&head_ref
, branch_top
);
593 strbuf_addstr(&head_ref
, "HEAD");
594 if (create_symref(head_ref
.buf
,
595 remote_head_points_at
->peer_ref
->name
,
597 die(_("unable to update %s"), head_ref
.buf
);
598 strbuf_release(&head_ref
);
602 static void update_head(const struct ref
*our
, const struct ref
*remote
,
606 if (our
&& skip_prefix(our
->name
, "refs/heads/", &head
)) {
607 /* Local default branch link */
608 if (create_symref("HEAD", our
->name
, NULL
) < 0)
609 die(_("unable to update HEAD"));
611 update_ref(msg
, "HEAD", &our
->old_oid
, NULL
, 0,
612 UPDATE_REFS_DIE_ON_ERR
);
613 install_branch_config(0, head
, remote_name
, our
->name
);
616 struct commit
*c
= lookup_commit_reference(the_repository
,
618 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
619 update_ref(msg
, "HEAD", &c
->object
.oid
, NULL
, REF_NO_DEREF
,
620 UPDATE_REFS_DIE_ON_ERR
);
623 * We know remote HEAD points to a non-branch, or
624 * HEAD points to a branch but we don't know which one.
625 * Detach HEAD in all these cases.
627 update_ref(msg
, "HEAD", &remote
->old_oid
, NULL
, REF_NO_DEREF
,
628 UPDATE_REFS_DIE_ON_ERR
);
632 static int git_sparse_checkout_init(const char *repo
)
634 struct strvec argv
= STRVEC_INIT
;
636 strvec_pushl(&argv
, "-C", repo
, "sparse-checkout", "init", NULL
);
639 * We must apply the setting in the current process
640 * for the later checkout to use the sparse-checkout file.
642 core_apply_sparse_checkout
= 1;
644 if (run_command_v_opt(argv
.v
, RUN_GIT_CMD
)) {
645 error(_("failed to initialize sparse-checkout"));
653 static int checkout(int submodule_progress
)
655 struct object_id oid
;
657 struct lock_file lock_file
= LOCK_INIT
;
658 struct unpack_trees_options opts
;
663 if (option_no_checkout
)
666 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, &oid
, NULL
);
668 warning(_("remote HEAD refers to nonexistent ref, "
669 "unable to checkout.\n"));
672 if (!strcmp(head
, "HEAD")) {
673 if (advice_enabled(ADVICE_DETACHED_HEAD
))
674 detach_advice(oid_to_hex(&oid
));
677 if (!starts_with(head
, "refs/heads/"))
678 die(_("HEAD not found below refs/heads!"));
681 /* We need to be in the new work tree for the checkout */
684 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
686 memset(&opts
, 0, sizeof opts
);
690 opts
.preserve_ignored
= 0;
691 opts
.fn
= oneway_merge
;
692 opts
.verbose_update
= (option_verbosity
>= 0);
693 opts
.src_index
= &the_index
;
694 opts
.dst_index
= &the_index
;
695 init_checkout_metadata(&opts
.meta
, head
, &oid
, NULL
);
697 tree
= parse_tree_indirect(&oid
);
699 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
700 if (unpack_trees(1, &t
, &opts
) < 0)
701 die(_("unable to checkout working tree"));
705 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
706 die(_("unable to write new index file"));
708 err
|= run_hook_le(NULL
, "post-checkout", oid_to_hex(null_oid()),
709 oid_to_hex(&oid
), "1", NULL
);
711 if (!err
&& (option_recurse_submodules
.nr
> 0)) {
712 struct strvec args
= STRVEC_INIT
;
713 strvec_pushl(&args
, "submodule", "update", "--require-init", "--recursive", NULL
);
715 if (option_shallow_submodules
== 1)
716 strvec_push(&args
, "--depth=1");
719 strvec_pushf(&args
, "--jobs=%d", max_jobs
);
721 if (submodule_progress
)
722 strvec_push(&args
, "--progress");
724 if (option_verbosity
< 0)
725 strvec_push(&args
, "--quiet");
727 if (option_remote_submodules
) {
728 strvec_push(&args
, "--remote");
729 strvec_push(&args
, "--no-fetch");
732 if (option_single_branch
>= 0)
733 strvec_push(&args
, option_single_branch
?
735 "--no-single-branch");
737 err
= run_command_v_opt(args
.v
, RUN_GIT_CMD
);
744 static int git_clone_config(const char *k
, const char *v
, void *cb
)
746 if (!strcmp(k
, "clone.defaultremotename")) {
748 remote_name
= xstrdup(v
);
750 if (!strcmp(k
, "clone.rejectshallow"))
751 config_reject_shallow
= git_config_bool(k
, v
);
753 return git_default_config(k
, v
, cb
);
756 static int write_one_config(const char *key
, const char *value
, void *data
)
759 * give git_clone_config a chance to write config values back to the
760 * environment, since git_config_set_multivar_gently only deals with
763 int apply_failed
= git_clone_config(key
, value
, data
);
767 return git_config_set_multivar_gently(key
,
768 value
? value
: "true",
769 CONFIG_REGEX_NONE
, 0);
772 static void write_config(struct string_list
*config
)
776 for (i
= 0; i
< config
->nr
; i
++) {
777 if (git_config_parse_parameter(config
->items
[i
].string
,
778 write_one_config
, NULL
) < 0)
779 die(_("unable to write parameters to config file"));
783 static void write_refspec_config(const char *src_ref_prefix
,
784 const struct ref
*our_head_points_at
,
785 const struct ref
*remote_head_points_at
,
786 struct strbuf
*branch_top
)
788 struct strbuf key
= STRBUF_INIT
;
789 struct strbuf value
= STRBUF_INIT
;
791 if (option_mirror
|| !option_bare
) {
792 if (option_single_branch
&& !option_mirror
) {
794 if (starts_with(our_head_points_at
->name
, "refs/tags/"))
795 strbuf_addf(&value
, "+%s:%s", our_head_points_at
->name
,
796 our_head_points_at
->name
);
798 strbuf_addf(&value
, "+%s:%s%s", our_head_points_at
->name
,
799 branch_top
->buf
, option_branch
);
800 } else if (remote_head_points_at
) {
801 const char *head
= remote_head_points_at
->name
;
802 if (!skip_prefix(head
, "refs/heads/", &head
))
803 BUG("remote HEAD points at non-head?");
805 strbuf_addf(&value
, "+%s:%s%s", remote_head_points_at
->name
,
806 branch_top
->buf
, head
);
809 * otherwise, the next "git fetch" will
810 * simply fetch from HEAD without updating
811 * any remote-tracking branch, which is what
815 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
->buf
);
817 /* Configure the remote */
819 strbuf_addf(&key
, "remote.%s.fetch", remote_name
);
820 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
824 strbuf_addf(&key
, "remote.%s.mirror", remote_name
);
825 git_config_set(key
.buf
, "true");
831 strbuf_release(&key
);
832 strbuf_release(&value
);
835 static void dissociate_from_references(void)
837 static const char* argv
[] = { "repack", "-a", "-d", NULL
};
838 char *alternates
= git_pathdup("objects/info/alternates");
840 if (!access(alternates
, F_OK
)) {
841 if (run_command_v_opt(argv
, RUN_GIT_CMD
|RUN_COMMAND_NO_STDIN
))
842 die(_("cannot repack to clean up"));
843 if (unlink(alternates
) && errno
!= ENOENT
)
844 die_errno(_("cannot unlink temporary alternates file"));
849 static int path_exists(const char *path
)
852 return !stat(path
, &sb
);
855 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
857 int is_bundle
= 0, is_local
;
858 int reject_shallow
= 0;
859 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
860 char *path
= NULL
, *dir
, *display_repo
= NULL
;
861 int dest_exists
, real_dest_exists
= 0;
862 const struct ref
*refs
, *remote_head
;
863 struct ref
*remote_head_points_at
= NULL
;
864 const struct ref
*our_head_points_at
;
865 struct ref
*mapped_refs
;
866 const struct ref
*ref
;
867 struct strbuf key
= STRBUF_INIT
;
868 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
869 struct transport
*transport
= NULL
;
870 const char *src_ref_prefix
= "refs/heads/";
871 struct remote
*remote
;
872 int err
= 0, complete_refs_before_fetch
= 1;
873 int submodule_progress
;
875 struct transport_ls_refs_options transport_ls_refs_options
=
876 TRANSPORT_LS_REFS_OPTIONS_INIT
;
878 packet_trace_identity("clone");
880 git_config(git_clone_config
, NULL
);
882 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
883 builtin_clone_usage
, 0);
886 usage_msg_opt(_("Too many arguments."),
887 builtin_clone_usage
, builtin_clone_options
);
890 usage_msg_opt(_("You must specify a repository to clone."),
891 builtin_clone_usage
, builtin_clone_options
);
893 if (option_depth
|| option_since
|| option_not
.nr
)
895 if (option_single_branch
== -1)
896 option_single_branch
= deepen
? 1 : 0;
903 die(_("--bare and --origin %s options are incompatible."),
906 die(_("--bare and --separate-git-dir are incompatible."));
907 option_no_checkout
= 1;
912 path
= get_repo_path(repo_name
, &is_bundle
);
915 repo
= absolute_pathdup(repo_name
);
916 } else if (strchr(repo_name
, ':')) {
918 display_repo
= transport_anonymize_url(repo
);
920 die(_("repository '%s' does not exist"), repo_name
);
922 /* no need to be strict, transport_set_option() will validate it again */
923 if (option_depth
&& atoi(option_depth
) < 1)
924 die(_("depth %s is not a positive number"), option_depth
);
927 dir
= xstrdup(argv
[1]);
929 dir
= git_url_basename(repo_name
, is_bundle
, option_bare
);
930 strip_dir_trailing_slashes(dir
);
932 dest_exists
= path_exists(dir
);
933 if (dest_exists
&& !is_empty_dir(dir
))
934 die(_("destination path '%s' already exists and is not "
935 "an empty directory."), dir
);
938 real_dest_exists
= path_exists(real_git_dir
);
939 if (real_dest_exists
&& !is_empty_dir(real_git_dir
))
940 die(_("repository path '%s' already exists and is not "
941 "an empty directory."), real_git_dir
);
945 strbuf_addf(&reflog_msg
, "clone: from %s",
946 display_repo
? display_repo
: repo
);
952 work_tree
= getenv("GIT_WORK_TREE");
953 if (work_tree
&& path_exists(work_tree
))
954 die(_("working tree '%s' already exists."), work_tree
);
957 if (option_bare
|| work_tree
)
958 git_dir
= xstrdup(dir
);
961 git_dir
= mkpathdup("%s/.git", dir
);
965 sigchain_push_common(remove_junk_on_signal
);
968 if (safe_create_leading_directories_const(work_tree
) < 0)
969 die_errno(_("could not create leading directories of '%s'"),
972 junk_work_tree_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
973 else if (mkdir(work_tree
, 0777))
974 die_errno(_("could not create work tree dir '%s'"),
976 junk_work_tree
= work_tree
;
977 set_git_work_tree(work_tree
);
981 if (real_dest_exists
)
982 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
983 junk_git_dir
= real_git_dir
;
986 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
987 junk_git_dir
= git_dir
;
989 if (safe_create_leading_directories_const(git_dir
) < 0)
990 die(_("could not create leading directories of '%s'"), git_dir
);
992 if (0 <= option_verbosity
) {
994 fprintf(stderr
, _("Cloning into bare repository '%s'...\n"), dir
);
996 fprintf(stderr
, _("Cloning into '%s'...\n"), dir
);
999 if (option_recurse_submodules
.nr
> 0) {
1000 struct string_list_item
*item
;
1001 struct strbuf sb
= STRBUF_INIT
;
1004 /* remove duplicates */
1005 string_list_sort(&option_recurse_submodules
);
1006 string_list_remove_duplicates(&option_recurse_submodules
, 0);
1009 * NEEDSWORK: In a multi-working-tree world, this needs to be
1010 * set in the per-worktree config.
1012 for_each_string_list_item(item
, &option_recurse_submodules
) {
1013 strbuf_addf(&sb
, "submodule.active=%s",
1015 string_list_append(&option_config
,
1016 strbuf_detach(&sb
, NULL
));
1019 if (!git_config_get_bool("submodule.stickyRecursiveClone", &val
) &&
1021 string_list_append(&option_config
, "submodule.recurse=true");
1023 if (option_required_reference
.nr
&&
1024 option_optional_reference
.nr
)
1025 die(_("clone --recursive is not compatible with "
1026 "both --reference and --reference-if-able"));
1027 else if (option_required_reference
.nr
) {
1028 string_list_append(&option_config
,
1029 "submodule.alternateLocation=superproject");
1030 string_list_append(&option_config
,
1031 "submodule.alternateErrorStrategy=die");
1032 } else if (option_optional_reference
.nr
) {
1033 string_list_append(&option_config
,
1034 "submodule.alternateLocation=superproject");
1035 string_list_append(&option_config
,
1036 "submodule.alternateErrorStrategy=info");
1040 init_db(git_dir
, real_git_dir
, option_template
, GIT_HASH_UNKNOWN
, NULL
,
1044 free((char *)git_dir
);
1045 git_dir
= real_git_dir
;
1049 * additional config can be injected with -c, make sure it's included
1050 * after init_db, which clears the entire config environment.
1052 write_config(&option_config
);
1055 * re-read config after init_db and write_config to pick up any config
1056 * injected by --template and --config, respectively.
1058 git_config(git_clone_config
, NULL
);
1061 * If option_reject_shallow is specified from CLI option,
1062 * ignore config_reject_shallow from git_clone_config.
1064 if (config_reject_shallow
!= -1)
1065 reject_shallow
= config_reject_shallow
;
1066 if (option_reject_shallow
!= -1)
1067 reject_shallow
= option_reject_shallow
;
1070 * apply the remote name provided by --origin only after this second
1071 * call to git_config, to ensure it overrides all config-based values.
1073 if (option_origin
!= NULL
)
1074 remote_name
= xstrdup(option_origin
);
1076 if (remote_name
== NULL
)
1077 remote_name
= xstrdup("origin");
1079 if (!valid_remote_name(remote_name
))
1080 die(_("'%s' is not a valid remote name"), remote_name
);
1084 src_ref_prefix
= "refs/";
1085 strbuf_addstr(&branch_top
, src_ref_prefix
);
1087 git_config_set("core.bare", "true");
1089 strbuf_addf(&branch_top
, "refs/remotes/%s/", remote_name
);
1092 strbuf_addf(&key
, "remote.%s.url", remote_name
);
1093 git_config_set(key
.buf
, repo
);
1096 if (option_no_tags
) {
1097 strbuf_addf(&key
, "remote.%s.tagOpt", remote_name
);
1098 git_config_set(key
.buf
, "--no-tags");
1102 if (option_required_reference
.nr
|| option_optional_reference
.nr
)
1105 if (option_sparse_checkout
&& git_sparse_checkout_init(dir
))
1108 remote
= remote_get(remote_name
);
1110 refspec_appendf(&remote
->fetch
, "+%s*:%s*", src_ref_prefix
,
1113 transport
= transport_get(remote
, remote
->url
[0]);
1114 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
1115 transport
->family
= family
;
1117 path
= get_repo_path(remote
->url
[0], &is_bundle
);
1118 is_local
= option_local
!= 0 && path
&& !is_bundle
;
1121 warning(_("--depth is ignored in local clones; use file:// instead."));
1123 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1125 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1126 if (filter_options
.choice
)
1127 warning(_("--filter is ignored in local clones; use file:// instead."));
1128 if (!access(mkpath("%s/shallow", path
), F_OK
)) {
1130 die(_("source repository is shallow, reject to clone."));
1131 if (option_local
> 0)
1132 warning(_("source repository is shallow, ignoring --local"));
1136 if (option_local
> 0 && !is_local
)
1137 warning(_("--local is ignored"));
1138 transport
->cloning
= 1;
1140 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
1143 transport_set_option(transport
, TRANS_OPT_REJECT_SHALLOW
, "1");
1145 transport_set_option(transport
, TRANS_OPT_DEPTH
,
1148 transport_set_option(transport
, TRANS_OPT_DEEPEN_SINCE
,
1151 transport_set_option(transport
, TRANS_OPT_DEEPEN_NOT
,
1152 (const char *)&option_not
);
1153 if (option_single_branch
)
1154 transport_set_option(transport
, TRANS_OPT_FOLLOWTAGS
, "1");
1156 if (option_upload_pack
)
1157 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
1158 option_upload_pack
);
1160 if (server_options
.nr
)
1161 transport
->server_options
= &server_options
;
1163 if (filter_options
.choice
) {
1165 expand_list_objects_filter_spec(&filter_options
);
1166 transport_set_option(transport
, TRANS_OPT_LIST_OBJECTS_FILTER
,
1168 transport_set_option(transport
, TRANS_OPT_FROM_PROMISOR
, "1");
1171 if (transport
->smart_options
&& !deepen
&& !filter_options
.choice
)
1172 transport
->smart_options
->check_self_contained_and_connected
= 1;
1175 strvec_push(&transport_ls_refs_options
.ref_prefixes
, "HEAD");
1176 refspec_ref_prefixes(&remote
->fetch
,
1177 &transport_ls_refs_options
.ref_prefixes
);
1179 expand_ref_prefix(&transport_ls_refs_options
.ref_prefixes
,
1181 if (!option_no_tags
)
1182 strvec_push(&transport_ls_refs_options
.ref_prefixes
,
1185 refs
= transport_get_remote_refs(transport
, &transport_ls_refs_options
);
1188 int hash_algo
= hash_algo_by_ptr(transport_get_hash_algo(transport
));
1191 * Now that we know what algorithm the remote side is using,
1192 * let's set ours to the same thing.
1194 initialize_repository_version(hash_algo
, 1);
1195 repo_set_hash_algo(the_repository
, hash_algo
);
1197 mapped_refs
= wanted_peer_refs(refs
, &remote
->fetch
);
1199 * transport_get_remote_refs() may return refs with null sha-1
1200 * in mapped_refs (see struct transport->get_refs_list
1201 * comment). In that case we need fetch it early because
1202 * remote_head code below relies on it.
1204 * for normal clones, transport_get_remote_refs() should
1205 * return reliable ref set, we can delay cloning until after
1206 * remote HEAD check.
1208 for (ref
= refs
; ref
; ref
= ref
->next
)
1209 if (is_null_oid(&ref
->old_oid
)) {
1210 complete_refs_before_fetch
= 0;
1214 if (!is_local
&& !complete_refs_before_fetch
) {
1215 if (transport_fetch_refs(transport
, mapped_refs
))
1216 die(_("remote transport reported error"));
1219 remote_head
= find_ref_by_name(refs
, "HEAD");
1220 remote_head_points_at
=
1221 guess_remote_head(remote_head
, mapped_refs
, 0);
1223 if (option_branch
) {
1224 our_head_points_at
=
1225 find_remote_branch(mapped_refs
, option_branch
);
1227 if (!our_head_points_at
)
1228 die(_("Remote branch %s not found in upstream %s"),
1229 option_branch
, remote_name
);
1232 our_head_points_at
= remote_head_points_at
;
1239 die(_("Remote branch %s not found in upstream %s"),
1240 option_branch
, remote_name
);
1242 warning(_("You appear to have cloned an empty repository."));
1244 our_head_points_at
= NULL
;
1245 remote_head_points_at
= NULL
;
1247 option_no_checkout
= 1;
1249 if (transport_ls_refs_options
.unborn_head_target
&&
1250 skip_prefix(transport_ls_refs_options
.unborn_head_target
,
1251 "refs/heads/", &branch
)) {
1252 ref
= transport_ls_refs_options
.unborn_head_target
;
1253 transport_ls_refs_options
.unborn_head_target
= NULL
;
1254 create_symref("HEAD", ref
, reflog_msg
.buf
);
1256 branch
= git_default_branch_name(0);
1257 ref
= xstrfmt("refs/heads/%s", branch
);
1261 install_branch_config(0, branch
, remote_name
, ref
);
1266 write_refspec_config(src_ref_prefix
, our_head_points_at
,
1267 remote_head_points_at
, &branch_top
);
1269 if (filter_options
.choice
)
1270 partial_clone_register(remote_name
, &filter_options
);
1273 clone_local(path
, git_dir
);
1274 else if (refs
&& complete_refs_before_fetch
) {
1275 if (transport_fetch_refs(transport
, mapped_refs
))
1276 die(_("remote transport reported error"));
1279 update_remote_refs(refs
, mapped_refs
, remote_head_points_at
,
1280 branch_top
.buf
, reflog_msg
.buf
, transport
,
1283 update_head(our_head_points_at
, remote_head
, reflog_msg
.buf
);
1286 * We want to show progress for recursive submodule clones iff
1287 * we did so for the main clone. But only the transport knows
1288 * the final decision for this flag, so we need to rescue the value
1289 * before we free the transport.
1291 submodule_progress
= transport
->progress
;
1293 transport_unlock_pack(transport
);
1294 transport_disconnect(transport
);
1296 if (option_dissociate
) {
1297 close_object_store(the_repository
->objects
);
1298 dissociate_from_references();
1301 junk_mode
= JUNK_LEAVE_REPO
;
1302 err
= checkout(submodule_progress
);
1305 strbuf_release(&reflog_msg
);
1306 strbuf_release(&branch_top
);
1307 strbuf_release(&key
);
1308 free_refs(mapped_refs
);
1309 free_refs(remote_head_points_at
);
1313 junk_mode
= JUNK_LEAVE_ALL
;
1315 strvec_clear(&transport_ls_refs_options
.ref_prefixes
);
1316 free(transport_ls_refs_options
.unborn_head_target
);