Merge tag 'v2.14.1'
[git/raj.git] / sequencer.c
blob3010faf86398697469e903318a35421d911acb23
1 #include "cache.h"
2 #include "config.h"
3 #include "lockfile.h"
4 #include "sequencer.h"
5 #include "dir.h"
6 #include "object.h"
7 #include "commit.h"
8 #include "tag.h"
9 #include "run-command.h"
10 #include "exec_cmd.h"
11 #include "utf8.h"
12 #include "cache-tree.h"
13 #include "diff.h"
14 #include "revision.h"
15 #include "rerere.h"
16 #include "merge-recursive.h"
17 #include "refs.h"
18 #include "argv-array.h"
19 #include "quote.h"
20 #include "trailer.h"
21 #include "log-tree.h"
22 #include "wt-status.h"
24 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
26 const char sign_off_header[] = "Signed-off-by: ";
27 static const char cherry_picked_prefix[] = "(cherry picked from commit ";
29 GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
31 static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
32 static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
33 static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
34 static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
36 static GIT_PATH_FUNC(rebase_path, "rebase-merge")
38 * The file containing rebase commands, comments, and empty lines.
39 * This file is created by "git rebase -i" then edited by the user. As
40 * the lines are processed, they are removed from the front of this
41 * file and written to the tail of 'done'.
43 static GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
45 * The rebase command lines that have already been processed. A line
46 * is moved here when it is first handled, before any associated user
47 * actions.
49 static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
51 * The file to keep track of how many commands were already processed (e.g.
52 * for the prompt).
54 static GIT_PATH_FUNC(rebase_path_msgnum, "rebase-merge/msgnum");
56 * The file to keep track of how many commands are to be processed in total
57 * (e.g. for the prompt).
59 static GIT_PATH_FUNC(rebase_path_msgtotal, "rebase-merge/end");
61 * The commit message that is planned to be used for any changes that
62 * need to be committed following a user interaction.
64 static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
66 * The file into which is accumulated the suggested commit message for
67 * squash/fixup commands. When the first of a series of squash/fixups
68 * is seen, the file is created and the commit message from the
69 * previous commit and from the first squash/fixup commit are written
70 * to it. The commit message for each subsequent squash/fixup commit
71 * is appended to the file as it is processed.
73 * The first line of the file is of the form
74 * # This is a combination of $count commits.
75 * where $count is the number of commits whose messages have been
76 * written to the file so far (including the initial "pick" commit).
77 * Each time that a commit message is processed, this line is read and
78 * updated. It is deleted just before the combined commit is made.
80 static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
82 * If the current series of squash/fixups has not yet included a squash
83 * command, then this file exists and holds the commit message of the
84 * original "pick" commit. (If the series ends without a "squash"
85 * command, then this can be used as the commit message of the combined
86 * commit without opening the editor.)
88 static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
90 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
91 * GIT_AUTHOR_DATE that will be used for the commit that is currently
92 * being rebased.
94 static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
96 * When an "edit" rebase command is being processed, the SHA1 of the
97 * commit to be edited is recorded in this file. When "git rebase
98 * --continue" is executed, if there are any staged changes then they
99 * will be amended to the HEAD commit, but only provided the HEAD
100 * commit is still the commit to be edited. When any other rebase
101 * command is processed, this file is deleted.
103 static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
105 * When we stop at a given patch via the "edit" command, this file contains
106 * the abbreviated commit name of the corresponding patch.
108 static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
110 * For the post-rewrite hook, we make a list of rewritten commits and
111 * their new sha1s. The rewritten-pending list keeps the sha1s of
112 * commits that have been processed, but not committed yet,
113 * e.g. because they are waiting for a 'squash' command.
115 static GIT_PATH_FUNC(rebase_path_rewritten_list, "rebase-merge/rewritten-list")
116 static GIT_PATH_FUNC(rebase_path_rewritten_pending,
117 "rebase-merge/rewritten-pending")
119 * The following files are written by git-rebase just after parsing the
120 * command-line (and are only consumed, not modified, by the sequencer).
122 static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
123 static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
124 static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
125 static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
126 static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
127 static GIT_PATH_FUNC(rebase_path_autostash, "rebase-merge/autostash")
128 static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy")
129 static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts")
131 static inline int is_rebase_i(const struct replay_opts *opts)
133 return opts->action == REPLAY_INTERACTIVE_REBASE;
136 static const char *get_dir(const struct replay_opts *opts)
138 if (is_rebase_i(opts))
139 return rebase_path();
140 return git_path_seq_dir();
143 static const char *get_todo_path(const struct replay_opts *opts)
145 if (is_rebase_i(opts))
146 return rebase_path_todo();
147 return git_path_todo_file();
151 * Returns 0 for non-conforming footer
152 * Returns 1 for conforming footer
153 * Returns 2 when sob exists within conforming footer
154 * Returns 3 when sob exists within conforming footer as last entry
156 static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
157 int ignore_footer)
159 struct trailer_info info;
160 int i;
161 int found_sob = 0, found_sob_last = 0;
163 trailer_info_get(&info, sb->buf);
165 if (info.trailer_start == info.trailer_end)
166 return 0;
168 for (i = 0; i < info.trailer_nr; i++)
169 if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
170 found_sob = 1;
171 if (i == info.trailer_nr - 1)
172 found_sob_last = 1;
175 trailer_info_release(&info);
177 if (found_sob_last)
178 return 3;
179 if (found_sob)
180 return 2;
181 return 1;
184 static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
186 static struct strbuf buf = STRBUF_INIT;
188 strbuf_reset(&buf);
189 if (opts->gpg_sign)
190 sq_quotef(&buf, "-S%s", opts->gpg_sign);
191 return buf.buf;
194 int sequencer_remove_state(struct replay_opts *opts)
196 struct strbuf dir = STRBUF_INIT;
197 int i;
199 free(opts->gpg_sign);
200 free(opts->strategy);
201 for (i = 0; i < opts->xopts_nr; i++)
202 free(opts->xopts[i]);
203 free(opts->xopts);
205 strbuf_addf(&dir, "%s", get_dir(opts));
206 remove_dir_recursively(&dir, 0);
207 strbuf_release(&dir);
209 return 0;
212 static const char *action_name(const struct replay_opts *opts)
214 switch (opts->action) {
215 case REPLAY_REVERT:
216 return N_("revert");
217 case REPLAY_PICK:
218 return N_("cherry-pick");
219 case REPLAY_INTERACTIVE_REBASE:
220 return N_("rebase -i");
222 die(_("Unknown action: %d"), opts->action);
225 struct commit_message {
226 char *parent_label;
227 char *label;
228 char *subject;
229 const char *message;
232 static const char *short_commit_name(struct commit *commit)
234 return find_unique_abbrev(commit->object.oid.hash, DEFAULT_ABBREV);
237 static int get_message(struct commit *commit, struct commit_message *out)
239 const char *abbrev, *subject;
240 int subject_len;
242 out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
243 abbrev = short_commit_name(commit);
245 subject_len = find_commit_subject(out->message, &subject);
247 out->subject = xmemdupz(subject, subject_len);
248 out->label = xstrfmt("%s... %s", abbrev, out->subject);
249 out->parent_label = xstrfmt("parent of %s", out->label);
251 return 0;
254 static void free_message(struct commit *commit, struct commit_message *msg)
256 free(msg->parent_label);
257 free(msg->label);
258 free(msg->subject);
259 unuse_commit_buffer(commit, msg->message);
262 static void print_advice(int show_hint, struct replay_opts *opts)
264 char *msg = getenv("GIT_CHERRY_PICK_HELP");
266 if (msg) {
267 fprintf(stderr, "%s\n", msg);
269 * A conflict has occurred but the porcelain
270 * (typically rebase --interactive) wants to take care
271 * of the commit itself so remove CHERRY_PICK_HEAD
273 unlink(git_path_cherry_pick_head());
274 return;
277 if (show_hint) {
278 if (opts->no_commit)
279 advise(_("after resolving the conflicts, mark the corrected paths\n"
280 "with 'git add <paths>' or 'git rm <paths>'"));
281 else
282 advise(_("after resolving the conflicts, mark the corrected paths\n"
283 "with 'git add <paths>' or 'git rm <paths>'\n"
284 "and commit the result with 'git commit'"));
288 static int write_message(const void *buf, size_t len, const char *filename,
289 int append_eol)
291 static struct lock_file msg_file;
293 int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
294 if (msg_fd < 0)
295 return error_errno(_("could not lock '%s'"), filename);
296 if (write_in_full(msg_fd, buf, len) < 0) {
297 rollback_lock_file(&msg_file);
298 return error_errno(_("could not write to '%s'"), filename);
300 if (append_eol && write(msg_fd, "\n", 1) < 0) {
301 rollback_lock_file(&msg_file);
302 return error_errno(_("could not write eol to '%s'"), filename);
304 if (commit_lock_file(&msg_file) < 0) {
305 rollback_lock_file(&msg_file);
306 return error(_("failed to finalize '%s'."), filename);
309 return 0;
313 * Reads a file that was presumably written by a shell script, i.e. with an
314 * end-of-line marker that needs to be stripped.
316 * Note that only the last end-of-line marker is stripped, consistent with the
317 * behavior of "$(cat path)" in a shell script.
319 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
321 static int read_oneliner(struct strbuf *buf,
322 const char *path, int skip_if_empty)
324 int orig_len = buf->len;
326 if (!file_exists(path))
327 return 0;
329 if (strbuf_read_file(buf, path, 0) < 0) {
330 warning_errno(_("could not read '%s'"), path);
331 return 0;
334 if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
335 if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
336 --buf->len;
337 buf->buf[buf->len] = '\0';
340 if (skip_if_empty && buf->len == orig_len)
341 return 0;
343 return 1;
346 static struct tree *empty_tree(void)
348 return lookup_tree(&empty_tree_oid);
351 static int error_dirty_index(struct replay_opts *opts)
353 if (read_cache_unmerged())
354 return error_resolve_conflict(_(action_name(opts)));
356 error(_("your local changes would be overwritten by %s."),
357 _(action_name(opts)));
359 if (advice_commit_before_merge)
360 advise(_("commit your changes or stash them to proceed."));
361 return -1;
364 static void update_abort_safety_file(void)
366 struct object_id head;
368 /* Do nothing on a single-pick */
369 if (!file_exists(git_path_seq_dir()))
370 return;
372 if (!get_oid("HEAD", &head))
373 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
374 else
375 write_file(git_path_abort_safety_file(), "%s", "");
378 static int fast_forward_to(const struct object_id *to, const struct object_id *from,
379 int unborn, struct replay_opts *opts)
381 struct ref_transaction *transaction;
382 struct strbuf sb = STRBUF_INIT;
383 struct strbuf err = STRBUF_INIT;
385 read_cache();
386 if (checkout_fast_forward(from, to, 1))
387 return -1; /* the callee should have complained already */
389 strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
391 transaction = ref_transaction_begin(&err);
392 if (!transaction ||
393 ref_transaction_update(transaction, "HEAD",
394 to->hash, unborn ? null_sha1 : from->hash,
395 0, sb.buf, &err) ||
396 ref_transaction_commit(transaction, &err)) {
397 ref_transaction_free(transaction);
398 error("%s", err.buf);
399 strbuf_release(&sb);
400 strbuf_release(&err);
401 return -1;
404 strbuf_release(&sb);
405 strbuf_release(&err);
406 ref_transaction_free(transaction);
407 update_abort_safety_file();
408 return 0;
411 void append_conflicts_hint(struct strbuf *msgbuf)
413 int i;
415 strbuf_addch(msgbuf, '\n');
416 strbuf_commented_addf(msgbuf, "Conflicts:\n");
417 for (i = 0; i < active_nr;) {
418 const struct cache_entry *ce = active_cache[i++];
419 if (ce_stage(ce)) {
420 strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
421 while (i < active_nr && !strcmp(ce->name,
422 active_cache[i]->name))
423 i++;
428 static int do_recursive_merge(struct commit *base, struct commit *next,
429 const char *base_label, const char *next_label,
430 struct object_id *head, struct strbuf *msgbuf,
431 struct replay_opts *opts)
433 struct merge_options o;
434 struct tree *result, *next_tree, *base_tree, *head_tree;
435 int clean;
436 char **xopt;
437 static struct lock_file index_lock;
439 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
441 read_cache();
443 init_merge_options(&o);
444 o.ancestor = base ? base_label : "(empty tree)";
445 o.branch1 = "HEAD";
446 o.branch2 = next ? next_label : "(empty tree)";
447 if (is_rebase_i(opts))
448 o.buffer_output = 2;
450 head_tree = parse_tree_indirect(head);
451 next_tree = next ? next->tree : empty_tree();
452 base_tree = base ? base->tree : empty_tree();
454 for (xopt = opts->xopts; xopt != opts->xopts + opts->xopts_nr; xopt++)
455 parse_merge_opt(&o, *xopt);
457 clean = merge_trees(&o,
458 head_tree,
459 next_tree, base_tree, &result);
460 if (is_rebase_i(opts) && clean <= 0)
461 fputs(o.obuf.buf, stdout);
462 strbuf_release(&o.obuf);
463 if (clean < 0)
464 return clean;
466 if (active_cache_changed &&
467 write_locked_index(&the_index, &index_lock, COMMIT_LOCK))
469 * TRANSLATORS: %s will be "revert", "cherry-pick" or
470 * "rebase -i".
472 return error(_("%s: Unable to write new index file"),
473 _(action_name(opts)));
474 rollback_lock_file(&index_lock);
476 if (opts->signoff)
477 append_signoff(msgbuf, 0, 0);
479 if (!clean)
480 append_conflicts_hint(msgbuf);
482 return !clean;
485 static int is_index_unchanged(void)
487 struct object_id head_oid;
488 struct commit *head_commit;
490 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, head_oid.hash, NULL))
491 return error(_("could not resolve HEAD commit\n"));
493 head_commit = lookup_commit(&head_oid);
496 * If head_commit is NULL, check_commit, called from
497 * lookup_commit, would have indicated that head_commit is not
498 * a commit object already. parse_commit() will return failure
499 * without further complaints in such a case. Otherwise, if
500 * the commit is invalid, parse_commit() will complain. So
501 * there is nothing for us to say here. Just return failure.
503 if (parse_commit(head_commit))
504 return -1;
506 if (!active_cache_tree)
507 active_cache_tree = cache_tree();
509 if (!cache_tree_fully_valid(active_cache_tree))
510 if (cache_tree_update(&the_index, 0))
511 return error(_("unable to update cache tree\n"));
513 return !oidcmp(&active_cache_tree->oid,
514 &head_commit->tree->object.oid);
517 static int write_author_script(const char *message)
519 struct strbuf buf = STRBUF_INIT;
520 const char *eol;
521 int res;
523 for (;;)
524 if (!*message || starts_with(message, "\n")) {
525 missing_author:
526 /* Missing 'author' line? */
527 unlink(rebase_path_author_script());
528 return 0;
529 } else if (skip_prefix(message, "author ", &message))
530 break;
531 else if ((eol = strchr(message, '\n')))
532 message = eol + 1;
533 else
534 goto missing_author;
536 strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
537 while (*message && *message != '\n' && *message != '\r')
538 if (skip_prefix(message, " <", &message))
539 break;
540 else if (*message != '\'')
541 strbuf_addch(&buf, *(message++));
542 else
543 strbuf_addf(&buf, "'\\\\%c'", *(message++));
544 strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
545 while (*message && *message != '\n' && *message != '\r')
546 if (skip_prefix(message, "> ", &message))
547 break;
548 else if (*message != '\'')
549 strbuf_addch(&buf, *(message++));
550 else
551 strbuf_addf(&buf, "'\\\\%c'", *(message++));
552 strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
553 while (*message && *message != '\n' && *message != '\r')
554 if (*message != '\'')
555 strbuf_addch(&buf, *(message++));
556 else
557 strbuf_addf(&buf, "'\\\\%c'", *(message++));
558 res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
559 strbuf_release(&buf);
560 return res;
564 * Read a list of environment variable assignments (such as the author-script
565 * file) into an environment block. Returns -1 on error, 0 otherwise.
567 static int read_env_script(struct argv_array *env)
569 struct strbuf script = STRBUF_INIT;
570 int i, count = 0;
571 char *p, *p2;
573 if (strbuf_read_file(&script, rebase_path_author_script(), 256) <= 0)
574 return -1;
576 for (p = script.buf; *p; p++)
577 if (skip_prefix(p, "'\\\\''", (const char **)&p2))
578 strbuf_splice(&script, p - script.buf, p2 - p, "'", 1);
579 else if (*p == '\'')
580 strbuf_splice(&script, p-- - script.buf, 1, "", 0);
581 else if (*p == '\n') {
582 *p = '\0';
583 count++;
586 for (i = 0, p = script.buf; i < count; i++) {
587 argv_array_push(env, p);
588 p += strlen(p) + 1;
591 return 0;
594 static const char staged_changes_advice[] =
595 N_("you have staged changes in your working tree\n"
596 "If these changes are meant to be squashed into the previous commit, run:\n"
597 "\n"
598 " git commit --amend %s\n"
599 "\n"
600 "If they are meant to go into a new commit, run:\n"
601 "\n"
602 " git commit %s\n"
603 "\n"
604 "In both cases, once you're done, continue with:\n"
605 "\n"
606 " git rebase --continue\n");
608 #define ALLOW_EMPTY (1<<0)
609 #define EDIT_MSG (1<<1)
610 #define AMEND_MSG (1<<2)
611 #define CLEANUP_MSG (1<<3)
612 #define VERIFY_MSG (1<<4)
615 * If we are cherry-pick, and if the merge did not result in
616 * hand-editing, we will hit this commit and inherit the original
617 * author date and name.
619 * If we are revert, or if our cherry-pick results in a hand merge,
620 * we had better say that the current user is responsible for that.
622 * An exception is when run_git_commit() is called during an
623 * interactive rebase: in that case, we will want to retain the
624 * author metadata.
626 static int run_git_commit(const char *defmsg, struct replay_opts *opts,
627 unsigned int flags)
629 struct child_process cmd = CHILD_PROCESS_INIT;
630 const char *value;
632 cmd.git_cmd = 1;
634 if (is_rebase_i(opts)) {
635 if (!(flags & EDIT_MSG)) {
636 cmd.stdout_to_stderr = 1;
637 cmd.err = -1;
640 if (read_env_script(&cmd.env_array)) {
641 const char *gpg_opt = gpg_sign_opt_quoted(opts);
643 return error(_(staged_changes_advice),
644 gpg_opt, gpg_opt);
648 argv_array_push(&cmd.args, "commit");
650 if (!(flags & VERIFY_MSG))
651 argv_array_push(&cmd.args, "-n");
652 if ((flags & AMEND_MSG))
653 argv_array_push(&cmd.args, "--amend");
654 if (opts->gpg_sign)
655 argv_array_pushf(&cmd.args, "-S%s", opts->gpg_sign);
656 if (opts->signoff)
657 argv_array_push(&cmd.args, "-s");
658 if (defmsg)
659 argv_array_pushl(&cmd.args, "-F", defmsg, NULL);
660 if ((flags & CLEANUP_MSG))
661 argv_array_push(&cmd.args, "--cleanup=strip");
662 if ((flags & EDIT_MSG))
663 argv_array_push(&cmd.args, "-e");
664 else if (!(flags & CLEANUP_MSG) &&
665 !opts->signoff && !opts->record_origin &&
666 git_config_get_value("commit.cleanup", &value))
667 argv_array_push(&cmd.args, "--cleanup=verbatim");
669 if ((flags & ALLOW_EMPTY))
670 argv_array_push(&cmd.args, "--allow-empty");
672 if (opts->allow_empty_message)
673 argv_array_push(&cmd.args, "--allow-empty-message");
675 if (cmd.err == -1) {
676 /* hide stderr on success */
677 struct strbuf buf = STRBUF_INIT;
678 int rc = pipe_command(&cmd,
679 NULL, 0,
680 /* stdout is already redirected */
681 NULL, 0,
682 &buf, 0);
683 if (rc)
684 fputs(buf.buf, stderr);
685 strbuf_release(&buf);
686 return rc;
689 return run_command(&cmd);
692 static int is_original_commit_empty(struct commit *commit)
694 const unsigned char *ptree_sha1;
696 if (parse_commit(commit))
697 return error(_("could not parse commit %s\n"),
698 oid_to_hex(&commit->object.oid));
699 if (commit->parents) {
700 struct commit *parent = commit->parents->item;
701 if (parse_commit(parent))
702 return error(_("could not parse parent commit %s\n"),
703 oid_to_hex(&parent->object.oid));
704 ptree_sha1 = parent->tree->object.oid.hash;
705 } else {
706 ptree_sha1 = EMPTY_TREE_SHA1_BIN; /* commit is root */
709 return !hashcmp(ptree_sha1, commit->tree->object.oid.hash);
713 * Do we run "git commit" with "--allow-empty"?
715 static int allow_empty(struct replay_opts *opts, struct commit *commit)
717 int index_unchanged, empty_commit;
720 * Three cases:
722 * (1) we do not allow empty at all and error out.
724 * (2) we allow ones that were initially empty, but
725 * forbid the ones that become empty;
727 * (3) we allow both.
729 if (!opts->allow_empty)
730 return 0; /* let "git commit" barf as necessary */
732 index_unchanged = is_index_unchanged();
733 if (index_unchanged < 0)
734 return index_unchanged;
735 if (!index_unchanged)
736 return 0; /* we do not have to say --allow-empty */
738 if (opts->keep_redundant_commits)
739 return 1;
741 empty_commit = is_original_commit_empty(commit);
742 if (empty_commit < 0)
743 return empty_commit;
744 if (!empty_commit)
745 return 0;
746 else
747 return 1;
751 * Note that ordering matters in this enum. Not only must it match the mapping
752 * below, it is also divided into several sections that matter. When adding
753 * new commands, make sure you add it in the right section.
755 enum todo_command {
756 /* commands that handle commits */
757 TODO_PICK = 0,
758 TODO_REVERT,
759 TODO_EDIT,
760 TODO_REWORD,
761 TODO_FIXUP,
762 TODO_SQUASH,
763 /* commands that do something else than handling a single commit */
764 TODO_EXEC,
765 /* commands that do nothing but are counted for reporting progress */
766 TODO_NOOP,
767 TODO_DROP,
768 /* comments (not counted for reporting progress) */
769 TODO_COMMENT
772 static struct {
773 char c;
774 const char *str;
775 } todo_command_info[] = {
776 { 'p', "pick" },
777 { 0, "revert" },
778 { 'e', "edit" },
779 { 'r', "reword" },
780 { 'f', "fixup" },
781 { 's', "squash" },
782 { 'x', "exec" },
783 { 0, "noop" },
784 { 'd', "drop" },
785 { 0, NULL }
788 static const char *command_to_string(const enum todo_command command)
790 if (command < TODO_COMMENT)
791 return todo_command_info[command].str;
792 die("Unknown command: %d", command);
795 static int is_noop(const enum todo_command command)
797 return TODO_NOOP <= command;
800 static int is_fixup(enum todo_command command)
802 return command == TODO_FIXUP || command == TODO_SQUASH;
805 static int update_squash_messages(enum todo_command command,
806 struct commit *commit, struct replay_opts *opts)
808 struct strbuf buf = STRBUF_INIT;
809 int count, res;
810 const char *message, *body;
812 if (file_exists(rebase_path_squash_msg())) {
813 struct strbuf header = STRBUF_INIT;
814 char *eol, *p;
816 if (strbuf_read_file(&buf, rebase_path_squash_msg(), 2048) <= 0)
817 return error(_("could not read '%s'"),
818 rebase_path_squash_msg());
820 p = buf.buf + 1;
821 eol = strchrnul(buf.buf, '\n');
822 if (buf.buf[0] != comment_line_char ||
823 (p += strcspn(p, "0123456789\n")) == eol)
824 return error(_("unexpected 1st line of squash message:"
825 "\n\n\t%.*s"),
826 (int)(eol - buf.buf), buf.buf);
827 count = strtol(p, NULL, 10);
829 if (count < 1)
830 return error(_("invalid 1st line of squash message:\n"
831 "\n\t%.*s"),
832 (int)(eol - buf.buf), buf.buf);
834 strbuf_addf(&header, "%c ", comment_line_char);
835 strbuf_addf(&header,
836 _("This is a combination of %d commits."), ++count);
837 strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
838 strbuf_release(&header);
839 } else {
840 struct object_id head;
841 struct commit *head_commit;
842 const char *head_message, *body;
844 if (get_oid("HEAD", &head))
845 return error(_("need a HEAD to fixup"));
846 if (!(head_commit = lookup_commit_reference(&head)))
847 return error(_("could not read HEAD"));
848 if (!(head_message = get_commit_buffer(head_commit, NULL)))
849 return error(_("could not read HEAD's commit message"));
851 find_commit_subject(head_message, &body);
852 if (write_message(body, strlen(body),
853 rebase_path_fixup_msg(), 0)) {
854 unuse_commit_buffer(head_commit, head_message);
855 return error(_("cannot write '%s'"),
856 rebase_path_fixup_msg());
859 count = 2;
860 strbuf_addf(&buf, "%c ", comment_line_char);
861 strbuf_addf(&buf, _("This is a combination of %d commits."),
862 count);
863 strbuf_addf(&buf, "\n%c ", comment_line_char);
864 strbuf_addstr(&buf, _("This is the 1st commit message:"));
865 strbuf_addstr(&buf, "\n\n");
866 strbuf_addstr(&buf, body);
868 unuse_commit_buffer(head_commit, head_message);
871 if (!(message = get_commit_buffer(commit, NULL)))
872 return error(_("could not read commit message of %s"),
873 oid_to_hex(&commit->object.oid));
874 find_commit_subject(message, &body);
876 if (command == TODO_SQUASH) {
877 unlink(rebase_path_fixup_msg());
878 strbuf_addf(&buf, "\n%c ", comment_line_char);
879 strbuf_addf(&buf, _("This is the commit message #%d:"), count);
880 strbuf_addstr(&buf, "\n\n");
881 strbuf_addstr(&buf, body);
882 } else if (command == TODO_FIXUP) {
883 strbuf_addf(&buf, "\n%c ", comment_line_char);
884 strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
885 count);
886 strbuf_addstr(&buf, "\n\n");
887 strbuf_add_commented_lines(&buf, body, strlen(body));
888 } else
889 return error(_("unknown command: %d"), command);
890 unuse_commit_buffer(commit, message);
892 res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
893 strbuf_release(&buf);
894 return res;
897 static void flush_rewritten_pending(void) {
898 struct strbuf buf = STRBUF_INIT;
899 unsigned char newsha1[20];
900 FILE *out;
902 if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), 82) > 0 &&
903 !get_sha1("HEAD", newsha1) &&
904 (out = fopen_or_warn(rebase_path_rewritten_list(), "a"))) {
905 char *bol = buf.buf, *eol;
907 while (*bol) {
908 eol = strchrnul(bol, '\n');
909 fprintf(out, "%.*s %s\n", (int)(eol - bol),
910 bol, sha1_to_hex(newsha1));
911 if (!*eol)
912 break;
913 bol = eol + 1;
915 fclose(out);
916 unlink(rebase_path_rewritten_pending());
918 strbuf_release(&buf);
921 static void record_in_rewritten(struct object_id *oid,
922 enum todo_command next_command) {
923 FILE *out = fopen_or_warn(rebase_path_rewritten_pending(), "a");
925 if (!out)
926 return;
928 fprintf(out, "%s\n", oid_to_hex(oid));
929 fclose(out);
931 if (!is_fixup(next_command))
932 flush_rewritten_pending();
935 static int do_pick_commit(enum todo_command command, struct commit *commit,
936 struct replay_opts *opts, int final_fixup)
938 unsigned int flags = opts->edit ? EDIT_MSG : 0;
939 const char *msg_file = opts->edit ? NULL : git_path_merge_msg();
940 struct object_id head;
941 struct commit *base, *next, *parent;
942 const char *base_label, *next_label;
943 struct commit_message msg = { NULL, NULL, NULL, NULL };
944 struct strbuf msgbuf = STRBUF_INIT;
945 int res, unborn = 0, allow;
947 if (opts->no_commit) {
949 * We do not intend to commit immediately. We just want to
950 * merge the differences in, so let's compute the tree
951 * that represents the "current" state for merge-recursive
952 * to work on.
954 if (write_cache_as_tree(head.hash, 0, NULL))
955 return error(_("your index file is unmerged."));
956 } else {
957 unborn = get_oid("HEAD", &head);
958 if (unborn)
959 oidcpy(&head, &empty_tree_oid);
960 if (index_differs_from(unborn ? EMPTY_TREE_SHA1_HEX : "HEAD", 0, 0))
961 return error_dirty_index(opts);
963 discard_cache();
965 if (!commit->parents)
966 parent = NULL;
967 else if (commit->parents->next) {
968 /* Reverting or cherry-picking a merge commit */
969 int cnt;
970 struct commit_list *p;
972 if (!opts->mainline)
973 return error(_("commit %s is a merge but no -m option was given."),
974 oid_to_hex(&commit->object.oid));
976 for (cnt = 1, p = commit->parents;
977 cnt != opts->mainline && p;
978 cnt++)
979 p = p->next;
980 if (cnt != opts->mainline || !p)
981 return error(_("commit %s does not have parent %d"),
982 oid_to_hex(&commit->object.oid), opts->mainline);
983 parent = p->item;
984 } else if (0 < opts->mainline)
985 return error(_("mainline was specified but commit %s is not a merge."),
986 oid_to_hex(&commit->object.oid));
987 else
988 parent = commit->parents->item;
990 if (get_message(commit, &msg) != 0)
991 return error(_("cannot get commit message for %s"),
992 oid_to_hex(&commit->object.oid));
994 if (opts->allow_ff && !is_fixup(command) &&
995 ((parent && !oidcmp(&parent->object.oid, &head)) ||
996 (!parent && unborn))) {
997 if (is_rebase_i(opts))
998 write_author_script(msg.message);
999 res = fast_forward_to(&commit->object.oid, &head, unborn,
1000 opts);
1001 if (res || command != TODO_REWORD)
1002 goto leave;
1003 flags |= EDIT_MSG | AMEND_MSG;
1004 if (command == TODO_REWORD)
1005 flags |= VERIFY_MSG;
1006 msg_file = NULL;
1007 goto fast_forward_edit;
1009 if (parent && parse_commit(parent) < 0)
1010 /* TRANSLATORS: The first %s will be a "todo" command like
1011 "revert" or "pick", the second %s a SHA1. */
1012 return error(_("%s: cannot parse parent commit %s"),
1013 command_to_string(command),
1014 oid_to_hex(&parent->object.oid));
1017 * "commit" is an existing commit. We would want to apply
1018 * the difference it introduces since its first parent "prev"
1019 * on top of the current HEAD if we are cherry-pick. Or the
1020 * reverse of it if we are revert.
1023 if (command == TODO_REVERT) {
1024 base = commit;
1025 base_label = msg.label;
1026 next = parent;
1027 next_label = msg.parent_label;
1028 strbuf_addstr(&msgbuf, "Revert \"");
1029 strbuf_addstr(&msgbuf, msg.subject);
1030 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
1031 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1033 if (commit->parents && commit->parents->next) {
1034 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
1035 strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
1037 strbuf_addstr(&msgbuf, ".\n");
1038 } else {
1039 const char *p;
1041 base = parent;
1042 base_label = msg.parent_label;
1043 next = commit;
1044 next_label = msg.label;
1046 /* Append the commit log message to msgbuf. */
1047 if (find_commit_subject(msg.message, &p))
1048 strbuf_addstr(&msgbuf, p);
1050 if (opts->record_origin) {
1051 strbuf_complete_line(&msgbuf);
1052 if (!has_conforming_footer(&msgbuf, NULL, 0))
1053 strbuf_addch(&msgbuf, '\n');
1054 strbuf_addstr(&msgbuf, cherry_picked_prefix);
1055 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1056 strbuf_addstr(&msgbuf, ")\n");
1060 if (command == TODO_REWORD)
1061 flags |= EDIT_MSG | VERIFY_MSG;
1062 else if (is_fixup(command)) {
1063 if (update_squash_messages(command, commit, opts))
1064 return -1;
1065 flags |= AMEND_MSG;
1066 if (!final_fixup)
1067 msg_file = rebase_path_squash_msg();
1068 else if (file_exists(rebase_path_fixup_msg())) {
1069 flags |= CLEANUP_MSG;
1070 msg_file = rebase_path_fixup_msg();
1071 } else {
1072 const char *dest = git_path_squash_msg();
1073 unlink(dest);
1074 if (copy_file(dest, rebase_path_squash_msg(), 0666))
1075 return error(_("could not rename '%s' to '%s'"),
1076 rebase_path_squash_msg(), dest);
1077 unlink(git_path_merge_msg());
1078 msg_file = dest;
1079 flags |= EDIT_MSG;
1083 if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
1084 res = -1;
1085 else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
1086 res = do_recursive_merge(base, next, base_label, next_label,
1087 &head, &msgbuf, opts);
1088 if (res < 0)
1089 return res;
1090 res |= write_message(msgbuf.buf, msgbuf.len,
1091 git_path_merge_msg(), 0);
1092 } else {
1093 struct commit_list *common = NULL;
1094 struct commit_list *remotes = NULL;
1096 res = write_message(msgbuf.buf, msgbuf.len,
1097 git_path_merge_msg(), 0);
1099 commit_list_insert(base, &common);
1100 commit_list_insert(next, &remotes);
1101 res |= try_merge_command(opts->strategy,
1102 opts->xopts_nr, (const char **)opts->xopts,
1103 common, oid_to_hex(&head), remotes);
1104 free_commit_list(common);
1105 free_commit_list(remotes);
1107 strbuf_release(&msgbuf);
1110 * If the merge was clean or if it failed due to conflict, we write
1111 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
1112 * However, if the merge did not even start, then we don't want to
1113 * write it at all.
1115 if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
1116 update_ref(NULL, "CHERRY_PICK_HEAD", commit->object.oid.hash, NULL,
1117 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1118 res = -1;
1119 if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
1120 update_ref(NULL, "REVERT_HEAD", commit->object.oid.hash, NULL,
1121 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
1122 res = -1;
1124 if (res) {
1125 error(command == TODO_REVERT
1126 ? _("could not revert %s... %s")
1127 : _("could not apply %s... %s"),
1128 short_commit_name(commit), msg.subject);
1129 print_advice(res == 1, opts);
1130 rerere(opts->allow_rerere_auto);
1131 goto leave;
1134 allow = allow_empty(opts, commit);
1135 if (allow < 0) {
1136 res = allow;
1137 goto leave;
1138 } else if (allow)
1139 flags |= ALLOW_EMPTY;
1140 if (!opts->no_commit)
1141 fast_forward_edit:
1142 res = run_git_commit(msg_file, opts, flags);
1144 if (!res && final_fixup) {
1145 unlink(rebase_path_fixup_msg());
1146 unlink(rebase_path_squash_msg());
1149 leave:
1150 free_message(commit, &msg);
1151 update_abort_safety_file();
1153 return res;
1156 static int prepare_revs(struct replay_opts *opts)
1159 * picking (but not reverting) ranges (but not individual revisions)
1160 * should be done in reverse
1162 if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
1163 opts->revs->reverse ^= 1;
1165 if (prepare_revision_walk(opts->revs))
1166 return error(_("revision walk setup failed"));
1168 if (!opts->revs->commits)
1169 return error(_("empty commit set passed"));
1170 return 0;
1173 static int read_and_refresh_cache(struct replay_opts *opts)
1175 static struct lock_file index_lock;
1176 int index_fd = hold_locked_index(&index_lock, 0);
1177 if (read_index_preload(&the_index, NULL) < 0) {
1178 rollback_lock_file(&index_lock);
1179 return error(_("git %s: failed to read the index"),
1180 _(action_name(opts)));
1182 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
1183 if (the_index.cache_changed && index_fd >= 0) {
1184 if (write_locked_index(&the_index, &index_lock, COMMIT_LOCK)) {
1185 rollback_lock_file(&index_lock);
1186 return error(_("git %s: failed to refresh the index"),
1187 _(action_name(opts)));
1190 rollback_lock_file(&index_lock);
1191 return 0;
1194 struct todo_item {
1195 enum todo_command command;
1196 struct commit *commit;
1197 const char *arg;
1198 int arg_len;
1199 size_t offset_in_buf;
1202 struct todo_list {
1203 struct strbuf buf;
1204 struct todo_item *items;
1205 int nr, alloc, current;
1206 int done_nr, total_nr;
1207 struct stat_data stat;
1210 #define TODO_LIST_INIT { STRBUF_INIT }
1212 static void todo_list_release(struct todo_list *todo_list)
1214 strbuf_release(&todo_list->buf);
1215 FREE_AND_NULL(todo_list->items);
1216 todo_list->nr = todo_list->alloc = 0;
1219 static struct todo_item *append_new_todo(struct todo_list *todo_list)
1221 ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
1222 return todo_list->items + todo_list->nr++;
1225 static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
1227 struct object_id commit_oid;
1228 char *end_of_object_name;
1229 int i, saved, status, padding;
1231 /* left-trim */
1232 bol += strspn(bol, " \t");
1234 if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
1235 item->command = TODO_COMMENT;
1236 item->commit = NULL;
1237 item->arg = bol;
1238 item->arg_len = eol - bol;
1239 return 0;
1242 for (i = 0; i < TODO_COMMENT; i++)
1243 if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
1244 item->command = i;
1245 break;
1246 } else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
1247 bol++;
1248 item->command = i;
1249 break;
1251 if (i >= TODO_COMMENT)
1252 return -1;
1254 if (item->command == TODO_NOOP) {
1255 item->commit = NULL;
1256 item->arg = bol;
1257 item->arg_len = eol - bol;
1258 return 0;
1261 /* Eat up extra spaces/ tabs before object name */
1262 padding = strspn(bol, " \t");
1263 if (!padding)
1264 return -1;
1265 bol += padding;
1267 if (item->command == TODO_EXEC) {
1268 item->arg = bol;
1269 item->arg_len = (int)(eol - bol);
1270 return 0;
1273 end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
1274 saved = *end_of_object_name;
1275 *end_of_object_name = '\0';
1276 status = get_oid(bol, &commit_oid);
1277 *end_of_object_name = saved;
1279 item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
1280 item->arg_len = (int)(eol - item->arg);
1282 if (status < 0)
1283 return -1;
1285 item->commit = lookup_commit_reference(&commit_oid);
1286 return !item->commit;
1289 static int parse_insn_buffer(char *buf, struct todo_list *todo_list)
1291 struct todo_item *item;
1292 char *p = buf, *next_p;
1293 int i, res = 0, fixup_okay = file_exists(rebase_path_done());
1295 for (i = 1; *p; i++, p = next_p) {
1296 char *eol = strchrnul(p, '\n');
1298 next_p = *eol ? eol + 1 /* skip LF */ : eol;
1300 if (p != eol && eol[-1] == '\r')
1301 eol--; /* strip Carriage Return */
1303 item = append_new_todo(todo_list);
1304 item->offset_in_buf = p - todo_list->buf.buf;
1305 if (parse_insn_line(item, p, eol)) {
1306 res = error(_("invalid line %d: %.*s"),
1307 i, (int)(eol - p), p);
1308 item->command = TODO_NOOP;
1311 if (fixup_okay)
1312 ; /* do nothing */
1313 else if (is_fixup(item->command))
1314 return error(_("cannot '%s' without a previous commit"),
1315 command_to_string(item->command));
1316 else if (!is_noop(item->command))
1317 fixup_okay = 1;
1320 return res;
1323 static int count_commands(struct todo_list *todo_list)
1325 int count = 0, i;
1327 for (i = 0; i < todo_list->nr; i++)
1328 if (todo_list->items[i].command != TODO_COMMENT)
1329 count++;
1331 return count;
1334 static int read_populate_todo(struct todo_list *todo_list,
1335 struct replay_opts *opts)
1337 struct stat st;
1338 const char *todo_file = get_todo_path(opts);
1339 int fd, res;
1341 strbuf_reset(&todo_list->buf);
1342 fd = open(todo_file, O_RDONLY);
1343 if (fd < 0)
1344 return error_errno(_("could not open '%s'"), todo_file);
1345 if (strbuf_read(&todo_list->buf, fd, 0) < 0) {
1346 close(fd);
1347 return error(_("could not read '%s'."), todo_file);
1349 close(fd);
1351 res = stat(todo_file, &st);
1352 if (res)
1353 return error(_("could not stat '%s'"), todo_file);
1354 fill_stat_data(&todo_list->stat, &st);
1356 res = parse_insn_buffer(todo_list->buf.buf, todo_list);
1357 if (res) {
1358 if (is_rebase_i(opts))
1359 return error(_("please fix this using "
1360 "'git rebase --edit-todo'."));
1361 return error(_("unusable instruction sheet: '%s'"), todo_file);
1364 if (!todo_list->nr &&
1365 (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
1366 return error(_("no commits parsed."));
1368 if (!is_rebase_i(opts)) {
1369 enum todo_command valid =
1370 opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
1371 int i;
1373 for (i = 0; i < todo_list->nr; i++)
1374 if (valid == todo_list->items[i].command)
1375 continue;
1376 else if (valid == TODO_PICK)
1377 return error(_("cannot cherry-pick during a revert."));
1378 else
1379 return error(_("cannot revert during a cherry-pick."));
1382 if (is_rebase_i(opts)) {
1383 struct todo_list done = TODO_LIST_INIT;
1384 FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
1386 if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
1387 !parse_insn_buffer(done.buf.buf, &done))
1388 todo_list->done_nr = count_commands(&done);
1389 else
1390 todo_list->done_nr = 0;
1392 todo_list->total_nr = todo_list->done_nr
1393 + count_commands(todo_list);
1394 todo_list_release(&done);
1396 if (f) {
1397 fprintf(f, "%d\n", todo_list->total_nr);
1398 fclose(f);
1402 return 0;
1405 static int git_config_string_dup(char **dest,
1406 const char *var, const char *value)
1408 if (!value)
1409 return config_error_nonbool(var);
1410 free(*dest);
1411 *dest = xstrdup(value);
1412 return 0;
1415 static int populate_opts_cb(const char *key, const char *value, void *data)
1417 struct replay_opts *opts = data;
1418 int error_flag = 1;
1420 if (!value)
1421 error_flag = 0;
1422 else if (!strcmp(key, "options.no-commit"))
1423 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
1424 else if (!strcmp(key, "options.edit"))
1425 opts->edit = git_config_bool_or_int(key, value, &error_flag);
1426 else if (!strcmp(key, "options.signoff"))
1427 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
1428 else if (!strcmp(key, "options.record-origin"))
1429 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
1430 else if (!strcmp(key, "options.allow-ff"))
1431 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
1432 else if (!strcmp(key, "options.mainline"))
1433 opts->mainline = git_config_int(key, value);
1434 else if (!strcmp(key, "options.strategy"))
1435 git_config_string_dup(&opts->strategy, key, value);
1436 else if (!strcmp(key, "options.gpg-sign"))
1437 git_config_string_dup(&opts->gpg_sign, key, value);
1438 else if (!strcmp(key, "options.strategy-option")) {
1439 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
1440 opts->xopts[opts->xopts_nr++] = xstrdup(value);
1441 } else
1442 return error(_("invalid key: %s"), key);
1444 if (!error_flag)
1445 return error(_("invalid value for %s: %s"), key, value);
1447 return 0;
1450 static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
1452 int i;
1454 strbuf_reset(buf);
1455 if (!read_oneliner(buf, rebase_path_strategy(), 0))
1456 return;
1457 opts->strategy = strbuf_detach(buf, NULL);
1458 if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
1459 return;
1461 opts->xopts_nr = split_cmdline(buf->buf, (const char ***)&opts->xopts);
1462 for (i = 0; i < opts->xopts_nr; i++) {
1463 const char *arg = opts->xopts[i];
1465 skip_prefix(arg, "--", &arg);
1466 opts->xopts[i] = xstrdup(arg);
1470 static int read_populate_opts(struct replay_opts *opts)
1472 if (is_rebase_i(opts)) {
1473 struct strbuf buf = STRBUF_INIT;
1475 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
1476 if (!starts_with(buf.buf, "-S"))
1477 strbuf_reset(&buf);
1478 else {
1479 free(opts->gpg_sign);
1480 opts->gpg_sign = xstrdup(buf.buf + 2);
1484 if (file_exists(rebase_path_verbose()))
1485 opts->verbose = 1;
1487 read_strategy_opts(opts, &buf);
1488 strbuf_release(&buf);
1490 return 0;
1493 if (!file_exists(git_path_opts_file()))
1494 return 0;
1496 * The function git_parse_source(), called from git_config_from_file(),
1497 * may die() in case of a syntactically incorrect file. We do not care
1498 * about this case, though, because we wrote that file ourselves, so we
1499 * are pretty certain that it is syntactically correct.
1501 if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
1502 return error(_("malformed options sheet: '%s'"),
1503 git_path_opts_file());
1504 return 0;
1507 static int walk_revs_populate_todo(struct todo_list *todo_list,
1508 struct replay_opts *opts)
1510 enum todo_command command = opts->action == REPLAY_PICK ?
1511 TODO_PICK : TODO_REVERT;
1512 const char *command_string = todo_command_info[command].str;
1513 struct commit *commit;
1515 if (prepare_revs(opts))
1516 return -1;
1518 while ((commit = get_revision(opts->revs))) {
1519 struct todo_item *item = append_new_todo(todo_list);
1520 const char *commit_buffer = get_commit_buffer(commit, NULL);
1521 const char *subject;
1522 int subject_len;
1524 item->command = command;
1525 item->commit = commit;
1526 item->arg = NULL;
1527 item->arg_len = 0;
1528 item->offset_in_buf = todo_list->buf.len;
1529 subject_len = find_commit_subject(commit_buffer, &subject);
1530 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
1531 short_commit_name(commit), subject_len, subject);
1532 unuse_commit_buffer(commit, commit_buffer);
1534 return 0;
1537 static int create_seq_dir(void)
1539 if (file_exists(git_path_seq_dir())) {
1540 error(_("a cherry-pick or revert is already in progress"));
1541 advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
1542 return -1;
1543 } else if (mkdir(git_path_seq_dir(), 0777) < 0)
1544 return error_errno(_("could not create sequencer directory '%s'"),
1545 git_path_seq_dir());
1546 return 0;
1549 static int save_head(const char *head)
1551 static struct lock_file head_lock;
1552 struct strbuf buf = STRBUF_INIT;
1553 int fd;
1555 fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
1556 if (fd < 0) {
1557 rollback_lock_file(&head_lock);
1558 return error_errno(_("could not lock HEAD"));
1560 strbuf_addf(&buf, "%s\n", head);
1561 if (write_in_full(fd, buf.buf, buf.len) < 0) {
1562 rollback_lock_file(&head_lock);
1563 return error_errno(_("could not write to '%s'"),
1564 git_path_head_file());
1566 if (commit_lock_file(&head_lock) < 0) {
1567 rollback_lock_file(&head_lock);
1568 return error(_("failed to finalize '%s'."), git_path_head_file());
1570 return 0;
1573 static int rollback_is_safe(void)
1575 struct strbuf sb = STRBUF_INIT;
1576 struct object_id expected_head, actual_head;
1578 if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
1579 strbuf_trim(&sb);
1580 if (get_oid_hex(sb.buf, &expected_head)) {
1581 strbuf_release(&sb);
1582 die(_("could not parse %s"), git_path_abort_safety_file());
1584 strbuf_release(&sb);
1586 else if (errno == ENOENT)
1587 oidclr(&expected_head);
1588 else
1589 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
1591 if (get_oid("HEAD", &actual_head))
1592 oidclr(&actual_head);
1594 return !oidcmp(&actual_head, &expected_head);
1597 static int reset_for_rollback(const unsigned char *sha1)
1599 const char *argv[4]; /* reset --merge <arg> + NULL */
1601 argv[0] = "reset";
1602 argv[1] = "--merge";
1603 argv[2] = sha1_to_hex(sha1);
1604 argv[3] = NULL;
1605 return run_command_v_opt(argv, RUN_GIT_CMD);
1608 static int rollback_single_pick(void)
1610 unsigned char head_sha1[20];
1612 if (!file_exists(git_path_cherry_pick_head()) &&
1613 !file_exists(git_path_revert_head()))
1614 return error(_("no cherry-pick or revert in progress"));
1615 if (read_ref_full("HEAD", 0, head_sha1, NULL))
1616 return error(_("cannot resolve HEAD"));
1617 if (is_null_sha1(head_sha1))
1618 return error(_("cannot abort from a branch yet to be born"));
1619 return reset_for_rollback(head_sha1);
1622 int sequencer_rollback(struct replay_opts *opts)
1624 FILE *f;
1625 unsigned char sha1[20];
1626 struct strbuf buf = STRBUF_INIT;
1628 f = fopen(git_path_head_file(), "r");
1629 if (!f && errno == ENOENT) {
1631 * There is no multiple-cherry-pick in progress.
1632 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
1633 * a single-cherry-pick in progress, abort that.
1635 return rollback_single_pick();
1637 if (!f)
1638 return error_errno(_("cannot open '%s'"), git_path_head_file());
1639 if (strbuf_getline_lf(&buf, f)) {
1640 error(_("cannot read '%s': %s"), git_path_head_file(),
1641 ferror(f) ? strerror(errno) : _("unexpected end of file"));
1642 fclose(f);
1643 goto fail;
1645 fclose(f);
1646 if (get_sha1_hex(buf.buf, sha1) || buf.buf[40] != '\0') {
1647 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
1648 git_path_head_file());
1649 goto fail;
1651 if (is_null_sha1(sha1)) {
1652 error(_("cannot abort from a branch yet to be born"));
1653 goto fail;
1656 if (!rollback_is_safe()) {
1657 /* Do not error, just do not rollback */
1658 warning(_("You seem to have moved HEAD. "
1659 "Not rewinding, check your HEAD!"));
1660 } else
1661 if (reset_for_rollback(sha1))
1662 goto fail;
1663 strbuf_release(&buf);
1664 return sequencer_remove_state(opts);
1665 fail:
1666 strbuf_release(&buf);
1667 return -1;
1670 static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
1672 static struct lock_file todo_lock;
1673 const char *todo_path = get_todo_path(opts);
1674 int next = todo_list->current, offset, fd;
1677 * rebase -i writes "git-rebase-todo" without the currently executing
1678 * command, appending it to "done" instead.
1680 if (is_rebase_i(opts))
1681 next++;
1683 fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
1684 if (fd < 0)
1685 return error_errno(_("could not lock '%s'"), todo_path);
1686 offset = next < todo_list->nr ?
1687 todo_list->items[next].offset_in_buf : todo_list->buf.len;
1688 if (write_in_full(fd, todo_list->buf.buf + offset,
1689 todo_list->buf.len - offset) < 0)
1690 return error_errno(_("could not write to '%s'"), todo_path);
1691 if (commit_lock_file(&todo_lock) < 0)
1692 return error(_("failed to finalize '%s'."), todo_path);
1694 if (is_rebase_i(opts)) {
1695 const char *done_path = rebase_path_done();
1696 int fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
1697 int prev_offset = !next ? 0 :
1698 todo_list->items[next - 1].offset_in_buf;
1700 if (fd >= 0 && offset > prev_offset &&
1701 write_in_full(fd, todo_list->buf.buf + prev_offset,
1702 offset - prev_offset) < 0) {
1703 close(fd);
1704 return error_errno(_("could not write to '%s'"),
1705 done_path);
1707 if (fd >= 0)
1708 close(fd);
1710 return 0;
1713 static int save_opts(struct replay_opts *opts)
1715 const char *opts_file = git_path_opts_file();
1716 int res = 0;
1718 if (opts->no_commit)
1719 res |= git_config_set_in_file_gently(opts_file, "options.no-commit", "true");
1720 if (opts->edit)
1721 res |= git_config_set_in_file_gently(opts_file, "options.edit", "true");
1722 if (opts->signoff)
1723 res |= git_config_set_in_file_gently(opts_file, "options.signoff", "true");
1724 if (opts->record_origin)
1725 res |= git_config_set_in_file_gently(opts_file, "options.record-origin", "true");
1726 if (opts->allow_ff)
1727 res |= git_config_set_in_file_gently(opts_file, "options.allow-ff", "true");
1728 if (opts->mainline) {
1729 struct strbuf buf = STRBUF_INIT;
1730 strbuf_addf(&buf, "%d", opts->mainline);
1731 res |= git_config_set_in_file_gently(opts_file, "options.mainline", buf.buf);
1732 strbuf_release(&buf);
1734 if (opts->strategy)
1735 res |= git_config_set_in_file_gently(opts_file, "options.strategy", opts->strategy);
1736 if (opts->gpg_sign)
1737 res |= git_config_set_in_file_gently(opts_file, "options.gpg-sign", opts->gpg_sign);
1738 if (opts->xopts) {
1739 int i;
1740 for (i = 0; i < opts->xopts_nr; i++)
1741 res |= git_config_set_multivar_in_file_gently(opts_file,
1742 "options.strategy-option",
1743 opts->xopts[i], "^$", 0);
1745 return res;
1748 static int make_patch(struct commit *commit, struct replay_opts *opts)
1750 struct strbuf buf = STRBUF_INIT;
1751 struct rev_info log_tree_opt;
1752 const char *subject, *p;
1753 int res = 0;
1755 p = short_commit_name(commit);
1756 if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
1757 return -1;
1759 strbuf_addf(&buf, "%s/patch", get_dir(opts));
1760 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
1761 init_revisions(&log_tree_opt, NULL);
1762 log_tree_opt.abbrev = 0;
1763 log_tree_opt.diff = 1;
1764 log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
1765 log_tree_opt.disable_stdin = 1;
1766 log_tree_opt.no_commit_id = 1;
1767 log_tree_opt.diffopt.file = fopen(buf.buf, "w");
1768 log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
1769 if (!log_tree_opt.diffopt.file)
1770 res |= error_errno(_("could not open '%s'"), buf.buf);
1771 else {
1772 res |= log_tree_commit(&log_tree_opt, commit);
1773 fclose(log_tree_opt.diffopt.file);
1775 strbuf_reset(&buf);
1777 strbuf_addf(&buf, "%s/message", get_dir(opts));
1778 if (!file_exists(buf.buf)) {
1779 const char *commit_buffer = get_commit_buffer(commit, NULL);
1780 find_commit_subject(commit_buffer, &subject);
1781 res |= write_message(subject, strlen(subject), buf.buf, 1);
1782 unuse_commit_buffer(commit, commit_buffer);
1784 strbuf_release(&buf);
1786 return res;
1789 static int intend_to_amend(void)
1791 unsigned char head[20];
1792 char *p;
1794 if (get_sha1("HEAD", head))
1795 return error(_("cannot read HEAD"));
1797 p = sha1_to_hex(head);
1798 return write_message(p, strlen(p), rebase_path_amend(), 1);
1801 static int error_with_patch(struct commit *commit,
1802 const char *subject, int subject_len,
1803 struct replay_opts *opts, int exit_code, int to_amend)
1805 if (make_patch(commit, opts))
1806 return -1;
1808 if (to_amend) {
1809 if (intend_to_amend())
1810 return -1;
1812 fprintf(stderr, "You can amend the commit now, with\n"
1813 "\n"
1814 " git commit --amend %s\n"
1815 "\n"
1816 "Once you are satisfied with your changes, run\n"
1817 "\n"
1818 " git rebase --continue\n", gpg_sign_opt_quoted(opts));
1819 } else if (exit_code)
1820 fprintf(stderr, "Could not apply %s... %.*s\n",
1821 short_commit_name(commit), subject_len, subject);
1823 return exit_code;
1826 static int error_failed_squash(struct commit *commit,
1827 struct replay_opts *opts, int subject_len, const char *subject)
1829 if (rename(rebase_path_squash_msg(), rebase_path_message()))
1830 return error(_("could not rename '%s' to '%s'"),
1831 rebase_path_squash_msg(), rebase_path_message());
1832 unlink(rebase_path_fixup_msg());
1833 unlink(git_path_merge_msg());
1834 if (copy_file(git_path_merge_msg(), rebase_path_message(), 0666))
1835 return error(_("could not copy '%s' to '%s'"),
1836 rebase_path_message(), git_path_merge_msg());
1837 return error_with_patch(commit, subject, subject_len, opts, 1, 0);
1840 static int do_exec(const char *command_line)
1842 const char *child_argv[] = { NULL, NULL };
1843 int dirty, status;
1845 fprintf(stderr, "Executing: %s\n", command_line);
1846 child_argv[0] = command_line;
1847 status = run_command_v_opt(child_argv, RUN_USING_SHELL);
1849 /* force re-reading of the cache */
1850 if (discard_cache() < 0 || read_cache() < 0)
1851 return error(_("could not read index"));
1853 dirty = require_clean_work_tree("rebase", NULL, 1, 1);
1855 if (status) {
1856 warning(_("execution failed: %s\n%s"
1857 "You can fix the problem, and then run\n"
1858 "\n"
1859 " git rebase --continue\n"
1860 "\n"),
1861 command_line,
1862 dirty ? N_("and made changes to the index and/or the "
1863 "working tree\n") : "");
1864 if (status == 127)
1865 /* command not found */
1866 status = 1;
1867 } else if (dirty) {
1868 warning(_("execution succeeded: %s\nbut "
1869 "left changes to the index and/or the working tree\n"
1870 "Commit or stash your changes, and then run\n"
1871 "\n"
1872 " git rebase --continue\n"
1873 "\n"), command_line);
1874 status = 1;
1877 return status;
1880 static int is_final_fixup(struct todo_list *todo_list)
1882 int i = todo_list->current;
1884 if (!is_fixup(todo_list->items[i].command))
1885 return 0;
1887 while (++i < todo_list->nr)
1888 if (is_fixup(todo_list->items[i].command))
1889 return 0;
1890 else if (!is_noop(todo_list->items[i].command))
1891 break;
1892 return 1;
1895 static enum todo_command peek_command(struct todo_list *todo_list, int offset)
1897 int i;
1899 for (i = todo_list->current + offset; i < todo_list->nr; i++)
1900 if (!is_noop(todo_list->items[i].command))
1901 return todo_list->items[i].command;
1903 return -1;
1906 static int apply_autostash(struct replay_opts *opts)
1908 struct strbuf stash_sha1 = STRBUF_INIT;
1909 struct child_process child = CHILD_PROCESS_INIT;
1910 int ret = 0;
1912 if (!read_oneliner(&stash_sha1, rebase_path_autostash(), 1)) {
1913 strbuf_release(&stash_sha1);
1914 return 0;
1916 strbuf_trim(&stash_sha1);
1918 child.git_cmd = 1;
1919 child.no_stdout = 1;
1920 child.no_stderr = 1;
1921 argv_array_push(&child.args, "stash");
1922 argv_array_push(&child.args, "apply");
1923 argv_array_push(&child.args, stash_sha1.buf);
1924 if (!run_command(&child))
1925 fprintf(stderr, _("Applied autostash.\n"));
1926 else {
1927 struct child_process store = CHILD_PROCESS_INIT;
1929 store.git_cmd = 1;
1930 argv_array_push(&store.args, "stash");
1931 argv_array_push(&store.args, "store");
1932 argv_array_push(&store.args, "-m");
1933 argv_array_push(&store.args, "autostash");
1934 argv_array_push(&store.args, "-q");
1935 argv_array_push(&store.args, stash_sha1.buf);
1936 if (run_command(&store))
1937 ret = error(_("cannot store %s"), stash_sha1.buf);
1938 else
1939 fprintf(stderr,
1940 _("Applying autostash resulted in conflicts.\n"
1941 "Your changes are safe in the stash.\n"
1942 "You can run \"git stash pop\" or"
1943 " \"git stash drop\" at any time.\n"));
1946 strbuf_release(&stash_sha1);
1947 return ret;
1950 static const char *reflog_message(struct replay_opts *opts,
1951 const char *sub_action, const char *fmt, ...)
1953 va_list ap;
1954 static struct strbuf buf = STRBUF_INIT;
1956 va_start(ap, fmt);
1957 strbuf_reset(&buf);
1958 strbuf_addstr(&buf, action_name(opts));
1959 if (sub_action)
1960 strbuf_addf(&buf, " (%s)", sub_action);
1961 if (fmt) {
1962 strbuf_addstr(&buf, ": ");
1963 strbuf_vaddf(&buf, fmt, ap);
1965 va_end(ap);
1967 return buf.buf;
1970 static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
1972 int res = 0;
1974 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
1975 if (opts->allow_ff)
1976 assert(!(opts->signoff || opts->no_commit ||
1977 opts->record_origin || opts->edit));
1978 if (read_and_refresh_cache(opts))
1979 return -1;
1981 while (todo_list->current < todo_list->nr) {
1982 struct todo_item *item = todo_list->items + todo_list->current;
1983 if (save_todo(todo_list, opts))
1984 return -1;
1985 if (is_rebase_i(opts)) {
1986 if (item->command != TODO_COMMENT) {
1987 FILE *f = fopen(rebase_path_msgnum(), "w");
1989 todo_list->done_nr++;
1991 if (f) {
1992 fprintf(f, "%d\n", todo_list->done_nr);
1993 fclose(f);
1995 fprintf(stderr, "Rebasing (%d/%d)%s",
1996 todo_list->done_nr,
1997 todo_list->total_nr,
1998 opts->verbose ? "\n" : "\r");
2000 unlink(rebase_path_message());
2001 unlink(rebase_path_author_script());
2002 unlink(rebase_path_stopped_sha());
2003 unlink(rebase_path_amend());
2005 if (item->command <= TODO_SQUASH) {
2006 if (is_rebase_i(opts))
2007 setenv("GIT_REFLOG_ACTION", reflog_message(opts,
2008 command_to_string(item->command), NULL),
2010 res = do_pick_commit(item->command, item->commit,
2011 opts, is_final_fixup(todo_list));
2012 if (is_rebase_i(opts) && res < 0) {
2013 /* Reschedule */
2014 todo_list->current--;
2015 if (save_todo(todo_list, opts))
2016 return -1;
2018 if (item->command == TODO_EDIT) {
2019 struct commit *commit = item->commit;
2020 if (!res)
2021 fprintf(stderr,
2022 _("Stopped at %s... %.*s\n"),
2023 short_commit_name(commit),
2024 item->arg_len, item->arg);
2025 return error_with_patch(commit,
2026 item->arg, item->arg_len, opts, res,
2027 !res);
2029 if (is_rebase_i(opts) && !res)
2030 record_in_rewritten(&item->commit->object.oid,
2031 peek_command(todo_list, 1));
2032 if (res && is_fixup(item->command)) {
2033 if (res == 1)
2034 intend_to_amend();
2035 return error_failed_squash(item->commit, opts,
2036 item->arg_len, item->arg);
2037 } else if (res && is_rebase_i(opts))
2038 return res | error_with_patch(item->commit,
2039 item->arg, item->arg_len, opts, res,
2040 item->command == TODO_REWORD);
2041 } else if (item->command == TODO_EXEC) {
2042 char *end_of_arg = (char *)(item->arg + item->arg_len);
2043 int saved = *end_of_arg;
2044 struct stat st;
2046 *end_of_arg = '\0';
2047 res = do_exec(item->arg);
2048 *end_of_arg = saved;
2050 /* Reread the todo file if it has changed. */
2051 if (res)
2052 ; /* fall through */
2053 else if (stat(get_todo_path(opts), &st))
2054 res = error_errno(_("could not stat '%s'"),
2055 get_todo_path(opts));
2056 else if (match_stat_data(&todo_list->stat, &st)) {
2057 todo_list_release(todo_list);
2058 if (read_populate_todo(todo_list, opts))
2059 res = -1; /* message was printed */
2060 /* `current` will be incremented below */
2061 todo_list->current = -1;
2063 } else if (!is_noop(item->command))
2064 return error(_("unknown command %d"), item->command);
2066 todo_list->current++;
2067 if (res)
2068 return res;
2071 if (is_rebase_i(opts)) {
2072 struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
2073 struct stat st;
2075 /* Stopped in the middle, as planned? */
2076 if (todo_list->current < todo_list->nr)
2077 return 0;
2079 if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
2080 starts_with(head_ref.buf, "refs/")) {
2081 const char *msg;
2082 unsigned char head[20], orig[20];
2083 int res;
2085 if (get_sha1("HEAD", head)) {
2086 res = error(_("cannot read HEAD"));
2087 cleanup_head_ref:
2088 strbuf_release(&head_ref);
2089 strbuf_release(&buf);
2090 return res;
2092 if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
2093 get_sha1_hex(buf.buf, orig)) {
2094 res = error(_("could not read orig-head"));
2095 goto cleanup_head_ref;
2097 strbuf_reset(&buf);
2098 if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
2099 res = error(_("could not read 'onto'"));
2100 goto cleanup_head_ref;
2102 msg = reflog_message(opts, "finish", "%s onto %s",
2103 head_ref.buf, buf.buf);
2104 if (update_ref(msg, head_ref.buf, head, orig,
2105 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR)) {
2106 res = error(_("could not update %s"),
2107 head_ref.buf);
2108 goto cleanup_head_ref;
2110 msg = reflog_message(opts, "finish", "returning to %s",
2111 head_ref.buf);
2112 if (create_symref("HEAD", head_ref.buf, msg)) {
2113 res = error(_("could not update HEAD to %s"),
2114 head_ref.buf);
2115 goto cleanup_head_ref;
2117 strbuf_reset(&buf);
2120 if (opts->verbose) {
2121 struct rev_info log_tree_opt;
2122 struct object_id orig, head;
2124 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
2125 init_revisions(&log_tree_opt, NULL);
2126 log_tree_opt.diff = 1;
2127 log_tree_opt.diffopt.output_format =
2128 DIFF_FORMAT_DIFFSTAT;
2129 log_tree_opt.disable_stdin = 1;
2131 if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
2132 !get_sha1(buf.buf, orig.hash) &&
2133 !get_sha1("HEAD", head.hash)) {
2134 diff_tree_oid(&orig, &head, "",
2135 &log_tree_opt.diffopt);
2136 log_tree_diff_flush(&log_tree_opt);
2139 flush_rewritten_pending();
2140 if (!stat(rebase_path_rewritten_list(), &st) &&
2141 st.st_size > 0) {
2142 struct child_process child = CHILD_PROCESS_INIT;
2143 const char *post_rewrite_hook =
2144 find_hook("post-rewrite");
2146 child.in = open(rebase_path_rewritten_list(), O_RDONLY);
2147 child.git_cmd = 1;
2148 argv_array_push(&child.args, "notes");
2149 argv_array_push(&child.args, "copy");
2150 argv_array_push(&child.args, "--for-rewrite=rebase");
2151 /* we don't care if this copying failed */
2152 run_command(&child);
2154 if (post_rewrite_hook) {
2155 struct child_process hook = CHILD_PROCESS_INIT;
2157 hook.in = open(rebase_path_rewritten_list(),
2158 O_RDONLY);
2159 hook.stdout_to_stderr = 1;
2160 argv_array_push(&hook.args, post_rewrite_hook);
2161 argv_array_push(&hook.args, "rebase");
2162 /* we don't care if this hook failed */
2163 run_command(&hook);
2166 apply_autostash(opts);
2168 fprintf(stderr, "Successfully rebased and updated %s.\n",
2169 head_ref.buf);
2171 strbuf_release(&buf);
2172 strbuf_release(&head_ref);
2176 * Sequence of picks finished successfully; cleanup by
2177 * removing the .git/sequencer directory
2179 return sequencer_remove_state(opts);
2182 static int continue_single_pick(void)
2184 const char *argv[] = { "commit", NULL };
2186 if (!file_exists(git_path_cherry_pick_head()) &&
2187 !file_exists(git_path_revert_head()))
2188 return error(_("no cherry-pick or revert in progress"));
2189 return run_command_v_opt(argv, RUN_GIT_CMD);
2192 static int commit_staged_changes(struct replay_opts *opts)
2194 unsigned int flags = ALLOW_EMPTY | EDIT_MSG;
2196 if (has_unstaged_changes(1))
2197 return error(_("cannot rebase: You have unstaged changes."));
2198 if (!has_uncommitted_changes(0)) {
2199 const char *cherry_pick_head = git_path_cherry_pick_head();
2201 if (file_exists(cherry_pick_head) && unlink(cherry_pick_head))
2202 return error(_("could not remove CHERRY_PICK_HEAD"));
2203 return 0;
2206 if (file_exists(rebase_path_amend())) {
2207 struct strbuf rev = STRBUF_INIT;
2208 unsigned char head[20], to_amend[20];
2210 if (get_sha1("HEAD", head))
2211 return error(_("cannot amend non-existing commit"));
2212 if (!read_oneliner(&rev, rebase_path_amend(), 0))
2213 return error(_("invalid file: '%s'"), rebase_path_amend());
2214 if (get_sha1_hex(rev.buf, to_amend))
2215 return error(_("invalid contents: '%s'"),
2216 rebase_path_amend());
2217 if (hashcmp(head, to_amend))
2218 return error(_("\nYou have uncommitted changes in your "
2219 "working tree. Please, commit them\n"
2220 "first and then run 'git rebase "
2221 "--continue' again."));
2223 strbuf_release(&rev);
2224 flags |= AMEND_MSG;
2227 if (run_git_commit(rebase_path_message(), opts, flags))
2228 return error(_("could not commit staged changes."));
2229 unlink(rebase_path_amend());
2230 return 0;
2233 int sequencer_continue(struct replay_opts *opts)
2235 struct todo_list todo_list = TODO_LIST_INIT;
2236 int res;
2238 if (read_and_refresh_cache(opts))
2239 return -1;
2241 if (is_rebase_i(opts)) {
2242 if (commit_staged_changes(opts))
2243 return -1;
2244 } else if (!file_exists(get_todo_path(opts)))
2245 return continue_single_pick();
2246 if (read_populate_opts(opts))
2247 return -1;
2248 if ((res = read_populate_todo(&todo_list, opts)))
2249 goto release_todo_list;
2251 if (!is_rebase_i(opts)) {
2252 /* Verify that the conflict has been resolved */
2253 if (file_exists(git_path_cherry_pick_head()) ||
2254 file_exists(git_path_revert_head())) {
2255 res = continue_single_pick();
2256 if (res)
2257 goto release_todo_list;
2259 if (index_differs_from("HEAD", 0, 0)) {
2260 res = error_dirty_index(opts);
2261 goto release_todo_list;
2263 todo_list.current++;
2264 } else if (file_exists(rebase_path_stopped_sha())) {
2265 struct strbuf buf = STRBUF_INIT;
2266 struct object_id oid;
2268 if (read_oneliner(&buf, rebase_path_stopped_sha(), 1) &&
2269 !get_sha1_committish(buf.buf, oid.hash))
2270 record_in_rewritten(&oid, peek_command(&todo_list, 0));
2271 strbuf_release(&buf);
2274 res = pick_commits(&todo_list, opts);
2275 release_todo_list:
2276 todo_list_release(&todo_list);
2277 return res;
2280 static int single_pick(struct commit *cmit, struct replay_opts *opts)
2282 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
2283 return do_pick_commit(opts->action == REPLAY_PICK ?
2284 TODO_PICK : TODO_REVERT, cmit, opts, 0);
2287 int sequencer_pick_revisions(struct replay_opts *opts)
2289 struct todo_list todo_list = TODO_LIST_INIT;
2290 struct object_id oid;
2291 int i, res;
2293 assert(opts->revs);
2294 if (read_and_refresh_cache(opts))
2295 return -1;
2297 for (i = 0; i < opts->revs->pending.nr; i++) {
2298 struct object_id oid;
2299 const char *name = opts->revs->pending.objects[i].name;
2301 /* This happens when using --stdin. */
2302 if (!strlen(name))
2303 continue;
2305 if (!get_oid(name, &oid)) {
2306 if (!lookup_commit_reference_gently(&oid, 1)) {
2307 enum object_type type = sha1_object_info(oid.hash, NULL);
2308 return error(_("%s: can't cherry-pick a %s"),
2309 name, typename(type));
2311 } else
2312 return error(_("%s: bad revision"), name);
2316 * If we were called as "git cherry-pick <commit>", just
2317 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
2318 * REVERT_HEAD, and don't touch the sequencer state.
2319 * This means it is possible to cherry-pick in the middle
2320 * of a cherry-pick sequence.
2322 if (opts->revs->cmdline.nr == 1 &&
2323 opts->revs->cmdline.rev->whence == REV_CMD_REV &&
2324 opts->revs->no_walk &&
2325 !opts->revs->cmdline.rev->flags) {
2326 struct commit *cmit;
2327 if (prepare_revision_walk(opts->revs))
2328 return error(_("revision walk setup failed"));
2329 cmit = get_revision(opts->revs);
2330 if (!cmit || get_revision(opts->revs))
2331 return error("BUG: expected exactly one commit from walk");
2332 return single_pick(cmit, opts);
2336 * Start a new cherry-pick/ revert sequence; but
2337 * first, make sure that an existing one isn't in
2338 * progress
2341 if (walk_revs_populate_todo(&todo_list, opts) ||
2342 create_seq_dir() < 0)
2343 return -1;
2344 if (get_oid("HEAD", &oid) && (opts->action == REPLAY_REVERT))
2345 return error(_("can't revert as initial commit"));
2346 if (save_head(oid_to_hex(&oid)))
2347 return -1;
2348 if (save_opts(opts))
2349 return -1;
2350 update_abort_safety_file();
2351 res = pick_commits(&todo_list, opts);
2352 todo_list_release(&todo_list);
2353 return res;
2356 void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag)
2358 unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
2359 struct strbuf sob = STRBUF_INIT;
2360 int has_footer;
2362 strbuf_addstr(&sob, sign_off_header);
2363 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
2364 getenv("GIT_COMMITTER_EMAIL")));
2365 strbuf_addch(&sob, '\n');
2367 if (!ignore_footer)
2368 strbuf_complete_line(msgbuf);
2371 * If the whole message buffer is equal to the sob, pretend that we
2372 * found a conforming footer with a matching sob
2374 if (msgbuf->len - ignore_footer == sob.len &&
2375 !strncmp(msgbuf->buf, sob.buf, sob.len))
2376 has_footer = 3;
2377 else
2378 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
2380 if (!has_footer) {
2381 const char *append_newlines = NULL;
2382 size_t len = msgbuf->len - ignore_footer;
2384 if (!len) {
2386 * The buffer is completely empty. Leave foom for
2387 * the title and body to be filled in by the user.
2389 append_newlines = "\n\n";
2390 } else if (len == 1) {
2392 * Buffer contains a single newline. Add another
2393 * so that we leave room for the title and body.
2395 append_newlines = "\n";
2396 } else if (msgbuf->buf[len - 2] != '\n') {
2398 * Buffer ends with a single newline. Add another
2399 * so that there is an empty line between the message
2400 * body and the sob.
2402 append_newlines = "\n";
2403 } /* else, the buffer already ends with two newlines. */
2405 if (append_newlines)
2406 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2407 append_newlines, strlen(append_newlines));
2410 if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
2411 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
2412 sob.buf, sob.len);
2414 strbuf_release(&sob);