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"
29 #include "run-command.h"
30 #include "connected.h"
32 #include "list-objects-filter-options.h"
33 #include "object-store.h"
37 * - respect DB_ENVIRONMENT for .git/objects.
39 * Implementation notes:
40 * - dropping use-separate-remote and no-separate-remote compatibility
43 static const char * const builtin_clone_usage
[] = {
44 N_("git clone [<options>] [--] <repo> [<dir>]"),
48 static int option_no_checkout
, option_bare
, option_mirror
, option_single_branch
= -1;
49 static int option_local
= -1, option_no_hardlinks
, option_shared
;
50 static int option_no_tags
;
51 static int option_shallow_submodules
;
53 static char *option_template
, *option_depth
, *option_since
;
54 static char *option_origin
= NULL
;
55 static char *option_branch
= NULL
;
56 static struct string_list option_not
= STRING_LIST_INIT_NODUP
;
57 static const char *real_git_dir
;
58 static char *option_upload_pack
= "git-upload-pack";
59 static int option_verbosity
;
60 static int option_progress
= -1;
61 static enum transport_family family
;
62 static struct string_list option_config
= STRING_LIST_INIT_NODUP
;
63 static struct string_list option_required_reference
= STRING_LIST_INIT_NODUP
;
64 static struct string_list option_optional_reference
= STRING_LIST_INIT_NODUP
;
65 static int option_dissociate
;
66 static int max_jobs
= -1;
67 static struct string_list option_recurse_submodules
= STRING_LIST_INIT_NODUP
;
68 static struct list_objects_filter_options filter_options
;
69 static struct string_list server_options
= STRING_LIST_INIT_NODUP
;
71 static int recurse_submodules_cb(const struct option
*opt
,
72 const char *arg
, int unset
)
75 string_list_clear((struct string_list
*)opt
->value
, 0);
77 string_list_append((struct string_list
*)opt
->value
, arg
);
79 string_list_append((struct string_list
*)opt
->value
,
80 (const char *)opt
->defval
);
85 static struct option builtin_clone_options
[] = {
86 OPT__VERBOSITY(&option_verbosity
),
87 OPT_BOOL(0, "progress", &option_progress
,
88 N_("force progress reporting")),
89 OPT_BOOL('n', "no-checkout", &option_no_checkout
,
90 N_("don't create a checkout")),
91 OPT_BOOL(0, "bare", &option_bare
, N_("create a bare repository")),
92 OPT_HIDDEN_BOOL(0, "naked", &option_bare
,
93 N_("create a bare repository")),
94 OPT_BOOL(0, "mirror", &option_mirror
,
95 N_("create a mirror repository (implies bare)")),
96 OPT_BOOL('l', "local", &option_local
,
97 N_("to clone from a local repository")),
98 OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks
,
99 N_("don't use local hardlinks, always copy")),
100 OPT_BOOL('s', "shared", &option_shared
,
101 N_("setup as shared repository")),
102 OPT_ALIAS(0, "recursive", "recurse-submodules"),
103 { OPTION_CALLBACK
, 0, "recurse-submodules", &option_recurse_submodules
,
104 N_("pathspec"), N_("initialize submodules in the clone"),
105 PARSE_OPT_OPTARG
, recurse_submodules_cb
, (intptr_t)"." },
106 OPT_INTEGER('j', "jobs", &max_jobs
,
107 N_("number of submodules cloned in parallel")),
108 OPT_STRING(0, "template", &option_template
, N_("template-directory"),
109 N_("directory from which templates will be used")),
110 OPT_STRING_LIST(0, "reference", &option_required_reference
, N_("repo"),
111 N_("reference repository")),
112 OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference
,
113 N_("repo"), N_("reference repository")),
114 OPT_BOOL(0, "dissociate", &option_dissociate
,
115 N_("use --reference only while cloning")),
116 OPT_STRING('o', "origin", &option_origin
, N_("name"),
117 N_("use <name> instead of 'origin' to track upstream")),
118 OPT_STRING('b', "branch", &option_branch
, N_("branch"),
119 N_("checkout <branch> instead of the remote's HEAD")),
120 OPT_STRING('u', "upload-pack", &option_upload_pack
, N_("path"),
121 N_("path to git-upload-pack on the remote")),
122 OPT_STRING(0, "depth", &option_depth
, N_("depth"),
123 N_("create a shallow clone of that depth")),
124 OPT_STRING(0, "shallow-since", &option_since
, N_("time"),
125 N_("create a shallow clone since a specific time")),
126 OPT_STRING_LIST(0, "shallow-exclude", &option_not
, N_("revision"),
127 N_("deepen history of shallow clone, excluding rev")),
128 OPT_BOOL(0, "single-branch", &option_single_branch
,
129 N_("clone only one branch, HEAD or --branch")),
130 OPT_BOOL(0, "no-tags", &option_no_tags
,
131 N_("don't clone any tags, and make later fetches not to follow them")),
132 OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules
,
133 N_("any cloned submodules will be shallow")),
134 OPT_STRING(0, "separate-git-dir", &real_git_dir
, N_("gitdir"),
135 N_("separate git dir from working tree")),
136 OPT_STRING_LIST('c', "config", &option_config
, N_("key=value"),
137 N_("set config inside the new repository")),
138 OPT_STRING_LIST(0, "server-option", &server_options
,
139 N_("server-specific"), N_("option to transmit")),
140 OPT_SET_INT('4', "ipv4", &family
, N_("use IPv4 addresses only"),
141 TRANSPORT_FAMILY_IPV4
),
142 OPT_SET_INT('6', "ipv6", &family
, N_("use IPv6 addresses only"),
143 TRANSPORT_FAMILY_IPV6
),
144 OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options
),
148 static const char *get_repo_path_1(struct strbuf
*path
, int *is_bundle
)
150 static char *suffix
[] = { "/.git", "", ".git/.git", ".git" };
151 static char *bundle_suffix
[] = { ".bundle", "" };
152 size_t baselen
= path
->len
;
156 for (i
= 0; i
< ARRAY_SIZE(suffix
); i
++) {
157 strbuf_setlen(path
, baselen
);
158 strbuf_addstr(path
, suffix
[i
]);
159 if (stat(path
->buf
, &st
))
161 if (S_ISDIR(st
.st_mode
) && is_git_directory(path
->buf
)) {
164 } else if (S_ISREG(st
.st_mode
) && st
.st_size
> 8) {
165 /* Is it a "gitfile"? */
168 int len
, fd
= open(path
->buf
, O_RDONLY
);
171 len
= read_in_full(fd
, signature
, 8);
173 if (len
!= 8 || strncmp(signature
, "gitdir: ", 8))
175 dst
= read_gitfile(path
->buf
);
183 for (i
= 0; i
< ARRAY_SIZE(bundle_suffix
); i
++) {
184 strbuf_setlen(path
, baselen
);
185 strbuf_addstr(path
, bundle_suffix
[i
]);
186 if (!stat(path
->buf
, &st
) && S_ISREG(st
.st_mode
)) {
195 static char *get_repo_path(const char *repo
, int *is_bundle
)
197 struct strbuf path
= STRBUF_INIT
;
201 strbuf_addstr(&path
, repo
);
202 raw
= get_repo_path_1(&path
, is_bundle
);
203 canon
= raw
? absolute_pathdup(raw
) : NULL
;
204 strbuf_release(&path
);
208 static char *guess_dir_name(const char *repo
, int is_bundle
, int is_bare
)
210 const char *end
= repo
+ strlen(repo
), *start
, *ptr
;
217 start
= strstr(repo
, "://");
224 * Skip authentication data. The stripping does happen
225 * greedily, such that we strip up to the last '@' inside
228 for (ptr
= start
; ptr
< end
&& !is_dir_sep(*ptr
); ptr
++) {
234 * Strip trailing spaces, slashes and /.git
236 while (start
< end
&& (is_dir_sep(end
[-1]) || isspace(end
[-1])))
238 if (end
- start
> 5 && is_dir_sep(end
[-5]) &&
239 !strncmp(end
- 4, ".git", 4)) {
241 while (start
< end
&& is_dir_sep(end
[-1]))
246 * Strip trailing port number if we've got only a
247 * hostname (that is, there is no dir separator but a
248 * colon). This check is required such that we do not
249 * strip URI's like '/foo/bar:2222.git', which should
250 * result in a dir '2222' being guessed due to backwards
253 if (memchr(start
, '/', end
- start
) == NULL
254 && memchr(start
, ':', end
- start
) != NULL
) {
256 while (start
< ptr
&& isdigit(ptr
[-1]) && ptr
[-1] != ':')
258 if (start
< ptr
&& ptr
[-1] == ':')
263 * Find last component. To remain backwards compatible we
264 * also regard colons as path separators, such that
265 * cloning a repository 'foo:bar.git' would result in a
266 * directory 'bar' being guessed.
269 while (start
< ptr
&& !is_dir_sep(ptr
[-1]) && ptr
[-1] != ':')
274 * Strip .{bundle,git}.
277 strip_suffix_mem(start
, &len
, is_bundle
? ".bundle" : ".git");
279 if (!len
|| (len
== 1 && *start
== '/'))
280 die(_("No directory name could be guessed.\n"
281 "Please specify a directory on the command line"));
284 dir
= xstrfmt("%.*s.git", (int)len
, start
);
286 dir
= xstrndup(start
, len
);
288 * Replace sequences of 'control' characters and whitespace
289 * with one ascii space, remove leading and trailing spaces.
293 int prev_space
= 1 /* strip leading whitespace */;
294 for (end
= dir
; *end
; ++end
) {
296 if ((unsigned char)ch
< '\x20')
307 if (out
> dir
&& prev_space
)
313 static void strip_trailing_slashes(char *dir
)
315 char *end
= dir
+ strlen(dir
);
317 while (dir
< end
- 1 && is_dir_sep(end
[-1]))
322 static int add_one_reference(struct string_list_item
*item
, void *cb_data
)
324 struct strbuf err
= STRBUF_INIT
;
325 int *required
= cb_data
;
326 char *ref_git
= compute_alternate_path(item
->string
, &err
);
333 _("info: Could not add alternate for '%s': %s\n"),
334 item
->string
, err
.buf
);
336 struct strbuf sb
= STRBUF_INIT
;
337 strbuf_addf(&sb
, "%s/objects", ref_git
);
338 add_to_alternates_file(sb
.buf
);
342 strbuf_release(&err
);
347 static void setup_reference(void)
350 for_each_string_list(&option_required_reference
,
351 add_one_reference
, &required
);
353 for_each_string_list(&option_optional_reference
,
354 add_one_reference
, &required
);
357 static void copy_alternates(struct strbuf
*src
, const char *src_repo
)
360 * Read from the source objects/info/alternates file
361 * and copy the entries to corresponding file in the
362 * destination repository with add_to_alternates_file().
363 * Both src and dst have "$path/objects/info/alternates".
365 * Instead of copying bit-for-bit from the original,
366 * we need to append to existing one so that the already
367 * created entry via "clone -s" is not lost, and also
368 * to turn entries with paths relative to the original
369 * absolute, so that they can be used in the new repository.
371 FILE *in
= xfopen(src
->buf
, "r");
372 struct strbuf line
= STRBUF_INIT
;
374 while (strbuf_getline(&line
, in
) != EOF
) {
376 if (!line
.len
|| line
.buf
[0] == '#')
378 if (is_absolute_path(line
.buf
)) {
379 add_to_alternates_file(line
.buf
);
382 abs_path
= mkpathdup("%s/objects/%s", src_repo
, line
.buf
);
383 if (!normalize_path_copy(abs_path
, abs_path
))
384 add_to_alternates_file(abs_path
);
386 warning("skipping invalid relative alternate: %s/%s",
390 strbuf_release(&line
);
394 static void copy_or_link_directory(struct strbuf
*src
, struct strbuf
*dest
,
395 const char *src_repo
, int src_baselen
)
399 int src_len
, dest_len
;
402 dir
= opendir(src
->buf
);
404 die_errno(_("failed to open '%s'"), src
->buf
);
406 if (mkdir(dest
->buf
, 0777)) {
408 die_errno(_("failed to create directory '%s'"), dest
->buf
);
409 else if (stat(dest
->buf
, &buf
))
410 die_errno(_("failed to stat '%s'"), dest
->buf
);
411 else if (!S_ISDIR(buf
.st_mode
))
412 die(_("%s exists and is not a directory"), dest
->buf
);
415 strbuf_addch(src
, '/');
417 strbuf_addch(dest
, '/');
418 dest_len
= dest
->len
;
420 while ((de
= readdir(dir
)) != NULL
) {
421 strbuf_setlen(src
, src_len
);
422 strbuf_addstr(src
, de
->d_name
);
423 strbuf_setlen(dest
, dest_len
);
424 strbuf_addstr(dest
, de
->d_name
);
425 if (stat(src
->buf
, &buf
)) {
426 warning (_("failed to stat %s\n"), src
->buf
);
429 if (S_ISDIR(buf
.st_mode
)) {
430 if (de
->d_name
[0] != '.')
431 copy_or_link_directory(src
, dest
,
432 src_repo
, src_baselen
);
436 /* Files that cannot be copied bit-for-bit... */
437 if (!strcmp(src
->buf
+ src_baselen
, "/info/alternates")) {
438 copy_alternates(src
, src_repo
);
442 if (unlink(dest
->buf
) && errno
!= ENOENT
)
443 die_errno(_("failed to unlink '%s'"), dest
->buf
);
444 if (!option_no_hardlinks
) {
445 if (!link(src
->buf
, dest
->buf
))
447 if (option_local
> 0)
448 die_errno(_("failed to create link '%s'"), dest
->buf
);
449 option_no_hardlinks
= 1;
451 if (copy_file_with_time(dest
->buf
, src
->buf
, 0666))
452 die_errno(_("failed to copy file to '%s'"), dest
->buf
);
457 static void clone_local(const char *src_repo
, const char *dest_repo
)
460 struct strbuf alt
= STRBUF_INIT
;
461 get_common_dir(&alt
, src_repo
);
462 strbuf_addstr(&alt
, "/objects");
463 add_to_alternates_file(alt
.buf
);
464 strbuf_release(&alt
);
466 struct strbuf src
= STRBUF_INIT
;
467 struct strbuf dest
= STRBUF_INIT
;
468 get_common_dir(&src
, src_repo
);
469 get_common_dir(&dest
, dest_repo
);
470 strbuf_addstr(&src
, "/objects");
471 strbuf_addstr(&dest
, "/objects");
472 copy_or_link_directory(&src
, &dest
, src_repo
, src
.len
);
473 strbuf_release(&src
);
474 strbuf_release(&dest
);
477 if (0 <= option_verbosity
)
478 fprintf(stderr
, _("done.\n"));
481 static const char *junk_work_tree
;
482 static int junk_work_tree_flags
;
483 static const char *junk_git_dir
;
484 static int junk_git_dir_flags
;
489 } junk_mode
= JUNK_LEAVE_NONE
;
491 static const char junk_leave_repo_msg
[] =
492 N_("Clone succeeded, but checkout failed.\n"
493 "You can inspect what was checked out with 'git status'\n"
494 "and retry the checkout with 'git checkout -f HEAD'\n");
496 static void remove_junk(void)
498 struct strbuf sb
= STRBUF_INIT
;
501 case JUNK_LEAVE_REPO
:
502 warning("%s", _(junk_leave_repo_msg
));
507 /* proceed to removal */
512 strbuf_addstr(&sb
, junk_git_dir
);
513 remove_dir_recursively(&sb
, junk_git_dir_flags
);
516 if (junk_work_tree
) {
517 strbuf_addstr(&sb
, junk_work_tree
);
518 remove_dir_recursively(&sb
, junk_work_tree_flags
);
523 static void remove_junk_on_signal(int signo
)
530 static struct ref
*find_remote_branch(const struct ref
*refs
, const char *branch
)
533 struct strbuf head
= STRBUF_INIT
;
534 strbuf_addstr(&head
, "refs/heads/");
535 strbuf_addstr(&head
, branch
);
536 ref
= find_ref_by_name(refs
, head
.buf
);
537 strbuf_release(&head
);
542 strbuf_addstr(&head
, "refs/tags/");
543 strbuf_addstr(&head
, branch
);
544 ref
= find_ref_by_name(refs
, head
.buf
);
545 strbuf_release(&head
);
550 static struct ref
*wanted_peer_refs(const struct ref
*refs
,
551 struct refspec
*refspec
)
553 struct ref
*head
= copy_ref(find_ref_by_name(refs
, "HEAD"));
554 struct ref
*local_refs
= head
;
555 struct ref
**tail
= head
? &head
->next
: &local_refs
;
557 if (option_single_branch
) {
558 struct ref
*remote_head
= NULL
;
561 remote_head
= guess_remote_head(head
, refs
, 0);
565 remote_head
= copy_ref(find_remote_branch(refs
, option_branch
));
568 if (!remote_head
&& option_branch
)
569 warning(_("Could not find remote branch %s to clone."),
573 for (i
= 0; i
< refspec
->nr
; i
++)
574 get_fetch_map(remote_head
, &refspec
->items
[i
],
577 /* if --branch=tag, pull the requested tag explicitly */
578 get_fetch_map(remote_head
, tag_refspec
, &tail
, 0);
582 for (i
= 0; i
< refspec
->nr
; i
++)
583 get_fetch_map(refs
, &refspec
->items
[i
], &tail
, 0);
586 if (!option_mirror
&& !option_single_branch
&& !option_no_tags
)
587 get_fetch_map(refs
, tag_refspec
, &tail
, 0);
592 static void write_remote_refs(const struct ref
*local_refs
)
596 struct ref_transaction
*t
;
597 struct strbuf err
= STRBUF_INIT
;
599 t
= ref_transaction_begin(&err
);
603 for (r
= local_refs
; r
; r
= r
->next
) {
606 if (ref_transaction_create(t
, r
->peer_ref
->name
, &r
->old_oid
,
611 if (initial_ref_transaction_commit(t
, &err
))
614 strbuf_release(&err
);
615 ref_transaction_free(t
);
618 static void write_followtags(const struct ref
*refs
, const char *msg
)
620 const struct ref
*ref
;
621 for (ref
= refs
; ref
; ref
= ref
->next
) {
622 if (!starts_with(ref
->name
, "refs/tags/"))
624 if (ends_with(ref
->name
, "^{}"))
626 if (!has_object_file(&ref
->old_oid
))
628 update_ref(msg
, ref
->name
, &ref
->old_oid
, NULL
, 0,
629 UPDATE_REFS_DIE_ON_ERR
);
633 static int iterate_ref_map(void *cb_data
, struct object_id
*oid
)
635 struct ref
**rm
= cb_data
;
636 struct ref
*ref
= *rm
;
639 * Skip anything missing a peer_ref, which we are not
640 * actually going to write a ref for.
642 while (ref
&& !ref
->peer_ref
)
644 /* Returning -1 notes "end of list" to the caller. */
648 oidcpy(oid
, &ref
->old_oid
);
653 static void update_remote_refs(const struct ref
*refs
,
654 const struct ref
*mapped_refs
,
655 const struct ref
*remote_head_points_at
,
656 const char *branch_top
,
658 struct transport
*transport
,
659 int check_connectivity
,
662 const struct ref
*rm
= mapped_refs
;
664 if (check_connectivity
) {
665 struct check_connected_options opt
= CHECK_CONNECTED_INIT
;
667 opt
.transport
= transport
;
668 opt
.progress
= transport
->progress
;
669 opt
.check_refs_only
= !!check_refs_only
;
671 if (check_connected(iterate_ref_map
, &rm
, &opt
))
672 die(_("remote did not send all necessary objects"));
676 write_remote_refs(mapped_refs
);
677 if (option_single_branch
&& !option_no_tags
)
678 write_followtags(refs
, msg
);
681 if (remote_head_points_at
&& !option_bare
) {
682 struct strbuf head_ref
= STRBUF_INIT
;
683 strbuf_addstr(&head_ref
, branch_top
);
684 strbuf_addstr(&head_ref
, "HEAD");
685 if (create_symref(head_ref
.buf
,
686 remote_head_points_at
->peer_ref
->name
,
688 die(_("unable to update %s"), head_ref
.buf
);
689 strbuf_release(&head_ref
);
693 static void update_head(const struct ref
*our
, const struct ref
*remote
,
697 if (our
&& skip_prefix(our
->name
, "refs/heads/", &head
)) {
698 /* Local default branch link */
699 if (create_symref("HEAD", our
->name
, NULL
) < 0)
700 die(_("unable to update HEAD"));
702 update_ref(msg
, "HEAD", &our
->old_oid
, NULL
, 0,
703 UPDATE_REFS_DIE_ON_ERR
);
704 install_branch_config(0, head
, option_origin
, our
->name
);
707 struct commit
*c
= lookup_commit_reference(the_repository
,
709 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
710 update_ref(msg
, "HEAD", &c
->object
.oid
, NULL
, REF_NO_DEREF
,
711 UPDATE_REFS_DIE_ON_ERR
);
714 * We know remote HEAD points to a non-branch, or
715 * HEAD points to a branch but we don't know which one.
716 * Detach HEAD in all these cases.
718 update_ref(msg
, "HEAD", &remote
->old_oid
, NULL
, REF_NO_DEREF
,
719 UPDATE_REFS_DIE_ON_ERR
);
723 static int checkout(int submodule_progress
)
725 struct object_id oid
;
727 struct lock_file lock_file
= LOCK_INIT
;
728 struct unpack_trees_options opts
;
733 if (option_no_checkout
)
736 head
= resolve_refdup("HEAD", RESOLVE_REF_READING
, &oid
, NULL
);
738 warning(_("remote HEAD refers to nonexistent ref, "
739 "unable to checkout.\n"));
742 if (!strcmp(head
, "HEAD")) {
743 if (advice_detached_head
)
744 detach_advice(oid_to_hex(&oid
));
746 if (!starts_with(head
, "refs/heads/"))
747 die(_("HEAD not found below refs/heads!"));
751 /* We need to be in the new work tree for the checkout */
754 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
756 memset(&opts
, 0, sizeof opts
);
760 opts
.fn
= oneway_merge
;
761 opts
.verbose_update
= (option_verbosity
>= 0);
762 opts
.src_index
= &the_index
;
763 opts
.dst_index
= &the_index
;
765 tree
= parse_tree_indirect(&oid
);
767 init_tree_desc(&t
, tree
->buffer
, tree
->size
);
768 if (unpack_trees(1, &t
, &opts
) < 0)
769 die(_("unable to checkout working tree"));
771 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
772 die(_("unable to write new index file"));
774 err
|= run_hook_le(NULL
, "post-checkout", sha1_to_hex(null_sha1
),
775 oid_to_hex(&oid
), "1", NULL
);
777 if (!err
&& (option_recurse_submodules
.nr
> 0)) {
778 struct argv_array args
= ARGV_ARRAY_INIT
;
779 argv_array_pushl(&args
, "submodule", "update", "--init", "--recursive", NULL
);
781 if (option_shallow_submodules
== 1)
782 argv_array_push(&args
, "--depth=1");
785 argv_array_pushf(&args
, "--jobs=%d", max_jobs
);
787 if (submodule_progress
)
788 argv_array_push(&args
, "--progress");
790 if (option_verbosity
< 0)
791 argv_array_push(&args
, "--quiet");
793 err
= run_command_v_opt(args
.argv
, RUN_GIT_CMD
);
794 argv_array_clear(&args
);
800 static int write_one_config(const char *key
, const char *value
, void *data
)
802 return git_config_set_multivar_gently(key
,
803 value
? value
: "true",
804 CONFIG_REGEX_NONE
, 0);
807 static void write_config(struct string_list
*config
)
811 for (i
= 0; i
< config
->nr
; i
++) {
812 if (git_config_parse_parameter(config
->items
[i
].string
,
813 write_one_config
, NULL
) < 0)
814 die(_("unable to write parameters to config file"));
818 static void write_refspec_config(const char *src_ref_prefix
,
819 const struct ref
*our_head_points_at
,
820 const struct ref
*remote_head_points_at
,
821 struct strbuf
*branch_top
)
823 struct strbuf key
= STRBUF_INIT
;
824 struct strbuf value
= STRBUF_INIT
;
826 if (option_mirror
|| !option_bare
) {
827 if (option_single_branch
&& !option_mirror
) {
829 if (starts_with(our_head_points_at
->name
, "refs/tags/"))
830 strbuf_addf(&value
, "+%s:%s", our_head_points_at
->name
,
831 our_head_points_at
->name
);
833 strbuf_addf(&value
, "+%s:%s%s", our_head_points_at
->name
,
834 branch_top
->buf
, option_branch
);
835 } else if (remote_head_points_at
) {
836 const char *head
= remote_head_points_at
->name
;
837 if (!skip_prefix(head
, "refs/heads/", &head
))
838 BUG("remote HEAD points at non-head?");
840 strbuf_addf(&value
, "+%s:%s%s", remote_head_points_at
->name
,
841 branch_top
->buf
, head
);
844 * otherwise, the next "git fetch" will
845 * simply fetch from HEAD without updating
846 * any remote-tracking branch, which is what
850 strbuf_addf(&value
, "+%s*:%s*", src_ref_prefix
, branch_top
->buf
);
852 /* Configure the remote */
854 strbuf_addf(&key
, "remote.%s.fetch", option_origin
);
855 git_config_set_multivar(key
.buf
, value
.buf
, "^$", 0);
859 strbuf_addf(&key
, "remote.%s.mirror", option_origin
);
860 git_config_set(key
.buf
, "true");
866 strbuf_release(&key
);
867 strbuf_release(&value
);
870 static void dissociate_from_references(void)
872 static const char* argv
[] = { "repack", "-a", "-d", NULL
};
873 char *alternates
= git_pathdup("objects/info/alternates");
875 if (!access(alternates
, F_OK
)) {
876 if (run_command_v_opt(argv
, RUN_GIT_CMD
|RUN_COMMAND_NO_STDIN
))
877 die(_("cannot repack to clean up"));
878 if (unlink(alternates
) && errno
!= ENOENT
)
879 die_errno(_("cannot unlink temporary alternates file"));
884 static int dir_exists(const char *path
)
887 return !stat(path
, &sb
);
890 int cmd_clone(int argc
, const char **argv
, const char *prefix
)
892 int is_bundle
= 0, is_local
;
893 const char *repo_name
, *repo
, *work_tree
, *git_dir
;
896 const struct ref
*refs
, *remote_head
;
897 const struct ref
*remote_head_points_at
;
898 const struct ref
*our_head_points_at
;
899 struct ref
*mapped_refs
;
900 const struct ref
*ref
;
901 struct strbuf key
= STRBUF_INIT
;
902 struct strbuf default_refspec
= STRBUF_INIT
;
903 struct strbuf branch_top
= STRBUF_INIT
, reflog_msg
= STRBUF_INIT
;
904 struct transport
*transport
= NULL
;
905 const char *src_ref_prefix
= "refs/heads/";
906 struct remote
*remote
;
907 int err
= 0, complete_refs_before_fetch
= 1;
908 int submodule_progress
;
910 struct argv_array ref_prefixes
= ARGV_ARRAY_INIT
;
912 fetch_if_missing
= 0;
914 packet_trace_identity("clone");
915 argc
= parse_options(argc
, argv
, prefix
, builtin_clone_options
,
916 builtin_clone_usage
, 0);
919 usage_msg_opt(_("Too many arguments."),
920 builtin_clone_usage
, builtin_clone_options
);
923 usage_msg_opt(_("You must specify a repository to clone."),
924 builtin_clone_usage
, builtin_clone_options
);
926 if (option_depth
|| option_since
|| option_not
.nr
)
928 if (option_single_branch
== -1)
929 option_single_branch
= deepen
? 1 : 0;
936 die(_("--bare and --origin %s options are incompatible."),
939 die(_("--bare and --separate-git-dir are incompatible."));
940 option_no_checkout
= 1;
944 option_origin
= "origin";
948 path
= get_repo_path(repo_name
, &is_bundle
);
950 repo
= absolute_pathdup(repo_name
);
951 else if (!strchr(repo_name
, ':'))
952 die(_("repository '%s' does not exist"), repo_name
);
956 /* no need to be strict, transport_set_option() will validate it again */
957 if (option_depth
&& atoi(option_depth
) < 1)
958 die(_("depth %s is not a positive number"), option_depth
);
961 dir
= xstrdup(argv
[1]);
963 dir
= guess_dir_name(repo_name
, is_bundle
, option_bare
);
964 strip_trailing_slashes(dir
);
966 dest_exists
= dir_exists(dir
);
967 if (dest_exists
&& !is_empty_dir(dir
))
968 die(_("destination path '%s' already exists and is not "
969 "an empty directory."), dir
);
971 strbuf_addf(&reflog_msg
, "clone: from %s", repo
);
976 work_tree
= getenv("GIT_WORK_TREE");
977 if (work_tree
&& dir_exists(work_tree
))
978 die(_("working tree '%s' already exists."), work_tree
);
981 if (option_bare
|| work_tree
)
982 git_dir
= xstrdup(dir
);
985 git_dir
= mkpathdup("%s/.git", dir
);
989 sigchain_push_common(remove_junk_on_signal
);
992 if (safe_create_leading_directories_const(work_tree
) < 0)
993 die_errno(_("could not create leading directories of '%s'"),
996 junk_work_tree_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
997 else if (mkdir(work_tree
, 0777))
998 die_errno(_("could not create work tree dir '%s'"),
1000 junk_work_tree
= work_tree
;
1001 set_git_work_tree(work_tree
);
1005 if (dir_exists(real_git_dir
))
1006 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1007 junk_git_dir
= real_git_dir
;
1010 junk_git_dir_flags
|= REMOVE_DIR_KEEP_TOPLEVEL
;
1011 junk_git_dir
= git_dir
;
1013 if (safe_create_leading_directories_const(git_dir
) < 0)
1014 die(_("could not create leading directories of '%s'"), git_dir
);
1016 if (0 <= option_verbosity
) {
1018 fprintf(stderr
, _("Cloning into bare repository '%s'...\n"), dir
);
1020 fprintf(stderr
, _("Cloning into '%s'...\n"), dir
);
1023 if (option_recurse_submodules
.nr
> 0) {
1024 struct string_list_item
*item
;
1025 struct strbuf sb
= STRBUF_INIT
;
1027 /* remove duplicates */
1028 string_list_sort(&option_recurse_submodules
);
1029 string_list_remove_duplicates(&option_recurse_submodules
, 0);
1032 * NEEDSWORK: In a multi-working-tree world, this needs to be
1033 * set in the per-worktree config.
1035 for_each_string_list_item(item
, &option_recurse_submodules
) {
1036 strbuf_addf(&sb
, "submodule.active=%s",
1038 string_list_append(&option_config
,
1039 strbuf_detach(&sb
, NULL
));
1042 if (option_required_reference
.nr
&&
1043 option_optional_reference
.nr
)
1044 die(_("clone --recursive is not compatible with "
1045 "both --reference and --reference-if-able"));
1046 else if (option_required_reference
.nr
) {
1047 string_list_append(&option_config
,
1048 "submodule.alternateLocation=superproject");
1049 string_list_append(&option_config
,
1050 "submodule.alternateErrorStrategy=die");
1051 } else if (option_optional_reference
.nr
) {
1052 string_list_append(&option_config
,
1053 "submodule.alternateLocation=superproject");
1054 string_list_append(&option_config
,
1055 "submodule.alternateErrorStrategy=info");
1059 init_db(git_dir
, real_git_dir
, option_template
, INIT_DB_QUIET
);
1062 git_dir
= real_git_dir
;
1064 write_config(&option_config
);
1066 git_config(git_default_config
, NULL
);
1070 src_ref_prefix
= "refs/";
1071 strbuf_addstr(&branch_top
, src_ref_prefix
);
1073 git_config_set("core.bare", "true");
1075 strbuf_addf(&branch_top
, "refs/remotes/%s/", option_origin
);
1078 strbuf_addf(&key
, "remote.%s.url", option_origin
);
1079 git_config_set(key
.buf
, repo
);
1082 if (option_no_tags
) {
1083 strbuf_addf(&key
, "remote.%s.tagOpt", option_origin
);
1084 git_config_set(key
.buf
, "--no-tags");
1088 if (option_required_reference
.nr
|| option_optional_reference
.nr
)
1091 remote
= remote_get(option_origin
);
1093 strbuf_addf(&default_refspec
, "+%s*:%s*", src_ref_prefix
,
1095 refspec_append(&remote
->fetch
, default_refspec
.buf
);
1097 transport
= transport_get(remote
, remote
->url
[0]);
1098 transport_set_verbosity(transport
, option_verbosity
, option_progress
);
1099 transport
->family
= family
;
1101 path
= get_repo_path(remote
->url
[0], &is_bundle
);
1102 is_local
= option_local
!= 0 && path
&& !is_bundle
;
1105 warning(_("--depth is ignored in local clones; use file:// instead."));
1107 warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1109 warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1110 if (filter_options
.choice
)
1111 warning(_("--filter is ignored in local clones; use file:// instead."));
1112 if (!access(mkpath("%s/shallow", path
), F_OK
)) {
1113 if (option_local
> 0)
1114 warning(_("source repository is shallow, ignoring --local"));
1118 if (option_local
> 0 && !is_local
)
1119 warning(_("--local is ignored"));
1120 transport
->cloning
= 1;
1122 transport_set_option(transport
, TRANS_OPT_KEEP
, "yes");
1125 transport_set_option(transport
, TRANS_OPT_DEPTH
,
1128 transport_set_option(transport
, TRANS_OPT_DEEPEN_SINCE
,
1131 transport_set_option(transport
, TRANS_OPT_DEEPEN_NOT
,
1132 (const char *)&option_not
);
1133 if (option_single_branch
)
1134 transport_set_option(transport
, TRANS_OPT_FOLLOWTAGS
, "1");
1136 if (option_upload_pack
)
1137 transport_set_option(transport
, TRANS_OPT_UPLOADPACK
,
1138 option_upload_pack
);
1140 if (server_options
.nr
)
1141 transport
->server_options
= &server_options
;
1143 if (filter_options
.choice
) {
1144 struct strbuf expanded_filter_spec
= STRBUF_INIT
;
1145 expand_list_objects_filter_spec(&filter_options
,
1146 &expanded_filter_spec
);
1147 transport_set_option(transport
, TRANS_OPT_LIST_OBJECTS_FILTER
,
1148 expanded_filter_spec
.buf
);
1149 transport_set_option(transport
, TRANS_OPT_FROM_PROMISOR
, "1");
1150 strbuf_release(&expanded_filter_spec
);
1153 if (transport
->smart_options
&& !deepen
&& !filter_options
.choice
)
1154 transport
->smart_options
->check_self_contained_and_connected
= 1;
1157 argv_array_push(&ref_prefixes
, "HEAD");
1158 refspec_ref_prefixes(&remote
->fetch
, &ref_prefixes
);
1160 expand_ref_prefix(&ref_prefixes
, option_branch
);
1161 if (!option_no_tags
)
1162 argv_array_push(&ref_prefixes
, "refs/tags/");
1164 refs
= transport_get_remote_refs(transport
, &ref_prefixes
);
1167 mapped_refs
= wanted_peer_refs(refs
, &remote
->fetch
);
1169 * transport_get_remote_refs() may return refs with null sha-1
1170 * in mapped_refs (see struct transport->get_refs_list
1171 * comment). In that case we need fetch it early because
1172 * remote_head code below relies on it.
1174 * for normal clones, transport_get_remote_refs() should
1175 * return reliable ref set, we can delay cloning until after
1176 * remote HEAD check.
1178 for (ref
= refs
; ref
; ref
= ref
->next
)
1179 if (is_null_oid(&ref
->old_oid
)) {
1180 complete_refs_before_fetch
= 0;
1184 if (!is_local
&& !complete_refs_before_fetch
)
1185 transport_fetch_refs(transport
, mapped_refs
);
1187 remote_head
= find_ref_by_name(refs
, "HEAD");
1188 remote_head_points_at
=
1189 guess_remote_head(remote_head
, mapped_refs
, 0);
1191 if (option_branch
) {
1192 our_head_points_at
=
1193 find_remote_branch(mapped_refs
, option_branch
);
1195 if (!our_head_points_at
)
1196 die(_("Remote branch %s not found in upstream %s"),
1197 option_branch
, option_origin
);
1200 our_head_points_at
= remote_head_points_at
;
1204 die(_("Remote branch %s not found in upstream %s"),
1205 option_branch
, option_origin
);
1207 warning(_("You appear to have cloned an empty repository."));
1209 our_head_points_at
= NULL
;
1210 remote_head_points_at
= NULL
;
1212 option_no_checkout
= 1;
1214 install_branch_config(0, "master", option_origin
,
1215 "refs/heads/master");
1218 write_refspec_config(src_ref_prefix
, our_head_points_at
,
1219 remote_head_points_at
, &branch_top
);
1221 if (filter_options
.choice
)
1222 partial_clone_register("origin", &filter_options
);
1225 clone_local(path
, git_dir
);
1226 else if (refs
&& complete_refs_before_fetch
)
1227 transport_fetch_refs(transport
, mapped_refs
);
1229 update_remote_refs(refs
, mapped_refs
, remote_head_points_at
,
1230 branch_top
.buf
, reflog_msg
.buf
, transport
,
1231 !is_local
, filter_options
.choice
);
1233 update_head(our_head_points_at
, remote_head
, reflog_msg
.buf
);
1236 * We want to show progress for recursive submodule clones iff
1237 * we did so for the main clone. But only the transport knows
1238 * the final decision for this flag, so we need to rescue the value
1239 * before we free the transport.
1241 submodule_progress
= transport
->progress
;
1243 transport_unlock_pack(transport
);
1244 transport_disconnect(transport
);
1246 if (option_dissociate
) {
1247 close_all_packs(the_repository
->objects
);
1248 dissociate_from_references();
1251 junk_mode
= JUNK_LEAVE_REPO
;
1252 fetch_if_missing
= 1;
1253 err
= checkout(submodule_progress
);
1255 strbuf_release(&reflog_msg
);
1256 strbuf_release(&branch_top
);
1257 strbuf_release(&key
);
1258 strbuf_release(&default_refspec
);
1259 junk_mode
= JUNK_LEAVE_ALL
;
1261 argv_array_clear(&ref_prefixes
);