rebase: fill `squash_onto' in get_replay_opts()
[git] / sequencer.c
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"
33 #include "commit-reach.h"
34 #include "rebase-interactive.h"
35
36 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
37
38 static const char sign_off_header[] = "Signed-off-by: ";
39 static const char cherry_picked_prefix[] = "(cherry picked from commit ";
40
41 GIT_PATH_FUNC(git_path_commit_editmsg, "COMMIT_EDITMSG")
42
43 GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
44
45 static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
46 static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
47 static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
48 static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
49
50 static GIT_PATH_FUNC(rebase_path, "rebase-merge")
51 /*
52  * The file containing rebase commands, comments, and empty lines.
53  * This file is created by "git rebase -i" then edited by the user. As
54  * the lines are processed, they are removed from the front of this
55  * file and written to the tail of 'done'.
56  */
57 GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
58 GIT_PATH_FUNC(rebase_path_todo_backup, "rebase-merge/git-rebase-todo.backup")
59
60 /*
61  * The rebase command lines that have already been processed. A line
62  * is moved here when it is first handled, before any associated user
63  * actions.
64  */
65 static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
66 /*
67  * The file to keep track of how many commands were already processed (e.g.
68  * for the prompt).
69  */
70 static GIT_PATH_FUNC(rebase_path_msgnum, "rebase-merge/msgnum")
71 /*
72  * The file to keep track of how many commands are to be processed in total
73  * (e.g. for the prompt).
74  */
75 static GIT_PATH_FUNC(rebase_path_msgtotal, "rebase-merge/end")
76 /*
77  * The commit message that is planned to be used for any changes that
78  * need to be committed following a user interaction.
79  */
80 static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
81 /*
82  * The file into which is accumulated the suggested commit message for
83  * squash/fixup commands. When the first of a series of squash/fixups
84  * is seen, the file is created and the commit message from the
85  * previous commit and from the first squash/fixup commit are written
86  * to it. The commit message for each subsequent squash/fixup commit
87  * is appended to the file as it is processed.
88  */
89 static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
90 /*
91  * If the current series of squash/fixups has not yet included a squash
92  * command, then this file exists and holds the commit message of the
93  * original "pick" commit.  (If the series ends without a "squash"
94  * command, then this can be used as the commit message of the combined
95  * commit without opening the editor.)
96  */
97 static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
98 /*
99  * This file contains the list fixup/squash commands that have been
100  * accumulated into message-fixup or message-squash so far.
101  */
102 static GIT_PATH_FUNC(rebase_path_current_fixups, "rebase-merge/current-fixups")
103 /*
104  * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
105  * GIT_AUTHOR_DATE that will be used for the commit that is currently
106  * being rebased.
107  */
108 static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
109 /*
110  * When an "edit" rebase command is being processed, the SHA1 of the
111  * commit to be edited is recorded in this file.  When "git rebase
112  * --continue" is executed, if there are any staged changes then they
113  * will be amended to the HEAD commit, but only provided the HEAD
114  * commit is still the commit to be edited.  When any other rebase
115  * command is processed, this file is deleted.
116  */
117 static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
118 /*
119  * When we stop at a given patch via the "edit" command, this file contains
120  * the abbreviated commit name of the corresponding patch.
121  */
122 static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
123 /*
124  * For the post-rewrite hook, we make a list of rewritten commits and
125  * their new sha1s.  The rewritten-pending list keeps the sha1s of
126  * commits that have been processed, but not committed yet,
127  * e.g. because they are waiting for a 'squash' command.
128  */
129 static GIT_PATH_FUNC(rebase_path_rewritten_list, "rebase-merge/rewritten-list")
130 static GIT_PATH_FUNC(rebase_path_rewritten_pending,
131         "rebase-merge/rewritten-pending")
132
133 /*
134  * The path of the file containig the OID of the "squash onto" commit, i.e.
135  * the dummy commit used for `reset [new root]`.
136  */
137 static GIT_PATH_FUNC(rebase_path_squash_onto, "rebase-merge/squash-onto")
138
139 /*
140  * The path of the file listing refs that need to be deleted after the rebase
141  * finishes. This is used by the `label` command to record the need for cleanup.
142  */
143 static GIT_PATH_FUNC(rebase_path_refs_to_delete, "rebase-merge/refs-to-delete")
144
145 /*
146  * The following files are written by git-rebase just after parsing the
147  * command-line.
148  */
149 static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
150 static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
151 static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
152 static GIT_PATH_FUNC(rebase_path_quiet, "rebase-merge/quiet")
153 static GIT_PATH_FUNC(rebase_path_signoff, "rebase-merge/signoff")
154 static GIT_PATH_FUNC(rebase_path_head_name, "rebase-merge/head-name")
155 static GIT_PATH_FUNC(rebase_path_onto, "rebase-merge/onto")
156 static GIT_PATH_FUNC(rebase_path_autostash, "rebase-merge/autostash")
157 static GIT_PATH_FUNC(rebase_path_strategy, "rebase-merge/strategy")
158 static GIT_PATH_FUNC(rebase_path_strategy_opts, "rebase-merge/strategy_opts")
159 static GIT_PATH_FUNC(rebase_path_allow_rerere_autoupdate, "rebase-merge/allow_rerere_autoupdate")
160 static GIT_PATH_FUNC(rebase_path_reschedule_failed_exec, "rebase-merge/reschedule-failed-exec")
161
162 static int git_sequencer_config(const char *k, const char *v, void *cb)
163 {
164         struct replay_opts *opts = cb;
165         int status;
166
167         if (!strcmp(k, "commit.cleanup")) {
168                 const char *s;
169
170                 status = git_config_string(&s, k, v);
171                 if (status)
172                         return status;
173
174                 if (!strcmp(s, "verbatim")) {
175                         opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
176                         opts->explicit_cleanup = 1;
177                 } else if (!strcmp(s, "whitespace")) {
178                         opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SPACE;
179                         opts->explicit_cleanup = 1;
180                 } else if (!strcmp(s, "strip")) {
181                         opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_ALL;
182                         opts->explicit_cleanup = 1;
183                 } else if (!strcmp(s, "scissors")) {
184                         opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_SCISSORS;
185                         opts->explicit_cleanup = 1;
186                 } else {
187                         warning(_("invalid commit message cleanup mode '%s'"),
188                                   s);
189                 }
190
191                 free((char *)s);
192                 return status;
193         }
194
195         if (!strcmp(k, "commit.gpgsign")) {
196                 opts->gpg_sign = git_config_bool(k, v) ? xstrdup("") : NULL;
197                 return 0;
198         }
199
200         status = git_gpg_config(k, v, NULL);
201         if (status)
202                 return status;
203
204         return git_diff_basic_config(k, v, NULL);
205 }
206
207 void sequencer_init_config(struct replay_opts *opts)
208 {
209         opts->default_msg_cleanup = COMMIT_MSG_CLEANUP_NONE;
210         git_config(git_sequencer_config, opts);
211 }
212
213 static inline int is_rebase_i(const struct replay_opts *opts)
214 {
215         return opts->action == REPLAY_INTERACTIVE_REBASE;
216 }
217
218 static const char *get_dir(const struct replay_opts *opts)
219 {
220         if (is_rebase_i(opts))
221                 return rebase_path();
222         return git_path_seq_dir();
223 }
224
225 static const char *get_todo_path(const struct replay_opts *opts)
226 {
227         if (is_rebase_i(opts))
228                 return rebase_path_todo();
229         return git_path_todo_file();
230 }
231
232 /*
233  * Returns 0 for non-conforming footer
234  * Returns 1 for conforming footer
235  * Returns 2 when sob exists within conforming footer
236  * Returns 3 when sob exists within conforming footer as last entry
237  */
238 static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
239         size_t ignore_footer)
240 {
241         struct process_trailer_options opts = PROCESS_TRAILER_OPTIONS_INIT;
242         struct trailer_info info;
243         size_t i;
244         int found_sob = 0, found_sob_last = 0;
245
246         opts.no_divider = 1;
247
248         trailer_info_get(&info, sb->buf, &opts);
249
250         if (info.trailer_start == info.trailer_end)
251                 return 0;
252
253         for (i = 0; i < info.trailer_nr; i++)
254                 if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
255                         found_sob = 1;
256                         if (i == info.trailer_nr - 1)
257                                 found_sob_last = 1;
258                 }
259
260         trailer_info_release(&info);
261
262         if (found_sob_last)
263                 return 3;
264         if (found_sob)
265                 return 2;
266         return 1;
267 }
268
269 static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
270 {
271         static struct strbuf buf = STRBUF_INIT;
272
273         strbuf_reset(&buf);
274         if (opts->gpg_sign)
275                 sq_quotef(&buf, "-S%s", opts->gpg_sign);
276         return buf.buf;
277 }
278
279 int sequencer_remove_state(struct replay_opts *opts)
280 {
281         struct strbuf buf = STRBUF_INIT;
282         int i, ret = 0;
283
284         if (is_rebase_i(opts) &&
285             strbuf_read_file(&buf, rebase_path_refs_to_delete(), 0) > 0) {
286                 char *p = buf.buf;
287                 while (*p) {
288                         char *eol = strchr(p, '\n');
289                         if (eol)
290                                 *eol = '\0';
291                         if (delete_ref("(rebase -i) cleanup", p, NULL, 0) < 0) {
292                                 warning(_("could not delete '%s'"), p);
293                                 ret = -1;
294                         }
295                         if (!eol)
296                                 break;
297                         p = eol + 1;
298                 }
299         }
300
301         free(opts->gpg_sign);
302         free(opts->strategy);
303         for (i = 0; i < opts->xopts_nr; i++)
304                 free(opts->xopts[i]);
305         free(opts->xopts);
306         strbuf_release(&opts->current_fixups);
307
308         strbuf_reset(&buf);
309         strbuf_addstr(&buf, get_dir(opts));
310         if (remove_dir_recursively(&buf, 0))
311                 ret = error(_("could not remove '%s'"), buf.buf);
312         strbuf_release(&buf);
313
314         return ret;
315 }
316
317 static const char *action_name(const struct replay_opts *opts)
318 {
319         switch (opts->action) {
320         case REPLAY_REVERT:
321                 return N_("revert");
322         case REPLAY_PICK:
323                 return N_("cherry-pick");
324         case REPLAY_INTERACTIVE_REBASE:
325                 return N_("rebase -i");
326         }
327         die(_("unknown action: %d"), opts->action);
328 }
329
330 struct commit_message {
331         char *parent_label;
332         char *label;
333         char *subject;
334         const char *message;
335 };
336
337 static const char *short_commit_name(struct commit *commit)
338 {
339         return find_unique_abbrev(&commit->object.oid, DEFAULT_ABBREV);
340 }
341
342 static int get_message(struct commit *commit, struct commit_message *out)
343 {
344         const char *abbrev, *subject;
345         int subject_len;
346
347         out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
348         abbrev = short_commit_name(commit);
349
350         subject_len = find_commit_subject(out->message, &subject);
351
352         out->subject = xmemdupz(subject, subject_len);
353         out->label = xstrfmt("%s... %s", abbrev, out->subject);
354         out->parent_label = xstrfmt("parent of %s", out->label);
355
356         return 0;
357 }
358
359 static void free_message(struct commit *commit, struct commit_message *msg)
360 {
361         free(msg->parent_label);
362         free(msg->label);
363         free(msg->subject);
364         unuse_commit_buffer(commit, msg->message);
365 }
366
367 static void print_advice(struct repository *r, int show_hint,
368                          struct replay_opts *opts)
369 {
370         char *msg = getenv("GIT_CHERRY_PICK_HELP");
371
372         if (msg) {
373                 fprintf(stderr, "%s\n", msg);
374                 /*
375                  * A conflict has occurred but the porcelain
376                  * (typically rebase --interactive) wants to take care
377                  * of the commit itself so remove CHERRY_PICK_HEAD
378                  */
379                 unlink(git_path_cherry_pick_head(r));
380                 return;
381         }
382
383         if (show_hint) {
384                 if (opts->no_commit)
385                         advise(_("after resolving the conflicts, mark the corrected paths\n"
386                                  "with 'git add <paths>' or 'git rm <paths>'"));
387                 else
388                         advise(_("after resolving the conflicts, mark the corrected paths\n"
389                                  "with 'git add <paths>' or 'git rm <paths>'\n"
390                                  "and commit the result with 'git commit'"));
391         }
392 }
393
394 static int write_message(const void *buf, size_t len, const char *filename,
395                          int append_eol)
396 {
397         struct lock_file msg_file = LOCK_INIT;
398
399         int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
400         if (msg_fd < 0)
401                 return error_errno(_("could not lock '%s'"), filename);
402         if (write_in_full(msg_fd, buf, len) < 0) {
403                 error_errno(_("could not write to '%s'"), filename);
404                 rollback_lock_file(&msg_file);
405                 return -1;
406         }
407         if (append_eol && write(msg_fd, "\n", 1) < 0) {
408                 error_errno(_("could not write eol to '%s'"), filename);
409                 rollback_lock_file(&msg_file);
410                 return -1;
411         }
412         if (commit_lock_file(&msg_file) < 0)
413                 return error(_("failed to finalize '%s'"), filename);
414
415         return 0;
416 }
417
418 /*
419  * Reads a file that was presumably written by a shell script, i.e. with an
420  * end-of-line marker that needs to be stripped.
421  *
422  * Note that only the last end-of-line marker is stripped, consistent with the
423  * behavior of "$(cat path)" in a shell script.
424  *
425  * Returns 1 if the file was read, 0 if it could not be read or does not exist.
426  */
427 static int read_oneliner(struct strbuf *buf,
428         const char *path, int skip_if_empty)
429 {
430         int orig_len = buf->len;
431
432         if (!file_exists(path))
433                 return 0;
434
435         if (strbuf_read_file(buf, path, 0) < 0) {
436                 warning_errno(_("could not read '%s'"), path);
437                 return 0;
438         }
439
440         if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
441                 if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
442                         --buf->len;
443                 buf->buf[buf->len] = '\0';
444         }
445
446         if (skip_if_empty && buf->len == orig_len)
447                 return 0;
448
449         return 1;
450 }
451
452 static struct tree *empty_tree(struct repository *r)
453 {
454         return lookup_tree(r, the_hash_algo->empty_tree);
455 }
456
457 static int error_dirty_index(struct repository *repo, struct replay_opts *opts)
458 {
459         if (repo_read_index_unmerged(repo))
460                 return error_resolve_conflict(_(action_name(opts)));
461
462         error(_("your local changes would be overwritten by %s."),
463                 _(action_name(opts)));
464
465         if (advice_commit_before_merge)
466                 advise(_("commit your changes or stash them to proceed."));
467         return -1;
468 }
469
470 static void update_abort_safety_file(void)
471 {
472         struct object_id head;
473
474         /* Do nothing on a single-pick */
475         if (!file_exists(git_path_seq_dir()))
476                 return;
477
478         if (!get_oid("HEAD", &head))
479                 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
480         else
481                 write_file(git_path_abort_safety_file(), "%s", "");
482 }
483
484 static int fast_forward_to(struct repository *r,
485                            const struct object_id *to,
486                            const struct object_id *from,
487                            int unborn,
488                            struct replay_opts *opts)
489 {
490         struct ref_transaction *transaction;
491         struct strbuf sb = STRBUF_INIT;
492         struct strbuf err = STRBUF_INIT;
493
494         repo_read_index(r);
495         if (checkout_fast_forward(r, from, to, 1))
496                 return -1; /* the callee should have complained already */
497
498         strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
499
500         transaction = ref_transaction_begin(&err);
501         if (!transaction ||
502             ref_transaction_update(transaction, "HEAD",
503                                    to, unborn && !is_rebase_i(opts) ?
504                                    &null_oid : from,
505                                    0, sb.buf, &err) ||
506             ref_transaction_commit(transaction, &err)) {
507                 ref_transaction_free(transaction);
508                 error("%s", err.buf);
509                 strbuf_release(&sb);
510                 strbuf_release(&err);
511                 return -1;
512         }
513
514         strbuf_release(&sb);
515         strbuf_release(&err);
516         ref_transaction_free(transaction);
517         update_abort_safety_file();
518         return 0;
519 }
520
521 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
522         int use_editor)
523 {
524         if (!cleanup_arg || !strcmp(cleanup_arg, "default"))
525                 return use_editor ? COMMIT_MSG_CLEANUP_ALL :
526                                     COMMIT_MSG_CLEANUP_SPACE;
527         else if (!strcmp(cleanup_arg, "verbatim"))
528                 return COMMIT_MSG_CLEANUP_NONE;
529         else if (!strcmp(cleanup_arg, "whitespace"))
530                 return COMMIT_MSG_CLEANUP_SPACE;
531         else if (!strcmp(cleanup_arg, "strip"))
532                 return COMMIT_MSG_CLEANUP_ALL;
533         else if (!strcmp(cleanup_arg, "scissors"))
534                 return use_editor ? COMMIT_MSG_CLEANUP_SCISSORS :
535                                     COMMIT_MSG_CLEANUP_SPACE;
536         else
537                 die(_("Invalid cleanup mode %s"), cleanup_arg);
538 }
539
540 /*
541  * NB using int rather than enum cleanup_mode to stop clang's
542  * -Wtautological-constant-out-of-range-compare complaining that the comparison
543  * is always true.
544  */
545 static const char *describe_cleanup_mode(int cleanup_mode)
546 {
547         static const char *modes[] = { "whitespace",
548                                        "verbatim",
549                                        "scissors",
550                                        "strip" };
551
552         if (cleanup_mode < ARRAY_SIZE(modes))
553                 return modes[cleanup_mode];
554
555         BUG("invalid cleanup_mode provided (%d)", cleanup_mode);
556 }
557
558 void append_conflicts_hint(struct index_state *istate,
559         struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode)
560 {
561         int i;
562
563         if (cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS) {
564                 strbuf_addch(msgbuf, '\n');
565                 wt_status_append_cut_line(msgbuf);
566                 strbuf_addch(msgbuf, comment_line_char);
567         }
568
569         strbuf_addch(msgbuf, '\n');
570         strbuf_commented_addf(msgbuf, "Conflicts:\n");
571         for (i = 0; i < istate->cache_nr;) {
572                 const struct cache_entry *ce = istate->cache[i++];
573                 if (ce_stage(ce)) {
574                         strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
575                         while (i < istate->cache_nr &&
576                                !strcmp(ce->name, istate->cache[i]->name))
577                                 i++;
578                 }
579         }
580 }
581
582 static int do_recursive_merge(struct repository *r,
583                               struct commit *base, struct commit *next,
584                               const char *base_label, const char *next_label,
585                               struct object_id *head, struct strbuf *msgbuf,
586                               struct replay_opts *opts)
587 {
588         struct merge_options o;
589         struct tree *result, *next_tree, *base_tree, *head_tree;
590         int clean;
591         char **xopt;
592         struct lock_file index_lock = LOCK_INIT;
593
594         if (repo_hold_locked_index(r, &index_lock, LOCK_REPORT_ON_ERROR) < 0)
595                 return -1;
596
597         repo_read_index(r);
598
599         init_merge_options(&o, r);
600         o.ancestor = base ? base_label : "(empty tree)";
601         o.branch1 = "HEAD";
602         o.branch2 = next ? next_label : "(empty tree)";
603         if (is_rebase_i(opts))
604                 o.buffer_output = 2;
605         o.show_rename_progress = 1;
606
607         head_tree = parse_tree_indirect(head);
608         next_tree = next ? get_commit_tree(next) : empty_tree(r);
609         base_tree = base ? get_commit_tree(base) : empty_tree(r);
610
611         for (xopt = opts->xopts; xopt != opts->xopts + opts->xopts_nr; xopt++)
612                 parse_merge_opt(&o, *xopt);
613
614         clean = merge_trees(&o,
615                             head_tree,
616                             next_tree, base_tree, &result);
617         if (is_rebase_i(opts) && clean <= 0)
618                 fputs(o.obuf.buf, stdout);
619         strbuf_release(&o.obuf);
620         diff_warn_rename_limit("merge.renamelimit", o.needed_rename_limit, 0);
621         if (clean < 0) {
622                 rollback_lock_file(&index_lock);
623                 return clean;
624         }
625
626         if (write_locked_index(r->index, &index_lock,
627                                COMMIT_LOCK | SKIP_IF_UNCHANGED))
628                 /*
629                  * TRANSLATORS: %s will be "revert", "cherry-pick" or
630                  * "rebase -i".
631                  */
632                 return error(_("%s: Unable to write new index file"),
633                         _(action_name(opts)));
634
635         if (!clean)
636                 append_conflicts_hint(r->index, msgbuf,
637                                       opts->default_msg_cleanup);
638
639         return !clean;
640 }
641
642 static struct object_id *get_cache_tree_oid(struct index_state *istate)
643 {
644         if (!istate->cache_tree)
645                 istate->cache_tree = cache_tree();
646
647         if (!cache_tree_fully_valid(istate->cache_tree))
648                 if (cache_tree_update(istate, 0)) {
649                         error(_("unable to update cache tree"));
650                         return NULL;
651                 }
652
653         return &istate->cache_tree->oid;
654 }
655
656 static int is_index_unchanged(struct repository *r)
657 {
658         struct object_id head_oid, *cache_tree_oid;
659         struct commit *head_commit;
660         struct index_state *istate = r->index;
661
662         if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, &head_oid, NULL))
663                 return error(_("could not resolve HEAD commit"));
664
665         head_commit = lookup_commit(r, &head_oid);
666
667         /*
668          * If head_commit is NULL, check_commit, called from
669          * lookup_commit, would have indicated that head_commit is not
670          * a commit object already.  parse_commit() will return failure
671          * without further complaints in such a case.  Otherwise, if
672          * the commit is invalid, parse_commit() will complain.  So
673          * there is nothing for us to say here.  Just return failure.
674          */
675         if (parse_commit(head_commit))
676                 return -1;
677
678         if (!(cache_tree_oid = get_cache_tree_oid(istate)))
679                 return -1;
680
681         return oideq(cache_tree_oid, get_commit_tree_oid(head_commit));
682 }
683
684 static int write_author_script(const char *message)
685 {
686         struct strbuf buf = STRBUF_INIT;
687         const char *eol;
688         int res;
689
690         for (;;)
691                 if (!*message || starts_with(message, "\n")) {
692 missing_author:
693                         /* Missing 'author' line? */
694                         unlink(rebase_path_author_script());
695                         return 0;
696                 } else if (skip_prefix(message, "author ", &message))
697                         break;
698                 else if ((eol = strchr(message, '\n')))
699                         message = eol + 1;
700                 else
701                         goto missing_author;
702
703         strbuf_addstr(&buf, "GIT_AUTHOR_NAME='");
704         while (*message && *message != '\n' && *message != '\r')
705                 if (skip_prefix(message, " <", &message))
706                         break;
707                 else if (*message != '\'')
708                         strbuf_addch(&buf, *(message++));
709                 else
710                         strbuf_addf(&buf, "'\\%c'", *(message++));
711         strbuf_addstr(&buf, "'\nGIT_AUTHOR_EMAIL='");
712         while (*message && *message != '\n' && *message != '\r')
713                 if (skip_prefix(message, "> ", &message))
714                         break;
715                 else if (*message != '\'')
716                         strbuf_addch(&buf, *(message++));
717                 else
718                         strbuf_addf(&buf, "'\\%c'", *(message++));
719         strbuf_addstr(&buf, "'\nGIT_AUTHOR_DATE='@");
720         while (*message && *message != '\n' && *message != '\r')
721                 if (*message != '\'')
722                         strbuf_addch(&buf, *(message++));
723                 else
724                         strbuf_addf(&buf, "'\\%c'", *(message++));
725         strbuf_addch(&buf, '\'');
726         res = write_message(buf.buf, buf.len, rebase_path_author_script(), 1);
727         strbuf_release(&buf);
728         return res;
729 }
730
731 /**
732  * Take a series of KEY='VALUE' lines where VALUE part is
733  * sq-quoted, and append <KEY, VALUE> at the end of the string list
734  */
735 static int parse_key_value_squoted(char *buf, struct string_list *list)
736 {
737         while (*buf) {
738                 struct string_list_item *item;
739                 char *np;
740                 char *cp = strchr(buf, '=');
741                 if (!cp) {
742                         np = strchrnul(buf, '\n');
743                         return error(_("no key present in '%.*s'"),
744                                      (int) (np - buf), buf);
745                 }
746                 np = strchrnul(cp, '\n');
747                 *cp++ = '\0';
748                 item = string_list_append(list, buf);
749
750                 buf = np + (*np == '\n');
751                 *np = '\0';
752                 cp = sq_dequote(cp);
753                 if (!cp)
754                         return error(_("unable to dequote value of '%s'"),
755                                      item->string);
756                 item->util = xstrdup(cp);
757         }
758         return 0;
759 }
760
761 /**
762  * Reads and parses the state directory's "author-script" file, and sets name,
763  * email and date accordingly.
764  * Returns 0 on success, -1 if the file could not be parsed.
765  *
766  * The author script is of the format:
767  *
768  *      GIT_AUTHOR_NAME='$author_name'
769  *      GIT_AUTHOR_EMAIL='$author_email'
770  *      GIT_AUTHOR_DATE='$author_date'
771  *
772  * where $author_name, $author_email and $author_date are quoted. We are strict
773  * with our parsing, as the file was meant to be eval'd in the now-removed
774  * git-am.sh/git-rebase--interactive.sh scripts, and thus if the file differs
775  * from what this function expects, it is better to bail out than to do
776  * something that the user does not expect.
777  */
778 int read_author_script(const char *path, char **name, char **email, char **date,
779                        int allow_missing)
780 {
781         struct strbuf buf = STRBUF_INIT;
782         struct string_list kv = STRING_LIST_INIT_DUP;
783         int retval = -1; /* assume failure */
784         int i, name_i = -2, email_i = -2, date_i = -2, err = 0;
785
786         if (strbuf_read_file(&buf, path, 256) <= 0) {
787                 strbuf_release(&buf);
788                 if (errno == ENOENT && allow_missing)
789                         return 0;
790                 else
791                         return error_errno(_("could not open '%s' for reading"),
792                                            path);
793         }
794
795         if (parse_key_value_squoted(buf.buf, &kv))
796                 goto finish;
797
798         for (i = 0; i < kv.nr; i++) {
799                 if (!strcmp(kv.items[i].string, "GIT_AUTHOR_NAME")) {
800                         if (name_i != -2)
801                                 name_i = error(_("'GIT_AUTHOR_NAME' already given"));
802                         else
803                                 name_i = i;
804                 } else if (!strcmp(kv.items[i].string, "GIT_AUTHOR_EMAIL")) {
805                         if (email_i != -2)
806                                 email_i = error(_("'GIT_AUTHOR_EMAIL' already given"));
807                         else
808                                 email_i = i;
809                 } else if (!strcmp(kv.items[i].string, "GIT_AUTHOR_DATE")) {
810                         if (date_i != -2)
811                                 date_i = error(_("'GIT_AUTHOR_DATE' already given"));
812                         else
813                                 date_i = i;
814                 } else {
815                         err = error(_("unknown variable '%s'"),
816                                     kv.items[i].string);
817                 }
818         }
819         if (name_i == -2)
820                 error(_("missing 'GIT_AUTHOR_NAME'"));
821         if (email_i == -2)
822                 error(_("missing 'GIT_AUTHOR_EMAIL'"));
823         if (date_i == -2)
824                 error(_("missing 'GIT_AUTHOR_DATE'"));
825         if (date_i < 0 || email_i < 0 || date_i < 0 || err)
826                 goto finish;
827         *name = kv.items[name_i].util;
828         *email = kv.items[email_i].util;
829         *date = kv.items[date_i].util;
830         retval = 0;
831 finish:
832         string_list_clear(&kv, !!retval);
833         strbuf_release(&buf);
834         return retval;
835 }
836
837 /*
838  * Read a GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL AND GIT_AUTHOR_DATE from a
839  * file with shell quoting into struct argv_array. Returns -1 on
840  * error, 0 otherwise.
841  */
842 static int read_env_script(struct argv_array *env)
843 {
844         char *name, *email, *date;
845
846         if (read_author_script(rebase_path_author_script(),
847                                &name, &email, &date, 0))
848                 return -1;
849
850         argv_array_pushf(env, "GIT_AUTHOR_NAME=%s", name);
851         argv_array_pushf(env, "GIT_AUTHOR_EMAIL=%s", email);
852         argv_array_pushf(env, "GIT_AUTHOR_DATE=%s", date);
853         free(name);
854         free(email);
855         free(date);
856
857         return 0;
858 }
859
860 static char *get_author(const char *message)
861 {
862         size_t len;
863         const char *a;
864
865         a = find_commit_header(message, "author", &len);
866         if (a)
867                 return xmemdupz(a, len);
868
869         return NULL;
870 }
871
872 /* Read author-script and return an ident line (author <email> timestamp) */
873 static const char *read_author_ident(struct strbuf *buf)
874 {
875         struct strbuf out = STRBUF_INIT;
876         char *name, *email, *date;
877
878         if (read_author_script(rebase_path_author_script(),
879                                &name, &email, &date, 0))
880                 return NULL;
881
882         /* validate date since fmt_ident() will die() on bad value */
883         if (parse_date(date, &out)){
884                 warning(_("invalid date format '%s' in '%s'"),
885                         date, rebase_path_author_script());
886                 strbuf_release(&out);
887                 return NULL;
888         }
889
890         strbuf_reset(&out);
891         strbuf_addstr(&out, fmt_ident(name, email, WANT_AUTHOR_IDENT, date, 0));
892         strbuf_swap(buf, &out);
893         strbuf_release(&out);
894         free(name);
895         free(email);
896         free(date);
897         return buf->buf;
898 }
899
900 static const char staged_changes_advice[] =
901 N_("you have staged changes in your working tree\n"
902 "If these changes are meant to be squashed into the previous commit, run:\n"
903 "\n"
904 "  git commit --amend %s\n"
905 "\n"
906 "If they are meant to go into a new commit, run:\n"
907 "\n"
908 "  git commit %s\n"
909 "\n"
910 "In both cases, once you're done, continue with:\n"
911 "\n"
912 "  git rebase --continue\n");
913
914 #define ALLOW_EMPTY (1<<0)
915 #define EDIT_MSG    (1<<1)
916 #define AMEND_MSG   (1<<2)
917 #define CLEANUP_MSG (1<<3)
918 #define VERIFY_MSG  (1<<4)
919 #define CREATE_ROOT_COMMIT (1<<5)
920
921 static int run_command_silent_on_success(struct child_process *cmd)
922 {
923         struct strbuf buf = STRBUF_INIT;
924         int rc;
925
926         cmd->stdout_to_stderr = 1;
927         rc = pipe_command(cmd,
928                           NULL, 0,
929                           NULL, 0,
930                           &buf, 0);
931
932         if (rc)
933                 fputs(buf.buf, stderr);
934         strbuf_release(&buf);
935         return rc;
936 }
937
938 /*
939  * If we are cherry-pick, and if the merge did not result in
940  * hand-editing, we will hit this commit and inherit the original
941  * author date and name.
942  *
943  * If we are revert, or if our cherry-pick results in a hand merge,
944  * we had better say that the current user is responsible for that.
945  *
946  * An exception is when run_git_commit() is called during an
947  * interactive rebase: in that case, we will want to retain the
948  * author metadata.
949  */
950 static int run_git_commit(struct repository *r,
951                           const char *defmsg,
952                           struct replay_opts *opts,
953                           unsigned int flags)
954 {
955         struct child_process cmd = CHILD_PROCESS_INIT;
956
957         if ((flags & CREATE_ROOT_COMMIT) && !(flags & AMEND_MSG)) {
958                 struct strbuf msg = STRBUF_INIT, script = STRBUF_INIT;
959                 const char *author = NULL;
960                 struct object_id root_commit, *cache_tree_oid;
961                 int res = 0;
962
963                 if (is_rebase_i(opts)) {
964                         author = read_author_ident(&script);
965                         if (!author) {
966                                 strbuf_release(&script);
967                                 return -1;
968                         }
969                 }
970
971                 if (!defmsg)
972                         BUG("root commit without message");
973
974                 if (!(cache_tree_oid = get_cache_tree_oid(r->index)))
975                         res = -1;
976
977                 if (!res)
978                         res = strbuf_read_file(&msg, defmsg, 0);
979
980                 if (res <= 0)
981                         res = error_errno(_("could not read '%s'"), defmsg);
982                 else
983                         res = commit_tree(msg.buf, msg.len, cache_tree_oid,
984                                           NULL, &root_commit, author,
985                                           opts->gpg_sign);
986
987                 strbuf_release(&msg);
988                 strbuf_release(&script);
989                 if (!res) {
990                         update_ref(NULL, "CHERRY_PICK_HEAD", &root_commit, NULL,
991                                    REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR);
992                         res = update_ref(NULL, "HEAD", &root_commit, NULL, 0,
993                                          UPDATE_REFS_MSG_ON_ERR);
994                 }
995                 return res < 0 ? error(_("writing root commit")) : 0;
996         }
997
998         cmd.git_cmd = 1;
999
1000         if (is_rebase_i(opts) && read_env_script(&cmd.env_array)) {
1001                 const char *gpg_opt = gpg_sign_opt_quoted(opts);
1002
1003                 return error(_(staged_changes_advice),
1004                              gpg_opt, gpg_opt);
1005         }
1006
1007         argv_array_push(&cmd.args, "commit");
1008
1009         if (!(flags & VERIFY_MSG))
1010                 argv_array_push(&cmd.args, "-n");
1011         if ((flags & AMEND_MSG))
1012                 argv_array_push(&cmd.args, "--amend");
1013         if (opts->gpg_sign)
1014                 argv_array_pushf(&cmd.args, "-S%s", opts->gpg_sign);
1015         if (defmsg)
1016                 argv_array_pushl(&cmd.args, "-F", defmsg, NULL);
1017         else if (!(flags & EDIT_MSG))
1018                 argv_array_pushl(&cmd.args, "-C", "HEAD", NULL);
1019         if ((flags & CLEANUP_MSG))
1020                 argv_array_push(&cmd.args, "--cleanup=strip");
1021         if ((flags & EDIT_MSG))
1022                 argv_array_push(&cmd.args, "-e");
1023         else if (!(flags & CLEANUP_MSG) &&
1024                  !opts->signoff && !opts->record_origin &&
1025                  !opts->explicit_cleanup)
1026                 argv_array_push(&cmd.args, "--cleanup=verbatim");
1027
1028         if ((flags & ALLOW_EMPTY))
1029                 argv_array_push(&cmd.args, "--allow-empty");
1030
1031         if (!(flags & EDIT_MSG))
1032                 argv_array_push(&cmd.args, "--allow-empty-message");
1033
1034         if (is_rebase_i(opts) && !(flags & EDIT_MSG))
1035                 return run_command_silent_on_success(&cmd);
1036         else
1037                 return run_command(&cmd);
1038 }
1039
1040 static int rest_is_empty(const struct strbuf *sb, int start)
1041 {
1042         int i, eol;
1043         const char *nl;
1044
1045         /* Check if the rest is just whitespace and Signed-off-by's. */
1046         for (i = start; i < sb->len; i++) {
1047                 nl = memchr(sb->buf + i, '\n', sb->len - i);
1048                 if (nl)
1049                         eol = nl - sb->buf;
1050                 else
1051                         eol = sb->len;
1052
1053                 if (strlen(sign_off_header) <= eol - i &&
1054                     starts_with(sb->buf + i, sign_off_header)) {
1055                         i = eol;
1056                         continue;
1057                 }
1058                 while (i < eol)
1059                         if (!isspace(sb->buf[i++]))
1060                                 return 0;
1061         }
1062
1063         return 1;
1064 }
1065
1066 void cleanup_message(struct strbuf *msgbuf,
1067         enum commit_msg_cleanup_mode cleanup_mode, int verbose)
1068 {
1069         if (verbose || /* Truncate the message just before the diff, if any. */
1070             cleanup_mode == COMMIT_MSG_CLEANUP_SCISSORS)
1071                 strbuf_setlen(msgbuf, wt_status_locate_end(msgbuf->buf, msgbuf->len));
1072         if (cleanup_mode != COMMIT_MSG_CLEANUP_NONE)
1073                 strbuf_stripspace(msgbuf, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
1074 }
1075
1076 /*
1077  * Find out if the message in the strbuf contains only whitespace and
1078  * Signed-off-by lines.
1079  */
1080 int message_is_empty(const struct strbuf *sb,
1081                      enum commit_msg_cleanup_mode cleanup_mode)
1082 {
1083         if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
1084                 return 0;
1085         return rest_is_empty(sb, 0);
1086 }
1087
1088 /*
1089  * See if the user edited the message in the editor or left what
1090  * was in the template intact
1091  */
1092 int template_untouched(const struct strbuf *sb, const char *template_file,
1093                        enum commit_msg_cleanup_mode cleanup_mode)
1094 {
1095         struct strbuf tmpl = STRBUF_INIT;
1096         const char *start;
1097
1098         if (cleanup_mode == COMMIT_MSG_CLEANUP_NONE && sb->len)
1099                 return 0;
1100
1101         if (!template_file || strbuf_read_file(&tmpl, template_file, 0) <= 0)
1102                 return 0;
1103
1104         strbuf_stripspace(&tmpl, cleanup_mode == COMMIT_MSG_CLEANUP_ALL);
1105         if (!skip_prefix(sb->buf, tmpl.buf, &start))
1106                 start = sb->buf;
1107         strbuf_release(&tmpl);
1108         return rest_is_empty(sb, start - sb->buf);
1109 }
1110
1111 int update_head_with_reflog(const struct commit *old_head,
1112                             const struct object_id *new_head,
1113                             const char *action, const struct strbuf *msg,
1114                             struct strbuf *err)
1115 {
1116         struct ref_transaction *transaction;
1117         struct strbuf sb = STRBUF_INIT;
1118         const char *nl;
1119         int ret = 0;
1120
1121         if (action) {
1122                 strbuf_addstr(&sb, action);
1123                 strbuf_addstr(&sb, ": ");
1124         }
1125
1126         nl = strchr(msg->buf, '\n');
1127         if (nl) {
1128                 strbuf_add(&sb, msg->buf, nl + 1 - msg->buf);
1129         } else {
1130                 strbuf_addbuf(&sb, msg);
1131                 strbuf_addch(&sb, '\n');
1132         }
1133
1134         transaction = ref_transaction_begin(err);
1135         if (!transaction ||
1136             ref_transaction_update(transaction, "HEAD", new_head,
1137                                    old_head ? &old_head->object.oid : &null_oid,
1138                                    0, sb.buf, err) ||
1139             ref_transaction_commit(transaction, err)) {
1140                 ret = -1;
1141         }
1142         ref_transaction_free(transaction);
1143         strbuf_release(&sb);
1144
1145         return ret;
1146 }
1147
1148 static int run_rewrite_hook(const struct object_id *oldoid,
1149                             const struct object_id *newoid)
1150 {
1151         struct child_process proc = CHILD_PROCESS_INIT;
1152         const char *argv[3];
1153         int code;
1154         struct strbuf sb = STRBUF_INIT;
1155
1156         argv[0] = find_hook("post-rewrite");
1157         if (!argv[0])
1158                 return 0;
1159
1160         argv[1] = "amend";
1161         argv[2] = NULL;
1162
1163         proc.argv = argv;
1164         proc.in = -1;
1165         proc.stdout_to_stderr = 1;
1166         proc.trace2_hook_name = "post-rewrite";
1167
1168         code = start_command(&proc);
1169         if (code)
1170                 return code;
1171         strbuf_addf(&sb, "%s %s\n", oid_to_hex(oldoid), oid_to_hex(newoid));
1172         sigchain_push(SIGPIPE, SIG_IGN);
1173         write_in_full(proc.in, sb.buf, sb.len);
1174         close(proc.in);
1175         strbuf_release(&sb);
1176         sigchain_pop(SIGPIPE);
1177         return finish_command(&proc);
1178 }
1179
1180 void commit_post_rewrite(struct repository *r,
1181                          const struct commit *old_head,
1182                          const struct object_id *new_head)
1183 {
1184         struct notes_rewrite_cfg *cfg;
1185
1186         cfg = init_copy_notes_for_rewrite("amend");
1187         if (cfg) {
1188                 /* we are amending, so old_head is not NULL */
1189                 copy_note_for_rewrite(cfg, &old_head->object.oid, new_head);
1190                 finish_copy_notes_for_rewrite(r, cfg, "Notes added by 'git commit --amend'");
1191         }
1192         run_rewrite_hook(&old_head->object.oid, new_head);
1193 }
1194
1195 static int run_prepare_commit_msg_hook(struct repository *r,
1196                                        struct strbuf *msg,
1197                                        const char *commit)
1198 {
1199         struct argv_array hook_env = ARGV_ARRAY_INIT;
1200         int ret;
1201         const char *name;
1202
1203         name = git_path_commit_editmsg();
1204         if (write_message(msg->buf, msg->len, name, 0))
1205                 return -1;
1206
1207         argv_array_pushf(&hook_env, "GIT_INDEX_FILE=%s", r->index_file);
1208         argv_array_push(&hook_env, "GIT_EDITOR=:");
1209         if (commit)
1210                 ret = run_hook_le(hook_env.argv, "prepare-commit-msg", name,
1211                                   "commit", commit, NULL);
1212         else
1213                 ret = run_hook_le(hook_env.argv, "prepare-commit-msg", name,
1214                                   "message", NULL);
1215         if (ret)
1216                 ret = error(_("'prepare-commit-msg' hook failed"));
1217         argv_array_clear(&hook_env);
1218
1219         return ret;
1220 }
1221
1222 static const char implicit_ident_advice_noconfig[] =
1223 N_("Your name and email address were configured automatically based\n"
1224 "on your username and hostname. Please check that they are accurate.\n"
1225 "You can suppress this message by setting them explicitly. Run the\n"
1226 "following command and follow the instructions in your editor to edit\n"
1227 "your configuration file:\n"
1228 "\n"
1229 "    git config --global --edit\n"
1230 "\n"
1231 "After doing this, you may fix the identity used for this commit with:\n"
1232 "\n"
1233 "    git commit --amend --reset-author\n");
1234
1235 static const char implicit_ident_advice_config[] =
1236 N_("Your name and email address were configured automatically based\n"
1237 "on your username and hostname. Please check that they are accurate.\n"
1238 "You can suppress this message by setting them explicitly:\n"
1239 "\n"
1240 "    git config --global user.name \"Your Name\"\n"
1241 "    git config --global user.email you@example.com\n"
1242 "\n"
1243 "After doing this, you may fix the identity used for this commit with:\n"
1244 "\n"
1245 "    git commit --amend --reset-author\n");
1246
1247 static const char *implicit_ident_advice(void)
1248 {
1249         char *user_config = expand_user_path("~/.gitconfig", 0);
1250         char *xdg_config = xdg_config_home("config");
1251         int config_exists = file_exists(user_config) || file_exists(xdg_config);
1252
1253         free(user_config);
1254         free(xdg_config);
1255
1256         if (config_exists)
1257                 return _(implicit_ident_advice_config);
1258         else
1259                 return _(implicit_ident_advice_noconfig);
1260
1261 }
1262
1263 void print_commit_summary(struct repository *r,
1264                           const char *prefix,
1265                           const struct object_id *oid,
1266                           unsigned int flags)
1267 {
1268         struct rev_info rev;
1269         struct commit *commit;
1270         struct strbuf format = STRBUF_INIT;
1271         const char *head;
1272         struct pretty_print_context pctx = {0};
1273         struct strbuf author_ident = STRBUF_INIT;
1274         struct strbuf committer_ident = STRBUF_INIT;
1275
1276         commit = lookup_commit(r, oid);
1277         if (!commit)
1278                 die(_("couldn't look up newly created commit"));
1279         if (parse_commit(commit))
1280                 die(_("could not parse newly created commit"));
1281
1282         strbuf_addstr(&format, "format:%h] %s");
1283
1284         format_commit_message(commit, "%an <%ae>", &author_ident, &pctx);
1285         format_commit_message(commit, "%cn <%ce>", &committer_ident, &pctx);
1286         if (strbuf_cmp(&author_ident, &committer_ident)) {
1287                 strbuf_addstr(&format, "\n Author: ");
1288                 strbuf_addbuf_percentquote(&format, &author_ident);
1289         }
1290         if (flags & SUMMARY_SHOW_AUTHOR_DATE) {
1291                 struct strbuf date = STRBUF_INIT;
1292
1293                 format_commit_message(commit, "%ad", &date, &pctx);
1294                 strbuf_addstr(&format, "\n Date: ");
1295                 strbuf_addbuf_percentquote(&format, &date);
1296                 strbuf_release(&date);
1297         }
1298         if (!committer_ident_sufficiently_given()) {
1299                 strbuf_addstr(&format, "\n Committer: ");
1300                 strbuf_addbuf_percentquote(&format, &committer_ident);
1301                 if (advice_implicit_identity) {
1302                         strbuf_addch(&format, '\n');
1303                         strbuf_addstr(&format, implicit_ident_advice());
1304                 }
1305         }
1306         strbuf_release(&author_ident);
1307         strbuf_release(&committer_ident);
1308
1309         repo_init_revisions(r, &rev, prefix);
1310         setup_revisions(0, NULL, &rev, NULL);
1311
1312         rev.diff = 1;
1313         rev.diffopt.output_format =
1314                 DIFF_FORMAT_SHORTSTAT | DIFF_FORMAT_SUMMARY;
1315
1316         rev.verbose_header = 1;
1317         rev.show_root_diff = 1;
1318         get_commit_format(format.buf, &rev);
1319         rev.always_show_header = 0;
1320         rev.diffopt.detect_rename = DIFF_DETECT_RENAME;
1321         rev.diffopt.break_opt = 0;
1322         diff_setup_done(&rev.diffopt);
1323
1324         head = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
1325         if (!head)
1326                 die_errno(_("unable to resolve HEAD after creating commit"));
1327         if (!strcmp(head, "HEAD"))
1328                 head = _("detached HEAD");
1329         else
1330                 skip_prefix(head, "refs/heads/", &head);
1331         printf("[%s%s ", head, (flags & SUMMARY_INITIAL_COMMIT) ?
1332                                                 _(" (root-commit)") : "");
1333
1334         if (!log_tree_commit(&rev, commit)) {
1335                 rev.always_show_header = 1;
1336                 rev.use_terminator = 1;
1337                 log_tree_commit(&rev, commit);
1338         }
1339
1340         strbuf_release(&format);
1341 }
1342
1343 static int parse_head(struct repository *r, struct commit **head)
1344 {
1345         struct commit *current_head;
1346         struct object_id oid;
1347
1348         if (get_oid("HEAD", &oid)) {
1349                 current_head = NULL;
1350         } else {
1351                 current_head = lookup_commit_reference(r, &oid);
1352                 if (!current_head)
1353                         return error(_("could not parse HEAD"));
1354                 if (!oideq(&oid, &current_head->object.oid)) {
1355                         warning(_("HEAD %s is not a commit!"),
1356                                 oid_to_hex(&oid));
1357                 }
1358                 if (parse_commit(current_head))
1359                         return error(_("could not parse HEAD commit"));
1360         }
1361         *head = current_head;
1362
1363         return 0;
1364 }
1365
1366 /*
1367  * Try to commit without forking 'git commit'. In some cases we need
1368  * to run 'git commit' to display an error message
1369  *
1370  * Returns:
1371  *  -1 - error unable to commit
1372  *   0 - success
1373  *   1 - run 'git commit'
1374  */
1375 static int try_to_commit(struct repository *r,
1376                          struct strbuf *msg, const char *author,
1377                          struct replay_opts *opts, unsigned int flags,
1378                          struct object_id *oid)
1379 {
1380         struct object_id tree;
1381         struct commit *current_head;
1382         struct commit_list *parents = NULL;
1383         struct commit_extra_header *extra = NULL;
1384         struct strbuf err = STRBUF_INIT;
1385         struct strbuf commit_msg = STRBUF_INIT;
1386         char *amend_author = NULL;
1387         const char *hook_commit = NULL;
1388         enum commit_msg_cleanup_mode cleanup;
1389         int res = 0;
1390
1391         if (parse_head(r, &current_head))
1392                 return -1;
1393
1394         if (flags & AMEND_MSG) {
1395                 const char *exclude_gpgsig[] = { "gpgsig", NULL };
1396                 const char *out_enc = get_commit_output_encoding();
1397                 const char *message = logmsg_reencode(current_head, NULL,
1398                                                       out_enc);
1399
1400                 if (!msg) {
1401                         const char *orig_message = NULL;
1402
1403                         find_commit_subject(message, &orig_message);
1404                         msg = &commit_msg;
1405                         strbuf_addstr(msg, orig_message);
1406                         hook_commit = "HEAD";
1407                 }
1408                 author = amend_author = get_author(message);
1409                 unuse_commit_buffer(current_head, message);
1410                 if (!author) {
1411                         res = error(_("unable to parse commit author"));
1412                         goto out;
1413                 }
1414                 parents = copy_commit_list(current_head->parents);
1415                 extra = read_commit_extra_headers(current_head, exclude_gpgsig);
1416         } else if (current_head) {
1417                 commit_list_insert(current_head, &parents);
1418         }
1419
1420         if (write_index_as_tree(&tree, r->index, r->index_file, 0, NULL)) {
1421                 res = error(_("git write-tree failed to write a tree"));
1422                 goto out;
1423         }
1424
1425         if (!(flags & ALLOW_EMPTY) && oideq(current_head ?
1426                                             get_commit_tree_oid(current_head) :
1427                                             the_hash_algo->empty_tree, &tree)) {
1428                 res = 1; /* run 'git commit' to display error message */
1429                 goto out;
1430         }
1431
1432         if (find_hook("prepare-commit-msg")) {
1433                 res = run_prepare_commit_msg_hook(r, msg, hook_commit);
1434                 if (res)
1435                         goto out;
1436                 if (strbuf_read_file(&commit_msg, git_path_commit_editmsg(),
1437                                      2048) < 0) {
1438                         res = error_errno(_("unable to read commit message "
1439                                               "from '%s'"),
1440                                             git_path_commit_editmsg());
1441                         goto out;
1442                 }
1443                 msg = &commit_msg;
1444         }
1445
1446         if (flags & CLEANUP_MSG)
1447                 cleanup = COMMIT_MSG_CLEANUP_ALL;
1448         else if ((opts->signoff || opts->record_origin) &&
1449                  !opts->explicit_cleanup)
1450                 cleanup = COMMIT_MSG_CLEANUP_SPACE;
1451         else
1452                 cleanup = opts->default_msg_cleanup;
1453
1454         if (cleanup != COMMIT_MSG_CLEANUP_NONE)
1455                 strbuf_stripspace(msg, cleanup == COMMIT_MSG_CLEANUP_ALL);
1456         if ((flags & EDIT_MSG) && message_is_empty(msg, cleanup)) {
1457                 res = 1; /* run 'git commit' to display error message */
1458                 goto out;
1459         }
1460
1461         reset_ident_date();
1462
1463         if (commit_tree_extended(msg->buf, msg->len, &tree, parents,
1464                                  oid, author, opts->gpg_sign, extra)) {
1465                 res = error(_("failed to write commit object"));
1466                 goto out;
1467         }
1468
1469         if (update_head_with_reflog(current_head, oid,
1470                                     getenv("GIT_REFLOG_ACTION"), msg, &err)) {
1471                 res = error("%s", err.buf);
1472                 goto out;
1473         }
1474
1475         if (flags & AMEND_MSG)
1476                 commit_post_rewrite(r, current_head, oid);
1477
1478 out:
1479         free_commit_extra_headers(extra);
1480         strbuf_release(&err);
1481         strbuf_release(&commit_msg);
1482         free(amend_author);
1483
1484         return res;
1485 }
1486
1487 static int do_commit(struct repository *r,
1488                      const char *msg_file, const char *author,
1489                      struct replay_opts *opts, unsigned int flags)
1490 {
1491         int res = 1;
1492
1493         if (!(flags & EDIT_MSG) && !(flags & VERIFY_MSG) &&
1494             !(flags & CREATE_ROOT_COMMIT)) {
1495                 struct object_id oid;
1496                 struct strbuf sb = STRBUF_INIT;
1497
1498                 if (msg_file && strbuf_read_file(&sb, msg_file, 2048) < 0)
1499                         return error_errno(_("unable to read commit message "
1500                                              "from '%s'"),
1501                                            msg_file);
1502
1503                 res = try_to_commit(r, msg_file ? &sb : NULL,
1504                                     author, opts, flags, &oid);
1505                 strbuf_release(&sb);
1506                 if (!res) {
1507                         unlink(git_path_cherry_pick_head(r));
1508                         unlink(git_path_merge_msg(r));
1509                         if (!is_rebase_i(opts))
1510                                 print_commit_summary(r, NULL, &oid,
1511                                                 SUMMARY_SHOW_AUTHOR_DATE);
1512                         return res;
1513                 }
1514         }
1515         if (res == 1)
1516                 return run_git_commit(r, msg_file, opts, flags);
1517
1518         return res;
1519 }
1520
1521 static int is_original_commit_empty(struct commit *commit)
1522 {
1523         const struct object_id *ptree_oid;
1524
1525         if (parse_commit(commit))
1526                 return error(_("could not parse commit %s"),
1527                              oid_to_hex(&commit->object.oid));
1528         if (commit->parents) {
1529                 struct commit *parent = commit->parents->item;
1530                 if (parse_commit(parent))
1531                         return error(_("could not parse parent commit %s"),
1532                                 oid_to_hex(&parent->object.oid));
1533                 ptree_oid = get_commit_tree_oid(parent);
1534         } else {
1535                 ptree_oid = the_hash_algo->empty_tree; /* commit is root */
1536         }
1537
1538         return oideq(ptree_oid, get_commit_tree_oid(commit));
1539 }
1540
1541 /*
1542  * Do we run "git commit" with "--allow-empty"?
1543  */
1544 static int allow_empty(struct repository *r,
1545                        struct replay_opts *opts,
1546                        struct commit *commit)
1547 {
1548         int index_unchanged, empty_commit;
1549
1550         /*
1551          * Three cases:
1552          *
1553          * (1) we do not allow empty at all and error out.
1554          *
1555          * (2) we allow ones that were initially empty, but
1556          * forbid the ones that become empty;
1557          *
1558          * (3) we allow both.
1559          */
1560         if (!opts->allow_empty)
1561                 return 0; /* let "git commit" barf as necessary */
1562
1563         index_unchanged = is_index_unchanged(r);
1564         if (index_unchanged < 0)
1565                 return index_unchanged;
1566         if (!index_unchanged)
1567                 return 0; /* we do not have to say --allow-empty */
1568
1569         if (opts->keep_redundant_commits)
1570                 return 1;
1571
1572         empty_commit = is_original_commit_empty(commit);
1573         if (empty_commit < 0)
1574                 return empty_commit;
1575         if (!empty_commit)
1576                 return 0;
1577         else
1578                 return 1;
1579 }
1580
1581 static struct {
1582         char c;
1583         const char *str;
1584 } todo_command_info[] = {
1585         { 'p', "pick" },
1586         { 0,   "revert" },
1587         { 'e', "edit" },
1588         { 'r', "reword" },
1589         { 'f', "fixup" },
1590         { 's', "squash" },
1591         { 'x', "exec" },
1592         { 'b', "break" },
1593         { 'l', "label" },
1594         { 't', "reset" },
1595         { 'm', "merge" },
1596         { 0,   "noop" },
1597         { 'd', "drop" },
1598         { 0,   NULL }
1599 };
1600
1601 static const char *command_to_string(const enum todo_command command)
1602 {
1603         if (command < TODO_COMMENT)
1604                 return todo_command_info[command].str;
1605         die(_("unknown command: %d"), command);
1606 }
1607
1608 static char command_to_char(const enum todo_command command)
1609 {
1610         if (command < TODO_COMMENT && todo_command_info[command].c)
1611                 return todo_command_info[command].c;
1612         return comment_line_char;
1613 }
1614
1615 static int is_noop(const enum todo_command command)
1616 {
1617         return TODO_NOOP <= command;
1618 }
1619
1620 static int is_fixup(enum todo_command command)
1621 {
1622         return command == TODO_FIXUP || command == TODO_SQUASH;
1623 }
1624
1625 /* Does this command create a (non-merge) commit? */
1626 static int is_pick_or_similar(enum todo_command command)
1627 {
1628         switch (command) {
1629         case TODO_PICK:
1630         case TODO_REVERT:
1631         case TODO_EDIT:
1632         case TODO_REWORD:
1633         case TODO_FIXUP:
1634         case TODO_SQUASH:
1635                 return 1;
1636         default:
1637                 return 0;
1638         }
1639 }
1640
1641 static int update_squash_messages(struct repository *r,
1642                                   enum todo_command command,
1643                                   struct commit *commit,
1644                                   struct replay_opts *opts)
1645 {
1646         struct strbuf buf = STRBUF_INIT;
1647         int res;
1648         const char *message, *body;
1649
1650         if (opts->current_fixup_count > 0) {
1651                 struct strbuf header = STRBUF_INIT;
1652                 char *eol;
1653
1654                 if (strbuf_read_file(&buf, rebase_path_squash_msg(), 9) <= 0)
1655                         return error(_("could not read '%s'"),
1656                                 rebase_path_squash_msg());
1657
1658                 eol = buf.buf[0] != comment_line_char ?
1659                         buf.buf : strchrnul(buf.buf, '\n');
1660
1661                 strbuf_addf(&header, "%c ", comment_line_char);
1662                 strbuf_addf(&header, _("This is a combination of %d commits."),
1663                             opts->current_fixup_count + 2);
1664                 strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
1665                 strbuf_release(&header);
1666         } else {
1667                 struct object_id head;
1668                 struct commit *head_commit;
1669                 const char *head_message, *body;
1670
1671                 if (get_oid("HEAD", &head))
1672                         return error(_("need a HEAD to fixup"));
1673                 if (!(head_commit = lookup_commit_reference(r, &head)))
1674                         return error(_("could not read HEAD"));
1675                 if (!(head_message = get_commit_buffer(head_commit, NULL)))
1676                         return error(_("could not read HEAD's commit message"));
1677
1678                 find_commit_subject(head_message, &body);
1679                 if (write_message(body, strlen(body),
1680                                   rebase_path_fixup_msg(), 0)) {
1681                         unuse_commit_buffer(head_commit, head_message);
1682                         return error(_("cannot write '%s'"),
1683                                      rebase_path_fixup_msg());
1684                 }
1685
1686                 strbuf_addf(&buf, "%c ", comment_line_char);
1687                 strbuf_addf(&buf, _("This is a combination of %d commits."), 2);
1688                 strbuf_addf(&buf, "\n%c ", comment_line_char);
1689                 strbuf_addstr(&buf, _("This is the 1st commit message:"));
1690                 strbuf_addstr(&buf, "\n\n");
1691                 strbuf_addstr(&buf, body);
1692
1693                 unuse_commit_buffer(head_commit, head_message);
1694         }
1695
1696         if (!(message = get_commit_buffer(commit, NULL)))
1697                 return error(_("could not read commit message of %s"),
1698                              oid_to_hex(&commit->object.oid));
1699         find_commit_subject(message, &body);
1700
1701         if (command == TODO_SQUASH) {
1702                 unlink(rebase_path_fixup_msg());
1703                 strbuf_addf(&buf, "\n%c ", comment_line_char);
1704                 strbuf_addf(&buf, _("This is the commit message #%d:"),
1705                             ++opts->current_fixup_count + 1);
1706                 strbuf_addstr(&buf, "\n\n");
1707                 strbuf_addstr(&buf, body);
1708         } else if (command == TODO_FIXUP) {
1709                 strbuf_addf(&buf, "\n%c ", comment_line_char);
1710                 strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
1711                             ++opts->current_fixup_count + 1);
1712                 strbuf_addstr(&buf, "\n\n");
1713                 strbuf_add_commented_lines(&buf, body, strlen(body));
1714         } else
1715                 return error(_("unknown command: %d"), command);
1716         unuse_commit_buffer(commit, message);
1717
1718         res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
1719         strbuf_release(&buf);
1720
1721         if (!res) {
1722                 strbuf_addf(&opts->current_fixups, "%s%s %s",
1723                             opts->current_fixups.len ? "\n" : "",
1724                             command_to_string(command),
1725                             oid_to_hex(&commit->object.oid));
1726                 res = write_message(opts->current_fixups.buf,
1727                                     opts->current_fixups.len,
1728                                     rebase_path_current_fixups(), 0);
1729         }
1730
1731         return res;
1732 }
1733
1734 static void flush_rewritten_pending(void)
1735 {
1736         struct strbuf buf = STRBUF_INIT;
1737         struct object_id newoid;
1738         FILE *out;
1739
1740         if (strbuf_read_file(&buf, rebase_path_rewritten_pending(), (GIT_MAX_HEXSZ + 1) * 2) > 0 &&
1741             !get_oid("HEAD", &newoid) &&
1742             (out = fopen_or_warn(rebase_path_rewritten_list(), "a"))) {
1743                 char *bol = buf.buf, *eol;
1744
1745                 while (*bol) {
1746                         eol = strchrnul(bol, '\n');
1747                         fprintf(out, "%.*s %s\n", (int)(eol - bol),
1748                                         bol, oid_to_hex(&newoid));
1749                         if (!*eol)
1750                                 break;
1751                         bol = eol + 1;
1752                 }
1753                 fclose(out);
1754                 unlink(rebase_path_rewritten_pending());
1755         }
1756         strbuf_release(&buf);
1757 }
1758
1759 static void record_in_rewritten(struct object_id *oid,
1760                 enum todo_command next_command)
1761 {
1762         FILE *out = fopen_or_warn(rebase_path_rewritten_pending(), "a");
1763
1764         if (!out)
1765                 return;
1766
1767         fprintf(out, "%s\n", oid_to_hex(oid));
1768         fclose(out);
1769
1770         if (!is_fixup(next_command))
1771                 flush_rewritten_pending();
1772 }
1773
1774 static int do_pick_commit(struct repository *r,
1775                           enum todo_command command,
1776                           struct commit *commit,
1777                           struct replay_opts *opts,
1778                           int final_fixup)
1779 {
1780         unsigned int flags = opts->edit ? EDIT_MSG : 0;
1781         const char *msg_file = opts->edit ? NULL : git_path_merge_msg(r);
1782         struct object_id head;
1783         struct commit *base, *next, *parent;
1784         const char *base_label, *next_label;
1785         char *author = NULL;
1786         struct commit_message msg = { NULL, NULL, NULL, NULL };
1787         struct strbuf msgbuf = STRBUF_INIT;
1788         int res, unborn = 0, allow;
1789
1790         if (opts->no_commit) {
1791                 /*
1792                  * We do not intend to commit immediately.  We just want to
1793                  * merge the differences in, so let's compute the tree
1794                  * that represents the "current" state for merge-recursive
1795                  * to work on.
1796                  */
1797                 if (write_index_as_tree(&head, r->index, r->index_file, 0, NULL))
1798                         return error(_("your index file is unmerged."));
1799         } else {
1800                 unborn = get_oid("HEAD", &head);
1801                 /* Do we want to generate a root commit? */
1802                 if (is_pick_or_similar(command) && opts->have_squash_onto &&
1803                     oideq(&head, &opts->squash_onto)) {
1804                         if (is_fixup(command))
1805                                 return error(_("cannot fixup root commit"));
1806                         flags |= CREATE_ROOT_COMMIT;
1807                         unborn = 1;
1808                 } else if (unborn)
1809                         oidcpy(&head, the_hash_algo->empty_tree);
1810                 if (index_differs_from(r, unborn ? empty_tree_oid_hex() : "HEAD",
1811                                        NULL, 0))
1812                         return error_dirty_index(r, opts);
1813         }
1814         discard_index(r->index);
1815
1816         if (!commit->parents)
1817                 parent = NULL;
1818         else if (commit->parents->next) {
1819                 /* Reverting or cherry-picking a merge commit */
1820                 int cnt;
1821                 struct commit_list *p;
1822
1823                 if (!opts->mainline)
1824                         return error(_("commit %s is a merge but no -m option was given."),
1825                                 oid_to_hex(&commit->object.oid));
1826
1827                 for (cnt = 1, p = commit->parents;
1828                      cnt != opts->mainline && p;
1829                      cnt++)
1830                         p = p->next;
1831                 if (cnt != opts->mainline || !p)
1832                         return error(_("commit %s does not have parent %d"),
1833                                 oid_to_hex(&commit->object.oid), opts->mainline);
1834                 parent = p->item;
1835         } else if (1 < opts->mainline)
1836                 /*
1837                  *  Non-first parent explicitly specified as mainline for
1838                  *  non-merge commit
1839                  */
1840                 return error(_("commit %s does not have parent %d"),
1841                              oid_to_hex(&commit->object.oid), opts->mainline);
1842         else
1843                 parent = commit->parents->item;
1844
1845         if (get_message(commit, &msg) != 0)
1846                 return error(_("cannot get commit message for %s"),
1847                         oid_to_hex(&commit->object.oid));
1848
1849         if (opts->allow_ff && !is_fixup(command) &&
1850             ((parent && oideq(&parent->object.oid, &head)) ||
1851              (!parent && unborn))) {
1852                 if (is_rebase_i(opts))
1853                         write_author_script(msg.message);
1854                 res = fast_forward_to(r, &commit->object.oid, &head, unborn,
1855                         opts);
1856                 if (res || command != TODO_REWORD)
1857                         goto leave;
1858                 flags |= EDIT_MSG | AMEND_MSG | VERIFY_MSG;
1859                 msg_file = NULL;
1860                 goto fast_forward_edit;
1861         }
1862         if (parent && parse_commit(parent) < 0)
1863                 /* TRANSLATORS: The first %s will be a "todo" command like
1864                    "revert" or "pick", the second %s a SHA1. */
1865                 return error(_("%s: cannot parse parent commit %s"),
1866                         command_to_string(command),
1867                         oid_to_hex(&parent->object.oid));
1868
1869         /*
1870          * "commit" is an existing commit.  We would want to apply
1871          * the difference it introduces since its first parent "prev"
1872          * on top of the current HEAD if we are cherry-pick.  Or the
1873          * reverse of it if we are revert.
1874          */
1875
1876         if (command == TODO_REVERT) {
1877                 base = commit;
1878                 base_label = msg.label;
1879                 next = parent;
1880                 next_label = msg.parent_label;
1881                 strbuf_addstr(&msgbuf, "Revert \"");
1882                 strbuf_addstr(&msgbuf, msg.subject);
1883                 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
1884                 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1885
1886                 if (commit->parents && commit->parents->next) {
1887                         strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
1888                         strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
1889                 }
1890                 strbuf_addstr(&msgbuf, ".\n");
1891         } else {
1892                 const char *p;
1893
1894                 base = parent;
1895                 base_label = msg.parent_label;
1896                 next = commit;
1897                 next_label = msg.label;
1898
1899                 /* Append the commit log message to msgbuf. */
1900                 if (find_commit_subject(msg.message, &p))
1901                         strbuf_addstr(&msgbuf, p);
1902
1903                 if (opts->record_origin) {
1904                         strbuf_complete_line(&msgbuf);
1905                         if (!has_conforming_footer(&msgbuf, NULL, 0))
1906                                 strbuf_addch(&msgbuf, '\n');
1907                         strbuf_addstr(&msgbuf, cherry_picked_prefix);
1908                         strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
1909                         strbuf_addstr(&msgbuf, ")\n");
1910                 }
1911                 if (!is_fixup(command))
1912                         author = get_author(msg.message);
1913         }
1914
1915         if (command == TODO_REWORD)
1916                 flags |= EDIT_MSG | VERIFY_MSG;
1917         else if (is_fixup(command)) {
1918                 if (update_squash_messages(r, command, commit, opts))
1919                         return -1;
1920                 flags |= AMEND_MSG;
1921                 if (!final_fixup)
1922                         msg_file = rebase_path_squash_msg();
1923                 else if (file_exists(rebase_path_fixup_msg())) {
1924                         flags |= CLEANUP_MSG;
1925                         msg_file = rebase_path_fixup_msg();
1926                 } else {
1927                         const char *dest = git_path_squash_msg(r);
1928                         unlink(dest);
1929                         if (copy_file(dest, rebase_path_squash_msg(), 0666))
1930                                 return error(_("could not rename '%s' to '%s'"),
1931                                              rebase_path_squash_msg(), dest);
1932                         unlink(git_path_merge_msg(r));
1933                         msg_file = dest;
1934                         flags |= EDIT_MSG;
1935                 }
1936         }
1937
1938         if (opts->signoff && !is_fixup(command))
1939                 append_signoff(&msgbuf, 0, 0);
1940
1941         if (is_rebase_i(opts) && write_author_script(msg.message) < 0)
1942                 res = -1;
1943         else if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
1944                 res = do_recursive_merge(r, base, next, base_label, next_label,
1945                                          &head, &msgbuf, opts);
1946                 if (res < 0)
1947                         goto leave;
1948
1949                 res |= write_message(msgbuf.buf, msgbuf.len,
1950                                      git_path_merge_msg(r), 0);
1951         } else {
1952                 struct commit_list *common = NULL;
1953                 struct commit_list *remotes = NULL;
1954
1955                 res = write_message(msgbuf.buf, msgbuf.len,
1956                                     git_path_merge_msg(r), 0);
1957
1958                 commit_list_insert(base, &common);
1959                 commit_list_insert(next, &remotes);
1960                 res |= try_merge_command(r, opts->strategy,
1961                                          opts->xopts_nr, (const char **)opts->xopts,
1962                                         common, oid_to_hex(&head), remotes);
1963                 free_commit_list(common);
1964                 free_commit_list(remotes);
1965         }
1966         strbuf_release(&msgbuf);
1967
1968         /*
1969          * If the merge was clean or if it failed due to conflict, we write
1970          * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
1971          * However, if the merge did not even start, then we don't want to
1972          * write it at all.
1973          */
1974         if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
1975             update_ref(NULL, "CHERRY_PICK_HEAD", &commit->object.oid, NULL,
1976                        REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1977                 res = -1;
1978         if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
1979             update_ref(NULL, "REVERT_HEAD", &commit->object.oid, NULL,
1980                        REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
1981                 res = -1;
1982
1983         if (res) {
1984                 error(command == TODO_REVERT
1985                       ? _("could not revert %s... %s")
1986                       : _("could not apply %s... %s"),
1987                       short_commit_name(commit), msg.subject);
1988                 print_advice(r, res == 1, opts);
1989                 repo_rerere(r, opts->allow_rerere_auto);
1990                 goto leave;
1991         }
1992
1993         allow = allow_empty(r, opts, commit);
1994         if (allow < 0) {
1995                 res = allow;
1996                 goto leave;
1997         } else if (allow)
1998                 flags |= ALLOW_EMPTY;
1999         if (!opts->no_commit) {
2000 fast_forward_edit:
2001                 if (author || command == TODO_REVERT || (flags & AMEND_MSG))
2002                         res = do_commit(r, msg_file, author, opts, flags);
2003                 else
2004                         res = error(_("unable to parse commit author"));
2005         }
2006
2007         if (!res && final_fixup) {
2008                 unlink(rebase_path_fixup_msg());
2009                 unlink(rebase_path_squash_msg());
2010                 unlink(rebase_path_current_fixups());
2011                 strbuf_reset(&opts->current_fixups);
2012                 opts->current_fixup_count = 0;
2013         }
2014
2015 leave:
2016         free_message(commit, &msg);
2017         free(author);
2018         update_abort_safety_file();
2019
2020         return res;
2021 }
2022
2023 static int prepare_revs(struct replay_opts *opts)
2024 {
2025         /*
2026          * picking (but not reverting) ranges (but not individual revisions)
2027          * should be done in reverse
2028          */
2029         if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
2030                 opts->revs->reverse ^= 1;
2031
2032         if (prepare_revision_walk(opts->revs))
2033                 return error(_("revision walk setup failed"));
2034
2035         return 0;
2036 }
2037
2038 static int read_and_refresh_cache(struct repository *r,
2039                                   struct replay_opts *opts)
2040 {
2041         struct lock_file index_lock = LOCK_INIT;
2042         int index_fd = repo_hold_locked_index(r, &index_lock, 0);
2043         if (repo_read_index(r) < 0) {
2044                 rollback_lock_file(&index_lock);
2045                 return error(_("git %s: failed to read the index"),
2046                         _(action_name(opts)));
2047         }
2048         refresh_index(r->index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
2049         if (index_fd >= 0) {
2050                 if (write_locked_index(r->index, &index_lock,
2051                                        COMMIT_LOCK | SKIP_IF_UNCHANGED)) {
2052                         return error(_("git %s: failed to refresh the index"),
2053                                 _(action_name(opts)));
2054                 }
2055         }
2056         return 0;
2057 }
2058
2059 enum todo_item_flags {
2060         TODO_EDIT_MERGE_MSG = 1
2061 };
2062
2063 void todo_list_release(struct todo_list *todo_list)
2064 {
2065         strbuf_release(&todo_list->buf);
2066         FREE_AND_NULL(todo_list->items);
2067         todo_list->nr = todo_list->alloc = 0;
2068 }
2069
2070 static struct todo_item *append_new_todo(struct todo_list *todo_list)
2071 {
2072         ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
2073         todo_list->total_nr++;
2074         return todo_list->items + todo_list->nr++;
2075 }
2076
2077 const char *todo_item_get_arg(struct todo_list *todo_list,
2078                               struct todo_item *item)
2079 {
2080         return todo_list->buf.buf + item->arg_offset;
2081 }
2082
2083 static int is_command(enum todo_command command, const char **bol)
2084 {
2085         const char *str = todo_command_info[command].str;
2086         const char nick = todo_command_info[command].c;
2087         const char *p = *bol + 1;
2088
2089         return skip_prefix(*bol, str, bol) ||
2090                 ((nick && **bol == nick) &&
2091                  (*p == ' ' || *p == '\t' || *p == '\n' || *p == '\r' || !*p) &&
2092                  (*bol = p));
2093 }
2094
2095 static int parse_insn_line(struct repository *r, struct todo_item *item,
2096                            const char *buf, const char *bol, char *eol)
2097 {
2098         struct object_id commit_oid;
2099         char *end_of_object_name;
2100         int i, saved, status, padding;
2101
2102         item->flags = 0;
2103
2104         /* left-trim */
2105         bol += strspn(bol, " \t");
2106
2107         if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
2108                 item->command = TODO_COMMENT;
2109                 item->commit = NULL;
2110                 item->arg_offset = bol - buf;
2111                 item->arg_len = eol - bol;
2112                 return 0;
2113         }
2114
2115         for (i = 0; i < TODO_COMMENT; i++)
2116                 if (is_command(i, &bol)) {
2117                         item->command = i;
2118                         break;
2119                 }
2120         if (i >= TODO_COMMENT)
2121                 return -1;
2122
2123         /* Eat up extra spaces/ tabs before object name */
2124         padding = strspn(bol, " \t");
2125         bol += padding;
2126
2127         if (item->command == TODO_NOOP || item->command == TODO_BREAK) {
2128                 if (bol != eol)
2129                         return error(_("%s does not accept arguments: '%s'"),
2130                                      command_to_string(item->command), bol);
2131                 item->commit = NULL;
2132                 item->arg_offset = bol - buf;
2133                 item->arg_len = eol - bol;
2134                 return 0;
2135         }
2136
2137         if (!padding)
2138                 return error(_("missing arguments for %s"),
2139                              command_to_string(item->command));
2140
2141         if (item->command == TODO_EXEC || item->command == TODO_LABEL ||
2142             item->command == TODO_RESET) {
2143                 item->commit = NULL;
2144                 item->arg_offset = bol - buf;
2145                 item->arg_len = (int)(eol - bol);
2146                 return 0;
2147         }
2148
2149         if (item->command == TODO_MERGE) {
2150                 if (skip_prefix(bol, "-C", &bol))
2151                         bol += strspn(bol, " \t");
2152                 else if (skip_prefix(bol, "-c", &bol)) {
2153                         bol += strspn(bol, " \t");
2154                         item->flags |= TODO_EDIT_MERGE_MSG;
2155                 } else {
2156                         item->flags |= TODO_EDIT_MERGE_MSG;
2157                         item->commit = NULL;
2158                         item->arg_offset = bol - buf;
2159                         item->arg_len = (int)(eol - bol);
2160                         return 0;
2161                 }
2162         }
2163
2164         end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
2165         saved = *end_of_object_name;
2166         *end_of_object_name = '\0';
2167         status = get_oid(bol, &commit_oid);
2168         *end_of_object_name = saved;
2169
2170         bol = end_of_object_name + strspn(end_of_object_name, " \t");
2171         item->arg_offset = bol - buf;
2172         item->arg_len = (int)(eol - bol);
2173
2174         if (status < 0)
2175                 return error(_("could not parse '%.*s'"),
2176                              (int)(end_of_object_name - bol), bol);
2177
2178         item->commit = lookup_commit_reference(r, &commit_oid);
2179         return !item->commit;
2180 }
2181
2182 int sequencer_get_last_command(struct repository *r, enum replay_action *action)
2183 {
2184         const char *todo_file, *bol;
2185         struct strbuf buf = STRBUF_INIT;
2186         int ret = 0;
2187
2188         todo_file = git_path_todo_file();
2189         if (strbuf_read_file(&buf, todo_file, 0) < 0) {
2190                 if (errno == ENOENT || errno == ENOTDIR)
2191                         return -1;
2192                 else
2193                         return error_errno("unable to open '%s'", todo_file);
2194         }
2195         bol = buf.buf + strspn(buf.buf, " \t\r\n");
2196         if (is_command(TODO_PICK, &bol) && (*bol == ' ' || *bol == '\t'))
2197                 *action = REPLAY_PICK;
2198         else if (is_command(TODO_REVERT, &bol) &&
2199                  (*bol == ' ' || *bol == '\t'))
2200                 *action = REPLAY_REVERT;
2201         else
2202                 ret = -1;
2203
2204         strbuf_release(&buf);
2205
2206         return ret;
2207 }
2208
2209 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
2210                                 struct todo_list *todo_list)
2211 {
2212         struct todo_item *item;
2213         char *p = buf, *next_p;
2214         int i, res = 0, fixup_okay = file_exists(rebase_path_done());
2215
2216         todo_list->current = todo_list->nr = 0;
2217
2218         for (i = 1; *p; i++, p = next_p) {
2219                 char *eol = strchrnul(p, '\n');
2220
2221                 next_p = *eol ? eol + 1 /* skip LF */ : eol;
2222
2223                 if (p != eol && eol[-1] == '\r')
2224                         eol--; /* strip Carriage Return */
2225
2226                 item = append_new_todo(todo_list);
2227                 item->offset_in_buf = p - todo_list->buf.buf;
2228                 if (parse_insn_line(r, item, buf, p, eol)) {
2229                         res = error(_("invalid line %d: %.*s"),
2230                                 i, (int)(eol - p), p);
2231                         item->command = TODO_COMMENT + 1;
2232                         item->arg_offset = p - buf;
2233                         item->arg_len = (int)(eol - p);
2234                         item->commit = NULL;
2235                 }
2236
2237                 if (fixup_okay)
2238                         ; /* do nothing */
2239                 else if (is_fixup(item->command))
2240                         return error(_("cannot '%s' without a previous commit"),
2241                                 command_to_string(item->command));
2242                 else if (!is_noop(item->command))
2243                         fixup_okay = 1;
2244         }
2245
2246         return res;
2247 }
2248
2249 static int count_commands(struct todo_list *todo_list)
2250 {
2251         int count = 0, i;
2252
2253         for (i = 0; i < todo_list->nr; i++)
2254                 if (todo_list->items[i].command != TODO_COMMENT)
2255                         count++;
2256
2257         return count;
2258 }
2259
2260 static int get_item_line_offset(struct todo_list *todo_list, int index)
2261 {
2262         return index < todo_list->nr ?
2263                 todo_list->items[index].offset_in_buf : todo_list->buf.len;
2264 }
2265
2266 static const char *get_item_line(struct todo_list *todo_list, int index)
2267 {
2268         return todo_list->buf.buf + get_item_line_offset(todo_list, index);
2269 }
2270
2271 static int get_item_line_length(struct todo_list *todo_list, int index)
2272 {
2273         return get_item_line_offset(todo_list, index + 1)
2274                 -  get_item_line_offset(todo_list, index);
2275 }
2276
2277 static ssize_t strbuf_read_file_or_whine(struct strbuf *sb, const char *path)
2278 {
2279         int fd;
2280         ssize_t len;
2281
2282         fd = open(path, O_RDONLY);
2283         if (fd < 0)
2284                 return error_errno(_("could not open '%s'"), path);
2285         len = strbuf_read(sb, fd, 0);
2286         close(fd);
2287         if (len < 0)
2288                 return error(_("could not read '%s'."), path);
2289         return len;
2290 }
2291
2292 static int have_finished_the_last_pick(void)
2293 {
2294         struct strbuf buf = STRBUF_INIT;
2295         const char *eol;
2296         const char *todo_path = git_path_todo_file();
2297         int ret = 0;
2298
2299         if (strbuf_read_file(&buf, todo_path, 0) < 0) {
2300                 if (errno == ENOENT) {
2301                         return 0;
2302                 } else {
2303                         error_errno("unable to open '%s'", todo_path);
2304                         return 0;
2305                 }
2306         }
2307         /* If there is only one line then we are done */
2308         eol = strchr(buf.buf, '\n');
2309         if (!eol || !eol[1])
2310                 ret = 1;
2311
2312         strbuf_release(&buf);
2313
2314         return ret;
2315 }
2316
2317 void sequencer_post_commit_cleanup(struct repository *r, int verbose)
2318 {
2319         struct replay_opts opts = REPLAY_OPTS_INIT;
2320         int need_cleanup = 0;
2321
2322         if (file_exists(git_path_cherry_pick_head(r))) {
2323                 if (!unlink(git_path_cherry_pick_head(r)) && verbose)
2324                         warning(_("cancelling a cherry picking in progress"));
2325                 opts.action = REPLAY_PICK;
2326                 need_cleanup = 1;
2327         }
2328
2329         if (file_exists(git_path_revert_head(r))) {
2330                 if (!unlink(git_path_revert_head(r)) && verbose)
2331                         warning(_("cancelling a revert in progress"));
2332                 opts.action = REPLAY_REVERT;
2333                 need_cleanup = 1;
2334         }
2335
2336         if (!need_cleanup)
2337                 return;
2338
2339         if (!have_finished_the_last_pick())
2340                 return;
2341
2342         sequencer_remove_state(&opts);
2343 }
2344
2345 static void todo_list_write_total_nr(struct todo_list *todo_list)
2346 {
2347         FILE *f = fopen_or_warn(rebase_path_msgtotal(), "w");
2348
2349         if (f) {
2350                 fprintf(f, "%d\n", todo_list->total_nr);
2351                 fclose(f);
2352         }
2353 }
2354
2355 static int read_populate_todo(struct repository *r,
2356                               struct todo_list *todo_list,
2357                               struct replay_opts *opts)
2358 {
2359         struct stat st;
2360         const char *todo_file = get_todo_path(opts);
2361         int res;
2362
2363         strbuf_reset(&todo_list->buf);
2364         if (strbuf_read_file_or_whine(&todo_list->buf, todo_file) < 0)
2365                 return -1;
2366
2367         res = stat(todo_file, &st);
2368         if (res)
2369                 return error(_("could not stat '%s'"), todo_file);
2370         fill_stat_data(&todo_list->stat, &st);
2371
2372         res = todo_list_parse_insn_buffer(r, todo_list->buf.buf, todo_list);
2373         if (res) {
2374                 if (is_rebase_i(opts))
2375                         return error(_("please fix this using "
2376                                        "'git rebase --edit-todo'."));
2377                 return error(_("unusable instruction sheet: '%s'"), todo_file);
2378         }
2379
2380         if (!todo_list->nr &&
2381             (!is_rebase_i(opts) || !file_exists(rebase_path_done())))
2382                 return error(_("no commits parsed."));
2383
2384         if (!is_rebase_i(opts)) {
2385                 enum todo_command valid =
2386                         opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
2387                 int i;
2388
2389                 for (i = 0; i < todo_list->nr; i++)
2390                         if (valid == todo_list->items[i].command)
2391                                 continue;
2392                         else if (valid == TODO_PICK)
2393                                 return error(_("cannot cherry-pick during a revert."));
2394                         else
2395                                 return error(_("cannot revert during a cherry-pick."));
2396         }
2397
2398         if (is_rebase_i(opts)) {
2399                 struct todo_list done = TODO_LIST_INIT;
2400
2401                 if (strbuf_read_file(&done.buf, rebase_path_done(), 0) > 0 &&
2402                     !todo_list_parse_insn_buffer(r, done.buf.buf, &done))
2403                         todo_list->done_nr = count_commands(&done);
2404                 else
2405                         todo_list->done_nr = 0;
2406
2407                 todo_list->total_nr = todo_list->done_nr
2408                         + count_commands(todo_list);
2409                 todo_list_release(&done);
2410
2411                 todo_list_write_total_nr(todo_list);
2412         }
2413
2414         return 0;
2415 }
2416
2417 static int git_config_string_dup(char **dest,
2418                                  const char *var, const char *value)
2419 {
2420         if (!value)
2421                 return config_error_nonbool(var);
2422         free(*dest);
2423         *dest = xstrdup(value);
2424         return 0;
2425 }
2426
2427 static int populate_opts_cb(const char *key, const char *value, void *data)
2428 {
2429         struct replay_opts *opts = data;
2430         int error_flag = 1;
2431
2432         if (!value)
2433                 error_flag = 0;
2434         else if (!strcmp(key, "options.no-commit"))
2435                 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
2436         else if (!strcmp(key, "options.edit"))
2437                 opts->edit = git_config_bool_or_int(key, value, &error_flag);
2438         else if (!strcmp(key, "options.allow-empty"))
2439                 opts->allow_empty =
2440                         git_config_bool_or_int(key, value, &error_flag);
2441         else if (!strcmp(key, "options.allow-empty-message"))
2442                 opts->allow_empty_message =
2443                         git_config_bool_or_int(key, value, &error_flag);
2444         else if (!strcmp(key, "options.keep-redundant-commits"))
2445                 opts->keep_redundant_commits =
2446                         git_config_bool_or_int(key, value, &error_flag);
2447         else if (!strcmp(key, "options.signoff"))
2448                 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
2449         else if (!strcmp(key, "options.record-origin"))
2450                 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
2451         else if (!strcmp(key, "options.allow-ff"))
2452                 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
2453         else if (!strcmp(key, "options.mainline"))
2454                 opts->mainline = git_config_int(key, value);
2455         else if (!strcmp(key, "options.strategy"))
2456                 git_config_string_dup(&opts->strategy, key, value);
2457         else if (!strcmp(key, "options.gpg-sign"))
2458                 git_config_string_dup(&opts->gpg_sign, key, value);
2459         else if (!strcmp(key, "options.strategy-option")) {
2460                 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
2461                 opts->xopts[opts->xopts_nr++] = xstrdup(value);
2462         } else if (!strcmp(key, "options.allow-rerere-auto"))
2463                 opts->allow_rerere_auto =
2464                         git_config_bool_or_int(key, value, &error_flag) ?
2465                                 RERERE_AUTOUPDATE : RERERE_NOAUTOUPDATE;
2466         else if (!strcmp(key, "options.default-msg-cleanup")) {
2467                 opts->explicit_cleanup = 1;
2468                 opts->default_msg_cleanup = get_cleanup_mode(value, 1);
2469         } else
2470                 return error(_("invalid key: %s"), key);
2471
2472         if (!error_flag)
2473                 return error(_("invalid value for %s: %s"), key, value);
2474
2475         return 0;
2476 }
2477
2478 void parse_strategy_opts(struct replay_opts *opts, char *raw_opts)
2479 {
2480         int i;
2481         char *strategy_opts_string = raw_opts;
2482
2483         if (*strategy_opts_string == ' ')
2484                 strategy_opts_string++;
2485
2486         opts->xopts_nr = split_cmdline(strategy_opts_string,
2487                                        (const char ***)&opts->xopts);
2488         for (i = 0; i < opts->xopts_nr; i++) {
2489                 const char *arg = opts->xopts[i];
2490
2491                 skip_prefix(arg, "--", &arg);
2492                 opts->xopts[i] = xstrdup(arg);
2493         }
2494 }
2495
2496 static void read_strategy_opts(struct replay_opts *opts, struct strbuf *buf)
2497 {
2498         strbuf_reset(buf);
2499         if (!read_oneliner(buf, rebase_path_strategy(), 0))
2500                 return;
2501         opts->strategy = strbuf_detach(buf, NULL);
2502         if (!read_oneliner(buf, rebase_path_strategy_opts(), 0))
2503                 return;
2504
2505         parse_strategy_opts(opts, buf->buf);
2506 }
2507
2508 static int read_populate_opts(struct replay_opts *opts)
2509 {
2510         if (is_rebase_i(opts)) {
2511                 struct strbuf buf = STRBUF_INIT;
2512
2513                 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
2514                         if (!starts_with(buf.buf, "-S"))
2515                                 strbuf_reset(&buf);
2516                         else {
2517                                 free(opts->gpg_sign);
2518                                 opts->gpg_sign = xstrdup(buf.buf + 2);
2519                         }
2520                         strbuf_reset(&buf);
2521                 }
2522
2523                 if (read_oneliner(&buf, rebase_path_allow_rerere_autoupdate(), 1)) {
2524                         if (!strcmp(buf.buf, "--rerere-autoupdate"))
2525                                 opts->allow_rerere_auto = RERERE_AUTOUPDATE;
2526                         else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
2527                                 opts->allow_rerere_auto = RERERE_NOAUTOUPDATE;
2528                         strbuf_reset(&buf);
2529                 }
2530
2531                 if (file_exists(rebase_path_verbose()))
2532                         opts->verbose = 1;
2533
2534                 if (file_exists(rebase_path_quiet()))
2535                         opts->quiet = 1;
2536
2537                 if (file_exists(rebase_path_signoff())) {
2538                         opts->allow_ff = 0;
2539                         opts->signoff = 1;
2540                 }
2541
2542                 if (file_exists(rebase_path_reschedule_failed_exec()))
2543                         opts->reschedule_failed_exec = 1;
2544
2545                 read_strategy_opts(opts, &buf);
2546                 strbuf_release(&buf);
2547
2548                 if (read_oneliner(&opts->current_fixups,
2549                                   rebase_path_current_fixups(), 1)) {
2550                         const char *p = opts->current_fixups.buf;
2551                         opts->current_fixup_count = 1;
2552                         while ((p = strchr(p, '\n'))) {
2553                                 opts->current_fixup_count++;
2554                                 p++;
2555                         }
2556                 }
2557
2558                 if (read_oneliner(&buf, rebase_path_squash_onto(), 0)) {
2559                         if (get_oid_hex(buf.buf, &opts->squash_onto) < 0)
2560                                 return error(_("unusable squash-onto"));
2561                         opts->have_squash_onto = 1;
2562                 }
2563
2564                 return 0;
2565         }
2566
2567         if (!file_exists(git_path_opts_file()))
2568                 return 0;
2569         /*
2570          * The function git_parse_source(), called from git_config_from_file(),
2571          * may die() in case of a syntactically incorrect file. We do not care
2572          * about this case, though, because we wrote that file ourselves, so we
2573          * are pretty certain that it is syntactically correct.
2574          */
2575         if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
2576                 return error(_("malformed options sheet: '%s'"),
2577                         git_path_opts_file());
2578         return 0;
2579 }
2580
2581 static void write_strategy_opts(struct replay_opts *opts)
2582 {
2583         int i;
2584         struct strbuf buf = STRBUF_INIT;
2585
2586         for (i = 0; i < opts->xopts_nr; ++i)
2587                 strbuf_addf(&buf, " --%s", opts->xopts[i]);
2588
2589         write_file(rebase_path_strategy_opts(), "%s\n", buf.buf);
2590         strbuf_release(&buf);
2591 }
2592
2593 int write_basic_state(struct replay_opts *opts, const char *head_name,
2594                       struct commit *onto, const char *orig_head)
2595 {
2596         const char *quiet = getenv("GIT_QUIET");
2597
2598         if (head_name)
2599                 write_file(rebase_path_head_name(), "%s\n", head_name);
2600         if (onto)
2601                 write_file(rebase_path_onto(), "%s\n",
2602                            oid_to_hex(&onto->object.oid));
2603         if (orig_head)
2604                 write_file(rebase_path_orig_head(), "%s\n", orig_head);
2605
2606         if (quiet)
2607                 write_file(rebase_path_quiet(), "%s\n", quiet);
2608         if (opts->verbose)
2609                 write_file(rebase_path_verbose(), "%s", "");
2610         if (opts->strategy)
2611                 write_file(rebase_path_strategy(), "%s\n", opts->strategy);
2612         if (opts->xopts_nr > 0)
2613                 write_strategy_opts(opts);
2614
2615         if (opts->allow_rerere_auto == RERERE_AUTOUPDATE)
2616                 write_file(rebase_path_allow_rerere_autoupdate(), "--rerere-autoupdate\n");
2617         else if (opts->allow_rerere_auto == RERERE_NOAUTOUPDATE)
2618                 write_file(rebase_path_allow_rerere_autoupdate(), "--no-rerere-autoupdate\n");
2619
2620         if (opts->gpg_sign)
2621                 write_file(rebase_path_gpg_sign_opt(), "-S%s\n", opts->gpg_sign);
2622         if (opts->signoff)
2623                 write_file(rebase_path_signoff(), "--signoff\n");
2624         if (opts->reschedule_failed_exec)
2625                 write_file(rebase_path_reschedule_failed_exec(), "%s", "");
2626
2627         return 0;
2628 }
2629
2630 static int walk_revs_populate_todo(struct todo_list *todo_list,
2631                                 struct replay_opts *opts)
2632 {
2633         enum todo_command command = opts->action == REPLAY_PICK ?
2634                 TODO_PICK : TODO_REVERT;
2635         const char *command_string = todo_command_info[command].str;
2636         struct commit *commit;
2637
2638         if (prepare_revs(opts))
2639                 return -1;
2640
2641         while ((commit = get_revision(opts->revs))) {
2642                 struct todo_item *item = append_new_todo(todo_list);
2643                 const char *commit_buffer = get_commit_buffer(commit, NULL);
2644                 const char *subject;
2645                 int subject_len;
2646
2647                 item->command = command;
2648                 item->commit = commit;
2649                 item->arg_offset = 0;
2650                 item->arg_len = 0;
2651                 item->offset_in_buf = todo_list->buf.len;
2652                 subject_len = find_commit_subject(commit_buffer, &subject);
2653                 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
2654                         short_commit_name(commit), subject_len, subject);
2655                 unuse_commit_buffer(commit, commit_buffer);
2656         }
2657
2658         if (!todo_list->nr)
2659                 return error(_("empty commit set passed"));
2660
2661         return 0;
2662 }
2663
2664 static int create_seq_dir(struct repository *r)
2665 {
2666         enum replay_action action;
2667         const char *in_progress_error = NULL;
2668         const char *in_progress_advice = NULL;
2669         unsigned int advise_skip = file_exists(git_path_revert_head(r)) ||
2670                                 file_exists(git_path_cherry_pick_head(r));
2671
2672         if (!sequencer_get_last_command(r, &action)) {
2673                 switch (action) {
2674                 case REPLAY_REVERT:
2675                         in_progress_error = _("revert is already in progress");
2676                         in_progress_advice =
2677                         _("try \"git revert (--continue | %s--abort | --quit)\"");
2678                         break;
2679                 case REPLAY_PICK:
2680                         in_progress_error = _("cherry-pick is already in progress");
2681                         in_progress_advice =
2682                         _("try \"git cherry-pick (--continue | %s--abort | --quit)\"");
2683                         break;
2684                 default:
2685                         BUG("unexpected action in create_seq_dir");
2686                 }
2687         }
2688         if (in_progress_error) {
2689                 error("%s", in_progress_error);
2690                 if (advice_sequencer_in_use)
2691                         advise(in_progress_advice,
2692                                 advise_skip ? "--skip | " : "");
2693                 return -1;
2694         }
2695         if (mkdir(git_path_seq_dir(), 0777) < 0)
2696                 return error_errno(_("could not create sequencer directory '%s'"),
2697                                    git_path_seq_dir());
2698
2699         return 0;
2700 }
2701
2702 static int save_head(const char *head)
2703 {
2704         struct lock_file head_lock = LOCK_INIT;
2705         struct strbuf buf = STRBUF_INIT;
2706         int fd;
2707         ssize_t written;
2708
2709         fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
2710         if (fd < 0)
2711                 return error_errno(_("could not lock HEAD"));
2712         strbuf_addf(&buf, "%s\n", head);
2713         written = write_in_full(fd, buf.buf, buf.len);
2714         strbuf_release(&buf);
2715         if (written < 0) {
2716                 error_errno(_("could not write to '%s'"), git_path_head_file());
2717                 rollback_lock_file(&head_lock);
2718                 return -1;
2719         }
2720         if (commit_lock_file(&head_lock) < 0)
2721                 return error(_("failed to finalize '%s'"), git_path_head_file());
2722         return 0;
2723 }
2724
2725 static int rollback_is_safe(void)
2726 {
2727         struct strbuf sb = STRBUF_INIT;
2728         struct object_id expected_head, actual_head;
2729
2730         if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
2731                 strbuf_trim(&sb);
2732                 if (get_oid_hex(sb.buf, &expected_head)) {
2733                         strbuf_release(&sb);
2734                         die(_("could not parse %s"), git_path_abort_safety_file());
2735                 }
2736                 strbuf_release(&sb);
2737         }
2738         else if (errno == ENOENT)
2739                 oidclr(&expected_head);
2740         else
2741                 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
2742
2743         if (get_oid("HEAD", &actual_head))
2744                 oidclr(&actual_head);
2745
2746         return oideq(&actual_head, &expected_head);
2747 }
2748
2749 static int reset_merge(const struct object_id *oid)
2750 {
2751         int ret;
2752         struct argv_array argv = ARGV_ARRAY_INIT;
2753
2754         argv_array_pushl(&argv, "reset", "--merge", NULL);
2755
2756         if (!is_null_oid(oid))
2757                 argv_array_push(&argv, oid_to_hex(oid));
2758
2759         ret = run_command_v_opt(argv.argv, RUN_GIT_CMD);
2760         argv_array_clear(&argv);
2761
2762         return ret;
2763 }
2764
2765 static int rollback_single_pick(struct repository *r)
2766 {
2767         struct object_id head_oid;
2768
2769         if (!file_exists(git_path_cherry_pick_head(r)) &&
2770             !file_exists(git_path_revert_head(r)))
2771                 return error(_("no cherry-pick or revert in progress"));
2772         if (read_ref_full("HEAD", 0, &head_oid, NULL))
2773                 return error(_("cannot resolve HEAD"));
2774         if (is_null_oid(&head_oid))
2775                 return error(_("cannot abort from a branch yet to be born"));
2776         return reset_merge(&head_oid);
2777 }
2778
2779 static int skip_single_pick(void)
2780 {
2781         struct object_id head;
2782
2783         if (read_ref_full("HEAD", 0, &head, NULL))
2784                 return error(_("cannot resolve HEAD"));
2785         return reset_merge(&head);
2786 }
2787
2788 int sequencer_rollback(struct repository *r, struct replay_opts *opts)
2789 {
2790         FILE *f;
2791         struct object_id oid;
2792         struct strbuf buf = STRBUF_INIT;
2793         const char *p;
2794
2795         f = fopen(git_path_head_file(), "r");
2796         if (!f && errno == ENOENT) {
2797                 /*
2798                  * There is no multiple-cherry-pick in progress.
2799                  * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
2800                  * a single-cherry-pick in progress, abort that.
2801                  */
2802                 return rollback_single_pick(r);
2803         }
2804         if (!f)
2805                 return error_errno(_("cannot open '%s'"), git_path_head_file());
2806         if (strbuf_getline_lf(&buf, f)) {
2807                 error(_("cannot read '%s': %s"), git_path_head_file(),
2808                       ferror(f) ?  strerror(errno) : _("unexpected end of file"));
2809                 fclose(f);
2810                 goto fail;
2811         }
2812         fclose(f);
2813         if (parse_oid_hex(buf.buf, &oid, &p) || *p != '\0') {
2814                 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
2815                         git_path_head_file());
2816                 goto fail;
2817         }
2818         if (is_null_oid(&oid)) {
2819                 error(_("cannot abort from a branch yet to be born"));
2820                 goto fail;
2821         }
2822
2823         if (!rollback_is_safe()) {
2824                 /* Do not error, just do not rollback */
2825                 warning(_("You seem to have moved HEAD. "
2826                           "Not rewinding, check your HEAD!"));
2827         } else
2828         if (reset_merge(&oid))
2829                 goto fail;
2830         strbuf_release(&buf);
2831         return sequencer_remove_state(opts);
2832 fail:
2833         strbuf_release(&buf);
2834         return -1;
2835 }
2836
2837 int sequencer_skip(struct repository *r, struct replay_opts *opts)
2838 {
2839         enum replay_action action = -1;
2840         sequencer_get_last_command(r, &action);
2841
2842         /*
2843          * Check whether the subcommand requested to skip the commit is actually
2844          * in progress and that it's safe to skip the commit.
2845          *
2846          * opts->action tells us which subcommand requested to skip the commit.
2847          * If the corresponding .git/<ACTION>_HEAD exists, we know that the
2848          * action is in progress and we can skip the commit.
2849          *
2850          * Otherwise we check that the last instruction was related to the
2851          * particular subcommand we're trying to execute and barf if that's not
2852          * the case.
2853          *
2854          * Finally we check that the rollback is "safe", i.e., has the HEAD
2855          * moved? In this case, it doesn't make sense to "reset the merge" and
2856          * "skip the commit" as the user already handled this by committing. But
2857          * we'd not want to barf here, instead give advice on how to proceed. We
2858          * only need to check that when .git/<ACTION>_HEAD doesn't exist because
2859          * it gets removed when the user commits, so if it still exists we're
2860          * sure the user can't have committed before.
2861          */
2862         switch (opts->action) {
2863         case REPLAY_REVERT:
2864                 if (!file_exists(git_path_revert_head(r))) {
2865                         if (action != REPLAY_REVERT)
2866                                 return error(_("no revert in progress"));
2867                         if (!rollback_is_safe())
2868                                 goto give_advice;
2869                 }
2870                 break;
2871         case REPLAY_PICK:
2872                 if (!file_exists(git_path_cherry_pick_head(r))) {
2873                         if (action != REPLAY_PICK)
2874                                 return error(_("no cherry-pick in progress"));
2875                         if (!rollback_is_safe())
2876                                 goto give_advice;
2877                 }
2878                 break;
2879         default:
2880                 BUG("unexpected action in sequencer_skip");
2881         }
2882
2883         if (skip_single_pick())
2884                 return error(_("failed to skip the commit"));
2885         if (!is_directory(git_path_seq_dir()))
2886                 return 0;
2887
2888         return sequencer_continue(r, opts);
2889
2890 give_advice:
2891         error(_("there is nothing to skip"));
2892
2893         if (advice_resolve_conflict) {
2894                 advise(_("have you committed already?\n"
2895                          "try \"git %s --continue\""),
2896                          action == REPLAY_REVERT ? "revert" : "cherry-pick");
2897         }
2898         return -1;
2899 }
2900
2901 static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
2902 {
2903         struct lock_file todo_lock = LOCK_INIT;
2904         const char *todo_path = get_todo_path(opts);
2905         int next = todo_list->current, offset, fd;
2906
2907         /*
2908          * rebase -i writes "git-rebase-todo" without the currently executing
2909          * command, appending it to "done" instead.
2910          */
2911         if (is_rebase_i(opts))
2912                 next++;
2913
2914         fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
2915         if (fd < 0)
2916                 return error_errno(_("could not lock '%s'"), todo_path);
2917         offset = get_item_line_offset(todo_list, next);
2918         if (write_in_full(fd, todo_list->buf.buf + offset,
2919                         todo_list->buf.len - offset) < 0)
2920                 return error_errno(_("could not write to '%s'"), todo_path);
2921         if (commit_lock_file(&todo_lock) < 0)
2922                 return error(_("failed to finalize '%s'"), todo_path);
2923
2924         if (is_rebase_i(opts) && next > 0) {
2925                 const char *done = rebase_path_done();
2926                 int fd = open(done, O_CREAT | O_WRONLY | O_APPEND, 0666);
2927                 int ret = 0;
2928
2929                 if (fd < 0)
2930                         return 0;
2931                 if (write_in_full(fd, get_item_line(todo_list, next - 1),
2932                                   get_item_line_length(todo_list, next - 1))
2933                     < 0)
2934                         ret = error_errno(_("could not write to '%s'"), done);
2935                 if (close(fd) < 0)
2936                         ret = error_errno(_("failed to finalize '%s'"), done);
2937                 return ret;
2938         }
2939         return 0;
2940 }
2941
2942 static int save_opts(struct replay_opts *opts)
2943 {
2944         const char *opts_file = git_path_opts_file();
2945         int res = 0;
2946
2947         if (opts->no_commit)
2948                 res |= git_config_set_in_file_gently(opts_file,
2949                                         "options.no-commit", "true");
2950         if (opts->edit)
2951                 res |= git_config_set_in_file_gently(opts_file,
2952                                         "options.edit", "true");
2953         if (opts->allow_empty)
2954                 res |= git_config_set_in_file_gently(opts_file,
2955                                         "options.allow-empty", "true");
2956         if (opts->allow_empty_message)
2957                 res |= git_config_set_in_file_gently(opts_file,
2958                                 "options.allow-empty-message", "true");
2959         if (opts->keep_redundant_commits)
2960                 res |= git_config_set_in_file_gently(opts_file,
2961                                 "options.keep-redundant-commits", "true");
2962         if (opts->signoff)
2963                 res |= git_config_set_in_file_gently(opts_file,
2964                                         "options.signoff", "true");
2965         if (opts->record_origin)
2966                 res |= git_config_set_in_file_gently(opts_file,
2967                                         "options.record-origin", "true");
2968         if (opts->allow_ff)
2969                 res |= git_config_set_in_file_gently(opts_file,
2970                                         "options.allow-ff", "true");
2971         if (opts->mainline) {
2972                 struct strbuf buf = STRBUF_INIT;
2973                 strbuf_addf(&buf, "%d", opts->mainline);
2974                 res |= git_config_set_in_file_gently(opts_file,
2975                                         "options.mainline", buf.buf);
2976                 strbuf_release(&buf);
2977         }
2978         if (opts->strategy)
2979                 res |= git_config_set_in_file_gently(opts_file,
2980                                         "options.strategy", opts->strategy);
2981         if (opts->gpg_sign)
2982                 res |= git_config_set_in_file_gently(opts_file,
2983                                         "options.gpg-sign", opts->gpg_sign);
2984         if (opts->xopts) {
2985                 int i;
2986                 for (i = 0; i < opts->xopts_nr; i++)
2987                         res |= git_config_set_multivar_in_file_gently(opts_file,
2988                                         "options.strategy-option",
2989                                         opts->xopts[i], "^$", 0);
2990         }
2991         if (opts->allow_rerere_auto)
2992                 res |= git_config_set_in_file_gently(opts_file,
2993                                 "options.allow-rerere-auto",
2994                                 opts->allow_rerere_auto == RERERE_AUTOUPDATE ?
2995                                 "true" : "false");
2996
2997         if (opts->explicit_cleanup)
2998                 res |= git_config_set_in_file_gently(opts_file,
2999                                 "options.default-msg-cleanup",
3000                                 describe_cleanup_mode(opts->default_msg_cleanup));
3001         return res;
3002 }
3003
3004 static int make_patch(struct repository *r,
3005                       struct commit *commit,
3006                       struct replay_opts *opts)
3007 {
3008         struct strbuf buf = STRBUF_INIT;
3009         struct rev_info log_tree_opt;
3010         const char *subject, *p;
3011         int res = 0;
3012
3013         p = short_commit_name(commit);
3014         if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
3015                 return -1;
3016         if (update_ref("rebase", "REBASE_HEAD", &commit->object.oid,
3017                        NULL, REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR))
3018                 res |= error(_("could not update %s"), "REBASE_HEAD");
3019
3020         strbuf_addf(&buf, "%s/patch", get_dir(opts));
3021         memset(&log_tree_opt, 0, sizeof(log_tree_opt));
3022         repo_init_revisions(r, &log_tree_opt, NULL);
3023         log_tree_opt.abbrev = 0;
3024         log_tree_opt.diff = 1;
3025         log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
3026         log_tree_opt.disable_stdin = 1;
3027         log_tree_opt.no_commit_id = 1;
3028         log_tree_opt.diffopt.file = fopen(buf.buf, "w");
3029         log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
3030         if (!log_tree_opt.diffopt.file)
3031                 res |= error_errno(_("could not open '%s'"), buf.buf);
3032         else {
3033                 res |= log_tree_commit(&log_tree_opt, commit);
3034                 fclose(log_tree_opt.diffopt.file);
3035         }
3036         strbuf_reset(&buf);
3037
3038         strbuf_addf(&buf, "%s/message", get_dir(opts));
3039         if (!file_exists(buf.buf)) {
3040                 const char *commit_buffer = get_commit_buffer(commit, NULL);
3041                 find_commit_subject(commit_buffer, &subject);
3042                 res |= write_message(subject, strlen(subject), buf.buf, 1);
3043                 unuse_commit_buffer(commit, commit_buffer);
3044         }
3045         strbuf_release(&buf);
3046
3047         return res;
3048 }
3049
3050 static int intend_to_amend(void)
3051 {
3052         struct object_id head;
3053         char *p;
3054
3055         if (get_oid("HEAD", &head))
3056                 return error(_("cannot read HEAD"));
3057
3058         p = oid_to_hex(&head);
3059         return write_message(p, strlen(p), rebase_path_amend(), 1);
3060 }
3061
3062 static int error_with_patch(struct repository *r,
3063                             struct commit *commit,
3064                             const char *subject, int subject_len,
3065                             struct replay_opts *opts,
3066                             int exit_code, int to_amend)
3067 {
3068         if (commit) {
3069                 if (make_patch(r, commit, opts))
3070                         return -1;
3071         } else if (copy_file(rebase_path_message(),
3072                              git_path_merge_msg(r), 0666))
3073                 return error(_("unable to copy '%s' to '%s'"),
3074                              git_path_merge_msg(r), rebase_path_message());
3075
3076         if (to_amend) {
3077                 if (intend_to_amend())
3078                         return -1;
3079
3080                 fprintf(stderr,
3081                         _("You can amend the commit now, with\n"
3082                           "\n"
3083                           "  git commit --amend %s\n"
3084                           "\n"
3085                           "Once you are satisfied with your changes, run\n"
3086                           "\n"
3087                           "  git rebase --continue\n"),
3088                         gpg_sign_opt_quoted(opts));
3089         } else if (exit_code) {
3090                 if (commit)
3091                         fprintf_ln(stderr, _("Could not apply %s... %.*s"),
3092                                    short_commit_name(commit), subject_len, subject);
3093                 else
3094                         /*
3095                          * We don't have the hash of the parent so
3096                          * just print the line from the todo file.
3097                          */
3098                         fprintf_ln(stderr, _("Could not merge %.*s"),
3099                                    subject_len, subject);
3100         }
3101
3102         return exit_code;
3103 }
3104
3105 static int error_failed_squash(struct repository *r,
3106                                struct commit *commit,
3107                                struct replay_opts *opts,
3108                                int subject_len,
3109                                const char *subject)
3110 {
3111         if (copy_file(rebase_path_message(), rebase_path_squash_msg(), 0666))
3112                 return error(_("could not copy '%s' to '%s'"),
3113                         rebase_path_squash_msg(), rebase_path_message());
3114         unlink(git_path_merge_msg(r));
3115         if (copy_file(git_path_merge_msg(r), rebase_path_message(), 0666))
3116                 return error(_("could not copy '%s' to '%s'"),
3117                              rebase_path_message(),
3118                              git_path_merge_msg(r));
3119         return error_with_patch(r, commit, subject, subject_len, opts, 1, 0);
3120 }
3121
3122 static int do_exec(struct repository *r, const char *command_line)
3123 {
3124         struct argv_array child_env = ARGV_ARRAY_INIT;
3125         const char *child_argv[] = { NULL, NULL };
3126         int dirty, status;
3127
3128         fprintf(stderr, "Executing: %s\n", command_line);
3129         child_argv[0] = command_line;
3130         argv_array_pushf(&child_env, "GIT_DIR=%s", absolute_path(get_git_dir()));
3131         argv_array_pushf(&child_env, "GIT_WORK_TREE=%s",
3132                          absolute_path(get_git_work_tree()));
3133         status = run_command_v_opt_cd_env(child_argv, RUN_USING_SHELL, NULL,
3134                                           child_env.argv);
3135
3136         /* force re-reading of the cache */
3137         if (discard_index(r->index) < 0 || repo_read_index(r) < 0)
3138                 return error(_("could not read index"));
3139
3140         dirty = require_clean_work_tree(r, "rebase", NULL, 1, 1);
3141
3142         if (status) {
3143                 warning(_("execution failed: %s\n%s"
3144                           "You can fix the problem, and then run\n"
3145                           "\n"
3146                           "  git rebase --continue\n"
3147                           "\n"),
3148                         command_line,
3149                         dirty ? N_("and made changes to the index and/or the "
3150                                 "working tree\n") : "");
3151                 if (status == 127)
3152                         /* command not found */
3153                         status = 1;
3154         } else if (dirty) {
3155                 warning(_("execution succeeded: %s\nbut "
3156                           "left changes to the index and/or the working tree\n"
3157                           "Commit or stash your changes, and then run\n"
3158                           "\n"
3159                           "  git rebase --continue\n"
3160                           "\n"), command_line);
3161                 status = 1;
3162         }
3163
3164         argv_array_clear(&child_env);
3165
3166         return status;
3167 }
3168
3169 static int safe_append(const char *filename, const char *fmt, ...)
3170 {
3171         va_list ap;
3172         struct lock_file lock = LOCK_INIT;
3173         int fd = hold_lock_file_for_update(&lock, filename,
3174                                            LOCK_REPORT_ON_ERROR);
3175         struct strbuf buf = STRBUF_INIT;
3176
3177         if (fd < 0)
3178                 return -1;
3179
3180         if (strbuf_read_file(&buf, filename, 0) < 0 && errno != ENOENT) {
3181                 error_errno(_("could not read '%s'"), filename);
3182                 rollback_lock_file(&lock);
3183                 return -1;
3184         }
3185         strbuf_complete(&buf, '\n');
3186         va_start(ap, fmt);
3187         strbuf_vaddf(&buf, fmt, ap);
3188         va_end(ap);
3189
3190         if (write_in_full(fd, buf.buf, buf.len) < 0) {
3191                 error_errno(_("could not write to '%s'"), filename);
3192                 strbuf_release(&buf);
3193                 rollback_lock_file(&lock);
3194                 return -1;
3195         }
3196         if (commit_lock_file(&lock) < 0) {
3197                 strbuf_release(&buf);
3198                 rollback_lock_file(&lock);
3199                 return error(_("failed to finalize '%s'"), filename);
3200         }
3201
3202         strbuf_release(&buf);
3203         return 0;
3204 }
3205
3206 static int do_label(struct repository *r, const char *name, int len)
3207 {
3208         struct ref_store *refs = get_main_ref_store(r);
3209         struct ref_transaction *transaction;
3210         struct strbuf ref_name = STRBUF_INIT, err = STRBUF_INIT;
3211         struct strbuf msg = STRBUF_INIT;
3212         int ret = 0;
3213         struct object_id head_oid;
3214
3215         if (len == 1 && *name == '#')
3216                 return error(_("illegal label name: '%.*s'"), len, name);
3217
3218         strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
3219         strbuf_addf(&msg, "rebase -i (label) '%.*s'", len, name);
3220
3221         transaction = ref_store_transaction_begin(refs, &err);
3222         if (!transaction) {
3223                 error("%s", err.buf);
3224                 ret = -1;
3225         } else if (get_oid("HEAD", &head_oid)) {
3226                 error(_("could not read HEAD"));
3227                 ret = -1;
3228         } else if (ref_transaction_update(transaction, ref_name.buf, &head_oid,
3229                                           NULL, 0, msg.buf, &err) < 0 ||
3230                    ref_transaction_commit(transaction, &err)) {
3231                 error("%s", err.buf);
3232                 ret = -1;
3233         }
3234         ref_transaction_free(transaction);
3235         strbuf_release(&err);
3236         strbuf_release(&msg);
3237
3238         if (!ret)
3239                 ret = safe_append(rebase_path_refs_to_delete(),
3240                                   "%s\n", ref_name.buf);
3241         strbuf_release(&ref_name);
3242
3243         return ret;
3244 }
3245
3246 static const char *reflog_message(struct replay_opts *opts,
3247         const char *sub_action, const char *fmt, ...);
3248
3249 static int do_reset(struct repository *r,
3250                     const char *name, int len,
3251                     struct replay_opts *opts)
3252 {
3253         struct strbuf ref_name = STRBUF_INIT;
3254         struct object_id oid;
3255         struct lock_file lock = LOCK_INIT;
3256         struct tree_desc desc;
3257         struct tree *tree;
3258         struct unpack_trees_options unpack_tree_opts;
3259         int ret = 0;
3260
3261         if (repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0)
3262                 return -1;
3263
3264         if (len == 10 && !strncmp("[new root]", name, len)) {
3265                 if (!opts->have_squash_onto) {
3266                         const char *hex;
3267                         if (commit_tree("", 0, the_hash_algo->empty_tree,
3268                                         NULL, &opts->squash_onto,
3269                                         NULL, NULL))
3270                                 return error(_("writing fake root commit"));
3271                         opts->have_squash_onto = 1;
3272                         hex = oid_to_hex(&opts->squash_onto);
3273                         if (write_message(hex, strlen(hex),
3274                                           rebase_path_squash_onto(), 0))
3275                                 return error(_("writing squash-onto"));
3276                 }
3277                 oidcpy(&oid, &opts->squash_onto);
3278         } else {
3279                 int i;
3280
3281                 /* Determine the length of the label */
3282                 for (i = 0; i < len; i++)
3283                         if (isspace(name[i]))
3284                                 break;
3285                 len = i;
3286
3287                 strbuf_addf(&ref_name, "refs/rewritten/%.*s", len, name);
3288                 if (get_oid(ref_name.buf, &oid) &&
3289                     get_oid(ref_name.buf + strlen("refs/rewritten/"), &oid)) {
3290                         error(_("could not read '%s'"), ref_name.buf);
3291                         rollback_lock_file(&lock);
3292                         strbuf_release(&ref_name);
3293                         return -1;
3294                 }
3295         }
3296
3297         memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
3298         setup_unpack_trees_porcelain(&unpack_tree_opts, "reset");
3299         unpack_tree_opts.head_idx = 1;
3300         unpack_tree_opts.src_index = r->index;
3301         unpack_tree_opts.dst_index = r->index;
3302         unpack_tree_opts.fn = oneway_merge;
3303         unpack_tree_opts.merge = 1;
3304         unpack_tree_opts.update = 1;
3305
3306         if (repo_read_index_unmerged(r)) {
3307                 rollback_lock_file(&lock);
3308                 strbuf_release(&ref_name);
3309                 return error_resolve_conflict(_(action_name(opts)));
3310         }
3311
3312         if (!fill_tree_descriptor(r, &desc, &oid)) {
3313                 error(_("failed to find tree of %s"), oid_to_hex(&oid));
3314                 rollback_lock_file(&lock);
3315                 free((void *)desc.buffer);
3316                 strbuf_release(&ref_name);
3317                 return -1;
3318         }
3319
3320         if (unpack_trees(1, &desc, &unpack_tree_opts)) {
3321                 rollback_lock_file(&lock);
3322                 free((void *)desc.buffer);
3323                 strbuf_release(&ref_name);
3324                 return -1;
3325         }
3326
3327         tree = parse_tree_indirect(&oid);
3328         prime_cache_tree(r, r->index, tree);
3329
3330         if (write_locked_index(r->index, &lock, COMMIT_LOCK) < 0)
3331                 ret = error(_("could not write index"));
3332         free((void *)desc.buffer);
3333
3334         if (!ret)
3335                 ret = update_ref(reflog_message(opts, "reset", "'%.*s'",
3336                                                 len, name), "HEAD", &oid,
3337                                  NULL, 0, UPDATE_REFS_MSG_ON_ERR);
3338
3339         strbuf_release(&ref_name);
3340         return ret;
3341 }
3342
3343 static struct commit *lookup_label(const char *label, int len,
3344                                    struct strbuf *buf)
3345 {
3346         struct commit *commit;
3347
3348         strbuf_reset(buf);
3349         strbuf_addf(buf, "refs/rewritten/%.*s", len, label);
3350         commit = lookup_commit_reference_by_name(buf->buf);
3351         if (!commit) {
3352                 /* fall back to non-rewritten ref or commit */
3353                 strbuf_splice(buf, 0, strlen("refs/rewritten/"), "", 0);
3354                 commit = lookup_commit_reference_by_name(buf->buf);
3355         }
3356
3357         if (!commit)
3358                 error(_("could not resolve '%s'"), buf->buf);
3359
3360         return commit;
3361 }
3362
3363 static int do_merge(struct repository *r,
3364                     struct commit *commit,
3365                     const char *arg, int arg_len,
3366                     int flags, struct replay_opts *opts)
3367 {
3368         int run_commit_flags = (flags & TODO_EDIT_MERGE_MSG) ?
3369                 EDIT_MSG | VERIFY_MSG : 0;
3370         struct strbuf ref_name = STRBUF_INIT;
3371         struct commit *head_commit, *merge_commit, *i;
3372         struct commit_list *bases, *j, *reversed = NULL;
3373         struct commit_list *to_merge = NULL, **tail = &to_merge;
3374         const char *strategy = !opts->xopts_nr &&
3375                 (!opts->strategy || !strcmp(opts->strategy, "recursive")) ?
3376                 NULL : opts->strategy;
3377         struct merge_options o;
3378         int merge_arg_len, oneline_offset, can_fast_forward, ret, k;
3379         static struct lock_file lock;
3380         const char *p;
3381
3382         if (repo_hold_locked_index(r, &lock, LOCK_REPORT_ON_ERROR) < 0) {
3383                 ret = -1;
3384                 goto leave_merge;
3385         }
3386
3387         head_commit = lookup_commit_reference_by_name("HEAD");
3388         if (!head_commit) {
3389                 ret = error(_("cannot merge without a current revision"));
3390                 goto leave_merge;
3391         }
3392
3393         /*
3394          * For octopus merges, the arg starts with the list of revisions to be
3395          * merged. The list is optionally followed by '#' and the oneline.
3396          */
3397         merge_arg_len = oneline_offset = arg_len;
3398         for (p = arg; p - arg < arg_len; p += strspn(p, " \t\n")) {
3399                 if (!*p)
3400                         break;
3401                 if (*p == '#' && (!p[1] || isspace(p[1]))) {
3402                         p += 1 + strspn(p + 1, " \t\n");
3403                         oneline_offset = p - arg;
3404                         break;
3405                 }
3406                 k = strcspn(p, " \t\n");
3407                 if (!k)
3408                         continue;
3409                 merge_commit = lookup_label(p, k, &ref_name);
3410                 if (!merge_commit) {
3411                         ret = error(_("unable to parse '%.*s'"), k, p);
3412                         goto leave_merge;
3413                 }
3414                 tail = &commit_list_insert(merge_commit, tail)->next;
3415                 p += k;
3416                 merge_arg_len = p - arg;
3417         }
3418
3419         if (!to_merge) {
3420                 ret = error(_("nothing to merge: '%.*s'"), arg_len, arg);
3421                 goto leave_merge;
3422         }
3423
3424         if (opts->have_squash_onto &&
3425             oideq(&head_commit->object.oid, &opts->squash_onto)) {
3426                 /*
3427                  * When the user tells us to "merge" something into a
3428                  * "[new root]", let's simply fast-forward to the merge head.
3429                  */
3430                 rollback_lock_file(&lock);
3431                 if (to_merge->next)
3432                         ret = error(_("octopus merge cannot be executed on "
3433                                       "top of a [new root]"));
3434                 else
3435                         ret = fast_forward_to(r, &to_merge->item->object.oid,
3436                                               &head_commit->object.oid, 0,
3437                                               opts);
3438                 goto leave_merge;
3439         }
3440
3441         if (commit) {
3442                 const char *message = get_commit_buffer(commit, NULL);
3443                 const char *body;
3444                 int len;
3445
3446                 if (!message) {
3447                         ret = error(_("could not get commit message of '%s'"),
3448                                     oid_to_hex(&commit->object.oid));
3449                         goto leave_merge;
3450                 }
3451                 write_author_script(message);
3452                 find_commit_subject(message, &body);
3453                 len = strlen(body);
3454                 ret = write_message(body, len, git_path_merge_msg(r), 0);
3455                 unuse_commit_buffer(commit, message);
3456                 if (ret) {
3457                         error_errno(_("could not write '%s'"),
3458                                     git_path_merge_msg(r));
3459                         goto leave_merge;
3460                 }
3461         } else {
3462                 struct strbuf buf = STRBUF_INIT;
3463                 int len;
3464
3465                 strbuf_addf(&buf, "author %s", git_author_info(0));
3466                 write_author_script(buf.buf);
3467                 strbuf_reset(&buf);
3468
3469                 if (oneline_offset < arg_len) {
3470                         p = arg + oneline_offset;
3471                         len = arg_len - oneline_offset;
3472                 } else {
3473                         strbuf_addf(&buf, "Merge %s '%.*s'",
3474                                     to_merge->next ? "branches" : "branch",
3475                                     merge_arg_len, arg);
3476                         p = buf.buf;
3477                         len = buf.len;
3478                 }
3479
3480                 ret = write_message(p, len, git_path_merge_msg(r), 0);
3481                 strbuf_release(&buf);
3482                 if (ret) {
3483                         error_errno(_("could not write '%s'"),
3484                                     git_path_merge_msg(r));
3485                         goto leave_merge;
3486                 }
3487         }
3488
3489         /*
3490          * If HEAD is not identical to the first parent of the original merge
3491          * commit, we cannot fast-forward.
3492          */
3493         can_fast_forward = opts->allow_ff && commit && commit->parents &&
3494                 oideq(&commit->parents->item->object.oid,
3495                       &head_commit->object.oid);
3496
3497         /*
3498          * If any merge head is different from the original one, we cannot
3499          * fast-forward.
3500          */
3501         if (can_fast_forward) {
3502                 struct commit_list *p = commit->parents->next;
3503
3504                 for (j = to_merge; j && p; j = j->next, p = p->next)
3505                         if (!oideq(&j->item->object.oid,
3506                                    &p->item->object.oid)) {
3507                                 can_fast_forward = 0;
3508                                 break;
3509                         }
3510                 /*
3511                  * If the number of merge heads differs from the original merge
3512                  * commit, we cannot fast-forward.
3513                  */
3514                 if (j || p)
3515                         can_fast_forward = 0;
3516         }
3517
3518         if (can_fast_forward) {
3519                 rollback_lock_file(&lock);
3520                 ret = fast_forward_to(r, &commit->object.oid,
3521                                       &head_commit->object.oid, 0, opts);
3522                 if (flags & TODO_EDIT_MERGE_MSG) {
3523                         run_commit_flags |= AMEND_MSG;
3524                         goto fast_forward_edit;
3525                 }
3526                 goto leave_merge;
3527         }
3528
3529         if (strategy || to_merge->next) {
3530                 /* Octopus merge */
3531                 struct child_process cmd = CHILD_PROCESS_INIT;
3532
3533                 if (read_env_script(&cmd.env_array)) {
3534                         const char *gpg_opt = gpg_sign_opt_quoted(opts);
3535
3536                         ret = error(_(staged_changes_advice), gpg_opt, gpg_opt);
3537                         goto leave_merge;
3538                 }
3539
3540                 cmd.git_cmd = 1;
3541                 argv_array_push(&cmd.args, "merge");
3542                 argv_array_push(&cmd.args, "-s");
3543                 if (!strategy)
3544                         argv_array_push(&cmd.args, "octopus");
3545                 else {
3546                         argv_array_push(&cmd.args, strategy);
3547                         for (k = 0; k < opts->xopts_nr; k++)
3548                                 argv_array_pushf(&cmd.args,
3549                                                  "-X%s", opts->xopts[k]);
3550                 }
3551                 argv_array_push(&cmd.args, "--no-edit");
3552                 argv_array_push(&cmd.args, "--no-ff");
3553                 argv_array_push(&cmd.args, "--no-log");
3554                 argv_array_push(&cmd.args, "--no-stat");
3555                 argv_array_push(&cmd.args, "-F");
3556                 argv_array_push(&cmd.args, git_path_merge_msg(r));
3557                 if (opts->gpg_sign)
3558                         argv_array_push(&cmd.args, opts->gpg_sign);
3559
3560                 /* Add the tips to be merged */
3561                 for (j = to_merge; j; j = j->next)
3562                         argv_array_push(&cmd.args,
3563                                         oid_to_hex(&j->item->object.oid));
3564
3565                 strbuf_release(&ref_name);
3566                 unlink(git_path_cherry_pick_head(r));
3567                 rollback_lock_file(&lock);
3568
3569                 rollback_lock_file(&lock);
3570                 ret = run_command(&cmd);
3571
3572                 /* force re-reading of the cache */
3573                 if (!ret && (discard_index(r->index) < 0 ||
3574                              repo_read_index(r) < 0))
3575                         ret = error(_("could not read index"));
3576                 goto leave_merge;
3577         }
3578
3579         merge_commit = to_merge->item;
3580         bases = get_merge_bases(head_commit, merge_commit);
3581         if (bases && oideq(&merge_commit->object.oid,
3582                            &bases->item->object.oid)) {
3583                 ret = 0;
3584                 /* skip merging an ancestor of HEAD */
3585                 goto leave_merge;
3586         }
3587
3588         write_message(oid_to_hex(&merge_commit->object.oid), GIT_SHA1_HEXSZ,
3589                       git_path_merge_head(r), 0);
3590         write_message("no-ff", 5, git_path_merge_mode(r), 0);
3591
3592         for (j = bases; j; j = j->next)
3593                 commit_list_insert(j->item, &reversed);
3594         free_commit_list(bases);
3595
3596         repo_read_index(r);
3597         init_merge_options(&o, r);
3598         o.branch1 = "HEAD";
3599         o.branch2 = ref_name.buf;
3600         o.buffer_output = 2;
3601
3602         ret = merge_recursive(&o, head_commit, merge_commit, reversed, &i);
3603         if (ret <= 0)
3604                 fputs(o.obuf.buf, stdout);
3605         strbuf_release(&o.obuf);
3606         if (ret < 0) {
3607                 error(_("could not even attempt to merge '%.*s'"),
3608                       merge_arg_len, arg);
3609                 goto leave_merge;
3610         }
3611         /*
3612          * The return value of merge_recursive() is 1 on clean, and 0 on
3613          * unclean merge.
3614          *
3615          * Let's reverse that, so that do_merge() returns 0 upon success and
3616          * 1 upon failed merge (keeping the return value -1 for the cases where
3617          * we will want to reschedule the `merge` command).
3618          */
3619         ret = !ret;
3620
3621         if (r->index->cache_changed &&
3622             write_locked_index(r->index, &lock, COMMIT_LOCK)) {
3623                 ret = error(_("merge: Unable to write new index file"));
3624                 goto leave_merge;
3625         }
3626
3627         rollback_lock_file(&lock);
3628         if (ret)
3629                 repo_rerere(r, opts->allow_rerere_auto);
3630         else
3631                 /*
3632                  * In case of problems, we now want to return a positive
3633                  * value (a negative one would indicate that the `merge`
3634                  * command needs to be rescheduled).
3635                  */
3636         fast_forward_edit:
3637                 ret = !!run_git_commit(r, git_path_merge_msg(r), opts,
3638                                        run_commit_flags);
3639
3640 leave_merge:
3641         strbuf_release(&ref_name);
3642         rollback_lock_file(&lock);
3643         free_commit_list(to_merge);
3644         return ret;
3645 }
3646
3647 static int is_final_fixup(struct todo_list *todo_list)
3648 {
3649         int i = todo_list->current;
3650
3651         if (!is_fixup(todo_list->items[i].command))
3652                 return 0;
3653
3654         while (++i < todo_list->nr)
3655                 if (is_fixup(todo_list->items[i].command))
3656                         return 0;
3657                 else if (!is_noop(todo_list->items[i].command))
3658                         break;
3659         return 1;
3660 }
3661
3662 static enum todo_command peek_command(struct todo_list *todo_list, int offset)
3663 {
3664         int i;
3665
3666         for (i = todo_list->current + offset; i < todo_list->nr; i++)
3667                 if (!is_noop(todo_list->items[i].command))
3668                         return todo_list->items[i].command;
3669
3670         return -1;
3671 }
3672
3673 static int apply_autostash(struct replay_opts *opts)
3674 {
3675         struct strbuf stash_sha1 = STRBUF_INIT;
3676         struct child_process child = CHILD_PROCESS_INIT;
3677         int ret = 0;
3678
3679         if (!read_oneliner(&stash_sha1, rebase_path_autostash(), 1)) {
3680                 strbuf_release(&stash_sha1);
3681                 return 0;
3682         }
3683         strbuf_trim(&stash_sha1);
3684
3685         child.git_cmd = 1;
3686         child.no_stdout = 1;
3687         child.no_stderr = 1;
3688         argv_array_push(&child.args, "stash");
3689         argv_array_push(&child.args, "apply");
3690         argv_array_push(&child.args, stash_sha1.buf);
3691         if (!run_command(&child))
3692                 fprintf(stderr, _("Applied autostash.\n"));
3693         else {
3694                 struct child_process store = CHILD_PROCESS_INIT;
3695
3696                 store.git_cmd = 1;
3697                 argv_array_push(&store.args, "stash");
3698                 argv_array_push(&store.args, "store");
3699                 argv_array_push(&store.args, "-m");
3700                 argv_array_push(&store.args, "autostash");
3701                 argv_array_push(&store.args, "-q");
3702                 argv_array_push(&store.args, stash_sha1.buf);
3703                 if (run_command(&store))
3704                         ret = error(_("cannot store %s"), stash_sha1.buf);
3705                 else
3706                         fprintf(stderr,
3707                                 _("Applying autostash resulted in conflicts.\n"
3708                                   "Your changes are safe in the stash.\n"
3709                                   "You can run \"git stash pop\" or"
3710                                   " \"git stash drop\" at any time.\n"));
3711         }
3712
3713         strbuf_release(&stash_sha1);
3714         return ret;
3715 }
3716
3717 static const char *reflog_message(struct replay_opts *opts,
3718         const char *sub_action, const char *fmt, ...)
3719 {
3720         va_list ap;
3721         static struct strbuf buf = STRBUF_INIT;
3722
3723         va_start(ap, fmt);
3724         strbuf_reset(&buf);
3725         strbuf_addstr(&buf, action_name(opts));
3726         if (sub_action)
3727                 strbuf_addf(&buf, " (%s)", sub_action);
3728         if (fmt) {
3729                 strbuf_addstr(&buf, ": ");
3730                 strbuf_vaddf(&buf, fmt, ap);
3731         }
3732         va_end(ap);
3733
3734         return buf.buf;
3735 }
3736
3737 static int run_git_checkout(struct repository *r, struct replay_opts *opts,
3738                             const char *commit, const char *action)
3739 {
3740         struct child_process cmd = CHILD_PROCESS_INIT;
3741         int ret;
3742
3743         cmd.git_cmd = 1;
3744
3745         argv_array_push(&cmd.args, "checkout");
3746         argv_array_push(&cmd.args, commit);
3747         argv_array_pushf(&cmd.env_array, GIT_REFLOG_ACTION "=%s", action);
3748
3749         if (opts->verbose)
3750                 ret = run_command(&cmd);
3751         else
3752                 ret = run_command_silent_on_success(&cmd);
3753
3754         if (!ret)
3755                 discard_index(r->index);
3756
3757         return ret;
3758 }
3759
3760 int prepare_branch_to_be_rebased(struct repository *r, struct replay_opts *opts,
3761                                  const char *commit)
3762 {
3763         const char *action;
3764
3765         if (commit && *commit) {
3766                 action = reflog_message(opts, "start", "checkout %s", commit);
3767                 if (run_git_checkout(r, opts, commit, action))
3768                         return error(_("could not checkout %s"), commit);
3769         }
3770
3771         return 0;
3772 }
3773
3774 static int checkout_onto(struct repository *r, struct replay_opts *opts,
3775                          const char *onto_name, const struct object_id *onto,
3776                          const char *orig_head)
3777 {
3778         struct object_id oid;
3779         const char *action = reflog_message(opts, "start", "checkout %s", onto_name);
3780
3781         if (get_oid(orig_head, &oid))
3782                 return error(_("%s: not a valid OID"), orig_head);
3783
3784         if (run_git_checkout(r, opts, oid_to_hex(onto), action)) {
3785                 apply_autostash(opts);
3786                 sequencer_remove_state(opts);
3787                 return error(_("could not detach HEAD"));
3788         }
3789
3790         return update_ref(NULL, "ORIG_HEAD", &oid, NULL, 0, UPDATE_REFS_MSG_ON_ERR);
3791 }
3792
3793 static int stopped_at_head(struct repository *r)
3794 {
3795         struct object_id head;
3796         struct commit *commit;
3797         struct commit_message message;
3798
3799         if (get_oid("HEAD", &head) ||
3800             !(commit = lookup_commit(r, &head)) ||
3801             parse_commit(commit) || get_message(commit, &message))
3802                 fprintf(stderr, _("Stopped at HEAD\n"));
3803         else {
3804                 fprintf(stderr, _("Stopped at %s\n"), message.label);
3805                 free_message(commit, &message);
3806         }
3807         return 0;
3808
3809 }
3810
3811 static const char rescheduled_advice[] =
3812 N_("Could not execute the todo command\n"
3813 "\n"
3814 "    %.*s"
3815 "\n"
3816 "It has been rescheduled; To edit the command before continuing, please\n"
3817 "edit the todo list first:\n"
3818 "\n"
3819 "    git rebase --edit-todo\n"
3820 "    git rebase --continue\n");
3821
3822 static int pick_commits(struct repository *r,
3823                         struct todo_list *todo_list,
3824                         struct replay_opts *opts)
3825 {
3826         int res = 0, reschedule = 0;
3827
3828         setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
3829         if (opts->allow_ff)
3830                 assert(!(opts->signoff || opts->no_commit ||
3831                                 opts->record_origin || opts->edit));
3832         if (read_and_refresh_cache(r, opts))
3833                 return -1;
3834
3835         while (todo_list->current < todo_list->nr) {
3836                 struct todo_item *item = todo_list->items + todo_list->current;
3837                 const char *arg = todo_item_get_arg(todo_list, item);
3838
3839                 if (save_todo(todo_list, opts))
3840                         return -1;
3841                 if (is_rebase_i(opts)) {
3842                         if (item->command != TODO_COMMENT) {
3843                                 FILE *f = fopen(rebase_path_msgnum(), "w");
3844
3845                                 todo_list->done_nr++;
3846
3847                                 if (f) {
3848                                         fprintf(f, "%d\n", todo_list->done_nr);
3849                                         fclose(f);
3850                                 }
3851                                 if (!opts->quiet)
3852                                         fprintf(stderr, "Rebasing (%d/%d)%s",
3853                                                 todo_list->done_nr,
3854                                                 todo_list->total_nr,
3855                                                 opts->verbose ? "\n" : "\r");
3856                         }
3857                         unlink(rebase_path_message());
3858                         unlink(rebase_path_author_script());
3859                         unlink(rebase_path_stopped_sha());
3860                         unlink(rebase_path_amend());
3861                         unlink(git_path_merge_head(r));
3862                         delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
3863
3864                         if (item->command == TODO_BREAK) {
3865                                 if (!opts->verbose)
3866                                         term_clear_line();
3867                                 return stopped_at_head(r);
3868                         }
3869                 }
3870                 if (item->command <= TODO_SQUASH) {
3871                         if (is_rebase_i(opts))
3872                                 setenv("GIT_REFLOG_ACTION", reflog_message(opts,
3873                                         command_to_string(item->command), NULL),
3874                                         1);
3875                         res = do_pick_commit(r, item->command, item->commit,
3876                                         opts, is_final_fixup(todo_list));
3877                         if (is_rebase_i(opts) && res < 0) {
3878                                 /* Reschedule */
3879                                 advise(_(rescheduled_advice),
3880                                        get_item_line_length(todo_list,
3881                                                             todo_list->current),
3882                                        get_item_line(todo_list,
3883                                                      todo_list->current));
3884                                 todo_list->current--;
3885                                 if (save_todo(todo_list, opts))
3886                                         return -1;
3887                         }
3888                         if (item->command == TODO_EDIT) {
3889                                 struct commit *commit = item->commit;
3890                                 if (!res) {
3891                                         if (!opts->verbose)
3892                                                 term_clear_line();
3893                                         fprintf(stderr,
3894                                                 _("Stopped at %s...  %.*s\n"),
3895                                                 short_commit_name(commit),
3896                                                 item->arg_len, arg);
3897                                 }
3898                                 return error_with_patch(r, commit,
3899                                         arg, item->arg_len, opts, res, !res);
3900                         }
3901                         if (is_rebase_i(opts) && !res)
3902                                 record_in_rewritten(&item->commit->object.oid,
3903                                         peek_command(todo_list, 1));
3904                         if (res && is_fixup(item->command)) {
3905                                 if (res == 1)
3906                                         intend_to_amend();
3907                                 return error_failed_squash(r, item->commit, opts,
3908                                         item->arg_len, arg);
3909                         } else if (res && is_rebase_i(opts) && item->commit) {
3910                                 int to_amend = 0;
3911                                 struct object_id oid;
3912
3913                                 /*
3914                                  * If we are rewording and have either
3915                                  * fast-forwarded already, or are about to
3916                                  * create a new root commit, we want to amend,
3917                                  * otherwise we do not.
3918                                  */
3919                                 if (item->command == TODO_REWORD &&
3920                                     !get_oid("HEAD", &oid) &&
3921                                     (oideq(&item->commit->object.oid, &oid) ||
3922                                      (opts->have_squash_onto &&
3923                                       oideq(&opts->squash_onto, &oid))))
3924                                         to_amend = 1;
3925
3926                                 return res | error_with_patch(r, item->commit,
3927                                                 arg, item->arg_len, opts,
3928                                                 res, to_amend);
3929                         }
3930                 } else if (item->command == TODO_EXEC) {
3931                         char *end_of_arg = (char *)(arg + item->arg_len);
3932                         int saved = *end_of_arg;
3933                         struct stat st;
3934
3935                         if (!opts->verbose)
3936                                 term_clear_line();
3937                         *end_of_arg = '\0';
3938                         res = do_exec(r, arg);
3939                         *end_of_arg = saved;
3940
3941                         if (res) {
3942                                 if (opts->reschedule_failed_exec)
3943                                         reschedule = 1;
3944                         } else if (stat(get_todo_path(opts), &st))
3945                                 res = error_errno(_("could not stat '%s'"),
3946                                                   get_todo_path(opts));
3947                         else if (match_stat_data(&todo_list->stat, &st)) {
3948                                 /* Reread the todo file if it has changed. */
3949                                 todo_list_release(todo_list);
3950                                 if (read_populate_todo(r, todo_list, opts))
3951                                         res = -1; /* message was printed */
3952                                 /* `current` will be incremented below */
3953                                 todo_list->current = -1;
3954                         }
3955                 } else if (item->command == TODO_LABEL) {
3956                         if ((res = do_label(r, arg, item->arg_len)))
3957                                 reschedule = 1;
3958                 } else if (item->command == TODO_RESET) {
3959                         if ((res = do_reset(r, arg, item->arg_len, opts)))
3960                                 reschedule = 1;
3961                 } else if (item->command == TODO_MERGE) {
3962                         if ((res = do_merge(r, item->commit,
3963                                             arg, item->arg_len,
3964                                             item->flags, opts)) < 0)
3965                                 reschedule = 1;
3966                         else if (item->commit)
3967                                 record_in_rewritten(&item->commit->object.oid,
3968                                                     peek_command(todo_list, 1));
3969                         if (res > 0)
3970                                 /* failed with merge conflicts */
3971                                 return error_with_patch(r, item->commit,
3972                                                         arg, item->arg_len,
3973                                                         opts, res, 0);
3974                 } else if (!is_noop(item->command))
3975                         return error(_("unknown command %d"), item->command);
3976
3977                 if (reschedule) {
3978                         advise(_(rescheduled_advice),
3979                                get_item_line_length(todo_list,
3980                                                     todo_list->current),
3981                                get_item_line(todo_list, todo_list->current));
3982                         todo_list->current--;
3983                         if (save_todo(todo_list, opts))
3984                                 return -1;
3985                         if (item->commit)
3986                                 return error_with_patch(r,
3987                                                         item->commit,
3988                                                         arg, item->arg_len,
3989                                                         opts, res, 0);
3990                 }
3991
3992                 todo_list->current++;
3993                 if (res)
3994                         return res;
3995         }
3996
3997         if (is_rebase_i(opts)) {
3998                 struct strbuf head_ref = STRBUF_INIT, buf = STRBUF_INIT;
3999                 struct stat st;
4000
4001                 /* Stopped in the middle, as planned? */
4002                 if (todo_list->current < todo_list->nr)
4003                         return 0;
4004
4005                 if (read_oneliner(&head_ref, rebase_path_head_name(), 0) &&
4006                                 starts_with(head_ref.buf, "refs/")) {
4007                         const char *msg;
4008                         struct object_id head, orig;
4009                         int res;
4010
4011                         if (get_oid("HEAD", &head)) {
4012                                 res = error(_("cannot read HEAD"));
4013 cleanup_head_ref:
4014                                 strbuf_release(&head_ref);
4015                                 strbuf_release(&buf);
4016                                 return res;
4017                         }
4018                         if (!read_oneliner(&buf, rebase_path_orig_head(), 0) ||
4019                                         get_oid_hex(buf.buf, &orig)) {
4020                                 res = error(_("could not read orig-head"));
4021                                 goto cleanup_head_ref;
4022                         }
4023                         strbuf_reset(&buf);
4024                         if (!read_oneliner(&buf, rebase_path_onto(), 0)) {
4025                                 res = error(_("could not read 'onto'"));
4026                                 goto cleanup_head_ref;
4027                         }
4028                         msg = reflog_message(opts, "finish", "%s onto %s",
4029                                 head_ref.buf, buf.buf);
4030                         if (update_ref(msg, head_ref.buf, &head, &orig,
4031                                        REF_NO_DEREF, UPDATE_REFS_MSG_ON_ERR)) {
4032                                 res = error(_("could not update %s"),
4033                                         head_ref.buf);
4034                                 goto cleanup_head_ref;
4035                         }
4036                         msg = reflog_message(opts, "finish", "returning to %s",
4037                                 head_ref.buf);
4038                         if (create_symref("HEAD", head_ref.buf, msg)) {
4039                                 res = error(_("could not update HEAD to %s"),
4040                                         head_ref.buf);
4041                                 goto cleanup_head_ref;
4042                         }
4043                         strbuf_reset(&buf);
4044                 }
4045
4046                 if (opts->verbose) {
4047                         struct rev_info log_tree_opt;
4048                         struct object_id orig, head;
4049
4050                         memset(&log_tree_opt, 0, sizeof(log_tree_opt));
4051                         repo_init_revisions(r, &log_tree_opt, NULL);
4052                         log_tree_opt.diff = 1;
4053                         log_tree_opt.diffopt.output_format =
4054                                 DIFF_FORMAT_DIFFSTAT;
4055                         log_tree_opt.disable_stdin = 1;
4056
4057                         if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
4058                             !get_oid(buf.buf, &orig) &&
4059                             !get_oid("HEAD", &head)) {
4060                                 diff_tree_oid(&orig, &head, "",
4061                                               &log_tree_opt.diffopt);
4062                                 log_tree_diff_flush(&log_tree_opt);
4063                         }
4064                 }
4065                 flush_rewritten_pending();
4066                 if (!stat(rebase_path_rewritten_list(), &st) &&
4067                                 st.st_size > 0) {
4068                         struct child_process child = CHILD_PROCESS_INIT;
4069                         const char *post_rewrite_hook =
4070                                 find_hook("post-rewrite");
4071
4072                         child.in = open(rebase_path_rewritten_list(), O_RDONLY);
4073                         child.git_cmd = 1;
4074                         argv_array_push(&child.args, "notes");
4075                         argv_array_push(&child.args, "copy");
4076                         argv_array_push(&child.args, "--for-rewrite=rebase");
4077                         /* we don't care if this copying failed */
4078                         run_command(&child);
4079
4080                         if (post_rewrite_hook) {
4081                                 struct child_process hook = CHILD_PROCESS_INIT;
4082
4083                                 hook.in = open(rebase_path_rewritten_list(),
4084                                         O_RDONLY);
4085                                 hook.stdout_to_stderr = 1;
4086                                 hook.trace2_hook_name = "post-rewrite";
4087                                 argv_array_push(&hook.args, post_rewrite_hook);
4088                                 argv_array_push(&hook.args, "rebase");
4089                                 /* we don't care if this hook failed */
4090                                 run_command(&hook);
4091                         }
4092                 }
4093                 apply_autostash(opts);
4094
4095                 if (!opts->quiet) {
4096                         if (!opts->verbose)
4097                                 term_clear_line();
4098                         fprintf(stderr,
4099                                 "Successfully rebased and updated %s.\n",
4100                                 head_ref.buf);
4101                 }
4102
4103                 strbuf_release(&buf);
4104                 strbuf_release(&head_ref);
4105         }
4106
4107         /*
4108          * Sequence of picks finished successfully; cleanup by
4109          * removing the .git/sequencer directory
4110          */
4111         return sequencer_remove_state(opts);
4112 }
4113
4114 static int continue_single_pick(struct repository *r)
4115 {
4116         const char *argv[] = { "commit", NULL };
4117
4118         if (!file_exists(git_path_cherry_pick_head(r)) &&
4119             !file_exists(git_path_revert_head(r)))
4120                 return error(_("no cherry-pick or revert in progress"));
4121         return run_command_v_opt(argv, RUN_GIT_CMD);
4122 }
4123
4124 static int commit_staged_changes(struct repository *r,
4125                                  struct replay_opts *opts,
4126                                  struct todo_list *todo_list)
4127 {
4128         unsigned int flags = ALLOW_EMPTY | EDIT_MSG;
4129         unsigned int final_fixup = 0, is_clean;
4130
4131         if (has_unstaged_changes(r, 1))
4132                 return error(_("cannot rebase: You have unstaged changes."));
4133
4134         is_clean = !has_uncommitted_changes(r, 0);
4135
4136         if (file_exists(rebase_path_amend())) {
4137                 struct strbuf rev = STRBUF_INIT;
4138                 struct object_id head, to_amend;
4139
4140                 if (get_oid("HEAD", &head))
4141                         return error(_("cannot amend non-existing commit"));
4142                 if (!read_oneliner(&rev, rebase_path_amend(), 0))
4143                         return error(_("invalid file: '%s'"), rebase_path_amend());
4144                 if (get_oid_hex(rev.buf, &to_amend))
4145                         return error(_("invalid contents: '%s'"),
4146                                 rebase_path_amend());
4147                 if (!is_clean && !oideq(&head, &to_amend))
4148                         return error(_("\nYou have uncommitted changes in your "
4149                                        "working tree. Please, commit them\n"
4150                                        "first and then run 'git rebase "
4151                                        "--continue' again."));
4152                 /*
4153                  * When skipping a failed fixup/squash, we need to edit the
4154                  * commit message, the current fixup list and count, and if it
4155                  * was the last fixup/squash in the chain, we need to clean up
4156                  * the commit message and if there was a squash, let the user
4157                  * edit it.
4158                  */
4159                 if (!is_clean || !opts->current_fixup_count)
4160                         ; /* this is not the final fixup */
4161                 else if (!oideq(&head, &to_amend) ||
4162                          !file_exists(rebase_path_stopped_sha())) {
4163                         /* was a final fixup or squash done manually? */
4164                         if (!is_fixup(peek_command(todo_list, 0))) {
4165                                 unlink(rebase_path_fixup_msg());
4166                                 unlink(rebase_path_squash_msg());
4167                                 unlink(rebase_path_current_fixups());
4168                                 strbuf_reset(&opts->current_fixups);
4169                                 opts->current_fixup_count = 0;
4170                         }
4171                 } else {
4172                         /* we are in a fixup/squash chain */
4173                         const char *p = opts->current_fixups.buf;
4174                         int len = opts->current_fixups.len;
4175
4176                         opts->current_fixup_count--;
4177                         if (!len)
4178                                 BUG("Incorrect current_fixups:\n%s", p);
4179                         while (len && p[len - 1] != '\n')
4180                                 len--;
4181                         strbuf_setlen(&opts->current_fixups, len);
4182                         if (write_message(p, len, rebase_path_current_fixups(),
4183                                           0) < 0)
4184                                 return error(_("could not write file: '%s'"),
4185                                              rebase_path_current_fixups());
4186
4187                         /*
4188                          * If a fixup/squash in a fixup/squash chain failed, the
4189                          * commit message is already correct, no need to commit
4190                          * it again.
4191                          *
4192                          * Only if it is the final command in the fixup/squash
4193                          * chain, and only if the chain is longer than a single
4194                          * fixup/squash command (which was just skipped), do we
4195                          * actually need to re-commit with a cleaned up commit
4196                          * message.
4197                          */
4198                         if (opts->current_fixup_count > 0 &&
4199                             !is_fixup(peek_command(todo_list, 0))) {
4200                                 final_fixup = 1;
4201                                 /*
4202                                  * If there was not a single "squash" in the
4203                                  * chain, we only need to clean up the commit
4204                                  * message, no need to bother the user with
4205                                  * opening the commit message in the editor.
4206                                  */
4207                                 if (!starts_with(p, "squash ") &&
4208                                     !strstr(p, "\nsquash "))
4209                                         flags = (flags & ~EDIT_MSG) | CLEANUP_MSG;
4210                         } else if (is_fixup(peek_command(todo_list, 0))) {
4211                                 /*
4212                                  * We need to update the squash message to skip
4213                                  * the latest commit message.
4214                                  */
4215                                 struct commit *commit;
4216                                 const char *path = rebase_path_squash_msg();
4217
4218                                 if (parse_head(r, &commit) ||
4219                                     !(p = get_commit_buffer(commit, NULL)) ||
4220                                     write_message(p, strlen(p), path, 0)) {
4221                                         unuse_commit_buffer(commit, p);
4222                                         return error(_("could not write file: "
4223                                                        "'%s'"), path);
4224                                 }
4225                                 unuse_commit_buffer(commit, p);
4226                         }
4227                 }
4228
4229                 strbuf_release(&rev);
4230                 flags |= AMEND_MSG;
4231         }
4232
4233         if (is_clean) {
4234                 const char *cherry_pick_head = git_path_cherry_pick_head(r);
4235
4236                 if (file_exists(cherry_pick_head) && unlink(cherry_pick_head))
4237                         return error(_("could not remove CHERRY_PICK_HEAD"));
4238                 if (!final_fixup)
4239                         return 0;
4240         }
4241
4242         if (run_git_commit(r, final_fixup ? NULL : rebase_path_message(),
4243                            opts, flags))
4244                 return error(_("could not commit staged changes."));
4245         unlink(rebase_path_amend());
4246         unlink(git_path_merge_head(r));
4247         if (final_fixup) {
4248                 unlink(rebase_path_fixup_msg());
4249                 unlink(rebase_path_squash_msg());
4250         }
4251         if (opts->current_fixup_count > 0) {
4252                 /*
4253                  * Whether final fixup or not, we just cleaned up the commit
4254                  * message...
4255                  */
4256                 unlink(rebase_path_current_fixups());
4257                 strbuf_reset(&opts->current_fixups);
4258                 opts->current_fixup_count = 0;
4259         }
4260         return 0;
4261 }
4262
4263 int sequencer_continue(struct repository *r, struct replay_opts *opts)
4264 {
4265         struct todo_list todo_list = TODO_LIST_INIT;
4266         int res;
4267
4268         if (read_and_refresh_cache(r, opts))
4269                 return -1;
4270
4271         if (read_populate_opts(opts))
4272                 return -1;
4273         if (is_rebase_i(opts)) {
4274                 if ((res = read_populate_todo(r, &todo_list, opts)))
4275                         goto release_todo_list;
4276                 if (commit_staged_changes(r, opts, &todo_list))
4277                         return -1;
4278         } else if (!file_exists(get_todo_path(opts)))
4279                 return continue_single_pick(r);
4280         else if ((res = read_populate_todo(r, &todo_list, opts)))
4281                 goto release_todo_list;
4282
4283         if (!is_rebase_i(opts)) {
4284                 /* Verify that the conflict has been resolved */
4285                 if (file_exists(git_path_cherry_pick_head(r)) ||
4286                     file_exists(git_path_revert_head(r))) {
4287                         res = continue_single_pick(r);
4288                         if (res)
4289                                 goto release_todo_list;
4290                 }
4291                 if (index_differs_from(r, "HEAD", NULL, 0)) {
4292                         res = error_dirty_index(r, opts);
4293                         goto release_todo_list;
4294                 }
4295                 todo_list.current++;
4296         } else if (file_exists(rebase_path_stopped_sha())) {
4297                 struct strbuf buf = STRBUF_INIT;
4298                 struct object_id oid;
4299
4300                 if (read_oneliner(&buf, rebase_path_stopped_sha(), 1) &&
4301                     !get_oid_committish(buf.buf, &oid))
4302                         record_in_rewritten(&oid, peek_command(&todo_list, 0));
4303                 strbuf_release(&buf);
4304         }
4305
4306         res = pick_commits(r, &todo_list, opts);
4307 release_todo_list:
4308         todo_list_release(&todo_list);
4309         return res;
4310 }
4311
4312 static int single_pick(struct repository *r,
4313                        struct commit *cmit,
4314                        struct replay_opts *opts)
4315 {
4316         setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
4317         return do_pick_commit(r, opts->action == REPLAY_PICK ?
4318                 TODO_PICK : TODO_REVERT, cmit, opts, 0);
4319 }
4320
4321 int sequencer_pick_revisions(struct repository *r,
4322                              struct replay_opts *opts)
4323 {
4324         struct todo_list todo_list = TODO_LIST_INIT;
4325         struct object_id oid;
4326         int i, res;
4327
4328         assert(opts->revs);
4329         if (read_and_refresh_cache(r, opts))
4330                 return -1;
4331
4332         for (i = 0; i < opts->revs->pending.nr; i++) {
4333                 struct object_id oid;
4334                 const char *name = opts->revs->pending.objects[i].name;
4335
4336                 /* This happens when using --stdin. */
4337                 if (!strlen(name))
4338                         continue;
4339
4340                 if (!get_oid(name, &oid)) {
4341                         if (!lookup_commit_reference_gently(r, &oid, 1)) {
4342                                 enum object_type type = oid_object_info(r,
4343                                                                         &oid,
4344                                                                         NULL);
4345                                 return error(_("%s: can't cherry-pick a %s"),
4346                                         name, type_name(type));
4347                         }
4348                 } else
4349                         return error(_("%s: bad revision"), name);
4350         }
4351
4352         /*
4353          * If we were called as "git cherry-pick <commit>", just
4354          * cherry-pick/revert it, set CHERRY_PICK_HEAD /
4355          * REVERT_HEAD, and don't touch the sequencer state.
4356          * This means it is possible to cherry-pick in the middle
4357          * of a cherry-pick sequence.
4358          */
4359         if (opts->revs->cmdline.nr == 1 &&
4360             opts->revs->cmdline.rev->whence == REV_CMD_REV &&
4361             opts->revs->no_walk &&
4362             !opts->revs->cmdline.rev->flags) {
4363                 struct commit *cmit;
4364                 if (prepare_revision_walk(opts->revs))
4365                         return error(_("revision walk setup failed"));
4366                 cmit = get_revision(opts->revs);
4367                 if (!cmit)
4368                         return error(_("empty commit set passed"));
4369                 if (get_revision(opts->revs))
4370                         BUG("unexpected extra commit from walk");
4371                 return single_pick(r, cmit, opts);
4372         }
4373
4374         /*
4375          * Start a new cherry-pick/ revert sequence; but
4376          * first, make sure that an existing one isn't in
4377          * progress
4378          */
4379
4380         if (walk_revs_populate_todo(&todo_list, opts) ||
4381                         create_seq_dir(r) < 0)
4382                 return -1;
4383         if (get_oid("HEAD", &oid) && (opts->action == REPLAY_REVERT))
4384                 return error(_("can't revert as initial commit"));
4385         if (save_head(oid_to_hex(&oid)))
4386                 return -1;
4387         if (save_opts(opts))
4388                 return -1;
4389         update_abort_safety_file();
4390         res = pick_commits(r, &todo_list, opts);
4391         todo_list_release(&todo_list);
4392         return res;
4393 }
4394
4395 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag)
4396 {
4397         unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
4398         struct strbuf sob = STRBUF_INIT;
4399         int has_footer;
4400
4401         strbuf_addstr(&sob, sign_off_header);
4402         strbuf_addstr(&sob, fmt_name(WANT_COMMITTER_IDENT));
4403         strbuf_addch(&sob, '\n');
4404
4405         if (!ignore_footer)
4406                 strbuf_complete_line(msgbuf);
4407
4408         /*
4409          * If the whole message buffer is equal to the sob, pretend that we
4410          * found a conforming footer with a matching sob
4411          */
4412         if (msgbuf->len - ignore_footer == sob.len &&
4413             !strncmp(msgbuf->buf, sob.buf, sob.len))
4414                 has_footer = 3;
4415         else
4416                 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
4417
4418         if (!has_footer) {
4419                 const char *append_newlines = NULL;
4420                 size_t len = msgbuf->len - ignore_footer;
4421
4422                 if (!len) {
4423                         /*
4424                          * The buffer is completely empty.  Leave foom for
4425                          * the title and body to be filled in by the user.
4426                          */
4427                         append_newlines = "\n\n";
4428                 } else if (len == 1) {
4429                         /*
4430                          * Buffer contains a single newline.  Add another
4431                          * so that we leave room for the title and body.
4432                          */
4433                         append_newlines = "\n";
4434                 } else if (msgbuf->buf[len - 2] != '\n') {
4435                         /*
4436                          * Buffer ends with a single newline.  Add another
4437                          * so that there is an empty line between the message
4438                          * body and the sob.
4439                          */
4440                         append_newlines = "\n";
4441                 } /* else, the buffer already ends with two newlines. */
4442
4443                 if (append_newlines)
4444                         strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
4445                                 append_newlines, strlen(append_newlines));
4446         }
4447
4448         if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
4449                 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
4450                                 sob.buf, sob.len);
4451
4452         strbuf_release(&sob);
4453 }
4454
4455 struct labels_entry {
4456         struct hashmap_entry entry;
4457         char label[FLEX_ARRAY];
4458 };
4459
4460 static int labels_cmp(const void *fndata, const struct labels_entry *a,
4461                       const struct labels_entry *b, const void *key)
4462 {
4463         return key ? strcmp(a->label, key) : strcmp(a->label, b->label);
4464 }
4465
4466 struct string_entry {
4467         struct oidmap_entry entry;
4468         char string[FLEX_ARRAY];
4469 };
4470
4471 struct label_state {
4472         struct oidmap commit2label;
4473         struct hashmap labels;
4474         struct strbuf buf;
4475 };
4476
4477 static const char *label_oid(struct object_id *oid, const char *label,
4478                              struct label_state *state)
4479 {
4480         struct labels_entry *labels_entry;
4481         struct string_entry *string_entry;
4482         struct object_id dummy;
4483         size_t len;
4484         int i;
4485
4486         string_entry = oidmap_get(&state->commit2label, oid);
4487         if (string_entry)
4488                 return string_entry->string;
4489
4490         /*
4491          * For "uninteresting" commits, i.e. commits that are not to be
4492          * rebased, and which can therefore not be labeled, we use a unique
4493          * abbreviation of the commit name. This is slightly more complicated
4494          * than calling find_unique_abbrev() because we also need to make
4495          * sure that the abbreviation does not conflict with any other
4496          * label.
4497          *
4498          * We disallow "interesting" commits to be labeled by a string that
4499          * is a valid full-length hash, to ensure that we always can find an
4500          * abbreviation for any uninteresting commit's names that does not
4501          * clash with any other label.
4502          */
4503         if (!label) {
4504                 char *p;
4505
4506                 strbuf_reset(&state->buf);
4507                 strbuf_grow(&state->buf, GIT_SHA1_HEXSZ);
4508                 label = p = state->buf.buf;
4509
4510                 find_unique_abbrev_r(p, oid, default_abbrev);
4511
4512                 /*
4513                  * We may need to extend the abbreviated hash so that there is
4514                  * no conflicting label.
4515                  */
4516                 if (hashmap_get_from_hash(&state->labels, strihash(p), p)) {
4517                         size_t i = strlen(p) + 1;
4518
4519                         oid_to_hex_r(p, oid);
4520                         for (; i < GIT_SHA1_HEXSZ; i++) {
4521                                 char save = p[i];
4522                                 p[i] = '\0';
4523                                 if (!hashmap_get_from_hash(&state->labels,
4524                                                            strihash(p), p))
4525                                         break;
4526                                 p[i] = save;
4527                         }
4528                 }
4529         } else if (((len = strlen(label)) == the_hash_algo->hexsz &&
4530                     !get_oid_hex(label, &dummy)) ||
4531                    (len == 1 && *label == '#') ||
4532                    hashmap_get_from_hash(&state->labels,
4533                                          strihash(label), label)) {
4534                 /*
4535                  * If the label already exists, or if the label is a valid full
4536                  * OID, or the label is a '#' (which we use as a separator
4537                  * between merge heads and oneline), we append a dash and a
4538                  * number to make it unique.
4539                  */
4540                 struct strbuf *buf = &state->buf;
4541
4542                 strbuf_reset(buf);
4543                 strbuf_add(buf, label, len);
4544
4545                 for (i = 2; ; i++) {
4546                         strbuf_setlen(buf, len);
4547                         strbuf_addf(buf, "-%d", i);
4548                         if (!hashmap_get_from_hash(&state->labels,
4549                                                    strihash(buf->buf),
4550                                                    buf->buf))
4551                                 break;
4552                 }
4553
4554                 label = buf->buf;
4555         }
4556
4557         FLEX_ALLOC_STR(labels_entry, label, label);
4558         hashmap_entry_init(labels_entry, strihash(label));
4559         hashmap_add(&state->labels, labels_entry);
4560
4561         FLEX_ALLOC_STR(string_entry, string, label);
4562         oidcpy(&string_entry->entry.oid, oid);
4563         oidmap_put(&state->commit2label, string_entry);
4564
4565         return string_entry->string;
4566 }
4567
4568 static int make_script_with_merges(struct pretty_print_context *pp,
4569                                    struct rev_info *revs, struct strbuf *out,
4570                                    unsigned flags)
4571 {
4572         int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
4573         int rebase_cousins = flags & TODO_LIST_REBASE_COUSINS;
4574         int root_with_onto = flags & TODO_LIST_ROOT_WITH_ONTO;
4575         struct strbuf buf = STRBUF_INIT, oneline = STRBUF_INIT;
4576         struct strbuf label = STRBUF_INIT;
4577         struct commit_list *commits = NULL, **tail = &commits, *iter;
4578         struct commit_list *tips = NULL, **tips_tail = &tips;
4579         struct commit *commit;
4580         struct oidmap commit2todo = OIDMAP_INIT;
4581         struct string_entry *entry;
4582         struct oidset interesting = OIDSET_INIT, child_seen = OIDSET_INIT,
4583                 shown = OIDSET_INIT;
4584         struct label_state state = { OIDMAP_INIT, { NULL }, STRBUF_INIT };
4585
4586         int abbr = flags & TODO_LIST_ABBREVIATE_CMDS;
4587         const char *cmd_pick = abbr ? "p" : "pick",
4588                 *cmd_label = abbr ? "l" : "label",
4589                 *cmd_reset = abbr ? "t" : "reset",
4590                 *cmd_merge = abbr ? "m" : "merge";
4591
4592         oidmap_init(&commit2todo, 0);
4593         oidmap_init(&state.commit2label, 0);
4594         hashmap_init(&state.labels, (hashmap_cmp_fn) labels_cmp, NULL, 0);
4595         strbuf_init(&state.buf, 32);
4596
4597         if (revs->cmdline.nr && (revs->cmdline.rev[0].flags & BOTTOM)) {
4598                 struct object_id *oid = &revs->cmdline.rev[0].item->oid;
4599                 FLEX_ALLOC_STR(entry, string, "onto");
4600                 oidcpy(&entry->entry.oid, oid);
4601                 oidmap_put(&state.commit2label, entry);
4602         }
4603
4604         /*
4605          * First phase:
4606          * - get onelines for all commits
4607          * - gather all branch tips (i.e. 2nd or later parents of merges)
4608          * - label all branch tips
4609          */
4610         while ((commit = get_revision(revs))) {
4611                 struct commit_list *to_merge;
4612                 const char *p1, *p2;
4613                 struct object_id *oid;
4614                 int is_empty;
4615
4616                 tail = &commit_list_insert(commit, tail)->next;
4617                 oidset_insert(&interesting, &commit->object.oid);
4618
4619                 is_empty = is_original_commit_empty(commit);
4620                 if (!is_empty && (commit->object.flags & PATCHSAME))
4621                         continue;
4622
4623                 strbuf_reset(&oneline);
4624                 pretty_print_commit(pp, commit, &oneline);
4625
4626                 to_merge = commit->parents ? commit->parents->next : NULL;
4627                 if (!to_merge) {
4628                         /* non-merge commit: easy case */
4629                         strbuf_reset(&buf);
4630                         if (!keep_empty && is_empty)
4631                                 strbuf_addf(&buf, "%c ", comment_line_char);
4632                         strbuf_addf(&buf, "%s %s %s", cmd_pick,
4633                                     oid_to_hex(&commit->object.oid),
4634                                     oneline.buf);
4635
4636                         FLEX_ALLOC_STR(entry, string, buf.buf);
4637                         oidcpy(&entry->entry.oid, &commit->object.oid);
4638                         oidmap_put(&commit2todo, entry);
4639
4640                         continue;
4641                 }
4642
4643                 /* Create a label */
4644                 strbuf_reset(&label);
4645                 if (skip_prefix(oneline.buf, "Merge ", &p1) &&
4646                     (p1 = strchr(p1, '\'')) &&
4647                     (p2 = strchr(++p1, '\'')))
4648                         strbuf_add(&label, p1, p2 - p1);
4649                 else if (skip_prefix(oneline.buf, "Merge pull request ",
4650                                      &p1) &&
4651                          (p1 = strstr(p1, " from ")))
4652                         strbuf_addstr(&label, p1 + strlen(" from "));
4653                 else
4654                         strbuf_addbuf(&label, &oneline);
4655
4656                 for (p1 = label.buf; *p1; p1++)
4657                         if (isspace(*p1))
4658                                 *(char *)p1 = '-';
4659
4660                 strbuf_reset(&buf);
4661                 strbuf_addf(&buf, "%s -C %s",
4662                             cmd_merge, oid_to_hex(&commit->object.oid));
4663
4664                 /* label the tips of merged branches */
4665                 for (; to_merge; to_merge = to_merge->next) {
4666                         oid = &to_merge->item->object.oid;
4667                         strbuf_addch(&buf, ' ');
4668
4669                         if (!oidset_contains(&interesting, oid)) {
4670                                 strbuf_addstr(&buf, label_oid(oid, NULL,
4671                                                               &state));
4672                                 continue;
4673                         }
4674
4675                         tips_tail = &commit_list_insert(to_merge->item,
4676                                                         tips_tail)->next;
4677
4678                         strbuf_addstr(&buf, label_oid(oid, label.buf, &state));
4679                 }
4680                 strbuf_addf(&buf, " # %s", oneline.buf);
4681
4682                 FLEX_ALLOC_STR(entry, string, buf.buf);
4683                 oidcpy(&entry->entry.oid, &commit->object.oid);
4684                 oidmap_put(&commit2todo, entry);
4685         }
4686
4687         /*
4688          * Second phase:
4689          * - label branch points
4690          * - add HEAD to the branch tips
4691          */
4692         for (iter = commits; iter; iter = iter->next) {
4693                 struct commit_list *parent = iter->item->parents;
4694                 for (; parent; parent = parent->next) {
4695                         struct object_id *oid = &parent->item->object.oid;
4696                         if (!oidset_contains(&interesting, oid))
4697                                 continue;
4698                         if (oidset_insert(&child_seen, oid))
4699                                 label_oid(oid, "branch-point", &state);
4700                 }
4701
4702                 /* Add HEAD as implict "tip of branch" */
4703                 if (!iter->next)
4704                         tips_tail = &commit_list_insert(iter->item,
4705                                                         tips_tail)->next;
4706         }
4707
4708         /*
4709          * Third phase: output the todo list. This is a bit tricky, as we
4710          * want to avoid jumping back and forth between revisions. To
4711          * accomplish that goal, we walk backwards from the branch tips,
4712          * gathering commits not yet shown, reversing the list on the fly,
4713          * then outputting that list (labeling revisions as needed).
4714          */
4715         strbuf_addf(out, "%s onto\n", cmd_label);
4716         for (iter = tips; iter; iter = iter->next) {
4717                 struct commit_list *list = NULL, *iter2;
4718
4719                 commit = iter->item;
4720                 if (oidset_contains(&shown, &commit->object.oid))
4721                         continue;
4722                 entry = oidmap_get(&state.commit2label, &commit->object.oid);
4723
4724                 if (entry)
4725                         strbuf_addf(out, "\n%c Branch %s\n", comment_line_char, entry->string);
4726                 else
4727                         strbuf_addch(out, '\n');
4728
4729                 while (oidset_contains(&interesting, &commit->object.oid) &&
4730                        !oidset_contains(&shown, &commit->object.oid)) {
4731                         commit_list_insert(commit, &list);
4732                         if (!commit->parents) {
4733                                 commit = NULL;
4734                                 break;
4735                         }
4736                         commit = commit->parents->item;
4737                 }
4738
4739                 if (!commit)
4740                         strbuf_addf(out, "%s %s\n", cmd_reset,
4741                                     rebase_cousins || root_with_onto ?
4742                                     "onto" : "[new root]");
4743                 else {
4744                         const char *to = NULL;
4745
4746                         entry = oidmap_get(&state.commit2label,
4747                                            &commit->object.oid);
4748                         if (entry)
4749                                 to = entry->string;
4750                         else if (!rebase_cousins)
4751                                 to = label_oid(&commit->object.oid, NULL,
4752                                                &state);
4753
4754                         if (!to || !strcmp(to, "onto"))
4755                                 strbuf_addf(out, "%s onto\n", cmd_reset);
4756                         else {
4757                                 strbuf_reset(&oneline);
4758                                 pretty_print_commit(pp, commit, &oneline);
4759                                 strbuf_addf(out, "%s %s # %s\n",
4760                                             cmd_reset, to, oneline.buf);
4761                         }
4762                 }
4763
4764                 for (iter2 = list; iter2; iter2 = iter2->next) {
4765                         struct object_id *oid = &iter2->item->object.oid;
4766                         entry = oidmap_get(&commit2todo, oid);
4767                         /* only show if not already upstream */
4768                         if (entry)
4769                                 strbuf_addf(out, "%s\n", entry->string);
4770                         entry = oidmap_get(&state.commit2label, oid);
4771                         if (entry)
4772                                 strbuf_addf(out, "%s %s\n",
4773                                             cmd_label, entry->string);
4774                         oidset_insert(&shown, oid);
4775                 }
4776
4777                 free_commit_list(list);
4778         }
4779
4780         free_commit_list(commits);
4781         free_commit_list(tips);
4782
4783         strbuf_release(&label);
4784         strbuf_release(&oneline);
4785         strbuf_release(&buf);
4786
4787         oidmap_free(&commit2todo, 1);
4788         oidmap_free(&state.commit2label, 1);
4789         hashmap_free(&state.labels, 1);
4790         strbuf_release(&state.buf);
4791
4792         return 0;
4793 }
4794
4795 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
4796                           const char **argv, unsigned flags)
4797 {
4798         char *format = NULL;
4799         struct pretty_print_context pp = {0};
4800         struct rev_info revs;
4801         struct commit *commit;
4802         int keep_empty = flags & TODO_LIST_KEEP_EMPTY;
4803         const char *insn = flags & TODO_LIST_ABBREVIATE_CMDS ? "p" : "pick";
4804         int rebase_merges = flags & TODO_LIST_REBASE_MERGES;
4805
4806         repo_init_revisions(r, &revs, NULL);
4807         revs.verbose_header = 1;
4808         if (!rebase_merges)
4809                 revs.max_parents = 1;
4810         revs.cherry_mark = 1;
4811         revs.limited = 1;
4812         revs.reverse = 1;
4813         revs.right_only = 1;
4814         revs.sort_order = REV_SORT_IN_GRAPH_ORDER;
4815         revs.topo_order = 1;
4816
4817         revs.pretty_given = 1;
4818         git_config_get_string("rebase.instructionFormat", &format);
4819         if (!format || !*format) {
4820                 free(format);
4821                 format = xstrdup("%s");
4822         }
4823         get_commit_format(format, &revs);
4824         free(format);
4825         pp.fmt = revs.commit_format;
4826         pp.output_encoding = get_log_output_encoding();
4827
4828         if (setup_revisions(argc, argv, &revs, NULL) > 1)
4829                 return error(_("make_script: unhandled options"));
4830
4831         if (prepare_revision_walk(&revs) < 0)
4832                 return error(_("make_script: error preparing revisions"));
4833
4834         if (rebase_merges)
4835                 return make_script_with_merges(&pp, &revs, out, flags);
4836
4837         while ((commit = get_revision(&revs))) {
4838                 int is_empty  = is_original_commit_empty(commit);
4839
4840                 if (!is_empty && (commit->object.flags & PATCHSAME))
4841                         continue;
4842                 if (!keep_empty && is_empty)
4843                         strbuf_addf(out, "%c ", comment_line_char);
4844                 strbuf_addf(out, "%s %s ", insn,
4845                             oid_to_hex(&commit->object.oid));
4846                 pretty_print_commit(&pp, commit, out);
4847                 strbuf_addch(out, '\n');
4848         }
4849         return 0;
4850 }
4851
4852 /*
4853  * Add commands after pick and (series of) squash/fixup commands
4854  * in the todo list.
4855  */
4856 void todo_list_add_exec_commands(struct todo_list *todo_list,
4857                                  struct string_list *commands)
4858 {
4859         struct strbuf *buf = &todo_list->buf;
4860         size_t base_offset = buf->len;
4861         int i, insert, nr = 0, alloc = 0;
4862         struct todo_item *items = NULL, *base_items = NULL;
4863
4864         base_items = xcalloc(commands->nr, sizeof(struct todo_item));
4865         for (i = 0; i < commands->nr; i++) {
4866                 size_t command_len = strlen(commands->items[i].string);
4867
4868                 strbuf_addstr(buf, commands->items[i].string);
4869                 strbuf_addch(buf, '\n');
4870
4871                 base_items[i].command = TODO_EXEC;
4872                 base_items[i].offset_in_buf = base_offset;
4873                 base_items[i].arg_offset = base_offset + strlen("exec ");
4874                 base_items[i].arg_len = command_len - strlen("exec ");
4875
4876                 base_offset += command_len + 1;
4877         }
4878
4879         /*
4880          * Insert <commands> after every pick. Here, fixup/squash chains
4881          * are considered part of the pick, so we insert the commands *after*
4882          * those chains if there are any.
4883          *
4884          * As we insert the exec commands immediatly after rearranging
4885          * any fixups and before the user edits the list, a fixup chain
4886          * can never contain comments (any comments are empty picks that
4887          * have been commented out because the user did not specify
4888          * --keep-empty).  So, it is safe to insert an exec command
4889          * without looking at the command following a comment.
4890          */
4891         insert = 0;
4892         for (i = 0; i < todo_list->nr; i++) {
4893                 enum todo_command command = todo_list->items[i].command;
4894                 if (insert && !is_fixup(command)) {
4895                         ALLOC_GROW(items, nr + commands->nr, alloc);
4896                         COPY_ARRAY(items + nr, base_items, commands->nr);
4897                         nr += commands->nr;
4898
4899                         insert = 0;
4900                 }
4901
4902                 ALLOC_GROW(items, nr + 1, alloc);
4903                 items[nr++] = todo_list->items[i];
4904
4905                 if (command == TODO_PICK || command == TODO_MERGE)
4906                         insert = 1;
4907         }
4908
4909         /* insert or append final <commands> */
4910         if (insert || nr == todo_list->nr) {
4911                 ALLOC_GROW(items, nr + commands->nr, alloc);
4912                 COPY_ARRAY(items + nr, base_items, commands->nr);
4913                 nr += commands->nr;
4914         }
4915
4916         free(base_items);
4917         FREE_AND_NULL(todo_list->items);
4918         todo_list->items = items;
4919         todo_list->nr = nr;
4920         todo_list->alloc = alloc;
4921 }
4922
4923 static void todo_list_to_strbuf(struct repository *r, struct todo_list *todo_list,
4924                                 struct strbuf *buf, int num, unsigned flags)
4925 {
4926         struct todo_item *item;
4927         int i, max = todo_list->nr;
4928
4929         if (num > 0 && num < max)
4930                 max = num;
4931
4932         for (item = todo_list->items, i = 0; i < max; i++, item++) {
4933                 /* if the item is not a command write it and continue */
4934                 if (item->command >= TODO_COMMENT) {
4935                         strbuf_addf(buf, "%.*s\n", item->arg_len,
4936                                     todo_item_get_arg(todo_list, item));
4937                         continue;
4938                 }
4939
4940                 /* add command to the buffer */
4941                 if (flags & TODO_LIST_ABBREVIATE_CMDS)
4942                         strbuf_addch(buf, command_to_char(item->command));
4943                 else
4944                         strbuf_addstr(buf, command_to_string(item->command));
4945
4946                 /* add commit id */
4947                 if (item->commit) {
4948                         const char *oid = flags & TODO_LIST_SHORTEN_IDS ?
4949                                           short_commit_name(item->commit) :
4950                                           oid_to_hex(&item->commit->object.oid);
4951
4952                         if (item->command == TODO_MERGE) {
4953                                 if (item->flags & TODO_EDIT_MERGE_MSG)
4954                                         strbuf_addstr(buf, " -c");
4955                                 else
4956                                         strbuf_addstr(buf, " -C");
4957                         }
4958
4959                         strbuf_addf(buf, " %s", oid);
4960                 }
4961
4962                 /* add all the rest */
4963                 if (!item->arg_len)
4964                         strbuf_addch(buf, '\n');
4965                 else
4966                         strbuf_addf(buf, " %.*s\n", item->arg_len,
4967                                     todo_item_get_arg(todo_list, item));
4968         }
4969 }
4970
4971 int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
4972                             const char *file, const char *shortrevisions,
4973                             const char *shortonto, int num, unsigned flags)
4974 {
4975         int res;
4976         struct strbuf buf = STRBUF_INIT;
4977
4978         todo_list_to_strbuf(r, todo_list, &buf, num, flags);
4979         if (flags & TODO_LIST_APPEND_TODO_HELP)
4980                 append_todo_help(flags & TODO_LIST_KEEP_EMPTY, count_commands(todo_list),
4981                                  shortrevisions, shortonto, &buf);
4982
4983         res = write_message(buf.buf, buf.len, file, 0);
4984         strbuf_release(&buf);
4985
4986         return res;
4987 }
4988
4989 static const char edit_todo_list_advice[] =
4990 N_("You can fix this with 'git rebase --edit-todo' "
4991 "and then run 'git rebase --continue'.\n"
4992 "Or you can abort the rebase with 'git rebase"
4993 " --abort'.\n");
4994
4995 int check_todo_list_from_file(struct repository *r)
4996 {
4997         struct todo_list old_todo = TODO_LIST_INIT, new_todo = TODO_LIST_INIT;
4998         int res = 0;
4999
5000         if (strbuf_read_file_or_whine(&new_todo.buf, rebase_path_todo()) < 0) {
5001                 res = -1;
5002                 goto out;
5003         }
5004
5005         if (strbuf_read_file_or_whine(&old_todo.buf, rebase_path_todo_backup()) < 0) {
5006                 res = -1;
5007                 goto out;
5008         }
5009
5010         res = todo_list_parse_insn_buffer(r, old_todo.buf.buf, &old_todo);
5011         if (!res)
5012                 res = todo_list_parse_insn_buffer(r, new_todo.buf.buf, &new_todo);
5013         if (!res)
5014                 res = todo_list_check(&old_todo, &new_todo);
5015         if (res)
5016                 fprintf(stderr, _(edit_todo_list_advice));
5017 out:
5018         todo_list_release(&old_todo);
5019         todo_list_release(&new_todo);
5020
5021         return res;
5022 }
5023
5024 /* skip picking commits whose parents are unchanged */
5025 static int skip_unnecessary_picks(struct repository *r,
5026                                   struct todo_list *todo_list,
5027                                   struct object_id *base_oid)
5028 {
5029         struct object_id *parent_oid;
5030         int i;
5031
5032         for (i = 0; i < todo_list->nr; i++) {
5033                 struct todo_item *item = todo_list->items + i;
5034
5035                 if (item->command >= TODO_NOOP)
5036                         continue;
5037                 if (item->command != TODO_PICK)
5038                         break;
5039                 if (parse_commit(item->commit)) {
5040                         return error(_("could not parse commit '%s'"),
5041                                 oid_to_hex(&item->commit->object.oid));
5042                 }
5043                 if (!item->commit->parents)
5044                         break; /* root commit */
5045                 if (item->commit->parents->next)
5046                         break; /* merge commit */
5047                 parent_oid = &item->commit->parents->item->object.oid;
5048                 if (!oideq(parent_oid, base_oid))
5049                         break;
5050                 oidcpy(base_oid, &item->commit->object.oid);
5051         }
5052         if (i > 0) {
5053                 const char *done_path = rebase_path_done();
5054
5055                 if (todo_list_write_to_file(r, todo_list, done_path, NULL, NULL, i, 0)) {
5056                         error_errno(_("could not write to '%s'"), done_path);
5057                         return -1;
5058                 }
5059
5060                 MOVE_ARRAY(todo_list->items, todo_list->items + i, todo_list->nr - i);
5061                 todo_list->nr -= i;
5062                 todo_list->current = 0;
5063                 todo_list->done_nr += i;
5064
5065                 if (is_fixup(peek_command(todo_list, 0)))
5066                         record_in_rewritten(base_oid, peek_command(todo_list, 0));
5067         }
5068
5069         return 0;
5070 }
5071
5072 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
5073                     const char *shortrevisions, const char *onto_name,
5074                     struct commit *onto, const char *orig_head,
5075                     struct string_list *commands, unsigned autosquash,
5076                     struct todo_list *todo_list)
5077 {
5078         const char *shortonto, *todo_file = rebase_path_todo();
5079         struct todo_list new_todo = TODO_LIST_INIT;
5080         struct strbuf *buf = &todo_list->buf;
5081         struct object_id oid = onto->object.oid;
5082         int res;
5083
5084         shortonto = find_unique_abbrev(&oid, DEFAULT_ABBREV);
5085
5086         if (buf->len == 0) {
5087                 struct todo_item *item = append_new_todo(todo_list);
5088                 item->command = TODO_NOOP;
5089                 item->commit = NULL;
5090                 item->arg_len = item->arg_offset = item->flags = item->offset_in_buf = 0;
5091         }
5092
5093         if (autosquash && todo_list_rearrange_squash(todo_list))
5094                 return -1;
5095
5096         if (commands->nr)
5097                 todo_list_add_exec_commands(todo_list, commands);
5098
5099         if (count_commands(todo_list) == 0) {
5100                 apply_autostash(opts);
5101                 sequencer_remove_state(opts);
5102
5103                 return error(_("nothing to do"));
5104         }
5105
5106         res = edit_todo_list(r, todo_list, &new_todo, shortrevisions,
5107                              shortonto, flags);
5108         if (res == -1)
5109                 return -1;
5110         else if (res == -2) {
5111                 apply_autostash(opts);
5112                 sequencer_remove_state(opts);
5113
5114                 return -1;
5115         } else if (res == -3) {
5116                 apply_autostash(opts);
5117                 sequencer_remove_state(opts);
5118                 todo_list_release(&new_todo);
5119
5120                 return error(_("nothing to do"));
5121         }
5122
5123         if (todo_list_parse_insn_buffer(r, new_todo.buf.buf, &new_todo) ||
5124             todo_list_check(todo_list, &new_todo)) {
5125                 fprintf(stderr, _(edit_todo_list_advice));
5126                 checkout_onto(r, opts, onto_name, &onto->object.oid, orig_head);
5127                 todo_list_release(&new_todo);
5128
5129                 return -1;
5130         }
5131
5132         if (opts->allow_ff && skip_unnecessary_picks(r, &new_todo, &oid)) {
5133                 todo_list_release(&new_todo);
5134                 return error(_("could not skip unnecessary pick commands"));
5135         }
5136
5137         if (todo_list_write_to_file(r, &new_todo, todo_file, NULL, NULL, -1,
5138                                     flags & ~(TODO_LIST_SHORTEN_IDS))) {
5139                 todo_list_release(&new_todo);
5140                 return error_errno(_("could not write '%s'"), todo_file);
5141         }
5142
5143         todo_list_release(&new_todo);
5144
5145         if (checkout_onto(r, opts, onto_name, &oid, orig_head))
5146                 return -1;
5147
5148         if (require_clean_work_tree(r, "rebase", "", 1, 1))
5149                 return -1;
5150
5151         return sequencer_continue(r, opts);
5152 }
5153
5154 struct subject2item_entry {
5155         struct hashmap_entry entry;
5156         int i;
5157         char subject[FLEX_ARRAY];
5158 };
5159
5160 static int subject2item_cmp(const void *fndata,
5161                             const struct subject2item_entry *a,
5162                             const struct subject2item_entry *b, const void *key)
5163 {
5164         return key ? strcmp(a->subject, key) : strcmp(a->subject, b->subject);
5165 }
5166
5167 define_commit_slab(commit_todo_item, struct todo_item *);
5168
5169 /*
5170  * Rearrange the todo list that has both "pick commit-id msg" and "pick
5171  * commit-id fixup!/squash! msg" in it so that the latter is put immediately
5172  * after the former, and change "pick" to "fixup"/"squash".
5173  *
5174  * Note that if the config has specified a custom instruction format, each log
5175  * message will have to be retrieved from the commit (as the oneline in the
5176  * script cannot be trusted) in order to normalize the autosquash arrangement.
5177  */
5178 int todo_list_rearrange_squash(struct todo_list *todo_list)
5179 {
5180         struct hashmap subject2item;
5181         int rearranged = 0, *next, *tail, i, nr = 0, alloc = 0;
5182         char **subjects;
5183         struct commit_todo_item commit_todo;
5184         struct todo_item *items = NULL;
5185
5186         init_commit_todo_item(&commit_todo);
5187         /*
5188          * The hashmap maps onelines to the respective todo list index.
5189          *
5190          * If any items need to be rearranged, the next[i] value will indicate
5191          * which item was moved directly after the i'th.
5192          *
5193          * In that case, last[i] will indicate the index of the latest item to
5194          * be moved to appear after the i'th.
5195          */
5196         hashmap_init(&subject2item, (hashmap_cmp_fn) subject2item_cmp,
5197                      NULL, todo_list->nr);
5198         ALLOC_ARRAY(next, todo_list->nr);
5199         ALLOC_ARRAY(tail, todo_list->nr);
5200         ALLOC_ARRAY(subjects, todo_list->nr);
5201         for (i = 0; i < todo_list->nr; i++) {
5202                 struct strbuf buf = STRBUF_INIT;
5203                 struct todo_item *item = todo_list->items + i;
5204                 const char *commit_buffer, *subject, *p;
5205                 size_t subject_len;
5206                 int i2 = -1;
5207                 struct subject2item_entry *entry;
5208
5209                 next[i] = tail[i] = -1;
5210                 if (!item->commit || item->command == TODO_DROP) {
5211                         subjects[i] = NULL;
5212                         continue;
5213                 }
5214
5215                 if (is_fixup(item->command)) {
5216                         clear_commit_todo_item(&commit_todo);
5217                         return error(_("the script was already rearranged."));
5218                 }
5219
5220                 *commit_todo_item_at(&commit_todo, item->commit) = item;
5221
5222                 parse_commit(item->commit);
5223                 commit_buffer = get_commit_buffer(item->commit, NULL);
5224                 find_commit_subject(commit_buffer, &subject);
5225                 format_subject(&buf, subject, " ");
5226                 subject = subjects[i] = strbuf_detach(&buf, &subject_len);
5227                 unuse_commit_buffer(item->commit, commit_buffer);
5228                 if ((skip_prefix(subject, "fixup! ", &p) ||
5229                      skip_prefix(subject, "squash! ", &p))) {
5230                         struct commit *commit2;
5231
5232                         for (;;) {
5233                                 while (isspace(*p))
5234                                         p++;
5235                                 if (!skip_prefix(p, "fixup! ", &p) &&
5236                                     !skip_prefix(p, "squash! ", &p))
5237                                         break;
5238                         }
5239
5240                         if ((entry = hashmap_get_from_hash(&subject2item,
5241                                                            strhash(p), p)))
5242                                 /* found by title */
5243                                 i2 = entry->i;
5244                         else if (!strchr(p, ' ') &&
5245                                  (commit2 =
5246                                   lookup_commit_reference_by_name(p)) &&
5247                                  *commit_todo_item_at(&commit_todo, commit2))
5248                                 /* found by commit name */
5249                                 i2 = *commit_todo_item_at(&commit_todo, commit2)
5250                                         - todo_list->items;
5251                         else {
5252                                 /* copy can be a prefix of the commit subject */
5253                                 for (i2 = 0; i2 < i; i2++)
5254                                         if (subjects[i2] &&
5255                                             starts_with(subjects[i2], p))
5256                                                 break;
5257                                 if (i2 == i)
5258                                         i2 = -1;
5259                         }
5260                 }
5261                 if (i2 >= 0) {
5262                         rearranged = 1;
5263                         todo_list->items[i].command =
5264                                 starts_with(subject, "fixup!") ?
5265                                 TODO_FIXUP : TODO_SQUASH;
5266                         if (next[i2] < 0)
5267                                 next[i2] = i;
5268                         else
5269                                 next[tail[i2]] = i;
5270                         tail[i2] = i;
5271                 } else if (!hashmap_get_from_hash(&subject2item,
5272                                                 strhash(subject), subject)) {
5273                         FLEX_ALLOC_MEM(entry, subject, subject, subject_len);
5274                         entry->i = i;
5275                         hashmap_entry_init(entry, strhash(entry->subject));
5276                         hashmap_put(&subject2item, entry);
5277                 }
5278         }
5279
5280         if (rearranged) {
5281                 for (i = 0; i < todo_list->nr; i++) {
5282                         enum todo_command command = todo_list->items[i].command;
5283                         int cur = i;
5284
5285                         /*
5286                          * Initially, all commands are 'pick's. If it is a
5287                          * fixup or a squash now, we have rearranged it.
5288                          */
5289                         if (is_fixup(command))
5290                                 continue;
5291
5292                         while (cur >= 0) {
5293                                 ALLOC_GROW(items, nr + 1, alloc);
5294                                 items[nr++] = todo_list->items[cur];
5295                                 cur = next[cur];
5296                         }
5297                 }
5298
5299                 FREE_AND_NULL(todo_list->items);
5300                 todo_list->items = items;
5301                 todo_list->nr = nr;
5302                 todo_list->alloc = alloc;
5303         }
5304
5305         free(next);
5306         free(tail);
5307         for (i = 0; i < todo_list->nr; i++)
5308                 free(subjects[i]);
5309         free(subjects);
5310         hashmap_free(&subject2item, 1);
5311
5312         clear_commit_todo_item(&commit_todo);
5313
5314         return 0;
5315 }