builtin/clone.c

   1 /*
   2  * Builtin "git clone"
   3  *
   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
   7  *
   8  * Clone a repository into a different directory that does not yet exist.
   9  */
  10
  11 #define USE_THE_INDEX_VARIABLE
  12 #include "builtin.h"
  13 #include "config.h"
  14 #include "lockfile.h"
  15 #include "parse-options.h"
  16 #include "fetch-pack.h"
  17 #include "refs.h"
  18 #include "refspec.h"
  19 #include "object-store.h"
  20 #include "tree.h"
  21 #include "tree-walk.h"
  22 #include "unpack-trees.h"
  23 #include "transport.h"
  24 #include "strbuf.h"
  25 #include "dir.h"
  26 #include "dir-iterator.h"
  27 #include "iterator.h"
  28 #include "sigchain.h"
  29 #include "branch.h"
  30 #include "remote.h"
  31 #include "run-command.h"
  32 #include "connected.h"
  33 #include "packfile.h"
  34 #include "list-objects-filter-options.h"
  35 #include "hook.h"
  36 #include "bundle.h"
  37 #include "bundle-uri.h"
  38
  39 /*
  40  * Overall FIXMEs:
  41  *  - respect DB_ENVIRONMENT for .git/objects.
  42  *
  43  * Implementation notes:
  44  *  - dropping use-separate-remote and no-separate-remote compatibility
  45  *
  46  */
  47 static const char * const builtin_clone_usage[] = {
  48         N_("git clone [<options>] [--] <repo> [<dir>]"),
  49         NULL
  50 };
  51
  52 static int option_no_checkout, option_bare, option_mirror, option_single_branch = -1;
  53 static int option_local = -1, option_no_hardlinks, option_shared;
  54 static int option_no_tags;
  55 static int option_shallow_submodules;
  56 static int option_reject_shallow = -1;    /* unspecified */
  57 static int config_reject_shallow = -1;    /* unspecified */
  58 static int deepen;
  59 static char *option_template, *option_depth, *option_since;
  60 static char *option_origin = NULL;
  61 static char *remote_name = NULL;
  62 static char *option_branch = NULL;
  63 static struct string_list option_not = STRING_LIST_INIT_NODUP;
  64 static const char *real_git_dir;
  65 static char *option_upload_pack = "git-upload-pack";
  66 static int option_verbosity;
  67 static int option_progress = -1;
  68 static int option_sparse_checkout;
  69 static enum transport_family family;
  70 static struct string_list option_config = STRING_LIST_INIT_NODUP;
  71 static struct string_list option_required_reference = STRING_LIST_INIT_NODUP;
  72 static struct string_list option_optional_reference = STRING_LIST_INIT_NODUP;
  73 static int option_dissociate;
  74 static int max_jobs = -1;
  75 static struct string_list option_recurse_submodules = STRING_LIST_INIT_NODUP;
  76 static struct list_objects_filter_options filter_options = LIST_OBJECTS_FILTER_INIT;
  77 static int option_filter_submodules = -1;    /* unspecified */
  78 static int config_filter_submodules = -1;    /* unspecified */
  79 static struct string_list server_options = STRING_LIST_INIT_NODUP;
  80 static int option_remote_submodules;
  81 static const char *bundle_uri;
  82
  83 static int recurse_submodules_cb(const struct option *opt,
  84                                  const char *arg, int unset)
  85 {
  86         if (unset)
  87                 string_list_clear((struct string_list *)opt->value, 0);
  88         else if (arg)
  89                 string_list_append((struct string_list *)opt->value, arg);
  90         else
  91                 string_list_append((struct string_list *)opt->value,
  92                                    (const char *)opt->defval);
  93
  94         return 0;
  95 }
  96
  97 static struct option builtin_clone_options[] = {
  98         OPT__VERBOSITY(&option_verbosity),
  99         OPT_BOOL(0, "progress", &option_progress,
 100                  N_("force progress reporting")),
 101         OPT_BOOL(0, "reject-shallow", &option_reject_shallow,
 102                  N_("don't clone shallow repository")),
 103         OPT_BOOL('n', "no-checkout", &option_no_checkout,
 104                  N_("don't create a checkout")),
 105         OPT_BOOL(0, "bare", &option_bare, N_("create a bare repository")),
 106         OPT_HIDDEN_BOOL(0, "naked", &option_bare,
 107                         N_("create a bare repository")),
 108         OPT_BOOL(0, "mirror", &option_mirror,
 109                  N_("create a mirror repository (implies bare)")),
 110         OPT_BOOL('l', "local", &option_local,
 111                 N_("to clone from a local repository")),
 112         OPT_BOOL(0, "no-hardlinks", &option_no_hardlinks,
 113                     N_("don't use local hardlinks, always copy")),
 114         OPT_BOOL('s', "shared", &option_shared,
 115                     N_("setup as shared repository")),
 116         { OPTION_CALLBACK, 0, "recurse-submodules", &option_recurse_submodules,
 117           N_("pathspec"), N_("initialize submodules in the clone"),
 118           PARSE_OPT_OPTARG, recurse_submodules_cb, (intptr_t)"." },
 119         OPT_ALIAS(0, "recursive", "recurse-submodules"),
 120         OPT_INTEGER('j', "jobs", &max_jobs,
 121                     N_("number of submodules cloned in parallel")),
 122         OPT_STRING(0, "template", &option_template, N_("template-directory"),
 123                    N_("directory from which templates will be used")),
 124         OPT_STRING_LIST(0, "reference", &option_required_reference, N_("repo"),
 125                         N_("reference repository")),
 126         OPT_STRING_LIST(0, "reference-if-able", &option_optional_reference,
 127                         N_("repo"), N_("reference repository")),
 128         OPT_BOOL(0, "dissociate", &option_dissociate,
 129                  N_("use --reference only while cloning")),
 130         OPT_STRING('o', "origin", &option_origin, N_("name"),
 131                    N_("use <name> instead of 'origin' to track upstream")),
 132         OPT_STRING('b', "branch", &option_branch, N_("branch"),
 133                    N_("checkout <branch> instead of the remote's HEAD")),
 134         OPT_STRING('u', "upload-pack", &option_upload_pack, N_("path"),
 135                    N_("path to git-upload-pack on the remote")),
 136         OPT_STRING(0, "depth", &option_depth, N_("depth"),
 137                     N_("create a shallow clone of that depth")),
 138         OPT_STRING(0, "shallow-since", &option_since, N_("time"),
 139                     N_("create a shallow clone since a specific time")),
 140         OPT_STRING_LIST(0, "shallow-exclude", &option_not, N_("revision"),
 141                         N_("deepen history of shallow clone, excluding rev")),
 142         OPT_BOOL(0, "single-branch", &option_single_branch,
 143                     N_("clone only one branch, HEAD or --branch")),
 144         OPT_BOOL(0, "no-tags", &option_no_tags,
 145                  N_("don't clone any tags, and make later fetches not to follow them")),
 146         OPT_BOOL(0, "shallow-submodules", &option_shallow_submodules,
 147                     N_("any cloned submodules will be shallow")),
 148         OPT_STRING(0, "separate-git-dir", &real_git_dir, N_("gitdir"),
 149                    N_("separate git dir from working tree")),
 150         OPT_STRING_LIST('c', "config", &option_config, N_("key=value"),
 151                         N_("set config inside the new repository")),
 152         OPT_STRING_LIST(0, "server-option", &server_options,
 153                         N_("server-specific"), N_("option to transmit")),
 154         OPT_SET_INT('4', "ipv4", &family, N_("use IPv4 addresses only"),
 155                         TRANSPORT_FAMILY_IPV4),
 156         OPT_SET_INT('6', "ipv6", &family, N_("use IPv6 addresses only"),
 157                         TRANSPORT_FAMILY_IPV6),
 158         OPT_PARSE_LIST_OBJECTS_FILTER(&filter_options),
 159         OPT_BOOL(0, "also-filter-submodules", &option_filter_submodules,
 160                     N_("apply partial clone filters to submodules")),
 161         OPT_BOOL(0, "remote-submodules", &option_remote_submodules,
 162                     N_("any cloned submodules will use their remote-tracking branch")),
 163         OPT_BOOL(0, "sparse", &option_sparse_checkout,
 164                     N_("initialize sparse-checkout file to include only files at root")),
 165         OPT_STRING(0, "bundle-uri", &bundle_uri,
 166                    N_("uri"), N_("a URI for downloading bundles before fetching from origin remote")),
 167         OPT_END()
 168 };
 169
 170 static const char *get_repo_path_1(struct strbuf *path, int *is_bundle)
 171 {
 172         static char *suffix[] = { "/.git", "", ".git/.git", ".git" };
 173         static char *bundle_suffix[] = { ".bundle", "" };
 174         size_t baselen = path->len;
 175         struct stat st;
 176         int i;
 177
 178         for (i = 0; i < ARRAY_SIZE(suffix); i++) {
 179                 strbuf_setlen(path, baselen);
 180                 strbuf_addstr(path, suffix[i]);
 181                 if (stat(path->buf, &st))
 182                         continue;
 183                 if (S_ISDIR(st.st_mode) && is_git_directory(path->buf)) {
 184                         *is_bundle = 0;
 185                         return path->buf;
 186                 } else if (S_ISREG(st.st_mode) && st.st_size > 8) {
 187                         /* Is it a "gitfile"? */
 188                         char signature[8];
 189                         const char *dst;
 190                         int len, fd = open(path->buf, O_RDONLY);
 191                         if (fd < 0)
 192                                 continue;
 193                         len = read_in_full(fd, signature, 8);
 194                         close(fd);
 195                         if (len != 8 || strncmp(signature, "gitdir: ", 8))
 196                                 continue;
 197                         dst = read_gitfile(path->buf);
 198                         if (dst) {
 199                                 *is_bundle = 0;
 200                                 return dst;
 201                         }
 202                 }
 203         }
 204
 205         for (i = 0; i < ARRAY_SIZE(bundle_suffix); i++) {
 206                 strbuf_setlen(path, baselen);
 207                 strbuf_addstr(path, bundle_suffix[i]);
 208                 if (!stat(path->buf, &st) && S_ISREG(st.st_mode)) {
 209                         *is_bundle = 1;
 210                         return path->buf;
 211                 }
 212         }
 213
 214         return NULL;
 215 }
 216
 217 static char *get_repo_path(const char *repo, int *is_bundle)
 218 {
 219         struct strbuf path = STRBUF_INIT;
 220         const char *raw;
 221         char *canon;
 222
 223         strbuf_addstr(&path, repo);
 224         raw = get_repo_path_1(&path, is_bundle);
 225         canon = raw ? absolute_pathdup(raw) : NULL;
 226         strbuf_release(&path);
 227         return canon;
 228 }
 229
 230 static int add_one_reference(struct string_list_item *item, void *cb_data)
 231 {
 232         struct strbuf err = STRBUF_INIT;
 233         int *required = cb_data;
 234         char *ref_git = compute_alternate_path(item->string, &err);
 235
 236         if (!ref_git) {
 237                 if (*required)
 238                         die("%s", err.buf);
 239                 else
 240                         fprintf(stderr,
 241                                 _("info: Could not add alternate for '%s': %s\n"),
 242                                 item->string, err.buf);
 243         } else {
 244                 struct strbuf sb = STRBUF_INIT;
 245                 strbuf_addf(&sb, "%s/objects", ref_git);
 246                 add_to_alternates_file(sb.buf);
 247                 strbuf_release(&sb);
 248         }
 249
 250         strbuf_release(&err);
 251         free(ref_git);
 252         return 0;
 253 }
 254
 255 static void setup_reference(void)
 256 {
 257         int required = 1;
 258         for_each_string_list(&option_required_reference,
 259                              add_one_reference, &required);
 260         required = 0;
 261         for_each_string_list(&option_optional_reference,
 262                              add_one_reference, &required);
 263 }
 264
 265 static void copy_alternates(struct strbuf *src, const char *src_repo)
 266 {
 267         /*
 268          * Read from the source objects/info/alternates file
 269          * and copy the entries to corresponding file in the
 270          * destination repository with add_to_alternates_file().
 271          * Both src and dst have "$path/objects/info/alternates".
 272          *
 273          * Instead of copying bit-for-bit from the original,
 274          * we need to append to existing one so that the already
 275          * created entry via "clone -s" is not lost, and also
 276          * to turn entries with paths relative to the original
 277          * absolute, so that they can be used in the new repository.
 278          */
 279         FILE *in = xfopen(src->buf, "r");
 280         struct strbuf line = STRBUF_INIT;
 281
 282         while (strbuf_getline(&line, in) != EOF) {
 283                 char *abs_path;
 284                 if (!line.len || line.buf[0] == '#')
 285                         continue;
 286                 if (is_absolute_path(line.buf)) {
 287                         add_to_alternates_file(line.buf);
 288                         continue;
 289                 }
 290                 abs_path = mkpathdup("%s/objects/%s", src_repo, line.buf);
 291                 if (!normalize_path_copy(abs_path, abs_path))
 292                         add_to_alternates_file(abs_path);
 293                 else
 294                         warning("skipping invalid relative alternate: %s/%s",
 295                                 src_repo, line.buf);
 296                 free(abs_path);
 297         }
 298         strbuf_release(&line);
 299         fclose(in);
 300 }
 301
 302 static void mkdir_if_missing(const char *pathname, mode_t mode)
 303 {
 304         struct stat st;
 305
 306         if (!mkdir(pathname, mode))
 307                 return;
 308
 309         if (errno != EEXIST)
 310                 die_errno(_("failed to create directory '%s'"), pathname);
 311         else if (stat(pathname, &st))
 312                 die_errno(_("failed to stat '%s'"), pathname);
 313         else if (!S_ISDIR(st.st_mode))
 314                 die(_("%s exists and is not a directory"), pathname);
 315 }
 316
 317 static void copy_or_link_directory(struct strbuf *src, struct strbuf *dest,
 318                                    const char *src_repo)
 319 {
 320         int src_len, dest_len;
 321         struct dir_iterator *iter;
 322         int iter_status;
 323         struct strbuf realpath = STRBUF_INIT;
 324
 325         mkdir_if_missing(dest->buf, 0777);
 326
 327         iter = dir_iterator_begin(src->buf, DIR_ITERATOR_PEDANTIC);
 328
 329         if (!iter)
 330                 die_errno(_("failed to start iterator over '%s'"), src->buf);
 331
 332         strbuf_addch(src, '/');
 333         src_len = src->len;
 334         strbuf_addch(dest, '/');
 335         dest_len = dest->len;
 336
 337         while ((iter_status = dir_iterator_advance(iter)) == ITER_OK) {
 338                 strbuf_setlen(src, src_len);
 339                 strbuf_addstr(src, iter->relative_path);
 340                 strbuf_setlen(dest, dest_len);
 341                 strbuf_addstr(dest, iter->relative_path);
 342
 343                 if (S_ISLNK(iter->st.st_mode))
 344                         die(_("symlink '%s' exists, refusing to clone with --local"),
 345                             iter->relative_path);
 346
 347                 if (S_ISDIR(iter->st.st_mode)) {
 348                         mkdir_if_missing(dest->buf, 0777);
 349                         continue;
 350                 }
 351
 352                 /* Files that cannot be copied bit-for-bit... */
 353                 if (!fspathcmp(iter->relative_path, "info/alternates")) {
 354                         copy_alternates(src, src_repo);
 355                         continue;
 356                 }
 357
 358                 if (unlink(dest->buf) && errno != ENOENT)
 359                         die_errno(_("failed to unlink '%s'"), dest->buf);
 360                 if (!option_no_hardlinks) {
 361                         strbuf_realpath(&realpath, src->buf, 1);
 362                         if (!link(realpath.buf, dest->buf))
 363                                 continue;
 364                         if (option_local > 0)
 365                                 die_errno(_("failed to create link '%s'"), dest->buf);
 366                         option_no_hardlinks = 1;
 367                 }
 368                 if (copy_file_with_time(dest->buf, src->buf, 0666))
 369                         die_errno(_("failed to copy file to '%s'"), dest->buf);
 370         }
 371
 372         if (iter_status != ITER_DONE) {
 373                 strbuf_setlen(src, src_len);
 374                 die(_("failed to iterate over '%s'"), src->buf);
 375         }
 376
 377         strbuf_release(&realpath);
 378 }
 379
 380 static void clone_local(const char *src_repo, const char *dest_repo)
 381 {
 382         if (option_shared) {
 383                 struct strbuf alt = STRBUF_INIT;
 384                 get_common_dir(&alt, src_repo);
 385                 strbuf_addstr(&alt, "/objects");
 386                 add_to_alternates_file(alt.buf);
 387                 strbuf_release(&alt);
 388         } else {
 389                 struct strbuf src = STRBUF_INIT;
 390                 struct strbuf dest = STRBUF_INIT;
 391                 get_common_dir(&src, src_repo);
 392                 get_common_dir(&dest, dest_repo);
 393                 strbuf_addstr(&src, "/objects");
 394                 strbuf_addstr(&dest, "/objects");
 395                 copy_or_link_directory(&src, &dest, src_repo);
 396                 strbuf_release(&src);
 397                 strbuf_release(&dest);
 398         }
 399
 400         if (0 <= option_verbosity)
 401                 fprintf(stderr, _("done.\n"));
 402 }
 403
 404 static const char *junk_work_tree;
 405 static int junk_work_tree_flags;
 406 static const char *junk_git_dir;
 407 static int junk_git_dir_flags;
 408 static enum {
 409         JUNK_LEAVE_NONE,
 410         JUNK_LEAVE_REPO,
 411         JUNK_LEAVE_ALL
 412 } junk_mode = JUNK_LEAVE_NONE;
 413
 414 static const char junk_leave_repo_msg[] =
 415 N_("Clone succeeded, but checkout failed.\n"
 416    "You can inspect what was checked out with 'git status'\n"
 417    "and retry with 'git restore --source=HEAD :/'\n");
 418
 419 static void remove_junk(void)
 420 {
 421         struct strbuf sb = STRBUF_INIT;
 422
 423         switch (junk_mode) {
 424         case JUNK_LEAVE_REPO:
 425                 warning("%s", _(junk_leave_repo_msg));
 426                 /* fall-through */
 427         case JUNK_LEAVE_ALL:
 428                 return;
 429         default:
 430                 /* proceed to removal */
 431                 break;
 432         }
 433
 434         if (junk_git_dir) {
 435                 strbuf_addstr(&sb, junk_git_dir);
 436                 remove_dir_recursively(&sb, junk_git_dir_flags);
 437                 strbuf_reset(&sb);
 438         }
 439         if (junk_work_tree) {
 440                 strbuf_addstr(&sb, junk_work_tree);
 441                 remove_dir_recursively(&sb, junk_work_tree_flags);
 442         }
 443         strbuf_release(&sb);
 444 }
 445
 446 static void remove_junk_on_signal(int signo)
 447 {
 448         remove_junk();
 449         sigchain_pop(signo);
 450         raise(signo);
 451 }
 452
 453 static struct ref *find_remote_branch(const struct ref *refs, const char *branch)
 454 {
 455         struct ref *ref;
 456         struct strbuf head = STRBUF_INIT;
 457         strbuf_addstr(&head, "refs/heads/");
 458         strbuf_addstr(&head, branch);
 459         ref = find_ref_by_name(refs, head.buf);
 460         strbuf_release(&head);
 461
 462         if (ref)
 463                 return ref;
 464
 465         strbuf_addstr(&head, "refs/tags/");
 466         strbuf_addstr(&head, branch);
 467         ref = find_ref_by_name(refs, head.buf);
 468         strbuf_release(&head);
 469
 470         return ref;
 471 }
 472
 473 static struct ref *wanted_peer_refs(const struct ref *refs,
 474                 struct refspec *refspec)
 475 {
 476         struct ref *head = copy_ref(find_ref_by_name(refs, "HEAD"));
 477         struct ref *local_refs = head;
 478         struct ref **tail = head ? &head->next : &local_refs;
 479
 480         if (option_single_branch) {
 481                 struct ref *remote_head = NULL;
 482
 483                 if (!option_branch)
 484                         remote_head = guess_remote_head(head, refs, 0);
 485                 else {
 486                         local_refs = NULL;
 487                         tail = &local_refs;
 488                         remote_head = copy_ref(find_remote_branch(refs, option_branch));
 489                 }
 490
 491                 if (!remote_head && option_branch)
 492                         warning(_("Could not find remote branch %s to clone."),
 493                                 option_branch);
 494                 else {
 495                         int i;
 496                         for (i = 0; i < refspec->nr; i++)
 497                                 get_fetch_map(remote_head, &refspec->items[i],
 498                                               &tail, 0);
 499
 500                         /* if --branch=tag, pull the requested tag explicitly */
 501                         get_fetch_map(remote_head, tag_refspec, &tail, 0);
 502                 }
 503                 free_refs(remote_head);
 504         } else {
 505                 int i;
 506                 for (i = 0; i < refspec->nr; i++)
 507                         get_fetch_map(refs, &refspec->items[i], &tail, 0);
 508         }
 509
 510         if (!option_mirror && !option_single_branch && !option_no_tags)
 511                 get_fetch_map(refs, tag_refspec, &tail, 0);
 512
 513         return local_refs;
 514 }
 515
 516 static void write_remote_refs(const struct ref *local_refs)
 517 {
 518         const struct ref *r;
 519
 520         struct ref_transaction *t;
 521         struct strbuf err = STRBUF_INIT;
 522
 523         t = ref_transaction_begin(&err);
 524         if (!t)
 525                 die("%s", err.buf);
 526
 527         for (r = local_refs; r; r = r->next) {
 528                 if (!r->peer_ref)
 529                         continue;
 530                 if (ref_transaction_create(t, r->peer_ref->name, &r->old_oid,
 531                                            0, NULL, &err))
 532                         die("%s", err.buf);
 533         }
 534
 535         if (initial_ref_transaction_commit(t, &err))
 536                 die("%s", err.buf);
 537
 538         strbuf_release(&err);
 539         ref_transaction_free(t);
 540 }
 541
 542 static void write_followtags(const struct ref *refs, const char *msg)
 543 {
 544         const struct ref *ref;
 545         for (ref = refs; ref; ref = ref->next) {
 546                 if (!starts_with(ref->name, "refs/tags/"))
 547                         continue;
 548                 if (ends_with(ref->name, "^{}"))
 549                         continue;
 550                 if (!has_object_file_with_flags(&ref->old_oid,
 551                                                 OBJECT_INFO_QUICK |
 552                                                 OBJECT_INFO_SKIP_FETCH_OBJECT))
 553                         continue;
 554                 update_ref(msg, ref->name, &ref->old_oid, NULL, 0,
 555                            UPDATE_REFS_DIE_ON_ERR);
 556         }
 557 }
 558
 559 static const struct object_id *iterate_ref_map(void *cb_data)
 560 {
 561         struct ref **rm = cb_data;
 562         struct ref *ref = *rm;
 563
 564         /*
 565          * Skip anything missing a peer_ref, which we are not
 566          * actually going to write a ref for.
 567          */
 568         while (ref && !ref->peer_ref)
 569                 ref = ref->next;
 570         if (!ref)
 571                 return NULL;
 572
 573         *rm = ref->next;
 574         return &ref->old_oid;
 575 }
 576
 577 static void update_remote_refs(const struct ref *refs,
 578                                const struct ref *mapped_refs,
 579                                const struct ref *remote_head_points_at,
 580                                const char *branch_top,
 581                                const char *msg,
 582                                struct transport *transport,
 583                                int check_connectivity)
 584 {
 585         const struct ref *rm = mapped_refs;
 586
 587         if (check_connectivity) {
 588                 struct check_connected_options opt = CHECK_CONNECTED_INIT;
 589
 590                 opt.transport = transport;
 591                 opt.progress = transport->progress;
 592
 593                 if (check_connected(iterate_ref_map, &rm, &opt))
 594                         die(_("remote did not send all necessary objects"));
 595         }
 596
 597         if (refs) {
 598                 write_remote_refs(mapped_refs);
 599                 if (option_single_branch && !option_no_tags)
 600                         write_followtags(refs, msg);
 601         }
 602
 603         if (remote_head_points_at && !option_bare) {
 604                 struct strbuf head_ref = STRBUF_INIT;
 605                 strbuf_addstr(&head_ref, branch_top);
 606                 strbuf_addstr(&head_ref, "HEAD");
 607                 if (create_symref(head_ref.buf,
 608                                   remote_head_points_at->peer_ref->name,
 609                                   msg) < 0)
 610                         die(_("unable to update %s"), head_ref.buf);
 611                 strbuf_release(&head_ref);
 612         }
 613 }
 614
 615 static void update_head(const struct ref *our, const struct ref *remote,
 616                         const char *unborn, const char *msg)
 617 {
 618         const char *head;
 619         if (our && skip_prefix(our->name, "refs/heads/", &head)) {
 620                 /* Local default branch link */
 621                 if (create_symref("HEAD", our->name, NULL) < 0)
 622                         die(_("unable to update HEAD"));
 623                 if (!option_bare) {
 624                         update_ref(msg, "HEAD", &our->old_oid, NULL, 0,
 625                                    UPDATE_REFS_DIE_ON_ERR);
 626                         install_branch_config(0, head, remote_name, our->name);
 627                 }
 628         } else if (our) {
 629                 struct commit *c = lookup_commit_reference(the_repository,
 630                                                            &our->old_oid);
 631                 /* --branch specifies a non-branch (i.e. tags), detach HEAD */
 632                 update_ref(msg, "HEAD", &c->object.oid, NULL, REF_NO_DEREF,
 633                            UPDATE_REFS_DIE_ON_ERR);
 634         } else if (remote) {
 635                 /*
 636                  * We know remote HEAD points to a non-branch, or
 637                  * HEAD points to a branch but we don't know which one.
 638                  * Detach HEAD in all these cases.
 639                  */
 640                 update_ref(msg, "HEAD", &remote->old_oid, NULL, REF_NO_DEREF,
 641                            UPDATE_REFS_DIE_ON_ERR);
 642         } else if (unborn && skip_prefix(unborn, "refs/heads/", &head)) {
 643                 /*
 644                  * Unborn head from remote; same as "our" case above except
 645                  * that we have no ref to update.
 646                  */
 647                 if (create_symref("HEAD", unborn, NULL) < 0)
 648                         die(_("unable to update HEAD"));
 649                 if (!option_bare)
 650                         install_branch_config(0, head, remote_name, unborn);
 651         }
 652 }
 653
 654 static int git_sparse_checkout_init(const char *repo)
 655 {
 656         struct child_process cmd = CHILD_PROCESS_INIT;
 657         int result = 0;
 658         strvec_pushl(&cmd.args, "-C", repo, "sparse-checkout", "set", NULL);
 659
 660         /*
 661          * We must apply the setting in the current process
 662          * for the later checkout to use the sparse-checkout file.
 663          */
 664         core_apply_sparse_checkout = 1;
 665
 666         cmd.git_cmd = 1;
 667         if (run_command(&cmd)) {
 668                 error(_("failed to initialize sparse-checkout"));
 669                 result = 1;
 670         }
 671
 672         return result;
 673 }
 674
 675 static int checkout(int submodule_progress, int filter_submodules)
 676 {
 677         struct object_id oid;
 678         char *head;
 679         struct lock_file lock_file = LOCK_INIT;
 680         struct unpack_trees_options opts;
 681         struct tree *tree;
 682         struct tree_desc t;
 683         int err = 0;
 684
 685         if (option_no_checkout)
 686                 return 0;
 687
 688         head = resolve_refdup("HEAD", RESOLVE_REF_READING, &oid, NULL);
 689         if (!head) {
 690                 warning(_("remote HEAD refers to nonexistent ref, "
 691                           "unable to checkout"));
 692                 return 0;
 693         }
 694         if (!strcmp(head, "HEAD")) {
 695                 if (advice_enabled(ADVICE_DETACHED_HEAD))
 696                         detach_advice(oid_to_hex(&oid));
 697                 FREE_AND_NULL(head);
 698         } else {
 699                 if (!starts_with(head, "refs/heads/"))
 700                         die(_("HEAD not found below refs/heads!"));
 701         }
 702
 703         /* We need to be in the new work tree for the checkout */
 704         setup_work_tree();
 705
 706         repo_hold_locked_index(the_repository, &lock_file, LOCK_DIE_ON_ERROR);
 707
 708         memset(&opts, 0, sizeof opts);
 709         opts.update = 1;
 710         opts.merge = 1;
 711         opts.clone = 1;
 712         opts.preserve_ignored = 0;
 713         opts.fn = oneway_merge;
 714         opts.verbose_update = (option_verbosity >= 0);
 715         opts.src_index = &the_index;
 716         opts.dst_index = &the_index;
 717         init_checkout_metadata(&opts.meta, head, &oid, NULL);
 718
 719         tree = parse_tree_indirect(&oid);
 720         if (!tree)
 721                 die(_("unable to parse commit %s"), oid_to_hex(&oid));
 722         parse_tree(tree);
 723         init_tree_desc(&t, tree->buffer, tree->size);
 724         if (unpack_trees(1, &t, &opts) < 0)
 725                 die(_("unable to checkout working tree"));
 726
 727         free(head);
 728
 729         if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
 730                 die(_("unable to write new index file"));
 731
 732         err |= run_hooks_l("post-checkout", oid_to_hex(null_oid()),
 733                            oid_to_hex(&oid), "1", NULL);
 734
 735         if (!err && (option_recurse_submodules.nr > 0)) {
 736                 struct child_process cmd = CHILD_PROCESS_INIT;
 737                 strvec_pushl(&cmd.args, "submodule", "update", "--require-init",
 738                              "--recursive", NULL);
 739
 740                 if (option_shallow_submodules == 1)
 741                         strvec_push(&cmd.args, "--depth=1");
 742
 743                 if (max_jobs != -1)
 744                         strvec_pushf(&cmd.args, "--jobs=%d", max_jobs);
 745
 746                 if (submodule_progress)
 747                         strvec_push(&cmd.args, "--progress");
 748
 749                 if (option_verbosity < 0)
 750                         strvec_push(&cmd.args, "--quiet");
 751
 752                 if (option_remote_submodules) {
 753                         strvec_push(&cmd.args, "--remote");
 754                         strvec_push(&cmd.args, "--no-fetch");
 755                 }
 756
 757                 if (filter_submodules && filter_options.choice)
 758                         strvec_pushf(&cmd.args, "--filter=%s",
 759                                      expand_list_objects_filter_spec(&filter_options));
 760
 761                 if (option_single_branch >= 0)
 762                         strvec_push(&cmd.args, option_single_branch ?
 763                                                "--single-branch" :
 764                                                "--no-single-branch");
 765
 766                 cmd.git_cmd = 1;
 767                 err = run_command(&cmd);
 768         }
 769
 770         return err;
 771 }
 772
 773 static int git_clone_config(const char *k, const char *v, void *cb)
 774 {
 775         if (!strcmp(k, "clone.defaultremotename")) {
 776                 free(remote_name);
 777                 remote_name = xstrdup(v);
 778         }
 779         if (!strcmp(k, "clone.rejectshallow"))
 780                 config_reject_shallow = git_config_bool(k, v);
 781         if (!strcmp(k, "clone.filtersubmodules"))
 782                 config_filter_submodules = git_config_bool(k, v);
 783
 784         return git_default_config(k, v, cb);
 785 }
 786
 787 static int write_one_config(const char *key, const char *value, void *data)
 788 {
 789         /*
 790          * give git_clone_config a chance to write config values back to the
 791          * environment, since git_config_set_multivar_gently only deals with
 792          * config-file writes
 793          */
 794         int apply_failed = git_clone_config(key, value, data);
 795         if (apply_failed)
 796                 return apply_failed;
 797
 798         return git_config_set_multivar_gently(key,
 799                                               value ? value : "true",
 800                                               CONFIG_REGEX_NONE, 0);
 801 }
 802
 803 static void write_config(struct string_list *config)
 804 {
 805         int i;
 806
 807         for (i = 0; i < config->nr; i++) {
 808                 if (git_config_parse_parameter(config->items[i].string,
 809                                                write_one_config, NULL) < 0)
 810                         die(_("unable to write parameters to config file"));
 811         }
 812 }
 813
 814 static void write_refspec_config(const char *src_ref_prefix,
 815                 const struct ref *our_head_points_at,
 816                 const struct ref *remote_head_points_at,
 817                 struct strbuf *branch_top)
 818 {
 819         struct strbuf key = STRBUF_INIT;
 820         struct strbuf value = STRBUF_INIT;
 821
 822         if (option_mirror || !option_bare) {
 823                 if (option_single_branch && !option_mirror) {
 824                         if (option_branch) {
 825                                 if (starts_with(our_head_points_at->name, "refs/tags/"))
 826                                         strbuf_addf(&value, "+%s:%s", our_head_points_at->name,
 827                                                 our_head_points_at->name);
 828                                 else
 829                                         strbuf_addf(&value, "+%s:%s%s", our_head_points_at->name,
 830                                                 branch_top->buf, option_branch);
 831                         } else if (remote_head_points_at) {
 832                                 const char *head = remote_head_points_at->name;
 833                                 if (!skip_prefix(head, "refs/heads/", &head))
 834                                         BUG("remote HEAD points at non-head?");
 835
 836                                 strbuf_addf(&value, "+%s:%s%s", remote_head_points_at->name,
 837                                                 branch_top->buf, head);
 838                         }
 839                         /*
 840                          * otherwise, the next "git fetch" will
 841                          * simply fetch from HEAD without updating
 842                          * any remote-tracking branch, which is what
 843                          * we want.
 844                          */
 845                 } else {
 846                         strbuf_addf(&value, "+%s*:%s*", src_ref_prefix, branch_top->buf);
 847                 }
 848                 /* Configure the remote */
 849                 if (value.len) {
 850                         strbuf_addf(&key, "remote.%s.fetch", remote_name);
 851                         git_config_set_multivar(key.buf, value.buf, "^$", 0);
 852                         strbuf_reset(&key);
 853
 854                         if (option_mirror) {
 855                                 strbuf_addf(&key, "remote.%s.mirror", remote_name);
 856                                 git_config_set(key.buf, "true");
 857                                 strbuf_reset(&key);
 858                         }
 859                 }
 860         }
 861
 862         strbuf_release(&key);
 863         strbuf_release(&value);
 864 }
 865
 866 static void dissociate_from_references(void)
 867 {
 868         char *alternates = git_pathdup("objects/info/alternates");
 869
 870         if (!access(alternates, F_OK)) {
 871                 struct child_process cmd = CHILD_PROCESS_INIT;
 872
 873                 cmd.git_cmd = 1;
 874                 cmd.no_stdin = 1;
 875                 strvec_pushl(&cmd.args, "repack", "-a", "-d", NULL);
 876                 if (run_command(&cmd))
 877                         die(_("cannot repack to clean up"));
 878                 if (unlink(alternates) && errno != ENOENT)
 879                         die_errno(_("cannot unlink temporary alternates file"));
 880         }
 881         free(alternates);
 882 }
 883
 884 static int path_exists(const char *path)
 885 {
 886         struct stat sb;
 887         return !stat(path, &sb);
 888 }
 889
 890 int cmd_clone(int argc, const char **argv, const char *prefix)
 891 {
 892         int is_bundle = 0, is_local;
 893         int reject_shallow = 0;
 894         const char *repo_name, *repo, *work_tree, *git_dir;
 895         char *path = NULL, *dir, *display_repo = NULL;
 896         int dest_exists, real_dest_exists = 0;
 897         const struct ref *refs, *remote_head;
 898         struct ref *remote_head_points_at = NULL;
 899         const struct ref *our_head_points_at;
 900         char *unborn_head = NULL;
 901         struct ref *mapped_refs = NULL;
 902         const struct ref *ref;
 903         struct strbuf key = STRBUF_INIT;
 904         struct strbuf branch_top = STRBUF_INIT, reflog_msg = STRBUF_INIT;
 905         struct transport *transport = NULL;
 906         const char *src_ref_prefix = "refs/heads/";
 907         struct remote *remote;
 908         int err = 0, complete_refs_before_fetch = 1;
 909         int submodule_progress;
 910         int filter_submodules = 0;
 911
 912         struct transport_ls_refs_options transport_ls_refs_options =
 913                 TRANSPORT_LS_REFS_OPTIONS_INIT;
 914
 915         packet_trace_identity("clone");
 916
 917         git_config(git_clone_config, NULL);
 918
 919         argc = parse_options(argc, argv, prefix, builtin_clone_options,
 920                              builtin_clone_usage, 0);
 921
 922         if (argc > 2)
 923                 usage_msg_opt(_("Too many arguments."),
 924                         builtin_clone_usage, builtin_clone_options);
 925
 926         if (argc == 0)
 927                 usage_msg_opt(_("You must specify a repository to clone."),
 928                         builtin_clone_usage, builtin_clone_options);
 929
 930         if (option_depth || option_since || option_not.nr)
 931                 deepen = 1;
 932         if (option_single_branch == -1)
 933                 option_single_branch = deepen ? 1 : 0;
 934
 935         if (option_mirror)
 936                 option_bare = 1;
 937
 938         if (option_bare) {
 939                 if (real_git_dir)
 940                         die(_("options '%s' and '%s' cannot be used together"), "--bare", "--separate-git-dir");
 941                 option_no_checkout = 1;
 942         }
 943
 944         if (bundle_uri && deepen)
 945                 die(_("--bundle-uri is incompatible with --depth, --shallow-since, and --shallow-exclude"));
 946
 947         repo_name = argv[0];
 948
 949         path = get_repo_path(repo_name, &is_bundle);
 950         if (path) {
 951                 FREE_AND_NULL(path);
 952                 repo = absolute_pathdup(repo_name);
 953         } else if (strchr(repo_name, ':')) {
 954                 repo = repo_name;
 955                 display_repo = transport_anonymize_url(repo);
 956         } else
 957                 die(_("repository '%s' does not exist"), repo_name);
 958
 959         /* no need to be strict, transport_set_option() will validate it again */
 960         if (option_depth && atoi(option_depth) < 1)
 961                 die(_("depth %s is not a positive number"), option_depth);
 962
 963         if (argc == 2)
 964                 dir = xstrdup(argv[1]);
 965         else
 966                 dir = git_url_basename(repo_name, is_bundle, option_bare);
 967         strip_dir_trailing_slashes(dir);
 968
 969         dest_exists = path_exists(dir);
 970         if (dest_exists && !is_empty_dir(dir))
 971                 die(_("destination path '%s' already exists and is not "
 972                         "an empty directory."), dir);
 973
 974         if (real_git_dir) {
 975                 real_dest_exists = path_exists(real_git_dir);
 976                 if (real_dest_exists && !is_empty_dir(real_git_dir))
 977                         die(_("repository path '%s' already exists and is not "
 978                                 "an empty directory."), real_git_dir);
 979         }
 980
 981
 982         strbuf_addf(&reflog_msg, "clone: from %s",
 983                     display_repo ? display_repo : repo);
 984         free(display_repo);
 985
 986         if (option_bare)
 987                 work_tree = NULL;
 988         else {
 989                 work_tree = getenv("GIT_WORK_TREE");
 990                 if (work_tree && path_exists(work_tree))
 991                         die(_("working tree '%s' already exists."), work_tree);
 992         }
 993
 994         if (option_bare || work_tree)
 995                 git_dir = xstrdup(dir);
 996         else {
 997                 work_tree = dir;
 998                 git_dir = mkpathdup("%s/.git", dir);
 999         }
1000
1001         atexit(remove_junk);
1002         sigchain_push_common(remove_junk_on_signal);
1003
1004         if (!option_bare) {
1005                 if (safe_create_leading_directories_const(work_tree) < 0)
1006                         die_errno(_("could not create leading directories of '%s'"),
1007                                   work_tree);
1008                 if (dest_exists)
1009                         junk_work_tree_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1010                 else if (mkdir(work_tree, 0777))
1011                         die_errno(_("could not create work tree dir '%s'"),
1012                                   work_tree);
1013                 junk_work_tree = work_tree;
1014                 set_git_work_tree(work_tree);
1015         }
1016
1017         if (real_git_dir) {
1018                 if (real_dest_exists)
1019                         junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1020                 junk_git_dir = real_git_dir;
1021         } else {
1022                 if (dest_exists)
1023                         junk_git_dir_flags |= REMOVE_DIR_KEEP_TOPLEVEL;
1024                 junk_git_dir = git_dir;
1025         }
1026         if (safe_create_leading_directories_const(git_dir) < 0)
1027                 die(_("could not create leading directories of '%s'"), git_dir);
1028
1029         if (0 <= option_verbosity) {
1030                 if (option_bare)
1031                         fprintf(stderr, _("Cloning into bare repository '%s'...\n"), dir);
1032                 else
1033                         fprintf(stderr, _("Cloning into '%s'...\n"), dir);
1034         }
1035
1036         if (option_recurse_submodules.nr > 0) {
1037                 struct string_list_item *item;
1038                 struct strbuf sb = STRBUF_INIT;
1039                 int val;
1040
1041                 /* remove duplicates */
1042                 string_list_sort(&option_recurse_submodules);
1043                 string_list_remove_duplicates(&option_recurse_submodules, 0);
1044
1045                 /*
1046                  * NEEDSWORK: In a multi-working-tree world, this needs to be
1047                  * set in the per-worktree config.
1048                  */
1049                 for_each_string_list_item(item, &option_recurse_submodules) {
1050                         strbuf_addf(&sb, "submodule.active=%s",
1051                                     item->string);
1052                         string_list_append(&option_config,
1053                                            strbuf_detach(&sb, NULL));
1054                 }
1055
1056                 if (!git_config_get_bool("submodule.stickyRecursiveClone", &val) &&
1057                     val)
1058                         string_list_append(&option_config, "submodule.recurse=true");
1059
1060                 if (option_required_reference.nr &&
1061                     option_optional_reference.nr)
1062                         die(_("clone --recursive is not compatible with "
1063                               "both --reference and --reference-if-able"));
1064                 else if (option_required_reference.nr) {
1065                         string_list_append(&option_config,
1066                                 "submodule.alternateLocation=superproject");
1067                         string_list_append(&option_config,
1068                                 "submodule.alternateErrorStrategy=die");
1069                 } else if (option_optional_reference.nr) {
1070                         string_list_append(&option_config,
1071                                 "submodule.alternateLocation=superproject");
1072                         string_list_append(&option_config,
1073                                 "submodule.alternateErrorStrategy=info");
1074                 }
1075         }
1076
1077         init_db(git_dir, real_git_dir, option_template, GIT_HASH_UNKNOWN, NULL,
1078                 INIT_DB_QUIET);
1079
1080         if (real_git_dir) {
1081                 free((char *)git_dir);
1082                 git_dir = real_git_dir;
1083         }
1084
1085         /*
1086          * additional config can be injected with -c, make sure it's included
1087          * after init_db, which clears the entire config environment.
1088          */
1089         write_config(&option_config);
1090
1091         /*
1092          * re-read config after init_db and write_config to pick up any config
1093          * injected by --template and --config, respectively.
1094          */
1095         git_config(git_clone_config, NULL);
1096
1097         /*
1098          * If option_reject_shallow is specified from CLI option,
1099          * ignore config_reject_shallow from git_clone_config.
1100          */
1101         if (config_reject_shallow != -1)
1102                 reject_shallow = config_reject_shallow;
1103         if (option_reject_shallow != -1)
1104                 reject_shallow = option_reject_shallow;
1105
1106         /*
1107          * If option_filter_submodules is specified from CLI option,
1108          * ignore config_filter_submodules from git_clone_config.
1109          */
1110         if (config_filter_submodules != -1)
1111                 filter_submodules = config_filter_submodules;
1112         if (option_filter_submodules != -1)
1113                 filter_submodules = option_filter_submodules;
1114
1115         /*
1116          * Exit if the user seems to be doing something silly with submodule
1117          * filter flags (but not with filter configs, as those should be
1118          * set-and-forget).
1119          */
1120         if (option_filter_submodules > 0 && !filter_options.choice)
1121                 die(_("the option '%s' requires '%s'"),
1122                     "--also-filter-submodules", "--filter");
1123         if (option_filter_submodules > 0 && !option_recurse_submodules.nr)
1124                 die(_("the option '%s' requires '%s'"),
1125                     "--also-filter-submodules", "--recurse-submodules");
1126
1127         /*
1128          * apply the remote name provided by --origin only after this second
1129          * call to git_config, to ensure it overrides all config-based values.
1130          */
1131         if (option_origin) {
1132                 free(remote_name);
1133                 remote_name = xstrdup(option_origin);
1134         }
1135
1136         if (!remote_name)
1137                 remote_name = xstrdup("origin");
1138
1139         if (!valid_remote_name(remote_name))
1140                 die(_("'%s' is not a valid remote name"), remote_name);
1141
1142         if (option_bare) {
1143                 if (option_mirror)
1144                         src_ref_prefix = "refs/";
1145                 strbuf_addstr(&branch_top, src_ref_prefix);
1146
1147                 git_config_set("core.bare", "true");
1148         } else {
1149                 strbuf_addf(&branch_top, "refs/remotes/%s/", remote_name);
1150         }
1151
1152         strbuf_addf(&key, "remote.%s.url", remote_name);
1153         git_config_set(key.buf, repo);
1154         strbuf_reset(&key);
1155
1156         if (option_no_tags) {
1157                 strbuf_addf(&key, "remote.%s.tagOpt", remote_name);
1158                 git_config_set(key.buf, "--no-tags");
1159                 strbuf_reset(&key);
1160         }
1161
1162         if (option_required_reference.nr || option_optional_reference.nr)
1163                 setup_reference();
1164
1165         if (option_sparse_checkout && git_sparse_checkout_init(dir))
1166                 return 1;
1167
1168         remote = remote_get(remote_name);
1169
1170         refspec_appendf(&remote->fetch, "+%s*:%s*", src_ref_prefix,
1171                         branch_top.buf);
1172
1173         path = get_repo_path(remote->url[0], &is_bundle);
1174         is_local = option_local != 0 && path && !is_bundle;
1175         if (is_local) {
1176                 if (option_depth)
1177                         warning(_("--depth is ignored in local clones; use file:// instead."));
1178                 if (option_since)
1179                         warning(_("--shallow-since is ignored in local clones; use file:// instead."));
1180                 if (option_not.nr)
1181                         warning(_("--shallow-exclude is ignored in local clones; use file:// instead."));
1182                 if (filter_options.choice)
1183                         warning(_("--filter is ignored in local clones; use file:// instead."));
1184                 if (!access(mkpath("%s/shallow", path), F_OK)) {
1185                         if (reject_shallow)
1186                                 die(_("source repository is shallow, reject to clone."));
1187                         if (option_local > 0)
1188                                 warning(_("source repository is shallow, ignoring --local"));
1189                         is_local = 0;
1190                 }
1191         }
1192         if (option_local > 0 && !is_local)
1193                 warning(_("--local is ignored"));
1194
1195         transport = transport_get(remote, path ? path : remote->url[0]);
1196         transport_set_verbosity(transport, option_verbosity, option_progress);
1197         transport->family = family;
1198         transport->cloning = 1;
1199
1200         if (is_bundle) {
1201                 struct bundle_header header = BUNDLE_HEADER_INIT;
1202                 int fd = read_bundle_header(path, &header);
1203                 int has_filter = header.filter.choice != LOFC_DISABLED;
1204
1205                 if (fd > 0)
1206                         close(fd);
1207                 bundle_header_release(&header);
1208                 if (has_filter)
1209                         die(_("cannot clone from filtered bundle"));
1210         }
1211
1212         transport_set_option(transport, TRANS_OPT_KEEP, "yes");
1213
1214         if (reject_shallow)
1215                 transport_set_option(transport, TRANS_OPT_REJECT_SHALLOW, "1");
1216         if (option_depth)
1217                 transport_set_option(transport, TRANS_OPT_DEPTH,
1218                                      option_depth);
1219         if (option_since)
1220                 transport_set_option(transport, TRANS_OPT_DEEPEN_SINCE,
1221                                      option_since);
1222         if (option_not.nr)
1223                 transport_set_option(transport, TRANS_OPT_DEEPEN_NOT,
1224                                      (const char *)&option_not);
1225         if (option_single_branch)
1226                 transport_set_option(transport, TRANS_OPT_FOLLOWTAGS, "1");
1227
1228         if (option_upload_pack)
1229                 transport_set_option(transport, TRANS_OPT_UPLOADPACK,
1230                                      option_upload_pack);
1231
1232         if (server_options.nr)
1233                 transport->server_options = &server_options;
1234
1235         if (filter_options.choice) {
1236                 const char *spec =
1237                         expand_list_objects_filter_spec(&filter_options);
1238                 transport_set_option(transport, TRANS_OPT_LIST_OBJECTS_FILTER,
1239                                      spec);
1240                 transport_set_option(transport, TRANS_OPT_FROM_PROMISOR, "1");
1241         }
1242
1243         if (transport->smart_options && !deepen && !filter_options.choice)
1244                 transport->smart_options->check_self_contained_and_connected = 1;
1245
1246         /*
1247          * Before fetching from the remote, download and install bundle
1248          * data from the --bundle-uri option.
1249          */
1250         if (bundle_uri) {
1251                 /* At this point, we need the_repository to match the cloned repo. */
1252                 if (repo_init(the_repository, git_dir, work_tree))
1253                         warning(_("failed to initialize the repo, skipping bundle URI"));
1254                 else if (fetch_bundle_uri(the_repository, bundle_uri))
1255                         warning(_("failed to fetch objects from bundle URI '%s'"),
1256                                 bundle_uri);
1257         }
1258
1259         strvec_push(&transport_ls_refs_options.ref_prefixes, "HEAD");
1260         refspec_ref_prefixes(&remote->fetch,
1261                              &transport_ls_refs_options.ref_prefixes);
1262         if (option_branch)
1263                 expand_ref_prefix(&transport_ls_refs_options.ref_prefixes,
1264                                   option_branch);
1265         if (!option_no_tags)
1266                 strvec_push(&transport_ls_refs_options.ref_prefixes,
1267                             "refs/tags/");
1268
1269         refs = transport_get_remote_refs(transport, &transport_ls_refs_options);
1270
1271         if (refs)
1272                 mapped_refs = wanted_peer_refs(refs, &remote->fetch);
1273
1274         if (mapped_refs) {
1275                 int hash_algo = hash_algo_by_ptr(transport_get_hash_algo(transport));
1276
1277                 /*
1278                  * Now that we know what algorithm the remote side is using,
1279                  * let's set ours to the same thing.
1280                  */
1281                 initialize_repository_version(hash_algo, 1);
1282                 repo_set_hash_algo(the_repository, hash_algo);
1283                 /*
1284                  * transport_get_remote_refs() may return refs with null sha-1
1285                  * in mapped_refs (see struct transport->get_refs_list
1286                  * comment). In that case we need fetch it early because
1287                  * remote_head code below relies on it.
1288                  *
1289                  * for normal clones, transport_get_remote_refs() should
1290                  * return reliable ref set, we can delay cloning until after
1291                  * remote HEAD check.
1292                  */
1293                 for (ref = refs; ref; ref = ref->next)
1294                         if (is_null_oid(&ref->old_oid)) {
1295                                 complete_refs_before_fetch = 0;
1296                                 break;
1297                         }
1298
1299                 if (!is_local && !complete_refs_before_fetch) {
1300                         if (transport_fetch_refs(transport, mapped_refs))
1301                                 die(_("remote transport reported error"));
1302                 }
1303         }
1304
1305         remote_head = find_ref_by_name(refs, "HEAD");
1306         remote_head_points_at = guess_remote_head(remote_head, mapped_refs, 0);
1307
1308         if (option_branch) {
1309                 our_head_points_at = find_remote_branch(mapped_refs, option_branch);
1310                 if (!our_head_points_at)
1311                         die(_("Remote branch %s not found in upstream %s"),
1312                             option_branch, remote_name);
1313         } else if (remote_head_points_at) {
1314                 our_head_points_at = remote_head_points_at;
1315         } else if (remote_head) {
1316                 our_head_points_at = NULL;
1317         } else {
1318                 const char *branch;
1319
1320                 if (!mapped_refs) {
1321                         warning(_("You appear to have cloned an empty repository."));
1322                         option_no_checkout = 1;
1323                 }
1324
1325                 if (transport_ls_refs_options.unborn_head_target &&
1326                     skip_prefix(transport_ls_refs_options.unborn_head_target,
1327                                 "refs/heads/", &branch)) {
1328                         unborn_head  = xstrdup(transport_ls_refs_options.unborn_head_target);
1329                 } else {
1330                         branch = git_default_branch_name(0);
1331                         unborn_head = xstrfmt("refs/heads/%s", branch);
1332                 }
1333
1334                 /*
1335                  * We may have selected a local default branch name "foo",
1336                  * and even though the remote's HEAD does not point there,
1337                  * it may still have a "foo" branch. If so, set it up so
1338                  * that we can follow the usual checkout code later.
1339                  *
1340                  * Note that for an empty repo we'll already have set
1341                  * option_no_checkout above, which would work against us here.
1342                  * But for an empty repo, find_remote_branch() can never find
1343                  * a match.
1344                  */
1345                 our_head_points_at = find_remote_branch(mapped_refs, branch);
1346         }
1347
1348         write_refspec_config(src_ref_prefix, our_head_points_at,
1349                         remote_head_points_at, &branch_top);
1350
1351         if (filter_options.choice)
1352                 partial_clone_register(remote_name, &filter_options);
1353
1354         if (is_local)
1355                 clone_local(path, git_dir);
1356         else if (mapped_refs && complete_refs_before_fetch) {
1357                 if (transport_fetch_refs(transport, mapped_refs))
1358                         die(_("remote transport reported error"));
1359         }
1360
1361         update_remote_refs(refs, mapped_refs, remote_head_points_at,
1362                            branch_top.buf, reflog_msg.buf, transport,
1363                            !is_local);
1364
1365         update_head(our_head_points_at, remote_head, unborn_head, reflog_msg.buf);
1366
1367         /*
1368          * We want to show progress for recursive submodule clones iff
1369          * we did so for the main clone. But only the transport knows
1370          * the final decision for this flag, so we need to rescue the value
1371          * before we free the transport.
1372          */
1373         submodule_progress = transport->progress;
1374
1375         transport_unlock_pack(transport, 0);
1376         transport_disconnect(transport);
1377
1378         if (option_dissociate) {
1379                 close_object_store(the_repository->objects);
1380                 dissociate_from_references();
1381         }
1382
1383         junk_mode = JUNK_LEAVE_REPO;
1384         err = checkout(submodule_progress, filter_submodules);
1385
1386         free(remote_name);
1387         strbuf_release(&reflog_msg);
1388         strbuf_release(&branch_top);
1389         strbuf_release(&key);
1390         free_refs(mapped_refs);
1391         free_refs(remote_head_points_at);
1392         free(unborn_head);
1393         free(dir);
1394         free(path);
1395         UNLEAK(repo);
1396         junk_mode = JUNK_LEAVE_ALL;
1397
1398         transport_ls_refs_options_release(&transport_ls_refs_options);
1399         return err;
1400 }