5 #include "object-store.h"
10 #include "run-command.h"
13 #include "cache-tree.h"
17 #include "merge-recursive.h"
19 #include "argv-array.h"
23 #include "wt-status.h"
25 #include "notes-utils.h"
27 #include "unpack-trees.h"
31 #include "commit-slab.h"
33 #include "commit-reach.h"
34 #include "rebase-interactive.h"
36 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
38 static const char sign_off_header[] = "Signed-off-by: ";
39 static const char cherry_picked_prefix[] = "(cherry picked from commit ";
41 GIT_PATH_FUNC(git_path_commit_editmsg, "COMMIT_EDITMSG")
43 GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
45 static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
46 static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
47 static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
48 static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
50 static GIT_PATH_FUNC(rebase_path, "rebase-merge")
52 * The file containing rebase commands, comments, and empty lines.
53 * This file is created by "git rebase -i" then edited by the user. As
54 * the lines are processed, they are removed from the front of this
55 * file and written to the tail of 'done'.
57 GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
58 GIT_PATH_FUNC(rebase_path_todo_backup, "rebase-merge/git-rebase-todo.backup")
60 GIT_PATH_FUNC(rebase_path_dropped, "rebase-merge/dropped")
63 * The rebase command lines that have already been processed. A line
64 * is moved here when it is first handled, before any associated user
67 static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
69 * The file to keep track of how many commands were already processed (e.g.
72 static GIT_PATH_FUNC(rebase_path_msgnum, "rebase-merge/msgnum")
74 * The file to keep track of how many commands are to be processed in total
75 * (e.g. for the prompt).
77 static GIT_PATH_FUNC(rebase_path_msgtotal, "rebase-merge/end")
79 * The commit message that is planned to be used for any changes that
80 * need to be committed following a user interaction.
82 static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
84 * The file into which is accumulated the suggested commit message for
85 * squash/fixup commands. When the first of a series of squash/fixups
86 * is seen, the file is created and the commit message from the
87 * previous commit and from the first squash/fixup commit are written
88 * to it. The commit message for each subsequent squash/fixup commit
89 * is appended to the file as it is processed.
91 static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
93 * If the current series of squash/fixups has not yet included a squash
94 * command, then this file exists and holds the commit message of the
95 * original "pick" commit. (If the series ends without a "squash"
96 * command, then this can be used as the commit message of the combined
97 * commit without opening the editor.)
99 static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
101 * This file contains the list fixup/squash commands that have been
102 * accumulated into message-fixup or message-squash so far.
104 static GIT_PATH_FUNC(rebase_path_current_fixups, "rebase-merge/current-fixups")
106 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
107 * GIT_AUTHOR_DATE that will be used for the commit that is currently
110 static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
112 * When an "edit" rebase command is being processed, the SHA1 of the
113 * commit to be edited is recorded in this file. When "git rebase
114 * --continue" is executed, if there are any staged changes then they
115 * will be amended to the HEAD commit, but only provided the HEAD
116 * commit is still the commit to be edited. When any other rebase
117 * command is processed, this file is deleted.
119 static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
121 * When we stop at a given patch via the "edit" command, this file contains
122 * the abbreviated commit name of the corresponding patch.
124 static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
126 * For the post-rewrite hook, we make a list of rewritten commits and
127 * their new sha1s. The rewritten-pending list keeps the sha1s of
128 * commits that have been processed, but not committed yet,
129 * e.g. because they are waiting for a 'squash' command.
131 static GIT_PATH_FUNC(rebase_path_rewritten_list, "rebase-merge/rewritten-list")
132 static GIT_PATH_FUNC(rebase_path_rewritten_pending,
133 "rebase-merge/rewritten-pending")
136 * The path of the file containing the OID of the "squash onto" commit, i.e.
137 * the dummy commit used for `reset [new root]`.
139 static GIT_PATH_FUNC(rebase_path_squash_onto, "rebase-merge/squash-onto")
142 * The path of the file listing refs that need to be deleted after the rebase
143 * finishes. This is used by the `label` command to record the need for cleanup.
145 static GIT_PATH_FUNC(rebase_path_refs_to_delete, "rebase-merge/refs-to-delete")
148 * The following files are written by git-rebase just after parsing the
151 static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
152 static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
153 static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
154 static GIT_PATH_FUNC(rebase_path_quiet, "rebase-merge/quiet")
155 static GIT_PATH_FUNC(rebase_path_signoff, "rebase-merge/signoff")
156 static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
157 static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
158 static GIT_PATH_FUNC(rebase_path_autostash, "rebase-merge/autostash")
159 static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy")
160 static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts")
161 static GIT_PATH_FUNC(rebase_path_allow_rerere_autoupdate, "rebase-merge/allow_rerere_autoupdate")
162 static GIT_PATH_FUNC(rebase_path_reschedule_failed_exec, "rebase-merge/reschedule-failed-exec")
163 static GIT_PATH_FUNC(rebase_path_drop_redundant_commits, "rebase-merge/drop_redundant_commits")
164 static GIT_PATH_FUNC(rebase_path_keep_redundant_commits, "rebase-merge/keep_redundant_commits")
166 static int git_sequencer_config(const char *k, const char *v, void *cb)
168 struct replay_opts *opts = cb;
171 if (!strcmp(k, "commit.cleanup")) {
174 status = git_config_string(&s, k, v);
178 if (!strcmp(s, "verbatim")) {
179 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
180 opts->explicit_cleanup = 1;
181 } else if (!strcmp(s, "whitespace")) {
182 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE;
183 opts->explicit_cleanup = 1;
184 } else if (!strcmp(s, "strip")) {
185 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_ALL;
186 opts->explicit_cleanup = 1;
187 } else if (!strcmp(s, "scissors")) {
188 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SCISSORS;
189 opts->explicit_cleanup = 1;
191 warning(_("invalid commit message cleanup mode '%s'"),
199 if (!strcmp(k, "commit.gpgsign")) {
200 opts->gpg_sign = git_config_bool(k, v) ? xstrdup("") : NULL;
204 status = git_gpg_config(k, v, NULL);
208 return git_diff_basic_config(k, v, NULL);
211 void sequencer_init_config(struct replay_opts *opts)
213 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
214 git_config(git_sequencer_config, opts);
217 static inline int is_rebase_i(const struct replay_opts *opts)
219 return opts->action == REPLAY_INTERACTIVE_REBASE;
222 static const char *get_dir(const struct replay_opts *opts)
224 if (is_rebase_i(opts))
225 return rebase_path();
226 return git_path_seq_dir();
229 static const char *get_todo_path(const struct replay_opts *opts)
231 if (is_rebase_i(opts))
232 return rebase_path_todo();
233 return git_path_todo_file();
237 * Returns 0 for non-conforming footer
238 * Returns 1 for conforming footer
239 * Returns 2 when sob exists within conforming footer
240 * Returns 3 when sob exists within conforming footer as last entry
242 static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
243 size_t ignore_footer)
245 struct process_trailer_options opts = PROCESS_TRAILER_OPTIONS_INIT;
246 struct trailer_info info;
248 int found_sob = 0, found_sob_last = 0;
252 trailer_info_get(&info, sb->buf, &opts);
254 if (info.trailer_start == info.trailer_end)
257 for (i = 0; i < info.trailer_nr; i++)
258 if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
260 if (i == info.trailer_nr - 1)
264 trailer_info_release(&info);
273 static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
275 static struct strbuf buf = STRBUF_INIT;
279 sq_quotef(&buf, "-S%s", opts->gpg_sign);
283 int sequencer_remove_state(struct replay_opts *opts)
285 struct strbuf buf = STRBUF_INIT;
288 if (is_rebase_i(opts) &&
289 strbuf_read_file(&buf, rebase_path_refs_to_delete(), 0) > 0) {
292 char *eol = strchr(p, '\n');
295 if (delete_ref("(rebase) cleanup", p, NULL, 0) < 0) {
296 warning(_("could not delete '%s'"), p);
305 free(opts->gpg_sign);
306 free(opts->strategy);
307 for (i = 0; i < opts->xopts_nr; i++)
308 free(opts->xopts[i]);
310 strbuf_release(&opts->current_fixups);
313 strbuf_addstr(&buf, get_dir(opts));
314 if (remove_dir_recursively(&buf, 0))
315 ret = error(_("could not remove '%s'"), buf.buf);
316 strbuf_release(&buf);
321 static const char *action_name(const struct replay_opts *opts)
323 switch (opts->action) {
327 return N_("cherry-pick");
328 case REPLAY_INTERACTIVE_REBASE:
331 die(_("unknown action: %d"), opts->action);
334 struct commit_message {
341 static const char *short_commit_name(struct commit *commit)
343 return find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV);
346 static int get_message(struct commit *commit, struct commit_message *out)
348 const char *abbrev, *subject;
351 out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
352 abbrev = short_commit_name(commit);
354 subject_len = find_commit_subject(out->message, &subject);
356 out->subject = xmemdupz(subject, subject_len);
357 out->label = xstrfmt("%s... %s", abbrev, out->subject);
358 out->parent_label = xstrfmt("parent of %s", out->label);
363 static void free_message(struct commit *commit, struct commit_message *msg)
365 free(msg->parent_label);
368 unuse_commit_buffer(commit, msg->message);
371 static void print_advice(struct repository *r, int show_hint,
372 struct replay_opts *opts)
374 char *msg = getenv("GIT_CHERRY_PICK_HELP");
377 fprintf(stderr, "%s\n", msg);
379 * A conflict has occurred but the porcelain
380 * (typically rebase --interactive) wants to take care
381 * of the commit itself so remove CHERRY_PICK_HEAD
383 unlink(git_path_cherry_pick_head(r));
389 advise(_("after resolving the conflicts, mark the corrected paths\n"
390 "with 'git add <paths>' or 'git rm <paths>'"));
392 advise(_("after resolving the conflicts, mark the corrected paths\n"
393 "with 'git add <paths>' or 'git rm <paths>'\n"
394 "and commit the result with 'git commit'"));
398 static int write_message(const void *buf, size_t len, const char *filename,
401 struct lock_file msg_file = LOCK_INIT;
403 int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
405 return error_errno(_("could not lock '%s'"), filename);
406 if (write_in_full(msg_fd, buf, len) < 0) {
407 error_errno(_("could not write to '%s'"), filename);
408 rollback_lock_file(&msg_file);
411 if (append_eol && write(msg_fd, "\n", 1) < 0) {
412 error_errno(_("could not write eol to '%s'"), filename);
413 rollback_lock_file(&msg_file);
416 if (commit_lock_file(&msg_file) < 0)
417 return error(_("failed to finalize '%s'"), filename);
422 int read_oneliner(struct strbuf *buf,
423 const char *path, unsigned flags)
425 int orig_len = buf->len;
427 if (strbuf_read_file(buf, path, 0) < 0) {
428 if ((flags & READ_ONELINER_WARN_MISSING) ||
429 (errno != ENOENT && errno != ENOTDIR))
430 warning_errno(_("could not read '%s'"), path);
434 if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
435 if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
437 buf->buf[buf->len] = '\0';
440 if ((flags & READ_ONELINER_SKIP_IF_EMPTY) && buf->len == orig_len)
446 static struct tree *empty_tree(struct repository *r)
448 return lookup_tree(r, the_hash_algo->empty_tree);
451 static int error_dirty_index(struct repository *repo, struct replay_opts *opts)
453 if (repo_read_index_unmerged(repo))
454 return error_resolve_conflict(_(action_name(opts)));
456 error(_("your local changes would be overwritten by %s."),
457 _(action_name(opts)));
459 if (advice_commit_before_merge)
460 advise(_("commit your changes or stash them to proceed."));
464 static void update_abort_safety_file(void)
466 struct object_id head;
468 /* Do nothing on a single-pick */
469 if (!file_exists(git_path_seq_dir()))
472 if (!get_oid("HEAD", &head))
473 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
475 write_file(git_path_abort_safety_file(), "%s", "");
478 static int fast_forward_to(struct repository *r,
479 const struct object_id *to,
480 const struct object_id *from,
482 struct replay_opts *opts)
484 struct ref_transaction *transaction;
485 struct strbuf sb = STRBUF_INIT;
486 struct strbuf err = STRBUF_INIT;
489 if (checkout_fast_forward(r, from, to, 1))
490 return -1; /* the callee should have complained already */
492 strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
494 transaction = ref_transaction_begin(&err);
496 ref_transaction_update(transaction, "HEAD",
497 to, unborn && !is_rebase_i(opts) ?
500 ref_transaction_commit(transaction, &err)) {
501 ref_transaction_free(transaction);
502 error("%s", err.buf);
504 strbuf_release(&err);
509 strbuf_release(&err);
510 ref_transaction_free(transaction);
511 update_abort_safety_file();
515 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
518 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
519 return use_editor ? COMMIT_MSG_CLEANUP_ALL :
520 COMMIT_MSG_CLEANUP_SPACE;
521 else if (!strcmp(cleanup_arg, "verbatim"))
522 return COMMIT_MSG_CLEANUP_NONE;
523 else if (!strcmp(cleanup_arg, "whitespace"))
524 return COMMIT_MSG_CLEANUP_SPACE;
525 else if (!strcmp(cleanup_arg, "strip"))
526 return COMMIT_MSG_CLEANUP_ALL;
527 else if (!strcmp(cleanup_arg, "scissors"))
528 return use_editor ? COMMIT_MSG_CLEANUP_SCISSORS :
529 COMMIT_MSG_CLEANUP_SPACE;
531 die(_("Invalid cleanup mode %s"), cleanup_arg);
535 * NB using int rather than enum cleanup_mode to stop clang's
536 * -Wtautological-constant-out-of-range-compare complaining that the comparison
539 static const char *describe_cleanup_mode(int cleanup_mode)
541 static const char *modes[] = { "whitespace",
546 if (cleanup_mode < ARRAY_SIZE(modes))
547 return modes[cleanup_mode];
549 BUG("invalid cleanup_mode provided (%d)", cleanup_mode);
552 void append_conflicts_hint(struct index_state *istate,
553 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode)
557 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
558 strbuf_addch(msgbuf, '\n');
559 wt_status_append_cut_line(msgbuf);
560 strbuf_addch(msgbuf, comment_line_char);
563 strbuf_addch(msgbuf, '\n');
564 strbuf_commented_addf(msgbuf, "Conflicts:\n");
565 for (i = 0; i < istate->cache_nr;) {
566 const struct cache_entry *ce = istate->cache[i++];
568 strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
569 while (i < istate->cache_nr &&
570 !strcmp(ce->name, istate->cache[i]->name))
576 static int do_recursive_merge(struct repository *r,
577 struct commit *base, struct commit *next,
578 const char *base_label, const char *next_label,
579 struct object_id *head, struct strbuf *msgbuf,
580 struct replay_opts *opts)
582 struct merge_options o;
583 struct tree *next_tree, *base_tree, *head_tree;
586 struct lock_file index_lock = LOCK_INIT;
588 if (repo_hold_locked_index(r, &index_lock, LOCK_REPORT_ON_ERROR) < 0)
593 init_merge_options(&o, r);
594 o.ancestor = base ? base_label : "(empty tree)";
596 o.branch2 = next ? next_label : "(empty tree)";
597 if (is_rebase_i(opts))
599 o.show_rename_progress = 1;
601 head_tree = parse_tree_indirect(head);
602 next_tree = next ? get_commit_tree(next) : empty_tree(r);
603 base_tree = base ? get_commit_tree(base) : empty_tree(r);
605 for (i = 0; i < opts->xopts_nr; i++)
606 parse_merge_opt(&o, opts->xopts[i]);
608 clean = merge_trees(&o,
610 next_tree, base_tree);
611 if (is_rebase_i(opts) && clean <= 0)
612 fputs(o.obuf.buf, stdout);
613 strbuf_release(&o.obuf);
615 rollback_lock_file(&index_lock);
619 if (write_locked_index(r->index, &index_lock,
620 COMMIT_LOCK | SKIP_IF_UNCHANGED))
622 * TRANSLATORS: %s will be "revert", "cherry-pick" or
625 return error(_("%s: Unable to write new index file"),
626 _(action_name(opts)));
629 append_conflicts_hint(r->index, msgbuf,
630 opts->default_msg_cleanup);
635 static struct object_id *get_cache_tree_oid(struct index_state *istate)
637 if (!istate->cache_tree)
638 istate->cache_tree = cache_tree();
640 if (!cache_tree_fully_valid(istate->cache_tree))
641 if (cache_tree_update(istate, 0)) {
642 error(_("unable to update cache tree"));
646 return &istate->cache_tree->oid;
649 static int is_index_unchanged(struct repository *r)
651 struct object_id head_oid, *cache_tree_oid;
652 struct commit *head_commit;
653 struct index_state *istate = r->index;
655 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, &head_oid, NULL))
656 return error(_("could not resolve HEAD commit"));
658 head_commit = lookup_commit(r, &head_oid);
661 * If head_commit is NULL, check_commit, called from
662 * lookup_commit, would have indicated that head_commit is not
663 * a commit object already. parse_commit() will return failure
664 * without further complaints in such a case. Otherwise, if
665 * the commit is invalid, parse_commit() will complain. So
666 * there is nothing for us to say here. Just return failure.
668 if (parse_commit(head_commit))
671 if (!(cache_tree_oid = get_cache_tree_oid(istate)))
674 return oideq(cache_tree_oid, get_commit_tree_oid(head_commit));
677 static int write_author_script(const char *message)
679 struct strbuf buf = STRBUF_INIT;
684 if (!*message || starts_with(message, "\n")) {
686 /* Missing 'author' line? */
687 unlink(rebase_path_author_script());
689 } else if (skip_prefix(message, "author ", &message))
691 else if ((eol = strchr(message, '\n')))
696 strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
697 while (*message && *message != '\n' && *message != '\r')
698 if (skip_prefix(message, " <", &message))
700 else if (*message != '\'')
701 strbuf_addch(&buf, *(message++));
703 strbuf_addf(&buf, "'\\%c'", *(message++));
704 strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
705 while (*message && *message != '\n' && *message != '\r')
706 if (skip_prefix(message, "> ", &message))
708 else if (*message != '\'')
709 strbuf_addch(&buf, *(message++));
711 strbuf_addf(&buf, "'\\%c'", *(message++));
712 strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
713 while (*message && *message != '\n' && *message != '\r')
714 if (*message != '\'')
715 strbuf_addch(&buf, *(message++));
717 strbuf_addf(&buf, "'\\%c'", *(message++));
718 strbuf_addch(&buf, '\'');
719 res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
720 strbuf_release(&buf);
725 * Take a series of KEY='VALUE' lines where VALUE part is
726 * sq-quoted, and append <KEY, VALUE> at the end of the string list
728 static int parse_key_value_squoted(char *buf, struct string_list *list)
731 struct string_list_item *item;
733 char *cp = strchr(buf, '=');
735 np = strchrnul(buf, '\n');
736 return error(_("no key present in '%.*s'"),
737 (int) (np - buf), buf);
739 np = strchrnul(cp, '\n');
741 item = string_list_append(list, buf);
743 buf = np + (*np == '\n');
747 return error(_("unable to dequote value of '%s'"),
749 item->util = xstrdup(cp);
755 * Reads and parses the state directory's "author-script" file, and sets name,
756 * email and date accordingly.
757 * Returns 0 on success, -1 if the file could not be parsed.
759 * The author script is of the format:
761 * GIT_AUTHOR_NAME='$author_name'
762 * GIT_AUTHOR_EMAIL='$author_email'
763 * GIT_AUTHOR_DATE='$author_date'
765 * where $author_name, $author_email and $author_date are quoted. We are strict
766 * with our parsing, as the file was meant to be eval'd in the now-removed
767 * git-am.sh/git-rebase--interactive.sh scripts, and thus if the file differs
768 * from what this function expects, it is better to bail out than to do
769 * something that the user does not expect.
771 int read_author_script(const char *path, char **name, char **email, char **date,
774 struct strbuf buf = STRBUF_INIT;
775 struct string_list kv = STRING_LIST_INIT_DUP;
776 int retval = -1; /* assume failure */
777 int i, name_i = -2, email_i = -2, date_i = -2, err = 0;
779 if (strbuf_read_file(&buf, path, 256) <= 0) {
780 strbuf_release(&buf);
781 if (errno == ENOENT && allow_missing)
784 return error_errno(_("could not open '%s' for reading"),
788 if (parse_key_value_squoted(buf.buf, &kv))
791 for (i = 0; i < kv.nr; i++) {
792 if (!strcmp(kv.items[i].string, "GIT_AUTHOR_NAME")) {
794 name_i = error(_("'GIT_AUTHOR_NAME' already given"));
797 } else if (!strcmp(kv.items[i].string, "GIT_AUTHOR_EMAIL")) {
799 email_i = error(_("'GIT_AUTHOR_EMAIL' already given"));
802 } else if (!strcmp(kv.items[i].string, "GIT_AUTHOR_DATE")) {
804 date_i = error(_("'GIT_AUTHOR_DATE' already given"));
808 err = error(_("unknown variable '%s'"),
813 error(_("missing 'GIT_AUTHOR_NAME'"));
815 error(_("missing 'GIT_AUTHOR_EMAIL'"));
817 error(_("missing 'GIT_AUTHOR_DATE'"));
818 if (date_i < 0 || email_i < 0 || date_i < 0 || err)
820 *name = kv.items[name_i].util;
821 *email = kv.items[email_i].util;
822 *date = kv.items[date_i].util;
825 string_list_clear(&kv, !!retval);
826 strbuf_release(&buf);
831 * Read a GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL AND GIT_AUTHOR_DATE from a
832 * file with shell quoting into struct argv_array. Returns -1 on
833 * error, 0 otherwise.
835 static int read_env_script(struct argv_array *env)
837 char *name, *email, *date;
839 if (read_author_script(rebase_path_author_script(),
840 &name, &email, &date, 0))
843 argv_array_pushf(env, "GIT_AUTHOR_NAME=%s", name);
844 argv_array_pushf(env, "GIT_AUTHOR_EMAIL=%s", email);
845 argv_array_pushf(env, "GIT_AUTHOR_DATE=%s", date);
853 static char *get_author(const char *message)
858 a = find_commit_header(message, "author", &len);
860 return xmemdupz(a, len);
865 static const char staged_changes_advice[] =
866 N_("you have staged changes in your working tree\n"
867 "If these changes are meant to be squashed into the previous commit, run:\n"
869 " git commit --amend %s\n"
871 "If they are meant to go into a new commit, run:\n"
875 "In both cases, once you're done, continue with:\n"
877 " git rebase --continue\n");
879 #define ALLOW_EMPTY (1<<0)
880 #define EDIT_MSG (1<<1)
881 #define AMEND_MSG (1<<2)
882 #define CLEANUP_MSG (1<<3)
883 #define VERIFY_MSG (1<<4)
884 #define CREATE_ROOT_COMMIT (1<<5)
886 static int run_command_silent_on_success(struct child_process *cmd)
888 struct strbuf buf = STRBUF_INIT;
891 cmd->stdout_to_stderr = 1;
892 rc = pipe_command(cmd,
898 fputs(buf.buf, stderr);
899 strbuf_release(&buf);
904 * If we are cherry-pick, and if the merge did not result in
905 * hand-editing, we will hit this commit and inherit the original
906 * author date and name.
908 * If we are revert, or if our cherry-pick results in a hand merge,
909 * we had better say that the current user is responsible for that.
911 * An exception is when run_git_commit() is called during an
912 * interactive rebase: in that case, we will want to retain the
915 static int run_git_commit(struct repository *r,
917 struct replay_opts *opts,
920 struct child_process cmd = CHILD_PROCESS_INIT;
924 if (is_rebase_i(opts) && read_env_script(&cmd.env_array)) {
925 const char *gpg_opt = gpg_sign_opt_quoted(opts);
927 return error(_(staged_changes_advice),
931 argv_array_push(&cmd.args, "commit");
933 if (!(flags & VERIFY_MSG))
934 argv_array_push(&cmd.args, "-n");
935 if ((flags & AMEND_MSG))
936 argv_array_push(&cmd.args, "--amend");
938 argv_array_pushf(&cmd.args, "-S%s", opts->gpg_sign);
940 argv_array_pushl(&cmd.args, "-F", defmsg, NULL);
941 else if (!(flags & EDIT_MSG))
942 argv_array_pushl(&cmd.args, "-C", "HEAD", NULL);
943 if ((flags & CLEANUP_MSG))
944 argv_array_push(&cmd.args, "--cleanup=strip");
945 if ((flags & EDIT_MSG))
946 argv_array_push(&cmd.args, "-e");
947 else if (!(flags & CLEANUP_MSG) &&
948 !opts->signoff && !opts->record_origin &&
949 !opts->explicit_cleanup)
950 argv_array_push(&cmd.args, "--cleanup=verbatim");
952 if ((flags & ALLOW_EMPTY))
953 argv_array_push(&cmd.args, "--allow-empty");
955 if (!(flags & EDIT_MSG))
956 argv_array_push(&cmd.args, "--allow-empty-message");
958 if (is_rebase_i(opts) && !(flags & EDIT_MSG))
959 return run_command_silent_on_success(&cmd);
961 return run_command(&cmd);
964 static int rest_is_empty(const struct strbuf *sb, int start)
969 /* Check if the rest is just whitespace and Signed-off-by's. */
970 for (i = start; i < sb->len; i++) {
971 nl = memchr(sb->buf + i, '\n', sb->len - i);
977 if (strlen(sign_off_header) <= eol - i &&
978 starts_with(sb->buf + i, sign_off_header)) {
983 if (!isspace(sb->buf[i++]))
990 void cleanup_message(struct strbuf *msgbuf,
991 enum commit_msg_cleanup_mode cleanup_mode, int verbose)
993 if (verbose || /* Truncate the message just before the diff, if any. */
994 cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS)
995 strbuf_setlen(msgbuf, wt_status_locate_end(msgbuf->buf, msgbuf->len));
996 if (cleanup_mode != COMMIT_MSG_CLEANUP_NONE)
997 strbuf_stripspace(msgbuf, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
1001 * Find out if the message in the strbuf contains only whitespace and
1002 * Signed-off-by lines.
1004 int message_is_empty(const struct strbuf *sb,
1005 enum commit_msg_cleanup_mode cleanup_mode)
1007 if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
1009 return rest_is_empty(sb, 0);
1013 * See if the user edited the message in the editor or left what
1014 * was in the template intact
1016 int template_untouched(const struct strbuf *sb, const char *template_file,
1017 enum commit_msg_cleanup_mode cleanup_mode)
1019 struct strbuf tmpl = STRBUF_INIT;
1022 if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
1025 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
1028 strbuf_stripspace(&tmpl, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
1029 if (!skip_prefix(sb->buf, tmpl.buf, &start))
1031 strbuf_release(&tmpl);
1032 return rest_is_empty(sb, start - sb->buf);
1035 int update_head_with_reflog(const struct commit *old_head,
1036 const struct object_id *new_head,
1037 const char *action, const struct strbuf *msg,
1040 struct ref_transaction *transaction;
1041 struct strbuf sb = STRBUF_INIT;
1046 strbuf_addstr(&sb, action);
1047 strbuf_addstr(&sb, ": ");
1050 nl = strchr(msg->buf, '\n');
1052 strbuf_add(&sb, msg->buf, nl + 1 - msg->buf);
1054 strbuf_addbuf(&sb, msg);
1055 strbuf_addch(&sb, '\n');
1058 transaction = ref_transaction_begin(err);
1060 ref_transaction_update(transaction, "HEAD", new_head,
1061 old_head ? &old_head->object.oid : &null_oid,
1063 ref_transaction_commit(transaction, err)) {
1066 ref_transaction_free(transaction);
1067 strbuf_release(&sb);
1072 static int run_rewrite_hook(const struct object_id *oldoid,
1073 const struct object_id *newoid)
1075 struct child_process proc = CHILD_PROCESS_INIT;
1076 const char *argv[3];
1078 struct strbuf sb = STRBUF_INIT;
1080 argv[0] = find_hook("post-rewrite");
1089 proc.stdout_to_stderr = 1;
1090 proc.trace2_hook_name = "post-rewrite";
1092 code = start_command(&proc);
1095 strbuf_addf(&sb, "%s %s\n", oid_to_hex(oldoid), oid_to_hex(newoid));
1096 sigchain_push(SIGPIPE, SIG_IGN);
1097 write_in_full(proc.in, sb.buf, sb.len);
1099 strbuf_release(&sb);
1100 sigchain_pop(SIGPIPE);
1101 return finish_command(&proc);
1104 void commit_post_rewrite(struct repository *r,
1105 const struct commit *old_head,
1106 const struct object_id *new_head)
1108 struct notes_rewrite_cfg *cfg;
1110 cfg = init_copy_notes_for_rewrite("amend");
1112 /* we are amending, so old_head is not NULL */
1113 copy_note_for_rewrite(cfg, &old_head->object.oid, new_head);
1114 finish_copy_notes_for_rewrite(r, cfg, "Notes added by 'git commit --amend'");
1116 run_rewrite_hook(&old_head->object.oid, new_head);
1119 static int run_prepare_commit_msg_hook(struct repository *r,
1124 const char *name, *arg1 = NULL, *arg2 = NULL;
1126 name = git_path_commit_editmsg();
1127 if (write_message(msg->buf, msg->len, name, 0))
1136 if (run_commit_hook(0, r->index_file, "prepare-commit-msg", name,
1138 ret = error(_("'prepare-commit-msg' hook failed"));
1143 static const char implicit_ident_advice_noconfig[] =
1144 N_("Your name and email address were configured automatically based\n"
1145 "on your username and hostname. Please check that they are accurate.\n"
1146 "You can suppress this message by setting them explicitly. Run the\n"
1147 "following command and follow the instructions in your editor to edit\n"
1148 "your configuration file:\n"
1150 " git config --global --edit\n"
1152 "After doing this, you may fix the identity used for this commit with:\n"
1154 " git commit --amend --reset-author\n");
1156 static const char implicit_ident_advice_config[] =
1157 N_("Your name and email address were configured automatically based\n"
1158 "on your username and hostname. Please check that they are accurate.\n"
1159 "You can suppress this message by setting them explicitly:\n"
1161 " git config --global user.name \"Your Name\"\n"
1162 " git config --global user.email you@example.com\n"
1164 "After doing this, you may fix the identity used for this commit with:\n"
1166 " git commit --amend --reset-author\n");
1168 static const char *implicit_ident_advice(void)
1170 char *user_config = expand_user_path("~/.gitconfig", 0);
1171 char *xdg_config = xdg_config_home("config");
1172 int config_exists = file_exists(user_config) || file_exists(xdg_config);
1178 return _(implicit_ident_advice_config);
1180 return _(implicit_ident_advice_noconfig);
1184 void print_commit_summary(struct repository *r,
1186 const struct object_id *oid,
1189 struct rev_info rev;
1190 struct commit *commit;
1191 struct strbuf format = STRBUF_INIT;
1193 struct pretty_print_context pctx = {0};
1194 struct strbuf author_ident = STRBUF_INIT;
1195 struct strbuf committer_ident = STRBUF_INIT;
1197 commit = lookup_commit(r, oid);
1199 die(_("couldn't look up newly created commit"));
1200 if (parse_commit(commit))
1201 die(_("could not parse newly created commit"));
1203 strbuf_addstr(&format, "format:%h] %s");
1205 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1206 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1207 if (strbuf_cmp(&author_ident, &committer_ident)) {
1208 strbuf_addstr(&format, "\n Author: ");
1209 strbuf_addbuf_percentquote(&format, &author_ident);
1211 if (flags & SUMMARY_SHOW_AUTHOR_DATE) {
1212 struct strbuf date = STRBUF_INIT;
1214 format_commit_message(commit, "%ad", &date, &pctx);
1215 strbuf_addstr(&format, "\n Date: ");
1216 strbuf_addbuf_percentquote(&format, &date);
1217 strbuf_release(&date);
1219 if (!committer_ident_sufficiently_given()) {
1220 strbuf_addstr(&format, "\n Committer: ");
1221 strbuf_addbuf_percentquote(&format, &committer_ident);
1222 if (advice_implicit_identity) {
1223 strbuf_addch(&format, '\n');
1224 strbuf_addstr(&format, implicit_ident_advice());
1227 strbuf_release(&author_ident);
1228 strbuf_release(&committer_ident);
1230 repo_init_revisions(r, &rev, prefix);
1231 setup_revisions(0, NULL, &rev, NULL);
1234 rev.diffopt.output_format =
1235 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1237 rev.verbose_header = 1;
1238 rev.show_root_diff = 1;
1239 get_commit_format(format.buf, &rev);
1240 rev.always_show_header = 0;
1241 rev.diffopt.detect_rename = DIFF_DETECT_RENAME;
1242 rev.diffopt.break_opt = 0;
1243 diff_setup_done(&rev.diffopt);
1245 head = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1247 die_errno(_("unable to resolve HEAD after creating commit"));
1248 if (!strcmp(head, "HEAD"))
1249 head = _("detached HEAD");
1251 skip_prefix(head, "refs/heads/", &head);
1252 printf("[%s%s ", head, (flags & SUMMARY_INITIAL_COMMIT) ?
1253 _(" (root-commit)") : "");
1255 if (!log_tree_commit(&rev, commit)) {
1256 rev.always_show_header = 1;
1257 rev.use_terminator = 1;
1258 log_tree_commit(&rev, commit);
1261 strbuf_release(&format);
1264 static int parse_head(struct repository *r, struct commit **head)
1266 struct commit *current_head;
1267 struct object_id oid;
1269 if (get_oid("HEAD", &oid)) {
1270 current_head = NULL;
1272 current_head = lookup_commit_reference(r, &oid);
1274 return error(_("could not parse HEAD"));
1275 if (!oideq(&oid, ¤t_head->object.oid)) {
1276 warning(_("HEAD %s is not a commit!"),
1279 if (parse_commit(current_head))
1280 return error(_("could not parse HEAD commit"));
1282 *head = current_head;
1288 * Try to commit without forking 'git commit'. In some cases we need
1289 * to run 'git commit' to display an error message
1292 * -1 - error unable to commit
1294 * 1 - run 'git commit'
1296 static int try_to_commit(struct repository *r,
1297 struct strbuf *msg, const char *author,
1298 struct replay_opts *opts, unsigned int flags,
1299 struct object_id *oid)
1301 struct object_id tree;
1302 struct commit *current_head = NULL;
1303 struct commit_list *parents = NULL;
1304 struct commit_extra_header *extra = NULL;
1305 struct strbuf err = STRBUF_INIT;
1306 struct strbuf commit_msg = STRBUF_INIT;
1307 char *amend_author = NULL;
1308 const char *hook_commit = NULL;
1309 enum commit_msg_cleanup_mode cleanup;
1312 if (parse_head(r, ¤t_head))
1315 if (flags & AMEND_MSG) {
1316 const char *exclude_gpgsig[] = { "gpgsig", NULL };
1317 const char *out_enc = get_commit_output_encoding();
1318 const char *message = logmsg_reencode(current_head, NULL,
1322 const char *orig_message = NULL;
1324 find_commit_subject(message, &orig_message);
1326 strbuf_addstr(msg, orig_message);
1327 hook_commit = "HEAD";
1329 author = amend_author = get_author(message);
1330 unuse_commit_buffer(current_head, message);
1332 res = error(_("unable to parse commit author"));
1335 parents = copy_commit_list(current_head->parents);
1336 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1337 } else if (current_head &&
1338 (!(flags & CREATE_ROOT_COMMIT) || (flags & AMEND_MSG))) {
1339 commit_list_insert(current_head, &parents);
1342 if (write_index_as_tree(&tree, r->index, r->index_file, 0, NULL)) {
1343 res = error(_("git write-tree failed to write a tree"));
1347 if (!(flags & ALLOW_EMPTY)) {
1348 struct commit *first_parent = current_head;
1350 if (flags & AMEND_MSG) {
1351 if (current_head->parents) {
1352 first_parent = current_head->parents->item;
1353 if (repo_parse_commit(r, first_parent)) {
1354 res = error(_("could not parse HEAD commit"));
1358 first_parent = NULL;
1361 if (oideq(first_parent
1362 ? get_commit_tree_oid(first_parent)
1363 : the_hash_algo->empty_tree,
1365 res = 1; /* run 'git commit' to display error message */
1370 if (find_hook("prepare-commit-msg")) {
1371 res = run_prepare_commit_msg_hook(r, msg, hook_commit);
1374 if (strbuf_read_file(&commit_msg, git_path_commit_editmsg(),
1376 res = error_errno(_("unable to read commit message "
1378 git_path_commit_editmsg());
1384 if (flags & CLEANUP_MSG)
1385 cleanup = COMMIT_MSG_CLEANUP_ALL;
1386 else if ((opts->signoff || opts->record_origin) &&
1387 !opts->explicit_cleanup)
1388 cleanup = COMMIT_MSG_CLEANUP_SPACE;
1390 cleanup = opts->default_msg_cleanup;
1392 if (cleanup != COMMIT_MSG_CLEANUP_NONE)
1393 strbuf_stripspace(msg, cleanup == COMMIT_MSG_CLEANUP_ALL);
1394 if ((flags & EDIT_MSG) && message_is_empty(msg, cleanup)) {
1395 res = 1; /* run 'git commit' to display error message */
1401 if (commit_tree_extended(msg->buf, msg->len, &tree, parents,
1402 oid, author, opts->gpg_sign, extra)) {
1403 res = error(_("failed to write commit object"));
1407 if (update_head_with_reflog(current_head, oid,
1408 getenv("GIT_REFLOG_ACTION"), msg, &err)) {
1409 res = error("%s", err.buf);
1413 run_commit_hook(0, r->index_file, "post-commit", NULL);
1414 if (flags & AMEND_MSG)
1415 commit_post_rewrite(r, current_head, oid);
1418 free_commit_extra_headers(extra);
1419 strbuf_release(&err);
1420 strbuf_release(&commit_msg);
1426 static int do_commit(struct repository *r,
1427 const char *msg_file, const char *author,
1428 struct replay_opts *opts, unsigned int flags)
1432 if (!(flags & EDIT_MSG) && !(flags & VERIFY_MSG)) {
1433 struct object_id oid;
1434 struct strbuf sb = STRBUF_INIT;
1436 if (msg_file && strbuf_read_file(&sb, msg_file, 2048) < 0)
1437 return error_errno(_("unable to read commit message "
1441 res = try_to_commit(r, msg_file ? &sb : NULL,
1442 author, opts, flags, &oid);
1443 strbuf_release(&sb);
1445 unlink(git_path_cherry_pick_head(r));
1446 unlink(git_path_merge_msg(r));
1447 if (!is_rebase_i(opts))
1448 print_commit_summary(r, NULL, &oid,
1449 SUMMARY_SHOW_AUTHOR_DATE);
1454 return run_git_commit(r, msg_file, opts, flags);
1459 static int is_original_commit_empty(struct commit *commit)
1461 const struct object_id *ptree_oid;
1463 if (parse_commit(commit))
1464 return error(_("could not parse commit %s"),
1465 oid_to_hex(&commit->object.oid));
1466 if (commit->parents) {
1467 struct commit *parent = commit->parents->item;
1468 if (parse_commit(parent))
1469 return error(_("could not parse parent commit %s"),
1470 oid_to_hex(&parent->object.oid));
1471 ptree_oid = get_commit_tree_oid(parent);
1473 ptree_oid = the_hash_algo->empty_tree; /* commit is root */
1476 return oideq(ptree_oid, get_commit_tree_oid(commit));
1480 * Should empty commits be allowed? Return status:
1481 * <0: Error in is_index_unchanged(r) or is_original_commit_empty(commit)
1482 * 0: Halt on empty commit
1483 * 1: Allow empty commit
1484 * 2: Drop empty commit
1486 static int allow_empty(struct repository *r,
1487 struct replay_opts *opts,
1488 struct commit *commit)
1490 int index_unchanged, originally_empty;
1495 * (1) we do not allow empty at all and error out.
1497 * (2) we allow ones that were initially empty, and
1498 * just drop the ones that become empty
1500 * (3) we allow ones that were initially empty, but
1501 * halt for the ones that become empty;
1503 * (4) we allow both.
1505 if (!opts->allow_empty)
1506 return 0; /* let "git commit" barf as necessary */
1508 index_unchanged = is_index_unchanged(r);
1509 if (index_unchanged < 0)
1510 return index_unchanged;
1511 if (!index_unchanged)
1512 return 0; /* we do not have to say --allow-empty */
1514 if (opts->keep_redundant_commits)
1517 originally_empty = is_original_commit_empty(commit);
1518 if (originally_empty < 0)
1519 return originally_empty;
1520 if (originally_empty)
1522 else if (opts->drop_redundant_commits)
1531 } todo_command_info[] = {
1548 static const char *command_to_string(const enum todo_command command)
1550 if (command < TODO_COMMENT)
1551 return todo_command_info[command].str;
1552 die(_("unknown command: %d"), command);
1555 static char command_to_char(const enum todo_command command)
1557 if (command < TODO_COMMENT && todo_command_info[command].c)
1558 return todo_command_info[command].c;
1559 return comment_line_char;
1562 static int is_noop(const enum todo_command command)
1564 return TODO_NOOP <= command;
1567 static int is_fixup(enum todo_command command)
1569 return command == TODO_FIXUP || command == TODO_SQUASH;
1572 /* Does this command create a (non-merge) commit? */
1573 static int is_pick_or_similar(enum todo_command command)
1588 static int update_squash_messages(struct repository *r,
1589 enum todo_command command,
1590 struct commit *commit,
1591 struct replay_opts *opts)
1593 struct strbuf buf = STRBUF_INIT;
1595 const char *message, *body;
1596 const char *encoding = get_commit_output_encoding();
1598 if (opts->current_fixup_count > 0) {
1599 struct strbuf header = STRBUF_INIT;
1602 if (strbuf_read_file(&buf, rebase_path_squash_msg(), 9) <= 0)
1603 return error(_("could not read '%s'"),
1604 rebase_path_squash_msg());
1606 eol = buf.buf[0] != comment_line_char ?
1607 buf.buf : strchrnul(buf.buf, '\n');
1609 strbuf_addf(&header, "%c ", comment_line_char);
1610 strbuf_addf(&header, _("This is a combination of %d commits."),
1611 opts->current_fixup_count + 2);
1612 strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
1613 strbuf_release(&header);
1615 struct object_id head;
1616 struct commit *head_commit;
1617 const char *head_message, *body;
1619 if (get_oid("HEAD", &head))
1620 return error(_("need a HEAD to fixup"));
1621 if (!(head_commit = lookup_commit_reference(r, &head)))
1622 return error(_("could not read HEAD"));
1623 if (!(head_message = logmsg_reencode(head_commit, NULL, encoding)))
1624 return error(_("could not read HEAD's commit message"));
1626 find_commit_subject(head_message, &body);
1627 if (write_message(body, strlen(body),
1628 rebase_path_fixup_msg(), 0)) {
1629 unuse_commit_buffer(head_commit, head_message);
1630 return error(_("cannot write '%s'"),
1631 rebase_path_fixup_msg());
1634 strbuf_addf(&buf, "%c ", comment_line_char);
1635 strbuf_addf(&buf, _("This is a combination of %d commits."), 2);
1636 strbuf_addf(&buf, "\n%c ", comment_line_char);
1637 strbuf_addstr(&buf, _("This is the 1st commit message:"));
1638 strbuf_addstr(&buf, "\n\n");
1639 strbuf_addstr(&buf, body);
1641 unuse_commit_buffer(head_commit, head_message);
1644 if (!(message = logmsg_reencode(commit, NULL, encoding)))
1645 return error(_("could not read commit message of %s"),
1646 oid_to_hex(&commit->object.oid));
1647 find_commit_subject(message, &body);
1649 if (command == TODO_SQUASH) {
1650 unlink(rebase_path_fixup_msg());
1651 strbuf_addf(&buf, "\n%c ", comment_line_char);
1652 strbuf_addf(&buf, _("This is the commit message #%d:"),
1653 ++opts->current_fixup_count + 1);
1654 strbuf_addstr(&buf, "\n\n");
1655 strbuf_addstr(&buf, body);
1656 } else if (command == TODO_FIXUP) {
1657 strbuf_addf(&buf, "\n%c ", comment_line_char);
1658 strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
1659 ++opts->current_fixup_count + 1);
1660 strbuf_addstr(&buf, "\n\n");
1661 strbuf_add_commented_lines(&buf, body, strlen(body));
1663 return error(_("unknown command: %d"), command);
1664 unuse_commit_buffer(commit, message);
1666 res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
1667 strbuf_release(&buf);
1670 strbuf_addf(&opts->current_fixups, "%s%s %s",
1671 opts->current_fixups.len ? "\n" : "",
1672 command_to_string(command),
1673 oid_to_hex(&commit->object.oid));
1674 res = write_message(opts->current_fixups.buf,
1675 opts->current_fixups.len,
1676 rebase_path_current_fixups(), 0);
1682 static void flush_rewritten_pending(void)
1684 struct strbuf buf = STRBUF_INIT;
1685 struct object_id newoid;
1688 if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), (GIT_MAX_HEXSZ + 1) * 2) > 0 &&
1689 !get_oid("HEAD", &newoid) &&
1690 (out = fopen_or_warn(rebase_path_rewritten_list(), "a"))) {
1691 char *bol = buf.buf, *eol;
1694 eol = strchrnul(bol, '\n');
1695 fprintf(out, "%.*s %s\n", (int)(eol - bol),
1696 bol, oid_to_hex(&newoid));
1702 unlink(rebase_path_rewritten_pending());
1704 strbuf_release(&buf);
1707 static void record_in_rewritten(struct object_id *oid,
1708 enum todo_command next_command)
1710 FILE *out = fopen_or_warn(rebase_path_rewritten_pending(), "a");
1715 fprintf(out, "%s\n", oid_to_hex(oid));
1718 if (!is_fixup(next_command))
1719 flush_rewritten_pending();
1722 static int do_pick_commit(struct repository *r,
1723 enum todo_command command,
1724 struct commit *commit,
1725 struct replay_opts *opts,
1726 int final_fixup, int *check_todo)
1728 unsigned int flags = opts->edit ? EDIT_MSG : 0;
1729 const char *msg_file = opts->edit ? NULL : git_path_merge_msg(r);
1730 struct object_id head;
1731 struct commit *base, *next, *parent;
1732 const char *base_label, *next_label;
1733 char *author = NULL;
1734 struct commit_message msg = { NULL, NULL, NULL, NULL };
1735 struct strbuf msgbuf = STRBUF_INIT;
1736 int res, unborn = 0, reword = 0, allow, drop_commit;
1738 if (opts->no_commit) {
1740 * We do not intend to commit immediately. We just want to
1741 * merge the differences in, so let's compute the tree
1742 * that represents the "current" state for merge-recursive
1745 if (write_index_as_tree(&head, r->index, r->index_file, 0, NULL))
1746 return error(_("your index file is unmerged."));
1748 unborn = get_oid("HEAD", &head);
1749 /* Do we want to generate a root commit? */
1750 if (is_pick_or_similar(command) && opts->have_squash_onto &&
1751 oideq(&head, &opts->squash_onto)) {
1752 if (is_fixup(command))
1753 return error(_("cannot fixup root commit"));
1754 flags |= CREATE_ROOT_COMMIT;
1757 oidcpy(&head, the_hash_algo->empty_tree);
1758 if (index_differs_from(r, unborn ? empty_tree_oid_hex() : "HEAD",
1760 return error_dirty_index(r, opts);
1762 discard_index(r->index);
1764 if (!commit->parents)
1766 else if (commit->parents->next) {
1767 /* Reverting or cherry-picking a merge commit */
1769 struct commit_list *p;
1771 if (!opts->mainline)
1772 return error(_("commit %s is a merge but no -m option was given."),
1773 oid_to_hex(&commit->object.oid));
1775 for (cnt = 1, p = commit->parents;
1776 cnt != opts->mainline && p;
1779 if (cnt != opts->mainline || !p)
1780 return error(_("commit %s does not have parent %d"),
1781 oid_to_hex(&commit->object.oid), opts->mainline);
1783 } else if (1 < opts->mainline)
1785 * Non-first parent explicitly specified as mainline for
1788 return error(_("commit %s does not have parent %d"),
1789 oid_to_hex(&commit->object.oid), opts->mainline);
1791 parent = commit->parents->item;
1793 if (get_message(commit, &msg) != 0)
1794 return error(_("cannot get commit message for %s"),
1795 oid_to_hex(&commit->object.oid));
1797 if (opts->allow_ff && !is_fixup(command) &&
1798 ((parent && oideq(&parent->object.oid, &head)) ||
1799 (!parent && unborn))) {
1800 if (is_rebase_i(opts))
1801 write_author_script(msg.message);
1802 res = fast_forward_to(r, &commit->object.oid, &head, unborn,
1804 if (res || command != TODO_REWORD)
1808 goto fast_forward_edit;
1810 if (parent && parse_commit(parent) < 0)
1811 /* TRANSLATORS: The first %s will be a "todo" command like
1812 "revert" or "pick", the second %s a SHA1. */
1813 return error(_("%s: cannot parse parent commit %s"),
1814 command_to_string(command),
1815 oid_to_hex(&parent->object.oid));
1818 * "commit" is an existing commit. We would want to apply
1819 * the difference it introduces since its first parent "prev"
1820 * on top of the current HEAD if we are cherry-pick. Or the
1821 * reverse of it if we are revert.
1824 if (command == TODO_REVERT) {
1826 base_label = msg.label;
1828 next_label = msg.parent_label;
1829 strbuf_addstr(&msgbuf, "Revert \"");
1830 strbuf_addstr(&msgbuf, msg.subject);
1831 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
1832 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1834 if (commit->parents && commit->parents->next) {
1835 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
1836 strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
1838 strbuf_addstr(&msgbuf, ".\n");
1843 base_label = msg.parent_label;
1845 next_label = msg.label;
1847 /* Append the commit log message to msgbuf. */
1848 if (find_commit_subject(msg.message, &p))
1849 strbuf_addstr(&msgbuf, p);
1851 if (opts->record_origin) {
1852 strbuf_complete_line(&msgbuf);
1853 if (!has_conforming_footer(&msgbuf, NULL, 0))
1854 strbuf_addch(&msgbuf, '\n');
1855 strbuf_addstr(&msgbuf, cherry_picked_prefix);
1856 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1857 strbuf_addstr(&msgbuf, ")\n");
1859 if (!is_fixup(command))
1860 author = get_author(msg.message);
1863 if (command == TODO_REWORD)
1865 else if (is_fixup(command)) {
1866 if (update_squash_messages(r, command, commit, opts))
1870 msg_file = rebase_path_squash_msg();
1871 else if (file_exists(rebase_path_fixup_msg())) {
1872 flags |= CLEANUP_MSG;
1873 msg_file = rebase_path_fixup_msg();
1875 const char *dest = git_path_squash_msg(r);
1877 if (copy_file(dest, rebase_path_squash_msg(), 0666))
1878 return error(_("could not rename '%s' to '%s'"),
1879 rebase_path_squash_msg(), dest);
1880 unlink(git_path_merge_msg(r));
1886 if (opts->signoff && !is_fixup(command))
1887 append_signoff(&msgbuf, 0, 0);
1889 if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
1891 else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
1892 res = do_recursive_merge(r, base, next, base_label, next_label,
1893 &head, &msgbuf, opts);
1897 res |= write_message(msgbuf.buf, msgbuf.len,
1898 git_path_merge_msg(r), 0);
1900 struct commit_list *common = NULL;
1901 struct commit_list *remotes = NULL;
1903 res = write_message(msgbuf.buf, msgbuf.len,
1904 git_path_merge_msg(r), 0);
1906 commit_list_insert(base, &common);
1907 commit_list_insert(next, &remotes);
1908 res |= try_merge_command(r, opts->strategy,
1909 opts->xopts_nr, (const char **)opts->xopts,
1910 common, oid_to_hex(&head), remotes);
1911 free_commit_list(common);
1912 free_commit_list(remotes);
1914 strbuf_release(&msgbuf);
1917 * If the merge was clean or if it failed due to conflict, we write
1918 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
1919 * However, if the merge did not even start, then we don't want to
1922 if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
1923 update_ref(NULL, "CHERRY_PICK_HEAD", &commit->object.oid, NULL,
1924 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1926 if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
1927 update_ref(NULL, "REVERT_HEAD", &commit->object.oid, NULL,
1928 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1932 error(command == TODO_REVERT
1933 ? _("could not revert %s... %s")
1934 : _("could not apply %s... %s"),
1935 short_commit_name(commit), msg.subject);
1936 print_advice(r, res == 1, opts);
1937 repo_rerere(r, opts->allow_rerere_auto);
1942 allow = allow_empty(r, opts, commit);
1946 } else if (allow == 1) {
1947 flags |= ALLOW_EMPTY;
1948 } else if (allow == 2) {
1950 unlink(git_path_cherry_pick_head(r));
1951 unlink(git_path_merge_msg(r));
1953 _("dropping %s %s -- patch contents already upstream\n"),
1954 oid_to_hex(&commit->object.oid), msg.subject);
1955 } /* else allow == 0 and there's nothing special to do */
1956 if (!opts->no_commit && !drop_commit) {
1957 if (author || command == TODO_REVERT || (flags & AMEND_MSG))
1958 res = do_commit(r, msg_file, author, opts, flags);
1960 res = error(_("unable to parse commit author"));
1961 *check_todo = !!(flags & EDIT_MSG);
1962 if (!res && reword) {
1964 res = run_git_commit(r, NULL, opts, EDIT_MSG |
1965 VERIFY_MSG | AMEND_MSG |
1966 (flags & ALLOW_EMPTY));
1972 if (!res && final_fixup) {
1973 unlink(rebase_path_fixup_msg());
1974 unlink(rebase_path_squash_msg());
1975 unlink(rebase_path_current_fixups());
1976 strbuf_reset(&opts->current_fixups);
1977 opts->current_fixup_count = 0;
1981 free_message(commit, &msg);
1983 update_abort_safety_file();
1988 static int prepare_revs(struct replay_opts *opts)
1991 * picking (but not reverting) ranges (but not individual revisions)
1992 * should be done in reverse
1994 if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
1995 opts->revs->reverse ^= 1;
1997 if (prepare_revision_walk(opts->revs))
1998 return error(_("revision walk setup failed"));
2003 static int read_and_refresh_cache(struct repository *r,
2004 struct replay_opts *opts)
2006 struct lock_file index_lock = LOCK_INIT;
2007 int index_fd = repo_hold_locked_index(r, &index_lock, 0);
2008 if (repo_read_index(r) < 0) {
2009 rollback_lock_file(&index_lock);
2010 return error(_("git %s: failed to read the index"),
2011 _(action_name(opts)));
2013 refresh_index(r->index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
2014 if (index_fd >= 0) {
2015 if (write_locked_index(r->index, &index_lock,
2016 COMMIT_LOCK | SKIP_IF_UNCHANGED)) {
2017 return error(_("git %s: failed to refresh the index"),
2018 _(action_name(opts)));
2024 enum todo_item_flags {
2025 TODO_EDIT_MERGE_MSG = 1
2028 void todo_list_release(struct todo_list *todo_list)
2030 strbuf_release(&todo_list->buf);
2031 FREE_AND_NULL(todo_list->items);
2032 todo_list->nr = todo_list->alloc = 0;
2035 static struct todo_item *append_new_todo(struct todo_list *todo_list)
2037 ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
2038 todo_list->total_nr++;
2039 return todo_list->items + todo_list->nr++;
2042 const char *todo_item_get_arg(struct todo_list *todo_list,
2043 struct todo_item *item)
2045 return todo_list->buf.buf + item->arg_offset;
2048 static int is_command(enum todo_command command, const char **bol)
2050 const char *str = todo_command_info[command].str;
2051 const char nick = todo_command_info[command].c;
2052 const char *p = *bol + 1;
2054 return skip_prefix(*bol, str, bol) ||
2055 ((nick && **bol == nick) &&
2056 (*p == ' ' || *p == '\t' || *p == '\n' || *p == '\r' || !*p) &&
2060 static int parse_insn_line(struct repository *r, struct todo_item *item,
2061 const char *buf, const char *bol, char *eol)
2063 struct object_id commit_oid;
2064 char *end_of_object_name;
2065 int i, saved, status, padding;
2070 bol += strspn(bol, " \t");
2072 if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
2073 item->command = TODO_COMMENT;
2074 item->commit = NULL;
2075 item->arg_offset = bol - buf;
2076 item->arg_len = eol - bol;
2080 for (i = 0; i < TODO_COMMENT; i++)
2081 if (is_command(i, &bol)) {
2085 if (i >= TODO_COMMENT)
2088 /* Eat up extra spaces/ tabs before object name */
2089 padding = strspn(bol, " \t");
2092 if (item->command == TODO_NOOP || item->command == TODO_BREAK) {
2094 return error(_("%s does not accept arguments: '%s'"),
2095 command_to_string(item->command), bol);
2096 item->commit = NULL;
2097 item->arg_offset = bol - buf;
2098 item->arg_len = eol - bol;
2103 return error(_("missing arguments for %s"),
2104 command_to_string(item->command));
2106 if (item->command == TODO_EXEC || item->command == TODO_LABEL ||
2107 item->command == TODO_RESET) {
2108 item->commit = NULL;
2109 item->arg_offset = bol - buf;
2110 item->arg_len = (int)(eol - bol);
2114 if (item->command == TODO_MERGE) {
2115 if (skip_prefix(bol, "-C", &bol))
2116 bol += strspn(bol, " \t");
2117 else if (skip_prefix(bol, "-c", &bol)) {
2118 bol += strspn(bol, " \t");
2119 item->flags |= TODO_EDIT_MERGE_MSG;
2121 item->flags |= TODO_EDIT_MERGE_MSG;
2122 item->commit = NULL;
2123 item->arg_offset = bol - buf;
2124 item->arg_len = (int)(eol - bol);
2129 end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
2130 saved = *end_of_object_name;
2131 *end_of_object_name = '\0';
2132 status = get_oid(bol, &commit_oid);
2134 error(_("could not parse '%s'"), bol); /* return later */
2135 *end_of_object_name = saved;
2137 bol = end_of_object_name + strspn(end_of_object_name, " \t");
2138 item->arg_offset = bol - buf;
2139 item->arg_len = (int)(eol - bol);
2144 item->commit = lookup_commit_reference(r, &commit_oid);
2145 return item->commit ? 0 : -1;
2148 int sequencer_get_last_command(struct repository *r, enum replay_action *action)
2150 const char *todo_file, *bol;
2151 struct strbuf buf = STRBUF_INIT;
2154 todo_file = git_path_todo_file();
2155 if (strbuf_read_file(&buf, todo_file, 0) < 0) {
2156 if (errno == ENOENT || errno == ENOTDIR)
2159 return error_errno("unable to open '%s'", todo_file);
2161 bol = buf.buf + strspn(buf.buf, " \t\r\n");
2162 if (is_command(TODO_PICK, &bol) && (*bol == ' ' || *bol == '\t'))
2163 *action = REPLAY_PICK;
2164 else if (is_command(TODO_REVERT, &bol) &&
2165 (*bol == ' ' || *bol == '\t'))
2166 *action = REPLAY_REVERT;
2170 strbuf_release(&buf);
2175 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
2176 struct todo_list *todo_list)
2178 struct todo_item *item;
2179 char *p = buf, *next_p;
2180 int i, res = 0, fixup_okay = file_exists(rebase_path_done());
2182 todo_list->current = todo_list->nr = 0;
2184 for (i = 1; *p; i++, p = next_p) {
2185 char *eol = strchrnul(p, '\n');
2187 next_p = *eol ? eol + 1 /* skip LF */ : eol;
2189 if (p != eol && eol[-1] == '\r')
2190 eol--; /* strip Carriage Return */
2192 item = append_new_todo(todo_list);
2193 item->offset_in_buf = p - todo_list->buf.buf;
2194 if (parse_insn_line(r, item, buf, p, eol)) {
2195 res = error(_("invalid line %d: %.*s"),
2196 i, (int)(eol - p), p);
2197 item->command = TODO_COMMENT + 1;
2198 item->arg_offset = p - buf;
2199 item->arg_len = (int)(eol - p);
2200 item->commit = NULL;
2205 else if (is_fixup(item->command))
2206 return error(_("cannot '%s' without a previous commit"),
2207 command_to_string(item->command));
2208 else if (!is_noop(item->command))
2215 static int count_commands(struct todo_list *todo_list)
2219 for (i = 0; i < todo_list->nr; i++)
2220 if (todo_list->items[i].command != TODO_COMMENT)
2226 static int get_item_line_offset(struct todo_list *todo_list, int index)
2228 return index < todo_list->nr ?
2229 todo_list->items[index].offset_in_buf : todo_list->buf.len;
2232 static const char *get_item_line(struct todo_list *todo_list, int index)
2234 return todo_list->buf.buf + get_item_line_offset(todo_list, index);
2237 static int get_item_line_length(struct todo_list *todo_list, int index)
2239 return get_item_line_offset(todo_list, index + 1)
2240 - get_item_line_offset(todo_list, index);
2243 static ssize_t strbuf_read_file_or_whine(struct strbuf *sb, const char *path)
2248 fd = open(path, O_RDONLY);
2250 return error_errno(_("could not open '%s'"), path);
2251 len = strbuf_read(sb, fd, 0);
2254 return error(_("could not read '%s'."), path);
2258 static int have_finished_the_last_pick(void)
2260 struct strbuf buf = STRBUF_INIT;
2262 const char *todo_path = git_path_todo_file();
2265 if (strbuf_read_file(&buf, todo_path, 0) < 0) {
2266 if (errno == ENOENT) {
2269 error_errno("unable to open '%s'", todo_path);
2273 /* If there is only one line then we are done */
2274 eol = strchr(buf.buf, '\n');
2275 if (!eol || !eol[1])
2278 strbuf_release(&buf);
2283 void sequencer_post_commit_cleanup(struct repository *r, int verbose)
2285 struct replay_opts opts = REPLAY_OPTS_INIT;
2286 int need_cleanup = 0;
2288 if (file_exists(git_path_cherry_pick_head(r))) {
2289 if (!unlink(git_path_cherry_pick_head(r)) && verbose)
2290 warning(_("cancelling a cherry picking in progress"));
2291 opts.action = REPLAY_PICK;
2295 if (file_exists(git_path_revert_head(r))) {
2296 if (!unlink(git_path_revert_head(r)) && verbose)
2297 warning(_("cancelling a revert in progress"));
2298 opts.action = REPLAY_REVERT;
2305 if (!have_finished_the_last_pick())
2308 sequencer_remove_state(&opts);
2311 static void todo_list_write_total_nr(struct todo_list *todo_list)
2313 FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
2316 fprintf(f, "%d\n", todo_list->total_nr);
2321 static int read_populate_todo(struct repository *r,
2322 struct todo_list *todo_list,
2323 struct replay_opts *opts)
2326 const char *todo_file = get_todo_path(opts);
2329 strbuf_reset(&todo_list->buf);
2330 if (strbuf_read_file_or_whine(&todo_list->buf, todo_file) < 0)
2333 res = stat(todo_file, &st);
2335 return error(_("could not stat '%s'"), todo_file);
2336 fill_stat_data(&todo_list->stat, &st);
2338 res = todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
2340 if (is_rebase_i(opts))
2341 return error(_("please fix this using "
2342 "'git rebase --edit-todo'."));
2343 return error(_("unusable instruction sheet: '%s'"), todo_file);
2346 if (!todo_list->nr &&
2347 (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
2348 return error(_("no commits parsed."));
2350 if (!is_rebase_i(opts)) {
2351 enum todo_command valid =
2352 opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
2355 for (i = 0; i < todo_list->nr; i++)
2356 if (valid == todo_list->items[i].command)
2358 else if (valid == TODO_PICK)
2359 return error(_("cannot cherry-pick during a revert."));
2361 return error(_("cannot revert during a cherry-pick."));
2364 if (is_rebase_i(opts)) {
2365 struct todo_list done = TODO_LIST_INIT;
2367 if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
2368 !todo_list_parse_insn_buffer(r, done.buf.buf, &done))
2369 todo_list->done_nr = count_commands(&done);
2371 todo_list->done_nr = 0;
2373 todo_list->total_nr = todo_list->done_nr
2374 + count_commands(todo_list);
2375 todo_list_release(&done);
2377 todo_list_write_total_nr(todo_list);
2383 static int git_config_string_dup(char **dest,
2384 const char *var, const char *value)
2387 return config_error_nonbool(var);
2389 *dest = xstrdup(value);
2393 static int populate_opts_cb(const char *key, const char *value, void *data)
2395 struct replay_opts *opts = data;
2400 else if (!strcmp(key, "options.no-commit"))
2401 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
2402 else if (!strcmp(key, "options.edit"))
2403 opts->edit = git_config_bool_or_int(key, value, &error_flag);
2404 else if (!strcmp(key, "options.allow-empty"))
2406 git_config_bool_or_int(key, value, &error_flag);
2407 else if (!strcmp(key, "options.allow-empty-message"))
2408 opts->allow_empty_message =
2409 git_config_bool_or_int(key, value, &error_flag);
2410 else if (!strcmp(key, "options.keep-redundant-commits"))
2411 opts->keep_redundant_commits =
2412 git_config_bool_or_int(key, value, &error_flag);
2413 else if (!strcmp(key, "options.signoff"))
2414 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
2415 else if (!strcmp(key, "options.record-origin"))
2416 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
2417 else if (!strcmp(key, "options.allow-ff"))
2418 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
2419 else if (!strcmp(key, "options.mainline"))
2420 opts->mainline = git_config_int(key, value);
2421 else if (!strcmp(key, "options.strategy"))
2422 git_config_string_dup(&opts->strategy, key, value);
2423 else if (!strcmp(key, "options.gpg-sign"))
2424 git_config_string_dup(&opts->gpg_sign, key, value);
2425 else if (!strcmp(key, "options.strategy-option")) {
2426 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
2427 opts->xopts[opts->xopts_nr++] = xstrdup(value);
2428 } else if (!strcmp(key, "options.allow-rerere-auto"))
2429 opts->allow_rerere_auto =
2430 git_config_bool_or_int(key, value, &error_flag) ?
2431 RERERE_AUTOUPDATE : RERERE_NOAUTOUPDATE;
2432 else if (!strcmp(key, "options.default-msg-cleanup")) {
2433 opts->explicit_cleanup = 1;
2434 opts->default_msg_cleanup = get_cleanup_mode(value, 1);
2436 return error(_("invalid key: %s"), key);
2439 return error(_("invalid value for %s: %s"), key, value);
2444 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts)
2447 char *strategy_opts_string = raw_opts;
2449 if (*strategy_opts_string == ' ')
2450 strategy_opts_string++;
2452 opts->xopts_nr = split_cmdline(strategy_opts_string,
2453 (const char ***)&opts->xopts);
2454 for (i = 0; i < opts->xopts_nr; i++) {
2455 const char *arg = opts->xopts[i];
2457 skip_prefix(arg, "--", &arg);
2458 opts->xopts[i] = xstrdup(arg);
2462 static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
2465 if (!read_oneliner(buf, rebase_path_strategy(), 0))
2467 opts->strategy = strbuf_detach(buf, NULL);
2468 if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
2471 parse_strategy_opts(opts, buf->buf);
2474 static int read_populate_opts(struct replay_opts *opts)
2476 if (is_rebase_i(opts)) {
2477 struct strbuf buf = STRBUF_INIT;
2480 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(),
2481 READ_ONELINER_SKIP_IF_EMPTY)) {
2482 if (!starts_with(buf.buf, "-S"))
2485 free(opts->gpg_sign);
2486 opts->gpg_sign = xstrdup(buf.buf + 2);
2491 if (read_oneliner(&buf, rebase_path_allow_rerere_autoupdate(),
2492 READ_ONELINER_SKIP_IF_EMPTY)) {
2493 if (!strcmp(buf.buf, "--rerere-autoupdate"))
2494 opts->allow_rerere_auto = RERERE_AUTOUPDATE;
2495 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
2496 opts->allow_rerere_auto = RERERE_NOAUTOUPDATE;
2500 if (file_exists(rebase_path_verbose()))
2503 if (file_exists(rebase_path_quiet()))
2506 if (file_exists(rebase_path_signoff())) {
2511 if (file_exists(rebase_path_reschedule_failed_exec()))
2512 opts->reschedule_failed_exec = 1;
2514 if (file_exists(rebase_path_drop_redundant_commits()))
2515 opts->drop_redundant_commits = 1;
2517 if (file_exists(rebase_path_keep_redundant_commits()))
2518 opts->keep_redundant_commits = 1;
2520 read_strategy_opts(opts, &buf);
2523 if (read_oneliner(&opts->current_fixups,
2524 rebase_path_current_fixups(),
2525 READ_ONELINER_SKIP_IF_EMPTY)) {
2526 const char *p = opts->current_fixups.buf;
2527 opts->current_fixup_count = 1;
2528 while ((p = strchr(p, '\n'))) {
2529 opts->current_fixup_count++;
2534 if (read_oneliner(&buf, rebase_path_squash_onto(), 0)) {
2535 if (get_oid_hex(buf.buf, &opts->squash_onto) < 0) {
2536 ret = error(_("unusable squash-onto"));
2539 opts->have_squash_onto = 1;
2543 strbuf_release(&buf);
2547 if (!file_exists(git_path_opts_file()))
2550 * The function git_parse_source(), called from git_config_from_file(),
2551 * may die() in case of a syntactically incorrect file. We do not care
2552 * about this case, though, because we wrote that file ourselves, so we
2553 * are pretty certain that it is syntactically correct.
2555 if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
2556 return error(_("malformed options sheet: '%s'"),
2557 git_path_opts_file());
2561 static void write_strategy_opts(struct replay_opts *opts)
2564 struct strbuf buf = STRBUF_INIT;
2566 for (i = 0; i < opts->xopts_nr; ++i)
2567 strbuf_addf(&buf, " --%s", opts->xopts[i]);
2569 write_file(rebase_path_strategy_opts(), "%s\n", buf.buf);
2570 strbuf_release(&buf);
2573 int write_basic_state(struct replay_opts *opts, const char *head_name,
2574 struct commit *onto, const char *orig_head)
2577 write_file(rebase_path_head_name(), "%s\n", head_name);
2579 write_file(rebase_path_onto(), "%s\n",
2580 oid_to_hex(&onto->object.oid));
2582 write_file(rebase_path_orig_head(), "%s\n", orig_head);
2585 write_file(rebase_path_quiet(), "%s", "");
2587 write_file(rebase_path_verbose(), "%s", "");
2589 write_file(rebase_path_strategy(), "%s\n", opts->strategy);
2590 if (opts->xopts_nr > 0)
2591 write_strategy_opts(opts);
2593 if (opts->allow_rerere_auto == RERERE_AUTOUPDATE)
2594 write_file(rebase_path_allow_rerere_autoupdate(), "--rerere-autoupdate\n");
2595 else if (opts->allow_rerere_auto == RERERE_NOAUTOUPDATE)
2596 write_file(rebase_path_allow_rerere_autoupdate(), "--no-rerere-autoupdate\n");
2599 write_file(rebase_path_gpg_sign_opt(), "-S%s\n", opts->gpg_sign);
2601 write_file(rebase_path_signoff(), "--signoff\n");
2602 if (opts->drop_redundant_commits)
2603 write_file(rebase_path_drop_redundant_commits(), "%s", "");
2604 if (opts->keep_redundant_commits)
2605 write_file(rebase_path_keep_redundant_commits(), "%s", "");
2606 if (opts->reschedule_failed_exec)
2607 write_file(rebase_path_reschedule_failed_exec(), "%s", "");
2612 static int walk_revs_populate_todo(struct todo_list *todo_list,
2613 struct replay_opts *opts)
2615 enum todo_command command = opts->action == REPLAY_PICK ?
2616 TODO_PICK : TODO_REVERT;
2617 const char *command_string = todo_command_info[command].str;
2618 const char *encoding;
2619 struct commit *commit;
2621 if (prepare_revs(opts))
2624 encoding = get_log_output_encoding();
2626 while ((commit = get_revision(opts->revs))) {
2627 struct todo_item *item = append_new_todo(todo_list);
2628 const char *commit_buffer = logmsg_reencode(commit, NULL, encoding);
2629 const char *subject;
2632 item->command = command;
2633 item->commit = commit;
2634 item->arg_offset = 0;
2636 item->offset_in_buf = todo_list->buf.len;
2637 subject_len = find_commit_subject(commit_buffer, &subject);
2638 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
2639 short_commit_name(commit), subject_len, subject);
2640 unuse_commit_buffer(commit, commit_buffer);
2644 return error(_("empty commit set passed"));
2649 static int create_seq_dir(struct repository *r)
2651 enum replay_action action;
2652 const char *in_progress_error = NULL;
2653 const char *in_progress_advice = NULL;
2654 unsigned int advise_skip = file_exists(git_path_revert_head(r)) ||
2655 file_exists(git_path_cherry_pick_head(r));
2657 if (!sequencer_get_last_command(r, &action)) {
2660 in_progress_error = _("revert is already in progress");
2661 in_progress_advice =
2662 _("try \"git revert (--continue | %s--abort | --quit)\"");
2665 in_progress_error = _("cherry-pick is already in progress");
2666 in_progress_advice =
2667 _("try \"git cherry-pick (--continue | %s--abort | --quit)\"");
2670 BUG("unexpected action in create_seq_dir");
2673 if (in_progress_error) {
2674 error("%s", in_progress_error);
2675 if (advice_sequencer_in_use)
2676 advise(in_progress_advice,
2677 advise_skip ? "--skip | " : "");
2680 if (mkdir(git_path_seq_dir(), 0777) < 0)
2681 return error_errno(_("could not create sequencer directory '%s'"),
2682 git_path_seq_dir());
2687 static int save_head(const char *head)
2689 struct lock_file head_lock = LOCK_INIT;
2690 struct strbuf buf = STRBUF_INIT;
2694 fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
2696 return error_errno(_("could not lock HEAD"));
2697 strbuf_addf(&buf, "%s\n", head);
2698 written = write_in_full(fd, buf.buf, buf.len);
2699 strbuf_release(&buf);
2701 error_errno(_("could not write to '%s'"), git_path_head_file());
2702 rollback_lock_file(&head_lock);
2705 if (commit_lock_file(&head_lock) < 0)
2706 return error(_("failed to finalize '%s'"), git_path_head_file());
2710 static int rollback_is_safe(void)
2712 struct strbuf sb = STRBUF_INIT;
2713 struct object_id expected_head, actual_head;
2715 if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
2717 if (get_oid_hex(sb.buf, &expected_head)) {
2718 strbuf_release(&sb);
2719 die(_("could not parse %s"), git_path_abort_safety_file());
2721 strbuf_release(&sb);
2723 else if (errno == ENOENT)
2724 oidclr(&expected_head);
2726 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
2728 if (get_oid("HEAD", &actual_head))
2729 oidclr(&actual_head);
2731 return oideq(&actual_head, &expected_head);
2734 static int reset_merge(const struct object_id *oid)
2737 struct argv_array argv = ARGV_ARRAY_INIT;
2739 argv_array_pushl(&argv, "reset", "--merge", NULL);
2741 if (!is_null_oid(oid))
2742 argv_array_push(&argv, oid_to_hex(oid));
2744 ret = run_command_v_opt(argv.argv, RUN_GIT_CMD);
2745 argv_array_clear(&argv);
2750 static int rollback_single_pick(struct repository *r)
2752 struct object_id head_oid;
2754 if (!file_exists(git_path_cherry_pick_head(r)) &&
2755 !file_exists(git_path_revert_head(r)))
2756 return error(_("no cherry-pick or revert in progress"));
2757 if (read_ref_full("HEAD", 0, &head_oid, NULL))
2758 return error(_("cannot resolve HEAD"));
2759 if (is_null_oid(&head_oid))
2760 return error(_("cannot abort from a branch yet to be born"));
2761 return reset_merge(&head_oid);
2764 static int skip_single_pick(void)
2766 struct object_id head;
2768 if (read_ref_full("HEAD", 0, &head, NULL))
2769 return error(_("cannot resolve HEAD"));
2770 return reset_merge(&head);
2773 int sequencer_rollback(struct repository *r, struct replay_opts *opts)
2776 struct object_id oid;
2777 struct strbuf buf = STRBUF_INIT;
2780 f = fopen(git_path_head_file(), "r");
2781 if (!f && errno == ENOENT) {
2783 * There is no multiple-cherry-pick in progress.
2784 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
2785 * a single-cherry-pick in progress, abort that.
2787 return rollback_single_pick(r);
2790 return error_errno(_("cannot open '%s'"), git_path_head_file());
2791 if (strbuf_getline_lf(&buf, f)) {
2792 error(_("cannot read '%s': %s"), git_path_head_file(),
2793 ferror(f) ? strerror(errno) : _("unexpected end of file"));
2798 if (parse_oid_hex(buf.buf, &oid, &p) || *p != '\0') {
2799 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
2800 git_path_head_file());
2803 if (is_null_oid(&oid)) {
2804 error(_("cannot abort from a branch yet to be born"));
2808 if (!rollback_is_safe()) {
2809 /* Do not error, just do not rollback */
2810 warning(_("You seem to have moved HEAD. "
2811 "Not rewinding, check your HEAD!"));
2813 if (reset_merge(&oid))
2815 strbuf_release(&buf);
2816 return sequencer_remove_state(opts);
2818 strbuf_release(&buf);
2822 int sequencer_skip(struct repository *r, struct replay_opts *opts)
2824 enum replay_action action = -1;
2825 sequencer_get_last_command(r, &action);
2828 * Check whether the subcommand requested to skip the commit is actually
2829 * in progress and that it's safe to skip the commit.
2831 * opts->action tells us which subcommand requested to skip the commit.
2832 * If the corresponding .git/<ACTION>_HEAD exists, we know that the
2833 * action is in progress and we can skip the commit.
2835 * Otherwise we check that the last instruction was related to the
2836 * particular subcommand we're trying to execute and barf if that's not
2839 * Finally we check that the rollback is "safe", i.e., has the HEAD
2840 * moved? In this case, it doesn't make sense to "reset the merge" and
2841 * "skip the commit" as the user already handled this by committing. But
2842 * we'd not want to barf here, instead give advice on how to proceed. We
2843 * only need to check that when .git/<ACTION>_HEAD doesn't exist because
2844 * it gets removed when the user commits, so if it still exists we're
2845 * sure the user can't have committed before.
2847 switch (opts->action) {
2849 if (!file_exists(git_path_revert_head(r))) {
2850 if (action != REPLAY_REVERT)
2851 return error(_("no revert in progress"));
2852 if (!rollback_is_safe())
2857 if (!file_exists(git_path_cherry_pick_head(r))) {
2858 if (action != REPLAY_PICK)
2859 return error(_("no cherry-pick in progress"));
2860 if (!rollback_is_safe())
2865 BUG("unexpected action in sequencer_skip");
2868 if (skip_single_pick())
2869 return error(_("failed to skip the commit"));
2870 if (!is_directory(git_path_seq_dir()))
2873 return sequencer_continue(r, opts);
2876 error(_("there is nothing to skip"));
2878 if (advice_resolve_conflict) {
2879 advise(_("have you committed already?\n"
2880 "try \"git %s --continue\""),
2881 action == REPLAY_REVERT ? "revert" : "cherry-pick");
2886 static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
2888 struct lock_file todo_lock = LOCK_INIT;
2889 const char *todo_path = get_todo_path(opts);
2890 int next = todo_list->current, offset, fd;
2893 * rebase -i writes "git-rebase-todo" without the currently executing
2894 * command, appending it to "done" instead.
2896 if (is_rebase_i(opts))
2899 fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
2901 return error_errno(_("could not lock '%s'"), todo_path);
2902 offset = get_item_line_offset(todo_list, next);
2903 if (write_in_full(fd, todo_list->buf.buf + offset,
2904 todo_list->buf.len - offset) < 0)
2905 return error_errno(_("could not write to '%s'"), todo_path);
2906 if (commit_lock_file(&todo_lock) < 0)
2907 return error(_("failed to finalize '%s'"), todo_path);
2909 if (is_rebase_i(opts) && next > 0) {
2910 const char *done = rebase_path_done();
2911 int fd = open(done, O_CREAT | O_WRONLY | O_APPEND, 0666);
2916 if (write_in_full(fd, get_item_line(todo_list, next - 1),
2917 get_item_line_length(todo_list, next - 1))
2919 ret = error_errno(_("could not write to '%s'"), done);
2921 ret = error_errno(_("failed to finalize '%s'"), done);
2927 static int save_opts(struct replay_opts *opts)
2929 const char *opts_file = git_path_opts_file();
2932 if (opts->no_commit)
2933 res |= git_config_set_in_file_gently(opts_file,
2934 "options.no-commit", "true");
2936 res |= git_config_set_in_file_gently(opts_file,
2937 "options.edit", "true");
2938 if (opts->allow_empty)
2939 res |= git_config_set_in_file_gently(opts_file,
2940 "options.allow-empty", "true");
2941 if (opts->allow_empty_message)
2942 res |= git_config_set_in_file_gently(opts_file,
2943 "options.allow-empty-message", "true");
2944 if (opts->keep_redundant_commits)
2945 res |= git_config_set_in_file_gently(opts_file,
2946 "options.keep-redundant-commits", "true");
2948 res |= git_config_set_in_file_gently(opts_file,
2949 "options.signoff", "true");
2950 if (opts->record_origin)
2951 res |= git_config_set_in_file_gently(opts_file,
2952 "options.record-origin", "true");
2954 res |= git_config_set_in_file_gently(opts_file,
2955 "options.allow-ff", "true");
2956 if (opts->mainline) {
2957 struct strbuf buf = STRBUF_INIT;
2958 strbuf_addf(&buf, "%d", opts->mainline);
2959 res |= git_config_set_in_file_gently(opts_file,
2960 "options.mainline", buf.buf);
2961 strbuf_release(&buf);
2964 res |= git_config_set_in_file_gently(opts_file,
2965 "options.strategy", opts->strategy);
2967 res |= git_config_set_in_file_gently(opts_file,
2968 "options.gpg-sign", opts->gpg_sign);
2971 for (i = 0; i < opts->xopts_nr; i++)
2972 res |= git_config_set_multivar_in_file_gently(opts_file,
2973 "options.strategy-option",
2974 opts->xopts[i], "^$", 0);
2976 if (opts->allow_rerere_auto)
2977 res |= git_config_set_in_file_gently(opts_file,
2978 "options.allow-rerere-auto",
2979 opts->allow_rerere_auto == RERERE_AUTOUPDATE ?
2982 if (opts->explicit_cleanup)
2983 res |= git_config_set_in_file_gently(opts_file,
2984 "options.default-msg-cleanup",
2985 describe_cleanup_mode(opts->default_msg_cleanup));
2989 static int make_patch(struct repository *r,
2990 struct commit *commit,
2991 struct replay_opts *opts)
2993 struct strbuf buf = STRBUF_INIT;
2994 struct rev_info log_tree_opt;
2995 const char *subject, *p;
2998 p = short_commit_name(commit);
2999 if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
3001 if (update_ref("rebase", "REBASE_HEAD", &commit->object.oid,
3002 NULL, REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
3003 res |= error(_("could not update %s"), "REBASE_HEAD");
3005 strbuf_addf(&buf, "%s/patch", get_dir(opts));
3006 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
3007 repo_init_revisions(r, &log_tree_opt, NULL);
3008 log_tree_opt.abbrev = 0;
3009 log_tree_opt.diff = 1;
3010 log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
3011 log_tree_opt.disable_stdin = 1;
3012 log_tree_opt.no_commit_id = 1;
3013 log_tree_opt.diffopt.file = fopen(buf.buf, "w");
3014 log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
3015 if (!log_tree_opt.diffopt.file)
3016 res |= error_errno(_("could not open '%s'"), buf.buf);
3018 res |= log_tree_commit(&log_tree_opt, commit);
3019 fclose(log_tree_opt.diffopt.file);
3023 strbuf_addf(&buf, "%s/message", get_dir(opts));
3024 if (!file_exists(buf.buf)) {
3025 const char *encoding = get_commit_output_encoding();
3026 const char *commit_buffer = logmsg_reencode(commit, NULL, encoding);
3027 find_commit_subject(commit_buffer, &subject);
3028 res |= write_message(subject, strlen(subject), buf.buf, 1);
3029 unuse_commit_buffer(commit, commit_buffer);
3031 strbuf_release(&buf);
3036 static int intend_to_amend(void)
3038 struct object_id head;
3041 if (get_oid("HEAD", &head))
3042 return error(_("cannot read HEAD"));
3044 p = oid_to_hex(&head);
3045 return write_message(p, strlen(p), rebase_path_amend(), 1);
3048 static int error_with_patch(struct repository *r,
3049 struct commit *commit,
3050 const char *subject, int subject_len,
3051 struct replay_opts *opts,
3052 int exit_code, int to_amend)
3055 if (make_patch(r, commit, opts))
3057 } else if (copy_file(rebase_path_message(),
3058 git_path_merge_msg(r), 0666))
3059 return error(_("unable to copy '%s' to '%s'"),
3060 git_path_merge_msg(r), rebase_path_message());
3063 if (intend_to_amend())
3067 _("You can amend the commit now, with\n"
3069 " git commit --amend %s\n"
3071 "Once you are satisfied with your changes, run\n"
3073 " git rebase --continue\n"),
3074 gpg_sign_opt_quoted(opts));
3075 } else if (exit_code) {
3077 fprintf_ln(stderr, _("Could not apply %s... %.*s"),
3078 short_commit_name(commit), subject_len, subject);
3081 * We don't have the hash of the parent so
3082 * just print the line from the todo file.
3084 fprintf_ln(stderr, _("Could not merge %.*s"),
3085 subject_len, subject);
3091 static int error_failed_squash(struct repository *r,
3092 struct commit *commit,
3093 struct replay_opts *opts,
3095 const char *subject)
3097 if (copy_file(rebase_path_message(), rebase_path_squash_msg(), 0666))
3098 return error(_("could not copy '%s' to '%s'"),
3099 rebase_path_squash_msg(), rebase_path_message());
3100 unlink(git_path_merge_msg(r));
3101 if (copy_file(git_path_merge_msg(r), rebase_path_message(), 0666))
3102 return error(_("could not copy '%s' to '%s'"),
3103 rebase_path_message(),
3104 git_path_merge_msg(r));
3105 return error_with_patch(r, commit, subject, subject_len, opts, 1, 0);
3108 static int do_exec(struct repository *r, const char *command_line)
3110 struct argv_array child_env = ARGV_ARRAY_INIT;
3111 const char *child_argv[] = { NULL, NULL };
3114 fprintf(stderr, "Executing: %s\n", command_line);
3115 child_argv[0] = command_line;
3116 argv_array_pushf(&child_env, "GIT_DIR=%s", absolute_path(get_git_dir()));
3117 argv_array_pushf(&child_env, "GIT_WORK_TREE=%s",
3118 absolute_path(get_git_work_tree()));
3119 status = run_command_v_opt_cd_env(child_argv, RUN_USING_SHELL, NULL,
3122 /* force re-reading of the cache */
3123 if (discard_index(r->index) < 0 || repo_read_index(r) < 0)
3124 return error(_("could not read index"));
3126 dirty = require_clean_work_tree(r, "rebase", NULL, 1, 1);
3129 warning(_("execution failed: %s\n%s"
3130 "You can fix the problem, and then run\n"
3132 " git rebase --continue\n"
3135 dirty ? N_("and made changes to the index and/or the "
3136 "working tree\n") : "");
3138 /* command not found */
3141 warning(_("execution succeeded: %s\nbut "
3142 "left changes to the index and/or the working tree\n"
3143 "Commit or stash your changes, and then run\n"
3145 " git rebase --continue\n"
3146 "\n"), command_line);
3150 argv_array_clear(&child_env);
3155 static int safe_append(const char *filename, const char *fmt, ...)
3158 struct lock_file lock = LOCK_INIT;
3159 int fd = hold_lock_file_for_update(&lock, filename,
3160 LOCK_REPORT_ON_ERROR);
3161 struct strbuf buf = STRBUF_INIT;
3166 if (strbuf_read_file(&buf, filename, 0) < 0 && errno != ENOENT) {
3167 error_errno(_("could not read '%s'"), filename);
3168 rollback_lock_file(&lock);
3171 strbuf_complete(&buf, '\n');
3173 strbuf_vaddf(&buf, fmt, ap);
3176 if (write_in_full(fd, buf.buf, buf.len) < 0) {
3177 error_errno(_("could not write to '%s'"), filename);
3178 strbuf_release(&buf);
3179 rollback_lock_file(&lock);
3182 if (commit_lock_file(&lock) < 0) {
3183 strbuf_release(&buf);
3184 rollback_lock_file(&lock);
3185 return error(_("failed to finalize '%s'"), filename);
3188 strbuf_release(&buf);
3192 static int do_label(struct repository *r, const char *name, int len)
3194 struct ref_store *refs = get_main_ref_store(r);
3195 struct ref_transaction *transaction;
3196 struct strbuf ref_name = STRBUF_INIT, err = STRBUF_INIT;
3197 struct strbuf msg = STRBUF_INIT;
3199 struct object_id head_oid;
3201 if (len == 1 && *name == '#')
3202 return error(_("illegal label name: '%.*s'"), len, name);
3204 strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
3205 strbuf_addf(&msg, "rebase (label) '%.*s'", len, name);
3207 transaction = ref_store_transaction_begin(refs, &err);
3209 error("%s", err.buf);
3211 } else if (get_oid("HEAD", &head_oid)) {
3212 error(_("could not read HEAD"));
3214 } else if (ref_transaction_update(transaction, ref_name.buf, &head_oid,
3215 NULL, 0, msg.buf, &err) < 0 ||
3216 ref_transaction_commit(transaction, &err)) {
3217 error("%s", err.buf);
3220 ref_transaction_free(transaction);
3221 strbuf_release(&err);
3222 strbuf_release(&msg);
3225 ret = safe_append(rebase_path_refs_to_delete(),
3226 "%s\n", ref_name.buf);
3227 strbuf_release(&ref_name);
3232 static const char *reflog_message(struct replay_opts *opts,
3233 const char *sub_action, const char *fmt, ...);
3235 static int do_reset(struct repository *r,
3236 const char *name, int len,
3237 struct replay_opts *opts)
3239 struct strbuf ref_name = STRBUF_INIT;
3240 struct object_id oid;
3241 struct lock_file lock = LOCK_INIT;
3242 struct tree_desc desc;
3244 struct unpack_trees_options unpack_tree_opts;
3247 if (repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0)
3250 if (len == 10 && !strncmp("[new root]", name, len)) {
3251 if (!opts->have_squash_onto) {
3253 if (commit_tree("", 0, the_hash_algo->empty_tree,
3254 NULL, &opts->squash_onto,
3256 return error(_("writing fake root commit"));
3257 opts->have_squash_onto = 1;
3258 hex = oid_to_hex(&opts->squash_onto);
3259 if (write_message(hex, strlen(hex),
3260 rebase_path_squash_onto(), 0))
3261 return error(_("writing squash-onto"));
3263 oidcpy(&oid, &opts->squash_onto);
3267 /* Determine the length of the label */
3268 for (i = 0; i < len; i++)
3269 if (isspace(name[i]))
3273 strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
3274 if (get_oid(ref_name.buf, &oid) &&
3275 get_oid(ref_name.buf + strlen("refs/rewritten/"), &oid)) {
3276 error(_("could not read '%s'"), ref_name.buf);
3277 rollback_lock_file(&lock);
3278 strbuf_release(&ref_name);
3283 memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
3284 setup_unpack_trees_porcelain(&unpack_tree_opts, "reset");
3285 unpack_tree_opts.head_idx = 1;
3286 unpack_tree_opts.src_index = r->index;
3287 unpack_tree_opts.dst_index = r->index;
3288 unpack_tree_opts.fn = oneway_merge;
3289 unpack_tree_opts.merge = 1;
3290 unpack_tree_opts.update = 1;
3292 if (repo_read_index_unmerged(r)) {
3293 rollback_lock_file(&lock);
3294 strbuf_release(&ref_name);
3295 return error_resolve_conflict(_(action_name(opts)));
3298 if (!fill_tree_descriptor(r, &desc, &oid)) {
3299 error(_("failed to find tree of %s"), oid_to_hex(&oid));
3300 rollback_lock_file(&lock);
3301 free((void *)desc.buffer);
3302 strbuf_release(&ref_name);
3306 if (unpack_trees(1, &desc, &unpack_tree_opts)) {
3307 rollback_lock_file(&lock);
3308 free((void *)desc.buffer);
3309 strbuf_release(&ref_name);
3313 tree = parse_tree_indirect(&oid);
3314 prime_cache_tree(r, r->index, tree);
3316 if (write_locked_index(r->index, &lock, COMMIT_LOCK) < 0)
3317 ret = error(_("could not write index"));
3318 free((void *)desc.buffer);
3321 ret = update_ref(reflog_message(opts, "reset", "'%.*s'",
3322 len, name), "HEAD", &oid,
3323 NULL, 0, UPDATE_REFS_MSG_ON_ERR);
3325 strbuf_release(&ref_name);
3329 static struct commit *lookup_label(const char *label, int len,
3332 struct commit *commit;
3335 strbuf_addf(buf, "refs/rewritten/%.*s", len, label);
3336 commit = lookup_commit_reference_by_name(buf->buf);
3338 /* fall back to non-rewritten ref or commit */
3339 strbuf_splice(buf, 0, strlen("refs/rewritten/"), "", 0);
3340 commit = lookup_commit_reference_by_name(buf->buf);
3344 error(_("could not resolve '%s'"), buf->buf);
3349 static int do_merge(struct repository *r,
3350 struct commit *commit,
3351 const char *arg, int arg_len,
3352 int flags, struct replay_opts *opts)
3354 int run_commit_flags = (flags & TODO_EDIT_MERGE_MSG) ?
3355 EDIT_MSG | VERIFY_MSG : 0;
3356 struct strbuf ref_name = STRBUF_INIT;
3357 struct commit *head_commit, *merge_commit, *i;
3358 struct commit_list *bases, *j, *reversed = NULL;
3359 struct commit_list *to_merge = NULL, **tail = &to_merge;
3360 const char *strategy = !opts->xopts_nr &&
3361 (!opts->strategy || !strcmp(opts->strategy, "recursive")) ?
3362 NULL : opts->strategy;
3363 struct merge_options o;
3364 int merge_arg_len, oneline_offset, can_fast_forward, ret, k;
3365 static struct lock_file lock;
3368 if (repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0) {
3373 head_commit = lookup_commit_reference_by_name("HEAD");
3375 ret = error(_("cannot merge without a current revision"));
3380 * For octopus merges, the arg starts with the list of revisions to be
3381 * merged. The list is optionally followed by '#' and the oneline.
3383 merge_arg_len = oneline_offset = arg_len;
3384 for (p = arg; p - arg < arg_len; p += strspn(p, " \t\n")) {
3387 if (*p == '#' && (!p[1] || isspace(p[1]))) {
3388 p += 1 + strspn(p + 1, " \t\n");
3389 oneline_offset = p - arg;
3392 k = strcspn(p, " \t\n");
3395 merge_commit = lookup_label(p, k, &ref_name);
3396 if (!merge_commit) {
3397 ret = error(_("unable to parse '%.*s'"), k, p);
3400 tail = &commit_list_insert(merge_commit, tail)->next;
3402 merge_arg_len = p - arg;
3406 ret = error(_("nothing to merge: '%.*s'"), arg_len, arg);
3410 if (opts->have_squash_onto &&
3411 oideq(&head_commit->object.oid, &opts->squash_onto)) {
3413 * When the user tells us to "merge" something into a
3414 * "[new root]", let's simply fast-forward to the merge head.
3416 rollback_lock_file(&lock);
3418 ret = error(_("octopus merge cannot be executed on "
3419 "top of a [new root]"));
3421 ret = fast_forward_to(r, &to_merge->item->object.oid,
3422 &head_commit->object.oid, 0,
3428 const char *encoding = get_commit_output_encoding();
3429 const char *message = logmsg_reencode(commit, NULL, encoding);
3434 ret = error(_("could not get commit message of '%s'"),
3435 oid_to_hex(&commit->object.oid));
3438 write_author_script(message);
3439 find_commit_subject(message, &body);
3441 ret = write_message(body, len, git_path_merge_msg(r), 0);
3442 unuse_commit_buffer(commit, message);
3444 error_errno(_("could not write '%s'"),
3445 git_path_merge_msg(r));
3449 struct strbuf buf = STRBUF_INIT;
3452 strbuf_addf(&buf, "author %s", git_author_info(0));
3453 write_author_script(buf.buf);
3456 if (oneline_offset < arg_len) {
3457 p = arg + oneline_offset;
3458 len = arg_len - oneline_offset;
3460 strbuf_addf(&buf, "Merge %s '%.*s'",
3461 to_merge->next ? "branches" : "branch",
3462 merge_arg_len, arg);
3467 ret = write_message(p, len, git_path_merge_msg(r), 0);
3468 strbuf_release(&buf);
3470 error_errno(_("could not write '%s'"),
3471 git_path_merge_msg(r));
3477 * If HEAD is not identical to the first parent of the original merge
3478 * commit, we cannot fast-forward.
3480 can_fast_forward = opts->allow_ff && commit && commit->parents &&
3481 oideq(&commit->parents->item->object.oid,
3482 &head_commit->object.oid);
3485 * If any merge head is different from the original one, we cannot
3488 if (can_fast_forward) {
3489 struct commit_list *p = commit->parents->next;
3491 for (j = to_merge; j && p; j = j->next, p = p->next)
3492 if (!oideq(&j->item->object.oid,
3493 &p->item->object.oid)) {
3494 can_fast_forward = 0;
3498 * If the number of merge heads differs from the original merge
3499 * commit, we cannot fast-forward.
3502 can_fast_forward = 0;
3505 if (can_fast_forward) {
3506 rollback_lock_file(&lock);
3507 ret = fast_forward_to(r, &commit->object.oid,
3508 &head_commit->object.oid, 0, opts);
3509 if (flags & TODO_EDIT_MERGE_MSG) {
3510 run_commit_flags |= AMEND_MSG;
3511 goto fast_forward_edit;
3516 if (strategy || to_merge->next) {
3518 struct child_process cmd = CHILD_PROCESS_INIT;
3520 if (read_env_script(&cmd.env_array)) {
3521 const char *gpg_opt = gpg_sign_opt_quoted(opts);
3523 ret = error(_(staged_changes_advice), gpg_opt, gpg_opt);
3528 argv_array_push(&cmd.args, "merge");
3529 argv_array_push(&cmd.args, "-s");
3531 argv_array_push(&cmd.args, "octopus");
3533 argv_array_push(&cmd.args, strategy);
3534 for (k = 0; k < opts->xopts_nr; k++)
3535 argv_array_pushf(&cmd.args,
3536 "-X%s", opts->xopts[k]);
3538 argv_array_push(&cmd.args, "--no-edit");
3539 argv_array_push(&cmd.args, "--no-ff");
3540 argv_array_push(&cmd.args, "--no-log");
3541 argv_array_push(&cmd.args, "--no-stat");
3542 argv_array_push(&cmd.args, "-F");
3543 argv_array_push(&cmd.args, git_path_merge_msg(r));
3545 argv_array_push(&cmd.args, opts->gpg_sign);
3547 /* Add the tips to be merged */
3548 for (j = to_merge; j; j = j->next)
3549 argv_array_push(&cmd.args,
3550 oid_to_hex(&j->item->object.oid));
3552 strbuf_release(&ref_name);
3553 unlink(git_path_cherry_pick_head(r));
3554 rollback_lock_file(&lock);
3556 rollback_lock_file(&lock);
3557 ret = run_command(&cmd);
3559 /* force re-reading of the cache */
3560 if (!ret && (discard_index(r->index) < 0 ||
3561 repo_read_index(r) < 0))
3562 ret = error(_("could not read index"));
3566 merge_commit = to_merge->item;
3567 bases = get_merge_bases(head_commit, merge_commit);
3568 if (bases && oideq(&merge_commit->object.oid,
3569 &bases->item->object.oid)) {
3571 /* skip merging an ancestor of HEAD */
3575 write_message(oid_to_hex(&merge_commit->object.oid), the_hash_algo->hexsz,
3576 git_path_merge_head(r), 0);
3577 write_message("no-ff", 5, git_path_merge_mode(r), 0);
3579 for (j = bases; j; j = j->next)
3580 commit_list_insert(j->item, &reversed);
3581 free_commit_list(bases);
3584 init_merge_options(&o, r);
3586 o.branch2 = ref_name.buf;
3587 o.buffer_output = 2;
3589 ret = merge_recursive(&o, head_commit, merge_commit, reversed, &i);
3591 fputs(o.obuf.buf, stdout);
3592 strbuf_release(&o.obuf);
3594 error(_("could not even attempt to merge '%.*s'"),
3595 merge_arg_len, arg);
3599 * The return value of merge_recursive() is 1 on clean, and 0 on
3602 * Let's reverse that, so that do_merge() returns 0 upon success and
3603 * 1 upon failed merge (keeping the return value -1 for the cases where
3604 * we will want to reschedule the `merge` command).
3608 if (r->index->cache_changed &&
3609 write_locked_index(r->index, &lock, COMMIT_LOCK)) {
3610 ret = error(_("merge: Unable to write new index file"));
3614 rollback_lock_file(&lock);
3616 repo_rerere(r, opts->allow_rerere_auto);
3619 * In case of problems, we now want to return a positive
3620 * value (a negative one would indicate that the `merge`
3621 * command needs to be rescheduled).
3624 ret = !!run_git_commit(r, git_path_merge_msg(r), opts,
3628 strbuf_release(&ref_name);
3629 rollback_lock_file(&lock);
3630 free_commit_list(to_merge);
3634 static int is_final_fixup(struct todo_list *todo_list)
3636 int i = todo_list->current;
3638 if (!is_fixup(todo_list->items[i].command))
3641 while (++i < todo_list->nr)
3642 if (is_fixup(todo_list->items[i].command))
3644 else if (!is_noop(todo_list->items[i].command))
3649 static enum todo_command peek_command(struct todo_list *todo_list, int offset)
3653 for (i = todo_list->current + offset; i < todo_list->nr; i++)
3654 if (!is_noop(todo_list->items[i].command))
3655 return todo_list->items[i].command;
3660 static int apply_autostash(struct replay_opts *opts)
3662 struct strbuf stash_sha1 = STRBUF_INIT;
3663 struct child_process child = CHILD_PROCESS_INIT;
3666 if (!read_oneliner(&stash_sha1, rebase_path_autostash(),
3667 READ_ONELINER_SKIP_IF_EMPTY)) {
3668 strbuf_release(&stash_sha1);
3671 strbuf_trim(&stash_sha1);
3674 child.no_stdout = 1;
3675 child.no_stderr = 1;
3676 argv_array_push(&child.args, "stash");
3677 argv_array_push(&child.args, "apply");
3678 argv_array_push(&child.args, stash_sha1.buf);
3679 if (!run_command(&child))
3680 fprintf(stderr, _("Applied autostash.\n"));
3682 struct child_process store = CHILD_PROCESS_INIT;
3685 argv_array_push(&store.args, "stash");
3686 argv_array_push(&store.args, "store");
3687 argv_array_push(&store.args, "-m");
3688 argv_array_push(&store.args, "autostash");
3689 argv_array_push(&store.args, "-q");
3690 argv_array_push(&store.args, stash_sha1.buf);
3691 if (run_command(&store))
3692 ret = error(_("cannot store %s"), stash_sha1.buf);
3695 _("Applying autostash resulted in conflicts.\n"
3696 "Your changes are safe in the stash.\n"
3697 "You can run \"git stash pop\" or"
3698 " \"git stash drop\" at any time.\n"));
3701 strbuf_release(&stash_sha1);
3705 static const char *reflog_message(struct replay_opts *opts,
3706 const char *sub_action, const char *fmt, ...)
3709 static struct strbuf buf = STRBUF_INIT;
3713 strbuf_addstr(&buf, action_name(opts));
3715 strbuf_addf(&buf, " (%s)", sub_action);
3717 strbuf_addstr(&buf, ": ");
3718 strbuf_vaddf(&buf, fmt, ap);
3725 static int run_git_checkout(struct repository *r, struct replay_opts *opts,
3726 const char *commit, const char *action)
3728 struct child_process cmd = CHILD_PROCESS_INIT;
3733 argv_array_push(&cmd.args, "checkout");
3734 argv_array_push(&cmd.args, commit);
3735 argv_array_pushf(&cmd.env_array, GIT_REFLOG_ACTION "=%s", action);
3738 ret = run_command(&cmd);
3740 ret = run_command_silent_on_success(&cmd);
3743 discard_index(r->index);
3748 static int checkout_onto(struct repository *r, struct replay_opts *opts,
3749 const char *onto_name, const struct object_id *onto,
3750 const char *orig_head)
3752 struct object_id oid;
3753 const char *action = reflog_message(opts, "start", "checkout %s", onto_name);
3755 if (get_oid(orig_head, &oid))
3756 return error(_("%s: not a valid OID"), orig_head);
3758 if (run_git_checkout(r, opts, oid_to_hex(onto), action)) {
3759 apply_autostash(opts);
3760 sequencer_remove_state(opts);
3761 return error(_("could not detach HEAD"));
3764 return update_ref(NULL, "ORIG_HEAD", &oid, NULL, 0, UPDATE_REFS_MSG_ON_ERR);
3767 static int stopped_at_head(struct repository *r)
3769 struct object_id head;
3770 struct commit *commit;
3771 struct commit_message message;
3773 if (get_oid("HEAD", &head) ||
3774 !(commit = lookup_commit(r, &head)) ||
3775 parse_commit(commit) || get_message(commit, &message))
3776 fprintf(stderr, _("Stopped at HEAD\n"));
3778 fprintf(stderr, _("Stopped at %s\n"), message.label);
3779 free_message(commit, &message);
3785 static const char rescheduled_advice[] =
3786 N_("Could not execute the todo command\n"
3790 "It has been rescheduled; To edit the command before continuing, please\n"
3791 "edit the todo list first:\n"
3793 " git rebase --edit-todo\n"
3794 " git rebase --continue\n");
3796 static int pick_commits(struct repository *r,
3797 struct todo_list *todo_list,
3798 struct replay_opts *opts)
3800 int res = 0, reschedule = 0;
3802 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
3804 assert(!(opts->signoff || opts->no_commit ||
3805 opts->record_origin || opts->edit));
3806 if (read_and_refresh_cache(r, opts))
3809 while (todo_list->current < todo_list->nr) {
3810 struct todo_item *item = todo_list->items + todo_list->current;
3811 const char *arg = todo_item_get_arg(todo_list, item);
3814 if (save_todo(todo_list, opts))
3816 if (is_rebase_i(opts)) {
3817 if (item->command != TODO_COMMENT) {
3818 FILE *f = fopen(rebase_path_msgnum(), "w");
3820 todo_list->done_nr++;
3823 fprintf(f, "%d\n", todo_list->done_nr);
3827 fprintf(stderr, "Rebasing (%d/%d)%s",
3829 todo_list->total_nr,
3830 opts->verbose ? "\n" : "\r");
3832 unlink(rebase_path_message());
3833 unlink(rebase_path_author_script());
3834 unlink(rebase_path_stopped_sha());
3835 unlink(rebase_path_amend());
3836 unlink(git_path_merge_head(r));
3837 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
3839 if (item->command == TODO_BREAK) {
3842 return stopped_at_head(r);
3845 if (item->command <= TODO_SQUASH) {
3846 if (is_rebase_i(opts))
3847 setenv("GIT_REFLOG_ACTION", reflog_message(opts,
3848 command_to_string(item->command), NULL),
3850 res = do_pick_commit(r, item->command, item->commit,
3851 opts, is_final_fixup(todo_list),
3853 if (is_rebase_i(opts) && res < 0) {
3855 advise(_(rescheduled_advice),
3856 get_item_line_length(todo_list,
3857 todo_list->current),
3858 get_item_line(todo_list,
3859 todo_list->current));
3860 todo_list->current--;
3861 if (save_todo(todo_list, opts))
3864 if (item->command == TODO_EDIT) {
3865 struct commit *commit = item->commit;
3870 _("Stopped at %s... %.*s\n"),
3871 short_commit_name(commit),
3872 item->arg_len, arg);
3874 return error_with_patch(r, commit,
3875 arg, item->arg_len, opts, res, !res);
3877 if (is_rebase_i(opts) && !res)
3878 record_in_rewritten(&item->commit->object.oid,
3879 peek_command(todo_list, 1));
3880 if (res && is_fixup(item->command)) {
3883 return error_failed_squash(r, item->commit, opts,
3884 item->arg_len, arg);
3885 } else if (res && is_rebase_i(opts) && item->commit) {
3887 struct object_id oid;
3890 * If we are rewording and have either
3891 * fast-forwarded already, or are about to
3892 * create a new root commit, we want to amend,
3893 * otherwise we do not.
3895 if (item->command == TODO_REWORD &&
3896 !get_oid("HEAD", &oid) &&
3897 (oideq(&item->commit->object.oid, &oid) ||
3898 (opts->have_squash_onto &&
3899 oideq(&opts->squash_onto, &oid))))
3902 return res | error_with_patch(r, item->commit,
3903 arg, item->arg_len, opts,
3906 } else if (item->command == TODO_EXEC) {
3907 char *end_of_arg = (char *)(arg + item->arg_len);
3908 int saved = *end_of_arg;
3913 res = do_exec(r, arg);
3914 *end_of_arg = saved;
3917 if (opts->reschedule_failed_exec)
3921 } else if (item->command == TODO_LABEL) {
3922 if ((res = do_label(r, arg, item->arg_len)))
3924 } else if (item->command == TODO_RESET) {
3925 if ((res = do_reset(r, arg, item->arg_len, opts)))
3927 } else if (item->command == TODO_MERGE) {
3928 if ((res = do_merge(r, item->commit,
3930 item->flags, opts)) < 0)
3932 else if (item->commit)
3933 record_in_rewritten(&item->commit->object.oid,
3934 peek_command(todo_list, 1));
3936 /* failed with merge conflicts */
3937 return error_with_patch(r, item->commit,
3940 } else if (!is_noop(item->command))
3941 return error(_("unknown command %d"), item->command);
3944 advise(_(rescheduled_advice),
3945 get_item_line_length(todo_list,
3946 todo_list->current),
3947 get_item_line(todo_list, todo_list->current));
3948 todo_list->current--;
3949 if (save_todo(todo_list, opts))
3952 return error_with_patch(r,
3956 } else if (is_rebase_i(opts) && check_todo && !res) {
3959 if (stat(get_todo_path(opts), &st)) {
3960 res = error_errno(_("could not stat '%s'"),
3961 get_todo_path(opts));
3962 } else if (match_stat_data(&todo_list->stat, &st)) {
3963 /* Reread the todo file if it has changed. */
3964 todo_list_release(todo_list);
3965 if (read_populate_todo(r, todo_list, opts))
3966 res = -1; /* message was printed */
3967 /* `current` will be incremented below */
3968 todo_list->current = -1;
3972 todo_list->current++;
3977 if (is_rebase_i(opts)) {
3978 struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
3981 /* Stopped in the middle, as planned? */
3982 if (todo_list->current < todo_list->nr)
3985 if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
3986 starts_with(head_ref.buf, "refs/")) {
3988 struct object_id head, orig;
3991 if (get_oid("HEAD", &head)) {
3992 res = error(_("cannot read HEAD"));
3994 strbuf_release(&head_ref);
3995 strbuf_release(&buf);
3998 if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
3999 get_oid_hex(buf.buf, &orig)) {
4000 res = error(_("could not read orig-head"));
4001 goto cleanup_head_ref;
4004 if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
4005 res = error(_("could not read 'onto'"));
4006 goto cleanup_head_ref;
4008 msg = reflog_message(opts, "finish", "%s onto %s",
4009 head_ref.buf, buf.buf);
4010 if (update_ref(msg, head_ref.buf, &head, &orig,
4011 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR)) {
4012 res = error(_("could not update %s"),
4014 goto cleanup_head_ref;
4016 msg = reflog_message(opts, "finish", "returning to %s",
4018 if (create_symref("HEAD", head_ref.buf, msg)) {
4019 res = error(_("could not update HEAD to %s"),
4021 goto cleanup_head_ref;
4026 if (opts->verbose) {
4027 struct rev_info log_tree_opt;
4028 struct object_id orig, head;
4030 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
4031 repo_init_revisions(r, &log_tree_opt, NULL);
4032 log_tree_opt.diff = 1;
4033 log_tree_opt.diffopt.output_format =
4034 DIFF_FORMAT_DIFFSTAT;
4035 log_tree_opt.disable_stdin = 1;
4037 if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
4038 !get_oid(buf.buf, &orig) &&
4039 !get_oid("HEAD", &head)) {
4040 diff_tree_oid(&orig, &head, "",
4041 &log_tree_opt.diffopt);
4042 log_tree_diff_flush(&log_tree_opt);
4045 flush_rewritten_pending();
4046 if (!stat(rebase_path_rewritten_list(), &st) &&
4048 struct child_process child = CHILD_PROCESS_INIT;
4049 const char *post_rewrite_hook =
4050 find_hook("post-rewrite");
4052 child.in = open(rebase_path_rewritten_list(), O_RDONLY);
4054 argv_array_push(&child.args, "notes");
4055 argv_array_push(&child.args, "copy");
4056 argv_array_push(&child.args, "--for-rewrite=rebase");
4057 /* we don't care if this copying failed */
4058 run_command(&child);
4060 if (post_rewrite_hook) {
4061 struct child_process hook = CHILD_PROCESS_INIT;
4063 hook.in = open(rebase_path_rewritten_list(),
4065 hook.stdout_to_stderr = 1;
4066 hook.trace2_hook_name = "post-rewrite";
4067 argv_array_push(&hook.args, post_rewrite_hook);
4068 argv_array_push(&hook.args, "rebase");
4069 /* we don't care if this hook failed */
4073 apply_autostash(opts);
4079 "Successfully rebased and updated %s.\n",
4083 strbuf_release(&buf);
4084 strbuf_release(&head_ref);
4088 * Sequence of picks finished successfully; cleanup by
4089 * removing the .git/sequencer directory
4091 return sequencer_remove_state(opts);
4094 static int continue_single_pick(struct repository *r)
4096 const char *argv[] = { "commit", NULL };
4098 if (!file_exists(git_path_cherry_pick_head(r)) &&
4099 !file_exists(git_path_revert_head(r)))
4100 return error(_("no cherry-pick or revert in progress"));
4101 return run_command_v_opt(argv, RUN_GIT_CMD);
4104 static int commit_staged_changes(struct repository *r,
4105 struct replay_opts *opts,
4106 struct todo_list *todo_list)
4108 unsigned int flags = ALLOW_EMPTY | EDIT_MSG;
4109 unsigned int final_fixup = 0, is_clean;
4111 if (has_unstaged_changes(r, 1))
4112 return error(_("cannot rebase: You have unstaged changes."));
4114 is_clean = !has_uncommitted_changes(r, 0);
4116 if (file_exists(rebase_path_amend())) {
4117 struct strbuf rev = STRBUF_INIT;
4118 struct object_id head, to_amend;
4120 if (get_oid("HEAD", &head))
4121 return error(_("cannot amend non-existing commit"));
4122 if (!read_oneliner(&rev, rebase_path_amend(), 0))
4123 return error(_("invalid file: '%s'"), rebase_path_amend());
4124 if (get_oid_hex(rev.buf, &to_amend))
4125 return error(_("invalid contents: '%s'"),
4126 rebase_path_amend());
4127 if (!is_clean && !oideq(&head, &to_amend))
4128 return error(_("\nYou have uncommitted changes in your "
4129 "working tree. Please, commit them\n"
4130 "first and then run 'git rebase "
4131 "--continue' again."));
4133 * When skipping a failed fixup/squash, we need to edit the
4134 * commit message, the current fixup list and count, and if it
4135 * was the last fixup/squash in the chain, we need to clean up
4136 * the commit message and if there was a squash, let the user
4139 if (!is_clean || !opts->current_fixup_count)
4140 ; /* this is not the final fixup */
4141 else if (!oideq(&head, &to_amend) ||
4142 !file_exists(rebase_path_stopped_sha())) {
4143 /* was a final fixup or squash done manually? */
4144 if (!is_fixup(peek_command(todo_list, 0))) {
4145 unlink(rebase_path_fixup_msg());
4146 unlink(rebase_path_squash_msg());
4147 unlink(rebase_path_current_fixups());
4148 strbuf_reset(&opts->current_fixups);
4149 opts->current_fixup_count = 0;
4152 /* we are in a fixup/squash chain */
4153 const char *p = opts->current_fixups.buf;
4154 int len = opts->current_fixups.len;
4156 opts->current_fixup_count--;
4158 BUG("Incorrect current_fixups:\n%s", p);
4159 while (len && p[len - 1] != '\n')
4161 strbuf_setlen(&opts->current_fixups, len);
4162 if (write_message(p, len, rebase_path_current_fixups(),
4164 return error(_("could not write file: '%s'"),
4165 rebase_path_current_fixups());
4168 * If a fixup/squash in a fixup/squash chain failed, the
4169 * commit message is already correct, no need to commit
4172 * Only if it is the final command in the fixup/squash
4173 * chain, and only if the chain is longer than a single
4174 * fixup/squash command (which was just skipped), do we
4175 * actually need to re-commit with a cleaned up commit
4178 if (opts->current_fixup_count > 0 &&
4179 !is_fixup(peek_command(todo_list, 0))) {
4182 * If there was not a single "squash" in the
4183 * chain, we only need to clean up the commit
4184 * message, no need to bother the user with
4185 * opening the commit message in the editor.
4187 if (!starts_with(p, "squash ") &&
4188 !strstr(p, "\nsquash "))
4189 flags = (flags & ~EDIT_MSG) | CLEANUP_MSG;
4190 } else if (is_fixup(peek_command(todo_list, 0))) {
4192 * We need to update the squash message to skip
4193 * the latest commit message.
4195 struct commit *commit;
4196 const char *path = rebase_path_squash_msg();
4197 const char *encoding = get_commit_output_encoding();
4199 if (parse_head(r, &commit) ||
4200 !(p = logmsg_reencode(commit, NULL, encoding)) ||
4201 write_message(p, strlen(p), path, 0)) {
4202 unuse_commit_buffer(commit, p);
4203 return error(_("could not write file: "
4206 unuse_commit_buffer(commit, p);
4210 strbuf_release(&rev);
4215 const char *cherry_pick_head = git_path_cherry_pick_head(r);
4217 if (file_exists(cherry_pick_head) && unlink(cherry_pick_head))
4218 return error(_("could not remove CHERRY_PICK_HEAD"));
4223 if (run_git_commit(r, final_fixup ? NULL : rebase_path_message(),
4225 return error(_("could not commit staged changes."));
4226 unlink(rebase_path_amend());
4227 unlink(git_path_merge_head(r));
4229 unlink(rebase_path_fixup_msg());
4230 unlink(rebase_path_squash_msg());
4232 if (opts->current_fixup_count > 0) {
4234 * Whether final fixup or not, we just cleaned up the commit
4237 unlink(rebase_path_current_fixups());
4238 strbuf_reset(&opts->current_fixups);
4239 opts->current_fixup_count = 0;
4244 int sequencer_continue(struct repository *r, struct replay_opts *opts)
4246 struct todo_list todo_list = TODO_LIST_INIT;
4249 if (read_and_refresh_cache(r, opts))
4252 if (read_populate_opts(opts))
4254 if (is_rebase_i(opts)) {
4255 if ((res = read_populate_todo(r, &todo_list, opts)))
4256 goto release_todo_list;
4258 if (file_exists(rebase_path_dropped())) {
4259 if ((res = todo_list_check_against_backup(r, &todo_list)))
4260 goto release_todo_list;
4262 unlink(rebase_path_dropped());
4265 if (commit_staged_changes(r, opts, &todo_list)) {
4267 goto release_todo_list;
4269 } else if (!file_exists(get_todo_path(opts)))
4270 return continue_single_pick(r);
4271 else if ((res = read_populate_todo(r, &todo_list, opts)))
4272 goto release_todo_list;
4274 if (!is_rebase_i(opts)) {
4275 /* Verify that the conflict has been resolved */
4276 if (file_exists(git_path_cherry_pick_head(r)) ||
4277 file_exists(git_path_revert_head(r))) {
4278 res = continue_single_pick(r);
4280 goto release_todo_list;
4282 if (index_differs_from(r, "HEAD", NULL, 0)) {
4283 res = error_dirty_index(r, opts);
4284 goto release_todo_list;
4286 todo_list.current++;
4287 } else if (file_exists(rebase_path_stopped_sha())) {
4288 struct strbuf buf = STRBUF_INIT;
4289 struct object_id oid;
4291 if (read_oneliner(&buf, rebase_path_stopped_sha(),
4292 READ_ONELINER_SKIP_IF_EMPTY) &&
4293 !get_oid_committish(buf.buf, &oid))
4294 record_in_rewritten(&oid, peek_command(&todo_list, 0));
4295 strbuf_release(&buf);
4298 res = pick_commits(r, &todo_list, opts);
4300 todo_list_release(&todo_list);
4304 static int single_pick(struct repository *r,
4305 struct commit *cmit,
4306 struct replay_opts *opts)
4310 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
4311 return do_pick_commit(r, opts->action == REPLAY_PICK ?
4312 TODO_PICK : TODO_REVERT, cmit, opts, 0,
4316 int sequencer_pick_revisions(struct repository *r,
4317 struct replay_opts *opts)
4319 struct todo_list todo_list = TODO_LIST_INIT;
4320 struct object_id oid;
4324 if (read_and_refresh_cache(r, opts))
4327 for (i = 0; i < opts->revs->pending.nr; i++) {
4328 struct object_id oid;
4329 const char *name = opts->revs->pending.objects[i].name;
4331 /* This happens when using --stdin. */
4335 if (!get_oid(name, &oid)) {
4336 if (!lookup_commit_reference_gently(r, &oid, 1)) {
4337 enum object_type type = oid_object_info(r,
4340 return error(_("%s: can't cherry-pick a %s"),
4341 name, type_name(type));
4344 return error(_("%s: bad revision"), name);
4348 * If we were called as "git cherry-pick <commit>", just
4349 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
4350 * REVERT_HEAD, and don't touch the sequencer state.
4351 * This means it is possible to cherry-pick in the middle
4352 * of a cherry-pick sequence.
4354 if (opts->revs->cmdline.nr == 1 &&
4355 opts->revs->cmdline.rev->whence == REV_CMD_REV &&
4356 opts->revs->no_walk &&
4357 !opts->revs->cmdline.rev->flags) {
4358 struct commit *cmit;
4359 if (prepare_revision_walk(opts->revs))
4360 return error(_("revision walk setup failed"));
4361 cmit = get_revision(opts->revs);
4363 return error(_("empty commit set passed"));
4364 if (get_revision(opts->revs))
4365 BUG("unexpected extra commit from walk");
4366 return single_pick(r, cmit, opts);
4370 * Start a new cherry-pick/ revert sequence; but
4371 * first, make sure that an existing one isn't in
4375 if (walk_revs_populate_todo(&todo_list, opts) ||
4376 create_seq_dir(r) < 0)
4378 if (get_oid("HEAD", &oid) && (opts->action == REPLAY_REVERT))
4379 return error(_("can't revert as initial commit"));
4380 if (save_head(oid_to_hex(&oid)))
4382 if (save_opts(opts))
4384 update_abort_safety_file();
4385 res = pick_commits(r, &todo_list, opts);
4386 todo_list_release(&todo_list);
4390 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag)
4392 unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
4393 struct strbuf sob = STRBUF_INIT;
4396 strbuf_addstr(&sob, sign_off_header);
4397 strbuf_addstr(&sob, fmt_name(WANT_COMMITTER_IDENT));
4398 strbuf_addch(&sob, '\n');
4401 strbuf_complete_line(msgbuf);
4404 * If the whole message buffer is equal to the sob, pretend that we
4405 * found a conforming footer with a matching sob
4407 if (msgbuf->len - ignore_footer == sob.len &&
4408 !strncmp(msgbuf->buf, sob.buf, sob.len))
4411 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
4414 const char *append_newlines = NULL;
4415 size_t len = msgbuf->len - ignore_footer;
4419 * The buffer is completely empty. Leave foom for
4420 * the title and body to be filled in by the user.
4422 append_newlines = "\n\n";
4423 } else if (len == 1) {
4425 * Buffer contains a single newline. Add another
4426 * so that we leave room for the title and body.
4428 append_newlines = "\n";
4429 } else if (msgbuf->buf[len - 2] != '\n') {
4431 * Buffer ends with a single newline. Add another
4432 * so that there is an empty line between the message
4435 append_newlines = "\n";
4436 } /* else, the buffer already ends with two newlines. */
4438 if (append_newlines)
4439 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
4440 append_newlines, strlen(append_newlines));
4443 if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
4444 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
4447 strbuf_release(&sob);
4450 struct labels_entry {
4451 struct hashmap_entry entry;
4452 char label[FLEX_ARRAY];
4455 static int labels_cmp(const void *fndata, const struct hashmap_entry *eptr,
4456 const struct hashmap_entry *entry_or_key, const void *key)
4458 const struct labels_entry *a, *b;
4460 a = container_of(eptr, const struct labels_entry, entry);
4461 b = container_of(entry_or_key, const struct labels_entry, entry);
4463 return key ? strcmp(a->label, key) : strcmp(a->label, b->label);
4466 struct string_entry {
4467 struct oidmap_entry entry;
4468 char string[FLEX_ARRAY];
4471 struct label_state {
4472 struct oidmap commit2label;
4473 struct hashmap labels;
4477 static const char *label_oid(struct object_id *oid, const char *label,
4478 struct label_state *state)
4480 struct labels_entry *labels_entry;
4481 struct string_entry *string_entry;
4482 struct object_id dummy;
4485 string_entry = oidmap_get(&state->commit2label, oid);
4487 return string_entry->string;
4490 * For "uninteresting" commits, i.e. commits that are not to be
4491 * rebased, and which can therefore not be labeled, we use a unique
4492 * abbreviation of the commit name. This is slightly more complicated
4493 * than calling find_unique_abbrev() because we also need to make
4494 * sure that the abbreviation does not conflict with any other
4497 * We disallow "interesting" commits to be labeled by a string that
4498 * is a valid full-length hash, to ensure that we always can find an
4499 * abbreviation for any uninteresting commit's names that does not
4500 * clash with any other label.
4502 strbuf_reset(&state->buf);
4506 strbuf_grow(&state->buf, GIT_MAX_HEXSZ);
4507 label = p = state->buf.buf;
4509 find_unique_abbrev_r(p, oid, default_abbrev);
4512 * We may need to extend the abbreviated hash so that there is
4513 * no conflicting label.
4515 if (hashmap_get_from_hash(&state->labels, strihash(p), p)) {
4516 size_t i = strlen(p) + 1;
4518 oid_to_hex_r(p, oid);
4519 for (; i < the_hash_algo->hexsz; i++) {
4522 if (!hashmap_get_from_hash(&state->labels,
4529 struct strbuf *buf = &state->buf;
4532 * Sanitize labels by replacing non-alpha-numeric characters
4533 * (including white-space ones) by dashes, as they might be
4534 * illegal in file names (and hence in ref names).
4536 * Note that we retain non-ASCII UTF-8 characters (identified
4537 * via the most significant bit). They should be all acceptable
4538 * in file names. We do not validate the UTF-8 here, that's not
4539 * the job of this function.
4541 for (; *label; label++)
4542 if ((*label & 0x80) || isalnum(*label))
4543 strbuf_addch(buf, *label);
4544 /* avoid leading dash and double-dashes */
4545 else if (buf->len && buf->buf[buf->len - 1] != '-')
4546 strbuf_addch(buf, '-');
4548 strbuf_addstr(buf, "rev-");
4549 strbuf_add_unique_abbrev(buf, oid, default_abbrev);
4553 if ((buf->len == the_hash_algo->hexsz &&
4554 !get_oid_hex(label, &dummy)) ||
4555 (buf->len == 1 && *label == '#') ||
4556 hashmap_get_from_hash(&state->labels,
4557 strihash(label), label)) {
4559 * If the label already exists, or if the label is a
4560 * valid full OID, or the label is a '#' (which we use
4561 * as a separator between merge heads and oneline), we
4562 * append a dash and a number to make it unique.
4564 size_t len = buf->len;
4566 for (i = 2; ; i++) {
4567 strbuf_setlen(buf, len);
4568 strbuf_addf(buf, "-%d", i);
4569 if (!hashmap_get_from_hash(&state->labels,
4579 FLEX_ALLOC_STR(labels_entry, label, label);
4580 hashmap_entry_init(&labels_entry->entry, strihash(label));
4581 hashmap_add(&state->labels, &labels_entry->entry);
4583 FLEX_ALLOC_STR(string_entry, string, label);
4584 oidcpy(&string_entry->entry.oid, oid);
4585 oidmap_put(&state->commit2label, string_entry);
4587 return string_entry->string;
4590 static int make_script_with_merges(struct pretty_print_context *pp,
4591 struct rev_info *revs, struct strbuf *out,
4594 int rebase_cousins = flags & TODO_LIST_REBASE_COUSINS;
4595 int root_with_onto = flags & TODO_LIST_ROOT_WITH_ONTO;
4596 struct strbuf buf = STRBUF_INIT, oneline = STRBUF_INIT;
4597 struct strbuf label = STRBUF_INIT;
4598 struct commit_list *commits = NULL, **tail = &commits, *iter;
4599 struct commit_list *tips = NULL, **tips_tail = &tips;
4600 struct commit *commit;
4601 struct oidmap commit2todo = OIDMAP_INIT;
4602 struct string_entry *entry;
4603 struct oidset interesting = OIDSET_INIT, child_seen = OIDSET_INIT,
4604 shown = OIDSET_INIT;
4605 struct label_state state = { OIDMAP_INIT, { NULL }, STRBUF_INIT };
4607 int abbr = flags & TODO_LIST_ABBREVIATE_CMDS;
4608 const char *cmd_pick = abbr ? "p" : "pick",
4609 *cmd_label = abbr ? "l" : "label",
4610 *cmd_reset = abbr ? "t" : "reset",
4611 *cmd_merge = abbr ? "m" : "merge";
4613 oidmap_init(&commit2todo, 0);
4614 oidmap_init(&state.commit2label, 0);
4615 hashmap_init(&state.labels, labels_cmp, NULL, 0);
4616 strbuf_init(&state.buf, 32);
4618 if (revs->cmdline.nr && (revs->cmdline.rev[0].flags & BOTTOM)) {
4619 struct labels_entry *onto_label_entry;
4620 struct object_id *oid = &revs->cmdline.rev[0].item->oid;
4621 FLEX_ALLOC_STR(entry, string, "onto");
4622 oidcpy(&entry->entry.oid, oid);
4623 oidmap_put(&state.commit2label, entry);
4625 FLEX_ALLOC_STR(onto_label_entry, label, "onto");
4626 hashmap_entry_init(&onto_label_entry->entry, strihash("onto"));
4627 hashmap_add(&state.labels, &onto_label_entry->entry);
4632 * - get onelines for all commits
4633 * - gather all branch tips (i.e. 2nd or later parents of merges)
4634 * - label all branch tips
4636 while ((commit = get_revision(revs))) {
4637 struct commit_list *to_merge;
4638 const char *p1, *p2;
4639 struct object_id *oid;
4642 tail = &commit_list_insert(commit, tail)->next;
4643 oidset_insert(&interesting, &commit->object.oid);
4645 is_empty = is_original_commit_empty(commit);
4646 if (!is_empty && (commit->object.flags & PATCHSAME))
4649 strbuf_reset(&oneline);
4650 pretty_print_commit(pp, commit, &oneline);
4652 to_merge = commit->parents ? commit->parents->next : NULL;
4654 /* non-merge commit: easy case */
4656 strbuf_addf(&buf, "%s %s %s", cmd_pick,
4657 oid_to_hex(&commit->object.oid),
4660 FLEX_ALLOC_STR(entry, string, buf.buf);
4661 oidcpy(&entry->entry.oid, &commit->object.oid);
4662 oidmap_put(&commit2todo, entry);
4667 /* Create a label */
4668 strbuf_reset(&label);
4669 if (skip_prefix(oneline.buf, "Merge ", &p1) &&
4670 (p1 = strchr(p1, '\'')) &&
4671 (p2 = strchr(++p1, '\'')))
4672 strbuf_add(&label, p1, p2 - p1);
4673 else if (skip_prefix(oneline.buf, "Merge pull request ",
4675 (p1 = strstr(p1, " from ")))
4676 strbuf_addstr(&label, p1 + strlen(" from "));
4678 strbuf_addbuf(&label, &oneline);
4681 strbuf_addf(&buf, "%s -C %s",
4682 cmd_merge, oid_to_hex(&commit->object.oid));
4684 /* label the tips of merged branches */
4685 for (; to_merge; to_merge = to_merge->next) {
4686 oid = &to_merge->item->object.oid;
4687 strbuf_addch(&buf, ' ');
4689 if (!oidset_contains(&interesting, oid)) {
4690 strbuf_addstr(&buf, label_oid(oid, NULL,
4695 tips_tail = &commit_list_insert(to_merge->item,
4698 strbuf_addstr(&buf, label_oid(oid, label.buf, &state));
4700 strbuf_addf(&buf, " # %s", oneline.buf);
4702 FLEX_ALLOC_STR(entry, string, buf.buf);
4703 oidcpy(&entry->entry.oid, &commit->object.oid);
4704 oidmap_put(&commit2todo, entry);
4709 * - label branch points
4710 * - add HEAD to the branch tips
4712 for (iter = commits; iter; iter = iter->next) {
4713 struct commit_list *parent = iter->item->parents;
4714 for (; parent; parent = parent->next) {
4715 struct object_id *oid = &parent->item->object.oid;
4716 if (!oidset_contains(&interesting, oid))
4718 if (oidset_insert(&child_seen, oid))
4719 label_oid(oid, "branch-point", &state);
4722 /* Add HEAD as implicit "tip of branch" */
4724 tips_tail = &commit_list_insert(iter->item,
4729 * Third phase: output the todo list. This is a bit tricky, as we
4730 * want to avoid jumping back and forth between revisions. To
4731 * accomplish that goal, we walk backwards from the branch tips,
4732 * gathering commits not yet shown, reversing the list on the fly,
4733 * then outputting that list (labeling revisions as needed).
4735 strbuf_addf(out, "%s onto\n", cmd_label);
4736 for (iter = tips; iter; iter = iter->next) {
4737 struct commit_list *list = NULL, *iter2;
4739 commit = iter->item;
4740 if (oidset_contains(&shown, &commit->object.oid))
4742 entry = oidmap_get(&state.commit2label, &commit->object.oid);
4745 strbuf_addf(out, "\n%c Branch %s\n", comment_line_char, entry->string);
4747 strbuf_addch(out, '\n');
4749 while (oidset_contains(&interesting, &commit->object.oid) &&
4750 !oidset_contains(&shown, &commit->object.oid)) {
4751 commit_list_insert(commit, &list);
4752 if (!commit->parents) {
4756 commit = commit->parents->item;
4760 strbuf_addf(out, "%s %s\n", cmd_reset,
4761 rebase_cousins || root_with_onto ?
4762 "onto" : "[new root]");
4764 const char *to = NULL;
4766 entry = oidmap_get(&state.commit2label,
4767 &commit->object.oid);
4770 else if (!rebase_cousins)
4771 to = label_oid(&commit->object.oid, NULL,
4774 if (!to || !strcmp(to, "onto"))
4775 strbuf_addf(out, "%s onto\n", cmd_reset);
4777 strbuf_reset(&oneline);
4778 pretty_print_commit(pp, commit, &oneline);
4779 strbuf_addf(out, "%s %s # %s\n",
4780 cmd_reset, to, oneline.buf);
4784 for (iter2 = list; iter2; iter2 = iter2->next) {
4785 struct object_id *oid = &iter2->item->object.oid;
4786 entry = oidmap_get(&commit2todo, oid);
4787 /* only show if not already upstream */
4789 strbuf_addf(out, "%s\n", entry->string);
4790 entry = oidmap_get(&state.commit2label, oid);
4792 strbuf_addf(out, "%s %s\n",
4793 cmd_label, entry->string);
4794 oidset_insert(&shown, oid);
4797 free_commit_list(list);
4800 free_commit_list(commits);
4801 free_commit_list(tips);
4803 strbuf_release(&label);
4804 strbuf_release(&oneline);
4805 strbuf_release(&buf);
4807 oidmap_free(&commit2todo, 1);
4808 oidmap_free(&state.commit2label, 1);
4809 hashmap_free_entries(&state.labels, struct labels_entry, entry);
4810 strbuf_release(&state.buf);
4815 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
4816 const char **argv, unsigned flags)
4818 char *format = NULL;
4819 struct pretty_print_context pp = {0};
4820 struct rev_info revs;
4821 struct commit *commit;
4822 const char *insn = flags & TODO_LIST_ABBREVIATE_CMDS ? "p" : "pick";
4823 int rebase_merges = flags & TODO_LIST_REBASE_MERGES;
4825 repo_init_revisions(r, &revs, NULL);
4826 revs.verbose_header = 1;
4828 revs.max_parents = 1;
4829 revs.cherry_mark = 1;
4832 revs.right_only = 1;
4833 revs.sort_order = REV_SORT_IN_GRAPH_ORDER;
4834 revs.topo_order = 1;
4836 revs.pretty_given = 1;
4837 git_config_get_string("rebase.instructionFormat", &format);
4838 if (!format || !*format) {
4840 format = xstrdup("%s");
4842 get_commit_format(format, &revs);
4844 pp.fmt = revs.commit_format;
4845 pp.output_encoding = get_log_output_encoding();
4847 if (setup_revisions(argc, argv, &revs, NULL) > 1)
4848 return error(_("make_script: unhandled options"));
4850 if (prepare_revision_walk(&revs) < 0)
4851 return error(_("make_script: error preparing revisions"));
4854 return make_script_with_merges(&pp, &revs, out, flags);
4856 while ((commit = get_revision(&revs))) {
4857 int is_empty = is_original_commit_empty(commit);
4859 if (!is_empty && (commit->object.flags & PATCHSAME))
4861 strbuf_addf(out, "%s %s ", insn,
4862 oid_to_hex(&commit->object.oid));
4863 pretty_print_commit(&pp, commit, out);
4864 strbuf_addch(out, '\n');
4870 * Add commands after pick and (series of) squash/fixup commands
4873 void todo_list_add_exec_commands(struct todo_list *todo_list,
4874 struct string_list *commands)
4876 struct strbuf *buf = &todo_list->buf;
4877 size_t base_offset = buf->len;
4878 int i, insert, nr = 0, alloc = 0;
4879 struct todo_item *items = NULL, *base_items = NULL;
4881 base_items = xcalloc(commands->nr, sizeof(struct todo_item));
4882 for (i = 0; i < commands->nr; i++) {
4883 size_t command_len = strlen(commands->items[i].string);
4885 strbuf_addstr(buf, commands->items[i].string);
4886 strbuf_addch(buf, '\n');
4888 base_items[i].command = TODO_EXEC;
4889 base_items[i].offset_in_buf = base_offset;
4890 base_items[i].arg_offset = base_offset + strlen("exec ");
4891 base_items[i].arg_len = command_len - strlen("exec ");
4893 base_offset += command_len + 1;
4897 * Insert <commands> after every pick. Here, fixup/squash chains
4898 * are considered part of the pick, so we insert the commands *after*
4899 * those chains if there are any.
4901 * As we insert the exec commands immediately after rearranging
4902 * any fixups and before the user edits the list, a fixup chain
4903 * can never contain comments (any comments are empty picks that
4904 * have been commented out because the user did not specify
4905 * --keep-empty). So, it is safe to insert an exec command
4906 * without looking at the command following a comment.
4909 for (i = 0; i < todo_list->nr; i++) {
4910 enum todo_command command = todo_list->items[i].command;
4911 if (insert && !is_fixup(command)) {
4912 ALLOC_GROW(items, nr + commands->nr, alloc);
4913 COPY_ARRAY(items + nr, base_items, commands->nr);
4919 ALLOC_GROW(items, nr + 1, alloc);
4920 items[nr++] = todo_list->items[i];
4922 if (command == TODO_PICK || command == TODO_MERGE)
4926 /* insert or append final <commands> */
4927 if (insert || nr == todo_list->nr) {
4928 ALLOC_GROW(items, nr + commands->nr, alloc);
4929 COPY_ARRAY(items + nr, base_items, commands->nr);
4934 FREE_AND_NULL(todo_list->items);
4935 todo_list->items = items;
4937 todo_list->alloc = alloc;
4940 static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
4941 struct strbuf *buf, int num, unsigned flags)
4943 struct todo_item *item;
4944 int i, max = todo_list->nr;
4946 if (num > 0 && num < max)
4949 for (item = todo_list->items, i = 0; i < max; i++, item++) {
4950 /* if the item is not a command write it and continue */
4951 if (item->command >= TODO_COMMENT) {
4952 strbuf_addf(buf, "%.*s\n", item->arg_len,
4953 todo_item_get_arg(todo_list, item));
4957 /* add command to the buffer */
4958 if (flags & TODO_LIST_ABBREVIATE_CMDS)
4959 strbuf_addch(buf, command_to_char(item->command));
4961 strbuf_addstr(buf, command_to_string(item->command));
4965 const char *oid = flags & TODO_LIST_SHORTEN_IDS ?
4966 short_commit_name(item->commit) :
4967 oid_to_hex(&item->commit->object.oid);
4969 if (item->command == TODO_MERGE) {
4970 if (item->flags & TODO_EDIT_MERGE_MSG)
4971 strbuf_addstr(buf, " -c");
4973 strbuf_addstr(buf, " -C");
4976 strbuf_addf(buf, " %s", oid);
4979 /* add all the rest */
4981 strbuf_addch(buf, '\n');
4983 strbuf_addf(buf, " %.*s\n", item->arg_len,
4984 todo_item_get_arg(todo_list, item));
4988 int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
4989 const char *file, const char *shortrevisions,
4990 const char *shortonto, int num, unsigned flags)
4993 struct strbuf buf = STRBUF_INIT;
4995 todo_list_to_strbuf(r, todo_list, &buf, num, flags);
4996 if (flags & TODO_LIST_APPEND_TODO_HELP)
4997 append_todo_help(count_commands(todo_list),
4998 shortrevisions, shortonto, &buf);
5000 res = write_message(buf.buf, buf.len, file, 0);
5001 strbuf_release(&buf);
5006 /* skip picking commits whose parents are unchanged */
5007 static int skip_unnecessary_picks(struct repository *r,
5008 struct todo_list *todo_list,
5009 struct object_id *base_oid)
5011 struct object_id *parent_oid;
5014 for (i = 0; i < todo_list->nr; i++) {
5015 struct todo_item *item = todo_list->items + i;
5017 if (item->command >= TODO_NOOP)
5019 if (item->command != TODO_PICK)
5021 if (parse_commit(item->commit)) {
5022 return error(_("could not parse commit '%s'"),
5023 oid_to_hex(&item->commit->object.oid));
5025 if (!item->commit->parents)
5026 break; /* root commit */
5027 if (item->commit->parents->next)
5028 break; /* merge commit */
5029 parent_oid = &item->commit->parents->item->object.oid;
5030 if (!oideq(parent_oid, base_oid))
5032 oidcpy(base_oid, &item->commit->object.oid);
5035 const char *done_path = rebase_path_done();
5037 if (todo_list_write_to_file(r, todo_list, done_path, NULL, NULL, i, 0)) {
5038 error_errno(_("could not write to '%s'"), done_path);
5042 MOVE_ARRAY(todo_list->items, todo_list->items + i, todo_list->nr - i);
5044 todo_list->current = 0;
5045 todo_list->done_nr += i;
5047 if (is_fixup(peek_command(todo_list, 0)))
5048 record_in_rewritten(base_oid, peek_command(todo_list, 0));
5054 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
5055 const char *shortrevisions, const char *onto_name,
5056 struct commit *onto, const char *orig_head,
5057 struct string_list *commands, unsigned autosquash,
5058 struct todo_list *todo_list)
5060 const char *shortonto, *todo_file = rebase_path_todo();
5061 struct todo_list new_todo = TODO_LIST_INIT;
5062 struct strbuf *buf = &todo_list->buf, buf2 = STRBUF_INIT;
5063 struct object_id oid = onto->object.oid;
5066 shortonto = find_unique_abbrev(&oid, DEFAULT_ABBREV);
5068 if (buf->len == 0) {
5069 struct todo_item *item = append_new_todo(todo_list);
5070 item->command = TODO_NOOP;
5071 item->commit = NULL;
5072 item->arg_len = item->arg_offset = item->flags = item->offset_in_buf = 0;
5075 if (autosquash && todo_list_rearrange_squash(todo_list))
5079 todo_list_add_exec_commands(todo_list, commands);
5081 if (count_commands(todo_list) == 0) {
5082 apply_autostash(opts);
5083 sequencer_remove_state(opts);
5085 return error(_("nothing to do"));
5088 res = edit_todo_list(r, todo_list, &new_todo, shortrevisions,
5092 else if (res == -2) {
5093 apply_autostash(opts);
5094 sequencer_remove_state(opts);
5097 } else if (res == -3) {
5098 apply_autostash(opts);
5099 sequencer_remove_state(opts);
5100 todo_list_release(&new_todo);
5102 return error(_("nothing to do"));
5103 } else if (res == -4) {
5104 checkout_onto(r, opts, onto_name, &onto->object.oid, orig_head);
5105 todo_list_release(&new_todo);
5110 /* Expand the commit IDs */
5111 todo_list_to_strbuf(r, &new_todo, &buf2, -1, 0);
5112 strbuf_swap(&new_todo.buf, &buf2);
5113 strbuf_release(&buf2);
5114 new_todo.total_nr -= new_todo.nr;
5115 if (todo_list_parse_insn_buffer(r, new_todo.buf.buf, &new_todo) < 0)
5116 BUG("invalid todo list after expanding IDs:\n%s",
5119 if (opts->allow_ff && skip_unnecessary_picks(r, &new_todo, &oid)) {
5120 todo_list_release(&new_todo);
5121 return error(_("could not skip unnecessary pick commands"));
5124 if (todo_list_write_to_file(r, &new_todo, todo_file, NULL, NULL, -1,
5125 flags & ~(TODO_LIST_SHORTEN_IDS))) {
5126 todo_list_release(&new_todo);
5127 return error_errno(_("could not write '%s'"), todo_file);
5132 if (checkout_onto(r, opts, onto_name, &oid, orig_head))
5135 if (require_clean_work_tree(r, "rebase", "", 1, 1))
5138 todo_list_write_total_nr(&new_todo);
5139 res = pick_commits(r, &new_todo, opts);
5142 todo_list_release(&new_todo);
5147 struct subject2item_entry {
5148 struct hashmap_entry entry;
5150 char subject[FLEX_ARRAY];
5153 static int subject2item_cmp(const void *fndata,
5154 const struct hashmap_entry *eptr,
5155 const struct hashmap_entry *entry_or_key,
5158 const struct subject2item_entry *a, *b;
5160 a = container_of(eptr, const struct subject2item_entry, entry);
5161 b = container_of(entry_or_key, const struct subject2item_entry, entry);
5163 return key ? strcmp(a->subject, key) : strcmp(a->subject, b->subject);
5166 define_commit_slab(commit_todo_item, struct todo_item *);
5169 * Rearrange the todo list that has both "pick commit-id msg" and "pick
5170 * commit-id fixup!/squash! msg" in it so that the latter is put immediately
5171 * after the former, and change "pick" to "fixup"/"squash".
5173 * Note that if the config has specified a custom instruction format, each log
5174 * message will have to be retrieved from the commit (as the oneline in the
5175 * script cannot be trusted) in order to normalize the autosquash arrangement.
5177 int todo_list_rearrange_squash(struct todo_list *todo_list)
5179 struct hashmap subject2item;
5180 int rearranged = 0, *next, *tail, i, nr = 0, alloc = 0;
5182 struct commit_todo_item commit_todo;
5183 struct todo_item *items = NULL;
5185 init_commit_todo_item(&commit_todo);
5187 * The hashmap maps onelines to the respective todo list index.
5189 * If any items need to be rearranged, the next[i] value will indicate
5190 * which item was moved directly after the i'th.
5192 * In that case, last[i] will indicate the index of the latest item to
5193 * be moved to appear after the i'th.
5195 hashmap_init(&subject2item, subject2item_cmp, NULL, todo_list->nr);
5196 ALLOC_ARRAY(next, todo_list->nr);
5197 ALLOC_ARRAY(tail, todo_list->nr);
5198 ALLOC_ARRAY(subjects, todo_list->nr);
5199 for (i = 0; i < todo_list->nr; i++) {
5200 struct strbuf buf = STRBUF_INIT;
5201 struct todo_item *item = todo_list->items + i;
5202 const char *commit_buffer, *subject, *p;
5205 struct subject2item_entry *entry;
5207 next[i] = tail[i] = -1;
5208 if (!item->commit || item->command == TODO_DROP) {
5213 if (is_fixup(item->command)) {
5214 clear_commit_todo_item(&commit_todo);
5215 return error(_("the script was already rearranged."));
5218 *commit_todo_item_at(&commit_todo, item->commit) = item;
5220 parse_commit(item->commit);
5221 commit_buffer = logmsg_reencode(item->commit, NULL, "UTF-8");
5222 find_commit_subject(commit_buffer, &subject);
5223 format_subject(&buf, subject, " ");
5224 subject = subjects[i] = strbuf_detach(&buf, &subject_len);
5225 unuse_commit_buffer(item->commit, commit_buffer);
5226 if ((skip_prefix(subject, "fixup! ", &p) ||
5227 skip_prefix(subject, "squash! ", &p))) {
5228 struct commit *commit2;
5233 if (!skip_prefix(p, "fixup! ", &p) &&
5234 !skip_prefix(p, "squash! ", &p))
5238 entry = hashmap_get_entry_from_hash(&subject2item,
5240 struct subject2item_entry,
5243 /* found by title */
5245 else if (!strchr(p, ' ') &&
5247 lookup_commit_reference_by_name(p)) &&
5248 *commit_todo_item_at(&commit_todo, commit2))
5249 /* found by commit name */
5250 i2 = *commit_todo_item_at(&commit_todo, commit2)
5253 /* copy can be a prefix of the commit subject */
5254 for (i2 = 0; i2 < i; i2++)
5256 starts_with(subjects[i2], p))
5264 todo_list->items[i].command =
5265 starts_with(subject, "fixup!") ?
5266 TODO_FIXUP : TODO_SQUASH;
5272 } else if (!hashmap_get_from_hash(&subject2item,
5273 strhash(subject), subject)) {
5274 FLEX_ALLOC_MEM(entry, subject, subject, subject_len);
5276 hashmap_entry_init(&entry->entry,
5277 strhash(entry->subject));
5278 hashmap_put(&subject2item, &entry->entry);
5283 for (i = 0; i < todo_list->nr; i++) {
5284 enum todo_command command = todo_list->items[i].command;
5288 * Initially, all commands are 'pick's. If it is a
5289 * fixup or a squash now, we have rearranged it.
5291 if (is_fixup(command))
5295 ALLOC_GROW(items, nr + 1, alloc);
5296 items[nr++] = todo_list->items[cur];
5301 FREE_AND_NULL(todo_list->items);
5302 todo_list->items = items;
5304 todo_list->alloc = alloc;
5309 for (i = 0; i < todo_list->nr; i++)
5312 hashmap_free_entries(&subject2item, struct subject2item_entry, entry);
5314 clear_commit_todo_item(&commit_todo);