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
17 #include "environment.h"
21 #include "parse-options.h"
22 #include "fetch-pack.h"
25 #include "object-file.h"
26 #include "object-store.h"
28 #include "tree-walk.h"
29 #include "unpack-trees.h"
30 #include "transport.h"
33 #include "dir-iterator.h"
38 #include "run-command.h"
40 #include "connected.h"
43 #include "list-objects-filter-options.h"
46 #include "bundle-uri.h"
51 * - respect DB_ENVIRONMENT for .git/objects.
53 * Implementation notes:
54 * - dropping use-separate-remote and no-separate-remote compatibility
57 static const char * const builtin_clone_usage
[] = {
58 N_("git clone [<options>] [--] <repo> [<dir>]"),
62 static int option_no_checkout
, option_bare
, option_mirror
, option_single_branch
= -1;
63 static int option_local
= -1, option_no_hardlinks
, option_shared
;
64 static int option_no_tags
;
65 static int option_shallow_submodules
;
66 static int option_reject_shallow
= -1; /* unspecified */
67 static int config_reject_shallow
= -1; /* unspecified */
69 static char *option_template
, *option_depth
, *option_since
;
70 static char *option_origin
= NULL
;
71 static char *remote_name
= NULL
;
72 static char *option_branch
= NULL
;
73 static struct string_list option_not
= STRING_LIST_INIT_NODUP
;
74 static const char *real_git_dir
;
75 static char *option_upload_pack
= "git-upload-pack";
76 static int option_verbosity
;
77 static int option_progress
= -1;
78 static int option_sparse_checkout
;
79 static enum transport_family family
;
80 static struct string_list option_config
= STRING_LIST_INIT_NODUP
;
81 static struct string_list option_required_reference
= STRING_LIST_INIT_NODUP
;
82 static struct string_list option_optional_reference
= STRING_LIST_INIT_NODUP
;
83 static int option_dissociate
;
84 static int max_jobs
= -1;
85 static struct string_list option_recurse_submodules
= STRING_LIST_INIT_NODUP
;
86 static struct list_objects_filter_options filter_options
= LIST_OBJECTS_FILTER_INIT
;
87 static int option_filter_submodules
= -1; /* unspecified */
88 static int config_filter_submodules
= -1; /* unspecified */
89 static struct string_list server_options
= STRING_LIST_INIT_NODUP
;
90 static int option_remote_submodules
;
91 static const char *bundle_uri
;
93 static int recurse_submodules_cb(const struct option
*opt
,
94 const char *arg
, int unset
)
97 string_list_clear((struct string_list
*)opt
->value
, 0);
99 string_list_append((struct string_list
*)opt
->value
, arg
);
101 string_list_append((struct string_list
*)opt
->value
,
102 (const char *)opt
->defval
);
107 static struct option builtin_clone_options
[] = {
108 OPT__VERBOSITY(&option_verbosity
),
109 OPT_BOOL(0, "progress", &option_progress
,
110 N_("force progress reporting")),
111 OPT_BOOL(0, "reject-shallow", &option_reject_shallow
,
112 N_("don't clone shallow repository")),
113 OPT_BOOL('n', "no-checkout", &option_no_checkout
,
114 N_("don't create a checkout")),
115 OPT_BOOL(0, "bare", &option_bare
, N_("create a bare repository")),
116 OPT_HIDDEN_BOOL(0, "naked", &option_bare
,
117 N_("create a bare repository")),
118 OPT_BOOL(0, "mirror", &option_mirror
,
119 N_("create a mirror repository (implies bare)")),
120 OPT_BOOL('l', "local", &option_local
,
121 N_("to clone from a local repository")),
122 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks
,
123 N_("don't use local hardlinks, always copy")),
124 OPT_BOOL('s', "shared", &option_shared
,
125 N_("setup as shared repository")),
126 { OPTION_CALLBACK
, 0, "recurse-submodules", &option_recurse_submodules
,
127 N_("pathspec"), N_("initialize submodules in the clone"),
128 PARSE_OPT_OPTARG
, recurse_submodules_cb
, (intptr_t)"." },
129 OPT_ALIAS(0, "recursive", "recurse-submodules"),
130 OPT_INTEGER('j', "jobs", &max_jobs
,
131 N_("number of submodules cloned in parallel")),
132 OPT_STRING(0, "template", &option_template
, N_("template-directory"),
133 N_("directory from which templates will be used")),
134 OPT_STRING_LIST(0, "reference", &option_required_reference
, N_("repo"),
135 N_("reference repository")),
136 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference
,
137 N_("repo"), N_("reference repository")),
138 OPT_BOOL(0, "dissociate", &option_dissociate
,
139 N_("use --reference only while cloning")),
140 OPT_STRING('o', "origin", &option_origin
, N_("name"),
141 N_("use <name> instead of 'origin' to track upstream")),
142 OPT_STRING('b', "branch", &option_branch
, N_("branch"),
143 N_("checkout <branch> instead of the remote's HEAD")),
144 OPT_STRING('u', "upload-pack", &option_upload_pack
, N_("path"),
145 N_("path to git-upload-pack on the remote")),
146 OPT_STRING(0, "depth", &option_depth
, N_("depth"),
147 N_("create a shallow clone of that depth")),
148 OPT_STRING(0, "shallow-since", &option_since
, N_("time"),
149 N_("create a shallow clone since a specific time")),
150 OPT_STRING_LIST(0, "shallow-exclude", &option_not
, N_("revision"),
151 N_("deepen history of shallow clone, excluding rev")),
152 OPT_BOOL(0, "single-branch", &option_single_branch
,
153 N_("clone only one branch, HEAD or --branch")),
154 OPT_BOOL(0, "no-tags", &option_no_tags
,
155 N_("don't clone any tags, and make later fetches not to follow them")),
156 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules
,
157 N_("any cloned submodules will be shallow")),
158 OPT_STRING(0, "separate-git-dir", &real_git_dir
, N_("gitdir"),
159 N_("separate git dir from working tree")),
160 OPT_STRING_LIST('c', "config", &option_config
, N_("key=value"),
161 N_("set config inside the new repository")),
162 OPT_STRING_LIST(0, "server-option", &server_options
,
163 N_("server-specific"), N_("option to transmit")),
164 OPT_SET_INT('4', "ipv4", &family
, N_("use IPv4 addresses only"),
165 TRANSPORT_FAMILY_IPV4
),
166 OPT_SET_INT('6', "ipv6", &family
, N_("use IPv6 addresses only"),
167 TRANSPORT_FAMILY_IPV6
),
168 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
169 OPT_BOOL(0, "also-filter-submodules", &option_filter_submodules
,
170 N_("apply partial clone filters to submodules")),
171 OPT_BOOL(0, "remote-submodules", &option_remote_submodules
,
172 N_("any cloned submodules will use their remote-tracking branch")),
173 OPT_BOOL(0, "sparse", &option_sparse_checkout
,
174 N_("initialize sparse-checkout file to include only files at root")),
175 OPT_STRING(0, "bundle-uri", &bundle_uri
,
176 N_("uri"), N_("a URI for downloading bundles before fetching from origin remote")),
180 static const char *get_repo_path_1(struct strbuf
*path
, int *is_bundle
)
182 static char *suffix
[] = { "/.git", "", ".git/.git", ".git" };
183 static char *bundle_suffix
[] = { ".bundle", "" };
184 size_t baselen
= path
->len
;
188 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
189 strbuf_setlen(path
, baselen
);
190 strbuf_addstr(path
, suffix
[i
]);
191 if (stat(path
->buf
, &st
))
193 if (S_ISDIR(st
.st_mode
) && is_git_directory(path
->buf
)) {
196 } else if (S_ISREG(st
.st_mode
) && st
.st_size
> 8) {
197 /* Is it a "gitfile"? */
200 int len
, fd
= open(path
->buf
, O_RDONLY
);
203 len
= read_in_full(fd
, signature
, 8);
205 if (len
!= 8 || strncmp(signature
, "gitdir: ", 8))
207 dst
= read_gitfile(path
->buf
);
215 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
216 strbuf_setlen(path
, baselen
);
217 strbuf_addstr(path
, bundle_suffix
[i
]);
218 if (!stat(path
->buf
, &st
) && S_ISREG(st
.st_mode
)) {
227 static char *get_repo_path(const char *repo
, int *is_bundle
)
229 struct strbuf path
= STRBUF_INIT
;
233 strbuf_addstr(&path
, repo
);
234 raw
= get_repo_path_1(&path
, is_bundle
);
235 canon
= raw
? absolute_pathdup(raw
) : NULL
;
236 strbuf_release(&path
);
240 static int add_one_reference(struct string_list_item
*item
, void *cb_data
)
242 struct strbuf err
= STRBUF_INIT
;
243 int *required
= cb_data
;
244 char *ref_git
= compute_alternate_path(item
->string
, &err
);
251 _("info: Could not add alternate for '%s': %s\n"),
252 item
->string
, err
.buf
);
254 struct strbuf sb
= STRBUF_INIT
;
255 strbuf_addf(&sb
, "%s/objects", ref_git
);
256 add_to_alternates_file(sb
.buf
);
260 strbuf_release(&err
);
265 static void setup_reference(void)
268 for_each_string_list(&option_required_reference
,
269 add_one_reference
, &required
);
271 for_each_string_list(&option_optional_reference
,
272 add_one_reference
, &required
);
275 static void copy_alternates(struct strbuf
*src
, const char *src_repo
)
278 * Read from the source objects/info/alternates file
279 * and copy the entries to corresponding file in the
280 * destination repository with add_to_alternates_file().
281 * Both src and dst have "$path/objects/info/alternates".
283 * Instead of copying bit-for-bit from the original,
284 * we need to append to existing one so that the already
285 * created entry via "clone -s" is not lost, and also
286 * to turn entries with paths relative to the original
287 * absolute, so that they can be used in the new repository.
289 FILE *in
= xfopen(src
->buf
, "r");
290 struct strbuf line
= STRBUF_INIT
;
292 while (strbuf_getline(&line
, in
) != EOF
) {
294 if (!line
.len
|| line
.buf
[0] == '#')
296 if (is_absolute_path(line
.buf
)) {
297 add_to_alternates_file(line
.buf
);
300 abs_path
= mkpathdup("%s/objects/%s", src_repo
, line
.buf
);
301 if (!normalize_path_copy(abs_path
, abs_path
))
302 add_to_alternates_file(abs_path
);
304 warning("skipping invalid relative alternate: %s/%s",
308 strbuf_release(&line
);
312 static void mkdir_if_missing(const char *pathname
, mode_t mode
)
316 if (!mkdir(pathname
, mode
))
320 die_errno(_("failed to create directory '%s'"), pathname
);
321 else if (stat(pathname
, &st
))
322 die_errno(_("failed to stat '%s'"), pathname
);
323 else if (!S_ISDIR(st
.st_mode
))
324 die(_("%s exists and is not a directory"), pathname
);
327 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
,
328 const char *src_repo
)
330 int src_len
, dest_len
;
331 struct dir_iterator
*iter
;
333 struct strbuf realpath
= STRBUF_INIT
;
335 mkdir_if_missing(dest
->buf
, 0777);
337 iter
= dir_iterator_begin(src
->buf
, DIR_ITERATOR_PEDANTIC
);
340 if (errno
== ENOTDIR
) {
341 int saved_errno
= errno
;
344 if (!lstat(src
->buf
, &st
) && S_ISLNK(st
.st_mode
))
345 die(_("'%s' is a symlink, refusing to clone with --local"),
349 die_errno(_("failed to start iterator over '%s'"), src
->buf
);
352 strbuf_addch(src
, '/');
354 strbuf_addch(dest
, '/');
355 dest_len
= dest
->len
;
357 while ((iter_status
= dir_iterator_advance(iter
)) == ITER_OK
) {
358 strbuf_setlen(src
, src_len
);
359 strbuf_addstr(src
, iter
->relative_path
);
360 strbuf_setlen(dest
, dest_len
);
361 strbuf_addstr(dest
, iter
->relative_path
);
363 if (S_ISLNK(iter
->st
.st_mode
))
364 die(_("symlink '%s' exists, refusing to clone with --local"),
365 iter
->relative_path
);
367 if (S_ISDIR(iter
->st
.st_mode
)) {
368 mkdir_if_missing(dest
->buf
, 0777);
372 /* Files that cannot be copied bit-for-bit... */
373 if (!fspathcmp(iter
->relative_path
, "info/alternates")) {
374 copy_alternates(src
, src_repo
);
378 if (unlink(dest
->buf
) && errno
!= ENOENT
)
379 die_errno(_("failed to unlink '%s'"), dest
->buf
);
380 if (!option_no_hardlinks
) {
381 strbuf_realpath(&realpath
, src
->buf
, 1);
382 if (!link(realpath
.buf
, dest
->buf
))
384 if (option_local
> 0)
385 die_errno(_("failed to create link '%s'"), dest
->buf
);
386 option_no_hardlinks
= 1;
388 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
389 die_errno(_("failed to copy file to '%s'"), dest
->buf
);
392 if (iter_status
!= ITER_DONE
) {
393 strbuf_setlen(src
, src_len
);
394 die(_("failed to iterate over '%s'"), src
->buf
);
397 strbuf_release(&realpath
);
400 static void clone_local(const char *src_repo
, const char *dest_repo
)
403 struct strbuf alt
= STRBUF_INIT
;
404 get_common_dir(&alt
, src_repo
);
405 strbuf_addstr(&alt
, "/objects");
406 add_to_alternates_file(alt
.buf
);
407 strbuf_release(&alt
);
409 struct strbuf src
= STRBUF_INIT
;
410 struct strbuf dest
= STRBUF_INIT
;
411 get_common_dir(&src
, src_repo
);
412 get_common_dir(&dest
, dest_repo
);
413 strbuf_addstr(&src
, "/objects");
414 strbuf_addstr(&dest
, "/objects");
415 copy_or_link_directory(&src
, &dest
, src_repo
);
416 strbuf_release(&src
);
417 strbuf_release(&dest
);
420 if (0 <= option_verbosity
)
421 fprintf(stderr
, _("done.\n"));
424 static const char *junk_work_tree
;
425 static int junk_work_tree_flags
;
426 static const char *junk_git_dir
;
427 static int junk_git_dir_flags
;
432 } junk_mode
= JUNK_LEAVE_NONE
;
434 static const char junk_leave_repo_msg
[] =
435 N_("Clone succeeded, but checkout failed.\n"
436 "You can inspect what was checked out with 'git status'\n"
437 "and retry with 'git restore --source=HEAD :/'\n");
439 static void remove_junk(void)
441 struct strbuf sb
= STRBUF_INIT
;
444 case JUNK_LEAVE_REPO
:
445 warning("%s", _(junk_leave_repo_msg
));
450 /* proceed to removal */
455 strbuf_addstr(&sb
, junk_git_dir
);
456 remove_dir_recursively(&sb
, junk_git_dir_flags
);
459 if (junk_work_tree
) {
460 strbuf_addstr(&sb
, junk_work_tree
);
461 remove_dir_recursively(&sb
, junk_work_tree_flags
);
466 static void remove_junk_on_signal(int signo
)
473 static struct ref
*find_remote_branch(const struct ref
*refs
, const char *branch
)
476 struct strbuf head
= STRBUF_INIT
;
477 strbuf_addstr(&head
, "refs/heads/");
478 strbuf_addstr(&head
, branch
);
479 ref
= find_ref_by_name(refs
, head
.buf
);
480 strbuf_release(&head
);
485 strbuf_addstr(&head
, "refs/tags/");
486 strbuf_addstr(&head
, branch
);
487 ref
= find_ref_by_name(refs
, head
.buf
);
488 strbuf_release(&head
);
493 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
494 struct refspec
*refspec
)
496 struct ref
*head
= copy_ref(find_ref_by_name(refs
, "HEAD"));
497 struct ref
*local_refs
= head
;
498 struct ref
**tail
= head
? &head
->next
: &local_refs
;
500 if (option_single_branch
) {
501 struct ref
*remote_head
= NULL
;
504 remote_head
= guess_remote_head(head
, refs
, 0);
508 remote_head
= copy_ref(find_remote_branch(refs
, option_branch
));
511 if (!remote_head
&& option_branch
)
512 warning(_("Could not find remote branch %s to clone."),
516 for (i
= 0; i
< refspec
->nr
; i
++)
517 get_fetch_map(remote_head
, &refspec
->items
[i
],
520 /* if --branch=tag, pull the requested tag explicitly */
521 get_fetch_map(remote_head
, tag_refspec
, &tail
, 0);
523 free_refs(remote_head
);
526 for (i
= 0; i
< refspec
->nr
; i
++)
527 get_fetch_map(refs
, &refspec
->items
[i
], &tail
, 0);
530 if (!option_mirror
&& !option_single_branch
&& !option_no_tags
)
531 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
536 static void write_remote_refs(const struct ref
*local_refs
)
540 struct ref_transaction
*t
;
541 struct strbuf err
= STRBUF_INIT
;
543 t
= ref_transaction_begin(&err
);
547 for (r
= local_refs
; r
; r
= r
->next
) {
550 if (ref_transaction_create(t
, r
->peer_ref
->name
, &r
->old_oid
,
555 if (initial_ref_transaction_commit(t
, &err
))
558 strbuf_release(&err
);
559 ref_transaction_free(t
);
562 static void write_followtags(const struct ref
*refs
, const char *msg
)
564 const struct ref
*ref
;
565 for (ref
= refs
; ref
; ref
= ref
->next
) {
566 if (!starts_with(ref
->name
, "refs/tags/"))
568 if (ends_with(ref
->name
, "^{}"))
570 if (!repo_has_object_file_with_flags(the_repository
, &ref
->old_oid
,
572 OBJECT_INFO_SKIP_FETCH_OBJECT
))
574 update_ref(msg
, ref
->name
, &ref
->old_oid
, NULL
, 0,
575 UPDATE_REFS_DIE_ON_ERR
);
579 static const struct object_id
*iterate_ref_map(void *cb_data
)
581 struct ref
**rm
= cb_data
;
582 struct ref
*ref
= *rm
;
585 * Skip anything missing a peer_ref, which we are not
586 * actually going to write a ref for.
588 while (ref
&& !ref
->peer_ref
)
594 return &ref
->old_oid
;
597 static void update_remote_refs(const struct ref
*refs
,
598 const struct ref
*mapped_refs
,
599 const struct ref
*remote_head_points_at
,
600 const char *branch_top
,
602 struct transport
*transport
,
603 int check_connectivity
)
605 const struct ref
*rm
= mapped_refs
;
607 if (check_connectivity
) {
608 struct check_connected_options opt
= CHECK_CONNECTED_INIT
;
610 opt
.transport
= transport
;
611 opt
.progress
= transport
->progress
;
613 if (check_connected(iterate_ref_map
, &rm
, &opt
))
614 die(_("remote did not send all necessary objects"));
618 write_remote_refs(mapped_refs
);
619 if (option_single_branch
&& !option_no_tags
)
620 write_followtags(refs
, msg
);
623 if (remote_head_points_at
&& !option_bare
) {
624 struct strbuf head_ref
= STRBUF_INIT
;
625 strbuf_addstr(&head_ref
, branch_top
);
626 strbuf_addstr(&head_ref
, "HEAD");
627 if (create_symref(head_ref
.buf
,
628 remote_head_points_at
->peer_ref
->name
,
630 die(_("unable to update %s"), head_ref
.buf
);
631 strbuf_release(&head_ref
);
635 static void update_head(const struct ref
*our
, const struct ref
*remote
,
636 const char *unborn
, const char *msg
)
639 if (our
&& skip_prefix(our
->name
, "refs/heads/", &head
)) {
640 /* Local default branch link */
641 if (create_symref("HEAD", our
->name
, NULL
) < 0)
642 die(_("unable to update HEAD"));
644 update_ref(msg
, "HEAD", &our
->old_oid
, NULL
, 0,
645 UPDATE_REFS_DIE_ON_ERR
);
646 install_branch_config(0, head
, remote_name
, our
->name
);
649 struct commit
*c
= lookup_commit_reference(the_repository
,
651 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
652 update_ref(msg
, "HEAD", &c
->object
.oid
, NULL
, REF_NO_DEREF
,
653 UPDATE_REFS_DIE_ON_ERR
);
656 * We know remote HEAD points to a non-branch, or
657 * HEAD points to a branch but we don't know which one.
658 * Detach HEAD in all these cases.
660 update_ref(msg
, "HEAD", &remote
->old_oid
, NULL
, REF_NO_DEREF
,
661 UPDATE_REFS_DIE_ON_ERR
);
662 } else if (unborn
&& skip_prefix(unborn
, "refs/heads/", &head
)) {
664 * Unborn head from remote; same as "our" case above except
665 * that we have no ref to update.
667 if (create_symref("HEAD", unborn
, NULL
) < 0)
668 die(_("unable to update HEAD"));
670 install_branch_config(0, head
, remote_name
, unborn
);
674 static int git_sparse_checkout_init(const char *repo
)
676 struct child_process cmd
= CHILD_PROCESS_INIT
;
678 strvec_pushl(&cmd
.args
, "-C", repo
, "sparse-checkout", "set", NULL
);
681 * We must apply the setting in the current process
682 * for the later checkout to use the sparse-checkout file.
684 core_apply_sparse_checkout
= 1;
687 if (run_command(&cmd
)) {
688 error(_("failed to initialize sparse-checkout"));
695 static int checkout(int submodule_progress
, int filter_submodules
)
697 struct object_id oid
;
699 struct lock_file lock_file
= LOCK_INIT
;
700 struct unpack_trees_options opts
;
705 if (option_no_checkout
)
708 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, &oid
, NULL
);
710 warning(_("remote HEAD refers to nonexistent ref, "
711 "unable to checkout"));
714 if (!strcmp(head
, "HEAD")) {
715 if (advice_enabled(ADVICE_DETACHED_HEAD
))
716 detach_advice(oid_to_hex(&oid
));
719 if (!starts_with(head
, "refs/heads/"))
720 die(_("HEAD not found below refs/heads!"));
723 /* We need to be in the new work tree for the checkout */
726 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
728 memset(&opts
, 0, sizeof opts
);
732 opts
.preserve_ignored
= 0;
733 opts
.fn
= oneway_merge
;
734 opts
.verbose_update
= (option_verbosity
>= 0);
735 opts
.src_index
= &the_index
;
736 opts
.dst_index
= &the_index
;
737 init_checkout_metadata(&opts
.meta
, head
, &oid
, NULL
);
739 tree
= parse_tree_indirect(&oid
);
741 die(_("unable to parse commit %s"), oid_to_hex(&oid
));
743 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
744 if (unpack_trees(1, &t
, &opts
) < 0)
745 die(_("unable to checkout working tree"));
749 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
750 die(_("unable to write new index file"));
752 err
|= run_hooks_l("post-checkout", oid_to_hex(null_oid()),
753 oid_to_hex(&oid
), "1", NULL
);
755 if (!err
&& (option_recurse_submodules
.nr
> 0)) {
756 struct child_process cmd
= CHILD_PROCESS_INIT
;
757 strvec_pushl(&cmd
.args
, "submodule", "update", "--require-init",
758 "--recursive", NULL
);
760 if (option_shallow_submodules
== 1)
761 strvec_push(&cmd
.args
, "--depth=1");
764 strvec_pushf(&cmd
.args
, "--jobs=%d", max_jobs
);
766 if (submodule_progress
)
767 strvec_push(&cmd
.args
, "--progress");
769 if (option_verbosity
< 0)
770 strvec_push(&cmd
.args
, "--quiet");
772 if (option_remote_submodules
) {
773 strvec_push(&cmd
.args
, "--remote");
774 strvec_push(&cmd
.args
, "--no-fetch");
777 if (filter_submodules
&& filter_options
.choice
)
778 strvec_pushf(&cmd
.args
, "--filter=%s",
779 expand_list_objects_filter_spec(&filter_options
));
781 if (option_single_branch
>= 0)
782 strvec_push(&cmd
.args
, option_single_branch
?
784 "--no-single-branch");
787 err
= run_command(&cmd
);
793 static int git_clone_config(const char *k
, const char *v
, void *cb
)
795 if (!strcmp(k
, "clone.defaultremotename")) {
797 remote_name
= xstrdup(v
);
799 if (!strcmp(k
, "clone.rejectshallow"))
800 config_reject_shallow
= git_config_bool(k
, v
);
801 if (!strcmp(k
, "clone.filtersubmodules"))
802 config_filter_submodules
= git_config_bool(k
, v
);
804 return git_default_config(k
, v
, cb
);
807 static int write_one_config(const char *key
, const char *value
, void *data
)
810 * give git_clone_config a chance to write config values back to the
811 * environment, since git_config_set_multivar_gently only deals with
814 int apply_failed
= git_clone_config(key
, value
, data
);
818 return git_config_set_multivar_gently(key
,
819 value
? value
: "true",
820 CONFIG_REGEX_NONE
, 0);
823 static void write_config(struct string_list
*config
)
827 for (i
= 0; i
< config
->nr
; i
++) {
828 if (git_config_parse_parameter(config
->items
[i
].string
,
829 write_one_config
, NULL
) < 0)
830 die(_("unable to write parameters to config file"));
834 static void write_refspec_config(const char *src_ref_prefix
,
835 const struct ref
*our_head_points_at
,
836 const struct ref
*remote_head_points_at
,
837 struct strbuf
*branch_top
)
839 struct strbuf key
= STRBUF_INIT
;
840 struct strbuf value
= STRBUF_INIT
;
842 if (option_mirror
|| !option_bare
) {
843 if (option_single_branch
&& !option_mirror
) {
845 if (starts_with(our_head_points_at
->name
, "refs/tags/"))
846 strbuf_addf(&value
, "+%s:%s", our_head_points_at
->name
,
847 our_head_points_at
->name
);
849 strbuf_addf(&value
, "+%s:%s%s", our_head_points_at
->name
,
850 branch_top
->buf
, option_branch
);
851 } else if (remote_head_points_at
) {
852 const char *head
= remote_head_points_at
->name
;
853 if (!skip_prefix(head
, "refs/heads/", &head
))
854 BUG("remote HEAD points at non-head?");
856 strbuf_addf(&value
, "+%s:%s%s", remote_head_points_at
->name
,
857 branch_top
->buf
, head
);
860 * otherwise, the next "git fetch" will
861 * simply fetch from HEAD without updating
862 * any remote-tracking branch, which is what
866 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
->buf
);
868 /* Configure the remote */
870 strbuf_addf(&key
, "remote.%s.fetch", remote_name
);
871 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
875 strbuf_addf(&key
, "remote.%s.mirror", remote_name
);
876 git_config_set(key
.buf
, "true");
882 strbuf_release(&key
);
883 strbuf_release(&value
);
886 static void dissociate_from_references(void)
888 char *alternates
= git_pathdup("objects/info/alternates");
890 if (!access(alternates
, F_OK
)) {
891 struct child_process cmd
= CHILD_PROCESS_INIT
;
895 strvec_pushl(&cmd
.args
, "repack", "-a", "-d", NULL
);
896 if (run_command(&cmd
))
897 die(_("cannot repack to clean up"));
898 if (unlink(alternates
) && errno
!= ENOENT
)
899 die_errno(_("cannot unlink temporary alternates file"));
904 static int path_exists(const char *path
)
907 return !stat(path
, &sb
);
910 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
912 int is_bundle
= 0, is_local
;
913 int reject_shallow
= 0;
914 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
915 char *repo_to_free
= NULL
;
916 char *path
= NULL
, *dir
, *display_repo
= NULL
;
917 int dest_exists
, real_dest_exists
= 0;
918 const struct ref
*refs
, *remote_head
;
919 struct ref
*remote_head_points_at
= NULL
;
920 const struct ref
*our_head_points_at
;
921 char *unborn_head
= NULL
;
922 struct ref
*mapped_refs
= NULL
;
923 const struct ref
*ref
;
924 struct strbuf key
= STRBUF_INIT
;
925 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
926 struct transport
*transport
= NULL
;
927 const char *src_ref_prefix
= "refs/heads/";
928 struct remote
*remote
;
929 int err
= 0, complete_refs_before_fetch
= 1;
930 int submodule_progress
;
931 int filter_submodules
= 0;
934 struct transport_ls_refs_options transport_ls_refs_options
=
935 TRANSPORT_LS_REFS_OPTIONS_INIT
;
937 packet_trace_identity("clone");
939 git_config(git_clone_config
, NULL
);
941 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
942 builtin_clone_usage
, 0);
945 usage_msg_opt(_("Too many arguments."),
946 builtin_clone_usage
, builtin_clone_options
);
949 usage_msg_opt(_("You must specify a repository to clone."),
950 builtin_clone_usage
, builtin_clone_options
);
952 if (option_depth
|| option_since
|| option_not
.nr
)
954 if (option_single_branch
== -1)
955 option_single_branch
= deepen
? 1 : 0;
962 die(_("options '%s' and '%s' cannot be used together"), "--bare", "--separate-git-dir");
963 option_no_checkout
= 1;
966 if (bundle_uri
&& deepen
)
967 die(_("--bundle-uri is incompatible with --depth, --shallow-since, and --shallow-exclude"));
971 path
= get_repo_path(repo_name
, &is_bundle
);
974 repo
= repo_to_free
= absolute_pathdup(repo_name
);
975 } else if (strchr(repo_name
, ':')) {
977 display_repo
= transport_anonymize_url(repo
);
979 die(_("repository '%s' does not exist"), repo_name
);
981 /* no need to be strict, transport_set_option() will validate it again */
982 if (option_depth
&& atoi(option_depth
) < 1)
983 die(_("depth %s is not a positive number"), option_depth
);
986 dir
= xstrdup(argv
[1]);
988 dir
= git_url_basename(repo_name
, is_bundle
, option_bare
);
989 strip_dir_trailing_slashes(dir
);
991 dest_exists
= path_exists(dir
);
992 if (dest_exists
&& !is_empty_dir(dir
))
993 die(_("destination path '%s' already exists and is not "
994 "an empty directory."), dir
);
997 real_dest_exists
= path_exists(real_git_dir
);
998 if (real_dest_exists
&& !is_empty_dir(real_git_dir
))
999 die(_("repository path '%s' already exists and is not "
1000 "an empty directory."), real_git_dir
);
1004 strbuf_addf(&reflog_msg
, "clone: from %s",
1005 display_repo
? display_repo
: repo
);
1011 work_tree
= getenv("GIT_WORK_TREE");
1012 if (work_tree
&& path_exists(work_tree
))
1013 die(_("working tree '%s' already exists."), work_tree
);
1016 if (option_bare
|| work_tree
)
1017 git_dir
= xstrdup(dir
);
1020 git_dir
= mkpathdup("%s/.git", dir
);
1023 atexit(remove_junk
);
1024 sigchain_push_common(remove_junk_on_signal
);
1027 if (safe_create_leading_directories_const(work_tree
) < 0)
1028 die_errno(_("could not create leading directories of '%s'"),
1031 junk_work_tree_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1032 else if (mkdir(work_tree
, 0777))
1033 die_errno(_("could not create work tree dir '%s'"),
1035 junk_work_tree
= work_tree
;
1036 set_git_work_tree(work_tree
);
1040 if (real_dest_exists
)
1041 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1042 junk_git_dir
= real_git_dir
;
1045 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1046 junk_git_dir
= git_dir
;
1048 if (safe_create_leading_directories_const(git_dir
) < 0)
1049 die(_("could not create leading directories of '%s'"), git_dir
);
1051 if (0 <= option_verbosity
) {
1053 fprintf(stderr
, _("Cloning into bare repository '%s'...\n"), dir
);
1055 fprintf(stderr
, _("Cloning into '%s'...\n"), dir
);
1058 if (option_recurse_submodules
.nr
> 0) {
1059 struct string_list_item
*item
;
1060 struct strbuf sb
= STRBUF_INIT
;
1063 /* remove duplicates */
1064 string_list_sort(&option_recurse_submodules
);
1065 string_list_remove_duplicates(&option_recurse_submodules
, 0);
1068 * NEEDSWORK: In a multi-working-tree world, this needs to be
1069 * set in the per-worktree config.
1071 for_each_string_list_item(item
, &option_recurse_submodules
) {
1072 strbuf_addf(&sb
, "submodule.active=%s",
1074 string_list_append(&option_config
,
1075 strbuf_detach(&sb
, NULL
));
1078 if (!git_config_get_bool("submodule.stickyRecursiveClone", &val
) &&
1080 string_list_append(&option_config
, "submodule.recurse=true");
1082 if (option_required_reference
.nr
&&
1083 option_optional_reference
.nr
)
1084 die(_("clone --recursive is not compatible with "
1085 "both --reference and --reference-if-able"));
1086 else if (option_required_reference
.nr
) {
1087 string_list_append(&option_config
,
1088 "submodule.alternateLocation=superproject");
1089 string_list_append(&option_config
,
1090 "submodule.alternateErrorStrategy=die");
1091 } else if (option_optional_reference
.nr
) {
1092 string_list_append(&option_config
,
1093 "submodule.alternateLocation=superproject");
1094 string_list_append(&option_config
,
1095 "submodule.alternateErrorStrategy=info");
1099 init_db(git_dir
, real_git_dir
, option_template
, GIT_HASH_UNKNOWN
, NULL
,
1103 free((char *)git_dir
);
1104 git_dir
= real_git_dir
;
1108 * additional config can be injected with -c, make sure it's included
1109 * after init_db, which clears the entire config environment.
1111 write_config(&option_config
);
1114 * re-read config after init_db and write_config to pick up any config
1115 * injected by --template and --config, respectively.
1117 git_config(git_clone_config
, NULL
);
1120 * If option_reject_shallow is specified from CLI option,
1121 * ignore config_reject_shallow from git_clone_config.
1123 if (config_reject_shallow
!= -1)
1124 reject_shallow
= config_reject_shallow
;
1125 if (option_reject_shallow
!= -1)
1126 reject_shallow
= option_reject_shallow
;
1129 * If option_filter_submodules is specified from CLI option,
1130 * ignore config_filter_submodules from git_clone_config.
1132 if (config_filter_submodules
!= -1)
1133 filter_submodules
= config_filter_submodules
;
1134 if (option_filter_submodules
!= -1)
1135 filter_submodules
= option_filter_submodules
;
1138 * Exit if the user seems to be doing something silly with submodule
1139 * filter flags (but not with filter configs, as those should be
1142 if (option_filter_submodules
> 0 && !filter_options
.choice
)
1143 die(_("the option '%s' requires '%s'"),
1144 "--also-filter-submodules", "--filter");
1145 if (option_filter_submodules
> 0 && !option_recurse_submodules
.nr
)
1146 die(_("the option '%s' requires '%s'"),
1147 "--also-filter-submodules", "--recurse-submodules");
1150 * apply the remote name provided by --origin only after this second
1151 * call to git_config, to ensure it overrides all config-based values.
1153 if (option_origin
) {
1155 remote_name
= xstrdup(option_origin
);
1159 remote_name
= xstrdup("origin");
1161 if (!valid_remote_name(remote_name
))
1162 die(_("'%s' is not a valid remote name"), remote_name
);
1166 src_ref_prefix
= "refs/";
1167 strbuf_addstr(&branch_top
, src_ref_prefix
);
1169 git_config_set("core.bare", "true");
1171 strbuf_addf(&branch_top
, "refs/remotes/%s/", remote_name
);
1174 strbuf_addf(&key
, "remote.%s.url", remote_name
);
1175 git_config_set(key
.buf
, repo
);
1178 if (option_no_tags
) {
1179 strbuf_addf(&key
, "remote.%s.tagOpt", remote_name
);
1180 git_config_set(key
.buf
, "--no-tags");
1184 if (option_required_reference
.nr
|| option_optional_reference
.nr
)
1187 if (option_sparse_checkout
&& git_sparse_checkout_init(dir
))
1190 remote
= remote_get(remote_name
);
1192 refspec_appendf(&remote
->fetch
, "+%s*:%s*", src_ref_prefix
,
1195 path
= get_repo_path(remote
->url
[0], &is_bundle
);
1196 is_local
= option_local
!= 0 && path
&& !is_bundle
;
1199 warning(_("--depth is ignored in local clones; use file:// instead."));
1201 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1203 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1204 if (filter_options
.choice
)
1205 warning(_("--filter is ignored in local clones; use file:// instead."));
1206 if (!access(mkpath("%s/shallow", path
), F_OK
)) {
1208 die(_("source repository is shallow, reject to clone."));
1209 if (option_local
> 0)
1210 warning(_("source repository is shallow, ignoring --local"));
1214 if (option_local
> 0 && !is_local
)
1215 warning(_("--local is ignored"));
1217 transport
= transport_get(remote
, path
? path
: remote
->url
[0]);
1218 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
1219 transport
->family
= family
;
1220 transport
->cloning
= 1;
1223 struct bundle_header header
= BUNDLE_HEADER_INIT
;
1224 int fd
= read_bundle_header(path
, &header
);
1225 int has_filter
= header
.filter
.choice
!= LOFC_DISABLED
;
1229 bundle_header_release(&header
);
1231 die(_("cannot clone from filtered bundle"));
1234 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
1237 transport_set_option(transport
, TRANS_OPT_REJECT_SHALLOW
, "1");
1239 transport_set_option(transport
, TRANS_OPT_DEPTH
,
1242 transport_set_option(transport
, TRANS_OPT_DEEPEN_SINCE
,
1245 transport_set_option(transport
, TRANS_OPT_DEEPEN_NOT
,
1246 (const char *)&option_not
);
1247 if (option_single_branch
)
1248 transport_set_option(transport
, TRANS_OPT_FOLLOWTAGS
, "1");
1250 if (option_upload_pack
)
1251 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
1252 option_upload_pack
);
1254 if (server_options
.nr
)
1255 transport
->server_options
= &server_options
;
1257 if (filter_options
.choice
) {
1259 expand_list_objects_filter_spec(&filter_options
);
1260 transport_set_option(transport
, TRANS_OPT_LIST_OBJECTS_FILTER
,
1262 transport_set_option(transport
, TRANS_OPT_FROM_PROMISOR
, "1");
1265 if (transport
->smart_options
&& !deepen
&& !filter_options
.choice
)
1266 transport
->smart_options
->check_self_contained_and_connected
= 1;
1269 * Before fetching from the remote, download and install bundle
1270 * data from the --bundle-uri option.
1273 int has_heuristic
= 0;
1275 /* At this point, we need the_repository to match the cloned repo. */
1276 if (repo_init(the_repository
, git_dir
, work_tree
))
1277 warning(_("failed to initialize the repo, skipping bundle URI"));
1278 else if (fetch_bundle_uri(the_repository
, bundle_uri
, &has_heuristic
))
1279 warning(_("failed to fetch objects from bundle URI '%s'"),
1281 else if (has_heuristic
)
1282 git_config_set_gently("fetch.bundleuri", bundle_uri
);
1285 strvec_push(&transport_ls_refs_options
.ref_prefixes
, "HEAD");
1286 refspec_ref_prefixes(&remote
->fetch
,
1287 &transport_ls_refs_options
.ref_prefixes
);
1289 expand_ref_prefix(&transport_ls_refs_options
.ref_prefixes
,
1291 if (!option_no_tags
)
1292 strvec_push(&transport_ls_refs_options
.ref_prefixes
,
1295 refs
= transport_get_remote_refs(transport
, &transport_ls_refs_options
);
1298 mapped_refs
= wanted_peer_refs(refs
, &remote
->fetch
);
1302 * Populate transport->got_remote_bundle_uri and
1303 * transport->bundle_uri. We might get nothing.
1305 transport_get_remote_bundle_uri(transport
);
1307 if (transport
->bundles
&&
1308 hashmap_get_size(&transport
->bundles
->bundles
)) {
1309 /* At this point, we need the_repository to match the cloned repo. */
1310 if (repo_init(the_repository
, git_dir
, work_tree
))
1311 warning(_("failed to initialize the repo, skipping bundle URI"));
1312 else if (fetch_bundle_list(the_repository
,
1313 transport
->bundles
))
1314 warning(_("failed to fetch advertised bundles"));
1316 clear_bundle_list(transport
->bundles
);
1317 FREE_AND_NULL(transport
->bundles
);
1322 * Now that we know what algorithm the remote side is using,
1323 * let's set ours to the same thing.
1325 hash_algo
= hash_algo_by_ptr(transport_get_hash_algo(transport
));
1326 initialize_repository_version(hash_algo
, 1);
1327 repo_set_hash_algo(the_repository
, hash_algo
);
1331 * transport_get_remote_refs() may return refs with null sha-1
1332 * in mapped_refs (see struct transport->get_refs_list
1333 * comment). In that case we need fetch it early because
1334 * remote_head code below relies on it.
1336 * for normal clones, transport_get_remote_refs() should
1337 * return reliable ref set, we can delay cloning until after
1338 * remote HEAD check.
1340 for (ref
= refs
; ref
; ref
= ref
->next
)
1341 if (is_null_oid(&ref
->old_oid
)) {
1342 complete_refs_before_fetch
= 0;
1346 if (!is_local
&& !complete_refs_before_fetch
) {
1347 if (transport_fetch_refs(transport
, mapped_refs
))
1348 die(_("remote transport reported error"));
1352 remote_head
= find_ref_by_name(refs
, "HEAD");
1353 remote_head_points_at
= guess_remote_head(remote_head
, mapped_refs
, 0);
1355 if (option_branch
) {
1356 our_head_points_at
= find_remote_branch(mapped_refs
, option_branch
);
1357 if (!our_head_points_at
)
1358 die(_("Remote branch %s not found in upstream %s"),
1359 option_branch
, remote_name
);
1360 } else if (remote_head_points_at
) {
1361 our_head_points_at
= remote_head_points_at
;
1362 } else if (remote_head
) {
1363 our_head_points_at
= NULL
;
1368 warning(_("You appear to have cloned an empty repository."));
1369 option_no_checkout
= 1;
1372 if (transport_ls_refs_options
.unborn_head_target
&&
1373 skip_prefix(transport_ls_refs_options
.unborn_head_target
,
1374 "refs/heads/", &branch
)) {
1375 unborn_head
= xstrdup(transport_ls_refs_options
.unborn_head_target
);
1377 branch
= git_default_branch_name(0);
1378 unborn_head
= xstrfmt("refs/heads/%s", branch
);
1382 * We may have selected a local default branch name "foo",
1383 * and even though the remote's HEAD does not point there,
1384 * it may still have a "foo" branch. If so, set it up so
1385 * that we can follow the usual checkout code later.
1387 * Note that for an empty repo we'll already have set
1388 * option_no_checkout above, which would work against us here.
1389 * But for an empty repo, find_remote_branch() can never find
1392 our_head_points_at
= find_remote_branch(mapped_refs
, branch
);
1395 write_refspec_config(src_ref_prefix
, our_head_points_at
,
1396 remote_head_points_at
, &branch_top
);
1398 if (filter_options
.choice
)
1399 partial_clone_register(remote_name
, &filter_options
);
1402 clone_local(path
, git_dir
);
1403 else if (mapped_refs
&& complete_refs_before_fetch
) {
1404 if (transport_fetch_refs(transport
, mapped_refs
))
1405 die(_("remote transport reported error"));
1408 update_remote_refs(refs
, mapped_refs
, remote_head_points_at
,
1409 branch_top
.buf
, reflog_msg
.buf
, transport
,
1412 update_head(our_head_points_at
, remote_head
, unborn_head
, reflog_msg
.buf
);
1415 * We want to show progress for recursive submodule clones iff
1416 * we did so for the main clone. But only the transport knows
1417 * the final decision for this flag, so we need to rescue the value
1418 * before we free the transport.
1420 submodule_progress
= transport
->progress
;
1422 transport_unlock_pack(transport
, 0);
1423 transport_disconnect(transport
);
1425 if (option_dissociate
) {
1426 close_object_store(the_repository
->objects
);
1427 dissociate_from_references();
1430 junk_mode
= JUNK_LEAVE_REPO
;
1431 err
= checkout(submodule_progress
, filter_submodules
);
1434 strbuf_release(&reflog_msg
);
1435 strbuf_release(&branch_top
);
1436 strbuf_release(&key
);
1437 free_refs(mapped_refs
);
1438 free_refs(remote_head_points_at
);
1443 junk_mode
= JUNK_LEAVE_ALL
;
1445 transport_ls_refs_options_release(&transport_ls_refs_options
);