sequencer.con commit sequencer (rebase -i): update refs after a successful rebase (4b83ce9)
   1#include "cache.h"
   2#include "lockfile.h"
   3#include "sequencer.h"
   4#include "dir.h"
   5#include "object.h"
   6#include "commit.h"
   7#include "tag.h"
   8#include "run-command.h"
   9#include "exec_cmd.h"
  10#include "utf8.h"
  11#include "cache-tree.h"
  12#include "diff.h"
  13#include "revision.h"
  14#include "rerere.h"
  15#include "merge-recursive.h"
  16#include "refs.h"
  17#include "argv-array.h"
  18#include "quote.h"
  19#include "trailer.h"
  20#include "log-tree.h"
  21#include "wt-status.h"
  22
  23#define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
  24
  25const char sign_off_header[] = "Signed-off-by: ";
  26static const char cherry_picked_prefix[] = "(cherry picked from commit ";
  27
  28GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
  29
  30static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
  31static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
  32static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
  33static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
  34
  35static GIT_PATH_FUNC(rebase_path, "rebase-merge")
  36/*
  37 * The file containing rebase commands, comments, and empty lines.
  38 * This file is created by "git rebase -i" then edited by the user. As
  39 * the lines are processed, they are removed from the front of this
  40 * file and written to the tail of 'done'.
  41 */
  42static GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
  43/*
  44 * The rebase command lines that have already been processed. A line
  45 * is moved here when it is first handled, before any associated user
  46 * actions.
  47 */
  48static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
  49/*
  50 * The commit message that is planned to be used for any changes that
  51 * need to be committed following a user interaction.
  52 */
  53static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
  54/*
  55 * The file into which is accumulated the suggested commit message for
  56 * squash/fixup commands. When the first of a series of squash/fixups
  57 * is seen, the file is created and the commit message from the
  58 * previous commit and from the first squash/fixup commit are written
  59 * to it. The commit message for each subsequent squash/fixup commit
  60 * is appended to the file as it is processed.
  61 *
  62 * The first line of the file is of the form
  63 *     # This is a combination of $count commits.
  64 * where $count is the number of commits whose messages have been
  65 * written to the file so far (including the initial "pick" commit).
  66 * Each time that a commit message is processed, this line is read and
  67 * updated. It is deleted just before the combined commit is made.
  68 */
  69static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
  70/*
  71 * If the current series of squash/fixups has not yet included a squash
  72 * command, then this file exists and holds the commit message of the
  73 * original "pick" commit.  (If the series ends without a "squash"
  74 * command, then this can be used as the commit message of the combined
  75 * commit without opening the editor.)
  76 */
  77static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
  78/*
  79 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
  80 * GIT_AUTHOR_DATE that will be used for the commit that is currently
  81 * being rebased.
  82 */
  83static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
  84/*
  85 * When an "edit" rebase command is being processed, the SHA1 of the
  86 * commit to be edited is recorded in this file.  When "git rebase
  87 * --continue" is executed, if there are any staged changes then they
  88 * will be amended to the HEAD commit, but only provided the HEAD
  89 * commit is still the commit to be edited.  When any other rebase
  90 * command is processed, this file is deleted.
  91 */
  92static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
  93/*
  94 * When we stop at a given patch via the "edit" command, this file contains
  95 * the abbreviated commit name of the corresponding patch.
  96 */
  97static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
  98/*
  99 * The following files are written by git-rebase just after parsing the
 100 * command-line (and are only consumed, not modified, by the sequencer).
 101 */
 102static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
 103static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
 104static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
 105static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
 106static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
 107
 108static inline int is_rebase_i(const struct replay_opts *opts)
 109{
 110        return opts->action == REPLAY_INTERACTIVE_REBASE;
 111}
 112
 113static const char *get_dir(const struct replay_opts *opts)
 114{
 115        if (is_rebase_i(opts))
 116                return rebase_path();
 117        return git_path_seq_dir();
 118}
 119
 120static const char *get_todo_path(const struct replay_opts *opts)
 121{
 122        if (is_rebase_i(opts))
 123                return rebase_path_todo();
 124        return git_path_todo_file();
 125}
 126
 127/*
 128 * Returns 0 for non-conforming footer
 129 * Returns 1 for conforming footer
 130 * Returns 2 when sob exists within conforming footer
 131 * Returns 3 when sob exists within conforming footer as last entry
 132 */
 133static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
 134        int ignore_footer)
 135{
 136        struct trailer_info info;
 137        int i;
 138        int found_sob = 0, found_sob_last = 0;
 139
 140        trailer_info_get(&info, sb->buf);
 141
 142        if (info.trailer_start == info.trailer_end)
 143                return 0;
 144
 145        for (i = 0; i < info.trailer_nr; i++)
 146                if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
 147                        found_sob = 1;
 148                        if (i == info.trailer_nr - 1)
 149                                found_sob_last = 1;
 150                }
 151
 152        trailer_info_release(&info);
 153
 154        if (found_sob_last)
 155                return 3;
 156        if (found_sob)
 157                return 2;
 158        return 1;
 159}
 160
 161static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
 162{
 163        static struct strbuf buf = STRBUF_INIT;
 164
 165        strbuf_reset(&buf);
 166        if (opts->gpg_sign)
 167                sq_quotef(&buf, "-S%s", opts->gpg_sign);
 168        return buf.buf;
 169}
 170
 171int sequencer_remove_state(struct replay_opts *opts)
 172{
 173        struct strbuf dir = STRBUF_INIT;
 174        int i;
 175
 176        free(opts->gpg_sign);
 177        free(opts->strategy);
 178        for (i = 0; i < opts->xopts_nr; i++)
 179                free(opts->xopts[i]);
 180        free(opts->xopts);
 181
 182        strbuf_addf(&dir, "%s", get_dir(opts));
 183        remove_dir_recursively(&dir, 0);
 184        strbuf_release(&dir);
 185
 186        return 0;
 187}
 188
 189static const char *action_name(const struct replay_opts *opts)
 190{
 191        switch (opts->action) {
 192        case REPLAY_REVERT:
 193                return N_("revert");
 194        case REPLAY_PICK:
 195                return N_("cherry-pick");
 196        case REPLAY_INTERACTIVE_REBASE:
 197                return N_("rebase -i");
 198        }
 199        die(_("Unknown action: %d"), opts->action);
 200}
 201
 202struct commit_message {
 203        char *parent_label;
 204        char *label;
 205        char *subject;
 206        const char *message;
 207};
 208
 209static const char *short_commit_name(struct commit *commit)
 210{
 211        return find_unique_abbrev(commit->object.oid.hash, DEFAULT_ABBREV);
 212}
 213
 214static int get_message(struct commit *commit, struct commit_message *out)
 215{
 216        const char *abbrev, *subject;
 217        int subject_len;
 218
 219        out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
 220        abbrev = short_commit_name(commit);
 221
 222        subject_len = find_commit_subject(out->message, &subject);
 223
 224        out->subject = xmemdupz(subject, subject_len);
 225        out->label = xstrfmt("%s... %s", abbrev, out->subject);
 226        out->parent_label = xstrfmt("parent of %s", out->label);
 227
 228        return 0;
 229}
 230
 231static void free_message(struct commit *commit, struct commit_message *msg)
 232{
 233        free(msg->parent_label);
 234        free(msg->label);
 235        free(msg->subject);
 236        unuse_commit_buffer(commit, msg->message);
 237}
 238
 239static void print_advice(int show_hint, struct replay_opts *opts)
 240{
 241        char *msg = getenv("GIT_CHERRY_PICK_HELP");
 242
 243        if (msg) {
 244                fprintf(stderr, "%s\n", msg);
 245                /*
 246                 * A conflict has occurred but the porcelain
 247                 * (typically rebase --interactive) wants to take care
 248                 * of the commit itself so remove CHERRY_PICK_HEAD
 249                 */
 250                unlink(git_path_cherry_pick_head());
 251                return;
 252        }
 253
 254        if (show_hint) {
 255                if (opts->no_commit)
 256                        advise(_("after resolving the conflicts, mark the corrected paths\n"
 257                                 "with 'git add <paths>' or 'git rm <paths>'"));
 258                else
 259                        advise(_("after resolving the conflicts, mark the corrected paths\n"
 260                                 "with 'git add <paths>' or 'git rm <paths>'\n"
 261                                 "and commit the result with 'git commit'"));
 262        }
 263}
 264
 265static int write_message(const void *buf, size_t len, const char *filename,
 266                         int append_eol)
 267{
 268        static struct lock_file msg_file;
 269
 270        int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
 271        if (msg_fd < 0)
 272                return error_errno(_("could not lock '%s'"), filename);
 273        if (write_in_full(msg_fd, buf, len) < 0) {
 274                rollback_lock_file(&msg_file);
 275                return error_errno(_("could not write to '%s'"), filename);
 276        }
 277        if (append_eol && write(msg_fd, "\n", 1) < 0) {
 278                rollback_lock_file(&msg_file);
 279                return error_errno(_("could not write eol to '%s'"), filename);
 280        }
 281        if (commit_lock_file(&msg_file) < 0) {
 282                rollback_lock_file(&msg_file);
 283                return error(_("failed to finalize '%s'."), filename);
 284        }
 285
 286        return 0;
 287}
 288
 289/*
 290 * Reads a file that was presumably written by a shell script, i.e. with an
 291 * end-of-line marker that needs to be stripped.
 292 *
 293 * Note that only the last end-of-line marker is stripped, consistent with the
 294 * behavior of "$(cat path)" in a shell script.
 295 *
 296 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
 297 */
 298static int read_oneliner(struct strbuf *buf,
 299        const char *path, int skip_if_empty)
 300{
 301        int orig_len = buf->len;
 302
 303        if (!file_exists(path))
 304                return 0;
 305
 306        if (strbuf_read_file(buf, path, 0) < 0) {
 307                warning_errno(_("could not read '%s'"), path);
 308                return 0;
 309        }
 310
 311        if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
 312                if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
 313                        --buf->len;
 314                buf->buf[buf->len] = '\0';
 315        }
 316
 317        if (skip_if_empty && buf->len == orig_len)
 318                return 0;
 319
 320        return 1;
 321}
 322
 323static struct tree *empty_tree(void)
 324{
 325        return lookup_tree(EMPTY_TREE_SHA1_BIN);
 326}
 327
 328static int error_dirty_index(struct replay_opts *opts)
 329{
 330        if (read_cache_unmerged())
 331                return error_resolve_conflict(_(action_name(opts)));
 332
 333        error(_("your local changes would be overwritten by %s."),
 334                _(action_name(opts)));
 335
 336        if (advice_commit_before_merge)
 337                advise(_("commit your changes or stash them to proceed."));
 338        return -1;
 339}
 340
 341static void update_abort_safety_file(void)
 342{
 343        struct object_id head;
 344
 345        /* Do nothing on a single-pick */
 346        if (!file_exists(git_path_seq_dir()))
 347                return;
 348
 349        if (!get_oid("HEAD", &head))
 350                write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
 351        else
 352                write_file(git_path_abort_safety_file(), "%s", "");
 353}
 354
 355static int fast_forward_to(const unsigned char *to, const unsigned char *from,
 356                        int unborn, struct replay_opts *opts)
 357{
 358        struct ref_transaction *transaction;
 359        struct strbuf sb = STRBUF_INIT;
 360        struct strbuf err = STRBUF_INIT;
 361
 362        read_cache();
 363        if (checkout_fast_forward(from, to, 1))
 364                return -1; /* the callee should have complained already */
 365
 366        strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
 367
 368        transaction = ref_transaction_begin(&err);
 369        if (!transaction ||
 370            ref_transaction_update(transaction, "HEAD",
 371                                   to, unborn ? null_sha1 : from,
 372                                   0, sb.buf, &err) ||
 373            ref_transaction_commit(transaction, &err)) {
 374                ref_transaction_free(transaction);
 375                error("%s", err.buf);
 376                strbuf_release(&sb);
 377                strbuf_release(&err);
 378                return -1;
 379        }
 380
 381        strbuf_release(&sb);
 382        strbuf_release(&err);
 383        ref_transaction_free(transaction);
 384        update_abort_safety_file();
 385        return 0;
 386}
 387
 388void append_conflicts_hint(struct strbuf *msgbuf)
 389{
 390        int i;
 391
 392        strbuf_addch(msgbuf, '\n');
 393        strbuf_commented_addf(msgbuf, "Conflicts:\n");
 394        for (i = 0; i < active_nr;) {
 395                const struct cache_entry *ce = active_cache[i++];
 396                if (ce_stage(ce)) {
 397                        strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
 398                        while (i < active_nr && !strcmp(ce->name,
 399                                                        active_cache[i]->name))
 400                                i++;
 401                }
 402        }
 403}
 404
 405static int do_recursive_merge(struct commit *base, struct commit *next,
 406                              const char *base_label, const char *next_label,
 407                              unsigned char *head, struct strbuf *msgbuf,
 408                              struct replay_opts *opts)
 409{
 410        struct merge_options o;
 411        struct tree *result, *next_tree, *base_tree, *head_tree;
 412        int clean;
 413        char **xopt;
 414        static struct lock_file index_lock;
 415
 416        hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
 417
 418        read_cache();
 419
 420        init_merge_options(&o);
 421        o.ancestor = base ? base_label : "(empty tree)";
 422        o.branch1 = "HEAD";
 423        o.branch2 = next ? next_label : "(empty tree)";
 424
 425        head_tree = parse_tree_indirect(head);
 426        next_tree = next ? next->tree : empty_tree();
 427        base_tree = base ? base->tree : empty_tree();
 428
 429        for (xopt = opts->xopts; xopt != opts->xopts + opts->xopts_nr; xopt++)
 430                parse_merge_opt(&o, *xopt);
 431
 432        clean = merge_trees(&o,
 433                            head_tree,
 434                            next_tree, base_tree, &result);
 435        strbuf_release(&o.obuf);
 436        if (clean < 0)
 437                return clean;
 438
 439        if (active_cache_changed &&
 440            write_locked_index(&the_index, &index_lock, COMMIT_LOCK))
 441                /* TRANSLATORS: %s will be "revert", "cherry-pick" or
 442                 * "rebase -i".
 443                 */
 444                return error(_("%s: Unable to write new index file"),
 445                        _(action_name(opts)));
 446        rollback_lock_file(&index_lock);
 447
 448        if (opts->signoff)
 449                append_signoff(msgbuf, 0, 0);
 450
 451        if (!clean)
 452                append_conflicts_hint(msgbuf);
 453
 454        return !clean;
 455}
 456
 457static int is_index_unchanged(void)
 458{
 459        unsigned char head_sha1[20];
 460        struct commit *head_commit;
 461
 462        if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, head_sha1, NULL))
 463                return error(_("could not resolve HEAD commit\n"));
 464
 465        head_commit = lookup_commit(head_sha1);
 466
 467        /*
 468         * If head_commit is NULL, check_commit, called from
 469         * lookup_commit, would have indicated that head_commit is not
 470         * a commit object already.  parse_commit() will return failure
 471         * without further complaints in such a case.  Otherwise, if
 472         * the commit is invalid, parse_commit() will complain.  So
 473         * there is nothing for us to say here.  Just return failure.
 474         */
 475        if (parse_commit(head_commit))
 476                return -1;
 477
 478        if (!active_cache_tree)
 479                active_cache_tree = cache_tree();
 480
 481        if (!cache_tree_fully_valid(active_cache_tree))
 482                if (cache_tree_update(&the_index, 0))
 483                        return error(_("unable to update cache tree\n"));
 484
 485        return !hashcmp(active_cache_tree->sha1, head_commit->tree->object.oid.hash);
 486}
 487
 488static int write_author_script(const char *message)
 489{
 490        struct strbuf buf = STRBUF_INIT;
 491        const char *eol;
 492        int res;
 493
 494        for (;;)
 495                if (!*message || starts_with(message, "\n")) {
 496missing_author:
 497                        /* Missing 'author' line? */
 498                        unlink(rebase_path_author_script());
 499                        return 0;
 500                } else if (skip_prefix(message, "author ", &message))
 501                        break;
 502                else if ((eol = strchr(message, '\n')))
 503                        message = eol + 1;
 504                else
 505                        goto missing_author;
 506
 507        strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
 508        while (*message && *message != '\n' && *message != '\r')
 509                if (skip_prefix(message, " <", &message))
 510                        break;
 511                else if (*message != '\'')
 512                        strbuf_addch(&buf, *(message++));
 513                else
 514                        strbuf_addf(&buf, "'\\\\%c'", *(message++));
 515        strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
 516        while (*message && *message != '\n' && *message != '\r')
 517                if (skip_prefix(message, "> ", &message))
 518                        break;
 519                else if (*message != '\'')
 520                        strbuf_addch(&buf, *(message++));
 521                else
 522                        strbuf_addf(&buf, "'\\\\%c'", *(message++));
 523        strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
 524        while (*message && *message != '\n' && *message != '\r')
 525                if (*message != '\'')
 526                        strbuf_addch(&buf, *(message++));
 527                else
 528                        strbuf_addf(&buf, "'\\\\%c'", *(message++));
 529        res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
 530        strbuf_release(&buf);
 531        return res;
 532}
 533
 534/*
 535 * Read the author-script file into an environment block, ready for use in
 536 * run_command(), that can be free()d afterwards.
 537 */
 538static char **read_author_script(void)
 539{
 540        struct strbuf script = STRBUF_INIT;
 541        int i, count = 0;
 542        char *p, *p2, **env;
 543        size_t env_size;
 544
 545        if (strbuf_read_file(&script, rebase_path_author_script(), 256) <= 0)
 546                return NULL;
 547
 548        for (p = script.buf; *p; p++)
 549                if (skip_prefix(p, "'\\\\''", (const char **)&p2))
 550                        strbuf_splice(&script, p - script.buf, p2 - p, "'", 1);
 551                else if (*p == '\'')
 552                        strbuf_splice(&script, p-- - script.buf, 1, "", 0);
 553                else if (*p == '\n') {
 554                        *p = '\0';
 555                        count++;
 556                }
 557
 558        env_size = (count + 1) * sizeof(*env);
 559        strbuf_grow(&script, env_size);
 560        memmove(script.buf + env_size, script.buf, script.len);
 561        p = script.buf + env_size;
 562        env = (char **)strbuf_detach(&script, NULL);
 563
 564        for (i = 0; i < count; i++) {
 565                env[i] = p;
 566                p += strlen(p) + 1;
 567        }
 568        env[count] = NULL;
 569
 570        return env;
 571}
 572
 573static const char staged_changes_advice[] =
 574N_("you have staged changes in your working tree\n"
 575"If these changes are meant to be squashed into the previous commit, run:\n"
 576"\n"
 577"  git commit --amend %s\n"
 578"\n"
 579"If they are meant to go into a new commit, run:\n"
 580"\n"
 581"  git commit %s\n"
 582"\n"
 583"In both cases, once you're done, continue with:\n"
 584"\n"
 585"  git rebase --continue\n");
 586
 587/*
 588 * If we are cherry-pick, and if the merge did not result in
 589 * hand-editing, we will hit this commit and inherit the original
 590 * author date and name.
 591 *
 592 * If we are revert, or if our cherry-pick results in a hand merge,
 593 * we had better say that the current user is responsible for that.
 594 *
 595 * An exception is when run_git_commit() is called during an
 596 * interactive rebase: in that case, we will want to retain the
 597 * author metadata.
 598 */
 599static int run_git_commit(const char *defmsg, struct replay_opts *opts,
 600                          int allow_empty, int edit, int amend,
 601                          int cleanup_commit_message)
 602{
 603        char **env = NULL;
 604        struct argv_array array;
 605        int rc;
 606        const char *value;
 607
 608        if (is_rebase_i(opts)) {
 609                env = read_author_script();
 610                if (!env) {
 611                        const char *gpg_opt = gpg_sign_opt_quoted(opts);
 612
 613                        return error(_(staged_changes_advice),
 614                                     gpg_opt, gpg_opt);
 615                }
 616        }
 617
 618        argv_array_init(&array);
 619        argv_array_push(&array, "commit");
 620        argv_array_push(&array, "-n");
 621
 622        if (amend)
 623                argv_array_push(&array, "--amend");
 624        if (opts->gpg_sign)
 625                argv_array_pushf(&array, "-S%s", opts->gpg_sign);
 626        if (opts->signoff)
 627                argv_array_push(&array, "-s");
 628        if (defmsg)
 629                argv_array_pushl(&array, "-F", defmsg, NULL);
 630        if (cleanup_commit_message)
 631                argv_array_push(&array, "--cleanup=strip");
 632        if (edit)
 633                argv_array_push(&array, "-e");
 634        else if (!cleanup_commit_message &&
 635                 !opts->signoff && !opts->record_origin &&
 636                 git_config_get_value("commit.cleanup", &value))
 637                argv_array_push(&array, "--cleanup=verbatim");
 638
 639        if (allow_empty)
 640                argv_array_push(&array, "--allow-empty");
 641
 642        if (opts->allow_empty_message)
 643                argv_array_push(&array, "--allow-empty-message");
 644
 645        rc = run_command_v_opt_cd_env(array.argv, RUN_GIT_CMD, NULL,
 646                        (const char *const *)env);
 647        argv_array_clear(&array);
 648        free(env);
 649
 650        return rc;
 651}
 652
 653static int is_original_commit_empty(struct commit *commit)
 654{
 655        const unsigned char *ptree_sha1;
 656
 657        if (parse_commit(commit))
 658                return error(_("could not parse commit %s\n"),
 659                             oid_to_hex(&commit->object.oid));
 660        if (commit->parents) {
 661                struct commit *parent = commit->parents->item;
 662                if (parse_commit(parent))
 663                        return error(_("could not parse parent commit %s\n"),
 664                                oid_to_hex(&parent->object.oid));
 665                ptree_sha1 = parent->tree->object.oid.hash;
 666        } else {
 667                ptree_sha1 = EMPTY_TREE_SHA1_BIN; /* commit is root */
 668        }
 669
 670        return !hashcmp(ptree_sha1, commit->tree->object.oid.hash);
 671}
 672
 673/*
 674 * Do we run "git commit" with "--allow-empty"?
 675 */
 676static int allow_empty(struct replay_opts *opts, struct commit *commit)
 677{
 678        int index_unchanged, empty_commit;
 679
 680        /*
 681         * Three cases:
 682         *
 683         * (1) we do not allow empty at all and error out.
 684         *
 685         * (2) we allow ones that were initially empty, but
 686         * forbid the ones that become empty;
 687         *
 688         * (3) we allow both.
 689         */
 690        if (!opts->allow_empty)
 691                return 0; /* let "git commit" barf as necessary */
 692
 693        index_unchanged = is_index_unchanged();
 694        if (index_unchanged < 0)
 695                return index_unchanged;
 696        if (!index_unchanged)
 697                return 0; /* we do not have to say --allow-empty */
 698
 699        if (opts->keep_redundant_commits)
 700                return 1;
 701
 702        empty_commit = is_original_commit_empty(commit);
 703        if (empty_commit < 0)
 704                return empty_commit;
 705        if (!empty_commit)
 706                return 0;
 707        else
 708                return 1;
 709}
 710
 711/*
 712 * Note that ordering matters in this enum. Not only must it match the mapping
 713 * below, it is also divided into several sections that matter.  When adding
 714 * new commands, make sure you add it in the right section.
 715 */
 716enum todo_command {
 717        /* commands that handle commits */
 718        TODO_PICK = 0,
 719        TODO_REVERT,
 720        TODO_EDIT,
 721        TODO_FIXUP,
 722        TODO_SQUASH,
 723        /* commands that do something else than handling a single commit */
 724        TODO_EXEC,
 725        /* commands that do nothing but are counted for reporting progress */
 726        TODO_NOOP
 727};
 728
 729static struct {
 730        char c;
 731        const char *str;
 732} todo_command_info[] = {
 733        { 'p', "pick" },
 734        { 0,   "revert" },
 735        { 'e', "edit" },
 736        { 'f', "fixup" },
 737        { 's', "squash" },
 738        { 'x', "exec" },
 739        { 0,   "noop" }
 740};
 741
 742static const char *command_to_string(const enum todo_command command)
 743{
 744        if ((size_t)command < ARRAY_SIZE(todo_command_info))
 745                return todo_command_info[command].str;
 746        die("Unknown command: %d", command);
 747}
 748
 749static int is_noop(const enum todo_command command)
 750{
 751        return TODO_NOOP <= (size_t)command;
 752}
 753
 754static int is_fixup(enum todo_command command)
 755{
 756        return command == TODO_FIXUP || command == TODO_SQUASH;
 757}
 758
 759static int update_squash_messages(enum todo_command command,
 760                struct commit *commit, struct replay_opts *opts)
 761{
 762        struct strbuf buf = STRBUF_INIT;
 763        int count, res;
 764        const char *message, *body;
 765
 766        if (file_exists(rebase_path_squash_msg())) {
 767                struct strbuf header = STRBUF_INIT;
 768                char *eol, *p;
 769
 770                if (strbuf_read_file(&buf, rebase_path_squash_msg(), 2048) <= 0)
 771                        return error(_("could not read '%s'"),
 772                                rebase_path_squash_msg());
 773
 774                p = buf.buf + 1;
 775                eol = strchrnul(buf.buf, '\n');
 776                if (buf.buf[0] != comment_line_char ||
 777                    (p += strcspn(p, "0123456789\n")) == eol)
 778                        return error(_("unexpected 1st line of squash message:"
 779                                       "\n\n\t%.*s"),
 780                                     (int)(eol - buf.buf), buf.buf);
 781                count = strtol(p, NULL, 10);
 782
 783                if (count < 1)
 784                        return error(_("invalid 1st line of squash message:\n"
 785                                       "\n\t%.*s"),
 786                                     (int)(eol - buf.buf), buf.buf);
 787
 788                strbuf_addf(&header, "%c ", comment_line_char);
 789                strbuf_addf(&header,
 790                            _("This is a combination of %d commits."), ++count);
 791                strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
 792                strbuf_release(&header);
 793        } else {
 794                unsigned char head[20];
 795                struct commit *head_commit;
 796                const char *head_message, *body;
 797
 798                if (get_sha1("HEAD", head))
 799                        return error(_("need a HEAD to fixup"));
 800                if (!(head_commit = lookup_commit_reference(head)))
 801                        return error(_("could not read HEAD"));
 802                if (!(head_message = get_commit_buffer(head_commit, NULL)))
 803                        return error(_("could not read HEAD's commit message"));
 804
 805                find_commit_subject(head_message, &body);
 806                if (write_message(body, strlen(body),
 807                                  rebase_path_fixup_msg(), 0)) {
 808                        unuse_commit_buffer(head_commit, head_message);
 809                        return error(_("cannot write '%s'"),
 810                                     rebase_path_fixup_msg());
 811                }
 812
 813                count = 2;
 814                strbuf_addf(&buf, "%c ", comment_line_char);
 815                strbuf_addf(&buf, _("This is a combination of %d commits."),
 816                            count);
 817                strbuf_addf(&buf, "\n%c ", comment_line_char);
 818                strbuf_addstr(&buf, _("This is the 1st commit message:"));
 819                strbuf_addstr(&buf, "\n\n");
 820                strbuf_addstr(&buf, body);
 821
 822                unuse_commit_buffer(head_commit, head_message);
 823        }
 824
 825        if (!(message = get_commit_buffer(commit, NULL)))
 826                return error(_("could not read commit message of %s"),
 827                             oid_to_hex(&commit->object.oid));
 828        find_commit_subject(message, &body);
 829
 830        if (command == TODO_SQUASH) {
 831                unlink(rebase_path_fixup_msg());
 832                strbuf_addf(&buf, "\n%c ", comment_line_char);
 833                strbuf_addf(&buf, _("This is the commit message #%d:"), count);
 834                strbuf_addstr(&buf, "\n\n");
 835                strbuf_addstr(&buf, body);
 836        } else if (command == TODO_FIXUP) {
 837                strbuf_addf(&buf, "\n%c ", comment_line_char);
 838                strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
 839                            count);
 840                strbuf_addstr(&buf, "\n\n");
 841                strbuf_add_commented_lines(&buf, body, strlen(body));
 842        } else
 843                return error(_("unknown command: %d"), command);
 844        unuse_commit_buffer(commit, message);
 845
 846        res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
 847        strbuf_release(&buf);
 848        return res;
 849}
 850
 851static int do_pick_commit(enum todo_command command, struct commit *commit,
 852                struct replay_opts *opts, int final_fixup)
 853{
 854        int edit = opts->edit, cleanup_commit_message = 0;
 855        const char *msg_file = edit ? NULL : git_path_merge_msg();
 856        unsigned char head[20];
 857        struct commit *base, *next, *parent;
 858        const char *base_label, *next_label;
 859        struct commit_message msg = { NULL, NULL, NULL, NULL };
 860        struct strbuf msgbuf = STRBUF_INIT;
 861        int res, unborn = 0, amend = 0, allow;
 862
 863        if (opts->no_commit) {
 864                /*
 865                 * We do not intend to commit immediately.  We just want to
 866                 * merge the differences in, so let's compute the tree
 867                 * that represents the "current" state for merge-recursive
 868                 * to work on.
 869                 */
 870                if (write_cache_as_tree(head, 0, NULL))
 871                        return error(_("your index file is unmerged."));
 872        } else {
 873                unborn = get_sha1("HEAD", head);
 874                if (unborn)
 875                        hashcpy(head, EMPTY_TREE_SHA1_BIN);
 876                if (index_differs_from(unborn ? EMPTY_TREE_SHA1_HEX : "HEAD", 0, 0))
 877                        return error_dirty_index(opts);
 878        }
 879        discard_cache();
 880
 881        if (!commit->parents)
 882                parent = NULL;
 883        else if (commit->parents->next) {
 884                /* Reverting or cherry-picking a merge commit */
 885                int cnt;
 886                struct commit_list *p;
 887
 888                if (!opts->mainline)
 889                        return error(_("commit %s is a merge but no -m option was given."),
 890                                oid_to_hex(&commit->object.oid));
 891
 892                for (cnt = 1, p = commit->parents;
 893                     cnt != opts->mainline && p;
 894                     cnt++)
 895                        p = p->next;
 896                if (cnt != opts->mainline || !p)
 897                        return error(_("commit %s does not have parent %d"),
 898                                oid_to_hex(&commit->object.oid), opts->mainline);
 899                parent = p->item;
 900        } else if (0 < opts->mainline)
 901                return error(_("mainline was specified but commit %s is not a merge."),
 902                        oid_to_hex(&commit->object.oid));
 903        else
 904                parent = commit->parents->item;
 905
 906        if (opts->allow_ff && !is_fixup(command) &&
 907            ((parent && !hashcmp(parent->object.oid.hash, head)) ||
 908             (!parent && unborn)))
 909                return fast_forward_to(commit->object.oid.hash, head, unborn, opts);
 910
 911        if (parent && parse_commit(parent) < 0)
 912                /* TRANSLATORS: The first %s will be a "todo" command like
 913                   "revert" or "pick", the second %s a SHA1. */
 914                return error(_("%s: cannot parse parent commit %s"),
 915                        command_to_string(command),
 916                        oid_to_hex(&parent->object.oid));
 917
 918        if (get_message(commit, &msg) != 0)
 919                return error(_("cannot get commit message for %s"),
 920                        oid_to_hex(&commit->object.oid));
 921
 922        /*
 923         * "commit" is an existing commit.  We would want to apply
 924         * the difference it introduces since its first parent "prev"
 925         * on top of the current HEAD if we are cherry-pick.  Or the
 926         * reverse of it if we are revert.
 927         */
 928
 929        if (command == TODO_REVERT) {
 930                base = commit;
 931                base_label = msg.label;
 932                next = parent;
 933                next_label = msg.parent_label;
 934                strbuf_addstr(&msgbuf, "Revert \"");
 935                strbuf_addstr(&msgbuf, msg.subject);
 936                strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
 937                strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
 938
 939                if (commit->parents && commit->parents->next) {
 940                        strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
 941                        strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
 942                }
 943                strbuf_addstr(&msgbuf, ".\n");
 944        } else {
 945                const char *p;
 946
 947                base = parent;
 948                base_label = msg.parent_label;
 949                next = commit;
 950                next_label = msg.label;
 951
 952                /* Append the commit log message to msgbuf. */
 953                if (find_commit_subject(msg.message, &p))
 954                        strbuf_addstr(&msgbuf, p);
 955
 956                if (opts->record_origin) {
 957                        if (!has_conforming_footer(&msgbuf, NULL, 0))
 958                                strbuf_addch(&msgbuf, '\n');
 959                        strbuf_addstr(&msgbuf, cherry_picked_prefix);
 960                        strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
 961                        strbuf_addstr(&msgbuf, ")\n");
 962                }
 963        }
 964
 965        if (is_fixup(command)) {
 966                if (update_squash_messages(command, commit, opts))
 967                        return -1;
 968                amend = 1;
 969                if (!final_fixup)
 970                        msg_file = rebase_path_squash_msg();
 971                else if (file_exists(rebase_path_fixup_msg())) {
 972                        cleanup_commit_message = 1;
 973                        msg_file = rebase_path_fixup_msg();
 974                } else {
 975                        const char *dest = git_path("SQUASH_MSG");
 976                        unlink(dest);
 977                        if (copy_file(dest, rebase_path_squash_msg(), 0666))
 978                                return error(_("could not rename '%s' to '%s'"),
 979                                             rebase_path_squash_msg(), dest);
 980                        unlink(git_path("MERGE_MSG"));
 981                        msg_file = dest;
 982                        edit = 1;
 983                }
 984        }
 985
 986        if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
 987                res = -1;
 988        else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
 989                res = do_recursive_merge(base, next, base_label, next_label,
 990                                         head, &msgbuf, opts);
 991                if (res < 0)
 992                        return res;
 993                res |= write_message(msgbuf.buf, msgbuf.len,
 994                                     git_path_merge_msg(), 0);
 995        } else {
 996                struct commit_list *common = NULL;
 997                struct commit_list *remotes = NULL;
 998
 999                res = write_message(msgbuf.buf, msgbuf.len,
1000                                    git_path_merge_msg(), 0);
1001
1002                commit_list_insert(base, &common);
1003                commit_list_insert(next, &remotes);
1004                res |= try_merge_command(opts->strategy,
1005                                         opts->xopts_nr, (const char **)opts->xopts,
1006                                        common, sha1_to_hex(head), remotes);
1007                free_commit_list(common);
1008                free_commit_list(remotes);
1009        }
1010        strbuf_release(&msgbuf);
1011
1012        /*
1013         * If the merge was clean or if it failed due to conflict, we write
1014         * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
1015         * However, if the merge did not even start, then we don't want to
1016         * write it at all.
1017         */
1018        if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
1019            update_ref(NULL, "CHERRY_PICK_HEAD", commit->object.oid.hash, NULL,
1020                       REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1021                res = -1;
1022        if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
1023            update_ref(NULL, "REVERT_HEAD", commit->object.oid.hash, NULL,
1024                       REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1025                res = -1;
1026
1027        if (res) {
1028                error(command == TODO_REVERT
1029                      ? _("could not revert %s... %s")
1030                      : _("could not apply %s... %s"),
1031                      short_commit_name(commit), msg.subject);
1032                print_advice(res == 1, opts);
1033                rerere(opts->allow_rerere_auto);
1034                goto leave;
1035        }
1036
1037        allow = allow_empty(opts, commit);
1038        if (allow < 0) {
1039                res = allow;
1040                goto leave;
1041        }
1042        if (!opts->no_commit)
1043                res = run_git_commit(msg_file, opts, allow, edit, amend,
1044                                     cleanup_commit_message);
1045
1046        if (!res && final_fixup) {
1047                unlink(rebase_path_fixup_msg());
1048                unlink(rebase_path_squash_msg());
1049        }
1050
1051leave:
1052        free_message(commit, &msg);
1053        update_abort_safety_file();
1054
1055        return res;
1056}
1057
1058static int prepare_revs(struct replay_opts *opts)
1059{
1060        /*
1061         * picking (but not reverting) ranges (but not individual revisions)
1062         * should be done in reverse
1063         */
1064        if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
1065                opts->revs->reverse ^= 1;
1066
1067        if (prepare_revision_walk(opts->revs))
1068                return error(_("revision walk setup failed"));
1069
1070        if (!opts->revs->commits)
1071                return error(_("empty commit set passed"));
1072        return 0;
1073}
1074
1075static int read_and_refresh_cache(struct replay_opts *opts)
1076{
1077        static struct lock_file index_lock;
1078        int index_fd = hold_locked_index(&index_lock, 0);
1079        if (read_index_preload(&the_index, NULL) < 0) {
1080                rollback_lock_file(&index_lock);
1081                return error(_("git %s: failed to read the index"),
1082                        _(action_name(opts)));
1083        }
1084        refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
1085        if (the_index.cache_changed && index_fd >= 0) {
1086                if (write_locked_index(&the_index, &index_lock, COMMIT_LOCK)) {
1087                        rollback_lock_file(&index_lock);
1088                        return error(_("git %s: failed to refresh the index"),
1089                                _(action_name(opts)));
1090                }
1091        }
1092        rollback_lock_file(&index_lock);
1093        return 0;
1094}
1095
1096struct todo_item {
1097        enum todo_command command;
1098        struct commit *commit;
1099        const char *arg;
1100        int arg_len;
1101        size_t offset_in_buf;
1102};
1103
1104struct todo_list {
1105        struct strbuf buf;
1106        struct todo_item *items;
1107        int nr, alloc, current;
1108};
1109
1110#define TODO_LIST_INIT { STRBUF_INIT }
1111
1112static void todo_list_release(struct todo_list *todo_list)
1113{
1114        strbuf_release(&todo_list->buf);
1115        free(todo_list->items);
1116        todo_list->items = NULL;
1117        todo_list->nr = todo_list->alloc = 0;
1118}
1119
1120static struct todo_item *append_new_todo(struct todo_list *todo_list)
1121{
1122        ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
1123        return todo_list->items + todo_list->nr++;
1124}
1125
1126static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
1127{
1128        unsigned char commit_sha1[20];
1129        char *end_of_object_name;
1130        int i, saved, status, padding;
1131
1132        /* left-trim */
1133        bol += strspn(bol, " \t");
1134
1135        if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
1136                item->command = TODO_NOOP;
1137                item->commit = NULL;
1138                item->arg = bol;
1139                item->arg_len = eol - bol;
1140                return 0;
1141        }
1142
1143        for (i = 0; i < ARRAY_SIZE(todo_command_info); i++)
1144                if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
1145                        item->command = i;
1146                        break;
1147                } else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
1148                        bol++;
1149                        item->command = i;
1150                        break;
1151                }
1152        if (i >= ARRAY_SIZE(todo_command_info))
1153                return -1;
1154
1155        if (item->command == TODO_NOOP) {
1156                item->commit = NULL;
1157                item->arg = bol;
1158                item->arg_len = eol - bol;
1159                return 0;
1160        }
1161
1162        /* Eat up extra spaces/ tabs before object name */
1163        padding = strspn(bol, " \t");
1164        if (!padding)
1165                return -1;
1166        bol += padding;
1167
1168        if (item->command == TODO_EXEC) {
1169                item->arg = bol;
1170                item->arg_len = (int)(eol - bol);
1171                return 0;
1172        }
1173
1174        end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
1175        saved = *end_of_object_name;
1176        *end_of_object_name = '\0';
1177        status = get_sha1(bol, commit_sha1);
1178        *end_of_object_name = saved;
1179
1180        item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
1181        item->arg_len = (int)(eol - item->arg);
1182
1183        if (status < 0)
1184                return -1;
1185
1186        item->commit = lookup_commit_reference(commit_sha1);
1187        return !item->commit;
1188}
1189
1190static int parse_insn_buffer(char *buf, struct todo_list *todo_list)
1191{
1192        struct todo_item *item;
1193        char *p = buf, *next_p;
1194        int i, res = 0, fixup_okay = file_exists(rebase_path_done());
1195
1196        for (i = 1; *p; i++, p = next_p) {
1197                char *eol = strchrnul(p, '\n');
1198
1199                next_p = *eol ? eol + 1 /* skip LF */ : eol;
1200
1201                if (p != eol && eol[-1] == '\r')
1202                        eol--; /* strip Carriage Return */
1203
1204                item = append_new_todo(todo_list);
1205                item->offset_in_buf = p - todo_list->buf.buf;
1206                if (parse_insn_line(item, p, eol)) {
1207                        res = error(_("invalid line %d: %.*s"),
1208                                i, (int)(eol - p), p);
1209                        item->command = TODO_NOOP;
1210                }
1211
1212                if (fixup_okay)
1213                        ; /* do nothing */
1214                else if (is_fixup(item->command))
1215                        return error(_("cannot '%s' without a previous commit"),
1216                                command_to_string(item->command));
1217                else if (!is_noop(item->command))
1218                        fixup_okay = 1;
1219        }
1220
1221        return res;
1222}
1223
1224static int read_populate_todo(struct todo_list *todo_list,
1225                        struct replay_opts *opts)
1226{
1227        const char *todo_file = get_todo_path(opts);
1228        int fd, res;
1229
1230        strbuf_reset(&todo_list->buf);
1231        fd = open(todo_file, O_RDONLY);
1232        if (fd < 0)
1233                return error_errno(_("could not open '%s'"), todo_file);
1234        if (strbuf_read(&todo_list->buf, fd, 0) < 0) {
1235                close(fd);
1236                return error(_("could not read '%s'."), todo_file);
1237        }
1238        close(fd);
1239
1240        res = parse_insn_buffer(todo_list->buf.buf, todo_list);
1241        if (res)
1242                return error(_("unusable instruction sheet: '%s'"), todo_file);
1243
1244        if (!todo_list->nr &&
1245            (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
1246                return error(_("no commits parsed."));
1247
1248        if (!is_rebase_i(opts)) {
1249                enum todo_command valid =
1250                        opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
1251                int i;
1252
1253                for (i = 0; i < todo_list->nr; i++)
1254                        if (valid == todo_list->items[i].command)
1255                                continue;
1256                        else if (valid == TODO_PICK)
1257                                return error(_("cannot cherry-pick during a revert."));
1258                        else
1259                                return error(_("cannot revert during a cherry-pick."));
1260        }
1261
1262        return 0;
1263}
1264
1265static int git_config_string_dup(char **dest,
1266                                 const char *var, const char *value)
1267{
1268        if (!value)
1269                return config_error_nonbool(var);
1270        free(*dest);
1271        *dest = xstrdup(value);
1272        return 0;
1273}
1274
1275static int populate_opts_cb(const char *key, const char *value, void *data)
1276{
1277        struct replay_opts *opts = data;
1278        int error_flag = 1;
1279
1280        if (!value)
1281                error_flag = 0;
1282        else if (!strcmp(key, "options.no-commit"))
1283                opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
1284        else if (!strcmp(key, "options.edit"))
1285                opts->edit = git_config_bool_or_int(key, value, &error_flag);
1286        else if (!strcmp(key, "options.signoff"))
1287                opts->signoff = git_config_bool_or_int(key, value, &error_flag);
1288        else if (!strcmp(key, "options.record-origin"))
1289                opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
1290        else if (!strcmp(key, "options.allow-ff"))
1291                opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
1292        else if (!strcmp(key, "options.mainline"))
1293                opts->mainline = git_config_int(key, value);
1294        else if (!strcmp(key, "options.strategy"))
1295                git_config_string_dup(&opts->strategy, key, value);
1296        else if (!strcmp(key, "options.gpg-sign"))
1297                git_config_string_dup(&opts->gpg_sign, key, value);
1298        else if (!strcmp(key, "options.strategy-option")) {
1299                ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
1300                opts->xopts[opts->xopts_nr++] = xstrdup(value);
1301        } else
1302                return error(_("invalid key: %s"), key);
1303
1304        if (!error_flag)
1305                return error(_("invalid value for %s: %s"), key, value);
1306
1307        return 0;
1308}
1309
1310static int read_populate_opts(struct replay_opts *opts)
1311{
1312        if (is_rebase_i(opts)) {
1313                struct strbuf buf = STRBUF_INIT;
1314
1315                if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
1316                        if (!starts_with(buf.buf, "-S"))
1317                                strbuf_reset(&buf);
1318                        else {
1319                                free(opts->gpg_sign);
1320                                opts->gpg_sign = xstrdup(buf.buf + 2);
1321                        }
1322                }
1323                strbuf_release(&buf);
1324
1325                if (file_exists(rebase_path_verbose()))
1326                        opts->verbose = 1;
1327
1328                return 0;
1329        }
1330
1331        if (!file_exists(git_path_opts_file()))
1332                return 0;
1333        /*
1334         * The function git_parse_source(), called from git_config_from_file(),
1335         * may die() in case of a syntactically incorrect file. We do not care
1336         * about this case, though, because we wrote that file ourselves, so we
1337         * are pretty certain that it is syntactically correct.
1338         */
1339        if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
1340                return error(_("malformed options sheet: '%s'"),
1341                        git_path_opts_file());
1342        return 0;
1343}
1344
1345static int walk_revs_populate_todo(struct todo_list *todo_list,
1346                                struct replay_opts *opts)
1347{
1348        enum todo_command command = opts->action == REPLAY_PICK ?
1349                TODO_PICK : TODO_REVERT;
1350        const char *command_string = todo_command_info[command].str;
1351        struct commit *commit;
1352
1353        if (prepare_revs(opts))
1354                return -1;
1355
1356        while ((commit = get_revision(opts->revs))) {
1357                struct todo_item *item = append_new_todo(todo_list);
1358                const char *commit_buffer = get_commit_buffer(commit, NULL);
1359                const char *subject;
1360                int subject_len;
1361
1362                item->command = command;
1363                item->commit = commit;
1364                item->arg = NULL;
1365                item->arg_len = 0;
1366                item->offset_in_buf = todo_list->buf.len;
1367                subject_len = find_commit_subject(commit_buffer, &subject);
1368                strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
1369                        short_commit_name(commit), subject_len, subject);
1370                unuse_commit_buffer(commit, commit_buffer);
1371        }
1372        return 0;
1373}
1374
1375static int create_seq_dir(void)
1376{
1377        if (file_exists(git_path_seq_dir())) {
1378                error(_("a cherry-pick or revert is already in progress"));
1379                advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
1380                return -1;
1381        } else if (mkdir(git_path_seq_dir(), 0777) < 0)
1382                return error_errno(_("could not create sequencer directory '%s'"),
1383                                   git_path_seq_dir());
1384        return 0;
1385}
1386
1387static int save_head(const char *head)
1388{
1389        static struct lock_file head_lock;
1390        struct strbuf buf = STRBUF_INIT;
1391        int fd;
1392
1393        fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
1394        if (fd < 0) {
1395                rollback_lock_file(&head_lock);
1396                return error_errno(_("could not lock HEAD"));
1397        }
1398        strbuf_addf(&buf, "%s\n", head);
1399        if (write_in_full(fd, buf.buf, buf.len) < 0) {
1400                rollback_lock_file(&head_lock);
1401                return error_errno(_("could not write to '%s'"),
1402                                   git_path_head_file());
1403        }
1404        if (commit_lock_file(&head_lock) < 0) {
1405                rollback_lock_file(&head_lock);
1406                return error(_("failed to finalize '%s'."), git_path_head_file());
1407        }
1408        return 0;
1409}
1410
1411static int rollback_is_safe(void)
1412{
1413        struct strbuf sb = STRBUF_INIT;
1414        struct object_id expected_head, actual_head;
1415
1416        if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
1417                strbuf_trim(&sb);
1418                if (get_oid_hex(sb.buf, &expected_head)) {
1419                        strbuf_release(&sb);
1420                        die(_("could not parse %s"), git_path_abort_safety_file());
1421                }
1422                strbuf_release(&sb);
1423        }
1424        else if (errno == ENOENT)
1425                oidclr(&expected_head);
1426        else
1427                die_errno(_("could not read '%s'"), git_path_abort_safety_file());
1428
1429        if (get_oid("HEAD", &actual_head))
1430                oidclr(&actual_head);
1431
1432        return !oidcmp(&actual_head, &expected_head);
1433}
1434
1435static int reset_for_rollback(const unsigned char *sha1)
1436{
1437        const char *argv[4];    /* reset --merge <arg> + NULL */
1438
1439        argv[0] = "reset";
1440        argv[1] = "--merge";
1441        argv[2] = sha1_to_hex(sha1);
1442        argv[3] = NULL;
1443        return run_command_v_opt(argv, RUN_GIT_CMD);
1444}
1445
1446static int rollback_single_pick(void)
1447{
1448        unsigned char head_sha1[20];
1449
1450        if (!file_exists(git_path_cherry_pick_head()) &&
1451            !file_exists(git_path_revert_head()))
1452                return error(_("no cherry-pick or revert in progress"));
1453        if (read_ref_full("HEAD", 0, head_sha1, NULL))
1454                return error(_("cannot resolve HEAD"));
1455        if (is_null_sha1(head_sha1))
1456                return error(_("cannot abort from a branch yet to be born"));
1457        return reset_for_rollback(head_sha1);
1458}
1459
1460int sequencer_rollback(struct replay_opts *opts)
1461{
1462        FILE *f;
1463        unsigned char sha1[20];
1464        struct strbuf buf = STRBUF_INIT;
1465
1466        f = fopen(git_path_head_file(), "r");
1467        if (!f && errno == ENOENT) {
1468                /*
1469                 * There is no multiple-cherry-pick in progress.
1470                 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
1471                 * a single-cherry-pick in progress, abort that.
1472                 */
1473                return rollback_single_pick();
1474        }
1475        if (!f)
1476                return error_errno(_("cannot open '%s'"), git_path_head_file());
1477        if (strbuf_getline_lf(&buf, f)) {
1478                error(_("cannot read '%s': %s"), git_path_head_file(),
1479                      ferror(f) ?  strerror(errno) : _("unexpected end of file"));
1480                fclose(f);
1481                goto fail;
1482        }
1483        fclose(f);
1484        if (get_sha1_hex(buf.buf, sha1) || buf.buf[40] != '\0') {
1485                error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
1486                        git_path_head_file());
1487                goto fail;
1488        }
1489        if (is_null_sha1(sha1)) {
1490                error(_("cannot abort from a branch yet to be born"));
1491                goto fail;
1492        }
1493
1494        if (!rollback_is_safe()) {
1495                /* Do not error, just do not rollback */
1496                warning(_("You seem to have moved HEAD. "
1497                          "Not rewinding, check your HEAD!"));
1498        } else
1499        if (reset_for_rollback(sha1))
1500                goto fail;
1501        strbuf_release(&buf);
1502        return sequencer_remove_state(opts);
1503fail:
1504        strbuf_release(&buf);
1505        return -1;
1506}
1507
1508static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
1509{
1510        static struct lock_file todo_lock;
1511        const char *todo_path = get_todo_path(opts);
1512        int next = todo_list->current, offset, fd;
1513
1514        /*
1515         * rebase -i writes "git-rebase-todo" without the currently executing
1516         * command, appending it to "done" instead.
1517         */
1518        if (is_rebase_i(opts))
1519                next++;
1520
1521        fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
1522        if (fd < 0)
1523                return error_errno(_("could not lock '%s'"), todo_path);
1524        offset = next < todo_list->nr ?
1525                todo_list->items[next].offset_in_buf : todo_list->buf.len;
1526        if (write_in_full(fd, todo_list->buf.buf + offset,
1527                        todo_list->buf.len - offset) < 0)
1528                return error_errno(_("could not write to '%s'"), todo_path);
1529        if (commit_lock_file(&todo_lock) < 0)
1530                return error(_("failed to finalize '%s'."), todo_path);
1531
1532        if (is_rebase_i(opts)) {
1533                const char *done_path = rebase_path_done();
1534                int fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
1535                int prev_offset = !next ? 0 :
1536                        todo_list->items[next - 1].offset_in_buf;
1537
1538                if (fd >= 0 && offset > prev_offset &&
1539                    write_in_full(fd, todo_list->buf.buf + prev_offset,
1540                                  offset - prev_offset) < 0) {
1541                        close(fd);
1542                        return error_errno(_("could not write to '%s'"),
1543                                           done_path);
1544                }
1545                if (fd >= 0)
1546                        close(fd);
1547        }
1548        return 0;
1549}
1550
1551static int save_opts(struct replay_opts *opts)
1552{
1553        const char *opts_file = git_path_opts_file();
1554        int res = 0;
1555
1556        if (opts->no_commit)
1557                res |= git_config_set_in_file_gently(opts_file, "options.no-commit", "true");
1558        if (opts->edit)
1559                res |= git_config_set_in_file_gently(opts_file, "options.edit", "true");
1560        if (opts->signoff)
1561                res |= git_config_set_in_file_gently(opts_file, "options.signoff", "true");
1562        if (opts->record_origin)
1563                res |= git_config_set_in_file_gently(opts_file, "options.record-origin", "true");
1564        if (opts->allow_ff)
1565                res |= git_config_set_in_file_gently(opts_file, "options.allow-ff", "true");
1566        if (opts->mainline) {
1567                struct strbuf buf = STRBUF_INIT;
1568                strbuf_addf(&buf, "%d", opts->mainline);
1569                res |= git_config_set_in_file_gently(opts_file, "options.mainline", buf.buf);
1570                strbuf_release(&buf);
1571        }
1572        if (opts->strategy)
1573                res |= git_config_set_in_file_gently(opts_file, "options.strategy", opts->strategy);
1574        if (opts->gpg_sign)
1575                res |= git_config_set_in_file_gently(opts_file, "options.gpg-sign", opts->gpg_sign);
1576        if (opts->xopts) {
1577                int i;
1578                for (i = 0; i < opts->xopts_nr; i++)
1579                        res |= git_config_set_multivar_in_file_gently(opts_file,
1580                                                        "options.strategy-option",
1581                                                        opts->xopts[i], "^$", 0);
1582        }
1583        return res;
1584}
1585
1586static int make_patch(struct commit *commit, struct replay_opts *opts)
1587{
1588        struct strbuf buf = STRBUF_INIT;
1589        struct rev_info log_tree_opt;
1590        const char *subject, *p;
1591        int res = 0;
1592
1593        p = short_commit_name(commit);
1594        if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
1595                return -1;
1596
1597        strbuf_addf(&buf, "%s/patch", get_dir(opts));
1598        memset(&log_tree_opt, 0, sizeof(log_tree_opt));
1599        init_revisions(&log_tree_opt, NULL);
1600        log_tree_opt.abbrev = 0;
1601        log_tree_opt.diff = 1;
1602        log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
1603        log_tree_opt.disable_stdin = 1;
1604        log_tree_opt.no_commit_id = 1;
1605        log_tree_opt.diffopt.file = fopen(buf.buf, "w");
1606        log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
1607        if (!log_tree_opt.diffopt.file)
1608                res |= error_errno(_("could not open '%s'"), buf.buf);
1609        else {
1610                res |= log_tree_commit(&log_tree_opt, commit);
1611                fclose(log_tree_opt.diffopt.file);
1612        }
1613        strbuf_reset(&buf);
1614
1615        strbuf_addf(&buf, "%s/message", get_dir(opts));
1616        if (!file_exists(buf.buf)) {
1617                const char *commit_buffer = get_commit_buffer(commit, NULL);
1618                find_commit_subject(commit_buffer, &subject);
1619                res |= write_message(subject, strlen(subject), buf.buf, 1);
1620                unuse_commit_buffer(commit, commit_buffer);
1621        }
1622        strbuf_release(&buf);
1623
1624        return res;
1625}
1626
1627static int intend_to_amend(void)
1628{
1629        unsigned char head[20];
1630        char *p;
1631
1632        if (get_sha1("HEAD", head))
1633                return error(_("cannot read HEAD"));
1634
1635        p = sha1_to_hex(head);
1636        return write_message(p, strlen(p), rebase_path_amend(), 1);
1637}
1638
1639static int error_with_patch(struct commit *commit,
1640        const char *subject, int subject_len,
1641        struct replay_opts *opts, int exit_code, int to_amend)
1642{
1643        if (make_patch(commit, opts))
1644                return -1;
1645
1646        if (to_amend) {
1647                if (intend_to_amend())
1648                        return -1;
1649
1650                fprintf(stderr, "You can amend the commit now, with\n"
1651                        "\n"
1652                        "  git commit --amend %s\n"
1653                        "\n"
1654                        "Once you are satisfied with your changes, run\n"
1655                        "\n"
1656                        "  git rebase --continue\n", gpg_sign_opt_quoted(opts));
1657        } else if (exit_code)
1658                fprintf(stderr, "Could not apply %s... %.*s\n",
1659                        short_commit_name(commit), subject_len, subject);
1660
1661        return exit_code;
1662}
1663
1664static int error_failed_squash(struct commit *commit,
1665        struct replay_opts *opts, int subject_len, const char *subject)
1666{
1667        if (rename(rebase_path_squash_msg(), rebase_path_message()))
1668                return error(_("could not rename '%s' to '%s'"),
1669                        rebase_path_squash_msg(), rebase_path_message());
1670        unlink(rebase_path_fixup_msg());
1671        unlink(git_path("MERGE_MSG"));
1672        if (copy_file(git_path("MERGE_MSG"), rebase_path_message(), 0666))
1673                return error(_("could not copy '%s' to '%s'"),
1674                             rebase_path_message(), git_path("MERGE_MSG"));
1675        return error_with_patch(commit, subject, subject_len, opts, 1, 0);
1676}
1677
1678static int do_exec(const char *command_line)
1679{
1680        const char *child_argv[] = { NULL, NULL };
1681        int dirty, status;
1682
1683        fprintf(stderr, "Executing: %s\n", command_line);
1684        child_argv[0] = command_line;
1685        status = run_command_v_opt(child_argv, RUN_USING_SHELL);
1686
1687        /* force re-reading of the cache */
1688        if (discard_cache() < 0 || read_cache() < 0)
1689                return error(_("could not read index"));
1690
1691        dirty = require_clean_work_tree("rebase", NULL, 1, 1);
1692
1693        if (status) {
1694                warning(_("execution failed: %s\n%s"
1695                          "You can fix the problem, and then run\n"
1696                          "\n"
1697                          "  git rebase --continue\n"
1698                          "\n"),
1699                        command_line,
1700                        dirty ? N_("and made changes to the index and/or the "
1701                                "working tree\n") : "");
1702                if (status == 127)
1703                        /* command not found */
1704                        status = 1;
1705        } else if (dirty) {
1706                warning(_("execution succeeded: %s\nbut "
1707                          "left changes to the index and/or the working tree\n"
1708                          "Commit or stash your changes, and then run\n"
1709                          "\n"
1710                          "  git rebase --continue\n"
1711                          "\n"), command_line);
1712                status = 1;
1713        }
1714
1715        return status;
1716}
1717
1718static int is_final_fixup(struct todo_list *todo_list)
1719{
1720        int i = todo_list->current;
1721
1722        if (!is_fixup(todo_list->items[i].command))
1723                return 0;
1724
1725        while (++i < todo_list->nr)
1726                if (is_fixup(todo_list->items[i].command))
1727                        return 0;
1728                else if (!is_noop(todo_list->items[i].command))
1729                        break;
1730        return 1;
1731}
1732
1733static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
1734{
1735        int res = 0;
1736
1737        setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
1738        if (opts->allow_ff)
1739                assert(!(opts->signoff || opts->no_commit ||
1740                                opts->record_origin || opts->edit));
1741        if (read_and_refresh_cache(opts))
1742                return -1;
1743
1744        while (todo_list->current < todo_list->nr) {
1745                struct todo_item *item = todo_list->items + todo_list->current;
1746                if (save_todo(todo_list, opts))
1747                        return -1;
1748                if (is_rebase_i(opts)) {
1749                        unlink(rebase_path_message());
1750                        unlink(rebase_path_author_script());
1751                        unlink(rebase_path_stopped_sha());
1752                        unlink(rebase_path_amend());
1753                }
1754                if (item->command <= TODO_SQUASH) {
1755                        res = do_pick_commit(item->command, item->commit,
1756                                        opts, is_final_fixup(todo_list));
1757                        if (item->command == TODO_EDIT) {
1758                                struct commit *commit = item->commit;
1759                                if (!res)
1760                                        warning(_("stopped at %s... %.*s"),
1761                                                short_commit_name(commit),
1762                                                item->arg_len, item->arg);
1763                                return error_with_patch(commit,
1764                                        item->arg, item->arg_len, opts, res,
1765                                        !res);
1766                        }
1767                        if (res && is_fixup(item->command)) {
1768                                if (res == 1)
1769                                        intend_to_amend();
1770                                return error_failed_squash(item->commit, opts,
1771                                        item->arg_len, item->arg);
1772                        }
1773                } else if (item->command == TODO_EXEC) {
1774                        char *end_of_arg = (char *)(item->arg + item->arg_len);
1775                        int saved = *end_of_arg;
1776
1777                        *end_of_arg = '\0';
1778                        res = do_exec(item->arg);
1779                        *end_of_arg = saved;
1780                } else if (!is_noop(item->command))
1781                        return error(_("unknown command %d"), item->command);
1782
1783                todo_list->current++;
1784                if (res)
1785                        return res;
1786        }
1787
1788        if (is_rebase_i(opts)) {
1789                struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
1790
1791                /* Stopped in the middle, as planned? */
1792                if (todo_list->current < todo_list->nr)
1793                        return 0;
1794
1795                if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
1796                                starts_with(head_ref.buf, "refs/")) {
1797                        unsigned char head[20], orig[20];
1798                        int res;
1799
1800                        if (get_sha1("HEAD", head)) {
1801                                res = error(_("cannot read HEAD"));
1802cleanup_head_ref:
1803                                strbuf_release(&head_ref);
1804                                strbuf_release(&buf);
1805                                return res;
1806                        }
1807                        if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
1808                                        get_sha1_hex(buf.buf, orig)) {
1809                                res = error(_("could not read orig-head"));
1810                                goto cleanup_head_ref;
1811                        }
1812                        strbuf_addf(&buf, "rebase -i (finish): %s onto ",
1813                                head_ref.buf);
1814                        if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
1815                                res = error(_("could not read 'onto'"));
1816                                goto cleanup_head_ref;
1817                        }
1818                        if (update_ref(buf.buf, head_ref.buf, head, orig,
1819                                        REF_NODEREF, UPDATE_REFS_MSG_ON_ERR)) {
1820                                res = error(_("could not update %s"),
1821                                        head_ref.buf);
1822                                goto cleanup_head_ref;
1823                        }
1824                        strbuf_reset(&buf);
1825                        strbuf_addf(&buf,
1826                                "rebase -i (finish): returning to %s",
1827                                head_ref.buf);
1828                        if (create_symref("HEAD", head_ref.buf, buf.buf)) {
1829                                res = error(_("could not update HEAD to %s"),
1830                                        head_ref.buf);
1831                                goto cleanup_head_ref;
1832                        }
1833                        strbuf_reset(&buf);
1834                }
1835
1836                if (opts->verbose) {
1837                        struct rev_info log_tree_opt;
1838                        struct object_id orig, head;
1839
1840                        memset(&log_tree_opt, 0, sizeof(log_tree_opt));
1841                        init_revisions(&log_tree_opt, NULL);
1842                        log_tree_opt.diff = 1;
1843                        log_tree_opt.diffopt.output_format =
1844                                DIFF_FORMAT_DIFFSTAT;
1845                        log_tree_opt.disable_stdin = 1;
1846
1847                        if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
1848                            !get_sha1(buf.buf, orig.hash) &&
1849                            !get_sha1("HEAD", head.hash)) {
1850                                diff_tree_sha1(orig.hash, head.hash,
1851                                               "", &log_tree_opt.diffopt);
1852                                log_tree_diff_flush(&log_tree_opt);
1853                        }
1854                }
1855                strbuf_release(&buf);
1856                strbuf_release(&head_ref);
1857        }
1858
1859        /*
1860         * Sequence of picks finished successfully; cleanup by
1861         * removing the .git/sequencer directory
1862         */
1863        return sequencer_remove_state(opts);
1864}
1865
1866static int continue_single_pick(void)
1867{
1868        const char *argv[] = { "commit", NULL };
1869
1870        if (!file_exists(git_path_cherry_pick_head()) &&
1871            !file_exists(git_path_revert_head()))
1872                return error(_("no cherry-pick or revert in progress"));
1873        return run_command_v_opt(argv, RUN_GIT_CMD);
1874}
1875
1876static int commit_staged_changes(struct replay_opts *opts)
1877{
1878        int amend = 0;
1879
1880        if (has_unstaged_changes(1))
1881                return error(_("cannot rebase: You have unstaged changes."));
1882        if (!has_uncommitted_changes(0)) {
1883                const char *cherry_pick_head = git_path("CHERRY_PICK_HEAD");
1884
1885                if (file_exists(cherry_pick_head) && unlink(cherry_pick_head))
1886                        return error(_("could not remove CHERRY_PICK_HEAD"));
1887                return 0;
1888        }
1889
1890        if (file_exists(rebase_path_amend())) {
1891                struct strbuf rev = STRBUF_INIT;
1892                unsigned char head[20], to_amend[20];
1893
1894                if (get_sha1("HEAD", head))
1895                        return error(_("cannot amend non-existing commit"));
1896                if (!read_oneliner(&rev, rebase_path_amend(), 0))
1897                        return error(_("invalid file: '%s'"), rebase_path_amend());
1898                if (get_sha1_hex(rev.buf, to_amend))
1899                        return error(_("invalid contents: '%s'"),
1900                                rebase_path_amend());
1901                if (hashcmp(head, to_amend))
1902                        return error(_("\nYou have uncommitted changes in your "
1903                                       "working tree. Please, commit them\n"
1904                                       "first and then run 'git rebase "
1905                                       "--continue' again."));
1906
1907                strbuf_release(&rev);
1908                amend = 1;
1909        }
1910
1911        if (run_git_commit(rebase_path_message(), opts, 1, 1, amend, 0))
1912                return error(_("could not commit staged changes."));
1913        unlink(rebase_path_amend());
1914        return 0;
1915}
1916
1917int sequencer_continue(struct replay_opts *opts)
1918{
1919        struct todo_list todo_list = TODO_LIST_INIT;
1920        int res;
1921
1922        if (read_and_refresh_cache(opts))
1923                return -1;
1924
1925        if (is_rebase_i(opts)) {
1926                if (commit_staged_changes(opts))
1927                        return -1;
1928        } else if (!file_exists(get_todo_path(opts)))
1929                return continue_single_pick();
1930        if (read_populate_opts(opts))
1931                return -1;
1932        if ((res = read_populate_todo(&todo_list, opts)))
1933                goto release_todo_list;
1934
1935        if (!is_rebase_i(opts)) {
1936                /* Verify that the conflict has been resolved */
1937                if (file_exists(git_path_cherry_pick_head()) ||
1938                    file_exists(git_path_revert_head())) {
1939                        res = continue_single_pick();
1940                        if (res)
1941                                goto release_todo_list;
1942                }
1943                if (index_differs_from("HEAD", 0, 0)) {
1944                        res = error_dirty_index(opts);
1945                        goto release_todo_list;
1946                }
1947                todo_list.current++;
1948        }
1949
1950        res = pick_commits(&todo_list, opts);
1951release_todo_list:
1952        todo_list_release(&todo_list);
1953        return res;
1954}
1955
1956static int single_pick(struct commit *cmit, struct replay_opts *opts)
1957{
1958        setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
1959        return do_pick_commit(opts->action == REPLAY_PICK ?
1960                TODO_PICK : TODO_REVERT, cmit, opts, 0);
1961}
1962
1963int sequencer_pick_revisions(struct replay_opts *opts)
1964{
1965        struct todo_list todo_list = TODO_LIST_INIT;
1966        unsigned char sha1[20];
1967        int i, res;
1968
1969        assert(opts->revs);
1970        if (read_and_refresh_cache(opts))
1971                return -1;
1972
1973        for (i = 0; i < opts->revs->pending.nr; i++) {
1974                unsigned char sha1[20];
1975                const char *name = opts->revs->pending.objects[i].name;
1976
1977                /* This happens when using --stdin. */
1978                if (!strlen(name))
1979                        continue;
1980
1981                if (!get_sha1(name, sha1)) {
1982                        if (!lookup_commit_reference_gently(sha1, 1)) {
1983                                enum object_type type = sha1_object_info(sha1, NULL);
1984                                return error(_("%s: can't cherry-pick a %s"),
1985                                        name, typename(type));
1986                        }
1987                } else
1988                        return error(_("%s: bad revision"), name);
1989        }
1990
1991        /*
1992         * If we were called as "git cherry-pick <commit>", just
1993         * cherry-pick/revert it, set CHERRY_PICK_HEAD /
1994         * REVERT_HEAD, and don't touch the sequencer state.
1995         * This means it is possible to cherry-pick in the middle
1996         * of a cherry-pick sequence.
1997         */
1998        if (opts->revs->cmdline.nr == 1 &&
1999            opts->revs->cmdline.rev->whence == REV_CMD_REV &&
2000            opts->revs->no_walk &&
2001            !opts->revs->cmdline.rev->flags) {
2002                struct commit *cmit;
2003                if (prepare_revision_walk(opts->revs))
2004                        return error(_("revision walk setup failed"));
2005                cmit = get_revision(opts->revs);
2006                if (!cmit || get_revision(opts->revs))
2007                        return error("BUG: expected exactly one commit from walk");
2008                return single_pick(cmit, opts);
2009        }
2010
2011        /*
2012         * Start a new cherry-pick/ revert sequence; but
2013         * first, make sure that an existing one isn't in
2014         * progress
2015         */
2016
2017        if (walk_revs_populate_todo(&todo_list, opts) ||
2018                        create_seq_dir() < 0)
2019                return -1;
2020        if (get_sha1("HEAD", sha1) && (opts->action == REPLAY_REVERT))
2021                return error(_("can't revert as initial commit"));
2022        if (save_head(sha1_to_hex(sha1)))
2023                return -1;
2024        if (save_opts(opts))
2025                return -1;
2026        update_abort_safety_file();
2027        res = pick_commits(&todo_list, opts);
2028        todo_list_release(&todo_list);
2029        return res;
2030}
2031
2032void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag)
2033{
2034        unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
2035        struct strbuf sob = STRBUF_INIT;
2036        int has_footer;
2037
2038        strbuf_addstr(&sob, sign_off_header);
2039        strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
2040                                getenv("GIT_COMMITTER_EMAIL")));
2041        strbuf_addch(&sob, '\n');
2042
2043        /*
2044         * If the whole message buffer is equal to the sob, pretend that we
2045         * found a conforming footer with a matching sob
2046         */
2047        if (msgbuf->len - ignore_footer == sob.len &&
2048            !strncmp(msgbuf->buf, sob.buf, sob.len))
2049                has_footer = 3;
2050        else
2051                has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
2052
2053        if (!has_footer) {
2054                const char *append_newlines = NULL;
2055                size_t len = msgbuf->len - ignore_footer;
2056
2057                if (!len) {
2058                        /*
2059                         * The buffer is completely empty.  Leave foom for
2060                         * the title and body to be filled in by the user.
2061                         */
2062                        append_newlines = "\n\n";
2063                } else if (msgbuf->buf[len - 1] != '\n') {
2064                        /*
2065                         * Incomplete line.  Complete the line and add a
2066                         * blank one so that there is an empty line between
2067                         * the message body and the sob.
2068                         */
2069                        append_newlines = "\n\n";
2070                } else if (len == 1) {
2071                        /*
2072                         * Buffer contains a single newline.  Add another
2073                         * so that we leave room for the title and body.
2074                         */
2075                        append_newlines = "\n";
2076                } else if (msgbuf->buf[len - 2] != '\n') {
2077                        /*
2078                         * Buffer ends with a single newline.  Add another
2079                         * so that there is an empty line between the message
2080                         * body and the sob.
2081                         */
2082                        append_newlines = "\n";
2083                } /* else, the buffer already ends with two newlines. */
2084
2085                if (append_newlines)
2086                        strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2087                                append_newlines, strlen(append_newlines));
2088        }
2089
2090        if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
2091                strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2092                                sob.buf, sob.len);
2093
2094        strbuf_release(&sob);
2095}