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