5 #include "object-store.h"
10 #include "run-command.h"
13 #include "cache-tree.h"
17 #include "merge-recursive.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"
37 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
39 static const char sign_off_header[] = "Signed-off-by: ";
40 static const char cherry_picked_prefix[] = "(cherry picked from commit ";
42 GIT_PATH_FUNC(git_path_commit_editmsg, "COMMIT_EDITMSG")
44 static GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
46 static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
47 static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
48 static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
49 static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
51 static GIT_PATH_FUNC(rebase_path, "rebase-merge")
53 * The file containing rebase commands, comments, and empty lines.
54 * This file is created by "git rebase -i" then edited by the user. As
55 * the lines are processed, they are removed from the front of this
56 * file and written to the tail of 'done'.
58 GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
59 GIT_PATH_FUNC(rebase_path_todo_backup, "rebase-merge/git-rebase-todo.backup")
61 GIT_PATH_FUNC(rebase_path_dropped, "rebase-merge/dropped")
64 * The rebase command lines that have already been processed. A line
65 * is moved here when it is first handled, before any associated user
68 static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
70 * The file to keep track of how many commands were already processed (e.g.
73 static GIT_PATH_FUNC(rebase_path_msgnum, "rebase-merge/msgnum")
75 * The file to keep track of how many commands are to be processed in total
76 * (e.g. for the prompt).
78 static GIT_PATH_FUNC(rebase_path_msgtotal, "rebase-merge/end")
80 * The commit message that is planned to be used for any changes that
81 * need to be committed following a user interaction.
83 static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
85 * The file into which is accumulated the suggested commit message for
86 * squash/fixup commands. When the first of a series of squash/fixups
87 * is seen, the file is created and the commit message from the
88 * previous commit and from the first squash/fixup commit are written
89 * to it. The commit message for each subsequent squash/fixup commit
90 * is appended to the file as it is processed.
92 static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
94 * If the current series of squash/fixups has not yet included a squash
95 * command, then this file exists and holds the commit message of the
96 * original "pick" commit. (If the series ends without a "squash"
97 * command, then this can be used as the commit message of the combined
98 * commit without opening the editor.)
100 static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
102 * This file contains the list fixup/squash commands that have been
103 * accumulated into message-fixup or message-squash so far.
105 static GIT_PATH_FUNC(rebase_path_current_fixups, "rebase-merge/current-fixups")
107 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
108 * GIT_AUTHOR_DATE that will be used for the commit that is currently
111 static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
113 * When an "edit" rebase command is being processed, the SHA1 of the
114 * commit to be edited is recorded in this file. When "git rebase
115 * --continue" is executed, if there are any staged changes then they
116 * will be amended to the HEAD commit, but only provided the HEAD
117 * commit is still the commit to be edited. When any other rebase
118 * command is processed, this file is deleted.
120 static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
122 * When we stop at a given patch via the "edit" command, this file contains
123 * the commit object name of the corresponding patch.
125 static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
127 * For the post-rewrite hook, we make a list of rewritten commits and
128 * their new sha1s. The rewritten-pending list keeps the sha1s of
129 * commits that have been processed, but not committed yet,
130 * e.g. because they are waiting for a 'squash' command.
132 static GIT_PATH_FUNC(rebase_path_rewritten_list, "rebase-merge/rewritten-list")
133 static GIT_PATH_FUNC(rebase_path_rewritten_pending,
134 "rebase-merge/rewritten-pending")
137 * The path of the file containing the OID of the "squash onto" commit, i.e.
138 * the dummy commit used for `reset [new root]`.
140 static GIT_PATH_FUNC(rebase_path_squash_onto, "rebase-merge/squash-onto")
143 * The path of the file listing refs that need to be deleted after the rebase
144 * finishes. This is used by the `label` command to record the need for cleanup.
146 static GIT_PATH_FUNC(rebase_path_refs_to_delete, "rebase-merge/refs-to-delete")
149 * The following files are written by git-rebase just after parsing the
152 static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
153 static GIT_PATH_FUNC(rebase_path_cdate_is_adate, "rebase-merge/cdate_is_adate")
154 static GIT_PATH_FUNC(rebase_path_ignore_date, "rebase-merge/ignore_date")
155 static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
156 static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
157 static GIT_PATH_FUNC(rebase_path_quiet, "rebase-merge/quiet")
158 static GIT_PATH_FUNC(rebase_path_signoff, "rebase-merge/signoff")
159 static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
160 static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
161 static GIT_PATH_FUNC(rebase_path_autostash, "rebase-merge/autostash")
162 static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy")
163 static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts")
164 static GIT_PATH_FUNC(rebase_path_allow_rerere_autoupdate, "rebase-merge/allow_rerere_autoupdate")
165 static GIT_PATH_FUNC(rebase_path_reschedule_failed_exec, "rebase-merge/reschedule-failed-exec")
166 static GIT_PATH_FUNC(rebase_path_drop_redundant_commits, "rebase-merge/drop_redundant_commits")
167 static GIT_PATH_FUNC(rebase_path_keep_redundant_commits, "rebase-merge/keep_redundant_commits")
169 static int git_sequencer_config(const char *k, const char *v, void *cb)
171 struct replay_opts *opts = cb;
174 if (!strcmp(k, "commit.cleanup")) {
177 status = git_config_string(&s, k, v);
181 if (!strcmp(s, "verbatim")) {
182 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
183 opts->explicit_cleanup = 1;
184 } else if (!strcmp(s, "whitespace")) {
185 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE;
186 opts->explicit_cleanup = 1;
187 } else if (!strcmp(s, "strip")) {
188 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_ALL;
189 opts->explicit_cleanup = 1;
190 } else if (!strcmp(s, "scissors")) {
191 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SCISSORS;
192 opts->explicit_cleanup = 1;
194 warning(_("invalid commit message cleanup mode '%s'"),
202 if (!strcmp(k, "commit.gpgsign")) {
203 opts->gpg_sign = git_config_bool(k, v) ? xstrdup("") : NULL;
207 status = git_gpg_config(k, v, NULL);
211 return git_diff_basic_config(k, v, NULL);
214 void sequencer_init_config(struct replay_opts *opts)
216 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
217 git_config(git_sequencer_config, opts);
220 static inline int is_rebase_i(const struct replay_opts *opts)
222 return opts->action == REPLAY_INTERACTIVE_REBASE;
225 static const char *get_dir(const struct replay_opts *opts)
227 if (is_rebase_i(opts))
228 return rebase_path();
229 return git_path_seq_dir();
232 static const char *get_todo_path(const struct replay_opts *opts)
234 if (is_rebase_i(opts))
235 return rebase_path_todo();
236 return git_path_todo_file();
240 * Returns 0 for non-conforming footer
241 * Returns 1 for conforming footer
242 * Returns 2 when sob exists within conforming footer
243 * Returns 3 when sob exists within conforming footer as last entry
245 static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
246 size_t ignore_footer)
248 struct process_trailer_options opts = PROCESS_TRAILER_OPTIONS_INIT;
249 struct trailer_info info;
251 int found_sob = 0, found_sob_last = 0;
257 saved_char = sb->buf[sb->len - ignore_footer];
258 sb->buf[sb->len - ignore_footer] = '\0';
261 trailer_info_get(&info, sb->buf, &opts);
264 sb->buf[sb->len - ignore_footer] = saved_char;
266 if (info.trailer_start == info.trailer_end)
269 for (i = 0; i < info.trailer_nr; i++)
270 if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
272 if (i == info.trailer_nr - 1)
276 trailer_info_release(&info);
285 static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
287 static struct strbuf buf = STRBUF_INIT;
291 sq_quotef(&buf, "-S%s", opts->gpg_sign);
295 int sequencer_remove_state(struct replay_opts *opts)
297 struct strbuf buf = STRBUF_INIT;
300 if (is_rebase_i(opts) &&
301 strbuf_read_file(&buf, rebase_path_refs_to_delete(), 0) > 0) {
304 char *eol = strchr(p, '\n');
307 if (delete_ref("(rebase) cleanup", p, NULL, 0) < 0) {
308 warning(_("could not delete '%s'"), p);
317 free(opts->committer_name);
318 free(opts->committer_email);
319 free(opts->gpg_sign);
320 free(opts->strategy);
321 for (i = 0; i < opts->xopts_nr; i++)
322 free(opts->xopts[i]);
324 strbuf_release(&opts->current_fixups);
327 strbuf_addstr(&buf, get_dir(opts));
328 if (remove_dir_recursively(&buf, 0))
329 ret = error(_("could not remove '%s'"), buf.buf);
330 strbuf_release(&buf);
335 static const char *action_name(const struct replay_opts *opts)
337 switch (opts->action) {
341 return N_("cherry-pick");
342 case REPLAY_INTERACTIVE_REBASE:
345 die(_("unknown action: %d"), opts->action);
348 struct commit_message {
355 static const char *short_commit_name(struct commit *commit)
357 return find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV);
360 static int get_message(struct commit *commit, struct commit_message *out)
362 const char *abbrev, *subject;
365 out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
366 abbrev = short_commit_name(commit);
368 subject_len = find_commit_subject(out->message, &subject);
370 out->subject = xmemdupz(subject, subject_len);
371 out->label = xstrfmt("%s (%s)", abbrev, out->subject);
372 out->parent_label = xstrfmt("parent of %s", out->label);
377 static void free_message(struct commit *commit, struct commit_message *msg)
379 free(msg->parent_label);
382 unuse_commit_buffer(commit, msg->message);
385 static void print_advice(struct repository *r, int show_hint,
386 struct replay_opts *opts)
388 char *msg = getenv("GIT_CHERRY_PICK_HELP");
391 fprintf(stderr, "%s\n", msg);
393 * A conflict has occurred but the porcelain
394 * (typically rebase --interactive) wants to take care
395 * of the commit itself so remove CHERRY_PICK_HEAD
397 refs_delete_ref(get_main_ref_store(r), "", "CHERRY_PICK_HEAD",
404 advise(_("after resolving the conflicts, mark the corrected paths\n"
405 "with 'git add <paths>' or 'git rm <paths>'"));
407 advise(_("after resolving the conflicts, mark the corrected paths\n"
408 "with 'git add <paths>' or 'git rm <paths>'\n"
409 "and commit the result with 'git commit'"));
413 static int write_message(const void *buf, size_t len, const char *filename,
416 struct lock_file msg_file = LOCK_INIT;
418 int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
420 return error_errno(_("could not lock '%s'"), filename);
421 if (write_in_full(msg_fd, buf, len) < 0) {
422 error_errno(_("could not write to '%s'"), filename);
423 rollback_lock_file(&msg_file);
426 if (append_eol && write(msg_fd, "\n", 1) < 0) {
427 error_errno(_("could not write eol to '%s'"), filename);
428 rollback_lock_file(&msg_file);
431 if (commit_lock_file(&msg_file) < 0)
432 return error(_("failed to finalize '%s'"), filename);
437 int read_oneliner(struct strbuf *buf,
438 const char *path, unsigned flags)
440 int orig_len = buf->len;
442 if (strbuf_read_file(buf, path, 0) < 0) {
443 if ((flags & READ_ONELINER_WARN_MISSING) ||
444 (errno != ENOENT && errno != ENOTDIR))
445 warning_errno(_("could not read '%s'"), path);
449 if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
450 if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
452 buf->buf[buf->len] = '\0';
455 if ((flags & READ_ONELINER_SKIP_IF_EMPTY) && buf->len == orig_len)
461 static struct tree *empty_tree(struct repository *r)
463 return lookup_tree(r, the_hash_algo->empty_tree);
466 static int error_dirty_index(struct repository *repo, struct replay_opts *opts)
468 if (repo_read_index_unmerged(repo))
469 return error_resolve_conflict(_(action_name(opts)));
471 error(_("your local changes would be overwritten by %s."),
472 _(action_name(opts)));
474 if (advice_commit_before_merge)
475 advise(_("commit your changes or stash them to proceed."));
479 static void update_abort_safety_file(void)
481 struct object_id head;
483 /* Do nothing on a single-pick */
484 if (!file_exists(git_path_seq_dir()))
487 if (!get_oid("HEAD", &head))
488 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
490 write_file(git_path_abort_safety_file(), "%s", "");
493 static int fast_forward_to(struct repository *r,
494 const struct object_id *to,
495 const struct object_id *from,
497 struct replay_opts *opts)
499 struct ref_transaction *transaction;
500 struct strbuf sb = STRBUF_INIT;
501 struct strbuf err = STRBUF_INIT;
504 if (checkout_fast_forward(r, from, to, 1))
505 return -1; /* the callee should have complained already */
507 strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
509 transaction = ref_transaction_begin(&err);
511 ref_transaction_update(transaction, "HEAD",
512 to, unborn && !is_rebase_i(opts) ?
515 ref_transaction_commit(transaction, &err)) {
516 ref_transaction_free(transaction);
517 error("%s", err.buf);
519 strbuf_release(&err);
524 strbuf_release(&err);
525 ref_transaction_free(transaction);
526 update_abort_safety_file();
530 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
533 if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
534 return use_editor ? COMMIT_MSG_CLEANUP_ALL :
535 COMMIT_MSG_CLEANUP_SPACE;
536 else if (!strcmp(cleanup_arg, "verbatim"))
537 return COMMIT_MSG_CLEANUP_NONE;
538 else if (!strcmp(cleanup_arg, "whitespace"))
539 return COMMIT_MSG_CLEANUP_SPACE;
540 else if (!strcmp(cleanup_arg, "strip"))
541 return COMMIT_MSG_CLEANUP_ALL;
542 else if (!strcmp(cleanup_arg, "scissors"))
543 return use_editor ? COMMIT_MSG_CLEANUP_SCISSORS :
544 COMMIT_MSG_CLEANUP_SPACE;
546 die(_("Invalid cleanup mode %s"), cleanup_arg);
550 * NB using int rather than enum cleanup_mode to stop clang's
551 * -Wtautological-constant-out-of-range-compare complaining that the comparison
554 static const char *describe_cleanup_mode(int cleanup_mode)
556 static const char *modes[] = { "whitespace",
561 if (cleanup_mode < ARRAY_SIZE(modes))
562 return modes[cleanup_mode];
564 BUG("invalid cleanup_mode provided (%d)", cleanup_mode);
567 void append_conflicts_hint(struct index_state *istate,
568 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode)
572 if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
573 strbuf_addch(msgbuf, '\n');
574 wt_status_append_cut_line(msgbuf);
575 strbuf_addch(msgbuf, comment_line_char);
578 strbuf_addch(msgbuf, '\n');
579 strbuf_commented_addf(msgbuf, "Conflicts:\n");
580 for (i = 0; i < istate->cache_nr;) {
581 const struct cache_entry *ce = istate->cache[i++];
583 strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
584 while (i < istate->cache_nr &&
585 !strcmp(ce->name, istate->cache[i]->name))
591 static int do_recursive_merge(struct repository *r,
592 struct commit *base, struct commit *next,
593 const char *base_label, const char *next_label,
594 struct object_id *head, struct strbuf *msgbuf,
595 struct replay_opts *opts)
597 struct merge_options o;
598 struct tree *next_tree, *base_tree, *head_tree;
601 struct lock_file index_lock = LOCK_INIT;
603 if (repo_hold_locked_index(r, &index_lock, LOCK_REPORT_ON_ERROR) < 0)
608 init_merge_options(&o, r);
609 o.ancestor = base ? base_label : "(empty tree)";
611 o.branch2 = next ? next_label : "(empty tree)";
612 if (is_rebase_i(opts))
614 o.show_rename_progress = 1;
616 head_tree = parse_tree_indirect(head);
617 next_tree = next ? get_commit_tree(next) : empty_tree(r);
618 base_tree = base ? get_commit_tree(base) : empty_tree(r);
620 for (i = 0; i < opts->xopts_nr; i++)
621 parse_merge_opt(&o, opts->xopts[i]);
623 clean = merge_trees(&o,
625 next_tree, base_tree);
626 if (is_rebase_i(opts) && clean <= 0)
627 fputs(o.obuf.buf, stdout);
628 strbuf_release(&o.obuf);
630 rollback_lock_file(&index_lock);
634 if (write_locked_index(r->index, &index_lock,
635 COMMIT_LOCK | SKIP_IF_UNCHANGED))
637 * TRANSLATORS: %s will be "revert", "cherry-pick" or
640 return error(_("%s: Unable to write new index file"),
641 _(action_name(opts)));
644 append_conflicts_hint(r->index, msgbuf,
645 opts->default_msg_cleanup);
650 static struct object_id *get_cache_tree_oid(struct index_state *istate)
652 if (!istate->cache_tree)
653 istate->cache_tree = cache_tree();
655 if (!cache_tree_fully_valid(istate->cache_tree))
656 if (cache_tree_update(istate, 0)) {
657 error(_("unable to update cache tree"));
661 return &istate->cache_tree->oid;
664 static int is_index_unchanged(struct repository *r)
666 struct object_id head_oid, *cache_tree_oid;
667 struct commit *head_commit;
668 struct index_state *istate = r->index;
670 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, &head_oid, NULL))
671 return error(_("could not resolve HEAD commit"));
673 head_commit = lookup_commit(r, &head_oid);
676 * If head_commit is NULL, check_commit, called from
677 * lookup_commit, would have indicated that head_commit is not
678 * a commit object already. parse_commit() will return failure
679 * without further complaints in such a case. Otherwise, if
680 * the commit is invalid, parse_commit() will complain. So
681 * there is nothing for us to say here. Just return failure.
683 if (parse_commit(head_commit))
686 if (!(cache_tree_oid = get_cache_tree_oid(istate)))
689 return oideq(cache_tree_oid, get_commit_tree_oid(head_commit));
692 static int write_author_script(const char *message)
694 struct strbuf buf = STRBUF_INIT;
699 if (!*message || starts_with(message, "\n")) {
701 /* Missing 'author' line? */
702 unlink(rebase_path_author_script());
704 } else if (skip_prefix(message, "author ", &message))
706 else if ((eol = strchr(message, '\n')))
711 strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
712 while (*message && *message != '\n' && *message != '\r')
713 if (skip_prefix(message, " <", &message))
715 else if (*message != '\'')
716 strbuf_addch(&buf, *(message++));
718 strbuf_addf(&buf, "'\\%c'", *(message++));
719 strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
720 while (*message && *message != '\n' && *message != '\r')
721 if (skip_prefix(message, "> ", &message))
723 else if (*message != '\'')
724 strbuf_addch(&buf, *(message++));
726 strbuf_addf(&buf, "'\\%c'", *(message++));
727 strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
728 while (*message && *message != '\n' && *message != '\r')
729 if (*message != '\'')
730 strbuf_addch(&buf, *(message++));
732 strbuf_addf(&buf, "'\\%c'", *(message++));
733 strbuf_addch(&buf, '\'');
734 res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
735 strbuf_release(&buf);
740 * Take a series of KEY='VALUE' lines where VALUE part is
741 * sq-quoted, and append <KEY, VALUE> at the end of the string list
743 static int parse_key_value_squoted(char *buf, struct string_list *list)
746 struct string_list_item *item;
748 char *cp = strchr(buf, '=');
750 np = strchrnul(buf, '\n');
751 return error(_("no key present in '%.*s'"),
752 (int) (np - buf), buf);
754 np = strchrnul(cp, '\n');
756 item = string_list_append(list, buf);
758 buf = np + (*np == '\n');
762 return error(_("unable to dequote value of '%s'"),
764 item->util = xstrdup(cp);
770 * Reads and parses the state directory's "author-script" file, and sets name,
771 * email and date accordingly.
772 * Returns 0 on success, -1 if the file could not be parsed.
774 * The author script is of the format:
776 * GIT_AUTHOR_NAME='$author_name'
777 * GIT_AUTHOR_EMAIL='$author_email'
778 * GIT_AUTHOR_DATE='$author_date'
780 * where $author_name, $author_email and $author_date are quoted. We are strict
781 * with our parsing, as the file was meant to be eval'd in the now-removed
782 * git-am.sh/git-rebase--interactive.sh scripts, and thus if the file differs
783 * from what this function expects, it is better to bail out than to do
784 * something that the user does not expect.
786 int read_author_script(const char *path, char **name, char **email, char **date,
789 struct strbuf buf = STRBUF_INIT;
790 struct string_list kv = STRING_LIST_INIT_DUP;
791 int retval = -1; /* assume failure */
792 int i, name_i = -2, email_i = -2, date_i = -2, err = 0;
794 if (strbuf_read_file(&buf, path, 256) <= 0) {
795 strbuf_release(&buf);
796 if (errno == ENOENT && allow_missing)
799 return error_errno(_("could not open '%s' for reading"),
803 if (parse_key_value_squoted(buf.buf, &kv))
806 for (i = 0; i < kv.nr; i++) {
807 if (!strcmp(kv.items[i].string, "GIT_AUTHOR_NAME")) {
809 name_i = error(_("'GIT_AUTHOR_NAME' already given"));
812 } else if (!strcmp(kv.items[i].string, "GIT_AUTHOR_EMAIL")) {
814 email_i = error(_("'GIT_AUTHOR_EMAIL' already given"));
817 } else if (!strcmp(kv.items[i].string, "GIT_AUTHOR_DATE")) {
819 date_i = error(_("'GIT_AUTHOR_DATE' already given"));
823 err = error(_("unknown variable '%s'"),
828 error(_("missing 'GIT_AUTHOR_NAME'"));
830 error(_("missing 'GIT_AUTHOR_EMAIL'"));
832 error(_("missing 'GIT_AUTHOR_DATE'"));
833 if (date_i < 0 || email_i < 0 || date_i < 0 || err)
835 *name = kv.items[name_i].util;
836 *email = kv.items[email_i].util;
837 *date = kv.items[date_i].util;
840 string_list_clear(&kv, !!retval);
841 strbuf_release(&buf);
846 * Read a GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL AND GIT_AUTHOR_DATE from a
847 * file with shell quoting into struct strvec. Returns -1 on
848 * error, 0 otherwise.
850 static int read_env_script(struct strvec *env)
852 char *name, *email, *date;
854 if (read_author_script(rebase_path_author_script(),
855 &name, &email, &date, 0))
858 strvec_pushf(env, "GIT_AUTHOR_NAME=%s", name);
859 strvec_pushf(env, "GIT_AUTHOR_EMAIL=%s", email);
860 strvec_pushf(env, "GIT_AUTHOR_DATE=%s", date);
868 static char *get_author(const char *message)
873 a = find_commit_header(message, "author", &len);
875 return xmemdupz(a, len);
880 static const char *author_date_from_env_array(const struct strvec *env)
885 for (i = 0; i < env->nr; i++)
886 if (skip_prefix(env->v[i],
887 "GIT_AUTHOR_DATE=", &date))
890 * If GIT_AUTHOR_DATE is missing we should have already errored out when
893 BUG("GIT_AUTHOR_DATE missing from author script");
896 static const char staged_changes_advice[] =
897 N_("you have staged changes in your working tree\n"
898 "If these changes are meant to be squashed into the previous commit, run:\n"
900 " git commit --amend %s\n"
902 "If they are meant to go into a new commit, run:\n"
906 "In both cases, once you're done, continue with:\n"
908 " git rebase --continue\n");
910 #define ALLOW_EMPTY (1<<0)
911 #define EDIT_MSG (1<<1)
912 #define AMEND_MSG (1<<2)
913 #define CLEANUP_MSG (1<<3)
914 #define VERIFY_MSG (1<<4)
915 #define CREATE_ROOT_COMMIT (1<<5)
917 static int run_command_silent_on_success(struct child_process *cmd)
919 struct strbuf buf = STRBUF_INIT;
922 cmd->stdout_to_stderr = 1;
923 rc = pipe_command(cmd,
929 fputs(buf.buf, stderr);
930 strbuf_release(&buf);
935 * If we are cherry-pick, and if the merge did not result in
936 * hand-editing, we will hit this commit and inherit the original
937 * author date and name.
939 * If we are revert, or if our cherry-pick results in a hand merge,
940 * we had better say that the current user is responsible for that.
942 * An exception is when run_git_commit() is called during an
943 * interactive rebase: in that case, we will want to retain the
946 static int run_git_commit(const char *defmsg,
947 struct replay_opts *opts,
950 struct child_process cmd = CHILD_PROCESS_INIT;
954 if (is_rebase_i(opts) && read_env_script(&cmd.env_array)) {
955 const char *gpg_opt = gpg_sign_opt_quoted(opts);
957 return error(_(staged_changes_advice),
961 if (opts->committer_date_is_author_date)
962 strvec_pushf(&cmd.env_array, "GIT_COMMITTER_DATE=%s",
965 author_date_from_env_array(&cmd.env_array));
966 if (opts->ignore_date)
967 strvec_push(&cmd.env_array, "GIT_AUTHOR_DATE=");
969 strvec_push(&cmd.args, "commit");
971 if (!(flags & VERIFY_MSG))
972 strvec_push(&cmd.args, "-n");
973 if ((flags & AMEND_MSG))
974 strvec_push(&cmd.args, "--amend");
976 strvec_pushf(&cmd.args, "-S%s", opts->gpg_sign);
978 strvec_push(&cmd.args, "--no-gpg-sign");
980 strvec_pushl(&cmd.args, "-F", defmsg, NULL);
981 else if (!(flags & EDIT_MSG))
982 strvec_pushl(&cmd.args, "-C", "HEAD", NULL);
983 if ((flags & CLEANUP_MSG))
984 strvec_push(&cmd.args, "--cleanup=strip");
985 if ((flags & EDIT_MSG))
986 strvec_push(&cmd.args, "-e");
987 else if (!(flags & CLEANUP_MSG) &&
988 !opts->signoff && !opts->record_origin &&
989 !opts->explicit_cleanup)
990 strvec_push(&cmd.args, "--cleanup=verbatim");
992 if ((flags & ALLOW_EMPTY))
993 strvec_push(&cmd.args, "--allow-empty");
995 if (!(flags & EDIT_MSG))
996 strvec_push(&cmd.args, "--allow-empty-message");
998 if (is_rebase_i(opts) && !(flags & EDIT_MSG))
999 return run_command_silent_on_success(&cmd);
1001 return run_command(&cmd);
1004 static int rest_is_empty(const struct strbuf *sb, int start)
1009 /* Check if the rest is just whitespace and Signed-off-by's. */
1010 for (i = start; i < sb->len; i++) {
1011 nl = memchr(sb->buf + i, '\n', sb->len - i);
1017 if (strlen(sign_off_header) <= eol - i &&
1018 starts_with(sb->buf + i, sign_off_header)) {
1023 if (!isspace(sb->buf[i++]))
1030 void cleanup_message(struct strbuf *msgbuf,
1031 enum commit_msg_cleanup_mode cleanup_mode, int verbose)
1033 if (verbose || /* Truncate the message just before the diff, if any. */
1034 cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS)
1035 strbuf_setlen(msgbuf, wt_status_locate_end(msgbuf->buf, msgbuf->len));
1036 if (cleanup_mode != COMMIT_MSG_CLEANUP_NONE)
1037 strbuf_stripspace(msgbuf, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
1041 * Find out if the message in the strbuf contains only whitespace and
1042 * Signed-off-by lines.
1044 int message_is_empty(const struct strbuf *sb,
1045 enum commit_msg_cleanup_mode cleanup_mode)
1047 if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
1049 return rest_is_empty(sb, 0);
1053 * See if the user edited the message in the editor or left what
1054 * was in the template intact
1056 int template_untouched(const struct strbuf *sb, const char *template_file,
1057 enum commit_msg_cleanup_mode cleanup_mode)
1059 struct strbuf tmpl = STRBUF_INIT;
1062 if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
1065 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
1068 strbuf_stripspace(&tmpl, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
1069 if (!skip_prefix(sb->buf, tmpl.buf, &start))
1071 strbuf_release(&tmpl);
1072 return rest_is_empty(sb, start - sb->buf);
1075 int update_head_with_reflog(const struct commit *old_head,
1076 const struct object_id *new_head,
1077 const char *action, const struct strbuf *msg,
1080 struct ref_transaction *transaction;
1081 struct strbuf sb = STRBUF_INIT;
1086 strbuf_addstr(&sb, action);
1087 strbuf_addstr(&sb, ": ");
1090 nl = strchr(msg->buf, '\n');
1092 strbuf_add(&sb, msg->buf, nl + 1 - msg->buf);
1094 strbuf_addbuf(&sb, msg);
1095 strbuf_addch(&sb, '\n');
1098 transaction = ref_transaction_begin(err);
1100 ref_transaction_update(transaction, "HEAD", new_head,
1101 old_head ? &old_head->object.oid : &null_oid,
1103 ref_transaction_commit(transaction, err)) {
1106 ref_transaction_free(transaction);
1107 strbuf_release(&sb);
1112 static int run_rewrite_hook(const struct object_id *oldoid,
1113 const struct object_id *newoid)
1115 struct child_process proc = CHILD_PROCESS_INIT;
1116 const char *argv[3];
1118 struct strbuf sb = STRBUF_INIT;
1120 argv[0] = find_hook("post-rewrite");
1129 proc.stdout_to_stderr = 1;
1130 proc.trace2_hook_name = "post-rewrite";
1132 code = start_command(&proc);
1135 strbuf_addf(&sb, "%s %s\n", oid_to_hex(oldoid), oid_to_hex(newoid));
1136 sigchain_push(SIGPIPE, SIG_IGN);
1137 write_in_full(proc.in, sb.buf, sb.len);
1139 strbuf_release(&sb);
1140 sigchain_pop(SIGPIPE);
1141 return finish_command(&proc);
1144 void commit_post_rewrite(struct repository *r,
1145 const struct commit *old_head,
1146 const struct object_id *new_head)
1148 struct notes_rewrite_cfg *cfg;
1150 cfg = init_copy_notes_for_rewrite("amend");
1152 /* we are amending, so old_head is not NULL */
1153 copy_note_for_rewrite(cfg, &old_head->object.oid, new_head);
1154 finish_copy_notes_for_rewrite(r, cfg, "Notes added by 'git commit --amend'");
1156 run_rewrite_hook(&old_head->object.oid, new_head);
1159 static int run_prepare_commit_msg_hook(struct repository *r,
1164 const char *name, *arg1 = NULL, *arg2 = NULL;
1166 name = git_path_commit_editmsg();
1167 if (write_message(msg->buf, msg->len, name, 0))
1176 if (run_commit_hook(0, r->index_file, "prepare-commit-msg", name,
1178 ret = error(_("'prepare-commit-msg' hook failed"));
1183 static const char implicit_ident_advice_noconfig[] =
1184 N_("Your name and email address were configured automatically based\n"
1185 "on your username and hostname. Please check that they are accurate.\n"
1186 "You can suppress this message by setting them explicitly. Run the\n"
1187 "following command and follow the instructions in your editor to edit\n"
1188 "your configuration file:\n"
1190 " git config --global --edit\n"
1192 "After doing this, you may fix the identity used for this commit with:\n"
1194 " git commit --amend --reset-author\n");
1196 static const char implicit_ident_advice_config[] =
1197 N_("Your name and email address were configured automatically based\n"
1198 "on your username and hostname. Please check that they are accurate.\n"
1199 "You can suppress this message by setting them explicitly:\n"
1201 " git config --global user.name \"Your Name\"\n"
1202 " git config --global user.email you@example.com\n"
1204 "After doing this, you may fix the identity used for this commit with:\n"
1206 " git commit --amend --reset-author\n");
1208 static const char *implicit_ident_advice(void)
1210 char *user_config = expand_user_path("~/.gitconfig", 0);
1211 char *xdg_config = xdg_config_home("config");
1212 int config_exists = file_exists(user_config) || file_exists(xdg_config);
1218 return _(implicit_ident_advice_config);
1220 return _(implicit_ident_advice_noconfig);
1224 void print_commit_summary(struct repository *r,
1226 const struct object_id *oid,
1229 struct rev_info rev;
1230 struct commit *commit;
1231 struct strbuf format = STRBUF_INIT;
1233 struct pretty_print_context pctx = {0};
1234 struct strbuf author_ident = STRBUF_INIT;
1235 struct strbuf committer_ident = STRBUF_INIT;
1237 commit = lookup_commit(r, oid);
1239 die(_("couldn't look up newly created commit"));
1240 if (parse_commit(commit))
1241 die(_("could not parse newly created commit"));
1243 strbuf_addstr(&format, "format:%h] %s");
1245 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1246 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1247 if (strbuf_cmp(&author_ident, &committer_ident)) {
1248 strbuf_addstr(&format, "\n Author: ");
1249 strbuf_addbuf_percentquote(&format, &author_ident);
1251 if (flags & SUMMARY_SHOW_AUTHOR_DATE) {
1252 struct strbuf date = STRBUF_INIT;
1254 format_commit_message(commit, "%ad", &date, &pctx);
1255 strbuf_addstr(&format, "\n Date: ");
1256 strbuf_addbuf_percentquote(&format, &date);
1257 strbuf_release(&date);
1259 if (!committer_ident_sufficiently_given()) {
1260 strbuf_addstr(&format, "\n Committer: ");
1261 strbuf_addbuf_percentquote(&format, &committer_ident);
1262 if (advice_implicit_identity) {
1263 strbuf_addch(&format, '\n');
1264 strbuf_addstr(&format, implicit_ident_advice());
1267 strbuf_release(&author_ident);
1268 strbuf_release(&committer_ident);
1270 repo_init_revisions(r, &rev, prefix);
1271 setup_revisions(0, NULL, &rev, NULL);
1274 rev.diffopt.output_format =
1275 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1277 rev.verbose_header = 1;
1278 rev.show_root_diff = 1;
1279 get_commit_format(format.buf, &rev);
1280 rev.always_show_header = 0;
1281 rev.diffopt.detect_rename = DIFF_DETECT_RENAME;
1282 rev.diffopt.break_opt = 0;
1283 diff_setup_done(&rev.diffopt);
1285 head = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1287 die_errno(_("unable to resolve HEAD after creating commit"));
1288 if (!strcmp(head, "HEAD"))
1289 head = _("detached HEAD");
1291 skip_prefix(head, "refs/heads/", &head);
1292 printf("[%s%s ", head, (flags & SUMMARY_INITIAL_COMMIT) ?
1293 _(" (root-commit)") : "");
1295 if (!log_tree_commit(&rev, commit)) {
1296 rev.always_show_header = 1;
1297 rev.use_terminator = 1;
1298 log_tree_commit(&rev, commit);
1301 strbuf_release(&format);
1304 static int parse_head(struct repository *r, struct commit **head)
1306 struct commit *current_head;
1307 struct object_id oid;
1309 if (get_oid("HEAD", &oid)) {
1310 current_head = NULL;
1312 current_head = lookup_commit_reference(r, &oid);
1314 return error(_("could not parse HEAD"));
1315 if (!oideq(&oid, ¤t_head->object.oid)) {
1316 warning(_("HEAD %s is not a commit!"),
1319 if (parse_commit(current_head))
1320 return error(_("could not parse HEAD commit"));
1322 *head = current_head;
1328 * Try to commit without forking 'git commit'. In some cases we need
1329 * to run 'git commit' to display an error message
1332 * -1 - error unable to commit
1334 * 1 - run 'git commit'
1336 static int try_to_commit(struct repository *r,
1337 struct strbuf *msg, const char *author,
1338 struct replay_opts *opts, unsigned int flags,
1339 struct object_id *oid)
1341 struct object_id tree;
1342 struct commit *current_head = NULL;
1343 struct commit_list *parents = NULL;
1344 struct commit_extra_header *extra = NULL;
1345 struct strbuf err = STRBUF_INIT;
1346 struct strbuf commit_msg = STRBUF_INIT;
1347 char *amend_author = NULL;
1348 const char *committer = NULL;
1349 const char *hook_commit = NULL;
1350 enum commit_msg_cleanup_mode cleanup;
1353 if (parse_head(r, ¤t_head))
1356 if (flags & AMEND_MSG) {
1357 const char *exclude_gpgsig[] = { "gpgsig", "gpgsig-sha256", NULL };
1358 const char *out_enc = get_commit_output_encoding();
1359 const char *message = logmsg_reencode(current_head, NULL,
1363 const char *orig_message = NULL;
1365 find_commit_subject(message, &orig_message);
1367 strbuf_addstr(msg, orig_message);
1368 hook_commit = "HEAD";
1370 author = amend_author = get_author(message);
1371 unuse_commit_buffer(current_head, message);
1373 res = error(_("unable to parse commit author"));
1376 parents = copy_commit_list(current_head->parents);
1377 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1378 } else if (current_head &&
1379 (!(flags & CREATE_ROOT_COMMIT) || (flags & AMEND_MSG))) {
1380 commit_list_insert(current_head, &parents);
1383 if (write_index_as_tree(&tree, r->index, r->index_file, 0, NULL)) {
1384 res = error(_("git write-tree failed to write a tree"));
1388 if (!(flags & ALLOW_EMPTY)) {
1389 struct commit *first_parent = current_head;
1391 if (flags & AMEND_MSG) {
1392 if (current_head->parents) {
1393 first_parent = current_head->parents->item;
1394 if (repo_parse_commit(r, first_parent)) {
1395 res = error(_("could not parse HEAD commit"));
1399 first_parent = NULL;
1402 if (oideq(first_parent
1403 ? get_commit_tree_oid(first_parent)
1404 : the_hash_algo->empty_tree,
1406 res = 1; /* run 'git commit' to display error message */
1411 if (find_hook("prepare-commit-msg")) {
1412 res = run_prepare_commit_msg_hook(r, msg, hook_commit);
1415 if (strbuf_read_file(&commit_msg, git_path_commit_editmsg(),
1417 res = error_errno(_("unable to read commit message "
1419 git_path_commit_editmsg());
1425 if (flags & CLEANUP_MSG)
1426 cleanup = COMMIT_MSG_CLEANUP_ALL;
1427 else if ((opts->signoff || opts->record_origin) &&
1428 !opts->explicit_cleanup)
1429 cleanup = COMMIT_MSG_CLEANUP_SPACE;
1431 cleanup = opts->default_msg_cleanup;
1433 if (cleanup != COMMIT_MSG_CLEANUP_NONE)
1434 strbuf_stripspace(msg, cleanup == COMMIT_MSG_CLEANUP_ALL);
1435 if ((flags & EDIT_MSG) && message_is_empty(msg, cleanup)) {
1436 res = 1; /* run 'git commit' to display error message */
1440 if (opts->committer_date_is_author_date) {
1441 struct ident_split id;
1442 struct strbuf date = STRBUF_INIT;
1444 if (!opts->ignore_date) {
1445 if (split_ident_line(&id, author, (int)strlen(author)) < 0) {
1446 res = error(_("invalid author identity '%s'"),
1450 if (!id.date_begin) {
1452 "corrupt author: missing date information"));
1455 strbuf_addf(&date, "@%.*s %.*s",
1456 (int)(id.date_end - id.date_begin),
1458 (int)(id.tz_end - id.tz_begin),
1463 committer = fmt_ident(opts->committer_name,
1464 opts->committer_email,
1465 WANT_COMMITTER_IDENT,
1466 opts->ignore_date ? NULL : date.buf,
1468 strbuf_release(&date);
1473 if (opts->ignore_date) {
1474 struct ident_split id;
1477 if (split_ident_line(&id, author, strlen(author)) < 0) {
1478 error(_("invalid author identity '%s'"), author);
1481 name = xmemdupz(id.name_begin, id.name_end - id.name_begin);
1482 email = xmemdupz(id.mail_begin, id.mail_end - id.mail_begin);
1483 author = fmt_ident(name, email, WANT_AUTHOR_IDENT, NULL,
1489 if (commit_tree_extended(msg->buf, msg->len, &tree, parents, oid,
1490 author, committer, opts->gpg_sign, extra)) {
1491 res = error(_("failed to write commit object"));
1495 if (update_head_with_reflog(current_head, oid,
1496 getenv("GIT_REFLOG_ACTION"), msg, &err)) {
1497 res = error("%s", err.buf);
1501 run_commit_hook(0, r->index_file, "post-commit", NULL);
1502 if (flags & AMEND_MSG)
1503 commit_post_rewrite(r, current_head, oid);
1506 free_commit_extra_headers(extra);
1507 strbuf_release(&err);
1508 strbuf_release(&commit_msg);
1514 static int write_rebase_head(struct object_id *oid)
1516 if (update_ref("rebase", "REBASE_HEAD", oid,
1517 NULL, REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1518 return error(_("could not update %s"), "REBASE_HEAD");
1523 static int do_commit(struct repository *r,
1524 const char *msg_file, const char *author,
1525 struct replay_opts *opts, unsigned int flags,
1526 struct object_id *oid)
1530 if (!(flags & EDIT_MSG) && !(flags & VERIFY_MSG)) {
1531 struct object_id oid;
1532 struct strbuf sb = STRBUF_INIT;
1534 if (msg_file && strbuf_read_file(&sb, msg_file, 2048) < 0)
1535 return error_errno(_("unable to read commit message "
1539 res = try_to_commit(r, msg_file ? &sb : NULL,
1540 author, opts, flags, &oid);
1541 strbuf_release(&sb);
1543 refs_delete_ref(get_main_ref_store(r), "",
1544 "CHERRY_PICK_HEAD", NULL, 0);
1545 unlink(git_path_merge_msg(r));
1546 if (!is_rebase_i(opts))
1547 print_commit_summary(r, NULL, &oid,
1548 SUMMARY_SHOW_AUTHOR_DATE);
1553 if (is_rebase_i(opts) && oid)
1554 if (write_rebase_head(oid))
1556 return run_git_commit(msg_file, opts, flags);
1562 static int is_original_commit_empty(struct commit *commit)
1564 const struct object_id *ptree_oid;
1566 if (parse_commit(commit))
1567 return error(_("could not parse commit %s"),
1568 oid_to_hex(&commit->object.oid));
1569 if (commit->parents) {
1570 struct commit *parent = commit->parents->item;
1571 if (parse_commit(parent))
1572 return error(_("could not parse parent commit %s"),
1573 oid_to_hex(&parent->object.oid));
1574 ptree_oid = get_commit_tree_oid(parent);
1576 ptree_oid = the_hash_algo->empty_tree; /* commit is root */
1579 return oideq(ptree_oid, get_commit_tree_oid(commit));
1583 * Should empty commits be allowed? Return status:
1584 * <0: Error in is_index_unchanged(r) or is_original_commit_empty(commit)
1585 * 0: Halt on empty commit
1586 * 1: Allow empty commit
1587 * 2: Drop empty commit
1589 static int allow_empty(struct repository *r,
1590 struct replay_opts *opts,
1591 struct commit *commit)
1593 int index_unchanged, originally_empty;
1598 * (1) we do not allow empty at all and error out.
1600 * (2) we allow ones that were initially empty, and
1601 * just drop the ones that become empty
1603 * (3) we allow ones that were initially empty, but
1604 * halt for the ones that become empty;
1606 * (4) we allow both.
1608 if (!opts->allow_empty)
1609 return 0; /* let "git commit" barf as necessary */
1611 index_unchanged = is_index_unchanged(r);
1612 if (index_unchanged < 0)
1613 return index_unchanged;
1614 if (!index_unchanged)
1615 return 0; /* we do not have to say --allow-empty */
1617 if (opts->keep_redundant_commits)
1620 originally_empty = is_original_commit_empty(commit);
1621 if (originally_empty < 0)
1622 return originally_empty;
1623 if (originally_empty)
1625 else if (opts->drop_redundant_commits)
1634 } todo_command_info[] = {
1651 static const char *command_to_string(const enum todo_command command)
1653 if (command < TODO_COMMENT)
1654 return todo_command_info[command].str;
1655 die(_("unknown command: %d"), command);
1658 static char command_to_char(const enum todo_command command)
1660 if (command < TODO_COMMENT)
1661 return todo_command_info[command].c;
1662 return comment_line_char;
1665 static int is_noop(const enum todo_command command)
1667 return TODO_NOOP <= command;
1670 static int is_fixup(enum todo_command command)
1672 return command == TODO_FIXUP || command == TODO_SQUASH;
1675 /* Does this command create a (non-merge) commit? */
1676 static int is_pick_or_similar(enum todo_command command)
1691 static int update_squash_messages(struct repository *r,
1692 enum todo_command command,
1693 struct commit *commit,
1694 struct replay_opts *opts)
1696 struct strbuf buf = STRBUF_INIT;
1698 const char *message, *body;
1699 const char *encoding = get_commit_output_encoding();
1701 if (opts->current_fixup_count > 0) {
1702 struct strbuf header = STRBUF_INIT;
1705 if (strbuf_read_file(&buf, rebase_path_squash_msg(), 9) <= 0)
1706 return error(_("could not read '%s'"),
1707 rebase_path_squash_msg());
1709 eol = buf.buf[0] != comment_line_char ?
1710 buf.buf : strchrnul(buf.buf, '\n');
1712 strbuf_addf(&header, "%c ", comment_line_char);
1713 strbuf_addf(&header, _("This is a combination of %d commits."),
1714 opts->current_fixup_count + 2);
1715 strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
1716 strbuf_release(&header);
1718 struct object_id head;
1719 struct commit *head_commit;
1720 const char *head_message, *body;
1722 if (get_oid("HEAD", &head))
1723 return error(_("need a HEAD to fixup"));
1724 if (!(head_commit = lookup_commit_reference(r, &head)))
1725 return error(_("could not read HEAD"));
1726 if (!(head_message = logmsg_reencode(head_commit, NULL, encoding)))
1727 return error(_("could not read HEAD's commit message"));
1729 find_commit_subject(head_message, &body);
1730 if (write_message(body, strlen(body),
1731 rebase_path_fixup_msg(), 0)) {
1732 unuse_commit_buffer(head_commit, head_message);
1733 return error(_("cannot write '%s'"),
1734 rebase_path_fixup_msg());
1737 strbuf_addf(&buf, "%c ", comment_line_char);
1738 strbuf_addf(&buf, _("This is a combination of %d commits."), 2);
1739 strbuf_addf(&buf, "\n%c ", comment_line_char);
1740 strbuf_addstr(&buf, _("This is the 1st commit message:"));
1741 strbuf_addstr(&buf, "\n\n");
1742 strbuf_addstr(&buf, body);
1744 unuse_commit_buffer(head_commit, head_message);
1747 if (!(message = logmsg_reencode(commit, NULL, encoding)))
1748 return error(_("could not read commit message of %s"),
1749 oid_to_hex(&commit->object.oid));
1750 find_commit_subject(message, &body);
1752 if (command == TODO_SQUASH) {
1753 unlink(rebase_path_fixup_msg());
1754 strbuf_addf(&buf, "\n%c ", comment_line_char);
1755 strbuf_addf(&buf, _("This is the commit message #%d:"),
1756 ++opts->current_fixup_count + 1);
1757 strbuf_addstr(&buf, "\n\n");
1758 strbuf_addstr(&buf, body);
1759 } else if (command == TODO_FIXUP) {
1760 strbuf_addf(&buf, "\n%c ", comment_line_char);
1761 strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
1762 ++opts->current_fixup_count + 1);
1763 strbuf_addstr(&buf, "\n\n");
1764 strbuf_add_commented_lines(&buf, body, strlen(body));
1766 return error(_("unknown command: %d"), command);
1767 unuse_commit_buffer(commit, message);
1769 res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
1770 strbuf_release(&buf);
1773 strbuf_addf(&opts->current_fixups, "%s%s %s",
1774 opts->current_fixups.len ? "\n" : "",
1775 command_to_string(command),
1776 oid_to_hex(&commit->object.oid));
1777 res = write_message(opts->current_fixups.buf,
1778 opts->current_fixups.len,
1779 rebase_path_current_fixups(), 0);
1785 static void flush_rewritten_pending(void)
1787 struct strbuf buf = STRBUF_INIT;
1788 struct object_id newoid;
1791 if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), (GIT_MAX_HEXSZ + 1) * 2) > 0 &&
1792 !get_oid("HEAD", &newoid) &&
1793 (out = fopen_or_warn(rebase_path_rewritten_list(), "a"))) {
1794 char *bol = buf.buf, *eol;
1797 eol = strchrnul(bol, '\n');
1798 fprintf(out, "%.*s %s\n", (int)(eol - bol),
1799 bol, oid_to_hex(&newoid));
1805 unlink(rebase_path_rewritten_pending());
1807 strbuf_release(&buf);
1810 static void record_in_rewritten(struct object_id *oid,
1811 enum todo_command next_command)
1813 FILE *out = fopen_or_warn(rebase_path_rewritten_pending(), "a");
1818 fprintf(out, "%s\n", oid_to_hex(oid));
1821 if (!is_fixup(next_command))
1822 flush_rewritten_pending();
1825 static int do_pick_commit(struct repository *r,
1826 enum todo_command command,
1827 struct commit *commit,
1828 struct replay_opts *opts,
1829 int final_fixup, int *check_todo)
1831 unsigned int flags = opts->edit ? EDIT_MSG : 0;
1832 const char *msg_file = opts->edit ? NULL : git_path_merge_msg(r);
1833 struct object_id head;
1834 struct commit *base, *next, *parent;
1835 const char *base_label, *next_label;
1836 char *author = NULL;
1837 struct commit_message msg = { NULL, NULL, NULL, NULL };
1838 struct strbuf msgbuf = STRBUF_INIT;
1839 int res, unborn = 0, reword = 0, allow, drop_commit;
1841 if (opts->no_commit) {
1843 * We do not intend to commit immediately. We just want to
1844 * merge the differences in, so let's compute the tree
1845 * that represents the "current" state for merge-recursive
1848 if (write_index_as_tree(&head, r->index, r->index_file, 0, NULL))
1849 return error(_("your index file is unmerged."));
1851 unborn = get_oid("HEAD", &head);
1852 /* Do we want to generate a root commit? */
1853 if (is_pick_or_similar(command) && opts->have_squash_onto &&
1854 oideq(&head, &opts->squash_onto)) {
1855 if (is_fixup(command))
1856 return error(_("cannot fixup root commit"));
1857 flags |= CREATE_ROOT_COMMIT;
1860 oidcpy(&head, the_hash_algo->empty_tree);
1861 if (index_differs_from(r, unborn ? empty_tree_oid_hex() : "HEAD",
1863 return error_dirty_index(r, opts);
1865 discard_index(r->index);
1867 if (!commit->parents)
1869 else if (commit->parents->next) {
1870 /* Reverting or cherry-picking a merge commit */
1872 struct commit_list *p;
1874 if (!opts->mainline)
1875 return error(_("commit %s is a merge but no -m option was given."),
1876 oid_to_hex(&commit->object.oid));
1878 for (cnt = 1, p = commit->parents;
1879 cnt != opts->mainline && p;
1882 if (cnt != opts->mainline || !p)
1883 return error(_("commit %s does not have parent %d"),
1884 oid_to_hex(&commit->object.oid), opts->mainline);
1886 } else if (1 < opts->mainline)
1888 * Non-first parent explicitly specified as mainline for
1891 return error(_("commit %s does not have parent %d"),
1892 oid_to_hex(&commit->object.oid), opts->mainline);
1894 parent = commit->parents->item;
1896 if (get_message(commit, &msg) != 0)
1897 return error(_("cannot get commit message for %s"),
1898 oid_to_hex(&commit->object.oid));
1900 if (opts->allow_ff && !is_fixup(command) &&
1901 ((parent && oideq(&parent->object.oid, &head)) ||
1902 (!parent && unborn))) {
1903 if (is_rebase_i(opts))
1904 write_author_script(msg.message);
1905 res = fast_forward_to(r, &commit->object.oid, &head, unborn,
1907 if (res || command != TODO_REWORD)
1911 goto fast_forward_edit;
1913 if (parent && parse_commit(parent) < 0)
1914 /* TRANSLATORS: The first %s will be a "todo" command like
1915 "revert" or "pick", the second %s a SHA1. */
1916 return error(_("%s: cannot parse parent commit %s"),
1917 command_to_string(command),
1918 oid_to_hex(&parent->object.oid));
1921 * "commit" is an existing commit. We would want to apply
1922 * the difference it introduces since its first parent "prev"
1923 * on top of the current HEAD if we are cherry-pick. Or the
1924 * reverse of it if we are revert.
1927 if (command == TODO_REVERT) {
1929 base_label = msg.label;
1931 next_label = msg.parent_label;
1932 strbuf_addstr(&msgbuf, "Revert \"");
1933 strbuf_addstr(&msgbuf, msg.subject);
1934 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
1935 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1937 if (commit->parents && commit->parents->next) {
1938 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
1939 strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
1941 strbuf_addstr(&msgbuf, ".\n");
1946 base_label = msg.parent_label;
1948 next_label = msg.label;
1950 /* Append the commit log message to msgbuf. */
1951 if (find_commit_subject(msg.message, &p))
1952 strbuf_addstr(&msgbuf, p);
1954 if (opts->record_origin) {
1955 strbuf_complete_line(&msgbuf);
1956 if (!has_conforming_footer(&msgbuf, NULL, 0))
1957 strbuf_addch(&msgbuf, '\n');
1958 strbuf_addstr(&msgbuf, cherry_picked_prefix);
1959 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1960 strbuf_addstr(&msgbuf, ")\n");
1962 if (!is_fixup(command))
1963 author = get_author(msg.message);
1966 if (command == TODO_REWORD)
1968 else if (is_fixup(command)) {
1969 if (update_squash_messages(r, command, commit, opts))
1973 msg_file = rebase_path_squash_msg();
1974 else if (file_exists(rebase_path_fixup_msg())) {
1975 flags |= CLEANUP_MSG;
1976 msg_file = rebase_path_fixup_msg();
1978 const char *dest = git_path_squash_msg(r);
1980 if (copy_file(dest, rebase_path_squash_msg(), 0666))
1981 return error(_("could not rename '%s' to '%s'"),
1982 rebase_path_squash_msg(), dest);
1983 unlink(git_path_merge_msg(r));
1989 if (opts->signoff && !is_fixup(command))
1990 append_signoff(&msgbuf, 0, 0);
1992 if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
1994 else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
1995 res = do_recursive_merge(r, base, next, base_label, next_label,
1996 &head, &msgbuf, opts);
2000 res |= write_message(msgbuf.buf, msgbuf.len,
2001 git_path_merge_msg(r), 0);
2003 struct commit_list *common = NULL;
2004 struct commit_list *remotes = NULL;
2006 res = write_message(msgbuf.buf, msgbuf.len,
2007 git_path_merge_msg(r), 0);
2009 commit_list_insert(base, &common);
2010 commit_list_insert(next, &remotes);
2011 res |= try_merge_command(r, opts->strategy,
2012 opts->xopts_nr, (const char **)opts->xopts,
2013 common, oid_to_hex(&head), remotes);
2014 free_commit_list(common);
2015 free_commit_list(remotes);
2017 strbuf_release(&msgbuf);
2020 * If the merge was clean or if it failed due to conflict, we write
2021 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
2022 * However, if the merge did not even start, then we don't want to
2025 if ((command == TODO_PICK || command == TODO_REWORD ||
2026 command == TODO_EDIT) && !opts->no_commit &&
2027 (res == 0 || res == 1) &&
2028 update_ref(NULL, "CHERRY_PICK_HEAD", &commit->object.oid, NULL,
2029 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
2031 if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
2032 update_ref(NULL, "REVERT_HEAD", &commit->object.oid, NULL,
2033 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
2037 error(command == TODO_REVERT
2038 ? _("could not revert %s... %s")
2039 : _("could not apply %s... %s"),
2040 short_commit_name(commit), msg.subject);
2041 print_advice(r, res == 1, opts);
2042 repo_rerere(r, opts->allow_rerere_auto);
2047 allow = allow_empty(r, opts, commit);
2051 } else if (allow == 1) {
2052 flags |= ALLOW_EMPTY;
2053 } else if (allow == 2) {
2055 refs_delete_ref(get_main_ref_store(r), "", "CHERRY_PICK_HEAD",
2057 unlink(git_path_merge_msg(r));
2059 _("dropping %s %s -- patch contents already upstream\n"),
2060 oid_to_hex(&commit->object.oid), msg.subject);
2061 } /* else allow == 0 and there's nothing special to do */
2062 if (!opts->no_commit && !drop_commit) {
2063 if (author || command == TODO_REVERT || (flags & AMEND_MSG))
2064 res = do_commit(r, msg_file, author, opts, flags,
2065 commit? &commit->object.oid : NULL);
2067 res = error(_("unable to parse commit author"));
2068 *check_todo = !!(flags & EDIT_MSG);
2069 if (!res && reword) {
2071 res = run_git_commit(NULL, opts, EDIT_MSG |
2072 VERIFY_MSG | AMEND_MSG |
2073 (flags & ALLOW_EMPTY));
2079 if (!res && final_fixup) {
2080 unlink(rebase_path_fixup_msg());
2081 unlink(rebase_path_squash_msg());
2082 unlink(rebase_path_current_fixups());
2083 strbuf_reset(&opts->current_fixups);
2084 opts->current_fixup_count = 0;
2088 free_message(commit, &msg);
2090 update_abort_safety_file();
2095 static int prepare_revs(struct replay_opts *opts)
2098 * picking (but not reverting) ranges (but not individual revisions)
2099 * should be done in reverse
2101 if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
2102 opts->revs->reverse ^= 1;
2104 if (prepare_revision_walk(opts->revs))
2105 return error(_("revision walk setup failed"));
2110 static int read_and_refresh_cache(struct repository *r,
2111 struct replay_opts *opts)
2113 struct lock_file index_lock = LOCK_INIT;
2114 int index_fd = repo_hold_locked_index(r, &index_lock, 0);
2115 if (repo_read_index(r) < 0) {
2116 rollback_lock_file(&index_lock);
2117 return error(_("git %s: failed to read the index"),
2118 _(action_name(opts)));
2120 refresh_index(r->index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
2121 if (index_fd >= 0) {
2122 if (write_locked_index(r->index, &index_lock,
2123 COMMIT_LOCK | SKIP_IF_UNCHANGED)) {
2124 return error(_("git %s: failed to refresh the index"),
2125 _(action_name(opts)));
2131 enum todo_item_flags {
2132 TODO_EDIT_MERGE_MSG = 1
2135 void todo_list_release(struct todo_list *todo_list)
2137 strbuf_release(&todo_list->buf);
2138 FREE_AND_NULL(todo_list->items);
2139 todo_list->nr = todo_list->alloc = 0;
2142 static struct todo_item *append_new_todo(struct todo_list *todo_list)
2144 ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
2145 todo_list->total_nr++;
2146 return todo_list->items + todo_list->nr++;
2149 const char *todo_item_get_arg(struct todo_list *todo_list,
2150 struct todo_item *item)
2152 return todo_list->buf.buf + item->arg_offset;
2155 static int is_command(enum todo_command command, const char **bol)
2157 const char *str = todo_command_info[command].str;
2158 const char nick = todo_command_info[command].c;
2159 const char *p = *bol + 1;
2161 return skip_prefix(*bol, str, bol) ||
2162 ((nick && **bol == nick) &&
2163 (*p == ' ' || *p == '\t' || *p == '\n' || *p == '\r' || !*p) &&
2167 static int parse_insn_line(struct repository *r, struct todo_item *item,
2168 const char *buf, const char *bol, char *eol)
2170 struct object_id commit_oid;
2171 char *end_of_object_name;
2172 int i, saved, status, padding;
2177 bol += strspn(bol, " \t");
2179 if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
2180 item->command = TODO_COMMENT;
2181 item->commit = NULL;
2182 item->arg_offset = bol - buf;
2183 item->arg_len = eol - bol;
2187 for (i = 0; i < TODO_COMMENT; i++)
2188 if (is_command(i, &bol)) {
2192 if (i >= TODO_COMMENT)
2195 /* Eat up extra spaces/ tabs before object name */
2196 padding = strspn(bol, " \t");
2199 if (item->command == TODO_NOOP || item->command == TODO_BREAK) {
2201 return error(_("%s does not accept arguments: '%s'"),
2202 command_to_string(item->command), bol);
2203 item->commit = NULL;
2204 item->arg_offset = bol - buf;
2205 item->arg_len = eol - bol;
2210 return error(_("missing arguments for %s"),
2211 command_to_string(item->command));
2213 if (item->command == TODO_EXEC || item->command == TODO_LABEL ||
2214 item->command == TODO_RESET) {
2215 item->commit = NULL;
2216 item->arg_offset = bol - buf;
2217 item->arg_len = (int)(eol - bol);
2221 if (item->command == TODO_MERGE) {
2222 if (skip_prefix(bol, "-C", &bol))
2223 bol += strspn(bol, " \t");
2224 else if (skip_prefix(bol, "-c", &bol)) {
2225 bol += strspn(bol, " \t");
2226 item->flags |= TODO_EDIT_MERGE_MSG;
2228 item->flags |= TODO_EDIT_MERGE_MSG;
2229 item->commit = NULL;
2230 item->arg_offset = bol - buf;
2231 item->arg_len = (int)(eol - bol);
2236 end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
2237 saved = *end_of_object_name;
2238 *end_of_object_name = '\0';
2239 status = get_oid(bol, &commit_oid);
2241 error(_("could not parse '%s'"), bol); /* return later */
2242 *end_of_object_name = saved;
2244 bol = end_of_object_name + strspn(end_of_object_name, " \t");
2245 item->arg_offset = bol - buf;
2246 item->arg_len = (int)(eol - bol);
2251 item->commit = lookup_commit_reference(r, &commit_oid);
2252 return item->commit ? 0 : -1;
2255 int sequencer_get_last_command(struct repository *r, enum replay_action *action)
2257 const char *todo_file, *bol;
2258 struct strbuf buf = STRBUF_INIT;
2261 todo_file = git_path_todo_file();
2262 if (strbuf_read_file(&buf, todo_file, 0) < 0) {
2263 if (errno == ENOENT || errno == ENOTDIR)
2266 return error_errno("unable to open '%s'", todo_file);
2268 bol = buf.buf + strspn(buf.buf, " \t\r\n");
2269 if (is_command(TODO_PICK, &bol) && (*bol == ' ' || *bol == '\t'))
2270 *action = REPLAY_PICK;
2271 else if (is_command(TODO_REVERT, &bol) &&
2272 (*bol == ' ' || *bol == '\t'))
2273 *action = REPLAY_REVERT;
2277 strbuf_release(&buf);
2282 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
2283 struct todo_list *todo_list)
2285 struct todo_item *item;
2286 char *p = buf, *next_p;
2287 int i, res = 0, fixup_okay = file_exists(rebase_path_done());
2289 todo_list->current = todo_list->nr = 0;
2291 for (i = 1; *p; i++, p = next_p) {
2292 char *eol = strchrnul(p, '\n');
2294 next_p = *eol ? eol + 1 /* skip LF */ : eol;
2296 if (p != eol && eol[-1] == '\r')
2297 eol--; /* strip Carriage Return */
2299 item = append_new_todo(todo_list);
2300 item->offset_in_buf = p - todo_list->buf.buf;
2301 if (parse_insn_line(r, item, buf, p, eol)) {
2302 res = error(_("invalid line %d: %.*s"),
2303 i, (int)(eol - p), p);
2304 item->command = TODO_COMMENT + 1;
2305 item->arg_offset = p - buf;
2306 item->arg_len = (int)(eol - p);
2307 item->commit = NULL;
2312 else if (is_fixup(item->command))
2313 return error(_("cannot '%s' without a previous commit"),
2314 command_to_string(item->command));
2315 else if (!is_noop(item->command))
2322 static int count_commands(struct todo_list *todo_list)
2326 for (i = 0; i < todo_list->nr; i++)
2327 if (todo_list->items[i].command != TODO_COMMENT)
2333 static int get_item_line_offset(struct todo_list *todo_list, int index)
2335 return index < todo_list->nr ?
2336 todo_list->items[index].offset_in_buf : todo_list->buf.len;
2339 static const char *get_item_line(struct todo_list *todo_list, int index)
2341 return todo_list->buf.buf + get_item_line_offset(todo_list, index);
2344 static int get_item_line_length(struct todo_list *todo_list, int index)
2346 return get_item_line_offset(todo_list, index + 1)
2347 - get_item_line_offset(todo_list, index);
2350 static ssize_t strbuf_read_file_or_whine(struct strbuf *sb, const char *path)
2355 fd = open(path, O_RDONLY);
2357 return error_errno(_("could not open '%s'"), path);
2358 len = strbuf_read(sb, fd, 0);
2361 return error(_("could not read '%s'."), path);
2365 static int have_finished_the_last_pick(void)
2367 struct strbuf buf = STRBUF_INIT;
2369 const char *todo_path = git_path_todo_file();
2372 if (strbuf_read_file(&buf, todo_path, 0) < 0) {
2373 if (errno == ENOENT) {
2376 error_errno("unable to open '%s'", todo_path);
2380 /* If there is only one line then we are done */
2381 eol = strchr(buf.buf, '\n');
2382 if (!eol || !eol[1])
2385 strbuf_release(&buf);
2390 void sequencer_post_commit_cleanup(struct repository *r, int verbose)
2392 struct replay_opts opts = REPLAY_OPTS_INIT;
2393 int need_cleanup = 0;
2395 if (refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD")) {
2396 if (!refs_delete_ref(get_main_ref_store(r), "",
2397 "CHERRY_PICK_HEAD", NULL, 0) &&
2399 warning(_("cancelling a cherry picking in progress"));
2400 opts.action = REPLAY_PICK;
2404 if (refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD")) {
2405 if (!refs_delete_ref(get_main_ref_store(r), "", "REVERT_HEAD",
2408 warning(_("cancelling a revert in progress"));
2409 opts.action = REPLAY_REVERT;
2416 if (!have_finished_the_last_pick())
2419 sequencer_remove_state(&opts);
2422 static void todo_list_write_total_nr(struct todo_list *todo_list)
2424 FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
2427 fprintf(f, "%d\n", todo_list->total_nr);
2432 static int read_populate_todo(struct repository *r,
2433 struct todo_list *todo_list,
2434 struct replay_opts *opts)
2437 const char *todo_file = get_todo_path(opts);
2440 strbuf_reset(&todo_list->buf);
2441 if (strbuf_read_file_or_whine(&todo_list->buf, todo_file) < 0)
2444 res = stat(todo_file, &st);
2446 return error(_("could not stat '%s'"), todo_file);
2447 fill_stat_data(&todo_list->stat, &st);
2449 res = todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
2451 if (is_rebase_i(opts))
2452 return error(_("please fix this using "
2453 "'git rebase --edit-todo'."));
2454 return error(_("unusable instruction sheet: '%s'"), todo_file);
2457 if (!todo_list->nr &&
2458 (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
2459 return error(_("no commits parsed."));
2461 if (!is_rebase_i(opts)) {
2462 enum todo_command valid =
2463 opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
2466 for (i = 0; i < todo_list->nr; i++)
2467 if (valid == todo_list->items[i].command)
2469 else if (valid == TODO_PICK)
2470 return error(_("cannot cherry-pick during a revert."));
2472 return error(_("cannot revert during a cherry-pick."));
2475 if (is_rebase_i(opts)) {
2476 struct todo_list done = TODO_LIST_INIT;
2478 if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
2479 !todo_list_parse_insn_buffer(r, done.buf.buf, &done))
2480 todo_list->done_nr = count_commands(&done);
2482 todo_list->done_nr = 0;
2484 todo_list->total_nr = todo_list->done_nr
2485 + count_commands(todo_list);
2486 todo_list_release(&done);
2488 todo_list_write_total_nr(todo_list);
2494 static int git_config_string_dup(char **dest,
2495 const char *var, const char *value)
2498 return config_error_nonbool(var);
2500 *dest = xstrdup(value);
2504 static int populate_opts_cb(const char *key, const char *value, void *data)
2506 struct replay_opts *opts = data;
2511 else if (!strcmp(key, "options.no-commit"))
2512 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
2513 else if (!strcmp(key, "options.edit"))
2514 opts->edit = git_config_bool_or_int(key, value, &error_flag);
2515 else if (!strcmp(key, "options.allow-empty"))
2517 git_config_bool_or_int(key, value, &error_flag);
2518 else if (!strcmp(key, "options.allow-empty-message"))
2519 opts->allow_empty_message =
2520 git_config_bool_or_int(key, value, &error_flag);
2521 else if (!strcmp(key, "options.keep-redundant-commits"))
2522 opts->keep_redundant_commits =
2523 git_config_bool_or_int(key, value, &error_flag);
2524 else if (!strcmp(key, "options.signoff"))
2525 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
2526 else if (!strcmp(key, "options.record-origin"))
2527 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
2528 else if (!strcmp(key, "options.allow-ff"))
2529 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
2530 else if (!strcmp(key, "options.mainline"))
2531 opts->mainline = git_config_int(key, value);
2532 else if (!strcmp(key, "options.strategy"))
2533 git_config_string_dup(&opts->strategy, key, value);
2534 else if (!strcmp(key, "options.gpg-sign"))
2535 git_config_string_dup(&opts->gpg_sign, key, value);
2536 else if (!strcmp(key, "options.strategy-option")) {
2537 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
2538 opts->xopts[opts->xopts_nr++] = xstrdup(value);
2539 } else if (!strcmp(key, "options.allow-rerere-auto"))
2540 opts->allow_rerere_auto =
2541 git_config_bool_or_int(key, value, &error_flag) ?
2542 RERERE_AUTOUPDATE : RERERE_NOAUTOUPDATE;
2543 else if (!strcmp(key, "options.default-msg-cleanup")) {
2544 opts->explicit_cleanup = 1;
2545 opts->default_msg_cleanup = get_cleanup_mode(value, 1);
2547 return error(_("invalid key: %s"), key);
2550 return error(_("invalid value for %s: %s"), key, value);
2555 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts)
2558 char *strategy_opts_string = raw_opts;
2560 if (*strategy_opts_string == ' ')
2561 strategy_opts_string++;
2563 opts->xopts_nr = split_cmdline(strategy_opts_string,
2564 (const char ***)&opts->xopts);
2565 for (i = 0; i < opts->xopts_nr; i++) {
2566 const char *arg = opts->xopts[i];
2568 skip_prefix(arg, "--", &arg);
2569 opts->xopts[i] = xstrdup(arg);
2573 static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
2576 if (!read_oneliner(buf, rebase_path_strategy(), 0))
2578 opts->strategy = strbuf_detach(buf, NULL);
2579 if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
2582 parse_strategy_opts(opts, buf->buf);
2585 static int read_populate_opts(struct replay_opts *opts)
2587 if (is_rebase_i(opts)) {
2588 struct strbuf buf = STRBUF_INIT;
2591 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(),
2592 READ_ONELINER_SKIP_IF_EMPTY)) {
2593 if (!starts_with(buf.buf, "-S"))
2596 free(opts->gpg_sign);
2597 opts->gpg_sign = xstrdup(buf.buf + 2);
2602 if (read_oneliner(&buf, rebase_path_allow_rerere_autoupdate(),
2603 READ_ONELINER_SKIP_IF_EMPTY)) {
2604 if (!strcmp(buf.buf, "--rerere-autoupdate"))
2605 opts->allow_rerere_auto = RERERE_AUTOUPDATE;
2606 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
2607 opts->allow_rerere_auto = RERERE_NOAUTOUPDATE;
2611 if (file_exists(rebase_path_verbose()))
2614 if (file_exists(rebase_path_quiet()))
2617 if (file_exists(rebase_path_signoff())) {
2622 if (file_exists(rebase_path_cdate_is_adate())) {
2624 opts->committer_date_is_author_date = 1;
2627 if (file_exists(rebase_path_ignore_date())) {
2629 opts->ignore_date = 1;
2632 if (file_exists(rebase_path_reschedule_failed_exec()))
2633 opts->reschedule_failed_exec = 1;
2635 if (file_exists(rebase_path_drop_redundant_commits()))
2636 opts->drop_redundant_commits = 1;
2638 if (file_exists(rebase_path_keep_redundant_commits()))
2639 opts->keep_redundant_commits = 1;
2641 read_strategy_opts(opts, &buf);
2644 if (read_oneliner(&opts->current_fixups,
2645 rebase_path_current_fixups(),
2646 READ_ONELINER_SKIP_IF_EMPTY)) {
2647 const char *p = opts->current_fixups.buf;
2648 opts->current_fixup_count = 1;
2649 while ((p = strchr(p, '\n'))) {
2650 opts->current_fixup_count++;
2655 if (read_oneliner(&buf, rebase_path_squash_onto(), 0)) {
2656 if (get_oid_hex(buf.buf, &opts->squash_onto) < 0) {
2657 ret = error(_("unusable squash-onto"));
2660 opts->have_squash_onto = 1;
2664 strbuf_release(&buf);
2668 if (!file_exists(git_path_opts_file()))
2671 * The function git_parse_source(), called from git_config_from_file(),
2672 * may die() in case of a syntactically incorrect file. We do not care
2673 * about this case, though, because we wrote that file ourselves, so we
2674 * are pretty certain that it is syntactically correct.
2676 if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
2677 return error(_("malformed options sheet: '%s'"),
2678 git_path_opts_file());
2682 static void write_strategy_opts(struct replay_opts *opts)
2685 struct strbuf buf = STRBUF_INIT;
2687 for (i = 0; i < opts->xopts_nr; ++i)
2688 strbuf_addf(&buf, " --%s", opts->xopts[i]);
2690 write_file(rebase_path_strategy_opts(), "%s\n", buf.buf);
2691 strbuf_release(&buf);
2694 int write_basic_state(struct replay_opts *opts, const char *head_name,
2695 struct commit *onto, const struct object_id *orig_head)
2698 write_file(rebase_path_head_name(), "%s\n", head_name);
2700 write_file(rebase_path_onto(), "%s\n",
2701 oid_to_hex(&onto->object.oid));
2703 write_file(rebase_path_orig_head(), "%s\n",
2704 oid_to_hex(orig_head));
2707 write_file(rebase_path_quiet(), "%s", "");
2709 write_file(rebase_path_verbose(), "%s", "");
2711 write_file(rebase_path_strategy(), "%s\n", opts->strategy);
2712 if (opts->xopts_nr > 0)
2713 write_strategy_opts(opts);
2715 if (opts->allow_rerere_auto == RERERE_AUTOUPDATE)
2716 write_file(rebase_path_allow_rerere_autoupdate(), "--rerere-autoupdate\n");
2717 else if (opts->allow_rerere_auto == RERERE_NOAUTOUPDATE)
2718 write_file(rebase_path_allow_rerere_autoupdate(), "--no-rerere-autoupdate\n");
2721 write_file(rebase_path_gpg_sign_opt(), "-S%s\n", opts->gpg_sign);
2723 write_file(rebase_path_signoff(), "--signoff\n");
2724 if (opts->drop_redundant_commits)
2725 write_file(rebase_path_drop_redundant_commits(), "%s", "");
2726 if (opts->keep_redundant_commits)
2727 write_file(rebase_path_keep_redundant_commits(), "%s", "");
2728 if (opts->committer_date_is_author_date)
2729 write_file(rebase_path_cdate_is_adate(), "%s", "");
2730 if (opts->ignore_date)
2731 write_file(rebase_path_ignore_date(), "%s", "");
2732 if (opts->reschedule_failed_exec)
2733 write_file(rebase_path_reschedule_failed_exec(), "%s", "");
2738 static int walk_revs_populate_todo(struct todo_list *todo_list,
2739 struct replay_opts *opts)
2741 enum todo_command command = opts->action == REPLAY_PICK ?
2742 TODO_PICK : TODO_REVERT;
2743 const char *command_string = todo_command_info[command].str;
2744 const char *encoding;
2745 struct commit *commit;
2747 if (prepare_revs(opts))
2750 encoding = get_log_output_encoding();
2752 while ((commit = get_revision(opts->revs))) {
2753 struct todo_item *item = append_new_todo(todo_list);
2754 const char *commit_buffer = logmsg_reencode(commit, NULL, encoding);
2755 const char *subject;
2758 item->command = command;
2759 item->commit = commit;
2760 item->arg_offset = 0;
2762 item->offset_in_buf = todo_list->buf.len;
2763 subject_len = find_commit_subject(commit_buffer, &subject);
2764 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
2765 short_commit_name(commit), subject_len, subject);
2766 unuse_commit_buffer(commit, commit_buffer);
2770 return error(_("empty commit set passed"));
2775 static int create_seq_dir(struct repository *r)
2777 enum replay_action action;
2778 const char *in_progress_error = NULL;
2779 const char *in_progress_advice = NULL;
2780 unsigned int advise_skip =
2781 refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD") ||
2782 refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD");
2784 if (!sequencer_get_last_command(r, &action)) {
2787 in_progress_error = _("revert is already in progress");
2788 in_progress_advice =
2789 _("try \"git revert (--continue | %s--abort | --quit)\"");
2792 in_progress_error = _("cherry-pick is already in progress");
2793 in_progress_advice =
2794 _("try \"git cherry-pick (--continue | %s--abort | --quit)\"");
2797 BUG("unexpected action in create_seq_dir");
2800 if (in_progress_error) {
2801 error("%s", in_progress_error);
2802 if (advice_sequencer_in_use)
2803 advise(in_progress_advice,
2804 advise_skip ? "--skip | " : "");
2807 if (mkdir(git_path_seq_dir(), 0777) < 0)
2808 return error_errno(_("could not create sequencer directory '%s'"),
2809 git_path_seq_dir());
2814 static int save_head(const char *head)
2816 struct lock_file head_lock = LOCK_INIT;
2817 struct strbuf buf = STRBUF_INIT;
2821 fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
2823 return error_errno(_("could not lock HEAD"));
2824 strbuf_addf(&buf, "%s\n", head);
2825 written = write_in_full(fd, buf.buf, buf.len);
2826 strbuf_release(&buf);
2828 error_errno(_("could not write to '%s'"), git_path_head_file());
2829 rollback_lock_file(&head_lock);
2832 if (commit_lock_file(&head_lock) < 0)
2833 return error(_("failed to finalize '%s'"), git_path_head_file());
2837 static int rollback_is_safe(void)
2839 struct strbuf sb = STRBUF_INIT;
2840 struct object_id expected_head, actual_head;
2842 if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
2844 if (get_oid_hex(sb.buf, &expected_head)) {
2845 strbuf_release(&sb);
2846 die(_("could not parse %s"), git_path_abort_safety_file());
2848 strbuf_release(&sb);
2850 else if (errno == ENOENT)
2851 oidclr(&expected_head);
2853 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
2855 if (get_oid("HEAD", &actual_head))
2856 oidclr(&actual_head);
2858 return oideq(&actual_head, &expected_head);
2861 static int reset_merge(const struct object_id *oid)
2864 struct strvec argv = STRVEC_INIT;
2866 strvec_pushl(&argv, "reset", "--merge", NULL);
2868 if (!is_null_oid(oid))
2869 strvec_push(&argv, oid_to_hex(oid));
2871 ret = run_command_v_opt(argv.v, RUN_GIT_CMD);
2872 strvec_clear(&argv);
2877 static int rollback_single_pick(struct repository *r)
2879 struct object_id head_oid;
2881 if (!refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD") &&
2882 !refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD"))
2883 return error(_("no cherry-pick or revert in progress"));
2884 if (read_ref_full("HEAD", 0, &head_oid, NULL))
2885 return error(_("cannot resolve HEAD"));
2886 if (is_null_oid(&head_oid))
2887 return error(_("cannot abort from a branch yet to be born"));
2888 return reset_merge(&head_oid);
2891 static int skip_single_pick(void)
2893 struct object_id head;
2895 if (read_ref_full("HEAD", 0, &head, NULL))
2896 return error(_("cannot resolve HEAD"));
2897 return reset_merge(&head);
2900 int sequencer_rollback(struct repository *r, struct replay_opts *opts)
2903 struct object_id oid;
2904 struct strbuf buf = STRBUF_INIT;
2907 f = fopen(git_path_head_file(), "r");
2908 if (!f && errno == ENOENT) {
2910 * There is no multiple-cherry-pick in progress.
2911 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
2912 * a single-cherry-pick in progress, abort that.
2914 return rollback_single_pick(r);
2917 return error_errno(_("cannot open '%s'"), git_path_head_file());
2918 if (strbuf_getline_lf(&buf, f)) {
2919 error(_("cannot read '%s': %s"), git_path_head_file(),
2920 ferror(f) ? strerror(errno) : _("unexpected end of file"));
2925 if (parse_oid_hex(buf.buf, &oid, &p) || *p != '\0') {
2926 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
2927 git_path_head_file());
2930 if (is_null_oid(&oid)) {
2931 error(_("cannot abort from a branch yet to be born"));
2935 if (!rollback_is_safe()) {
2936 /* Do not error, just do not rollback */
2937 warning(_("You seem to have moved HEAD. "
2938 "Not rewinding, check your HEAD!"));
2940 if (reset_merge(&oid))
2942 strbuf_release(&buf);
2943 return sequencer_remove_state(opts);
2945 strbuf_release(&buf);
2949 int sequencer_skip(struct repository *r, struct replay_opts *opts)
2951 enum replay_action action = -1;
2952 sequencer_get_last_command(r, &action);
2955 * Check whether the subcommand requested to skip the commit is actually
2956 * in progress and that it's safe to skip the commit.
2958 * opts->action tells us which subcommand requested to skip the commit.
2959 * If the corresponding .git/<ACTION>_HEAD exists, we know that the
2960 * action is in progress and we can skip the commit.
2962 * Otherwise we check that the last instruction was related to the
2963 * particular subcommand we're trying to execute and barf if that's not
2966 * Finally we check that the rollback is "safe", i.e., has the HEAD
2967 * moved? In this case, it doesn't make sense to "reset the merge" and
2968 * "skip the commit" as the user already handled this by committing. But
2969 * we'd not want to barf here, instead give advice on how to proceed. We
2970 * only need to check that when .git/<ACTION>_HEAD doesn't exist because
2971 * it gets removed when the user commits, so if it still exists we're
2972 * sure the user can't have committed before.
2974 switch (opts->action) {
2976 if (!refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD")) {
2977 if (action != REPLAY_REVERT)
2978 return error(_("no revert in progress"));
2979 if (!rollback_is_safe())
2984 if (!refs_ref_exists(get_main_ref_store(r),
2985 "CHERRY_PICK_HEAD")) {
2986 if (action != REPLAY_PICK)
2987 return error(_("no cherry-pick in progress"));
2988 if (!rollback_is_safe())
2993 BUG("unexpected action in sequencer_skip");
2996 if (skip_single_pick())
2997 return error(_("failed to skip the commit"));
2998 if (!is_directory(git_path_seq_dir()))
3001 return sequencer_continue(r, opts);
3004 error(_("there is nothing to skip"));
3006 if (advice_resolve_conflict) {
3007 advise(_("have you committed already?\n"
3008 "try \"git %s --continue\""),
3009 action == REPLAY_REVERT ? "revert" : "cherry-pick");
3014 static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
3016 struct lock_file todo_lock = LOCK_INIT;
3017 const char *todo_path = get_todo_path(opts);
3018 int next = todo_list->current, offset, fd;
3021 * rebase -i writes "git-rebase-todo" without the currently executing
3022 * command, appending it to "done" instead.
3024 if (is_rebase_i(opts))
3027 fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
3029 return error_errno(_("could not lock '%s'"), todo_path);
3030 offset = get_item_line_offset(todo_list, next);
3031 if (write_in_full(fd, todo_list->buf.buf + offset,
3032 todo_list->buf.len - offset) < 0)
3033 return error_errno(_("could not write to '%s'"), todo_path);
3034 if (commit_lock_file(&todo_lock) < 0)
3035 return error(_("failed to finalize '%s'"), todo_path);
3037 if (is_rebase_i(opts) && next > 0) {
3038 const char *done = rebase_path_done();
3039 int fd = open(done, O_CREAT | O_WRONLY | O_APPEND, 0666);
3044 if (write_in_full(fd, get_item_line(todo_list, next - 1),
3045 get_item_line_length(todo_list, next - 1))
3047 ret = error_errno(_("could not write to '%s'"), done);
3049 ret = error_errno(_("failed to finalize '%s'"), done);
3055 static int save_opts(struct replay_opts *opts)
3057 const char *opts_file = git_path_opts_file();
3060 if (opts->no_commit)
3061 res |= git_config_set_in_file_gently(opts_file,
3062 "options.no-commit", "true");
3064 res |= git_config_set_in_file_gently(opts_file,
3065 "options.edit", "true");
3066 if (opts->allow_empty)
3067 res |= git_config_set_in_file_gently(opts_file,
3068 "options.allow-empty", "true");
3069 if (opts->allow_empty_message)
3070 res |= git_config_set_in_file_gently(opts_file,
3071 "options.allow-empty-message", "true");
3072 if (opts->keep_redundant_commits)
3073 res |= git_config_set_in_file_gently(opts_file,
3074 "options.keep-redundant-commits", "true");
3076 res |= git_config_set_in_file_gently(opts_file,
3077 "options.signoff", "true");
3078 if (opts->record_origin)
3079 res |= git_config_set_in_file_gently(opts_file,
3080 "options.record-origin", "true");
3082 res |= git_config_set_in_file_gently(opts_file,
3083 "options.allow-ff", "true");
3084 if (opts->mainline) {
3085 struct strbuf buf = STRBUF_INIT;
3086 strbuf_addf(&buf, "%d", opts->mainline);
3087 res |= git_config_set_in_file_gently(opts_file,
3088 "options.mainline", buf.buf);
3089 strbuf_release(&buf);
3092 res |= git_config_set_in_file_gently(opts_file,
3093 "options.strategy", opts->strategy);
3095 res |= git_config_set_in_file_gently(opts_file,
3096 "options.gpg-sign", opts->gpg_sign);
3099 for (i = 0; i < opts->xopts_nr; i++)
3100 res |= git_config_set_multivar_in_file_gently(opts_file,
3101 "options.strategy-option",
3102 opts->xopts[i], "^$", 0);
3104 if (opts->allow_rerere_auto)
3105 res |= git_config_set_in_file_gently(opts_file,
3106 "options.allow-rerere-auto",
3107 opts->allow_rerere_auto == RERERE_AUTOUPDATE ?
3110 if (opts->explicit_cleanup)
3111 res |= git_config_set_in_file_gently(opts_file,
3112 "options.default-msg-cleanup",
3113 describe_cleanup_mode(opts->default_msg_cleanup));
3117 static int make_patch(struct repository *r,
3118 struct commit *commit,
3119 struct replay_opts *opts)
3121 struct strbuf buf = STRBUF_INIT;
3122 struct rev_info log_tree_opt;
3123 const char *subject;
3124 char hex[GIT_MAX_HEXSZ + 1];
3127 oid_to_hex_r(hex, &commit->object.oid);
3128 if (write_message(hex, strlen(hex), rebase_path_stopped_sha(), 1) < 0)
3130 res |= write_rebase_head(&commit->object.oid);
3132 strbuf_addf(&buf, "%s/patch", get_dir(opts));
3133 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
3134 repo_init_revisions(r, &log_tree_opt, NULL);
3135 log_tree_opt.abbrev = 0;
3136 log_tree_opt.diff = 1;
3137 log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
3138 log_tree_opt.disable_stdin = 1;
3139 log_tree_opt.no_commit_id = 1;
3140 log_tree_opt.diffopt.file = fopen(buf.buf, "w");
3141 log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
3142 if (!log_tree_opt.diffopt.file)
3143 res |= error_errno(_("could not open '%s'"), buf.buf);
3145 res |= log_tree_commit(&log_tree_opt, commit);
3146 fclose(log_tree_opt.diffopt.file);
3150 strbuf_addf(&buf, "%s/message", get_dir(opts));
3151 if (!file_exists(buf.buf)) {
3152 const char *encoding = get_commit_output_encoding();
3153 const char *commit_buffer = logmsg_reencode(commit, NULL, encoding);
3154 find_commit_subject(commit_buffer, &subject);
3155 res |= write_message(subject, strlen(subject), buf.buf, 1);
3156 unuse_commit_buffer(commit, commit_buffer);
3158 strbuf_release(&buf);
3163 static int intend_to_amend(void)
3165 struct object_id head;
3168 if (get_oid("HEAD", &head))
3169 return error(_("cannot read HEAD"));
3171 p = oid_to_hex(&head);
3172 return write_message(p, strlen(p), rebase_path_amend(), 1);
3175 static int error_with_patch(struct repository *r,
3176 struct commit *commit,
3177 const char *subject, int subject_len,
3178 struct replay_opts *opts,
3179 int exit_code, int to_amend)
3182 if (make_patch(r, commit, opts))
3184 } else if (copy_file(rebase_path_message(),
3185 git_path_merge_msg(r), 0666))
3186 return error(_("unable to copy '%s' to '%s'"),
3187 git_path_merge_msg(r), rebase_path_message());
3190 if (intend_to_amend())
3194 _("You can amend the commit now, with\n"
3196 " git commit --amend %s\n"
3198 "Once you are satisfied with your changes, run\n"
3200 " git rebase --continue\n"),
3201 gpg_sign_opt_quoted(opts));
3202 } else if (exit_code) {
3204 fprintf_ln(stderr, _("Could not apply %s... %.*s"),
3205 short_commit_name(commit), subject_len, subject);
3208 * We don't have the hash of the parent so
3209 * just print the line from the todo file.
3211 fprintf_ln(stderr, _("Could not merge %.*s"),
3212 subject_len, subject);
3218 static int error_failed_squash(struct repository *r,
3219 struct commit *commit,
3220 struct replay_opts *opts,
3222 const char *subject)
3224 if (copy_file(rebase_path_message(), rebase_path_squash_msg(), 0666))
3225 return error(_("could not copy '%s' to '%s'"),
3226 rebase_path_squash_msg(), rebase_path_message());
3227 unlink(git_path_merge_msg(r));
3228 if (copy_file(git_path_merge_msg(r), rebase_path_message(), 0666))
3229 return error(_("could not copy '%s' to '%s'"),
3230 rebase_path_message(),
3231 git_path_merge_msg(r));
3232 return error_with_patch(r, commit, subject, subject_len, opts, 1, 0);
3235 static int do_exec(struct repository *r, const char *command_line)
3237 struct strvec child_env = STRVEC_INIT;
3238 const char *child_argv[] = { NULL, NULL };
3241 fprintf(stderr, _("Executing: %s\n"), command_line);
3242 child_argv[0] = command_line;
3243 strvec_pushf(&child_env, "GIT_DIR=%s", absolute_path(get_git_dir()));
3244 strvec_pushf(&child_env, "GIT_WORK_TREE=%s",
3245 absolute_path(get_git_work_tree()));
3246 status = run_command_v_opt_cd_env(child_argv, RUN_USING_SHELL, NULL,
3249 /* force re-reading of the cache */
3250 if (discard_index(r->index) < 0 || repo_read_index(r) < 0)
3251 return error(_("could not read index"));
3253 dirty = require_clean_work_tree(r, "rebase", NULL, 1, 1);
3256 warning(_("execution failed: %s\n%s"
3257 "You can fix the problem, and then run\n"
3259 " git rebase --continue\n"
3262 dirty ? N_("and made changes to the index and/or the "
3263 "working tree\n") : "");
3265 /* command not found */
3268 warning(_("execution succeeded: %s\nbut "
3269 "left changes to the index and/or the working tree\n"
3270 "Commit or stash your changes, and then run\n"
3272 " git rebase --continue\n"
3273 "\n"), command_line);
3277 strvec_clear(&child_env);
3282 static int safe_append(const char *filename, const char *fmt, ...)
3285 struct lock_file lock = LOCK_INIT;
3286 int fd = hold_lock_file_for_update(&lock, filename,
3287 LOCK_REPORT_ON_ERROR);
3288 struct strbuf buf = STRBUF_INIT;
3293 if (strbuf_read_file(&buf, filename, 0) < 0 && errno != ENOENT) {
3294 error_errno(_("could not read '%s'"), filename);
3295 rollback_lock_file(&lock);
3298 strbuf_complete(&buf, '\n');
3300 strbuf_vaddf(&buf, fmt, ap);
3303 if (write_in_full(fd, buf.buf, buf.len) < 0) {
3304 error_errno(_("could not write to '%s'"), filename);
3305 strbuf_release(&buf);
3306 rollback_lock_file(&lock);
3309 if (commit_lock_file(&lock) < 0) {
3310 strbuf_release(&buf);
3311 rollback_lock_file(&lock);
3312 return error(_("failed to finalize '%s'"), filename);
3315 strbuf_release(&buf);
3319 static int do_label(struct repository *r, const char *name, int len)
3321 struct ref_store *refs = get_main_ref_store(r);
3322 struct ref_transaction *transaction;
3323 struct strbuf ref_name = STRBUF_INIT, err = STRBUF_INIT;
3324 struct strbuf msg = STRBUF_INIT;
3326 struct object_id head_oid;
3328 if (len == 1 && *name == '#')
3329 return error(_("illegal label name: '%.*s'"), len, name);
3331 strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
3332 strbuf_addf(&msg, "rebase (label) '%.*s'", len, name);
3334 transaction = ref_store_transaction_begin(refs, &err);
3336 error("%s", err.buf);
3338 } else if (get_oid("HEAD", &head_oid)) {
3339 error(_("could not read HEAD"));
3341 } else if (ref_transaction_update(transaction, ref_name.buf, &head_oid,
3342 NULL, 0, msg.buf, &err) < 0 ||
3343 ref_transaction_commit(transaction, &err)) {
3344 error("%s", err.buf);
3347 ref_transaction_free(transaction);
3348 strbuf_release(&err);
3349 strbuf_release(&msg);
3352 ret = safe_append(rebase_path_refs_to_delete(),
3353 "%s\n", ref_name.buf);
3354 strbuf_release(&ref_name);
3359 static const char *reflog_message(struct replay_opts *opts,
3360 const char *sub_action, const char *fmt, ...);
3362 static int do_reset(struct repository *r,
3363 const char *name, int len,
3364 struct replay_opts *opts)
3366 struct strbuf ref_name = STRBUF_INIT;
3367 struct object_id oid;
3368 struct lock_file lock = LOCK_INIT;
3369 struct tree_desc desc;
3371 struct unpack_trees_options unpack_tree_opts;
3374 if (repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0)
3377 if (len == 10 && !strncmp("[new root]", name, len)) {
3378 if (!opts->have_squash_onto) {
3380 if (commit_tree("", 0, the_hash_algo->empty_tree,
3381 NULL, &opts->squash_onto,
3383 return error(_("writing fake root commit"));
3384 opts->have_squash_onto = 1;
3385 hex = oid_to_hex(&opts->squash_onto);
3386 if (write_message(hex, strlen(hex),
3387 rebase_path_squash_onto(), 0))
3388 return error(_("writing squash-onto"));
3390 oidcpy(&oid, &opts->squash_onto);
3394 /* Determine the length of the label */
3395 for (i = 0; i < len; i++)
3396 if (isspace(name[i]))
3400 strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
3401 if (get_oid(ref_name.buf, &oid) &&
3402 get_oid(ref_name.buf + strlen("refs/rewritten/"), &oid)) {
3403 error(_("could not read '%s'"), ref_name.buf);
3404 rollback_lock_file(&lock);
3405 strbuf_release(&ref_name);
3410 memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
3411 setup_unpack_trees_porcelain(&unpack_tree_opts, "reset");
3412 unpack_tree_opts.head_idx = 1;
3413 unpack_tree_opts.src_index = r->index;
3414 unpack_tree_opts.dst_index = r->index;
3415 unpack_tree_opts.fn = oneway_merge;
3416 unpack_tree_opts.merge = 1;
3417 unpack_tree_opts.update = 1;
3418 init_checkout_metadata(&unpack_tree_opts.meta, name, &oid, NULL);
3420 if (repo_read_index_unmerged(r)) {
3421 rollback_lock_file(&lock);
3422 strbuf_release(&ref_name);
3423 return error_resolve_conflict(_(action_name(opts)));
3426 if (!fill_tree_descriptor(r, &desc, &oid)) {
3427 error(_("failed to find tree of %s"), oid_to_hex(&oid));
3428 rollback_lock_file(&lock);
3429 free((void *)desc.buffer);
3430 strbuf_release(&ref_name);
3434 if (unpack_trees(1, &desc, &unpack_tree_opts)) {
3435 rollback_lock_file(&lock);
3436 free((void *)desc.buffer);
3437 strbuf_release(&ref_name);
3441 tree = parse_tree_indirect(&oid);
3442 prime_cache_tree(r, r->index, tree);
3444 if (write_locked_index(r->index, &lock, COMMIT_LOCK) < 0)
3445 ret = error(_("could not write index"));
3446 free((void *)desc.buffer);
3449 ret = update_ref(reflog_message(opts, "reset", "'%.*s'",
3450 len, name), "HEAD", &oid,
3451 NULL, 0, UPDATE_REFS_MSG_ON_ERR);
3453 strbuf_release(&ref_name);
3457 static struct commit *lookup_label(const char *label, int len,
3460 struct commit *commit;
3463 strbuf_addf(buf, "refs/rewritten/%.*s", len, label);
3464 commit = lookup_commit_reference_by_name(buf->buf);
3466 /* fall back to non-rewritten ref or commit */
3467 strbuf_splice(buf, 0, strlen("refs/rewritten/"), "", 0);
3468 commit = lookup_commit_reference_by_name(buf->buf);
3472 error(_("could not resolve '%s'"), buf->buf);
3477 static int do_merge(struct repository *r,
3478 struct commit *commit,
3479 const char *arg, int arg_len,
3480 int flags, struct replay_opts *opts)
3482 int run_commit_flags = (flags & TODO_EDIT_MERGE_MSG) ?
3483 EDIT_MSG | VERIFY_MSG : 0;
3484 struct strbuf ref_name = STRBUF_INIT;
3485 struct commit *head_commit, *merge_commit, *i;
3486 struct commit_list *bases, *j, *reversed = NULL;
3487 struct commit_list *to_merge = NULL, **tail = &to_merge;
3488 const char *strategy = !opts->xopts_nr &&
3489 (!opts->strategy || !strcmp(opts->strategy, "recursive")) ?
3490 NULL : opts->strategy;
3491 struct merge_options o;
3492 int merge_arg_len, oneline_offset, can_fast_forward, ret, k;
3493 static struct lock_file lock;
3496 if (repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0) {
3501 head_commit = lookup_commit_reference_by_name("HEAD");
3503 ret = error(_("cannot merge without a current revision"));
3508 * For octopus merges, the arg starts with the list of revisions to be
3509 * merged. The list is optionally followed by '#' and the oneline.
3511 merge_arg_len = oneline_offset = arg_len;
3512 for (p = arg; p - arg < arg_len; p += strspn(p, " \t\n")) {
3515 if (*p == '#' && (!p[1] || isspace(p[1]))) {
3516 p += 1 + strspn(p + 1, " \t\n");
3517 oneline_offset = p - arg;
3520 k = strcspn(p, " \t\n");
3523 merge_commit = lookup_label(p, k, &ref_name);
3524 if (!merge_commit) {
3525 ret = error(_("unable to parse '%.*s'"), k, p);
3528 tail = &commit_list_insert(merge_commit, tail)->next;
3530 merge_arg_len = p - arg;
3534 ret = error(_("nothing to merge: '%.*s'"), arg_len, arg);
3538 if (opts->have_squash_onto &&
3539 oideq(&head_commit->object.oid, &opts->squash_onto)) {
3541 * When the user tells us to "merge" something into a
3542 * "[new root]", let's simply fast-forward to the merge head.
3544 rollback_lock_file(&lock);
3546 ret = error(_("octopus merge cannot be executed on "
3547 "top of a [new root]"));
3549 ret = fast_forward_to(r, &to_merge->item->object.oid,
3550 &head_commit->object.oid, 0,
3556 const char *encoding = get_commit_output_encoding();
3557 const char *message = logmsg_reencode(commit, NULL, encoding);
3562 ret = error(_("could not get commit message of '%s'"),
3563 oid_to_hex(&commit->object.oid));
3566 write_author_script(message);
3567 find_commit_subject(message, &body);
3569 ret = write_message(body, len, git_path_merge_msg(r), 0);
3570 unuse_commit_buffer(commit, message);
3572 error_errno(_("could not write '%s'"),
3573 git_path_merge_msg(r));
3577 struct strbuf buf = STRBUF_INIT;
3580 strbuf_addf(&buf, "author %s", git_author_info(0));
3581 write_author_script(buf.buf);
3584 if (oneline_offset < arg_len) {
3585 p = arg + oneline_offset;
3586 len = arg_len - oneline_offset;
3588 strbuf_addf(&buf, "Merge %s '%.*s'",
3589 to_merge->next ? "branches" : "branch",
3590 merge_arg_len, arg);
3595 ret = write_message(p, len, git_path_merge_msg(r), 0);
3596 strbuf_release(&buf);
3598 error_errno(_("could not write '%s'"),
3599 git_path_merge_msg(r));
3605 * If HEAD is not identical to the first parent of the original merge
3606 * commit, we cannot fast-forward.
3608 can_fast_forward = opts->allow_ff && commit && commit->parents &&
3609 oideq(&commit->parents->item->object.oid,
3610 &head_commit->object.oid);
3613 * If any merge head is different from the original one, we cannot
3616 if (can_fast_forward) {
3617 struct commit_list *p = commit->parents->next;
3619 for (j = to_merge; j && p; j = j->next, p = p->next)
3620 if (!oideq(&j->item->object.oid,
3621 &p->item->object.oid)) {
3622 can_fast_forward = 0;
3626 * If the number of merge heads differs from the original merge
3627 * commit, we cannot fast-forward.
3630 can_fast_forward = 0;
3633 if (can_fast_forward) {
3634 rollback_lock_file(&lock);
3635 ret = fast_forward_to(r, &commit->object.oid,
3636 &head_commit->object.oid, 0, opts);
3637 if (flags & TODO_EDIT_MERGE_MSG) {
3638 run_commit_flags |= AMEND_MSG;
3639 goto fast_forward_edit;
3644 if (strategy || to_merge->next) {
3646 struct child_process cmd = CHILD_PROCESS_INIT;
3648 if (read_env_script(&cmd.env_array)) {
3649 const char *gpg_opt = gpg_sign_opt_quoted(opts);
3651 ret = error(_(staged_changes_advice), gpg_opt, gpg_opt);
3655 if (opts->committer_date_is_author_date)
3656 strvec_pushf(&cmd.env_array, "GIT_COMMITTER_DATE=%s",
3659 author_date_from_env_array(&cmd.env_array));
3660 if (opts->ignore_date)
3661 strvec_push(&cmd.env_array, "GIT_AUTHOR_DATE=");
3664 strvec_push(&cmd.args, "merge");
3665 strvec_push(&cmd.args, "-s");
3667 strvec_push(&cmd.args, "octopus");
3669 strvec_push(&cmd.args, strategy);
3670 for (k = 0; k < opts->xopts_nr; k++)
3671 strvec_pushf(&cmd.args,
3672 "-X%s", opts->xopts[k]);
3674 strvec_push(&cmd.args, "--no-edit");
3675 strvec_push(&cmd.args, "--no-ff");
3676 strvec_push(&cmd.args, "--no-log");
3677 strvec_push(&cmd.args, "--no-stat");
3678 strvec_push(&cmd.args, "-F");
3679 strvec_push(&cmd.args, git_path_merge_msg(r));
3681 strvec_push(&cmd.args, opts->gpg_sign);
3683 /* Add the tips to be merged */
3684 for (j = to_merge; j; j = j->next)
3685 strvec_push(&cmd.args,
3686 oid_to_hex(&j->item->object.oid));
3688 strbuf_release(&ref_name);
3689 refs_delete_ref(get_main_ref_store(r), "", "CHERRY_PICK_HEAD",
3691 rollback_lock_file(&lock);
3693 rollback_lock_file(&lock);
3694 ret = run_command(&cmd);
3696 /* force re-reading of the cache */
3697 if (!ret && (discard_index(r->index) < 0 ||
3698 repo_read_index(r) < 0))
3699 ret = error(_("could not read index"));
3703 merge_commit = to_merge->item;
3704 bases = get_merge_bases(head_commit, merge_commit);
3705 if (bases && oideq(&merge_commit->object.oid,
3706 &bases->item->object.oid)) {
3708 /* skip merging an ancestor of HEAD */
3712 write_message(oid_to_hex(&merge_commit->object.oid), the_hash_algo->hexsz,
3713 git_path_merge_head(r), 0);
3714 write_message("no-ff", 5, git_path_merge_mode(r), 0);
3716 for (j = bases; j; j = j->next)
3717 commit_list_insert(j->item, &reversed);
3718 free_commit_list(bases);
3721 init_merge_options(&o, r);
3723 o.branch2 = ref_name.buf;
3724 o.buffer_output = 2;
3726 ret = merge_recursive(&o, head_commit, merge_commit, reversed, &i);
3728 fputs(o.obuf.buf, stdout);
3729 strbuf_release(&o.obuf);
3731 error(_("could not even attempt to merge '%.*s'"),
3732 merge_arg_len, arg);
3736 * The return value of merge_recursive() is 1 on clean, and 0 on
3739 * Let's reverse that, so that do_merge() returns 0 upon success and
3740 * 1 upon failed merge (keeping the return value -1 for the cases where
3741 * we will want to reschedule the `merge` command).
3745 if (r->index->cache_changed &&
3746 write_locked_index(r->index, &lock, COMMIT_LOCK)) {
3747 ret = error(_("merge: Unable to write new index file"));
3751 rollback_lock_file(&lock);
3753 repo_rerere(r, opts->allow_rerere_auto);
3756 * In case of problems, we now want to return a positive
3757 * value (a negative one would indicate that the `merge`
3758 * command needs to be rescheduled).
3761 ret = !!run_git_commit(git_path_merge_msg(r), opts,
3765 strbuf_release(&ref_name);
3766 rollback_lock_file(&lock);
3767 free_commit_list(to_merge);
3771 static int is_final_fixup(struct todo_list *todo_list)
3773 int i = todo_list->current;
3775 if (!is_fixup(todo_list->items[i].command))
3778 while (++i < todo_list->nr)
3779 if (is_fixup(todo_list->items[i].command))
3781 else if (!is_noop(todo_list->items[i].command))
3786 static enum todo_command peek_command(struct todo_list *todo_list, int offset)
3790 for (i = todo_list->current + offset; i < todo_list->nr; i++)
3791 if (!is_noop(todo_list->items[i].command))
3792 return todo_list->items[i].command;
3797 void create_autostash(struct repository *r, const char *path,
3798 const char *default_reflog_action)
3800 struct strbuf buf = STRBUF_INIT;
3801 struct lock_file lock_file = LOCK_INIT;
3804 fd = repo_hold_locked_index(r, &lock_file, 0);
3805 refresh_index(r->index, REFRESH_QUIET, NULL, NULL, NULL);
3807 repo_update_index_if_able(r, &lock_file);
3808 rollback_lock_file(&lock_file);
3810 if (has_unstaged_changes(r, 1) ||
3811 has_uncommitted_changes(r, 1)) {
3812 struct child_process stash = CHILD_PROCESS_INIT;
3813 struct object_id oid;
3815 strvec_pushl(&stash.args,
3816 "stash", "create", "autostash", NULL);
3820 if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
3821 die(_("Cannot autostash"));
3822 strbuf_trim_trailing_newline(&buf);
3823 if (get_oid(buf.buf, &oid))
3824 die(_("Unexpected stash response: '%s'"),
3827 strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
3829 if (safe_create_leading_directories_const(path))
3830 die(_("Could not create directory for '%s'"),
3832 write_file(path, "%s", oid_to_hex(&oid));
3833 printf(_("Created autostash: %s\n"), buf.buf);
3834 if (reset_head(r, NULL, "reset --hard",
3835 NULL, RESET_HEAD_HARD, NULL, NULL,
3836 default_reflog_action) < 0)
3837 die(_("could not reset --hard"));
3839 if (discard_index(r->index) < 0 ||
3840 repo_read_index(r) < 0)
3841 die(_("could not read index"));
3843 strbuf_release(&buf);
3846 static int apply_save_autostash_oid(const char *stash_oid, int attempt_apply)
3848 struct child_process child = CHILD_PROCESS_INIT;
3851 if (attempt_apply) {
3853 child.no_stdout = 1;
3854 child.no_stderr = 1;
3855 strvec_push(&child.args, "stash");
3856 strvec_push(&child.args, "apply");
3857 strvec_push(&child.args, stash_oid);
3858 ret = run_command(&child);
3861 if (attempt_apply && !ret)
3862 fprintf(stderr, _("Applied autostash.\n"));
3864 struct child_process store = CHILD_PROCESS_INIT;
3867 strvec_push(&store.args, "stash");
3868 strvec_push(&store.args, "store");
3869 strvec_push(&store.args, "-m");
3870 strvec_push(&store.args, "autostash");
3871 strvec_push(&store.args, "-q");
3872 strvec_push(&store.args, stash_oid);
3873 if (run_command(&store))
3874 ret = error(_("cannot store %s"), stash_oid);
3878 "Your changes are safe in the stash.\n"
3879 "You can run \"git stash pop\" or"
3880 " \"git stash drop\" at any time.\n"),
3882 _("Applying autostash resulted in conflicts.") :
3883 _("Autostash exists; creating a new stash entry."));
3889 static int apply_save_autostash(const char *path, int attempt_apply)
3891 struct strbuf stash_oid = STRBUF_INIT;
3894 if (!read_oneliner(&stash_oid, path,
3895 READ_ONELINER_SKIP_IF_EMPTY)) {
3896 strbuf_release(&stash_oid);
3899 strbuf_trim(&stash_oid);
3901 ret = apply_save_autostash_oid(stash_oid.buf, attempt_apply);
3904 strbuf_release(&stash_oid);
3908 int save_autostash(const char *path)
3910 return apply_save_autostash(path, 0);
3913 int apply_autostash(const char *path)
3915 return apply_save_autostash(path, 1);
3918 int apply_autostash_oid(const char *stash_oid)
3920 return apply_save_autostash_oid(stash_oid, 1);
3923 static const char *reflog_message(struct replay_opts *opts,
3924 const char *sub_action, const char *fmt, ...)
3927 static struct strbuf buf = STRBUF_INIT;
3928 char *reflog_action = getenv(GIT_REFLOG_ACTION);
3932 strbuf_addstr(&buf, reflog_action ? reflog_action : action_name(opts));
3934 strbuf_addf(&buf, " (%s)", sub_action);
3936 strbuf_addstr(&buf, ": ");
3937 strbuf_vaddf(&buf, fmt, ap);
3944 static int run_git_checkout(struct repository *r, struct replay_opts *opts,
3945 const char *commit, const char *action)
3947 struct child_process cmd = CHILD_PROCESS_INIT;
3952 strvec_push(&cmd.args, "checkout");
3953 strvec_push(&cmd.args, commit);
3954 strvec_pushf(&cmd.env_array, GIT_REFLOG_ACTION "=%s", action);
3957 ret = run_command(&cmd);
3959 ret = run_command_silent_on_success(&cmd);
3962 discard_index(r->index);
3967 static int checkout_onto(struct repository *r, struct replay_opts *opts,
3968 const char *onto_name, const struct object_id *onto,
3969 const struct object_id *orig_head)
3971 const char *action = reflog_message(opts, "start", "checkout %s", onto_name);
3973 if (run_git_checkout(r, opts, oid_to_hex(onto), action)) {
3974 apply_autostash(rebase_path_autostash());
3975 sequencer_remove_state(opts);
3976 return error(_("could not detach HEAD"));
3979 return update_ref(NULL, "ORIG_HEAD", orig_head, NULL, 0, UPDATE_REFS_MSG_ON_ERR);
3982 static int stopped_at_head(struct repository *r)
3984 struct object_id head;
3985 struct commit *commit;
3986 struct commit_message message;
3988 if (get_oid("HEAD", &head) ||
3989 !(commit = lookup_commit(r, &head)) ||
3990 parse_commit(commit) || get_message(commit, &message))
3991 fprintf(stderr, _("Stopped at HEAD\n"));
3993 fprintf(stderr, _("Stopped at %s\n"), message.label);
3994 free_message(commit, &message);
4000 static const char rescheduled_advice[] =
4001 N_("Could not execute the todo command\n"
4005 "It has been rescheduled; To edit the command before continuing, please\n"
4006 "edit the todo list first:\n"
4008 " git rebase --edit-todo\n"
4009 " git rebase --continue\n");
4011 static int pick_commits(struct repository *r,
4012 struct todo_list *todo_list,
4013 struct replay_opts *opts)
4015 int res = 0, reschedule = 0;
4016 char *prev_reflog_action;
4018 /* Note that 0 for 3rd parameter of setenv means set only if not set */
4019 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
4020 prev_reflog_action = xstrdup(getenv(GIT_REFLOG_ACTION));
4022 assert(!(opts->signoff || opts->no_commit ||
4023 opts->record_origin || opts->edit ||
4024 opts->committer_date_is_author_date ||
4025 opts->ignore_date));
4026 if (read_and_refresh_cache(r, opts))
4029 while (todo_list->current < todo_list->nr) {
4030 struct todo_item *item = todo_list->items + todo_list->current;
4031 const char *arg = todo_item_get_arg(todo_list, item);
4034 if (save_todo(todo_list, opts))
4036 if (is_rebase_i(opts)) {
4037 if (item->command != TODO_COMMENT) {
4038 FILE *f = fopen(rebase_path_msgnum(), "w");
4040 todo_list->done_nr++;
4043 fprintf(f, "%d\n", todo_list->done_nr);
4047 fprintf(stderr, _("Rebasing (%d/%d)%s"),
4049 todo_list->total_nr,
4050 opts->verbose ? "\n" : "\r");
4052 unlink(rebase_path_message());
4053 unlink(rebase_path_author_script());
4054 unlink(rebase_path_stopped_sha());
4055 unlink(rebase_path_amend());
4056 unlink(git_path_merge_head(r));
4057 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
4059 if (item->command == TODO_BREAK) {
4062 return stopped_at_head(r);
4065 if (item->command <= TODO_SQUASH) {
4066 if (is_rebase_i(opts))
4067 setenv(GIT_REFLOG_ACTION, reflog_message(opts,
4068 command_to_string(item->command), NULL),
4070 res = do_pick_commit(r, item->command, item->commit,
4071 opts, is_final_fixup(todo_list),
4073 if (is_rebase_i(opts))
4074 setenv(GIT_REFLOG_ACTION, prev_reflog_action, 1);
4075 if (is_rebase_i(opts) && res < 0) {
4077 advise(_(rescheduled_advice),
4078 get_item_line_length(todo_list,
4079 todo_list->current),
4080 get_item_line(todo_list,
4081 todo_list->current));
4082 todo_list->current--;
4083 if (save_todo(todo_list, opts))
4086 if (item->command == TODO_EDIT) {
4087 struct commit *commit = item->commit;
4092 _("Stopped at %s... %.*s\n"),
4093 short_commit_name(commit),
4094 item->arg_len, arg);
4096 return error_with_patch(r, commit,
4097 arg, item->arg_len, opts, res, !res);
4099 if (is_rebase_i(opts) && !res)
4100 record_in_rewritten(&item->commit->object.oid,
4101 peek_command(todo_list, 1));
4102 if (res && is_fixup(item->command)) {
4105 return error_failed_squash(r, item->commit, opts,
4106 item->arg_len, arg);
4107 } else if (res && is_rebase_i(opts) && item->commit) {
4109 struct object_id oid;
4112 * If we are rewording and have either
4113 * fast-forwarded already, or are about to
4114 * create a new root commit, we want to amend,
4115 * otherwise we do not.
4117 if (item->command == TODO_REWORD &&
4118 !get_oid("HEAD", &oid) &&
4119 (oideq(&item->commit->object.oid, &oid) ||
4120 (opts->have_squash_onto &&
4121 oideq(&opts->squash_onto, &oid))))
4124 return res | error_with_patch(r, item->commit,
4125 arg, item->arg_len, opts,
4128 } else if (item->command == TODO_EXEC) {
4129 char *end_of_arg = (char *)(arg + item->arg_len);
4130 int saved = *end_of_arg;
4135 res = do_exec(r, arg);
4136 *end_of_arg = saved;
4139 if (opts->reschedule_failed_exec)
4143 } else if (item->command == TODO_LABEL) {
4144 if ((res = do_label(r, arg, item->arg_len)))
4146 } else if (item->command == TODO_RESET) {
4147 if ((res = do_reset(r, arg, item->arg_len, opts)))
4149 } else if (item->command == TODO_MERGE) {
4150 if ((res = do_merge(r, item->commit,
4152 item->flags, opts)) < 0)
4154 else if (item->commit)
4155 record_in_rewritten(&item->commit->object.oid,
4156 peek_command(todo_list, 1));
4158 /* failed with merge conflicts */
4159 return error_with_patch(r, item->commit,
4162 } else if (!is_noop(item->command))
4163 return error(_("unknown command %d"), item->command);
4166 advise(_(rescheduled_advice),
4167 get_item_line_length(todo_list,
4168 todo_list->current),
4169 get_item_line(todo_list, todo_list->current));
4170 todo_list->current--;
4171 if (save_todo(todo_list, opts))
4174 return error_with_patch(r,
4178 } else if (is_rebase_i(opts) && check_todo && !res) {
4181 if (stat(get_todo_path(opts), &st)) {
4182 res = error_errno(_("could not stat '%s'"),
4183 get_todo_path(opts));
4184 } else if (match_stat_data(&todo_list->stat, &st)) {
4185 /* Reread the todo file if it has changed. */
4186 todo_list_release(todo_list);
4187 if (read_populate_todo(r, todo_list, opts))
4188 res = -1; /* message was printed */
4189 /* `current` will be incremented below */
4190 todo_list->current = -1;
4194 todo_list->current++;
4199 if (is_rebase_i(opts)) {
4200 struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
4203 /* Stopped in the middle, as planned? */
4204 if (todo_list->current < todo_list->nr)
4207 if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
4208 starts_with(head_ref.buf, "refs/")) {
4210 struct object_id head, orig;
4213 if (get_oid("HEAD", &head)) {
4214 res = error(_("cannot read HEAD"));
4216 strbuf_release(&head_ref);
4217 strbuf_release(&buf);
4220 if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
4221 get_oid_hex(buf.buf, &orig)) {
4222 res = error(_("could not read orig-head"));
4223 goto cleanup_head_ref;
4226 if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
4227 res = error(_("could not read 'onto'"));
4228 goto cleanup_head_ref;
4230 msg = reflog_message(opts, "finish", "%s onto %s",
4231 head_ref.buf, buf.buf);
4232 if (update_ref(msg, head_ref.buf, &head, &orig,
4233 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR)) {
4234 res = error(_("could not update %s"),
4236 goto cleanup_head_ref;
4238 msg = reflog_message(opts, "finish", "returning to %s",
4240 if (create_symref("HEAD", head_ref.buf, msg)) {
4241 res = error(_("could not update HEAD to %s"),
4243 goto cleanup_head_ref;
4248 if (opts->verbose) {
4249 struct rev_info log_tree_opt;
4250 struct object_id orig, head;
4252 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
4253 repo_init_revisions(r, &log_tree_opt, NULL);
4254 log_tree_opt.diff = 1;
4255 log_tree_opt.diffopt.output_format =
4256 DIFF_FORMAT_DIFFSTAT;
4257 log_tree_opt.disable_stdin = 1;
4259 if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
4260 !get_oid(buf.buf, &orig) &&
4261 !get_oid("HEAD", &head)) {
4262 diff_tree_oid(&orig, &head, "",
4263 &log_tree_opt.diffopt);
4264 log_tree_diff_flush(&log_tree_opt);
4267 flush_rewritten_pending();
4268 if (!stat(rebase_path_rewritten_list(), &st) &&
4270 struct child_process child = CHILD_PROCESS_INIT;
4271 const char *post_rewrite_hook =
4272 find_hook("post-rewrite");
4274 child.in = open(rebase_path_rewritten_list(), O_RDONLY);
4276 strvec_push(&child.args, "notes");
4277 strvec_push(&child.args, "copy");
4278 strvec_push(&child.args, "--for-rewrite=rebase");
4279 /* we don't care if this copying failed */
4280 run_command(&child);
4282 if (post_rewrite_hook) {
4283 struct child_process hook = CHILD_PROCESS_INIT;
4285 hook.in = open(rebase_path_rewritten_list(),
4287 hook.stdout_to_stderr = 1;
4288 hook.trace2_hook_name = "post-rewrite";
4289 strvec_push(&hook.args, post_rewrite_hook);
4290 strvec_push(&hook.args, "rebase");
4291 /* we don't care if this hook failed */
4295 apply_autostash(rebase_path_autostash());
4301 _("Successfully rebased and updated %s.\n"),
4305 strbuf_release(&buf);
4306 strbuf_release(&head_ref);
4310 * Sequence of picks finished successfully; cleanup by
4311 * removing the .git/sequencer directory
4313 return sequencer_remove_state(opts);
4316 static int continue_single_pick(struct repository *r)
4318 const char *argv[] = { "commit", NULL };
4320 if (!refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD") &&
4321 !refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD"))
4322 return error(_("no cherry-pick or revert in progress"));
4323 return run_command_v_opt(argv, RUN_GIT_CMD);
4326 static int commit_staged_changes(struct repository *r,
4327 struct replay_opts *opts,
4328 struct todo_list *todo_list)
4330 unsigned int flags = ALLOW_EMPTY | EDIT_MSG;
4331 unsigned int final_fixup = 0, is_clean;
4333 if (has_unstaged_changes(r, 1))
4334 return error(_("cannot rebase: You have unstaged changes."));
4336 is_clean = !has_uncommitted_changes(r, 0);
4338 if (file_exists(rebase_path_amend())) {
4339 struct strbuf rev = STRBUF_INIT;
4340 struct object_id head, to_amend;
4342 if (get_oid("HEAD", &head))
4343 return error(_("cannot amend non-existing commit"));
4344 if (!read_oneliner(&rev, rebase_path_amend(), 0))
4345 return error(_("invalid file: '%s'"), rebase_path_amend());
4346 if (get_oid_hex(rev.buf, &to_amend))
4347 return error(_("invalid contents: '%s'"),
4348 rebase_path_amend());
4349 if (!is_clean && !oideq(&head, &to_amend))
4350 return error(_("\nYou have uncommitted changes in your "
4351 "working tree. Please, commit them\n"
4352 "first and then run 'git rebase "
4353 "--continue' again."));
4355 * When skipping a failed fixup/squash, we need to edit the
4356 * commit message, the current fixup list and count, and if it
4357 * was the last fixup/squash in the chain, we need to clean up
4358 * the commit message and if there was a squash, let the user
4361 if (!is_clean || !opts->current_fixup_count)
4362 ; /* this is not the final fixup */
4363 else if (!oideq(&head, &to_amend) ||
4364 !file_exists(rebase_path_stopped_sha())) {
4365 /* was a final fixup or squash done manually? */
4366 if (!is_fixup(peek_command(todo_list, 0))) {
4367 unlink(rebase_path_fixup_msg());
4368 unlink(rebase_path_squash_msg());
4369 unlink(rebase_path_current_fixups());
4370 strbuf_reset(&opts->current_fixups);
4371 opts->current_fixup_count = 0;
4374 /* we are in a fixup/squash chain */
4375 const char *p = opts->current_fixups.buf;
4376 int len = opts->current_fixups.len;
4378 opts->current_fixup_count--;
4380 BUG("Incorrect current_fixups:\n%s", p);
4381 while (len && p[len - 1] != '\n')
4383 strbuf_setlen(&opts->current_fixups, len);
4384 if (write_message(p, len, rebase_path_current_fixups(),
4386 return error(_("could not write file: '%s'"),
4387 rebase_path_current_fixups());
4390 * If a fixup/squash in a fixup/squash chain failed, the
4391 * commit message is already correct, no need to commit
4394 * Only if it is the final command in the fixup/squash
4395 * chain, and only if the chain is longer than a single
4396 * fixup/squash command (which was just skipped), do we
4397 * actually need to re-commit with a cleaned up commit
4400 if (opts->current_fixup_count > 0 &&
4401 !is_fixup(peek_command(todo_list, 0))) {
4404 * If there was not a single "squash" in the
4405 * chain, we only need to clean up the commit
4406 * message, no need to bother the user with
4407 * opening the commit message in the editor.
4409 if (!starts_with(p, "squash ") &&
4410 !strstr(p, "\nsquash "))
4411 flags = (flags & ~EDIT_MSG) | CLEANUP_MSG;
4412 } else if (is_fixup(peek_command(todo_list, 0))) {
4414 * We need to update the squash message to skip
4415 * the latest commit message.
4417 struct commit *commit;
4418 const char *path = rebase_path_squash_msg();
4419 const char *encoding = get_commit_output_encoding();
4421 if (parse_head(r, &commit) ||
4422 !(p = logmsg_reencode(commit, NULL, encoding)) ||
4423 write_message(p, strlen(p), path, 0)) {
4424 unuse_commit_buffer(commit, p);
4425 return error(_("could not write file: "
4428 unuse_commit_buffer(commit, p);
4432 strbuf_release(&rev);
4437 if (refs_ref_exists(get_main_ref_store(r),
4438 "CHERRY_PICK_HEAD") &&
4439 refs_delete_ref(get_main_ref_store(r), "",
4440 "CHERRY_PICK_HEAD", NULL, 0))
4441 return error(_("could not remove CHERRY_PICK_HEAD"));
4446 if (run_git_commit(final_fixup ? NULL : rebase_path_message(),
4448 return error(_("could not commit staged changes."));
4449 unlink(rebase_path_amend());
4450 unlink(git_path_merge_head(r));
4452 unlink(rebase_path_fixup_msg());
4453 unlink(rebase_path_squash_msg());
4455 if (opts->current_fixup_count > 0) {
4457 * Whether final fixup or not, we just cleaned up the commit
4460 unlink(rebase_path_current_fixups());
4461 strbuf_reset(&opts->current_fixups);
4462 opts->current_fixup_count = 0;
4467 static int init_committer(struct replay_opts *opts)
4469 struct ident_split id;
4470 const char *committer;
4472 committer = git_committer_info(IDENT_STRICT);
4473 if (split_ident_line(&id, committer, strlen(committer)) < 0)
4474 return error(_("invalid committer '%s'"), committer);
4475 opts->committer_name =
4476 xmemdupz(id.name_begin, id.name_end - id.name_begin);
4477 opts->committer_email =
4478 xmemdupz(id.mail_begin, id.mail_end - id.mail_end);
4483 int sequencer_continue(struct repository *r, struct replay_opts *opts)
4485 struct todo_list todo_list = TODO_LIST_INIT;
4488 if (read_and_refresh_cache(r, opts))
4491 if (read_populate_opts(opts))
4493 if (is_rebase_i(opts)) {
4494 if (opts->committer_date_is_author_date && init_committer(opts))
4497 if ((res = read_populate_todo(r, &todo_list, opts)))
4498 goto release_todo_list;
4500 if (file_exists(rebase_path_dropped())) {
4501 if ((res = todo_list_check_against_backup(r, &todo_list)))
4502 goto release_todo_list;
4504 unlink(rebase_path_dropped());
4507 if (commit_staged_changes(r, opts, &todo_list)) {
4509 goto release_todo_list;
4511 } else if (!file_exists(get_todo_path(opts)))
4512 return continue_single_pick(r);
4513 else if ((res = read_populate_todo(r, &todo_list, opts)))
4514 goto release_todo_list;
4516 if (!is_rebase_i(opts)) {
4517 /* Verify that the conflict has been resolved */
4518 if (refs_ref_exists(get_main_ref_store(r),
4519 "CHERRY_PICK_HEAD") ||
4520 refs_ref_exists(get_main_ref_store(r), "REVERT_HEAD")) {
4521 res = continue_single_pick(r);
4523 goto release_todo_list;
4525 if (index_differs_from(r, "HEAD", NULL, 0)) {
4526 res = error_dirty_index(r, opts);
4527 goto release_todo_list;
4529 todo_list.current++;
4530 } else if (file_exists(rebase_path_stopped_sha())) {
4531 struct strbuf buf = STRBUF_INIT;
4532 struct object_id oid;
4534 if (read_oneliner(&buf, rebase_path_stopped_sha(),
4535 READ_ONELINER_SKIP_IF_EMPTY) &&
4536 !get_oid_hex(buf.buf, &oid))
4537 record_in_rewritten(&oid, peek_command(&todo_list, 0));
4538 strbuf_release(&buf);
4541 res = pick_commits(r, &todo_list, opts);
4543 todo_list_release(&todo_list);
4547 static int single_pick(struct repository *r,
4548 struct commit *cmit,
4549 struct replay_opts *opts)
4553 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
4554 return do_pick_commit(r, opts->action == REPLAY_PICK ?
4555 TODO_PICK : TODO_REVERT, cmit, opts, 0,
4559 int sequencer_pick_revisions(struct repository *r,
4560 struct replay_opts *opts)
4562 struct todo_list todo_list = TODO_LIST_INIT;
4563 struct object_id oid;
4567 if (read_and_refresh_cache(r, opts))
4570 for (i = 0; i < opts->revs->pending.nr; i++) {
4571 struct object_id oid;
4572 const char *name = opts->revs->pending.objects[i].name;
4574 /* This happens when using --stdin. */
4578 if (!get_oid(name, &oid)) {
4579 if (!lookup_commit_reference_gently(r, &oid, 1)) {
4580 enum object_type type = oid_object_info(r,
4583 return error(_("%s: can't cherry-pick a %s"),
4584 name, type_name(type));
4587 return error(_("%s: bad revision"), name);
4591 * If we were called as "git cherry-pick <commit>", just
4592 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
4593 * REVERT_HEAD, and don't touch the sequencer state.
4594 * This means it is possible to cherry-pick in the middle
4595 * of a cherry-pick sequence.
4597 if (opts->revs->cmdline.nr == 1 &&
4598 opts->revs->cmdline.rev->whence == REV_CMD_REV &&
4599 opts->revs->no_walk &&
4600 !opts->revs->cmdline.rev->flags) {
4601 struct commit *cmit;
4602 if (prepare_revision_walk(opts->revs))
4603 return error(_("revision walk setup failed"));
4604 cmit = get_revision(opts->revs);
4606 return error(_("empty commit set passed"));
4607 if (get_revision(opts->revs))
4608 BUG("unexpected extra commit from walk");
4609 return single_pick(r, cmit, opts);
4613 * Start a new cherry-pick/ revert sequence; but
4614 * first, make sure that an existing one isn't in
4618 if (walk_revs_populate_todo(&todo_list, opts) ||
4619 create_seq_dir(r) < 0)
4621 if (get_oid("HEAD", &oid) && (opts->action == REPLAY_REVERT))
4622 return error(_("can't revert as initial commit"));
4623 if (save_head(oid_to_hex(&oid)))
4625 if (save_opts(opts))
4627 update_abort_safety_file();
4628 res = pick_commits(r, &todo_list, opts);
4629 todo_list_release(&todo_list);
4633 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag)
4635 unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
4636 struct strbuf sob = STRBUF_INIT;
4639 strbuf_addstr(&sob, sign_off_header);
4640 strbuf_addstr(&sob, fmt_name(WANT_COMMITTER_IDENT));
4641 strbuf_addch(&sob, '\n');
4644 strbuf_complete_line(msgbuf);
4647 * If the whole message buffer is equal to the sob, pretend that we
4648 * found a conforming footer with a matching sob
4650 if (msgbuf->len - ignore_footer == sob.len &&
4651 !strncmp(msgbuf->buf, sob.buf, sob.len))
4654 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
4657 const char *append_newlines = NULL;
4658 size_t len = msgbuf->len - ignore_footer;
4662 * The buffer is completely empty. Leave foom for
4663 * the title and body to be filled in by the user.
4665 append_newlines = "\n\n";
4666 } else if (len == 1) {
4668 * Buffer contains a single newline. Add another
4669 * so that we leave room for the title and body.
4671 append_newlines = "\n";
4672 } else if (msgbuf->buf[len - 2] != '\n') {
4674 * Buffer ends with a single newline. Add another
4675 * so that there is an empty line between the message
4678 append_newlines = "\n";
4679 } /* else, the buffer already ends with two newlines. */
4681 if (append_newlines)
4682 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
4683 append_newlines, strlen(append_newlines));
4686 if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
4687 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
4690 strbuf_release(&sob);
4693 struct labels_entry {
4694 struct hashmap_entry entry;
4695 char label[FLEX_ARRAY];
4698 static int labels_cmp(const void *fndata, const struct hashmap_entry *eptr,
4699 const struct hashmap_entry *entry_or_key, const void *key)
4701 const struct labels_entry *a, *b;
4703 a = container_of(eptr, const struct labels_entry, entry);
4704 b = container_of(entry_or_key, const struct labels_entry, entry);
4706 return key ? strcmp(a->label, key) : strcmp(a->label, b->label);
4709 struct string_entry {
4710 struct oidmap_entry entry;
4711 char string[FLEX_ARRAY];
4714 struct label_state {
4715 struct oidmap commit2label;
4716 struct hashmap labels;
4720 static const char *label_oid(struct object_id *oid, const char *label,
4721 struct label_state *state)
4723 struct labels_entry *labels_entry;
4724 struct string_entry *string_entry;
4725 struct object_id dummy;
4728 string_entry = oidmap_get(&state->commit2label, oid);
4730 return string_entry->string;
4733 * For "uninteresting" commits, i.e. commits that are not to be
4734 * rebased, and which can therefore not be labeled, we use a unique
4735 * abbreviation of the commit name. This is slightly more complicated
4736 * than calling find_unique_abbrev() because we also need to make
4737 * sure that the abbreviation does not conflict with any other
4740 * We disallow "interesting" commits to be labeled by a string that
4741 * is a valid full-length hash, to ensure that we always can find an
4742 * abbreviation for any uninteresting commit's names that does not
4743 * clash with any other label.
4745 strbuf_reset(&state->buf);
4749 strbuf_grow(&state->buf, GIT_MAX_HEXSZ);
4750 label = p = state->buf.buf;
4752 find_unique_abbrev_r(p, oid, default_abbrev);
4755 * We may need to extend the abbreviated hash so that there is
4756 * no conflicting label.
4758 if (hashmap_get_from_hash(&state->labels, strihash(p), p)) {
4759 size_t i = strlen(p) + 1;
4761 oid_to_hex_r(p, oid);
4762 for (; i < the_hash_algo->hexsz; i++) {
4765 if (!hashmap_get_from_hash(&state->labels,
4772 struct strbuf *buf = &state->buf;
4775 * Sanitize labels by replacing non-alpha-numeric characters
4776 * (including white-space ones) by dashes, as they might be
4777 * illegal in file names (and hence in ref names).
4779 * Note that we retain non-ASCII UTF-8 characters (identified
4780 * via the most significant bit). They should be all acceptable
4781 * in file names. We do not validate the UTF-8 here, that's not
4782 * the job of this function.
4784 for (; *label; label++)
4785 if ((*label & 0x80) || isalnum(*label))
4786 strbuf_addch(buf, *label);
4787 /* avoid leading dash and double-dashes */
4788 else if (buf->len && buf->buf[buf->len - 1] != '-')
4789 strbuf_addch(buf, '-');
4791 strbuf_addstr(buf, "rev-");
4792 strbuf_add_unique_abbrev(buf, oid, default_abbrev);
4796 if ((buf->len == the_hash_algo->hexsz &&
4797 !get_oid_hex(label, &dummy)) ||
4798 (buf->len == 1 && *label == '#') ||
4799 hashmap_get_from_hash(&state->labels,
4800 strihash(label), label)) {
4802 * If the label already exists, or if the label is a
4803 * valid full OID, or the label is a '#' (which we use
4804 * as a separator between merge heads and oneline), we
4805 * append a dash and a number to make it unique.
4807 size_t len = buf->len;
4809 for (i = 2; ; i++) {
4810 strbuf_setlen(buf, len);
4811 strbuf_addf(buf, "-%d", i);
4812 if (!hashmap_get_from_hash(&state->labels,
4822 FLEX_ALLOC_STR(labels_entry, label, label);
4823 hashmap_entry_init(&labels_entry->entry, strihash(label));
4824 hashmap_add(&state->labels, &labels_entry->entry);
4826 FLEX_ALLOC_STR(string_entry, string, label);
4827 oidcpy(&string_entry->entry.oid, oid);
4828 oidmap_put(&state->commit2label, string_entry);
4830 return string_entry->string;
4833 static int make_script_with_merges(struct pretty_print_context *pp,
4834 struct rev_info *revs, struct strbuf *out,
4837 int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
4838 int rebase_cousins = flags & TODO_LIST_REBASE_COUSINS;
4839 int root_with_onto = flags & TODO_LIST_ROOT_WITH_ONTO;
4840 struct strbuf buf = STRBUF_INIT, oneline = STRBUF_INIT;
4841 struct strbuf label = STRBUF_INIT;
4842 struct commit_list *commits = NULL, **tail = &commits, *iter;
4843 struct commit_list *tips = NULL, **tips_tail = &tips;
4844 struct commit *commit;
4845 struct oidmap commit2todo = OIDMAP_INIT;
4846 struct string_entry *entry;
4847 struct oidset interesting = OIDSET_INIT, child_seen = OIDSET_INIT,
4848 shown = OIDSET_INIT;
4849 struct label_state state = { OIDMAP_INIT, { NULL }, STRBUF_INIT };
4851 int abbr = flags & TODO_LIST_ABBREVIATE_CMDS;
4852 const char *cmd_pick = abbr ? "p" : "pick",
4853 *cmd_label = abbr ? "l" : "label",
4854 *cmd_reset = abbr ? "t" : "reset",
4855 *cmd_merge = abbr ? "m" : "merge";
4857 oidmap_init(&commit2todo, 0);
4858 oidmap_init(&state.commit2label, 0);
4859 hashmap_init(&state.labels, labels_cmp, NULL, 0);
4860 strbuf_init(&state.buf, 32);
4862 if (revs->cmdline.nr && (revs->cmdline.rev[0].flags & BOTTOM)) {
4863 struct labels_entry *onto_label_entry;
4864 struct object_id *oid = &revs->cmdline.rev[0].item->oid;
4865 FLEX_ALLOC_STR(entry, string, "onto");
4866 oidcpy(&entry->entry.oid, oid);
4867 oidmap_put(&state.commit2label, entry);
4869 FLEX_ALLOC_STR(onto_label_entry, label, "onto");
4870 hashmap_entry_init(&onto_label_entry->entry, strihash("onto"));
4871 hashmap_add(&state.labels, &onto_label_entry->entry);
4876 * - get onelines for all commits
4877 * - gather all branch tips (i.e. 2nd or later parents of merges)
4878 * - label all branch tips
4880 while ((commit = get_revision(revs))) {
4881 struct commit_list *to_merge;
4882 const char *p1, *p2;
4883 struct object_id *oid;
4886 tail = &commit_list_insert(commit, tail)->next;
4887 oidset_insert(&interesting, &commit->object.oid);
4889 is_empty = is_original_commit_empty(commit);
4890 if (!is_empty && (commit->object.flags & PATCHSAME))
4892 if (is_empty && !keep_empty)
4895 strbuf_reset(&oneline);
4896 pretty_print_commit(pp, commit, &oneline);
4898 to_merge = commit->parents ? commit->parents->next : NULL;
4900 /* non-merge commit: easy case */
4902 strbuf_addf(&buf, "%s %s %s", cmd_pick,
4903 oid_to_hex(&commit->object.oid),
4906 strbuf_addf(&buf, " %c empty",
4909 FLEX_ALLOC_STR(entry, string, buf.buf);
4910 oidcpy(&entry->entry.oid, &commit->object.oid);
4911 oidmap_put(&commit2todo, entry);
4916 /* Create a label */
4917 strbuf_reset(&label);
4918 if (skip_prefix(oneline.buf, "Merge ", &p1) &&
4919 (p1 = strchr(p1, '\'')) &&
4920 (p2 = strchr(++p1, '\'')))
4921 strbuf_add(&label, p1, p2 - p1);
4922 else if (skip_prefix(oneline.buf, "Merge pull request ",
4924 (p1 = strstr(p1, " from ")))
4925 strbuf_addstr(&label, p1 + strlen(" from "));
4927 strbuf_addbuf(&label, &oneline);
4930 strbuf_addf(&buf, "%s -C %s",
4931 cmd_merge, oid_to_hex(&commit->object.oid));
4933 /* label the tips of merged branches */
4934 for (; to_merge; to_merge = to_merge->next) {
4935 oid = &to_merge->item->object.oid;
4936 strbuf_addch(&buf, ' ');
4938 if (!oidset_contains(&interesting, oid)) {
4939 strbuf_addstr(&buf, label_oid(oid, NULL,
4944 tips_tail = &commit_list_insert(to_merge->item,
4947 strbuf_addstr(&buf, label_oid(oid, label.buf, &state));
4949 strbuf_addf(&buf, " # %s", oneline.buf);
4951 FLEX_ALLOC_STR(entry, string, buf.buf);
4952 oidcpy(&entry->entry.oid, &commit->object.oid);
4953 oidmap_put(&commit2todo, entry);
4958 * - label branch points
4959 * - add HEAD to the branch tips
4961 for (iter = commits; iter; iter = iter->next) {
4962 struct commit_list *parent = iter->item->parents;
4963 for (; parent; parent = parent->next) {
4964 struct object_id *oid = &parent->item->object.oid;
4965 if (!oidset_contains(&interesting, oid))
4967 if (oidset_insert(&child_seen, oid))
4968 label_oid(oid, "branch-point", &state);
4971 /* Add HEAD as implicit "tip of branch" */
4973 tips_tail = &commit_list_insert(iter->item,
4978 * Third phase: output the todo list. This is a bit tricky, as we
4979 * want to avoid jumping back and forth between revisions. To
4980 * accomplish that goal, we walk backwards from the branch tips,
4981 * gathering commits not yet shown, reversing the list on the fly,
4982 * then outputting that list (labeling revisions as needed).
4984 strbuf_addf(out, "%s onto\n", cmd_label);
4985 for (iter = tips; iter; iter = iter->next) {
4986 struct commit_list *list = NULL, *iter2;
4988 commit = iter->item;
4989 if (oidset_contains(&shown, &commit->object.oid))
4991 entry = oidmap_get(&state.commit2label, &commit->object.oid);
4994 strbuf_addf(out, "\n%c Branch %s\n", comment_line_char, entry->string);
4996 strbuf_addch(out, '\n');
4998 while (oidset_contains(&interesting, &commit->object.oid) &&
4999 !oidset_contains(&shown, &commit->object.oid)) {
5000 commit_list_insert(commit, &list);
5001 if (!commit->parents) {
5005 commit = commit->parents->item;
5009 strbuf_addf(out, "%s %s\n", cmd_reset,
5010 rebase_cousins || root_with_onto ?
5011 "onto" : "[new root]");
5013 const char *to = NULL;
5015 entry = oidmap_get(&state.commit2label,
5016 &commit->object.oid);
5019 else if (!rebase_cousins)
5020 to = label_oid(&commit->object.oid, NULL,
5023 if (!to || !strcmp(to, "onto"))
5024 strbuf_addf(out, "%s onto\n", cmd_reset);
5026 strbuf_reset(&oneline);
5027 pretty_print_commit(pp, commit, &oneline);
5028 strbuf_addf(out, "%s %s # %s\n",
5029 cmd_reset, to, oneline.buf);
5033 for (iter2 = list; iter2; iter2 = iter2->next) {
5034 struct object_id *oid = &iter2->item->object.oid;
5035 entry = oidmap_get(&commit2todo, oid);
5036 /* only show if not already upstream */
5038 strbuf_addf(out, "%s\n", entry->string);
5039 entry = oidmap_get(&state.commit2label, oid);
5041 strbuf_addf(out, "%s %s\n",
5042 cmd_label, entry->string);
5043 oidset_insert(&shown, oid);
5046 free_commit_list(list);
5049 free_commit_list(commits);
5050 free_commit_list(tips);
5052 strbuf_release(&label);
5053 strbuf_release(&oneline);
5054 strbuf_release(&buf);
5056 oidmap_free(&commit2todo, 1);
5057 oidmap_free(&state.commit2label, 1);
5058 hashmap_free_entries(&state.labels, struct labels_entry, entry);
5059 strbuf_release(&state.buf);
5064 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
5065 const char **argv, unsigned flags)
5067 char *format = NULL;
5068 struct pretty_print_context pp = {0};
5069 struct rev_info revs;
5070 struct commit *commit;
5071 int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
5072 const char *insn = flags & TODO_LIST_ABBREVIATE_CMDS ? "p" : "pick";
5073 int rebase_merges = flags & TODO_LIST_REBASE_MERGES;
5074 int reapply_cherry_picks = flags & TODO_LIST_REAPPLY_CHERRY_PICKS;
5076 repo_init_revisions(r, &revs, NULL);
5077 revs.verbose_header = 1;
5079 revs.max_parents = 1;
5080 revs.cherry_mark = !reapply_cherry_picks;
5083 revs.right_only = 1;
5084 revs.sort_order = REV_SORT_IN_GRAPH_ORDER;
5085 revs.topo_order = 1;
5087 revs.pretty_given = 1;
5088 git_config_get_string("rebase.instructionFormat", &format);
5089 if (!format || !*format) {
5091 format = xstrdup("%s");
5093 get_commit_format(format, &revs);
5095 pp.fmt = revs.commit_format;
5096 pp.output_encoding = get_log_output_encoding();
5098 if (setup_revisions(argc, argv, &revs, NULL) > 1)
5099 return error(_("make_script: unhandled options"));
5101 if (prepare_revision_walk(&revs) < 0)
5102 return error(_("make_script: error preparing revisions"));
5105 return make_script_with_merges(&pp, &revs, out, flags);
5107 while ((commit = get_revision(&revs))) {
5108 int is_empty = is_original_commit_empty(commit);
5110 if (!is_empty && (commit->object.flags & PATCHSAME))
5112 if (is_empty && !keep_empty)
5114 strbuf_addf(out, "%s %s ", insn,
5115 oid_to_hex(&commit->object.oid));
5116 pretty_print_commit(&pp, commit, out);
5118 strbuf_addf(out, " %c empty", comment_line_char);
5119 strbuf_addch(out, '\n');
5125 * Add commands after pick and (series of) squash/fixup commands
5128 void todo_list_add_exec_commands(struct todo_list *todo_list,
5129 struct string_list *commands)
5131 struct strbuf *buf = &todo_list->buf;
5132 size_t base_offset = buf->len;
5133 int i, insert, nr = 0, alloc = 0;
5134 struct todo_item *items = NULL, *base_items = NULL;
5136 base_items = xcalloc(commands->nr, sizeof(struct todo_item));
5137 for (i = 0; i < commands->nr; i++) {
5138 size_t command_len = strlen(commands->items[i].string);
5140 strbuf_addstr(buf, commands->items[i].string);
5141 strbuf_addch(buf, '\n');
5143 base_items[i].command = TODO_EXEC;
5144 base_items[i].offset_in_buf = base_offset;
5145 base_items[i].arg_offset = base_offset + strlen("exec ");
5146 base_items[i].arg_len = command_len - strlen("exec ");
5148 base_offset += command_len + 1;
5152 * Insert <commands> after every pick. Here, fixup/squash chains
5153 * are considered part of the pick, so we insert the commands *after*
5154 * those chains if there are any.
5156 * As we insert the exec commands immediately after rearranging
5157 * any fixups and before the user edits the list, a fixup chain
5158 * can never contain comments (any comments are empty picks that
5159 * have been commented out because the user did not specify
5160 * --keep-empty). So, it is safe to insert an exec command
5161 * without looking at the command following a comment.
5164 for (i = 0; i < todo_list->nr; i++) {
5165 enum todo_command command = todo_list->items[i].command;
5166 if (insert && !is_fixup(command)) {
5167 ALLOC_GROW(items, nr + commands->nr, alloc);
5168 COPY_ARRAY(items + nr, base_items, commands->nr);
5174 ALLOC_GROW(items, nr + 1, alloc);
5175 items[nr++] = todo_list->items[i];
5177 if (command == TODO_PICK || command == TODO_MERGE)
5181 /* insert or append final <commands> */
5182 if (insert || nr == todo_list->nr) {
5183 ALLOC_GROW(items, nr + commands->nr, alloc);
5184 COPY_ARRAY(items + nr, base_items, commands->nr);
5189 FREE_AND_NULL(todo_list->items);
5190 todo_list->items = items;
5192 todo_list->alloc = alloc;
5195 static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
5196 struct strbuf *buf, int num, unsigned flags)
5198 struct todo_item *item;
5199 int i, max = todo_list->nr;
5201 if (num > 0 && num < max)
5204 for (item = todo_list->items, i = 0; i < max; i++, item++) {
5207 /* if the item is not a command write it and continue */
5208 if (item->command >= TODO_COMMENT) {
5209 strbuf_addf(buf, "%.*s\n", item->arg_len,
5210 todo_item_get_arg(todo_list, item));
5214 /* add command to the buffer */
5215 cmd = command_to_char(item->command);
5216 if ((flags & TODO_LIST_ABBREVIATE_CMDS) && cmd)
5217 strbuf_addch(buf, cmd);
5219 strbuf_addstr(buf, command_to_string(item->command));
5223 const char *oid = flags & TODO_LIST_SHORTEN_IDS ?
5224 short_commit_name(item->commit) :
5225 oid_to_hex(&item->commit->object.oid);
5227 if (item->command == TODO_MERGE) {
5228 if (item->flags & TODO_EDIT_MERGE_MSG)
5229 strbuf_addstr(buf, " -c");
5231 strbuf_addstr(buf, " -C");
5234 strbuf_addf(buf, " %s", oid);
5237 /* add all the rest */
5239 strbuf_addch(buf, '\n');
5241 strbuf_addf(buf, " %.*s\n", item->arg_len,
5242 todo_item_get_arg(todo_list, item));
5246 int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
5247 const char *file, const char *shortrevisions,
5248 const char *shortonto, int num, unsigned flags)
5251 struct strbuf buf = STRBUF_INIT;
5253 todo_list_to_strbuf(r, todo_list, &buf, num, flags);
5254 if (flags & TODO_LIST_APPEND_TODO_HELP)
5255 append_todo_help(count_commands(todo_list),
5256 shortrevisions, shortonto, &buf);
5258 res = write_message(buf.buf, buf.len, file, 0);
5259 strbuf_release(&buf);
5264 /* skip picking commits whose parents are unchanged */
5265 static int skip_unnecessary_picks(struct repository *r,
5266 struct todo_list *todo_list,
5267 struct object_id *base_oid)
5269 struct object_id *parent_oid;
5272 for (i = 0; i < todo_list->nr; i++) {
5273 struct todo_item *item = todo_list->items + i;
5275 if (item->command >= TODO_NOOP)
5277 if (item->command != TODO_PICK)
5279 if (parse_commit(item->commit)) {
5280 return error(_("could not parse commit '%s'"),
5281 oid_to_hex(&item->commit->object.oid));
5283 if (!item->commit->parents)
5284 break; /* root commit */
5285 if (item->commit->parents->next)
5286 break; /* merge commit */
5287 parent_oid = &item->commit->parents->item->object.oid;
5288 if (!oideq(parent_oid, base_oid))
5290 oidcpy(base_oid, &item->commit->object.oid);
5293 const char *done_path = rebase_path_done();
5295 if (todo_list_write_to_file(r, todo_list, done_path, NULL, NULL, i, 0)) {
5296 error_errno(_("could not write to '%s'"), done_path);
5300 MOVE_ARRAY(todo_list->items, todo_list->items + i, todo_list->nr - i);
5302 todo_list->current = 0;
5303 todo_list->done_nr += i;
5305 if (is_fixup(peek_command(todo_list, 0)))
5306 record_in_rewritten(base_oid, peek_command(todo_list, 0));
5312 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
5313 const char *shortrevisions, const char *onto_name,
5314 struct commit *onto, const struct object_id *orig_head,
5315 struct string_list *commands, unsigned autosquash,
5316 struct todo_list *todo_list)
5318 char shortonto[GIT_MAX_HEXSZ + 1];
5319 const char *todo_file = rebase_path_todo();
5320 struct todo_list new_todo = TODO_LIST_INIT;
5321 struct strbuf *buf = &todo_list->buf, buf2 = STRBUF_INIT;
5322 struct object_id oid = onto->object.oid;
5325 find_unique_abbrev_r(shortonto, &oid, DEFAULT_ABBREV);
5327 if (buf->len == 0) {
5328 struct todo_item *item = append_new_todo(todo_list);
5329 item->command = TODO_NOOP;
5330 item->commit = NULL;
5331 item->arg_len = item->arg_offset = item->flags = item->offset_in_buf = 0;
5334 if (autosquash && todo_list_rearrange_squash(todo_list))
5338 todo_list_add_exec_commands(todo_list, commands);
5340 if (count_commands(todo_list) == 0) {
5341 apply_autostash(rebase_path_autostash());
5342 sequencer_remove_state(opts);
5344 return error(_("nothing to do"));
5347 res = edit_todo_list(r, todo_list, &new_todo, shortrevisions,
5351 else if (res == -2) {
5352 apply_autostash(rebase_path_autostash());
5353 sequencer_remove_state(opts);
5356 } else if (res == -3) {
5357 apply_autostash(rebase_path_autostash());
5358 sequencer_remove_state(opts);
5359 todo_list_release(&new_todo);
5361 return error(_("nothing to do"));
5362 } else if (res == -4) {
5363 checkout_onto(r, opts, onto_name, &onto->object.oid, orig_head);
5364 todo_list_release(&new_todo);
5369 /* Expand the commit IDs */
5370 todo_list_to_strbuf(r, &new_todo, &buf2, -1, 0);
5371 strbuf_swap(&new_todo.buf, &buf2);
5372 strbuf_release(&buf2);
5373 new_todo.total_nr -= new_todo.nr;
5374 if (todo_list_parse_insn_buffer(r, new_todo.buf.buf, &new_todo) < 0)
5375 BUG("invalid todo list after expanding IDs:\n%s",
5378 if (opts->allow_ff && skip_unnecessary_picks(r, &new_todo, &oid)) {
5379 todo_list_release(&new_todo);
5380 return error(_("could not skip unnecessary pick commands"));
5383 if (todo_list_write_to_file(r, &new_todo, todo_file, NULL, NULL, -1,
5384 flags & ~(TODO_LIST_SHORTEN_IDS))) {
5385 todo_list_release(&new_todo);
5386 return error_errno(_("could not write '%s'"), todo_file);
5391 if (opts->committer_date_is_author_date && init_committer(opts))
5394 if (checkout_onto(r, opts, onto_name, &oid, orig_head))
5397 if (require_clean_work_tree(r, "rebase", "", 1, 1))
5400 todo_list_write_total_nr(&new_todo);
5401 res = pick_commits(r, &new_todo, opts);
5404 todo_list_release(&new_todo);
5409 struct subject2item_entry {
5410 struct hashmap_entry entry;
5412 char subject[FLEX_ARRAY];
5415 static int subject2item_cmp(const void *fndata,
5416 const struct hashmap_entry *eptr,
5417 const struct hashmap_entry *entry_or_key,
5420 const struct subject2item_entry *a, *b;
5422 a = container_of(eptr, const struct subject2item_entry, entry);
5423 b = container_of(entry_or_key, const struct subject2item_entry, entry);
5425 return key ? strcmp(a->subject, key) : strcmp(a->subject, b->subject);
5428 define_commit_slab(commit_todo_item, struct todo_item *);
5431 * Rearrange the todo list that has both "pick commit-id msg" and "pick
5432 * commit-id fixup!/squash! msg" in it so that the latter is put immediately
5433 * after the former, and change "pick" to "fixup"/"squash".
5435 * Note that if the config has specified a custom instruction format, each log
5436 * message will have to be retrieved from the commit (as the oneline in the
5437 * script cannot be trusted) in order to normalize the autosquash arrangement.
5439 int todo_list_rearrange_squash(struct todo_list *todo_list)
5441 struct hashmap subject2item;
5442 int rearranged = 0, *next, *tail, i, nr = 0, alloc = 0;
5444 struct commit_todo_item commit_todo;
5445 struct todo_item *items = NULL;
5447 init_commit_todo_item(&commit_todo);
5449 * The hashmap maps onelines to the respective todo list index.
5451 * If any items need to be rearranged, the next[i] value will indicate
5452 * which item was moved directly after the i'th.
5454 * In that case, last[i] will indicate the index of the latest item to
5455 * be moved to appear after the i'th.
5457 hashmap_init(&subject2item, subject2item_cmp, NULL, todo_list->nr);
5458 ALLOC_ARRAY(next, todo_list->nr);
5459 ALLOC_ARRAY(tail, todo_list->nr);
5460 ALLOC_ARRAY(subjects, todo_list->nr);
5461 for (i = 0; i < todo_list->nr; i++) {
5462 struct strbuf buf = STRBUF_INIT;
5463 struct todo_item *item = todo_list->items + i;
5464 const char *commit_buffer, *subject, *p;
5467 struct subject2item_entry *entry;
5469 next[i] = tail[i] = -1;
5470 if (!item->commit || item->command == TODO_DROP) {
5475 if (is_fixup(item->command)) {
5476 clear_commit_todo_item(&commit_todo);
5477 return error(_("the script was already rearranged."));
5480 *commit_todo_item_at(&commit_todo, item->commit) = item;
5482 parse_commit(item->commit);
5483 commit_buffer = logmsg_reencode(item->commit, NULL, "UTF-8");
5484 find_commit_subject(commit_buffer, &subject);
5485 format_subject(&buf, subject, " ");
5486 subject = subjects[i] = strbuf_detach(&buf, &subject_len);
5487 unuse_commit_buffer(item->commit, commit_buffer);
5488 if ((skip_prefix(subject, "fixup! ", &p) ||
5489 skip_prefix(subject, "squash! ", &p))) {
5490 struct commit *commit2;
5495 if (!skip_prefix(p, "fixup! ", &p) &&
5496 !skip_prefix(p, "squash! ", &p))
5500 entry = hashmap_get_entry_from_hash(&subject2item,
5502 struct subject2item_entry,
5505 /* found by title */
5507 else if (!strchr(p, ' ') &&
5509 lookup_commit_reference_by_name(p)) &&
5510 *commit_todo_item_at(&commit_todo, commit2))
5511 /* found by commit name */
5512 i2 = *commit_todo_item_at(&commit_todo, commit2)
5515 /* copy can be a prefix of the commit subject */
5516 for (i2 = 0; i2 < i; i2++)
5518 starts_with(subjects[i2], p))
5526 todo_list->items[i].command =
5527 starts_with(subject, "fixup!") ?
5528 TODO_FIXUP : TODO_SQUASH;
5533 next[i] = next[tail[i2]];
5537 } else if (!hashmap_get_from_hash(&subject2item,
5538 strhash(subject), subject)) {
5539 FLEX_ALLOC_MEM(entry, subject, subject, subject_len);
5541 hashmap_entry_init(&entry->entry,
5542 strhash(entry->subject));
5543 hashmap_put(&subject2item, &entry->entry);
5548 for (i = 0; i < todo_list->nr; i++) {
5549 enum todo_command command = todo_list->items[i].command;
5553 * Initially, all commands are 'pick's. If it is a
5554 * fixup or a squash now, we have rearranged it.
5556 if (is_fixup(command))
5560 ALLOC_GROW(items, nr + 1, alloc);
5561 items[nr++] = todo_list->items[cur];
5566 FREE_AND_NULL(todo_list->items);
5567 todo_list->items = items;
5569 todo_list->alloc = alloc;
5574 for (i = 0; i < todo_list->nr; i++)
5577 hashmap_free_entries(&subject2item, struct subject2item_entry, entry);
5579 clear_commit_todo_item(&commit_todo);
5584 int sequencer_determine_whence(struct repository *r, enum commit_whence *whence)
5586 if (refs_ref_exists(get_main_ref_store(r), "CHERRY_PICK_HEAD")) {
5587 struct object_id cherry_pick_head, rebase_head;
5589 if (file_exists(git_path_seq_dir()))
5590 *whence = FROM_CHERRY_PICK_MULTI;
5591 if (file_exists(rebase_path()) &&
5592 !get_oid("REBASE_HEAD", &rebase_head) &&
5593 !get_oid("CHERRY_PICK_HEAD", &cherry_pick_head) &&
5594 oideq(&rebase_head, &cherry_pick_head))
5595 *whence = FROM_REBASE_PICK;
5597 *whence = FROM_CHERRY_PICK_SINGLE;