git.oblomov.eu Git - git/blob - builtin/pull.c

   1 /*
   2  * Builtin "git pull"
   3  *
   4  * Based on git-pull.sh by Junio C Hamano
   5  *
   6  * Fetch one or more remote refs and merge it/them into the current HEAD.
   7  */
   8 #define USE_THE_INDEX_COMPATIBILITY_MACROS
   9 #include "cache.h"
  10 #include "config.h"
  11 #include "builtin.h"
  12 #include "parse-options.h"
  13 #include "exec-cmd.h"
  14 #include "run-command.h"
  15 #include "sha1-array.h"
  16 #include "remote.h"
  17 #include "dir.h"
  18 #include "rebase.h"
  19 #include "refs.h"
  20 #include "refspec.h"
  21 #include "revision.h"
  22 #include "submodule.h"
  23 #include "submodule-config.h"
  24 #include "tempfile.h"
  25 #include "lockfile.h"
  26 #include "wt-status.h"
  27 #include "commit-reach.h"
  28 #include "sequencer.h"
  29
  30 /**
  31  * Parses the value of --rebase. If value is a false value, returns
  32  * REBASE_FALSE. If value is a true value, returns REBASE_TRUE. If value is
  33  * "merges", returns REBASE_MERGES. If value is "preserve", returns
  34  * REBASE_PRESERVE. If value is a invalid value, dies with a fatal error if
  35  * fatal is true, otherwise returns REBASE_INVALID.
  36  */
  37 static enum rebase_type parse_config_rebase(const char *key, const char *value,
  38                 int fatal)
  39 {
  40         enum rebase_type v = rebase_parse_value(value);
  41         if (v != REBASE_INVALID)
  42                 return v;
  43
  44         if (fatal)
  45                 die(_("Invalid value for %s: %s"), key, value);
  46         else
  47                 error(_("Invalid value for %s: %s"), key, value);
  48
  49         return REBASE_INVALID;
  50 }
  51
  52 /**
  53  * Callback for --rebase, which parses arg with parse_config_rebase().
  54  */
  55 static int parse_opt_rebase(const struct option *opt, const char *arg, int unset)
  56 {
  57         enum rebase_type *value = opt->value;
  58
  59         if (arg)
  60                 *value = parse_config_rebase("--rebase", arg, 0);
  61         else
  62                 *value = unset ? REBASE_FALSE : REBASE_TRUE;
  63         return *value == REBASE_INVALID ? -1 : 0;
  64 }
  65
  66 static const char * const pull_usage[] = {
  67         N_("git pull [<options>] [<repository> [<refspec>...]]"),
  68         NULL
  69 };
  70
  71 /* Shared options */
  72 static int opt_verbosity;
  73 static char *opt_progress;
  74 static int recurse_submodules = RECURSE_SUBMODULES_DEFAULT;
  75
  76 /* Options passed to git-merge or git-rebase */
  77 static enum rebase_type opt_rebase = -1;
  78 static char *opt_diffstat;
  79 static char *opt_log;
  80 static char *opt_signoff;
  81 static char *opt_squash;
  82 static char *opt_commit;
  83 static char *opt_edit;
  84 static char *cleanup_arg;
  85 static char *opt_ff;
  86 static char *opt_verify_signatures;
  87 static int opt_autostash = -1;
  88 static int config_autostash;
  89 static struct argv_array opt_strategies = ARGV_ARRAY_INIT;
  90 static struct argv_array opt_strategy_opts = ARGV_ARRAY_INIT;
  91 static char *opt_gpg_sign;
  92 static int opt_allow_unrelated_histories;
  93
  94 /* Options passed to git-fetch */
  95 static char *opt_all;
  96 static char *opt_append;
  97 static char *opt_upload_pack;
  98 static int opt_force;
  99 static char *opt_tags;
 100 static char *opt_prune;
 101 static char *max_children;
 102 static int opt_dry_run;
 103 static char *opt_keep;
 104 static char *opt_depth;
 105 static char *opt_unshallow;
 106 static char *opt_update_shallow;
 107 static char *opt_refmap;
 108 static char *opt_ipv4;
 109 static char *opt_ipv6;
 110 static int opt_show_forced_updates = -1;
 111 static char *set_upstream;
 112
 113 static struct option pull_options[] = {
 114         /* Shared options */
 115         OPT__VERBOSITY(&opt_verbosity),
 116         OPT_PASSTHRU(0, "progress", &opt_progress, NULL,
 117                 N_("force progress reporting"),
 118                 PARSE_OPT_NOARG),
 119         { OPTION_CALLBACK, 0, "recurse-submodules",
 120                    &recurse_submodules, N_("on-demand"),
 121                    N_("control for recursive fetching of submodules"),
 122                    PARSE_OPT_OPTARG, option_fetch_parse_recurse_submodules },
 123
 124         /* Options passed to git-merge or git-rebase */
 125         OPT_GROUP(N_("Options related to merging")),
 126         { OPTION_CALLBACK, 'r', "rebase", &opt_rebase,
 127           "(false|true|merges|preserve|interactive)",
 128           N_("incorporate changes by rebasing rather than merging"),
 129           PARSE_OPT_OPTARG, parse_opt_rebase },
 130         OPT_PASSTHRU('n', NULL, &opt_diffstat, NULL,
 131                 N_("do not show a diffstat at the end of the merge"),
 132                 PARSE_OPT_NOARG | PARSE_OPT_NONEG),
 133         OPT_PASSTHRU(0, "stat", &opt_diffstat, NULL,
 134                 N_("show a diffstat at the end of the merge"),
 135                 PARSE_OPT_NOARG),
 136         OPT_PASSTHRU(0, "summary", &opt_diffstat, NULL,
 137                 N_("(synonym to --stat)"),
 138                 PARSE_OPT_NOARG | PARSE_OPT_HIDDEN),
 139         OPT_PASSTHRU(0, "log", &opt_log, N_("n"),
 140                 N_("add (at most <n>) entries from shortlog to merge commit message"),
 141                 PARSE_OPT_OPTARG),
 142         OPT_PASSTHRU(0, "signoff", &opt_signoff, NULL,
 143                 N_("add Signed-off-by:"),
 144                 PARSE_OPT_OPTARG),
 145         OPT_PASSTHRU(0, "squash", &opt_squash, NULL,
 146                 N_("create a single commit instead of doing a merge"),
 147                 PARSE_OPT_NOARG),
 148         OPT_PASSTHRU(0, "commit", &opt_commit, NULL,
 149                 N_("perform a commit if the merge succeeds (default)"),
 150                 PARSE_OPT_NOARG),
 151         OPT_PASSTHRU(0, "edit", &opt_edit, NULL,
 152                 N_("edit message before committing"),
 153                 PARSE_OPT_NOARG),
 154         OPT_CLEANUP(&cleanup_arg),
 155         OPT_PASSTHRU(0, "ff", &opt_ff, NULL,
 156                 N_("allow fast-forward"),
 157                 PARSE_OPT_NOARG),
 158         OPT_PASSTHRU(0, "ff-only", &opt_ff, NULL,
 159                 N_("abort if fast-forward is not possible"),
 160                 PARSE_OPT_NOARG | PARSE_OPT_NONEG),
 161         OPT_PASSTHRU(0, "verify-signatures", &opt_verify_signatures, NULL,
 162                 N_("verify that the named commit has a valid GPG signature"),
 163                 PARSE_OPT_NOARG),
 164         OPT_BOOL(0, "autostash", &opt_autostash,
 165                 N_("automatically stash/stash pop before and after rebase")),
 166         OPT_PASSTHRU_ARGV('s', "strategy", &opt_strategies, N_("strategy"),
 167                 N_("merge strategy to use"),
 168                 0),
 169         OPT_PASSTHRU_ARGV('X', "strategy-option", &opt_strategy_opts,
 170                 N_("option=value"),
 171                 N_("option for selected merge strategy"),
 172                 0),
 173         OPT_PASSTHRU('S', "gpg-sign", &opt_gpg_sign, N_("key-id"),
 174                 N_("GPG sign commit"),
 175                 PARSE_OPT_OPTARG),
 176         OPT_SET_INT(0, "allow-unrelated-histories",
 177                     &opt_allow_unrelated_histories,
 178                     N_("allow merging unrelated histories"), 1),
 179
 180         /* Options passed to git-fetch */
 181         OPT_GROUP(N_("Options related to fetching")),
 182         OPT_PASSTHRU(0, "all", &opt_all, NULL,
 183                 N_("fetch from all remotes"),
 184                 PARSE_OPT_NOARG),
 185         OPT_PASSTHRU('a', "append", &opt_append, NULL,
 186                 N_("append to .git/FETCH_HEAD instead of overwriting"),
 187                 PARSE_OPT_NOARG),
 188         OPT_PASSTHRU(0, "upload-pack", &opt_upload_pack, N_("path"),
 189                 N_("path to upload pack on remote end"),
 190                 0),
 191         OPT__FORCE(&opt_force, N_("force overwrite of local branch"), 0),
 192         OPT_PASSTHRU('t', "tags", &opt_tags, NULL,
 193                 N_("fetch all tags and associated objects"),
 194                 PARSE_OPT_NOARG),
 195         OPT_PASSTHRU('p', "prune", &opt_prune, NULL,
 196                 N_("prune remote-tracking branches no longer on remote"),
 197                 PARSE_OPT_NOARG),
 198         OPT_PASSTHRU('j', "jobs", &max_children, N_("n"),
 199                 N_("number of submodules pulled in parallel"),
 200                 PARSE_OPT_OPTARG),
 201         OPT_BOOL(0, "dry-run", &opt_dry_run,
 202                 N_("dry run")),
 203         OPT_PASSTHRU('k', "keep", &opt_keep, NULL,
 204                 N_("keep downloaded pack"),
 205                 PARSE_OPT_NOARG),
 206         OPT_PASSTHRU(0, "depth", &opt_depth, N_("depth"),
 207                 N_("deepen history of shallow clone"),
 208                 0),
 209         OPT_PASSTHRU(0, "unshallow", &opt_unshallow, NULL,
 210                 N_("convert to a complete repository"),
 211                 PARSE_OPT_NONEG | PARSE_OPT_NOARG),
 212         OPT_PASSTHRU(0, "update-shallow", &opt_update_shallow, NULL,
 213                 N_("accept refs that update .git/shallow"),
 214                 PARSE_OPT_NOARG),
 215         OPT_PASSTHRU(0, "refmap", &opt_refmap, N_("refmap"),
 216                 N_("specify fetch refmap"),
 217                 PARSE_OPT_NONEG),
 218         OPT_PASSTHRU('4',  "ipv4", &opt_ipv4, NULL,
 219                 N_("use IPv4 addresses only"),
 220                 PARSE_OPT_NOARG),
 221         OPT_PASSTHRU('6',  "ipv6", &opt_ipv6, NULL,
 222                 N_("use IPv6 addresses only"),
 223                 PARSE_OPT_NOARG),
 224         OPT_BOOL(0, "show-forced-updates", &opt_show_forced_updates,
 225                  N_("check for forced-updates on all updated branches")),
 226         OPT_PASSTHRU(0, "set-upstream", &set_upstream, NULL,
 227                 N_("set upstream for git pull/fetch"),
 228                 PARSE_OPT_NOARG),
 229
 230         OPT_END()
 231 };
 232
 233 /**
 234  * Pushes "-q" or "-v" switches into arr to match the opt_verbosity level.
 235  */
 236 static void argv_push_verbosity(struct argv_array *arr)
 237 {
 238         int verbosity;
 239
 240         for (verbosity = opt_verbosity; verbosity > 0; verbosity--)
 241                 argv_array_push(arr, "-v");
 242
 243         for (verbosity = opt_verbosity; verbosity < 0; verbosity++)
 244                 argv_array_push(arr, "-q");
 245 }
 246
 247 /**
 248  * Pushes "-f" switches into arr to match the opt_force level.
 249  */
 250 static void argv_push_force(struct argv_array *arr)
 251 {
 252         int force = opt_force;
 253         while (force-- > 0)
 254                 argv_array_push(arr, "-f");
 255 }
 256
 257 /**
 258  * Sets the GIT_REFLOG_ACTION environment variable to the concatenation of argv
 259  */
 260 static void set_reflog_message(int argc, const char **argv)
 261 {
 262         int i;
 263         struct strbuf msg = STRBUF_INIT;
 264
 265         for (i = 0; i < argc; i++) {
 266                 if (i)
 267                         strbuf_addch(&msg, ' ');
 268                 strbuf_addstr(&msg, argv[i]);
 269         }
 270
 271         setenv("GIT_REFLOG_ACTION", msg.buf, 0);
 272
 273         strbuf_release(&msg);
 274 }
 275
 276 /**
 277  * If pull.ff is unset, returns NULL. If pull.ff is "true", returns "--ff". If
 278  * pull.ff is "false", returns "--no-ff". If pull.ff is "only", returns
 279  * "--ff-only". Otherwise, if pull.ff is set to an invalid value, die with an
 280  * error.
 281  */
 282 static const char *config_get_ff(void)
 283 {
 284         const char *value;
 285
 286         if (git_config_get_value("pull.ff", &value))
 287                 return NULL;
 288
 289         switch (git_parse_maybe_bool(value)) {
 290         case 0:
 291                 return "--no-ff";
 292         case 1:
 293                 return "--ff";
 294         }
 295
 296         if (!strcmp(value, "only"))
 297                 return "--ff-only";
 298
 299         die(_("Invalid value for pull.ff: %s"), value);
 300 }
 301
 302 /**
 303  * Returns the default configured value for --rebase. It first looks for the
 304  * value of "branch.$curr_branch.rebase", where $curr_branch is the current
 305  * branch, and if HEAD is detached or the configuration key does not exist,
 306  * looks for the value of "pull.rebase". If both configuration keys do not
 307  * exist, returns REBASE_FALSE.
 308  */
 309 static enum rebase_type config_get_rebase(void)
 310 {
 311         struct branch *curr_branch = branch_get("HEAD");
 312         const char *value;
 313
 314         if (curr_branch) {
 315                 char *key = xstrfmt("branch.%s.rebase", curr_branch->name);
 316
 317                 if (!git_config_get_value(key, &value)) {
 318                         enum rebase_type ret = parse_config_rebase(key, value, 1);
 319                         free(key);
 320                         return ret;
 321                 }
 322
 323                 free(key);
 324         }
 325
 326         if (!git_config_get_value("pull.rebase", &value))
 327                 return parse_config_rebase("pull.rebase", value, 1);
 328
 329         return REBASE_FALSE;
 330 }
 331
 332 /**
 333  * Read config variables.
 334  */
 335 static int git_pull_config(const char *var, const char *value, void *cb)
 336 {
 337         if (!strcmp(var, "rebase.autostash")) {
 338                 config_autostash = git_config_bool(var, value);
 339                 return 0;
 340         } else if (!strcmp(var, "submodule.recurse")) {
 341                 recurse_submodules = git_config_bool(var, value) ?
 342                         RECURSE_SUBMODULES_ON : RECURSE_SUBMODULES_OFF;
 343                 return 0;
 344         }
 345         return git_default_config(var, value, cb);
 346 }
 347
 348 /**
 349  * Appends merge candidates from FETCH_HEAD that are not marked not-for-merge
 350  * into merge_heads.
 351  */
 352 static void get_merge_heads(struct oid_array *merge_heads)
 353 {
 354         const char *filename = git_path_fetch_head(the_repository);
 355         FILE *fp;
 356         struct strbuf sb = STRBUF_INIT;
 357         struct object_id oid;
 358
 359         fp = xfopen(filename, "r");
 360         while (strbuf_getline_lf(&sb, fp) != EOF) {
 361                 const char *p;
 362                 if (parse_oid_hex(sb.buf, &oid, &p))
 363                         continue;  /* invalid line: does not start with object ID */
 364                 if (starts_with(p, "\tnot-for-merge\t"))
 365                         continue;  /* ref is not-for-merge */
 366                 oid_array_append(merge_heads, &oid);
 367         }
 368         fclose(fp);
 369         strbuf_release(&sb);
 370 }
 371
 372 /**
 373  * Used by die_no_merge_candidates() as a for_each_remote() callback to
 374  * retrieve the name of the remote if the repository only has one remote.
 375  */
 376 static int get_only_remote(struct remote *remote, void *cb_data)
 377 {
 378         const char **remote_name = cb_data;
 379
 380         if (*remote_name)
 381                 return -1;
 382
 383         *remote_name = remote->name;
 384         return 0;
 385 }
 386
 387 /**
 388  * Dies with the appropriate reason for why there are no merge candidates:
 389  *
 390  * 1. We fetched from a specific remote, and a refspec was given, but it ended
 391  *    up not fetching anything. This is usually because the user provided a
 392  *    wildcard refspec which had no matches on the remote end.
 393  *
 394  * 2. We fetched from a non-default remote, but didn't specify a branch to
 395  *    merge. We can't use the configured one because it applies to the default
 396  *    remote, thus the user must specify the branches to merge.
 397  *
 398  * 3. We fetched from the branch's or repo's default remote, but:
 399  *
 400  *    a. We are not on a branch, so there will never be a configured branch to
 401  *       merge with.
 402  *
 403  *    b. We are on a branch, but there is no configured branch to merge with.
 404  *
 405  * 4. We fetched from the branch's or repo's default remote, but the configured
 406  *    branch to merge didn't get fetched. (Either it doesn't exist, or wasn't
 407  *    part of the configured fetch refspec.)
 408  */
 409 static void NORETURN die_no_merge_candidates(const char *repo, const char **refspecs)
 410 {
 411         struct branch *curr_branch = branch_get("HEAD");
 412         const char *remote = curr_branch ? curr_branch->remote_name : NULL;
 413
 414         if (*refspecs) {
 415                 if (opt_rebase)
 416                         fprintf_ln(stderr, _("There is no candidate for rebasing against among the refs that you just fetched."));
 417                 else
 418                         fprintf_ln(stderr, _("There are no candidates for merging among the refs that you just fetched."));
 419                 fprintf_ln(stderr, _("Generally this means that you provided a wildcard refspec which had no\n"
 420                                         "matches on the remote end."));
 421         } else if (repo && curr_branch && (!remote || strcmp(repo, remote))) {
 422                 fprintf_ln(stderr, _("You asked to pull from the remote '%s', but did not specify\n"
 423                         "a branch. Because this is not the default configured remote\n"
 424                         "for your current branch, you must specify a branch on the command line."),
 425                         repo);
 426         } else if (!curr_branch) {
 427                 fprintf_ln(stderr, _("You are not currently on a branch."));
 428                 if (opt_rebase)
 429                         fprintf_ln(stderr, _("Please specify which branch you want to rebase against."));
 430                 else
 431                         fprintf_ln(stderr, _("Please specify which branch you want to merge with."));
 432                 fprintf_ln(stderr, _("See git-pull(1) for details."));
 433                 fprintf(stderr, "\n");
 434                 fprintf_ln(stderr, "    git pull %s %s", _("<remote>"), _("<branch>"));
 435                 fprintf(stderr, "\n");
 436         } else if (!curr_branch->merge_nr) {
 437                 const char *remote_name = NULL;
 438
 439                 if (for_each_remote(get_only_remote, &remote_name) || !remote_name)
 440                         remote_name = _("<remote>");
 441
 442                 fprintf_ln(stderr, _("There is no tracking information for the current branch."));
 443                 if (opt_rebase)
 444                         fprintf_ln(stderr, _("Please specify which branch you want to rebase against."));
 445                 else
 446                         fprintf_ln(stderr, _("Please specify which branch you want to merge with."));
 447                 fprintf_ln(stderr, _("See git-pull(1) for details."));
 448                 fprintf(stderr, "\n");
 449                 fprintf_ln(stderr, "    git pull %s %s", _("<remote>"), _("<branch>"));
 450                 fprintf(stderr, "\n");
 451                 fprintf_ln(stderr, _("If you wish to set tracking information for this branch you can do so with:"));
 452                 fprintf(stderr, "\n");
 453                 fprintf_ln(stderr, "    git branch --set-upstream-to=%s/%s %s\n",
 454                                 remote_name, _("<branch>"), curr_branch->name);
 455         } else
 456                 fprintf_ln(stderr, _("Your configuration specifies to merge with the ref '%s'\n"
 457                         "from the remote, but no such ref was fetched."),
 458                         *curr_branch->merge_name);
 459         exit(1);
 460 }
 461
 462 /**
 463  * Parses argv into [<repo> [<refspecs>...]], returning their values in `repo`
 464  * as a string and `refspecs` as a null-terminated array of strings. If `repo`
 465  * is not provided in argv, it is set to NULL.
 466  */
 467 static void parse_repo_refspecs(int argc, const char **argv, const char **repo,
 468                 const char ***refspecs)
 469 {
 470         if (argc > 0) {
 471                 *repo = *argv++;
 472                 argc--;
 473         } else
 474                 *repo = NULL;
 475         *refspecs = argv;
 476 }
 477
 478 /**
 479  * Runs git-fetch, returning its exit status. `repo` and `refspecs` are the
 480  * repository and refspecs to fetch, or NULL if they are not provided.
 481  */
 482 static int run_fetch(const char *repo, const char **refspecs)
 483 {
 484         struct argv_array args = ARGV_ARRAY_INIT;
 485         int ret;
 486
 487         argv_array_pushl(&args, "fetch", "--update-head-ok", NULL);
 488
 489         /* Shared options */
 490         argv_push_verbosity(&args);
 491         if (opt_progress)
 492                 argv_array_push(&args, opt_progress);
 493
 494         /* Options passed to git-fetch */
 495         if (opt_all)
 496                 argv_array_push(&args, opt_all);
 497         if (opt_append)
 498                 argv_array_push(&args, opt_append);
 499         if (opt_upload_pack)
 500                 argv_array_push(&args, opt_upload_pack);
 501         argv_push_force(&args);
 502         if (opt_tags)
 503                 argv_array_push(&args, opt_tags);
 504         if (opt_prune)
 505                 argv_array_push(&args, opt_prune);
 506         if (recurse_submodules != RECURSE_SUBMODULES_DEFAULT)
 507                 switch (recurse_submodules) {
 508                 case RECURSE_SUBMODULES_ON:
 509                         argv_array_push(&args, "--recurse-submodules=on");
 510                         break;
 511                 case RECURSE_SUBMODULES_OFF:
 512                         argv_array_push(&args, "--recurse-submodules=no");
 513                         break;
 514                 case RECURSE_SUBMODULES_ON_DEMAND:
 515                         argv_array_push(&args, "--recurse-submodules=on-demand");
 516                         break;
 517                 default:
 518                         BUG("submodule recursion option not understood");
 519                 }
 520         if (max_children)
 521                 argv_array_push(&args, max_children);
 522         if (opt_dry_run)
 523                 argv_array_push(&args, "--dry-run");
 524         if (opt_keep)
 525                 argv_array_push(&args, opt_keep);
 526         if (opt_depth)
 527                 argv_array_push(&args, opt_depth);
 528         if (opt_unshallow)
 529                 argv_array_push(&args, opt_unshallow);
 530         if (opt_update_shallow)
 531                 argv_array_push(&args, opt_update_shallow);
 532         if (opt_refmap)
 533                 argv_array_push(&args, opt_refmap);
 534         if (opt_ipv4)
 535                 argv_array_push(&args, opt_ipv4);
 536         if (opt_ipv6)
 537                 argv_array_push(&args, opt_ipv6);
 538         if (opt_show_forced_updates > 0)
 539                 argv_array_push(&args, "--show-forced-updates");
 540         else if (opt_show_forced_updates == 0)
 541                 argv_array_push(&args, "--no-show-forced-updates");
 542         if (set_upstream)
 543                 argv_array_push(&args, set_upstream);
 544
 545         if (repo) {
 546                 argv_array_push(&args, repo);
 547                 argv_array_pushv(&args, refspecs);
 548         } else if (*refspecs)
 549                 BUG("refspecs without repo?");
 550         ret = run_command_v_opt(args.argv, RUN_GIT_CMD);
 551         argv_array_clear(&args);
 552         return ret;
 553 }
 554
 555 /**
 556  * "Pulls into void" by branching off merge_head.
 557  */
 558 static int pull_into_void(const struct object_id *merge_head,
 559                 const struct object_id *curr_head)
 560 {
 561         if (opt_verify_signatures) {
 562                 struct commit *commit;
 563
 564                 commit = lookup_commit(the_repository, merge_head);
 565                 if (!commit)
 566                         die(_("unable to access commit %s"),
 567                             oid_to_hex(merge_head));
 568
 569                 verify_merge_signature(commit, opt_verbosity);
 570         }
 571
 572         /*
 573          * Two-way merge: we treat the index as based on an empty tree,
 574          * and try to fast-forward to HEAD. This ensures we will not lose
 575          * index/worktree changes that the user already made on the unborn
 576          * branch.
 577          */
 578         if (checkout_fast_forward(the_repository,
 579                                   the_hash_algo->empty_tree,
 580                                   merge_head, 0))
 581                 return 1;
 582
 583         if (update_ref("initial pull", "HEAD", merge_head, curr_head, 0, UPDATE_REFS_DIE_ON_ERR))
 584                 return 1;
 585
 586         return 0;
 587 }
 588
 589 static int rebase_submodules(void)
 590 {
 591         struct child_process cp = CHILD_PROCESS_INIT;
 592
 593         cp.git_cmd = 1;
 594         cp.no_stdin = 1;
 595         argv_array_pushl(&cp.args, "submodule", "update",
 596                                    "--recursive", "--rebase", NULL);
 597         argv_push_verbosity(&cp.args);
 598
 599         return run_command(&cp);
 600 }
 601
 602 static int update_submodules(void)
 603 {
 604         struct child_process cp = CHILD_PROCESS_INIT;
 605
 606         cp.git_cmd = 1;
 607         cp.no_stdin = 1;
 608         argv_array_pushl(&cp.args, "submodule", "update",
 609                                    "--recursive", "--checkout", NULL);
 610         argv_push_verbosity(&cp.args);
 611
 612         return run_command(&cp);
 613 }
 614
 615 /**
 616  * Runs git-merge, returning its exit status.
 617  */
 618 static int run_merge(void)
 619 {
 620         int ret;
 621         struct argv_array args = ARGV_ARRAY_INIT;
 622
 623         argv_array_pushl(&args, "merge", NULL);
 624
 625         /* Shared options */
 626         argv_push_verbosity(&args);
 627         if (opt_progress)
 628                 argv_array_push(&args, opt_progress);
 629
 630         /* Options passed to git-merge */
 631         if (opt_diffstat)
 632                 argv_array_push(&args, opt_diffstat);
 633         if (opt_log)
 634                 argv_array_push(&args, opt_log);
 635         if (opt_signoff)
 636                 argv_array_push(&args, opt_signoff);
 637         if (opt_squash)
 638                 argv_array_push(&args, opt_squash);
 639         if (opt_commit)
 640                 argv_array_push(&args, opt_commit);
 641         if (opt_edit)
 642                 argv_array_push(&args, opt_edit);
 643         if (cleanup_arg)
 644                 argv_array_pushf(&args, "--cleanup=%s", cleanup_arg);
 645         if (opt_ff)
 646                 argv_array_push(&args, opt_ff);
 647         if (opt_verify_signatures)
 648                 argv_array_push(&args, opt_verify_signatures);
 649         argv_array_pushv(&args, opt_strategies.argv);
 650         argv_array_pushv(&args, opt_strategy_opts.argv);
 651         if (opt_gpg_sign)
 652                 argv_array_push(&args, opt_gpg_sign);
 653         if (opt_allow_unrelated_histories > 0)
 654                 argv_array_push(&args, "--allow-unrelated-histories");
 655
 656         argv_array_push(&args, "FETCH_HEAD");
 657         ret = run_command_v_opt(args.argv, RUN_GIT_CMD);
 658         argv_array_clear(&args);
 659         return ret;
 660 }
 661
 662 /**
 663  * Returns remote's upstream branch for the current branch. If remote is NULL,
 664  * the current branch's configured default remote is used. Returns NULL if
 665  * `remote` does not name a valid remote, HEAD does not point to a branch,
 666  * remote is not the branch's configured remote or the branch does not have any
 667  * configured upstream branch.
 668  */
 669 static const char *get_upstream_branch(const char *remote)
 670 {
 671         struct remote *rm;
 672         struct branch *curr_branch;
 673         const char *curr_branch_remote;
 674
 675         rm = remote_get(remote);
 676         if (!rm)
 677                 return NULL;
 678
 679         curr_branch = branch_get("HEAD");
 680         if (!curr_branch)
 681                 return NULL;
 682
 683         curr_branch_remote = remote_for_branch(curr_branch, NULL);
 684         assert(curr_branch_remote);
 685
 686         if (strcmp(curr_branch_remote, rm->name))
 687                 return NULL;
 688
 689         return branch_get_upstream(curr_branch, NULL);
 690 }
 691
 692 /**
 693  * Derives the remote-tracking branch from the remote and refspec.
 694  *
 695  * FIXME: The current implementation assumes the default mapping of
 696  * refs/heads/<branch_name> to refs/remotes/<remote_name>/<branch_name>.
 697  */
 698 static const char *get_tracking_branch(const char *remote, const char *refspec)
 699 {
 700         struct refspec_item spec;
 701         const char *spec_src;
 702         const char *merge_branch;
 703
 704         refspec_item_init_or_die(&spec, refspec, REFSPEC_FETCH);
 705         spec_src = spec.src;
 706         if (!*spec_src || !strcmp(spec_src, "HEAD"))
 707                 spec_src = "HEAD";
 708         else if (skip_prefix(spec_src, "heads/", &spec_src))
 709                 ;
 710         else if (skip_prefix(spec_src, "refs/heads/", &spec_src))
 711                 ;
 712         else if (starts_with(spec_src, "refs/") ||
 713                 starts_with(spec_src, "tags/") ||
 714                 starts_with(spec_src, "remotes/"))
 715                 spec_src = "";
 716
 717         if (*spec_src) {
 718                 if (!strcmp(remote, "."))
 719                         merge_branch = mkpath("refs/heads/%s", spec_src);
 720                 else
 721                         merge_branch = mkpath("refs/remotes/%s/%s", remote, spec_src);
 722         } else
 723                 merge_branch = NULL;
 724
 725         refspec_item_clear(&spec);
 726         return merge_branch;
 727 }
 728
 729 /**
 730  * Given the repo and refspecs, sets fork_point to the point at which the
 731  * current branch forked from its remote-tracking branch. Returns 0 on success,
 732  * -1 on failure.
 733  */
 734 static int get_rebase_fork_point(struct object_id *fork_point, const char *repo,
 735                 const char *refspec)
 736 {
 737         int ret;
 738         struct branch *curr_branch;
 739         const char *remote_branch;
 740         struct child_process cp = CHILD_PROCESS_INIT;
 741         struct strbuf sb = STRBUF_INIT;
 742
 743         curr_branch = branch_get("HEAD");
 744         if (!curr_branch)
 745                 return -1;
 746
 747         if (refspec)
 748                 remote_branch = get_tracking_branch(repo, refspec);
 749         else
 750                 remote_branch = get_upstream_branch(repo);
 751
 752         if (!remote_branch)
 753                 return -1;
 754
 755         argv_array_pushl(&cp.args, "merge-base", "--fork-point",
 756                         remote_branch, curr_branch->name, NULL);
 757         cp.no_stdin = 1;
 758         cp.no_stderr = 1;
 759         cp.git_cmd = 1;
 760
 761         ret = capture_command(&cp, &sb, GIT_MAX_HEXSZ);
 762         if (ret)
 763                 goto cleanup;
 764
 765         ret = get_oid_hex(sb.buf, fork_point);
 766         if (ret)
 767                 goto cleanup;
 768
 769 cleanup:
 770         strbuf_release(&sb);
 771         return ret ? -1 : 0;
 772 }
 773
 774 /**
 775  * Sets merge_base to the octopus merge base of curr_head, merge_head and
 776  * fork_point. Returns 0 if a merge base is found, 1 otherwise.
 777  */
 778 static int get_octopus_merge_base(struct object_id *merge_base,
 779                 const struct object_id *curr_head,
 780                 const struct object_id *merge_head,
 781                 const struct object_id *fork_point)
 782 {
 783         struct commit_list *revs = NULL, *result;
 784
 785         commit_list_insert(lookup_commit_reference(the_repository, curr_head),
 786                            &revs);
 787         commit_list_insert(lookup_commit_reference(the_repository, merge_head),
 788                            &revs);
 789         if (!is_null_oid(fork_point))
 790                 commit_list_insert(lookup_commit_reference(the_repository, fork_point),
 791                                    &revs);
 792
 793         result = get_octopus_merge_bases(revs);
 794         free_commit_list(revs);
 795         reduce_heads_replace(&result);
 796
 797         if (!result)
 798                 return 1;
 799
 800         oidcpy(merge_base, &result->item->object.oid);
 801         free_commit_list(result);
 802         return 0;
 803 }
 804
 805 /**
 806  * Given the current HEAD oid, the merge head returned from git-fetch and the
 807  * fork point calculated by get_rebase_fork_point(), runs git-rebase with the
 808  * appropriate arguments and returns its exit status.
 809  */
 810 static int run_rebase(const struct object_id *curr_head,
 811                 const struct object_id *merge_head,
 812                 const struct object_id *fork_point)
 813 {
 814         int ret;
 815         struct object_id oct_merge_base;
 816         struct argv_array args = ARGV_ARRAY_INIT;
 817
 818         if (!get_octopus_merge_base(&oct_merge_base, curr_head, merge_head, fork_point))
 819                 if (!is_null_oid(fork_point) && oideq(&oct_merge_base, fork_point))
 820                         fork_point = NULL;
 821
 822         argv_array_push(&args, "rebase");
 823
 824         /* Shared options */
 825         argv_push_verbosity(&args);
 826
 827         /* Options passed to git-rebase */
 828         if (opt_rebase == REBASE_MERGES)
 829                 argv_array_push(&args, "--rebase-merges");
 830         else if (opt_rebase == REBASE_PRESERVE)
 831                 argv_array_push(&args, "--preserve-merges");
 832         else if (opt_rebase == REBASE_INTERACTIVE)
 833                 argv_array_push(&args, "--interactive");
 834         if (opt_diffstat)
 835                 argv_array_push(&args, opt_diffstat);
 836         argv_array_pushv(&args, opt_strategies.argv);
 837         argv_array_pushv(&args, opt_strategy_opts.argv);
 838         if (opt_gpg_sign)
 839                 argv_array_push(&args, opt_gpg_sign);
 840         if (opt_autostash == 0)
 841                 argv_array_push(&args, "--no-autostash");
 842         else if (opt_autostash == 1)
 843                 argv_array_push(&args, "--autostash");
 844         if (opt_verify_signatures &&
 845             !strcmp(opt_verify_signatures, "--verify-signatures"))
 846                 warning(_("ignoring --verify-signatures for rebase"));
 847
 848         argv_array_push(&args, "--onto");
 849         argv_array_push(&args, oid_to_hex(merge_head));
 850
 851         if (fork_point && !is_null_oid(fork_point))
 852                 argv_array_push(&args, oid_to_hex(fork_point));
 853         else
 854                 argv_array_push(&args, oid_to_hex(merge_head));
 855
 856         ret = run_command_v_opt(args.argv, RUN_GIT_CMD);
 857         argv_array_clear(&args);
 858         return ret;
 859 }
 860
 861 int cmd_pull(int argc, const char **argv, const char *prefix)
 862 {
 863         const char *repo, **refspecs;
 864         struct oid_array merge_heads = OID_ARRAY_INIT;
 865         struct object_id orig_head, curr_head;
 866         struct object_id rebase_fork_point;
 867         int autostash;
 868
 869         if (!getenv("GIT_REFLOG_ACTION"))
 870                 set_reflog_message(argc, argv);
 871
 872         git_config(git_pull_config, NULL);
 873
 874         argc = parse_options(argc, argv, prefix, pull_options, pull_usage, 0);
 875
 876         if (cleanup_arg)
 877                 /*
 878                  * this only checks the validity of cleanup_arg; we don't need
 879                  * a valid value for use_editor
 880                  */
 881                 get_cleanup_mode(cleanup_arg, 0);
 882
 883         parse_repo_refspecs(argc, argv, &repo, &refspecs);
 884
 885         if (!opt_ff)
 886                 opt_ff = xstrdup_or_null(config_get_ff());
 887
 888         if (opt_rebase < 0)
 889                 opt_rebase = config_get_rebase();
 890
 891         if (read_cache_unmerged())
 892                 die_resolve_conflict("pull");
 893
 894         if (file_exists(git_path_merge_head(the_repository)))
 895                 die_conclude_merge();
 896
 897         if (get_oid("HEAD", &orig_head))
 898                 oidclr(&orig_head);
 899
 900         if (!opt_rebase && opt_autostash != -1)
 901                 die(_("--[no-]autostash option is only valid with --rebase."));
 902
 903         autostash = config_autostash;
 904         if (opt_rebase) {
 905                 if (opt_autostash != -1)
 906                         autostash = opt_autostash;
 907
 908                 if (is_null_oid(&orig_head) && !is_cache_unborn())
 909                         die(_("Updating an unborn branch with changes added to the index."));
 910
 911                 if (!autostash)
 912                         require_clean_work_tree(the_repository,
 913                                 N_("pull with rebase"),
 914                                 _("please commit or stash them."), 1, 0);
 915
 916                 if (get_rebase_fork_point(&rebase_fork_point, repo, *refspecs))
 917                         oidclr(&rebase_fork_point);
 918         }
 919
 920         if (run_fetch(repo, refspecs))
 921                 return 1;
 922
 923         if (opt_dry_run)
 924                 return 0;
 925
 926         if (get_oid("HEAD", &curr_head))
 927                 oidclr(&curr_head);
 928
 929         if (!is_null_oid(&orig_head) && !is_null_oid(&curr_head) &&
 930                         !oideq(&orig_head, &curr_head)) {
 931                 /*
 932                  * The fetch involved updating the current branch.
 933                  *
 934                  * The working tree and the index file are still based on
 935                  * orig_head commit, but we are merging into curr_head.
 936                  * Update the working tree to match curr_head.
 937                  */
 938
 939                 warning(_("fetch updated the current branch head.\n"
 940                         "fast-forwarding your working tree from\n"
 941                         "commit %s."), oid_to_hex(&orig_head));
 942
 943                 if (checkout_fast_forward(the_repository, &orig_head,
 944                                           &curr_head, 0))
 945                         die(_("Cannot fast-forward your working tree.\n"
 946                                 "After making sure that you saved anything precious from\n"
 947                                 "$ git diff %s\n"
 948                                 "output, run\n"
 949                                 "$ git reset --hard\n"
 950                                 "to recover."), oid_to_hex(&orig_head));
 951         }
 952
 953         get_merge_heads(&merge_heads);
 954
 955         if (!merge_heads.nr)
 956                 die_no_merge_candidates(repo, refspecs);
 957
 958         if (is_null_oid(&orig_head)) {
 959                 if (merge_heads.nr > 1)
 960                         die(_("Cannot merge multiple branches into empty head."));
 961                 return pull_into_void(merge_heads.oid, &curr_head);
 962         }
 963         if (opt_rebase && merge_heads.nr > 1)
 964                 die(_("Cannot rebase onto multiple branches."));
 965
 966         if (opt_rebase) {
 967                 int ret = 0;
 968                 if ((recurse_submodules == RECURSE_SUBMODULES_ON ||
 969                      recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND) &&
 970                     submodule_touches_in_range(the_repository, &rebase_fork_point, &curr_head))
 971                         die(_("cannot rebase with locally recorded submodule modifications"));
 972                 if (!autostash) {
 973                         struct commit_list *list = NULL;
 974                         struct commit *merge_head, *head;
 975
 976                         head = lookup_commit_reference(the_repository,
 977                                                        &orig_head);
 978                         commit_list_insert(head, &list);
 979                         merge_head = lookup_commit_reference(the_repository,
 980                                                              &merge_heads.oid[0]);
 981                         if (is_descendant_of(merge_head, list)) {
 982                                 /* we can fast-forward this without invoking rebase */
 983                                 opt_ff = "--ff-only";
 984                                 ret = run_merge();
 985                         }
 986                 }
 987                 ret = run_rebase(&curr_head, merge_heads.oid, &rebase_fork_point);
 988
 989                 if (!ret && (recurse_submodules == RECURSE_SUBMODULES_ON ||
 990                              recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND))
 991                         ret = rebase_submodules();
 992
 993                 return ret;
 994         } else {
 995                 int ret = run_merge();
 996                 if (!ret && (recurse_submodules == RECURSE_SUBMODULES_ON ||
 997                              recurse_submodules == RECURSE_SUBMODULES_ON_DEMAND))
 998                         ret = update_submodules();
 999                 return ret;
1000         }
1001 }