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 char *guess_dir_name(const char *repo
, int is_bundle
, int is_bare
)
222 const char *end
= repo
+ strlen(repo
), *start
, *ptr
;
229 start
= strstr(repo
, "://");
236 * Skip authentication data. The stripping does happen
237 * greedily, such that we strip up to the last '@' inside
240 for (ptr
= start
; ptr
< end
&& !is_dir_sep(*ptr
); ptr
++) {
246 * Strip trailing spaces, slashes and /.git
248 while (start
< end
&& (is_dir_sep(end
[-1]) || isspace(end
[-1])))
250 if (end
- start
> 5 && is_dir_sep(end
[-5]) &&
251 !strncmp(end
- 4, ".git", 4)) {
253 while (start
< end
&& is_dir_sep(end
[-1]))
258 * Strip trailing port number if we've got only a
259 * hostname (that is, there is no dir separator but a
260 * colon). This check is required such that we do not
261 * strip URI's like '/foo/bar:2222.git', which should
262 * result in a dir '2222' being guessed due to backwards
265 if (memchr(start
, '/', end
- start
) == NULL
266 && memchr(start
, ':', end
- start
) != NULL
) {
268 while (start
< ptr
&& isdigit(ptr
[-1]) && ptr
[-1] != ':')
270 if (start
< ptr
&& ptr
[-1] == ':')
275 * Find last component. To remain backwards compatible we
276 * also regard colons as path separators, such that
277 * cloning a repository 'foo:bar.git' would result in a
278 * directory 'bar' being guessed.
281 while (start
< ptr
&& !is_dir_sep(ptr
[-1]) && ptr
[-1] != ':')
286 * Strip .{bundle,git}.
289 strip_suffix_mem(start
, &len
, is_bundle
? ".bundle" : ".git");
291 if (!len
|| (len
== 1 && *start
== '/'))
292 die(_("No directory name could be guessed.\n"
293 "Please specify a directory on the command line"));
296 dir
= xstrfmt("%.*s.git", (int)len
, start
);
298 dir
= xstrndup(start
, len
);
300 * Replace sequences of 'control' characters and whitespace
301 * with one ascii space, remove leading and trailing spaces.
305 int prev_space
= 1 /* strip leading whitespace */;
306 for (end
= dir
; *end
; ++end
) {
308 if ((unsigned char)ch
< '\x20')
319 if (out
> dir
&& prev_space
)
325 static void strip_trailing_slashes(char *dir
)
327 char *end
= dir
+ strlen(dir
);
329 while (dir
< end
- 1 && is_dir_sep(end
[-1]))
334 static int add_one_reference(struct string_list_item
*item
, void *cb_data
)
336 struct strbuf err
= STRBUF_INIT
;
337 int *required
= cb_data
;
338 char *ref_git
= compute_alternate_path(item
->string
, &err
);
345 _("info: Could not add alternate for '%s': %s\n"),
346 item
->string
, err
.buf
);
348 struct strbuf sb
= STRBUF_INIT
;
349 strbuf_addf(&sb
, "%s/objects", ref_git
);
350 add_to_alternates_file(sb
.buf
);
354 strbuf_release(&err
);
359 static void setup_reference(void)
362 for_each_string_list(&option_required_reference
,
363 add_one_reference
, &required
);
365 for_each_string_list(&option_optional_reference
,
366 add_one_reference
, &required
);
369 static void copy_alternates(struct strbuf
*src
, const char *src_repo
)
372 * Read from the source objects/info/alternates file
373 * and copy the entries to corresponding file in the
374 * destination repository with add_to_alternates_file().
375 * Both src and dst have "$path/objects/info/alternates".
377 * Instead of copying bit-for-bit from the original,
378 * we need to append to existing one so that the already
379 * created entry via "clone -s" is not lost, and also
380 * to turn entries with paths relative to the original
381 * absolute, so that they can be used in the new repository.
383 FILE *in
= xfopen(src
->buf
, "r");
384 struct strbuf line
= STRBUF_INIT
;
386 while (strbuf_getline(&line
, in
) != EOF
) {
388 if (!line
.len
|| line
.buf
[0] == '#')
390 if (is_absolute_path(line
.buf
)) {
391 add_to_alternates_file(line
.buf
);
394 abs_path
= mkpathdup("%s/objects/%s", src_repo
, line
.buf
);
395 if (!normalize_path_copy(abs_path
, abs_path
))
396 add_to_alternates_file(abs_path
);
398 warning("skipping invalid relative alternate: %s/%s",
402 strbuf_release(&line
);
406 static void mkdir_if_missing(const char *pathname
, mode_t mode
)
410 if (!mkdir(pathname
, mode
))
414 die_errno(_("failed to create directory '%s'"), pathname
);
415 else if (stat(pathname
, &st
))
416 die_errno(_("failed to stat '%s'"), pathname
);
417 else if (!S_ISDIR(st
.st_mode
))
418 die(_("%s exists and is not a directory"), pathname
);
421 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
,
422 const char *src_repo
)
424 int src_len
, dest_len
;
425 struct dir_iterator
*iter
;
428 struct strbuf realpath
= STRBUF_INIT
;
430 mkdir_if_missing(dest
->buf
, 0777);
432 flags
= DIR_ITERATOR_PEDANTIC
| DIR_ITERATOR_FOLLOW_SYMLINKS
;
433 iter
= dir_iterator_begin(src
->buf
, flags
);
436 die_errno(_("failed to start iterator over '%s'"), src
->buf
);
438 strbuf_addch(src
, '/');
440 strbuf_addch(dest
, '/');
441 dest_len
= dest
->len
;
443 while ((iter_status
= dir_iterator_advance(iter
)) == ITER_OK
) {
444 strbuf_setlen(src
, src_len
);
445 strbuf_addstr(src
, iter
->relative_path
);
446 strbuf_setlen(dest
, dest_len
);
447 strbuf_addstr(dest
, iter
->relative_path
);
449 if (S_ISDIR(iter
->st
.st_mode
)) {
450 mkdir_if_missing(dest
->buf
, 0777);
454 /* Files that cannot be copied bit-for-bit... */
455 if (!fspathcmp(iter
->relative_path
, "info/alternates")) {
456 copy_alternates(src
, src_repo
);
460 if (unlink(dest
->buf
) && errno
!= ENOENT
)
461 die_errno(_("failed to unlink '%s'"), dest
->buf
);
462 if (!option_no_hardlinks
) {
463 strbuf_realpath(&realpath
, src
->buf
, 1);
464 if (!link(realpath
.buf
, dest
->buf
))
466 if (option_local
> 0)
467 die_errno(_("failed to create link '%s'"), dest
->buf
);
468 option_no_hardlinks
= 1;
470 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
471 die_errno(_("failed to copy file to '%s'"), dest
->buf
);
474 if (iter_status
!= ITER_DONE
) {
475 strbuf_setlen(src
, src_len
);
476 die(_("failed to iterate over '%s'"), src
->buf
);
479 strbuf_release(&realpath
);
482 static void clone_local(const char *src_repo
, const char *dest_repo
)
485 struct strbuf alt
= STRBUF_INIT
;
486 get_common_dir(&alt
, src_repo
);
487 strbuf_addstr(&alt
, "/objects");
488 add_to_alternates_file(alt
.buf
);
489 strbuf_release(&alt
);
491 struct strbuf src
= STRBUF_INIT
;
492 struct strbuf dest
= STRBUF_INIT
;
493 get_common_dir(&src
, src_repo
);
494 get_common_dir(&dest
, dest_repo
);
495 strbuf_addstr(&src
, "/objects");
496 strbuf_addstr(&dest
, "/objects");
497 copy_or_link_directory(&src
, &dest
, src_repo
);
498 strbuf_release(&src
);
499 strbuf_release(&dest
);
502 if (0 <= option_verbosity
)
503 fprintf(stderr
, _("done.\n"));
506 static const char *junk_work_tree
;
507 static int junk_work_tree_flags
;
508 static const char *junk_git_dir
;
509 static int junk_git_dir_flags
;
514 } junk_mode
= JUNK_LEAVE_NONE
;
516 static const char junk_leave_repo_msg
[] =
517 N_("Clone succeeded, but checkout failed.\n"
518 "You can inspect what was checked out with 'git status'\n"
519 "and retry with 'git restore --source=HEAD :/'\n");
521 static void remove_junk(void)
523 struct strbuf sb
= STRBUF_INIT
;
526 case JUNK_LEAVE_REPO
:
527 warning("%s", _(junk_leave_repo_msg
));
532 /* proceed to removal */
537 strbuf_addstr(&sb
, junk_git_dir
);
538 remove_dir_recursively(&sb
, junk_git_dir_flags
);
541 if (junk_work_tree
) {
542 strbuf_addstr(&sb
, junk_work_tree
);
543 remove_dir_recursively(&sb
, junk_work_tree_flags
);
548 static void remove_junk_on_signal(int signo
)
555 static struct ref
*find_remote_branch(const struct ref
*refs
, const char *branch
)
558 struct strbuf head
= STRBUF_INIT
;
559 strbuf_addstr(&head
, "refs/heads/");
560 strbuf_addstr(&head
, branch
);
561 ref
= find_ref_by_name(refs
, head
.buf
);
562 strbuf_release(&head
);
567 strbuf_addstr(&head
, "refs/tags/");
568 strbuf_addstr(&head
, branch
);
569 ref
= find_ref_by_name(refs
, head
.buf
);
570 strbuf_release(&head
);
575 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
576 struct refspec
*refspec
)
578 struct ref
*head
= copy_ref(find_ref_by_name(refs
, "HEAD"));
579 struct ref
*local_refs
= head
;
580 struct ref
**tail
= head
? &head
->next
: &local_refs
;
582 if (option_single_branch
) {
583 struct ref
*remote_head
= NULL
;
586 remote_head
= guess_remote_head(head
, refs
, 0);
590 remote_head
= copy_ref(find_remote_branch(refs
, option_branch
));
593 if (!remote_head
&& option_branch
)
594 warning(_("Could not find remote branch %s to clone."),
598 for (i
= 0; i
< refspec
->nr
; i
++)
599 get_fetch_map(remote_head
, &refspec
->items
[i
],
602 /* if --branch=tag, pull the requested tag explicitly */
603 get_fetch_map(remote_head
, tag_refspec
, &tail
, 0);
607 for (i
= 0; i
< refspec
->nr
; i
++)
608 get_fetch_map(refs
, &refspec
->items
[i
], &tail
, 0);
611 if (!option_mirror
&& !option_single_branch
&& !option_no_tags
)
612 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
617 static void write_remote_refs(const struct ref
*local_refs
)
621 struct ref_transaction
*t
;
622 struct strbuf err
= STRBUF_INIT
;
624 t
= ref_transaction_begin(&err
);
628 for (r
= local_refs
; r
; r
= r
->next
) {
631 if (ref_transaction_create(t
, r
->peer_ref
->name
, &r
->old_oid
,
636 if (initial_ref_transaction_commit(t
, &err
))
639 strbuf_release(&err
);
640 ref_transaction_free(t
);
643 static void write_followtags(const struct ref
*refs
, const char *msg
)
645 const struct ref
*ref
;
646 for (ref
= refs
; ref
; ref
= ref
->next
) {
647 if (!starts_with(ref
->name
, "refs/tags/"))
649 if (ends_with(ref
->name
, "^{}"))
651 if (!has_object_file_with_flags(&ref
->old_oid
,
653 OBJECT_INFO_SKIP_FETCH_OBJECT
))
655 update_ref(msg
, ref
->name
, &ref
->old_oid
, NULL
, 0,
656 UPDATE_REFS_DIE_ON_ERR
);
660 static int iterate_ref_map(void *cb_data
, struct object_id
*oid
)
662 struct ref
**rm
= cb_data
;
663 struct ref
*ref
= *rm
;
666 * Skip anything missing a peer_ref, which we are not
667 * actually going to write a ref for.
669 while (ref
&& !ref
->peer_ref
)
671 /* Returning -1 notes "end of list" to the caller. */
675 oidcpy(oid
, &ref
->old_oid
);
680 static void update_remote_refs(const struct ref
*refs
,
681 const struct ref
*mapped_refs
,
682 const struct ref
*remote_head_points_at
,
683 const char *branch_top
,
685 struct transport
*transport
,
686 int check_connectivity
)
688 const struct ref
*rm
= mapped_refs
;
690 if (check_connectivity
) {
691 struct check_connected_options opt
= CHECK_CONNECTED_INIT
;
693 opt
.transport
= transport
;
694 opt
.progress
= transport
->progress
;
696 if (check_connected(iterate_ref_map
, &rm
, &opt
))
697 die(_("remote did not send all necessary objects"));
701 write_remote_refs(mapped_refs
);
702 if (option_single_branch
&& !option_no_tags
)
703 write_followtags(refs
, msg
);
706 if (remote_head_points_at
&& !option_bare
) {
707 struct strbuf head_ref
= STRBUF_INIT
;
708 strbuf_addstr(&head_ref
, branch_top
);
709 strbuf_addstr(&head_ref
, "HEAD");
710 if (create_symref(head_ref
.buf
,
711 remote_head_points_at
->peer_ref
->name
,
713 die(_("unable to update %s"), head_ref
.buf
);
714 strbuf_release(&head_ref
);
718 static void update_head(const struct ref
*our
, const struct ref
*remote
,
722 if (our
&& skip_prefix(our
->name
, "refs/heads/", &head
)) {
723 /* Local default branch link */
724 if (create_symref("HEAD", our
->name
, NULL
) < 0)
725 die(_("unable to update HEAD"));
727 update_ref(msg
, "HEAD", &our
->old_oid
, NULL
, 0,
728 UPDATE_REFS_DIE_ON_ERR
);
729 install_branch_config(0, head
, remote_name
, our
->name
);
732 struct commit
*c
= lookup_commit_reference(the_repository
,
734 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
735 update_ref(msg
, "HEAD", &c
->object
.oid
, NULL
, REF_NO_DEREF
,
736 UPDATE_REFS_DIE_ON_ERR
);
739 * We know remote HEAD points to a non-branch, or
740 * HEAD points to a branch but we don't know which one.
741 * Detach HEAD in all these cases.
743 update_ref(msg
, "HEAD", &remote
->old_oid
, NULL
, REF_NO_DEREF
,
744 UPDATE_REFS_DIE_ON_ERR
);
748 static int git_sparse_checkout_init(const char *repo
)
750 struct strvec argv
= STRVEC_INIT
;
752 strvec_pushl(&argv
, "-C", repo
, "sparse-checkout", "init", NULL
);
755 * We must apply the setting in the current process
756 * for the later checkout to use the sparse-checkout file.
758 core_apply_sparse_checkout
= 1;
760 if (run_command_v_opt(argv
.v
, RUN_GIT_CMD
)) {
761 error(_("failed to initialize sparse-checkout"));
769 static int checkout(int submodule_progress
)
771 struct object_id oid
;
773 struct lock_file lock_file
= LOCK_INIT
;
774 struct unpack_trees_options opts
;
779 if (option_no_checkout
)
782 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, &oid
, NULL
);
784 warning(_("remote HEAD refers to nonexistent ref, "
785 "unable to checkout.\n"));
788 if (!strcmp(head
, "HEAD")) {
789 if (advice_detached_head
)
790 detach_advice(oid_to_hex(&oid
));
793 if (!starts_with(head
, "refs/heads/"))
794 die(_("HEAD not found below refs/heads!"));
797 /* We need to be in the new work tree for the checkout */
800 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
802 memset(&opts
, 0, sizeof opts
);
806 opts
.fn
= oneway_merge
;
807 opts
.verbose_update
= (option_verbosity
>= 0);
808 opts
.src_index
= &the_index
;
809 opts
.dst_index
= &the_index
;
810 init_checkout_metadata(&opts
.meta
, head
, &oid
, NULL
);
812 tree
= parse_tree_indirect(&oid
);
814 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
815 if (unpack_trees(1, &t
, &opts
) < 0)
816 die(_("unable to checkout working tree"));
820 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
821 die(_("unable to write new index file"));
823 err
|= run_hook_le(NULL
, "post-checkout", oid_to_hex(null_oid()),
824 oid_to_hex(&oid
), "1", NULL
);
826 if (!err
&& (option_recurse_submodules
.nr
> 0)) {
827 struct strvec args
= STRVEC_INIT
;
828 strvec_pushl(&args
, "submodule", "update", "--require-init", "--recursive", NULL
);
830 if (option_shallow_submodules
== 1)
831 strvec_push(&args
, "--depth=1");
834 strvec_pushf(&args
, "--jobs=%d", max_jobs
);
836 if (submodule_progress
)
837 strvec_push(&args
, "--progress");
839 if (option_verbosity
< 0)
840 strvec_push(&args
, "--quiet");
842 if (option_remote_submodules
) {
843 strvec_push(&args
, "--remote");
844 strvec_push(&args
, "--no-fetch");
847 if (option_single_branch
>= 0)
848 strvec_push(&args
, option_single_branch
?
850 "--no-single-branch");
852 err
= run_command_v_opt(args
.v
, RUN_GIT_CMD
);
859 static int git_clone_config(const char *k
, const char *v
, void *cb
)
861 if (!strcmp(k
, "clone.defaultremotename")) {
863 remote_name
= xstrdup(v
);
865 if (!strcmp(k
, "clone.rejectshallow"))
866 config_reject_shallow
= git_config_bool(k
, v
);
868 return git_default_config(k
, v
, cb
);
871 static int write_one_config(const char *key
, const char *value
, void *data
)
874 * give git_clone_config a chance to write config values back to the
875 * environment, since git_config_set_multivar_gently only deals with
878 int apply_failed
= git_clone_config(key
, value
, data
);
882 return git_config_set_multivar_gently(key
,
883 value
? value
: "true",
884 CONFIG_REGEX_NONE
, 0);
887 static void write_config(struct string_list
*config
)
891 for (i
= 0; i
< config
->nr
; i
++) {
892 if (git_config_parse_parameter(config
->items
[i
].string
,
893 write_one_config
, NULL
) < 0)
894 die(_("unable to write parameters to config file"));
898 static void write_refspec_config(const char *src_ref_prefix
,
899 const struct ref
*our_head_points_at
,
900 const struct ref
*remote_head_points_at
,
901 struct strbuf
*branch_top
)
903 struct strbuf key
= STRBUF_INIT
;
904 struct strbuf value
= STRBUF_INIT
;
906 if (option_mirror
|| !option_bare
) {
907 if (option_single_branch
&& !option_mirror
) {
909 if (starts_with(our_head_points_at
->name
, "refs/tags/"))
910 strbuf_addf(&value
, "+%s:%s", our_head_points_at
->name
,
911 our_head_points_at
->name
);
913 strbuf_addf(&value
, "+%s:%s%s", our_head_points_at
->name
,
914 branch_top
->buf
, option_branch
);
915 } else if (remote_head_points_at
) {
916 const char *head
= remote_head_points_at
->name
;
917 if (!skip_prefix(head
, "refs/heads/", &head
))
918 BUG("remote HEAD points at non-head?");
920 strbuf_addf(&value
, "+%s:%s%s", remote_head_points_at
->name
,
921 branch_top
->buf
, head
);
924 * otherwise, the next "git fetch" will
925 * simply fetch from HEAD without updating
926 * any remote-tracking branch, which is what
930 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
->buf
);
932 /* Configure the remote */
934 strbuf_addf(&key
, "remote.%s.fetch", remote_name
);
935 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
939 strbuf_addf(&key
, "remote.%s.mirror", remote_name
);
940 git_config_set(key
.buf
, "true");
946 strbuf_release(&key
);
947 strbuf_release(&value
);
950 static void dissociate_from_references(void)
952 static const char* argv
[] = { "repack", "-a", "-d", NULL
};
953 char *alternates
= git_pathdup("objects/info/alternates");
955 if (!access(alternates
, F_OK
)) {
956 if (run_command_v_opt(argv
, RUN_GIT_CMD
|RUN_COMMAND_NO_STDIN
))
957 die(_("cannot repack to clean up"));
958 if (unlink(alternates
) && errno
!= ENOENT
)
959 die_errno(_("cannot unlink temporary alternates file"));
964 static int path_exists(const char *path
)
967 return !stat(path
, &sb
);
970 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
972 int is_bundle
= 0, is_local
;
973 int reject_shallow
= 0;
974 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
975 char *path
= NULL
, *dir
, *display_repo
= NULL
;
976 int dest_exists
, real_dest_exists
= 0;
977 const struct ref
*refs
, *remote_head
;
978 struct ref
*remote_head_points_at
= NULL
;
979 const struct ref
*our_head_points_at
;
980 struct ref
*mapped_refs
;
981 const struct ref
*ref
;
982 struct strbuf key
= STRBUF_INIT
;
983 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
984 struct transport
*transport
= NULL
;
985 const char *src_ref_prefix
= "refs/heads/";
986 struct remote
*remote
;
987 int err
= 0, complete_refs_before_fetch
= 1;
988 int submodule_progress
;
990 struct transport_ls_refs_options transport_ls_refs_options
=
991 TRANSPORT_LS_REFS_OPTIONS_INIT
;
993 packet_trace_identity("clone");
995 git_config(git_clone_config
, NULL
);
997 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
998 builtin_clone_usage
, 0);
1001 usage_msg_opt(_("Too many arguments."),
1002 builtin_clone_usage
, builtin_clone_options
);
1005 usage_msg_opt(_("You must specify a repository to clone."),
1006 builtin_clone_usage
, builtin_clone_options
);
1008 if (option_depth
|| option_since
|| option_not
.nr
)
1010 if (option_single_branch
== -1)
1011 option_single_branch
= deepen
? 1 : 0;
1018 die(_("--bare and --origin %s options are incompatible."),
1021 die(_("--bare and --separate-git-dir are incompatible."));
1022 option_no_checkout
= 1;
1025 repo_name
= argv
[0];
1027 path
= get_repo_path(repo_name
, &is_bundle
);
1029 FREE_AND_NULL(path
);
1030 repo
= absolute_pathdup(repo_name
);
1031 } else if (strchr(repo_name
, ':')) {
1033 display_repo
= transport_anonymize_url(repo
);
1035 die(_("repository '%s' does not exist"), repo_name
);
1037 /* no need to be strict, transport_set_option() will validate it again */
1038 if (option_depth
&& atoi(option_depth
) < 1)
1039 die(_("depth %s is not a positive number"), option_depth
);
1042 dir
= xstrdup(argv
[1]);
1044 dir
= guess_dir_name(repo_name
, is_bundle
, option_bare
);
1045 strip_trailing_slashes(dir
);
1047 dest_exists
= path_exists(dir
);
1048 if (dest_exists
&& !is_empty_dir(dir
))
1049 die(_("destination path '%s' already exists and is not "
1050 "an empty directory."), dir
);
1053 real_dest_exists
= path_exists(real_git_dir
);
1054 if (real_dest_exists
&& !is_empty_dir(real_git_dir
))
1055 die(_("repository path '%s' already exists and is not "
1056 "an empty directory."), real_git_dir
);
1060 strbuf_addf(&reflog_msg
, "clone: from %s",
1061 display_repo
? display_repo
: repo
);
1067 work_tree
= getenv("GIT_WORK_TREE");
1068 if (work_tree
&& path_exists(work_tree
))
1069 die(_("working tree '%s' already exists."), work_tree
);
1072 if (option_bare
|| work_tree
)
1073 git_dir
= xstrdup(dir
);
1076 git_dir
= mkpathdup("%s/.git", dir
);
1079 atexit(remove_junk
);
1080 sigchain_push_common(remove_junk_on_signal
);
1083 if (safe_create_leading_directories_const(work_tree
) < 0)
1084 die_errno(_("could not create leading directories of '%s'"),
1087 junk_work_tree_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1088 else if (mkdir(work_tree
, 0777))
1089 die_errno(_("could not create work tree dir '%s'"),
1091 junk_work_tree
= work_tree
;
1092 set_git_work_tree(work_tree
);
1096 if (real_dest_exists
)
1097 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1098 junk_git_dir
= real_git_dir
;
1101 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1102 junk_git_dir
= git_dir
;
1104 if (safe_create_leading_directories_const(git_dir
) < 0)
1105 die(_("could not create leading directories of '%s'"), git_dir
);
1107 if (0 <= option_verbosity
) {
1109 fprintf(stderr
, _("Cloning into bare repository '%s'...\n"), dir
);
1111 fprintf(stderr
, _("Cloning into '%s'...\n"), dir
);
1114 if (option_recurse_submodules
.nr
> 0) {
1115 struct string_list_item
*item
;
1116 struct strbuf sb
= STRBUF_INIT
;
1118 /* remove duplicates */
1119 string_list_sort(&option_recurse_submodules
);
1120 string_list_remove_duplicates(&option_recurse_submodules
, 0);
1123 * NEEDSWORK: In a multi-working-tree world, this needs to be
1124 * set in the per-worktree config.
1126 for_each_string_list_item(item
, &option_recurse_submodules
) {
1127 strbuf_addf(&sb
, "submodule.active=%s",
1129 string_list_append(&option_config
,
1130 strbuf_detach(&sb
, NULL
));
1133 if (option_required_reference
.nr
&&
1134 option_optional_reference
.nr
)
1135 die(_("clone --recursive is not compatible with "
1136 "both --reference and --reference-if-able"));
1137 else if (option_required_reference
.nr
) {
1138 string_list_append(&option_config
,
1139 "submodule.alternateLocation=superproject");
1140 string_list_append(&option_config
,
1141 "submodule.alternateErrorStrategy=die");
1142 } else if (option_optional_reference
.nr
) {
1143 string_list_append(&option_config
,
1144 "submodule.alternateLocation=superproject");
1145 string_list_append(&option_config
,
1146 "submodule.alternateErrorStrategy=info");
1150 init_db(git_dir
, real_git_dir
, option_template
, GIT_HASH_UNKNOWN
, NULL
,
1154 git_dir
= real_git_dir
;
1157 * additional config can be injected with -c, make sure it's included
1158 * after init_db, which clears the entire config environment.
1160 write_config(&option_config
);
1163 * re-read config after init_db and write_config to pick up any config
1164 * injected by --template and --config, respectively.
1166 git_config(git_clone_config
, NULL
);
1169 * If option_reject_shallow is specified from CLI option,
1170 * ignore config_reject_shallow from git_clone_config.
1172 if (config_reject_shallow
!= -1)
1173 reject_shallow
= config_reject_shallow
;
1174 if (option_reject_shallow
!= -1)
1175 reject_shallow
= option_reject_shallow
;
1178 * apply the remote name provided by --origin only after this second
1179 * call to git_config, to ensure it overrides all config-based values.
1181 if (option_origin
!= NULL
)
1182 remote_name
= xstrdup(option_origin
);
1184 if (remote_name
== NULL
)
1185 remote_name
= xstrdup("origin");
1187 if (!valid_remote_name(remote_name
))
1188 die(_("'%s' is not a valid remote name"), remote_name
);
1192 src_ref_prefix
= "refs/";
1193 strbuf_addstr(&branch_top
, src_ref_prefix
);
1195 git_config_set("core.bare", "true");
1197 strbuf_addf(&branch_top
, "refs/remotes/%s/", remote_name
);
1200 strbuf_addf(&key
, "remote.%s.url", remote_name
);
1201 git_config_set(key
.buf
, repo
);
1204 if (option_no_tags
) {
1205 strbuf_addf(&key
, "remote.%s.tagOpt", remote_name
);
1206 git_config_set(key
.buf
, "--no-tags");
1210 if (option_required_reference
.nr
|| option_optional_reference
.nr
)
1213 if (option_sparse_checkout
&& git_sparse_checkout_init(dir
))
1216 remote
= remote_get(remote_name
);
1218 refspec_appendf(&remote
->fetch
, "+%s*:%s*", src_ref_prefix
,
1221 transport
= transport_get(remote
, remote
->url
[0]);
1222 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
1223 transport
->family
= family
;
1225 path
= get_repo_path(remote
->url
[0], &is_bundle
);
1226 is_local
= option_local
!= 0 && path
&& !is_bundle
;
1229 warning(_("--depth is ignored in local clones; use file:// instead."));
1231 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1233 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1234 if (filter_options
.choice
)
1235 warning(_("--filter is ignored in local clones; use file:// instead."));
1236 if (!access(mkpath("%s/shallow", path
), F_OK
)) {
1238 die(_("source repository is shallow, reject to clone."));
1239 if (option_local
> 0)
1240 warning(_("source repository is shallow, ignoring --local"));
1244 if (option_local
> 0 && !is_local
)
1245 warning(_("--local is ignored"));
1246 transport
->cloning
= 1;
1248 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
1251 transport_set_option(transport
, TRANS_OPT_REJECT_SHALLOW
, "1");
1253 transport_set_option(transport
, TRANS_OPT_DEPTH
,
1256 transport_set_option(transport
, TRANS_OPT_DEEPEN_SINCE
,
1259 transport_set_option(transport
, TRANS_OPT_DEEPEN_NOT
,
1260 (const char *)&option_not
);
1261 if (option_single_branch
)
1262 transport_set_option(transport
, TRANS_OPT_FOLLOWTAGS
, "1");
1264 if (option_upload_pack
)
1265 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
1266 option_upload_pack
);
1268 if (server_options
.nr
)
1269 transport
->server_options
= &server_options
;
1271 if (filter_options
.choice
) {
1273 expand_list_objects_filter_spec(&filter_options
);
1274 transport_set_option(transport
, TRANS_OPT_LIST_OBJECTS_FILTER
,
1276 transport_set_option(transport
, TRANS_OPT_FROM_PROMISOR
, "1");
1279 if (transport
->smart_options
&& !deepen
&& !filter_options
.choice
)
1280 transport
->smart_options
->check_self_contained_and_connected
= 1;
1283 strvec_push(&transport_ls_refs_options
.ref_prefixes
, "HEAD");
1284 refspec_ref_prefixes(&remote
->fetch
,
1285 &transport_ls_refs_options
.ref_prefixes
);
1287 expand_ref_prefix(&transport_ls_refs_options
.ref_prefixes
,
1289 if (!option_no_tags
)
1290 strvec_push(&transport_ls_refs_options
.ref_prefixes
,
1293 refs
= transport_get_remote_refs(transport
, &transport_ls_refs_options
);
1296 int hash_algo
= hash_algo_by_ptr(transport_get_hash_algo(transport
));
1299 * Now that we know what algorithm the remote side is using,
1300 * let's set ours to the same thing.
1302 initialize_repository_version(hash_algo
, 1);
1303 repo_set_hash_algo(the_repository
, hash_algo
);
1305 mapped_refs
= wanted_peer_refs(refs
, &remote
->fetch
);
1307 * transport_get_remote_refs() may return refs with null sha-1
1308 * in mapped_refs (see struct transport->get_refs_list
1309 * comment). In that case we need fetch it early because
1310 * remote_head code below relies on it.
1312 * for normal clones, transport_get_remote_refs() should
1313 * return reliable ref set, we can delay cloning until after
1314 * remote HEAD check.
1316 for (ref
= refs
; ref
; ref
= ref
->next
)
1317 if (is_null_oid(&ref
->old_oid
)) {
1318 complete_refs_before_fetch
= 0;
1322 if (!is_local
&& !complete_refs_before_fetch
) {
1323 err
= transport_fetch_refs(transport
, mapped_refs
);
1328 remote_head
= find_ref_by_name(refs
, "HEAD");
1329 remote_head_points_at
=
1330 guess_remote_head(remote_head
, mapped_refs
, 0);
1332 if (option_branch
) {
1333 our_head_points_at
=
1334 find_remote_branch(mapped_refs
, option_branch
);
1336 if (!our_head_points_at
)
1337 die(_("Remote branch %s not found in upstream %s"),
1338 option_branch
, remote_name
);
1341 our_head_points_at
= remote_head_points_at
;
1345 die(_("Remote branch %s not found in upstream %s"),
1346 option_branch
, remote_name
);
1348 warning(_("You appear to have cloned an empty repository."));
1350 our_head_points_at
= NULL
;
1351 remote_head_points_at
= NULL
;
1353 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 ref
= transport_ls_refs_options
.unborn_head_target
;
1362 transport_ls_refs_options
.unborn_head_target
= NULL
;
1363 create_symref("HEAD", ref
, reflog_msg
.buf
);
1365 branch
= git_default_branch_name(0);
1366 ref
= xstrfmt("refs/heads/%s", branch
);
1369 install_branch_config(0, branch
, remote_name
, ref
);
1374 write_refspec_config(src_ref_prefix
, our_head_points_at
,
1375 remote_head_points_at
, &branch_top
);
1377 if (filter_options
.choice
)
1378 partial_clone_register(remote_name
, &filter_options
);
1381 clone_local(path
, git_dir
);
1382 else if (refs
&& complete_refs_before_fetch
) {
1383 err
= transport_fetch_refs(transport
, mapped_refs
);
1388 update_remote_refs(refs
, mapped_refs
, remote_head_points_at
,
1389 branch_top
.buf
, reflog_msg
.buf
, transport
,
1392 update_head(our_head_points_at
, remote_head
, reflog_msg
.buf
);
1395 * We want to show progress for recursive submodule clones iff
1396 * we did so for the main clone. But only the transport knows
1397 * the final decision for this flag, so we need to rescue the value
1398 * before we free the transport.
1400 submodule_progress
= transport
->progress
;
1402 transport_unlock_pack(transport
);
1403 transport_disconnect(transport
);
1405 if (option_dissociate
) {
1406 close_object_store(the_repository
->objects
);
1407 dissociate_from_references();
1410 junk_mode
= JUNK_LEAVE_REPO
;
1411 err
= checkout(submodule_progress
);
1415 strbuf_release(&reflog_msg
);
1416 strbuf_release(&branch_top
);
1417 strbuf_release(&key
);
1418 free_refs(mapped_refs
);
1419 free_refs(remote_head_points_at
);
1423 junk_mode
= JUNK_LEAVE_ALL
;
1425 strvec_clear(&transport_ls_refs_options
.ref_prefixes
);
1426 free(transport_ls_refs_options
.unborn_head_target
);