4 * Based on git-am.sh by Junio C Hamano.
6 #define USE_THE_INDEX_COMPATIBILITY_MACROS
11 #include "parse-options.h"
13 #include "run-command.h"
18 #include "cache-tree.h"
23 #include "unpack-trees.h"
25 #include "sequencer.h"
27 #include "merge-recursive.h"
29 #include "notes-utils.h"
34 #include "string-list.h"
36 #include "repository.h"
39 * Returns the length of the first line of msg.
41 static int linelen(const char *msg)
43 return strchrnul(msg, '\n') - msg;
47 * Returns true if `str` consists of only whitespace, false otherwise.
49 static int str_isspace(const char *str)
59 PATCH_FORMAT_UNKNOWN = 0,
62 PATCH_FORMAT_STGIT_SERIES,
69 KEEP_TRUE, /* pass -k flag to git-mailinfo */
70 KEEP_NON_PATCH /* pass -b flag to git-mailinfo */
75 SCISSORS_FALSE = 0, /* pass --no-scissors to git-mailinfo */
76 SCISSORS_TRUE /* pass --scissors to git-mailinfo */
82 SIGNOFF_EXPLICIT /* --signoff was set on the command-line */
85 enum show_patch_type {
91 /* state directory path */
94 /* current and last patch numbers, 1-indexed */
98 /* commit metadata and message */
105 /* when --rebasing, records the original commit the patch came from */
106 struct object_id orig_commit;
108 /* number of digits in patch filename */
111 /* various operating modes and command line options */
115 int signoff; /* enum signoff_type */
117 int keep; /* enum keep_type */
119 int scissors; /* enum scissors_type */
120 int quoted_cr; /* enum quoted_cr_action */
121 struct strvec git_apply_opts;
122 const char *resolvemsg;
123 int committer_date_is_author_date;
125 int allow_rerere_autoupdate;
126 const char *sign_commit;
131 * Initializes am_state with the default values.
133 static void am_state_init(struct am_state *state)
137 memset(state, 0, sizeof(*state));
139 state->dir = git_pathdup("rebase-apply");
143 git_config_get_bool("am.threeway", &state->threeway);
147 git_config_get_bool("am.messageid", &state->message_id);
149 state->scissors = SCISSORS_UNSET;
150 state->quoted_cr = quoted_cr_unset;
152 strvec_init(&state->git_apply_opts);
154 if (!git_config_get_bool("commit.gpgsign", &gpgsign))
155 state->sign_commit = gpgsign ? "" : NULL;
159 * Releases memory allocated by an am_state.
161 static void am_state_release(struct am_state *state)
164 free(state->author_name);
165 free(state->author_email);
166 free(state->author_date);
168 strvec_clear(&state->git_apply_opts);
171 static int am_option_parse_quoted_cr(const struct option *opt,
172 const char *arg, int unset)
174 BUG_ON_OPT_NEG(unset);
176 if (mailinfo_parse_quoted_cr_action(arg, opt->value) != 0)
177 return error(_("bad action '%s' for '%s'"), arg, "--quoted-cr");
182 * Returns path relative to the am_state directory.
184 static inline const char *am_path(const struct am_state *state, const char *path)
186 return mkpath("%s/%s", state->dir, path);
190 * For convenience to call write_file()
192 static void write_state_text(const struct am_state *state,
193 const char *name, const char *string)
195 write_file(am_path(state, name), "%s", string);
198 static void write_state_count(const struct am_state *state,
199 const char *name, int value)
201 write_file(am_path(state, name), "%d", value);
204 static void write_state_bool(const struct am_state *state,
205 const char *name, int value)
207 write_state_text(state, name, value ? "t" : "f");
211 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
214 static void say(const struct am_state *state, FILE *fp, const char *fmt, ...)
220 vfprintf(fp, fmt, ap);
227 * Returns 1 if there is an am session in progress, 0 otherwise.
229 static int am_in_progress(const struct am_state *state)
233 if (lstat(state->dir, &st) < 0 || !S_ISDIR(st.st_mode))
235 if (lstat(am_path(state, "last"), &st) || !S_ISREG(st.st_mode))
237 if (lstat(am_path(state, "next"), &st) || !S_ISREG(st.st_mode))
243 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
244 * number of bytes read on success, -1 if the file does not exist. If `trim` is
245 * set, trailing whitespace will be removed.
247 static int read_state_file(struct strbuf *sb, const struct am_state *state,
248 const char *file, int trim)
252 if (strbuf_read_file(sb, am_path(state, file), 0) >= 0) {
262 die_errno(_("could not read '%s'"), am_path(state, file));
266 * Reads and parses the state directory's "author-script" file, and sets
267 * state->author_name, state->author_email and state->author_date accordingly.
268 * Returns 0 on success, -1 if the file could not be parsed.
270 * The author script is of the format:
272 * GIT_AUTHOR_NAME='$author_name'
273 * GIT_AUTHOR_EMAIL='$author_email'
274 * GIT_AUTHOR_DATE='$author_date'
276 * where $author_name, $author_email and $author_date are quoted. We are strict
277 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
278 * script, and thus if the file differs from what this function expects, it is
279 * better to bail out than to do something that the user does not expect.
281 static int read_am_author_script(struct am_state *state)
283 const char *filename = am_path(state, "author-script");
285 assert(!state->author_name);
286 assert(!state->author_email);
287 assert(!state->author_date);
289 return read_author_script(filename, &state->author_name,
290 &state->author_email, &state->author_date, 1);
294 * Saves state->author_name, state->author_email and state->author_date in the
295 * state directory's "author-script" file.
297 static void write_author_script(const struct am_state *state)
299 struct strbuf sb = STRBUF_INIT;
301 strbuf_addstr(&sb, "GIT_AUTHOR_NAME=");
302 sq_quote_buf(&sb, state->author_name);
303 strbuf_addch(&sb, '\n');
305 strbuf_addstr(&sb, "GIT_AUTHOR_EMAIL=");
306 sq_quote_buf(&sb, state->author_email);
307 strbuf_addch(&sb, '\n');
309 strbuf_addstr(&sb, "GIT_AUTHOR_DATE=");
310 sq_quote_buf(&sb, state->author_date);
311 strbuf_addch(&sb, '\n');
313 write_state_text(state, "author-script", sb.buf);
319 * Reads the commit message from the state directory's "final-commit" file,
320 * setting state->msg to its contents and state->msg_len to the length of its
323 * Returns 0 on success, -1 if the file does not exist.
325 static int read_commit_msg(struct am_state *state)
327 struct strbuf sb = STRBUF_INIT;
331 if (read_state_file(&sb, state, "final-commit", 0) < 0) {
336 state->msg = strbuf_detach(&sb, &state->msg_len);
341 * Saves state->msg in the state directory's "final-commit" file.
343 static void write_commit_msg(const struct am_state *state)
345 const char *filename = am_path(state, "final-commit");
346 write_file_buf(filename, state->msg, state->msg_len);
350 * Loads state from disk.
352 static void am_load(struct am_state *state)
354 struct strbuf sb = STRBUF_INIT;
356 if (read_state_file(&sb, state, "next", 1) < 0)
357 BUG("state file 'next' does not exist");
358 state->cur = strtol(sb.buf, NULL, 10);
360 if (read_state_file(&sb, state, "last", 1) < 0)
361 BUG("state file 'last' does not exist");
362 state->last = strtol(sb.buf, NULL, 10);
364 if (read_am_author_script(state) < 0)
365 die(_("could not parse author script"));
367 read_commit_msg(state);
369 if (read_state_file(&sb, state, "original-commit", 1) < 0)
370 oidclr(&state->orig_commit);
371 else if (get_oid_hex(sb.buf, &state->orig_commit) < 0)
372 die(_("could not parse %s"), am_path(state, "original-commit"));
374 read_state_file(&sb, state, "threeway", 1);
375 state->threeway = !strcmp(sb.buf, "t");
377 read_state_file(&sb, state, "quiet", 1);
378 state->quiet = !strcmp(sb.buf, "t");
380 read_state_file(&sb, state, "sign", 1);
381 state->signoff = !strcmp(sb.buf, "t");
383 read_state_file(&sb, state, "utf8", 1);
384 state->utf8 = !strcmp(sb.buf, "t");
386 if (file_exists(am_path(state, "rerere-autoupdate"))) {
387 read_state_file(&sb, state, "rerere-autoupdate", 1);
388 state->allow_rerere_autoupdate = strcmp(sb.buf, "t") ?
389 RERERE_NOAUTOUPDATE : RERERE_AUTOUPDATE;
391 state->allow_rerere_autoupdate = 0;
394 read_state_file(&sb, state, "keep", 1);
395 if (!strcmp(sb.buf, "t"))
396 state->keep = KEEP_TRUE;
397 else if (!strcmp(sb.buf, "b"))
398 state->keep = KEEP_NON_PATCH;
400 state->keep = KEEP_FALSE;
402 read_state_file(&sb, state, "messageid", 1);
403 state->message_id = !strcmp(sb.buf, "t");
405 read_state_file(&sb, state, "scissors", 1);
406 if (!strcmp(sb.buf, "t"))
407 state->scissors = SCISSORS_TRUE;
408 else if (!strcmp(sb.buf, "f"))
409 state->scissors = SCISSORS_FALSE;
411 state->scissors = SCISSORS_UNSET;
413 read_state_file(&sb, state, "quoted-cr", 1);
415 state->quoted_cr = quoted_cr_unset;
416 else if (mailinfo_parse_quoted_cr_action(sb.buf, &state->quoted_cr) != 0)
417 die(_("could not parse %s"), am_path(state, "quoted-cr"));
419 read_state_file(&sb, state, "apply-opt", 1);
420 strvec_clear(&state->git_apply_opts);
421 if (sq_dequote_to_strvec(sb.buf, &state->git_apply_opts) < 0)
422 die(_("could not parse %s"), am_path(state, "apply-opt"));
424 state->rebasing = !!file_exists(am_path(state, "rebasing"));
430 * Removes the am_state directory, forcefully terminating the current am
433 static void am_destroy(const struct am_state *state)
435 struct strbuf sb = STRBUF_INIT;
437 strbuf_addstr(&sb, state->dir);
438 remove_dir_recursively(&sb, 0);
443 * Runs applypatch-msg hook. Returns its exit code.
445 static int run_applypatch_msg_hook(struct am_state *state)
448 struct run_hooks_opt opt = RUN_HOOKS_OPT_INIT;
451 strvec_push(&opt.args, am_path(state, "final-commit"));
452 ret = run_hooks("applypatch-msg", &opt);
453 run_hooks_opt_clear(&opt);
456 FREE_AND_NULL(state->msg);
457 if (read_commit_msg(state) < 0)
458 die(_("'%s' was deleted by the applypatch-msg hook"),
459 am_path(state, "final-commit"));
466 * Runs post-rewrite hook. Returns it exit code.
468 static int run_post_rewrite_hook(const struct am_state *state)
470 struct run_hooks_opt opt = RUN_HOOKS_OPT_INIT;
473 strvec_push(&opt.args, "rebase");
474 opt.path_to_stdin = am_path(state, "rewritten");
476 ret = run_hooks("post-rewrite", &opt);
478 run_hooks_opt_clear(&opt);
483 * Reads the state directory's "rewritten" file, and copies notes from the old
484 * commits listed in the file to their rewritten commits.
486 * Returns 0 on success, -1 on failure.
488 static int copy_notes_for_rebase(const struct am_state *state)
490 struct notes_rewrite_cfg *c;
491 struct strbuf sb = STRBUF_INIT;
492 const char *invalid_line = _("Malformed input line: '%s'.");
493 const char *msg = "Notes added by 'git rebase'";
497 assert(state->rebasing);
499 c = init_copy_notes_for_rewrite("rebase");
503 fp = xfopen(am_path(state, "rewritten"), "r");
505 while (!strbuf_getline_lf(&sb, fp)) {
506 struct object_id from_obj, to_obj;
509 if (sb.len != the_hash_algo->hexsz * 2 + 1) {
510 ret = error(invalid_line, sb.buf);
514 if (parse_oid_hex(sb.buf, &from_obj, &p)) {
515 ret = error(invalid_line, sb.buf);
520 ret = error(invalid_line, sb.buf);
524 if (get_oid_hex(p + 1, &to_obj)) {
525 ret = error(invalid_line, sb.buf);
529 if (copy_note_for_rewrite(c, &from_obj, &to_obj))
530 ret = error(_("Failed to copy notes from '%s' to '%s'"),
531 oid_to_hex(&from_obj), oid_to_hex(&to_obj));
535 finish_copy_notes_for_rewrite(the_repository, c, msg);
542 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
543 * non-indented lines and checking if they look like they begin with valid
544 * header field names.
546 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
548 static int is_mail(FILE *fp)
550 const char *header_regex = "^[!-9;-~]+:";
551 struct strbuf sb = STRBUF_INIT;
555 if (fseek(fp, 0L, SEEK_SET))
556 die_errno(_("fseek failed"));
558 if (regcomp(®ex, header_regex, REG_NOSUB | REG_EXTENDED))
559 die("invalid pattern: %s", header_regex);
561 while (!strbuf_getline(&sb, fp)) {
563 break; /* End of header */
565 /* Ignore indented folded lines */
566 if (*sb.buf == '\t' || *sb.buf == ' ')
569 /* It's a header if it matches header_regex */
570 if (regexec(®ex, sb.buf, 0, NULL, 0)) {
583 * Attempts to detect the patch_format of the patches contained in `paths`,
584 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
587 static int detect_patch_format(const char **paths)
589 enum patch_format ret = PATCH_FORMAT_UNKNOWN;
590 struct strbuf l1 = STRBUF_INIT;
591 struct strbuf l2 = STRBUF_INIT;
592 struct strbuf l3 = STRBUF_INIT;
596 * We default to mbox format if input is from stdin and for directories
598 if (!*paths || !strcmp(*paths, "-") || is_directory(*paths))
599 return PATCH_FORMAT_MBOX;
602 * Otherwise, check the first few lines of the first patch, starting
603 * from the first non-blank line, to try to detect its format.
606 fp = xfopen(*paths, "r");
608 while (!strbuf_getline(&l1, fp)) {
613 if (starts_with(l1.buf, "From ") || starts_with(l1.buf, "From: ")) {
614 ret = PATCH_FORMAT_MBOX;
618 if (starts_with(l1.buf, "# This series applies on GIT commit")) {
619 ret = PATCH_FORMAT_STGIT_SERIES;
623 if (!strcmp(l1.buf, "# HG changeset patch")) {
624 ret = PATCH_FORMAT_HG;
628 strbuf_getline(&l2, fp);
629 strbuf_getline(&l3, fp);
632 * If the second line is empty and the third is a From, Author or Date
633 * entry, this is likely an StGit patch.
635 if (l1.len && !l2.len &&
636 (starts_with(l3.buf, "From:") ||
637 starts_with(l3.buf, "Author:") ||
638 starts_with(l3.buf, "Date:"))) {
639 ret = PATCH_FORMAT_STGIT;
643 if (l1.len && is_mail(fp)) {
644 ret = PATCH_FORMAT_MBOX;
657 * Splits out individual email patches from `paths`, where each path is either
658 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
660 static int split_mail_mbox(struct am_state *state, const char **paths,
661 int keep_cr, int mboxrd)
663 struct child_process cp = CHILD_PROCESS_INIT;
664 struct strbuf last = STRBUF_INIT;
668 strvec_push(&cp.args, "mailsplit");
669 strvec_pushf(&cp.args, "-d%d", state->prec);
670 strvec_pushf(&cp.args, "-o%s", state->dir);
671 strvec_push(&cp.args, "-b");
673 strvec_push(&cp.args, "--keep-cr");
675 strvec_push(&cp.args, "--mboxrd");
676 strvec_push(&cp.args, "--");
677 strvec_pushv(&cp.args, paths);
679 ret = capture_command(&cp, &last, 8);
684 state->last = strtol(last.buf, NULL, 10);
687 strbuf_release(&last);
692 * Callback signature for split_mail_conv(). The foreign patch should be
693 * read from `in`, and the converted patch (in RFC2822 mail format) should be
694 * written to `out`. Return 0 on success, or -1 on failure.
696 typedef int (*mail_conv_fn)(FILE *out, FILE *in, int keep_cr);
699 * Calls `fn` for each file in `paths` to convert the foreign patch to the
700 * RFC2822 mail format suitable for parsing with git-mailinfo.
702 * Returns 0 on success, -1 on failure.
704 static int split_mail_conv(mail_conv_fn fn, struct am_state *state,
705 const char **paths, int keep_cr)
707 static const char *stdin_only[] = {"-", NULL};
713 for (i = 0; *paths; paths++, i++) {
718 if (!strcmp(*paths, "-"))
721 in = fopen(*paths, "r");
724 return error_errno(_("could not open '%s' for reading"),
727 mail = mkpath("%s/%0*d", state->dir, state->prec, i + 1);
729 out = fopen(mail, "w");
733 return error_errno(_("could not open '%s' for writing"),
737 ret = fn(out, in, keep_cr);
744 return error(_("could not parse patch '%s'"), *paths);
753 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
754 * message suitable for parsing with git-mailinfo.
756 static int stgit_patch_to_mail(FILE *out, FILE *in, int keep_cr)
758 struct strbuf sb = STRBUF_INIT;
759 int subject_printed = 0;
761 while (!strbuf_getline_lf(&sb, in)) {
764 if (str_isspace(sb.buf))
766 else if (skip_prefix(sb.buf, "Author:", &str))
767 fprintf(out, "From:%s\n", str);
768 else if (starts_with(sb.buf, "From") || starts_with(sb.buf, "Date"))
769 fprintf(out, "%s\n", sb.buf);
770 else if (!subject_printed) {
771 fprintf(out, "Subject: %s\n", sb.buf);
774 fprintf(out, "\n%s\n", sb.buf);
780 while (strbuf_fread(&sb, 8192, in) > 0) {
781 fwrite(sb.buf, 1, sb.len, out);
790 * This function only supports a single StGit series file in `paths`.
792 * Given an StGit series file, converts the StGit patches in the series into
793 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
794 * the state directory.
796 * Returns 0 on success, -1 on failure.
798 static int split_mail_stgit_series(struct am_state *state, const char **paths,
801 const char *series_dir;
802 char *series_dir_buf;
804 struct strvec patches = STRVEC_INIT;
805 struct strbuf sb = STRBUF_INIT;
808 if (!paths[0] || paths[1])
809 return error(_("Only one StGIT patch series can be applied at once"));
811 series_dir_buf = xstrdup(*paths);
812 series_dir = dirname(series_dir_buf);
814 fp = fopen(*paths, "r");
816 return error_errno(_("could not open '%s' for reading"), *paths);
818 while (!strbuf_getline_lf(&sb, fp)) {
820 continue; /* skip comment lines */
822 strvec_push(&patches, mkpath("%s/%s", series_dir, sb.buf));
827 free(series_dir_buf);
829 ret = split_mail_conv(stgit_patch_to_mail, state, patches.v, keep_cr);
831 strvec_clear(&patches);
836 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
837 * message suitable for parsing with git-mailinfo.
839 static int hg_patch_to_mail(FILE *out, FILE *in, int keep_cr)
841 struct strbuf sb = STRBUF_INIT;
844 while (!strbuf_getline_lf(&sb, in)) {
847 if (skip_prefix(sb.buf, "# User ", &str))
848 fprintf(out, "From: %s\n", str);
849 else if (skip_prefix(sb.buf, "# Date ", &str)) {
850 timestamp_t timestamp;
855 timestamp = parse_timestamp(str, &end, 10);
857 rc = error(_("invalid timestamp"));
861 if (!skip_prefix(end, " ", &str)) {
862 rc = error(_("invalid Date line"));
867 tz = strtol(str, &end, 10);
869 rc = error(_("invalid timezone offset"));
874 rc = error(_("invalid Date line"));
879 * mercurial's timezone is in seconds west of UTC,
880 * however git's timezone is in hours + minutes east of
883 tz2 = labs(tz) / 3600 * 100 + labs(tz) % 3600 / 60;
887 fprintf(out, "Date: %s\n", show_date(timestamp, tz2, DATE_MODE(RFC2822)));
888 } else if (starts_with(sb.buf, "# ")) {
891 fprintf(out, "\n%s\n", sb.buf);
897 while (strbuf_fread(&sb, 8192, in) > 0) {
898 fwrite(sb.buf, 1, sb.len, out);
907 * Splits a list of files/directories into individual email patches. Each path
908 * in `paths` must be a file/directory that is formatted according to
911 * Once split out, the individual email patches will be stored in the state
912 * directory, with each patch's filename being its index, padded to state->prec
915 * state->cur will be set to the index of the first mail, and state->last will
916 * be set to the index of the last mail.
918 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
919 * to disable this behavior, -1 to use the default configured setting.
921 * Returns 0 on success, -1 on failure.
923 static int split_mail(struct am_state *state, enum patch_format patch_format,
924 const char **paths, int keep_cr)
928 git_config_get_bool("am.keepcr", &keep_cr);
931 switch (patch_format) {
932 case PATCH_FORMAT_MBOX:
933 return split_mail_mbox(state, paths, keep_cr, 0);
934 case PATCH_FORMAT_STGIT:
935 return split_mail_conv(stgit_patch_to_mail, state, paths, keep_cr);
936 case PATCH_FORMAT_STGIT_SERIES:
937 return split_mail_stgit_series(state, paths, keep_cr);
938 case PATCH_FORMAT_HG:
939 return split_mail_conv(hg_patch_to_mail, state, paths, keep_cr);
940 case PATCH_FORMAT_MBOXRD:
941 return split_mail_mbox(state, paths, keep_cr, 1);
943 BUG("invalid patch_format");
949 * Setup a new am session for applying patches
951 static void am_setup(struct am_state *state, enum patch_format patch_format,
952 const char **paths, int keep_cr)
954 struct object_id curr_head;
956 struct strbuf sb = STRBUF_INIT;
959 patch_format = detect_patch_format(paths);
962 fprintf_ln(stderr, _("Patch format detection failed."));
966 if (mkdir(state->dir, 0777) < 0 && errno != EEXIST)
967 die_errno(_("failed to create directory '%s'"), state->dir);
968 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
970 if (split_mail(state, patch_format, paths, keep_cr) < 0) {
972 die(_("Failed to split patches."));
978 write_state_bool(state, "threeway", state->threeway);
979 write_state_bool(state, "quiet", state->quiet);
980 write_state_bool(state, "sign", state->signoff);
981 write_state_bool(state, "utf8", state->utf8);
983 if (state->allow_rerere_autoupdate)
984 write_state_bool(state, "rerere-autoupdate",
985 state->allow_rerere_autoupdate == RERERE_AUTOUPDATE);
987 switch (state->keep) {
998 BUG("invalid value for state->keep");
1001 write_state_text(state, "keep", str);
1002 write_state_bool(state, "messageid", state->message_id);
1004 switch (state->scissors) {
1005 case SCISSORS_UNSET:
1008 case SCISSORS_FALSE:
1015 BUG("invalid value for state->scissors");
1017 write_state_text(state, "scissors", str);
1019 switch (state->quoted_cr) {
1020 case quoted_cr_unset:
1023 case quoted_cr_nowarn:
1026 case quoted_cr_warn:
1029 case quoted_cr_strip:
1033 BUG("invalid value for state->quoted_cr");
1035 write_state_text(state, "quoted-cr", str);
1037 sq_quote_argv(&sb, state->git_apply_opts.v);
1038 write_state_text(state, "apply-opt", sb.buf);
1040 if (state->rebasing)
1041 write_state_text(state, "rebasing", "");
1043 write_state_text(state, "applying", "");
1045 if (!get_oid("HEAD", &curr_head)) {
1046 write_state_text(state, "abort-safety", oid_to_hex(&curr_head));
1047 if (!state->rebasing)
1048 update_ref("am", "ORIG_HEAD", &curr_head, NULL, 0,
1049 UPDATE_REFS_DIE_ON_ERR);
1051 write_state_text(state, "abort-safety", "");
1052 if (!state->rebasing)
1053 delete_ref(NULL, "ORIG_HEAD", NULL, 0);
1057 * NOTE: Since the "next" and "last" files determine if an am_state
1058 * session is in progress, they should be written last.
1061 write_state_count(state, "next", state->cur);
1062 write_state_count(state, "last", state->last);
1064 strbuf_release(&sb);
1068 * Increments the patch pointer, and cleans am_state for the application of the
1071 static void am_next(struct am_state *state)
1073 struct object_id head;
1075 FREE_AND_NULL(state->author_name);
1076 FREE_AND_NULL(state->author_email);
1077 FREE_AND_NULL(state->author_date);
1078 FREE_AND_NULL(state->msg);
1081 unlink(am_path(state, "author-script"));
1082 unlink(am_path(state, "final-commit"));
1084 oidclr(&state->orig_commit);
1085 unlink(am_path(state, "original-commit"));
1086 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
1088 if (!get_oid("HEAD", &head))
1089 write_state_text(state, "abort-safety", oid_to_hex(&head));
1091 write_state_text(state, "abort-safety", "");
1094 write_state_count(state, "next", state->cur);
1098 * Returns the filename of the current patch email.
1100 static const char *msgnum(const struct am_state *state)
1102 static struct strbuf sb = STRBUF_INIT;
1105 strbuf_addf(&sb, "%0*d", state->prec, state->cur);
1111 * Dies with a user-friendly message on how to proceed after resolving the
1112 * problem. This message can be overridden with state->resolvemsg.
1114 static void NORETURN die_user_resolve(const struct am_state *state)
1116 if (state->resolvemsg) {
1117 printf_ln("%s", state->resolvemsg);
1119 const char *cmdline = state->interactive ? "git am -i" : "git am";
1121 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline);
1122 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline);
1123 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline);
1130 * Appends signoff to the "msg" field of the am_state.
1132 static void am_append_signoff(struct am_state *state)
1134 struct strbuf sb = STRBUF_INIT;
1136 strbuf_attach(&sb, state->msg, state->msg_len, state->msg_len);
1137 append_signoff(&sb, 0, 0);
1138 state->msg = strbuf_detach(&sb, &state->msg_len);
1142 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1143 * state->msg will be set to the patch message. state->author_name,
1144 * state->author_email and state->author_date will be set to the patch author's
1145 * name, email and date respectively. The patch body will be written to the
1146 * state directory's "patch" file.
1148 * Returns 1 if the patch should be skipped, 0 otherwise.
1150 static int parse_mail(struct am_state *state, const char *mail)
1153 struct strbuf sb = STRBUF_INIT;
1154 struct strbuf msg = STRBUF_INIT;
1155 struct strbuf author_name = STRBUF_INIT;
1156 struct strbuf author_date = STRBUF_INIT;
1157 struct strbuf author_email = STRBUF_INIT;
1161 setup_mailinfo(&mi);
1164 mi.metainfo_charset = get_commit_output_encoding();
1166 mi.metainfo_charset = NULL;
1168 switch (state->keep) {
1172 mi.keep_subject = 1;
1174 case KEEP_NON_PATCH:
1175 mi.keep_non_patch_brackets_in_subject = 1;
1178 BUG("invalid value for state->keep");
1181 if (state->message_id)
1182 mi.add_message_id = 1;
1184 switch (state->scissors) {
1185 case SCISSORS_UNSET:
1187 case SCISSORS_FALSE:
1188 mi.use_scissors = 0;
1191 mi.use_scissors = 1;
1194 BUG("invalid value for state->scissors");
1197 switch (state->quoted_cr) {
1198 case quoted_cr_unset:
1200 case quoted_cr_nowarn:
1201 case quoted_cr_warn:
1202 case quoted_cr_strip:
1203 mi.quoted_cr = state->quoted_cr;
1206 BUG("invalid value for state->quoted_cr");
1209 mi.input = xfopen(mail, "r");
1210 mi.output = xfopen(am_path(state, "info"), "w");
1211 if (mailinfo(&mi, am_path(state, "msg"), am_path(state, "patch")))
1212 die("could not parse patch");
1217 if (mi.format_flowed)
1218 warning(_("Patch sent with format=flowed; "
1219 "space at the end of lines might be lost."));
1221 /* Extract message and author information */
1222 fp = xfopen(am_path(state, "info"), "r");
1223 while (!strbuf_getline_lf(&sb, fp)) {
1226 if (skip_prefix(sb.buf, "Subject: ", &x)) {
1228 strbuf_addch(&msg, '\n');
1229 strbuf_addstr(&msg, x);
1230 } else if (skip_prefix(sb.buf, "Author: ", &x))
1231 strbuf_addstr(&author_name, x);
1232 else if (skip_prefix(sb.buf, "Email: ", &x))
1233 strbuf_addstr(&author_email, x);
1234 else if (skip_prefix(sb.buf, "Date: ", &x))
1235 strbuf_addstr(&author_date, x);
1239 /* Skip pine's internal folder data */
1240 if (!strcmp(author_name.buf, "Mail System Internal Data")) {
1245 if (is_empty_or_missing_file(am_path(state, "patch"))) {
1246 printf_ln(_("Patch is empty."));
1247 die_user_resolve(state);
1250 strbuf_addstr(&msg, "\n\n");
1251 strbuf_addbuf(&msg, &mi.log_message);
1252 strbuf_stripspace(&msg, 0);
1254 assert(!state->author_name);
1255 state->author_name = strbuf_detach(&author_name, NULL);
1257 assert(!state->author_email);
1258 state->author_email = strbuf_detach(&author_email, NULL);
1260 assert(!state->author_date);
1261 state->author_date = strbuf_detach(&author_date, NULL);
1263 assert(!state->msg);
1264 state->msg = strbuf_detach(&msg, &state->msg_len);
1267 strbuf_release(&msg);
1268 strbuf_release(&author_date);
1269 strbuf_release(&author_email);
1270 strbuf_release(&author_name);
1271 strbuf_release(&sb);
1272 clear_mailinfo(&mi);
1277 * Sets commit_id to the commit hash where the mail was generated from.
1278 * Returns 0 on success, -1 on failure.
1280 static int get_mail_commit_oid(struct object_id *commit_id, const char *mail)
1282 struct strbuf sb = STRBUF_INIT;
1283 FILE *fp = xfopen(mail, "r");
1287 if (strbuf_getline_lf(&sb, fp) ||
1288 !skip_prefix(sb.buf, "From ", &x) ||
1289 get_oid_hex(x, commit_id) < 0)
1292 strbuf_release(&sb);
1298 * Sets state->msg, state->author_name, state->author_email, state->author_date
1299 * to the commit's respective info.
1301 static void get_commit_info(struct am_state *state, struct commit *commit)
1303 const char *buffer, *ident_line, *msg;
1305 struct ident_split id;
1307 buffer = logmsg_reencode(commit, NULL, get_commit_output_encoding());
1309 ident_line = find_commit_header(buffer, "author", &ident_len);
1311 die(_("missing author line in commit %s"),
1312 oid_to_hex(&commit->object.oid));
1313 if (split_ident_line(&id, ident_line, ident_len) < 0)
1314 die(_("invalid ident line: %.*s"), (int)ident_len, ident_line);
1316 assert(!state->author_name);
1318 state->author_name =
1319 xmemdupz(id.name_begin, id.name_end - id.name_begin);
1321 state->author_name = xstrdup("");
1323 assert(!state->author_email);
1325 state->author_email =
1326 xmemdupz(id.mail_begin, id.mail_end - id.mail_begin);
1328 state->author_email = xstrdup("");
1330 assert(!state->author_date);
1331 state->author_date = xstrdup(show_ident_date(&id, DATE_MODE(NORMAL)));
1333 assert(!state->msg);
1334 msg = strstr(buffer, "\n\n");
1336 die(_("unable to parse commit %s"), oid_to_hex(&commit->object.oid));
1337 state->msg = xstrdup(msg + 2);
1338 state->msg_len = strlen(state->msg);
1339 unuse_commit_buffer(commit, buffer);
1343 * Writes `commit` as a patch to the state directory's "patch" file.
1345 static void write_commit_patch(const struct am_state *state, struct commit *commit)
1347 struct rev_info rev_info;
1350 fp = xfopen(am_path(state, "patch"), "w");
1351 repo_init_revisions(the_repository, &rev_info, NULL);
1353 rev_info.abbrev = 0;
1354 rev_info.stdin_handling = REV_INFO_STDIN_IGNORE;
1355 rev_info.show_root_diff = 1;
1356 rev_info.diffopt.output_format = DIFF_FORMAT_PATCH;
1357 rev_info.no_commit_id = 1;
1358 rev_info.diffopt.flags.binary = 1;
1359 rev_info.diffopt.flags.full_index = 1;
1360 rev_info.diffopt.use_color = 0;
1361 rev_info.diffopt.file = fp;
1362 rev_info.diffopt.close_file = 1;
1363 add_pending_object(&rev_info, &commit->object, "");
1364 diff_setup_done(&rev_info.diffopt);
1365 log_tree_commit(&rev_info, commit);
1369 * Writes the diff of the index against HEAD as a patch to the state
1370 * directory's "patch" file.
1372 static void write_index_patch(const struct am_state *state)
1375 struct object_id head;
1376 struct rev_info rev_info;
1379 if (!get_oid("HEAD", &head)) {
1380 struct commit *commit = lookup_commit_or_die(&head, "HEAD");
1381 tree = get_commit_tree(commit);
1383 tree = lookup_tree(the_repository,
1384 the_repository->hash_algo->empty_tree);
1386 fp = xfopen(am_path(state, "patch"), "w");
1387 repo_init_revisions(the_repository, &rev_info, NULL);
1389 rev_info.stdin_handling = REV_INFO_STDIN_IGNORE;
1390 rev_info.no_commit_id = 1;
1391 rev_info.diffopt.output_format = DIFF_FORMAT_PATCH;
1392 rev_info.diffopt.use_color = 0;
1393 rev_info.diffopt.file = fp;
1394 rev_info.diffopt.close_file = 1;
1395 add_pending_object(&rev_info, &tree->object, "");
1396 diff_setup_done(&rev_info.diffopt);
1397 run_diff_index(&rev_info, 1);
1401 * Like parse_mail(), but parses the mail by looking up its commit ID
1402 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1405 * state->orig_commit will be set to the original commit ID.
1407 * Will always return 0 as the patch should never be skipped.
1409 static int parse_mail_rebase(struct am_state *state, const char *mail)
1411 struct commit *commit;
1412 struct object_id commit_oid;
1414 if (get_mail_commit_oid(&commit_oid, mail) < 0)
1415 die(_("could not parse %s"), mail);
1417 commit = lookup_commit_or_die(&commit_oid, mail);
1419 get_commit_info(state, commit);
1421 write_commit_patch(state, commit);
1423 oidcpy(&state->orig_commit, &commit_oid);
1424 write_state_text(state, "original-commit", oid_to_hex(&commit_oid));
1425 update_ref("am", "REBASE_HEAD", &commit_oid,
1426 NULL, REF_NO_DEREF, UPDATE_REFS_DIE_ON_ERR);
1432 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1433 * `index_file` is not NULL, the patch will be applied to that index.
1435 static int run_apply(const struct am_state *state, const char *index_file)
1437 struct strvec apply_paths = STRVEC_INIT;
1438 struct strvec apply_opts = STRVEC_INIT;
1439 struct apply_state apply_state;
1441 int force_apply = 0;
1444 if (init_apply_state(&apply_state, the_repository, NULL))
1445 BUG("init_apply_state() failed");
1447 strvec_push(&apply_opts, "apply");
1448 strvec_pushv(&apply_opts, state->git_apply_opts.v);
1450 opts_left = apply_parse_options(apply_opts.nr, apply_opts.v,
1451 &apply_state, &force_apply, &options,
1455 die("unknown option passed through to git apply");
1458 apply_state.index_file = index_file;
1459 apply_state.cached = 1;
1461 apply_state.check_index = 1;
1464 * If we are allowed to fall back on 3-way merge, don't give false
1465 * errors during the initial attempt.
1467 if (state->threeway && !index_file)
1468 apply_state.apply_verbosity = verbosity_silent;
1470 if (check_apply_state(&apply_state, force_apply))
1471 BUG("check_apply_state() failed");
1473 strvec_push(&apply_paths, am_path(state, "patch"));
1475 res = apply_all_patches(&apply_state, apply_paths.nr, apply_paths.v, options);
1477 strvec_clear(&apply_paths);
1478 strvec_clear(&apply_opts);
1479 clear_apply_state(&apply_state);
1485 /* Reload index as apply_all_patches() will have modified it. */
1487 read_cache_from(index_file);
1494 * Builds an index that contains just the blobs needed for a 3way merge.
1496 static int build_fake_ancestor(const struct am_state *state, const char *index_file)
1498 struct child_process cp = CHILD_PROCESS_INIT;
1501 strvec_push(&cp.args, "apply");
1502 strvec_pushv(&cp.args, state->git_apply_opts.v);
1503 strvec_pushf(&cp.args, "--build-fake-ancestor=%s", index_file);
1504 strvec_push(&cp.args, am_path(state, "patch"));
1506 if (run_command(&cp))
1513 * Attempt a threeway merge, using index_path as the temporary index.
1515 static int fall_back_threeway(const struct am_state *state, const char *index_path)
1517 struct object_id orig_tree, their_tree, our_tree;
1518 const struct object_id *bases[1] = { &orig_tree };
1519 struct merge_options o;
1520 struct commit *result;
1521 char *their_tree_name;
1523 if (get_oid("HEAD", &our_tree) < 0)
1524 oidcpy(&our_tree, the_hash_algo->empty_tree);
1526 if (build_fake_ancestor(state, index_path))
1527 return error("could not build fake ancestor");
1530 read_cache_from(index_path);
1532 if (write_index_as_tree(&orig_tree, &the_index, index_path, 0, NULL))
1533 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1535 say(state, stdout, _("Using index info to reconstruct a base tree..."));
1537 if (!state->quiet) {
1539 * List paths that needed 3-way fallback, so that the user can
1540 * review them with extra care to spot mismerges.
1542 struct rev_info rev_info;
1544 repo_init_revisions(the_repository, &rev_info, NULL);
1545 rev_info.diffopt.output_format = DIFF_FORMAT_NAME_STATUS;
1546 rev_info.diffopt.filter |= diff_filter_bit('A');
1547 rev_info.diffopt.filter |= diff_filter_bit('M');
1548 add_pending_oid(&rev_info, "HEAD", &our_tree, 0);
1549 diff_setup_done(&rev_info.diffopt);
1550 run_diff_index(&rev_info, 1);
1553 if (run_apply(state, index_path))
1554 return error(_("Did you hand edit your patch?\n"
1555 "It does not apply to blobs recorded in its index."));
1557 if (write_index_as_tree(&their_tree, &the_index, index_path, 0, NULL))
1558 return error("could not write tree");
1560 say(state, stdout, _("Falling back to patching base and 3-way merge..."));
1566 * This is not so wrong. Depending on which base we picked, orig_tree
1567 * may be wildly different from ours, but their_tree has the same set of
1568 * wildly different changes in parts the patch did not touch, so
1569 * recursive ends up canceling them, saying that we reverted all those
1573 init_merge_options(&o, the_repository);
1576 their_tree_name = xstrfmt("%.*s", linelen(state->msg), state->msg);
1577 o.branch2 = their_tree_name;
1578 o.detect_directory_renames = MERGE_DIRECTORY_RENAMES_NONE;
1583 if (merge_recursive_generic(&o, &our_tree, &their_tree, 1, bases, &result)) {
1584 repo_rerere(the_repository, state->allow_rerere_autoupdate);
1585 free(their_tree_name);
1586 return error(_("Failed to merge in the changes."));
1589 free(their_tree_name);
1594 * Commits the current index with state->msg as the commit message and
1595 * state->author_name, state->author_email and state->author_date as the author
1598 static void do_commit(const struct am_state *state)
1600 struct object_id tree, parent, commit;
1601 const struct object_id *old_oid;
1602 struct commit_list *parents = NULL;
1603 const char *reflog_msg, *author, *committer = NULL;
1604 struct strbuf sb = STRBUF_INIT;
1605 struct run_hooks_opt hook_opt_pre = RUN_HOOKS_OPT_INIT;
1606 struct run_hooks_opt hook_opt_post = RUN_HOOKS_OPT_INIT;
1608 if (run_hooks("pre-applypatch", &hook_opt_pre)) {
1609 run_hooks_opt_clear(&hook_opt_pre);
1613 if (write_cache_as_tree(&tree, 0, NULL))
1614 die(_("git write-tree failed to write a tree"));
1616 if (!get_oid_commit("HEAD", &parent)) {
1618 commit_list_insert(lookup_commit(the_repository, &parent),
1622 say(state, stderr, _("applying to an empty history"));
1625 author = fmt_ident(state->author_name, state->author_email,
1627 state->ignore_date ? NULL : state->author_date,
1630 if (state->committer_date_is_author_date)
1631 committer = fmt_ident(getenv("GIT_COMMITTER_NAME"),
1632 getenv("GIT_COMMITTER_EMAIL"),
1633 WANT_COMMITTER_IDENT,
1634 state->ignore_date ? NULL
1635 : state->author_date,
1638 if (commit_tree_extended(state->msg, state->msg_len, &tree, parents,
1639 &commit, author, committer, state->sign_commit,
1641 die(_("failed to write commit object"));
1643 reflog_msg = getenv("GIT_REFLOG_ACTION");
1647 strbuf_addf(&sb, "%s: %.*s", reflog_msg, linelen(state->msg),
1650 update_ref(sb.buf, "HEAD", &commit, old_oid, 0,
1651 UPDATE_REFS_DIE_ON_ERR);
1653 if (state->rebasing) {
1654 FILE *fp = xfopen(am_path(state, "rewritten"), "a");
1656 assert(!is_null_oid(&state->orig_commit));
1657 fprintf(fp, "%s ", oid_to_hex(&state->orig_commit));
1658 fprintf(fp, "%s\n", oid_to_hex(&commit));
1662 run_hooks("post-applypatch", &hook_opt_post);
1664 run_hooks_opt_clear(&hook_opt_pre);
1665 run_hooks_opt_clear(&hook_opt_post);
1666 strbuf_release(&sb);
1670 * Validates the am_state for resuming -- the "msg" and authorship fields must
1673 static void validate_resume_state(const struct am_state *state)
1676 die(_("cannot resume: %s does not exist."),
1677 am_path(state, "final-commit"));
1679 if (!state->author_name || !state->author_email || !state->author_date)
1680 die(_("cannot resume: %s does not exist."),
1681 am_path(state, "author-script"));
1685 * Interactively prompt the user on whether the current patch should be
1688 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1691 static int do_interactive(struct am_state *state)
1698 puts(_("Commit Body is:"));
1699 puts("--------------------------");
1700 printf("%s", state->msg);
1701 puts("--------------------------");
1704 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1705 * in your translation. The program will only accept English
1706 * input at this point.
1708 printf(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "));
1709 if (!fgets(reply, sizeof(reply), stdin))
1710 die("unable to read from stdin; aborting");
1712 if (*reply == 'y' || *reply == 'Y') {
1714 } else if (*reply == 'a' || *reply == 'A') {
1715 state->interactive = 0;
1717 } else if (*reply == 'n' || *reply == 'N') {
1719 } else if (*reply == 'e' || *reply == 'E') {
1720 struct strbuf msg = STRBUF_INIT;
1722 if (!launch_editor(am_path(state, "final-commit"), &msg, NULL)) {
1724 state->msg = strbuf_detach(&msg, &state->msg_len);
1726 strbuf_release(&msg);
1727 } else if (*reply == 'v' || *reply == 'V') {
1728 const char *pager = git_pager(1);
1729 struct child_process cp = CHILD_PROCESS_INIT;
1733 prepare_pager_args(&cp, pager);
1734 strvec_push(&cp.args, am_path(state, "patch"));
1741 * Applies all queued mail.
1743 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1744 * well as the state directory's "patch" file is used as-is for applying the
1745 * patch and committing it.
1747 static void am_run(struct am_state *state, int resume)
1749 struct strbuf sb = STRBUF_INIT;
1751 unlink(am_path(state, "dirtyindex"));
1753 if (refresh_and_write_cache(REFRESH_QUIET, 0, 0) < 0)
1754 die(_("unable to write index file"));
1756 if (repo_index_has_changes(the_repository, NULL, &sb)) {
1757 write_state_bool(state, "dirtyindex", 1);
1758 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb.buf);
1761 strbuf_release(&sb);
1763 while (state->cur <= state->last) {
1764 const char *mail = am_path(state, msgnum(state));
1769 if (!file_exists(mail))
1773 validate_resume_state(state);
1777 if (state->rebasing)
1778 skip = parse_mail_rebase(state, mail);
1780 skip = parse_mail(state, mail);
1783 goto next; /* mail should be skipped */
1786 am_append_signoff(state);
1788 write_author_script(state);
1789 write_commit_msg(state);
1792 if (state->interactive && do_interactive(state))
1795 if (run_applypatch_msg_hook(state))
1798 say(state, stdout, _("Applying: %.*s"), linelen(state->msg), state->msg);
1800 apply_status = run_apply(state, NULL);
1802 if (apply_status && state->threeway) {
1803 struct strbuf sb = STRBUF_INIT;
1805 strbuf_addstr(&sb, am_path(state, "patch-merge-index"));
1806 apply_status = fall_back_threeway(state, sb.buf);
1807 strbuf_release(&sb);
1810 * Applying the patch to an earlier tree and merging
1811 * the result may have produced the same tree as ours.
1813 if (!apply_status &&
1814 !repo_index_has_changes(the_repository, NULL, NULL)) {
1815 say(state, stdout, _("No changes -- Patch already applied."));
1821 printf_ln(_("Patch failed at %s %.*s"), msgnum(state),
1822 linelen(state->msg), state->msg);
1824 if (advice_amworkdir)
1825 advise(_("Use 'git am --show-current-patch=diff' to see the failed patch"));
1827 die_user_resolve(state);
1840 if (!is_empty_or_missing_file(am_path(state, "rewritten"))) {
1841 assert(state->rebasing);
1842 copy_notes_for_rebase(state);
1843 run_post_rewrite_hook(state);
1847 * In rebasing mode, it's up to the caller to take care of
1850 if (!state->rebasing) {
1852 close_object_store(the_repository->objects);
1853 run_auto_maintenance(state->quiet);
1858 * Resume the current am session after patch application failure. The user did
1859 * all the hard work, and we do not have to do any patch application. Just
1860 * trust and commit what the user has in the index and working tree.
1862 static void am_resolve(struct am_state *state)
1864 validate_resume_state(state);
1866 say(state, stdout, _("Applying: %.*s"), linelen(state->msg), state->msg);
1868 if (!repo_index_has_changes(the_repository, NULL, NULL)) {
1869 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1870 "If there is nothing left to stage, chances are that something else\n"
1871 "already introduced the same changes; you might want to skip this patch."));
1872 die_user_resolve(state);
1875 if (unmerged_cache()) {
1876 printf_ln(_("You still have unmerged paths in your index.\n"
1877 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1878 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1879 die_user_resolve(state);
1882 if (state->interactive) {
1883 write_index_patch(state);
1884 if (do_interactive(state))
1888 repo_rerere(the_repository, 0);
1899 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1900 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1903 static int fast_forward_to(struct tree *head, struct tree *remote, int reset)
1905 struct lock_file lock_file = LOCK_INIT;
1906 struct unpack_trees_options opts;
1907 struct tree_desc t[2];
1909 if (parse_tree(head) || parse_tree(remote))
1912 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
1914 refresh_cache(REFRESH_QUIET);
1916 memset(&opts, 0, sizeof(opts));
1918 opts.src_index = &the_index;
1919 opts.dst_index = &the_index;
1923 opts.fn = twoway_merge;
1924 init_tree_desc(&t[0], head->buffer, head->size);
1925 init_tree_desc(&t[1], remote->buffer, remote->size);
1927 if (unpack_trees(2, t, &opts)) {
1928 rollback_lock_file(&lock_file);
1932 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
1933 die(_("unable to write new index file"));
1939 * Merges a tree into the index. The index's stat info will take precedence
1940 * over the merged tree's. Returns 0 on success, -1 on failure.
1942 static int merge_tree(struct tree *tree)
1944 struct lock_file lock_file = LOCK_INIT;
1945 struct unpack_trees_options opts;
1946 struct tree_desc t[1];
1948 if (parse_tree(tree))
1951 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
1953 memset(&opts, 0, sizeof(opts));
1955 opts.src_index = &the_index;
1956 opts.dst_index = &the_index;
1958 opts.fn = oneway_merge;
1959 init_tree_desc(&t[0], tree->buffer, tree->size);
1961 if (unpack_trees(1, t, &opts)) {
1962 rollback_lock_file(&lock_file);
1966 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
1967 die(_("unable to write new index file"));
1973 * Clean the index without touching entries that are not modified between
1974 * `head` and `remote`.
1976 static int clean_index(const struct object_id *head, const struct object_id *remote)
1978 struct tree *head_tree, *remote_tree, *index_tree;
1979 struct object_id index;
1981 head_tree = parse_tree_indirect(head);
1983 return error(_("Could not parse object '%s'."), oid_to_hex(head));
1985 remote_tree = parse_tree_indirect(remote);
1987 return error(_("Could not parse object '%s'."), oid_to_hex(remote));
1989 read_cache_unmerged();
1991 if (fast_forward_to(head_tree, head_tree, 1))
1994 if (write_cache_as_tree(&index, 0, NULL))
1997 index_tree = parse_tree_indirect(&index);
1999 return error(_("Could not parse object '%s'."), oid_to_hex(&index));
2001 if (fast_forward_to(index_tree, remote_tree, 0))
2004 if (merge_tree(remote_tree))
2007 remove_branch_state(the_repository, 0);
2013 * Resets rerere's merge resolution metadata.
2015 static void am_rerere_clear(void)
2017 struct string_list merge_rr = STRING_LIST_INIT_DUP;
2018 rerere_clear(the_repository, &merge_rr);
2019 string_list_clear(&merge_rr, 1);
2023 * Resume the current am session by skipping the current patch.
2025 static void am_skip(struct am_state *state)
2027 struct object_id head;
2031 if (get_oid("HEAD", &head))
2032 oidcpy(&head, the_hash_algo->empty_tree);
2034 if (clean_index(&head, &head))
2035 die(_("failed to clean index"));
2037 if (state->rebasing) {
2038 FILE *fp = xfopen(am_path(state, "rewritten"), "a");
2040 assert(!is_null_oid(&state->orig_commit));
2041 fprintf(fp, "%s ", oid_to_hex(&state->orig_commit));
2042 fprintf(fp, "%s\n", oid_to_hex(&head));
2052 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2054 * It is not safe to reset HEAD when:
2055 * 1. git-am previously failed because the index was dirty.
2056 * 2. HEAD has moved since git-am previously failed.
2058 static int safe_to_abort(const struct am_state *state)
2060 struct strbuf sb = STRBUF_INIT;
2061 struct object_id abort_safety, head;
2063 if (file_exists(am_path(state, "dirtyindex")))
2066 if (read_state_file(&sb, state, "abort-safety", 1) > 0) {
2067 if (get_oid_hex(sb.buf, &abort_safety))
2068 die(_("could not parse %s"), am_path(state, "abort-safety"));
2070 oidclr(&abort_safety);
2071 strbuf_release(&sb);
2073 if (get_oid("HEAD", &head))
2076 if (oideq(&head, &abort_safety))
2079 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2080 "Not rewinding to ORIG_HEAD"));
2086 * Aborts the current am session if it is safe to do so.
2088 static void am_abort(struct am_state *state)
2090 struct object_id curr_head, orig_head;
2091 int has_curr_head, has_orig_head;
2094 if (!safe_to_abort(state)) {
2101 curr_branch = resolve_refdup("HEAD", 0, &curr_head, NULL);
2102 has_curr_head = curr_branch && !is_null_oid(&curr_head);
2104 oidcpy(&curr_head, the_hash_algo->empty_tree);
2106 has_orig_head = !get_oid("ORIG_HEAD", &orig_head);
2108 oidcpy(&orig_head, the_hash_algo->empty_tree);
2110 clean_index(&curr_head, &orig_head);
2113 update_ref("am --abort", "HEAD", &orig_head,
2114 has_curr_head ? &curr_head : NULL, 0,
2115 UPDATE_REFS_DIE_ON_ERR);
2116 else if (curr_branch)
2117 delete_ref(NULL, curr_branch, NULL, REF_NO_DEREF);
2123 static int show_patch(struct am_state *state, enum show_patch_type sub_mode)
2125 struct strbuf sb = STRBUF_INIT;
2126 const char *patch_path;
2129 if (!is_null_oid(&state->orig_commit)) {
2130 const char *av[4] = { "show", NULL, "--", NULL };
2134 av[1] = new_oid_str = xstrdup(oid_to_hex(&state->orig_commit));
2135 ret = run_command_v_opt(av, RUN_GIT_CMD);
2141 case SHOW_PATCH_RAW:
2142 patch_path = am_path(state, msgnum(state));
2144 case SHOW_PATCH_DIFF:
2145 patch_path = am_path(state, "patch");
2148 BUG("invalid mode for --show-current-patch");
2151 len = strbuf_read_file(&sb, patch_path, 0);
2153 die_errno(_("failed to read '%s'"), patch_path);
2156 write_in_full(1, sb.buf, sb.len);
2157 strbuf_release(&sb);
2162 * parse_options() callback that validates and sets opt->value to the
2163 * PATCH_FORMAT_* enum value corresponding to `arg`.
2165 static int parse_opt_patchformat(const struct option *opt, const char *arg, int unset)
2167 int *opt_value = opt->value;
2170 *opt_value = PATCH_FORMAT_UNKNOWN;
2171 else if (!strcmp(arg, "mbox"))
2172 *opt_value = PATCH_FORMAT_MBOX;
2173 else if (!strcmp(arg, "stgit"))
2174 *opt_value = PATCH_FORMAT_STGIT;
2175 else if (!strcmp(arg, "stgit-series"))
2176 *opt_value = PATCH_FORMAT_STGIT_SERIES;
2177 else if (!strcmp(arg, "hg"))
2178 *opt_value = PATCH_FORMAT_HG;
2179 else if (!strcmp(arg, "mboxrd"))
2180 *opt_value = PATCH_FORMAT_MBOXRD;
2182 * Please update $__git_patchformat in git-completion.bash
2183 * when you add new options
2186 return error(_("Invalid value for --patch-format: %s"), arg);
2200 struct resume_mode {
2201 enum resume_type mode;
2202 enum show_patch_type sub_mode;
2205 static int parse_opt_show_current_patch(const struct option *opt, const char *arg, int unset)
2207 int *opt_value = opt->value;
2208 struct resume_mode *resume = container_of(opt_value, struct resume_mode, mode);
2211 * Please update $__git_showcurrentpatch in git-completion.bash
2212 * when you add new options
2214 const char *valid_modes[] = {
2215 [SHOW_PATCH_DIFF] = "diff",
2216 [SHOW_PATCH_RAW] = "raw"
2218 int new_value = SHOW_PATCH_RAW;
2220 BUG_ON_OPT_NEG(unset);
2223 for (new_value = 0; new_value < ARRAY_SIZE(valid_modes); new_value++) {
2224 if (!strcmp(arg, valid_modes[new_value]))
2227 if (new_value >= ARRAY_SIZE(valid_modes))
2228 return error(_("Invalid value for --show-current-patch: %s"), arg);
2231 if (resume->mode == RESUME_SHOW_PATCH && new_value != resume->sub_mode)
2232 return error(_("--show-current-patch=%s is incompatible with "
2233 "--show-current-patch=%s"),
2234 arg, valid_modes[resume->sub_mode]);
2236 resume->mode = RESUME_SHOW_PATCH;
2237 resume->sub_mode = new_value;
2241 static int git_am_config(const char *k, const char *v, void *cb)
2245 status = git_gpg_config(k, v, NULL);
2249 return git_default_config(k, v, NULL);
2252 int cmd_am(int argc, const char **argv, const char *prefix)
2254 struct am_state state;
2257 int patch_format = PATCH_FORMAT_UNKNOWN;
2258 struct resume_mode resume = { .mode = RESUME_FALSE };
2262 const char * const usage[] = {
2263 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2264 N_("git am [<options>] (--continue | --skip | --abort)"),
2268 struct option options[] = {
2269 OPT_BOOL('i', "interactive", &state.interactive,
2270 N_("run interactively")),
2271 OPT_HIDDEN_BOOL('b', "binary", &binary,
2272 N_("historical option -- no-op")),
2273 OPT_BOOL('3', "3way", &state.threeway,
2274 N_("allow fall back on 3way merging if needed")),
2275 OPT__QUIET(&state.quiet, N_("be quiet")),
2276 OPT_SET_INT('s', "signoff", &state.signoff,
2277 N_("add a Signed-off-by trailer to the commit message"),
2279 OPT_BOOL('u', "utf8", &state.utf8,
2280 N_("recode into utf8 (default)")),
2281 OPT_SET_INT('k', "keep", &state.keep,
2282 N_("pass -k flag to git-mailinfo"), KEEP_TRUE),
2283 OPT_SET_INT(0, "keep-non-patch", &state.keep,
2284 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH),
2285 OPT_BOOL('m', "message-id", &state.message_id,
2286 N_("pass -m flag to git-mailinfo")),
2287 OPT_SET_INT_F(0, "keep-cr", &keep_cr,
2288 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2289 1, PARSE_OPT_NONEG),
2290 OPT_SET_INT_F(0, "no-keep-cr", &keep_cr,
2291 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2292 0, PARSE_OPT_NONEG),
2293 OPT_BOOL('c', "scissors", &state.scissors,
2294 N_("strip everything before a scissors line")),
2295 OPT_CALLBACK_F(0, "quoted-cr", &state.quoted_cr, N_("action"),
2296 N_("pass it through git-mailinfo"),
2297 PARSE_OPT_NONEG, am_option_parse_quoted_cr),
2298 OPT_PASSTHRU_ARGV(0, "whitespace", &state.git_apply_opts, N_("action"),
2299 N_("pass it through git-apply"),
2301 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state.git_apply_opts, NULL,
2302 N_("pass it through git-apply"),
2304 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state.git_apply_opts, NULL,
2305 N_("pass it through git-apply"),
2307 OPT_PASSTHRU_ARGV(0, "directory", &state.git_apply_opts, N_("root"),
2308 N_("pass it through git-apply"),
2310 OPT_PASSTHRU_ARGV(0, "exclude", &state.git_apply_opts, N_("path"),
2311 N_("pass it through git-apply"),
2313 OPT_PASSTHRU_ARGV(0, "include", &state.git_apply_opts, N_("path"),
2314 N_("pass it through git-apply"),
2316 OPT_PASSTHRU_ARGV('C', NULL, &state.git_apply_opts, N_("n"),
2317 N_("pass it through git-apply"),
2319 OPT_PASSTHRU_ARGV('p', NULL, &state.git_apply_opts, N_("num"),
2320 N_("pass it through git-apply"),
2322 OPT_CALLBACK(0, "patch-format", &patch_format, N_("format"),
2323 N_("format the patch(es) are in"),
2324 parse_opt_patchformat),
2325 OPT_PASSTHRU_ARGV(0, "reject", &state.git_apply_opts, NULL,
2326 N_("pass it through git-apply"),
2328 OPT_STRING(0, "resolvemsg", &state.resolvemsg, NULL,
2329 N_("override error message when patch failure occurs")),
2330 OPT_CMDMODE(0, "continue", &resume.mode,
2331 N_("continue applying patches after resolving a conflict"),
2333 OPT_CMDMODE('r', "resolved", &resume.mode,
2334 N_("synonyms for --continue"),
2336 OPT_CMDMODE(0, "skip", &resume.mode,
2337 N_("skip the current patch"),
2339 OPT_CMDMODE(0, "abort", &resume.mode,
2340 N_("restore the original branch and abort the patching operation"),
2342 OPT_CMDMODE(0, "quit", &resume.mode,
2343 N_("abort the patching operation but keep HEAD where it is"),
2345 { OPTION_CALLBACK, 0, "show-current-patch", &resume.mode,
2347 N_("show the patch being applied"),
2348 PARSE_OPT_CMDMODE | PARSE_OPT_OPTARG | PARSE_OPT_NONEG | PARSE_OPT_LITERAL_ARGHELP,
2349 parse_opt_show_current_patch, RESUME_SHOW_PATCH },
2350 OPT_BOOL(0, "committer-date-is-author-date",
2351 &state.committer_date_is_author_date,
2352 N_("lie about committer date")),
2353 OPT_BOOL(0, "ignore-date", &state.ignore_date,
2354 N_("use current timestamp for author date")),
2355 OPT_RERERE_AUTOUPDATE(&state.allow_rerere_autoupdate),
2356 { OPTION_STRING, 'S', "gpg-sign", &state.sign_commit, N_("key-id"),
2357 N_("GPG-sign commits"),
2358 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
2359 OPT_HIDDEN_BOOL(0, "rebasing", &state.rebasing,
2360 N_("(internal use for git-rebase)")),
2364 if (argc == 2 && !strcmp(argv[1], "-h"))
2365 usage_with_options(usage, options);
2367 git_config(git_am_config, NULL);
2369 am_state_init(&state);
2371 in_progress = am_in_progress(&state);
2375 argc = parse_options(argc, argv, prefix, options, usage, 0);
2378 fprintf_ln(stderr, _("The -b/--binary option has been a no-op for long time, and\n"
2379 "it will be removed. Please do not use it anymore."));
2381 /* Ensure a valid committer ident can be constructed */
2382 git_committer_info(IDENT_STRICT);
2384 if (repo_read_index_preload(the_repository, NULL, 0) < 0)
2385 die(_("failed to read the index"));
2389 * Catch user error to feed us patches when there is a session
2392 * 1. mbox path(s) are provided on the command-line.
2393 * 2. stdin is not a tty: the user is trying to feed us a patch
2394 * from standard input. This is somewhat unreliable -- stdin
2395 * could be /dev/null for example and the caller did not
2396 * intend to feed us a patch but wanted to continue
2399 if (argc || (resume.mode == RESUME_FALSE && !isatty(0)))
2400 die(_("previous rebase directory %s still exists but mbox given."),
2403 if (resume.mode == RESUME_FALSE)
2404 resume.mode = RESUME_APPLY;
2406 if (state.signoff == SIGNOFF_EXPLICIT)
2407 am_append_signoff(&state);
2409 struct strvec paths = STRVEC_INIT;
2413 * Handle stray state directory in the independent-run case. In
2414 * the --rebasing case, it is up to the caller to take care of
2415 * stray directories.
2417 if (file_exists(state.dir) && !state.rebasing) {
2418 if (resume.mode == RESUME_ABORT || resume.mode == RESUME_QUIT) {
2420 am_state_release(&state);
2424 die(_("Stray %s directory found.\n"
2425 "Use \"git am --abort\" to remove it."),
2430 die(_("Resolve operation not in progress, we are not resuming."));
2432 for (i = 0; i < argc; i++) {
2433 if (is_absolute_path(argv[i]) || !prefix)
2434 strvec_push(&paths, argv[i]);
2436 strvec_push(&paths, mkpath("%s/%s", prefix, argv[i]));
2439 if (state.interactive && !paths.nr)
2440 die(_("interactive mode requires patches on the command line"));
2442 am_setup(&state, patch_format, paths.v, keep_cr);
2444 strvec_clear(&paths);
2447 switch (resume.mode) {
2454 case RESUME_RESOLVED:
2467 case RESUME_SHOW_PATCH:
2468 ret = show_patch(&state, resume.sub_mode);
2471 BUG("invalid resume value");
2474 am_state_release(&state);