submodule.c: use the right index instead of the_index
[alt-git.git] / sequencer.c
blob4d40f50c1c9d5aae301bb1ead04d67d02d113cba
1 #include "cache.h"
2 #include "config.h"
3 #include "lockfile.h"
4 #include "dir.h"
5 #include "object-store.h"
6 #include "object.h"
7 #include "commit.h"
8 #include "sequencer.h"
9 #include "tag.h"
10 #include "run-command.h"
11 #include "exec-cmd.h"
12 #include "utf8.h"
13 #include "cache-tree.h"
14 #include "diff.h"
15 #include "revision.h"
16 #include "rerere.h"
17 #include "merge-recursive.h"
18 #include "refs.h"
19 #include "argv-array.h"
20 #include "quote.h"
21 #include "trailer.h"
22 #include "log-tree.h"
23 #include "wt-status.h"
24 #include "hashmap.h"
25 #include "notes-utils.h"
26 #include "sigchain.h"
27 #include "unpack-trees.h"
28 #include "worktree.h"
29 #include "oidmap.h"
30 #include "oidset.h"
31 #include "commit-slab.h"
32 #include "alias.h"
34 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
36 const char sign_off_header[] = "Signed-off-by: ";
37 static const char cherry_picked_prefix[] = "(cherry picked from commit ";
39 GIT_PATH_FUNC(git_path_commit_editmsg, "COMMIT_EDITMSG")
41 GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
43 static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
44 static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
45 static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
46 static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
48 static GIT_PATH_FUNC(rebase_path, "rebase-merge")
50 * The file containing rebase commands, comments, and empty lines.
51 * This file is created by "git rebase -i" then edited by the user. As
52 * the lines are processed, they are removed from the front of this
53 * file and written to the tail of 'done'.
55 static GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
57 * The rebase command lines that have already been processed. A line
58 * is moved here when it is first handled, before any associated user
59 * actions.
61 static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
63 * The file to keep track of how many commands were already processed (e.g.
64 * for the prompt).
66 static GIT_PATH_FUNC(rebase_path_msgnum, "rebase-merge/msgnum")
68 * The file to keep track of how many commands are to be processed in total
69 * (e.g. for the prompt).
71 static GIT_PATH_FUNC(rebase_path_msgtotal, "rebase-merge/end")
73 * The commit message that is planned to be used for any changes that
74 * need to be committed following a user interaction.
76 static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
78 * The file into which is accumulated the suggested commit message for
79 * squash/fixup commands. When the first of a series of squash/fixups
80 * is seen, the file is created and the commit message from the
81 * previous commit and from the first squash/fixup commit are written
82 * to it. The commit message for each subsequent squash/fixup commit
83 * is appended to the file as it is processed.
85 static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
87 * If the current series of squash/fixups has not yet included a squash
88 * command, then this file exists and holds the commit message of the
89 * original "pick" commit. (If the series ends without a "squash"
90 * command, then this can be used as the commit message of the combined
91 * commit without opening the editor.)
93 static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
95 * This file contains the list fixup/squash commands that have been
96 * accumulated into message-fixup or message-squash so far.
98 static GIT_PATH_FUNC(rebase_path_current_fixups, "rebase-merge/current-fixups")
100 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
101 * GIT_AUTHOR_DATE that will be used for the commit that is currently
102 * being rebased.
104 static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
106 * When an "edit" rebase command is being processed, the SHA1 of the
107 * commit to be edited is recorded in this file. When "git rebase
108 * --continue" is executed, if there are any staged changes then they
109 * will be amended to the HEAD commit, but only provided the HEAD
110 * commit is still the commit to be edited. When any other rebase
111 * command is processed, this file is deleted.
113 static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
115 * When we stop at a given patch via the "edit" command, this file contains
116 * the abbreviated commit name of the corresponding patch.
118 static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
120 * For the post-rewrite hook, we make a list of rewritten commits and
121 * their new sha1s. The rewritten-pending list keeps the sha1s of
122 * commits that have been processed, but not committed yet,
123 * e.g. because they are waiting for a 'squash' command.
125 static GIT_PATH_FUNC(rebase_path_rewritten_list, "rebase-merge/rewritten-list")
126 static GIT_PATH_FUNC(rebase_path_rewritten_pending,
127 "rebase-merge/rewritten-pending")
130 * The path of the file containig the OID of the "squash onto" commit, i.e.
131 * the dummy commit used for `reset [new root]`.
133 static GIT_PATH_FUNC(rebase_path_squash_onto, "rebase-merge/squash-onto")
136 * The path of the file listing refs that need to be deleted after the rebase
137 * finishes. This is used by the `label` command to record the need for cleanup.
139 static GIT_PATH_FUNC(rebase_path_refs_to_delete, "rebase-merge/refs-to-delete")
142 * The following files are written by git-rebase just after parsing the
143 * command-line (and are only consumed, not modified, by the sequencer).
145 static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
146 static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
147 static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
148 static GIT_PATH_FUNC(rebase_path_signoff, "rebase-merge/signoff")
149 static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
150 static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
151 static GIT_PATH_FUNC(rebase_path_autostash, "rebase-merge/autostash")
152 static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy")
153 static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts")
154 static GIT_PATH_FUNC(rebase_path_allow_rerere_autoupdate, "rebase-merge/allow_rerere_autoupdate")
156 static int git_sequencer_config(const char *k, const char *v, void *cb)
158 struct replay_opts *opts = cb;
159 int status;
161 if (!strcmp(k, "commit.cleanup")) {
162 const char *s;
164 status = git_config_string(&s, k, v);
165 if (status)
166 return status;
168 if (!strcmp(s, "verbatim"))
169 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
170 else if (!strcmp(s, "whitespace"))
171 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE;
172 else if (!strcmp(s, "strip"))
173 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_ALL;
174 else if (!strcmp(s, "scissors"))
175 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE;
176 else
177 warning(_("invalid commit message cleanup mode '%s'"),
180 free((char *)s);
181 return status;
184 if (!strcmp(k, "commit.gpgsign")) {
185 opts->gpg_sign = git_config_bool(k, v) ? xstrdup("") : NULL;
186 return 0;
189 status = git_gpg_config(k, v, NULL);
190 if (status)
191 return status;
193 return git_diff_basic_config(k, v, NULL);
196 void sequencer_init_config(struct replay_opts *opts)
198 opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
199 git_config(git_sequencer_config, opts);
202 static inline int is_rebase_i(const struct replay_opts *opts)
204 return opts->action == REPLAY_INTERACTIVE_REBASE;
207 static const char *get_dir(const struct replay_opts *opts)
209 if (is_rebase_i(opts))
210 return rebase_path();
211 return git_path_seq_dir();
214 static const char *get_todo_path(const struct replay_opts *opts)
216 if (is_rebase_i(opts))
217 return rebase_path_todo();
218 return git_path_todo_file();
222 * Returns 0 for non-conforming footer
223 * Returns 1 for conforming footer
224 * Returns 2 when sob exists within conforming footer
225 * Returns 3 when sob exists within conforming footer as last entry
227 static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
228 int ignore_footer)
230 struct trailer_info info;
231 int i;
232 int found_sob = 0, found_sob_last = 0;
234 trailer_info_get(&info, sb->buf);
236 if (info.trailer_start == info.trailer_end)
237 return 0;
239 for (i = 0; i < info.trailer_nr; i++)
240 if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
241 found_sob = 1;
242 if (i == info.trailer_nr - 1)
243 found_sob_last = 1;
246 trailer_info_release(&info);
248 if (found_sob_last)
249 return 3;
250 if (found_sob)
251 return 2;
252 return 1;
255 static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
257 static struct strbuf buf = STRBUF_INIT;
259 strbuf_reset(&buf);
260 if (opts->gpg_sign)
261 sq_quotef(&buf, "-S%s", opts->gpg_sign);
262 return buf.buf;
265 int sequencer_remove_state(struct replay_opts *opts)
267 struct strbuf buf = STRBUF_INIT;
268 int i;
270 if (is_rebase_i(opts) &&
271 strbuf_read_file(&buf, rebase_path_refs_to_delete(), 0) > 0) {
272 char *p = buf.buf;
273 while (*p) {
274 char *eol = strchr(p, '\n');
275 if (eol)
276 *eol = '\0';
277 if (delete_ref("(rebase -i) cleanup", p, NULL, 0) < 0)
278 warning(_("could not delete '%s'"), p);
279 if (!eol)
280 break;
281 p = eol + 1;
285 free(opts->gpg_sign);
286 free(opts->strategy);
287 for (i = 0; i < opts->xopts_nr; i++)
288 free(opts->xopts[i]);
289 free(opts->xopts);
290 strbuf_release(&opts->current_fixups);
292 strbuf_reset(&buf);
293 strbuf_addstr(&buf, get_dir(opts));
294 remove_dir_recursively(&buf, 0);
295 strbuf_release(&buf);
297 return 0;
300 static const char *action_name(const struct replay_opts *opts)
302 switch (opts->action) {
303 case REPLAY_REVERT:
304 return N_("revert");
305 case REPLAY_PICK:
306 return N_("cherry-pick");
307 case REPLAY_INTERACTIVE_REBASE:
308 return N_("rebase -i");
310 die(_("Unknown action: %d"), opts->action);
313 struct commit_message {
314 char *parent_label;
315 char *label;
316 char *subject;
317 const char *message;
320 static const char *short_commit_name(struct commit *commit)
322 return find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV);
325 static int get_message(struct commit *commit, struct commit_message *out)
327 const char *abbrev, *subject;
328 int subject_len;
330 out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
331 abbrev = short_commit_name(commit);
333 subject_len = find_commit_subject(out->message, &subject);
335 out->subject = xmemdupz(subject, subject_len);
336 out->label = xstrfmt("%s... %s", abbrev, out->subject);
337 out->parent_label = xstrfmt("parent of %s", out->label);
339 return 0;
342 static void free_message(struct commit *commit, struct commit_message *msg)
344 free(msg->parent_label);
345 free(msg->label);
346 free(msg->subject);
347 unuse_commit_buffer(commit, msg->message);
350 static void print_advice(int show_hint, struct replay_opts *opts)
352 char *msg = getenv("GIT_CHERRY_PICK_HELP");
354 if (msg) {
355 fprintf(stderr, "%s\n", msg);
357 * A conflict has occurred but the porcelain
358 * (typically rebase --interactive) wants to take care
359 * of the commit itself so remove CHERRY_PICK_HEAD
361 unlink(git_path_cherry_pick_head(the_repository));
362 return;
365 if (show_hint) {
366 if (opts->no_commit)
367 advise(_("after resolving the conflicts, mark the corrected paths\n"
368 "with 'git add <paths>' or 'git rm <paths>'"));
369 else
370 advise(_("after resolving the conflicts, mark the corrected paths\n"
371 "with 'git add <paths>' or 'git rm <paths>'\n"
372 "and commit the result with 'git commit'"));
376 static int write_message(const void *buf, size_t len, const char *filename,
377 int append_eol)
379 struct lock_file msg_file = LOCK_INIT;
381 int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
382 if (msg_fd < 0)
383 return error_errno(_("could not lock '%s'"), filename);
384 if (write_in_full(msg_fd, buf, len) < 0) {
385 error_errno(_("could not write to '%s'"), filename);
386 rollback_lock_file(&msg_file);
387 return -1;
389 if (append_eol && write(msg_fd, "\n", 1) < 0) {
390 error_errno(_("could not write eol to '%s'"), filename);
391 rollback_lock_file(&msg_file);
392 return -1;
394 if (commit_lock_file(&msg_file) < 0)
395 return error(_("failed to finalize '%s'"), filename);
397 return 0;
401 * Reads a file that was presumably written by a shell script, i.e. with an
402 * end-of-line marker that needs to be stripped.
404 * Note that only the last end-of-line marker is stripped, consistent with the
405 * behavior of "$(cat path)" in a shell script.
407 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
409 static int read_oneliner(struct strbuf *buf,
410 const char *path, int skip_if_empty)
412 int orig_len = buf->len;
414 if (!file_exists(path))
415 return 0;
417 if (strbuf_read_file(buf, path, 0) < 0) {
418 warning_errno(_("could not read '%s'"), path);
419 return 0;
422 if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
423 if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
424 --buf->len;
425 buf->buf[buf->len] = '\0';
428 if (skip_if_empty && buf->len == orig_len)
429 return 0;
431 return 1;
434 static struct tree *empty_tree(void)
436 return lookup_tree(the_repository, the_repository->hash_algo->empty_tree);
439 static int error_dirty_index(struct replay_opts *opts)
441 if (read_cache_unmerged())
442 return error_resolve_conflict(_(action_name(opts)));
444 error(_("your local changes would be overwritten by %s."),
445 _(action_name(opts)));
447 if (advice_commit_before_merge)
448 advise(_("commit your changes or stash them to proceed."));
449 return -1;
452 static void update_abort_safety_file(void)
454 struct object_id head;
456 /* Do nothing on a single-pick */
457 if (!file_exists(git_path_seq_dir()))
458 return;
460 if (!get_oid("HEAD", &head))
461 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
462 else
463 write_file(git_path_abort_safety_file(), "%s", "");
466 static int fast_forward_to(const struct object_id *to, const struct object_id *from,
467 int unborn, struct replay_opts *opts)
469 struct ref_transaction *transaction;
470 struct strbuf sb = STRBUF_INIT;
471 struct strbuf err = STRBUF_INIT;
473 read_cache();
474 if (checkout_fast_forward(from, to, 1))
475 return -1; /* the callee should have complained already */
477 strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
479 transaction = ref_transaction_begin(&err);
480 if (!transaction ||
481 ref_transaction_update(transaction, "HEAD",
482 to, unborn && !is_rebase_i(opts) ?
483 &null_oid : from,
484 0, sb.buf, &err) ||
485 ref_transaction_commit(transaction, &err)) {
486 ref_transaction_free(transaction);
487 error("%s", err.buf);
488 strbuf_release(&sb);
489 strbuf_release(&err);
490 return -1;
493 strbuf_release(&sb);
494 strbuf_release(&err);
495 ref_transaction_free(transaction);
496 update_abort_safety_file();
497 return 0;
500 void append_conflicts_hint(struct strbuf *msgbuf)
502 int i;
504 strbuf_addch(msgbuf, '\n');
505 strbuf_commented_addf(msgbuf, "Conflicts:\n");
506 for (i = 0; i < active_nr;) {
507 const struct cache_entry *ce = active_cache[i++];
508 if (ce_stage(ce)) {
509 strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
510 while (i < active_nr && !strcmp(ce->name,
511 active_cache[i]->name))
512 i++;
517 static int do_recursive_merge(struct commit *base, struct commit *next,
518 const char *base_label, const char *next_label,
519 struct object_id *head, struct strbuf *msgbuf,
520 struct replay_opts *opts)
522 struct merge_options o;
523 struct tree *result, *next_tree, *base_tree, *head_tree;
524 int clean;
525 char **xopt;
526 struct lock_file index_lock = LOCK_INIT;
528 if (hold_locked_index(&index_lock, LOCK_REPORT_ON_ERROR) < 0)
529 return -1;
531 read_cache();
533 init_merge_options(&o);
534 o.ancestor = base ? base_label : "(empty tree)";
535 o.branch1 = "HEAD";
536 o.branch2 = next ? next_label : "(empty tree)";
537 if (is_rebase_i(opts))
538 o.buffer_output = 2;
539 o.show_rename_progress = 1;
541 head_tree = parse_tree_indirect(head);
542 next_tree = next ? get_commit_tree(next) : empty_tree();
543 base_tree = base ? get_commit_tree(base) : empty_tree();
545 for (xopt = opts->xopts; xopt != opts->xopts + opts->xopts_nr; xopt++)
546 parse_merge_opt(&o, *xopt);
548 clean = merge_trees(&o,
549 head_tree,
550 next_tree, base_tree, &result);
551 if (is_rebase_i(opts) && clean <= 0)
552 fputs(o.obuf.buf, stdout);
553 strbuf_release(&o.obuf);
554 diff_warn_rename_limit("merge.renamelimit", o.needed_rename_limit, 0);
555 if (clean < 0) {
556 rollback_lock_file(&index_lock);
557 return clean;
560 if (write_locked_index(&the_index, &index_lock,
561 COMMIT_LOCK | SKIP_IF_UNCHANGED))
563 * TRANSLATORS: %s will be "revert", "cherry-pick" or
564 * "rebase -i".
566 return error(_("%s: Unable to write new index file"),
567 _(action_name(opts)));
569 if (!clean)
570 append_conflicts_hint(msgbuf);
572 return !clean;
575 static struct object_id *get_cache_tree_oid(void)
577 if (!active_cache_tree)
578 active_cache_tree = cache_tree();
580 if (!cache_tree_fully_valid(active_cache_tree))
581 if (cache_tree_update(&the_index, 0)) {
582 error(_("unable to update cache tree"));
583 return NULL;
586 return &active_cache_tree->oid;
589 static int is_index_unchanged(void)
591 struct object_id head_oid, *cache_tree_oid;
592 struct commit *head_commit;
594 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, &head_oid, NULL))
595 return error(_("could not resolve HEAD commit"));
597 head_commit = lookup_commit(the_repository, &head_oid);
600 * If head_commit is NULL, check_commit, called from
601 * lookup_commit, would have indicated that head_commit is not
602 * a commit object already. parse_commit() will return failure
603 * without further complaints in such a case. Otherwise, if
604 * the commit is invalid, parse_commit() will complain. So
605 * there is nothing for us to say here. Just return failure.
607 if (parse_commit(head_commit))
608 return -1;
610 if (!(cache_tree_oid = get_cache_tree_oid()))
611 return -1;
613 return !oidcmp(cache_tree_oid, get_commit_tree_oid(head_commit));
616 static int write_author_script(const char *message)
618 struct strbuf buf = STRBUF_INIT;
619 const char *eol;
620 int res;
622 for (;;)
623 if (!*message || starts_with(message, "\n")) {
624 missing_author:
625 /* Missing 'author' line? */
626 unlink(rebase_path_author_script());
627 return 0;
628 } else if (skip_prefix(message, "author ", &message))
629 break;
630 else if ((eol = strchr(message, '\n')))
631 message = eol + 1;
632 else
633 goto missing_author;
635 strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
636 while (*message && *message != '\n' && *message != '\r')
637 if (skip_prefix(message, " <", &message))
638 break;
639 else if (*message != '\'')
640 strbuf_addch(&buf, *(message++));
641 else
642 strbuf_addf(&buf, "'\\\\%c'", *(message++));
643 strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
644 while (*message && *message != '\n' && *message != '\r')
645 if (skip_prefix(message, "> ", &message))
646 break;
647 else if (*message != '\'')
648 strbuf_addch(&buf, *(message++));
649 else
650 strbuf_addf(&buf, "'\\\\%c'", *(message++));
651 strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
652 while (*message && *message != '\n' && *message != '\r')
653 if (*message != '\'')
654 strbuf_addch(&buf, *(message++));
655 else
656 strbuf_addf(&buf, "'\\\\%c'", *(message++));
657 res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
658 strbuf_release(&buf);
659 return res;
663 * Read a list of environment variable assignments (such as the author-script
664 * file) into an environment block. Returns -1 on error, 0 otherwise.
666 static int read_env_script(struct argv_array *env)
668 struct strbuf script = STRBUF_INIT;
669 int i, count = 0;
670 char *p, *p2;
672 if (strbuf_read_file(&script, rebase_path_author_script(), 256) <= 0)
673 return -1;
675 for (p = script.buf; *p; p++)
676 if (skip_prefix(p, "'\\\\''", (const char **)&p2))
677 strbuf_splice(&script, p - script.buf, p2 - p, "'", 1);
678 else if (*p == '\'')
679 strbuf_splice(&script, p-- - script.buf, 1, "", 0);
680 else if (*p == '\n') {
681 *p = '\0';
682 count++;
685 for (i = 0, p = script.buf; i < count; i++) {
686 argv_array_push(env, p);
687 p += strlen(p) + 1;
690 return 0;
693 static char *get_author(const char *message)
695 size_t len;
696 const char *a;
698 a = find_commit_header(message, "author", &len);
699 if (a)
700 return xmemdupz(a, len);
702 return NULL;
705 /* Read author-script and return an ident line (author <email> timestamp) */
706 static const char *read_author_ident(struct strbuf *buf)
708 const char *keys[] = {
709 "GIT_AUTHOR_NAME=", "GIT_AUTHOR_EMAIL=", "GIT_AUTHOR_DATE="
711 char *in, *out, *eol;
712 int i = 0, len;
714 if (strbuf_read_file(buf, rebase_path_author_script(), 256) <= 0)
715 return NULL;
717 /* dequote values and construct ident line in-place */
718 for (in = out = buf->buf; i < 3 && in - buf->buf < buf->len; i++) {
719 if (!skip_prefix(in, keys[i], (const char **)&in)) {
720 warning("could not parse '%s' (looking for '%s'",
721 rebase_path_author_script(), keys[i]);
722 return NULL;
725 eol = strchrnul(in, '\n');
726 *eol = '\0';
727 sq_dequote(in);
728 len = strlen(in);
730 if (i > 0) /* separate values by spaces */
731 *(out++) = ' ';
732 if (i == 1) /* email needs to be surrounded by <...> */
733 *(out++) = '<';
734 memmove(out, in, len);
735 out += len;
736 if (i == 1) /* email needs to be surrounded by <...> */
737 *(out++) = '>';
738 in = eol + 1;
741 if (i < 3) {
742 warning("could not parse '%s' (looking for '%s')",
743 rebase_path_author_script(), keys[i]);
744 return NULL;
747 buf->len = out - buf->buf;
748 return buf->buf;
751 static const char staged_changes_advice[] =
752 N_("you have staged changes in your working tree\n"
753 "If these changes are meant to be squashed into the previous commit, run:\n"
754 "\n"
755 " git commit --amend %s\n"
756 "\n"
757 "If they are meant to go into a new commit, run:\n"
758 "\n"
759 " git commit %s\n"
760 "\n"
761 "In both cases, once you're done, continue with:\n"
762 "\n"
763 " git rebase --continue\n");
765 #define ALLOW_EMPTY (1<<0)
766 #define EDIT_MSG (1<<1)
767 #define AMEND_MSG (1<<2)
768 #define CLEANUP_MSG (1<<3)
769 #define VERIFY_MSG (1<<4)
770 #define CREATE_ROOT_COMMIT (1<<5)
773 * If we are cherry-pick, and if the merge did not result in
774 * hand-editing, we will hit this commit and inherit the original
775 * author date and name.
777 * If we are revert, or if our cherry-pick results in a hand merge,
778 * we had better say that the current user is responsible for that.
780 * An exception is when run_git_commit() is called during an
781 * interactive rebase: in that case, we will want to retain the
782 * author metadata.
784 static int run_git_commit(const char *defmsg, struct replay_opts *opts,
785 unsigned int flags)
787 struct child_process cmd = CHILD_PROCESS_INIT;
788 const char *value;
790 if ((flags & CREATE_ROOT_COMMIT) && !(flags & AMEND_MSG)) {
791 struct strbuf msg = STRBUF_INIT, script = STRBUF_INIT;
792 const char *author = is_rebase_i(opts) ?
793 read_author_ident(&script) : NULL;
794 struct object_id root_commit, *cache_tree_oid;
795 int res = 0;
797 if (!defmsg)
798 BUG("root commit without message");
800 if (!(cache_tree_oid = get_cache_tree_oid()))
801 res = -1;
803 if (!res)
804 res = strbuf_read_file(&msg, defmsg, 0);
806 if (res <= 0)
807 res = error_errno(_("could not read '%s'"), defmsg);
808 else
809 res = commit_tree(msg.buf, msg.len, cache_tree_oid,
810 NULL, &root_commit, author,
811 opts->gpg_sign);
813 strbuf_release(&msg);
814 strbuf_release(&script);
815 if (!res) {
816 update_ref(NULL, "CHERRY_PICK_HEAD", &root_commit, NULL,
817 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR);
818 res = update_ref(NULL, "HEAD", &root_commit, NULL, 0,
819 UPDATE_REFS_MSG_ON_ERR);
821 return res < 0 ? error(_("writing root commit")) : 0;
824 cmd.git_cmd = 1;
826 if (is_rebase_i(opts)) {
827 if (!(flags & EDIT_MSG)) {
828 cmd.stdout_to_stderr = 1;
829 cmd.err = -1;
832 if (read_env_script(&cmd.env_array)) {
833 const char *gpg_opt = gpg_sign_opt_quoted(opts);
835 return error(_(staged_changes_advice),
836 gpg_opt, gpg_opt);
840 argv_array_push(&cmd.args, "commit");
842 if (!(flags & VERIFY_MSG))
843 argv_array_push(&cmd.args, "-n");
844 if ((flags & AMEND_MSG))
845 argv_array_push(&cmd.args, "--amend");
846 if (opts->gpg_sign)
847 argv_array_pushf(&cmd.args, "-S%s", opts->gpg_sign);
848 if (defmsg)
849 argv_array_pushl(&cmd.args, "-F", defmsg, NULL);
850 else if (!(flags & EDIT_MSG))
851 argv_array_pushl(&cmd.args, "-C", "HEAD", NULL);
852 if ((flags & CLEANUP_MSG))
853 argv_array_push(&cmd.args, "--cleanup=strip");
854 if ((flags & EDIT_MSG))
855 argv_array_push(&cmd.args, "-e");
856 else if (!(flags & CLEANUP_MSG) &&
857 !opts->signoff && !opts->record_origin &&
858 git_config_get_value("commit.cleanup", &value))
859 argv_array_push(&cmd.args, "--cleanup=verbatim");
861 if ((flags & ALLOW_EMPTY))
862 argv_array_push(&cmd.args, "--allow-empty");
864 if (opts->allow_empty_message)
865 argv_array_push(&cmd.args, "--allow-empty-message");
867 if (cmd.err == -1) {
868 /* hide stderr on success */
869 struct strbuf buf = STRBUF_INIT;
870 int rc = pipe_command(&cmd,
871 NULL, 0,
872 /* stdout is already redirected */
873 NULL, 0,
874 &buf, 0);
875 if (rc)
876 fputs(buf.buf, stderr);
877 strbuf_release(&buf);
878 return rc;
881 return run_command(&cmd);
884 static int rest_is_empty(const struct strbuf *sb, int start)
886 int i, eol;
887 const char *nl;
889 /* Check if the rest is just whitespace and Signed-off-by's. */
890 for (i = start; i < sb->len; i++) {
891 nl = memchr(sb->buf + i, '\n', sb->len - i);
892 if (nl)
893 eol = nl - sb->buf;
894 else
895 eol = sb->len;
897 if (strlen(sign_off_header) <= eol - i &&
898 starts_with(sb->buf + i, sign_off_header)) {
899 i = eol;
900 continue;
902 while (i < eol)
903 if (!isspace(sb->buf[i++]))
904 return 0;
907 return 1;
911 * Find out if the message in the strbuf contains only whitespace and
912 * Signed-off-by lines.
914 int message_is_empty(const struct strbuf *sb,
915 enum commit_msg_cleanup_mode cleanup_mode)
917 if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
918 return 0;
919 return rest_is_empty(sb, 0);
923 * See if the user edited the message in the editor or left what
924 * was in the template intact
926 int template_untouched(const struct strbuf *sb, const char *template_file,
927 enum commit_msg_cleanup_mode cleanup_mode)
929 struct strbuf tmpl = STRBUF_INIT;
930 const char *start;
932 if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
933 return 0;
935 if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
936 return 0;
938 strbuf_stripspace(&tmpl, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
939 if (!skip_prefix(sb->buf, tmpl.buf, &start))
940 start = sb->buf;
941 strbuf_release(&tmpl);
942 return rest_is_empty(sb, start - sb->buf);
945 int update_head_with_reflog(const struct commit *old_head,
946 const struct object_id *new_head,
947 const char *action, const struct strbuf *msg,
948 struct strbuf *err)
950 struct ref_transaction *transaction;
951 struct strbuf sb = STRBUF_INIT;
952 const char *nl;
953 int ret = 0;
955 if (action) {
956 strbuf_addstr(&sb, action);
957 strbuf_addstr(&sb, ": ");
960 nl = strchr(msg->buf, '\n');
961 if (nl) {
962 strbuf_add(&sb, msg->buf, nl + 1 - msg->buf);
963 } else {
964 strbuf_addbuf(&sb, msg);
965 strbuf_addch(&sb, '\n');
968 transaction = ref_transaction_begin(err);
969 if (!transaction ||
970 ref_transaction_update(transaction, "HEAD", new_head,
971 old_head ? &old_head->object.oid : &null_oid,
972 0, sb.buf, err) ||
973 ref_transaction_commit(transaction, err)) {
974 ret = -1;
976 ref_transaction_free(transaction);
977 strbuf_release(&sb);
979 return ret;
982 static int run_rewrite_hook(const struct object_id *oldoid,
983 const struct object_id *newoid)
985 struct child_process proc = CHILD_PROCESS_INIT;
986 const char *argv[3];
987 int code;
988 struct strbuf sb = STRBUF_INIT;
990 argv[0] = find_hook("post-rewrite");
991 if (!argv[0])
992 return 0;
994 argv[1] = "amend";
995 argv[2] = NULL;
997 proc.argv = argv;
998 proc.in = -1;
999 proc.stdout_to_stderr = 1;
1001 code = start_command(&proc);
1002 if (code)
1003 return code;
1004 strbuf_addf(&sb, "%s %s\n", oid_to_hex(oldoid), oid_to_hex(newoid));
1005 sigchain_push(SIGPIPE, SIG_IGN);
1006 write_in_full(proc.in, sb.buf, sb.len);
1007 close(proc.in);
1008 strbuf_release(&sb);
1009 sigchain_pop(SIGPIPE);
1010 return finish_command(&proc);
1013 void commit_post_rewrite(const struct commit *old_head,
1014 const struct object_id *new_head)
1016 struct notes_rewrite_cfg *cfg;
1018 cfg = init_copy_notes_for_rewrite("amend");
1019 if (cfg) {
1020 /* we are amending, so old_head is not NULL */
1021 copy_note_for_rewrite(cfg, &old_head->object.oid, new_head);
1022 finish_copy_notes_for_rewrite(cfg, "Notes added by 'git commit --amend'");
1024 run_rewrite_hook(&old_head->object.oid, new_head);
1027 static int run_prepare_commit_msg_hook(struct strbuf *msg, const char *commit)
1029 struct argv_array hook_env = ARGV_ARRAY_INIT;
1030 int ret;
1031 const char *name;
1033 name = git_path_commit_editmsg();
1034 if (write_message(msg->buf, msg->len, name, 0))
1035 return -1;
1037 argv_array_pushf(&hook_env, "GIT_INDEX_FILE=%s", get_index_file());
1038 argv_array_push(&hook_env, "GIT_EDITOR=:");
1039 if (commit)
1040 ret = run_hook_le(hook_env.argv, "prepare-commit-msg", name,
1041 "commit", commit, NULL);
1042 else
1043 ret = run_hook_le(hook_env.argv, "prepare-commit-msg", name,
1044 "message", NULL);
1045 if (ret)
1046 ret = error(_("'prepare-commit-msg' hook failed"));
1047 argv_array_clear(&hook_env);
1049 return ret;
1052 static const char implicit_ident_advice_noconfig[] =
1053 N_("Your name and email address were configured automatically based\n"
1054 "on your username and hostname. Please check that they are accurate.\n"
1055 "You can suppress this message by setting them explicitly. Run the\n"
1056 "following command and follow the instructions in your editor to edit\n"
1057 "your configuration file:\n"
1058 "\n"
1059 " git config --global --edit\n"
1060 "\n"
1061 "After doing this, you may fix the identity used for this commit with:\n"
1062 "\n"
1063 " git commit --amend --reset-author\n");
1065 static const char implicit_ident_advice_config[] =
1066 N_("Your name and email address were configured automatically based\n"
1067 "on your username and hostname. Please check that they are accurate.\n"
1068 "You can suppress this message by setting them explicitly:\n"
1069 "\n"
1070 " git config --global user.name \"Your Name\"\n"
1071 " git config --global user.email you@example.com\n"
1072 "\n"
1073 "After doing this, you may fix the identity used for this commit with:\n"
1074 "\n"
1075 " git commit --amend --reset-author\n");
1077 static const char *implicit_ident_advice(void)
1079 char *user_config = expand_user_path("~/.gitconfig", 0);
1080 char *xdg_config = xdg_config_home("config");
1081 int config_exists = file_exists(user_config) || file_exists(xdg_config);
1083 free(user_config);
1084 free(xdg_config);
1086 if (config_exists)
1087 return _(implicit_ident_advice_config);
1088 else
1089 return _(implicit_ident_advice_noconfig);
1093 void print_commit_summary(const char *prefix, const struct object_id *oid,
1094 unsigned int flags)
1096 struct rev_info rev;
1097 struct commit *commit;
1098 struct strbuf format = STRBUF_INIT;
1099 const char *head;
1100 struct pretty_print_context pctx = {0};
1101 struct strbuf author_ident = STRBUF_INIT;
1102 struct strbuf committer_ident = STRBUF_INIT;
1104 commit = lookup_commit(the_repository, oid);
1105 if (!commit)
1106 die(_("couldn't look up newly created commit"));
1107 if (parse_commit(commit))
1108 die(_("could not parse newly created commit"));
1110 strbuf_addstr(&format, "format:%h] %s");
1112 format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1113 format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1114 if (strbuf_cmp(&author_ident, &committer_ident)) {
1115 strbuf_addstr(&format, "\n Author: ");
1116 strbuf_addbuf_percentquote(&format, &author_ident);
1118 if (flags & SUMMARY_SHOW_AUTHOR_DATE) {
1119 struct strbuf date = STRBUF_INIT;
1121 format_commit_message(commit, "%ad", &date, &pctx);
1122 strbuf_addstr(&format, "\n Date: ");
1123 strbuf_addbuf_percentquote(&format, &date);
1124 strbuf_release(&date);
1126 if (!committer_ident_sufficiently_given()) {
1127 strbuf_addstr(&format, "\n Committer: ");
1128 strbuf_addbuf_percentquote(&format, &committer_ident);
1129 if (advice_implicit_identity) {
1130 strbuf_addch(&format, '\n');
1131 strbuf_addstr(&format, implicit_ident_advice());
1134 strbuf_release(&author_ident);
1135 strbuf_release(&committer_ident);
1137 init_revisions(&rev, prefix);
1138 setup_revisions(0, NULL, &rev, NULL);
1140 rev.diff = 1;
1141 rev.diffopt.output_format =
1142 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1144 rev.verbose_header = 1;
1145 rev.show_root_diff = 1;
1146 get_commit_format(format.buf, &rev);
1147 rev.always_show_header = 0;
1148 rev.diffopt.detect_rename = DIFF_DETECT_RENAME;
1149 rev.diffopt.break_opt = 0;
1150 diff_setup_done(&rev.diffopt);
1152 head = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1153 if (!head)
1154 die_errno(_("unable to resolve HEAD after creating commit"));
1155 if (!strcmp(head, "HEAD"))
1156 head = _("detached HEAD");
1157 else
1158 skip_prefix(head, "refs/heads/", &head);
1159 printf("[%s%s ", head, (flags & SUMMARY_INITIAL_COMMIT) ?
1160 _(" (root-commit)") : "");
1162 if (!log_tree_commit(&rev, commit)) {
1163 rev.always_show_header = 1;
1164 rev.use_terminator = 1;
1165 log_tree_commit(&rev, commit);
1168 strbuf_release(&format);
1171 static int parse_head(struct commit **head)
1173 struct commit *current_head;
1174 struct object_id oid;
1176 if (get_oid("HEAD", &oid)) {
1177 current_head = NULL;
1178 } else {
1179 current_head = lookup_commit_reference(the_repository, &oid);
1180 if (!current_head)
1181 return error(_("could not parse HEAD"));
1182 if (oidcmp(&oid, &current_head->object.oid)) {
1183 warning(_("HEAD %s is not a commit!"),
1184 oid_to_hex(&oid));
1186 if (parse_commit(current_head))
1187 return error(_("could not parse HEAD commit"));
1189 *head = current_head;
1191 return 0;
1195 * Try to commit without forking 'git commit'. In some cases we need
1196 * to run 'git commit' to display an error message
1198 * Returns:
1199 * -1 - error unable to commit
1200 * 0 - success
1201 * 1 - run 'git commit'
1203 static int try_to_commit(struct strbuf *msg, const char *author,
1204 struct replay_opts *opts, unsigned int flags,
1205 struct object_id *oid)
1207 struct object_id tree;
1208 struct commit *current_head;
1209 struct commit_list *parents = NULL;
1210 struct commit_extra_header *extra = NULL;
1211 struct strbuf err = STRBUF_INIT;
1212 struct strbuf commit_msg = STRBUF_INIT;
1213 char *amend_author = NULL;
1214 const char *hook_commit = NULL;
1215 enum commit_msg_cleanup_mode cleanup;
1216 int res = 0;
1218 if (parse_head(&current_head))
1219 return -1;
1221 if (flags & AMEND_MSG) {
1222 const char *exclude_gpgsig[] = { "gpgsig", NULL };
1223 const char *out_enc = get_commit_output_encoding();
1224 const char *message = logmsg_reencode(current_head, NULL,
1225 out_enc);
1227 if (!msg) {
1228 const char *orig_message = NULL;
1230 find_commit_subject(message, &orig_message);
1231 msg = &commit_msg;
1232 strbuf_addstr(msg, orig_message);
1233 hook_commit = "HEAD";
1235 author = amend_author = get_author(message);
1236 unuse_commit_buffer(current_head, message);
1237 if (!author) {
1238 res = error(_("unable to parse commit author"));
1239 goto out;
1241 parents = copy_commit_list(current_head->parents);
1242 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1243 } else if (current_head) {
1244 commit_list_insert(current_head, &parents);
1247 if (write_index_as_tree(&tree, &the_index, get_index_file(), 0, NULL)) {
1248 res = error(_("git write-tree failed to write a tree"));
1249 goto out;
1252 if (!(flags & ALLOW_EMPTY) && !oidcmp(current_head ?
1253 get_commit_tree_oid(current_head) :
1254 the_hash_algo->empty_tree, &tree)) {
1255 res = 1; /* run 'git commit' to display error message */
1256 goto out;
1259 if (find_hook("prepare-commit-msg")) {
1260 res = run_prepare_commit_msg_hook(msg, hook_commit);
1261 if (res)
1262 goto out;
1263 if (strbuf_read_file(&commit_msg, git_path_commit_editmsg(),
1264 2048) < 0) {
1265 res = error_errno(_("unable to read commit message "
1266 "from '%s'"),
1267 git_path_commit_editmsg());
1268 goto out;
1270 msg = &commit_msg;
1273 cleanup = (flags & CLEANUP_MSG) ? COMMIT_MSG_CLEANUP_ALL :
1274 opts->default_msg_cleanup;
1276 if (cleanup != COMMIT_MSG_CLEANUP_NONE)
1277 strbuf_stripspace(msg, cleanup == COMMIT_MSG_CLEANUP_ALL);
1278 if (!opts->allow_empty_message && message_is_empty(msg, cleanup)) {
1279 res = 1; /* run 'git commit' to display error message */
1280 goto out;
1283 reset_ident_date();
1285 if (commit_tree_extended(msg->buf, msg->len, &tree, parents,
1286 oid, author, opts->gpg_sign, extra)) {
1287 res = error(_("failed to write commit object"));
1288 goto out;
1291 if (update_head_with_reflog(current_head, oid,
1292 getenv("GIT_REFLOG_ACTION"), msg, &err)) {
1293 res = error("%s", err.buf);
1294 goto out;
1297 if (flags & AMEND_MSG)
1298 commit_post_rewrite(current_head, oid);
1300 out:
1301 free_commit_extra_headers(extra);
1302 strbuf_release(&err);
1303 strbuf_release(&commit_msg);
1304 free(amend_author);
1306 return res;
1309 static int do_commit(const char *msg_file, const char *author,
1310 struct replay_opts *opts, unsigned int flags)
1312 int res = 1;
1314 if (!(flags & EDIT_MSG) && !(flags & VERIFY_MSG) &&
1315 !(flags & CREATE_ROOT_COMMIT)) {
1316 struct object_id oid;
1317 struct strbuf sb = STRBUF_INIT;
1319 if (msg_file && strbuf_read_file(&sb, msg_file, 2048) < 0)
1320 return error_errno(_("unable to read commit message "
1321 "from '%s'"),
1322 msg_file);
1324 res = try_to_commit(msg_file ? &sb : NULL, author, opts, flags,
1325 &oid);
1326 strbuf_release(&sb);
1327 if (!res) {
1328 unlink(git_path_cherry_pick_head(the_repository));
1329 unlink(git_path_merge_msg(the_repository));
1330 if (!is_rebase_i(opts))
1331 print_commit_summary(NULL, &oid,
1332 SUMMARY_SHOW_AUTHOR_DATE);
1333 return res;
1336 if (res == 1)
1337 return run_git_commit(msg_file, opts, flags);
1339 return res;
1342 static int is_original_commit_empty(struct commit *commit)
1344 const struct object_id *ptree_oid;
1346 if (parse_commit(commit))
1347 return error(_("could not parse commit %s"),
1348 oid_to_hex(&commit->object.oid));
1349 if (commit->parents) {
1350 struct commit *parent = commit->parents->item;
1351 if (parse_commit(parent))
1352 return error(_("could not parse parent commit %s"),
1353 oid_to_hex(&parent->object.oid));
1354 ptree_oid = get_commit_tree_oid(parent);
1355 } else {
1356 ptree_oid = the_hash_algo->empty_tree; /* commit is root */
1359 return !oidcmp(ptree_oid, get_commit_tree_oid(commit));
1363 * Do we run "git commit" with "--allow-empty"?
1365 static int allow_empty(struct replay_opts *opts, struct commit *commit)
1367 int index_unchanged, empty_commit;
1370 * Three cases:
1372 * (1) we do not allow empty at all and error out.
1374 * (2) we allow ones that were initially empty, but
1375 * forbid the ones that become empty;
1377 * (3) we allow both.
1379 if (!opts->allow_empty)
1380 return 0; /* let "git commit" barf as necessary */
1382 index_unchanged = is_index_unchanged();
1383 if (index_unchanged < 0)
1384 return index_unchanged;
1385 if (!index_unchanged)
1386 return 0; /* we do not have to say --allow-empty */
1388 if (opts->keep_redundant_commits)
1389 return 1;
1391 empty_commit = is_original_commit_empty(commit);
1392 if (empty_commit < 0)
1393 return empty_commit;
1394 if (!empty_commit)
1395 return 0;
1396 else
1397 return 1;
1401 * Note that ordering matters in this enum. Not only must it match the mapping
1402 * below, it is also divided into several sections that matter. When adding
1403 * new commands, make sure you add it in the right section.
1405 enum todo_command {
1406 /* commands that handle commits */
1407 TODO_PICK = 0,
1408 TODO_REVERT,
1409 TODO_EDIT,
1410 TODO_REWORD,
1411 TODO_FIXUP,
1412 TODO_SQUASH,
1413 /* commands that do something else than handling a single commit */
1414 TODO_EXEC,
1415 TODO_LABEL,
1416 TODO_RESET,
1417 TODO_MERGE,
1418 /* commands that do nothing but are counted for reporting progress */
1419 TODO_NOOP,
1420 TODO_DROP,
1421 /* comments (not counted for reporting progress) */
1422 TODO_COMMENT
1425 static struct {
1426 char c;
1427 const char *str;
1428 } todo_command_info[] = {
1429 { 'p', "pick" },
1430 { 0, "revert" },
1431 { 'e', "edit" },
1432 { 'r', "reword" },
1433 { 'f', "fixup" },
1434 { 's', "squash" },
1435 { 'x', "exec" },
1436 { 'l', "label" },
1437 { 't', "reset" },
1438 { 'm', "merge" },
1439 { 0, "noop" },
1440 { 'd', "drop" },
1441 { 0, NULL }
1444 static const char *command_to_string(const enum todo_command command)
1446 if (command < TODO_COMMENT)
1447 return todo_command_info[command].str;
1448 die("Unknown command: %d", command);
1451 static char command_to_char(const enum todo_command command)
1453 if (command < TODO_COMMENT && todo_command_info[command].c)
1454 return todo_command_info[command].c;
1455 return comment_line_char;
1458 static int is_noop(const enum todo_command command)
1460 return TODO_NOOP <= command;
1463 static int is_fixup(enum todo_command command)
1465 return command == TODO_FIXUP || command == TODO_SQUASH;
1468 /* Does this command create a (non-merge) commit? */
1469 static int is_pick_or_similar(enum todo_command command)
1471 switch (command) {
1472 case TODO_PICK:
1473 case TODO_REVERT:
1474 case TODO_EDIT:
1475 case TODO_REWORD:
1476 case TODO_FIXUP:
1477 case TODO_SQUASH:
1478 return 1;
1479 default:
1480 return 0;
1484 static int update_squash_messages(enum todo_command command,
1485 struct commit *commit, struct replay_opts *opts)
1487 struct strbuf buf = STRBUF_INIT;
1488 int res;
1489 const char *message, *body;
1491 if (opts->current_fixup_count > 0) {
1492 struct strbuf header = STRBUF_INIT;
1493 char *eol;
1495 if (strbuf_read_file(&buf, rebase_path_squash_msg(), 9) <= 0)
1496 return error(_("could not read '%s'"),
1497 rebase_path_squash_msg());
1499 eol = buf.buf[0] != comment_line_char ?
1500 buf.buf : strchrnul(buf.buf, '\n');
1502 strbuf_addf(&header, "%c ", comment_line_char);
1503 strbuf_addf(&header, _("This is a combination of %d commits."),
1504 opts->current_fixup_count + 2);
1505 strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
1506 strbuf_release(&header);
1507 } else {
1508 struct object_id head;
1509 struct commit *head_commit;
1510 const char *head_message, *body;
1512 if (get_oid("HEAD", &head))
1513 return error(_("need a HEAD to fixup"));
1514 if (!(head_commit = lookup_commit_reference(the_repository, &head)))
1515 return error(_("could not read HEAD"));
1516 if (!(head_message = get_commit_buffer(head_commit, NULL)))
1517 return error(_("could not read HEAD's commit message"));
1519 find_commit_subject(head_message, &body);
1520 if (write_message(body, strlen(body),
1521 rebase_path_fixup_msg(), 0)) {
1522 unuse_commit_buffer(head_commit, head_message);
1523 return error(_("cannot write '%s'"),
1524 rebase_path_fixup_msg());
1527 strbuf_addf(&buf, "%c ", comment_line_char);
1528 strbuf_addf(&buf, _("This is a combination of %d commits."), 2);
1529 strbuf_addf(&buf, "\n%c ", comment_line_char);
1530 strbuf_addstr(&buf, _("This is the 1st commit message:"));
1531 strbuf_addstr(&buf, "\n\n");
1532 strbuf_addstr(&buf, body);
1534 unuse_commit_buffer(head_commit, head_message);
1537 if (!(message = get_commit_buffer(commit, NULL)))
1538 return error(_("could not read commit message of %s"),
1539 oid_to_hex(&commit->object.oid));
1540 find_commit_subject(message, &body);
1542 if (command == TODO_SQUASH) {
1543 unlink(rebase_path_fixup_msg());
1544 strbuf_addf(&buf, "\n%c ", comment_line_char);
1545 strbuf_addf(&buf, _("This is the commit message #%d:"),
1546 ++opts->current_fixup_count);
1547 strbuf_addstr(&buf, "\n\n");
1548 strbuf_addstr(&buf, body);
1549 } else if (command == TODO_FIXUP) {
1550 strbuf_addf(&buf, "\n%c ", comment_line_char);
1551 strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
1552 ++opts->current_fixup_count);
1553 strbuf_addstr(&buf, "\n\n");
1554 strbuf_add_commented_lines(&buf, body, strlen(body));
1555 } else
1556 return error(_("unknown command: %d"), command);
1557 unuse_commit_buffer(commit, message);
1559 res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
1560 strbuf_release(&buf);
1562 if (!res) {
1563 strbuf_addf(&opts->current_fixups, "%s%s %s",
1564 opts->current_fixups.len ? "\n" : "",
1565 command_to_string(command),
1566 oid_to_hex(&commit->object.oid));
1567 res = write_message(opts->current_fixups.buf,
1568 opts->current_fixups.len,
1569 rebase_path_current_fixups(), 0);
1572 return res;
1575 static void flush_rewritten_pending(void) {
1576 struct strbuf buf = STRBUF_INIT;
1577 struct object_id newoid;
1578 FILE *out;
1580 if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), (GIT_MAX_HEXSZ + 1) * 2) > 0 &&
1581 !get_oid("HEAD", &newoid) &&
1582 (out = fopen_or_warn(rebase_path_rewritten_list(), "a"))) {
1583 char *bol = buf.buf, *eol;
1585 while (*bol) {
1586 eol = strchrnul(bol, '\n');
1587 fprintf(out, "%.*s %s\n", (int)(eol - bol),
1588 bol, oid_to_hex(&newoid));
1589 if (!*eol)
1590 break;
1591 bol = eol + 1;
1593 fclose(out);
1594 unlink(rebase_path_rewritten_pending());
1596 strbuf_release(&buf);
1599 static void record_in_rewritten(struct object_id *oid,
1600 enum todo_command next_command) {
1601 FILE *out = fopen_or_warn(rebase_path_rewritten_pending(), "a");
1603 if (!out)
1604 return;
1606 fprintf(out, "%s\n", oid_to_hex(oid));
1607 fclose(out);
1609 if (!is_fixup(next_command))
1610 flush_rewritten_pending();
1613 static int do_pick_commit(enum todo_command command, struct commit *commit,
1614 struct replay_opts *opts, int final_fixup)
1616 unsigned int flags = opts->edit ? EDIT_MSG : 0;
1617 const char *msg_file = opts->edit ? NULL : git_path_merge_msg(the_repository);
1618 struct object_id head;
1619 struct commit *base, *next, *parent;
1620 const char *base_label, *next_label;
1621 char *author = NULL;
1622 struct commit_message msg = { NULL, NULL, NULL, NULL };
1623 struct strbuf msgbuf = STRBUF_INIT;
1624 int res, unborn = 0, allow;
1626 if (opts->no_commit) {
1628 * We do not intend to commit immediately. We just want to
1629 * merge the differences in, so let's compute the tree
1630 * that represents the "current" state for merge-recursive
1631 * to work on.
1633 if (write_index_as_tree(&head, &the_index, get_index_file(), 0, NULL))
1634 return error(_("your index file is unmerged."));
1635 } else {
1636 unborn = get_oid("HEAD", &head);
1637 /* Do we want to generate a root commit? */
1638 if (is_pick_or_similar(command) && opts->have_squash_onto &&
1639 !oidcmp(&head, &opts->squash_onto)) {
1640 if (is_fixup(command))
1641 return error(_("cannot fixup root commit"));
1642 flags |= CREATE_ROOT_COMMIT;
1643 unborn = 1;
1644 } else if (unborn)
1645 oidcpy(&head, the_hash_algo->empty_tree);
1646 if (index_differs_from(unborn ? empty_tree_oid_hex() : "HEAD",
1647 NULL, 0))
1648 return error_dirty_index(opts);
1650 discard_cache();
1652 if (!commit->parents)
1653 parent = NULL;
1654 else if (commit->parents->next) {
1655 /* Reverting or cherry-picking a merge commit */
1656 int cnt;
1657 struct commit_list *p;
1659 if (!opts->mainline)
1660 return error(_("commit %s is a merge but no -m option was given."),
1661 oid_to_hex(&commit->object.oid));
1663 for (cnt = 1, p = commit->parents;
1664 cnt != opts->mainline && p;
1665 cnt++)
1666 p = p->next;
1667 if (cnt != opts->mainline || !p)
1668 return error(_("commit %s does not have parent %d"),
1669 oid_to_hex(&commit->object.oid), opts->mainline);
1670 parent = p->item;
1671 } else if (0 < opts->mainline)
1672 return error(_("mainline was specified but commit %s is not a merge."),
1673 oid_to_hex(&commit->object.oid));
1674 else
1675 parent = commit->parents->item;
1677 if (get_message(commit, &msg) != 0)
1678 return error(_("cannot get commit message for %s"),
1679 oid_to_hex(&commit->object.oid));
1681 if (opts->allow_ff && !is_fixup(command) &&
1682 ((parent && !oidcmp(&parent->object.oid, &head)) ||
1683 (!parent && unborn))) {
1684 if (is_rebase_i(opts))
1685 write_author_script(msg.message);
1686 res = fast_forward_to(&commit->object.oid, &head, unborn,
1687 opts);
1688 if (res || command != TODO_REWORD)
1689 goto leave;
1690 flags |= EDIT_MSG | AMEND_MSG | VERIFY_MSG;
1691 msg_file = NULL;
1692 goto fast_forward_edit;
1694 if (parent && parse_commit(parent) < 0)
1695 /* TRANSLATORS: The first %s will be a "todo" command like
1696 "revert" or "pick", the second %s a SHA1. */
1697 return error(_("%s: cannot parse parent commit %s"),
1698 command_to_string(command),
1699 oid_to_hex(&parent->object.oid));
1702 * "commit" is an existing commit. We would want to apply
1703 * the difference it introduces since its first parent "prev"
1704 * on top of the current HEAD if we are cherry-pick. Or the
1705 * reverse of it if we are revert.
1708 if (command == TODO_REVERT) {
1709 base = commit;
1710 base_label = msg.label;
1711 next = parent;
1712 next_label = msg.parent_label;
1713 strbuf_addstr(&msgbuf, "Revert \"");
1714 strbuf_addstr(&msgbuf, msg.subject);
1715 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
1716 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1718 if (commit->parents && commit->parents->next) {
1719 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
1720 strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
1722 strbuf_addstr(&msgbuf, ".\n");
1723 } else {
1724 const char *p;
1726 base = parent;
1727 base_label = msg.parent_label;
1728 next = commit;
1729 next_label = msg.label;
1731 /* Append the commit log message to msgbuf. */
1732 if (find_commit_subject(msg.message, &p))
1733 strbuf_addstr(&msgbuf, p);
1735 if (opts->record_origin) {
1736 strbuf_complete_line(&msgbuf);
1737 if (!has_conforming_footer(&msgbuf, NULL, 0))
1738 strbuf_addch(&msgbuf, '\n');
1739 strbuf_addstr(&msgbuf, cherry_picked_prefix);
1740 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1741 strbuf_addstr(&msgbuf, ")\n");
1743 if (!is_fixup(command))
1744 author = get_author(msg.message);
1747 if (command == TODO_REWORD)
1748 flags |= EDIT_MSG | VERIFY_MSG;
1749 else if (is_fixup(command)) {
1750 if (update_squash_messages(command, commit, opts))
1751 return -1;
1752 flags |= AMEND_MSG;
1753 if (!final_fixup)
1754 msg_file = rebase_path_squash_msg();
1755 else if (file_exists(rebase_path_fixup_msg())) {
1756 flags |= CLEANUP_MSG;
1757 msg_file = rebase_path_fixup_msg();
1758 } else {
1759 const char *dest = git_path_squash_msg(the_repository);
1760 unlink(dest);
1761 if (copy_file(dest, rebase_path_squash_msg(), 0666))
1762 return error(_("could not rename '%s' to '%s'"),
1763 rebase_path_squash_msg(), dest);
1764 unlink(git_path_merge_msg(the_repository));
1765 msg_file = dest;
1766 flags |= EDIT_MSG;
1770 if (opts->signoff && !is_fixup(command))
1771 append_signoff(&msgbuf, 0, 0);
1773 if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
1774 res = -1;
1775 else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
1776 res = do_recursive_merge(base, next, base_label, next_label,
1777 &head, &msgbuf, opts);
1778 if (res < 0)
1779 goto leave;
1781 res |= write_message(msgbuf.buf, msgbuf.len,
1782 git_path_merge_msg(the_repository), 0);
1783 } else {
1784 struct commit_list *common = NULL;
1785 struct commit_list *remotes = NULL;
1787 res = write_message(msgbuf.buf, msgbuf.len,
1788 git_path_merge_msg(the_repository), 0);
1790 commit_list_insert(base, &common);
1791 commit_list_insert(next, &remotes);
1792 res |= try_merge_command(opts->strategy,
1793 opts->xopts_nr, (const char **)opts->xopts,
1794 common, oid_to_hex(&head), remotes);
1795 free_commit_list(common);
1796 free_commit_list(remotes);
1798 strbuf_release(&msgbuf);
1801 * If the merge was clean or if it failed due to conflict, we write
1802 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
1803 * However, if the merge did not even start, then we don't want to
1804 * write it at all.
1806 if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
1807 update_ref(NULL, "CHERRY_PICK_HEAD", &commit->object.oid, NULL,
1808 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1809 res = -1;
1810 if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
1811 update_ref(NULL, "REVERT_HEAD", &commit->object.oid, NULL,
1812 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1813 res = -1;
1815 if (res) {
1816 error(command == TODO_REVERT
1817 ? _("could not revert %s... %s")
1818 : _("could not apply %s... %s"),
1819 short_commit_name(commit), msg.subject);
1820 print_advice(res == 1, opts);
1821 rerere(opts->allow_rerere_auto);
1822 goto leave;
1825 allow = allow_empty(opts, commit);
1826 if (allow < 0) {
1827 res = allow;
1828 goto leave;
1829 } else if (allow)
1830 flags |= ALLOW_EMPTY;
1831 if (!opts->no_commit) {
1832 fast_forward_edit:
1833 if (author || command == TODO_REVERT || (flags & AMEND_MSG))
1834 res = do_commit(msg_file, author, opts, flags);
1835 else
1836 res = error(_("unable to parse commit author"));
1839 if (!res && final_fixup) {
1840 unlink(rebase_path_fixup_msg());
1841 unlink(rebase_path_squash_msg());
1842 unlink(rebase_path_current_fixups());
1843 strbuf_reset(&opts->current_fixups);
1844 opts->current_fixup_count = 0;
1847 leave:
1848 free_message(commit, &msg);
1849 free(author);
1850 update_abort_safety_file();
1852 return res;
1855 static int prepare_revs(struct replay_opts *opts)
1858 * picking (but not reverting) ranges (but not individual revisions)
1859 * should be done in reverse
1861 if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
1862 opts->revs->reverse ^= 1;
1864 if (prepare_revision_walk(opts->revs))
1865 return error(_("revision walk setup failed"));
1867 return 0;
1870 static int read_and_refresh_cache(struct replay_opts *opts)
1872 struct lock_file index_lock = LOCK_INIT;
1873 int index_fd = hold_locked_index(&index_lock, 0);
1874 if (read_index_preload(&the_index, NULL) < 0) {
1875 rollback_lock_file(&index_lock);
1876 return error(_("git %s: failed to read the index"),
1877 _(action_name(opts)));
1879 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
1880 if (index_fd >= 0) {
1881 if (write_locked_index(&the_index, &index_lock,
1882 COMMIT_LOCK | SKIP_IF_UNCHANGED)) {
1883 return error(_("git %s: failed to refresh the index"),
1884 _(action_name(opts)));
1887 return 0;
1890 enum todo_item_flags {
1891 TODO_EDIT_MERGE_MSG = 1
1894 struct todo_item {
1895 enum todo_command command;
1896 struct commit *commit;
1897 unsigned int flags;
1898 const char *arg;
1899 int arg_len;
1900 size_t offset_in_buf;
1903 struct todo_list {
1904 struct strbuf buf;
1905 struct todo_item *items;
1906 int nr, alloc, current;
1907 int done_nr, total_nr;
1908 struct stat_data stat;
1911 #define TODO_LIST_INIT { STRBUF_INIT }
1913 static void todo_list_release(struct todo_list *todo_list)
1915 strbuf_release(&todo_list->buf);
1916 FREE_AND_NULL(todo_list->items);
1917 todo_list->nr = todo_list->alloc = 0;
1920 static struct todo_item *append_new_todo(struct todo_list *todo_list)
1922 ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
1923 return todo_list->items + todo_list->nr++;
1926 static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
1928 struct object_id commit_oid;
1929 char *end_of_object_name;
1930 int i, saved, status, padding;
1932 item->flags = 0;
1934 /* left-trim */
1935 bol += strspn(bol, " \t");
1937 if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
1938 item->command = TODO_COMMENT;
1939 item->commit = NULL;
1940 item->arg = bol;
1941 item->arg_len = eol - bol;
1942 return 0;
1945 for (i = 0; i < TODO_COMMENT; i++)
1946 if (skip_prefix(bol, todo_command_info[i].str, &bol)) {
1947 item->command = i;
1948 break;
1949 } else if (bol[1] == ' ' && *bol == todo_command_info[i].c) {
1950 bol++;
1951 item->command = i;
1952 break;
1954 if (i >= TODO_COMMENT)
1955 return -1;
1957 /* Eat up extra spaces/ tabs before object name */
1958 padding = strspn(bol, " \t");
1959 bol += padding;
1961 if (item->command == TODO_NOOP) {
1962 if (bol != eol)
1963 return error(_("%s does not accept arguments: '%s'"),
1964 command_to_string(item->command), bol);
1965 item->commit = NULL;
1966 item->arg = bol;
1967 item->arg_len = eol - bol;
1968 return 0;
1971 if (!padding)
1972 return error(_("missing arguments for %s"),
1973 command_to_string(item->command));
1975 if (item->command == TODO_EXEC || item->command == TODO_LABEL ||
1976 item->command == TODO_RESET) {
1977 item->commit = NULL;
1978 item->arg = bol;
1979 item->arg_len = (int)(eol - bol);
1980 return 0;
1983 if (item->command == TODO_MERGE) {
1984 if (skip_prefix(bol, "-C", &bol))
1985 bol += strspn(bol, " \t");
1986 else if (skip_prefix(bol, "-c", &bol)) {
1987 bol += strspn(bol, " \t");
1988 item->flags |= TODO_EDIT_MERGE_MSG;
1989 } else {
1990 item->flags |= TODO_EDIT_MERGE_MSG;
1991 item->commit = NULL;
1992 item->arg = bol;
1993 item->arg_len = (int)(eol - bol);
1994 return 0;
1998 end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
1999 saved = *end_of_object_name;
2000 *end_of_object_name = '\0';
2001 status = get_oid(bol, &commit_oid);
2002 *end_of_object_name = saved;
2004 item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
2005 item->arg_len = (int)(eol - item->arg);
2007 if (status < 0)
2008 return -1;
2010 item->commit = lookup_commit_reference(the_repository, &commit_oid);
2011 return !item->commit;
2014 static int parse_insn_buffer(char *buf, struct todo_list *todo_list)
2016 struct todo_item *item;
2017 char *p = buf, *next_p;
2018 int i, res = 0, fixup_okay = file_exists(rebase_path_done());
2020 for (i = 1; *p; i++, p = next_p) {
2021 char *eol = strchrnul(p, '\n');
2023 next_p = *eol ? eol + 1 /* skip LF */ : eol;
2025 if (p != eol && eol[-1] == '\r')
2026 eol--; /* strip Carriage Return */
2028 item = append_new_todo(todo_list);
2029 item->offset_in_buf = p - todo_list->buf.buf;
2030 if (parse_insn_line(item, p, eol)) {
2031 res = error(_("invalid line %d: %.*s"),
2032 i, (int)(eol - p), p);
2033 item->command = TODO_NOOP;
2036 if (fixup_okay)
2037 ; /* do nothing */
2038 else if (is_fixup(item->command))
2039 return error(_("cannot '%s' without a previous commit"),
2040 command_to_string(item->command));
2041 else if (!is_noop(item->command))
2042 fixup_okay = 1;
2045 return res;
2048 static int count_commands(struct todo_list *todo_list)
2050 int count = 0, i;
2052 for (i = 0; i < todo_list->nr; i++)
2053 if (todo_list->items[i].command != TODO_COMMENT)
2054 count++;
2056 return count;
2059 static int get_item_line_offset(struct todo_list *todo_list, int index)
2061 return index < todo_list->nr ?
2062 todo_list->items[index].offset_in_buf : todo_list->buf.len;
2065 static const char *get_item_line(struct todo_list *todo_list, int index)
2067 return todo_list->buf.buf + get_item_line_offset(todo_list, index);
2070 static int get_item_line_length(struct todo_list *todo_list, int index)
2072 return get_item_line_offset(todo_list, index + 1)
2073 - get_item_line_offset(todo_list, index);
2076 static ssize_t strbuf_read_file_or_whine(struct strbuf *sb, const char *path)
2078 int fd;
2079 ssize_t len;
2081 fd = open(path, O_RDONLY);
2082 if (fd < 0)
2083 return error_errno(_("could not open '%s'"), path);
2084 len = strbuf_read(sb, fd, 0);
2085 close(fd);
2086 if (len < 0)
2087 return error(_("could not read '%s'."), path);
2088 return len;
2091 static int read_populate_todo(struct todo_list *todo_list,
2092 struct replay_opts *opts)
2094 struct stat st;
2095 const char *todo_file = get_todo_path(opts);
2096 int res;
2098 strbuf_reset(&todo_list->buf);
2099 if (strbuf_read_file_or_whine(&todo_list->buf, todo_file) < 0)
2100 return -1;
2102 res = stat(todo_file, &st);
2103 if (res)
2104 return error(_("could not stat '%s'"), todo_file);
2105 fill_stat_data(&todo_list->stat, &st);
2107 res = parse_insn_buffer(todo_list->buf.buf, todo_list);
2108 if (res) {
2109 if (is_rebase_i(opts))
2110 return error(_("please fix this using "
2111 "'git rebase --edit-todo'."));
2112 return error(_("unusable instruction sheet: '%s'"), todo_file);
2115 if (!todo_list->nr &&
2116 (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
2117 return error(_("no commits parsed."));
2119 if (!is_rebase_i(opts)) {
2120 enum todo_command valid =
2121 opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
2122 int i;
2124 for (i = 0; i < todo_list->nr; i++)
2125 if (valid == todo_list->items[i].command)
2126 continue;
2127 else if (valid == TODO_PICK)
2128 return error(_("cannot cherry-pick during a revert."));
2129 else
2130 return error(_("cannot revert during a cherry-pick."));
2133 if (is_rebase_i(opts)) {
2134 struct todo_list done = TODO_LIST_INIT;
2135 FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
2137 if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
2138 !parse_insn_buffer(done.buf.buf, &done))
2139 todo_list->done_nr = count_commands(&done);
2140 else
2141 todo_list->done_nr = 0;
2143 todo_list->total_nr = todo_list->done_nr
2144 + count_commands(todo_list);
2145 todo_list_release(&done);
2147 if (f) {
2148 fprintf(f, "%d\n", todo_list->total_nr);
2149 fclose(f);
2153 return 0;
2156 static int git_config_string_dup(char **dest,
2157 const char *var, const char *value)
2159 if (!value)
2160 return config_error_nonbool(var);
2161 free(*dest);
2162 *dest = xstrdup(value);
2163 return 0;
2166 static int populate_opts_cb(const char *key, const char *value, void *data)
2168 struct replay_opts *opts = data;
2169 int error_flag = 1;
2171 if (!value)
2172 error_flag = 0;
2173 else if (!strcmp(key, "options.no-commit"))
2174 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
2175 else if (!strcmp(key, "options.edit"))
2176 opts->edit = git_config_bool_or_int(key, value, &error_flag);
2177 else if (!strcmp(key, "options.signoff"))
2178 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
2179 else if (!strcmp(key, "options.record-origin"))
2180 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
2181 else if (!strcmp(key, "options.allow-ff"))
2182 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
2183 else if (!strcmp(key, "options.mainline"))
2184 opts->mainline = git_config_int(key, value);
2185 else if (!strcmp(key, "options.strategy"))
2186 git_config_string_dup(&opts->strategy, key, value);
2187 else if (!strcmp(key, "options.gpg-sign"))
2188 git_config_string_dup(&opts->gpg_sign, key, value);
2189 else if (!strcmp(key, "options.strategy-option")) {
2190 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
2191 opts->xopts[opts->xopts_nr++] = xstrdup(value);
2192 } else if (!strcmp(key, "options.allow-rerere-auto"))
2193 opts->allow_rerere_auto =
2194 git_config_bool_or_int(key, value, &error_flag) ?
2195 RERERE_AUTOUPDATE : RERERE_NOAUTOUPDATE;
2196 else
2197 return error(_("invalid key: %s"), key);
2199 if (!error_flag)
2200 return error(_("invalid value for %s: %s"), key, value);
2202 return 0;
2205 static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
2207 int i;
2208 char *strategy_opts_string;
2210 strbuf_reset(buf);
2211 if (!read_oneliner(buf, rebase_path_strategy(), 0))
2212 return;
2213 opts->strategy = strbuf_detach(buf, NULL);
2214 if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
2215 return;
2217 strategy_opts_string = buf->buf;
2218 if (*strategy_opts_string == ' ')
2219 strategy_opts_string++;
2220 opts->xopts_nr = split_cmdline(strategy_opts_string,
2221 (const char ***)&opts->xopts);
2222 for (i = 0; i < opts->xopts_nr; i++) {
2223 const char *arg = opts->xopts[i];
2225 skip_prefix(arg, "--", &arg);
2226 opts->xopts[i] = xstrdup(arg);
2230 static int read_populate_opts(struct replay_opts *opts)
2232 if (is_rebase_i(opts)) {
2233 struct strbuf buf = STRBUF_INIT;
2235 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
2236 if (!starts_with(buf.buf, "-S"))
2237 strbuf_reset(&buf);
2238 else {
2239 free(opts->gpg_sign);
2240 opts->gpg_sign = xstrdup(buf.buf + 2);
2242 strbuf_reset(&buf);
2245 if (read_oneliner(&buf, rebase_path_allow_rerere_autoupdate(), 1)) {
2246 if (!strcmp(buf.buf, "--rerere-autoupdate"))
2247 opts->allow_rerere_auto = RERERE_AUTOUPDATE;
2248 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
2249 opts->allow_rerere_auto = RERERE_NOAUTOUPDATE;
2250 strbuf_reset(&buf);
2253 if (file_exists(rebase_path_verbose()))
2254 opts->verbose = 1;
2256 if (file_exists(rebase_path_signoff())) {
2257 opts->allow_ff = 0;
2258 opts->signoff = 1;
2261 read_strategy_opts(opts, &buf);
2262 strbuf_release(&buf);
2264 if (read_oneliner(&opts->current_fixups,
2265 rebase_path_current_fixups(), 1)) {
2266 const char *p = opts->current_fixups.buf;
2267 opts->current_fixup_count = 1;
2268 while ((p = strchr(p, '\n'))) {
2269 opts->current_fixup_count++;
2270 p++;
2274 if (read_oneliner(&buf, rebase_path_squash_onto(), 0)) {
2275 if (get_oid_hex(buf.buf, &opts->squash_onto) < 0)
2276 return error(_("unusable squash-onto"));
2277 opts->have_squash_onto = 1;
2280 return 0;
2283 if (!file_exists(git_path_opts_file()))
2284 return 0;
2286 * The function git_parse_source(), called from git_config_from_file(),
2287 * may die() in case of a syntactically incorrect file. We do not care
2288 * about this case, though, because we wrote that file ourselves, so we
2289 * are pretty certain that it is syntactically correct.
2291 if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
2292 return error(_("malformed options sheet: '%s'"),
2293 git_path_opts_file());
2294 return 0;
2297 static int walk_revs_populate_todo(struct todo_list *todo_list,
2298 struct replay_opts *opts)
2300 enum todo_command command = opts->action == REPLAY_PICK ?
2301 TODO_PICK : TODO_REVERT;
2302 const char *command_string = todo_command_info[command].str;
2303 struct commit *commit;
2305 if (prepare_revs(opts))
2306 return -1;
2308 while ((commit = get_revision(opts->revs))) {
2309 struct todo_item *item = append_new_todo(todo_list);
2310 const char *commit_buffer = get_commit_buffer(commit, NULL);
2311 const char *subject;
2312 int subject_len;
2314 item->command = command;
2315 item->commit = commit;
2316 item->arg = NULL;
2317 item->arg_len = 0;
2318 item->offset_in_buf = todo_list->buf.len;
2319 subject_len = find_commit_subject(commit_buffer, &subject);
2320 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
2321 short_commit_name(commit), subject_len, subject);
2322 unuse_commit_buffer(commit, commit_buffer);
2325 if (!todo_list->nr)
2326 return error(_("empty commit set passed"));
2328 return 0;
2331 static int create_seq_dir(void)
2333 if (file_exists(git_path_seq_dir())) {
2334 error(_("a cherry-pick or revert is already in progress"));
2335 advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
2336 return -1;
2337 } else if (mkdir(git_path_seq_dir(), 0777) < 0)
2338 return error_errno(_("could not create sequencer directory '%s'"),
2339 git_path_seq_dir());
2340 return 0;
2343 static int save_head(const char *head)
2345 struct lock_file head_lock = LOCK_INIT;
2346 struct strbuf buf = STRBUF_INIT;
2347 int fd;
2348 ssize_t written;
2350 fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
2351 if (fd < 0)
2352 return error_errno(_("could not lock HEAD"));
2353 strbuf_addf(&buf, "%s\n", head);
2354 written = write_in_full(fd, buf.buf, buf.len);
2355 strbuf_release(&buf);
2356 if (written < 0) {
2357 error_errno(_("could not write to '%s'"), git_path_head_file());
2358 rollback_lock_file(&head_lock);
2359 return -1;
2361 if (commit_lock_file(&head_lock) < 0)
2362 return error(_("failed to finalize '%s'"), git_path_head_file());
2363 return 0;
2366 static int rollback_is_safe(void)
2368 struct strbuf sb = STRBUF_INIT;
2369 struct object_id expected_head, actual_head;
2371 if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
2372 strbuf_trim(&sb);
2373 if (get_oid_hex(sb.buf, &expected_head)) {
2374 strbuf_release(&sb);
2375 die(_("could not parse %s"), git_path_abort_safety_file());
2377 strbuf_release(&sb);
2379 else if (errno == ENOENT)
2380 oidclr(&expected_head);
2381 else
2382 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
2384 if (get_oid("HEAD", &actual_head))
2385 oidclr(&actual_head);
2387 return !oidcmp(&actual_head, &expected_head);
2390 static int reset_for_rollback(const struct object_id *oid)
2392 const char *argv[4]; /* reset --merge <arg> + NULL */
2394 argv[0] = "reset";
2395 argv[1] = "--merge";
2396 argv[2] = oid_to_hex(oid);
2397 argv[3] = NULL;
2398 return run_command_v_opt(argv, RUN_GIT_CMD);
2401 static int rollback_single_pick(void)
2403 struct object_id head_oid;
2405 if (!file_exists(git_path_cherry_pick_head(the_repository)) &&
2406 !file_exists(git_path_revert_head(the_repository)))
2407 return error(_("no cherry-pick or revert in progress"));
2408 if (read_ref_full("HEAD", 0, &head_oid, NULL))
2409 return error(_("cannot resolve HEAD"));
2410 if (is_null_oid(&head_oid))
2411 return error(_("cannot abort from a branch yet to be born"));
2412 return reset_for_rollback(&head_oid);
2415 int sequencer_rollback(struct replay_opts *opts)
2417 FILE *f;
2418 struct object_id oid;
2419 struct strbuf buf = STRBUF_INIT;
2420 const char *p;
2422 f = fopen(git_path_head_file(), "r");
2423 if (!f && errno == ENOENT) {
2425 * There is no multiple-cherry-pick in progress.
2426 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
2427 * a single-cherry-pick in progress, abort that.
2429 return rollback_single_pick();
2431 if (!f)
2432 return error_errno(_("cannot open '%s'"), git_path_head_file());
2433 if (strbuf_getline_lf(&buf, f)) {
2434 error(_("cannot read '%s': %s"), git_path_head_file(),
2435 ferror(f) ? strerror(errno) : _("unexpected end of file"));
2436 fclose(f);
2437 goto fail;
2439 fclose(f);
2440 if (parse_oid_hex(buf.buf, &oid, &p) || *p != '\0') {
2441 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
2442 git_path_head_file());
2443 goto fail;
2445 if (is_null_oid(&oid)) {
2446 error(_("cannot abort from a branch yet to be born"));
2447 goto fail;
2450 if (!rollback_is_safe()) {
2451 /* Do not error, just do not rollback */
2452 warning(_("You seem to have moved HEAD. "
2453 "Not rewinding, check your HEAD!"));
2454 } else
2455 if (reset_for_rollback(&oid))
2456 goto fail;
2457 strbuf_release(&buf);
2458 return sequencer_remove_state(opts);
2459 fail:
2460 strbuf_release(&buf);
2461 return -1;
2464 static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
2466 struct lock_file todo_lock = LOCK_INIT;
2467 const char *todo_path = get_todo_path(opts);
2468 int next = todo_list->current, offset, fd;
2471 * rebase -i writes "git-rebase-todo" without the currently executing
2472 * command, appending it to "done" instead.
2474 if (is_rebase_i(opts))
2475 next++;
2477 fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
2478 if (fd < 0)
2479 return error_errno(_("could not lock '%s'"), todo_path);
2480 offset = get_item_line_offset(todo_list, next);
2481 if (write_in_full(fd, todo_list->buf.buf + offset,
2482 todo_list->buf.len - offset) < 0)
2483 return error_errno(_("could not write to '%s'"), todo_path);
2484 if (commit_lock_file(&todo_lock) < 0)
2485 return error(_("failed to finalize '%s'"), todo_path);
2487 if (is_rebase_i(opts) && next > 0) {
2488 const char *done = rebase_path_done();
2489 int fd = open(done, O_CREAT | O_WRONLY | O_APPEND, 0666);
2490 int ret = 0;
2492 if (fd < 0)
2493 return 0;
2494 if (write_in_full(fd, get_item_line(todo_list, next - 1),
2495 get_item_line_length(todo_list, next - 1))
2496 < 0)
2497 ret = error_errno(_("could not write to '%s'"), done);
2498 if (close(fd) < 0)
2499 ret = error_errno(_("failed to finalize '%s'"), done);
2500 return ret;
2502 return 0;
2505 static int save_opts(struct replay_opts *opts)
2507 const char *opts_file = git_path_opts_file();
2508 int res = 0;
2510 if (opts->no_commit)
2511 res |= git_config_set_in_file_gently(opts_file, "options.no-commit", "true");
2512 if (opts->edit)
2513 res |= git_config_set_in_file_gently(opts_file, "options.edit", "true");
2514 if (opts->signoff)
2515 res |= git_config_set_in_file_gently(opts_file, "options.signoff", "true");
2516 if (opts->record_origin)
2517 res |= git_config_set_in_file_gently(opts_file, "options.record-origin", "true");
2518 if (opts->allow_ff)
2519 res |= git_config_set_in_file_gently(opts_file, "options.allow-ff", "true");
2520 if (opts->mainline) {
2521 struct strbuf buf = STRBUF_INIT;
2522 strbuf_addf(&buf, "%d", opts->mainline);
2523 res |= git_config_set_in_file_gently(opts_file, "options.mainline", buf.buf);
2524 strbuf_release(&buf);
2526 if (opts->strategy)
2527 res |= git_config_set_in_file_gently(opts_file, "options.strategy", opts->strategy);
2528 if (opts->gpg_sign)
2529 res |= git_config_set_in_file_gently(opts_file, "options.gpg-sign", opts->gpg_sign);
2530 if (opts->xopts) {
2531 int i;
2532 for (i = 0; i < opts->xopts_nr; i++)
2533 res |= git_config_set_multivar_in_file_gently(opts_file,
2534 "options.strategy-option",
2535 opts->xopts[i], "^$", 0);
2537 if (opts->allow_rerere_auto)
2538 res |= git_config_set_in_file_gently(opts_file, "options.allow-rerere-auto",
2539 opts->allow_rerere_auto == RERERE_AUTOUPDATE ?
2540 "true" : "false");
2541 return res;
2544 static int make_patch(struct commit *commit, struct replay_opts *opts)
2546 struct strbuf buf = STRBUF_INIT;
2547 struct rev_info log_tree_opt;
2548 const char *subject, *p;
2549 int res = 0;
2551 p = short_commit_name(commit);
2552 if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
2553 return -1;
2554 if (update_ref("rebase", "REBASE_HEAD", &commit->object.oid,
2555 NULL, REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
2556 res |= error(_("could not update %s"), "REBASE_HEAD");
2558 strbuf_addf(&buf, "%s/patch", get_dir(opts));
2559 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
2560 init_revisions(&log_tree_opt, NULL);
2561 log_tree_opt.abbrev = 0;
2562 log_tree_opt.diff = 1;
2563 log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
2564 log_tree_opt.disable_stdin = 1;
2565 log_tree_opt.no_commit_id = 1;
2566 log_tree_opt.diffopt.file = fopen(buf.buf, "w");
2567 log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
2568 if (!log_tree_opt.diffopt.file)
2569 res |= error_errno(_("could not open '%s'"), buf.buf);
2570 else {
2571 res |= log_tree_commit(&log_tree_opt, commit);
2572 fclose(log_tree_opt.diffopt.file);
2574 strbuf_reset(&buf);
2576 strbuf_addf(&buf, "%s/message", get_dir(opts));
2577 if (!file_exists(buf.buf)) {
2578 const char *commit_buffer = get_commit_buffer(commit, NULL);
2579 find_commit_subject(commit_buffer, &subject);
2580 res |= write_message(subject, strlen(subject), buf.buf, 1);
2581 unuse_commit_buffer(commit, commit_buffer);
2583 strbuf_release(&buf);
2585 return res;
2588 static int intend_to_amend(void)
2590 struct object_id head;
2591 char *p;
2593 if (get_oid("HEAD", &head))
2594 return error(_("cannot read HEAD"));
2596 p = oid_to_hex(&head);
2597 return write_message(p, strlen(p), rebase_path_amend(), 1);
2600 static int error_with_patch(struct commit *commit,
2601 const char *subject, int subject_len,
2602 struct replay_opts *opts, int exit_code, int to_amend)
2604 if (make_patch(commit, opts))
2605 return -1;
2607 if (to_amend) {
2608 if (intend_to_amend())
2609 return -1;
2611 fprintf(stderr, "You can amend the commit now, with\n"
2612 "\n"
2613 " git commit --amend %s\n"
2614 "\n"
2615 "Once you are satisfied with your changes, run\n"
2616 "\n"
2617 " git rebase --continue\n", gpg_sign_opt_quoted(opts));
2618 } else if (exit_code)
2619 fprintf(stderr, "Could not apply %s... %.*s\n",
2620 short_commit_name(commit), subject_len, subject);
2622 return exit_code;
2625 static int error_failed_squash(struct commit *commit,
2626 struct replay_opts *opts, int subject_len, const char *subject)
2628 if (copy_file(rebase_path_message(), rebase_path_squash_msg(), 0666))
2629 return error(_("could not copy '%s' to '%s'"),
2630 rebase_path_squash_msg(), rebase_path_message());
2631 unlink(git_path_merge_msg(the_repository));
2632 if (copy_file(git_path_merge_msg(the_repository), rebase_path_message(), 0666))
2633 return error(_("could not copy '%s' to '%s'"),
2634 rebase_path_message(),
2635 git_path_merge_msg(the_repository));
2636 return error_with_patch(commit, subject, subject_len, opts, 1, 0);
2639 static int do_exec(const char *command_line)
2641 struct argv_array child_env = ARGV_ARRAY_INIT;
2642 const char *child_argv[] = { NULL, NULL };
2643 int dirty, status;
2645 fprintf(stderr, "Executing: %s\n", command_line);
2646 child_argv[0] = command_line;
2647 argv_array_pushf(&child_env, "GIT_DIR=%s", absolute_path(get_git_dir()));
2648 argv_array_pushf(&child_env, "GIT_WORK_TREE=%s",
2649 absolute_path(get_git_work_tree()));
2650 status = run_command_v_opt_cd_env(child_argv, RUN_USING_SHELL, NULL,
2651 child_env.argv);
2653 /* force re-reading of the cache */
2654 if (discard_cache() < 0 || read_cache() < 0)
2655 return error(_("could not read index"));
2657 dirty = require_clean_work_tree("rebase", NULL, 1, 1);
2659 if (status) {
2660 warning(_("execution failed: %s\n%s"
2661 "You can fix the problem, and then run\n"
2662 "\n"
2663 " git rebase --continue\n"
2664 "\n"),
2665 command_line,
2666 dirty ? N_("and made changes to the index and/or the "
2667 "working tree\n") : "");
2668 if (status == 127)
2669 /* command not found */
2670 status = 1;
2671 } else if (dirty) {
2672 warning(_("execution succeeded: %s\nbut "
2673 "left changes to the index and/or the working tree\n"
2674 "Commit or stash your changes, and then run\n"
2675 "\n"
2676 " git rebase --continue\n"
2677 "\n"), command_line);
2678 status = 1;
2681 argv_array_clear(&child_env);
2683 return status;
2686 static int safe_append(const char *filename, const char *fmt, ...)
2688 va_list ap;
2689 struct lock_file lock = LOCK_INIT;
2690 int fd = hold_lock_file_for_update(&lock, filename,
2691 LOCK_REPORT_ON_ERROR);
2692 struct strbuf buf = STRBUF_INIT;
2694 if (fd < 0)
2695 return -1;
2697 if (strbuf_read_file(&buf, filename, 0) < 0 && errno != ENOENT) {
2698 error_errno(_("could not read '%s'"), filename);
2699 rollback_lock_file(&lock);
2700 return -1;
2702 strbuf_complete(&buf, '\n');
2703 va_start(ap, fmt);
2704 strbuf_vaddf(&buf, fmt, ap);
2705 va_end(ap);
2707 if (write_in_full(fd, buf.buf, buf.len) < 0) {
2708 error_errno(_("could not write to '%s'"), filename);
2709 strbuf_release(&buf);
2710 rollback_lock_file(&lock);
2711 return -1;
2713 if (commit_lock_file(&lock) < 0) {
2714 strbuf_release(&buf);
2715 rollback_lock_file(&lock);
2716 return error(_("failed to finalize '%s'"), filename);
2719 strbuf_release(&buf);
2720 return 0;
2723 static int do_label(const char *name, int len)
2725 struct ref_store *refs = get_main_ref_store(the_repository);
2726 struct ref_transaction *transaction;
2727 struct strbuf ref_name = STRBUF_INIT, err = STRBUF_INIT;
2728 struct strbuf msg = STRBUF_INIT;
2729 int ret = 0;
2730 struct object_id head_oid;
2732 if (len == 1 && *name == '#')
2733 return error("Illegal label name: '%.*s'", len, name);
2735 strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
2736 strbuf_addf(&msg, "rebase -i (label) '%.*s'", len, name);
2738 transaction = ref_store_transaction_begin(refs, &err);
2739 if (!transaction) {
2740 error("%s", err.buf);
2741 ret = -1;
2742 } else if (get_oid("HEAD", &head_oid)) {
2743 error(_("could not read HEAD"));
2744 ret = -1;
2745 } else if (ref_transaction_update(transaction, ref_name.buf, &head_oid,
2746 NULL, 0, msg.buf, &err) < 0 ||
2747 ref_transaction_commit(transaction, &err)) {
2748 error("%s", err.buf);
2749 ret = -1;
2751 ref_transaction_free(transaction);
2752 strbuf_release(&err);
2753 strbuf_release(&msg);
2755 if (!ret)
2756 ret = safe_append(rebase_path_refs_to_delete(),
2757 "%s\n", ref_name.buf);
2758 strbuf_release(&ref_name);
2760 return ret;
2763 static const char *reflog_message(struct replay_opts *opts,
2764 const char *sub_action, const char *fmt, ...);
2766 static int do_reset(const char *name, int len, struct replay_opts *opts)
2768 struct strbuf ref_name = STRBUF_INIT;
2769 struct object_id oid;
2770 struct lock_file lock = LOCK_INIT;
2771 struct tree_desc desc;
2772 struct tree *tree;
2773 struct unpack_trees_options unpack_tree_opts;
2774 int ret = 0, i;
2776 if (hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0)
2777 return -1;
2779 if (len == 10 && !strncmp("[new root]", name, len)) {
2780 if (!opts->have_squash_onto) {
2781 const char *hex;
2782 if (commit_tree("", 0, the_hash_algo->empty_tree,
2783 NULL, &opts->squash_onto,
2784 NULL, NULL))
2785 return error(_("writing fake root commit"));
2786 opts->have_squash_onto = 1;
2787 hex = oid_to_hex(&opts->squash_onto);
2788 if (write_message(hex, strlen(hex),
2789 rebase_path_squash_onto(), 0))
2790 return error(_("writing squash-onto"));
2792 oidcpy(&oid, &opts->squash_onto);
2793 } else {
2794 /* Determine the length of the label */
2795 for (i = 0; i < len; i++)
2796 if (isspace(name[i]))
2797 len = i;
2799 strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
2800 if (get_oid(ref_name.buf, &oid) &&
2801 get_oid(ref_name.buf + strlen("refs/rewritten/"), &oid)) {
2802 error(_("could not read '%s'"), ref_name.buf);
2803 rollback_lock_file(&lock);
2804 strbuf_release(&ref_name);
2805 return -1;
2809 memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
2810 setup_unpack_trees_porcelain(&unpack_tree_opts, "reset");
2811 unpack_tree_opts.head_idx = 1;
2812 unpack_tree_opts.src_index = &the_index;
2813 unpack_tree_opts.dst_index = &the_index;
2814 unpack_tree_opts.fn = oneway_merge;
2815 unpack_tree_opts.merge = 1;
2816 unpack_tree_opts.update = 1;
2818 if (read_cache_unmerged()) {
2819 rollback_lock_file(&lock);
2820 strbuf_release(&ref_name);
2821 return error_resolve_conflict(_(action_name(opts)));
2824 if (!fill_tree_descriptor(&desc, &oid)) {
2825 error(_("failed to find tree of %s"), oid_to_hex(&oid));
2826 rollback_lock_file(&lock);
2827 free((void *)desc.buffer);
2828 strbuf_release(&ref_name);
2829 return -1;
2832 if (unpack_trees(1, &desc, &unpack_tree_opts)) {
2833 rollback_lock_file(&lock);
2834 free((void *)desc.buffer);
2835 strbuf_release(&ref_name);
2836 return -1;
2839 tree = parse_tree_indirect(&oid);
2840 prime_cache_tree(&the_index, tree);
2842 if (write_locked_index(&the_index, &lock, COMMIT_LOCK) < 0)
2843 ret = error(_("could not write index"));
2844 free((void *)desc.buffer);
2846 if (!ret)
2847 ret = update_ref(reflog_message(opts, "reset", "'%.*s'",
2848 len, name), "HEAD", &oid,
2849 NULL, 0, UPDATE_REFS_MSG_ON_ERR);
2851 strbuf_release(&ref_name);
2852 return ret;
2855 static struct commit *lookup_label(const char *label, int len,
2856 struct strbuf *buf)
2858 struct commit *commit;
2860 strbuf_reset(buf);
2861 strbuf_addf(buf, "refs/rewritten/%.*s", len, label);
2862 commit = lookup_commit_reference_by_name(buf->buf);
2863 if (!commit) {
2864 /* fall back to non-rewritten ref or commit */
2865 strbuf_splice(buf, 0, strlen("refs/rewritten/"), "", 0);
2866 commit = lookup_commit_reference_by_name(buf->buf);
2869 if (!commit)
2870 error(_("could not resolve '%s'"), buf->buf);
2872 return commit;
2875 static int do_merge(struct commit *commit, const char *arg, int arg_len,
2876 int flags, struct replay_opts *opts)
2878 int run_commit_flags = (flags & TODO_EDIT_MERGE_MSG) ?
2879 EDIT_MSG | VERIFY_MSG : 0;
2880 struct strbuf ref_name = STRBUF_INIT;
2881 struct commit *head_commit, *merge_commit, *i;
2882 struct commit_list *bases, *j, *reversed = NULL;
2883 struct commit_list *to_merge = NULL, **tail = &to_merge;
2884 struct merge_options o;
2885 int merge_arg_len, oneline_offset, can_fast_forward, ret, k;
2886 static struct lock_file lock;
2887 const char *p;
2889 if (hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0) {
2890 ret = -1;
2891 goto leave_merge;
2894 head_commit = lookup_commit_reference_by_name("HEAD");
2895 if (!head_commit) {
2896 ret = error(_("cannot merge without a current revision"));
2897 goto leave_merge;
2901 * For octopus merges, the arg starts with the list of revisions to be
2902 * merged. The list is optionally followed by '#' and the oneline.
2904 merge_arg_len = oneline_offset = arg_len;
2905 for (p = arg; p - arg < arg_len; p += strspn(p, " \t\n")) {
2906 if (!*p)
2907 break;
2908 if (*p == '#' && (!p[1] || isspace(p[1]))) {
2909 p += 1 + strspn(p + 1, " \t\n");
2910 oneline_offset = p - arg;
2911 break;
2913 k = strcspn(p, " \t\n");
2914 if (!k)
2915 continue;
2916 merge_commit = lookup_label(p, k, &ref_name);
2917 if (!merge_commit) {
2918 ret = error(_("unable to parse '%.*s'"), k, p);
2919 goto leave_merge;
2921 tail = &commit_list_insert(merge_commit, tail)->next;
2922 p += k;
2923 merge_arg_len = p - arg;
2926 if (!to_merge) {
2927 ret = error(_("nothing to merge: '%.*s'"), arg_len, arg);
2928 goto leave_merge;
2931 if (opts->have_squash_onto &&
2932 !oidcmp(&head_commit->object.oid, &opts->squash_onto)) {
2934 * When the user tells us to "merge" something into a
2935 * "[new root]", let's simply fast-forward to the merge head.
2937 rollback_lock_file(&lock);
2938 if (to_merge->next)
2939 ret = error(_("octopus merge cannot be executed on "
2940 "top of a [new root]"));
2941 else
2942 ret = fast_forward_to(&to_merge->item->object.oid,
2943 &head_commit->object.oid, 0,
2944 opts);
2945 goto leave_merge;
2948 if (commit) {
2949 const char *message = get_commit_buffer(commit, NULL);
2950 const char *body;
2951 int len;
2953 if (!message) {
2954 ret = error(_("could not get commit message of '%s'"),
2955 oid_to_hex(&commit->object.oid));
2956 goto leave_merge;
2958 write_author_script(message);
2959 find_commit_subject(message, &body);
2960 len = strlen(body);
2961 ret = write_message(body, len, git_path_merge_msg(the_repository), 0);
2962 unuse_commit_buffer(commit, message);
2963 if (ret) {
2964 error_errno(_("could not write '%s'"),
2965 git_path_merge_msg(the_repository));
2966 goto leave_merge;
2968 } else {
2969 struct strbuf buf = STRBUF_INIT;
2970 int len;
2972 strbuf_addf(&buf, "author %s", git_author_info(0));
2973 write_author_script(buf.buf);
2974 strbuf_reset(&buf);
2976 if (oneline_offset < arg_len) {
2977 p = arg + oneline_offset;
2978 len = arg_len - oneline_offset;
2979 } else {
2980 strbuf_addf(&buf, "Merge %s '%.*s'",
2981 to_merge->next ? "branches" : "branch",
2982 merge_arg_len, arg);
2983 p = buf.buf;
2984 len = buf.len;
2987 ret = write_message(p, len, git_path_merge_msg(the_repository), 0);
2988 strbuf_release(&buf);
2989 if (ret) {
2990 error_errno(_("could not write '%s'"),
2991 git_path_merge_msg(the_repository));
2992 goto leave_merge;
2997 * If HEAD is not identical to the first parent of the original merge
2998 * commit, we cannot fast-forward.
3000 can_fast_forward = opts->allow_ff && commit && commit->parents &&
3001 !oidcmp(&commit->parents->item->object.oid,
3002 &head_commit->object.oid);
3005 * If any merge head is different from the original one, we cannot
3006 * fast-forward.
3008 if (can_fast_forward) {
3009 struct commit_list *p = commit->parents->next;
3011 for (j = to_merge; j && p; j = j->next, p = p->next)
3012 if (oidcmp(&j->item->object.oid,
3013 &p->item->object.oid)) {
3014 can_fast_forward = 0;
3015 break;
3018 * If the number of merge heads differs from the original merge
3019 * commit, we cannot fast-forward.
3021 if (j || p)
3022 can_fast_forward = 0;
3025 if (can_fast_forward) {
3026 rollback_lock_file(&lock);
3027 ret = fast_forward_to(&commit->object.oid,
3028 &head_commit->object.oid, 0, opts);
3029 goto leave_merge;
3032 if (to_merge->next) {
3033 /* Octopus merge */
3034 struct child_process cmd = CHILD_PROCESS_INIT;
3036 if (read_env_script(&cmd.env_array)) {
3037 const char *gpg_opt = gpg_sign_opt_quoted(opts);
3039 ret = error(_(staged_changes_advice), gpg_opt, gpg_opt);
3040 goto leave_merge;
3043 cmd.git_cmd = 1;
3044 argv_array_push(&cmd.args, "merge");
3045 argv_array_push(&cmd.args, "-s");
3046 argv_array_push(&cmd.args, "octopus");
3047 argv_array_push(&cmd.args, "--no-edit");
3048 argv_array_push(&cmd.args, "--no-ff");
3049 argv_array_push(&cmd.args, "--no-log");
3050 argv_array_push(&cmd.args, "--no-stat");
3051 argv_array_push(&cmd.args, "-F");
3052 argv_array_push(&cmd.args, git_path_merge_msg(the_repository));
3053 if (opts->gpg_sign)
3054 argv_array_push(&cmd.args, opts->gpg_sign);
3056 /* Add the tips to be merged */
3057 for (j = to_merge; j; j = j->next)
3058 argv_array_push(&cmd.args,
3059 oid_to_hex(&j->item->object.oid));
3061 strbuf_release(&ref_name);
3062 unlink(git_path_cherry_pick_head(the_repository));
3063 rollback_lock_file(&lock);
3065 rollback_lock_file(&lock);
3066 ret = run_command(&cmd);
3068 /* force re-reading of the cache */
3069 if (!ret && (discard_cache() < 0 || read_cache() < 0))
3070 ret = error(_("could not read index"));
3071 goto leave_merge;
3074 merge_commit = to_merge->item;
3075 write_message(oid_to_hex(&merge_commit->object.oid), GIT_SHA1_HEXSZ,
3076 git_path_merge_head(the_repository), 0);
3077 write_message("no-ff", 5, git_path_merge_mode(the_repository), 0);
3079 bases = get_merge_bases(head_commit, merge_commit);
3080 if (bases && !oidcmp(&merge_commit->object.oid,
3081 &bases->item->object.oid)) {
3082 ret = 0;
3083 /* skip merging an ancestor of HEAD */
3084 goto leave_merge;
3087 for (j = bases; j; j = j->next)
3088 commit_list_insert(j->item, &reversed);
3089 free_commit_list(bases);
3091 read_cache();
3092 init_merge_options(&o);
3093 o.branch1 = "HEAD";
3094 o.branch2 = ref_name.buf;
3095 o.buffer_output = 2;
3097 ret = merge_recursive(&o, head_commit, merge_commit, reversed, &i);
3098 if (ret <= 0)
3099 fputs(o.obuf.buf, stdout);
3100 strbuf_release(&o.obuf);
3101 if (ret < 0) {
3102 error(_("could not even attempt to merge '%.*s'"),
3103 merge_arg_len, arg);
3104 goto leave_merge;
3107 * The return value of merge_recursive() is 1 on clean, and 0 on
3108 * unclean merge.
3110 * Let's reverse that, so that do_merge() returns 0 upon success and
3111 * 1 upon failed merge (keeping the return value -1 for the cases where
3112 * we will want to reschedule the `merge` command).
3114 ret = !ret;
3116 if (active_cache_changed &&
3117 write_locked_index(&the_index, &lock, COMMIT_LOCK)) {
3118 ret = error(_("merge: Unable to write new index file"));
3119 goto leave_merge;
3122 rollback_lock_file(&lock);
3123 if (ret)
3124 rerere(opts->allow_rerere_auto);
3125 else
3127 * In case of problems, we now want to return a positive
3128 * value (a negative one would indicate that the `merge`
3129 * command needs to be rescheduled).
3131 ret = !!run_git_commit(git_path_merge_msg(the_repository), opts,
3132 run_commit_flags);
3134 leave_merge:
3135 strbuf_release(&ref_name);
3136 rollback_lock_file(&lock);
3137 free_commit_list(to_merge);
3138 return ret;
3141 static int is_final_fixup(struct todo_list *todo_list)
3143 int i = todo_list->current;
3145 if (!is_fixup(todo_list->items[i].command))
3146 return 0;
3148 while (++i < todo_list->nr)
3149 if (is_fixup(todo_list->items[i].command))
3150 return 0;
3151 else if (!is_noop(todo_list->items[i].command))
3152 break;
3153 return 1;
3156 static enum todo_command peek_command(struct todo_list *todo_list, int offset)
3158 int i;
3160 for (i = todo_list->current + offset; i < todo_list->nr; i++)
3161 if (!is_noop(todo_list->items[i].command))
3162 return todo_list->items[i].command;
3164 return -1;
3167 static int apply_autostash(struct replay_opts *opts)
3169 struct strbuf stash_sha1 = STRBUF_INIT;
3170 struct child_process child = CHILD_PROCESS_INIT;
3171 int ret = 0;
3173 if (!read_oneliner(&stash_sha1, rebase_path_autostash(), 1)) {
3174 strbuf_release(&stash_sha1);
3175 return 0;
3177 strbuf_trim(&stash_sha1);
3179 child.git_cmd = 1;
3180 child.no_stdout = 1;
3181 child.no_stderr = 1;
3182 argv_array_push(&child.args, "stash");
3183 argv_array_push(&child.args, "apply");
3184 argv_array_push(&child.args, stash_sha1.buf);
3185 if (!run_command(&child))
3186 fprintf(stderr, _("Applied autostash.\n"));
3187 else {
3188 struct child_process store = CHILD_PROCESS_INIT;
3190 store.git_cmd = 1;
3191 argv_array_push(&store.args, "stash");
3192 argv_array_push(&store.args, "store");
3193 argv_array_push(&store.args, "-m");
3194 argv_array_push(&store.args, "autostash");
3195 argv_array_push(&store.args, "-q");
3196 argv_array_push(&store.args, stash_sha1.buf);
3197 if (run_command(&store))
3198 ret = error(_("cannot store %s"), stash_sha1.buf);
3199 else
3200 fprintf(stderr,
3201 _("Applying autostash resulted in conflicts.\n"
3202 "Your changes are safe in the stash.\n"
3203 "You can run \"git stash pop\" or"
3204 " \"git stash drop\" at any time.\n"));
3207 strbuf_release(&stash_sha1);
3208 return ret;
3211 static const char *reflog_message(struct replay_opts *opts,
3212 const char *sub_action, const char *fmt, ...)
3214 va_list ap;
3215 static struct strbuf buf = STRBUF_INIT;
3217 va_start(ap, fmt);
3218 strbuf_reset(&buf);
3219 strbuf_addstr(&buf, action_name(opts));
3220 if (sub_action)
3221 strbuf_addf(&buf, " (%s)", sub_action);
3222 if (fmt) {
3223 strbuf_addstr(&buf, ": ");
3224 strbuf_vaddf(&buf, fmt, ap);
3226 va_end(ap);
3228 return buf.buf;
3231 static const char rescheduled_advice[] =
3232 N_("Could not execute the todo command\n"
3233 "\n"
3234 " %.*s"
3235 "\n"
3236 "It has been rescheduled; To edit the command before continuing, please\n"
3237 "edit the todo list first:\n"
3238 "\n"
3239 " git rebase --edit-todo\n"
3240 " git rebase --continue\n");
3242 static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
3244 int res = 0, reschedule = 0;
3246 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
3247 if (opts->allow_ff)
3248 assert(!(opts->signoff || opts->no_commit ||
3249 opts->record_origin || opts->edit));
3250 if (read_and_refresh_cache(opts))
3251 return -1;
3253 while (todo_list->current < todo_list->nr) {
3254 struct todo_item *item = todo_list->items + todo_list->current;
3255 if (save_todo(todo_list, opts))
3256 return -1;
3257 if (is_rebase_i(opts)) {
3258 if (item->command != TODO_COMMENT) {
3259 FILE *f = fopen(rebase_path_msgnum(), "w");
3261 todo_list->done_nr++;
3263 if (f) {
3264 fprintf(f, "%d\n", todo_list->done_nr);
3265 fclose(f);
3267 fprintf(stderr, "Rebasing (%d/%d)%s",
3268 todo_list->done_nr,
3269 todo_list->total_nr,
3270 opts->verbose ? "\n" : "\r");
3272 unlink(rebase_path_message());
3273 unlink(rebase_path_author_script());
3274 unlink(rebase_path_stopped_sha());
3275 unlink(rebase_path_amend());
3276 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
3278 if (item->command <= TODO_SQUASH) {
3279 if (is_rebase_i(opts))
3280 setenv("GIT_REFLOG_ACTION", reflog_message(opts,
3281 command_to_string(item->command), NULL),
3283 res = do_pick_commit(item->command, item->commit,
3284 opts, is_final_fixup(todo_list));
3285 if (is_rebase_i(opts) && res < 0) {
3286 /* Reschedule */
3287 advise(_(rescheduled_advice),
3288 get_item_line_length(todo_list,
3289 todo_list->current),
3290 get_item_line(todo_list,
3291 todo_list->current));
3292 todo_list->current--;
3293 if (save_todo(todo_list, opts))
3294 return -1;
3296 if (item->command == TODO_EDIT) {
3297 struct commit *commit = item->commit;
3298 if (!res)
3299 fprintf(stderr,
3300 _("Stopped at %s... %.*s\n"),
3301 short_commit_name(commit),
3302 item->arg_len, item->arg);
3303 return error_with_patch(commit,
3304 item->arg, item->arg_len, opts, res,
3305 !res);
3307 if (is_rebase_i(opts) && !res)
3308 record_in_rewritten(&item->commit->object.oid,
3309 peek_command(todo_list, 1));
3310 if (res && is_fixup(item->command)) {
3311 if (res == 1)
3312 intend_to_amend();
3313 return error_failed_squash(item->commit, opts,
3314 item->arg_len, item->arg);
3315 } else if (res && is_rebase_i(opts) && item->commit) {
3316 int to_amend = 0;
3317 struct object_id oid;
3320 * If we are rewording and have either
3321 * fast-forwarded already, or are about to
3322 * create a new root commit, we want to amend,
3323 * otherwise we do not.
3325 if (item->command == TODO_REWORD &&
3326 !get_oid("HEAD", &oid) &&
3327 (!oidcmp(&item->commit->object.oid, &oid) ||
3328 (opts->have_squash_onto &&
3329 !oidcmp(&opts->squash_onto, &oid))))
3330 to_amend = 1;
3332 return res | error_with_patch(item->commit,
3333 item->arg, item->arg_len, opts,
3334 res, to_amend);
3336 } else if (item->command == TODO_EXEC) {
3337 char *end_of_arg = (char *)(item->arg + item->arg_len);
3338 int saved = *end_of_arg;
3339 struct stat st;
3341 *end_of_arg = '\0';
3342 res = do_exec(item->arg);
3343 *end_of_arg = saved;
3345 /* Reread the todo file if it has changed. */
3346 if (res)
3347 ; /* fall through */
3348 else if (stat(get_todo_path(opts), &st))
3349 res = error_errno(_("could not stat '%s'"),
3350 get_todo_path(opts));
3351 else if (match_stat_data(&todo_list->stat, &st)) {
3352 todo_list_release(todo_list);
3353 if (read_populate_todo(todo_list, opts))
3354 res = -1; /* message was printed */
3355 /* `current` will be incremented below */
3356 todo_list->current = -1;
3358 } else if (item->command == TODO_LABEL) {
3359 if ((res = do_label(item->arg, item->arg_len)))
3360 reschedule = 1;
3361 } else if (item->command == TODO_RESET) {
3362 if ((res = do_reset(item->arg, item->arg_len, opts)))
3363 reschedule = 1;
3364 } else if (item->command == TODO_MERGE) {
3365 if ((res = do_merge(item->commit,
3366 item->arg, item->arg_len,
3367 item->flags, opts)) < 0)
3368 reschedule = 1;
3369 else if (item->commit)
3370 record_in_rewritten(&item->commit->object.oid,
3371 peek_command(todo_list, 1));
3372 if (res > 0)
3373 /* failed with merge conflicts */
3374 return error_with_patch(item->commit,
3375 item->arg,
3376 item->arg_len, opts,
3377 res, 0);
3378 } else if (!is_noop(item->command))
3379 return error(_("unknown command %d"), item->command);
3381 if (reschedule) {
3382 advise(_(rescheduled_advice),
3383 get_item_line_length(todo_list,
3384 todo_list->current),
3385 get_item_line(todo_list, todo_list->current));
3386 todo_list->current--;
3387 if (save_todo(todo_list, opts))
3388 return -1;
3389 if (item->commit)
3390 return error_with_patch(item->commit,
3391 item->arg,
3392 item->arg_len, opts,
3393 res, 0);
3396 todo_list->current++;
3397 if (res)
3398 return res;
3401 if (is_rebase_i(opts)) {
3402 struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
3403 struct stat st;
3405 /* Stopped in the middle, as planned? */
3406 if (todo_list->current < todo_list->nr)
3407 return 0;
3409 if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
3410 starts_with(head_ref.buf, "refs/")) {
3411 const char *msg;
3412 struct object_id head, orig;
3413 int res;
3415 if (get_oid("HEAD", &head)) {
3416 res = error(_("cannot read HEAD"));
3417 cleanup_head_ref:
3418 strbuf_release(&head_ref);
3419 strbuf_release(&buf);
3420 return res;
3422 if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
3423 get_oid_hex(buf.buf, &orig)) {
3424 res = error(_("could not read orig-head"));
3425 goto cleanup_head_ref;
3427 strbuf_reset(&buf);
3428 if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
3429 res = error(_("could not read 'onto'"));
3430 goto cleanup_head_ref;
3432 msg = reflog_message(opts, "finish", "%s onto %s",
3433 head_ref.buf, buf.buf);
3434 if (update_ref(msg, head_ref.buf, &head, &orig,
3435 REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR)) {
3436 res = error(_("could not update %s"),
3437 head_ref.buf);
3438 goto cleanup_head_ref;
3440 msg = reflog_message(opts, "finish", "returning to %s",
3441 head_ref.buf);
3442 if (create_symref("HEAD", head_ref.buf, msg)) {
3443 res = error(_("could not update HEAD to %s"),
3444 head_ref.buf);
3445 goto cleanup_head_ref;
3447 strbuf_reset(&buf);
3450 if (opts->verbose) {
3451 struct rev_info log_tree_opt;
3452 struct object_id orig, head;
3454 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
3455 init_revisions(&log_tree_opt, NULL);
3456 log_tree_opt.diff = 1;
3457 log_tree_opt.diffopt.output_format =
3458 DIFF_FORMAT_DIFFSTAT;
3459 log_tree_opt.disable_stdin = 1;
3461 if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
3462 !get_oid(buf.buf, &orig) &&
3463 !get_oid("HEAD", &head)) {
3464 diff_tree_oid(&orig, &head, "",
3465 &log_tree_opt.diffopt);
3466 log_tree_diff_flush(&log_tree_opt);
3469 flush_rewritten_pending();
3470 if (!stat(rebase_path_rewritten_list(), &st) &&
3471 st.st_size > 0) {
3472 struct child_process child = CHILD_PROCESS_INIT;
3473 const char *post_rewrite_hook =
3474 find_hook("post-rewrite");
3476 child.in = open(rebase_path_rewritten_list(), O_RDONLY);
3477 child.git_cmd = 1;
3478 argv_array_push(&child.args, "notes");
3479 argv_array_push(&child.args, "copy");
3480 argv_array_push(&child.args, "--for-rewrite=rebase");
3481 /* we don't care if this copying failed */
3482 run_command(&child);
3484 if (post_rewrite_hook) {
3485 struct child_process hook = CHILD_PROCESS_INIT;
3487 hook.in = open(rebase_path_rewritten_list(),
3488 O_RDONLY);
3489 hook.stdout_to_stderr = 1;
3490 argv_array_push(&hook.args, post_rewrite_hook);
3491 argv_array_push(&hook.args, "rebase");
3492 /* we don't care if this hook failed */
3493 run_command(&hook);
3496 apply_autostash(opts);
3498 fprintf(stderr, "Successfully rebased and updated %s.\n",
3499 head_ref.buf);
3501 strbuf_release(&buf);
3502 strbuf_release(&head_ref);
3506 * Sequence of picks finished successfully; cleanup by
3507 * removing the .git/sequencer directory
3509 return sequencer_remove_state(opts);
3512 static int continue_single_pick(void)
3514 const char *argv[] = { "commit", NULL };
3516 if (!file_exists(git_path_cherry_pick_head(the_repository)) &&
3517 !file_exists(git_path_revert_head(the_repository)))
3518 return error(_("no cherry-pick or revert in progress"));
3519 return run_command_v_opt(argv, RUN_GIT_CMD);
3522 static int commit_staged_changes(struct replay_opts *opts,
3523 struct todo_list *todo_list)
3525 unsigned int flags = ALLOW_EMPTY | EDIT_MSG;
3526 unsigned int final_fixup = 0, is_clean;
3528 if (has_unstaged_changes(1))
3529 return error(_("cannot rebase: You have unstaged changes."));
3531 is_clean = !has_uncommitted_changes(0);
3533 if (file_exists(rebase_path_amend())) {
3534 struct strbuf rev = STRBUF_INIT;
3535 struct object_id head, to_amend;
3537 if (get_oid("HEAD", &head))
3538 return error(_("cannot amend non-existing commit"));
3539 if (!read_oneliner(&rev, rebase_path_amend(), 0))
3540 return error(_("invalid file: '%s'"), rebase_path_amend());
3541 if (get_oid_hex(rev.buf, &to_amend))
3542 return error(_("invalid contents: '%s'"),
3543 rebase_path_amend());
3544 if (!is_clean && oidcmp(&head, &to_amend))
3545 return error(_("\nYou have uncommitted changes in your "
3546 "working tree. Please, commit them\n"
3547 "first and then run 'git rebase "
3548 "--continue' again."));
3550 * When skipping a failed fixup/squash, we need to edit the
3551 * commit message, the current fixup list and count, and if it
3552 * was the last fixup/squash in the chain, we need to clean up
3553 * the commit message and if there was a squash, let the user
3554 * edit it.
3556 if (is_clean && !oidcmp(&head, &to_amend) &&
3557 opts->current_fixup_count > 0 &&
3558 file_exists(rebase_path_stopped_sha())) {
3559 const char *p = opts->current_fixups.buf;
3560 int len = opts->current_fixups.len;
3562 opts->current_fixup_count--;
3563 if (!len)
3564 BUG("Incorrect current_fixups:\n%s", p);
3565 while (len && p[len - 1] != '\n')
3566 len--;
3567 strbuf_setlen(&opts->current_fixups, len);
3568 if (write_message(p, len, rebase_path_current_fixups(),
3569 0) < 0)
3570 return error(_("could not write file: '%s'"),
3571 rebase_path_current_fixups());
3574 * If a fixup/squash in a fixup/squash chain failed, the
3575 * commit message is already correct, no need to commit
3576 * it again.
3578 * Only if it is the final command in the fixup/squash
3579 * chain, and only if the chain is longer than a single
3580 * fixup/squash command (which was just skipped), do we
3581 * actually need to re-commit with a cleaned up commit
3582 * message.
3584 if (opts->current_fixup_count > 0 &&
3585 !is_fixup(peek_command(todo_list, 0))) {
3586 final_fixup = 1;
3588 * If there was not a single "squash" in the
3589 * chain, we only need to clean up the commit
3590 * message, no need to bother the user with
3591 * opening the commit message in the editor.
3593 if (!starts_with(p, "squash ") &&
3594 !strstr(p, "\nsquash "))
3595 flags = (flags & ~EDIT_MSG) | CLEANUP_MSG;
3596 } else if (is_fixup(peek_command(todo_list, 0))) {
3598 * We need to update the squash message to skip
3599 * the latest commit message.
3601 struct commit *commit;
3602 const char *path = rebase_path_squash_msg();
3604 if (parse_head(&commit) ||
3605 !(p = get_commit_buffer(commit, NULL)) ||
3606 write_message(p, strlen(p), path, 0)) {
3607 unuse_commit_buffer(commit, p);
3608 return error(_("could not write file: "
3609 "'%s'"), path);
3611 unuse_commit_buffer(commit, p);
3615 strbuf_release(&rev);
3616 flags |= AMEND_MSG;
3619 if (is_clean) {
3620 const char *cherry_pick_head = git_path_cherry_pick_head(the_repository);
3622 if (file_exists(cherry_pick_head) && unlink(cherry_pick_head))
3623 return error(_("could not remove CHERRY_PICK_HEAD"));
3624 if (!final_fixup)
3625 return 0;
3628 if (run_git_commit(final_fixup ? NULL : rebase_path_message(),
3629 opts, flags))
3630 return error(_("could not commit staged changes."));
3631 unlink(rebase_path_amend());
3632 if (final_fixup) {
3633 unlink(rebase_path_fixup_msg());
3634 unlink(rebase_path_squash_msg());
3636 if (opts->current_fixup_count > 0) {
3638 * Whether final fixup or not, we just cleaned up the commit
3639 * message...
3641 unlink(rebase_path_current_fixups());
3642 strbuf_reset(&opts->current_fixups);
3643 opts->current_fixup_count = 0;
3645 return 0;
3648 int sequencer_continue(struct replay_opts *opts)
3650 struct todo_list todo_list = TODO_LIST_INIT;
3651 int res;
3653 if (read_and_refresh_cache(opts))
3654 return -1;
3656 if (read_populate_opts(opts))
3657 return -1;
3658 if (is_rebase_i(opts)) {
3659 if ((res = read_populate_todo(&todo_list, opts)))
3660 goto release_todo_list;
3661 if (commit_staged_changes(opts, &todo_list))
3662 return -1;
3663 } else if (!file_exists(get_todo_path(opts)))
3664 return continue_single_pick();
3665 else if ((res = read_populate_todo(&todo_list, opts)))
3666 goto release_todo_list;
3668 if (!is_rebase_i(opts)) {
3669 /* Verify that the conflict has been resolved */
3670 if (file_exists(git_path_cherry_pick_head(the_repository)) ||
3671 file_exists(git_path_revert_head(the_repository))) {
3672 res = continue_single_pick();
3673 if (res)
3674 goto release_todo_list;
3676 if (index_differs_from("HEAD", NULL, 0)) {
3677 res = error_dirty_index(opts);
3678 goto release_todo_list;
3680 todo_list.current++;
3681 } else if (file_exists(rebase_path_stopped_sha())) {
3682 struct strbuf buf = STRBUF_INIT;
3683 struct object_id oid;
3685 if (read_oneliner(&buf, rebase_path_stopped_sha(), 1) &&
3686 !get_oid_committish(buf.buf, &oid))
3687 record_in_rewritten(&oid, peek_command(&todo_list, 0));
3688 strbuf_release(&buf);
3691 res = pick_commits(&todo_list, opts);
3692 release_todo_list:
3693 todo_list_release(&todo_list);
3694 return res;
3697 static int single_pick(struct commit *cmit, struct replay_opts *opts)
3699 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
3700 return do_pick_commit(opts->action == REPLAY_PICK ?
3701 TODO_PICK : TODO_REVERT, cmit, opts, 0);
3704 int sequencer_pick_revisions(struct replay_opts *opts)
3706 struct todo_list todo_list = TODO_LIST_INIT;
3707 struct object_id oid;
3708 int i, res;
3710 assert(opts->revs);
3711 if (read_and_refresh_cache(opts))
3712 return -1;
3714 for (i = 0; i < opts->revs->pending.nr; i++) {
3715 struct object_id oid;
3716 const char *name = opts->revs->pending.objects[i].name;
3718 /* This happens when using --stdin. */
3719 if (!strlen(name))
3720 continue;
3722 if (!get_oid(name, &oid)) {
3723 if (!lookup_commit_reference_gently(the_repository, &oid, 1)) {
3724 enum object_type type = oid_object_info(the_repository,
3725 &oid,
3726 NULL);
3727 return error(_("%s: can't cherry-pick a %s"),
3728 name, type_name(type));
3730 } else
3731 return error(_("%s: bad revision"), name);
3735 * If we were called as "git cherry-pick <commit>", just
3736 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
3737 * REVERT_HEAD, and don't touch the sequencer state.
3738 * This means it is possible to cherry-pick in the middle
3739 * of a cherry-pick sequence.
3741 if (opts->revs->cmdline.nr == 1 &&
3742 opts->revs->cmdline.rev->whence == REV_CMD_REV &&
3743 opts->revs->no_walk &&
3744 !opts->revs->cmdline.rev->flags) {
3745 struct commit *cmit;
3746 if (prepare_revision_walk(opts->revs))
3747 return error(_("revision walk setup failed"));
3748 cmit = get_revision(opts->revs);
3749 if (!cmit)
3750 return error(_("empty commit set passed"));
3751 if (get_revision(opts->revs))
3752 BUG("unexpected extra commit from walk");
3753 return single_pick(cmit, opts);
3757 * Start a new cherry-pick/ revert sequence; but
3758 * first, make sure that an existing one isn't in
3759 * progress
3762 if (walk_revs_populate_todo(&todo_list, opts) ||
3763 create_seq_dir() < 0)
3764 return -1;
3765 if (get_oid("HEAD", &oid) && (opts->action == REPLAY_REVERT))
3766 return error(_("can't revert as initial commit"));
3767 if (save_head(oid_to_hex(&oid)))
3768 return -1;
3769 if (save_opts(opts))
3770 return -1;
3771 update_abort_safety_file();
3772 res = pick_commits(&todo_list, opts);
3773 todo_list_release(&todo_list);
3774 return res;
3777 void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag)
3779 unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
3780 struct strbuf sob = STRBUF_INIT;
3781 int has_footer;
3783 strbuf_addstr(&sob, sign_off_header);
3784 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
3785 getenv("GIT_COMMITTER_EMAIL")));
3786 strbuf_addch(&sob, '\n');
3788 if (!ignore_footer)
3789 strbuf_complete_line(msgbuf);
3792 * If the whole message buffer is equal to the sob, pretend that we
3793 * found a conforming footer with a matching sob
3795 if (msgbuf->len - ignore_footer == sob.len &&
3796 !strncmp(msgbuf->buf, sob.buf, sob.len))
3797 has_footer = 3;
3798 else
3799 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
3801 if (!has_footer) {
3802 const char *append_newlines = NULL;
3803 size_t len = msgbuf->len - ignore_footer;
3805 if (!len) {
3807 * The buffer is completely empty. Leave foom for
3808 * the title and body to be filled in by the user.
3810 append_newlines = "\n\n";
3811 } else if (len == 1) {
3813 * Buffer contains a single newline. Add another
3814 * so that we leave room for the title and body.
3816 append_newlines = "\n";
3817 } else if (msgbuf->buf[len - 2] != '\n') {
3819 * Buffer ends with a single newline. Add another
3820 * so that there is an empty line between the message
3821 * body and the sob.
3823 append_newlines = "\n";
3824 } /* else, the buffer already ends with two newlines. */
3826 if (append_newlines)
3827 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
3828 append_newlines, strlen(append_newlines));
3831 if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
3832 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
3833 sob.buf, sob.len);
3835 strbuf_release(&sob);
3838 struct labels_entry {
3839 struct hashmap_entry entry;
3840 char label[FLEX_ARRAY];
3843 static int labels_cmp(const void *fndata, const struct labels_entry *a,
3844 const struct labels_entry *b, const void *key)
3846 return key ? strcmp(a->label, key) : strcmp(a->label, b->label);
3849 struct string_entry {
3850 struct oidmap_entry entry;
3851 char string[FLEX_ARRAY];
3854 struct label_state {
3855 struct oidmap commit2label;
3856 struct hashmap labels;
3857 struct strbuf buf;
3860 static const char *label_oid(struct object_id *oid, const char *label,
3861 struct label_state *state)
3863 struct labels_entry *labels_entry;
3864 struct string_entry *string_entry;
3865 struct object_id dummy;
3866 size_t len;
3867 int i;
3869 string_entry = oidmap_get(&state->commit2label, oid);
3870 if (string_entry)
3871 return string_entry->string;
3874 * For "uninteresting" commits, i.e. commits that are not to be
3875 * rebased, and which can therefore not be labeled, we use a unique
3876 * abbreviation of the commit name. This is slightly more complicated
3877 * than calling find_unique_abbrev() because we also need to make
3878 * sure that the abbreviation does not conflict with any other
3879 * label.
3881 * We disallow "interesting" commits to be labeled by a string that
3882 * is a valid full-length hash, to ensure that we always can find an
3883 * abbreviation for any uninteresting commit's names that does not
3884 * clash with any other label.
3886 if (!label) {
3887 char *p;
3889 strbuf_reset(&state->buf);
3890 strbuf_grow(&state->buf, GIT_SHA1_HEXSZ);
3891 label = p = state->buf.buf;
3893 find_unique_abbrev_r(p, oid, default_abbrev);
3896 * We may need to extend the abbreviated hash so that there is
3897 * no conflicting label.
3899 if (hashmap_get_from_hash(&state->labels, strihash(p), p)) {
3900 size_t i = strlen(p) + 1;
3902 oid_to_hex_r(p, oid);
3903 for (; i < GIT_SHA1_HEXSZ; i++) {
3904 char save = p[i];
3905 p[i] = '\0';
3906 if (!hashmap_get_from_hash(&state->labels,
3907 strihash(p), p))
3908 break;
3909 p[i] = save;
3912 } else if (((len = strlen(label)) == the_hash_algo->hexsz &&
3913 !get_oid_hex(label, &dummy)) ||
3914 (len == 1 && *label == '#') ||
3915 hashmap_get_from_hash(&state->labels,
3916 strihash(label), label)) {
3918 * If the label already exists, or if the label is a valid full
3919 * OID, or the label is a '#' (which we use as a separator
3920 * between merge heads and oneline), we append a dash and a
3921 * number to make it unique.
3923 struct strbuf *buf = &state->buf;
3925 strbuf_reset(buf);
3926 strbuf_add(buf, label, len);
3928 for (i = 2; ; i++) {
3929 strbuf_setlen(buf, len);
3930 strbuf_addf(buf, "-%d", i);
3931 if (!hashmap_get_from_hash(&state->labels,
3932 strihash(buf->buf),
3933 buf->buf))
3934 break;
3937 label = buf->buf;
3940 FLEX_ALLOC_STR(labels_entry, label, label);
3941 hashmap_entry_init(labels_entry, strihash(label));
3942 hashmap_add(&state->labels, labels_entry);
3944 FLEX_ALLOC_STR(string_entry, string, label);
3945 oidcpy(&string_entry->entry.oid, oid);
3946 oidmap_put(&state->commit2label, string_entry);
3948 return string_entry->string;
3951 static int make_script_with_merges(struct pretty_print_context *pp,
3952 struct rev_info *revs, FILE *out,
3953 unsigned flags)
3955 int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
3956 int rebase_cousins = flags & TODO_LIST_REBASE_COUSINS;
3957 struct strbuf buf = STRBUF_INIT, oneline = STRBUF_INIT;
3958 struct strbuf label = STRBUF_INIT;
3959 struct commit_list *commits = NULL, **tail = &commits, *iter;
3960 struct commit_list *tips = NULL, **tips_tail = &tips;
3961 struct commit *commit;
3962 struct oidmap commit2todo = OIDMAP_INIT;
3963 struct string_entry *entry;
3964 struct oidset interesting = OIDSET_INIT, child_seen = OIDSET_INIT,
3965 shown = OIDSET_INIT;
3966 struct label_state state = { OIDMAP_INIT, { NULL }, STRBUF_INIT };
3968 int abbr = flags & TODO_LIST_ABBREVIATE_CMDS;
3969 const char *cmd_pick = abbr ? "p" : "pick",
3970 *cmd_label = abbr ? "l" : "label",
3971 *cmd_reset = abbr ? "t" : "reset",
3972 *cmd_merge = abbr ? "m" : "merge";
3974 oidmap_init(&commit2todo, 0);
3975 oidmap_init(&state.commit2label, 0);
3976 hashmap_init(&state.labels, (hashmap_cmp_fn) labels_cmp, NULL, 0);
3977 strbuf_init(&state.buf, 32);
3979 if (revs->cmdline.nr && (revs->cmdline.rev[0].flags & BOTTOM)) {
3980 struct object_id *oid = &revs->cmdline.rev[0].item->oid;
3981 FLEX_ALLOC_STR(entry, string, "onto");
3982 oidcpy(&entry->entry.oid, oid);
3983 oidmap_put(&state.commit2label, entry);
3987 * First phase:
3988 * - get onelines for all commits
3989 * - gather all branch tips (i.e. 2nd or later parents of merges)
3990 * - label all branch tips
3992 while ((commit = get_revision(revs))) {
3993 struct commit_list *to_merge;
3994 const char *p1, *p2;
3995 struct object_id *oid;
3996 int is_empty;
3998 tail = &commit_list_insert(commit, tail)->next;
3999 oidset_insert(&interesting, &commit->object.oid);
4001 is_empty = is_original_commit_empty(commit);
4002 if (!is_empty && (commit->object.flags & PATCHSAME))
4003 continue;
4005 strbuf_reset(&oneline);
4006 pretty_print_commit(pp, commit, &oneline);
4008 to_merge = commit->parents ? commit->parents->next : NULL;
4009 if (!to_merge) {
4010 /* non-merge commit: easy case */
4011 strbuf_reset(&buf);
4012 if (!keep_empty && is_empty)
4013 strbuf_addf(&buf, "%c ", comment_line_char);
4014 strbuf_addf(&buf, "%s %s %s", cmd_pick,
4015 oid_to_hex(&commit->object.oid),
4016 oneline.buf);
4018 FLEX_ALLOC_STR(entry, string, buf.buf);
4019 oidcpy(&entry->entry.oid, &commit->object.oid);
4020 oidmap_put(&commit2todo, entry);
4022 continue;
4025 /* Create a label */
4026 strbuf_reset(&label);
4027 if (skip_prefix(oneline.buf, "Merge ", &p1) &&
4028 (p1 = strchr(p1, '\'')) &&
4029 (p2 = strchr(++p1, '\'')))
4030 strbuf_add(&label, p1, p2 - p1);
4031 else if (skip_prefix(oneline.buf, "Merge pull request ",
4032 &p1) &&
4033 (p1 = strstr(p1, " from ")))
4034 strbuf_addstr(&label, p1 + strlen(" from "));
4035 else
4036 strbuf_addbuf(&label, &oneline);
4038 for (p1 = label.buf; *p1; p1++)
4039 if (isspace(*p1))
4040 *(char *)p1 = '-';
4042 strbuf_reset(&buf);
4043 strbuf_addf(&buf, "%s -C %s",
4044 cmd_merge, oid_to_hex(&commit->object.oid));
4046 /* label the tips of merged branches */
4047 for (; to_merge; to_merge = to_merge->next) {
4048 oid = &to_merge->item->object.oid;
4049 strbuf_addch(&buf, ' ');
4051 if (!oidset_contains(&interesting, oid)) {
4052 strbuf_addstr(&buf, label_oid(oid, NULL,
4053 &state));
4054 continue;
4057 tips_tail = &commit_list_insert(to_merge->item,
4058 tips_tail)->next;
4060 strbuf_addstr(&buf, label_oid(oid, label.buf, &state));
4062 strbuf_addf(&buf, " # %s", oneline.buf);
4064 FLEX_ALLOC_STR(entry, string, buf.buf);
4065 oidcpy(&entry->entry.oid, &commit->object.oid);
4066 oidmap_put(&commit2todo, entry);
4070 * Second phase:
4071 * - label branch points
4072 * - add HEAD to the branch tips
4074 for (iter = commits; iter; iter = iter->next) {
4075 struct commit_list *parent = iter->item->parents;
4076 for (; parent; parent = parent->next) {
4077 struct object_id *oid = &parent->item->object.oid;
4078 if (!oidset_contains(&interesting, oid))
4079 continue;
4080 if (!oidset_contains(&child_seen, oid))
4081 oidset_insert(&child_seen, oid);
4082 else
4083 label_oid(oid, "branch-point", &state);
4086 /* Add HEAD as implict "tip of branch" */
4087 if (!iter->next)
4088 tips_tail = &commit_list_insert(iter->item,
4089 tips_tail)->next;
4093 * Third phase: output the todo list. This is a bit tricky, as we
4094 * want to avoid jumping back and forth between revisions. To
4095 * accomplish that goal, we walk backwards from the branch tips,
4096 * gathering commits not yet shown, reversing the list on the fly,
4097 * then outputting that list (labeling revisions as needed).
4099 fprintf(out, "%s onto\n", cmd_label);
4100 for (iter = tips; iter; iter = iter->next) {
4101 struct commit_list *list = NULL, *iter2;
4103 commit = iter->item;
4104 if (oidset_contains(&shown, &commit->object.oid))
4105 continue;
4106 entry = oidmap_get(&state.commit2label, &commit->object.oid);
4108 if (entry)
4109 fprintf(out, "\n%c Branch %s\n", comment_line_char, entry->string);
4110 else
4111 fprintf(out, "\n");
4113 while (oidset_contains(&interesting, &commit->object.oid) &&
4114 !oidset_contains(&shown, &commit->object.oid)) {
4115 commit_list_insert(commit, &list);
4116 if (!commit->parents) {
4117 commit = NULL;
4118 break;
4120 commit = commit->parents->item;
4123 if (!commit)
4124 fprintf(out, "%s %s\n", cmd_reset,
4125 rebase_cousins ? "onto" : "[new root]");
4126 else {
4127 const char *to = NULL;
4129 entry = oidmap_get(&state.commit2label,
4130 &commit->object.oid);
4131 if (entry)
4132 to = entry->string;
4133 else if (!rebase_cousins)
4134 to = label_oid(&commit->object.oid, NULL,
4135 &state);
4137 if (!to || !strcmp(to, "onto"))
4138 fprintf(out, "%s onto\n", cmd_reset);
4139 else {
4140 strbuf_reset(&oneline);
4141 pretty_print_commit(pp, commit, &oneline);
4142 fprintf(out, "%s %s # %s\n",
4143 cmd_reset, to, oneline.buf);
4147 for (iter2 = list; iter2; iter2 = iter2->next) {
4148 struct object_id *oid = &iter2->item->object.oid;
4149 entry = oidmap_get(&commit2todo, oid);
4150 /* only show if not already upstream */
4151 if (entry)
4152 fprintf(out, "%s\n", entry->string);
4153 entry = oidmap_get(&state.commit2label, oid);
4154 if (entry)
4155 fprintf(out, "%s %s\n",
4156 cmd_label, entry->string);
4157 oidset_insert(&shown, oid);
4160 free_commit_list(list);
4163 free_commit_list(commits);
4164 free_commit_list(tips);
4166 strbuf_release(&label);
4167 strbuf_release(&oneline);
4168 strbuf_release(&buf);
4170 oidmap_free(&commit2todo, 1);
4171 oidmap_free(&state.commit2label, 1);
4172 hashmap_free(&state.labels, 1);
4173 strbuf_release(&state.buf);
4175 return 0;
4178 int sequencer_make_script(FILE *out, int argc, const char **argv,
4179 unsigned flags)
4181 char *format = NULL;
4182 struct pretty_print_context pp = {0};
4183 struct strbuf buf = STRBUF_INIT;
4184 struct rev_info revs;
4185 struct commit *commit;
4186 int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
4187 const char *insn = flags & TODO_LIST_ABBREVIATE_CMDS ? "p" : "pick";
4188 int rebase_merges = flags & TODO_LIST_REBASE_MERGES;
4190 init_revisions(&revs, NULL);
4191 revs.verbose_header = 1;
4192 if (!rebase_merges)
4193 revs.max_parents = 1;
4194 revs.cherry_mark = 1;
4195 revs.limited = 1;
4196 revs.reverse = 1;
4197 revs.right_only = 1;
4198 revs.sort_order = REV_SORT_IN_GRAPH_ORDER;
4199 revs.topo_order = 1;
4201 revs.pretty_given = 1;
4202 git_config_get_string("rebase.instructionFormat", &format);
4203 if (!format || !*format) {
4204 free(format);
4205 format = xstrdup("%s");
4207 get_commit_format(format, &revs);
4208 free(format);
4209 pp.fmt = revs.commit_format;
4210 pp.output_encoding = get_log_output_encoding();
4212 if (setup_revisions(argc, argv, &revs, NULL) > 1)
4213 return error(_("make_script: unhandled options"));
4215 if (prepare_revision_walk(&revs) < 0)
4216 return error(_("make_script: error preparing revisions"));
4218 if (rebase_merges)
4219 return make_script_with_merges(&pp, &revs, out, flags);
4221 while ((commit = get_revision(&revs))) {
4222 int is_empty = is_original_commit_empty(commit);
4224 if (!is_empty && (commit->object.flags & PATCHSAME))
4225 continue;
4226 strbuf_reset(&buf);
4227 if (!keep_empty && is_empty)
4228 strbuf_addf(&buf, "%c ", comment_line_char);
4229 strbuf_addf(&buf, "%s %s ", insn,
4230 oid_to_hex(&commit->object.oid));
4231 pretty_print_commit(&pp, commit, &buf);
4232 strbuf_addch(&buf, '\n');
4233 fputs(buf.buf, out);
4235 strbuf_release(&buf);
4236 return 0;
4240 * Add commands after pick and (series of) squash/fixup commands
4241 * in the todo list.
4243 int sequencer_add_exec_commands(const char *commands)
4245 const char *todo_file = rebase_path_todo();
4246 struct todo_list todo_list = TODO_LIST_INIT;
4247 struct todo_item *item;
4248 struct strbuf *buf = &todo_list.buf;
4249 size_t offset = 0, commands_len = strlen(commands);
4250 int i, first;
4252 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
4253 return error(_("could not read '%s'."), todo_file);
4255 if (parse_insn_buffer(todo_list.buf.buf, &todo_list)) {
4256 todo_list_release(&todo_list);
4257 return error(_("unusable todo list: '%s'"), todo_file);
4260 first = 1;
4261 /* insert <commands> before every pick except the first one */
4262 for (item = todo_list.items, i = 0; i < todo_list.nr; i++, item++) {
4263 if (item->command == TODO_PICK && !first) {
4264 strbuf_insert(buf, item->offset_in_buf + offset,
4265 commands, commands_len);
4266 offset += commands_len;
4268 first = 0;
4271 /* append final <commands> */
4272 strbuf_add(buf, commands, commands_len);
4274 i = write_message(buf->buf, buf->len, todo_file, 0);
4275 todo_list_release(&todo_list);
4276 return i;
4279 int transform_todos(unsigned flags)
4281 const char *todo_file = rebase_path_todo();
4282 struct todo_list todo_list = TODO_LIST_INIT;
4283 struct strbuf buf = STRBUF_INIT;
4284 struct todo_item *item;
4285 int i;
4287 if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
4288 return error(_("could not read '%s'."), todo_file);
4290 if (parse_insn_buffer(todo_list.buf.buf, &todo_list)) {
4291 todo_list_release(&todo_list);
4292 return error(_("unusable todo list: '%s'"), todo_file);
4295 for (item = todo_list.items, i = 0; i < todo_list.nr; i++, item++) {
4296 /* if the item is not a command write it and continue */
4297 if (item->command >= TODO_COMMENT) {
4298 strbuf_addf(&buf, "%.*s\n", item->arg_len, item->arg);
4299 continue;
4302 /* add command to the buffer */
4303 if (flags & TODO_LIST_ABBREVIATE_CMDS)
4304 strbuf_addch(&buf, command_to_char(item->command));
4305 else
4306 strbuf_addstr(&buf, command_to_string(item->command));
4308 /* add commit id */
4309 if (item->commit) {
4310 const char *oid = flags & TODO_LIST_SHORTEN_IDS ?
4311 short_commit_name(item->commit) :
4312 oid_to_hex(&item->commit->object.oid);
4314 if (item->command == TODO_MERGE) {
4315 if (item->flags & TODO_EDIT_MERGE_MSG)
4316 strbuf_addstr(&buf, " -c");
4317 else
4318 strbuf_addstr(&buf, " -C");
4321 strbuf_addf(&buf, " %s", oid);
4324 /* add all the rest */
4325 if (!item->arg_len)
4326 strbuf_addch(&buf, '\n');
4327 else
4328 strbuf_addf(&buf, " %.*s\n", item->arg_len, item->arg);
4331 i = write_message(buf.buf, buf.len, todo_file, 0);
4332 todo_list_release(&todo_list);
4333 return i;
4336 enum check_level {
4337 CHECK_IGNORE = 0, CHECK_WARN, CHECK_ERROR
4340 static enum check_level get_missing_commit_check_level(void)
4342 const char *value;
4344 if (git_config_get_value("rebase.missingcommitscheck", &value) ||
4345 !strcasecmp("ignore", value))
4346 return CHECK_IGNORE;
4347 if (!strcasecmp("warn", value))
4348 return CHECK_WARN;
4349 if (!strcasecmp("error", value))
4350 return CHECK_ERROR;
4351 warning(_("unrecognized setting %s for option "
4352 "rebase.missingCommitsCheck. Ignoring."), value);
4353 return CHECK_IGNORE;
4356 define_commit_slab(commit_seen, unsigned char);
4358 * Check if the user dropped some commits by mistake
4359 * Behaviour determined by rebase.missingCommitsCheck.
4360 * Check if there is an unrecognized command or a
4361 * bad SHA-1 in a command.
4363 int check_todo_list(void)
4365 enum check_level check_level = get_missing_commit_check_level();
4366 struct strbuf todo_file = STRBUF_INIT;
4367 struct todo_list todo_list = TODO_LIST_INIT;
4368 struct strbuf missing = STRBUF_INIT;
4369 int advise_to_edit_todo = 0, res = 0, i;
4370 struct commit_seen commit_seen;
4372 init_commit_seen(&commit_seen);
4374 strbuf_addstr(&todo_file, rebase_path_todo());
4375 if (strbuf_read_file_or_whine(&todo_list.buf, todo_file.buf) < 0) {
4376 res = -1;
4377 goto leave_check;
4379 advise_to_edit_todo = res =
4380 parse_insn_buffer(todo_list.buf.buf, &todo_list);
4382 if (res || check_level == CHECK_IGNORE)
4383 goto leave_check;
4385 /* Mark the commits in git-rebase-todo as seen */
4386 for (i = 0; i < todo_list.nr; i++) {
4387 struct commit *commit = todo_list.items[i].commit;
4388 if (commit)
4389 *commit_seen_at(&commit_seen, commit) = 1;
4392 todo_list_release(&todo_list);
4393 strbuf_addstr(&todo_file, ".backup");
4394 if (strbuf_read_file_or_whine(&todo_list.buf, todo_file.buf) < 0) {
4395 res = -1;
4396 goto leave_check;
4398 strbuf_release(&todo_file);
4399 res = !!parse_insn_buffer(todo_list.buf.buf, &todo_list);
4401 /* Find commits in git-rebase-todo.backup yet unseen */
4402 for (i = todo_list.nr - 1; i >= 0; i--) {
4403 struct todo_item *item = todo_list.items + i;
4404 struct commit *commit = item->commit;
4405 if (commit && !*commit_seen_at(&commit_seen, commit)) {
4406 strbuf_addf(&missing, " - %s %.*s\n",
4407 short_commit_name(commit),
4408 item->arg_len, item->arg);
4409 *commit_seen_at(&commit_seen, commit) = 1;
4413 /* Warn about missing commits */
4414 if (!missing.len)
4415 goto leave_check;
4417 if (check_level == CHECK_ERROR)
4418 advise_to_edit_todo = res = 1;
4420 fprintf(stderr,
4421 _("Warning: some commits may have been dropped accidentally.\n"
4422 "Dropped commits (newer to older):\n"));
4424 /* Make the list user-friendly and display */
4425 fputs(missing.buf, stderr);
4426 strbuf_release(&missing);
4428 fprintf(stderr, _("To avoid this message, use \"drop\" to "
4429 "explicitly remove a commit.\n\n"
4430 "Use 'git config rebase.missingCommitsCheck' to change "
4431 "the level of warnings.\n"
4432 "The possible behaviours are: ignore, warn, error.\n\n"));
4434 leave_check:
4435 clear_commit_seen(&commit_seen);
4436 strbuf_release(&todo_file);
4437 todo_list_release(&todo_list);
4439 if (advise_to_edit_todo)
4440 fprintf(stderr,
4441 _("You can fix this with 'git rebase --edit-todo' "
4442 "and then run 'git rebase --continue'.\n"
4443 "Or you can abort the rebase with 'git rebase"
4444 " --abort'.\n"));
4446 return res;
4449 static int rewrite_file(const char *path, const char *buf, size_t len)
4451 int rc = 0;
4452 int fd = open(path, O_WRONLY | O_TRUNC);
4453 if (fd < 0)
4454 return error_errno(_("could not open '%s' for writing"), path);
4455 if (write_in_full(fd, buf, len) < 0)
4456 rc = error_errno(_("could not write to '%s'"), path);
4457 if (close(fd) && !rc)
4458 rc = error_errno(_("could not close '%s'"), path);
4459 return rc;
4462 /* skip picking commits whose parents are unchanged */
4463 int skip_unnecessary_picks(void)
4465 const char *todo_file = rebase_path_todo();
4466 struct strbuf buf = STRBUF_INIT;
4467 struct todo_list todo_list = TODO_LIST_INIT;
4468 struct object_id onto_oid, *oid = &onto_oid, *parent_oid;
4469 int fd, i;
4471 if (!read_oneliner(&buf, rebase_path_onto(), 0))
4472 return error(_("could not read 'onto'"));
4473 if (get_oid(buf.buf, &onto_oid)) {
4474 strbuf_release(&buf);
4475 return error(_("need a HEAD to fixup"));
4477 strbuf_release(&buf);
4479 if (strbuf_read_file_or_whine(&todo_list.buf, todo_file) < 0)
4480 return -1;
4481 if (parse_insn_buffer(todo_list.buf.buf, &todo_list) < 0) {
4482 todo_list_release(&todo_list);
4483 return -1;
4486 for (i = 0; i < todo_list.nr; i++) {
4487 struct todo_item *item = todo_list.items + i;
4489 if (item->command >= TODO_NOOP)
4490 continue;
4491 if (item->command != TODO_PICK)
4492 break;
4493 if (parse_commit(item->commit)) {
4494 todo_list_release(&todo_list);
4495 return error(_("could not parse commit '%s'"),
4496 oid_to_hex(&item->commit->object.oid));
4498 if (!item->commit->parents)
4499 break; /* root commit */
4500 if (item->commit->parents->next)
4501 break; /* merge commit */
4502 parent_oid = &item->commit->parents->item->object.oid;
4503 if (hashcmp(parent_oid->hash, oid->hash))
4504 break;
4505 oid = &item->commit->object.oid;
4507 if (i > 0) {
4508 int offset = get_item_line_offset(&todo_list, i);
4509 const char *done_path = rebase_path_done();
4511 fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
4512 if (fd < 0) {
4513 error_errno(_("could not open '%s' for writing"),
4514 done_path);
4515 todo_list_release(&todo_list);
4516 return -1;
4518 if (write_in_full(fd, todo_list.buf.buf, offset) < 0) {
4519 error_errno(_("could not write to '%s'"), done_path);
4520 todo_list_release(&todo_list);
4521 close(fd);
4522 return -1;
4524 close(fd);
4526 if (rewrite_file(rebase_path_todo(), todo_list.buf.buf + offset,
4527 todo_list.buf.len - offset) < 0) {
4528 todo_list_release(&todo_list);
4529 return -1;
4532 todo_list.current = i;
4533 if (is_fixup(peek_command(&todo_list, 0)))
4534 record_in_rewritten(oid, peek_command(&todo_list, 0));
4537 todo_list_release(&todo_list);
4538 printf("%s\n", oid_to_hex(oid));
4540 return 0;
4543 struct subject2item_entry {
4544 struct hashmap_entry entry;
4545 int i;
4546 char subject[FLEX_ARRAY];
4549 static int subject2item_cmp(const void *fndata,
4550 const struct subject2item_entry *a,
4551 const struct subject2item_entry *b, const void *key)
4553 return key ? strcmp(a->subject, key) : strcmp(a->subject, b->subject);
4556 define_commit_slab(commit_todo_item, struct todo_item *);
4559 * Rearrange the todo list that has both "pick commit-id msg" and "pick
4560 * commit-id fixup!/squash! msg" in it so that the latter is put immediately
4561 * after the former, and change "pick" to "fixup"/"squash".
4563 * Note that if the config has specified a custom instruction format, each log
4564 * message will have to be retrieved from the commit (as the oneline in the
4565 * script cannot be trusted) in order to normalize the autosquash arrangement.
4567 int rearrange_squash(void)
4569 const char *todo_file = rebase_path_todo();
4570 struct todo_list todo_list = TODO_LIST_INIT;
4571 struct hashmap subject2item;
4572 int res = 0, rearranged = 0, *next, *tail, i;
4573 char **subjects;
4574 struct commit_todo_item commit_todo;
4576 if (strbuf_read_file_or_whine(&todo_list.buf, todo_file) < 0)
4577 return -1;
4578 if (parse_insn_buffer(todo_list.buf.buf, &todo_list) < 0) {
4579 todo_list_release(&todo_list);
4580 return -1;
4583 init_commit_todo_item(&commit_todo);
4585 * The hashmap maps onelines to the respective todo list index.
4587 * If any items need to be rearranged, the next[i] value will indicate
4588 * which item was moved directly after the i'th.
4590 * In that case, last[i] will indicate the index of the latest item to
4591 * be moved to appear after the i'th.
4593 hashmap_init(&subject2item, (hashmap_cmp_fn) subject2item_cmp,
4594 NULL, todo_list.nr);
4595 ALLOC_ARRAY(next, todo_list.nr);
4596 ALLOC_ARRAY(tail, todo_list.nr);
4597 ALLOC_ARRAY(subjects, todo_list.nr);
4598 for (i = 0; i < todo_list.nr; i++) {
4599 struct strbuf buf = STRBUF_INIT;
4600 struct todo_item *item = todo_list.items + i;
4601 const char *commit_buffer, *subject, *p;
4602 size_t subject_len;
4603 int i2 = -1;
4604 struct subject2item_entry *entry;
4606 next[i] = tail[i] = -1;
4607 if (!item->commit || item->command == TODO_DROP) {
4608 subjects[i] = NULL;
4609 continue;
4612 if (is_fixup(item->command)) {
4613 todo_list_release(&todo_list);
4614 clear_commit_todo_item(&commit_todo);
4615 return error(_("the script was already rearranged."));
4618 *commit_todo_item_at(&commit_todo, item->commit) = item;
4620 parse_commit(item->commit);
4621 commit_buffer = get_commit_buffer(item->commit, NULL);
4622 find_commit_subject(commit_buffer, &subject);
4623 format_subject(&buf, subject, " ");
4624 subject = subjects[i] = strbuf_detach(&buf, &subject_len);
4625 unuse_commit_buffer(item->commit, commit_buffer);
4626 if ((skip_prefix(subject, "fixup! ", &p) ||
4627 skip_prefix(subject, "squash! ", &p))) {
4628 struct commit *commit2;
4630 for (;;) {
4631 while (isspace(*p))
4632 p++;
4633 if (!skip_prefix(p, "fixup! ", &p) &&
4634 !skip_prefix(p, "squash! ", &p))
4635 break;
4638 if ((entry = hashmap_get_from_hash(&subject2item,
4639 strhash(p), p)))
4640 /* found by title */
4641 i2 = entry->i;
4642 else if (!strchr(p, ' ') &&
4643 (commit2 =
4644 lookup_commit_reference_by_name(p)) &&
4645 *commit_todo_item_at(&commit_todo, commit2))
4646 /* found by commit name */
4647 i2 = *commit_todo_item_at(&commit_todo, commit2)
4648 - todo_list.items;
4649 else {
4650 /* copy can be a prefix of the commit subject */
4651 for (i2 = 0; i2 < i; i2++)
4652 if (subjects[i2] &&
4653 starts_with(subjects[i2], p))
4654 break;
4655 if (i2 == i)
4656 i2 = -1;
4659 if (i2 >= 0) {
4660 rearranged = 1;
4661 todo_list.items[i].command =
4662 starts_with(subject, "fixup!") ?
4663 TODO_FIXUP : TODO_SQUASH;
4664 if (next[i2] < 0)
4665 next[i2] = i;
4666 else
4667 next[tail[i2]] = i;
4668 tail[i2] = i;
4669 } else if (!hashmap_get_from_hash(&subject2item,
4670 strhash(subject), subject)) {
4671 FLEX_ALLOC_MEM(entry, subject, subject, subject_len);
4672 entry->i = i;
4673 hashmap_entry_init(entry, strhash(entry->subject));
4674 hashmap_put(&subject2item, entry);
4678 if (rearranged) {
4679 struct strbuf buf = STRBUF_INIT;
4681 for (i = 0; i < todo_list.nr; i++) {
4682 enum todo_command command = todo_list.items[i].command;
4683 int cur = i;
4686 * Initially, all commands are 'pick's. If it is a
4687 * fixup or a squash now, we have rearranged it.
4689 if (is_fixup(command))
4690 continue;
4692 while (cur >= 0) {
4693 const char *bol =
4694 get_item_line(&todo_list, cur);
4695 const char *eol =
4696 get_item_line(&todo_list, cur + 1);
4698 /* replace 'pick', by 'fixup' or 'squash' */
4699 command = todo_list.items[cur].command;
4700 if (is_fixup(command)) {
4701 strbuf_addstr(&buf,
4702 todo_command_info[command].str);
4703 bol += strcspn(bol, " \t");
4706 strbuf_add(&buf, bol, eol - bol);
4708 cur = next[cur];
4712 res = rewrite_file(todo_file, buf.buf, buf.len);
4713 strbuf_release(&buf);
4716 free(next);
4717 free(tail);
4718 for (i = 0; i < todo_list.nr; i++)
4719 free(subjects[i]);
4720 free(subjects);
4721 hashmap_free(&subject2item, 1);
4722 todo_list_release(&todo_list);
4724 clear_commit_todo_item(&commit_todo);
4725 return res;