4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
5 * 2008 Daniel Barkalow <barkalow@iabervon.org>
6 * Based on git-commit.sh by Junio C Hamano and Linus Torvalds
8 * Clone a repository into a different directory that does not yet exist.
11 #define USE_THE_INDEX_VARIABLE
16 #include "environment.h"
20 #include "parse-options.h"
21 #include "fetch-pack.h"
24 #include "object-file.h"
25 #include "object-store.h"
27 #include "tree-walk.h"
28 #include "unpack-trees.h"
29 #include "transport.h"
32 #include "dir-iterator.h"
37 #include "run-command.h"
39 #include "connected.h"
41 #include "list-objects-filter-options.h"
44 #include "bundle-uri.h"
48 * - respect DB_ENVIRONMENT for .git/objects.
50 * Implementation notes:
51 * - dropping use-separate-remote and no-separate-remote compatibility
54 static const char * const builtin_clone_usage
[] = {
55 N_("git clone [<options>] [--] <repo> [<dir>]"),
59 static int option_no_checkout
, option_bare
, option_mirror
, option_single_branch
= -1;
60 static int option_local
= -1, option_no_hardlinks
, option_shared
;
61 static int option_no_tags
;
62 static int option_shallow_submodules
;
63 static int option_reject_shallow
= -1; /* unspecified */
64 static int config_reject_shallow
= -1; /* unspecified */
66 static char *option_template
, *option_depth
, *option_since
;
67 static char *option_origin
= NULL
;
68 static char *remote_name
= NULL
;
69 static char *option_branch
= NULL
;
70 static struct string_list option_not
= STRING_LIST_INIT_NODUP
;
71 static const char *real_git_dir
;
72 static char *option_upload_pack
= "git-upload-pack";
73 static int option_verbosity
;
74 static int option_progress
= -1;
75 static int option_sparse_checkout
;
76 static enum transport_family family
;
77 static struct string_list option_config
= STRING_LIST_INIT_NODUP
;
78 static struct string_list option_required_reference
= STRING_LIST_INIT_NODUP
;
79 static struct string_list option_optional_reference
= STRING_LIST_INIT_NODUP
;
80 static int option_dissociate
;
81 static int max_jobs
= -1;
82 static struct string_list option_recurse_submodules
= STRING_LIST_INIT_NODUP
;
83 static struct list_objects_filter_options filter_options
= LIST_OBJECTS_FILTER_INIT
;
84 static int option_filter_submodules
= -1; /* unspecified */
85 static int config_filter_submodules
= -1; /* unspecified */
86 static struct string_list server_options
= STRING_LIST_INIT_NODUP
;
87 static int option_remote_submodules
;
88 static const char *bundle_uri
;
90 static int recurse_submodules_cb(const struct option
*opt
,
91 const char *arg
, int unset
)
94 string_list_clear((struct string_list
*)opt
->value
, 0);
96 string_list_append((struct string_list
*)opt
->value
, arg
);
98 string_list_append((struct string_list
*)opt
->value
,
99 (const char *)opt
->defval
);
104 static struct option builtin_clone_options
[] = {
105 OPT__VERBOSITY(&option_verbosity
),
106 OPT_BOOL(0, "progress", &option_progress
,
107 N_("force progress reporting")),
108 OPT_BOOL(0, "reject-shallow", &option_reject_shallow
,
109 N_("don't clone shallow repository")),
110 OPT_BOOL('n', "no-checkout", &option_no_checkout
,
111 N_("don't create a checkout")),
112 OPT_BOOL(0, "bare", &option_bare
, N_("create a bare repository")),
113 OPT_HIDDEN_BOOL(0, "naked", &option_bare
,
114 N_("create a bare repository")),
115 OPT_BOOL(0, "mirror", &option_mirror
,
116 N_("create a mirror repository (implies bare)")),
117 OPT_BOOL('l', "local", &option_local
,
118 N_("to clone from a local repository")),
119 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks
,
120 N_("don't use local hardlinks, always copy")),
121 OPT_BOOL('s', "shared", &option_shared
,
122 N_("setup as shared repository")),
123 { OPTION_CALLBACK
, 0, "recurse-submodules", &option_recurse_submodules
,
124 N_("pathspec"), N_("initialize submodules in the clone"),
125 PARSE_OPT_OPTARG
, recurse_submodules_cb
, (intptr_t)"." },
126 OPT_ALIAS(0, "recursive", "recurse-submodules"),
127 OPT_INTEGER('j', "jobs", &max_jobs
,
128 N_("number of submodules cloned in parallel")),
129 OPT_STRING(0, "template", &option_template
, N_("template-directory"),
130 N_("directory from which templates will be used")),
131 OPT_STRING_LIST(0, "reference", &option_required_reference
, N_("repo"),
132 N_("reference repository")),
133 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference
,
134 N_("repo"), N_("reference repository")),
135 OPT_BOOL(0, "dissociate", &option_dissociate
,
136 N_("use --reference only while cloning")),
137 OPT_STRING('o', "origin", &option_origin
, N_("name"),
138 N_("use <name> instead of 'origin' to track upstream")),
139 OPT_STRING('b', "branch", &option_branch
, N_("branch"),
140 N_("checkout <branch> instead of the remote's HEAD")),
141 OPT_STRING('u', "upload-pack", &option_upload_pack
, N_("path"),
142 N_("path to git-upload-pack on the remote")),
143 OPT_STRING(0, "depth", &option_depth
, N_("depth"),
144 N_("create a shallow clone of that depth")),
145 OPT_STRING(0, "shallow-since", &option_since
, N_("time"),
146 N_("create a shallow clone since a specific time")),
147 OPT_STRING_LIST(0, "shallow-exclude", &option_not
, N_("revision"),
148 N_("deepen history of shallow clone, excluding rev")),
149 OPT_BOOL(0, "single-branch", &option_single_branch
,
150 N_("clone only one branch, HEAD or --branch")),
151 OPT_BOOL(0, "no-tags", &option_no_tags
,
152 N_("don't clone any tags, and make later fetches not to follow them")),
153 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules
,
154 N_("any cloned submodules will be shallow")),
155 OPT_STRING(0, "separate-git-dir", &real_git_dir
, N_("gitdir"),
156 N_("separate git dir from working tree")),
157 OPT_STRING_LIST('c', "config", &option_config
, N_("key=value"),
158 N_("set config inside the new repository")),
159 OPT_STRING_LIST(0, "server-option", &server_options
,
160 N_("server-specific"), N_("option to transmit")),
161 OPT_SET_INT('4', "ipv4", &family
, N_("use IPv4 addresses only"),
162 TRANSPORT_FAMILY_IPV4
),
163 OPT_SET_INT('6', "ipv6", &family
, N_("use IPv6 addresses only"),
164 TRANSPORT_FAMILY_IPV6
),
165 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
166 OPT_BOOL(0, "also-filter-submodules", &option_filter_submodules
,
167 N_("apply partial clone filters to submodules")),
168 OPT_BOOL(0, "remote-submodules", &option_remote_submodules
,
169 N_("any cloned submodules will use their remote-tracking branch")),
170 OPT_BOOL(0, "sparse", &option_sparse_checkout
,
171 N_("initialize sparse-checkout file to include only files at root")),
172 OPT_STRING(0, "bundle-uri", &bundle_uri
,
173 N_("uri"), N_("a URI for downloading bundles before fetching from origin remote")),
177 static const char *get_repo_path_1(struct strbuf
*path
, int *is_bundle
)
179 static char *suffix
[] = { "/.git", "", ".git/.git", ".git" };
180 static char *bundle_suffix
[] = { ".bundle", "" };
181 size_t baselen
= path
->len
;
185 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
186 strbuf_setlen(path
, baselen
);
187 strbuf_addstr(path
, suffix
[i
]);
188 if (stat(path
->buf
, &st
))
190 if (S_ISDIR(st
.st_mode
) && is_git_directory(path
->buf
)) {
193 } else if (S_ISREG(st
.st_mode
) && st
.st_size
> 8) {
194 /* Is it a "gitfile"? */
197 int len
, fd
= open(path
->buf
, O_RDONLY
);
200 len
= read_in_full(fd
, signature
, 8);
202 if (len
!= 8 || strncmp(signature
, "gitdir: ", 8))
204 dst
= read_gitfile(path
->buf
);
212 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
213 strbuf_setlen(path
, baselen
);
214 strbuf_addstr(path
, bundle_suffix
[i
]);
215 if (!stat(path
->buf
, &st
) && S_ISREG(st
.st_mode
)) {
224 static char *get_repo_path(const char *repo
, int *is_bundle
)
226 struct strbuf path
= STRBUF_INIT
;
230 strbuf_addstr(&path
, repo
);
231 raw
= get_repo_path_1(&path
, is_bundle
);
232 canon
= raw
? absolute_pathdup(raw
) : NULL
;
233 strbuf_release(&path
);
237 static int add_one_reference(struct string_list_item
*item
, void *cb_data
)
239 struct strbuf err
= STRBUF_INIT
;
240 int *required
= cb_data
;
241 char *ref_git
= compute_alternate_path(item
->string
, &err
);
248 _("info: Could not add alternate for '%s': %s\n"),
249 item
->string
, err
.buf
);
251 struct strbuf sb
= STRBUF_INIT
;
252 strbuf_addf(&sb
, "%s/objects", ref_git
);
253 add_to_alternates_file(sb
.buf
);
257 strbuf_release(&err
);
262 static void setup_reference(void)
265 for_each_string_list(&option_required_reference
,
266 add_one_reference
, &required
);
268 for_each_string_list(&option_optional_reference
,
269 add_one_reference
, &required
);
272 static void copy_alternates(struct strbuf
*src
, const char *src_repo
)
275 * Read from the source objects/info/alternates file
276 * and copy the entries to corresponding file in the
277 * destination repository with add_to_alternates_file().
278 * Both src and dst have "$path/objects/info/alternates".
280 * Instead of copying bit-for-bit from the original,
281 * we need to append to existing one so that the already
282 * created entry via "clone -s" is not lost, and also
283 * to turn entries with paths relative to the original
284 * absolute, so that they can be used in the new repository.
286 FILE *in
= xfopen(src
->buf
, "r");
287 struct strbuf line
= STRBUF_INIT
;
289 while (strbuf_getline(&line
, in
) != EOF
) {
291 if (!line
.len
|| line
.buf
[0] == '#')
293 if (is_absolute_path(line
.buf
)) {
294 add_to_alternates_file(line
.buf
);
297 abs_path
= mkpathdup("%s/objects/%s", src_repo
, line
.buf
);
298 if (!normalize_path_copy(abs_path
, abs_path
))
299 add_to_alternates_file(abs_path
);
301 warning("skipping invalid relative alternate: %s/%s",
305 strbuf_release(&line
);
309 static void mkdir_if_missing(const char *pathname
, mode_t mode
)
313 if (!mkdir(pathname
, mode
))
317 die_errno(_("failed to create directory '%s'"), pathname
);
318 else if (stat(pathname
, &st
))
319 die_errno(_("failed to stat '%s'"), pathname
);
320 else if (!S_ISDIR(st
.st_mode
))
321 die(_("%s exists and is not a directory"), pathname
);
324 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
,
325 const char *src_repo
)
327 int src_len
, dest_len
;
328 struct dir_iterator
*iter
;
330 struct strbuf realpath
= STRBUF_INIT
;
332 mkdir_if_missing(dest
->buf
, 0777);
334 iter
= dir_iterator_begin(src
->buf
, DIR_ITERATOR_PEDANTIC
);
337 die_errno(_("failed to start iterator over '%s'"), src
->buf
);
339 strbuf_addch(src
, '/');
341 strbuf_addch(dest
, '/');
342 dest_len
= dest
->len
;
344 while ((iter_status
= dir_iterator_advance(iter
)) == ITER_OK
) {
345 strbuf_setlen(src
, src_len
);
346 strbuf_addstr(src
, iter
->relative_path
);
347 strbuf_setlen(dest
, dest_len
);
348 strbuf_addstr(dest
, iter
->relative_path
);
350 if (S_ISLNK(iter
->st
.st_mode
))
351 die(_("symlink '%s' exists, refusing to clone with --local"),
352 iter
->relative_path
);
354 if (S_ISDIR(iter
->st
.st_mode
)) {
355 mkdir_if_missing(dest
->buf
, 0777);
359 /* Files that cannot be copied bit-for-bit... */
360 if (!fspathcmp(iter
->relative_path
, "info/alternates")) {
361 copy_alternates(src
, src_repo
);
365 if (unlink(dest
->buf
) && errno
!= ENOENT
)
366 die_errno(_("failed to unlink '%s'"), dest
->buf
);
367 if (!option_no_hardlinks
) {
368 strbuf_realpath(&realpath
, src
->buf
, 1);
369 if (!link(realpath
.buf
, dest
->buf
))
371 if (option_local
> 0)
372 die_errno(_("failed to create link '%s'"), dest
->buf
);
373 option_no_hardlinks
= 1;
375 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
376 die_errno(_("failed to copy file to '%s'"), dest
->buf
);
379 if (iter_status
!= ITER_DONE
) {
380 strbuf_setlen(src
, src_len
);
381 die(_("failed to iterate over '%s'"), src
->buf
);
384 strbuf_release(&realpath
);
387 static void clone_local(const char *src_repo
, const char *dest_repo
)
390 struct strbuf alt
= STRBUF_INIT
;
391 get_common_dir(&alt
, src_repo
);
392 strbuf_addstr(&alt
, "/objects");
393 add_to_alternates_file(alt
.buf
);
394 strbuf_release(&alt
);
396 struct strbuf src
= STRBUF_INIT
;
397 struct strbuf dest
= STRBUF_INIT
;
398 get_common_dir(&src
, src_repo
);
399 get_common_dir(&dest
, dest_repo
);
400 strbuf_addstr(&src
, "/objects");
401 strbuf_addstr(&dest
, "/objects");
402 copy_or_link_directory(&src
, &dest
, src_repo
);
403 strbuf_release(&src
);
404 strbuf_release(&dest
);
407 if (0 <= option_verbosity
)
408 fprintf(stderr
, _("done.\n"));
411 static const char *junk_work_tree
;
412 static int junk_work_tree_flags
;
413 static const char *junk_git_dir
;
414 static int junk_git_dir_flags
;
419 } junk_mode
= JUNK_LEAVE_NONE
;
421 static const char junk_leave_repo_msg
[] =
422 N_("Clone succeeded, but checkout failed.\n"
423 "You can inspect what was checked out with 'git status'\n"
424 "and retry with 'git restore --source=HEAD :/'\n");
426 static void remove_junk(void)
428 struct strbuf sb
= STRBUF_INIT
;
431 case JUNK_LEAVE_REPO
:
432 warning("%s", _(junk_leave_repo_msg
));
437 /* proceed to removal */
442 strbuf_addstr(&sb
, junk_git_dir
);
443 remove_dir_recursively(&sb
, junk_git_dir_flags
);
446 if (junk_work_tree
) {
447 strbuf_addstr(&sb
, junk_work_tree
);
448 remove_dir_recursively(&sb
, junk_work_tree_flags
);
453 static void remove_junk_on_signal(int signo
)
460 static struct ref
*find_remote_branch(const struct ref
*refs
, const char *branch
)
463 struct strbuf head
= STRBUF_INIT
;
464 strbuf_addstr(&head
, "refs/heads/");
465 strbuf_addstr(&head
, branch
);
466 ref
= find_ref_by_name(refs
, head
.buf
);
467 strbuf_release(&head
);
472 strbuf_addstr(&head
, "refs/tags/");
473 strbuf_addstr(&head
, branch
);
474 ref
= find_ref_by_name(refs
, head
.buf
);
475 strbuf_release(&head
);
480 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
481 struct refspec
*refspec
)
483 struct ref
*head
= copy_ref(find_ref_by_name(refs
, "HEAD"));
484 struct ref
*local_refs
= head
;
485 struct ref
**tail
= head
? &head
->next
: &local_refs
;
487 if (option_single_branch
) {
488 struct ref
*remote_head
= NULL
;
491 remote_head
= guess_remote_head(head
, refs
, 0);
495 remote_head
= copy_ref(find_remote_branch(refs
, option_branch
));
498 if (!remote_head
&& option_branch
)
499 warning(_("Could not find remote branch %s to clone."),
503 for (i
= 0; i
< refspec
->nr
; i
++)
504 get_fetch_map(remote_head
, &refspec
->items
[i
],
507 /* if --branch=tag, pull the requested tag explicitly */
508 get_fetch_map(remote_head
, tag_refspec
, &tail
, 0);
510 free_refs(remote_head
);
513 for (i
= 0; i
< refspec
->nr
; i
++)
514 get_fetch_map(refs
, &refspec
->items
[i
], &tail
, 0);
517 if (!option_mirror
&& !option_single_branch
&& !option_no_tags
)
518 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
523 static void write_remote_refs(const struct ref
*local_refs
)
527 struct ref_transaction
*t
;
528 struct strbuf err
= STRBUF_INIT
;
530 t
= ref_transaction_begin(&err
);
534 for (r
= local_refs
; r
; r
= r
->next
) {
537 if (ref_transaction_create(t
, r
->peer_ref
->name
, &r
->old_oid
,
542 if (initial_ref_transaction_commit(t
, &err
))
545 strbuf_release(&err
);
546 ref_transaction_free(t
);
549 static void write_followtags(const struct ref
*refs
, const char *msg
)
551 const struct ref
*ref
;
552 for (ref
= refs
; ref
; ref
= ref
->next
) {
553 if (!starts_with(ref
->name
, "refs/tags/"))
555 if (ends_with(ref
->name
, "^{}"))
557 if (!repo_has_object_file_with_flags(the_repository
, &ref
->old_oid
,
559 OBJECT_INFO_SKIP_FETCH_OBJECT
))
561 update_ref(msg
, ref
->name
, &ref
->old_oid
, NULL
, 0,
562 UPDATE_REFS_DIE_ON_ERR
);
566 static const struct object_id
*iterate_ref_map(void *cb_data
)
568 struct ref
**rm
= cb_data
;
569 struct ref
*ref
= *rm
;
572 * Skip anything missing a peer_ref, which we are not
573 * actually going to write a ref for.
575 while (ref
&& !ref
->peer_ref
)
581 return &ref
->old_oid
;
584 static void update_remote_refs(const struct ref
*refs
,
585 const struct ref
*mapped_refs
,
586 const struct ref
*remote_head_points_at
,
587 const char *branch_top
,
589 struct transport
*transport
,
590 int check_connectivity
)
592 const struct ref
*rm
= mapped_refs
;
594 if (check_connectivity
) {
595 struct check_connected_options opt
= CHECK_CONNECTED_INIT
;
597 opt
.transport
= transport
;
598 opt
.progress
= transport
->progress
;
600 if (check_connected(iterate_ref_map
, &rm
, &opt
))
601 die(_("remote did not send all necessary objects"));
605 write_remote_refs(mapped_refs
);
606 if (option_single_branch
&& !option_no_tags
)
607 write_followtags(refs
, msg
);
610 if (remote_head_points_at
&& !option_bare
) {
611 struct strbuf head_ref
= STRBUF_INIT
;
612 strbuf_addstr(&head_ref
, branch_top
);
613 strbuf_addstr(&head_ref
, "HEAD");
614 if (create_symref(head_ref
.buf
,
615 remote_head_points_at
->peer_ref
->name
,
617 die(_("unable to update %s"), head_ref
.buf
);
618 strbuf_release(&head_ref
);
622 static void update_head(const struct ref
*our
, const struct ref
*remote
,
623 const char *unborn
, const char *msg
)
626 if (our
&& skip_prefix(our
->name
, "refs/heads/", &head
)) {
627 /* Local default branch link */
628 if (create_symref("HEAD", our
->name
, NULL
) < 0)
629 die(_("unable to update HEAD"));
631 update_ref(msg
, "HEAD", &our
->old_oid
, NULL
, 0,
632 UPDATE_REFS_DIE_ON_ERR
);
633 install_branch_config(0, head
, remote_name
, our
->name
);
636 struct commit
*c
= lookup_commit_reference(the_repository
,
638 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
639 update_ref(msg
, "HEAD", &c
->object
.oid
, NULL
, REF_NO_DEREF
,
640 UPDATE_REFS_DIE_ON_ERR
);
643 * We know remote HEAD points to a non-branch, or
644 * HEAD points to a branch but we don't know which one.
645 * Detach HEAD in all these cases.
647 update_ref(msg
, "HEAD", &remote
->old_oid
, NULL
, REF_NO_DEREF
,
648 UPDATE_REFS_DIE_ON_ERR
);
649 } else if (unborn
&& skip_prefix(unborn
, "refs/heads/", &head
)) {
651 * Unborn head from remote; same as "our" case above except
652 * that we have no ref to update.
654 if (create_symref("HEAD", unborn
, NULL
) < 0)
655 die(_("unable to update HEAD"));
657 install_branch_config(0, head
, remote_name
, unborn
);
661 static int git_sparse_checkout_init(const char *repo
)
663 struct child_process cmd
= CHILD_PROCESS_INIT
;
665 strvec_pushl(&cmd
.args
, "-C", repo
, "sparse-checkout", "set", NULL
);
668 * We must apply the setting in the current process
669 * for the later checkout to use the sparse-checkout file.
671 core_apply_sparse_checkout
= 1;
674 if (run_command(&cmd
)) {
675 error(_("failed to initialize sparse-checkout"));
682 static int checkout(int submodule_progress
, int filter_submodules
)
684 struct object_id oid
;
686 struct lock_file lock_file
= LOCK_INIT
;
687 struct unpack_trees_options opts
;
692 if (option_no_checkout
)
695 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, &oid
, NULL
);
697 warning(_("remote HEAD refers to nonexistent ref, "
698 "unable to checkout"));
701 if (!strcmp(head
, "HEAD")) {
702 if (advice_enabled(ADVICE_DETACHED_HEAD
))
703 detach_advice(oid_to_hex(&oid
));
706 if (!starts_with(head
, "refs/heads/"))
707 die(_("HEAD not found below refs/heads!"));
710 /* We need to be in the new work tree for the checkout */
713 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
715 memset(&opts
, 0, sizeof opts
);
719 opts
.preserve_ignored
= 0;
720 opts
.fn
= oneway_merge
;
721 opts
.verbose_update
= (option_verbosity
>= 0);
722 opts
.src_index
= &the_index
;
723 opts
.dst_index
= &the_index
;
724 init_checkout_metadata(&opts
.meta
, head
, &oid
, NULL
);
726 tree
= parse_tree_indirect(&oid
);
728 die(_("unable to parse commit %s"), oid_to_hex(&oid
));
730 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
731 if (unpack_trees(1, &t
, &opts
) < 0)
732 die(_("unable to checkout working tree"));
736 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
737 die(_("unable to write new index file"));
739 err
|= run_hooks_l("post-checkout", oid_to_hex(null_oid()),
740 oid_to_hex(&oid
), "1", NULL
);
742 if (!err
&& (option_recurse_submodules
.nr
> 0)) {
743 struct child_process cmd
= CHILD_PROCESS_INIT
;
744 strvec_pushl(&cmd
.args
, "submodule", "update", "--require-init",
745 "--recursive", NULL
);
747 if (option_shallow_submodules
== 1)
748 strvec_push(&cmd
.args
, "--depth=1");
751 strvec_pushf(&cmd
.args
, "--jobs=%d", max_jobs
);
753 if (submodule_progress
)
754 strvec_push(&cmd
.args
, "--progress");
756 if (option_verbosity
< 0)
757 strvec_push(&cmd
.args
, "--quiet");
759 if (option_remote_submodules
) {
760 strvec_push(&cmd
.args
, "--remote");
761 strvec_push(&cmd
.args
, "--no-fetch");
764 if (filter_submodules
&& filter_options
.choice
)
765 strvec_pushf(&cmd
.args
, "--filter=%s",
766 expand_list_objects_filter_spec(&filter_options
));
768 if (option_single_branch
>= 0)
769 strvec_push(&cmd
.args
, option_single_branch
?
771 "--no-single-branch");
774 err
= run_command(&cmd
);
780 static int git_clone_config(const char *k
, const char *v
, void *cb
)
782 if (!strcmp(k
, "clone.defaultremotename")) {
784 remote_name
= xstrdup(v
);
786 if (!strcmp(k
, "clone.rejectshallow"))
787 config_reject_shallow
= git_config_bool(k
, v
);
788 if (!strcmp(k
, "clone.filtersubmodules"))
789 config_filter_submodules
= git_config_bool(k
, v
);
791 return git_default_config(k
, v
, cb
);
794 static int write_one_config(const char *key
, const char *value
, void *data
)
797 * give git_clone_config a chance to write config values back to the
798 * environment, since git_config_set_multivar_gently only deals with
801 int apply_failed
= git_clone_config(key
, value
, data
);
805 return git_config_set_multivar_gently(key
,
806 value
? value
: "true",
807 CONFIG_REGEX_NONE
, 0);
810 static void write_config(struct string_list
*config
)
814 for (i
= 0; i
< config
->nr
; i
++) {
815 if (git_config_parse_parameter(config
->items
[i
].string
,
816 write_one_config
, NULL
) < 0)
817 die(_("unable to write parameters to config file"));
821 static void write_refspec_config(const char *src_ref_prefix
,
822 const struct ref
*our_head_points_at
,
823 const struct ref
*remote_head_points_at
,
824 struct strbuf
*branch_top
)
826 struct strbuf key
= STRBUF_INIT
;
827 struct strbuf value
= STRBUF_INIT
;
829 if (option_mirror
|| !option_bare
) {
830 if (option_single_branch
&& !option_mirror
) {
832 if (starts_with(our_head_points_at
->name
, "refs/tags/"))
833 strbuf_addf(&value
, "+%s:%s", our_head_points_at
->name
,
834 our_head_points_at
->name
);
836 strbuf_addf(&value
, "+%s:%s%s", our_head_points_at
->name
,
837 branch_top
->buf
, option_branch
);
838 } else if (remote_head_points_at
) {
839 const char *head
= remote_head_points_at
->name
;
840 if (!skip_prefix(head
, "refs/heads/", &head
))
841 BUG("remote HEAD points at non-head?");
843 strbuf_addf(&value
, "+%s:%s%s", remote_head_points_at
->name
,
844 branch_top
->buf
, head
);
847 * otherwise, the next "git fetch" will
848 * simply fetch from HEAD without updating
849 * any remote-tracking branch, which is what
853 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
->buf
);
855 /* Configure the remote */
857 strbuf_addf(&key
, "remote.%s.fetch", remote_name
);
858 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
862 strbuf_addf(&key
, "remote.%s.mirror", remote_name
);
863 git_config_set(key
.buf
, "true");
869 strbuf_release(&key
);
870 strbuf_release(&value
);
873 static void dissociate_from_references(void)
875 char *alternates
= git_pathdup("objects/info/alternates");
877 if (!access(alternates
, F_OK
)) {
878 struct child_process cmd
= CHILD_PROCESS_INIT
;
882 strvec_pushl(&cmd
.args
, "repack", "-a", "-d", NULL
);
883 if (run_command(&cmd
))
884 die(_("cannot repack to clean up"));
885 if (unlink(alternates
) && errno
!= ENOENT
)
886 die_errno(_("cannot unlink temporary alternates file"));
891 static int path_exists(const char *path
)
894 return !stat(path
, &sb
);
897 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
899 int is_bundle
= 0, is_local
;
900 int reject_shallow
= 0;
901 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
902 char *repo_to_free
= NULL
;
903 char *path
= NULL
, *dir
, *display_repo
= NULL
;
904 int dest_exists
, real_dest_exists
= 0;
905 const struct ref
*refs
, *remote_head
;
906 struct ref
*remote_head_points_at
= NULL
;
907 const struct ref
*our_head_points_at
;
908 char *unborn_head
= NULL
;
909 struct ref
*mapped_refs
= NULL
;
910 const struct ref
*ref
;
911 struct strbuf key
= STRBUF_INIT
;
912 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
913 struct transport
*transport
= NULL
;
914 const char *src_ref_prefix
= "refs/heads/";
915 struct remote
*remote
;
916 int err
= 0, complete_refs_before_fetch
= 1;
917 int submodule_progress
;
918 int filter_submodules
= 0;
920 struct transport_ls_refs_options transport_ls_refs_options
=
921 TRANSPORT_LS_REFS_OPTIONS_INIT
;
923 packet_trace_identity("clone");
925 git_config(git_clone_config
, NULL
);
927 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
928 builtin_clone_usage
, 0);
931 usage_msg_opt(_("Too many arguments."),
932 builtin_clone_usage
, builtin_clone_options
);
935 usage_msg_opt(_("You must specify a repository to clone."),
936 builtin_clone_usage
, builtin_clone_options
);
938 if (option_depth
|| option_since
|| option_not
.nr
)
940 if (option_single_branch
== -1)
941 option_single_branch
= deepen
? 1 : 0;
948 die(_("options '%s' and '%s' cannot be used together"), "--bare", "--separate-git-dir");
949 option_no_checkout
= 1;
952 if (bundle_uri
&& deepen
)
953 die(_("--bundle-uri is incompatible with --depth, --shallow-since, and --shallow-exclude"));
957 path
= get_repo_path(repo_name
, &is_bundle
);
960 repo
= repo_to_free
= absolute_pathdup(repo_name
);
961 } else if (strchr(repo_name
, ':')) {
963 display_repo
= transport_anonymize_url(repo
);
965 die(_("repository '%s' does not exist"), repo_name
);
967 /* no need to be strict, transport_set_option() will validate it again */
968 if (option_depth
&& atoi(option_depth
) < 1)
969 die(_("depth %s is not a positive number"), option_depth
);
972 dir
= xstrdup(argv
[1]);
974 dir
= git_url_basename(repo_name
, is_bundle
, option_bare
);
975 strip_dir_trailing_slashes(dir
);
977 dest_exists
= path_exists(dir
);
978 if (dest_exists
&& !is_empty_dir(dir
))
979 die(_("destination path '%s' already exists and is not "
980 "an empty directory."), dir
);
983 real_dest_exists
= path_exists(real_git_dir
);
984 if (real_dest_exists
&& !is_empty_dir(real_git_dir
))
985 die(_("repository path '%s' already exists and is not "
986 "an empty directory."), real_git_dir
);
990 strbuf_addf(&reflog_msg
, "clone: from %s",
991 display_repo
? display_repo
: repo
);
997 work_tree
= getenv("GIT_WORK_TREE");
998 if (work_tree
&& path_exists(work_tree
))
999 die(_("working tree '%s' already exists."), work_tree
);
1002 if (option_bare
|| work_tree
)
1003 git_dir
= xstrdup(dir
);
1006 git_dir
= mkpathdup("%s/.git", dir
);
1009 atexit(remove_junk
);
1010 sigchain_push_common(remove_junk_on_signal
);
1013 if (safe_create_leading_directories_const(work_tree
) < 0)
1014 die_errno(_("could not create leading directories of '%s'"),
1017 junk_work_tree_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1018 else if (mkdir(work_tree
, 0777))
1019 die_errno(_("could not create work tree dir '%s'"),
1021 junk_work_tree
= work_tree
;
1022 set_git_work_tree(work_tree
);
1026 if (real_dest_exists
)
1027 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1028 junk_git_dir
= real_git_dir
;
1031 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1032 junk_git_dir
= git_dir
;
1034 if (safe_create_leading_directories_const(git_dir
) < 0)
1035 die(_("could not create leading directories of '%s'"), git_dir
);
1037 if (0 <= option_verbosity
) {
1039 fprintf(stderr
, _("Cloning into bare repository '%s'...\n"), dir
);
1041 fprintf(stderr
, _("Cloning into '%s'...\n"), dir
);
1044 if (option_recurse_submodules
.nr
> 0) {
1045 struct string_list_item
*item
;
1046 struct strbuf sb
= STRBUF_INIT
;
1049 /* remove duplicates */
1050 string_list_sort(&option_recurse_submodules
);
1051 string_list_remove_duplicates(&option_recurse_submodules
, 0);
1054 * NEEDSWORK: In a multi-working-tree world, this needs to be
1055 * set in the per-worktree config.
1057 for_each_string_list_item(item
, &option_recurse_submodules
) {
1058 strbuf_addf(&sb
, "submodule.active=%s",
1060 string_list_append(&option_config
,
1061 strbuf_detach(&sb
, NULL
));
1064 if (!git_config_get_bool("submodule.stickyRecursiveClone", &val
) &&
1066 string_list_append(&option_config
, "submodule.recurse=true");
1068 if (option_required_reference
.nr
&&
1069 option_optional_reference
.nr
)
1070 die(_("clone --recursive is not compatible with "
1071 "both --reference and --reference-if-able"));
1072 else if (option_required_reference
.nr
) {
1073 string_list_append(&option_config
,
1074 "submodule.alternateLocation=superproject");
1075 string_list_append(&option_config
,
1076 "submodule.alternateErrorStrategy=die");
1077 } else if (option_optional_reference
.nr
) {
1078 string_list_append(&option_config
,
1079 "submodule.alternateLocation=superproject");
1080 string_list_append(&option_config
,
1081 "submodule.alternateErrorStrategy=info");
1085 init_db(git_dir
, real_git_dir
, option_template
, GIT_HASH_UNKNOWN
, NULL
,
1089 free((char *)git_dir
);
1090 git_dir
= real_git_dir
;
1094 * additional config can be injected with -c, make sure it's included
1095 * after init_db, which clears the entire config environment.
1097 write_config(&option_config
);
1100 * re-read config after init_db and write_config to pick up any config
1101 * injected by --template and --config, respectively.
1103 git_config(git_clone_config
, NULL
);
1106 * If option_reject_shallow is specified from CLI option,
1107 * ignore config_reject_shallow from git_clone_config.
1109 if (config_reject_shallow
!= -1)
1110 reject_shallow
= config_reject_shallow
;
1111 if (option_reject_shallow
!= -1)
1112 reject_shallow
= option_reject_shallow
;
1115 * If option_filter_submodules is specified from CLI option,
1116 * ignore config_filter_submodules from git_clone_config.
1118 if (config_filter_submodules
!= -1)
1119 filter_submodules
= config_filter_submodules
;
1120 if (option_filter_submodules
!= -1)
1121 filter_submodules
= option_filter_submodules
;
1124 * Exit if the user seems to be doing something silly with submodule
1125 * filter flags (but not with filter configs, as those should be
1128 if (option_filter_submodules
> 0 && !filter_options
.choice
)
1129 die(_("the option '%s' requires '%s'"),
1130 "--also-filter-submodules", "--filter");
1131 if (option_filter_submodules
> 0 && !option_recurse_submodules
.nr
)
1132 die(_("the option '%s' requires '%s'"),
1133 "--also-filter-submodules", "--recurse-submodules");
1136 * apply the remote name provided by --origin only after this second
1137 * call to git_config, to ensure it overrides all config-based values.
1139 if (option_origin
) {
1141 remote_name
= xstrdup(option_origin
);
1145 remote_name
= xstrdup("origin");
1147 if (!valid_remote_name(remote_name
))
1148 die(_("'%s' is not a valid remote name"), remote_name
);
1152 src_ref_prefix
= "refs/";
1153 strbuf_addstr(&branch_top
, src_ref_prefix
);
1155 git_config_set("core.bare", "true");
1157 strbuf_addf(&branch_top
, "refs/remotes/%s/", remote_name
);
1160 strbuf_addf(&key
, "remote.%s.url", remote_name
);
1161 git_config_set(key
.buf
, repo
);
1164 if (option_no_tags
) {
1165 strbuf_addf(&key
, "remote.%s.tagOpt", remote_name
);
1166 git_config_set(key
.buf
, "--no-tags");
1170 if (option_required_reference
.nr
|| option_optional_reference
.nr
)
1173 if (option_sparse_checkout
&& git_sparse_checkout_init(dir
))
1176 remote
= remote_get(remote_name
);
1178 refspec_appendf(&remote
->fetch
, "+%s*:%s*", src_ref_prefix
,
1181 path
= get_repo_path(remote
->url
[0], &is_bundle
);
1182 is_local
= option_local
!= 0 && path
&& !is_bundle
;
1185 warning(_("--depth is ignored in local clones; use file:// instead."));
1187 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1189 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1190 if (filter_options
.choice
)
1191 warning(_("--filter is ignored in local clones; use file:// instead."));
1192 if (!access(mkpath("%s/shallow", path
), F_OK
)) {
1194 die(_("source repository is shallow, reject to clone."));
1195 if (option_local
> 0)
1196 warning(_("source repository is shallow, ignoring --local"));
1200 if (option_local
> 0 && !is_local
)
1201 warning(_("--local is ignored"));
1203 transport
= transport_get(remote
, path
? path
: remote
->url
[0]);
1204 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
1205 transport
->family
= family
;
1206 transport
->cloning
= 1;
1209 struct bundle_header header
= BUNDLE_HEADER_INIT
;
1210 int fd
= read_bundle_header(path
, &header
);
1211 int has_filter
= header
.filter
.choice
!= LOFC_DISABLED
;
1215 bundle_header_release(&header
);
1217 die(_("cannot clone from filtered bundle"));
1220 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
1223 transport_set_option(transport
, TRANS_OPT_REJECT_SHALLOW
, "1");
1225 transport_set_option(transport
, TRANS_OPT_DEPTH
,
1228 transport_set_option(transport
, TRANS_OPT_DEEPEN_SINCE
,
1231 transport_set_option(transport
, TRANS_OPT_DEEPEN_NOT
,
1232 (const char *)&option_not
);
1233 if (option_single_branch
)
1234 transport_set_option(transport
, TRANS_OPT_FOLLOWTAGS
, "1");
1236 if (option_upload_pack
)
1237 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
1238 option_upload_pack
);
1240 if (server_options
.nr
)
1241 transport
->server_options
= &server_options
;
1243 if (filter_options
.choice
) {
1245 expand_list_objects_filter_spec(&filter_options
);
1246 transport_set_option(transport
, TRANS_OPT_LIST_OBJECTS_FILTER
,
1248 transport_set_option(transport
, TRANS_OPT_FROM_PROMISOR
, "1");
1251 if (transport
->smart_options
&& !deepen
&& !filter_options
.choice
)
1252 transport
->smart_options
->check_self_contained_and_connected
= 1;
1255 * Before fetching from the remote, download and install bundle
1256 * data from the --bundle-uri option.
1259 int has_heuristic
= 0;
1261 /* At this point, we need the_repository to match the cloned repo. */
1262 if (repo_init(the_repository
, git_dir
, work_tree
))
1263 warning(_("failed to initialize the repo, skipping bundle URI"));
1264 else if (fetch_bundle_uri(the_repository
, bundle_uri
, &has_heuristic
))
1265 warning(_("failed to fetch objects from bundle URI '%s'"),
1267 else if (has_heuristic
)
1268 git_config_set_gently("fetch.bundleuri", bundle_uri
);
1271 strvec_push(&transport_ls_refs_options
.ref_prefixes
, "HEAD");
1272 refspec_ref_prefixes(&remote
->fetch
,
1273 &transport_ls_refs_options
.ref_prefixes
);
1275 expand_ref_prefix(&transport_ls_refs_options
.ref_prefixes
,
1277 if (!option_no_tags
)
1278 strvec_push(&transport_ls_refs_options
.ref_prefixes
,
1281 refs
= transport_get_remote_refs(transport
, &transport_ls_refs_options
);
1284 mapped_refs
= wanted_peer_refs(refs
, &remote
->fetch
);
1288 * Populate transport->got_remote_bundle_uri and
1289 * transport->bundle_uri. We might get nothing.
1291 transport_get_remote_bundle_uri(transport
);
1293 if (transport
->bundles
&&
1294 hashmap_get_size(&transport
->bundles
->bundles
)) {
1295 /* At this point, we need the_repository to match the cloned repo. */
1296 if (repo_init(the_repository
, git_dir
, work_tree
))
1297 warning(_("failed to initialize the repo, skipping bundle URI"));
1298 else if (fetch_bundle_list(the_repository
,
1299 transport
->bundles
))
1300 warning(_("failed to fetch advertised bundles"));
1302 clear_bundle_list(transport
->bundles
);
1303 FREE_AND_NULL(transport
->bundles
);
1308 int hash_algo
= hash_algo_by_ptr(transport_get_hash_algo(transport
));
1311 * Now that we know what algorithm the remote side is using,
1312 * let's set ours to the same thing.
1314 initialize_repository_version(hash_algo
, 1);
1315 repo_set_hash_algo(the_repository
, hash_algo
);
1317 * transport_get_remote_refs() may return refs with null sha-1
1318 * in mapped_refs (see struct transport->get_refs_list
1319 * comment). In that case we need fetch it early because
1320 * remote_head code below relies on it.
1322 * for normal clones, transport_get_remote_refs() should
1323 * return reliable ref set, we can delay cloning until after
1324 * remote HEAD check.
1326 for (ref
= refs
; ref
; ref
= ref
->next
)
1327 if (is_null_oid(&ref
->old_oid
)) {
1328 complete_refs_before_fetch
= 0;
1332 if (!is_local
&& !complete_refs_before_fetch
) {
1333 if (transport_fetch_refs(transport
, mapped_refs
))
1334 die(_("remote transport reported error"));
1338 remote_head
= find_ref_by_name(refs
, "HEAD");
1339 remote_head_points_at
= guess_remote_head(remote_head
, mapped_refs
, 0);
1341 if (option_branch
) {
1342 our_head_points_at
= find_remote_branch(mapped_refs
, option_branch
);
1343 if (!our_head_points_at
)
1344 die(_("Remote branch %s not found in upstream %s"),
1345 option_branch
, remote_name
);
1346 } else if (remote_head_points_at
) {
1347 our_head_points_at
= remote_head_points_at
;
1348 } else if (remote_head
) {
1349 our_head_points_at
= NULL
;
1354 warning(_("You appear to have cloned an empty repository."));
1355 option_no_checkout
= 1;
1358 if (transport_ls_refs_options
.unborn_head_target
&&
1359 skip_prefix(transport_ls_refs_options
.unborn_head_target
,
1360 "refs/heads/", &branch
)) {
1361 unborn_head
= xstrdup(transport_ls_refs_options
.unborn_head_target
);
1363 branch
= git_default_branch_name(0);
1364 unborn_head
= xstrfmt("refs/heads/%s", branch
);
1368 * We may have selected a local default branch name "foo",
1369 * and even though the remote's HEAD does not point there,
1370 * it may still have a "foo" branch. If so, set it up so
1371 * that we can follow the usual checkout code later.
1373 * Note that for an empty repo we'll already have set
1374 * option_no_checkout above, which would work against us here.
1375 * But for an empty repo, find_remote_branch() can never find
1378 our_head_points_at
= find_remote_branch(mapped_refs
, branch
);
1381 write_refspec_config(src_ref_prefix
, our_head_points_at
,
1382 remote_head_points_at
, &branch_top
);
1384 if (filter_options
.choice
)
1385 partial_clone_register(remote_name
, &filter_options
);
1388 clone_local(path
, git_dir
);
1389 else if (mapped_refs
&& complete_refs_before_fetch
) {
1390 if (transport_fetch_refs(transport
, mapped_refs
))
1391 die(_("remote transport reported error"));
1394 update_remote_refs(refs
, mapped_refs
, remote_head_points_at
,
1395 branch_top
.buf
, reflog_msg
.buf
, transport
,
1398 update_head(our_head_points_at
, remote_head
, unborn_head
, reflog_msg
.buf
);
1401 * We want to show progress for recursive submodule clones iff
1402 * we did so for the main clone. But only the transport knows
1403 * the final decision for this flag, so we need to rescue the value
1404 * before we free the transport.
1406 submodule_progress
= transport
->progress
;
1408 transport_unlock_pack(transport
, 0);
1409 transport_disconnect(transport
);
1411 if (option_dissociate
) {
1412 close_object_store(the_repository
->objects
);
1413 dissociate_from_references();
1416 junk_mode
= JUNK_LEAVE_REPO
;
1417 err
= checkout(submodule_progress
, filter_submodules
);
1420 strbuf_release(&reflog_msg
);
1421 strbuf_release(&branch_top
);
1422 strbuf_release(&key
);
1423 free_refs(mapped_refs
);
1424 free_refs(remote_head_points_at
);
1429 junk_mode
= JUNK_LEAVE_ALL
;
1431 transport_ls_refs_options_release(&transport_ls_refs_options
);