Merge branch 'js/no-more-legacy-stash'
[git/debian.git] / sequencer.c
blobfb978a53a0fa8c28fdcf1b826be2f0f3a4929134
1 #include "cache.h"
2 #include "config.h"
3 #include "lockfile.h"
4 #include "dir.h"
5 #include "object-store.h"
6 #include "object.h"
7 #include "commit.h"
8 #include "sequencer.h"
9 #include "tag.h"
10 #include "run-command.h"
11 #include "hook.h"
12 #include "exec-cmd.h"
13 #include "utf8.h"
14 #include "cache-tree.h"
15 #include "diff.h"
16 #include "revision.h"
17 #include "rerere.h"
18 #include "merge-ort.h"
19 #include "merge-ort-wrappers.h"
20 #include "refs.h"
21 #include "strvec.h"
22 #include "quote.h"
23 #include "trailer.h"
24 #include "log-tree.h"
25 #include "wt-status.h"
26 #include "hashmap.h"
27 #include "notes-utils.h"
28 #include "sigchain.h"
29 #include "unpack-trees.h"
30 #include "worktree.h"
31 #include "oidmap.h"
32 #include "oidset.h"
33 #include "commit-slab.h"
34 #include "alias.h"
35 #include "commit-reach.h"
36 #include "rebase-interactive.h"
37 #include "reset.h"
39 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
41 static const char sign_off_header[] = "Signed-off-by: ";
42 static const char cherry_picked_prefix[] = "(cherry picked from commit ";
44 GIT_PATH_FUNC(git_path_commit_editmsg, "COMMIT_EDITMSG")
46 static GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
48 static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
49 static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
50 static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
51 static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
53 static GIT_PATH_FUNC(rebase_path, "rebase-merge")
55 * The file containing rebase commands, comments, and empty lines.
56 * This file is created by "git rebase -i" then edited by the user. As
57 * the lines are processed, they are removed from the front of this
58 * file and written to the tail of 'done'.
60 GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
61 GIT_PATH_FUNC(rebase_path_todo_backup, "rebase-merge/git-rebase-todo.backup")
63 GIT_PATH_FUNC(rebase_path_dropped, "rebase-merge/dropped")
66 * The rebase command lines that have already been processed. A line
67 * is moved here when it is first handled, before any associated user
68 * actions.
70 static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
72 * The file to keep track of how many commands were already processed (e.g.
73 * for the prompt).
75 static GIT_PATH_FUNC(rebase_path_msgnum, "rebase-merge/msgnum")
77 * The file to keep track of how many commands are to be processed in total
78 * (e.g. for the prompt).
80 static GIT_PATH_FUNC(rebase_path_msgtotal, "rebase-merge/end")
82 * The commit message that is planned to be used for any changes that
83 * need to be committed following a user interaction.
85 static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
87 * The file into which is accumulated the suggested commit message for
88 * squash/fixup commands. When the first of a series of squash/fixups
89 * is seen, the file is created and the commit message from the
90 * previous commit and from the first squash/fixup commit are written
91 * to it. The commit message for each subsequent squash/fixup commit
92 * is appended to the file as it is processed.
94 static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
96 * If the current series of squash/fixups has not yet included a squash
97 * command, then this file exists and holds the commit message of the
98 * original "pick" commit. (If the series ends without a "squash"
99 * command, then this can be used as the commit message of the combined
100 * commit without opening the editor.)
102 static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
104 * This file contains the list fixup/squash commands that have been
105 * accumulated into message-fixup or message-squash so far.
107 static GIT_PATH_FUNC(rebase_path_current_fixups, "rebase-merge/current-fixups")
109 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
110 * GIT_AUTHOR_DATE that will be used for the commit that is currently
111 * being rebased.
113 static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
115 * When an "edit" rebase command is being processed, the SHA1 of the
116 * commit to be edited is recorded in this file. When "git rebase
117 * --continue" is executed, if there are any staged changes then they
118 * will be amended to the HEAD commit, but only provided the HEAD
119 * commit is still the commit to be edited. When any other rebase
120 * command is processed, this file is deleted.
122 static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
124 * When we stop at a given patch via the "edit" command, this file contains
125 * the commit object name of the corresponding patch.
127 static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
129 * For the post-rewrite hook, we make a list of rewritten commits and
130 * their new sha1s. The rewritten-pending list keeps the sha1s of
131 * commits that have been processed, but not committed yet,
132 * e.g. because they are waiting for a 'squash' command.
134 static GIT_PATH_FUNC(rebase_path_rewritten_list, "rebase-merge/rewritten-list")
135 static GIT_PATH_FUNC(rebase_path_rewritten_pending,
136 "rebase-merge/rewritten-pending")
139 * The path of the file containing the OID of the "squash onto" commit, i.e.
140 * the dummy commit used for `reset [new root]`.
142 static GIT_PATH_FUNC(rebase_path_squash_onto, "rebase-merge/squash-onto")
145 * The path of the file listing refs that need to be deleted after the rebase
146 * finishes. This is used by the `label` command to record the need for cleanup.
148 static GIT_PATH_FUNC(rebase_path_refs_to_delete, "rebase-merge/refs-to-delete")
151 * The following files are written by git-rebase just after parsing the
152 * command-line.
154 static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
155 static GIT_PATH_FUNC(rebase_path_cdate_is_adate, "rebase-merge/cdate_is_adate")
156 static GIT_PATH_FUNC(rebase_path_ignore_date, "rebase-merge/ignore_date")
157 static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
158 static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
159 static GIT_PATH_FUNC(rebase_path_quiet, "rebase-merge/quiet")
160 static GIT_PATH_FUNC(rebase_path_signoff, "rebase-merge/signoff")
161 static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
162 static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
163 static GIT_PATH_FUNC(rebase_path_autostash, "rebase-merge/autostash")
164 static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy")
165 static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts")
166 static GIT_PATH_FUNC(rebase_path_allow_rerere_autoupdate, "rebase-merge/allow_rerere_autoupdate")
167 static GIT_PATH_FUNC(rebase_path_reschedule_failed_exec, "rebase-merge/reschedule-failed-exec")
168 static GIT_PATH_FUNC(rebase_path_no_reschedule_failed_exec, "rebase-merge/no-reschedule-failed-exec")
169 static GIT_PATH_FUNC(rebase_path_drop_redundant_commits, "rebase-merge/drop_redundant_commits")
170 static GIT_PATH_FUNC(rebase_path_keep_redundant_commits, "rebase-merge/keep_redundant_commits")
172 static int git_sequencer_config(const char *k, const char *v, void *cb)
174 struct replay_opts *opts = cb;
175 int status;
177 if (!strcmp(k, "commit.cleanup")) {
178 const char *s;
180 status = git_config_string(&s, k, v);
181 if (status)
182 return status;
184 if (!strcmp(s, "verbatim")) {
185 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
186 opts->explicit_cleanup = 1;
187 } else if (!strcmp(s, "whitespace")) {
188 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE;
189 opts->explicit_cleanup = 1;
190 } else if (!strcmp(s, "strip")) {
191 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_ALL;
192 opts->explicit_cleanup = 1;
193 } else if (!strcmp(s, "scissors")) {
194 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SCISSORS;
195 opts->explicit_cleanup = 1;
196 } else {
197 warning(_("invalid commit message cleanup mode '%s'"),
201 free((char *)s);
202 return status;
205 if (!strcmp(k, "commit.gpgsign")) {
206 opts->gpg_sign = git_config_bool(k, v) ? xstrdup("") : NULL;
207 return 0;
210 if (!opts->default_strategy && !strcmp(k, "pull.twohead")) {
211 int ret = git_config_string((const char**)&opts->default_strategy, k, v);
212 if (ret == 0) {
214 * pull.twohead is allowed to be multi-valued; we only
215 * care about the first value.
217 char *tmp = strchr(opts->default_strategy, ' ');
218 if (tmp)
219 *tmp = '\0';
221 return ret;
224 status = git_gpg_config(k, v, NULL);
225 if (status)
226 return status;
228 return git_diff_basic_config(k, v, NULL);
231 void sequencer_init_config(struct replay_opts *opts)
233 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
234 git_config(git_sequencer_config, opts);
237 static inline int is_rebase_i(const struct replay_opts *opts)
239 return opts->action == REPLAY_INTERACTIVE_REBASE;
242 static const char *get_dir(const struct replay_opts *opts)
244 if (is_rebase_i(opts))
245 return rebase_path();
246 return git_path_seq_dir();
249 static const char *get_todo_path(const struct replay_opts *opts)
251 if (is_rebase_i(opts))
252 return rebase_path_todo();
253 return git_path_todo_file();
257 * Returns 0 for non-conforming footer
258 * Returns 1 for conforming footer
259 * Returns 2 when sob exists within conforming footer
260 * Returns 3 when sob exists within conforming footer as last entry
262 static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
263 size_t ignore_footer)
265 struct process_trailer_options opts = PROCESS_TRAILER_OPTIONS_INIT;
266 struct trailer_info info;
267 size_t i;
268 int found_sob = 0, found_sob_last = 0;
269 char saved_char;
271 opts.no_divider = 1;
273 if (ignore_footer) {
274 saved_char = sb->buf[sb->len - ignore_footer];
275 sb->buf[sb->len - ignore_footer] = '\0';
278 trailer_info_get(&info, sb->buf, &opts);
280 if (ignore_footer)
281 sb->buf[sb->len - ignore_footer] = saved_char;
283 if (info.trailer_start == info.trailer_end)
284 return 0;
286 for (i = 0; i < info.trailer_nr; i++)
287 if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
288 found_sob = 1;
289 if (i == info.trailer_nr - 1)
290 found_sob_last = 1;
293 trailer_info_release(&info);
295 if (found_sob_last)
296 return 3;
297 if (found_sob)
298 return 2;
299 return 1;
302 static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
304 static struct strbuf buf = STRBUF_INIT;
306 strbuf_reset(&buf);
307 if (opts->gpg_sign)
308 sq_quotef(&buf, "-S%s", opts->gpg_sign);
309 return buf.buf;
312 int sequencer_remove_state(struct replay_opts *opts)
314 struct strbuf buf = STRBUF_INIT;
315 int i, ret = 0;
317 if (is_rebase_i(opts) &&
318 strbuf_read_file(&buf, rebase_path_refs_to_delete(), 0) > 0) {
319 char *p = buf.buf;
320 while (*p) {
321 char *eol = strchr(p, '\n');
322 if (eol)
323 *eol = '\0';
324 if (delete_ref("(rebase) cleanup", p, NULL, 0) < 0) {
325 warning(_("could not delete '%s'"), p);
326 ret = -1;
328 if (!eol)
329 break;
330 p = eol + 1;
334 free(opts->gpg_sign);
335 free(opts->default_strategy);
336 free(opts->strategy);
337 for (i = 0; i < opts->xopts_nr; i++)
338 free(opts->xopts[i]);
339 free(opts->xopts);
340 strbuf_release(&opts->current_fixups);
342 strbuf_reset(&buf);
343 strbuf_addstr(&buf, get_dir(opts));
344 if (remove_dir_recursively(&buf, 0))
345 ret = error(_("could not remove '%s'"), buf.buf);
346 strbuf_release(&buf);
348 return ret;
351 static const char *action_name(const struct replay_opts *opts)
353 switch (opts->action) {
354 case REPLAY_REVERT:
355 return N_("revert");
356 case REPLAY_PICK:
357 return N_("cherry-pick");
358 case REPLAY_INTERACTIVE_REBASE:
359 return N_("rebase");
361 die(_("unknown action: %d"), opts->action);
364 struct commit_message {
365 char *parent_label;
366 char *label;
367 char *subject;
368 const char *message;
371 static const char *short_commit_name(struct commit *commit)
373 return find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV);
376 static int get_message(struct commit *commit, struct commit_message *out)
378 const char *abbrev, *subject;
379 int subject_len;
381 out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
382 abbrev = short_commit_name(commit);
384 subject_len = find_commit_subject(out->message, &subject);
386 out->subject = xmemdupz(subject, subject_len);
387 out->label = xstrfmt("%s (%s)", abbrev, out->subject);
388 out->parent_label = xstrfmt("parent of %s", out->label);
390 return 0;
393 static void free_message(struct commit *commit, struct commit_message *msg)
395 free(msg->parent_label);
396 free(msg->label);
397 free(msg->subject);
398 unuse_commit_buffer(commit, msg->message);
401 static void print_advice(struct repository *r, int show_hint,
402 struct replay_opts *opts)
404 char *msg = getenv("GIT_CHERRY_PICK_HELP");
406 if (msg) {
407 advise("%s\n", msg);
409 * A conflict has occurred but the porcelain
410 * (typically rebase --interactive) wants to take care
411 * of the commit itself so remove CHERRY_PICK_HEAD
413 refs_delete_ref(get_main_ref_store(r), "", "CHERRY_PICK_HEAD",
414 NULL, 0);
415 return;
418 if (show_hint) {
419 if (opts->no_commit)
420 advise(_("after resolving the conflicts, mark the corrected paths\n"
421 "with 'git add <paths>' or 'git rm <paths>'"));
422 else if (opts->action == REPLAY_PICK)
423 advise(_("After resolving the conflicts, mark them with\n"
424 "\"git add/rm <pathspec>\", then run\n"
425 "\"git cherry-pick --continue\".\n"
426 "You can instead skip this commit with \"git cherry-pick --skip\".\n"
427 "To abort and get back to the state before \"git cherry-pick\",\n"
428 "run \"git cherry-pick --abort\"."));
429 else if (opts->action == REPLAY_REVERT)
430 advise(_("After resolving the conflicts, mark them with\n"
431 "\"git add/rm <pathspec>\", then run\n"
432 "\"git revert --continue\".\n"
433 "You can instead skip this commit with \"git revert --skip\".\n"
434 "To abort and get back to the state before \"git revert\",\n"
435 "run \"git revert --abort\"."));
436 else
437 BUG("unexpected pick action in print_advice()");
441 static int write_message(const void *buf, size_t len, const char *filename,
442 int append_eol)
444 struct lock_file msg_file = LOCK_INIT;
446 int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
447 if (msg_fd < 0)
448 return error_errno(_("could not lock '%s'"), filename);
449 if (write_in_full(msg_fd, buf, len) < 0) {
450 error_errno(_("could not write to '%s'"), filename);
451 rollback_lock_file(&msg_file);
452 return -1;
454 if (append_eol && write(msg_fd, "\n", 1) < 0) {
455 error_errno(_("could not write eol to '%s'"), filename);
456 rollback_lock_file(&msg_file);
457 return -1;
459 if (commit_lock_file(&msg_file) < 0)
460 return error(_("failed to finalize '%s'"), filename);
462 return 0;
465 int read_oneliner(struct strbuf *buf,
466 const char *path, unsigned flags)
468 int orig_len = buf->len;
470 if (strbuf_read_file(buf, path, 0) < 0) {
471 if ((flags & READ_ONELINER_WARN_MISSING) ||
472 (errno != ENOENT && errno != ENOTDIR))
473 warning_errno(_("could not read '%s'"), path);
474 return 0;
477 if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
478 if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
479 --buf->len;
480 buf->buf[buf->len] = '\0';
483 if ((flags & READ_ONELINER_SKIP_IF_EMPTY) && buf->len == orig_len)
484 return 0;
486 return 1;
489 static struct tree *empty_tree(struct repository *r)
491 return lookup_tree(r, the_hash_algo->empty_tree);
494 static int error_dirty_index(struct repository *repo, struct replay_opts *opts)
496 if (repo_read_index_unmerged(repo))
497 return error_resolve_conflict(_(action_name(opts)));
499 error(_("your local changes would be overwritten by %s."),
500 _(action_name(opts)));
502 if (advice_enabled(ADVICE_COMMIT_BEFORE_MERGE))
503 advise(_("commit your changes or stash them to proceed."));
504 return -1;
507 static void update_abort_safety_file(void)
509 struct object_id head;
511 /* Do nothing on a single-pick */
512 if (!file_exists(git_path_seq_dir()))
513 return;
515 if (!get_oid("HEAD", &head))
516 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
517 else
518 write_file(git_path_abort_safety_file(), "%s", "");
521 static int fast_forward_to(struct repository *r,
522 const struct object_id *to,
523 const struct object_id *from,
524 int unborn,
525 struct replay_opts *opts)
527 struct ref_transaction *transaction;
528 struct strbuf sb = STRBUF_INIT;
529 struct strbuf err = STRBUF_INIT;
531 repo_read_index(r);
532 if (checkout_fast_forward(r, from, to, 1))
533 return -1; /* the callee should have complained already */
535 strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
537 transaction = ref_transaction_begin(&err);
538 if (!transaction ||
539 ref_transaction_update(transaction, "HEAD",
540 to, unborn && !is_rebase_i(opts) ?
541 null_oid() : from,
542 0, sb.buf, &err) ||
543 ref_transaction_commit(transaction, &err)) {
544 ref_transaction_free(transaction);
545 error("%s", err.buf);
546 strbuf_release(&sb);
547 strbuf_release(&err);
548 return -1;
551 strbuf_release(&sb);
552 strbuf_release(&err);
553 ref_transaction_free(transaction);
554 update_abort_safety_file();
555 return 0;
558 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
559 int use_editor)
561 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
562 return use_editor ? COMMIT_MSG_CLEANUP_ALL :
563 COMMIT_MSG_CLEANUP_SPACE;
564 else if (!strcmp(cleanup_arg, "verbatim"))
565 return COMMIT_MSG_CLEANUP_NONE;
566 else if (!strcmp(cleanup_arg, "whitespace"))
567 return COMMIT_MSG_CLEANUP_SPACE;
568 else if (!strcmp(cleanup_arg, "strip"))
569 return COMMIT_MSG_CLEANUP_ALL;
570 else if (!strcmp(cleanup_arg, "scissors"))
571 return use_editor ? COMMIT_MSG_CLEANUP_SCISSORS :
572 COMMIT_MSG_CLEANUP_SPACE;
573 else
574 die(_("Invalid cleanup mode %s"), cleanup_arg);
578 * NB using int rather than enum cleanup_mode to stop clang's
579 * -Wtautological-constant-out-of-range-compare complaining that the comparison
580 * is always true.
582 static const char *describe_cleanup_mode(int cleanup_mode)
584 static const char *modes[] = { "whitespace",
585 "verbatim",
586 "scissors",
587 "strip" };
589 if (cleanup_mode < ARRAY_SIZE(modes))
590 return modes[cleanup_mode];
592 BUG("invalid cleanup_mode provided (%d)", cleanup_mode);
595 void append_conflicts_hint(struct index_state *istate,
596 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode)
598 int i;
600 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
601 strbuf_addch(msgbuf, '\n');
602 wt_status_append_cut_line(msgbuf);
603 strbuf_addch(msgbuf, comment_line_char);
606 strbuf_addch(msgbuf, '\n');
607 strbuf_commented_addf(msgbuf, "Conflicts:\n");
608 for (i = 0; i < istate->cache_nr;) {
609 const struct cache_entry *ce = istate->cache[i++];
610 if (ce_stage(ce)) {
611 strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
612 while (i < istate->cache_nr &&
613 !strcmp(ce->name, istate->cache[i]->name))
614 i++;
619 static int do_recursive_merge(struct repository *r,
620 struct commit *base, struct commit *next,
621 const char *base_label, const char *next_label,
622 struct object_id *head, struct strbuf *msgbuf,
623 struct replay_opts *opts)
625 struct merge_options o;
626 struct merge_result result;
627 struct tree *next_tree, *base_tree, *head_tree;
628 int clean, show_output;
629 int i;
630 struct lock_file index_lock = LOCK_INIT;
632 if (repo_hold_locked_index(r, &index_lock, LOCK_REPORT_ON_ERROR) < 0)
633 return -1;
635 repo_read_index(r);
637 init_merge_options(&o, r);
638 o.ancestor = base ? base_label : "(empty tree)";
639 o.branch1 = "HEAD";
640 o.branch2 = next ? next_label : "(empty tree)";
641 if (is_rebase_i(opts))
642 o.buffer_output = 2;
643 o.show_rename_progress = 1;
645 head_tree = parse_tree_indirect(head);
646 next_tree = next ? get_commit_tree(next) : empty_tree(r);
647 base_tree = base ? get_commit_tree(base) : empty_tree(r);
649 for (i = 0; i < opts->xopts_nr; i++)
650 parse_merge_opt(&o, opts->xopts[i]);
652 if (!opts->strategy || !strcmp(opts->strategy, "ort")) {
653 memset(&result, 0, sizeof(result));
654 merge_incore_nonrecursive(&o, base_tree, head_tree, next_tree,
655 &result);
656 show_output = !is_rebase_i(opts) || !result.clean;
658 * TODO: merge_switch_to_result will update index/working tree;
659 * we only really want to do that if !result.clean || this is
660 * the final patch to be picked. But determining this is the
661 * final patch would take some work, and "head_tree" would need
662 * to be replace with the tree the index matched before we
663 * started doing any picks.
665 merge_switch_to_result(&o, head_tree, &result, 1, show_output);
666 clean = result.clean;
667 } else {
668 ensure_full_index(r->index);
669 clean = merge_trees(&o, head_tree, next_tree, base_tree);
670 if (is_rebase_i(opts) && clean <= 0)
671 fputs(o.obuf.buf, stdout);
672 strbuf_release(&o.obuf);
674 if (clean < 0) {
675 rollback_lock_file(&index_lock);
676 return clean;
679 if (write_locked_index(r->index, &index_lock,
680 COMMIT_LOCK | SKIP_IF_UNCHANGED))
682 * TRANSLATORS: %s will be "revert", "cherry-pick" or
683 * "rebase".
685 return error(_("%s: Unable to write new index file"),
686 _(action_name(opts)));
688 if (!clean)
689 append_conflicts_hint(r->index, msgbuf,
690 opts->default_msg_cleanup);
692 return !clean;
695 static struct object_id *get_cache_tree_oid(struct index_state *istate)
697 if (!cache_tree_fully_valid(istate->cache_tree))
698 if (cache_tree_update(istate, 0)) {
699 error(_("unable to update cache tree"));
700 return NULL;
703 return &istate->cache_tree->oid;
706 static int is_index_unchanged(struct repository *r)
708 struct object_id head_oid, *cache_tree_oid;
709 struct commit *head_commit;
710 struct index_state *istate = r->index;
712 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, &head_oid, NULL))
713 return error(_("could not resolve HEAD commit"));
715 head_commit = lookup_commit(r, &head_oid);
718 * If head_commit is NULL, check_commit, called from
719 * lookup_commit, would have indicated that head_commit is not
720 * a commit object already. parse_commit() will return failure
721 * without further complaints in such a case. Otherwise, if
722 * the commit is invalid, parse_commit() will complain. So
723 * there is nothing for us to say here. Just return failure.
725 if (parse_commit(head_commit))
726 return -1;
728 if (!(cache_tree_oid = get_cache_tree_oid(istate)))
729 return -1;
731 return oideq(cache_tree_oid, get_commit_tree_oid(head_commit));
734 static int write_author_script(const char *message)
736 struct strbuf buf = STRBUF_INIT;
737 const char *eol;
738 int res;
740 for (;;)
741 if (!*message || starts_with(message, "\n")) {
742 missing_author:
743 /* Missing 'author' line? */
744 unlink(rebase_path_author_script());
745 return 0;
746 } else if (skip_prefix(message, "author ", &message))
747 break;
748 else if ((eol = strchr(message, '\n')))
749 message = eol + 1;
750 else
751 goto missing_author;
753 strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
754 while (*message && *message != '\n' && *message != '\r')
755 if (skip_prefix(message, " <", &message))
756 break;
757 else if (*message != '\'')
758 strbuf_addch(&buf, *(message++));
759 else
760 strbuf_addf(&buf, "'\\%c'", *(message++));
761 strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
762 while (*message && *message != '\n' && *message != '\r')
763 if (skip_prefix(message, "> ", &message))
764 break;
765 else if (*message != '\'')
766 strbuf_addch(&buf, *(message++));
767 else
768 strbuf_addf(&buf, "'\\%c'", *(message++));
769 strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
770 while (*message && *message != '\n' && *message != '\r')
771 if (*message != '\'')
772 strbuf_addch(&buf, *(message++));
773 else
774 strbuf_addf(&buf, "'\\%c'", *(message++));
775 strbuf_addch(&buf, '\'');
776 res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
777 strbuf_release(&buf);
778 return res;
782 * Take a series of KEY='VALUE' lines where VALUE part is
783 * sq-quoted, and append <KEY, VALUE> at the end of the string list
785 static int parse_key_value_squoted(char *buf, struct string_list *list)
787 while (*buf) {
788 struct string_list_item *item;
789 char *np;
790 char *cp = strchr(buf, '=');
791 if (!cp) {
792 np = strchrnul(buf, '\n');
793 return error(_("no key present in '%.*s'"),
794 (int) (np - buf), buf);
796 np = strchrnul(cp, '\n');
797 *cp++ = '\0';
798 item = string_list_append(list, buf);
800 buf = np + (*np == '\n');
801 *np = '\0';
802 cp = sq_dequote(cp);
803 if (!cp)
804 return error(_("unable to dequote value of '%s'"),
805 item->string);
806 item->util = xstrdup(cp);
808 return 0;
812 * Reads and parses the state directory's "author-script" file, and sets name,
813 * email and date accordingly.
814 * Returns 0 on success, -1 if the file could not be parsed.
816 * The author script is of the format:
818 * GIT_AUTHOR_NAME='$author_name'
819 * GIT_AUTHOR_EMAIL='$author_email'
820 * GIT_AUTHOR_DATE='$author_date'
822 * where $author_name, $author_email and $author_date are quoted. We are strict
823 * with our parsing, as the file was meant to be eval'd in the now-removed
824 * git-am.sh/git-rebase--interactive.sh scripts, and thus if the file differs
825 * from what this function expects, it is better to bail out than to do
826 * something that the user does not expect.
828 int read_author_script(const char *path, char **name, char **email, char **date,
829 int allow_missing)
831 struct strbuf buf = STRBUF_INIT;
832 struct string_list kv = STRING_LIST_INIT_DUP;
833 int retval = -1; /* assume failure */
834 int i, name_i = -2, email_i = -2, date_i = -2, err = 0;
836 if (strbuf_read_file(&buf, path, 256) <= 0) {
837 strbuf_release(&buf);
838 if (errno == ENOENT && allow_missing)
839 return 0;
840 else
841 return error_errno(_("could not open '%s' for reading"),
842 path);
845 if (parse_key_value_squoted(buf.buf, &kv))
846 goto finish;
848 for (i = 0; i < kv.nr; i++) {
849 if (!strcmp(kv.items[i].string, "GIT_AUTHOR_NAME")) {
850 if (name_i != -2)
851 name_i = error(_("'GIT_AUTHOR_NAME' already given"));
852 else
853 name_i = i;
854 } else if (!strcmp(kv.items[i].string, "GIT_AUTHOR_EMAIL")) {
855 if (email_i != -2)
856 email_i = error(_("'GIT_AUTHOR_EMAIL' already given"));
857 else
858 email_i = i;
859 } else if (!strcmp(kv.items[i].string, "GIT_AUTHOR_DATE")) {
860 if (date_i != -2)
861 date_i = error(_("'GIT_AUTHOR_DATE' already given"));
862 else
863 date_i = i;
864 } else {
865 err = error(_("unknown variable '%s'"),
866 kv.items[i].string);
869 if (name_i == -2)
870 error(_("missing 'GIT_AUTHOR_NAME'"));
871 if (email_i == -2)
872 error(_("missing 'GIT_AUTHOR_EMAIL'"));
873 if (date_i == -2)
874 error(_("missing 'GIT_AUTHOR_DATE'"));
875 if (date_i < 0 || email_i < 0 || date_i < 0 || err)
876 goto finish;
877 *name = kv.items[name_i].util;
878 *email = kv.items[email_i].util;
879 *date = kv.items[date_i].util;
880 retval = 0;
881 finish:
882 string_list_clear(&kv, !!retval);
883 strbuf_release(&buf);
884 return retval;
888 * Read a GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL AND GIT_AUTHOR_DATE from a
889 * file with shell quoting into struct strvec. Returns -1 on
890 * error, 0 otherwise.
892 static int read_env_script(struct strvec *env)
894 char *name, *email, *date;
896 if (read_author_script(rebase_path_author_script(),
897 &name, &email, &date, 0))
898 return -1;
900 strvec_pushf(env, "GIT_AUTHOR_NAME=%s", name);
901 strvec_pushf(env, "GIT_AUTHOR_EMAIL=%s", email);
902 strvec_pushf(env, "GIT_AUTHOR_DATE=%s", date);
903 free(name);
904 free(email);
905 free(date);
907 return 0;
910 static char *get_author(const char *message)
912 size_t len;
913 const char *a;
915 a = find_commit_header(message, "author", &len);
916 if (a)
917 return xmemdupz(a, len);
919 return NULL;
922 static const char *author_date_from_env_array(const struct strvec *env)
924 int i;
925 const char *date;
927 for (i = 0; i < env->nr; i++)
928 if (skip_prefix(env->v[i],
929 "GIT_AUTHOR_DATE=", &date))
930 return date;
932 * If GIT_AUTHOR_DATE is missing we should have already errored out when
933 * reading the script
935 BUG("GIT_AUTHOR_DATE missing from author script");
938 static const char staged_changes_advice[] =
939 N_("you have staged changes in your working tree\n"
940 "If these changes are meant to be squashed into the previous commit, run:\n"
941 "\n"
942 " git commit --amend %s\n"
943 "\n"
944 "If they are meant to go into a new commit, run:\n"
945 "\n"
946 " git commit %s\n"
947 "\n"
948 "In both cases, once you're done, continue with:\n"
949 "\n"
950 " git rebase --continue\n");
952 #define ALLOW_EMPTY (1<<0)
953 #define EDIT_MSG (1<<1)
954 #define AMEND_MSG (1<<2)
955 #define CLEANUP_MSG (1<<3)
956 #define VERIFY_MSG (1<<4)
957 #define CREATE_ROOT_COMMIT (1<<5)
958 #define VERBATIM_MSG (1<<6)
960 static int run_command_silent_on_success(struct child_process *cmd)
962 struct strbuf buf = STRBUF_INIT;
963 int rc;
965 cmd->stdout_to_stderr = 1;
966 rc = pipe_command(cmd,
967 NULL, 0,
968 NULL, 0,
969 &buf, 0);
971 if (rc)
972 fputs(buf.buf, stderr);
973 strbuf_release(&buf);
974 return rc;
978 * If we are cherry-pick, and if the merge did not result in
979 * hand-editing, we will hit this commit and inherit the original
980 * author date and name.
982 * If we are revert, or if our cherry-pick results in a hand merge,
983 * we had better say that the current user is responsible for that.
985 * An exception is when run_git_commit() is called during an
986 * interactive rebase: in that case, we will want to retain the
987 * author metadata.
989 static int run_git_commit(const char *defmsg,
990 struct replay_opts *opts,
991 unsigned int flags)
993 struct child_process cmd = CHILD_PROCESS_INIT;
995 if ((flags & CLEANUP_MSG) && (flags & VERBATIM_MSG))
996 BUG("CLEANUP_MSG and VERBATIM_MSG are mutually exclusive");
998 cmd.git_cmd = 1;
1000 if (is_rebase_i(opts) &&
1001 ((opts->committer_date_is_author_date && !opts->ignore_date) ||
1002 !(!defmsg && (flags & AMEND_MSG))) &&
1003 read_env_script(&cmd.env_array)) {
1004 const char *gpg_opt = gpg_sign_opt_quoted(opts);
1006 return error(_(staged_changes_advice),
1007 gpg_opt, gpg_opt);
1010 if (opts->committer_date_is_author_date)
1011 strvec_pushf(&cmd.env_array, "GIT_COMMITTER_DATE=%s",
1012 opts->ignore_date ?
1013 "" :
1014 author_date_from_env_array(&cmd.env_array));
1015 if (opts->ignore_date)
1016 strvec_push(&cmd.env_array, "GIT_AUTHOR_DATE=");
1018 strvec_push(&cmd.args, "commit");
1020 if (!(flags & VERIFY_MSG))
1021 strvec_push(&cmd.args, "-n");
1022 if ((flags & AMEND_MSG))
1023 strvec_push(&cmd.args, "--amend");
1024 if (opts->gpg_sign)
1025 strvec_pushf(&cmd.args, "-S%s", opts->gpg_sign);
1026 else
1027 strvec_push(&cmd.args, "--no-gpg-sign");
1028 if (defmsg)
1029 strvec_pushl(&cmd.args, "-F", defmsg, NULL);
1030 else if (!(flags & EDIT_MSG))
1031 strvec_pushl(&cmd.args, "-C", "HEAD", NULL);
1032 if ((flags & CLEANUP_MSG))
1033 strvec_push(&cmd.args, "--cleanup=strip");
1034 if ((flags & VERBATIM_MSG))
1035 strvec_push(&cmd.args, "--cleanup=verbatim");
1036 if ((flags & EDIT_MSG))
1037 strvec_push(&cmd.args, "-e");
1038 else if (!(flags & CLEANUP_MSG) &&
1039 !opts->signoff && !opts->record_origin &&
1040 !opts->explicit_cleanup)
1041 strvec_push(&cmd.args, "--cleanup=verbatim");
1043 if ((flags & ALLOW_EMPTY))
1044 strvec_push(&cmd.args, "--allow-empty");
1046 if (!(flags & EDIT_MSG))
1047 strvec_push(&cmd.args, "--allow-empty-message");
1049 if (is_rebase_i(opts) && !(flags & EDIT_MSG))
1050 return run_command_silent_on_success(&cmd);
1051 else
1052 return run_command(&cmd);
1055 static int rest_is_empty(const struct strbuf *sb, int start)
1057 int i, eol;
1058 const char *nl;
1060 /* Check if the rest is just whitespace and Signed-off-by's. */
1061 for (i = start; i < sb->len; i++) {
1062 nl = memchr(sb->buf + i, '\n', sb->len - i);
1063 if (nl)
1064 eol = nl - sb->buf;
1065 else
1066 eol = sb->len;
1068 if (strlen(sign_off_header) <= eol - i &&
1069 starts_with(sb->buf + i, sign_off_header)) {
1070 i = eol;
1071 continue;
1073 while (i < eol)
1074 if (!isspace(sb->buf[i++]))
1075 return 0;
1078 return 1;
1081 void cleanup_message(struct strbuf *msgbuf,
1082 enum commit_msg_cleanup_mode cleanup_mode, int verbose)
1084 if (verbose || /* Truncate the message just before the diff, if any. */
1085 cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS)
1086 strbuf_setlen(msgbuf, wt_status_locate_end(msgbuf->buf, msgbuf->len));
1087 if (cleanup_mode != COMMIT_MSG_CLEANUP_NONE)
1088 strbuf_stripspace(msgbuf, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
1092 * Find out if the message in the strbuf contains only whitespace and
1093 * Signed-off-by lines.
1095 int message_is_empty(const struct strbuf *sb,
1096 enum commit_msg_cleanup_mode cleanup_mode)
1098 if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
1099 return 0;
1100 return rest_is_empty(sb, 0);
1104 * See if the user edited the message in the editor or left what
1105 * was in the template intact
1107 int template_untouched(const struct strbuf *sb, const char *template_file,
1108 enum commit_msg_cleanup_mode cleanup_mode)
1110 struct strbuf tmpl = STRBUF_INIT;
1111 const char *start;
1113 if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
1114 return 0;
1116 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
1117 return 0;
1119 strbuf_stripspace(&tmpl, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
1120 if (!skip_prefix(sb->buf, tmpl.buf, &start))
1121 start = sb->buf;
1122 strbuf_release(&tmpl);
1123 return rest_is_empty(sb, start - sb->buf);
1126 int update_head_with_reflog(const struct commit *old_head,
1127 const struct object_id *new_head,
1128 const char *action, const struct strbuf *msg,
1129 struct strbuf *err)
1131 struct ref_transaction *transaction;
1132 struct strbuf sb = STRBUF_INIT;
1133 const char *nl;
1134 int ret = 0;
1136 if (action) {
1137 strbuf_addstr(&sb, action);
1138 strbuf_addstr(&sb, ": ");
1141 nl = strchr(msg->buf, '\n');
1142 if (nl) {
1143 strbuf_add(&sb, msg->buf, nl + 1 - msg->buf);
1144 } else {
1145 strbuf_addbuf(&sb, msg);
1146 strbuf_addch(&sb, '\n');
1149 transaction = ref_transaction_begin(err);
1150 if (!transaction ||
1151 ref_transaction_update(transaction, "HEAD", new_head,
1152 old_head ? &old_head->object.oid : null_oid(),
1153 0, sb.buf, err) ||
1154 ref_transaction_commit(transaction, err)) {
1155 ret = -1;
1157 ref_transaction_free(transaction);
1158 strbuf_release(&sb);
1160 return ret;
1163 static int run_rewrite_hook(const struct object_id *oldoid,
1164 const struct object_id *newoid)
1166 struct child_process proc = CHILD_PROCESS_INIT;
1167 int code;
1168 struct strbuf sb = STRBUF_INIT;
1169 const char *hook_path = find_hook("post-rewrite");
1171 if (!hook_path)
1172 return 0;
1174 strvec_pushl(&proc.args, hook_path, "amend", NULL);
1175 proc.in = -1;
1176 proc.stdout_to_stderr = 1;
1177 proc.trace2_hook_name = "post-rewrite";
1179 code = start_command(&proc);
1180 if (code)
1181 return code;
1182 strbuf_addf(&sb, "%s %s\n", oid_to_hex(oldoid), oid_to_hex(newoid));
1183 sigchain_push(SIGPIPE, SIG_IGN);
1184 write_in_full(proc.in, sb.buf, sb.len);
1185 close(proc.in);
1186 strbuf_release(&sb);
1187 sigchain_pop(SIGPIPE);
1188 return finish_command(&proc);
1191 void commit_post_rewrite(struct repository *r,
1192 const struct commit *old_head,
1193 const struct object_id *new_head)
1195 struct notes_rewrite_cfg *cfg;
1197 cfg = init_copy_notes_for_rewrite("amend");
1198 if (cfg) {
1199 /* we are amending, so old_head is not NULL */
1200 copy_note_for_rewrite(cfg, &old_head->object.oid, new_head);
1201 finish_copy_notes_for_rewrite(r, cfg, "Notes added by 'git commit --amend'");
1203 run_rewrite_hook(&old_head->object.oid, new_head);
1206 static int run_prepare_commit_msg_hook(struct repository *r,
1207 struct strbuf *msg,
1208 const char *commit)
1210 int ret = 0;
1211 const char *name, *arg1 = NULL, *arg2 = NULL;
1213 name = git_path_commit_editmsg();
1214 if (write_message(msg->buf, msg->len, name, 0))
1215 return -1;
1217 if (commit) {
1218 arg1 = "commit";
1219 arg2 = commit;
1220 } else {
1221 arg1 = "message";
1223 if (run_commit_hook(0, r->index_file, "prepare-commit-msg", name,
1224 arg1, arg2, NULL))
1225 ret = error(_("'prepare-commit-msg' hook failed"));
1227 return ret;
1230 static const char implicit_ident_advice_noconfig[] =
1231 N_("Your name and email address were configured automatically based\n"
1232 "on your username and hostname. Please check that they are accurate.\n"
1233 "You can suppress this message by setting them explicitly. Run the\n"
1234 "following command and follow the instructions in your editor to edit\n"
1235 "your configuration file:\n"
1236 "\n"
1237 " git config --global --edit\n"
1238 "\n"
1239 "After doing this, you may fix the identity used for this commit with:\n"
1240 "\n"
1241 " git commit --amend --reset-author\n");
1243 static const char implicit_ident_advice_config[] =
1244 N_("Your name and email address were configured automatically based\n"
1245 "on your username and hostname. Please check that they are accurate.\n"
1246 "You can suppress this message by setting them explicitly:\n"
1247 "\n"
1248 " git config --global user.name \"Your Name\"\n"
1249 " git config --global user.email you@example.com\n"
1250 "\n"
1251 "After doing this, you may fix the identity used for this commit with:\n"
1252 "\n"
1253 " git commit --amend --reset-author\n");
1255 static const char *implicit_ident_advice(void)
1257 char *user_config = interpolate_path("~/.gitconfig", 0);
1258 char *xdg_config = xdg_config_home("config");
1259 int config_exists = file_exists(user_config) || file_exists(xdg_config);
1261 free(user_config);
1262 free(xdg_config);
1264 if (config_exists)
1265 return _(implicit_ident_advice_config);
1266 else
1267 return _(implicit_ident_advice_noconfig);
1271 void print_commit_summary(struct repository *r,
1272 const char *prefix,
1273 const struct object_id *oid,
1274 unsigned int flags)
1276 struct rev_info rev;
1277 struct commit *commit;
1278 struct strbuf format = STRBUF_INIT;
1279 const char *head;
1280 struct pretty_print_context pctx = {0};
1281 struct strbuf author_ident = STRBUF_INIT;
1282 struct strbuf committer_ident = STRBUF_INIT;
1283 struct ref_store *refs;
1285 commit = lookup_commit(r, oid);
1286 if (!commit)
1287 die(_("couldn't look up newly created commit"));
1288 if (parse_commit(commit))
1289 die(_("could not parse newly created commit"));
1291 strbuf_addstr(&format, "format:%h] %s");
1293 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1294 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1295 if (strbuf_cmp(&author_ident, &committer_ident)) {
1296 strbuf_addstr(&format, "\n Author: ");
1297 strbuf_addbuf_percentquote(&format, &author_ident);
1299 if (flags & SUMMARY_SHOW_AUTHOR_DATE) {
1300 struct strbuf date = STRBUF_INIT;
1302 format_commit_message(commit, "%ad", &date, &pctx);
1303 strbuf_addstr(&format, "\n Date: ");
1304 strbuf_addbuf_percentquote(&format, &date);
1305 strbuf_release(&date);
1307 if (!committer_ident_sufficiently_given()) {
1308 strbuf_addstr(&format, "\n Committer: ");
1309 strbuf_addbuf_percentquote(&format, &committer_ident);
1310 if (advice_enabled(ADVICE_IMPLICIT_IDENTITY)) {
1311 strbuf_addch(&format, '\n');
1312 strbuf_addstr(&format, implicit_ident_advice());
1315 strbuf_release(&author_ident);
1316 strbuf_release(&committer_ident);
1318 repo_init_revisions(r, &rev, prefix);
1319 setup_revisions(0, NULL, &rev, NULL);
1321 rev.diff = 1;
1322 rev.diffopt.output_format =
1323 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1325 rev.verbose_header = 1;
1326 rev.show_root_diff = 1;
1327 get_commit_format(format.buf, &rev);
1328 rev.always_show_header = 0;
1329 rev.diffopt.detect_rename = DIFF_DETECT_RENAME;
1330 rev.diffopt.break_opt = 0;
1331 diff_setup_done(&rev.diffopt);
1333 refs = get_main_ref_store(the_repository);
1334 head = refs_resolve_ref_unsafe(refs, "HEAD", 0, NULL, NULL);
1335 if (!head)
1336 die(_("unable to resolve HEAD after creating commit"));
1337 if (!strcmp(head, "HEAD"))
1338 head = _("detached HEAD");
1339 else
1340 skip_prefix(head, "refs/heads/", &head);
1341 printf("[%s%s ", head, (flags & SUMMARY_INITIAL_COMMIT) ?
1342 _(" (root-commit)") : "");
1344 if (!log_tree_commit(&rev, commit)) {
1345 rev.always_show_header = 1;
1346 rev.use_terminator = 1;
1347 log_tree_commit(&rev, commit);
1350 strbuf_release(&format);
1353 static int parse_head(struct repository *r, struct commit **head)
1355 struct commit *current_head;
1356 struct object_id oid;
1358 if (get_oid("HEAD", &oid)) {
1359 current_head = NULL;
1360 } else {
1361 current_head = lookup_commit_reference(r, &oid);
1362 if (!current_head)
1363 return error(_("could not parse HEAD"));
1364 if (!oideq(&oid, &current_head->object.oid)) {
1365 warning(_("HEAD %s is not a commit!"),
1366 oid_to_hex(&oid));
1368 if (parse_commit(current_head))
1369 return error(_("could not parse HEAD commit"));
1371 *head = current_head;
1373 return 0;
1377 * Try to commit without forking 'git commit'. In some cases we need
1378 * to run 'git commit' to display an error message
1380 * Returns:
1381 * -1 - error unable to commit
1382 * 0 - success
1383 * 1 - run 'git commit'
1385 static int try_to_commit(struct repository *r,
1386 struct strbuf *msg, const char *author,
1387 struct replay_opts *opts, unsigned int flags,
1388 struct object_id *oid)
1390 struct object_id tree;
1391 struct commit *current_head = NULL;
1392 struct commit_list *parents = NULL;
1393 struct commit_extra_header *extra = NULL;
1394 struct strbuf err = STRBUF_INIT;
1395 struct strbuf commit_msg = STRBUF_INIT;
1396 char *amend_author = NULL;
1397 const char *committer = NULL;
1398 const char *hook_commit = NULL;
1399 enum commit_msg_cleanup_mode cleanup;
1400 int res = 0;
1402 if ((flags & CLEANUP_MSG) && (flags & VERBATIM_MSG))
1403 BUG("CLEANUP_MSG and VERBATIM_MSG are mutually exclusive");
1405 if (parse_head(r, &current_head))
1406 return -1;
1408 if (flags & AMEND_MSG) {
1409 const char *exclude_gpgsig[] = { "gpgsig", "gpgsig-sha256", NULL };
1410 const char *out_enc = get_commit_output_encoding();
1411 const char *message = logmsg_reencode(current_head, NULL,
1412 out_enc);
1414 if (!msg) {
1415 const char *orig_message = NULL;
1417 find_commit_subject(message, &orig_message);
1418 msg = &commit_msg;
1419 strbuf_addstr(msg, orig_message);
1420 hook_commit = "HEAD";
1422 author = amend_author = get_author(message);
1423 unuse_commit_buffer(current_head, message);
1424 if (!author) {
1425 res = error(_("unable to parse commit author"));
1426 goto out;
1428 parents = copy_commit_list(current_head->parents);
1429 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1430 } else if (current_head &&
1431 (!(flags & CREATE_ROOT_COMMIT) || (flags & AMEND_MSG))) {
1432 commit_list_insert(current_head, &parents);
1435 if (write_index_as_tree(&tree, r->index, r->index_file, 0, NULL)) {
1436 res = error(_("git write-tree failed to write a tree"));
1437 goto out;
1440 if (!(flags & ALLOW_EMPTY)) {
1441 struct commit *first_parent = current_head;
1443 if (flags & AMEND_MSG) {
1444 if (current_head->parents) {
1445 first_parent = current_head->parents->item;
1446 if (repo_parse_commit(r, first_parent)) {
1447 res = error(_("could not parse HEAD commit"));
1448 goto out;
1450 } else {
1451 first_parent = NULL;
1454 if (oideq(first_parent
1455 ? get_commit_tree_oid(first_parent)
1456 : the_hash_algo->empty_tree,
1457 &tree)) {
1458 res = 1; /* run 'git commit' to display error message */
1459 goto out;
1463 if (hook_exists("prepare-commit-msg")) {
1464 res = run_prepare_commit_msg_hook(r, msg, hook_commit);
1465 if (res)
1466 goto out;
1467 if (strbuf_read_file(&commit_msg, git_path_commit_editmsg(),
1468 2048) < 0) {
1469 res = error_errno(_("unable to read commit message "
1470 "from '%s'"),
1471 git_path_commit_editmsg());
1472 goto out;
1474 msg = &commit_msg;
1477 if (flags & CLEANUP_MSG)
1478 cleanup = COMMIT_MSG_CLEANUP_ALL;
1479 else if (flags & VERBATIM_MSG)
1480 cleanup = COMMIT_MSG_CLEANUP_NONE;
1481 else if ((opts->signoff || opts->record_origin) &&
1482 !opts->explicit_cleanup)
1483 cleanup = COMMIT_MSG_CLEANUP_SPACE;
1484 else
1485 cleanup = opts->default_msg_cleanup;
1487 if (cleanup != COMMIT_MSG_CLEANUP_NONE)
1488 strbuf_stripspace(msg, cleanup == COMMIT_MSG_CLEANUP_ALL);
1489 if ((flags & EDIT_MSG) && message_is_empty(msg, cleanup)) {
1490 res = 1; /* run 'git commit' to display error message */
1491 goto out;
1494 if (opts->committer_date_is_author_date) {
1495 struct ident_split id;
1496 struct strbuf date = STRBUF_INIT;
1498 if (!opts->ignore_date) {
1499 if (split_ident_line(&id, author, (int)strlen(author)) < 0) {
1500 res = error(_("invalid author identity '%s'"),
1501 author);
1502 goto out;
1504 if (!id.date_begin) {
1505 res = error(_(
1506 "corrupt author: missing date information"));
1507 goto out;
1509 strbuf_addf(&date, "@%.*s %.*s",
1510 (int)(id.date_end - id.date_begin),
1511 id.date_begin,
1512 (int)(id.tz_end - id.tz_begin),
1513 id.tz_begin);
1514 } else {
1515 reset_ident_date();
1517 committer = fmt_ident(getenv("GIT_COMMITTER_NAME"),
1518 getenv("GIT_COMMITTER_EMAIL"),
1519 WANT_COMMITTER_IDENT,
1520 opts->ignore_date ? NULL : date.buf,
1521 IDENT_STRICT);
1522 strbuf_release(&date);
1523 } else {
1524 reset_ident_date();
1527 if (opts->ignore_date) {
1528 struct ident_split id;
1529 char *name, *email;
1531 if (split_ident_line(&id, author, strlen(author)) < 0) {
1532 error(_("invalid author identity '%s'"), author);
1533 goto out;
1535 name = xmemdupz(id.name_begin, id.name_end - id.name_begin);
1536 email = xmemdupz(id.mail_begin, id.mail_end - id.mail_begin);
1537 author = fmt_ident(name, email, WANT_AUTHOR_IDENT, NULL,
1538 IDENT_STRICT);
1539 free(name);
1540 free(email);
1543 if (commit_tree_extended(msg->buf, msg->len, &tree, parents, oid,
1544 author, committer, opts->gpg_sign, extra)) {
1545 res = error(_("failed to write commit object"));
1546 goto out;
1549 if (update_head_with_reflog(current_head, oid,
1550 getenv("GIT_REFLOG_ACTION"), msg, &err)) {
1551 res = error("%s", err.buf);
1552 goto out;
1555 run_commit_hook(0, r->index_file, "post-commit", NULL);
1556 if (flags & AMEND_MSG)
1557 commit_post_rewrite(r, current_head, oid);
1559 out:
1560 free_commit_extra_headers(extra);
1561 strbuf_release(&err);
1562 strbuf_release(&commit_msg);
1563 free(amend_author);
1565 return res;
1568 static int write_rebase_head(struct object_id *oid)
1570 if (update_ref("rebase", "REBASE_HEAD", oid,
1571 NULL, REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1572 return error(_("could not update %s"), "REBASE_HEAD");
1574 return 0;
1577 static int do_commit(struct repository *r,
1578 const char *msg_file, const char *author,
1579 struct replay_opts *opts, unsigned int flags,
1580 struct object_id *oid)
1582 int res = 1;
1584 if (!(flags & EDIT_MSG) && !(flags & VERIFY_MSG)) {
1585 struct object_id oid;
1586 struct strbuf sb = STRBUF_INIT;
1588 if (msg_file && strbuf_read_file(&sb, msg_file, 2048) < 0)
1589 return error_errno(_("unable to read commit message "
1590 "from '%s'"),
1591 msg_file);
1593 res = try_to_commit(r, msg_file ? &sb : NULL,
1594 author, opts, flags, &oid);
1595 strbuf_release(&sb);
1596 if (!res) {
1597 refs_delete_ref(get_main_ref_store(r), "",
1598 "CHERRY_PICK_HEAD", NULL, 0);
1599 unlink(git_path_merge_msg(r));
1600 if (!is_rebase_i(opts))
1601 print_commit_summary(r, NULL, &oid,
1602 SUMMARY_SHOW_AUTHOR_DATE);
1603 return res;
1606 if (res == 1) {
1607 if (is_rebase_i(opts) && oid)
1608 if (write_rebase_head(oid))
1609 return -1;
1610 return run_git_commit(msg_file, opts, flags);
1613 return res;
1616 static int is_original_commit_empty(struct commit *commit)
1618 const struct object_id *ptree_oid;
1620 if (parse_commit(commit))
1621 return error(_("could not parse commit %s"),
1622 oid_to_hex(&commit->object.oid));
1623 if (commit->parents) {
1624 struct commit *parent = commit->parents->item;
1625 if (parse_commit(parent))
1626 return error(_("could not parse parent commit %s"),
1627 oid_to_hex(&parent->object.oid));
1628 ptree_oid = get_commit_tree_oid(parent);
1629 } else {
1630 ptree_oid = the_hash_algo->empty_tree; /* commit is root */
1633 return oideq(ptree_oid, get_commit_tree_oid(commit));
1637 * Should empty commits be allowed? Return status:
1638 * <0: Error in is_index_unchanged(r) or is_original_commit_empty(commit)
1639 * 0: Halt on empty commit
1640 * 1: Allow empty commit
1641 * 2: Drop empty commit
1643 static int allow_empty(struct repository *r,
1644 struct replay_opts *opts,
1645 struct commit *commit)
1647 int index_unchanged, originally_empty;
1650 * Four cases:
1652 * (1) we do not allow empty at all and error out.
1654 * (2) we allow ones that were initially empty, and
1655 * just drop the ones that become empty
1657 * (3) we allow ones that were initially empty, but
1658 * halt for the ones that become empty;
1660 * (4) we allow both.
1662 if (!opts->allow_empty)
1663 return 0; /* let "git commit" barf as necessary */
1665 index_unchanged = is_index_unchanged(r);
1666 if (index_unchanged < 0)
1667 return index_unchanged;
1668 if (!index_unchanged)
1669 return 0; /* we do not have to say --allow-empty */
1671 if (opts->keep_redundant_commits)
1672 return 1;
1674 originally_empty = is_original_commit_empty(commit);
1675 if (originally_empty < 0)
1676 return originally_empty;
1677 if (originally_empty)
1678 return 1;
1679 else if (opts->drop_redundant_commits)
1680 return 2;
1681 else
1682 return 0;
1685 static struct {
1686 char c;
1687 const char *str;
1688 } todo_command_info[] = {
1689 { 'p', "pick" },
1690 { 0, "revert" },
1691 { 'e', "edit" },
1692 { 'r', "reword" },
1693 { 'f', "fixup" },
1694 { 's', "squash" },
1695 { 'x', "exec" },
1696 { 'b', "break" },
1697 { 'l', "label" },
1698 { 't', "reset" },
1699 { 'm', "merge" },
1700 { 0, "noop" },
1701 { 'd', "drop" },
1702 { 0, NULL }
1705 static const char *command_to_string(const enum todo_command command)
1707 if (command < TODO_COMMENT)
1708 return todo_command_info[command].str;
1709 die(_("unknown command: %d"), command);
1712 static char command_to_char(const enum todo_command command)
1714 if (command < TODO_COMMENT)
1715 return todo_command_info[command].c;
1716 return comment_line_char;
1719 static int is_noop(const enum todo_command command)
1721 return TODO_NOOP <= command;
1724 static int is_fixup(enum todo_command command)
1726 return command == TODO_FIXUP || command == TODO_SQUASH;
1729 /* Does this command create a (non-merge) commit? */
1730 static int is_pick_or_similar(enum todo_command command)
1732 switch (command) {
1733 case TODO_PICK:
1734 case TODO_REVERT:
1735 case TODO_EDIT:
1736 case TODO_REWORD:
1737 case TODO_FIXUP:
1738 case TODO_SQUASH:
1739 return 1;
1740 default:
1741 return 0;
1745 enum todo_item_flags {
1746 TODO_EDIT_MERGE_MSG = (1 << 0),
1747 TODO_REPLACE_FIXUP_MSG = (1 << 1),
1748 TODO_EDIT_FIXUP_MSG = (1 << 2),
1751 static const char first_commit_msg_str[] = N_("This is the 1st commit message:");
1752 static const char nth_commit_msg_fmt[] = N_("This is the commit message #%d:");
1753 static const char skip_first_commit_msg_str[] = N_("The 1st commit message will be skipped:");
1754 static const char skip_nth_commit_msg_fmt[] = N_("The commit message #%d will be skipped:");
1755 static const char combined_commit_msg_fmt[] = N_("This is a combination of %d commits.");
1757 static int is_fixup_flag(enum todo_command command, unsigned flag)
1759 return command == TODO_FIXUP && ((flag & TODO_REPLACE_FIXUP_MSG) ||
1760 (flag & TODO_EDIT_FIXUP_MSG));
1764 * Wrapper around strbuf_add_commented_lines() which avoids double
1765 * commenting commit subjects.
1767 static void add_commented_lines(struct strbuf *buf, const void *str, size_t len)
1769 const char *s = str;
1770 while (len > 0 && s[0] == comment_line_char) {
1771 size_t count;
1772 const char *n = memchr(s, '\n', len);
1773 if (!n)
1774 count = len;
1775 else
1776 count = n - s + 1;
1777 strbuf_add(buf, s, count);
1778 s += count;
1779 len -= count;
1781 strbuf_add_commented_lines(buf, s, len);
1784 /* Does the current fixup chain contain a squash command? */
1785 static int seen_squash(struct replay_opts *opts)
1787 return starts_with(opts->current_fixups.buf, "squash") ||
1788 strstr(opts->current_fixups.buf, "\nsquash");
1791 static void update_comment_bufs(struct strbuf *buf1, struct strbuf *buf2, int n)
1793 strbuf_setlen(buf1, 2);
1794 strbuf_addf(buf1, _(nth_commit_msg_fmt), n);
1795 strbuf_addch(buf1, '\n');
1796 strbuf_setlen(buf2, 2);
1797 strbuf_addf(buf2, _(skip_nth_commit_msg_fmt), n);
1798 strbuf_addch(buf2, '\n');
1802 * Comment out any un-commented commit messages, updating the message comments
1803 * to say they will be skipped but do not comment out the empty lines that
1804 * surround commit messages and their comments.
1806 static void update_squash_message_for_fixup(struct strbuf *msg)
1808 void (*copy_lines)(struct strbuf *, const void *, size_t) = strbuf_add;
1809 struct strbuf buf1 = STRBUF_INIT, buf2 = STRBUF_INIT;
1810 const char *s, *start;
1811 char *orig_msg;
1812 size_t orig_msg_len;
1813 int i = 1;
1815 strbuf_addf(&buf1, "# %s\n", _(first_commit_msg_str));
1816 strbuf_addf(&buf2, "# %s\n", _(skip_first_commit_msg_str));
1817 s = start = orig_msg = strbuf_detach(msg, &orig_msg_len);
1818 while (s) {
1819 const char *next;
1820 size_t off;
1821 if (skip_prefix(s, buf1.buf, &next)) {
1823 * Copy the last message, preserving the blank line
1824 * preceding the current line
1826 off = (s > start + 1 && s[-2] == '\n') ? 1 : 0;
1827 copy_lines(msg, start, s - start - off);
1828 if (off)
1829 strbuf_addch(msg, '\n');
1831 * The next message needs to be commented out but the
1832 * message header is already commented out so just copy
1833 * it and the blank line that follows it.
1835 strbuf_addbuf(msg, &buf2);
1836 if (*next == '\n')
1837 strbuf_addch(msg, *next++);
1838 start = s = next;
1839 copy_lines = add_commented_lines;
1840 update_comment_bufs(&buf1, &buf2, ++i);
1841 } else if (skip_prefix(s, buf2.buf, &next)) {
1842 off = (s > start + 1 && s[-2] == '\n') ? 1 : 0;
1843 copy_lines(msg, start, s - start - off);
1844 start = s - off;
1845 s = next;
1846 copy_lines = strbuf_add;
1847 update_comment_bufs(&buf1, &buf2, ++i);
1848 } else {
1849 s = strchr(s, '\n');
1850 if (s)
1851 s++;
1854 copy_lines(msg, start, orig_msg_len - (start - orig_msg));
1855 free(orig_msg);
1856 strbuf_release(&buf1);
1857 strbuf_release(&buf2);
1860 static int append_squash_message(struct strbuf *buf, const char *body,
1861 enum todo_command command, struct replay_opts *opts,
1862 unsigned flag)
1864 const char *fixup_msg;
1865 size_t commented_len = 0, fixup_off;
1867 * amend is non-interactive and not normally used with fixup!
1868 * or squash! commits, so only comment out those subjects when
1869 * squashing commit messages.
1871 if (starts_with(body, "amend!") ||
1872 ((command == TODO_SQUASH || seen_squash(opts)) &&
1873 (starts_with(body, "squash!") || starts_with(body, "fixup!"))))
1874 commented_len = commit_subject_length(body);
1876 strbuf_addf(buf, "\n%c ", comment_line_char);
1877 strbuf_addf(buf, _(nth_commit_msg_fmt),
1878 ++opts->current_fixup_count + 1);
1879 strbuf_addstr(buf, "\n\n");
1880 strbuf_add_commented_lines(buf, body, commented_len);
1881 /* buf->buf may be reallocated so store an offset into the buffer */
1882 fixup_off = buf->len;
1883 strbuf_addstr(buf, body + commented_len);
1885 /* fixup -C after squash behaves like squash */
1886 if (is_fixup_flag(command, flag) && !seen_squash(opts)) {
1888 * We're replacing the commit message so we need to
1889 * append the Signed-off-by: trailer if the user
1890 * requested '--signoff'.
1892 if (opts->signoff)
1893 append_signoff(buf, 0, 0);
1895 if ((command == TODO_FIXUP) &&
1896 (flag & TODO_REPLACE_FIXUP_MSG) &&
1897 (file_exists(rebase_path_fixup_msg()) ||
1898 !file_exists(rebase_path_squash_msg()))) {
1899 fixup_msg = skip_blank_lines(buf->buf + fixup_off);
1900 if (write_message(fixup_msg, strlen(fixup_msg),
1901 rebase_path_fixup_msg(), 0) < 0)
1902 return error(_("cannot write '%s'"),
1903 rebase_path_fixup_msg());
1904 } else {
1905 unlink(rebase_path_fixup_msg());
1907 } else {
1908 unlink(rebase_path_fixup_msg());
1911 return 0;
1914 static int update_squash_messages(struct repository *r,
1915 enum todo_command command,
1916 struct commit *commit,
1917 struct replay_opts *opts,
1918 unsigned flag)
1920 struct strbuf buf = STRBUF_INIT;
1921 int res = 0;
1922 const char *message, *body;
1923 const char *encoding = get_commit_output_encoding();
1925 if (opts->current_fixup_count > 0) {
1926 struct strbuf header = STRBUF_INIT;
1927 char *eol;
1929 if (strbuf_read_file(&buf, rebase_path_squash_msg(), 9) <= 0)
1930 return error(_("could not read '%s'"),
1931 rebase_path_squash_msg());
1933 eol = buf.buf[0] != comment_line_char ?
1934 buf.buf : strchrnul(buf.buf, '\n');
1936 strbuf_addf(&header, "%c ", comment_line_char);
1937 strbuf_addf(&header, _(combined_commit_msg_fmt),
1938 opts->current_fixup_count + 2);
1939 strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
1940 strbuf_release(&header);
1941 if (is_fixup_flag(command, flag) && !seen_squash(opts))
1942 update_squash_message_for_fixup(&buf);
1943 } else {
1944 struct object_id head;
1945 struct commit *head_commit;
1946 const char *head_message, *body;
1948 if (get_oid("HEAD", &head))
1949 return error(_("need a HEAD to fixup"));
1950 if (!(head_commit = lookup_commit_reference(r, &head)))
1951 return error(_("could not read HEAD"));
1952 if (!(head_message = logmsg_reencode(head_commit, NULL, encoding)))
1953 return error(_("could not read HEAD's commit message"));
1955 find_commit_subject(head_message, &body);
1956 if (command == TODO_FIXUP && !flag && write_message(body, strlen(body),
1957 rebase_path_fixup_msg(), 0) < 0) {
1958 unuse_commit_buffer(head_commit, head_message);
1959 return error(_("cannot write '%s'"), rebase_path_fixup_msg());
1961 strbuf_addf(&buf, "%c ", comment_line_char);
1962 strbuf_addf(&buf, _(combined_commit_msg_fmt), 2);
1963 strbuf_addf(&buf, "\n%c ", comment_line_char);
1964 strbuf_addstr(&buf, is_fixup_flag(command, flag) ?
1965 _(skip_first_commit_msg_str) :
1966 _(first_commit_msg_str));
1967 strbuf_addstr(&buf, "\n\n");
1968 if (is_fixup_flag(command, flag))
1969 strbuf_add_commented_lines(&buf, body, strlen(body));
1970 else
1971 strbuf_addstr(&buf, body);
1973 unuse_commit_buffer(head_commit, head_message);
1976 if (!(message = logmsg_reencode(commit, NULL, encoding)))
1977 return error(_("could not read commit message of %s"),
1978 oid_to_hex(&commit->object.oid));
1979 find_commit_subject(message, &body);
1981 if (command == TODO_SQUASH || is_fixup_flag(command, flag)) {
1982 res = append_squash_message(&buf, body, command, opts, flag);
1983 } else if (command == TODO_FIXUP) {
1984 strbuf_addf(&buf, "\n%c ", comment_line_char);
1985 strbuf_addf(&buf, _(skip_nth_commit_msg_fmt),
1986 ++opts->current_fixup_count + 1);
1987 strbuf_addstr(&buf, "\n\n");
1988 strbuf_add_commented_lines(&buf, body, strlen(body));
1989 } else
1990 return error(_("unknown command: %d"), command);
1991 unuse_commit_buffer(commit, message);
1993 if (!res)
1994 res = write_message(buf.buf, buf.len, rebase_path_squash_msg(),
1996 strbuf_release(&buf);
1998 if (!res) {
1999 strbuf_addf(&opts->current_fixups, "%s%s %s",
2000 opts->current_fixups.len ? "\n" : "",
2001 command_to_string(command),
2002 oid_to_hex(&commit->object.oid));
2003 res = write_message(opts->current_fixups.buf,
2004 opts->current_fixups.len,
2005 rebase_path_current_fixups(), 0);
2008 return res;
2011 static void flush_rewritten_pending(void)
2013 struct strbuf buf = STRBUF_INIT;
2014 struct object_id newoid;
2015 FILE *out;
2017 if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), (GIT_MAX_HEXSZ + 1) * 2) > 0 &&
2018 !get_oid("HEAD", &newoid) &&
2019 (out = fopen_or_warn(rebase_path_rewritten_list(), "a"))) {
2020 char *bol = buf.buf, *eol;
2022 while (*bol) {
2023 eol = strchrnul(bol, '\n');
2024 fprintf(out, "%.*s %s\n", (int)(eol - bol),
2025 bol, oid_to_hex(&newoid));
2026 if (!*eol)
2027 break;
2028 bol = eol + 1;
2030 fclose(out);
2031 unlink(rebase_path_rewritten_pending());
2033 strbuf_release(&buf);
2036 static void record_in_rewritten(struct object_id *oid,
2037 enum todo_command next_command)
2039 FILE *out = fopen_or_warn(rebase_path_rewritten_pending(), "a");
2041 if (!out)
2042 return;
2044 fprintf(out, "%s\n", oid_to_hex(oid));
2045 fclose(out);
2047 if (!is_fixup(next_command))
2048 flush_rewritten_pending();
2051 static int should_edit(struct replay_opts *opts) {
2052 if (opts->edit < 0)
2054 * Note that we only handle the case of non-conflicted
2055 * commits; continue_single_pick() handles the conflicted
2056 * commits itself instead of calling this function.
2058 return (opts->action == REPLAY_REVERT && isatty(0)) ? 1 : 0;
2059 return opts->edit;
2062 static int do_pick_commit(struct repository *r,
2063 struct todo_item *item,
2064 struct replay_opts *opts,
2065 int final_fixup, int *check_todo)
2067 unsigned int flags = should_edit(opts) ? EDIT_MSG : 0;
2068 const char *msg_file = should_edit(opts) ? NULL : git_path_merge_msg(r);
2069 struct object_id head;
2070 struct commit *base, *next, *parent;
2071 const char *base_label, *next_label;
2072 char *author = NULL;
2073 struct commit_message msg = { NULL, NULL, NULL, NULL };
2074 struct strbuf msgbuf = STRBUF_INIT;
2075 int res, unborn = 0, reword = 0, allow, drop_commit;
2076 enum todo_command command = item->command;
2077 struct commit *commit = item->commit;
2079 if (opts->no_commit) {
2081 * We do not intend to commit immediately. We just want to
2082 * merge the differences in, so let's compute the tree
2083 * that represents the "current" state for the merge machinery
2084 * to work on.
2086 if (write_index_as_tree(&head, r->index, r->index_file, 0, NULL))
2087 return error(_("your index file is unmerged."));
2088 } else {
2089 unborn = get_oid("HEAD", &head);
2090 /* Do we want to generate a root commit? */
2091 if (is_pick_or_similar(command) && opts->have_squash_onto &&
2092 oideq(&head, &opts->squash_onto)) {
2093 if (is_fixup(command))
2094 return error(_("cannot fixup root commit"));
2095 flags |= CREATE_ROOT_COMMIT;
2096 unborn = 1;
2097 } else if (unborn)
2098 oidcpy(&head, the_hash_algo->empty_tree);
2099 if (index_differs_from(r, unborn ? empty_tree_oid_hex() : "HEAD",
2100 NULL, 0))
2101 return error_dirty_index(r, opts);
2103 discard_index(r->index);
2105 if (!commit->parents)
2106 parent = NULL;
2107 else if (commit->parents->next) {
2108 /* Reverting or cherry-picking a merge commit */
2109 int cnt;
2110 struct commit_list *p;
2112 if (!opts->mainline)
2113 return error(_("commit %s is a merge but no -m option was given."),
2114 oid_to_hex(&commit->object.oid));
2116 for (cnt = 1, p = commit->parents;
2117 cnt != opts->mainline && p;
2118 cnt++)
2119 p = p->next;
2120 if (cnt != opts->mainline || !p)
2121 return error(_("commit %s does not have parent %d"),
2122 oid_to_hex(&commit->object.oid), opts->mainline);
2123 parent = p->item;
2124 } else if (1 < opts->mainline)
2126 * Non-first parent explicitly specified as mainline for
2127 * non-merge commit
2129 return error(_("commit %s does not have parent %d"),
2130 oid_to_hex(&commit->object.oid), opts->mainline);
2131 else
2132 parent = commit->parents->item;
2134 if (get_message(commit, &msg) != 0)
2135 return error(_("cannot get commit message for %s"),
2136 oid_to_hex(&commit->object.oid));
2138 if (opts->allow_ff && !is_fixup(command) &&
2139 ((parent && oideq(&parent->object.oid, &head)) ||
2140 (!parent && unborn))) {
2141 if (is_rebase_i(opts))
2142 write_author_script(msg.message);
2143 res = fast_forward_to(r, &commit->object.oid, &head, unborn,
2144 opts);
2145 if (res || command != TODO_REWORD)
2146 goto leave;
2147 reword = 1;
2148 msg_file = NULL;
2149 goto fast_forward_edit;
2151 if (parent && parse_commit(parent) < 0)
2152 /* TRANSLATORS: The first %s will be a "todo" command like
2153 "revert" or "pick", the second %s a SHA1. */
2154 return error(_("%s: cannot parse parent commit %s"),
2155 command_to_string(command),
2156 oid_to_hex(&parent->object.oid));
2159 * "commit" is an existing commit. We would want to apply
2160 * the difference it introduces since its first parent "prev"
2161 * on top of the current HEAD if we are cherry-pick. Or the
2162 * reverse of it if we are revert.
2165 if (command == TODO_REVERT) {
2166 base = commit;
2167 base_label = msg.label;
2168 next = parent;
2169 next_label = msg.parent_label;
2170 strbuf_addstr(&msgbuf, "Revert \"");
2171 strbuf_addstr(&msgbuf, msg.subject);
2172 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
2173 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
2175 if (commit->parents && commit->parents->next) {
2176 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
2177 strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
2179 strbuf_addstr(&msgbuf, ".\n");
2180 } else {
2181 const char *p;
2183 base = parent;
2184 base_label = msg.parent_label;
2185 next = commit;
2186 next_label = msg.label;
2188 /* Append the commit log message to msgbuf. */
2189 if (find_commit_subject(msg.message, &p))
2190 strbuf_addstr(&msgbuf, p);
2192 if (opts->record_origin) {
2193 strbuf_complete_line(&msgbuf);
2194 if (!has_conforming_footer(&msgbuf, NULL, 0))
2195 strbuf_addch(&msgbuf, '\n');
2196 strbuf_addstr(&msgbuf, cherry_picked_prefix);
2197 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
2198 strbuf_addstr(&msgbuf, ")\n");
2200 if (!is_fixup(command))
2201 author = get_author(msg.message);
2204 if (command == TODO_REWORD)
2205 reword = 1;
2206 else if (is_fixup(command)) {
2207 if (update_squash_messages(r, command, commit,
2208 opts, item->flags))
2209 return -1;
2210 flags |= AMEND_MSG;
2211 if (!final_fixup)
2212 msg_file = rebase_path_squash_msg();
2213 else if (file_exists(rebase_path_fixup_msg())) {
2214 flags |= VERBATIM_MSG;
2215 msg_file = rebase_path_fixup_msg();
2216 } else {
2217 const char *dest = git_path_squash_msg(r);
2218 unlink(dest);
2219 if (copy_file(dest, rebase_path_squash_msg(), 0666))
2220 return error(_("could not rename '%s' to '%s'"),
2221 rebase_path_squash_msg(), dest);
2222 unlink(git_path_merge_msg(r));
2223 msg_file = dest;
2224 flags |= EDIT_MSG;
2228 if (opts->signoff && !is_fixup(command))
2229 append_signoff(&msgbuf, 0, 0);
2231 if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
2232 res = -1;
2233 else if (!opts->strategy ||
2234 !strcmp(opts->strategy, "recursive") ||
2235 !strcmp(opts->strategy, "ort") ||
2236 command == TODO_REVERT) {
2237 res = do_recursive_merge(r, base, next, base_label, next_label,
2238 &head, &msgbuf, opts);
2239 if (res < 0)
2240 goto leave;
2242 res |= write_message(msgbuf.buf, msgbuf.len,
2243 git_path_merge_msg(r), 0);
2244 } else {
2245 struct commit_list *common = NULL;
2246 struct commit_list *remotes = NULL;
2248 res = write_message(msgbuf.buf, msgbuf.len,
2249 git_path_merge_msg(r), 0);
2251 commit_list_insert(base, &common);
2252 commit_list_insert(next, &remotes);
2253 res |= try_merge_command(r, opts->strategy,
2254 opts->xopts_nr, (const char **)opts->xopts,
2255 common, oid_to_hex(&head), remotes);
2256 free_commit_list(common);
2257 free_commit_list(remotes);
2259 strbuf_release(&msgbuf);
2262 * If the merge was clean or if it failed due to conflict, we write
2263 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
2264 * However, if the merge did not even start, then we don't want to
2265 * write it at all.
2267 if ((command == TODO_PICK || command == TODO_REWORD ||
2268 command == TODO_EDIT) && !opts->no_commit &&
2269 (res == 0 || res == 1) &&
2270 update_ref(NULL, "CHERRY_PICK_HEAD", &commit->object.oid, NULL,
2271 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
2272 res = -1;
2273 if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
2274 update_ref(NULL, "REVERT_HEAD", &commit->object.oid, NULL,
2275 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
2276 res = -1;
2278 if (res) {
2279 error(command == TODO_REVERT
2280 ? _("could not revert %s... %s")
2281 : _("could not apply %s... %s"),
2282 short_commit_name(commit), msg.subject);
2283 print_advice(r, res == 1, opts);
2284 repo_rerere(r, opts->allow_rerere_auto);
2285 goto leave;
2288 drop_commit = 0;
2289 allow = allow_empty(r, opts, commit);
2290 if (allow < 0) {
2291 res = allow;
2292 goto leave;
2293 } else if (allow == 1) {
2294 flags |= ALLOW_EMPTY;
2295 } else if (allow == 2) {
2296 drop_commit = 1;
2297 refs_delete_ref(get_main_ref_store(r), "", "CHERRY_PICK_HEAD",
2298 NULL, 0);
2299 unlink(git_path_merge_msg(r));
2300 unlink(git_path_auto_merge(r));
2301 fprintf(stderr,
2302 _("dropping %s %s -- patch contents already upstream\n"),
2303 oid_to_hex(&commit->object.oid), msg.subject);
2304 } /* else allow == 0 and there's nothing special to do */
2305 if (!opts->no_commit && !drop_commit) {
2306 if (author || command == TODO_REVERT || (flags & AMEND_MSG))
2307 res = do_commit(r, msg_file, author, opts, flags,
2308 commit? &commit->object.oid : NULL);
2309 else
2310 res = error(_("unable to parse commit author"));
2311 *check_todo = !!(flags & EDIT_MSG);
2312 if (!res && reword) {
2313 fast_forward_edit:
2314 res = run_git_commit(NULL, opts, EDIT_MSG |
2315 VERIFY_MSG | AMEND_MSG |
2316 (flags & ALLOW_EMPTY));
2317 *check_todo = 1;
2322 if (!res && final_fixup) {
2323 unlink(rebase_path_fixup_msg());
2324 unlink(rebase_path_squash_msg());
2325 unlink(rebase_path_current_fixups());
2326 strbuf_reset(&opts->current_fixups);
2327 opts->current_fixup_count = 0;
2330 leave:
2331 free_message(commit, &msg);
2332 free(author);
2333 update_abort_safety_file();
2335 return res;
2338 static int prepare_revs(struct replay_opts *opts)
2341 * picking (but not reverting) ranges (but not individual revisions)
2342 * should be done in reverse
2344 if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
2345 opts->revs->reverse ^= 1;
2347 if (prepare_revision_walk(opts->revs))
2348 return error(_("revision walk setup failed"));
2350 return 0;
2353 static int read_and_refresh_cache(struct repository *r,
2354 struct replay_opts *opts)
2356 struct lock_file index_lock = LOCK_INIT;
2357 int index_fd = repo_hold_locked_index(r, &index_lock, 0);
2358 if (repo_read_index(r) < 0) {
2359 rollback_lock_file(&index_lock);
2360 return error(_("git %s: failed to read the index"),
2361 _(action_name(opts)));
2363 refresh_index(r->index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
2365 if (index_fd >= 0) {
2366 if (write_locked_index(r->index, &index_lock,
2367 COMMIT_LOCK | SKIP_IF_UNCHANGED)) {
2368 return error(_("git %s: failed to refresh the index"),
2369 _(action_name(opts)));
2374 * If we are resolving merges in any way other than "ort", then
2375 * expand the sparse index.
2377 if (opts->strategy && strcmp(opts->strategy, "ort"))
2378 ensure_full_index(r->index);
2379 return 0;
2382 void todo_list_release(struct todo_list *todo_list)
2384 strbuf_release(&todo_list->buf);
2385 FREE_AND_NULL(todo_list->items);
2386 todo_list->nr = todo_list->alloc = 0;
2389 static struct todo_item *append_new_todo(struct todo_list *todo_list)
2391 ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
2392 todo_list->total_nr++;
2393 return todo_list->items + todo_list->nr++;
2396 const char *todo_item_get_arg(struct todo_list *todo_list,
2397 struct todo_item *item)
2399 return todo_list->buf.buf + item->arg_offset;
2402 static int is_command(enum todo_command command, const char **bol)
2404 const char *str = todo_command_info[command].str;
2405 const char nick = todo_command_info[command].c;
2406 const char *p = *bol + 1;
2408 return skip_prefix(*bol, str, bol) ||
2409 ((nick && **bol == nick) &&
2410 (*p == ' ' || *p == '\t' || *p == '\n' || *p == '\r' || !*p) &&
2411 (*bol = p));
2414 static int parse_insn_line(struct repository *r, struct todo_item *item,
2415 const char *buf, const char *bol, char *eol)
2417 struct object_id commit_oid;
2418 char *end_of_object_name;
2419 int i, saved, status, padding;
2421 item->flags = 0;
2423 /* left-trim */
2424 bol += strspn(bol, " \t");
2426 if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
2427 item->command = TODO_COMMENT;
2428 item->commit = NULL;
2429 item->arg_offset = bol - buf;
2430 item->arg_len = eol - bol;
2431 return 0;
2434 for (i = 0; i < TODO_COMMENT; i++)
2435 if (is_command(i, &bol)) {
2436 item->command = i;
2437 break;
2439 if (i >= TODO_COMMENT)
2440 return -1;
2442 /* Eat up extra spaces/ tabs before object name */
2443 padding = strspn(bol, " \t");
2444 bol += padding;
2446 if (item->command == TODO_NOOP || item->command == TODO_BREAK) {
2447 if (bol != eol)
2448 return error(_("%s does not accept arguments: '%s'"),
2449 command_to_string(item->command), bol);
2450 item->commit = NULL;
2451 item->arg_offset = bol - buf;
2452 item->arg_len = eol - bol;
2453 return 0;
2456 if (!padding)
2457 return error(_("missing arguments for %s"),
2458 command_to_string(item->command));
2460 if (item->command == TODO_EXEC || item->command == TODO_LABEL ||
2461 item->command == TODO_RESET) {
2462 item->commit = NULL;
2463 item->arg_offset = bol - buf;
2464 item->arg_len = (int)(eol - bol);
2465 return 0;
2468 if (item->command == TODO_FIXUP) {
2469 if (skip_prefix(bol, "-C", &bol) &&
2470 (*bol == ' ' || *bol == '\t')) {
2471 bol += strspn(bol, " \t");
2472 item->flags |= TODO_REPLACE_FIXUP_MSG;
2473 } else if (skip_prefix(bol, "-c", &bol) &&
2474 (*bol == ' ' || *bol == '\t')) {
2475 bol += strspn(bol, " \t");
2476 item->flags |= TODO_EDIT_FIXUP_MSG;
2480 if (item->command == TODO_MERGE) {
2481 if (skip_prefix(bol, "-C", &bol))
2482 bol += strspn(bol, " \t");
2483 else if (skip_prefix(bol, "-c", &bol)) {
2484 bol += strspn(bol, " \t");
2485 item->flags |= TODO_EDIT_MERGE_MSG;
2486 } else {
2487 item->flags |= TODO_EDIT_MERGE_MSG;
2488 item->commit = NULL;
2489 item->arg_offset = bol - buf;
2490 item->arg_len = (int)(eol - bol);
2491 return 0;
2495 end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
2496 saved = *end_of_object_name;
2497 *end_of_object_name = '\0';
2498 status = get_oid(bol, &commit_oid);
2499 if (status < 0)
2500 error(_("could not parse '%s'"), bol); /* return later */
2501 *end_of_object_name = saved;
2503 bol = end_of_object_name + strspn(end_of_object_name, " \t");
2504 item->arg_offset = bol - buf;
2505 item->arg_len = (int)(eol - bol);
2507 if (status < 0)
2508 return status;
2510 item->commit = lookup_commit_reference(r, &commit_oid);
2511 return item->commit ? 0 : -1;
2514 int sequencer_get_last_command(struct repository *r, enum replay_action *action)
2516 const char *todo_file, *bol;
2517 struct strbuf buf = STRBUF_INIT;
2518 int ret = 0;
2520 todo_file = git_path_todo_file();
2521 if (strbuf_read_file(&buf, todo_file, 0) < 0) {
2522 if (errno == ENOENT || errno == ENOTDIR)
2523 return -1;
2524 else
2525 return error_errno("unable to open '%s'", todo_file);
2527 bol = buf.buf + strspn(buf.buf, " \t\r\n");
2528 if (is_command(TODO_PICK, &bol) && (*bol == ' ' || *bol == '\t'))
2529 *action = REPLAY_PICK;
2530 else if (is_command(TODO_REVERT, &bol) &&
2531 (*bol == ' ' || *bol == '\t'))
2532 *action = REPLAY_REVERT;
2533 else
2534 ret = -1;
2536 strbuf_release(&buf);
2538 return ret;
2541 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
2542 struct todo_list *todo_list)
2544 struct todo_item *item;
2545 char *p = buf, *next_p;
2546 int i, res = 0, fixup_okay = file_exists(rebase_path_done());
2548 todo_list->current = todo_list->nr = 0;
2550 for (i = 1; *p; i++, p = next_p) {
2551 char *eol = strchrnul(p, '\n');
2553 next_p = *eol ? eol + 1 /* skip LF */ : eol;
2555 if (p != eol && eol[-1] == '\r')
2556 eol--; /* strip Carriage Return */
2558 item = append_new_todo(todo_list);
2559 item->offset_in_buf = p - todo_list->buf.buf;
2560 if (parse_insn_line(r, item, buf, p, eol)) {
2561 res = error(_("invalid line %d: %.*s"),
2562 i, (int)(eol - p), p);
2563 item->command = TODO_COMMENT + 1;
2564 item->arg_offset = p - buf;
2565 item->arg_len = (int)(eol - p);
2566 item->commit = NULL;
2569 if (fixup_okay)
2570 ; /* do nothing */
2571 else if (is_fixup(item->command))
2572 return error(_("cannot '%s' without a previous commit"),
2573 command_to_string(item->command));
2574 else if (!is_noop(item->command))
2575 fixup_okay = 1;
2578 return res;
2581 static int count_commands(struct todo_list *todo_list)
2583 int count = 0, i;
2585 for (i = 0; i < todo_list->nr; i++)
2586 if (todo_list->items[i].command != TODO_COMMENT)
2587 count++;
2589 return count;
2592 static int get_item_line_offset(struct todo_list *todo_list, int index)
2594 return index < todo_list->nr ?
2595 todo_list->items[index].offset_in_buf : todo_list->buf.len;
2598 static const char *get_item_line(struct todo_list *todo_list, int index)
2600 return todo_list->buf.buf + get_item_line_offset(todo_list, index);
2603 static int get_item_line_length(struct todo_list *todo_list, int index)
2605 return get_item_line_offset(todo_list, index + 1)
2606 - get_item_line_offset(todo_list, index);
2609 static ssize_t strbuf_read_file_or_whine(struct strbuf *sb, const char *path)
2611 int fd;
2612 ssize_t len;
2614 fd = open(path, O_RDONLY);
2615 if (fd < 0)
2616 return error_errno(_("could not open '%s'"), path);
2617 len = strbuf_read(sb, fd, 0);
2618 close(fd);
2619 if (len < 0)
2620 return error(_("could not read '%s'."), path);
2621 return len;
2624 static int have_finished_the_last_pick(void)
2626 struct strbuf buf = STRBUF_INIT;
2627 const char *eol;
2628 const char *todo_path = git_path_todo_file();
2629 int ret = 0;
2631 if (strbuf_read_file(&buf, todo_path, 0) < 0) {
2632 if (errno == ENOENT) {
2633 return 0;
2634 } else {
2635 error_errno("unable to open '%s'", todo_path);
2636 return 0;
2639 /* If there is only one line then we are done */
2640 eol = strchr(buf.buf, '\n');
2641 if (!eol || !eol[1])
2642 ret = 1;
2644 strbuf_release(&buf);
2646 return ret;
2649 void sequencer_post_commit_cleanup(struct repository *r, int verbose)
2651 struct replay_opts opts = REPLAY_OPTS_INIT;
2652 int need_cleanup = 0;
2654 if (refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD")) {
2655 if (!refs_delete_ref(get_main_ref_store(r), "",
2656 "CHERRY_PICK_HEAD", NULL, 0) &&
2657 verbose)
2658 warning(_("cancelling a cherry picking in progress"));
2659 opts.action = REPLAY_PICK;
2660 need_cleanup = 1;
2663 if (refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD")) {
2664 if (!refs_delete_ref(get_main_ref_store(r), "", "REVERT_HEAD",
2665 NULL, 0) &&
2666 verbose)
2667 warning(_("cancelling a revert in progress"));
2668 opts.action = REPLAY_REVERT;
2669 need_cleanup = 1;
2672 unlink(git_path_auto_merge(r));
2674 if (!need_cleanup)
2675 return;
2677 if (!have_finished_the_last_pick())
2678 return;
2680 sequencer_remove_state(&opts);
2683 static void todo_list_write_total_nr(struct todo_list *todo_list)
2685 FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
2687 if (f) {
2688 fprintf(f, "%d\n", todo_list->total_nr);
2689 fclose(f);
2693 static int read_populate_todo(struct repository *r,
2694 struct todo_list *todo_list,
2695 struct replay_opts *opts)
2697 const char *todo_file = get_todo_path(opts);
2698 int res;
2700 strbuf_reset(&todo_list->buf);
2701 if (strbuf_read_file_or_whine(&todo_list->buf, todo_file) < 0)
2702 return -1;
2704 res = todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
2705 if (res) {
2706 if (is_rebase_i(opts))
2707 return error(_("please fix this using "
2708 "'git rebase --edit-todo'."));
2709 return error(_("unusable instruction sheet: '%s'"), todo_file);
2712 if (!todo_list->nr &&
2713 (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
2714 return error(_("no commits parsed."));
2716 if (!is_rebase_i(opts)) {
2717 enum todo_command valid =
2718 opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
2719 int i;
2721 for (i = 0; i < todo_list->nr; i++)
2722 if (valid == todo_list->items[i].command)
2723 continue;
2724 else if (valid == TODO_PICK)
2725 return error(_("cannot cherry-pick during a revert."));
2726 else
2727 return error(_("cannot revert during a cherry-pick."));
2730 if (is_rebase_i(opts)) {
2731 struct todo_list done = TODO_LIST_INIT;
2733 if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
2734 !todo_list_parse_insn_buffer(r, done.buf.buf, &done))
2735 todo_list->done_nr = count_commands(&done);
2736 else
2737 todo_list->done_nr = 0;
2739 todo_list->total_nr = todo_list->done_nr
2740 + count_commands(todo_list);
2741 todo_list_release(&done);
2743 todo_list_write_total_nr(todo_list);
2746 return 0;
2749 static int git_config_string_dup(char **dest,
2750 const char *var, const char *value)
2752 if (!value)
2753 return config_error_nonbool(var);
2754 free(*dest);
2755 *dest = xstrdup(value);
2756 return 0;
2759 static int populate_opts_cb(const char *key, const char *value, void *data)
2761 struct replay_opts *opts = data;
2762 int error_flag = 1;
2764 if (!value)
2765 error_flag = 0;
2766 else if (!strcmp(key, "options.no-commit"))
2767 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
2768 else if (!strcmp(key, "options.edit"))
2769 opts->edit = git_config_bool_or_int(key, value, &error_flag);
2770 else if (!strcmp(key, "options.allow-empty"))
2771 opts->allow_empty =
2772 git_config_bool_or_int(key, value, &error_flag);
2773 else if (!strcmp(key, "options.allow-empty-message"))
2774 opts->allow_empty_message =
2775 git_config_bool_or_int(key, value, &error_flag);
2776 else if (!strcmp(key, "options.keep-redundant-commits"))
2777 opts->keep_redundant_commits =
2778 git_config_bool_or_int(key, value, &error_flag);
2779 else if (!strcmp(key, "options.signoff"))
2780 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
2781 else if (!strcmp(key, "options.record-origin"))
2782 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
2783 else if (!strcmp(key, "options.allow-ff"))
2784 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
2785 else if (!strcmp(key, "options.mainline"))
2786 opts->mainline = git_config_int(key, value);
2787 else if (!strcmp(key, "options.strategy"))
2788 git_config_string_dup(&opts->strategy, key, value);
2789 else if (!strcmp(key, "options.gpg-sign"))
2790 git_config_string_dup(&opts->gpg_sign, key, value);
2791 else if (!strcmp(key, "options.strategy-option")) {
2792 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
2793 opts->xopts[opts->xopts_nr++] = xstrdup(value);
2794 } else if (!strcmp(key, "options.allow-rerere-auto"))
2795 opts->allow_rerere_auto =
2796 git_config_bool_or_int(key, value, &error_flag) ?
2797 RERERE_AUTOUPDATE : RERERE_NOAUTOUPDATE;
2798 else if (!strcmp(key, "options.default-msg-cleanup")) {
2799 opts->explicit_cleanup = 1;
2800 opts->default_msg_cleanup = get_cleanup_mode(value, 1);
2801 } else
2802 return error(_("invalid key: %s"), key);
2804 if (!error_flag)
2805 return error(_("invalid value for %s: %s"), key, value);
2807 return 0;
2810 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts)
2812 int i;
2813 char *strategy_opts_string = raw_opts;
2815 if (*strategy_opts_string == ' ')
2816 strategy_opts_string++;
2818 opts->xopts_nr = split_cmdline(strategy_opts_string,
2819 (const char ***)&opts->xopts);
2820 for (i = 0; i < opts->xopts_nr; i++) {
2821 const char *arg = opts->xopts[i];
2823 skip_prefix(arg, "--", &arg);
2824 opts->xopts[i] = xstrdup(arg);
2828 static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
2830 strbuf_reset(buf);
2831 if (!read_oneliner(buf, rebase_path_strategy(), 0))
2832 return;
2833 opts->strategy = strbuf_detach(buf, NULL);
2834 if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
2835 return;
2837 parse_strategy_opts(opts, buf->buf);
2840 static int read_populate_opts(struct replay_opts *opts)
2842 if (is_rebase_i(opts)) {
2843 struct strbuf buf = STRBUF_INIT;
2844 int ret = 0;
2846 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(),
2847 READ_ONELINER_SKIP_IF_EMPTY)) {
2848 if (!starts_with(buf.buf, "-S"))
2849 strbuf_reset(&buf);
2850 else {
2851 free(opts->gpg_sign);
2852 opts->gpg_sign = xstrdup(buf.buf + 2);
2854 strbuf_reset(&buf);
2857 if (read_oneliner(&buf, rebase_path_allow_rerere_autoupdate(),
2858 READ_ONELINER_SKIP_IF_EMPTY)) {
2859 if (!strcmp(buf.buf, "--rerere-autoupdate"))
2860 opts->allow_rerere_auto = RERERE_AUTOUPDATE;
2861 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
2862 opts->allow_rerere_auto = RERERE_NOAUTOUPDATE;
2863 strbuf_reset(&buf);
2866 if (file_exists(rebase_path_verbose()))
2867 opts->verbose = 1;
2869 if (file_exists(rebase_path_quiet()))
2870 opts->quiet = 1;
2872 if (file_exists(rebase_path_signoff())) {
2873 opts->allow_ff = 0;
2874 opts->signoff = 1;
2877 if (file_exists(rebase_path_cdate_is_adate())) {
2878 opts->allow_ff = 0;
2879 opts->committer_date_is_author_date = 1;
2882 if (file_exists(rebase_path_ignore_date())) {
2883 opts->allow_ff = 0;
2884 opts->ignore_date = 1;
2887 if (file_exists(rebase_path_reschedule_failed_exec()))
2888 opts->reschedule_failed_exec = 1;
2889 else if (file_exists(rebase_path_no_reschedule_failed_exec()))
2890 opts->reschedule_failed_exec = 0;
2892 if (file_exists(rebase_path_drop_redundant_commits()))
2893 opts->drop_redundant_commits = 1;
2895 if (file_exists(rebase_path_keep_redundant_commits()))
2896 opts->keep_redundant_commits = 1;
2898 read_strategy_opts(opts, &buf);
2899 strbuf_reset(&buf);
2901 if (read_oneliner(&opts->current_fixups,
2902 rebase_path_current_fixups(),
2903 READ_ONELINER_SKIP_IF_EMPTY)) {
2904 const char *p = opts->current_fixups.buf;
2905 opts->current_fixup_count = 1;
2906 while ((p = strchr(p, '\n'))) {
2907 opts->current_fixup_count++;
2908 p++;
2912 if (read_oneliner(&buf, rebase_path_squash_onto(), 0)) {
2913 if (get_oid_committish(buf.buf, &opts->squash_onto) < 0) {
2914 ret = error(_("unusable squash-onto"));
2915 goto done_rebase_i;
2917 opts->have_squash_onto = 1;
2920 done_rebase_i:
2921 strbuf_release(&buf);
2922 return ret;
2925 if (!file_exists(git_path_opts_file()))
2926 return 0;
2928 * The function git_parse_source(), called from git_config_from_file(),
2929 * may die() in case of a syntactically incorrect file. We do not care
2930 * about this case, though, because we wrote that file ourselves, so we
2931 * are pretty certain that it is syntactically correct.
2933 if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
2934 return error(_("malformed options sheet: '%s'"),
2935 git_path_opts_file());
2936 return 0;
2939 static void write_strategy_opts(struct replay_opts *opts)
2941 int i;
2942 struct strbuf buf = STRBUF_INIT;
2944 for (i = 0; i < opts->xopts_nr; ++i)
2945 strbuf_addf(&buf, " --%s", opts->xopts[i]);
2947 write_file(rebase_path_strategy_opts(), "%s\n", buf.buf);
2948 strbuf_release(&buf);
2951 int write_basic_state(struct replay_opts *opts, const char *head_name,
2952 struct commit *onto, const struct object_id *orig_head)
2954 if (head_name)
2955 write_file(rebase_path_head_name(), "%s\n", head_name);
2956 if (onto)
2957 write_file(rebase_path_onto(), "%s\n",
2958 oid_to_hex(&onto->object.oid));
2959 if (orig_head)
2960 write_file(rebase_path_orig_head(), "%s\n",
2961 oid_to_hex(orig_head));
2963 if (opts->quiet)
2964 write_file(rebase_path_quiet(), "%s", "");
2965 if (opts->verbose)
2966 write_file(rebase_path_verbose(), "%s", "");
2967 if (opts->strategy)
2968 write_file(rebase_path_strategy(), "%s\n", opts->strategy);
2969 if (opts->xopts_nr > 0)
2970 write_strategy_opts(opts);
2972 if (opts->allow_rerere_auto == RERERE_AUTOUPDATE)
2973 write_file(rebase_path_allow_rerere_autoupdate(), "--rerere-autoupdate\n");
2974 else if (opts->allow_rerere_auto == RERERE_NOAUTOUPDATE)
2975 write_file(rebase_path_allow_rerere_autoupdate(), "--no-rerere-autoupdate\n");
2977 if (opts->gpg_sign)
2978 write_file(rebase_path_gpg_sign_opt(), "-S%s\n", opts->gpg_sign);
2979 if (opts->signoff)
2980 write_file(rebase_path_signoff(), "--signoff\n");
2981 if (opts->drop_redundant_commits)
2982 write_file(rebase_path_drop_redundant_commits(), "%s", "");
2983 if (opts->keep_redundant_commits)
2984 write_file(rebase_path_keep_redundant_commits(), "%s", "");
2985 if (opts->committer_date_is_author_date)
2986 write_file(rebase_path_cdate_is_adate(), "%s", "");
2987 if (opts->ignore_date)
2988 write_file(rebase_path_ignore_date(), "%s", "");
2989 if (opts->reschedule_failed_exec)
2990 write_file(rebase_path_reschedule_failed_exec(), "%s", "");
2991 else
2992 write_file(rebase_path_no_reschedule_failed_exec(), "%s", "");
2994 return 0;
2997 static int walk_revs_populate_todo(struct todo_list *todo_list,
2998 struct replay_opts *opts)
3000 enum todo_command command = opts->action == REPLAY_PICK ?
3001 TODO_PICK : TODO_REVERT;
3002 const char *command_string = todo_command_info[command].str;
3003 const char *encoding;
3004 struct commit *commit;
3006 if (prepare_revs(opts))
3007 return -1;
3009 encoding = get_log_output_encoding();
3011 while ((commit = get_revision(opts->revs))) {
3012 struct todo_item *item = append_new_todo(todo_list);
3013 const char *commit_buffer = logmsg_reencode(commit, NULL, encoding);
3014 const char *subject;
3015 int subject_len;
3017 item->command = command;
3018 item->commit = commit;
3019 item->arg_offset = 0;
3020 item->arg_len = 0;
3021 item->offset_in_buf = todo_list->buf.len;
3022 subject_len = find_commit_subject(commit_buffer, &subject);
3023 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
3024 short_commit_name(commit), subject_len, subject);
3025 unuse_commit_buffer(commit, commit_buffer);
3028 if (!todo_list->nr)
3029 return error(_("empty commit set passed"));
3031 return 0;
3034 static int create_seq_dir(struct repository *r)
3036 enum replay_action action;
3037 const char *in_progress_error = NULL;
3038 const char *in_progress_advice = NULL;
3039 unsigned int advise_skip =
3040 refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD") ||
3041 refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD");
3043 if (!sequencer_get_last_command(r, &action)) {
3044 switch (action) {
3045 case REPLAY_REVERT:
3046 in_progress_error = _("revert is already in progress");
3047 in_progress_advice =
3048 _("try \"git revert (--continue | %s--abort | --quit)\"");
3049 break;
3050 case REPLAY_PICK:
3051 in_progress_error = _("cherry-pick is already in progress");
3052 in_progress_advice =
3053 _("try \"git cherry-pick (--continue | %s--abort | --quit)\"");
3054 break;
3055 default:
3056 BUG("unexpected action in create_seq_dir");
3059 if (in_progress_error) {
3060 error("%s", in_progress_error);
3061 if (advice_enabled(ADVICE_SEQUENCER_IN_USE))
3062 advise(in_progress_advice,
3063 advise_skip ? "--skip | " : "");
3064 return -1;
3066 if (mkdir(git_path_seq_dir(), 0777) < 0)
3067 return error_errno(_("could not create sequencer directory '%s'"),
3068 git_path_seq_dir());
3070 return 0;
3073 static int save_head(const char *head)
3075 struct lock_file head_lock = LOCK_INIT;
3076 struct strbuf buf = STRBUF_INIT;
3077 int fd;
3078 ssize_t written;
3080 fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
3081 if (fd < 0)
3082 return error_errno(_("could not lock HEAD"));
3083 strbuf_addf(&buf, "%s\n", head);
3084 written = write_in_full(fd, buf.buf, buf.len);
3085 strbuf_release(&buf);
3086 if (written < 0) {
3087 error_errno(_("could not write to '%s'"), git_path_head_file());
3088 rollback_lock_file(&head_lock);
3089 return -1;
3091 if (commit_lock_file(&head_lock) < 0)
3092 return error(_("failed to finalize '%s'"), git_path_head_file());
3093 return 0;
3096 static int rollback_is_safe(void)
3098 struct strbuf sb = STRBUF_INIT;
3099 struct object_id expected_head, actual_head;
3101 if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
3102 strbuf_trim(&sb);
3103 if (get_oid_hex(sb.buf, &expected_head)) {
3104 strbuf_release(&sb);
3105 die(_("could not parse %s"), git_path_abort_safety_file());
3107 strbuf_release(&sb);
3109 else if (errno == ENOENT)
3110 oidclr(&expected_head);
3111 else
3112 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
3114 if (get_oid("HEAD", &actual_head))
3115 oidclr(&actual_head);
3117 return oideq(&actual_head, &expected_head);
3120 static int reset_merge(const struct object_id *oid)
3122 int ret;
3123 struct strvec argv = STRVEC_INIT;
3125 strvec_pushl(&argv, "reset", "--merge", NULL);
3127 if (!is_null_oid(oid))
3128 strvec_push(&argv, oid_to_hex(oid));
3130 ret = run_command_v_opt(argv.v, RUN_GIT_CMD);
3131 strvec_clear(&argv);
3133 return ret;
3136 static int rollback_single_pick(struct repository *r)
3138 struct object_id head_oid;
3140 if (!refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD") &&
3141 !refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD"))
3142 return error(_("no cherry-pick or revert in progress"));
3143 if (read_ref_full("HEAD", 0, &head_oid, NULL))
3144 return error(_("cannot resolve HEAD"));
3145 if (is_null_oid(&head_oid))
3146 return error(_("cannot abort from a branch yet to be born"));
3147 return reset_merge(&head_oid);
3150 static int skip_single_pick(void)
3152 struct object_id head;
3154 if (read_ref_full("HEAD", 0, &head, NULL))
3155 return error(_("cannot resolve HEAD"));
3156 return reset_merge(&head);
3159 int sequencer_rollback(struct repository *r, struct replay_opts *opts)
3161 FILE *f;
3162 struct object_id oid;
3163 struct strbuf buf = STRBUF_INIT;
3164 const char *p;
3166 f = fopen(git_path_head_file(), "r");
3167 if (!f && errno == ENOENT) {
3169 * There is no multiple-cherry-pick in progress.
3170 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
3171 * a single-cherry-pick in progress, abort that.
3173 return rollback_single_pick(r);
3175 if (!f)
3176 return error_errno(_("cannot open '%s'"), git_path_head_file());
3177 if (strbuf_getline_lf(&buf, f)) {
3178 error(_("cannot read '%s': %s"), git_path_head_file(),
3179 ferror(f) ? strerror(errno) : _("unexpected end of file"));
3180 fclose(f);
3181 goto fail;
3183 fclose(f);
3184 if (parse_oid_hex(buf.buf, &oid, &p) || *p != '\0') {
3185 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
3186 git_path_head_file());
3187 goto fail;
3189 if (is_null_oid(&oid)) {
3190 error(_("cannot abort from a branch yet to be born"));
3191 goto fail;
3194 if (!rollback_is_safe()) {
3195 /* Do not error, just do not rollback */
3196 warning(_("You seem to have moved HEAD. "
3197 "Not rewinding, check your HEAD!"));
3198 } else
3199 if (reset_merge(&oid))
3200 goto fail;
3201 strbuf_release(&buf);
3202 return sequencer_remove_state(opts);
3203 fail:
3204 strbuf_release(&buf);
3205 return -1;
3208 int sequencer_skip(struct repository *r, struct replay_opts *opts)
3210 enum replay_action action = -1;
3211 sequencer_get_last_command(r, &action);
3214 * Check whether the subcommand requested to skip the commit is actually
3215 * in progress and that it's safe to skip the commit.
3217 * opts->action tells us which subcommand requested to skip the commit.
3218 * If the corresponding .git/<ACTION>_HEAD exists, we know that the
3219 * action is in progress and we can skip the commit.
3221 * Otherwise we check that the last instruction was related to the
3222 * particular subcommand we're trying to execute and barf if that's not
3223 * the case.
3225 * Finally we check that the rollback is "safe", i.e., has the HEAD
3226 * moved? In this case, it doesn't make sense to "reset the merge" and
3227 * "skip the commit" as the user already handled this by committing. But
3228 * we'd not want to barf here, instead give advice on how to proceed. We
3229 * only need to check that when .git/<ACTION>_HEAD doesn't exist because
3230 * it gets removed when the user commits, so if it still exists we're
3231 * sure the user can't have committed before.
3233 switch (opts->action) {
3234 case REPLAY_REVERT:
3235 if (!refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD")) {
3236 if (action != REPLAY_REVERT)
3237 return error(_("no revert in progress"));
3238 if (!rollback_is_safe())
3239 goto give_advice;
3241 break;
3242 case REPLAY_PICK:
3243 if (!refs_ref_exists(get_main_ref_store(r),
3244 "CHERRY_PICK_HEAD")) {
3245 if (action != REPLAY_PICK)
3246 return error(_("no cherry-pick in progress"));
3247 if (!rollback_is_safe())
3248 goto give_advice;
3250 break;
3251 default:
3252 BUG("unexpected action in sequencer_skip");
3255 if (skip_single_pick())
3256 return error(_("failed to skip the commit"));
3257 if (!is_directory(git_path_seq_dir()))
3258 return 0;
3260 return sequencer_continue(r, opts);
3262 give_advice:
3263 error(_("there is nothing to skip"));
3265 if (advice_enabled(ADVICE_RESOLVE_CONFLICT)) {
3266 advise(_("have you committed already?\n"
3267 "try \"git %s --continue\""),
3268 action == REPLAY_REVERT ? "revert" : "cherry-pick");
3270 return -1;
3273 static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
3275 struct lock_file todo_lock = LOCK_INIT;
3276 const char *todo_path = get_todo_path(opts);
3277 int next = todo_list->current, offset, fd;
3280 * rebase -i writes "git-rebase-todo" without the currently executing
3281 * command, appending it to "done" instead.
3283 if (is_rebase_i(opts))
3284 next++;
3286 fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
3287 if (fd < 0)
3288 return error_errno(_("could not lock '%s'"), todo_path);
3289 offset = get_item_line_offset(todo_list, next);
3290 if (write_in_full(fd, todo_list->buf.buf + offset,
3291 todo_list->buf.len - offset) < 0)
3292 return error_errno(_("could not write to '%s'"), todo_path);
3293 if (commit_lock_file(&todo_lock) < 0)
3294 return error(_("failed to finalize '%s'"), todo_path);
3296 if (is_rebase_i(opts) && next > 0) {
3297 const char *done = rebase_path_done();
3298 int fd = open(done, O_CREAT | O_WRONLY | O_APPEND, 0666);
3299 int ret = 0;
3301 if (fd < 0)
3302 return 0;
3303 if (write_in_full(fd, get_item_line(todo_list, next - 1),
3304 get_item_line_length(todo_list, next - 1))
3305 < 0)
3306 ret = error_errno(_("could not write to '%s'"), done);
3307 if (close(fd) < 0)
3308 ret = error_errno(_("failed to finalize '%s'"), done);
3309 return ret;
3311 return 0;
3314 static int save_opts(struct replay_opts *opts)
3316 const char *opts_file = git_path_opts_file();
3317 int res = 0;
3319 if (opts->no_commit)
3320 res |= git_config_set_in_file_gently(opts_file,
3321 "options.no-commit", "true");
3322 if (opts->edit >= 0)
3323 res |= git_config_set_in_file_gently(opts_file, "options.edit",
3324 opts->edit ? "true" : "false");
3325 if (opts->allow_empty)
3326 res |= git_config_set_in_file_gently(opts_file,
3327 "options.allow-empty", "true");
3328 if (opts->allow_empty_message)
3329 res |= git_config_set_in_file_gently(opts_file,
3330 "options.allow-empty-message", "true");
3331 if (opts->keep_redundant_commits)
3332 res |= git_config_set_in_file_gently(opts_file,
3333 "options.keep-redundant-commits", "true");
3334 if (opts->signoff)
3335 res |= git_config_set_in_file_gently(opts_file,
3336 "options.signoff", "true");
3337 if (opts->record_origin)
3338 res |= git_config_set_in_file_gently(opts_file,
3339 "options.record-origin", "true");
3340 if (opts->allow_ff)
3341 res |= git_config_set_in_file_gently(opts_file,
3342 "options.allow-ff", "true");
3343 if (opts->mainline) {
3344 struct strbuf buf = STRBUF_INIT;
3345 strbuf_addf(&buf, "%d", opts->mainline);
3346 res |= git_config_set_in_file_gently(opts_file,
3347 "options.mainline", buf.buf);
3348 strbuf_release(&buf);
3350 if (opts->strategy)
3351 res |= git_config_set_in_file_gently(opts_file,
3352 "options.strategy", opts->strategy);
3353 if (opts->gpg_sign)
3354 res |= git_config_set_in_file_gently(opts_file,
3355 "options.gpg-sign", opts->gpg_sign);
3356 if (opts->xopts) {
3357 int i;
3358 for (i = 0; i < opts->xopts_nr; i++)
3359 res |= git_config_set_multivar_in_file_gently(opts_file,
3360 "options.strategy-option",
3361 opts->xopts[i], "^$", 0);
3363 if (opts->allow_rerere_auto)
3364 res |= git_config_set_in_file_gently(opts_file,
3365 "options.allow-rerere-auto",
3366 opts->allow_rerere_auto == RERERE_AUTOUPDATE ?
3367 "true" : "false");
3369 if (opts->explicit_cleanup)
3370 res |= git_config_set_in_file_gently(opts_file,
3371 "options.default-msg-cleanup",
3372 describe_cleanup_mode(opts->default_msg_cleanup));
3373 return res;
3376 static int make_patch(struct repository *r,
3377 struct commit *commit,
3378 struct replay_opts *opts)
3380 struct strbuf buf = STRBUF_INIT;
3381 struct rev_info log_tree_opt;
3382 const char *subject;
3383 char hex[GIT_MAX_HEXSZ + 1];
3384 int res = 0;
3386 oid_to_hex_r(hex, &commit->object.oid);
3387 if (write_message(hex, strlen(hex), rebase_path_stopped_sha(), 1) < 0)
3388 return -1;
3389 res |= write_rebase_head(&commit->object.oid);
3391 strbuf_addf(&buf, "%s/patch", get_dir(opts));
3392 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
3393 repo_init_revisions(r, &log_tree_opt, NULL);
3394 log_tree_opt.abbrev = 0;
3395 log_tree_opt.diff = 1;
3396 log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
3397 log_tree_opt.disable_stdin = 1;
3398 log_tree_opt.no_commit_id = 1;
3399 log_tree_opt.diffopt.file = fopen(buf.buf, "w");
3400 log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
3401 if (!log_tree_opt.diffopt.file)
3402 res |= error_errno(_("could not open '%s'"), buf.buf);
3403 else {
3404 res |= log_tree_commit(&log_tree_opt, commit);
3405 fclose(log_tree_opt.diffopt.file);
3407 strbuf_reset(&buf);
3409 strbuf_addf(&buf, "%s/message", get_dir(opts));
3410 if (!file_exists(buf.buf)) {
3411 const char *encoding = get_commit_output_encoding();
3412 const char *commit_buffer = logmsg_reencode(commit, NULL, encoding);
3413 find_commit_subject(commit_buffer, &subject);
3414 res |= write_message(subject, strlen(subject), buf.buf, 1);
3415 unuse_commit_buffer(commit, commit_buffer);
3417 strbuf_release(&buf);
3419 return res;
3422 static int intend_to_amend(void)
3424 struct object_id head;
3425 char *p;
3427 if (get_oid("HEAD", &head))
3428 return error(_("cannot read HEAD"));
3430 p = oid_to_hex(&head);
3431 return write_message(p, strlen(p), rebase_path_amend(), 1);
3434 static int error_with_patch(struct repository *r,
3435 struct commit *commit,
3436 const char *subject, int subject_len,
3437 struct replay_opts *opts,
3438 int exit_code, int to_amend)
3440 if (commit) {
3441 if (make_patch(r, commit, opts))
3442 return -1;
3443 } else if (copy_file(rebase_path_message(),
3444 git_path_merge_msg(r), 0666))
3445 return error(_("unable to copy '%s' to '%s'"),
3446 git_path_merge_msg(r), rebase_path_message());
3448 if (to_amend) {
3449 if (intend_to_amend())
3450 return -1;
3452 fprintf(stderr,
3453 _("You can amend the commit now, with\n"
3454 "\n"
3455 " git commit --amend %s\n"
3456 "\n"
3457 "Once you are satisfied with your changes, run\n"
3458 "\n"
3459 " git rebase --continue\n"),
3460 gpg_sign_opt_quoted(opts));
3461 } else if (exit_code) {
3462 if (commit)
3463 fprintf_ln(stderr, _("Could not apply %s... %.*s"),
3464 short_commit_name(commit), subject_len, subject);
3465 else
3467 * We don't have the hash of the parent so
3468 * just print the line from the todo file.
3470 fprintf_ln(stderr, _("Could not merge %.*s"),
3471 subject_len, subject);
3474 return exit_code;
3477 static int error_failed_squash(struct repository *r,
3478 struct commit *commit,
3479 struct replay_opts *opts,
3480 int subject_len,
3481 const char *subject)
3483 if (copy_file(rebase_path_message(), rebase_path_squash_msg(), 0666))
3484 return error(_("could not copy '%s' to '%s'"),
3485 rebase_path_squash_msg(), rebase_path_message());
3486 unlink(git_path_merge_msg(r));
3487 if (copy_file(git_path_merge_msg(r), rebase_path_message(), 0666))
3488 return error(_("could not copy '%s' to '%s'"),
3489 rebase_path_message(),
3490 git_path_merge_msg(r));
3491 return error_with_patch(r, commit, subject, subject_len, opts, 1, 0);
3494 static int do_exec(struct repository *r, const char *command_line)
3496 const char *child_argv[] = { NULL, NULL };
3497 int dirty, status;
3499 fprintf(stderr, _("Executing: %s\n"), command_line);
3500 child_argv[0] = command_line;
3501 status = run_command_v_opt(child_argv, RUN_USING_SHELL);
3503 /* force re-reading of the cache */
3504 if (discard_index(r->index) < 0 || repo_read_index(r) < 0)
3505 return error(_("could not read index"));
3507 dirty = require_clean_work_tree(r, "rebase", NULL, 1, 1);
3509 if (status) {
3510 warning(_("execution failed: %s\n%s"
3511 "You can fix the problem, and then run\n"
3512 "\n"
3513 " git rebase --continue\n"
3514 "\n"),
3515 command_line,
3516 dirty ? N_("and made changes to the index and/or the "
3517 "working tree\n") : "");
3518 if (status == 127)
3519 /* command not found */
3520 status = 1;
3521 } else if (dirty) {
3522 warning(_("execution succeeded: %s\nbut "
3523 "left changes to the index and/or the working tree\n"
3524 "Commit or stash your changes, and then run\n"
3525 "\n"
3526 " git rebase --continue\n"
3527 "\n"), command_line);
3528 status = 1;
3531 return status;
3534 __attribute__((format (printf, 2, 3)))
3535 static int safe_append(const char *filename, const char *fmt, ...)
3537 va_list ap;
3538 struct lock_file lock = LOCK_INIT;
3539 int fd = hold_lock_file_for_update(&lock, filename,
3540 LOCK_REPORT_ON_ERROR);
3541 struct strbuf buf = STRBUF_INIT;
3543 if (fd < 0)
3544 return -1;
3546 if (strbuf_read_file(&buf, filename, 0) < 0 && errno != ENOENT) {
3547 error_errno(_("could not read '%s'"), filename);
3548 rollback_lock_file(&lock);
3549 return -1;
3551 strbuf_complete(&buf, '\n');
3552 va_start(ap, fmt);
3553 strbuf_vaddf(&buf, fmt, ap);
3554 va_end(ap);
3556 if (write_in_full(fd, buf.buf, buf.len) < 0) {
3557 error_errno(_("could not write to '%s'"), filename);
3558 strbuf_release(&buf);
3559 rollback_lock_file(&lock);
3560 return -1;
3562 if (commit_lock_file(&lock) < 0) {
3563 strbuf_release(&buf);
3564 rollback_lock_file(&lock);
3565 return error(_("failed to finalize '%s'"), filename);
3568 strbuf_release(&buf);
3569 return 0;
3572 static int do_label(struct repository *r, const char *name, int len)
3574 struct ref_store *refs = get_main_ref_store(r);
3575 struct ref_transaction *transaction;
3576 struct strbuf ref_name = STRBUF_INIT, err = STRBUF_INIT;
3577 struct strbuf msg = STRBUF_INIT;
3578 int ret = 0;
3579 struct object_id head_oid;
3581 if (len == 1 && *name == '#')
3582 return error(_("illegal label name: '%.*s'"), len, name);
3584 strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
3585 strbuf_addf(&msg, "rebase (label) '%.*s'", len, name);
3587 transaction = ref_store_transaction_begin(refs, &err);
3588 if (!transaction) {
3589 error("%s", err.buf);
3590 ret = -1;
3591 } else if (get_oid("HEAD", &head_oid)) {
3592 error(_("could not read HEAD"));
3593 ret = -1;
3594 } else if (ref_transaction_update(transaction, ref_name.buf, &head_oid,
3595 NULL, 0, msg.buf, &err) < 0 ||
3596 ref_transaction_commit(transaction, &err)) {
3597 error("%s", err.buf);
3598 ret = -1;
3600 ref_transaction_free(transaction);
3601 strbuf_release(&err);
3602 strbuf_release(&msg);
3604 if (!ret)
3605 ret = safe_append(rebase_path_refs_to_delete(),
3606 "%s\n", ref_name.buf);
3607 strbuf_release(&ref_name);
3609 return ret;
3612 __attribute__((format (printf, 3, 4)))
3613 static const char *reflog_message(struct replay_opts *opts,
3614 const char *sub_action, const char *fmt, ...)
3616 va_list ap;
3617 static struct strbuf buf = STRBUF_INIT;
3618 char *reflog_action = getenv(GIT_REFLOG_ACTION);
3620 va_start(ap, fmt);
3621 strbuf_reset(&buf);
3622 strbuf_addstr(&buf, reflog_action ? reflog_action : action_name(opts));
3623 if (sub_action)
3624 strbuf_addf(&buf, " (%s)", sub_action);
3625 if (fmt) {
3626 strbuf_addstr(&buf, ": ");
3627 strbuf_vaddf(&buf, fmt, ap);
3629 va_end(ap);
3631 return buf.buf;
3634 static int do_reset(struct repository *r,
3635 const char *name, int len,
3636 struct replay_opts *opts)
3638 struct strbuf ref_name = STRBUF_INIT;
3639 struct object_id oid;
3640 struct lock_file lock = LOCK_INIT;
3641 struct tree_desc desc = { 0 };
3642 struct tree *tree;
3643 struct unpack_trees_options unpack_tree_opts = { 0 };
3644 int ret = 0;
3646 if (repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0)
3647 return -1;
3649 if (len == 10 && !strncmp("[new root]", name, len)) {
3650 if (!opts->have_squash_onto) {
3651 const char *hex;
3652 if (commit_tree("", 0, the_hash_algo->empty_tree,
3653 NULL, &opts->squash_onto,
3654 NULL, NULL))
3655 return error(_("writing fake root commit"));
3656 opts->have_squash_onto = 1;
3657 hex = oid_to_hex(&opts->squash_onto);
3658 if (write_message(hex, strlen(hex),
3659 rebase_path_squash_onto(), 0))
3660 return error(_("writing squash-onto"));
3662 oidcpy(&oid, &opts->squash_onto);
3663 } else {
3664 int i;
3666 /* Determine the length of the label */
3667 for (i = 0; i < len; i++)
3668 if (isspace(name[i]))
3669 break;
3670 len = i;
3672 strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
3673 if (get_oid(ref_name.buf, &oid) &&
3674 get_oid(ref_name.buf + strlen("refs/rewritten/"), &oid)) {
3675 ret = error(_("could not read '%s'"), ref_name.buf);
3676 goto cleanup;
3680 setup_unpack_trees_porcelain(&unpack_tree_opts, "reset");
3681 unpack_tree_opts.head_idx = 1;
3682 unpack_tree_opts.src_index = r->index;
3683 unpack_tree_opts.dst_index = r->index;
3684 unpack_tree_opts.fn = oneway_merge;
3685 unpack_tree_opts.merge = 1;
3686 unpack_tree_opts.update = 1;
3687 unpack_tree_opts.preserve_ignored = 0; /* FIXME: !overwrite_ignore */
3688 init_checkout_metadata(&unpack_tree_opts.meta, name, &oid, NULL);
3690 if (repo_read_index_unmerged(r)) {
3691 ret = error_resolve_conflict(_(action_name(opts)));
3692 goto cleanup;
3695 if (!fill_tree_descriptor(r, &desc, &oid)) {
3696 ret = error(_("failed to find tree of %s"), oid_to_hex(&oid));
3697 goto cleanup;
3700 if (unpack_trees(1, &desc, &unpack_tree_opts)) {
3701 ret = -1;
3702 goto cleanup;
3705 tree = parse_tree_indirect(&oid);
3706 prime_cache_tree(r, r->index, tree);
3708 if (write_locked_index(r->index, &lock, COMMIT_LOCK) < 0)
3709 ret = error(_("could not write index"));
3711 if (!ret)
3712 ret = update_ref(reflog_message(opts, "reset", "'%.*s'",
3713 len, name), "HEAD", &oid,
3714 NULL, 0, UPDATE_REFS_MSG_ON_ERR);
3715 cleanup:
3716 free((void *)desc.buffer);
3717 if (ret < 0)
3718 rollback_lock_file(&lock);
3719 strbuf_release(&ref_name);
3720 clear_unpack_trees_porcelain(&unpack_tree_opts);
3721 return ret;
3724 static struct commit *lookup_label(const char *label, int len,
3725 struct strbuf *buf)
3727 struct commit *commit;
3729 strbuf_reset(buf);
3730 strbuf_addf(buf, "refs/rewritten/%.*s", len, label);
3731 commit = lookup_commit_reference_by_name(buf->buf);
3732 if (!commit) {
3733 /* fall back to non-rewritten ref or commit */
3734 strbuf_splice(buf, 0, strlen("refs/rewritten/"), "", 0);
3735 commit = lookup_commit_reference_by_name(buf->buf);
3738 if (!commit)
3739 error(_("could not resolve '%s'"), buf->buf);
3741 return commit;
3744 static int do_merge(struct repository *r,
3745 struct commit *commit,
3746 const char *arg, int arg_len,
3747 int flags, int *check_todo, struct replay_opts *opts)
3749 int run_commit_flags = 0;
3750 struct strbuf ref_name = STRBUF_INIT;
3751 struct commit *head_commit, *merge_commit, *i;
3752 struct commit_list *bases, *j, *reversed = NULL;
3753 struct commit_list *to_merge = NULL, **tail = &to_merge;
3754 const char *strategy = !opts->xopts_nr &&
3755 (!opts->strategy ||
3756 !strcmp(opts->strategy, "recursive") ||
3757 !strcmp(opts->strategy, "ort")) ?
3758 NULL : opts->strategy;
3759 struct merge_options o;
3760 int merge_arg_len, oneline_offset, can_fast_forward, ret, k;
3761 static struct lock_file lock;
3762 const char *p;
3764 if (repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0) {
3765 ret = -1;
3766 goto leave_merge;
3769 head_commit = lookup_commit_reference_by_name("HEAD");
3770 if (!head_commit) {
3771 ret = error(_("cannot merge without a current revision"));
3772 goto leave_merge;
3776 * For octopus merges, the arg starts with the list of revisions to be
3777 * merged. The list is optionally followed by '#' and the oneline.
3779 merge_arg_len = oneline_offset = arg_len;
3780 for (p = arg; p - arg < arg_len; p += strspn(p, " \t\n")) {
3781 if (!*p)
3782 break;
3783 if (*p == '#' && (!p[1] || isspace(p[1]))) {
3784 p += 1 + strspn(p + 1, " \t\n");
3785 oneline_offset = p - arg;
3786 break;
3788 k = strcspn(p, " \t\n");
3789 if (!k)
3790 continue;
3791 merge_commit = lookup_label(p, k, &ref_name);
3792 if (!merge_commit) {
3793 ret = error(_("unable to parse '%.*s'"), k, p);
3794 goto leave_merge;
3796 tail = &commit_list_insert(merge_commit, tail)->next;
3797 p += k;
3798 merge_arg_len = p - arg;
3801 if (!to_merge) {
3802 ret = error(_("nothing to merge: '%.*s'"), arg_len, arg);
3803 goto leave_merge;
3806 if (opts->have_squash_onto &&
3807 oideq(&head_commit->object.oid, &opts->squash_onto)) {
3809 * When the user tells us to "merge" something into a
3810 * "[new root]", let's simply fast-forward to the merge head.
3812 rollback_lock_file(&lock);
3813 if (to_merge->next)
3814 ret = error(_("octopus merge cannot be executed on "
3815 "top of a [new root]"));
3816 else
3817 ret = fast_forward_to(r, &to_merge->item->object.oid,
3818 &head_commit->object.oid, 0,
3819 opts);
3820 goto leave_merge;
3824 * If HEAD is not identical to the first parent of the original merge
3825 * commit, we cannot fast-forward.
3827 can_fast_forward = opts->allow_ff && commit && commit->parents &&
3828 oideq(&commit->parents->item->object.oid,
3829 &head_commit->object.oid);
3832 * If any merge head is different from the original one, we cannot
3833 * fast-forward.
3835 if (can_fast_forward) {
3836 struct commit_list *p = commit->parents->next;
3838 for (j = to_merge; j && p; j = j->next, p = p->next)
3839 if (!oideq(&j->item->object.oid,
3840 &p->item->object.oid)) {
3841 can_fast_forward = 0;
3842 break;
3845 * If the number of merge heads differs from the original merge
3846 * commit, we cannot fast-forward.
3848 if (j || p)
3849 can_fast_forward = 0;
3852 if (can_fast_forward) {
3853 rollback_lock_file(&lock);
3854 ret = fast_forward_to(r, &commit->object.oid,
3855 &head_commit->object.oid, 0, opts);
3856 if (flags & TODO_EDIT_MERGE_MSG)
3857 goto fast_forward_edit;
3859 goto leave_merge;
3862 if (commit) {
3863 const char *encoding = get_commit_output_encoding();
3864 const char *message = logmsg_reencode(commit, NULL, encoding);
3865 const char *body;
3866 int len;
3868 if (!message) {
3869 ret = error(_("could not get commit message of '%s'"),
3870 oid_to_hex(&commit->object.oid));
3871 goto leave_merge;
3873 write_author_script(message);
3874 find_commit_subject(message, &body);
3875 len = strlen(body);
3876 ret = write_message(body, len, git_path_merge_msg(r), 0);
3877 unuse_commit_buffer(commit, message);
3878 if (ret) {
3879 error_errno(_("could not write '%s'"),
3880 git_path_merge_msg(r));
3881 goto leave_merge;
3883 } else {
3884 struct strbuf buf = STRBUF_INIT;
3885 int len;
3887 strbuf_addf(&buf, "author %s", git_author_info(0));
3888 write_author_script(buf.buf);
3889 strbuf_reset(&buf);
3891 if (oneline_offset < arg_len) {
3892 p = arg + oneline_offset;
3893 len = arg_len - oneline_offset;
3894 } else {
3895 strbuf_addf(&buf, "Merge %s '%.*s'",
3896 to_merge->next ? "branches" : "branch",
3897 merge_arg_len, arg);
3898 p = buf.buf;
3899 len = buf.len;
3902 ret = write_message(p, len, git_path_merge_msg(r), 0);
3903 strbuf_release(&buf);
3904 if (ret) {
3905 error_errno(_("could not write '%s'"),
3906 git_path_merge_msg(r));
3907 goto leave_merge;
3911 if (strategy || to_merge->next) {
3912 /* Octopus merge */
3913 struct child_process cmd = CHILD_PROCESS_INIT;
3915 if (read_env_script(&cmd.env_array)) {
3916 const char *gpg_opt = gpg_sign_opt_quoted(opts);
3918 ret = error(_(staged_changes_advice), gpg_opt, gpg_opt);
3919 goto leave_merge;
3922 if (opts->committer_date_is_author_date)
3923 strvec_pushf(&cmd.env_array, "GIT_COMMITTER_DATE=%s",
3924 opts->ignore_date ?
3925 "" :
3926 author_date_from_env_array(&cmd.env_array));
3927 if (opts->ignore_date)
3928 strvec_push(&cmd.env_array, "GIT_AUTHOR_DATE=");
3930 cmd.git_cmd = 1;
3931 strvec_push(&cmd.args, "merge");
3932 strvec_push(&cmd.args, "-s");
3933 if (!strategy)
3934 strvec_push(&cmd.args, "octopus");
3935 else {
3936 strvec_push(&cmd.args, strategy);
3937 for (k = 0; k < opts->xopts_nr; k++)
3938 strvec_pushf(&cmd.args,
3939 "-X%s", opts->xopts[k]);
3941 if (!(flags & TODO_EDIT_MERGE_MSG))
3942 strvec_push(&cmd.args, "--no-edit");
3943 else
3944 strvec_push(&cmd.args, "--edit");
3945 strvec_push(&cmd.args, "--no-ff");
3946 strvec_push(&cmd.args, "--no-log");
3947 strvec_push(&cmd.args, "--no-stat");
3948 strvec_push(&cmd.args, "-F");
3949 strvec_push(&cmd.args, git_path_merge_msg(r));
3950 if (opts->gpg_sign)
3951 strvec_pushf(&cmd.args, "-S%s", opts->gpg_sign);
3952 else
3953 strvec_push(&cmd.args, "--no-gpg-sign");
3955 /* Add the tips to be merged */
3956 for (j = to_merge; j; j = j->next)
3957 strvec_push(&cmd.args,
3958 oid_to_hex(&j->item->object.oid));
3960 strbuf_release(&ref_name);
3961 refs_delete_ref(get_main_ref_store(r), "", "CHERRY_PICK_HEAD",
3962 NULL, 0);
3963 rollback_lock_file(&lock);
3965 ret = run_command(&cmd);
3967 /* force re-reading of the cache */
3968 if (!ret && (discard_index(r->index) < 0 ||
3969 repo_read_index(r) < 0))
3970 ret = error(_("could not read index"));
3971 goto leave_merge;
3974 merge_commit = to_merge->item;
3975 bases = get_merge_bases(head_commit, merge_commit);
3976 if (bases && oideq(&merge_commit->object.oid,
3977 &bases->item->object.oid)) {
3978 ret = 0;
3979 /* skip merging an ancestor of HEAD */
3980 goto leave_merge;
3983 write_message(oid_to_hex(&merge_commit->object.oid), the_hash_algo->hexsz,
3984 git_path_merge_head(r), 0);
3985 write_message("no-ff", 5, git_path_merge_mode(r), 0);
3987 for (j = bases; j; j = j->next)
3988 commit_list_insert(j->item, &reversed);
3989 free_commit_list(bases);
3991 repo_read_index(r);
3992 init_merge_options(&o, r);
3993 o.branch1 = "HEAD";
3994 o.branch2 = ref_name.buf;
3995 o.buffer_output = 2;
3997 if (!opts->strategy || !strcmp(opts->strategy, "ort")) {
3999 * TODO: Should use merge_incore_recursive() and
4000 * merge_switch_to_result(), skipping the call to
4001 * merge_switch_to_result() when we don't actually need to
4002 * update the index and working copy immediately.
4004 ret = merge_ort_recursive(&o,
4005 head_commit, merge_commit, reversed,
4006 &i);
4007 } else {
4008 ret = merge_recursive(&o, head_commit, merge_commit, reversed,
4009 &i);
4011 if (ret <= 0)
4012 fputs(o.obuf.buf, stdout);
4013 strbuf_release(&o.obuf);
4014 if (ret < 0) {
4015 error(_("could not even attempt to merge '%.*s'"),
4016 merge_arg_len, arg);
4017 goto leave_merge;
4020 * The return value of merge_recursive() is 1 on clean, and 0 on
4021 * unclean merge.
4023 * Let's reverse that, so that do_merge() returns 0 upon success and
4024 * 1 upon failed merge (keeping the return value -1 for the cases where
4025 * we will want to reschedule the `merge` command).
4027 ret = !ret;
4029 if (r->index->cache_changed &&
4030 write_locked_index(r->index, &lock, COMMIT_LOCK)) {
4031 ret = error(_("merge: Unable to write new index file"));
4032 goto leave_merge;
4035 rollback_lock_file(&lock);
4036 if (ret)
4037 repo_rerere(r, opts->allow_rerere_auto);
4038 else
4040 * In case of problems, we now want to return a positive
4041 * value (a negative one would indicate that the `merge`
4042 * command needs to be rescheduled).
4044 ret = !!run_git_commit(git_path_merge_msg(r), opts,
4045 run_commit_flags);
4047 if (!ret && flags & TODO_EDIT_MERGE_MSG) {
4048 fast_forward_edit:
4049 *check_todo = 1;
4050 run_commit_flags |= AMEND_MSG | EDIT_MSG | VERIFY_MSG;
4051 ret = !!run_git_commit(NULL, opts, run_commit_flags);
4055 leave_merge:
4056 strbuf_release(&ref_name);
4057 rollback_lock_file(&lock);
4058 free_commit_list(to_merge);
4059 return ret;
4062 static int is_final_fixup(struct todo_list *todo_list)
4064 int i = todo_list->current;
4066 if (!is_fixup(todo_list->items[i].command))
4067 return 0;
4069 while (++i < todo_list->nr)
4070 if (is_fixup(todo_list->items[i].command))
4071 return 0;
4072 else if (!is_noop(todo_list->items[i].command))
4073 break;
4074 return 1;
4077 static enum todo_command peek_command(struct todo_list *todo_list, int offset)
4079 int i;
4081 for (i = todo_list->current + offset; i < todo_list->nr; i++)
4082 if (!is_noop(todo_list->items[i].command))
4083 return todo_list->items[i].command;
4085 return -1;
4088 void create_autostash(struct repository *r, const char *path,
4089 const char *default_reflog_action)
4091 struct strbuf buf = STRBUF_INIT;
4092 struct lock_file lock_file = LOCK_INIT;
4093 int fd;
4095 fd = repo_hold_locked_index(r, &lock_file, 0);
4096 refresh_index(r->index, REFRESH_QUIET, NULL, NULL, NULL);
4097 if (0 <= fd)
4098 repo_update_index_if_able(r, &lock_file);
4099 rollback_lock_file(&lock_file);
4101 if (has_unstaged_changes(r, 1) ||
4102 has_uncommitted_changes(r, 1)) {
4103 struct child_process stash = CHILD_PROCESS_INIT;
4104 struct object_id oid;
4106 strvec_pushl(&stash.args,
4107 "stash", "create", "autostash", NULL);
4108 stash.git_cmd = 1;
4109 stash.no_stdin = 1;
4110 strbuf_reset(&buf);
4111 if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
4112 die(_("Cannot autostash"));
4113 strbuf_trim_trailing_newline(&buf);
4114 if (get_oid(buf.buf, &oid))
4115 die(_("Unexpected stash response: '%s'"),
4116 buf.buf);
4117 strbuf_reset(&buf);
4118 strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
4120 if (safe_create_leading_directories_const(path))
4121 die(_("Could not create directory for '%s'"),
4122 path);
4123 write_file(path, "%s", oid_to_hex(&oid));
4124 printf(_("Created autostash: %s\n"), buf.buf);
4125 if (reset_head(r, NULL, "reset --hard",
4126 NULL, RESET_HEAD_HARD, NULL, NULL,
4127 default_reflog_action) < 0)
4128 die(_("could not reset --hard"));
4130 if (discard_index(r->index) < 0 ||
4131 repo_read_index(r) < 0)
4132 die(_("could not read index"));
4134 strbuf_release(&buf);
4137 static int apply_save_autostash_oid(const char *stash_oid, int attempt_apply)
4139 struct child_process child = CHILD_PROCESS_INIT;
4140 int ret = 0;
4142 if (attempt_apply) {
4143 child.git_cmd = 1;
4144 child.no_stdout = 1;
4145 child.no_stderr = 1;
4146 strvec_push(&child.args, "stash");
4147 strvec_push(&child.args, "apply");
4148 strvec_push(&child.args, stash_oid);
4149 ret = run_command(&child);
4152 if (attempt_apply && !ret)
4153 fprintf(stderr, _("Applied autostash.\n"));
4154 else {
4155 struct child_process store = CHILD_PROCESS_INIT;
4157 store.git_cmd = 1;
4158 strvec_push(&store.args, "stash");
4159 strvec_push(&store.args, "store");
4160 strvec_push(&store.args, "-m");
4161 strvec_push(&store.args, "autostash");
4162 strvec_push(&store.args, "-q");
4163 strvec_push(&store.args, stash_oid);
4164 if (run_command(&store))
4165 ret = error(_("cannot store %s"), stash_oid);
4166 else
4167 fprintf(stderr,
4168 _("%s\n"
4169 "Your changes are safe in the stash.\n"
4170 "You can run \"git stash pop\" or"
4171 " \"git stash drop\" at any time.\n"),
4172 attempt_apply ?
4173 _("Applying autostash resulted in conflicts.") :
4174 _("Autostash exists; creating a new stash entry."));
4177 return ret;
4180 static int apply_save_autostash(const char *path, int attempt_apply)
4182 struct strbuf stash_oid = STRBUF_INIT;
4183 int ret = 0;
4185 if (!read_oneliner(&stash_oid, path,
4186 READ_ONELINER_SKIP_IF_EMPTY)) {
4187 strbuf_release(&stash_oid);
4188 return 0;
4190 strbuf_trim(&stash_oid);
4192 ret = apply_save_autostash_oid(stash_oid.buf, attempt_apply);
4194 unlink(path);
4195 strbuf_release(&stash_oid);
4196 return ret;
4199 int save_autostash(const char *path)
4201 return apply_save_autostash(path, 0);
4204 int apply_autostash(const char *path)
4206 return apply_save_autostash(path, 1);
4209 int apply_autostash_oid(const char *stash_oid)
4211 return apply_save_autostash_oid(stash_oid, 1);
4214 static int run_git_checkout(struct repository *r, struct replay_opts *opts,
4215 const char *commit, const char *action)
4217 struct child_process cmd = CHILD_PROCESS_INIT;
4218 int ret;
4220 cmd.git_cmd = 1;
4222 if (startup_info->original_cwd) {
4223 cmd.dir = startup_info->original_cwd;
4224 strvec_pushf(&cmd.env_array, "%s=%s",
4225 GIT_WORK_TREE_ENVIRONMENT, r->worktree);
4227 strvec_push(&cmd.args, "checkout");
4228 strvec_push(&cmd.args, commit);
4229 strvec_pushf(&cmd.env_array, GIT_REFLOG_ACTION "=%s", action);
4231 if (opts->verbose)
4232 ret = run_command(&cmd);
4233 else
4234 ret = run_command_silent_on_success(&cmd);
4236 if (!ret)
4237 discard_index(r->index);
4239 return ret;
4242 static int checkout_onto(struct repository *r, struct replay_opts *opts,
4243 const char *onto_name, const struct object_id *onto,
4244 const struct object_id *orig_head)
4246 const char *action = reflog_message(opts, "start", "checkout %s", onto_name);
4248 if (run_git_checkout(r, opts, oid_to_hex(onto), action)) {
4249 apply_autostash(rebase_path_autostash());
4250 sequencer_remove_state(opts);
4251 return error(_("could not detach HEAD"));
4254 return update_ref(NULL, "ORIG_HEAD", orig_head, NULL, 0, UPDATE_REFS_MSG_ON_ERR);
4257 static int stopped_at_head(struct repository *r)
4259 struct object_id head;
4260 struct commit *commit;
4261 struct commit_message message;
4263 if (get_oid("HEAD", &head) ||
4264 !(commit = lookup_commit(r, &head)) ||
4265 parse_commit(commit) || get_message(commit, &message))
4266 fprintf(stderr, _("Stopped at HEAD\n"));
4267 else {
4268 fprintf(stderr, _("Stopped at %s\n"), message.label);
4269 free_message(commit, &message);
4271 return 0;
4275 static int reread_todo_if_changed(struct repository *r,
4276 struct todo_list *todo_list,
4277 struct replay_opts *opts)
4279 int offset;
4280 struct strbuf buf = STRBUF_INIT;
4282 if (strbuf_read_file_or_whine(&buf, get_todo_path(opts)) < 0)
4283 return -1;
4284 offset = get_item_line_offset(todo_list, todo_list->current + 1);
4285 if (buf.len != todo_list->buf.len - offset ||
4286 memcmp(buf.buf, todo_list->buf.buf + offset, buf.len)) {
4287 /* Reread the todo file if it has changed. */
4288 todo_list_release(todo_list);
4289 if (read_populate_todo(r, todo_list, opts))
4290 return -1; /* message was printed */
4291 /* `current` will be incremented on return */
4292 todo_list->current = -1;
4294 strbuf_release(&buf);
4296 return 0;
4299 static const char rescheduled_advice[] =
4300 N_("Could not execute the todo command\n"
4301 "\n"
4302 " %.*s"
4303 "\n"
4304 "It has been rescheduled; To edit the command before continuing, please\n"
4305 "edit the todo list first:\n"
4306 "\n"
4307 " git rebase --edit-todo\n"
4308 " git rebase --continue\n");
4310 static int pick_commits(struct repository *r,
4311 struct todo_list *todo_list,
4312 struct replay_opts *opts)
4314 int res = 0, reschedule = 0;
4315 char *prev_reflog_action;
4317 /* Note that 0 for 3rd parameter of setenv means set only if not set */
4318 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
4319 prev_reflog_action = xstrdup(getenv(GIT_REFLOG_ACTION));
4320 if (opts->allow_ff)
4321 assert(!(opts->signoff || opts->no_commit ||
4322 opts->record_origin || should_edit(opts) ||
4323 opts->committer_date_is_author_date ||
4324 opts->ignore_date));
4325 if (read_and_refresh_cache(r, opts))
4326 return -1;
4328 while (todo_list->current < todo_list->nr) {
4329 struct todo_item *item = todo_list->items + todo_list->current;
4330 const char *arg = todo_item_get_arg(todo_list, item);
4331 int check_todo = 0;
4333 if (save_todo(todo_list, opts))
4334 return -1;
4335 if (is_rebase_i(opts)) {
4336 if (item->command != TODO_COMMENT) {
4337 FILE *f = fopen(rebase_path_msgnum(), "w");
4339 todo_list->done_nr++;
4341 if (f) {
4342 fprintf(f, "%d\n", todo_list->done_nr);
4343 fclose(f);
4345 if (!opts->quiet)
4346 fprintf(stderr, _("Rebasing (%d/%d)%s"),
4347 todo_list->done_nr,
4348 todo_list->total_nr,
4349 opts->verbose ? "\n" : "\r");
4351 unlink(rebase_path_message());
4352 unlink(rebase_path_author_script());
4353 unlink(rebase_path_stopped_sha());
4354 unlink(rebase_path_amend());
4355 unlink(git_path_merge_head(r));
4356 unlink(git_path_auto_merge(r));
4357 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
4359 if (item->command == TODO_BREAK) {
4360 if (!opts->verbose)
4361 term_clear_line();
4362 return stopped_at_head(r);
4365 if (item->command <= TODO_SQUASH) {
4366 if (is_rebase_i(opts))
4367 setenv(GIT_REFLOG_ACTION, reflog_message(opts,
4368 command_to_string(item->command), NULL),
4370 res = do_pick_commit(r, item, opts,
4371 is_final_fixup(todo_list),
4372 &check_todo);
4373 if (is_rebase_i(opts))
4374 setenv(GIT_REFLOG_ACTION, prev_reflog_action, 1);
4375 if (is_rebase_i(opts) && res < 0) {
4376 /* Reschedule */
4377 advise(_(rescheduled_advice),
4378 get_item_line_length(todo_list,
4379 todo_list->current),
4380 get_item_line(todo_list,
4381 todo_list->current));
4382 todo_list->current--;
4383 if (save_todo(todo_list, opts))
4384 return -1;
4386 if (item->command == TODO_EDIT) {
4387 struct commit *commit = item->commit;
4388 if (!res) {
4389 if (!opts->verbose)
4390 term_clear_line();
4391 fprintf(stderr,
4392 _("Stopped at %s... %.*s\n"),
4393 short_commit_name(commit),
4394 item->arg_len, arg);
4396 return error_with_patch(r, commit,
4397 arg, item->arg_len, opts, res, !res);
4399 if (is_rebase_i(opts) && !res)
4400 record_in_rewritten(&item->commit->object.oid,
4401 peek_command(todo_list, 1));
4402 if (res && is_fixup(item->command)) {
4403 if (res == 1)
4404 intend_to_amend();
4405 return error_failed_squash(r, item->commit, opts,
4406 item->arg_len, arg);
4407 } else if (res && is_rebase_i(opts) && item->commit) {
4408 int to_amend = 0;
4409 struct object_id oid;
4412 * If we are rewording and have either
4413 * fast-forwarded already, or are about to
4414 * create a new root commit, we want to amend,
4415 * otherwise we do not.
4417 if (item->command == TODO_REWORD &&
4418 !get_oid("HEAD", &oid) &&
4419 (oideq(&item->commit->object.oid, &oid) ||
4420 (opts->have_squash_onto &&
4421 oideq(&opts->squash_onto, &oid))))
4422 to_amend = 1;
4424 return res | error_with_patch(r, item->commit,
4425 arg, item->arg_len, opts,
4426 res, to_amend);
4428 } else if (item->command == TODO_EXEC) {
4429 char *end_of_arg = (char *)(arg + item->arg_len);
4430 int saved = *end_of_arg;
4432 if (!opts->verbose)
4433 term_clear_line();
4434 *end_of_arg = '\0';
4435 res = do_exec(r, arg);
4436 *end_of_arg = saved;
4438 if (res) {
4439 if (opts->reschedule_failed_exec)
4440 reschedule = 1;
4442 check_todo = 1;
4443 } else if (item->command == TODO_LABEL) {
4444 if ((res = do_label(r, arg, item->arg_len)))
4445 reschedule = 1;
4446 } else if (item->command == TODO_RESET) {
4447 if ((res = do_reset(r, arg, item->arg_len, opts)))
4448 reschedule = 1;
4449 } else if (item->command == TODO_MERGE) {
4450 if ((res = do_merge(r, item->commit, arg, item->arg_len,
4451 item->flags, &check_todo, opts)) < 0)
4452 reschedule = 1;
4453 else if (item->commit)
4454 record_in_rewritten(&item->commit->object.oid,
4455 peek_command(todo_list, 1));
4456 if (res > 0)
4457 /* failed with merge conflicts */
4458 return error_with_patch(r, item->commit,
4459 arg, item->arg_len,
4460 opts, res, 0);
4461 } else if (!is_noop(item->command))
4462 return error(_("unknown command %d"), item->command);
4464 if (reschedule) {
4465 advise(_(rescheduled_advice),
4466 get_item_line_length(todo_list,
4467 todo_list->current),
4468 get_item_line(todo_list, todo_list->current));
4469 todo_list->current--;
4470 if (save_todo(todo_list, opts))
4471 return -1;
4472 if (item->commit)
4473 return error_with_patch(r,
4474 item->commit,
4475 arg, item->arg_len,
4476 opts, res, 0);
4477 } else if (is_rebase_i(opts) && check_todo && !res &&
4478 reread_todo_if_changed(r, todo_list, opts)) {
4479 return -1;
4482 todo_list->current++;
4483 if (res)
4484 return res;
4487 if (is_rebase_i(opts)) {
4488 struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
4489 struct stat st;
4491 /* Stopped in the middle, as planned? */
4492 if (todo_list->current < todo_list->nr)
4493 return 0;
4495 if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
4496 starts_with(head_ref.buf, "refs/")) {
4497 const char *msg;
4498 struct object_id head, orig;
4499 int res;
4501 if (get_oid("HEAD", &head)) {
4502 res = error(_("cannot read HEAD"));
4503 cleanup_head_ref:
4504 strbuf_release(&head_ref);
4505 strbuf_release(&buf);
4506 return res;
4508 if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
4509 get_oid_hex(buf.buf, &orig)) {
4510 res = error(_("could not read orig-head"));
4511 goto cleanup_head_ref;
4513 strbuf_reset(&buf);
4514 if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
4515 res = error(_("could not read 'onto'"));
4516 goto cleanup_head_ref;
4518 msg = reflog_message(opts, "finish", "%s onto %s",
4519 head_ref.buf, buf.buf);
4520 if (update_ref(msg, head_ref.buf, &head, &orig,
4521 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR)) {
4522 res = error(_("could not update %s"),
4523 head_ref.buf);
4524 goto cleanup_head_ref;
4526 msg = reflog_message(opts, "finish", "returning to %s",
4527 head_ref.buf);
4528 if (create_symref("HEAD", head_ref.buf, msg)) {
4529 res = error(_("could not update HEAD to %s"),
4530 head_ref.buf);
4531 goto cleanup_head_ref;
4533 strbuf_reset(&buf);
4536 if (opts->verbose) {
4537 struct rev_info log_tree_opt;
4538 struct object_id orig, head;
4540 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
4541 repo_init_revisions(r, &log_tree_opt, NULL);
4542 log_tree_opt.diff = 1;
4543 log_tree_opt.diffopt.output_format =
4544 DIFF_FORMAT_DIFFSTAT;
4545 log_tree_opt.disable_stdin = 1;
4547 if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
4548 !get_oid(buf.buf, &orig) &&
4549 !get_oid("HEAD", &head)) {
4550 diff_tree_oid(&orig, &head, "",
4551 &log_tree_opt.diffopt);
4552 log_tree_diff_flush(&log_tree_opt);
4555 flush_rewritten_pending();
4556 if (!stat(rebase_path_rewritten_list(), &st) &&
4557 st.st_size > 0) {
4558 struct child_process child = CHILD_PROCESS_INIT;
4559 const char *post_rewrite_hook =
4560 find_hook("post-rewrite");
4562 child.in = open(rebase_path_rewritten_list(), O_RDONLY);
4563 child.git_cmd = 1;
4564 strvec_push(&child.args, "notes");
4565 strvec_push(&child.args, "copy");
4566 strvec_push(&child.args, "--for-rewrite=rebase");
4567 /* we don't care if this copying failed */
4568 run_command(&child);
4570 if (post_rewrite_hook) {
4571 struct child_process hook = CHILD_PROCESS_INIT;
4573 hook.in = open(rebase_path_rewritten_list(),
4574 O_RDONLY);
4575 hook.stdout_to_stderr = 1;
4576 hook.trace2_hook_name = "post-rewrite";
4577 strvec_push(&hook.args, post_rewrite_hook);
4578 strvec_push(&hook.args, "rebase");
4579 /* we don't care if this hook failed */
4580 run_command(&hook);
4583 apply_autostash(rebase_path_autostash());
4585 if (!opts->quiet) {
4586 if (!opts->verbose)
4587 term_clear_line();
4588 fprintf(stderr,
4589 _("Successfully rebased and updated %s.\n"),
4590 head_ref.buf);
4593 strbuf_release(&buf);
4594 strbuf_release(&head_ref);
4598 * Sequence of picks finished successfully; cleanup by
4599 * removing the .git/sequencer directory
4601 return sequencer_remove_state(opts);
4604 static int continue_single_pick(struct repository *r, struct replay_opts *opts)
4606 struct strvec argv = STRVEC_INIT;
4607 int ret;
4609 if (!refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD") &&
4610 !refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD"))
4611 return error(_("no cherry-pick or revert in progress"));
4613 strvec_push(&argv, "commit");
4616 * continue_single_pick() handles the case of recovering from a
4617 * conflict. should_edit() doesn't handle that case; for a conflict,
4618 * we want to edit if the user asked for it, or if they didn't specify
4619 * and stdin is a tty.
4621 if (!opts->edit || (opts->edit < 0 && !isatty(0)))
4623 * Include --cleanup=strip as well because we don't want the
4624 * "# Conflicts:" messages.
4626 strvec_pushl(&argv, "--no-edit", "--cleanup=strip", NULL);
4628 ret = run_command_v_opt(argv.v, RUN_GIT_CMD);
4629 strvec_clear(&argv);
4630 return ret;
4633 static int commit_staged_changes(struct repository *r,
4634 struct replay_opts *opts,
4635 struct todo_list *todo_list)
4637 unsigned int flags = ALLOW_EMPTY | EDIT_MSG;
4638 unsigned int final_fixup = 0, is_clean;
4640 if (has_unstaged_changes(r, 1))
4641 return error(_("cannot rebase: You have unstaged changes."));
4643 is_clean = !has_uncommitted_changes(r, 0);
4645 if (file_exists(rebase_path_amend())) {
4646 struct strbuf rev = STRBUF_INIT;
4647 struct object_id head, to_amend;
4649 if (get_oid("HEAD", &head))
4650 return error(_("cannot amend non-existing commit"));
4651 if (!read_oneliner(&rev, rebase_path_amend(), 0))
4652 return error(_("invalid file: '%s'"), rebase_path_amend());
4653 if (get_oid_hex(rev.buf, &to_amend))
4654 return error(_("invalid contents: '%s'"),
4655 rebase_path_amend());
4656 if (!is_clean && !oideq(&head, &to_amend))
4657 return error(_("\nYou have uncommitted changes in your "
4658 "working tree. Please, commit them\n"
4659 "first and then run 'git rebase "
4660 "--continue' again."));
4662 * When skipping a failed fixup/squash, we need to edit the
4663 * commit message, the current fixup list and count, and if it
4664 * was the last fixup/squash in the chain, we need to clean up
4665 * the commit message and if there was a squash, let the user
4666 * edit it.
4668 if (!is_clean || !opts->current_fixup_count)
4669 ; /* this is not the final fixup */
4670 else if (!oideq(&head, &to_amend) ||
4671 !file_exists(rebase_path_stopped_sha())) {
4672 /* was a final fixup or squash done manually? */
4673 if (!is_fixup(peek_command(todo_list, 0))) {
4674 unlink(rebase_path_fixup_msg());
4675 unlink(rebase_path_squash_msg());
4676 unlink(rebase_path_current_fixups());
4677 strbuf_reset(&opts->current_fixups);
4678 opts->current_fixup_count = 0;
4680 } else {
4681 /* we are in a fixup/squash chain */
4682 const char *p = opts->current_fixups.buf;
4683 int len = opts->current_fixups.len;
4685 opts->current_fixup_count--;
4686 if (!len)
4687 BUG("Incorrect current_fixups:\n%s", p);
4688 while (len && p[len - 1] != '\n')
4689 len--;
4690 strbuf_setlen(&opts->current_fixups, len);
4691 if (write_message(p, len, rebase_path_current_fixups(),
4692 0) < 0)
4693 return error(_("could not write file: '%s'"),
4694 rebase_path_current_fixups());
4697 * If a fixup/squash in a fixup/squash chain failed, the
4698 * commit message is already correct, no need to commit
4699 * it again.
4701 * Only if it is the final command in the fixup/squash
4702 * chain, and only if the chain is longer than a single
4703 * fixup/squash command (which was just skipped), do we
4704 * actually need to re-commit with a cleaned up commit
4705 * message.
4707 if (opts->current_fixup_count > 0 &&
4708 !is_fixup(peek_command(todo_list, 0))) {
4709 final_fixup = 1;
4711 * If there was not a single "squash" in the
4712 * chain, we only need to clean up the commit
4713 * message, no need to bother the user with
4714 * opening the commit message in the editor.
4716 if (!starts_with(p, "squash ") &&
4717 !strstr(p, "\nsquash "))
4718 flags = (flags & ~EDIT_MSG) | CLEANUP_MSG;
4719 } else if (is_fixup(peek_command(todo_list, 0))) {
4721 * We need to update the squash message to skip
4722 * the latest commit message.
4724 struct commit *commit;
4725 const char *path = rebase_path_squash_msg();
4726 const char *encoding = get_commit_output_encoding();
4728 if (parse_head(r, &commit) ||
4729 !(p = logmsg_reencode(commit, NULL, encoding)) ||
4730 write_message(p, strlen(p), path, 0)) {
4731 unuse_commit_buffer(commit, p);
4732 return error(_("could not write file: "
4733 "'%s'"), path);
4735 unuse_commit_buffer(commit, p);
4739 strbuf_release(&rev);
4740 flags |= AMEND_MSG;
4743 if (is_clean) {
4744 if (refs_ref_exists(get_main_ref_store(r),
4745 "CHERRY_PICK_HEAD") &&
4746 refs_delete_ref(get_main_ref_store(r), "",
4747 "CHERRY_PICK_HEAD", NULL, 0))
4748 return error(_("could not remove CHERRY_PICK_HEAD"));
4749 if (unlink(git_path_merge_msg(r)) && errno != ENOENT)
4750 return error_errno(_("could not remove '%s'"),
4751 git_path_merge_msg(r));
4752 if (!final_fixup)
4753 return 0;
4756 if (run_git_commit(final_fixup ? NULL : rebase_path_message(),
4757 opts, flags))
4758 return error(_("could not commit staged changes."));
4759 unlink(rebase_path_amend());
4760 unlink(git_path_merge_head(r));
4761 unlink(git_path_auto_merge(r));
4762 if (final_fixup) {
4763 unlink(rebase_path_fixup_msg());
4764 unlink(rebase_path_squash_msg());
4766 if (opts->current_fixup_count > 0) {
4768 * Whether final fixup or not, we just cleaned up the commit
4769 * message...
4771 unlink(rebase_path_current_fixups());
4772 strbuf_reset(&opts->current_fixups);
4773 opts->current_fixup_count = 0;
4775 return 0;
4778 int sequencer_continue(struct repository *r, struct replay_opts *opts)
4780 struct todo_list todo_list = TODO_LIST_INIT;
4781 int res;
4783 if (read_and_refresh_cache(r, opts))
4784 return -1;
4786 if (read_populate_opts(opts))
4787 return -1;
4788 if (is_rebase_i(opts)) {
4789 if ((res = read_populate_todo(r, &todo_list, opts)))
4790 goto release_todo_list;
4792 if (file_exists(rebase_path_dropped())) {
4793 if ((res = todo_list_check_against_backup(r, &todo_list)))
4794 goto release_todo_list;
4796 unlink(rebase_path_dropped());
4799 if (commit_staged_changes(r, opts, &todo_list)) {
4800 res = -1;
4801 goto release_todo_list;
4803 } else if (!file_exists(get_todo_path(opts)))
4804 return continue_single_pick(r, opts);
4805 else if ((res = read_populate_todo(r, &todo_list, opts)))
4806 goto release_todo_list;
4808 if (!is_rebase_i(opts)) {
4809 /* Verify that the conflict has been resolved */
4810 if (refs_ref_exists(get_main_ref_store(r),
4811 "CHERRY_PICK_HEAD") ||
4812 refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD")) {
4813 res = continue_single_pick(r, opts);
4814 if (res)
4815 goto release_todo_list;
4817 if (index_differs_from(r, "HEAD", NULL, 0)) {
4818 res = error_dirty_index(r, opts);
4819 goto release_todo_list;
4821 todo_list.current++;
4822 } else if (file_exists(rebase_path_stopped_sha())) {
4823 struct strbuf buf = STRBUF_INIT;
4824 struct object_id oid;
4826 if (read_oneliner(&buf, rebase_path_stopped_sha(),
4827 READ_ONELINER_SKIP_IF_EMPTY) &&
4828 !get_oid_hex(buf.buf, &oid))
4829 record_in_rewritten(&oid, peek_command(&todo_list, 0));
4830 strbuf_release(&buf);
4833 res = pick_commits(r, &todo_list, opts);
4834 release_todo_list:
4835 todo_list_release(&todo_list);
4836 return res;
4839 static int single_pick(struct repository *r,
4840 struct commit *cmit,
4841 struct replay_opts *opts)
4843 int check_todo;
4844 struct todo_item item;
4846 item.command = opts->action == REPLAY_PICK ?
4847 TODO_PICK : TODO_REVERT;
4848 item.commit = cmit;
4850 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
4851 return do_pick_commit(r, &item, opts, 0, &check_todo);
4854 int sequencer_pick_revisions(struct repository *r,
4855 struct replay_opts *opts)
4857 struct todo_list todo_list = TODO_LIST_INIT;
4858 struct object_id oid;
4859 int i, res;
4861 assert(opts->revs);
4862 if (read_and_refresh_cache(r, opts))
4863 return -1;
4865 for (i = 0; i < opts->revs->pending.nr; i++) {
4866 struct object_id oid;
4867 const char *name = opts->revs->pending.objects[i].name;
4869 /* This happens when using --stdin. */
4870 if (!strlen(name))
4871 continue;
4873 if (!get_oid(name, &oid)) {
4874 if (!lookup_commit_reference_gently(r, &oid, 1)) {
4875 enum object_type type = oid_object_info(r,
4876 &oid,
4877 NULL);
4878 return error(_("%s: can't cherry-pick a %s"),
4879 name, type_name(type));
4881 } else
4882 return error(_("%s: bad revision"), name);
4886 * If we were called as "git cherry-pick <commit>", just
4887 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
4888 * REVERT_HEAD, and don't touch the sequencer state.
4889 * This means it is possible to cherry-pick in the middle
4890 * of a cherry-pick sequence.
4892 if (opts->revs->cmdline.nr == 1 &&
4893 opts->revs->cmdline.rev->whence == REV_CMD_REV &&
4894 opts->revs->no_walk &&
4895 !opts->revs->cmdline.rev->flags) {
4896 struct commit *cmit;
4897 if (prepare_revision_walk(opts->revs))
4898 return error(_("revision walk setup failed"));
4899 cmit = get_revision(opts->revs);
4900 if (!cmit)
4901 return error(_("empty commit set passed"));
4902 if (get_revision(opts->revs))
4903 BUG("unexpected extra commit from walk");
4904 return single_pick(r, cmit, opts);
4908 * Start a new cherry-pick/ revert sequence; but
4909 * first, make sure that an existing one isn't in
4910 * progress
4913 if (walk_revs_populate_todo(&todo_list, opts) ||
4914 create_seq_dir(r) < 0)
4915 return -1;
4916 if (get_oid("HEAD", &oid) && (opts->action == REPLAY_REVERT))
4917 return error(_("can't revert as initial commit"));
4918 if (save_head(oid_to_hex(&oid)))
4919 return -1;
4920 if (save_opts(opts))
4921 return -1;
4922 update_abort_safety_file();
4923 res = pick_commits(r, &todo_list, opts);
4924 todo_list_release(&todo_list);
4925 return res;
4928 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag)
4930 unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
4931 struct strbuf sob = STRBUF_INIT;
4932 int has_footer;
4934 strbuf_addstr(&sob, sign_off_header);
4935 strbuf_addstr(&sob, fmt_name(WANT_COMMITTER_IDENT));
4936 strbuf_addch(&sob, '\n');
4938 if (!ignore_footer)
4939 strbuf_complete_line(msgbuf);
4942 * If the whole message buffer is equal to the sob, pretend that we
4943 * found a conforming footer with a matching sob
4945 if (msgbuf->len - ignore_footer == sob.len &&
4946 !strncmp(msgbuf->buf, sob.buf, sob.len))
4947 has_footer = 3;
4948 else
4949 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
4951 if (!has_footer) {
4952 const char *append_newlines = NULL;
4953 size_t len = msgbuf->len - ignore_footer;
4955 if (!len) {
4957 * The buffer is completely empty. Leave foom for
4958 * the title and body to be filled in by the user.
4960 append_newlines = "\n\n";
4961 } else if (len == 1) {
4963 * Buffer contains a single newline. Add another
4964 * so that we leave room for the title and body.
4966 append_newlines = "\n";
4967 } else if (msgbuf->buf[len - 2] != '\n') {
4969 * Buffer ends with a single newline. Add another
4970 * so that there is an empty line between the message
4971 * body and the sob.
4973 append_newlines = "\n";
4974 } /* else, the buffer already ends with two newlines. */
4976 if (append_newlines)
4977 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
4978 append_newlines, strlen(append_newlines));
4981 if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
4982 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
4983 sob.buf, sob.len);
4985 strbuf_release(&sob);
4988 struct labels_entry {
4989 struct hashmap_entry entry;
4990 char label[FLEX_ARRAY];
4993 static int labels_cmp(const void *fndata, const struct hashmap_entry *eptr,
4994 const struct hashmap_entry *entry_or_key, const void *key)
4996 const struct labels_entry *a, *b;
4998 a = container_of(eptr, const struct labels_entry, entry);
4999 b = container_of(entry_or_key, const struct labels_entry, entry);
5001 return key ? strcmp(a->label, key) : strcmp(a->label, b->label);
5004 struct string_entry {
5005 struct oidmap_entry entry;
5006 char string[FLEX_ARRAY];
5009 struct label_state {
5010 struct oidmap commit2label;
5011 struct hashmap labels;
5012 struct strbuf buf;
5015 static const char *label_oid(struct object_id *oid, const char *label,
5016 struct label_state *state)
5018 struct labels_entry *labels_entry;
5019 struct string_entry *string_entry;
5020 struct object_id dummy;
5021 int i;
5023 string_entry = oidmap_get(&state->commit2label, oid);
5024 if (string_entry)
5025 return string_entry->string;
5028 * For "uninteresting" commits, i.e. commits that are not to be
5029 * rebased, and which can therefore not be labeled, we use a unique
5030 * abbreviation of the commit name. This is slightly more complicated
5031 * than calling find_unique_abbrev() because we also need to make
5032 * sure that the abbreviation does not conflict with any other
5033 * label.
5035 * We disallow "interesting" commits to be labeled by a string that
5036 * is a valid full-length hash, to ensure that we always can find an
5037 * abbreviation for any uninteresting commit's names that does not
5038 * clash with any other label.
5040 strbuf_reset(&state->buf);
5041 if (!label) {
5042 char *p;
5044 strbuf_grow(&state->buf, GIT_MAX_HEXSZ);
5045 label = p = state->buf.buf;
5047 find_unique_abbrev_r(p, oid, default_abbrev);
5050 * We may need to extend the abbreviated hash so that there is
5051 * no conflicting label.
5053 if (hashmap_get_from_hash(&state->labels, strihash(p), p)) {
5054 size_t i = strlen(p) + 1;
5056 oid_to_hex_r(p, oid);
5057 for (; i < the_hash_algo->hexsz; i++) {
5058 char save = p[i];
5059 p[i] = '\0';
5060 if (!hashmap_get_from_hash(&state->labels,
5061 strihash(p), p))
5062 break;
5063 p[i] = save;
5066 } else {
5067 struct strbuf *buf = &state->buf;
5070 * Sanitize labels by replacing non-alpha-numeric characters
5071 * (including white-space ones) by dashes, as they might be
5072 * illegal in file names (and hence in ref names).
5074 * Note that we retain non-ASCII UTF-8 characters (identified
5075 * via the most significant bit). They should be all acceptable
5076 * in file names. We do not validate the UTF-8 here, that's not
5077 * the job of this function.
5079 for (; *label; label++)
5080 if ((*label & 0x80) || isalnum(*label))
5081 strbuf_addch(buf, *label);
5082 /* avoid leading dash and double-dashes */
5083 else if (buf->len && buf->buf[buf->len - 1] != '-')
5084 strbuf_addch(buf, '-');
5085 if (!buf->len) {
5086 strbuf_addstr(buf, "rev-");
5087 strbuf_add_unique_abbrev(buf, oid, default_abbrev);
5089 label = buf->buf;
5091 if ((buf->len == the_hash_algo->hexsz &&
5092 !get_oid_hex(label, &dummy)) ||
5093 (buf->len == 1 && *label == '#') ||
5094 hashmap_get_from_hash(&state->labels,
5095 strihash(label), label)) {
5097 * If the label already exists, or if the label is a
5098 * valid full OID, or the label is a '#' (which we use
5099 * as a separator between merge heads and oneline), we
5100 * append a dash and a number to make it unique.
5102 size_t len = buf->len;
5104 for (i = 2; ; i++) {
5105 strbuf_setlen(buf, len);
5106 strbuf_addf(buf, "-%d", i);
5107 if (!hashmap_get_from_hash(&state->labels,
5108 strihash(buf->buf),
5109 buf->buf))
5110 break;
5113 label = buf->buf;
5117 FLEX_ALLOC_STR(labels_entry, label, label);
5118 hashmap_entry_init(&labels_entry->entry, strihash(label));
5119 hashmap_add(&state->labels, &labels_entry->entry);
5121 FLEX_ALLOC_STR(string_entry, string, label);
5122 oidcpy(&string_entry->entry.oid, oid);
5123 oidmap_put(&state->commit2label, string_entry);
5125 return string_entry->string;
5128 static int make_script_with_merges(struct pretty_print_context *pp,
5129 struct rev_info *revs, struct strbuf *out,
5130 unsigned flags)
5132 int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
5133 int rebase_cousins = flags & TODO_LIST_REBASE_COUSINS;
5134 int root_with_onto = flags & TODO_LIST_ROOT_WITH_ONTO;
5135 int skipped_commit = 0;
5136 struct strbuf buf = STRBUF_INIT, oneline = STRBUF_INIT;
5137 struct strbuf label = STRBUF_INIT;
5138 struct commit_list *commits = NULL, **tail = &commits, *iter;
5139 struct commit_list *tips = NULL, **tips_tail = &tips;
5140 struct commit *commit;
5141 struct oidmap commit2todo = OIDMAP_INIT;
5142 struct string_entry *entry;
5143 struct oidset interesting = OIDSET_INIT, child_seen = OIDSET_INIT,
5144 shown = OIDSET_INIT;
5145 struct label_state state = { OIDMAP_INIT, { NULL }, STRBUF_INIT };
5147 int abbr = flags & TODO_LIST_ABBREVIATE_CMDS;
5148 const char *cmd_pick = abbr ? "p" : "pick",
5149 *cmd_label = abbr ? "l" : "label",
5150 *cmd_reset = abbr ? "t" : "reset",
5151 *cmd_merge = abbr ? "m" : "merge";
5153 oidmap_init(&commit2todo, 0);
5154 oidmap_init(&state.commit2label, 0);
5155 hashmap_init(&state.labels, labels_cmp, NULL, 0);
5156 strbuf_init(&state.buf, 32);
5158 if (revs->cmdline.nr && (revs->cmdline.rev[0].flags & BOTTOM)) {
5159 struct labels_entry *onto_label_entry;
5160 struct object_id *oid = &revs->cmdline.rev[0].item->oid;
5161 FLEX_ALLOC_STR(entry, string, "onto");
5162 oidcpy(&entry->entry.oid, oid);
5163 oidmap_put(&state.commit2label, entry);
5165 FLEX_ALLOC_STR(onto_label_entry, label, "onto");
5166 hashmap_entry_init(&onto_label_entry->entry, strihash("onto"));
5167 hashmap_add(&state.labels, &onto_label_entry->entry);
5171 * First phase:
5172 * - get onelines for all commits
5173 * - gather all branch tips (i.e. 2nd or later parents of merges)
5174 * - label all branch tips
5176 while ((commit = get_revision(revs))) {
5177 struct commit_list *to_merge;
5178 const char *p1, *p2;
5179 struct object_id *oid;
5180 int is_empty;
5182 tail = &commit_list_insert(commit, tail)->next;
5183 oidset_insert(&interesting, &commit->object.oid);
5185 is_empty = is_original_commit_empty(commit);
5186 if (!is_empty && (commit->object.flags & PATCHSAME)) {
5187 if (flags & TODO_LIST_WARN_SKIPPED_CHERRY_PICKS)
5188 warning(_("skipped previously applied commit %s"),
5189 short_commit_name(commit));
5190 skipped_commit = 1;
5191 continue;
5193 if (is_empty && !keep_empty)
5194 continue;
5196 strbuf_reset(&oneline);
5197 pretty_print_commit(pp, commit, &oneline);
5199 to_merge = commit->parents ? commit->parents->next : NULL;
5200 if (!to_merge) {
5201 /* non-merge commit: easy case */
5202 strbuf_reset(&buf);
5203 strbuf_addf(&buf, "%s %s %s", cmd_pick,
5204 oid_to_hex(&commit->object.oid),
5205 oneline.buf);
5206 if (is_empty)
5207 strbuf_addf(&buf, " %c empty",
5208 comment_line_char);
5210 FLEX_ALLOC_STR(entry, string, buf.buf);
5211 oidcpy(&entry->entry.oid, &commit->object.oid);
5212 oidmap_put(&commit2todo, entry);
5214 continue;
5217 /* Create a label */
5218 strbuf_reset(&label);
5219 if (skip_prefix(oneline.buf, "Merge ", &p1) &&
5220 (p1 = strchr(p1, '\'')) &&
5221 (p2 = strchr(++p1, '\'')))
5222 strbuf_add(&label, p1, p2 - p1);
5223 else if (skip_prefix(oneline.buf, "Merge pull request ",
5224 &p1) &&
5225 (p1 = strstr(p1, " from ")))
5226 strbuf_addstr(&label, p1 + strlen(" from "));
5227 else
5228 strbuf_addbuf(&label, &oneline);
5230 strbuf_reset(&buf);
5231 strbuf_addf(&buf, "%s -C %s",
5232 cmd_merge, oid_to_hex(&commit->object.oid));
5234 /* label the tips of merged branches */
5235 for (; to_merge; to_merge = to_merge->next) {
5236 oid = &to_merge->item->object.oid;
5237 strbuf_addch(&buf, ' ');
5239 if (!oidset_contains(&interesting, oid)) {
5240 strbuf_addstr(&buf, label_oid(oid, NULL,
5241 &state));
5242 continue;
5245 tips_tail = &commit_list_insert(to_merge->item,
5246 tips_tail)->next;
5248 strbuf_addstr(&buf, label_oid(oid, label.buf, &state));
5250 strbuf_addf(&buf, " # %s", oneline.buf);
5252 FLEX_ALLOC_STR(entry, string, buf.buf);
5253 oidcpy(&entry->entry.oid, &commit->object.oid);
5254 oidmap_put(&commit2todo, entry);
5256 if (skipped_commit)
5257 advise_if_enabled(ADVICE_SKIPPED_CHERRY_PICKS,
5258 _("use --reapply-cherry-picks to include skipped commits"));
5261 * Second phase:
5262 * - label branch points
5263 * - add HEAD to the branch tips
5265 for (iter = commits; iter; iter = iter->next) {
5266 struct commit_list *parent = iter->item->parents;
5267 for (; parent; parent = parent->next) {
5268 struct object_id *oid = &parent->item->object.oid;
5269 if (!oidset_contains(&interesting, oid))
5270 continue;
5271 if (oidset_insert(&child_seen, oid))
5272 label_oid(oid, "branch-point", &state);
5275 /* Add HEAD as implicit "tip of branch" */
5276 if (!iter->next)
5277 tips_tail = &commit_list_insert(iter->item,
5278 tips_tail)->next;
5282 * Third phase: output the todo list. This is a bit tricky, as we
5283 * want to avoid jumping back and forth between revisions. To
5284 * accomplish that goal, we walk backwards from the branch tips,
5285 * gathering commits not yet shown, reversing the list on the fly,
5286 * then outputting that list (labeling revisions as needed).
5288 strbuf_addf(out, "%s onto\n", cmd_label);
5289 for (iter = tips; iter; iter = iter->next) {
5290 struct commit_list *list = NULL, *iter2;
5292 commit = iter->item;
5293 if (oidset_contains(&shown, &commit->object.oid))
5294 continue;
5295 entry = oidmap_get(&state.commit2label, &commit->object.oid);
5297 if (entry)
5298 strbuf_addf(out, "\n%c Branch %s\n", comment_line_char, entry->string);
5299 else
5300 strbuf_addch(out, '\n');
5302 while (oidset_contains(&interesting, &commit->object.oid) &&
5303 !oidset_contains(&shown, &commit->object.oid)) {
5304 commit_list_insert(commit, &list);
5305 if (!commit->parents) {
5306 commit = NULL;
5307 break;
5309 commit = commit->parents->item;
5312 if (!commit)
5313 strbuf_addf(out, "%s %s\n", cmd_reset,
5314 rebase_cousins || root_with_onto ?
5315 "onto" : "[new root]");
5316 else {
5317 const char *to = NULL;
5319 entry = oidmap_get(&state.commit2label,
5320 &commit->object.oid);
5321 if (entry)
5322 to = entry->string;
5323 else if (!rebase_cousins)
5324 to = label_oid(&commit->object.oid, NULL,
5325 &state);
5327 if (!to || !strcmp(to, "onto"))
5328 strbuf_addf(out, "%s onto\n", cmd_reset);
5329 else {
5330 strbuf_reset(&oneline);
5331 pretty_print_commit(pp, commit, &oneline);
5332 strbuf_addf(out, "%s %s # %s\n",
5333 cmd_reset, to, oneline.buf);
5337 for (iter2 = list; iter2; iter2 = iter2->next) {
5338 struct object_id *oid = &iter2->item->object.oid;
5339 entry = oidmap_get(&commit2todo, oid);
5340 /* only show if not already upstream */
5341 if (entry)
5342 strbuf_addf(out, "%s\n", entry->string);
5343 entry = oidmap_get(&state.commit2label, oid);
5344 if (entry)
5345 strbuf_addf(out, "%s %s\n",
5346 cmd_label, entry->string);
5347 oidset_insert(&shown, oid);
5350 free_commit_list(list);
5353 free_commit_list(commits);
5354 free_commit_list(tips);
5356 strbuf_release(&label);
5357 strbuf_release(&oneline);
5358 strbuf_release(&buf);
5360 oidmap_free(&commit2todo, 1);
5361 oidmap_free(&state.commit2label, 1);
5362 hashmap_clear_and_free(&state.labels, struct labels_entry, entry);
5363 strbuf_release(&state.buf);
5365 return 0;
5368 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
5369 const char **argv, unsigned flags)
5371 char *format = NULL;
5372 struct pretty_print_context pp = {0};
5373 struct rev_info revs;
5374 struct commit *commit;
5375 int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
5376 const char *insn = flags & TODO_LIST_ABBREVIATE_CMDS ? "p" : "pick";
5377 int rebase_merges = flags & TODO_LIST_REBASE_MERGES;
5378 int reapply_cherry_picks = flags & TODO_LIST_REAPPLY_CHERRY_PICKS;
5379 int skipped_commit = 0;
5381 repo_init_revisions(r, &revs, NULL);
5382 revs.verbose_header = 1;
5383 if (!rebase_merges)
5384 revs.max_parents = 1;
5385 revs.cherry_mark = !reapply_cherry_picks;
5386 revs.limited = 1;
5387 revs.reverse = 1;
5388 revs.right_only = 1;
5389 revs.sort_order = REV_SORT_IN_GRAPH_ORDER;
5390 revs.topo_order = 1;
5392 revs.pretty_given = 1;
5393 git_config_get_string("rebase.instructionFormat", &format);
5394 if (!format || !*format) {
5395 free(format);
5396 format = xstrdup("%s");
5398 get_commit_format(format, &revs);
5399 free(format);
5400 pp.fmt = revs.commit_format;
5401 pp.output_encoding = get_log_output_encoding();
5403 if (setup_revisions(argc, argv, &revs, NULL) > 1)
5404 return error(_("make_script: unhandled options"));
5406 if (prepare_revision_walk(&revs) < 0)
5407 return error(_("make_script: error preparing revisions"));
5409 if (rebase_merges)
5410 return make_script_with_merges(&pp, &revs, out, flags);
5412 while ((commit = get_revision(&revs))) {
5413 int is_empty = is_original_commit_empty(commit);
5415 if (!is_empty && (commit->object.flags & PATCHSAME)) {
5416 if (flags & TODO_LIST_WARN_SKIPPED_CHERRY_PICKS)
5417 warning(_("skipped previously applied commit %s"),
5418 short_commit_name(commit));
5419 skipped_commit = 1;
5420 continue;
5422 if (is_empty && !keep_empty)
5423 continue;
5424 strbuf_addf(out, "%s %s ", insn,
5425 oid_to_hex(&commit->object.oid));
5426 pretty_print_commit(&pp, commit, out);
5427 if (is_empty)
5428 strbuf_addf(out, " %c empty", comment_line_char);
5429 strbuf_addch(out, '\n');
5431 if (skipped_commit)
5432 advise_if_enabled(ADVICE_SKIPPED_CHERRY_PICKS,
5433 _("use --reapply-cherry-picks to include skipped commits"));
5434 return 0;
5438 * Add commands after pick and (series of) squash/fixup commands
5439 * in the todo list.
5441 static void todo_list_add_exec_commands(struct todo_list *todo_list,
5442 struct string_list *commands)
5444 struct strbuf *buf = &todo_list->buf;
5445 size_t base_offset = buf->len;
5446 int i, insert, nr = 0, alloc = 0;
5447 struct todo_item *items = NULL, *base_items = NULL;
5449 CALLOC_ARRAY(base_items, commands->nr);
5450 for (i = 0; i < commands->nr; i++) {
5451 size_t command_len = strlen(commands->items[i].string);
5453 strbuf_addstr(buf, commands->items[i].string);
5454 strbuf_addch(buf, '\n');
5456 base_items[i].command = TODO_EXEC;
5457 base_items[i].offset_in_buf = base_offset;
5458 base_items[i].arg_offset = base_offset + strlen("exec ");
5459 base_items[i].arg_len = command_len - strlen("exec ");
5461 base_offset += command_len + 1;
5465 * Insert <commands> after every pick. Here, fixup/squash chains
5466 * are considered part of the pick, so we insert the commands *after*
5467 * those chains if there are any.
5469 * As we insert the exec commands immediately after rearranging
5470 * any fixups and before the user edits the list, a fixup chain
5471 * can never contain comments (any comments are empty picks that
5472 * have been commented out because the user did not specify
5473 * --keep-empty). So, it is safe to insert an exec command
5474 * without looking at the command following a comment.
5476 insert = 0;
5477 for (i = 0; i < todo_list->nr; i++) {
5478 enum todo_command command = todo_list->items[i].command;
5479 if (insert && !is_fixup(command)) {
5480 ALLOC_GROW(items, nr + commands->nr, alloc);
5481 COPY_ARRAY(items + nr, base_items, commands->nr);
5482 nr += commands->nr;
5484 insert = 0;
5487 ALLOC_GROW(items, nr + 1, alloc);
5488 items[nr++] = todo_list->items[i];
5490 if (command == TODO_PICK || command == TODO_MERGE)
5491 insert = 1;
5494 /* insert or append final <commands> */
5495 if (insert) {
5496 ALLOC_GROW(items, nr + commands->nr, alloc);
5497 COPY_ARRAY(items + nr, base_items, commands->nr);
5498 nr += commands->nr;
5501 free(base_items);
5502 FREE_AND_NULL(todo_list->items);
5503 todo_list->items = items;
5504 todo_list->nr = nr;
5505 todo_list->alloc = alloc;
5508 static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
5509 struct strbuf *buf, int num, unsigned flags)
5511 struct todo_item *item;
5512 int i, max = todo_list->nr;
5514 if (num > 0 && num < max)
5515 max = num;
5517 for (item = todo_list->items, i = 0; i < max; i++, item++) {
5518 char cmd;
5520 /* if the item is not a command write it and continue */
5521 if (item->command >= TODO_COMMENT) {
5522 strbuf_addf(buf, "%.*s\n", item->arg_len,
5523 todo_item_get_arg(todo_list, item));
5524 continue;
5527 /* add command to the buffer */
5528 cmd = command_to_char(item->command);
5529 if ((flags & TODO_LIST_ABBREVIATE_CMDS) && cmd)
5530 strbuf_addch(buf, cmd);
5531 else
5532 strbuf_addstr(buf, command_to_string(item->command));
5534 /* add commit id */
5535 if (item->commit) {
5536 const char *oid = flags & TODO_LIST_SHORTEN_IDS ?
5537 short_commit_name(item->commit) :
5538 oid_to_hex(&item->commit->object.oid);
5540 if (item->command == TODO_FIXUP) {
5541 if (item->flags & TODO_EDIT_FIXUP_MSG)
5542 strbuf_addstr(buf, " -c");
5543 else if (item->flags & TODO_REPLACE_FIXUP_MSG) {
5544 strbuf_addstr(buf, " -C");
5548 if (item->command == TODO_MERGE) {
5549 if (item->flags & TODO_EDIT_MERGE_MSG)
5550 strbuf_addstr(buf, " -c");
5551 else
5552 strbuf_addstr(buf, " -C");
5555 strbuf_addf(buf, " %s", oid);
5558 /* add all the rest */
5559 if (!item->arg_len)
5560 strbuf_addch(buf, '\n');
5561 else
5562 strbuf_addf(buf, " %.*s\n", item->arg_len,
5563 todo_item_get_arg(todo_list, item));
5567 int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
5568 const char *file, const char *shortrevisions,
5569 const char *shortonto, int num, unsigned flags)
5571 int res;
5572 struct strbuf buf = STRBUF_INIT;
5574 todo_list_to_strbuf(r, todo_list, &buf, num, flags);
5575 if (flags & TODO_LIST_APPEND_TODO_HELP)
5576 append_todo_help(count_commands(todo_list),
5577 shortrevisions, shortonto, &buf);
5579 res = write_message(buf.buf, buf.len, file, 0);
5580 strbuf_release(&buf);
5582 return res;
5585 /* skip picking commits whose parents are unchanged */
5586 static int skip_unnecessary_picks(struct repository *r,
5587 struct todo_list *todo_list,
5588 struct object_id *base_oid)
5590 struct object_id *parent_oid;
5591 int i;
5593 for (i = 0; i < todo_list->nr; i++) {
5594 struct todo_item *item = todo_list->items + i;
5596 if (item->command >= TODO_NOOP)
5597 continue;
5598 if (item->command != TODO_PICK)
5599 break;
5600 if (parse_commit(item->commit)) {
5601 return error(_("could not parse commit '%s'"),
5602 oid_to_hex(&item->commit->object.oid));
5604 if (!item->commit->parents)
5605 break; /* root commit */
5606 if (item->commit->parents->next)
5607 break; /* merge commit */
5608 parent_oid = &item->commit->parents->item->object.oid;
5609 if (!oideq(parent_oid, base_oid))
5610 break;
5611 oidcpy(base_oid, &item->commit->object.oid);
5613 if (i > 0) {
5614 const char *done_path = rebase_path_done();
5616 if (todo_list_write_to_file(r, todo_list, done_path, NULL, NULL, i, 0)) {
5617 error_errno(_("could not write to '%s'"), done_path);
5618 return -1;
5621 MOVE_ARRAY(todo_list->items, todo_list->items + i, todo_list->nr - i);
5622 todo_list->nr -= i;
5623 todo_list->current = 0;
5624 todo_list->done_nr += i;
5626 if (is_fixup(peek_command(todo_list, 0)))
5627 record_in_rewritten(base_oid, peek_command(todo_list, 0));
5630 return 0;
5633 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
5634 const char *shortrevisions, const char *onto_name,
5635 struct commit *onto, const struct object_id *orig_head,
5636 struct string_list *commands, unsigned autosquash,
5637 struct todo_list *todo_list)
5639 char shortonto[GIT_MAX_HEXSZ + 1];
5640 const char *todo_file = rebase_path_todo();
5641 struct todo_list new_todo = TODO_LIST_INIT;
5642 struct strbuf *buf = &todo_list->buf, buf2 = STRBUF_INIT;
5643 struct object_id oid = onto->object.oid;
5644 int res;
5646 find_unique_abbrev_r(shortonto, &oid, DEFAULT_ABBREV);
5648 if (buf->len == 0) {
5649 struct todo_item *item = append_new_todo(todo_list);
5650 item->command = TODO_NOOP;
5651 item->commit = NULL;
5652 item->arg_len = item->arg_offset = item->flags = item->offset_in_buf = 0;
5655 if (autosquash && todo_list_rearrange_squash(todo_list))
5656 return -1;
5658 if (commands->nr)
5659 todo_list_add_exec_commands(todo_list, commands);
5661 if (count_commands(todo_list) == 0) {
5662 apply_autostash(rebase_path_autostash());
5663 sequencer_remove_state(opts);
5665 return error(_("nothing to do"));
5668 res = edit_todo_list(r, todo_list, &new_todo, shortrevisions,
5669 shortonto, flags);
5670 if (res == -1)
5671 return -1;
5672 else if (res == -2) {
5673 apply_autostash(rebase_path_autostash());
5674 sequencer_remove_state(opts);
5676 return -1;
5677 } else if (res == -3) {
5678 apply_autostash(rebase_path_autostash());
5679 sequencer_remove_state(opts);
5680 todo_list_release(&new_todo);
5682 return error(_("nothing to do"));
5683 } else if (res == -4) {
5684 checkout_onto(r, opts, onto_name, &onto->object.oid, orig_head);
5685 todo_list_release(&new_todo);
5687 return -1;
5690 /* Expand the commit IDs */
5691 todo_list_to_strbuf(r, &new_todo, &buf2, -1, 0);
5692 strbuf_swap(&new_todo.buf, &buf2);
5693 strbuf_release(&buf2);
5694 new_todo.total_nr -= new_todo.nr;
5695 if (todo_list_parse_insn_buffer(r, new_todo.buf.buf, &new_todo) < 0)
5696 BUG("invalid todo list after expanding IDs:\n%s",
5697 new_todo.buf.buf);
5699 if (opts->allow_ff && skip_unnecessary_picks(r, &new_todo, &oid)) {
5700 todo_list_release(&new_todo);
5701 return error(_("could not skip unnecessary pick commands"));
5704 if (todo_list_write_to_file(r, &new_todo, todo_file, NULL, NULL, -1,
5705 flags & ~(TODO_LIST_SHORTEN_IDS))) {
5706 todo_list_release(&new_todo);
5707 return error_errno(_("could not write '%s'"), todo_file);
5710 res = -1;
5712 if (checkout_onto(r, opts, onto_name, &oid, orig_head))
5713 goto cleanup;
5715 if (require_clean_work_tree(r, "rebase", "", 1, 1))
5716 goto cleanup;
5718 todo_list_write_total_nr(&new_todo);
5719 res = pick_commits(r, &new_todo, opts);
5721 cleanup:
5722 todo_list_release(&new_todo);
5724 return res;
5727 struct subject2item_entry {
5728 struct hashmap_entry entry;
5729 int i;
5730 char subject[FLEX_ARRAY];
5733 static int subject2item_cmp(const void *fndata,
5734 const struct hashmap_entry *eptr,
5735 const struct hashmap_entry *entry_or_key,
5736 const void *key)
5738 const struct subject2item_entry *a, *b;
5740 a = container_of(eptr, const struct subject2item_entry, entry);
5741 b = container_of(entry_or_key, const struct subject2item_entry, entry);
5743 return key ? strcmp(a->subject, key) : strcmp(a->subject, b->subject);
5746 define_commit_slab(commit_todo_item, struct todo_item *);
5748 static int skip_fixupish(const char *subject, const char **p) {
5749 return skip_prefix(subject, "fixup! ", p) ||
5750 skip_prefix(subject, "amend! ", p) ||
5751 skip_prefix(subject, "squash! ", p);
5755 * Rearrange the todo list that has both "pick commit-id msg" and "pick
5756 * commit-id fixup!/squash! msg" in it so that the latter is put immediately
5757 * after the former, and change "pick" to "fixup"/"squash".
5759 * Note that if the config has specified a custom instruction format, each log
5760 * message will have to be retrieved from the commit (as the oneline in the
5761 * script cannot be trusted) in order to normalize the autosquash arrangement.
5763 int todo_list_rearrange_squash(struct todo_list *todo_list)
5765 struct hashmap subject2item;
5766 int rearranged = 0, *next, *tail, i, nr = 0, alloc = 0;
5767 char **subjects;
5768 struct commit_todo_item commit_todo;
5769 struct todo_item *items = NULL;
5771 init_commit_todo_item(&commit_todo);
5773 * The hashmap maps onelines to the respective todo list index.
5775 * If any items need to be rearranged, the next[i] value will indicate
5776 * which item was moved directly after the i'th.
5778 * In that case, last[i] will indicate the index of the latest item to
5779 * be moved to appear after the i'th.
5781 hashmap_init(&subject2item, subject2item_cmp, NULL, todo_list->nr);
5782 ALLOC_ARRAY(next, todo_list->nr);
5783 ALLOC_ARRAY(tail, todo_list->nr);
5784 ALLOC_ARRAY(subjects, todo_list->nr);
5785 for (i = 0; i < todo_list->nr; i++) {
5786 struct strbuf buf = STRBUF_INIT;
5787 struct todo_item *item = todo_list->items + i;
5788 const char *commit_buffer, *subject, *p;
5789 size_t subject_len;
5790 int i2 = -1;
5791 struct subject2item_entry *entry;
5793 next[i] = tail[i] = -1;
5794 if (!item->commit || item->command == TODO_DROP) {
5795 subjects[i] = NULL;
5796 continue;
5799 if (is_fixup(item->command)) {
5800 clear_commit_todo_item(&commit_todo);
5801 return error(_("the script was already rearranged."));
5804 *commit_todo_item_at(&commit_todo, item->commit) = item;
5806 parse_commit(item->commit);
5807 commit_buffer = logmsg_reencode(item->commit, NULL, "UTF-8");
5808 find_commit_subject(commit_buffer, &subject);
5809 format_subject(&buf, subject, " ");
5810 subject = subjects[i] = strbuf_detach(&buf, &subject_len);
5811 unuse_commit_buffer(item->commit, commit_buffer);
5812 if (skip_fixupish(subject, &p)) {
5813 struct commit *commit2;
5815 for (;;) {
5816 while (isspace(*p))
5817 p++;
5818 if (!skip_fixupish(p, &p))
5819 break;
5822 entry = hashmap_get_entry_from_hash(&subject2item,
5823 strhash(p), p,
5824 struct subject2item_entry,
5825 entry);
5826 if (entry)
5827 /* found by title */
5828 i2 = entry->i;
5829 else if (!strchr(p, ' ') &&
5830 (commit2 =
5831 lookup_commit_reference_by_name(p)) &&
5832 *commit_todo_item_at(&commit_todo, commit2))
5833 /* found by commit name */
5834 i2 = *commit_todo_item_at(&commit_todo, commit2)
5835 - todo_list->items;
5836 else {
5837 /* copy can be a prefix of the commit subject */
5838 for (i2 = 0; i2 < i; i2++)
5839 if (subjects[i2] &&
5840 starts_with(subjects[i2], p))
5841 break;
5842 if (i2 == i)
5843 i2 = -1;
5846 if (i2 >= 0) {
5847 rearranged = 1;
5848 if (starts_with(subject, "fixup!")) {
5849 todo_list->items[i].command = TODO_FIXUP;
5850 } else if (starts_with(subject, "amend!")) {
5851 todo_list->items[i].command = TODO_FIXUP;
5852 todo_list->items[i].flags = TODO_REPLACE_FIXUP_MSG;
5853 } else {
5854 todo_list->items[i].command = TODO_SQUASH;
5856 if (tail[i2] < 0) {
5857 next[i] = next[i2];
5858 next[i2] = i;
5859 } else {
5860 next[i] = next[tail[i2]];
5861 next[tail[i2]] = i;
5863 tail[i2] = i;
5864 } else if (!hashmap_get_from_hash(&subject2item,
5865 strhash(subject), subject)) {
5866 FLEX_ALLOC_MEM(entry, subject, subject, subject_len);
5867 entry->i = i;
5868 hashmap_entry_init(&entry->entry,
5869 strhash(entry->subject));
5870 hashmap_put(&subject2item, &entry->entry);
5874 if (rearranged) {
5875 for (i = 0; i < todo_list->nr; i++) {
5876 enum todo_command command = todo_list->items[i].command;
5877 int cur = i;
5880 * Initially, all commands are 'pick's. If it is a
5881 * fixup or a squash now, we have rearranged it.
5883 if (is_fixup(command))
5884 continue;
5886 while (cur >= 0) {
5887 ALLOC_GROW(items, nr + 1, alloc);
5888 items[nr++] = todo_list->items[cur];
5889 cur = next[cur];
5893 FREE_AND_NULL(todo_list->items);
5894 todo_list->items = items;
5895 todo_list->nr = nr;
5896 todo_list->alloc = alloc;
5899 free(next);
5900 free(tail);
5901 for (i = 0; i < todo_list->nr; i++)
5902 free(subjects[i]);
5903 free(subjects);
5904 hashmap_clear_and_free(&subject2item, struct subject2item_entry, entry);
5906 clear_commit_todo_item(&commit_todo);
5908 return 0;
5911 int sequencer_determine_whence(struct repository *r, enum commit_whence *whence)
5913 if (refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD")) {
5914 struct object_id cherry_pick_head, rebase_head;
5916 if (file_exists(git_path_seq_dir()))
5917 *whence = FROM_CHERRY_PICK_MULTI;
5918 if (file_exists(rebase_path()) &&
5919 !get_oid("REBASE_HEAD", &rebase_head) &&
5920 !get_oid("CHERRY_PICK_HEAD", &cherry_pick_head) &&
5921 oideq(&rebase_head, &cherry_pick_head))
5922 *whence = FROM_REBASE_PICK;
5923 else
5924 *whence = FROM_CHERRY_PICK_SINGLE;
5926 return 1;
5929 return 0;