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