8 #include "run-command.h"
11 #include "cache-tree.h"
15 #include "merge-recursive.h"
17 #include "argv-array.h"
21 #define GIT_REFLOG_ACTION "GIT_REFLOG_ACTION"
23 const char sign_off_header
[] = "Signed-off-by: ";
24 static const char cherry_picked_prefix
[] = "(cherry picked from commit ";
26 GIT_PATH_FUNC(git_path_seq_dir
, "sequencer")
28 static GIT_PATH_FUNC(git_path_todo_file
, "sequencer/todo")
29 static GIT_PATH_FUNC(git_path_opts_file
, "sequencer/opts")
30 static GIT_PATH_FUNC(git_path_head_file
, "sequencer/head")
31 static GIT_PATH_FUNC(git_path_abort_safety_file
, "sequencer/abort-safety")
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
38 static GIT_PATH_FUNC(rebase_path_author_script
, "rebase-merge/author-script")
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).
43 static GIT_PATH_FUNC(rebase_path_gpg_sign_opt
, "rebase-merge/gpg_sign_opt")
45 /* We will introduce the 'interactive rebase' mode later */
46 static inline int is_rebase_i(const struct replay_opts
*opts
)
51 static const char *get_dir(const struct replay_opts
*opts
)
53 return git_path_seq_dir();
56 static const char *get_todo_path(const struct replay_opts
*opts
)
58 return git_path_todo_file();
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
67 static int has_conforming_footer(struct strbuf
*sb
, struct strbuf
*sob
,
70 struct trailer_info info
;
72 int found_sob
= 0, found_sob_last
= 0;
74 trailer_info_get(&info
, sb
->buf
);
76 if (info
.trailer_start
== info
.trailer_end
)
79 for (i
= 0; i
< info
.trailer_nr
; i
++)
80 if (sob
&& !strncmp(info
.trailers
[i
], sob
->buf
, sob
->len
)) {
82 if (i
== info
.trailer_nr
- 1)
86 trailer_info_release(&info
);
95 static const char *gpg_sign_opt_quoted(struct replay_opts
*opts
)
97 static struct strbuf buf
= STRBUF_INIT
;
101 sq_quotef(&buf
, "-S%s", opts
->gpg_sign
);
105 int sequencer_remove_state(struct replay_opts
*opts
)
107 struct strbuf dir
= STRBUF_INIT
;
110 free(opts
->gpg_sign
);
111 free(opts
->strategy
);
112 for (i
= 0; i
< opts
->xopts_nr
; i
++)
113 free(opts
->xopts
[i
]);
116 strbuf_addf(&dir
, "%s", get_dir(opts
));
117 remove_dir_recursively(&dir
, 0);
118 strbuf_release(&dir
);
123 static const char *action_name(const struct replay_opts
*opts
)
125 return opts
->action
== REPLAY_REVERT
? N_("revert") : N_("cherry-pick");
128 struct commit_message
{
135 static const char *short_commit_name(struct commit
*commit
)
137 return find_unique_abbrev(commit
->object
.oid
.hash
, DEFAULT_ABBREV
);
140 static int get_message(struct commit
*commit
, struct commit_message
*out
)
142 const char *abbrev
, *subject
;
145 out
->message
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
146 abbrev
= short_commit_name(commit
);
148 subject_len
= find_commit_subject(out
->message
, &subject
);
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
);
157 static void free_message(struct commit
*commit
, struct commit_message
*msg
)
159 free(msg
->parent_label
);
162 unuse_commit_buffer(commit
, msg
->message
);
165 static void print_advice(int show_hint
, struct replay_opts
*opts
)
167 char *msg
= getenv("GIT_CHERRY_PICK_HELP");
170 fprintf(stderr
, "%s\n", msg
);
172 * A conflict has occurred but the porcelain
173 * (typically rebase --interactive) wants to take care
174 * of the commit itself so remove CHERRY_PICK_HEAD
176 unlink(git_path_cherry_pick_head());
182 advise(_("after resolving the conflicts, mark the corrected paths\n"
183 "with 'git add <paths>' or 'git rm <paths>'"));
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'"));
191 static int write_message(const void *buf
, size_t len
, const char *filename
,
194 static struct lock_file msg_file
;
196 int msg_fd
= hold_lock_file_for_update(&msg_file
, filename
, 0);
198 return error_errno(_("could not lock '%s'"), filename
);
199 if (write_in_full(msg_fd
, buf
, len
) < 0) {
200 rollback_lock_file(&msg_file
);
201 return error_errno(_("could not write to '%s'"), filename
);
203 if (append_eol
&& write(msg_fd
, "\n", 1) < 0) {
204 rollback_lock_file(&msg_file
);
205 return error_errno(_("could not write eol to '%s'"), filename
);
207 if (commit_lock_file(&msg_file
) < 0) {
208 rollback_lock_file(&msg_file
);
209 return error(_("failed to finalize '%s'."), filename
);
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.
219 * Note that only the last end-of-line marker is stripped, consistent with the
220 * behavior of "$(cat path)" in a shell script.
222 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
224 static int read_oneliner(struct strbuf
*buf
,
225 const char *path
, int skip_if_empty
)
227 int orig_len
= buf
->len
;
229 if (!file_exists(path
))
232 if (strbuf_read_file(buf
, path
, 0) < 0) {
233 warning_errno(_("could not read '%s'"), path
);
237 if (buf
->len
> orig_len
&& buf
->buf
[buf
->len
- 1] == '\n') {
238 if (--buf
->len
> orig_len
&& buf
->buf
[buf
->len
- 1] == '\r')
240 buf
->buf
[buf
->len
] = '\0';
243 if (skip_if_empty
&& buf
->len
== orig_len
)
249 static struct tree
*empty_tree(void)
251 return lookup_tree(EMPTY_TREE_SHA1_BIN
);
254 static int error_dirty_index(struct replay_opts
*opts
)
256 if (read_cache_unmerged())
257 return error_resolve_conflict(_(action_name(opts
)));
259 error(_("your local changes would be overwritten by %s."),
260 _(action_name(opts
)));
262 if (advice_commit_before_merge
)
263 advise(_("commit your changes or stash them to proceed."));
267 static void update_abort_safety_file(void)
269 struct object_id head
;
271 /* Do nothing on a single-pick */
272 if (!file_exists(git_path_seq_dir()))
275 if (!get_oid("HEAD", &head
))
276 write_file(git_path_abort_safety_file(), "%s", oid_to_hex(&head
));
278 write_file(git_path_abort_safety_file(), "%s", "");
281 static int fast_forward_to(const unsigned char *to
, const unsigned char *from
,
282 int unborn
, struct replay_opts
*opts
)
284 struct ref_transaction
*transaction
;
285 struct strbuf sb
= STRBUF_INIT
;
286 struct strbuf err
= STRBUF_INIT
;
289 if (checkout_fast_forward(from
, to
, 1))
290 return -1; /* the callee should have complained already */
292 strbuf_addf(&sb
, _("%s: fast-forward"), _(action_name(opts
)));
294 transaction
= ref_transaction_begin(&err
);
296 ref_transaction_update(transaction
, "HEAD",
297 to
, unborn
? null_sha1
: from
,
299 ref_transaction_commit(transaction
, &err
)) {
300 ref_transaction_free(transaction
);
301 error("%s", err
.buf
);
303 strbuf_release(&err
);
308 strbuf_release(&err
);
309 ref_transaction_free(transaction
);
310 update_abort_safety_file();
314 void append_conflicts_hint(struct strbuf
*msgbuf
)
318 strbuf_addch(msgbuf
, '\n');
319 strbuf_commented_addf(msgbuf
, "Conflicts:\n");
320 for (i
= 0; i
< active_nr
;) {
321 const struct cache_entry
*ce
= active_cache
[i
++];
323 strbuf_commented_addf(msgbuf
, "\t%s\n", ce
->name
);
324 while (i
< active_nr
&& !strcmp(ce
->name
,
325 active_cache
[i
]->name
))
331 static 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
)
336 struct merge_options o
;
337 struct tree
*result
, *next_tree
, *base_tree
, *head_tree
;
340 static struct lock_file index_lock
;
342 hold_locked_index(&index_lock
, LOCK_DIE_ON_ERROR
);
346 init_merge_options(&o
);
347 o
.ancestor
= base
? base_label
: "(empty tree)";
349 o
.branch2
= next
? next_label
: "(empty tree)";
351 head_tree
= parse_tree_indirect(head
);
352 next_tree
= next
? next
->tree
: empty_tree();
353 base_tree
= base
? base
->tree
: empty_tree();
355 for (xopt
= opts
->xopts
; xopt
!= opts
->xopts
+ opts
->xopts_nr
; xopt
++)
356 parse_merge_opt(&o
, *xopt
);
358 clean
= merge_trees(&o
,
360 next_tree
, base_tree
, &result
);
361 strbuf_release(&o
.obuf
);
365 if (active_cache_changed
&&
366 write_locked_index(&the_index
, &index_lock
, COMMIT_LOCK
))
367 /* TRANSLATORS: %s will be "revert" or "cherry-pick" */
368 return error(_("%s: Unable to write new index file"),
369 _(action_name(opts
)));
370 rollback_lock_file(&index_lock
);
373 append_signoff(msgbuf
, 0, 0);
376 append_conflicts_hint(msgbuf
);
381 static int is_index_unchanged(void)
383 unsigned char head_sha1
[20];
384 struct commit
*head_commit
;
386 if (!resolve_ref_unsafe("HEAD", RESOLVE_REF_READING
, head_sha1
, NULL
))
387 return error(_("could not resolve HEAD commit\n"));
389 head_commit
= lookup_commit(head_sha1
);
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.
399 if (parse_commit(head_commit
))
402 if (!active_cache_tree
)
403 active_cache_tree
= cache_tree();
405 if (!cache_tree_fully_valid(active_cache_tree
))
406 if (cache_tree_update(&the_index
, 0))
407 return error(_("unable to update cache tree\n"));
409 return !hashcmp(active_cache_tree
->sha1
, head_commit
->tree
->object
.oid
.hash
);
413 * Read the author-script file into an environment block, ready for use in
414 * run_command(), that can be free()d afterwards.
416 static char **read_author_script(void)
418 struct strbuf script
= STRBUF_INIT
;
423 if (strbuf_read_file(&script
, rebase_path_author_script(), 256) <= 0)
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);
430 strbuf_splice(&script
, p
-- - script
.buf
, 1, "", 0);
431 else if (*p
== '\n') {
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
);
442 for (i
= 0; i
< count
; i
++) {
451 static const char staged_changes_advice
[] =
452 N_("you have staged changes in your working tree\n"
453 "If these changes are meant to be squashed into the previous commit, run:\n"
455 " git commit --amend %s\n"
457 "If they are meant to go into a new commit, run:\n"
461 "In both cases, once you're done, continue with:\n"
463 " git rebase --continue\n");
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.
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.
473 * An exception is when run_git_commit() is called during an
474 * interactive rebase: in that case, we will want to retain the
477 static int run_git_commit(const char *defmsg
, struct replay_opts
*opts
,
478 int allow_empty
, int edit
, int amend
,
479 int cleanup_commit_message
)
482 struct argv_array array
;
486 if (is_rebase_i(opts
)) {
487 env
= read_author_script();
489 const char *gpg_opt
= gpg_sign_opt_quoted(opts
);
491 return error(_(staged_changes_advice
),
496 argv_array_init(&array
);
497 argv_array_push(&array
, "commit");
498 argv_array_push(&array
, "-n");
501 argv_array_push(&array
, "--amend");
503 argv_array_pushf(&array
, "-S%s", opts
->gpg_sign
);
505 argv_array_push(&array
, "-s");
507 argv_array_pushl(&array
, "-F", defmsg
, NULL
);
508 if (cleanup_commit_message
)
509 argv_array_push(&array
, "--cleanup=strip");
511 argv_array_push(&array
, "-e");
512 else if (!cleanup_commit_message
&&
513 !opts
->signoff
&& !opts
->record_origin
&&
514 git_config_get_value("commit.cleanup", &value
))
515 argv_array_push(&array
, "--cleanup=verbatim");
518 argv_array_push(&array
, "--allow-empty");
520 if (opts
->allow_empty_message
)
521 argv_array_push(&array
, "--allow-empty-message");
523 rc
= run_command_v_opt_cd_env(array
.argv
, RUN_GIT_CMD
, NULL
,
524 (const char *const *)env
);
525 argv_array_clear(&array
);
531 static int is_original_commit_empty(struct commit
*commit
)
533 const unsigned char *ptree_sha1
;
535 if (parse_commit(commit
))
536 return error(_("could not parse commit %s\n"),
537 oid_to_hex(&commit
->object
.oid
));
538 if (commit
->parents
) {
539 struct commit
*parent
= commit
->parents
->item
;
540 if (parse_commit(parent
))
541 return error(_("could not parse parent commit %s\n"),
542 oid_to_hex(&parent
->object
.oid
));
543 ptree_sha1
= parent
->tree
->object
.oid
.hash
;
545 ptree_sha1
= EMPTY_TREE_SHA1_BIN
; /* commit is root */
548 return !hashcmp(ptree_sha1
, commit
->tree
->object
.oid
.hash
);
552 * Do we run "git commit" with "--allow-empty"?
554 static int allow_empty(struct replay_opts
*opts
, struct commit
*commit
)
556 int index_unchanged
, empty_commit
;
561 * (1) we do not allow empty at all and error out.
563 * (2) we allow ones that were initially empty, but
564 * forbid the ones that become empty;
568 if (!opts
->allow_empty
)
569 return 0; /* let "git commit" barf as necessary */
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 */
577 if (opts
->keep_redundant_commits
)
580 empty_commit
= is_original_commit_empty(commit
);
581 if (empty_commit
< 0)
594 static const char *todo_command_strings
[] = {
599 static const char *command_to_string(const enum todo_command command
)
601 if ((size_t)command
< ARRAY_SIZE(todo_command_strings
))
602 return todo_command_strings
[command
];
603 die("Unknown command: %d", command
);
607 static int do_pick_commit(enum todo_command command
, struct commit
*commit
,
608 struct replay_opts
*opts
)
610 unsigned char head
[20];
611 struct commit
*base
, *next
, *parent
;
612 const char *base_label
, *next_label
;
613 struct commit_message msg
= { NULL
, NULL
, NULL
, NULL
};
614 struct strbuf msgbuf
= STRBUF_INIT
;
615 int res
, unborn
= 0, allow
;
617 if (opts
->no_commit
) {
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
624 if (write_cache_as_tree(head
, 0, NULL
))
625 return error(_("your index file is unmerged."));
627 unborn
= get_sha1("HEAD", head
);
629 hashcpy(head
, EMPTY_TREE_SHA1_BIN
);
630 if (index_differs_from(unborn
? EMPTY_TREE_SHA1_HEX
: "HEAD", 0, 0))
631 return error_dirty_index(opts
);
635 if (!commit
->parents
)
637 else if (commit
->parents
->next
) {
638 /* Reverting or cherry-picking a merge commit */
640 struct commit_list
*p
;
643 return error(_("commit %s is a merge but no -m option was given."),
644 oid_to_hex(&commit
->object
.oid
));
646 for (cnt
= 1, p
= commit
->parents
;
647 cnt
!= opts
->mainline
&& p
;
650 if (cnt
!= opts
->mainline
|| !p
)
651 return error(_("commit %s does not have parent %d"),
652 oid_to_hex(&commit
->object
.oid
), opts
->mainline
);
654 } else if (0 < opts
->mainline
)
655 return error(_("mainline was specified but commit %s is not a merge."),
656 oid_to_hex(&commit
->object
.oid
));
658 parent
= commit
->parents
->item
;
660 if (opts
->allow_ff
&&
661 ((parent
&& !hashcmp(parent
->object
.oid
.hash
, head
)) ||
662 (!parent
&& unborn
)))
663 return fast_forward_to(commit
->object
.oid
.hash
, head
, unborn
, opts
);
665 if (parent
&& parse_commit(parent
) < 0)
666 /* TRANSLATORS: The first %s will be a "todo" command like
667 "revert" or "pick", the second %s a SHA1. */
668 return error(_("%s: cannot parse parent commit %s"),
669 command_to_string(command
),
670 oid_to_hex(&parent
->object
.oid
));
672 if (get_message(commit
, &msg
) != 0)
673 return error(_("cannot get commit message for %s"),
674 oid_to_hex(&commit
->object
.oid
));
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.
683 if (command
== TODO_REVERT
) {
685 base_label
= msg
.label
;
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 ");
691 strbuf_addstr(&msgbuf
, oid_to_hex(&commit
->object
.oid
));
693 if (commit
->parents
&& commit
->parents
->next
) {
694 strbuf_addstr(&msgbuf
, ", reversing\nchanges made to ");
695 strbuf_addstr(&msgbuf
, oid_to_hex(&parent
->object
.oid
));
697 strbuf_addstr(&msgbuf
, ".\n");
702 base_label
= msg
.parent_label
;
704 next_label
= msg
.label
;
706 /* Append the commit log message to msgbuf. */
707 if (find_commit_subject(msg
.message
, &p
))
708 strbuf_addstr(&msgbuf
, p
);
710 if (opts
->record_origin
) {
711 if (!has_conforming_footer(&msgbuf
, NULL
, 0))
712 strbuf_addch(&msgbuf
, '\n');
713 strbuf_addstr(&msgbuf
, cherry_picked_prefix
);
714 strbuf_addstr(&msgbuf
, oid_to_hex(&commit
->object
.oid
));
715 strbuf_addstr(&msgbuf
, ")\n");
719 if (!opts
->strategy
|| !strcmp(opts
->strategy
, "recursive") || command
== TODO_REVERT
) {
720 res
= do_recursive_merge(base
, next
, base_label
, next_label
,
721 head
, &msgbuf
, opts
);
724 res
|= write_message(msgbuf
.buf
, msgbuf
.len
,
725 git_path_merge_msg(), 0);
727 struct commit_list
*common
= NULL
;
728 struct commit_list
*remotes
= NULL
;
730 res
= write_message(msgbuf
.buf
, msgbuf
.len
,
731 git_path_merge_msg(), 0);
733 commit_list_insert(base
, &common
);
734 commit_list_insert(next
, &remotes
);
735 res
|= try_merge_command(opts
->strategy
,
736 opts
->xopts_nr
, (const char **)opts
->xopts
,
737 common
, sha1_to_hex(head
), remotes
);
738 free_commit_list(common
);
739 free_commit_list(remotes
);
741 strbuf_release(&msgbuf
);
744 * If the merge was clean or if it failed due to conflict, we write
745 * CHERRY_PICK_HEAD for the subsequent invocation of commit to use.
746 * However, if the merge did not even start, then we don't want to
749 if (command
== TODO_PICK
&& !opts
->no_commit
&& (res
== 0 || res
== 1) &&
750 update_ref(NULL
, "CHERRY_PICK_HEAD", commit
->object
.oid
.hash
, NULL
,
751 REF_NODEREF
, UPDATE_REFS_MSG_ON_ERR
))
753 if (command
== TODO_REVERT
&& ((opts
->no_commit
&& res
== 0) || res
== 1) &&
754 update_ref(NULL
, "REVERT_HEAD", commit
->object
.oid
.hash
, NULL
,
755 REF_NODEREF
, UPDATE_REFS_MSG_ON_ERR
))
759 error(command
== TODO_REVERT
760 ? _("could not revert %s... %s")
761 : _("could not apply %s... %s"),
762 short_commit_name(commit
), msg
.subject
);
763 print_advice(res
== 1, opts
);
764 rerere(opts
->allow_rerere_auto
);
768 allow
= allow_empty(opts
, commit
);
773 if (!opts
->no_commit
)
774 res
= run_git_commit(opts
->edit
? NULL
: git_path_merge_msg(),
775 opts
, allow
, opts
->edit
, 0, 0);
778 free_message(commit
, &msg
);
779 update_abort_safety_file();
784 static int prepare_revs(struct replay_opts
*opts
)
787 * picking (but not reverting) ranges (but not individual revisions)
788 * should be done in reverse
790 if (opts
->action
== REPLAY_PICK
&& !opts
->revs
->no_walk
)
791 opts
->revs
->reverse
^= 1;
793 if (prepare_revision_walk(opts
->revs
))
794 return error(_("revision walk setup failed"));
796 if (!opts
->revs
->commits
)
797 return error(_("empty commit set passed"));
801 static int read_and_refresh_cache(struct replay_opts
*opts
)
803 static struct lock_file index_lock
;
804 int index_fd
= hold_locked_index(&index_lock
, 0);
805 if (read_index_preload(&the_index
, NULL
) < 0) {
806 rollback_lock_file(&index_lock
);
807 return error(_("git %s: failed to read the index"),
808 _(action_name(opts
)));
810 refresh_index(&the_index
, REFRESH_QUIET
|REFRESH_UNMERGED
, NULL
, NULL
, NULL
);
811 if (the_index
.cache_changed
&& index_fd
>= 0) {
812 if (write_locked_index(&the_index
, &index_lock
, COMMIT_LOCK
)) {
813 rollback_lock_file(&index_lock
);
814 return error(_("git %s: failed to refresh the index"),
815 _(action_name(opts
)));
818 rollback_lock_file(&index_lock
);
823 enum todo_command command
;
824 struct commit
*commit
;
827 size_t offset_in_buf
;
832 struct todo_item
*items
;
833 int nr
, alloc
, current
;
836 #define TODO_LIST_INIT { STRBUF_INIT }
838 static void todo_list_release(struct todo_list
*todo_list
)
840 strbuf_release(&todo_list
->buf
);
841 free(todo_list
->items
);
842 todo_list
->items
= NULL
;
843 todo_list
->nr
= todo_list
->alloc
= 0;
846 static struct todo_item
*append_new_todo(struct todo_list
*todo_list
)
848 ALLOC_GROW(todo_list
->items
, todo_list
->nr
+ 1, todo_list
->alloc
);
849 return todo_list
->items
+ todo_list
->nr
++;
852 static int parse_insn_line(struct todo_item
*item
, const char *bol
, char *eol
)
854 unsigned char commit_sha1
[20];
855 char *end_of_object_name
;
856 int i
, saved
, status
, padding
;
859 bol
+= strspn(bol
, " \t");
861 for (i
= 0; i
< ARRAY_SIZE(todo_command_strings
); i
++)
862 if (skip_prefix(bol
, todo_command_strings
[i
], &bol
)) {
866 if (i
>= ARRAY_SIZE(todo_command_strings
))
869 /* Eat up extra spaces/ tabs before object name */
870 padding
= strspn(bol
, " \t");
875 end_of_object_name
= (char *) bol
+ strcspn(bol
, " \t\n");
876 saved
= *end_of_object_name
;
877 *end_of_object_name
= '\0';
878 status
= get_sha1(bol
, commit_sha1
);
879 *end_of_object_name
= saved
;
881 item
->arg
= end_of_object_name
+ strspn(end_of_object_name
, " \t");
882 item
->arg_len
= (int)(eol
- item
->arg
);
887 item
->commit
= lookup_commit_reference(commit_sha1
);
888 return !item
->commit
;
891 static int parse_insn_buffer(char *buf
, struct todo_list
*todo_list
)
893 struct todo_item
*item
;
894 char *p
= buf
, *next_p
;
897 for (i
= 1; *p
; i
++, p
= next_p
) {
898 char *eol
= strchrnul(p
, '\n');
900 next_p
= *eol
? eol
+ 1 /* skip LF */ : eol
;
902 if (p
!= eol
&& eol
[-1] == '\r')
903 eol
--; /* strip Carriage Return */
905 item
= append_new_todo(todo_list
);
906 item
->offset_in_buf
= p
- todo_list
->buf
.buf
;
907 if (parse_insn_line(item
, p
, eol
)) {
908 res
= error(_("invalid line %d: %.*s"),
909 i
, (int)(eol
- p
), p
);
914 return error(_("no commits parsed."));
918 static int read_populate_todo(struct todo_list
*todo_list
,
919 struct replay_opts
*opts
)
921 const char *todo_file
= get_todo_path(opts
);
924 strbuf_reset(&todo_list
->buf
);
925 fd
= open(todo_file
, O_RDONLY
);
927 return error_errno(_("could not open '%s'"), todo_file
);
928 if (strbuf_read(&todo_list
->buf
, fd
, 0) < 0) {
930 return error(_("could not read '%s'."), todo_file
);
934 res
= parse_insn_buffer(todo_list
->buf
.buf
, todo_list
);
936 return error(_("unusable instruction sheet: '%s'"), todo_file
);
938 if (!is_rebase_i(opts
)) {
939 enum todo_command valid
=
940 opts
->action
== REPLAY_PICK
? TODO_PICK
: TODO_REVERT
;
943 for (i
= 0; i
< todo_list
->nr
; i
++)
944 if (valid
== todo_list
->items
[i
].command
)
946 else if (valid
== TODO_PICK
)
947 return error(_("cannot cherry-pick during a revert."));
949 return error(_("cannot revert during a cherry-pick."));
955 static int git_config_string_dup(char **dest
,
956 const char *var
, const char *value
)
959 return config_error_nonbool(var
);
961 *dest
= xstrdup(value
);
965 static int populate_opts_cb(const char *key
, const char *value
, void *data
)
967 struct replay_opts
*opts
= data
;
972 else if (!strcmp(key
, "options.no-commit"))
973 opts
->no_commit
= git_config_bool_or_int(key
, value
, &error_flag
);
974 else if (!strcmp(key
, "options.edit"))
975 opts
->edit
= git_config_bool_or_int(key
, value
, &error_flag
);
976 else if (!strcmp(key
, "options.signoff"))
977 opts
->signoff
= git_config_bool_or_int(key
, value
, &error_flag
);
978 else if (!strcmp(key
, "options.record-origin"))
979 opts
->record_origin
= git_config_bool_or_int(key
, value
, &error_flag
);
980 else if (!strcmp(key
, "options.allow-ff"))
981 opts
->allow_ff
= git_config_bool_or_int(key
, value
, &error_flag
);
982 else if (!strcmp(key
, "options.mainline"))
983 opts
->mainline
= git_config_int(key
, value
);
984 else if (!strcmp(key
, "options.strategy"))
985 git_config_string_dup(&opts
->strategy
, key
, value
);
986 else if (!strcmp(key
, "options.gpg-sign"))
987 git_config_string_dup(&opts
->gpg_sign
, key
, value
);
988 else if (!strcmp(key
, "options.strategy-option")) {
989 ALLOC_GROW(opts
->xopts
, opts
->xopts_nr
+ 1, opts
->xopts_alloc
);
990 opts
->xopts
[opts
->xopts_nr
++] = xstrdup(value
);
992 return error(_("invalid key: %s"), key
);
995 return error(_("invalid value for %s: %s"), key
, value
);
1000 static int read_populate_opts(struct replay_opts
*opts
)
1002 if (is_rebase_i(opts
)) {
1003 struct strbuf buf
= STRBUF_INIT
;
1005 if (read_oneliner(&buf
, rebase_path_gpg_sign_opt(), 1)) {
1006 if (!starts_with(buf
.buf
, "-S"))
1009 free(opts
->gpg_sign
);
1010 opts
->gpg_sign
= xstrdup(buf
.buf
+ 2);
1013 strbuf_release(&buf
);
1018 if (!file_exists(git_path_opts_file()))
1021 * The function git_parse_source(), called from git_config_from_file(),
1022 * may die() in case of a syntactically incorrect file. We do not care
1023 * about this case, though, because we wrote that file ourselves, so we
1024 * are pretty certain that it is syntactically correct.
1026 if (git_config_from_file(populate_opts_cb
, git_path_opts_file(), opts
) < 0)
1027 return error(_("malformed options sheet: '%s'"),
1028 git_path_opts_file());
1032 static int walk_revs_populate_todo(struct todo_list
*todo_list
,
1033 struct replay_opts
*opts
)
1035 enum todo_command command
= opts
->action
== REPLAY_PICK
?
1036 TODO_PICK
: TODO_REVERT
;
1037 const char *command_string
= todo_command_strings
[command
];
1038 struct commit
*commit
;
1040 if (prepare_revs(opts
))
1043 while ((commit
= get_revision(opts
->revs
))) {
1044 struct todo_item
*item
= append_new_todo(todo_list
);
1045 const char *commit_buffer
= get_commit_buffer(commit
, NULL
);
1046 const char *subject
;
1049 item
->command
= command
;
1050 item
->commit
= commit
;
1053 item
->offset_in_buf
= todo_list
->buf
.len
;
1054 subject_len
= find_commit_subject(commit_buffer
, &subject
);
1055 strbuf_addf(&todo_list
->buf
, "%s %s %.*s\n", command_string
,
1056 short_commit_name(commit
), subject_len
, subject
);
1057 unuse_commit_buffer(commit
, commit_buffer
);
1062 static int create_seq_dir(void)
1064 if (file_exists(git_path_seq_dir())) {
1065 error(_("a cherry-pick or revert is already in progress"));
1066 advise(_("try \"git cherry-pick (--continue | --quit | --abort)\""));
1068 } else if (mkdir(git_path_seq_dir(), 0777) < 0)
1069 return error_errno(_("could not create sequencer directory '%s'"),
1070 git_path_seq_dir());
1074 static int save_head(const char *head
)
1076 static struct lock_file head_lock
;
1077 struct strbuf buf
= STRBUF_INIT
;
1080 fd
= hold_lock_file_for_update(&head_lock
, git_path_head_file(), 0);
1082 rollback_lock_file(&head_lock
);
1083 return error_errno(_("could not lock HEAD"));
1085 strbuf_addf(&buf
, "%s\n", head
);
1086 if (write_in_full(fd
, buf
.buf
, buf
.len
) < 0) {
1087 rollback_lock_file(&head_lock
);
1088 return error_errno(_("could not write to '%s'"),
1089 git_path_head_file());
1091 if (commit_lock_file(&head_lock
) < 0) {
1092 rollback_lock_file(&head_lock
);
1093 return error(_("failed to finalize '%s'."), git_path_head_file());
1098 static int rollback_is_safe(void)
1100 struct strbuf sb
= STRBUF_INIT
;
1101 struct object_id expected_head
, actual_head
;
1103 if (strbuf_read_file(&sb
, git_path_abort_safety_file(), 0) >= 0) {
1105 if (get_oid_hex(sb
.buf
, &expected_head
)) {
1106 strbuf_release(&sb
);
1107 die(_("could not parse %s"), git_path_abort_safety_file());
1109 strbuf_release(&sb
);
1111 else if (errno
== ENOENT
)
1112 oidclr(&expected_head
);
1114 die_errno(_("could not read '%s'"), git_path_abort_safety_file());
1116 if (get_oid("HEAD", &actual_head
))
1117 oidclr(&actual_head
);
1119 return !oidcmp(&actual_head
, &expected_head
);
1122 static int reset_for_rollback(const unsigned char *sha1
)
1124 const char *argv
[4]; /* reset --merge <arg> + NULL */
1127 argv
[1] = "--merge";
1128 argv
[2] = sha1_to_hex(sha1
);
1130 return run_command_v_opt(argv
, RUN_GIT_CMD
);
1133 static int rollback_single_pick(void)
1135 unsigned char head_sha1
[20];
1137 if (!file_exists(git_path_cherry_pick_head()) &&
1138 !file_exists(git_path_revert_head()))
1139 return error(_("no cherry-pick or revert in progress"));
1140 if (read_ref_full("HEAD", 0, head_sha1
, NULL
))
1141 return error(_("cannot resolve HEAD"));
1142 if (is_null_sha1(head_sha1
))
1143 return error(_("cannot abort from a branch yet to be born"));
1144 return reset_for_rollback(head_sha1
);
1147 int sequencer_rollback(struct replay_opts
*opts
)
1150 unsigned char sha1
[20];
1151 struct strbuf buf
= STRBUF_INIT
;
1153 f
= fopen(git_path_head_file(), "r");
1154 if (!f
&& errno
== ENOENT
) {
1156 * There is no multiple-cherry-pick in progress.
1157 * If CHERRY_PICK_HEAD or REVERT_HEAD indicates
1158 * a single-cherry-pick in progress, abort that.
1160 return rollback_single_pick();
1163 return error_errno(_("cannot open '%s'"), git_path_head_file());
1164 if (strbuf_getline_lf(&buf
, f
)) {
1165 error(_("cannot read '%s': %s"), git_path_head_file(),
1166 ferror(f
) ? strerror(errno
) : _("unexpected end of file"));
1171 if (get_sha1_hex(buf
.buf
, sha1
) || buf
.buf
[40] != '\0') {
1172 error(_("stored pre-cherry-pick HEAD file '%s' is corrupt"),
1173 git_path_head_file());
1176 if (is_null_sha1(sha1
)) {
1177 error(_("cannot abort from a branch yet to be born"));
1181 if (!rollback_is_safe()) {
1182 /* Do not error, just do not rollback */
1183 warning(_("You seem to have moved HEAD. "
1184 "Not rewinding, check your HEAD!"));
1186 if (reset_for_rollback(sha1
))
1188 strbuf_release(&buf
);
1189 return sequencer_remove_state(opts
);
1191 strbuf_release(&buf
);
1195 static int save_todo(struct todo_list
*todo_list
, struct replay_opts
*opts
)
1197 static struct lock_file todo_lock
;
1198 const char *todo_path
= get_todo_path(opts
);
1199 int next
= todo_list
->current
, offset
, fd
;
1201 fd
= hold_lock_file_for_update(&todo_lock
, todo_path
, 0);
1203 return error_errno(_("could not lock '%s'"), todo_path
);
1204 offset
= next
< todo_list
->nr
?
1205 todo_list
->items
[next
].offset_in_buf
: todo_list
->buf
.len
;
1206 if (write_in_full(fd
, todo_list
->buf
.buf
+ offset
,
1207 todo_list
->buf
.len
- offset
) < 0)
1208 return error_errno(_("could not write to '%s'"), todo_path
);
1209 if (commit_lock_file(&todo_lock
) < 0)
1210 return error(_("failed to finalize '%s'."), todo_path
);
1214 static int save_opts(struct replay_opts
*opts
)
1216 const char *opts_file
= git_path_opts_file();
1219 if (opts
->no_commit
)
1220 res
|= git_config_set_in_file_gently(opts_file
, "options.no-commit", "true");
1222 res
|= git_config_set_in_file_gently(opts_file
, "options.edit", "true");
1224 res
|= git_config_set_in_file_gently(opts_file
, "options.signoff", "true");
1225 if (opts
->record_origin
)
1226 res
|= git_config_set_in_file_gently(opts_file
, "options.record-origin", "true");
1228 res
|= git_config_set_in_file_gently(opts_file
, "options.allow-ff", "true");
1229 if (opts
->mainline
) {
1230 struct strbuf buf
= STRBUF_INIT
;
1231 strbuf_addf(&buf
, "%d", opts
->mainline
);
1232 res
|= git_config_set_in_file_gently(opts_file
, "options.mainline", buf
.buf
);
1233 strbuf_release(&buf
);
1236 res
|= git_config_set_in_file_gently(opts_file
, "options.strategy", opts
->strategy
);
1238 res
|= git_config_set_in_file_gently(opts_file
, "options.gpg-sign", opts
->gpg_sign
);
1241 for (i
= 0; i
< opts
->xopts_nr
; i
++)
1242 res
|= git_config_set_multivar_in_file_gently(opts_file
,
1243 "options.strategy-option",
1244 opts
->xopts
[i
], "^$", 0);
1249 static int pick_commits(struct todo_list
*todo_list
, struct replay_opts
*opts
)
1253 setenv(GIT_REFLOG_ACTION
, action_name(opts
), 0);
1255 assert(!(opts
->signoff
|| opts
->no_commit
||
1256 opts
->record_origin
|| opts
->edit
));
1257 if (read_and_refresh_cache(opts
))
1260 while (todo_list
->current
< todo_list
->nr
) {
1261 struct todo_item
*item
= todo_list
->items
+ todo_list
->current
;
1262 if (save_todo(todo_list
, opts
))
1264 res
= do_pick_commit(item
->command
, item
->commit
, opts
);
1265 todo_list
->current
++;
1271 * Sequence of picks finished successfully; cleanup by
1272 * removing the .git/sequencer directory
1274 return sequencer_remove_state(opts
);
1277 static int continue_single_pick(void)
1279 const char *argv
[] = { "commit", NULL
};
1281 if (!file_exists(git_path_cherry_pick_head()) &&
1282 !file_exists(git_path_revert_head()))
1283 return error(_("no cherry-pick or revert in progress"));
1284 return run_command_v_opt(argv
, RUN_GIT_CMD
);
1287 int sequencer_continue(struct replay_opts
*opts
)
1289 struct todo_list todo_list
= TODO_LIST_INIT
;
1292 if (read_and_refresh_cache(opts
))
1295 if (!file_exists(get_todo_path(opts
)))
1296 return continue_single_pick();
1297 if (read_populate_opts(opts
))
1299 if ((res
= read_populate_todo(&todo_list
, opts
)))
1300 goto release_todo_list
;
1302 /* Verify that the conflict has been resolved */
1303 if (file_exists(git_path_cherry_pick_head()) ||
1304 file_exists(git_path_revert_head())) {
1305 res
= continue_single_pick();
1307 goto release_todo_list
;
1309 if (index_differs_from("HEAD", 0, 0)) {
1310 res
= error_dirty_index(opts
);
1311 goto release_todo_list
;
1313 todo_list
.current
++;
1314 res
= pick_commits(&todo_list
, opts
);
1316 todo_list_release(&todo_list
);
1320 static int single_pick(struct commit
*cmit
, struct replay_opts
*opts
)
1322 setenv(GIT_REFLOG_ACTION
, action_name(opts
), 0);
1323 return do_pick_commit(opts
->action
== REPLAY_PICK
?
1324 TODO_PICK
: TODO_REVERT
, cmit
, opts
);
1327 int sequencer_pick_revisions(struct replay_opts
*opts
)
1329 struct todo_list todo_list
= TODO_LIST_INIT
;
1330 unsigned char sha1
[20];
1334 if (read_and_refresh_cache(opts
))
1337 for (i
= 0; i
< opts
->revs
->pending
.nr
; i
++) {
1338 unsigned char sha1
[20];
1339 const char *name
= opts
->revs
->pending
.objects
[i
].name
;
1341 /* This happens when using --stdin. */
1345 if (!get_sha1(name
, sha1
)) {
1346 if (!lookup_commit_reference_gently(sha1
, 1)) {
1347 enum object_type type
= sha1_object_info(sha1
, NULL
);
1348 return error(_("%s: can't cherry-pick a %s"),
1349 name
, typename(type
));
1352 return error(_("%s: bad revision"), name
);
1356 * If we were called as "git cherry-pick <commit>", just
1357 * cherry-pick/revert it, set CHERRY_PICK_HEAD /
1358 * REVERT_HEAD, and don't touch the sequencer state.
1359 * This means it is possible to cherry-pick in the middle
1360 * of a cherry-pick sequence.
1362 if (opts
->revs
->cmdline
.nr
== 1 &&
1363 opts
->revs
->cmdline
.rev
->whence
== REV_CMD_REV
&&
1364 opts
->revs
->no_walk
&&
1365 !opts
->revs
->cmdline
.rev
->flags
) {
1366 struct commit
*cmit
;
1367 if (prepare_revision_walk(opts
->revs
))
1368 return error(_("revision walk setup failed"));
1369 cmit
= get_revision(opts
->revs
);
1370 if (!cmit
|| get_revision(opts
->revs
))
1371 return error("BUG: expected exactly one commit from walk");
1372 return single_pick(cmit
, opts
);
1376 * Start a new cherry-pick/ revert sequence; but
1377 * first, make sure that an existing one isn't in
1381 if (walk_revs_populate_todo(&todo_list
, opts
) ||
1382 create_seq_dir() < 0)
1384 if (get_sha1("HEAD", sha1
) && (opts
->action
== REPLAY_REVERT
))
1385 return error(_("can't revert as initial commit"));
1386 if (save_head(sha1_to_hex(sha1
)))
1388 if (save_opts(opts
))
1390 update_abort_safety_file();
1391 res
= pick_commits(&todo_list
, opts
);
1392 todo_list_release(&todo_list
);
1396 void append_signoff(struct strbuf
*msgbuf
, int ignore_footer
, unsigned flag
)
1398 unsigned no_dup_sob
= flag
& APPEND_SIGNOFF_DEDUP
;
1399 struct strbuf sob
= STRBUF_INIT
;
1402 strbuf_addstr(&sob
, sign_off_header
);
1403 strbuf_addstr(&sob
, fmt_name(getenv("GIT_COMMITTER_NAME"),
1404 getenv("GIT_COMMITTER_EMAIL")));
1405 strbuf_addch(&sob
, '\n');
1408 * If the whole message buffer is equal to the sob, pretend that we
1409 * found a conforming footer with a matching sob
1411 if (msgbuf
->len
- ignore_footer
== sob
.len
&&
1412 !strncmp(msgbuf
->buf
, sob
.buf
, sob
.len
))
1415 has_footer
= has_conforming_footer(msgbuf
, &sob
, ignore_footer
);
1418 const char *append_newlines
= NULL
;
1419 size_t len
= msgbuf
->len
- ignore_footer
;
1423 * The buffer is completely empty. Leave foom for
1424 * the title and body to be filled in by the user.
1426 append_newlines
= "\n\n";
1427 } else if (msgbuf
->buf
[len
- 1] != '\n') {
1429 * Incomplete line. Complete the line and add a
1430 * blank one so that there is an empty line between
1431 * the message body and the sob.
1433 append_newlines
= "\n\n";
1434 } else if (len
== 1) {
1436 * Buffer contains a single newline. Add another
1437 * so that we leave room for the title and body.
1439 append_newlines
= "\n";
1440 } else if (msgbuf
->buf
[len
- 2] != '\n') {
1442 * Buffer ends with a single newline. Add another
1443 * so that there is an empty line between the message
1446 append_newlines
= "\n";
1447 } /* else, the buffer already ends with two newlines. */
1449 if (append_newlines
)
1450 strbuf_splice(msgbuf
, msgbuf
->len
- ignore_footer
, 0,
1451 append_newlines
, strlen(append_newlines
));
1454 if (has_footer
!= 3 && (!no_dup_sob
|| has_footer
!= 2))
1455 strbuf_splice(msgbuf
, msgbuf
->len
- ignore_footer
, 0,
1458 strbuf_release(&sob
);