builtin/rebase.c

   1 /*
   2  * "git rebase" builtin command
   3  *
   4  * Copyright (c) 2018 Pratik Karki
   5  */
   6
   7 #define USE_THE_INDEX_COMPATIBILITY_MACROS
   8 #include "builtin.h"
   9 #include "run-command.h"
  10 #include "exec-cmd.h"
  11 #include "argv-array.h"
  12 #include "dir.h"
  13 #include "packfile.h"
  14 #include "refs.h"
  15 #include "quote.h"
  16 #include "config.h"
  17 #include "cache-tree.h"
  18 #include "unpack-trees.h"
  19 #include "lockfile.h"
  20 #include "parse-options.h"
  21 #include "commit.h"
  22 #include "diff.h"
  23 #include "wt-status.h"
  24 #include "revision.h"
  25 #include "commit-reach.h"
  26 #include "rerere.h"
  27 #include "branch.h"
  28
  29 static char const * const builtin_rebase_usage[] = {
  30         N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
  31                 "[<upstream>] [<branch>]"),
  32         N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
  33                 "--root [<branch>]"),
  34         N_("git rebase --continue | --abort | --skip | --edit-todo"),
  35         NULL
  36 };
  37
  38 static GIT_PATH_FUNC(apply_dir, "rebase-apply")
  39 static GIT_PATH_FUNC(merge_dir, "rebase-merge")
  40
  41 enum rebase_type {
  42         REBASE_UNSPECIFIED = -1,
  43         REBASE_AM,
  44         REBASE_MERGE,
  45         REBASE_INTERACTIVE,
  46         REBASE_PRESERVE_MERGES
  47 };
  48
  49 static int use_builtin_rebase(void)
  50 {
  51         struct child_process cp = CHILD_PROCESS_INIT;
  52         struct strbuf out = STRBUF_INIT;
  53         int ret, env = git_env_bool("GIT_TEST_REBASE_USE_BUILTIN", -1);
  54
  55         if (env != -1)
  56                 return env;
  57
  58         argv_array_pushl(&cp.args,
  59                          "config", "--bool", "rebase.usebuiltin", NULL);
  60         cp.git_cmd = 1;
  61         if (capture_command(&cp, &out, 6)) {
  62                 strbuf_release(&out);
  63                 return 1;
  64         }
  65
  66         strbuf_trim(&out);
  67         ret = !strcmp("true", out.buf);
  68         strbuf_release(&out);
  69         return ret;
  70 }
  71
  72 struct rebase_options {
  73         enum rebase_type type;
  74         const char *state_dir;
  75         struct commit *upstream;
  76         const char *upstream_name;
  77         const char *upstream_arg;
  78         char *head_name;
  79         struct object_id orig_head;
  80         struct commit *onto;
  81         const char *onto_name;
  82         const char *revisions;
  83         const char *switch_to;
  84         int root;
  85         struct object_id *squash_onto;
  86         struct commit *restrict_revision;
  87         int dont_finish_rebase;
  88         enum {
  89                 REBASE_NO_QUIET = 1<<0,
  90                 REBASE_VERBOSE = 1<<1,
  91                 REBASE_DIFFSTAT = 1<<2,
  92                 REBASE_FORCE = 1<<3,
  93                 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
  94         } flags;
  95         struct argv_array git_am_opts;
  96         const char *action;
  97         int signoff;
  98         int allow_rerere_autoupdate;
  99         int keep_empty;
 100         int autosquash;
 101         char *gpg_sign_opt;
 102         int autostash;
 103         char *cmd;
 104         int allow_empty_message;
 105         int rebase_merges, rebase_cousins;
 106         char *strategy, *strategy_opts;
 107         struct strbuf git_format_patch_opt;
 108         int reschedule_failed_exec;
 109 };
 110
 111 static int is_interactive(struct rebase_options *opts)
 112 {
 113         return opts->type == REBASE_INTERACTIVE ||
 114                 opts->type == REBASE_PRESERVE_MERGES;
 115 }
 116
 117 static void imply_interactive(struct rebase_options *opts, const char *option)
 118 {
 119         switch (opts->type) {
 120         case REBASE_AM:
 121                 die(_("%s requires an interactive rebase"), option);
 122                 break;
 123         case REBASE_INTERACTIVE:
 124         case REBASE_PRESERVE_MERGES:
 125                 break;
 126         case REBASE_MERGE:
 127                 /* we now implement --merge via --interactive */
 128         default:
 129                 opts->type = REBASE_INTERACTIVE; /* implied */
 130                 break;
 131         }
 132 }
 133
 134 /* Returns the filename prefixed by the state_dir */
 135 static const char *state_dir_path(const char *filename, struct rebase_options *opts)
 136 {
 137         static struct strbuf path = STRBUF_INIT;
 138         static size_t prefix_len;
 139
 140         if (!prefix_len) {
 141                 strbuf_addf(&path, "%s/", opts->state_dir);
 142                 prefix_len = path.len;
 143         }
 144
 145         strbuf_setlen(&path, prefix_len);
 146         strbuf_addstr(&path, filename);
 147         return path.buf;
 148 }
 149
 150 /* Read one file, then strip line endings */
 151 static int read_one(const char *path, struct strbuf *buf)
 152 {
 153         if (strbuf_read_file(buf, path, 0) < 0)
 154                 return error_errno(_("could not read '%s'"), path);
 155         strbuf_trim_trailing_newline(buf);
 156         return 0;
 157 }
 158
 159 /* Initialize the rebase options from the state directory. */
 160 static int read_basic_state(struct rebase_options *opts)
 161 {
 162         struct strbuf head_name = STRBUF_INIT;
 163         struct strbuf buf = STRBUF_INIT;
 164         struct object_id oid;
 165
 166         if (read_one(state_dir_path("head-name", opts), &head_name) ||
 167             read_one(state_dir_path("onto", opts), &buf))
 168                 return -1;
 169         opts->head_name = starts_with(head_name.buf, "refs/") ?
 170                 xstrdup(head_name.buf) : NULL;
 171         strbuf_release(&head_name);
 172         if (get_oid(buf.buf, &oid))
 173                 return error(_("could not get 'onto': '%s'"), buf.buf);
 174         opts->onto = lookup_commit_or_die(&oid, buf.buf);
 175
 176         /*
 177          * We always write to orig-head, but interactive rebase used to write to
 178          * head. Fall back to reading from head to cover for the case that the
 179          * user upgraded git with an ongoing interactive rebase.
 180          */
 181         strbuf_reset(&buf);
 182         if (file_exists(state_dir_path("orig-head", opts))) {
 183                 if (read_one(state_dir_path("orig-head", opts), &buf))
 184                         return -1;
 185         } else if (read_one(state_dir_path("head", opts), &buf))
 186                 return -1;
 187         if (get_oid(buf.buf, &opts->orig_head))
 188                 return error(_("invalid orig-head: '%s'"), buf.buf);
 189
 190         if (file_exists(state_dir_path("quiet", opts)))
 191                 opts->flags &= ~REBASE_NO_QUIET;
 192         else
 193                 opts->flags |= REBASE_NO_QUIET;
 194
 195         if (file_exists(state_dir_path("verbose", opts)))
 196                 opts->flags |= REBASE_VERBOSE;
 197
 198         if (file_exists(state_dir_path("signoff", opts))) {
 199                 opts->signoff = 1;
 200                 opts->flags |= REBASE_FORCE;
 201         }
 202
 203         if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
 204                 strbuf_reset(&buf);
 205                 if (read_one(state_dir_path("allow_rerere_autoupdate", opts),
 206                             &buf))
 207                         return -1;
 208                 if (!strcmp(buf.buf, "--rerere-autoupdate"))
 209                         opts->allow_rerere_autoupdate = 1;
 210                 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
 211                         opts->allow_rerere_autoupdate = 0;
 212                 else
 213                         warning(_("ignoring invalid allow_rerere_autoupdate: "
 214                                   "'%s'"), buf.buf);
 215         } else
 216                 opts->allow_rerere_autoupdate = -1;
 217
 218         if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
 219                 strbuf_reset(&buf);
 220                 if (read_one(state_dir_path("gpg_sign_opt", opts),
 221                             &buf))
 222                         return -1;
 223                 free(opts->gpg_sign_opt);
 224                 opts->gpg_sign_opt = xstrdup(buf.buf);
 225         }
 226
 227         if (file_exists(state_dir_path("strategy", opts))) {
 228                 strbuf_reset(&buf);
 229                 if (read_one(state_dir_path("strategy", opts), &buf))
 230                         return -1;
 231                 free(opts->strategy);
 232                 opts->strategy = xstrdup(buf.buf);
 233         }
 234
 235         if (file_exists(state_dir_path("strategy_opts", opts))) {
 236                 strbuf_reset(&buf);
 237                 if (read_one(state_dir_path("strategy_opts", opts), &buf))
 238                         return -1;
 239                 free(opts->strategy_opts);
 240                 opts->strategy_opts = xstrdup(buf.buf);
 241         }
 242
 243         strbuf_release(&buf);
 244
 245         return 0;
 246 }
 247
 248 static int write_basic_state(struct rebase_options *opts)
 249 {
 250         write_file(state_dir_path("head-name", opts), "%s",
 251                    opts->head_name ? opts->head_name : "detached HEAD");
 252         write_file(state_dir_path("onto", opts), "%s",
 253                    opts->onto ? oid_to_hex(&opts->onto->object.oid) : "");
 254         write_file(state_dir_path("orig-head", opts), "%s",
 255                    oid_to_hex(&opts->orig_head));
 256         write_file(state_dir_path("quiet", opts), "%s",
 257                    opts->flags & REBASE_NO_QUIET ? "" : "t");
 258         if (opts->flags & REBASE_VERBOSE)
 259                 write_file(state_dir_path("verbose", opts), "%s", "");
 260         if (opts->strategy)
 261                 write_file(state_dir_path("strategy", opts), "%s",
 262                            opts->strategy);
 263         if (opts->strategy_opts)
 264                 write_file(state_dir_path("strategy_opts", opts), "%s",
 265                            opts->strategy_opts);
 266         if (opts->allow_rerere_autoupdate >= 0)
 267                 write_file(state_dir_path("allow_rerere_autoupdate", opts),
 268                            "-%s-rerere-autoupdate",
 269                            opts->allow_rerere_autoupdate ? "" : "-no");
 270         if (opts->gpg_sign_opt)
 271                 write_file(state_dir_path("gpg_sign_opt", opts), "%s",
 272                            opts->gpg_sign_opt);
 273         if (opts->signoff)
 274                 write_file(state_dir_path("strategy", opts), "--signoff");
 275
 276         return 0;
 277 }
 278
 279 static int apply_autostash(struct rebase_options *opts)
 280 {
 281         const char *path = state_dir_path("autostash", opts);
 282         struct strbuf autostash = STRBUF_INIT;
 283         struct child_process stash_apply = CHILD_PROCESS_INIT;
 284
 285         if (!file_exists(path))
 286                 return 0;
 287
 288         if (read_one(path, &autostash))
 289                 return error(_("Could not read '%s'"), path);
 290         /* Ensure that the hash is not mistaken for a number */
 291         strbuf_addstr(&autostash, "^0");
 292         argv_array_pushl(&stash_apply.args,
 293                          "stash", "apply", autostash.buf, NULL);
 294         stash_apply.git_cmd = 1;
 295         stash_apply.no_stderr = stash_apply.no_stdout =
 296                 stash_apply.no_stdin = 1;
 297         if (!run_command(&stash_apply))
 298                 printf(_("Applied autostash.\n"));
 299         else {
 300                 struct argv_array args = ARGV_ARRAY_INIT;
 301                 int res = 0;
 302
 303                 argv_array_pushl(&args,
 304                                  "stash", "store", "-m", "autostash", "-q",
 305                                  autostash.buf, NULL);
 306                 if (run_command_v_opt(args.argv, RUN_GIT_CMD))
 307                         res = error(_("Cannot store %s"), autostash.buf);
 308                 argv_array_clear(&args);
 309                 strbuf_release(&autostash);
 310                 if (res)
 311                         return res;
 312
 313                 fprintf(stderr,
 314                         _("Applying autostash resulted in conflicts.\n"
 315                           "Your changes are safe in the stash.\n"
 316                           "You can run \"git stash pop\" or \"git stash drop\" "
 317                           "at any time.\n"));
 318         }
 319
 320         strbuf_release(&autostash);
 321         return 0;
 322 }
 323
 324 static int finish_rebase(struct rebase_options *opts)
 325 {
 326         struct strbuf dir = STRBUF_INIT;
 327         const char *argv_gc_auto[] = { "gc", "--auto", NULL };
 328
 329         delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
 330         apply_autostash(opts);
 331         close_all_packs(the_repository->objects);
 332         /*
 333          * We ignore errors in 'gc --auto', since the
 334          * user should see them.
 335          */
 336         run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
 337         strbuf_addstr(&dir, opts->state_dir);
 338         remove_dir_recursively(&dir, 0);
 339         strbuf_release(&dir);
 340
 341         return 0;
 342 }
 343
 344 static struct commit *peel_committish(const char *name)
 345 {
 346         struct object *obj;
 347         struct object_id oid;
 348
 349         if (get_oid(name, &oid))
 350                 return NULL;
 351         obj = parse_object(the_repository, &oid);
 352         return (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
 353 }
 354
 355 static void add_var(struct strbuf *buf, const char *name, const char *value)
 356 {
 357         if (!value)
 358                 strbuf_addf(buf, "unset %s; ", name);
 359         else {
 360                 strbuf_addf(buf, "%s=", name);
 361                 sq_quote_buf(buf, value);
 362                 strbuf_addstr(buf, "; ");
 363         }
 364 }
 365
 366 #define GIT_REFLOG_ACTION_ENVIRONMENT "GIT_REFLOG_ACTION"
 367
 368 #define RESET_HEAD_DETACH (1<<0)
 369 #define RESET_HEAD_HARD (1<<1)
 370 #define RESET_HEAD_RUN_POST_CHECKOUT_HOOK (1<<2)
 371 #define RESET_HEAD_REFS_ONLY (1<<3)
 372
 373 static int reset_head(struct object_id *oid, const char *action,
 374                       const char *switch_to_branch, unsigned flags,
 375                       const char *reflog_orig_head, const char *reflog_head)
 376 {
 377         unsigned detach_head = flags & RESET_HEAD_DETACH;
 378         unsigned reset_hard = flags & RESET_HEAD_HARD;
 379         unsigned run_hook = flags & RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
 380         unsigned refs_only = flags & RESET_HEAD_REFS_ONLY;
 381         struct object_id head_oid;
 382         struct tree_desc desc[2] = { { NULL }, { NULL } };
 383         struct lock_file lock = LOCK_INIT;
 384         struct unpack_trees_options unpack_tree_opts;
 385         struct tree *tree;
 386         const char *reflog_action;
 387         struct strbuf msg = STRBUF_INIT;
 388         size_t prefix_len;
 389         struct object_id *orig = NULL, oid_orig,
 390                 *old_orig = NULL, oid_old_orig;
 391         int ret = 0, nr = 0;
 392
 393         if (switch_to_branch && !starts_with(switch_to_branch, "refs/"))
 394                 BUG("Not a fully qualified branch: '%s'", switch_to_branch);
 395
 396         if (!refs_only && hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0) {
 397                 ret = -1;
 398                 goto leave_reset_head;
 399         }
 400
 401         if ((!oid || !reset_hard) && get_oid("HEAD", &head_oid)) {
 402                 ret = error(_("could not determine HEAD revision"));
 403                 goto leave_reset_head;
 404         }
 405
 406         if (!oid)
 407                 oid = &head_oid;
 408
 409         if (refs_only)
 410                 goto reset_head_refs;
 411
 412         memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
 413         setup_unpack_trees_porcelain(&unpack_tree_opts, action);
 414         unpack_tree_opts.head_idx = 1;
 415         unpack_tree_opts.src_index = the_repository->index;
 416         unpack_tree_opts.dst_index = the_repository->index;
 417         unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
 418         unpack_tree_opts.update = 1;
 419         unpack_tree_opts.merge = 1;
 420         if (!detach_head)
 421                 unpack_tree_opts.reset = 1;
 422
 423         if (repo_read_index_unmerged(the_repository) < 0) {
 424                 ret = error(_("could not read index"));
 425                 goto leave_reset_head;
 426         }
 427
 428         if (!reset_hard && !fill_tree_descriptor(&desc[nr++], &head_oid)) {
 429                 ret = error(_("failed to find tree of %s"),
 430                             oid_to_hex(&head_oid));
 431                 goto leave_reset_head;
 432         }
 433
 434         if (!fill_tree_descriptor(&desc[nr++], oid)) {
 435                 ret = error(_("failed to find tree of %s"), oid_to_hex(oid));
 436                 goto leave_reset_head;
 437         }
 438
 439         if (unpack_trees(nr, desc, &unpack_tree_opts)) {
 440                 ret = -1;
 441                 goto leave_reset_head;
 442         }
 443
 444         tree = parse_tree_indirect(oid);
 445         prime_cache_tree(the_repository, the_repository->index, tree);
 446
 447         if (write_locked_index(the_repository->index, &lock, COMMIT_LOCK) < 0) {
 448                 ret = error(_("could not write index"));
 449                 goto leave_reset_head;
 450         }
 451
 452 reset_head_refs:
 453         reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
 454         strbuf_addf(&msg, "%s: ", reflog_action ? reflog_action : "rebase");
 455         prefix_len = msg.len;
 456
 457         if (!get_oid("ORIG_HEAD", &oid_old_orig))
 458                 old_orig = &oid_old_orig;
 459         if (!get_oid("HEAD", &oid_orig)) {
 460                 orig = &oid_orig;
 461                 if (!reflog_orig_head) {
 462                         strbuf_addstr(&msg, "updating ORIG_HEAD");
 463                         reflog_orig_head = msg.buf;
 464                 }
 465                 update_ref(reflog_orig_head, "ORIG_HEAD", orig, old_orig, 0,
 466                            UPDATE_REFS_MSG_ON_ERR);
 467         } else if (old_orig)
 468                 delete_ref(NULL, "ORIG_HEAD", old_orig, 0);
 469         if (!reflog_head) {
 470                 strbuf_setlen(&msg, prefix_len);
 471                 strbuf_addstr(&msg, "updating HEAD");
 472                 reflog_head = msg.buf;
 473         }
 474         if (!switch_to_branch)
 475                 ret = update_ref(reflog_head, "HEAD", oid, orig,
 476                                  detach_head ? REF_NO_DEREF : 0,
 477                                  UPDATE_REFS_MSG_ON_ERR);
 478         else {
 479                 ret = update_ref(reflog_orig_head, switch_to_branch, oid,
 480                                  NULL, 0, UPDATE_REFS_MSG_ON_ERR);
 481                 if (!ret)
 482                         ret = create_symref("HEAD", switch_to_branch,
 483                                             reflog_head);
 484         }
 485         if (run_hook)
 486                 run_hook_le(NULL, "post-checkout",
 487                             oid_to_hex(orig ? orig : &null_oid),
 488                             oid_to_hex(oid), "1", NULL);
 489
 490 leave_reset_head:
 491         strbuf_release(&msg);
 492         rollback_lock_file(&lock);
 493         while (nr)
 494                 free((void *)desc[--nr].buffer);
 495         return ret;
 496 }
 497
 498 static int move_to_original_branch(struct rebase_options *opts)
 499 {
 500         struct strbuf orig_head_reflog = STRBUF_INIT, head_reflog = STRBUF_INIT;
 501         int ret;
 502
 503         if (!opts->head_name)
 504                 return 0; /* nothing to move back to */
 505
 506         if (!opts->onto)
 507                 BUG("move_to_original_branch without onto");
 508
 509         strbuf_addf(&orig_head_reflog, "rebase finished: %s onto %s",
 510                     opts->head_name, oid_to_hex(&opts->onto->object.oid));
 511         strbuf_addf(&head_reflog, "rebase finished: returning to %s",
 512                     opts->head_name);
 513         ret = reset_head(NULL, "", opts->head_name, RESET_HEAD_REFS_ONLY,
 514                          orig_head_reflog.buf, head_reflog.buf);
 515
 516         strbuf_release(&orig_head_reflog);
 517         strbuf_release(&head_reflog);
 518         return ret;
 519 }
 520
 521 static const char *resolvemsg =
 522 N_("Resolve all conflicts manually, mark them as resolved with\n"
 523 "\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
 524 "You can instead skip this commit: run \"git rebase --skip\".\n"
 525 "To abort and get back to the state before \"git rebase\", run "
 526 "\"git rebase --abort\".");
 527
 528 static int run_am(struct rebase_options *opts)
 529 {
 530         struct child_process am = CHILD_PROCESS_INIT;
 531         struct child_process format_patch = CHILD_PROCESS_INIT;
 532         struct strbuf revisions = STRBUF_INIT;
 533         int status;
 534         char *rebased_patches;
 535
 536         am.git_cmd = 1;
 537         argv_array_push(&am.args, "am");
 538
 539         if (opts->action && !strcmp("continue", opts->action)) {
 540                 argv_array_push(&am.args, "--resolved");
 541                 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
 542                 if (opts->gpg_sign_opt)
 543                         argv_array_push(&am.args, opts->gpg_sign_opt);
 544                 status = run_command(&am);
 545                 if (status)
 546                         return status;
 547
 548                 return move_to_original_branch(opts);
 549         }
 550         if (opts->action && !strcmp("skip", opts->action)) {
 551                 argv_array_push(&am.args, "--skip");
 552                 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
 553                 status = run_command(&am);
 554                 if (status)
 555                         return status;
 556
 557                 return move_to_original_branch(opts);
 558         }
 559         if (opts->action && !strcmp("show-current-patch", opts->action)) {
 560                 argv_array_push(&am.args, "--show-current-patch");
 561                 return run_command(&am);
 562         }
 563
 564         strbuf_addf(&revisions, "%s...%s",
 565                     oid_to_hex(opts->root ?
 566                                /* this is now equivalent to !opts->upstream */
 567                                &opts->onto->object.oid :
 568                                &opts->upstream->object.oid),
 569                     oid_to_hex(&opts->orig_head));
 570
 571         rebased_patches = xstrdup(git_path("rebased-patches"));
 572         format_patch.out = open(rebased_patches,
 573                                 O_WRONLY | O_CREAT | O_TRUNC, 0666);
 574         if (format_patch.out < 0) {
 575                 status = error_errno(_("could not open '%s' for writing"),
 576                                      rebased_patches);
 577                 free(rebased_patches);
 578                 argv_array_clear(&am.args);
 579                 return status;
 580         }
 581
 582         format_patch.git_cmd = 1;
 583         argv_array_pushl(&format_patch.args, "format-patch", "-k", "--stdout",
 584                          "--full-index", "--cherry-pick", "--right-only",
 585                          "--src-prefix=a/", "--dst-prefix=b/", "--no-renames",
 586                          "--no-cover-letter", "--pretty=mboxrd", "--topo-order", NULL);
 587         if (opts->git_format_patch_opt.len)
 588                 argv_array_split(&format_patch.args,
 589                                  opts->git_format_patch_opt.buf);
 590         argv_array_push(&format_patch.args, revisions.buf);
 591         if (opts->restrict_revision)
 592                 argv_array_pushf(&format_patch.args, "^%s",
 593                                  oid_to_hex(&opts->restrict_revision->object.oid));
 594
 595         status = run_command(&format_patch);
 596         if (status) {
 597                 unlink(rebased_patches);
 598                 free(rebased_patches);
 599                 argv_array_clear(&am.args);
 600
 601                 reset_head(&opts->orig_head, "checkout", opts->head_name, 0,
 602                            "HEAD", NULL);
 603                 error(_("\ngit encountered an error while preparing the "
 604                         "patches to replay\n"
 605                         "these revisions:\n"
 606                         "\n    %s\n\n"
 607                         "As a result, git cannot rebase them."),
 608                       opts->revisions);
 609
 610                 strbuf_release(&revisions);
 611                 return status;
 612         }
 613         strbuf_release(&revisions);
 614
 615         am.in = open(rebased_patches, O_RDONLY);
 616         if (am.in < 0) {
 617                 status = error_errno(_("could not open '%s' for reading"),
 618                                      rebased_patches);
 619                 free(rebased_patches);
 620                 argv_array_clear(&am.args);
 621                 return status;
 622         }
 623
 624         argv_array_pushv(&am.args, opts->git_am_opts.argv);
 625         argv_array_push(&am.args, "--rebasing");
 626         argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
 627         argv_array_push(&am.args, "--patch-format=mboxrd");
 628         if (opts->allow_rerere_autoupdate > 0)
 629                 argv_array_push(&am.args, "--rerere-autoupdate");
 630         else if (opts->allow_rerere_autoupdate == 0)
 631                 argv_array_push(&am.args, "--no-rerere-autoupdate");
 632         if (opts->gpg_sign_opt)
 633                 argv_array_push(&am.args, opts->gpg_sign_opt);
 634         status = run_command(&am);
 635         unlink(rebased_patches);
 636         free(rebased_patches);
 637
 638         if (!status) {
 639                 return move_to_original_branch(opts);
 640         }
 641
 642         if (is_directory(opts->state_dir))
 643                 write_basic_state(opts);
 644
 645         return status;
 646 }
 647
 648 static int run_specific_rebase(struct rebase_options *opts)
 649 {
 650         const char *argv[] = { NULL, NULL };
 651         struct strbuf script_snippet = STRBUF_INIT, buf = STRBUF_INIT;
 652         int status;
 653         const char *backend, *backend_func;
 654
 655         if (opts->type == REBASE_INTERACTIVE) {
 656                 /* Run builtin interactive rebase */
 657                 struct child_process child = CHILD_PROCESS_INIT;
 658
 659                 argv_array_pushf(&child.env_array, "GIT_CHERRY_PICK_HELP=%s",
 660                                  resolvemsg);
 661                 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
 662                         argv_array_push(&child.env_array,
 663                                         "GIT_SEQUENCE_EDITOR=:");
 664                         opts->autosquash = 0;
 665                 }
 666
 667                 child.git_cmd = 1;
 668                 argv_array_push(&child.args, "rebase--interactive");
 669
 670                 if (opts->action)
 671                         argv_array_pushf(&child.args, "--%s", opts->action);
 672                 if (opts->keep_empty)
 673                         argv_array_push(&child.args, "--keep-empty");
 674                 if (opts->rebase_merges)
 675                         argv_array_push(&child.args, "--rebase-merges");
 676                 if (opts->rebase_cousins)
 677                         argv_array_push(&child.args, "--rebase-cousins");
 678                 if (opts->autosquash)
 679                         argv_array_push(&child.args, "--autosquash");
 680                 if (opts->flags & REBASE_VERBOSE)
 681                         argv_array_push(&child.args, "--verbose");
 682                 if (opts->flags & REBASE_FORCE)
 683                         argv_array_push(&child.args, "--no-ff");
 684                 if (opts->restrict_revision)
 685                         argv_array_pushf(&child.args,
 686                                          "--restrict-revision=^%s",
 687                                          oid_to_hex(&opts->restrict_revision->object.oid));
 688                 if (opts->upstream)
 689                         argv_array_pushf(&child.args, "--upstream=%s",
 690                                          oid_to_hex(&opts->upstream->object.oid));
 691                 if (opts->onto)
 692                         argv_array_pushf(&child.args, "--onto=%s",
 693                                          oid_to_hex(&opts->onto->object.oid));
 694                 if (opts->squash_onto)
 695                         argv_array_pushf(&child.args, "--squash-onto=%s",
 696                                          oid_to_hex(opts->squash_onto));
 697                 if (opts->onto_name)
 698                         argv_array_pushf(&child.args, "--onto-name=%s",
 699                                          opts->onto_name);
 700                 argv_array_pushf(&child.args, "--head-name=%s",
 701                                  opts->head_name ?
 702                                  opts->head_name : "detached HEAD");
 703                 if (opts->strategy)
 704                         argv_array_pushf(&child.args, "--strategy=%s",
 705                                          opts->strategy);
 706                 if (opts->strategy_opts)
 707                         argv_array_pushf(&child.args, "--strategy-opts=%s",
 708                                          opts->strategy_opts);
 709                 if (opts->switch_to)
 710                         argv_array_pushf(&child.args, "--switch-to=%s",
 711                                          opts->switch_to);
 712                 if (opts->cmd)
 713                         argv_array_pushf(&child.args, "--cmd=%s", opts->cmd);
 714                 if (opts->allow_empty_message)
 715                         argv_array_push(&child.args, "--allow-empty-message");
 716                 if (opts->allow_rerere_autoupdate > 0)
 717                         argv_array_push(&child.args, "--rerere-autoupdate");
 718                 else if (opts->allow_rerere_autoupdate == 0)
 719                         argv_array_push(&child.args, "--no-rerere-autoupdate");
 720                 if (opts->gpg_sign_opt)
 721                         argv_array_push(&child.args, opts->gpg_sign_opt);
 722                 if (opts->signoff)
 723                         argv_array_push(&child.args, "--signoff");
 724                 if (opts->reschedule_failed_exec)
 725                         argv_array_push(&child.args, "--reschedule-failed-exec");
 726
 727                 status = run_command(&child);
 728                 goto finished_rebase;
 729         }
 730
 731         if (opts->type == REBASE_AM) {
 732                 status = run_am(opts);
 733                 goto finished_rebase;
 734         }
 735
 736         add_var(&script_snippet, "GIT_DIR", absolute_path(get_git_dir()));
 737         add_var(&script_snippet, "state_dir", opts->state_dir);
 738
 739         add_var(&script_snippet, "upstream_name", opts->upstream_name);
 740         add_var(&script_snippet, "upstream", opts->upstream ?
 741                 oid_to_hex(&opts->upstream->object.oid) : NULL);
 742         add_var(&script_snippet, "head_name",
 743                 opts->head_name ? opts->head_name : "detached HEAD");
 744         add_var(&script_snippet, "orig_head", oid_to_hex(&opts->orig_head));
 745         add_var(&script_snippet, "onto", opts->onto ?
 746                 oid_to_hex(&opts->onto->object.oid) : NULL);
 747         add_var(&script_snippet, "onto_name", opts->onto_name);
 748         add_var(&script_snippet, "revisions", opts->revisions);
 749         add_var(&script_snippet, "restrict_revision", opts->restrict_revision ?
 750                 oid_to_hex(&opts->restrict_revision->object.oid) : NULL);
 751         add_var(&script_snippet, "GIT_QUIET",
 752                 opts->flags & REBASE_NO_QUIET ? "" : "t");
 753         sq_quote_argv_pretty(&buf, opts->git_am_opts.argv);
 754         add_var(&script_snippet, "git_am_opt", buf.buf);
 755         strbuf_release(&buf);
 756         add_var(&script_snippet, "verbose",
 757                 opts->flags & REBASE_VERBOSE ? "t" : "");
 758         add_var(&script_snippet, "diffstat",
 759                 opts->flags & REBASE_DIFFSTAT ? "t" : "");
 760         add_var(&script_snippet, "force_rebase",
 761                 opts->flags & REBASE_FORCE ? "t" : "");
 762         if (opts->switch_to)
 763                 add_var(&script_snippet, "switch_to", opts->switch_to);
 764         add_var(&script_snippet, "action", opts->action ? opts->action : "");
 765         add_var(&script_snippet, "signoff", opts->signoff ? "--signoff" : "");
 766         add_var(&script_snippet, "allow_rerere_autoupdate",
 767                 opts->allow_rerere_autoupdate < 0 ? "" :
 768                 opts->allow_rerere_autoupdate ?
 769                 "--rerere-autoupdate" : "--no-rerere-autoupdate");
 770         add_var(&script_snippet, "keep_empty", opts->keep_empty ? "yes" : "");
 771         add_var(&script_snippet, "autosquash", opts->autosquash ? "t" : "");
 772         add_var(&script_snippet, "gpg_sign_opt", opts->gpg_sign_opt);
 773         add_var(&script_snippet, "cmd", opts->cmd);
 774         add_var(&script_snippet, "allow_empty_message",
 775                 opts->allow_empty_message ?  "--allow-empty-message" : "");
 776         add_var(&script_snippet, "rebase_merges",
 777                 opts->rebase_merges ? "t" : "");
 778         add_var(&script_snippet, "rebase_cousins",
 779                 opts->rebase_cousins ? "t" : "");
 780         add_var(&script_snippet, "strategy", opts->strategy);
 781         add_var(&script_snippet, "strategy_opts", opts->strategy_opts);
 782         add_var(&script_snippet, "rebase_root", opts->root ? "t" : "");
 783         add_var(&script_snippet, "squash_onto",
 784                 opts->squash_onto ? oid_to_hex(opts->squash_onto) : "");
 785         add_var(&script_snippet, "git_format_patch_opt",
 786                 opts->git_format_patch_opt.buf);
 787
 788         if (is_interactive(opts) &&
 789             !(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
 790                 strbuf_addstr(&script_snippet,
 791                               "GIT_SEQUENCE_EDITOR=:; export GIT_SEQUENCE_EDITOR; ");
 792                 opts->autosquash = 0;
 793         }
 794
 795         switch (opts->type) {
 796         case REBASE_AM:
 797                 backend = "git-rebase--am";
 798                 backend_func = "git_rebase__am";
 799                 break;
 800         case REBASE_PRESERVE_MERGES:
 801                 backend = "git-rebase--preserve-merges";
 802                 backend_func = "git_rebase__preserve_merges";
 803                 break;
 804         default:
 805                 BUG("Unhandled rebase type %d", opts->type);
 806                 break;
 807         }
 808
 809         strbuf_addf(&script_snippet,
 810                     ". git-sh-setup && . git-rebase--common &&"
 811                     " . %s && %s", backend, backend_func);
 812         argv[0] = script_snippet.buf;
 813
 814         status = run_command_v_opt(argv, RUN_USING_SHELL);
 815 finished_rebase:
 816         if (opts->dont_finish_rebase)
 817                 ; /* do nothing */
 818         else if (opts->type == REBASE_INTERACTIVE)
 819                 ; /* interactive rebase cleans up after itself */
 820         else if (status == 0) {
 821                 if (!file_exists(state_dir_path("stopped-sha", opts)))
 822                         finish_rebase(opts);
 823         } else if (status == 2) {
 824                 struct strbuf dir = STRBUF_INIT;
 825
 826                 apply_autostash(opts);
 827                 strbuf_addstr(&dir, opts->state_dir);
 828                 remove_dir_recursively(&dir, 0);
 829                 strbuf_release(&dir);
 830                 die("Nothing to do");
 831         }
 832
 833         strbuf_release(&script_snippet);
 834
 835         return status ? -1 : 0;
 836 }
 837
 838 static int rebase_config(const char *var, const char *value, void *data)
 839 {
 840         struct rebase_options *opts = data;
 841
 842         if (!strcmp(var, "rebase.stat")) {
 843                 if (git_config_bool(var, value))
 844                         opts->flags |= REBASE_DIFFSTAT;
 845                 else
 846                         opts->flags &= !REBASE_DIFFSTAT;
 847                 return 0;
 848         }
 849
 850         if (!strcmp(var, "rebase.autosquash")) {
 851                 opts->autosquash = git_config_bool(var, value);
 852                 return 0;
 853         }
 854
 855         if (!strcmp(var, "commit.gpgsign")) {
 856                 free(opts->gpg_sign_opt);
 857                 opts->gpg_sign_opt = git_config_bool(var, value) ?
 858                         xstrdup("-S") : NULL;
 859                 return 0;
 860         }
 861
 862         if (!strcmp(var, "rebase.autostash")) {
 863                 opts->autostash = git_config_bool(var, value);
 864                 return 0;
 865         }
 866
 867         if (!strcmp(var, "rebase.reschedulefailedexec")) {
 868                 opts->reschedule_failed_exec = git_config_bool(var, value);
 869                 return 0;
 870         }
 871
 872         return git_default_config(var, value, data);
 873 }
 874
 875 /*
 876  * Determines whether the commits in from..to are linear, i.e. contain
 877  * no merge commits. This function *expects* `from` to be an ancestor of
 878  * `to`.
 879  */
 880 static int is_linear_history(struct commit *from, struct commit *to)
 881 {
 882         while (to && to != from) {
 883                 parse_commit(to);
 884                 if (!to->parents)
 885                         return 1;
 886                 if (to->parents->next)
 887                         return 0;
 888                 to = to->parents->item;
 889         }
 890         return 1;
 891 }
 892
 893 static int can_fast_forward(struct commit *onto, struct object_id *head_oid,
 894                             struct object_id *merge_base)
 895 {
 896         struct commit *head = lookup_commit(the_repository, head_oid);
 897         struct commit_list *merge_bases;
 898         int res;
 899
 900         if (!head)
 901                 return 0;
 902
 903         merge_bases = get_merge_bases(onto, head);
 904         if (merge_bases && !merge_bases->next) {
 905                 oidcpy(merge_base, &merge_bases->item->object.oid);
 906                 res = oideq(merge_base, &onto->object.oid);
 907         } else {
 908                 oidcpy(merge_base, &null_oid);
 909                 res = 0;
 910         }
 911         free_commit_list(merge_bases);
 912         return res && is_linear_history(onto, head);
 913 }
 914
 915 /* -i followed by -m is still -i */
 916 static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
 917 {
 918         struct rebase_options *opts = opt->value;
 919
 920         BUG_ON_OPT_NEG(unset);
 921         BUG_ON_OPT_ARG(arg);
 922
 923         if (!is_interactive(opts))
 924                 opts->type = REBASE_MERGE;
 925
 926         return 0;
 927 }
 928
 929 /* -i followed by -p is still explicitly interactive, but -p alone is not */
 930 static int parse_opt_interactive(const struct option *opt, const char *arg,
 931                                  int unset)
 932 {
 933         struct rebase_options *opts = opt->value;
 934
 935         BUG_ON_OPT_NEG(unset);
 936         BUG_ON_OPT_ARG(arg);
 937
 938         opts->type = REBASE_INTERACTIVE;
 939         opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
 940
 941         return 0;
 942 }
 943
 944 static void NORETURN error_on_missing_default_upstream(void)
 945 {
 946         struct branch *current_branch = branch_get(NULL);
 947
 948         printf(_("%s\n"
 949                  "Please specify which branch you want to rebase against.\n"
 950                  "See git-rebase(1) for details.\n"
 951                  "\n"
 952                  "    git rebase '<branch>'\n"
 953                  "\n"),
 954                 current_branch ? _("There is no tracking information for "
 955                         "the current branch.") :
 956                         _("You are not currently on a branch."));
 957
 958         if (current_branch) {
 959                 const char *remote = current_branch->remote_name;
 960
 961                 if (!remote)
 962                         remote = _("<remote>");
 963
 964                 printf(_("If you wish to set tracking information for this "
 965                          "branch you can do so with:\n"
 966                          "\n"
 967                          "    git branch --set-upstream-to=%s/<branch> %s\n"
 968                          "\n"),
 969                        remote, current_branch->name);
 970         }
 971         exit(1);
 972 }
 973
 974 static void set_reflog_action(struct rebase_options *options)
 975 {
 976         const char *env;
 977         struct strbuf buf = STRBUF_INIT;
 978
 979         if (!is_interactive(options))
 980                 return;
 981
 982         env = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
 983         if (env && strcmp("rebase", env))
 984                 return; /* only override it if it is "rebase" */
 985
 986         strbuf_addf(&buf, "rebase -i (%s)", options->action);
 987         setenv(GIT_REFLOG_ACTION_ENVIRONMENT, buf.buf, 1);
 988         strbuf_release(&buf);
 989 }
 990
 991 static int check_exec_cmd(const char *cmd)
 992 {
 993         if (strchr(cmd, '\n'))
 994                 return error(_("exec commands cannot contain newlines"));
 995
 996         /* Does the command consist purely of whitespace? */
 997         if (!cmd[strspn(cmd, " \t\r\f\v")])
 998                 return error(_("empty exec command"));
 999
1000         return 0;
1001 }
1002
1003
1004 int cmd_rebase(int argc, const char **argv, const char *prefix)
1005 {
1006         struct rebase_options options = {
1007                 .type = REBASE_UNSPECIFIED,
1008                 .flags = REBASE_NO_QUIET,
1009                 .git_am_opts = ARGV_ARRAY_INIT,
1010                 .allow_rerere_autoupdate  = -1,
1011                 .allow_empty_message = 1,
1012                 .git_format_patch_opt = STRBUF_INIT,
1013         };
1014         const char *branch_name;
1015         int ret, flags, total_argc, in_progress = 0;
1016         int ok_to_skip_pre_rebase = 0;
1017         struct strbuf msg = STRBUF_INIT;
1018         struct strbuf revisions = STRBUF_INIT;
1019         struct strbuf buf = STRBUF_INIT;
1020         struct object_id merge_base;
1021         enum {
1022                 NO_ACTION,
1023                 ACTION_CONTINUE,
1024                 ACTION_SKIP,
1025                 ACTION_ABORT,
1026                 ACTION_QUIT,
1027                 ACTION_EDIT_TODO,
1028                 ACTION_SHOW_CURRENT_PATCH,
1029         } action = NO_ACTION;
1030         static const char *action_names[] = { N_("undefined"),
1031                                               N_("continue"),
1032                                               N_("skip"),
1033                                               N_("abort"),
1034                                               N_("quit"),
1035                                               N_("edit_todo"),
1036                                               N_("show_current_patch"),
1037                                               NULL };
1038         const char *gpg_sign = NULL;
1039         struct string_list exec = STRING_LIST_INIT_NODUP;
1040         const char *rebase_merges = NULL;
1041         int fork_point = -1;
1042         struct string_list strategy_options = STRING_LIST_INIT_NODUP;
1043         struct object_id squash_onto;
1044         char *squash_onto_name = NULL;
1045         struct option builtin_rebase_options[] = {
1046                 OPT_STRING(0, "onto", &options.onto_name,
1047                            N_("revision"),
1048                            N_("rebase onto given branch instead of upstream")),
1049                 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
1050                          N_("allow pre-rebase hook to run")),
1051                 OPT_NEGBIT('q', "quiet", &options.flags,
1052                            N_("be quiet. implies --no-stat"),
1053                            REBASE_NO_QUIET| REBASE_VERBOSE | REBASE_DIFFSTAT),
1054                 OPT_BIT('v', "verbose", &options.flags,
1055                         N_("display a diffstat of what changed upstream"),
1056                         REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1057                 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
1058                         N_("do not show diffstat of what changed upstream"),
1059                         PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
1060                 OPT_BOOL(0, "signoff", &options.signoff,
1061                          N_("add a Signed-off-by: line to each commit")),
1062                 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &options.git_am_opts,
1063                                   NULL, N_("passed to 'git am'"),
1064                                   PARSE_OPT_NOARG),
1065                 OPT_PASSTHRU_ARGV(0, "committer-date-is-author-date",
1066                                   &options.git_am_opts, NULL,
1067                                   N_("passed to 'git am'"), PARSE_OPT_NOARG),
1068                 OPT_PASSTHRU_ARGV(0, "ignore-date", &options.git_am_opts, NULL,
1069                                   N_("passed to 'git am'"), PARSE_OPT_NOARG),
1070                 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
1071                                   N_("passed to 'git apply'"), 0),
1072                 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
1073                                   N_("action"), N_("passed to 'git apply'"), 0),
1074                 OPT_BIT('f', "force-rebase", &options.flags,
1075                         N_("cherry-pick all commits, even if unchanged"),
1076                         REBASE_FORCE),
1077                 OPT_BIT(0, "no-ff", &options.flags,
1078                         N_("cherry-pick all commits, even if unchanged"),
1079                         REBASE_FORCE),
1080                 OPT_CMDMODE(0, "continue", &action, N_("continue"),
1081                             ACTION_CONTINUE),
1082                 OPT_CMDMODE(0, "skip", &action,
1083                             N_("skip current patch and continue"), ACTION_SKIP),
1084                 OPT_CMDMODE(0, "abort", &action,
1085                             N_("abort and check out the original branch"),
1086                             ACTION_ABORT),
1087                 OPT_CMDMODE(0, "quit", &action,
1088                             N_("abort but keep HEAD where it is"), ACTION_QUIT),
1089                 OPT_CMDMODE(0, "edit-todo", &action, N_("edit the todo list "
1090                             "during an interactive rebase"), ACTION_EDIT_TODO),
1091                 OPT_CMDMODE(0, "show-current-patch", &action,
1092                             N_("show the patch file being applied or merged"),
1093                             ACTION_SHOW_CURRENT_PATCH),
1094                 { OPTION_CALLBACK, 'm', "merge", &options, NULL,
1095                         N_("use merging strategies to rebase"),
1096                         PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1097                         parse_opt_merge },
1098                 { OPTION_CALLBACK, 'i', "interactive", &options, NULL,
1099                         N_("let the user edit the list of commits to rebase"),
1100                         PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1101                         parse_opt_interactive },
1102                 OPT_SET_INT('p', "preserve-merges", &options.type,
1103                             N_("try to recreate merges instead of ignoring "
1104                                "them"), REBASE_PRESERVE_MERGES),
1105                 OPT_BOOL(0, "rerere-autoupdate",
1106                          &options.allow_rerere_autoupdate,
1107                          N_("allow rerere to update index with resolved "
1108                             "conflict")),
1109                 OPT_BOOL('k', "keep-empty", &options.keep_empty,
1110                          N_("preserve empty commits during rebase")),
1111                 OPT_BOOL(0, "autosquash", &options.autosquash,
1112                          N_("move commits that begin with "
1113                             "squash!/fixup! under -i")),
1114                 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
1115                         N_("GPG-sign commits"),
1116                         PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1117                 OPT_BOOL(0, "autostash", &options.autostash,
1118                          N_("automatically stash/stash pop before and after")),
1119                 OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
1120                                 N_("add exec lines after each commit of the "
1121                                    "editable list")),
1122                 OPT_BOOL(0, "allow-empty-message",
1123                          &options.allow_empty_message,
1124                          N_("allow rebasing commits with empty messages")),
1125                 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
1126                         N_("mode"),
1127                         N_("try to rebase merges instead of skipping them"),
1128                         PARSE_OPT_OPTARG, NULL, (intptr_t)""},
1129                 OPT_BOOL(0, "fork-point", &fork_point,
1130                          N_("use 'merge-base --fork-point' to refine upstream")),
1131                 OPT_STRING('s', "strategy", &options.strategy,
1132                            N_("strategy"), N_("use the given merge strategy")),
1133                 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
1134                                 N_("option"),
1135                                 N_("pass the argument through to the merge "
1136                                    "strategy")),
1137                 OPT_BOOL(0, "root", &options.root,
1138                          N_("rebase all reachable commits up to the root(s)")),
1139                 OPT_BOOL(0, "reschedule-failed-exec",
1140                          &options.reschedule_failed_exec,
1141                          N_("automatically re-schedule any `exec` that fails")),
1142                 OPT_END(),
1143         };
1144         int i;
1145
1146         /*
1147          * NEEDSWORK: Once the builtin rebase has been tested enough
1148          * and git-legacy-rebase.sh is retired to contrib/, this preamble
1149          * can be removed.
1150          */
1151
1152         if (!use_builtin_rebase()) {
1153                 const char *path = mkpath("%s/git-legacy-rebase",
1154                                           git_exec_path());
1155
1156                 if (sane_execvp(path, (char **)argv) < 0)
1157                         die_errno(_("could not exec %s"), path);
1158                 else
1159                         BUG("sane_execvp() returned???");
1160         }
1161
1162         if (argc == 2 && !strcmp(argv[1], "-h"))
1163                 usage_with_options(builtin_rebase_usage,
1164                                    builtin_rebase_options);
1165
1166         prefix = setup_git_directory();
1167         trace_repo_setup(prefix);
1168         setup_work_tree();
1169
1170         git_config(rebase_config, &options);
1171
1172         strbuf_reset(&buf);
1173         strbuf_addf(&buf, "%s/applying", apply_dir());
1174         if(file_exists(buf.buf))
1175                 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1176
1177         if (is_directory(apply_dir())) {
1178                 options.type = REBASE_AM;
1179                 options.state_dir = apply_dir();
1180         } else if (is_directory(merge_dir())) {
1181                 strbuf_reset(&buf);
1182                 strbuf_addf(&buf, "%s/rewritten", merge_dir());
1183                 if (is_directory(buf.buf)) {
1184                         options.type = REBASE_PRESERVE_MERGES;
1185                         options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1186                 } else {
1187                         strbuf_reset(&buf);
1188                         strbuf_addf(&buf, "%s/interactive", merge_dir());
1189                         if(file_exists(buf.buf)) {
1190                                 options.type = REBASE_INTERACTIVE;
1191                                 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1192                         } else
1193                                 options.type = REBASE_MERGE;
1194                 }
1195                 options.state_dir = merge_dir();
1196         }
1197
1198         if (options.type != REBASE_UNSPECIFIED)
1199                 in_progress = 1;
1200
1201         total_argc = argc;
1202         argc = parse_options(argc, argv, prefix,
1203                              builtin_rebase_options,
1204                              builtin_rebase_usage, 0);
1205
1206         if (action != NO_ACTION && total_argc != 2) {
1207                 usage_with_options(builtin_rebase_usage,
1208                                    builtin_rebase_options);
1209         }
1210
1211         if (argc > 2)
1212                 usage_with_options(builtin_rebase_usage,
1213                                    builtin_rebase_options);
1214
1215         if (action != NO_ACTION && !in_progress)
1216                 die(_("No rebase in progress?"));
1217         setenv(GIT_REFLOG_ACTION_ENVIRONMENT, "rebase", 0);
1218
1219         if (action == ACTION_EDIT_TODO && !is_interactive(&options))
1220                 die(_("The --edit-todo action can only be used during "
1221                       "interactive rebase."));
1222
1223         if (trace2_is_enabled()) {
1224                 if (is_interactive(&options))
1225                         trace2_cmd_mode("interactive");
1226                 else if (exec.nr)
1227                         trace2_cmd_mode("interactive-exec");
1228                 else
1229                         trace2_cmd_mode(action_names[action]);
1230         }
1231
1232         switch (action) {
1233         case ACTION_CONTINUE: {
1234                 struct object_id head;
1235                 struct lock_file lock_file = LOCK_INIT;
1236                 int fd;
1237
1238                 options.action = "continue";
1239                 set_reflog_action(&options);
1240
1241                 /* Sanity check */
1242                 if (get_oid("HEAD", &head))
1243                         die(_("Cannot read HEAD"));
1244
1245                 fd = hold_locked_index(&lock_file, 0);
1246                 if (repo_read_index(the_repository) < 0)
1247                         die(_("could not read index"));
1248                 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1249                               NULL);
1250                 if (0 <= fd)
1251                         repo_update_index_if_able(the_repository, &lock_file);
1252                 rollback_lock_file(&lock_file);
1253
1254                 if (has_unstaged_changes(the_repository, 1)) {
1255                         puts(_("You must edit all merge conflicts and then\n"
1256                                "mark them as resolved using git add"));
1257                         exit(1);
1258                 }
1259                 if (read_basic_state(&options))
1260                         exit(1);
1261                 goto run_rebase;
1262         }
1263         case ACTION_SKIP: {
1264                 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1265
1266                 options.action = "skip";
1267                 set_reflog_action(&options);
1268
1269                 rerere_clear(the_repository, &merge_rr);
1270                 string_list_clear(&merge_rr, 1);
1271
1272                 if (reset_head(NULL, "reset", NULL, RESET_HEAD_HARD,
1273                                NULL, NULL) < 0)
1274                         die(_("could not discard worktree changes"));
1275                 remove_branch_state(the_repository, 0);
1276                 if (read_basic_state(&options))
1277                         exit(1);
1278                 goto run_rebase;
1279         }
1280         case ACTION_ABORT: {
1281                 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1282                 options.action = "abort";
1283                 set_reflog_action(&options);
1284
1285                 rerere_clear(the_repository, &merge_rr);
1286                 string_list_clear(&merge_rr, 1);
1287
1288                 if (read_basic_state(&options))
1289                         exit(1);
1290                 if (reset_head(&options.orig_head, "reset",
1291                                options.head_name, RESET_HEAD_HARD,
1292                                NULL, NULL) < 0)
1293                         die(_("could not move back to %s"),
1294                             oid_to_hex(&options.orig_head));
1295                 remove_branch_state(the_repository, 0);
1296                 ret = finish_rebase(&options);
1297                 goto cleanup;
1298         }
1299         case ACTION_QUIT: {
1300                 strbuf_reset(&buf);
1301                 strbuf_addstr(&buf, options.state_dir);
1302                 ret = !!remove_dir_recursively(&buf, 0);
1303                 if (ret)
1304                         die(_("could not remove '%s'"), options.state_dir);
1305                 goto cleanup;
1306         }
1307         case ACTION_EDIT_TODO:
1308                 options.action = "edit-todo";
1309                 options.dont_finish_rebase = 1;
1310                 goto run_rebase;
1311         case ACTION_SHOW_CURRENT_PATCH:
1312                 options.action = "show-current-patch";
1313                 options.dont_finish_rebase = 1;
1314                 goto run_rebase;
1315         case NO_ACTION:
1316                 break;
1317         default:
1318                 BUG("action: %d", action);
1319         }
1320
1321         /* Make sure no rebase is in progress */
1322         if (in_progress) {
1323                 const char *last_slash = strrchr(options.state_dir, '/');
1324                 const char *state_dir_base =
1325                         last_slash ? last_slash + 1 : options.state_dir;
1326                 const char *cmd_live_rebase =
1327                         "git rebase (--continue | --abort | --skip)";
1328                 strbuf_reset(&buf);
1329                 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1330                 die(_("It seems that there is already a %s directory, and\n"
1331                       "I wonder if you are in the middle of another rebase.  "
1332                       "If that is the\n"
1333                       "case, please try\n\t%s\n"
1334                       "If that is not the case, please\n\t%s\n"
1335                       "and run me again.  I am stopping in case you still "
1336                       "have something\n"
1337                       "valuable there.\n"),
1338                     state_dir_base, cmd_live_rebase, buf.buf);
1339         }
1340
1341         for (i = 0; i < options.git_am_opts.argc; i++) {
1342                 const char *option = options.git_am_opts.argv[i], *p;
1343                 if (!strcmp(option, "--committer-date-is-author-date") ||
1344                     !strcmp(option, "--ignore-date") ||
1345                     !strcmp(option, "--whitespace=fix") ||
1346                     !strcmp(option, "--whitespace=strip"))
1347                         options.flags |= REBASE_FORCE;
1348                 else if (skip_prefix(option, "-C", &p)) {
1349                         while (*p)
1350                                 if (!isdigit(*(p++)))
1351                                         die(_("switch `C' expects a "
1352                                               "numerical value"));
1353                 } else if (skip_prefix(option, "--whitespace=", &p)) {
1354                         if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1355                             strcmp(p, "error") && strcmp(p, "error-all"))
1356                                 die("Invalid whitespace option: '%s'", p);
1357                 }
1358         }
1359
1360         for (i = 0; i < exec.nr; i++)
1361                 if (check_exec_cmd(exec.items[i].string))
1362                         exit(1);
1363
1364         if (!(options.flags & REBASE_NO_QUIET))
1365                 argv_array_push(&options.git_am_opts, "-q");
1366
1367         if (options.keep_empty)
1368                 imply_interactive(&options, "--keep-empty");
1369
1370         if (gpg_sign) {
1371                 free(options.gpg_sign_opt);
1372                 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1373         }
1374
1375         if (exec.nr) {
1376                 int i;
1377
1378                 imply_interactive(&options, "--exec");
1379
1380                 strbuf_reset(&buf);
1381                 for (i = 0; i < exec.nr; i++)
1382                         strbuf_addf(&buf, "exec %s\n", exec.items[i].string);
1383                 options.cmd = xstrdup(buf.buf);
1384         }
1385
1386         if (rebase_merges) {
1387                 if (!*rebase_merges)
1388                         ; /* default mode; do nothing */
1389                 else if (!strcmp("rebase-cousins", rebase_merges))
1390                         options.rebase_cousins = 1;
1391                 else if (strcmp("no-rebase-cousins", rebase_merges))
1392                         die(_("Unknown mode: %s"), rebase_merges);
1393                 options.rebase_merges = 1;
1394                 imply_interactive(&options, "--rebase-merges");
1395         }
1396
1397         if (strategy_options.nr) {
1398                 int i;
1399
1400                 if (!options.strategy)
1401                         options.strategy = "recursive";
1402
1403                 strbuf_reset(&buf);
1404                 for (i = 0; i < strategy_options.nr; i++)
1405                         strbuf_addf(&buf, " --%s",
1406                                     strategy_options.items[i].string);
1407                 options.strategy_opts = xstrdup(buf.buf);
1408         }
1409
1410         if (options.strategy) {
1411                 options.strategy = xstrdup(options.strategy);
1412                 switch (options.type) {
1413                 case REBASE_AM:
1414                         die(_("--strategy requires --merge or --interactive"));
1415                 case REBASE_MERGE:
1416                 case REBASE_INTERACTIVE:
1417                 case REBASE_PRESERVE_MERGES:
1418                         /* compatible */
1419                         break;
1420                 case REBASE_UNSPECIFIED:
1421                         options.type = REBASE_MERGE;
1422                         break;
1423                 default:
1424                         BUG("unhandled rebase type (%d)", options.type);
1425                 }
1426         }
1427
1428         if (options.type == REBASE_MERGE)
1429                 imply_interactive(&options, "--merge");
1430
1431         if (options.root && !options.onto_name)
1432                 imply_interactive(&options, "--root without --onto");
1433
1434         if (isatty(2) && options.flags & REBASE_NO_QUIET)
1435                 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1436
1437         switch (options.type) {
1438         case REBASE_MERGE:
1439         case REBASE_INTERACTIVE:
1440         case REBASE_PRESERVE_MERGES:
1441                 options.state_dir = merge_dir();
1442                 break;
1443         case REBASE_AM:
1444                 options.state_dir = apply_dir();
1445                 break;
1446         default:
1447                 /* the default rebase backend is `--am` */
1448                 options.type = REBASE_AM;
1449                 options.state_dir = apply_dir();
1450                 break;
1451         }
1452
1453         if (options.reschedule_failed_exec && !is_interactive(&options))
1454                 die(_("%s requires an interactive rebase"), "--reschedule-failed-exec");
1455
1456         if (options.git_am_opts.argc) {
1457                 /* all am options except -q are compatible only with --am */
1458                 for (i = options.git_am_opts.argc - 1; i >= 0; i--)
1459                         if (strcmp(options.git_am_opts.argv[i], "-q"))
1460                                 break;
1461
1462                 if (is_interactive(&options) && i >= 0)
1463                         die(_("cannot combine am options with either "
1464                               "interactive or merge options"));
1465         }
1466
1467         if (options.signoff) {
1468                 if (options.type == REBASE_PRESERVE_MERGES)
1469                         die("cannot combine '--signoff' with "
1470                             "'--preserve-merges'");
1471                 argv_array_push(&options.git_am_opts, "--signoff");
1472                 options.flags |= REBASE_FORCE;
1473         }
1474
1475         if (options.type == REBASE_PRESERVE_MERGES) {
1476                 /*
1477                  * Note: incompatibility with --signoff handled in signoff block above
1478                  * Note: incompatibility with --interactive is just a strong warning;
1479                  *       git-rebase.txt caveats with "unless you know what you are doing"
1480                  */
1481                 if (options.rebase_merges)
1482                         die(_("cannot combine '--preserve-merges' with "
1483                               "'--rebase-merges'"));
1484
1485                 if (options.reschedule_failed_exec)
1486                         die(_("error: cannot combine '--preserve-merges' with "
1487                               "'--reschedule-failed-exec'"));
1488         }
1489
1490         if (options.rebase_merges) {
1491                 if (strategy_options.nr)
1492                         die(_("cannot combine '--rebase-merges' with "
1493                               "'--strategy-option'"));
1494                 if (options.strategy)
1495                         die(_("cannot combine '--rebase-merges' with "
1496                               "'--strategy'"));
1497         }
1498
1499         if (!options.root) {
1500                 if (argc < 1) {
1501                         struct branch *branch;
1502
1503                         branch = branch_get(NULL);
1504                         options.upstream_name = branch_get_upstream(branch,
1505                                                                     NULL);
1506                         if (!options.upstream_name)
1507                                 error_on_missing_default_upstream();
1508                         if (fork_point < 0)
1509                                 fork_point = 1;
1510                 } else {
1511                         options.upstream_name = argv[0];
1512                         argc--;
1513                         argv++;
1514                         if (!strcmp(options.upstream_name, "-"))
1515                                 options.upstream_name = "@{-1}";
1516                 }
1517                 options.upstream = peel_committish(options.upstream_name);
1518                 if (!options.upstream)
1519                         die(_("invalid upstream '%s'"), options.upstream_name);
1520                 options.upstream_arg = options.upstream_name;
1521         } else {
1522                 if (!options.onto_name) {
1523                         if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1524                                         &squash_onto, NULL, NULL) < 0)
1525                                 die(_("Could not create new root commit"));
1526                         options.squash_onto = &squash_onto;
1527                         options.onto_name = squash_onto_name =
1528                                 xstrdup(oid_to_hex(&squash_onto));
1529                 }
1530                 options.upstream_name = NULL;
1531                 options.upstream = NULL;
1532                 if (argc > 1)
1533                         usage_with_options(builtin_rebase_usage,
1534                                            builtin_rebase_options);
1535                 options.upstream_arg = "--root";
1536         }
1537
1538         /* Make sure the branch to rebase onto is valid. */
1539         if (!options.onto_name)
1540                 options.onto_name = options.upstream_name;
1541         if (strstr(options.onto_name, "...")) {
1542                 if (get_oid_mb(options.onto_name, &merge_base) < 0)
1543                         die(_("'%s': need exactly one merge base"),
1544                             options.onto_name);
1545                 options.onto = lookup_commit_or_die(&merge_base,
1546                                                     options.onto_name);
1547         } else {
1548                 options.onto = peel_committish(options.onto_name);
1549                 if (!options.onto)
1550                         die(_("Does not point to a valid commit '%s'"),
1551                                 options.onto_name);
1552         }
1553
1554         /*
1555          * If the branch to rebase is given, that is the branch we will rebase
1556          * branch_name -- branch/commit being rebased, or
1557          *                HEAD (already detached)
1558          * orig_head -- commit object name of tip of the branch before rebasing
1559          * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1560          */
1561         if (argc == 1) {
1562                 /* Is it "rebase other branchname" or "rebase other commit"? */
1563                 branch_name = argv[0];
1564                 options.switch_to = argv[0];
1565
1566                 /* Is it a local branch? */
1567                 strbuf_reset(&buf);
1568                 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1569                 if (!read_ref(buf.buf, &options.orig_head))
1570                         options.head_name = xstrdup(buf.buf);
1571                 /* If not is it a valid ref (branch or commit)? */
1572                 else if (!get_oid(branch_name, &options.orig_head))
1573                         options.head_name = NULL;
1574                 else
1575                         die(_("fatal: no such branch/commit '%s'"),
1576                             branch_name);
1577         } else if (argc == 0) {
1578                 /* Do not need to switch branches, we are already on it. */
1579                 options.head_name =
1580                         xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
1581                                          &flags));
1582                 if (!options.head_name)
1583                         die(_("No such ref: %s"), "HEAD");
1584                 if (flags & REF_ISSYMREF) {
1585                         if (!skip_prefix(options.head_name,
1586                                          "refs/heads/", &branch_name))
1587                                 branch_name = options.head_name;
1588
1589                 } else {
1590                         free(options.head_name);
1591                         options.head_name = NULL;
1592                         branch_name = "HEAD";
1593                 }
1594                 if (get_oid("HEAD", &options.orig_head))
1595                         die(_("Could not resolve HEAD to a revision"));
1596         } else
1597                 BUG("unexpected number of arguments left to parse");
1598
1599         if (fork_point > 0) {
1600                 struct commit *head =
1601                         lookup_commit_reference(the_repository,
1602                                                 &options.orig_head);
1603                 options.restrict_revision =
1604                         get_fork_point(options.upstream_name, head);
1605         }
1606
1607         if (repo_read_index(the_repository) < 0)
1608                 die(_("could not read index"));
1609
1610         if (options.autostash) {
1611                 struct lock_file lock_file = LOCK_INIT;
1612                 int fd;
1613
1614                 fd = hold_locked_index(&lock_file, 0);
1615                 refresh_cache(REFRESH_QUIET);
1616                 if (0 <= fd)
1617                         repo_update_index_if_able(the_repository, &lock_file);
1618                 rollback_lock_file(&lock_file);
1619
1620                 if (has_unstaged_changes(the_repository, 1) ||
1621                     has_uncommitted_changes(the_repository, 1)) {
1622                         const char *autostash =
1623                                 state_dir_path("autostash", &options);
1624                         struct child_process stash = CHILD_PROCESS_INIT;
1625                         struct object_id oid;
1626                         struct commit *head =
1627                                 lookup_commit_reference(the_repository,
1628                                                         &options.orig_head);
1629
1630                         argv_array_pushl(&stash.args,
1631                                          "stash", "create", "autostash", NULL);
1632                         stash.git_cmd = 1;
1633                         stash.no_stdin = 1;
1634                         strbuf_reset(&buf);
1635                         if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
1636                                 die(_("Cannot autostash"));
1637                         strbuf_trim_trailing_newline(&buf);
1638                         if (get_oid(buf.buf, &oid))
1639                                 die(_("Unexpected stash response: '%s'"),
1640                                     buf.buf);
1641                         strbuf_reset(&buf);
1642                         strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
1643
1644                         if (safe_create_leading_directories_const(autostash))
1645                                 die(_("Could not create directory for '%s'"),
1646                                     options.state_dir);
1647                         write_file(autostash, "%s", oid_to_hex(&oid));
1648                         printf(_("Created autostash: %s\n"), buf.buf);
1649                         if (reset_head(&head->object.oid, "reset --hard",
1650                                        NULL, RESET_HEAD_HARD, NULL, NULL) < 0)
1651                                 die(_("could not reset --hard"));
1652                         printf(_("HEAD is now at %s"),
1653                                find_unique_abbrev(&head->object.oid,
1654                                                   DEFAULT_ABBREV));
1655                         strbuf_reset(&buf);
1656                         pp_commit_easy(CMIT_FMT_ONELINE, head, &buf);
1657                         if (buf.len > 0)
1658                                 printf(" %s", buf.buf);
1659                         putchar('\n');
1660
1661                         if (discard_index(the_repository->index) < 0 ||
1662                                 repo_read_index(the_repository) < 0)
1663                                 die(_("could not read index"));
1664                 }
1665         }
1666
1667         if (require_clean_work_tree(the_repository, "rebase",
1668                                     _("Please commit or stash them."), 1, 1)) {
1669                 ret = 1;
1670                 goto cleanup;
1671         }
1672
1673         /*
1674          * Now we are rebasing commits upstream..orig_head (or with --root,
1675          * everything leading up to orig_head) on top of onto.
1676          */
1677
1678         /*
1679          * Check if we are already based on onto with linear history,
1680          * but this should be done only when upstream and onto are the same
1681          * and if this is not an interactive rebase.
1682          */
1683         if (can_fast_forward(options.onto, &options.orig_head, &merge_base) &&
1684             !is_interactive(&options) && !options.restrict_revision &&
1685             options.upstream &&
1686             !oidcmp(&options.upstream->object.oid, &options.onto->object.oid)) {
1687                 int flag;
1688
1689                 if (!(options.flags & REBASE_FORCE)) {
1690                         /* Lazily switch to the target branch if needed... */
1691                         if (options.switch_to) {
1692                                 struct object_id oid;
1693
1694                                 if (get_oid(options.switch_to, &oid) < 0) {
1695                                         ret = !!error(_("could not parse '%s'"),
1696                                                       options.switch_to);
1697                                         goto cleanup;
1698                                 }
1699
1700                                 strbuf_reset(&buf);
1701                                 strbuf_addf(&buf, "%s: checkout %s",
1702                                             getenv(GIT_REFLOG_ACTION_ENVIRONMENT),
1703                                             options.switch_to);
1704                                 if (reset_head(&oid, "checkout",
1705                                                options.head_name,
1706                                                RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
1707                                                NULL, buf.buf) < 0) {
1708                                         ret = !!error(_("could not switch to "
1709                                                         "%s"),
1710                                                       options.switch_to);
1711                                         goto cleanup;
1712                                 }
1713                         }
1714
1715                         if (!(options.flags & REBASE_NO_QUIET))
1716                                 ; /* be quiet */
1717                         else if (!strcmp(branch_name, "HEAD") &&
1718                                  resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1719                                 puts(_("HEAD is up to date."));
1720                         else
1721                                 printf(_("Current branch %s is up to date.\n"),
1722                                        branch_name);
1723                         ret = !!finish_rebase(&options);
1724                         goto cleanup;
1725                 } else if (!(options.flags & REBASE_NO_QUIET))
1726                         ; /* be quiet */
1727                 else if (!strcmp(branch_name, "HEAD") &&
1728                          resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1729                         puts(_("HEAD is up to date, rebase forced."));
1730                 else
1731                         printf(_("Current branch %s is up to date, rebase "
1732                                  "forced.\n"), branch_name);
1733         }
1734
1735         /* If a hook exists, give it a chance to interrupt*/
1736         if (!ok_to_skip_pre_rebase &&
1737             run_hook_le(NULL, "pre-rebase", options.upstream_arg,
1738                         argc ? argv[0] : NULL, NULL))
1739                 die(_("The pre-rebase hook refused to rebase."));
1740
1741         if (options.flags & REBASE_DIFFSTAT) {
1742                 struct diff_options opts;
1743
1744                 if (options.flags & REBASE_VERBOSE) {
1745                         if (is_null_oid(&merge_base))
1746                                 printf(_("Changes to %s:\n"),
1747                                        oid_to_hex(&options.onto->object.oid));
1748                         else
1749                                 printf(_("Changes from %s to %s:\n"),
1750                                        oid_to_hex(&merge_base),
1751                                        oid_to_hex(&options.onto->object.oid));
1752                 }
1753
1754                 /* We want color (if set), but no pager */
1755                 diff_setup(&opts);
1756                 opts.stat_width = -1; /* use full terminal width */
1757                 opts.stat_graph_width = -1; /* respect statGraphWidth config */
1758                 opts.output_format |=
1759                         DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1760                 opts.detect_rename = DIFF_DETECT_RENAME;
1761                 diff_setup_done(&opts);
1762                 diff_tree_oid(is_null_oid(&merge_base) ?
1763                               the_hash_algo->empty_tree : &merge_base,
1764                               &options.onto->object.oid, "", &opts);
1765                 diffcore_std(&opts);
1766                 diff_flush(&opts);
1767         }
1768
1769         if (is_interactive(&options))
1770                 goto run_rebase;
1771
1772         /* Detach HEAD and reset the tree */
1773         if (options.flags & REBASE_NO_QUIET)
1774                 printf(_("First, rewinding head to replay your work on top of "
1775                          "it...\n"));
1776
1777         strbuf_addf(&msg, "%s: checkout %s",
1778                     getenv(GIT_REFLOG_ACTION_ENVIRONMENT), options.onto_name);
1779         if (reset_head(&options.onto->object.oid, "checkout", NULL,
1780                        RESET_HEAD_DETACH | RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
1781                        NULL, msg.buf))
1782                 die(_("Could not detach HEAD"));
1783         strbuf_release(&msg);
1784
1785         /*
1786          * If the onto is a proper descendant of the tip of the branch, then
1787          * we just fast-forwarded.
1788          */
1789         strbuf_reset(&msg);
1790         if (!oidcmp(&merge_base, &options.orig_head)) {
1791                 printf(_("Fast-forwarded %s to %s.\n"),
1792                         branch_name, options.onto_name);
1793                 strbuf_addf(&msg, "rebase finished: %s onto %s",
1794                         options.head_name ? options.head_name : "detached HEAD",
1795                         oid_to_hex(&options.onto->object.oid));
1796                 reset_head(NULL, "Fast-forwarded", options.head_name, 0,
1797                            "HEAD", msg.buf);
1798                 strbuf_release(&msg);
1799                 ret = !!finish_rebase(&options);
1800                 goto cleanup;
1801         }
1802
1803         strbuf_addf(&revisions, "%s..%s",
1804                     options.root ? oid_to_hex(&options.onto->object.oid) :
1805                     (options.restrict_revision ?
1806                      oid_to_hex(&options.restrict_revision->object.oid) :
1807                      oid_to_hex(&options.upstream->object.oid)),
1808                     oid_to_hex(&options.orig_head));
1809
1810         options.revisions = revisions.buf;
1811
1812 run_rebase:
1813         ret = !!run_specific_rebase(&options);
1814
1815 cleanup:
1816         strbuf_release(&revisions);
1817         free(options.head_name);
1818         free(options.gpg_sign_opt);
1819         free(options.cmd);
1820         free(squash_onto_name);
1821         return ret;
1822 }