sequencer (rebase -i): add support for the 'fixup' and 'squash' commands
[git/git.git] / sequencer.c
CommitLineData
26ae337b 1#include "cache.h"
697cc8ef 2#include "lockfile.h"
26ae337b 3#include "sequencer.h"
26ae337b 4#include "dir.h"
043a4492
RR
5#include "object.h"
6#include "commit.h"
7#include "tag.h"
8#include "run-command.h"
9#include "exec_cmd.h"
10#include "utf8.h"
11#include "cache-tree.h"
12#include "diff.h"
13#include "revision.h"
14#include "rerere.h"
15#include "merge-recursive.h"
16#include "refs.h"
b27cfb0d 17#include "argv-array.h"
a1c75762 18#include "quote.h"
967dfd4d 19#include "trailer.h"
56dc3ab0 20#include "log-tree.h"
311af526 21#include "wt-status.h"
043a4492
RR
22
23#define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
26ae337b 24
5ed75e2a 25const char sign_off_header[] = "Signed-off-by: ";
cd650a4e 26static const char cherry_picked_prefix[] = "(cherry picked from commit ";
5ed75e2a 27
8a2a0f53
JS
28GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
29
30static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
31static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
32static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
1e41229d 33static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
f932729c 34
84583957
JS
35static GIT_PATH_FUNC(rebase_path, "rebase-merge")
36/*
37 * The file containing rebase commands, comments, and empty lines.
38 * This file is created by "git rebase -i" then edited by the user. As
39 * the lines are processed, they are removed from the front of this
40 * file and written to the tail of 'done'.
41 */
42static GIT_PATH_FUNC(rebase_path_todo, "rebase-merge/git-rebase-todo")
1df6df0c
JS
43/*
44 * The rebase command lines that have already been processed. A line
45 * is moved here when it is first handled, before any associated user
46 * actions.
47 */
48static GIT_PATH_FUNC(rebase_path_done, "rebase-merge/done")
6e98de72
JS
49/*
50 * The commit message that is planned to be used for any changes that
51 * need to be committed following a user interaction.
52 */
53static GIT_PATH_FUNC(rebase_path_message, "rebase-merge/message")
54/*
55 * The file into which is accumulated the suggested commit message for
56 * squash/fixup commands. When the first of a series of squash/fixups
57 * is seen, the file is created and the commit message from the
58 * previous commit and from the first squash/fixup commit are written
59 * to it. The commit message for each subsequent squash/fixup commit
60 * is appended to the file as it is processed.
61 *
62 * The first line of the file is of the form
63 * # This is a combination of $count commits.
64 * where $count is the number of commits whose messages have been
65 * written to the file so far (including the initial "pick" commit).
66 * Each time that a commit message is processed, this line is read and
67 * updated. It is deleted just before the combined commit is made.
68 */
69static GIT_PATH_FUNC(rebase_path_squash_msg, "rebase-merge/message-squash")
70/*
71 * If the current series of squash/fixups has not yet included a squash
72 * command, then this file exists and holds the commit message of the
73 * original "pick" commit. (If the series ends without a "squash"
74 * command, then this can be used as the commit message of the combined
75 * commit without opening the editor.)
76 */
77static GIT_PATH_FUNC(rebase_path_fixup_msg, "rebase-merge/message-fixup")
b5a67045
JS
78/*
79 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
80 * GIT_AUTHOR_DATE that will be used for the commit that is currently
81 * being rebased.
82 */
83static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
56dc3ab0
JS
84/*
85 * When an "edit" rebase command is being processed, the SHA1 of the
86 * commit to be edited is recorded in this file. When "git rebase
87 * --continue" is executed, if there are any staged changes then they
88 * will be amended to the HEAD commit, but only provided the HEAD
89 * commit is still the commit to be edited. When any other rebase
90 * command is processed, this file is deleted.
91 */
92static GIT_PATH_FUNC(rebase_path_amend, "rebase-merge/amend")
93/*
94 * When we stop at a given patch via the "edit" command, this file contains
95 * the abbreviated commit name of the corresponding patch.
96 */
97static GIT_PATH_FUNC(rebase_path_stopped_sha, "rebase-merge/stopped-sha")
a1c75762
JS
98/*
99 * The following files are written by git-rebase just after parsing the
100 * command-line (and are only consumed, not modified, by the sequencer).
101 */
102static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
556907f1
JS
103static GIT_PATH_FUNC(rebase_path_orig_head, "rebase-merge/orig-head")
104static GIT_PATH_FUNC(rebase_path_verbose, "rebase-merge/verbose")
b5a67045 105
b5a67045
JS
106static inline int is_rebase_i(const struct replay_opts *opts)
107{
84583957 108 return opts->action == REPLAY_INTERACTIVE_REBASE;
b5a67045
JS
109}
110
285abf56
JS
111static const char *get_dir(const struct replay_opts *opts)
112{
84583957
JS
113 if (is_rebase_i(opts))
114 return rebase_path();
285abf56
JS
115 return git_path_seq_dir();
116}
117
c0246501
JS
118static const char *get_todo_path(const struct replay_opts *opts)
119{
84583957
JS
120 if (is_rebase_i(opts))
121 return rebase_path_todo();
c0246501
JS
122 return git_path_todo_file();
123}
124
bab4d109
BC
125/*
126 * Returns 0 for non-conforming footer
127 * Returns 1 for conforming footer
128 * Returns 2 when sob exists within conforming footer
129 * Returns 3 when sob exists within conforming footer as last entry
130 */
131static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
132 int ignore_footer)
b971e04f 133{
967dfd4d
JT
134 struct trailer_info info;
135 int i;
136 int found_sob = 0, found_sob_last = 0;
b971e04f 137
967dfd4d 138 trailer_info_get(&info, sb->buf);
b971e04f 139
967dfd4d 140 if (info.trailer_start == info.trailer_end)
b971e04f
BC
141 return 0;
142
967dfd4d
JT
143 for (i = 0; i < info.trailer_nr; i++)
144 if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
145 found_sob = 1;
146 if (i == info.trailer_nr - 1)
147 found_sob_last = 1;
148 }
b971e04f 149
967dfd4d 150 trailer_info_release(&info);
bab4d109 151
967dfd4d 152 if (found_sob_last)
bab4d109
BC
153 return 3;
154 if (found_sob)
155 return 2;
b971e04f
BC
156 return 1;
157}
5ed75e2a 158
a1c75762
JS
159static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
160{
161 static struct strbuf buf = STRBUF_INIT;
162
163 strbuf_reset(&buf);
164 if (opts->gpg_sign)
165 sq_quotef(&buf, "-S%s", opts->gpg_sign);
166 return buf.buf;
167}
168
2863584f 169int sequencer_remove_state(struct replay_opts *opts)
26ae337b 170{
285abf56 171 struct strbuf dir = STRBUF_INIT;
03a4e260
JS
172 int i;
173
174 free(opts->gpg_sign);
175 free(opts->strategy);
176 for (i = 0; i < opts->xopts_nr; i++)
177 free(opts->xopts[i]);
178 free(opts->xopts);
26ae337b 179
285abf56
JS
180 strbuf_addf(&dir, "%s", get_dir(opts));
181 remove_dir_recursively(&dir, 0);
182 strbuf_release(&dir);
2863584f
JS
183
184 return 0;
26ae337b 185}
043a4492
RR
186
187static const char *action_name(const struct replay_opts *opts)
188{
84583957
JS
189 switch (opts->action) {
190 case REPLAY_REVERT:
191 return N_("revert");
192 case REPLAY_PICK:
193 return N_("cherry-pick");
194 case REPLAY_INTERACTIVE_REBASE:
195 return N_("rebase -i");
196 }
197 die(_("Unknown action: %d"), opts->action);
043a4492
RR
198}
199
043a4492
RR
200struct commit_message {
201 char *parent_label;
7b35eaf8
JK
202 char *label;
203 char *subject;
043a4492
RR
204 const char *message;
205};
206
39755964
JS
207static const char *short_commit_name(struct commit *commit)
208{
209 return find_unique_abbrev(commit->object.oid.hash, DEFAULT_ABBREV);
210}
211
043a4492
RR
212static int get_message(struct commit *commit, struct commit_message *out)
213{
043a4492 214 const char *abbrev, *subject;
7b35eaf8 215 int subject_len;
043a4492 216
7b35eaf8 217 out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
39755964 218 abbrev = short_commit_name(commit);
043a4492
RR
219
220 subject_len = find_commit_subject(out->message, &subject);
221
7b35eaf8
JK
222 out->subject = xmemdupz(subject, subject_len);
223 out->label = xstrfmt("%s... %s", abbrev, out->subject);
224 out->parent_label = xstrfmt("parent of %s", out->label);
225
043a4492
RR
226 return 0;
227}
228
d74a4e57 229static void free_message(struct commit *commit, struct commit_message *msg)
043a4492
RR
230{
231 free(msg->parent_label);
7b35eaf8
JK
232 free(msg->label);
233 free(msg->subject);
b66103c3 234 unuse_commit_buffer(commit, msg->message);
043a4492
RR
235}
236
ed727b19 237static void print_advice(int show_hint, struct replay_opts *opts)
043a4492
RR
238{
239 char *msg = getenv("GIT_CHERRY_PICK_HELP");
240
241 if (msg) {
242 fprintf(stderr, "%s\n", msg);
243 /*
41ccfdd9 244 * A conflict has occurred but the porcelain
043a4492
RR
245 * (typically rebase --interactive) wants to take care
246 * of the commit itself so remove CHERRY_PICK_HEAD
247 */
f932729c 248 unlink(git_path_cherry_pick_head());
043a4492
RR
249 return;
250 }
251
ed727b19
PH
252 if (show_hint) {
253 if (opts->no_commit)
254 advise(_("after resolving the conflicts, mark the corrected paths\n"
255 "with 'git add <paths>' or 'git rm <paths>'"));
256 else
257 advise(_("after resolving the conflicts, mark the corrected paths\n"
258 "with 'git add <paths>' or 'git rm <paths>'\n"
259 "and commit the result with 'git commit'"));
260 }
043a4492
RR
261}
262
f56fffef
JS
263static int write_message(const void *buf, size_t len, const char *filename,
264 int append_eol)
043a4492
RR
265{
266 static struct lock_file msg_file;
267
4ef3d8f0
JS
268 int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
269 if (msg_fd < 0)
93b3df6f 270 return error_errno(_("could not lock '%s'"), filename);
75871495 271 if (write_in_full(msg_fd, buf, len) < 0) {
4f66c837 272 rollback_lock_file(&msg_file);
93b3df6f 273 return error_errno(_("could not write to '%s'"), filename);
4f66c837 274 }
f56fffef
JS
275 if (append_eol && write(msg_fd, "\n", 1) < 0) {
276 rollback_lock_file(&msg_file);
35871806 277 return error_errno(_("could not write eol to '%s'"), filename);
f56fffef 278 }
4f66c837
JS
279 if (commit_lock_file(&msg_file) < 0) {
280 rollback_lock_file(&msg_file);
93b3df6f 281 return error(_("failed to finalize '%s'."), filename);
4f66c837 282 }
4ef3d8f0
JS
283
284 return 0;
043a4492
RR
285}
286
1dfc84e9
JS
287/*
288 * Reads a file that was presumably written by a shell script, i.e. with an
289 * end-of-line marker that needs to be stripped.
290 *
291 * Note that only the last end-of-line marker is stripped, consistent with the
292 * behavior of "$(cat path)" in a shell script.
293 *
294 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
295 */
296static int read_oneliner(struct strbuf *buf,
297 const char *path, int skip_if_empty)
298{
299 int orig_len = buf->len;
300
301 if (!file_exists(path))
302 return 0;
303
304 if (strbuf_read_file(buf, path, 0) < 0) {
305 warning_errno(_("could not read '%s'"), path);
306 return 0;
307 }
308
309 if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
310 if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
311 --buf->len;
312 buf->buf[buf->len] = '\0';
313 }
314
315 if (skip_if_empty && buf->len == orig_len)
316 return 0;
317
318 return 1;
319}
320
043a4492
RR
321static struct tree *empty_tree(void)
322{
cba595bd 323 return lookup_tree(EMPTY_TREE_SHA1_BIN);
043a4492
RR
324}
325
326static int error_dirty_index(struct replay_opts *opts)
327{
328 if (read_cache_unmerged())
c28cbc5e 329 return error_resolve_conflict(_(action_name(opts)));
043a4492 330
93b3df6f 331 error(_("your local changes would be overwritten by %s."),
c28cbc5e 332 _(action_name(opts)));
043a4492
RR
333
334 if (advice_commit_before_merge)
93b3df6f 335 advise(_("commit your changes or stash them to proceed."));
043a4492
RR
336 return -1;
337}
338
1e41229d
SB
339static void update_abort_safety_file(void)
340{
341 struct object_id head;
342
343 /* Do nothing on a single-pick */
344 if (!file_exists(git_path_seq_dir()))
345 return;
346
347 if (!get_oid("HEAD", &head))
348 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
349 else
350 write_file(git_path_abort_safety_file(), "%s", "");
351}
352
334ae397 353static int fast_forward_to(const unsigned char *to, const unsigned char *from,
eb4be1cb 354 int unborn, struct replay_opts *opts)
043a4492 355{
d668d16c 356 struct ref_transaction *transaction;
eb4be1cb 357 struct strbuf sb = STRBUF_INIT;
d668d16c 358 struct strbuf err = STRBUF_INIT;
043a4492
RR
359
360 read_cache();
db699a8a 361 if (checkout_fast_forward(from, to, 1))
0e408fc3 362 return -1; /* the callee should have complained already */
651ab9f5 363
c28cbc5e 364 strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
d668d16c
RS
365
366 transaction = ref_transaction_begin(&err);
367 if (!transaction ||
368 ref_transaction_update(transaction, "HEAD",
369 to, unborn ? null_sha1 : from,
1d147bdf 370 0, sb.buf, &err) ||
db7516ab 371 ref_transaction_commit(transaction, &err)) {
d668d16c
RS
372 ref_transaction_free(transaction);
373 error("%s", err.buf);
374 strbuf_release(&sb);
375 strbuf_release(&err);
376 return -1;
377 }
651ab9f5 378
eb4be1cb 379 strbuf_release(&sb);
d668d16c
RS
380 strbuf_release(&err);
381 ref_transaction_free(transaction);
1e41229d 382 update_abort_safety_file();
d668d16c 383 return 0;
043a4492
RR
384}
385
75c961b7
JH
386void append_conflicts_hint(struct strbuf *msgbuf)
387{
388 int i;
389
261f315b
JH
390 strbuf_addch(msgbuf, '\n');
391 strbuf_commented_addf(msgbuf, "Conflicts:\n");
75c961b7
JH
392 for (i = 0; i < active_nr;) {
393 const struct cache_entry *ce = active_cache[i++];
394 if (ce_stage(ce)) {
261f315b 395 strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
75c961b7
JH
396 while (i < active_nr && !strcmp(ce->name,
397 active_cache[i]->name))
398 i++;
399 }
400 }
401}
402
043a4492
RR
403static int do_recursive_merge(struct commit *base, struct commit *next,
404 const char *base_label, const char *next_label,
405 unsigned char *head, struct strbuf *msgbuf,
406 struct replay_opts *opts)
407{
408 struct merge_options o;
409 struct tree *result, *next_tree, *base_tree, *head_tree;
03b86647 410 int clean;
03a4e260 411 char **xopt;
043a4492
RR
412 static struct lock_file index_lock;
413
b3e83cc7 414 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
043a4492
RR
415
416 read_cache();
417
418 init_merge_options(&o);
419 o.ancestor = base ? base_label : "(empty tree)";
420 o.branch1 = "HEAD";
421 o.branch2 = next ? next_label : "(empty tree)";
422
423 head_tree = parse_tree_indirect(head);
424 next_tree = next ? next->tree : empty_tree();
425 base_tree = base ? base->tree : empty_tree();
426
427 for (xopt = opts->xopts; xopt != opts->xopts + opts->xopts_nr; xopt++)
428 parse_merge_opt(&o, *xopt);
429
430 clean = merge_trees(&o,
431 head_tree,
432 next_tree, base_tree, &result);
548009c0 433 strbuf_release(&o.obuf);
f241ff0d
JS
434 if (clean < 0)
435 return clean;
043a4492
RR
436
437 if (active_cache_changed &&
03b86647 438 write_locked_index(&the_index, &index_lock, COMMIT_LOCK))
84583957
JS
439 /* TRANSLATORS: %s will be "revert", "cherry-pick" or
440 * "rebase -i".
441 */
c527b55e 442 return error(_("%s: Unable to write new index file"),
c28cbc5e 443 _(action_name(opts)));
043a4492
RR
444 rollback_lock_file(&index_lock);
445
5ed75e2a 446 if (opts->signoff)
bab4d109 447 append_signoff(msgbuf, 0, 0);
5ed75e2a 448
75c961b7
JH
449 if (!clean)
450 append_conflicts_hint(msgbuf);
043a4492
RR
451
452 return !clean;
453}
454
b27cfb0d
NH
455static int is_index_unchanged(void)
456{
457 unsigned char head_sha1[20];
458 struct commit *head_commit;
459
7695d118 460 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, head_sha1, NULL))
93b3df6f 461 return error(_("could not resolve HEAD commit\n"));
b27cfb0d
NH
462
463 head_commit = lookup_commit(head_sha1);
4b580061
NH
464
465 /*
466 * If head_commit is NULL, check_commit, called from
467 * lookup_commit, would have indicated that head_commit is not
468 * a commit object already. parse_commit() will return failure
469 * without further complaints in such a case. Otherwise, if
470 * the commit is invalid, parse_commit() will complain. So
471 * there is nothing for us to say here. Just return failure.
472 */
473 if (parse_commit(head_commit))
474 return -1;
b27cfb0d
NH
475
476 if (!active_cache_tree)
477 active_cache_tree = cache_tree();
478
479 if (!cache_tree_fully_valid(active_cache_tree))
d0cfc3e8 480 if (cache_tree_update(&the_index, 0))
93b3df6f 481 return error(_("unable to update cache tree\n"));
b27cfb0d 482
ed1c9977 483 return !hashcmp(active_cache_tree->sha1, head_commit->tree->object.oid.hash);
b27cfb0d
NH
484}
485
b5a67045
JS
486/*
487 * Read the author-script file into an environment block, ready for use in
488 * run_command(), that can be free()d afterwards.
489 */
490static char **read_author_script(void)
491{
492 struct strbuf script = STRBUF_INIT;
493 int i, count = 0;
494 char *p, *p2, **env;
495 size_t env_size;
496
497 if (strbuf_read_file(&script, rebase_path_author_script(), 256) <= 0)
498 return NULL;
499
500 for (p = script.buf; *p; p++)
501 if (skip_prefix(p, "'\\\\''", (const char **)&p2))
502 strbuf_splice(&script, p - script.buf, p2 - p, "'", 1);
503 else if (*p == '\'')
504 strbuf_splice(&script, p-- - script.buf, 1, "", 0);
505 else if (*p == '\n') {
506 *p = '\0';
507 count++;
508 }
509
510 env_size = (count + 1) * sizeof(*env);
511 strbuf_grow(&script, env_size);
512 memmove(script.buf + env_size, script.buf, script.len);
513 p = script.buf + env_size;
514 env = (char **)strbuf_detach(&script, NULL);
515
516 for (i = 0; i < count; i++) {
517 env[i] = p;
518 p += strlen(p) + 1;
519 }
520 env[count] = NULL;
521
522 return env;
523}
524
791eb870
JS
525static const char staged_changes_advice[] =
526N_("you have staged changes in your working tree\n"
527"If these changes are meant to be squashed into the previous commit, run:\n"
528"\n"
529" git commit --amend %s\n"
530"\n"
531"If they are meant to go into a new commit, run:\n"
532"\n"
533" git commit %s\n"
534"\n"
535"In both cases, once you're done, continue with:\n"
536"\n"
537" git rebase --continue\n");
538
043a4492
RR
539/*
540 * If we are cherry-pick, and if the merge did not result in
541 * hand-editing, we will hit this commit and inherit the original
542 * author date and name.
b5a67045 543 *
043a4492
RR
544 * If we are revert, or if our cherry-pick results in a hand merge,
545 * we had better say that the current user is responsible for that.
b5a67045
JS
546 *
547 * An exception is when run_git_commit() is called during an
548 * interactive rebase: in that case, we will want to retain the
549 * author metadata.
043a4492 550 */
ac2b0e8f 551static int run_git_commit(const char *defmsg, struct replay_opts *opts,
0009426d
JS
552 int allow_empty, int edit, int amend,
553 int cleanup_commit_message)
043a4492 554{
b5a67045 555 char **env = NULL;
b27cfb0d
NH
556 struct argv_array array;
557 int rc;
17d65f03 558 const char *value;
b27cfb0d 559
b5a67045
JS
560 if (is_rebase_i(opts)) {
561 env = read_author_script();
a1c75762
JS
562 if (!env) {
563 const char *gpg_opt = gpg_sign_opt_quoted(opts);
564
791eb870
JS
565 return error(_(staged_changes_advice),
566 gpg_opt, gpg_opt);
a1c75762 567 }
b5a67045
JS
568 }
569
b27cfb0d
NH
570 argv_array_init(&array);
571 argv_array_push(&array, "commit");
572 argv_array_push(&array, "-n");
043a4492 573
9240beda
JS
574 if (amend)
575 argv_array_push(&array, "--amend");
3bdd5522
JK
576 if (opts->gpg_sign)
577 argv_array_pushf(&array, "-S%s", opts->gpg_sign);
043a4492 578 if (opts->signoff)
b27cfb0d 579 argv_array_push(&array, "-s");
b5a67045
JS
580 if (defmsg)
581 argv_array_pushl(&array, "-F", defmsg, NULL);
0009426d
JS
582 if (cleanup_commit_message)
583 argv_array_push(&array, "--cleanup=strip");
a1c75762 584 if (edit)
b5a67045 585 argv_array_push(&array, "-e");
0009426d
JS
586 else if (!cleanup_commit_message &&
587 !opts->signoff && !opts->record_origin &&
b5a67045
JS
588 git_config_get_value("commit.cleanup", &value))
589 argv_array_push(&array, "--cleanup=verbatim");
b27cfb0d 590
ac2b0e8f 591 if (allow_empty)
b27cfb0d 592 argv_array_push(&array, "--allow-empty");
df478b74 593
4bee9584
CW
594 if (opts->allow_empty_message)
595 argv_array_push(&array, "--allow-empty-message");
596
b5a67045
JS
597 rc = run_command_v_opt_cd_env(array.argv, RUN_GIT_CMD, NULL,
598 (const char *const *)env);
b27cfb0d 599 argv_array_clear(&array);
b5a67045
JS
600 free(env);
601
b27cfb0d
NH
602 return rc;
603}
604
605static int is_original_commit_empty(struct commit *commit)
606{
607 const unsigned char *ptree_sha1;
608
609 if (parse_commit(commit))
93b3df6f 610 return error(_("could not parse commit %s\n"),
f2fd0760 611 oid_to_hex(&commit->object.oid));
b27cfb0d
NH
612 if (commit->parents) {
613 struct commit *parent = commit->parents->item;
614 if (parse_commit(parent))
93b3df6f 615 return error(_("could not parse parent commit %s\n"),
f2fd0760 616 oid_to_hex(&parent->object.oid));
ed1c9977 617 ptree_sha1 = parent->tree->object.oid.hash;
b27cfb0d
NH
618 } else {
619 ptree_sha1 = EMPTY_TREE_SHA1_BIN; /* commit is root */
043a4492 620 }
043a4492 621
ed1c9977 622 return !hashcmp(ptree_sha1, commit->tree->object.oid.hash);
043a4492
RR
623}
624
ac2b0e8f
JH
625/*
626 * Do we run "git commit" with "--allow-empty"?
627 */
628static int allow_empty(struct replay_opts *opts, struct commit *commit)
629{
630 int index_unchanged, empty_commit;
631
632 /*
633 * Three cases:
634 *
635 * (1) we do not allow empty at all and error out.
636 *
637 * (2) we allow ones that were initially empty, but
638 * forbid the ones that become empty;
639 *
640 * (3) we allow both.
641 */
642 if (!opts->allow_empty)
643 return 0; /* let "git commit" barf as necessary */
644
645 index_unchanged = is_index_unchanged();
646 if (index_unchanged < 0)
647 return index_unchanged;
648 if (!index_unchanged)
649 return 0; /* we do not have to say --allow-empty */
650
651 if (opts->keep_redundant_commits)
652 return 1;
653
654 empty_commit = is_original_commit_empty(commit);
655 if (empty_commit < 0)
656 return empty_commit;
657 if (!empty_commit)
658 return 0;
659 else
660 return 1;
661}
662
25c43667
JS
663/*
664 * Note that ordering matters in this enum. Not only must it match the mapping
665 * below, it is also divided into several sections that matter. When adding
666 * new commands, make sure you add it in the right section.
667 */
004fefa7 668enum todo_command {
25c43667 669 /* commands that handle commits */
004fefa7 670 TODO_PICK = 0,
25c43667 671 TODO_REVERT,
56dc3ab0 672 TODO_EDIT,
6e98de72
JS
673 TODO_FIXUP,
674 TODO_SQUASH,
311af526
JS
675 /* commands that do something else than handling a single commit */
676 TODO_EXEC,
25c43667
JS
677 /* commands that do nothing but are counted for reporting progress */
678 TODO_NOOP
004fefa7
JS
679};
680
681static const char *todo_command_strings[] = {
682 "pick",
25c43667 683 "revert",
56dc3ab0 684 "edit",
6e98de72
JS
685 "fixup",
686 "squash",
311af526 687 "exec",
25c43667 688 "noop"
004fefa7
JS
689};
690
691static const char *command_to_string(const enum todo_command command)
692{
2ae38f2a 693 if ((size_t)command < ARRAY_SIZE(todo_command_strings))
004fefa7
JS
694 return todo_command_strings[command];
695 die("Unknown command: %d", command);
696}
697
25c43667
JS
698static int is_noop(const enum todo_command command)
699{
700 return TODO_NOOP <= (size_t)command;
701}
004fefa7 702
6e98de72
JS
703static int is_fixup(enum todo_command command)
704{
705 return command == TODO_FIXUP || command == TODO_SQUASH;
706}
707
708static int update_squash_messages(enum todo_command command,
709 struct commit *commit, struct replay_opts *opts)
710{
711 struct strbuf buf = STRBUF_INIT;
712 int count, res;
713 const char *message, *body;
714
715 if (file_exists(rebase_path_squash_msg())) {
716 struct strbuf header = STRBUF_INIT;
717 char *eol, *p;
718
719 if (strbuf_read_file(&buf, rebase_path_squash_msg(), 2048) <= 0)
720 return error(_("could not read '%s'"),
721 rebase_path_squash_msg());
722
723 p = buf.buf + 1;
724 eol = strchrnul(buf.buf, '\n');
725 if (buf.buf[0] != comment_line_char ||
726 (p += strcspn(p, "0123456789\n")) == eol)
727 return error(_("unexpected 1st line of squash message:"
728 "\n\n\t%.*s"),
729 (int)(eol - buf.buf), buf.buf);
730 count = strtol(p, NULL, 10);
731
732 if (count < 1)
733 return error(_("invalid 1st line of squash message:\n"
734 "\n\t%.*s"),
735 (int)(eol - buf.buf), buf.buf);
736
737 strbuf_addf(&header, "%c ", comment_line_char);
738 strbuf_addf(&header,
739 _("This is a combination of %d commits."), ++count);
740 strbuf_splice(&buf, 0, eol - buf.buf, header.buf, header.len);
741 strbuf_release(&header);
742 } else {
743 unsigned char head[20];
744 struct commit *head_commit;
745 const char *head_message, *body;
746
747 if (get_sha1("HEAD", head))
748 return error(_("need a HEAD to fixup"));
749 if (!(head_commit = lookup_commit_reference(head)))
750 return error(_("could not read HEAD"));
751 if (!(head_message = get_commit_buffer(head_commit, NULL)))
752 return error(_("could not read HEAD's commit message"));
753
754 find_commit_subject(head_message, &body);
755 if (write_message(body, strlen(body),
756 rebase_path_fixup_msg(), 0)) {
757 unuse_commit_buffer(head_commit, head_message);
758 return error(_("cannot write '%s'"),
759 rebase_path_fixup_msg());
760 }
761
762 count = 2;
763 strbuf_addf(&buf, "%c ", comment_line_char);
764 strbuf_addf(&buf, _("This is a combination of %d commits."),
765 count);
766 strbuf_addf(&buf, "\n%c ", comment_line_char);
767 strbuf_addstr(&buf, _("This is the 1st commit message:"));
768 strbuf_addstr(&buf, "\n\n");
769 strbuf_addstr(&buf, body);
770
771 unuse_commit_buffer(head_commit, head_message);
772 }
773
774 if (!(message = get_commit_buffer(commit, NULL)))
775 return error(_("could not read commit message of %s"),
776 oid_to_hex(&commit->object.oid));
777 find_commit_subject(message, &body);
778
779 if (command == TODO_SQUASH) {
780 unlink(rebase_path_fixup_msg());
781 strbuf_addf(&buf, "\n%c ", comment_line_char);
782 strbuf_addf(&buf, _("This is the commit message #%d:"), count);
783 strbuf_addstr(&buf, "\n\n");
784 strbuf_addstr(&buf, body);
785 } else if (command == TODO_FIXUP) {
786 strbuf_addf(&buf, "\n%c ", comment_line_char);
787 strbuf_addf(&buf, _("The commit message #%d will be skipped:"),
788 count);
789 strbuf_addstr(&buf, "\n\n");
790 strbuf_add_commented_lines(&buf, body, strlen(body));
791 } else
792 return error(_("unknown command: %d"), command);
793 unuse_commit_buffer(commit, message);
794
795 res = write_message(buf.buf, buf.len, rebase_path_squash_msg(), 0);
796 strbuf_release(&buf);
797 return res;
798}
799
004fefa7 800static int do_pick_commit(enum todo_command command, struct commit *commit,
6e98de72 801 struct replay_opts *opts, int final_fixup)
043a4492 802{
6e98de72
JS
803 int edit = opts->edit, cleanup_commit_message = 0;
804 const char *msg_file = edit ? NULL : git_path_merge_msg();
043a4492
RR
805 unsigned char head[20];
806 struct commit *base, *next, *parent;
807 const char *base_label, *next_label;
d74a4e57 808 struct commit_message msg = { NULL, NULL, NULL, NULL };
043a4492 809 struct strbuf msgbuf = STRBUF_INIT;
6e98de72 810 int res, unborn = 0, amend = 0, allow;
043a4492
RR
811
812 if (opts->no_commit) {
813 /*
814 * We do not intend to commit immediately. We just want to
815 * merge the differences in, so let's compute the tree
816 * that represents the "current" state for merge-recursive
817 * to work on.
818 */
819 if (write_cache_as_tree(head, 0, NULL))
93b3df6f 820 return error(_("your index file is unmerged."));
043a4492 821 } else {
334ae397
MZ
822 unborn = get_sha1("HEAD", head);
823 if (unborn)
824 hashcpy(head, EMPTY_TREE_SHA1_BIN);
018ec3c8 825 if (index_differs_from(unborn ? EMPTY_TREE_SHA1_HEX : "HEAD", 0, 0))
043a4492
RR
826 return error_dirty_index(opts);
827 }
828 discard_cache();
829
637666c8 830 if (!commit->parents)
043a4492 831 parent = NULL;
043a4492
RR
832 else if (commit->parents->next) {
833 /* Reverting or cherry-picking a merge commit */
834 int cnt;
835 struct commit_list *p;
836
837 if (!opts->mainline)
93b3df6f 838 return error(_("commit %s is a merge but no -m option was given."),
f2fd0760 839 oid_to_hex(&commit->object.oid));
043a4492
RR
840
841 for (cnt = 1, p = commit->parents;
842 cnt != opts->mainline && p;
843 cnt++)
844 p = p->next;
845 if (cnt != opts->mainline || !p)
93b3df6f 846 return error(_("commit %s does not have parent %d"),
f2fd0760 847 oid_to_hex(&commit->object.oid), opts->mainline);
043a4492
RR
848 parent = p->item;
849 } else if (0 < opts->mainline)
93b3df6f 850 return error(_("mainline was specified but commit %s is not a merge."),
f2fd0760 851 oid_to_hex(&commit->object.oid));
043a4492
RR
852 else
853 parent = commit->parents->item;
854
6e98de72 855 if (opts->allow_ff && !is_fixup(command) &&
ed1c9977 856 ((parent && !hashcmp(parent->object.oid.hash, head)) ||
334ae397 857 (!parent && unborn)))
ed1c9977 858 return fast_forward_to(commit->object.oid.hash, head, unborn, opts);
043a4492
RR
859
860 if (parent && parse_commit(parent) < 0)
004fefa7
JS
861 /* TRANSLATORS: The first %s will be a "todo" command like
862 "revert" or "pick", the second %s a SHA1. */
043a4492 863 return error(_("%s: cannot parse parent commit %s"),
004fefa7
JS
864 command_to_string(command),
865 oid_to_hex(&parent->object.oid));
043a4492
RR
866
867 if (get_message(commit, &msg) != 0)
93b3df6f 868 return error(_("cannot get commit message for %s"),
f2fd0760 869 oid_to_hex(&commit->object.oid));
043a4492
RR
870
871 /*
872 * "commit" is an existing commit. We would want to apply
873 * the difference it introduces since its first parent "prev"
874 * on top of the current HEAD if we are cherry-pick. Or the
875 * reverse of it if we are revert.
876 */
877
004fefa7 878 if (command == TODO_REVERT) {
043a4492
RR
879 base = commit;
880 base_label = msg.label;
881 next = parent;
882 next_label = msg.parent_label;
883 strbuf_addstr(&msgbuf, "Revert \"");
884 strbuf_addstr(&msgbuf, msg.subject);
885 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
f2fd0760 886 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
043a4492
RR
887
888 if (commit->parents && commit->parents->next) {
889 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
f2fd0760 890 strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
043a4492
RR
891 }
892 strbuf_addstr(&msgbuf, ".\n");
893 } else {
894 const char *p;
895
896 base = parent;
897 base_label = msg.parent_label;
898 next = commit;
899 next_label = msg.label;
900
23aa5142
JS
901 /* Append the commit log message to msgbuf. */
902 if (find_commit_subject(msg.message, &p))
903 strbuf_addstr(&msgbuf, p);
043a4492
RR
904
905 if (opts->record_origin) {
bab4d109 906 if (!has_conforming_footer(&msgbuf, NULL, 0))
b971e04f 907 strbuf_addch(&msgbuf, '\n');
cd650a4e 908 strbuf_addstr(&msgbuf, cherry_picked_prefix);
f2fd0760 909 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
043a4492
RR
910 strbuf_addstr(&msgbuf, ")\n");
911 }
912 }
913
6e98de72
JS
914 if (is_fixup(command)) {
915 if (update_squash_messages(command, commit, opts))
916 return -1;
917 amend = 1;
918 if (!final_fixup)
919 msg_file = rebase_path_squash_msg();
920 else if (file_exists(rebase_path_fixup_msg())) {
921 cleanup_commit_message = 1;
922 msg_file = rebase_path_fixup_msg();
923 } else {
924 const char *dest = git_path("SQUASH_MSG");
925 unlink(dest);
926 if (copy_file(dest, rebase_path_squash_msg(), 0666))
927 return error(_("could not rename '%s' to '%s'"),
928 rebase_path_squash_msg(), dest);
929 unlink(git_path("MERGE_MSG"));
930 msg_file = dest;
931 edit = 1;
932 }
933 }
934
004fefa7 935 if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
043a4492
RR
936 res = do_recursive_merge(base, next, base_label, next_label,
937 head, &msgbuf, opts);
f241ff0d
JS
938 if (res < 0)
939 return res;
75871495 940 res |= write_message(msgbuf.buf, msgbuf.len,
f56fffef 941 git_path_merge_msg(), 0);
043a4492
RR
942 } else {
943 struct commit_list *common = NULL;
944 struct commit_list *remotes = NULL;
945
75871495 946 res = write_message(msgbuf.buf, msgbuf.len,
f56fffef 947 git_path_merge_msg(), 0);
043a4492
RR
948
949 commit_list_insert(base, &common);
950 commit_list_insert(next, &remotes);
03a4e260
JS
951 res |= try_merge_command(opts->strategy,
952 opts->xopts_nr, (const char **)opts->xopts,
043a4492
RR
953 common, sha1_to_hex(head), remotes);
954 free_commit_list(common);
955 free_commit_list(remotes);
956 }
452202c7 957 strbuf_release(&msgbuf);
043a4492
RR
958
959 /*
960 * If the merge was clean or if it failed due to conflict, we write
961 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
962 * However, if the merge did not even start, then we don't want to
963 * write it at all.
964 */
004fefa7 965 if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
dbfad033
JS
966 update_ref(NULL, "CHERRY_PICK_HEAD", commit->object.oid.hash, NULL,
967 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
968 res = -1;
004fefa7 969 if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
dbfad033
JS
970 update_ref(NULL, "REVERT_HEAD", commit->object.oid.hash, NULL,
971 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
972 res = -1;
043a4492
RR
973
974 if (res) {
004fefa7 975 error(command == TODO_REVERT
043a4492
RR
976 ? _("could not revert %s... %s")
977 : _("could not apply %s... %s"),
39755964 978 short_commit_name(commit), msg.subject);
ed727b19 979 print_advice(res == 1, opts);
043a4492 980 rerere(opts->allow_rerere_auto);
c8d1351d 981 goto leave;
043a4492
RR
982 }
983
c8d1351d 984 allow = allow_empty(opts, commit);
706728a3
FC
985 if (allow < 0) {
986 res = allow;
987 goto leave;
988 }
c8d1351d 989 if (!opts->no_commit)
6e98de72
JS
990 res = run_git_commit(msg_file, opts, allow, edit, amend,
991 cleanup_commit_message);
992
993 if (!res && final_fixup) {
994 unlink(rebase_path_fixup_msg());
995 unlink(rebase_path_squash_msg());
996 }
c8d1351d
FC
997
998leave:
d74a4e57 999 free_message(commit, &msg);
1e41229d 1000 update_abort_safety_file();
043a4492
RR
1001
1002 return res;
1003}
1004
c3e8618c 1005static int prepare_revs(struct replay_opts *opts)
043a4492 1006{
a73e22e9
MZ
1007 /*
1008 * picking (but not reverting) ranges (but not individual revisions)
1009 * should be done in reverse
1010 */
1011 if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
043a4492
RR
1012 opts->revs->reverse ^= 1;
1013
1014 if (prepare_revision_walk(opts->revs))
c3e8618c 1015 return error(_("revision walk setup failed"));
043a4492
RR
1016
1017 if (!opts->revs->commits)
c3e8618c
JS
1018 return error(_("empty commit set passed"));
1019 return 0;
043a4492
RR
1020}
1021
0d9c6dc9 1022static int read_and_refresh_cache(struct replay_opts *opts)
043a4492
RR
1023{
1024 static struct lock_file index_lock;
1025 int index_fd = hold_locked_index(&index_lock, 0);
49fb937e
JS
1026 if (read_index_preload(&the_index, NULL) < 0) {
1027 rollback_lock_file(&index_lock);
0d9c6dc9 1028 return error(_("git %s: failed to read the index"),
c28cbc5e 1029 _(action_name(opts)));
49fb937e 1030 }
043a4492 1031 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
33c297aa 1032 if (the_index.cache_changed && index_fd >= 0) {
49fb937e
JS
1033 if (write_locked_index(&the_index, &index_lock, COMMIT_LOCK)) {
1034 rollback_lock_file(&index_lock);
0d9c6dc9 1035 return error(_("git %s: failed to refresh the index"),
c28cbc5e 1036 _(action_name(opts)));
49fb937e 1037 }
043a4492
RR
1038 }
1039 rollback_lock_file(&index_lock);
0d9c6dc9 1040 return 0;
043a4492
RR
1041}
1042
004fefa7
JS
1043struct todo_item {
1044 enum todo_command command;
1045 struct commit *commit;
c22f7dfb
JS
1046 const char *arg;
1047 int arg_len;
004fefa7
JS
1048 size_t offset_in_buf;
1049};
1050
1051struct todo_list {
1052 struct strbuf buf;
1053 struct todo_item *items;
1054 int nr, alloc, current;
1055};
1056
1057#define TODO_LIST_INIT { STRBUF_INIT }
1058
1059static void todo_list_release(struct todo_list *todo_list)
043a4492 1060{
004fefa7
JS
1061 strbuf_release(&todo_list->buf);
1062 free(todo_list->items);
1063 todo_list->items = NULL;
1064 todo_list->nr = todo_list->alloc = 0;
1065}
043a4492 1066
004fefa7
JS
1067static struct todo_item *append_new_todo(struct todo_list *todo_list)
1068{
1069 ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
1070 return todo_list->items + todo_list->nr++;
043a4492
RR
1071}
1072
004fefa7 1073static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
043a4492
RR
1074{
1075 unsigned char commit_sha1[20];
043a4492 1076 char *end_of_object_name;
004fefa7
JS
1077 int i, saved, status, padding;
1078
8f8550b3
JS
1079 /* left-trim */
1080 bol += strspn(bol, " \t");
1081
25c43667
JS
1082 if (bol == eol || *bol == '\r' || *bol == comment_line_char) {
1083 item->command = TODO_NOOP;
1084 item->commit = NULL;
1085 item->arg = bol;
1086 item->arg_len = eol - bol;
1087 return 0;
1088 }
1089
004fefa7
JS
1090 for (i = 0; i < ARRAY_SIZE(todo_command_strings); i++)
1091 if (skip_prefix(bol, todo_command_strings[i], &bol)) {
1092 item->command = i;
1093 break;
1094 }
1095 if (i >= ARRAY_SIZE(todo_command_strings))
1096 return -1;
043a4492 1097
25c43667
JS
1098 if (item->command == TODO_NOOP) {
1099 item->commit = NULL;
1100 item->arg = bol;
1101 item->arg_len = eol - bol;
1102 return 0;
1103 }
1104
043a4492
RR
1105 /* Eat up extra spaces/ tabs before object name */
1106 padding = strspn(bol, " \t");
1107 if (!padding)
004fefa7 1108 return -1;
043a4492
RR
1109 bol += padding;
1110
311af526
JS
1111 if (item->command == TODO_EXEC) {
1112 item->arg = bol;
1113 item->arg_len = (int)(eol - bol);
1114 return 0;
1115 }
1116
004fefa7 1117 end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
043a4492
RR
1118 saved = *end_of_object_name;
1119 *end_of_object_name = '\0';
1120 status = get_sha1(bol, commit_sha1);
1121 *end_of_object_name = saved;
1122
c22f7dfb
JS
1123 item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
1124 item->arg_len = (int)(eol - item->arg);
1125
043a4492 1126 if (status < 0)
004fefa7 1127 return -1;
043a4492 1128
004fefa7
JS
1129 item->commit = lookup_commit_reference(commit_sha1);
1130 return !item->commit;
043a4492
RR
1131}
1132
004fefa7 1133static int parse_insn_buffer(char *buf, struct todo_list *todo_list)
043a4492 1134{
004fefa7
JS
1135 struct todo_item *item;
1136 char *p = buf, *next_p;
6e98de72 1137 int i, res = 0, fixup_okay = file_exists(rebase_path_done());
043a4492 1138
004fefa7 1139 for (i = 1; *p; i++, p = next_p) {
043a4492 1140 char *eol = strchrnul(p, '\n');
004fefa7
JS
1141
1142 next_p = *eol ? eol + 1 /* skip LF */ : eol;
1143
6307041d
JS
1144 if (p != eol && eol[-1] == '\r')
1145 eol--; /* strip Carriage Return */
1146
004fefa7
JS
1147 item = append_new_todo(todo_list);
1148 item->offset_in_buf = p - todo_list->buf.buf;
1149 if (parse_insn_line(item, p, eol)) {
93b3df6f 1150 res = error(_("invalid line %d: %.*s"),
004fefa7 1151 i, (int)(eol - p), p);
6e98de72 1152 item->command = TODO_NOOP;
004fefa7 1153 }
6e98de72
JS
1154
1155 if (fixup_okay)
1156 ; /* do nothing */
1157 else if (is_fixup(item->command))
1158 return error(_("cannot '%s' without a previous commit"),
1159 command_to_string(item->command));
1160 else if (!is_noop(item->command))
1161 fixup_okay = 1;
043a4492 1162 }
004fefa7 1163 if (!todo_list->nr)
93b3df6f 1164 return error(_("no commits parsed."));
004fefa7 1165 return res;
043a4492
RR
1166}
1167
004fefa7 1168static int read_populate_todo(struct todo_list *todo_list,
043a4492
RR
1169 struct replay_opts *opts)
1170{
c0246501 1171 const char *todo_file = get_todo_path(opts);
043a4492
RR
1172 int fd, res;
1173
004fefa7 1174 strbuf_reset(&todo_list->buf);
c0246501 1175 fd = open(todo_file, O_RDONLY);
043a4492 1176 if (fd < 0)
93b3df6f 1177 return error_errno(_("could not open '%s'"), todo_file);
004fefa7 1178 if (strbuf_read(&todo_list->buf, fd, 0) < 0) {
043a4492 1179 close(fd);
93b3df6f 1180 return error(_("could not read '%s'."), todo_file);
043a4492
RR
1181 }
1182 close(fd);
1183
004fefa7 1184 res = parse_insn_buffer(todo_list->buf.buf, todo_list);
2eeaf1b3 1185 if (res)
93b3df6f 1186 return error(_("unusable instruction sheet: '%s'"), todo_file);
2eeaf1b3
JS
1187
1188 if (!is_rebase_i(opts)) {
004fefa7
JS
1189 enum todo_command valid =
1190 opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
1191 int i;
1192
1193 for (i = 0; i < todo_list->nr; i++)
1194 if (valid == todo_list->items[i].command)
1195 continue;
1196 else if (valid == TODO_PICK)
93b3df6f 1197 return error(_("cannot cherry-pick during a revert."));
004fefa7 1198 else
93b3df6f 1199 return error(_("cannot revert during a cherry-pick."));
004fefa7
JS
1200 }
1201
0ae42a03 1202 return 0;
043a4492
RR
1203}
1204
03a4e260
JS
1205static int git_config_string_dup(char **dest,
1206 const char *var, const char *value)
1207{
1208 if (!value)
1209 return config_error_nonbool(var);
1210 free(*dest);
1211 *dest = xstrdup(value);
1212 return 0;
1213}
1214
043a4492
RR
1215static int populate_opts_cb(const char *key, const char *value, void *data)
1216{
1217 struct replay_opts *opts = data;
1218 int error_flag = 1;
1219
1220 if (!value)
1221 error_flag = 0;
1222 else if (!strcmp(key, "options.no-commit"))
1223 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
1224 else if (!strcmp(key, "options.edit"))
1225 opts->edit = git_config_bool_or_int(key, value, &error_flag);
1226 else if (!strcmp(key, "options.signoff"))
1227 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
1228 else if (!strcmp(key, "options.record-origin"))
1229 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
1230 else if (!strcmp(key, "options.allow-ff"))
1231 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
1232 else if (!strcmp(key, "options.mainline"))
1233 opts->mainline = git_config_int(key, value);
1234 else if (!strcmp(key, "options.strategy"))
03a4e260 1235 git_config_string_dup(&opts->strategy, key, value);
3253553e 1236 else if (!strcmp(key, "options.gpg-sign"))
03a4e260 1237 git_config_string_dup(&opts->gpg_sign, key, value);
043a4492
RR
1238 else if (!strcmp(key, "options.strategy-option")) {
1239 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
1240 opts->xopts[opts->xopts_nr++] = xstrdup(value);
1241 } else
93b3df6f 1242 return error(_("invalid key: %s"), key);
043a4492
RR
1243
1244 if (!error_flag)
93b3df6f 1245 return error(_("invalid value for %s: %s"), key, value);
043a4492
RR
1246
1247 return 0;
1248}
1249
5adf9bdc 1250static int read_populate_opts(struct replay_opts *opts)
043a4492 1251{
a1c75762
JS
1252 if (is_rebase_i(opts)) {
1253 struct strbuf buf = STRBUF_INIT;
1254
1255 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
1256 if (!starts_with(buf.buf, "-S"))
1257 strbuf_reset(&buf);
1258 else {
1259 free(opts->gpg_sign);
1260 opts->gpg_sign = xstrdup(buf.buf + 2);
1261 }
1262 }
1263 strbuf_release(&buf);
1264
556907f1
JS
1265 if (file_exists(rebase_path_verbose()))
1266 opts->verbose = 1;
1267
b5a67045 1268 return 0;
a1c75762 1269 }
b5a67045 1270
f932729c 1271 if (!file_exists(git_path_opts_file()))
0d00da7b
JS
1272 return 0;
1273 /*
1274 * The function git_parse_source(), called from git_config_from_file(),
1275 * may die() in case of a syntactically incorrect file. We do not care
1276 * about this case, though, because we wrote that file ourselves, so we
1277 * are pretty certain that it is syntactically correct.
1278 */
5adf9bdc 1279 if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
93b3df6f 1280 return error(_("malformed options sheet: '%s'"),
0d00da7b
JS
1281 git_path_opts_file());
1282 return 0;
043a4492
RR
1283}
1284
004fefa7 1285static int walk_revs_populate_todo(struct todo_list *todo_list,
043a4492
RR
1286 struct replay_opts *opts)
1287{
004fefa7
JS
1288 enum todo_command command = opts->action == REPLAY_PICK ?
1289 TODO_PICK : TODO_REVERT;
1290 const char *command_string = todo_command_strings[command];
043a4492 1291 struct commit *commit;
043a4492 1292
34b0528b
JS
1293 if (prepare_revs(opts))
1294 return -1;
043a4492 1295
004fefa7
JS
1296 while ((commit = get_revision(opts->revs))) {
1297 struct todo_item *item = append_new_todo(todo_list);
1298 const char *commit_buffer = get_commit_buffer(commit, NULL);
1299 const char *subject;
1300 int subject_len;
1301
1302 item->command = command;
1303 item->commit = commit;
c22f7dfb
JS
1304 item->arg = NULL;
1305 item->arg_len = 0;
004fefa7
JS
1306 item->offset_in_buf = todo_list->buf.len;
1307 subject_len = find_commit_subject(commit_buffer, &subject);
1308 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
1309 short_commit_name(commit), subject_len, subject);
1310 unuse_commit_buffer(commit, commit_buffer);
1311 }
34b0528b 1312 return 0;
043a4492
RR
1313}
1314
1315static int create_seq_dir(void)
1316{
f932729c 1317 if (file_exists(git_path_seq_dir())) {
043a4492
RR
1318 error(_("a cherry-pick or revert is already in progress"));
1319 advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
1320 return -1;
a70d8f80 1321 } else if (mkdir(git_path_seq_dir(), 0777) < 0)
93b3df6f 1322 return error_errno(_("could not create sequencer directory '%s'"),
f6e82b0d 1323 git_path_seq_dir());
043a4492
RR
1324 return 0;
1325}
1326
311fd397 1327static int save_head(const char *head)
043a4492 1328{
043a4492
RR
1329 static struct lock_file head_lock;
1330 struct strbuf buf = STRBUF_INIT;
1331 int fd;
1332
311fd397
JS
1333 fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
1334 if (fd < 0) {
1335 rollback_lock_file(&head_lock);
93b3df6f 1336 return error_errno(_("could not lock HEAD"));
311fd397 1337 }
043a4492 1338 strbuf_addf(&buf, "%s\n", head);
311fd397
JS
1339 if (write_in_full(fd, buf.buf, buf.len) < 0) {
1340 rollback_lock_file(&head_lock);
93b3df6f 1341 return error_errno(_("could not write to '%s'"),
311fd397
JS
1342 git_path_head_file());
1343 }
1344 if (commit_lock_file(&head_lock) < 0) {
1345 rollback_lock_file(&head_lock);
93b3df6f 1346 return error(_("failed to finalize '%s'."), git_path_head_file());
311fd397
JS
1347 }
1348 return 0;
043a4492
RR
1349}
1350
1e41229d
SB
1351static int rollback_is_safe(void)
1352{
1353 struct strbuf sb = STRBUF_INIT;
1354 struct object_id expected_head, actual_head;
1355
1356 if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
1357 strbuf_trim(&sb);
1358 if (get_oid_hex(sb.buf, &expected_head)) {
1359 strbuf_release(&sb);
1360 die(_("could not parse %s"), git_path_abort_safety_file());
1361 }
1362 strbuf_release(&sb);
1363 }
1364 else if (errno == ENOENT)
1365 oidclr(&expected_head);
1366 else
1367 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
1368
1369 if (get_oid("HEAD", &actual_head))
1370 oidclr(&actual_head);
1371
1372 return !oidcmp(&actual_head, &expected_head);
1373}
1374
043a4492
RR
1375static int reset_for_rollback(const unsigned char *sha1)
1376{
1377 const char *argv[4]; /* reset --merge <arg> + NULL */
1e41229d 1378
043a4492
RR
1379 argv[0] = "reset";
1380 argv[1] = "--merge";
1381 argv[2] = sha1_to_hex(sha1);
1382 argv[3] = NULL;
1383 return run_command_v_opt(argv, RUN_GIT_CMD);
1384}
1385
1386static int rollback_single_pick(void)
1387{
1388 unsigned char head_sha1[20];
1389
f932729c
JK
1390 if (!file_exists(git_path_cherry_pick_head()) &&
1391 !file_exists(git_path_revert_head()))
043a4492 1392 return error(_("no cherry-pick or revert in progress"));
7695d118 1393 if (read_ref_full("HEAD", 0, head_sha1, NULL))
043a4492
RR
1394 return error(_("cannot resolve HEAD"));
1395 if (is_null_sha1(head_sha1))
1396 return error(_("cannot abort from a branch yet to be born"));
1397 return reset_for_rollback(head_sha1);
1398}
1399
2863584f 1400int sequencer_rollback(struct replay_opts *opts)
043a4492 1401{
043a4492
RR
1402 FILE *f;
1403 unsigned char sha1[20];
1404 struct strbuf buf = STRBUF_INIT;
1405
f932729c 1406 f = fopen(git_path_head_file(), "r");
043a4492
RR
1407 if (!f && errno == ENOENT) {
1408 /*
1409 * There is no multiple-cherry-pick in progress.
1410 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
1411 * a single-cherry-pick in progress, abort that.
1412 */
1413 return rollback_single_pick();
1414 }
1415 if (!f)
f7ed1953 1416 return error_errno(_("cannot open '%s'"), git_path_head_file());
8f309aeb 1417 if (strbuf_getline_lf(&buf, f)) {
f7ed1953 1418 error(_("cannot read '%s': %s"), git_path_head_file(),
f932729c 1419 ferror(f) ? strerror(errno) : _("unexpected end of file"));
043a4492
RR
1420 fclose(f);
1421 goto fail;
1422 }
1423 fclose(f);
1424 if (get_sha1_hex(buf.buf, sha1) || buf.buf[40] != '\0') {
1425 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
f932729c 1426 git_path_head_file());
043a4492
RR
1427 goto fail;
1428 }
0f974e21
MG
1429 if (is_null_sha1(sha1)) {
1430 error(_("cannot abort from a branch yet to be born"));
1431 goto fail;
1432 }
1e41229d
SB
1433
1434 if (!rollback_is_safe()) {
1435 /* Do not error, just do not rollback */
1436 warning(_("You seem to have moved HEAD. "
1437 "Not rewinding, check your HEAD!"));
1438 } else
043a4492
RR
1439 if (reset_for_rollback(sha1))
1440 goto fail;
043a4492 1441 strbuf_release(&buf);
2863584f 1442 return sequencer_remove_state(opts);
043a4492
RR
1443fail:
1444 strbuf_release(&buf);
1445 return -1;
1446}
1447
004fefa7 1448static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
043a4492 1449{
043a4492 1450 static struct lock_file todo_lock;
004fefa7
JS
1451 const char *todo_path = get_todo_path(opts);
1452 int next = todo_list->current, offset, fd;
043a4492 1453
84583957
JS
1454 /*
1455 * rebase -i writes "git-rebase-todo" without the currently executing
1456 * command, appending it to "done" instead.
1457 */
1458 if (is_rebase_i(opts))
1459 next++;
1460
004fefa7 1461 fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
221675de 1462 if (fd < 0)
93b3df6f 1463 return error_errno(_("could not lock '%s'"), todo_path);
004fefa7
JS
1464 offset = next < todo_list->nr ?
1465 todo_list->items[next].offset_in_buf : todo_list->buf.len;
1466 if (write_in_full(fd, todo_list->buf.buf + offset,
1467 todo_list->buf.len - offset) < 0)
93b3df6f 1468 return error_errno(_("could not write to '%s'"), todo_path);
004fefa7 1469 if (commit_lock_file(&todo_lock) < 0)
93b3df6f 1470 return error(_("failed to finalize '%s'."), todo_path);
1df6df0c
JS
1471
1472 if (is_rebase_i(opts)) {
1473 const char *done_path = rebase_path_done();
1474 int fd = open(done_path, O_CREAT | O_WRONLY | O_APPEND, 0666);
1475 int prev_offset = !next ? 0 :
1476 todo_list->items[next - 1].offset_in_buf;
1477
1478 if (fd >= 0 && offset > prev_offset &&
1479 write_in_full(fd, todo_list->buf.buf + prev_offset,
1480 offset - prev_offset) < 0) {
1481 close(fd);
1482 return error_errno(_("could not write to '%s'"),
1483 done_path);
1484 }
1485 if (fd >= 0)
1486 close(fd);
1487 }
221675de 1488 return 0;
043a4492
RR
1489}
1490
88d5a271 1491static int save_opts(struct replay_opts *opts)
043a4492 1492{
f932729c 1493 const char *opts_file = git_path_opts_file();
88d5a271 1494 int res = 0;
043a4492
RR
1495
1496 if (opts->no_commit)
88d5a271 1497 res |= git_config_set_in_file_gently(opts_file, "options.no-commit", "true");
043a4492 1498 if (opts->edit)
88d5a271 1499 res |= git_config_set_in_file_gently(opts_file, "options.edit", "true");
043a4492 1500 if (opts->signoff)
88d5a271 1501 res |= git_config_set_in_file_gently(opts_file, "options.signoff", "true");
043a4492 1502 if (opts->record_origin)
88d5a271 1503 res |= git_config_set_in_file_gently(opts_file, "options.record-origin", "true");
043a4492 1504 if (opts->allow_ff)
88d5a271 1505 res |= git_config_set_in_file_gently(opts_file, "options.allow-ff", "true");
043a4492
RR
1506 if (opts->mainline) {
1507 struct strbuf buf = STRBUF_INIT;
1508 strbuf_addf(&buf, "%d", opts->mainline);
88d5a271 1509 res |= git_config_set_in_file_gently(opts_file, "options.mainline", buf.buf);
043a4492
RR
1510 strbuf_release(&buf);
1511 }
1512 if (opts->strategy)
88d5a271 1513 res |= git_config_set_in_file_gently(opts_file, "options.strategy", opts->strategy);
3253553e 1514 if (opts->gpg_sign)
88d5a271 1515 res |= git_config_set_in_file_gently(opts_file, "options.gpg-sign", opts->gpg_sign);
043a4492
RR
1516 if (opts->xopts) {
1517 int i;
1518 for (i = 0; i < opts->xopts_nr; i++)
88d5a271 1519 res |= git_config_set_multivar_in_file_gently(opts_file,
043a4492
RR
1520 "options.strategy-option",
1521 opts->xopts[i], "^$", 0);
1522 }
88d5a271 1523 return res;
043a4492
RR
1524}
1525
56dc3ab0
JS
1526static int make_patch(struct commit *commit, struct replay_opts *opts)
1527{
1528 struct strbuf buf = STRBUF_INIT;
1529 struct rev_info log_tree_opt;
1530 const char *subject, *p;
1531 int res = 0;
1532
1533 p = short_commit_name(commit);
1534 if (write_message(p, strlen(p), rebase_path_stopped_sha(), 1) < 0)
1535 return -1;
1536
1537 strbuf_addf(&buf, "%s/patch", get_dir(opts));
1538 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
1539 init_revisions(&log_tree_opt, NULL);
1540 log_tree_opt.abbrev = 0;
1541 log_tree_opt.diff = 1;
1542 log_tree_opt.diffopt.output_format = DIFF_FORMAT_PATCH;
1543 log_tree_opt.disable_stdin = 1;
1544 log_tree_opt.no_commit_id = 1;
1545 log_tree_opt.diffopt.file = fopen(buf.buf, "w");
1546 log_tree_opt.diffopt.use_color = GIT_COLOR_NEVER;
1547 if (!log_tree_opt.diffopt.file)
1548 res |= error_errno(_("could not open '%s'"), buf.buf);
1549 else {
1550 res |= log_tree_commit(&log_tree_opt, commit);
1551 fclose(log_tree_opt.diffopt.file);
1552 }
1553 strbuf_reset(&buf);
1554
1555 strbuf_addf(&buf, "%s/message", get_dir(opts));
1556 if (!file_exists(buf.buf)) {
1557 const char *commit_buffer = get_commit_buffer(commit, NULL);
1558 find_commit_subject(commit_buffer, &subject);
1559 res |= write_message(subject, strlen(subject), buf.buf, 1);
1560 unuse_commit_buffer(commit, commit_buffer);
1561 }
1562 strbuf_release(&buf);
1563
1564 return res;
1565}
1566
1567static int intend_to_amend(void)
1568{
1569 unsigned char head[20];
1570 char *p;
1571
1572 if (get_sha1("HEAD", head))
1573 return error(_("cannot read HEAD"));
1574
1575 p = sha1_to_hex(head);
1576 return write_message(p, strlen(p), rebase_path_amend(), 1);
1577}
1578
1579static int error_with_patch(struct commit *commit,
1580 const char *subject, int subject_len,
1581 struct replay_opts *opts, int exit_code, int to_amend)
1582{
1583 if (make_patch(commit, opts))
1584 return -1;
1585
1586 if (to_amend) {
1587 if (intend_to_amend())
1588 return -1;
1589
1590 fprintf(stderr, "You can amend the commit now, with\n"
1591 "\n"
1592 " git commit --amend %s\n"
1593 "\n"
1594 "Once you are satisfied with your changes, run\n"
1595 "\n"
1596 " git rebase --continue\n", gpg_sign_opt_quoted(opts));
1597 } else if (exit_code)
1598 fprintf(stderr, "Could not apply %s... %.*s\n",
1599 short_commit_name(commit), subject_len, subject);
1600
1601 return exit_code;
1602}
1603
6e98de72
JS
1604static int error_failed_squash(struct commit *commit,
1605 struct replay_opts *opts, int subject_len, const char *subject)
1606{
1607 if (rename(rebase_path_squash_msg(), rebase_path_message()))
1608 return error(_("could not rename '%s' to '%s'"),
1609 rebase_path_squash_msg(), rebase_path_message());
1610 unlink(rebase_path_fixup_msg());
1611 unlink(git_path("MERGE_MSG"));
1612 if (copy_file(git_path("MERGE_MSG"), rebase_path_message(), 0666))
1613 return error(_("could not copy '%s' to '%s'"),
1614 rebase_path_message(), git_path("MERGE_MSG"));
1615 return error_with_patch(commit, subject, subject_len, opts, 1, 0);
1616}
1617
311af526
JS
1618static int do_exec(const char *command_line)
1619{
1620 const char *child_argv[] = { NULL, NULL };
1621 int dirty, status;
1622
1623 fprintf(stderr, "Executing: %s\n", command_line);
1624 child_argv[0] = command_line;
1625 status = run_command_v_opt(child_argv, RUN_USING_SHELL);
1626
1627 /* force re-reading of the cache */
1628 if (discard_cache() < 0 || read_cache() < 0)
1629 return error(_("could not read index"));
1630
1631 dirty = require_clean_work_tree("rebase", NULL, 1, 1);
1632
1633 if (status) {
1634 warning(_("execution failed: %s\n%s"
1635 "You can fix the problem, and then run\n"
1636 "\n"
1637 " git rebase --continue\n"
1638 "\n"),
1639 command_line,
1640 dirty ? N_("and made changes to the index and/or the "
1641 "working tree\n") : "");
1642 if (status == 127)
1643 /* command not found */
1644 status = 1;
1645 } else if (dirty) {
1646 warning(_("execution succeeded: %s\nbut "
1647 "left changes to the index and/or the working tree\n"
1648 "Commit or stash your changes, and then run\n"
1649 "\n"
1650 " git rebase --continue\n"
1651 "\n"), command_line);
1652 status = 1;
1653 }
1654
1655 return status;
1656}
1657
6e98de72
JS
1658static int is_final_fixup(struct todo_list *todo_list)
1659{
1660 int i = todo_list->current;
1661
1662 if (!is_fixup(todo_list->items[i].command))
1663 return 0;
1664
1665 while (++i < todo_list->nr)
1666 if (is_fixup(todo_list->items[i].command))
1667 return 0;
1668 else if (!is_noop(todo_list->items[i].command))
1669 break;
1670 return 1;
1671}
1672
004fefa7 1673static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
043a4492 1674{
56dc3ab0 1675 int res = 0;
043a4492
RR
1676
1677 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
1678 if (opts->allow_ff)
1679 assert(!(opts->signoff || opts->no_commit ||
1680 opts->record_origin || opts->edit));
0d9c6dc9
JS
1681 if (read_and_refresh_cache(opts))
1682 return -1;
043a4492 1683
004fefa7
JS
1684 while (todo_list->current < todo_list->nr) {
1685 struct todo_item *item = todo_list->items + todo_list->current;
1686 if (save_todo(todo_list, opts))
221675de 1687 return -1;
6e98de72
JS
1688 if (is_rebase_i(opts)) {
1689 unlink(rebase_path_message());
1690 unlink(rebase_path_author_script());
1691 unlink(rebase_path_stopped_sha());
1692 unlink(rebase_path_amend());
1693 }
1694 if (item->command <= TODO_SQUASH) {
25c43667 1695 res = do_pick_commit(item->command, item->commit,
6e98de72 1696 opts, is_final_fixup(todo_list));
56dc3ab0
JS
1697 if (item->command == TODO_EDIT) {
1698 struct commit *commit = item->commit;
1699 if (!res)
1700 warning(_("stopped at %s... %.*s"),
1701 short_commit_name(commit),
1702 item->arg_len, item->arg);
1703 return error_with_patch(commit,
1704 item->arg, item->arg_len, opts, res,
1705 !res);
1706 }
6e98de72
JS
1707 if (res && is_fixup(item->command)) {
1708 if (res == 1)
1709 intend_to_amend();
1710 return error_failed_squash(item->commit, opts,
1711 item->arg_len, item->arg);
1712 }
311af526
JS
1713 } else if (item->command == TODO_EXEC) {
1714 char *end_of_arg = (char *)(item->arg + item->arg_len);
1715 int saved = *end_of_arg;
1716
1717 *end_of_arg = '\0';
1718 res = do_exec(item->arg);
1719 *end_of_arg = saved;
56dc3ab0 1720 } else if (!is_noop(item->command))
25c43667
JS
1721 return error(_("unknown command %d"), item->command);
1722
004fefa7 1723 todo_list->current++;
043a4492
RR
1724 if (res)
1725 return res;
1726 }
1727
56dc3ab0 1728 if (is_rebase_i(opts)) {
556907f1
JS
1729 struct strbuf buf = STRBUF_INIT;
1730
56dc3ab0
JS
1731 /* Stopped in the middle, as planned? */
1732 if (todo_list->current < todo_list->nr)
1733 return 0;
556907f1
JS
1734
1735 if (opts->verbose) {
1736 struct rev_info log_tree_opt;
1737 struct object_id orig, head;
1738
1739 memset(&log_tree_opt, 0, sizeof(log_tree_opt));
1740 init_revisions(&log_tree_opt, NULL);
1741 log_tree_opt.diff = 1;
1742 log_tree_opt.diffopt.output_format =
1743 DIFF_FORMAT_DIFFSTAT;
1744 log_tree_opt.disable_stdin = 1;
1745
1746 if (read_oneliner(&buf, rebase_path_orig_head(), 0) &&
1747 !get_sha1(buf.buf, orig.hash) &&
1748 !get_sha1("HEAD", head.hash)) {
1749 diff_tree_sha1(orig.hash, head.hash,
1750 "", &log_tree_opt.diffopt);
1751 log_tree_diff_flush(&log_tree_opt);
1752 }
1753 }
1754 strbuf_release(&buf);
56dc3ab0
JS
1755 }
1756
043a4492
RR
1757 /*
1758 * Sequence of picks finished successfully; cleanup by
1759 * removing the .git/sequencer directory
1760 */
2863584f 1761 return sequencer_remove_state(opts);
043a4492
RR
1762}
1763
1764static int continue_single_pick(void)
1765{
1766 const char *argv[] = { "commit", NULL };
1767
f932729c
JK
1768 if (!file_exists(git_path_cherry_pick_head()) &&
1769 !file_exists(git_path_revert_head()))
043a4492
RR
1770 return error(_("no cherry-pick or revert in progress"));
1771 return run_command_v_opt(argv, RUN_GIT_CMD);
1772}
1773
2863584f 1774int sequencer_continue(struct replay_opts *opts)
043a4492 1775{
004fefa7
JS
1776 struct todo_list todo_list = TODO_LIST_INIT;
1777 int res;
043a4492 1778
2863584f
JS
1779 if (read_and_refresh_cache(opts))
1780 return -1;
1781
c0246501 1782 if (!file_exists(get_todo_path(opts)))
043a4492 1783 return continue_single_pick();
004fefa7 1784 if (read_populate_opts(opts))
0ae42a03 1785 return -1;
004fefa7
JS
1786 if ((res = read_populate_todo(&todo_list, opts)))
1787 goto release_todo_list;
043a4492
RR
1788
1789 /* Verify that the conflict has been resolved */
f932729c
JK
1790 if (file_exists(git_path_cherry_pick_head()) ||
1791 file_exists(git_path_revert_head())) {
004fefa7
JS
1792 res = continue_single_pick();
1793 if (res)
1794 goto release_todo_list;
043a4492 1795 }
65036021 1796 if (index_differs_from("HEAD", 0, 0)) {
004fefa7
JS
1797 res = error_dirty_index(opts);
1798 goto release_todo_list;
1799 }
1800 todo_list.current++;
1801 res = pick_commits(&todo_list, opts);
1802release_todo_list:
1803 todo_list_release(&todo_list);
1804 return res;
043a4492
RR
1805}
1806
1807static int single_pick(struct commit *cmit, struct replay_opts *opts)
1808{
1809 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
004fefa7 1810 return do_pick_commit(opts->action == REPLAY_PICK ?
6e98de72 1811 TODO_PICK : TODO_REVERT, cmit, opts, 0);
043a4492
RR
1812}
1813
1814int sequencer_pick_revisions(struct replay_opts *opts)
1815{
004fefa7 1816 struct todo_list todo_list = TODO_LIST_INIT;
043a4492 1817 unsigned char sha1[20];
004fefa7 1818 int i, res;
043a4492 1819
2863584f 1820 assert(opts->revs);
0d9c6dc9
JS
1821 if (read_and_refresh_cache(opts))
1822 return -1;
043a4492 1823
21246dbb
MV
1824 for (i = 0; i < opts->revs->pending.nr; i++) {
1825 unsigned char sha1[20];
1826 const char *name = opts->revs->pending.objects[i].name;
1827
1828 /* This happens when using --stdin. */
1829 if (!strlen(name))
1830 continue;
1831
1832 if (!get_sha1(name, sha1)) {
7c0b0d8d
JH
1833 if (!lookup_commit_reference_gently(sha1, 1)) {
1834 enum object_type type = sha1_object_info(sha1, NULL);
b9b946d4
JS
1835 return error(_("%s: can't cherry-pick a %s"),
1836 name, typename(type));
7c0b0d8d 1837 }
21246dbb 1838 } else
b9b946d4 1839 return error(_("%s: bad revision"), name);
21246dbb
MV
1840 }
1841
043a4492
RR
1842 /*
1843 * If we were called as "git cherry-pick <commit>", just
1844 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
1845 * REVERT_HEAD, and don't touch the sequencer state.
1846 * This means it is possible to cherry-pick in the middle
1847 * of a cherry-pick sequence.
1848 */
1849 if (opts->revs->cmdline.nr == 1 &&
1850 opts->revs->cmdline.rev->whence == REV_CMD_REV &&
1851 opts->revs->no_walk &&
1852 !opts->revs->cmdline.rev->flags) {
1853 struct commit *cmit;
1854 if (prepare_revision_walk(opts->revs))
b9b946d4 1855 return error(_("revision walk setup failed"));
043a4492
RR
1856 cmit = get_revision(opts->revs);
1857 if (!cmit || get_revision(opts->revs))
b9b946d4 1858 return error("BUG: expected exactly one commit from walk");
043a4492
RR
1859 return single_pick(cmit, opts);
1860 }
1861
1862 /*
1863 * Start a new cherry-pick/ revert sequence; but
1864 * first, make sure that an existing one isn't in
1865 * progress
1866 */
1867
34b0528b
JS
1868 if (walk_revs_populate_todo(&todo_list, opts) ||
1869 create_seq_dir() < 0)
043a4492 1870 return -1;
0f974e21 1871 if (get_sha1("HEAD", sha1) && (opts->action == REPLAY_REVERT))
93b3df6f 1872 return error(_("can't revert as initial commit"));
311fd397
JS
1873 if (save_head(sha1_to_hex(sha1)))
1874 return -1;
88d5a271
JS
1875 if (save_opts(opts))
1876 return -1;
1e41229d 1877 update_abort_safety_file();
004fefa7
JS
1878 res = pick_commits(&todo_list, opts);
1879 todo_list_release(&todo_list);
1880 return res;
043a4492 1881}
5ed75e2a 1882
bab4d109 1883void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag)
5ed75e2a 1884{
bab4d109 1885 unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
5ed75e2a 1886 struct strbuf sob = STRBUF_INIT;
bab4d109 1887 int has_footer;
5ed75e2a
MV
1888
1889 strbuf_addstr(&sob, sign_off_header);
1890 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
1891 getenv("GIT_COMMITTER_EMAIL")));
1892 strbuf_addch(&sob, '\n');
bab4d109
BC
1893
1894 /*
1895 * If the whole message buffer is equal to the sob, pretend that we
1896 * found a conforming footer with a matching sob
1897 */
1898 if (msgbuf->len - ignore_footer == sob.len &&
1899 !strncmp(msgbuf->buf, sob.buf, sob.len))
1900 has_footer = 3;
1901 else
1902 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
1903
33f2f9ab
BC
1904 if (!has_footer) {
1905 const char *append_newlines = NULL;
1906 size_t len = msgbuf->len - ignore_footer;
1907
8c613fd5
BC
1908 if (!len) {
1909 /*
1910 * The buffer is completely empty. Leave foom for
1911 * the title and body to be filled in by the user.
1912 */
33f2f9ab 1913 append_newlines = "\n\n";
8c613fd5
BC
1914 } else if (msgbuf->buf[len - 1] != '\n') {
1915 /*
1916 * Incomplete line. Complete the line and add a
1917 * blank one so that there is an empty line between
1918 * the message body and the sob.
1919 */
1920 append_newlines = "\n\n";
1921 } else if (len == 1) {
1922 /*
1923 * Buffer contains a single newline. Add another
1924 * so that we leave room for the title and body.
1925 */
1926 append_newlines = "\n";
1927 } else if (msgbuf->buf[len - 2] != '\n') {
1928 /*
1929 * Buffer ends with a single newline. Add another
1930 * so that there is an empty line between the message
1931 * body and the sob.
1932 */
33f2f9ab 1933 append_newlines = "\n";
8c613fd5 1934 } /* else, the buffer already ends with two newlines. */
33f2f9ab
BC
1935
1936 if (append_newlines)
1937 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
1938 append_newlines, strlen(append_newlines));
5ed75e2a 1939 }
bab4d109
BC
1940
1941 if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
1942 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
1943 sob.buf, sob.len);
1944
5ed75e2a
MV
1945 strbuf_release(&sob);
1946}