sequencer: move "else" keyword onto the same line as preceding brace
[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"
043a4492
RR
20
21#define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
26ae337b 22
5ed75e2a 23const char sign_off_header[] = "Signed-off-by: ";
cd650a4e 24static const char cherry_picked_prefix[] = "(cherry picked from commit ";
5ed75e2a 25
8a2a0f53
JS
26GIT_PATH_FUNC(git_path_seq_dir, "sequencer")
27
28static GIT_PATH_FUNC(git_path_todo_file, "sequencer/todo")
29static GIT_PATH_FUNC(git_path_opts_file, "sequencer/opts")
30static GIT_PATH_FUNC(git_path_head_file, "sequencer/head")
1e41229d 31static GIT_PATH_FUNC(git_path_abort_safety_file, "sequencer/abort-safety")
f932729c 32
b5a67045
JS
33/*
34 * A script to set the GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, and
35 * GIT_AUTHOR_DATE that will be used for the commit that is currently
36 * being rebased.
37 */
38static GIT_PATH_FUNC(rebase_path_author_script, "rebase-merge/author-script")
a1c75762
JS
39/*
40 * The following files are written by git-rebase just after parsing the
41 * command-line (and are only consumed, not modified, by the sequencer).
42 */
43static GIT_PATH_FUNC(rebase_path_gpg_sign_opt, "rebase-merge/gpg_sign_opt")
b5a67045
JS
44
45/* We will introduce the 'interactive rebase' mode later */
46static inline int is_rebase_i(const struct replay_opts *opts)
47{
48 return 0;
49}
50
285abf56
JS
51static const char *get_dir(const struct replay_opts *opts)
52{
53 return git_path_seq_dir();
54}
55
c0246501
JS
56static const char *get_todo_path(const struct replay_opts *opts)
57{
58 return git_path_todo_file();
59}
60
bab4d109
BC
61/*
62 * Returns 0 for non-conforming footer
63 * Returns 1 for conforming footer
64 * Returns 2 when sob exists within conforming footer
65 * Returns 3 when sob exists within conforming footer as last entry
66 */
67static int has_conforming_footer(struct strbuf *sb, struct strbuf *sob,
68 int ignore_footer)
b971e04f 69{
967dfd4d
JT
70 struct trailer_info info;
71 int i;
72 int found_sob = 0, found_sob_last = 0;
b971e04f 73
967dfd4d 74 trailer_info_get(&info, sb->buf);
b971e04f 75
967dfd4d 76 if (info.trailer_start == info.trailer_end)
b971e04f
BC
77 return 0;
78
967dfd4d
JT
79 for (i = 0; i < info.trailer_nr; i++)
80 if (sob && !strncmp(info.trailers[i], sob->buf, sob->len)) {
81 found_sob = 1;
82 if (i == info.trailer_nr - 1)
83 found_sob_last = 1;
84 }
b971e04f 85
967dfd4d 86 trailer_info_release(&info);
bab4d109 87
967dfd4d 88 if (found_sob_last)
bab4d109
BC
89 return 3;
90 if (found_sob)
91 return 2;
b971e04f
BC
92 return 1;
93}
5ed75e2a 94
a1c75762
JS
95static const char *gpg_sign_opt_quoted(struct replay_opts *opts)
96{
97 static struct strbuf buf = STRBUF_INIT;
98
99 strbuf_reset(&buf);
100 if (opts->gpg_sign)
101 sq_quotef(&buf, "-S%s", opts->gpg_sign);
102 return buf.buf;
103}
104
2863584f 105int sequencer_remove_state(struct replay_opts *opts)
26ae337b 106{
285abf56 107 struct strbuf dir = STRBUF_INIT;
03a4e260
JS
108 int i;
109
110 free(opts->gpg_sign);
111 free(opts->strategy);
112 for (i = 0; i < opts->xopts_nr; i++)
113 free(opts->xopts[i]);
114 free(opts->xopts);
26ae337b 115
285abf56
JS
116 strbuf_addf(&dir, "%s", get_dir(opts));
117 remove_dir_recursively(&dir, 0);
118 strbuf_release(&dir);
2863584f
JS
119
120 return 0;
26ae337b 121}
043a4492
RR
122
123static const char *action_name(const struct replay_opts *opts)
124{
c28cbc5e 125 return opts->action == REPLAY_REVERT ? N_("revert") : N_("cherry-pick");
043a4492
RR
126}
127
043a4492
RR
128struct commit_message {
129 char *parent_label;
7b35eaf8
JK
130 char *label;
131 char *subject;
043a4492
RR
132 const char *message;
133};
134
39755964
JS
135static const char *short_commit_name(struct commit *commit)
136{
137 return find_unique_abbrev(commit->object.oid.hash, DEFAULT_ABBREV);
138}
139
043a4492
RR
140static int get_message(struct commit *commit, struct commit_message *out)
141{
043a4492 142 const char *abbrev, *subject;
7b35eaf8 143 int subject_len;
043a4492 144
7b35eaf8 145 out->message = logmsg_reencode(commit, NULL, get_commit_output_encoding());
39755964 146 abbrev = short_commit_name(commit);
043a4492
RR
147
148 subject_len = find_commit_subject(out->message, &subject);
149
7b35eaf8
JK
150 out->subject = xmemdupz(subject, subject_len);
151 out->label = xstrfmt("%s... %s", abbrev, out->subject);
152 out->parent_label = xstrfmt("parent of %s", out->label);
153
043a4492
RR
154 return 0;
155}
156
d74a4e57 157static void free_message(struct commit *commit, struct commit_message *msg)
043a4492
RR
158{
159 free(msg->parent_label);
7b35eaf8
JK
160 free(msg->label);
161 free(msg->subject);
b66103c3 162 unuse_commit_buffer(commit, msg->message);
043a4492
RR
163}
164
ed727b19 165static void print_advice(int show_hint, struct replay_opts *opts)
043a4492
RR
166{
167 char *msg = getenv("GIT_CHERRY_PICK_HELP");
168
169 if (msg) {
170 fprintf(stderr, "%s\n", msg);
171 /*
41ccfdd9 172 * A conflict has occurred but the porcelain
043a4492
RR
173 * (typically rebase --interactive) wants to take care
174 * of the commit itself so remove CHERRY_PICK_HEAD
175 */
f932729c 176 unlink(git_path_cherry_pick_head());
043a4492
RR
177 return;
178 }
179
ed727b19
PH
180 if (show_hint) {
181 if (opts->no_commit)
182 advise(_("after resolving the conflicts, mark the corrected paths\n"
183 "with 'git add <paths>' or 'git rm <paths>'"));
184 else
185 advise(_("after resolving the conflicts, mark the corrected paths\n"
186 "with 'git add <paths>' or 'git rm <paths>'\n"
187 "and commit the result with 'git commit'"));
188 }
043a4492
RR
189}
190
f56fffef
JS
191static int write_message(const void *buf, size_t len, const char *filename,
192 int append_eol)
043a4492
RR
193{
194 static struct lock_file msg_file;
195
4ef3d8f0
JS
196 int msg_fd = hold_lock_file_for_update(&msg_file, filename, 0);
197 if (msg_fd < 0)
93b3df6f 198 return error_errno(_("could not lock '%s'"), filename);
75871495 199 if (write_in_full(msg_fd, buf, len) < 0) {
4f66c837 200 rollback_lock_file(&msg_file);
93b3df6f 201 return error_errno(_("could not write to '%s'"), filename);
4f66c837 202 }
f56fffef
JS
203 if (append_eol && write(msg_fd, "\n", 1) < 0) {
204 rollback_lock_file(&msg_file);
35871806 205 return error_errno(_("could not write eol to '%s'"), filename);
f56fffef 206 }
4f66c837
JS
207 if (commit_lock_file(&msg_file) < 0) {
208 rollback_lock_file(&msg_file);
93b3df6f 209 return error(_("failed to finalize '%s'."), filename);
4f66c837 210 }
4ef3d8f0
JS
211
212 return 0;
043a4492
RR
213}
214
1dfc84e9
JS
215/*
216 * Reads a file that was presumably written by a shell script, i.e. with an
217 * end-of-line marker that needs to be stripped.
218 *
219 * Note that only the last end-of-line marker is stripped, consistent with the
220 * behavior of "$(cat path)" in a shell script.
221 *
222 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
223 */
224static int read_oneliner(struct strbuf *buf,
225 const char *path, int skip_if_empty)
226{
227 int orig_len = buf->len;
228
229 if (!file_exists(path))
230 return 0;
231
232 if (strbuf_read_file(buf, path, 0) < 0) {
233 warning_errno(_("could not read '%s'"), path);
234 return 0;
235 }
236
237 if (buf->len > orig_len && buf->buf[buf->len - 1] == '\n') {
238 if (--buf->len > orig_len && buf->buf[buf->len - 1] == '\r')
239 --buf->len;
240 buf->buf[buf->len] = '\0';
241 }
242
243 if (skip_if_empty && buf->len == orig_len)
244 return 0;
245
246 return 1;
247}
248
043a4492
RR
249static struct tree *empty_tree(void)
250{
cba595bd 251 return lookup_tree(EMPTY_TREE_SHA1_BIN);
043a4492
RR
252}
253
254static int error_dirty_index(struct replay_opts *opts)
255{
256 if (read_cache_unmerged())
c28cbc5e 257 return error_resolve_conflict(_(action_name(opts)));
043a4492 258
93b3df6f 259 error(_("your local changes would be overwritten by %s."),
c28cbc5e 260 _(action_name(opts)));
043a4492
RR
261
262 if (advice_commit_before_merge)
93b3df6f 263 advise(_("commit your changes or stash them to proceed."));
043a4492
RR
264 return -1;
265}
266
1e41229d
SB
267static void update_abort_safety_file(void)
268{
269 struct object_id head;
270
271 /* Do nothing on a single-pick */
272 if (!file_exists(git_path_seq_dir()))
273 return;
274
275 if (!get_oid("HEAD", &head))
276 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head));
277 else
278 write_file(git_path_abort_safety_file(), "%s", "");
279}
280
334ae397 281static int fast_forward_to(const unsigned char *to, const unsigned char *from,
eb4be1cb 282 int unborn, struct replay_opts *opts)
043a4492 283{
d668d16c 284 struct ref_transaction *transaction;
eb4be1cb 285 struct strbuf sb = STRBUF_INIT;
d668d16c 286 struct strbuf err = STRBUF_INIT;
043a4492
RR
287
288 read_cache();
db699a8a 289 if (checkout_fast_forward(from, to, 1))
0e408fc3 290 return -1; /* the callee should have complained already */
651ab9f5 291
c28cbc5e 292 strbuf_addf(&sb, _("%s: fast-forward"), _(action_name(opts)));
d668d16c
RS
293
294 transaction = ref_transaction_begin(&err);
295 if (!transaction ||
296 ref_transaction_update(transaction, "HEAD",
297 to, unborn ? null_sha1 : from,
1d147bdf 298 0, sb.buf, &err) ||
db7516ab 299 ref_transaction_commit(transaction, &err)) {
d668d16c
RS
300 ref_transaction_free(transaction);
301 error("%s", err.buf);
302 strbuf_release(&sb);
303 strbuf_release(&err);
304 return -1;
305 }
651ab9f5 306
eb4be1cb 307 strbuf_release(&sb);
d668d16c
RS
308 strbuf_release(&err);
309 ref_transaction_free(transaction);
1e41229d 310 update_abort_safety_file();
d668d16c 311 return 0;
043a4492
RR
312}
313
75c961b7
JH
314void append_conflicts_hint(struct strbuf *msgbuf)
315{
316 int i;
317
261f315b
JH
318 strbuf_addch(msgbuf, '\n');
319 strbuf_commented_addf(msgbuf, "Conflicts:\n");
75c961b7
JH
320 for (i = 0; i < active_nr;) {
321 const struct cache_entry *ce = active_cache[i++];
322 if (ce_stage(ce)) {
261f315b 323 strbuf_commented_addf(msgbuf, "\t%s\n", ce->name);
75c961b7
JH
324 while (i < active_nr && !strcmp(ce->name,
325 active_cache[i]->name))
326 i++;
327 }
328 }
329}
330
043a4492
RR
331static int do_recursive_merge(struct commit *base, struct commit *next,
332 const char *base_label, const char *next_label,
333 unsigned char *head, struct strbuf *msgbuf,
334 struct replay_opts *opts)
335{
336 struct merge_options o;
337 struct tree *result, *next_tree, *base_tree, *head_tree;
03b86647 338 int clean;
03a4e260 339 char **xopt;
043a4492
RR
340 static struct lock_file index_lock;
341
b3e83cc7 342 hold_locked_index(&index_lock, LOCK_DIE_ON_ERROR);
043a4492
RR
343
344 read_cache();
345
346 init_merge_options(&o);
347 o.ancestor = base ? base_label : "(empty tree)";
348 o.branch1 = "HEAD";
349 o.branch2 = next ? next_label : "(empty tree)";
350
351 head_tree = parse_tree_indirect(head);
352 next_tree = next ? next->tree : empty_tree();
353 base_tree = base ? base->tree : empty_tree();
354
355 for (xopt = opts->xopts; xopt != opts->xopts + opts->xopts_nr; xopt++)
356 parse_merge_opt(&o, *xopt);
357
358 clean = merge_trees(&o,
359 head_tree,
360 next_tree, base_tree, &result);
548009c0 361 strbuf_release(&o.obuf);
f241ff0d
JS
362 if (clean < 0)
363 return clean;
043a4492
RR
364
365 if (active_cache_changed &&
03b86647 366 write_locked_index(&the_index, &index_lock, COMMIT_LOCK))
043a4492 367 /* TRANSLATORS: %s will be "revert" or "cherry-pick" */
c527b55e 368 return error(_("%s: Unable to write new index file"),
c28cbc5e 369 _(action_name(opts)));
043a4492
RR
370 rollback_lock_file(&index_lock);
371
5ed75e2a 372 if (opts->signoff)
bab4d109 373 append_signoff(msgbuf, 0, 0);
5ed75e2a 374
75c961b7
JH
375 if (!clean)
376 append_conflicts_hint(msgbuf);
043a4492
RR
377
378 return !clean;
379}
380
b27cfb0d
NH
381static int is_index_unchanged(void)
382{
383 unsigned char head_sha1[20];
384 struct commit *head_commit;
385
7695d118 386 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING, head_sha1, NULL))
93b3df6f 387 return error(_("could not resolve HEAD commit\n"));
b27cfb0d
NH
388
389 head_commit = lookup_commit(head_sha1);
4b580061
NH
390
391 /*
392 * If head_commit is NULL, check_commit, called from
393 * lookup_commit, would have indicated that head_commit is not
394 * a commit object already. parse_commit() will return failure
395 * without further complaints in such a case. Otherwise, if
396 * the commit is invalid, parse_commit() will complain. So
397 * there is nothing for us to say here. Just return failure.
398 */
399 if (parse_commit(head_commit))
400 return -1;
b27cfb0d
NH
401
402 if (!active_cache_tree)
403 active_cache_tree = cache_tree();
404
405 if (!cache_tree_fully_valid(active_cache_tree))
d0cfc3e8 406 if (cache_tree_update(&the_index, 0))
93b3df6f 407 return error(_("unable to update cache tree\n"));
b27cfb0d 408
ed1c9977 409 return !hashcmp(active_cache_tree->sha1, head_commit->tree->object.oid.hash);
b27cfb0d
NH
410}
411
b5a67045
JS
412/*
413 * Read the author-script file into an environment block, ready for use in
414 * run_command(), that can be free()d afterwards.
415 */
416static char **read_author_script(void)
417{
418 struct strbuf script = STRBUF_INIT;
419 int i, count = 0;
420 char *p, *p2, **env;
421 size_t env_size;
422
423 if (strbuf_read_file(&script, rebase_path_author_script(), 256) <= 0)
424 return NULL;
425
426 for (p = script.buf; *p; p++)
427 if (skip_prefix(p, "'\\\\''", (const char **)&p2))
428 strbuf_splice(&script, p - script.buf, p2 - p, "'", 1);
429 else if (*p == '\'')
430 strbuf_splice(&script, p-- - script.buf, 1, "", 0);
431 else if (*p == '\n') {
432 *p = '\0';
433 count++;
434 }
435
436 env_size = (count + 1) * sizeof(*env);
437 strbuf_grow(&script, env_size);
438 memmove(script.buf + env_size, script.buf, script.len);
439 p = script.buf + env_size;
440 env = (char **)strbuf_detach(&script, NULL);
441
442 for (i = 0; i < count; i++) {
443 env[i] = p;
444 p += strlen(p) + 1;
445 }
446 env[count] = NULL;
447
448 return env;
449}
450
791eb870
JS
451static const char staged_changes_advice[] =
452N_("you have staged changes in your working tree\n"
453"If these changes are meant to be squashed into the previous commit, run:\n"
454"\n"
455" git commit --amend %s\n"
456"\n"
457"If they are meant to go into a new commit, run:\n"
458"\n"
459" git commit %s\n"
460"\n"
461"In both cases, once you're done, continue with:\n"
462"\n"
463" git rebase --continue\n");
464
043a4492
RR
465/*
466 * If we are cherry-pick, and if the merge did not result in
467 * hand-editing, we will hit this commit and inherit the original
468 * author date and name.
b5a67045 469 *
043a4492
RR
470 * If we are revert, or if our cherry-pick results in a hand merge,
471 * we had better say that the current user is responsible for that.
b5a67045
JS
472 *
473 * An exception is when run_git_commit() is called during an
474 * interactive rebase: in that case, we will want to retain the
475 * author metadata.
043a4492 476 */
ac2b0e8f 477static int run_git_commit(const char *defmsg, struct replay_opts *opts,
0009426d
JS
478 int allow_empty, int edit, int amend,
479 int cleanup_commit_message)
043a4492 480{
b5a67045 481 char **env = NULL;
b27cfb0d
NH
482 struct argv_array array;
483 int rc;
17d65f03 484 const char *value;
b27cfb0d 485
b5a67045
JS
486 if (is_rebase_i(opts)) {
487 env = read_author_script();
a1c75762
JS
488 if (!env) {
489 const char *gpg_opt = gpg_sign_opt_quoted(opts);
490
791eb870
JS
491 return error(_(staged_changes_advice),
492 gpg_opt, gpg_opt);
a1c75762 493 }
b5a67045
JS
494 }
495
b27cfb0d
NH
496 argv_array_init(&array);
497 argv_array_push(&array, "commit");
498 argv_array_push(&array, "-n");
043a4492 499
9240beda
JS
500 if (amend)
501 argv_array_push(&array, "--amend");
3bdd5522
JK
502 if (opts->gpg_sign)
503 argv_array_pushf(&array, "-S%s", opts->gpg_sign);
043a4492 504 if (opts->signoff)
b27cfb0d 505 argv_array_push(&array, "-s");
b5a67045
JS
506 if (defmsg)
507 argv_array_pushl(&array, "-F", defmsg, NULL);
0009426d
JS
508 if (cleanup_commit_message)
509 argv_array_push(&array, "--cleanup=strip");
a1c75762 510 if (edit)
b5a67045 511 argv_array_push(&array, "-e");
0009426d
JS
512 else if (!cleanup_commit_message &&
513 !opts->signoff && !opts->record_origin &&
b5a67045
JS
514 git_config_get_value("commit.cleanup", &value))
515 argv_array_push(&array, "--cleanup=verbatim");
b27cfb0d 516
ac2b0e8f 517 if (allow_empty)
b27cfb0d 518 argv_array_push(&array, "--allow-empty");
df478b74 519
4bee9584
CW
520 if (opts->allow_empty_message)
521 argv_array_push(&array, "--allow-empty-message");
522
b5a67045
JS
523 rc = run_command_v_opt_cd_env(array.argv, RUN_GIT_CMD, NULL,
524 (const char *const *)env);
b27cfb0d 525 argv_array_clear(&array);
b5a67045
JS
526 free(env);
527
b27cfb0d
NH
528 return rc;
529}
530
531static int is_original_commit_empty(struct commit *commit)
532{
533 const unsigned char *ptree_sha1;
534
535 if (parse_commit(commit))
93b3df6f 536 return error(_("could not parse commit %s\n"),
f2fd0760 537 oid_to_hex(&commit->object.oid));
b27cfb0d
NH
538 if (commit->parents) {
539 struct commit *parent = commit->parents->item;
540 if (parse_commit(parent))
93b3df6f 541 return error(_("could not parse parent commit %s\n"),
f2fd0760 542 oid_to_hex(&parent->object.oid));
ed1c9977 543 ptree_sha1 = parent->tree->object.oid.hash;
b27cfb0d
NH
544 } else {
545 ptree_sha1 = EMPTY_TREE_SHA1_BIN; /* commit is root */
043a4492 546 }
043a4492 547
ed1c9977 548 return !hashcmp(ptree_sha1, commit->tree->object.oid.hash);
043a4492
RR
549}
550
ac2b0e8f
JH
551/*
552 * Do we run "git commit" with "--allow-empty"?
553 */
554static int allow_empty(struct replay_opts *opts, struct commit *commit)
555{
556 int index_unchanged, empty_commit;
557
558 /*
559 * Three cases:
560 *
561 * (1) we do not allow empty at all and error out.
562 *
563 * (2) we allow ones that were initially empty, but
564 * forbid the ones that become empty;
565 *
566 * (3) we allow both.
567 */
568 if (!opts->allow_empty)
569 return 0; /* let "git commit" barf as necessary */
570
571 index_unchanged = is_index_unchanged();
572 if (index_unchanged < 0)
573 return index_unchanged;
574 if (!index_unchanged)
575 return 0; /* we do not have to say --allow-empty */
576
577 if (opts->keep_redundant_commits)
578 return 1;
579
580 empty_commit = is_original_commit_empty(commit);
581 if (empty_commit < 0)
582 return empty_commit;
583 if (!empty_commit)
584 return 0;
585 else
586 return 1;
587}
588
004fefa7
JS
589enum todo_command {
590 TODO_PICK = 0,
591 TODO_REVERT
592};
593
594static const char *todo_command_strings[] = {
595 "pick",
596 "revert"
597};
598
599static const char *command_to_string(const enum todo_command command)
600{
2ae38f2a 601 if ((size_t)command < ARRAY_SIZE(todo_command_strings))
004fefa7
JS
602 return todo_command_strings[command];
603 die("Unknown command: %d", command);
604}
605
606
607static int do_pick_commit(enum todo_command command, struct commit *commit,
608 struct replay_opts *opts)
043a4492
RR
609{
610 unsigned char head[20];
611 struct commit *base, *next, *parent;
612 const char *base_label, *next_label;
d74a4e57 613 struct commit_message msg = { NULL, NULL, NULL, NULL };
043a4492 614 struct strbuf msgbuf = STRBUF_INIT;
c8d1351d 615 int res, unborn = 0, allow;
043a4492
RR
616
617 if (opts->no_commit) {
618 /*
619 * We do not intend to commit immediately. We just want to
620 * merge the differences in, so let's compute the tree
621 * that represents the "current" state for merge-recursive
622 * to work on.
623 */
624 if (write_cache_as_tree(head, 0, NULL))
93b3df6f 625 return error(_("your index file is unmerged."));
043a4492 626 } else {
334ae397
MZ
627 unborn = get_sha1("HEAD", head);
628 if (unborn)
629 hashcpy(head, EMPTY_TREE_SHA1_BIN);
018ec3c8 630 if (index_differs_from(unborn ? EMPTY_TREE_SHA1_HEX : "HEAD", 0, 0))
043a4492
RR
631 return error_dirty_index(opts);
632 }
633 discard_cache();
634
637666c8 635 if (!commit->parents)
043a4492 636 parent = NULL;
043a4492
RR
637 else if (commit->parents->next) {
638 /* Reverting or cherry-picking a merge commit */
639 int cnt;
640 struct commit_list *p;
641
642 if (!opts->mainline)
93b3df6f 643 return error(_("commit %s is a merge but no -m option was given."),
f2fd0760 644 oid_to_hex(&commit->object.oid));
043a4492
RR
645
646 for (cnt = 1, p = commit->parents;
647 cnt != opts->mainline && p;
648 cnt++)
649 p = p->next;
650 if (cnt != opts->mainline || !p)
93b3df6f 651 return error(_("commit %s does not have parent %d"),
f2fd0760 652 oid_to_hex(&commit->object.oid), opts->mainline);
043a4492
RR
653 parent = p->item;
654 } else if (0 < opts->mainline)
93b3df6f 655 return error(_("mainline was specified but commit %s is not a merge."),
f2fd0760 656 oid_to_hex(&commit->object.oid));
043a4492
RR
657 else
658 parent = commit->parents->item;
659
334ae397 660 if (opts->allow_ff &&
ed1c9977 661 ((parent && !hashcmp(parent->object.oid.hash, head)) ||
334ae397 662 (!parent && unborn)))
ed1c9977 663 return fast_forward_to(commit->object.oid.hash, head, unborn, opts);
043a4492
RR
664
665 if (parent && parse_commit(parent) < 0)
004fefa7
JS
666 /* TRANSLATORS: The first %s will be a "todo" command like
667 "revert" or "pick", the second %s a SHA1. */
043a4492 668 return error(_("%s: cannot parse parent commit %s"),
004fefa7
JS
669 command_to_string(command),
670 oid_to_hex(&parent->object.oid));
043a4492
RR
671
672 if (get_message(commit, &msg) != 0)
93b3df6f 673 return error(_("cannot get commit message for %s"),
f2fd0760 674 oid_to_hex(&commit->object.oid));
043a4492
RR
675
676 /*
677 * "commit" is an existing commit. We would want to apply
678 * the difference it introduces since its first parent "prev"
679 * on top of the current HEAD if we are cherry-pick. Or the
680 * reverse of it if we are revert.
681 */
682
004fefa7 683 if (command == TODO_REVERT) {
043a4492
RR
684 base = commit;
685 base_label = msg.label;
686 next = parent;
687 next_label = msg.parent_label;
688 strbuf_addstr(&msgbuf, "Revert \"");
689 strbuf_addstr(&msgbuf, msg.subject);
690 strbuf_addstr(&msgbuf, "\"\n\nThis reverts commit ");
f2fd0760 691 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
043a4492
RR
692
693 if (commit->parents && commit->parents->next) {
694 strbuf_addstr(&msgbuf, ", reversing\nchanges made to ");
f2fd0760 695 strbuf_addstr(&msgbuf, oid_to_hex(&parent->object.oid));
043a4492
RR
696 }
697 strbuf_addstr(&msgbuf, ".\n");
698 } else {
699 const char *p;
700
701 base = parent;
702 base_label = msg.parent_label;
703 next = commit;
704 next_label = msg.label;
705
706 /*
707 * Append the commit log message to msgbuf; it starts
708 * after the tree, parent, author, committer
709 * information followed by "\n\n".
710 */
711 p = strstr(msg.message, "\n\n");
88ef402f
JS
712 if (p)
713 strbuf_addstr(&msgbuf, skip_blank_lines(p + 2));
043a4492
RR
714
715 if (opts->record_origin) {
bab4d109 716 if (!has_conforming_footer(&msgbuf, NULL, 0))
b971e04f 717 strbuf_addch(&msgbuf, '\n');
cd650a4e 718 strbuf_addstr(&msgbuf, cherry_picked_prefix);
f2fd0760 719 strbuf_addstr(&msgbuf, oid_to_hex(&commit->object.oid));
043a4492
RR
720 strbuf_addstr(&msgbuf, ")\n");
721 }
722 }
723
004fefa7 724 if (!opts->strategy || !strcmp(opts->strategy, "recursive") || command == TODO_REVERT) {
043a4492
RR
725 res = do_recursive_merge(base, next, base_label, next_label,
726 head, &msgbuf, opts);
f241ff0d
JS
727 if (res < 0)
728 return res;
75871495 729 res |= write_message(msgbuf.buf, msgbuf.len,
f56fffef 730 git_path_merge_msg(), 0);
043a4492
RR
731 } else {
732 struct commit_list *common = NULL;
733 struct commit_list *remotes = NULL;
734
75871495 735 res = write_message(msgbuf.buf, msgbuf.len,
f56fffef 736 git_path_merge_msg(), 0);
043a4492
RR
737
738 commit_list_insert(base, &common);
739 commit_list_insert(next, &remotes);
03a4e260
JS
740 res |= try_merge_command(opts->strategy,
741 opts->xopts_nr, (const char **)opts->xopts,
043a4492
RR
742 common, sha1_to_hex(head), remotes);
743 free_commit_list(common);
744 free_commit_list(remotes);
745 }
452202c7 746 strbuf_release(&msgbuf);
043a4492
RR
747
748 /*
749 * If the merge was clean or if it failed due to conflict, we write
750 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
751 * However, if the merge did not even start, then we don't want to
752 * write it at all.
753 */
004fefa7 754 if (command == TODO_PICK && !opts->no_commit && (res == 0 || res == 1) &&
dbfad033
JS
755 update_ref(NULL, "CHERRY_PICK_HEAD", commit->object.oid.hash, NULL,
756 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
757 res = -1;
004fefa7 758 if (command == TODO_REVERT && ((opts->no_commit && res == 0) || res == 1) &&
dbfad033
JS
759 update_ref(NULL, "REVERT_HEAD", commit->object.oid.hash, NULL,
760 REF_NODEREF, UPDATE_REFS_MSG_ON_ERR))
761 res = -1;
043a4492
RR
762
763 if (res) {
004fefa7 764 error(command == TODO_REVERT
043a4492
RR
765 ? _("could not revert %s... %s")
766 : _("could not apply %s... %s"),
39755964 767 short_commit_name(commit), msg.subject);
ed727b19 768 print_advice(res == 1, opts);
043a4492 769 rerere(opts->allow_rerere_auto);
c8d1351d 770 goto leave;
043a4492
RR
771 }
772
c8d1351d 773 allow = allow_empty(opts, commit);
706728a3
FC
774 if (allow < 0) {
775 res = allow;
776 goto leave;
777 }
c8d1351d 778 if (!opts->no_commit)
b5a67045 779 res = run_git_commit(opts->edit ? NULL : git_path_merge_msg(),
0009426d 780 opts, allow, opts->edit, 0, 0);
c8d1351d
FC
781
782leave:
d74a4e57 783 free_message(commit, &msg);
1e41229d 784 update_abort_safety_file();
043a4492
RR
785
786 return res;
787}
788
c3e8618c 789static int prepare_revs(struct replay_opts *opts)
043a4492 790{
a73e22e9
MZ
791 /*
792 * picking (but not reverting) ranges (but not individual revisions)
793 * should be done in reverse
794 */
795 if (opts->action == REPLAY_PICK && !opts->revs->no_walk)
043a4492
RR
796 opts->revs->reverse ^= 1;
797
798 if (prepare_revision_walk(opts->revs))
c3e8618c 799 return error(_("revision walk setup failed"));
043a4492
RR
800
801 if (!opts->revs->commits)
c3e8618c
JS
802 return error(_("empty commit set passed"));
803 return 0;
043a4492
RR
804}
805
0d9c6dc9 806static int read_and_refresh_cache(struct replay_opts *opts)
043a4492
RR
807{
808 static struct lock_file index_lock;
809 int index_fd = hold_locked_index(&index_lock, 0);
49fb937e
JS
810 if (read_index_preload(&the_index, NULL) < 0) {
811 rollback_lock_file(&index_lock);
0d9c6dc9 812 return error(_("git %s: failed to read the index"),
c28cbc5e 813 _(action_name(opts)));
49fb937e 814 }
043a4492 815 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED, NULL, NULL, NULL);
33c297aa 816 if (the_index.cache_changed && index_fd >= 0) {
49fb937e
JS
817 if (write_locked_index(&the_index, &index_lock, COMMIT_LOCK)) {
818 rollback_lock_file(&index_lock);
0d9c6dc9 819 return error(_("git %s: failed to refresh the index"),
c28cbc5e 820 _(action_name(opts)));
49fb937e 821 }
043a4492
RR
822 }
823 rollback_lock_file(&index_lock);
0d9c6dc9 824 return 0;
043a4492
RR
825}
826
004fefa7
JS
827struct todo_item {
828 enum todo_command command;
829 struct commit *commit;
c22f7dfb
JS
830 const char *arg;
831 int arg_len;
004fefa7
JS
832 size_t offset_in_buf;
833};
834
835struct todo_list {
836 struct strbuf buf;
837 struct todo_item *items;
838 int nr, alloc, current;
839};
840
841#define TODO_LIST_INIT { STRBUF_INIT }
842
843static void todo_list_release(struct todo_list *todo_list)
043a4492 844{
004fefa7
JS
845 strbuf_release(&todo_list->buf);
846 free(todo_list->items);
847 todo_list->items = NULL;
848 todo_list->nr = todo_list->alloc = 0;
849}
043a4492 850
004fefa7
JS
851static struct todo_item *append_new_todo(struct todo_list *todo_list)
852{
853 ALLOC_GROW(todo_list->items, todo_list->nr + 1, todo_list->alloc);
854 return todo_list->items + todo_list->nr++;
043a4492
RR
855}
856
004fefa7 857static int parse_insn_line(struct todo_item *item, const char *bol, char *eol)
043a4492
RR
858{
859 unsigned char commit_sha1[20];
043a4492 860 char *end_of_object_name;
004fefa7
JS
861 int i, saved, status, padding;
862
8f8550b3
JS
863 /* left-trim */
864 bol += strspn(bol, " \t");
865
004fefa7
JS
866 for (i = 0; i < ARRAY_SIZE(todo_command_strings); i++)
867 if (skip_prefix(bol, todo_command_strings[i], &bol)) {
868 item->command = i;
869 break;
870 }
871 if (i >= ARRAY_SIZE(todo_command_strings))
872 return -1;
043a4492
RR
873
874 /* Eat up extra spaces/ tabs before object name */
875 padding = strspn(bol, " \t");
876 if (!padding)
004fefa7 877 return -1;
043a4492
RR
878 bol += padding;
879
004fefa7 880 end_of_object_name = (char *) bol + strcspn(bol, " \t\n");
043a4492
RR
881 saved = *end_of_object_name;
882 *end_of_object_name = '\0';
883 status = get_sha1(bol, commit_sha1);
884 *end_of_object_name = saved;
885
c22f7dfb
JS
886 item->arg = end_of_object_name + strspn(end_of_object_name, " \t");
887 item->arg_len = (int)(eol - item->arg);
888
043a4492 889 if (status < 0)
004fefa7 890 return -1;
043a4492 891
004fefa7
JS
892 item->commit = lookup_commit_reference(commit_sha1);
893 return !item->commit;
043a4492
RR
894}
895
004fefa7 896static int parse_insn_buffer(char *buf, struct todo_list *todo_list)
043a4492 897{
004fefa7
JS
898 struct todo_item *item;
899 char *p = buf, *next_p;
900 int i, res = 0;
043a4492 901
004fefa7 902 for (i = 1; *p; i++, p = next_p) {
043a4492 903 char *eol = strchrnul(p, '\n');
004fefa7
JS
904
905 next_p = *eol ? eol + 1 /* skip LF */ : eol;
906
6307041d
JS
907 if (p != eol && eol[-1] == '\r')
908 eol--; /* strip Carriage Return */
909
004fefa7
JS
910 item = append_new_todo(todo_list);
911 item->offset_in_buf = p - todo_list->buf.buf;
912 if (parse_insn_line(item, p, eol)) {
93b3df6f 913 res = error(_("invalid line %d: %.*s"),
004fefa7
JS
914 i, (int)(eol - p), p);
915 item->command = -1;
916 }
043a4492 917 }
004fefa7 918 if (!todo_list->nr)
93b3df6f 919 return error(_("no commits parsed."));
004fefa7 920 return res;
043a4492
RR
921}
922
004fefa7 923static int read_populate_todo(struct todo_list *todo_list,
043a4492
RR
924 struct replay_opts *opts)
925{
c0246501 926 const char *todo_file = get_todo_path(opts);
043a4492
RR
927 int fd, res;
928
004fefa7 929 strbuf_reset(&todo_list->buf);
c0246501 930 fd = open(todo_file, O_RDONLY);
043a4492 931 if (fd < 0)
93b3df6f 932 return error_errno(_("could not open '%s'"), todo_file);
004fefa7 933 if (strbuf_read(&todo_list->buf, fd, 0) < 0) {
043a4492 934 close(fd);
93b3df6f 935 return error(_("could not read '%s'."), todo_file);
043a4492
RR
936 }
937 close(fd);
938
004fefa7 939 res = parse_insn_buffer(todo_list->buf.buf, todo_list);
2eeaf1b3 940 if (res)
93b3df6f 941 return error(_("unusable instruction sheet: '%s'"), todo_file);
2eeaf1b3
JS
942
943 if (!is_rebase_i(opts)) {
004fefa7
JS
944 enum todo_command valid =
945 opts->action == REPLAY_PICK ? TODO_PICK : TODO_REVERT;
946 int i;
947
948 for (i = 0; i < todo_list->nr; i++)
949 if (valid == todo_list->items[i].command)
950 continue;
951 else if (valid == TODO_PICK)
93b3df6f 952 return error(_("cannot cherry-pick during a revert."));
004fefa7 953 else
93b3df6f 954 return error(_("cannot revert during a cherry-pick."));
004fefa7
JS
955 }
956
0ae42a03 957 return 0;
043a4492
RR
958}
959
03a4e260
JS
960static int git_config_string_dup(char **dest,
961 const char *var, const char *value)
962{
963 if (!value)
964 return config_error_nonbool(var);
965 free(*dest);
966 *dest = xstrdup(value);
967 return 0;
968}
969
043a4492
RR
970static int populate_opts_cb(const char *key, const char *value, void *data)
971{
972 struct replay_opts *opts = data;
973 int error_flag = 1;
974
975 if (!value)
976 error_flag = 0;
977 else if (!strcmp(key, "options.no-commit"))
978 opts->no_commit = git_config_bool_or_int(key, value, &error_flag);
979 else if (!strcmp(key, "options.edit"))
980 opts->edit = git_config_bool_or_int(key, value, &error_flag);
981 else if (!strcmp(key, "options.signoff"))
982 opts->signoff = git_config_bool_or_int(key, value, &error_flag);
983 else if (!strcmp(key, "options.record-origin"))
984 opts->record_origin = git_config_bool_or_int(key, value, &error_flag);
985 else if (!strcmp(key, "options.allow-ff"))
986 opts->allow_ff = git_config_bool_or_int(key, value, &error_flag);
987 else if (!strcmp(key, "options.mainline"))
988 opts->mainline = git_config_int(key, value);
989 else if (!strcmp(key, "options.strategy"))
03a4e260 990 git_config_string_dup(&opts->strategy, key, value);
3253553e 991 else if (!strcmp(key, "options.gpg-sign"))
03a4e260 992 git_config_string_dup(&opts->gpg_sign, key, value);
043a4492
RR
993 else if (!strcmp(key, "options.strategy-option")) {
994 ALLOC_GROW(opts->xopts, opts->xopts_nr + 1, opts->xopts_alloc);
995 opts->xopts[opts->xopts_nr++] = xstrdup(value);
996 } else
93b3df6f 997 return error(_("invalid key: %s"), key);
043a4492
RR
998
999 if (!error_flag)
93b3df6f 1000 return error(_("invalid value for %s: %s"), key, value);
043a4492
RR
1001
1002 return 0;
1003}
1004
5adf9bdc 1005static int read_populate_opts(struct replay_opts *opts)
043a4492 1006{
a1c75762
JS
1007 if (is_rebase_i(opts)) {
1008 struct strbuf buf = STRBUF_INIT;
1009
1010 if (read_oneliner(&buf, rebase_path_gpg_sign_opt(), 1)) {
1011 if (!starts_with(buf.buf, "-S"))
1012 strbuf_reset(&buf);
1013 else {
1014 free(opts->gpg_sign);
1015 opts->gpg_sign = xstrdup(buf.buf + 2);
1016 }
1017 }
1018 strbuf_release(&buf);
1019
b5a67045 1020 return 0;
a1c75762 1021 }
b5a67045 1022
f932729c 1023 if (!file_exists(git_path_opts_file()))
0d00da7b
JS
1024 return 0;
1025 /*
1026 * The function git_parse_source(), called from git_config_from_file(),
1027 * may die() in case of a syntactically incorrect file. We do not care
1028 * about this case, though, because we wrote that file ourselves, so we
1029 * are pretty certain that it is syntactically correct.
1030 */
5adf9bdc 1031 if (git_config_from_file(populate_opts_cb, git_path_opts_file(), opts) < 0)
93b3df6f 1032 return error(_("malformed options sheet: '%s'"),
0d00da7b
JS
1033 git_path_opts_file());
1034 return 0;
043a4492
RR
1035}
1036
004fefa7 1037static int walk_revs_populate_todo(struct todo_list *todo_list,
043a4492
RR
1038 struct replay_opts *opts)
1039{
004fefa7
JS
1040 enum todo_command command = opts->action == REPLAY_PICK ?
1041 TODO_PICK : TODO_REVERT;
1042 const char *command_string = todo_command_strings[command];
043a4492 1043 struct commit *commit;
043a4492 1044
34b0528b
JS
1045 if (prepare_revs(opts))
1046 return -1;
043a4492 1047
004fefa7
JS
1048 while ((commit = get_revision(opts->revs))) {
1049 struct todo_item *item = append_new_todo(todo_list);
1050 const char *commit_buffer = get_commit_buffer(commit, NULL);
1051 const char *subject;
1052 int subject_len;
1053
1054 item->command = command;
1055 item->commit = commit;
c22f7dfb
JS
1056 item->arg = NULL;
1057 item->arg_len = 0;
004fefa7
JS
1058 item->offset_in_buf = todo_list->buf.len;
1059 subject_len = find_commit_subject(commit_buffer, &subject);
1060 strbuf_addf(&todo_list->buf, "%s %s %.*s\n", command_string,
1061 short_commit_name(commit), subject_len, subject);
1062 unuse_commit_buffer(commit, commit_buffer);
1063 }
34b0528b 1064 return 0;
043a4492
RR
1065}
1066
1067static int create_seq_dir(void)
1068{
f932729c 1069 if (file_exists(git_path_seq_dir())) {
043a4492
RR
1070 error(_("a cherry-pick or revert is already in progress"));
1071 advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
1072 return -1;
a70d8f80 1073 } else if (mkdir(git_path_seq_dir(), 0777) < 0)
93b3df6f 1074 return error_errno(_("could not create sequencer directory '%s'"),
f6e82b0d 1075 git_path_seq_dir());
043a4492
RR
1076 return 0;
1077}
1078
311fd397 1079static int save_head(const char *head)
043a4492 1080{
043a4492
RR
1081 static struct lock_file head_lock;
1082 struct strbuf buf = STRBUF_INIT;
1083 int fd;
1084
311fd397
JS
1085 fd = hold_lock_file_for_update(&head_lock, git_path_head_file(), 0);
1086 if (fd < 0) {
1087 rollback_lock_file(&head_lock);
93b3df6f 1088 return error_errno(_("could not lock HEAD"));
311fd397 1089 }
043a4492 1090 strbuf_addf(&buf, "%s\n", head);
311fd397
JS
1091 if (write_in_full(fd, buf.buf, buf.len) < 0) {
1092 rollback_lock_file(&head_lock);
93b3df6f 1093 return error_errno(_("could not write to '%s'"),
311fd397
JS
1094 git_path_head_file());
1095 }
1096 if (commit_lock_file(&head_lock) < 0) {
1097 rollback_lock_file(&head_lock);
93b3df6f 1098 return error(_("failed to finalize '%s'."), git_path_head_file());
311fd397
JS
1099 }
1100 return 0;
043a4492
RR
1101}
1102
1e41229d
SB
1103static int rollback_is_safe(void)
1104{
1105 struct strbuf sb = STRBUF_INIT;
1106 struct object_id expected_head, actual_head;
1107
1108 if (strbuf_read_file(&sb, git_path_abort_safety_file(), 0) >= 0) {
1109 strbuf_trim(&sb);
1110 if (get_oid_hex(sb.buf, &expected_head)) {
1111 strbuf_release(&sb);
1112 die(_("could not parse %s"), git_path_abort_safety_file());
1113 }
1114 strbuf_release(&sb);
1115 }
1116 else if (errno == ENOENT)
1117 oidclr(&expected_head);
1118 else
1119 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
1120
1121 if (get_oid("HEAD", &actual_head))
1122 oidclr(&actual_head);
1123
1124 return !oidcmp(&actual_head, &expected_head);
1125}
1126
043a4492
RR
1127static int reset_for_rollback(const unsigned char *sha1)
1128{
1129 const char *argv[4]; /* reset --merge <arg> + NULL */
1e41229d 1130
043a4492
RR
1131 argv[0] = "reset";
1132 argv[1] = "--merge";
1133 argv[2] = sha1_to_hex(sha1);
1134 argv[3] = NULL;
1135 return run_command_v_opt(argv, RUN_GIT_CMD);
1136}
1137
1138static int rollback_single_pick(void)
1139{
1140 unsigned char head_sha1[20];
1141
f932729c
JK
1142 if (!file_exists(git_path_cherry_pick_head()) &&
1143 !file_exists(git_path_revert_head()))
043a4492 1144 return error(_("no cherry-pick or revert in progress"));
7695d118 1145 if (read_ref_full("HEAD", 0, head_sha1, NULL))
043a4492
RR
1146 return error(_("cannot resolve HEAD"));
1147 if (is_null_sha1(head_sha1))
1148 return error(_("cannot abort from a branch yet to be born"));
1149 return reset_for_rollback(head_sha1);
1150}
1151
2863584f 1152int sequencer_rollback(struct replay_opts *opts)
043a4492 1153{
043a4492
RR
1154 FILE *f;
1155 unsigned char sha1[20];
1156 struct strbuf buf = STRBUF_INIT;
1157
f932729c 1158 f = fopen(git_path_head_file(), "r");
043a4492
RR
1159 if (!f && errno == ENOENT) {
1160 /*
1161 * There is no multiple-cherry-pick in progress.
1162 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
1163 * a single-cherry-pick in progress, abort that.
1164 */
1165 return rollback_single_pick();
1166 }
1167 if (!f)
f7ed1953 1168 return error_errno(_("cannot open '%s'"), git_path_head_file());
8f309aeb 1169 if (strbuf_getline_lf(&buf, f)) {
f7ed1953 1170 error(_("cannot read '%s': %s"), git_path_head_file(),
f932729c 1171 ferror(f) ? strerror(errno) : _("unexpected end of file"));
043a4492
RR
1172 fclose(f);
1173 goto fail;
1174 }
1175 fclose(f);
1176 if (get_sha1_hex(buf.buf, sha1) || buf.buf[40] != '\0') {
1177 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
f932729c 1178 git_path_head_file());
043a4492
RR
1179 goto fail;
1180 }
0f974e21
MG
1181 if (is_null_sha1(sha1)) {
1182 error(_("cannot abort from a branch yet to be born"));
1183 goto fail;
1184 }
1e41229d
SB
1185
1186 if (!rollback_is_safe()) {
1187 /* Do not error, just do not rollback */
1188 warning(_("You seem to have moved HEAD. "
1189 "Not rewinding, check your HEAD!"));
1190 } else
043a4492
RR
1191 if (reset_for_rollback(sha1))
1192 goto fail;
043a4492 1193 strbuf_release(&buf);
2863584f 1194 return sequencer_remove_state(opts);
043a4492
RR
1195fail:
1196 strbuf_release(&buf);
1197 return -1;
1198}
1199
004fefa7 1200static int save_todo(struct todo_list *todo_list, struct replay_opts *opts)
043a4492 1201{
043a4492 1202 static struct lock_file todo_lock;
004fefa7
JS
1203 const char *todo_path = get_todo_path(opts);
1204 int next = todo_list->current, offset, fd;
043a4492 1205
004fefa7 1206 fd = hold_lock_file_for_update(&todo_lock, todo_path, 0);
221675de 1207 if (fd < 0)
93b3df6f 1208 return error_errno(_("could not lock '%s'"), todo_path);
004fefa7
JS
1209 offset = next < todo_list->nr ?
1210 todo_list->items[next].offset_in_buf : todo_list->buf.len;
1211 if (write_in_full(fd, todo_list->buf.buf + offset,
1212 todo_list->buf.len - offset) < 0)
93b3df6f 1213 return error_errno(_("could not write to '%s'"), todo_path);
004fefa7 1214 if (commit_lock_file(&todo_lock) < 0)
93b3df6f 1215 return error(_("failed to finalize '%s'."), todo_path);
221675de 1216 return 0;
043a4492
RR
1217}
1218
88d5a271 1219static int save_opts(struct replay_opts *opts)
043a4492 1220{
f932729c 1221 const char *opts_file = git_path_opts_file();
88d5a271 1222 int res = 0;
043a4492
RR
1223
1224 if (opts->no_commit)
88d5a271 1225 res |= git_config_set_in_file_gently(opts_file, "options.no-commit", "true");
043a4492 1226 if (opts->edit)
88d5a271 1227 res |= git_config_set_in_file_gently(opts_file, "options.edit", "true");
043a4492 1228 if (opts->signoff)
88d5a271 1229 res |= git_config_set_in_file_gently(opts_file, "options.signoff", "true");
043a4492 1230 if (opts->record_origin)
88d5a271 1231 res |= git_config_set_in_file_gently(opts_file, "options.record-origin", "true");
043a4492 1232 if (opts->allow_ff)
88d5a271 1233 res |= git_config_set_in_file_gently(opts_file, "options.allow-ff", "true");
043a4492
RR
1234 if (opts->mainline) {
1235 struct strbuf buf = STRBUF_INIT;
1236 strbuf_addf(&buf, "%d", opts->mainline);
88d5a271 1237 res |= git_config_set_in_file_gently(opts_file, "options.mainline", buf.buf);
043a4492
RR
1238 strbuf_release(&buf);
1239 }
1240 if (opts->strategy)
88d5a271 1241 res |= git_config_set_in_file_gently(opts_file, "options.strategy", opts->strategy);
3253553e 1242 if (opts->gpg_sign)
88d5a271 1243 res |= git_config_set_in_file_gently(opts_file, "options.gpg-sign", opts->gpg_sign);
043a4492
RR
1244 if (opts->xopts) {
1245 int i;
1246 for (i = 0; i < opts->xopts_nr; i++)
88d5a271 1247 res |= git_config_set_multivar_in_file_gently(opts_file,
043a4492
RR
1248 "options.strategy-option",
1249 opts->xopts[i], "^$", 0);
1250 }
88d5a271 1251 return res;
043a4492
RR
1252}
1253
004fefa7 1254static int pick_commits(struct todo_list *todo_list, struct replay_opts *opts)
043a4492 1255{
043a4492
RR
1256 int res;
1257
1258 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
1259 if (opts->allow_ff)
1260 assert(!(opts->signoff || opts->no_commit ||
1261 opts->record_origin || opts->edit));
0d9c6dc9
JS
1262 if (read_and_refresh_cache(opts))
1263 return -1;
043a4492 1264
004fefa7
JS
1265 while (todo_list->current < todo_list->nr) {
1266 struct todo_item *item = todo_list->items + todo_list->current;
1267 if (save_todo(todo_list, opts))
221675de 1268 return -1;
004fefa7
JS
1269 res = do_pick_commit(item->command, item->commit, opts);
1270 todo_list->current++;
043a4492
RR
1271 if (res)
1272 return res;
1273 }
1274
1275 /*
1276 * Sequence of picks finished successfully; cleanup by
1277 * removing the .git/sequencer directory
1278 */
2863584f 1279 return sequencer_remove_state(opts);
043a4492
RR
1280}
1281
1282static int continue_single_pick(void)
1283{
1284 const char *argv[] = { "commit", NULL };
1285
f932729c
JK
1286 if (!file_exists(git_path_cherry_pick_head()) &&
1287 !file_exists(git_path_revert_head()))
043a4492
RR
1288 return error(_("no cherry-pick or revert in progress"));
1289 return run_command_v_opt(argv, RUN_GIT_CMD);
1290}
1291
2863584f 1292int sequencer_continue(struct replay_opts *opts)
043a4492 1293{
004fefa7
JS
1294 struct todo_list todo_list = TODO_LIST_INIT;
1295 int res;
043a4492 1296
2863584f
JS
1297 if (read_and_refresh_cache(opts))
1298 return -1;
1299
c0246501 1300 if (!file_exists(get_todo_path(opts)))
043a4492 1301 return continue_single_pick();
004fefa7 1302 if (read_populate_opts(opts))
0ae42a03 1303 return -1;
004fefa7
JS
1304 if ((res = read_populate_todo(&todo_list, opts)))
1305 goto release_todo_list;
043a4492
RR
1306
1307 /* Verify that the conflict has been resolved */
f932729c
JK
1308 if (file_exists(git_path_cherry_pick_head()) ||
1309 file_exists(git_path_revert_head())) {
004fefa7
JS
1310 res = continue_single_pick();
1311 if (res)
1312 goto release_todo_list;
043a4492 1313 }
65036021 1314 if (index_differs_from("HEAD", 0, 0)) {
004fefa7
JS
1315 res = error_dirty_index(opts);
1316 goto release_todo_list;
1317 }
1318 todo_list.current++;
1319 res = pick_commits(&todo_list, opts);
1320release_todo_list:
1321 todo_list_release(&todo_list);
1322 return res;
043a4492
RR
1323}
1324
1325static int single_pick(struct commit *cmit, struct replay_opts *opts)
1326{
1327 setenv(GIT_REFLOG_ACTION, action_name(opts), 0);
004fefa7
JS
1328 return do_pick_commit(opts->action == REPLAY_PICK ?
1329 TODO_PICK : TODO_REVERT, cmit, opts);
043a4492
RR
1330}
1331
1332int sequencer_pick_revisions(struct replay_opts *opts)
1333{
004fefa7 1334 struct todo_list todo_list = TODO_LIST_INIT;
043a4492 1335 unsigned char sha1[20];
004fefa7 1336 int i, res;
043a4492 1337
2863584f 1338 assert(opts->revs);
0d9c6dc9
JS
1339 if (read_and_refresh_cache(opts))
1340 return -1;
043a4492 1341
21246dbb
MV
1342 for (i = 0; i < opts->revs->pending.nr; i++) {
1343 unsigned char sha1[20];
1344 const char *name = opts->revs->pending.objects[i].name;
1345
1346 /* This happens when using --stdin. */
1347 if (!strlen(name))
1348 continue;
1349
1350 if (!get_sha1(name, sha1)) {
7c0b0d8d
JH
1351 if (!lookup_commit_reference_gently(sha1, 1)) {
1352 enum object_type type = sha1_object_info(sha1, NULL);
b9b946d4
JS
1353 return error(_("%s: can't cherry-pick a %s"),
1354 name, typename(type));
7c0b0d8d 1355 }
21246dbb 1356 } else
b9b946d4 1357 return error(_("%s: bad revision"), name);
21246dbb
MV
1358 }
1359
043a4492
RR
1360 /*
1361 * If we were called as "git cherry-pick <commit>", just
1362 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
1363 * REVERT_HEAD, and don't touch the sequencer state.
1364 * This means it is possible to cherry-pick in the middle
1365 * of a cherry-pick sequence.
1366 */
1367 if (opts->revs->cmdline.nr == 1 &&
1368 opts->revs->cmdline.rev->whence == REV_CMD_REV &&
1369 opts->revs->no_walk &&
1370 !opts->revs->cmdline.rev->flags) {
1371 struct commit *cmit;
1372 if (prepare_revision_walk(opts->revs))
b9b946d4 1373 return error(_("revision walk setup failed"));
043a4492
RR
1374 cmit = get_revision(opts->revs);
1375 if (!cmit || get_revision(opts->revs))
b9b946d4 1376 return error("BUG: expected exactly one commit from walk");
043a4492
RR
1377 return single_pick(cmit, opts);
1378 }
1379
1380 /*
1381 * Start a new cherry-pick/ revert sequence; but
1382 * first, make sure that an existing one isn't in
1383 * progress
1384 */
1385
34b0528b
JS
1386 if (walk_revs_populate_todo(&todo_list, opts) ||
1387 create_seq_dir() < 0)
043a4492 1388 return -1;
0f974e21 1389 if (get_sha1("HEAD", sha1) && (opts->action == REPLAY_REVERT))
93b3df6f 1390 return error(_("can't revert as initial commit"));
311fd397
JS
1391 if (save_head(sha1_to_hex(sha1)))
1392 return -1;
88d5a271
JS
1393 if (save_opts(opts))
1394 return -1;
1e41229d 1395 update_abort_safety_file();
004fefa7
JS
1396 res = pick_commits(&todo_list, opts);
1397 todo_list_release(&todo_list);
1398 return res;
043a4492 1399}
5ed75e2a 1400
bab4d109 1401void append_signoff(struct strbuf *msgbuf, int ignore_footer, unsigned flag)
5ed75e2a 1402{
bab4d109 1403 unsigned no_dup_sob = flag & APPEND_SIGNOFF_DEDUP;
5ed75e2a 1404 struct strbuf sob = STRBUF_INIT;
bab4d109 1405 int has_footer;
5ed75e2a
MV
1406
1407 strbuf_addstr(&sob, sign_off_header);
1408 strbuf_addstr(&sob, fmt_name(getenv("GIT_COMMITTER_NAME"),
1409 getenv("GIT_COMMITTER_EMAIL")));
1410 strbuf_addch(&sob, '\n');
bab4d109
BC
1411
1412 /*
1413 * If the whole message buffer is equal to the sob, pretend that we
1414 * found a conforming footer with a matching sob
1415 */
1416 if (msgbuf->len - ignore_footer == sob.len &&
1417 !strncmp(msgbuf->buf, sob.buf, sob.len))
1418 has_footer = 3;
1419 else
1420 has_footer = has_conforming_footer(msgbuf, &sob, ignore_footer);
1421
33f2f9ab
BC
1422 if (!has_footer) {
1423 const char *append_newlines = NULL;
1424 size_t len = msgbuf->len - ignore_footer;
1425
8c613fd5
BC
1426 if (!len) {
1427 /*
1428 * The buffer is completely empty. Leave foom for
1429 * the title and body to be filled in by the user.
1430 */
33f2f9ab 1431 append_newlines = "\n\n";
8c613fd5
BC
1432 } else if (msgbuf->buf[len - 1] != '\n') {
1433 /*
1434 * Incomplete line. Complete the line and add a
1435 * blank one so that there is an empty line between
1436 * the message body and the sob.
1437 */
1438 append_newlines = "\n\n";
1439 } else if (len == 1) {
1440 /*
1441 * Buffer contains a single newline. Add another
1442 * so that we leave room for the title and body.
1443 */
1444 append_newlines = "\n";
1445 } else if (msgbuf->buf[len - 2] != '\n') {
1446 /*
1447 * Buffer ends with a single newline. Add another
1448 * so that there is an empty line between the message
1449 * body and the sob.
1450 */
33f2f9ab 1451 append_newlines = "\n";
8c613fd5 1452 } /* else, the buffer already ends with two newlines. */
33f2f9ab
BC
1453
1454 if (append_newlines)
1455 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
1456 append_newlines, strlen(append_newlines));
5ed75e2a 1457 }
bab4d109
BC
1458
1459 if (has_footer != 3 && (!no_dup_sob || has_footer != 2))
1460 strbuf_splice(msgbuf, msgbuf->len - ignore_footer, 0,
1461 sob.buf, sob.len);
1462
5ed75e2a
MV
1463 strbuf_release(&sob);
1464}