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"
17 #include "cache-tree.h"
22 #include "unpack-trees.h"
24 #include "sequencer.h"
26 #include "merge-recursive.h"
28 #include "notes-utils.h"
33 #include "string-list.h"
35 #include "repository.h"
38 * Returns the length of the first line of msg.
40 static int linelen(const char *msg)
42 return strchrnul(msg, '\n') - msg;
46 * Returns true if `str` consists of only whitespace, false otherwise.
48 static int str_isspace(const char *str)
58 PATCH_FORMAT_UNKNOWN = 0,
61 PATCH_FORMAT_STGIT_SERIES,
68 KEEP_TRUE, /* pass -k flag to git-mailinfo */
69 KEEP_NON_PATCH /* pass -b flag to git-mailinfo */
74 SCISSORS_FALSE = 0, /* pass --no-scissors to git-mailinfo */
75 SCISSORS_TRUE /* pass --scissors to git-mailinfo */
81 SIGNOFF_EXPLICIT /* --signoff was set on the command-line */
84 enum show_patch_type {
90 /* state directory path */
93 /* current and last patch numbers, 1-indexed */
97 /* commit metadata and message */
104 /* when --rebasing, records the original commit the patch came from */
105 struct object_id orig_commit;
107 /* number of digits in patch filename */
110 /* various operating modes and command line options */
114 int signoff; /* enum signoff_type */
116 int keep; /* enum keep_type */
118 int scissors; /* enum scissors_type */
119 int quoted_cr; /* enum quoted_cr_action */
120 struct strvec git_apply_opts;
121 const char *resolvemsg;
122 int committer_date_is_author_date;
124 int allow_rerere_autoupdate;
125 const char *sign_commit;
130 * Initializes am_state with the default values.
132 static void am_state_init(struct am_state *state)
136 memset(state, 0, sizeof(*state));
138 state->dir = git_pathdup("rebase-apply");
142 git_config_get_bool("am.threeway", &state->threeway);
146 git_config_get_bool("am.messageid", &state->message_id);
148 state->scissors = SCISSORS_UNSET;
149 state->quoted_cr = quoted_cr_unset;
151 strvec_init(&state->git_apply_opts);
153 if (!git_config_get_bool("commit.gpgsign", &gpgsign))
154 state->sign_commit = gpgsign ? "" : NULL;
158 * Releases memory allocated by an am_state.
160 static void am_state_release(struct am_state *state)
163 free(state->author_name);
164 free(state->author_email);
165 free(state->author_date);
167 strvec_clear(&state->git_apply_opts);
170 static int am_option_parse_quoted_cr(const struct option *opt,
171 const char *arg, int unset)
173 BUG_ON_OPT_NEG(unset);
175 if (mailinfo_parse_quoted_cr_action(arg, opt->value) != 0)
176 return error(_("bad action '%s' for '%s'"), arg, "--quoted-cr");
181 * Returns path relative to the am_state directory.
183 static inline const char *am_path(const struct am_state *state, const char *path)
185 return mkpath("%s/%s", state->dir, path);
189 * For convenience to call write_file()
191 static void write_state_text(const struct am_state *state,
192 const char *name, const char *string)
194 write_file(am_path(state, name), "%s", string);
197 static void write_state_count(const struct am_state *state,
198 const char *name, int value)
200 write_file(am_path(state, name), "%d", value);
203 static void write_state_bool(const struct am_state *state,
204 const char *name, int value)
206 write_state_text(state, name, value ? "t" : "f");
210 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
213 static void say(const struct am_state *state, FILE *fp, const char *fmt, ...)
219 vfprintf(fp, fmt, ap);
226 * Returns 1 if there is an am session in progress, 0 otherwise.
228 static int am_in_progress(const struct am_state *state)
232 if (lstat(state->dir, &st) < 0 || !S_ISDIR(st.st_mode))
234 if (lstat(am_path(state, "last"), &st) || !S_ISREG(st.st_mode))
236 if (lstat(am_path(state, "next"), &st) || !S_ISREG(st.st_mode))
242 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
243 * number of bytes read on success, -1 if the file does not exist. If `trim` is
244 * set, trailing whitespace will be removed.
246 static int read_state_file(struct strbuf *sb, const struct am_state *state,
247 const char *file, int trim)
251 if (strbuf_read_file(sb, am_path(state, file), 0) >= 0) {
261 die_errno(_("could not read '%s'"), am_path(state, file));
265 * Reads and parses the state directory's "author-script" file, and sets
266 * state->author_name, state->author_email and state->author_date accordingly.
267 * Returns 0 on success, -1 if the file could not be parsed.
269 * The author script is of the format:
271 * GIT_AUTHOR_NAME='$author_name'
272 * GIT_AUTHOR_EMAIL='$author_email'
273 * GIT_AUTHOR_DATE='$author_date'
275 * where $author_name, $author_email and $author_date are quoted. We are strict
276 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
277 * script, and thus if the file differs from what this function expects, it is
278 * better to bail out than to do something that the user does not expect.
280 static int read_am_author_script(struct am_state *state)
282 const char *filename = am_path(state, "author-script");
284 assert(!state->author_name);
285 assert(!state->author_email);
286 assert(!state->author_date);
288 return read_author_script(filename, &state->author_name,
289 &state->author_email, &state->author_date, 1);
293 * Saves state->author_name, state->author_email and state->author_date in the
294 * state directory's "author-script" file.
296 static void write_author_script(const struct am_state *state)
298 struct strbuf sb = STRBUF_INIT;
300 strbuf_addstr(&sb, "GIT_AUTHOR_NAME=");
301 sq_quote_buf(&sb, state->author_name);
302 strbuf_addch(&sb, '\n');
304 strbuf_addstr(&sb, "GIT_AUTHOR_EMAIL=");
305 sq_quote_buf(&sb, state->author_email);
306 strbuf_addch(&sb, '\n');
308 strbuf_addstr(&sb, "GIT_AUTHOR_DATE=");
309 sq_quote_buf(&sb, state->author_date);
310 strbuf_addch(&sb, '\n');
312 write_state_text(state, "author-script", sb.buf);
318 * Reads the commit message from the state directory's "final-commit" file,
319 * setting state->msg to its contents and state->msg_len to the length of its
322 * Returns 0 on success, -1 if the file does not exist.
324 static int read_commit_msg(struct am_state *state)
326 struct strbuf sb = STRBUF_INIT;
330 if (read_state_file(&sb, state, "final-commit", 0) < 0) {
335 state->msg = strbuf_detach(&sb, &state->msg_len);
340 * Saves state->msg in the state directory's "final-commit" file.
342 static void write_commit_msg(const struct am_state *state)
344 const char *filename = am_path(state, "final-commit");
345 write_file_buf(filename, state->msg, state->msg_len);
349 * Loads state from disk.
351 static void am_load(struct am_state *state)
353 struct strbuf sb = STRBUF_INIT;
355 if (read_state_file(&sb, state, "next", 1) < 0)
356 BUG("state file 'next' does not exist");
357 state->cur = strtol(sb.buf, NULL, 10);
359 if (read_state_file(&sb, state, "last", 1) < 0)
360 BUG("state file 'last' does not exist");
361 state->last = strtol(sb.buf, NULL, 10);
363 if (read_am_author_script(state) < 0)
364 die(_("could not parse author script"));
366 read_commit_msg(state);
368 if (read_state_file(&sb, state, "original-commit", 1) < 0)
369 oidclr(&state->orig_commit);
370 else if (get_oid_hex(sb.buf, &state->orig_commit) < 0)
371 die(_("could not parse %s"), am_path(state, "original-commit"));
373 read_state_file(&sb, state, "threeway", 1);
374 state->threeway = !strcmp(sb.buf, "t");
376 read_state_file(&sb, state, "quiet", 1);
377 state->quiet = !strcmp(sb.buf, "t");
379 read_state_file(&sb, state, "sign", 1);
380 state->signoff = !strcmp(sb.buf, "t");
382 read_state_file(&sb, state, "utf8", 1);
383 state->utf8 = !strcmp(sb.buf, "t");
385 if (file_exists(am_path(state, "rerere-autoupdate"))) {
386 read_state_file(&sb, state, "rerere-autoupdate", 1);
387 state->allow_rerere_autoupdate = strcmp(sb.buf, "t") ?
388 RERERE_NOAUTOUPDATE : RERERE_AUTOUPDATE;
390 state->allow_rerere_autoupdate = 0;
393 read_state_file(&sb, state, "keep", 1);
394 if (!strcmp(sb.buf, "t"))
395 state->keep = KEEP_TRUE;
396 else if (!strcmp(sb.buf, "b"))
397 state->keep = KEEP_NON_PATCH;
399 state->keep = KEEP_FALSE;
401 read_state_file(&sb, state, "messageid", 1);
402 state->message_id = !strcmp(sb.buf, "t");
404 read_state_file(&sb, state, "scissors", 1);
405 if (!strcmp(sb.buf, "t"))
406 state->scissors = SCISSORS_TRUE;
407 else if (!strcmp(sb.buf, "f"))
408 state->scissors = SCISSORS_FALSE;
410 state->scissors = SCISSORS_UNSET;
412 read_state_file(&sb, state, "quoted-cr", 1);
414 state->quoted_cr = quoted_cr_unset;
415 else if (mailinfo_parse_quoted_cr_action(sb.buf, &state->quoted_cr) != 0)
416 die(_("could not parse %s"), am_path(state, "quoted-cr"));
418 read_state_file(&sb, state, "apply-opt", 1);
419 strvec_clear(&state->git_apply_opts);
420 if (sq_dequote_to_strvec(sb.buf, &state->git_apply_opts) < 0)
421 die(_("could not parse %s"), am_path(state, "apply-opt"));
423 state->rebasing = !!file_exists(am_path(state, "rebasing"));
429 * Removes the am_state directory, forcefully terminating the current am
432 static void am_destroy(const struct am_state *state)
434 struct strbuf sb = STRBUF_INIT;
436 strbuf_addstr(&sb, state->dir);
437 remove_dir_recursively(&sb, 0);
442 * Runs applypatch-msg hook. Returns its exit code.
444 static int run_applypatch_msg_hook(struct am_state *state)
449 ret = run_hook_le(NULL, "applypatch-msg", am_path(state, "final-commit"), NULL);
452 FREE_AND_NULL(state->msg);
453 if (read_commit_msg(state) < 0)
454 die(_("'%s' was deleted by the applypatch-msg hook"),
455 am_path(state, "final-commit"));
462 * Runs post-rewrite hook. Returns it exit code.
464 static int run_post_rewrite_hook(const struct am_state *state)
466 struct child_process cp = CHILD_PROCESS_INIT;
467 const char *hook = find_hook("post-rewrite");
473 strvec_push(&cp.args, hook);
474 strvec_push(&cp.args, "rebase");
476 cp.in = xopen(am_path(state, "rewritten"), O_RDONLY);
477 cp.stdout_to_stderr = 1;
478 cp.trace2_hook_name = "post-rewrite";
480 ret = run_command(&cp);
487 * Reads the state directory's "rewritten" file, and copies notes from the old
488 * commits listed in the file to their rewritten commits.
490 * Returns 0 on success, -1 on failure.
492 static int copy_notes_for_rebase(const struct am_state *state)
494 struct notes_rewrite_cfg *c;
495 struct strbuf sb = STRBUF_INIT;
496 const char *invalid_line = _("Malformed input line: '%s'.");
497 const char *msg = "Notes added by 'git rebase'";
501 assert(state->rebasing);
503 c = init_copy_notes_for_rewrite("rebase");
507 fp = xfopen(am_path(state, "rewritten"), "r");
509 while (!strbuf_getline_lf(&sb, fp)) {
510 struct object_id from_obj, to_obj;
513 if (sb.len != the_hash_algo->hexsz * 2 + 1) {
514 ret = error(invalid_line, sb.buf);
518 if (parse_oid_hex(sb.buf, &from_obj, &p)) {
519 ret = error(invalid_line, sb.buf);
524 ret = error(invalid_line, sb.buf);
528 if (get_oid_hex(p + 1, &to_obj)) {
529 ret = error(invalid_line, sb.buf);
533 if (copy_note_for_rewrite(c, &from_obj, &to_obj))
534 ret = error(_("Failed to copy notes from '%s' to '%s'"),
535 oid_to_hex(&from_obj), oid_to_hex(&to_obj));
539 finish_copy_notes_for_rewrite(the_repository, c, msg);
546 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
547 * non-indented lines and checking if they look like they begin with valid
548 * header field names.
550 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
552 static int is_mail(FILE *fp)
554 const char *header_regex = "^[!-9;-~]+:";
555 struct strbuf sb = STRBUF_INIT;
559 if (fseek(fp, 0L, SEEK_SET))
560 die_errno(_("fseek failed"));
562 if (regcomp(®ex, header_regex, REG_NOSUB | REG_EXTENDED))
563 die("invalid pattern: %s", header_regex);
565 while (!strbuf_getline(&sb, fp)) {
567 break; /* End of header */
569 /* Ignore indented folded lines */
570 if (*sb.buf == '\t' || *sb.buf == ' ')
573 /* It's a header if it matches header_regex */
574 if (regexec(®ex, sb.buf, 0, NULL, 0)) {
587 * Attempts to detect the patch_format of the patches contained in `paths`,
588 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
591 static int detect_patch_format(const char **paths)
593 enum patch_format ret = PATCH_FORMAT_UNKNOWN;
594 struct strbuf l1 = STRBUF_INIT;
595 struct strbuf l2 = STRBUF_INIT;
596 struct strbuf l3 = STRBUF_INIT;
600 * We default to mbox format if input is from stdin and for directories
602 if (!*paths || !strcmp(*paths, "-") || is_directory(*paths))
603 return PATCH_FORMAT_MBOX;
606 * Otherwise, check the first few lines of the first patch, starting
607 * from the first non-blank line, to try to detect its format.
610 fp = xfopen(*paths, "r");
612 while (!strbuf_getline(&l1, fp)) {
617 if (starts_with(l1.buf, "From ") || starts_with(l1.buf, "From: ")) {
618 ret = PATCH_FORMAT_MBOX;
622 if (starts_with(l1.buf, "# This series applies on GIT commit")) {
623 ret = PATCH_FORMAT_STGIT_SERIES;
627 if (!strcmp(l1.buf, "# HG changeset patch")) {
628 ret = PATCH_FORMAT_HG;
632 strbuf_getline(&l2, fp);
633 strbuf_getline(&l3, fp);
636 * If the second line is empty and the third is a From, Author or Date
637 * entry, this is likely an StGit patch.
639 if (l1.len && !l2.len &&
640 (starts_with(l3.buf, "From:") ||
641 starts_with(l3.buf, "Author:") ||
642 starts_with(l3.buf, "Date:"))) {
643 ret = PATCH_FORMAT_STGIT;
647 if (l1.len && is_mail(fp)) {
648 ret = PATCH_FORMAT_MBOX;
661 * Splits out individual email patches from `paths`, where each path is either
662 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
664 static int split_mail_mbox(struct am_state *state, const char **paths,
665 int keep_cr, int mboxrd)
667 struct child_process cp = CHILD_PROCESS_INIT;
668 struct strbuf last = STRBUF_INIT;
672 strvec_push(&cp.args, "mailsplit");
673 strvec_pushf(&cp.args, "-d%d", state->prec);
674 strvec_pushf(&cp.args, "-o%s", state->dir);
675 strvec_push(&cp.args, "-b");
677 strvec_push(&cp.args, "--keep-cr");
679 strvec_push(&cp.args, "--mboxrd");
680 strvec_push(&cp.args, "--");
681 strvec_pushv(&cp.args, paths);
683 ret = capture_command(&cp, &last, 8);
688 state->last = strtol(last.buf, NULL, 10);
691 strbuf_release(&last);
696 * Callback signature for split_mail_conv(). The foreign patch should be
697 * read from `in`, and the converted patch (in RFC2822 mail format) should be
698 * written to `out`. Return 0 on success, or -1 on failure.
700 typedef int (*mail_conv_fn)(FILE *out, FILE *in, int keep_cr);
703 * Calls `fn` for each file in `paths` to convert the foreign patch to the
704 * RFC2822 mail format suitable for parsing with git-mailinfo.
706 * Returns 0 on success, -1 on failure.
708 static int split_mail_conv(mail_conv_fn fn, struct am_state *state,
709 const char **paths, int keep_cr)
711 static const char *stdin_only[] = {"-", NULL};
717 for (i = 0; *paths; paths++, i++) {
722 if (!strcmp(*paths, "-"))
725 in = fopen(*paths, "r");
728 return error_errno(_("could not open '%s' for reading"),
731 mail = mkpath("%s/%0*d", state->dir, state->prec, i + 1);
733 out = fopen(mail, "w");
737 return error_errno(_("could not open '%s' for writing"),
741 ret = fn(out, in, keep_cr);
748 return error(_("could not parse patch '%s'"), *paths);
757 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
758 * message suitable for parsing with git-mailinfo.
760 static int stgit_patch_to_mail(FILE *out, FILE *in, int keep_cr)
762 struct strbuf sb = STRBUF_INIT;
763 int subject_printed = 0;
765 while (!strbuf_getline_lf(&sb, in)) {
768 if (str_isspace(sb.buf))
770 else if (skip_prefix(sb.buf, "Author:", &str))
771 fprintf(out, "From:%s\n", str);
772 else if (starts_with(sb.buf, "From") || starts_with(sb.buf, "Date"))
773 fprintf(out, "%s\n", sb.buf);
774 else if (!subject_printed) {
775 fprintf(out, "Subject: %s\n", sb.buf);
778 fprintf(out, "\n%s\n", sb.buf);
784 while (strbuf_fread(&sb, 8192, in) > 0) {
785 fwrite(sb.buf, 1, sb.len, out);
794 * This function only supports a single StGit series file in `paths`.
796 * Given an StGit series file, converts the StGit patches in the series into
797 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
798 * the state directory.
800 * Returns 0 on success, -1 on failure.
802 static int split_mail_stgit_series(struct am_state *state, const char **paths,
805 const char *series_dir;
806 char *series_dir_buf;
808 struct strvec patches = STRVEC_INIT;
809 struct strbuf sb = STRBUF_INIT;
812 if (!paths[0] || paths[1])
813 return error(_("Only one StGIT patch series can be applied at once"));
815 series_dir_buf = xstrdup(*paths);
816 series_dir = dirname(series_dir_buf);
818 fp = fopen(*paths, "r");
820 return error_errno(_("could not open '%s' for reading"), *paths);
822 while (!strbuf_getline_lf(&sb, fp)) {
824 continue; /* skip comment lines */
826 strvec_push(&patches, mkpath("%s/%s", series_dir, sb.buf));
831 free(series_dir_buf);
833 ret = split_mail_conv(stgit_patch_to_mail, state, patches.v, keep_cr);
835 strvec_clear(&patches);
840 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
841 * message suitable for parsing with git-mailinfo.
843 static int hg_patch_to_mail(FILE *out, FILE *in, int keep_cr)
845 struct strbuf sb = STRBUF_INIT;
848 while (!strbuf_getline_lf(&sb, in)) {
851 if (skip_prefix(sb.buf, "# User ", &str))
852 fprintf(out, "From: %s\n", str);
853 else if (skip_prefix(sb.buf, "# Date ", &str)) {
854 timestamp_t timestamp;
859 timestamp = parse_timestamp(str, &end, 10);
861 rc = error(_("invalid timestamp"));
865 if (!skip_prefix(end, " ", &str)) {
866 rc = error(_("invalid Date line"));
871 tz = strtol(str, &end, 10);
873 rc = error(_("invalid timezone offset"));
878 rc = error(_("invalid Date line"));
883 * mercurial's timezone is in seconds west of UTC,
884 * however git's timezone is in hours + minutes east of
887 tz2 = labs(tz) / 3600 * 100 + labs(tz) % 3600 / 60;
891 fprintf(out, "Date: %s\n", show_date(timestamp, tz2, DATE_MODE(RFC2822)));
892 } else if (starts_with(sb.buf, "# ")) {
895 fprintf(out, "\n%s\n", sb.buf);
901 while (strbuf_fread(&sb, 8192, in) > 0) {
902 fwrite(sb.buf, 1, sb.len, out);
911 * Splits a list of files/directories into individual email patches. Each path
912 * in `paths` must be a file/directory that is formatted according to
915 * Once split out, the individual email patches will be stored in the state
916 * directory, with each patch's filename being its index, padded to state->prec
919 * state->cur will be set to the index of the first mail, and state->last will
920 * be set to the index of the last mail.
922 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
923 * to disable this behavior, -1 to use the default configured setting.
925 * Returns 0 on success, -1 on failure.
927 static int split_mail(struct am_state *state, enum patch_format patch_format,
928 const char **paths, int keep_cr)
932 git_config_get_bool("am.keepcr", &keep_cr);
935 switch (patch_format) {
936 case PATCH_FORMAT_MBOX:
937 return split_mail_mbox(state, paths, keep_cr, 0);
938 case PATCH_FORMAT_STGIT:
939 return split_mail_conv(stgit_patch_to_mail, state, paths, keep_cr);
940 case PATCH_FORMAT_STGIT_SERIES:
941 return split_mail_stgit_series(state, paths, keep_cr);
942 case PATCH_FORMAT_HG:
943 return split_mail_conv(hg_patch_to_mail, state, paths, keep_cr);
944 case PATCH_FORMAT_MBOXRD:
945 return split_mail_mbox(state, paths, keep_cr, 1);
947 BUG("invalid patch_format");
953 * Setup a new am session for applying patches
955 static void am_setup(struct am_state *state, enum patch_format patch_format,
956 const char **paths, int keep_cr)
958 struct object_id curr_head;
960 struct strbuf sb = STRBUF_INIT;
963 patch_format = detect_patch_format(paths);
966 fprintf_ln(stderr, _("Patch format detection failed."));
970 if (mkdir(state->dir, 0777) < 0 && errno != EEXIST)
971 die_errno(_("failed to create directory '%s'"), state->dir);
972 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
974 if (split_mail(state, patch_format, paths, keep_cr) < 0) {
976 die(_("Failed to split patches."));
982 write_state_bool(state, "threeway", state->threeway);
983 write_state_bool(state, "quiet", state->quiet);
984 write_state_bool(state, "sign", state->signoff);
985 write_state_bool(state, "utf8", state->utf8);
987 if (state->allow_rerere_autoupdate)
988 write_state_bool(state, "rerere-autoupdate",
989 state->allow_rerere_autoupdate == RERERE_AUTOUPDATE);
991 switch (state->keep) {
1002 BUG("invalid value for state->keep");
1005 write_state_text(state, "keep", str);
1006 write_state_bool(state, "messageid", state->message_id);
1008 switch (state->scissors) {
1009 case SCISSORS_UNSET:
1012 case SCISSORS_FALSE:
1019 BUG("invalid value for state->scissors");
1021 write_state_text(state, "scissors", str);
1023 switch (state->quoted_cr) {
1024 case quoted_cr_unset:
1027 case quoted_cr_nowarn:
1030 case quoted_cr_warn:
1033 case quoted_cr_strip:
1037 BUG("invalid value for state->quoted_cr");
1039 write_state_text(state, "quoted-cr", str);
1041 sq_quote_argv(&sb, state->git_apply_opts.v);
1042 write_state_text(state, "apply-opt", sb.buf);
1044 if (state->rebasing)
1045 write_state_text(state, "rebasing", "");
1047 write_state_text(state, "applying", "");
1049 if (!get_oid("HEAD", &curr_head)) {
1050 write_state_text(state, "abort-safety", oid_to_hex(&curr_head));
1051 if (!state->rebasing)
1052 update_ref("am", "ORIG_HEAD", &curr_head, NULL, 0,
1053 UPDATE_REFS_DIE_ON_ERR);
1055 write_state_text(state, "abort-safety", "");
1056 if (!state->rebasing)
1057 delete_ref(NULL, "ORIG_HEAD", NULL, 0);
1061 * NOTE: Since the "next" and "last" files determine if an am_state
1062 * session is in progress, they should be written last.
1065 write_state_count(state, "next", state->cur);
1066 write_state_count(state, "last", state->last);
1068 strbuf_release(&sb);
1072 * Increments the patch pointer, and cleans am_state for the application of the
1075 static void am_next(struct am_state *state)
1077 struct object_id head;
1079 FREE_AND_NULL(state->author_name);
1080 FREE_AND_NULL(state->author_email);
1081 FREE_AND_NULL(state->author_date);
1082 FREE_AND_NULL(state->msg);
1085 unlink(am_path(state, "author-script"));
1086 unlink(am_path(state, "final-commit"));
1088 oidclr(&state->orig_commit);
1089 unlink(am_path(state, "original-commit"));
1090 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
1092 if (!get_oid("HEAD", &head))
1093 write_state_text(state, "abort-safety", oid_to_hex(&head));
1095 write_state_text(state, "abort-safety", "");
1098 write_state_count(state, "next", state->cur);
1102 * Returns the filename of the current patch email.
1104 static const char *msgnum(const struct am_state *state)
1106 static struct strbuf sb = STRBUF_INIT;
1109 strbuf_addf(&sb, "%0*d", state->prec, state->cur);
1115 * Dies with a user-friendly message on how to proceed after resolving the
1116 * problem. This message can be overridden with state->resolvemsg.
1118 static void NORETURN die_user_resolve(const struct am_state *state)
1120 if (state->resolvemsg) {
1121 printf_ln("%s", state->resolvemsg);
1123 const char *cmdline = state->interactive ? "git am -i" : "git am";
1125 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline);
1126 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline);
1127 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline);
1134 * Appends signoff to the "msg" field of the am_state.
1136 static void am_append_signoff(struct am_state *state)
1138 struct strbuf sb = STRBUF_INIT;
1140 strbuf_attach(&sb, state->msg, state->msg_len, state->msg_len);
1141 append_signoff(&sb, 0, 0);
1142 state->msg = strbuf_detach(&sb, &state->msg_len);
1146 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1147 * state->msg will be set to the patch message. state->author_name,
1148 * state->author_email and state->author_date will be set to the patch author's
1149 * name, email and date respectively. The patch body will be written to the
1150 * state directory's "patch" file.
1152 * Returns 1 if the patch should be skipped, 0 otherwise.
1154 static int parse_mail(struct am_state *state, const char *mail)
1157 struct strbuf sb = STRBUF_INIT;
1158 struct strbuf msg = STRBUF_INIT;
1159 struct strbuf author_name = STRBUF_INIT;
1160 struct strbuf author_date = STRBUF_INIT;
1161 struct strbuf author_email = STRBUF_INIT;
1165 setup_mailinfo(&mi);
1168 mi.metainfo_charset = get_commit_output_encoding();
1170 mi.metainfo_charset = NULL;
1172 switch (state->keep) {
1176 mi.keep_subject = 1;
1178 case KEEP_NON_PATCH:
1179 mi.keep_non_patch_brackets_in_subject = 1;
1182 BUG("invalid value for state->keep");
1185 if (state->message_id)
1186 mi.add_message_id = 1;
1188 switch (state->scissors) {
1189 case SCISSORS_UNSET:
1191 case SCISSORS_FALSE:
1192 mi.use_scissors = 0;
1195 mi.use_scissors = 1;
1198 BUG("invalid value for state->scissors");
1201 switch (state->quoted_cr) {
1202 case quoted_cr_unset:
1204 case quoted_cr_nowarn:
1205 case quoted_cr_warn:
1206 case quoted_cr_strip:
1207 mi.quoted_cr = state->quoted_cr;
1210 BUG("invalid value for state->quoted_cr");
1213 mi.input = xfopen(mail, "r");
1214 mi.output = xfopen(am_path(state, "info"), "w");
1215 if (mailinfo(&mi, am_path(state, "msg"), am_path(state, "patch")))
1216 die("could not parse patch");
1221 if (mi.format_flowed)
1222 warning(_("Patch sent with format=flowed; "
1223 "space at the end of lines might be lost."));
1225 /* Extract message and author information */
1226 fp = xfopen(am_path(state, "info"), "r");
1227 while (!strbuf_getline_lf(&sb, fp)) {
1230 if (skip_prefix(sb.buf, "Subject: ", &x)) {
1232 strbuf_addch(&msg, '\n');
1233 strbuf_addstr(&msg, x);
1234 } else if (skip_prefix(sb.buf, "Author: ", &x))
1235 strbuf_addstr(&author_name, x);
1236 else if (skip_prefix(sb.buf, "Email: ", &x))
1237 strbuf_addstr(&author_email, x);
1238 else if (skip_prefix(sb.buf, "Date: ", &x))
1239 strbuf_addstr(&author_date, x);
1243 /* Skip pine's internal folder data */
1244 if (!strcmp(author_name.buf, "Mail System Internal Data")) {
1249 if (is_empty_or_missing_file(am_path(state, "patch"))) {
1250 printf_ln(_("Patch is empty."));
1251 die_user_resolve(state);
1254 strbuf_addstr(&msg, "\n\n");
1255 strbuf_addbuf(&msg, &mi.log_message);
1256 strbuf_stripspace(&msg, 0);
1258 assert(!state->author_name);
1259 state->author_name = strbuf_detach(&author_name, NULL);
1261 assert(!state->author_email);
1262 state->author_email = strbuf_detach(&author_email, NULL);
1264 assert(!state->author_date);
1265 state->author_date = strbuf_detach(&author_date, NULL);
1267 assert(!state->msg);
1268 state->msg = strbuf_detach(&msg, &state->msg_len);
1271 strbuf_release(&msg);
1272 strbuf_release(&author_date);
1273 strbuf_release(&author_email);
1274 strbuf_release(&author_name);
1275 strbuf_release(&sb);
1276 clear_mailinfo(&mi);
1281 * Sets commit_id to the commit hash where the mail was generated from.
1282 * Returns 0 on success, -1 on failure.
1284 static int get_mail_commit_oid(struct object_id *commit_id, const char *mail)
1286 struct strbuf sb = STRBUF_INIT;
1287 FILE *fp = xfopen(mail, "r");
1291 if (strbuf_getline_lf(&sb, fp) ||
1292 !skip_prefix(sb.buf, "From ", &x) ||
1293 get_oid_hex(x, commit_id) < 0)
1296 strbuf_release(&sb);
1302 * Sets state->msg, state->author_name, state->author_email, state->author_date
1303 * to the commit's respective info.
1305 static void get_commit_info(struct am_state *state, struct commit *commit)
1307 const char *buffer, *ident_line, *msg;
1309 struct ident_split id;
1311 buffer = logmsg_reencode(commit, NULL, get_commit_output_encoding());
1313 ident_line = find_commit_header(buffer, "author", &ident_len);
1315 die(_("missing author line in commit %s"),
1316 oid_to_hex(&commit->object.oid));
1317 if (split_ident_line(&id, ident_line, ident_len) < 0)
1318 die(_("invalid ident line: %.*s"), (int)ident_len, ident_line);
1320 assert(!state->author_name);
1322 state->author_name =
1323 xmemdupz(id.name_begin, id.name_end - id.name_begin);
1325 state->author_name = xstrdup("");
1327 assert(!state->author_email);
1329 state->author_email =
1330 xmemdupz(id.mail_begin, id.mail_end - id.mail_begin);
1332 state->author_email = xstrdup("");
1334 assert(!state->author_date);
1335 state->author_date = xstrdup(show_ident_date(&id, DATE_MODE(NORMAL)));
1337 assert(!state->msg);
1338 msg = strstr(buffer, "\n\n");
1340 die(_("unable to parse commit %s"), oid_to_hex(&commit->object.oid));
1341 state->msg = xstrdup(msg + 2);
1342 state->msg_len = strlen(state->msg);
1343 unuse_commit_buffer(commit, buffer);
1347 * Writes `commit` as a patch to the state directory's "patch" file.
1349 static void write_commit_patch(const struct am_state *state, struct commit *commit)
1351 struct rev_info rev_info;
1354 fp = xfopen(am_path(state, "patch"), "w");
1355 repo_init_revisions(the_repository, &rev_info, NULL);
1357 rev_info.abbrev = 0;
1358 rev_info.disable_stdin = 1;
1359 rev_info.show_root_diff = 1;
1360 rev_info.diffopt.output_format = DIFF_FORMAT_PATCH;
1361 rev_info.no_commit_id = 1;
1362 rev_info.diffopt.flags.binary = 1;
1363 rev_info.diffopt.flags.full_index = 1;
1364 rev_info.diffopt.use_color = 0;
1365 rev_info.diffopt.file = fp;
1366 rev_info.diffopt.close_file = 1;
1367 add_pending_object(&rev_info, &commit->object, "");
1368 diff_setup_done(&rev_info.diffopt);
1369 log_tree_commit(&rev_info, commit);
1373 * Writes the diff of the index against HEAD as a patch to the state
1374 * directory's "patch" file.
1376 static void write_index_patch(const struct am_state *state)
1379 struct object_id head;
1380 struct rev_info rev_info;
1383 if (!get_oid("HEAD", &head)) {
1384 struct commit *commit = lookup_commit_or_die(&head, "HEAD");
1385 tree = get_commit_tree(commit);
1387 tree = lookup_tree(the_repository,
1388 the_repository->hash_algo->empty_tree);
1390 fp = xfopen(am_path(state, "patch"), "w");
1391 repo_init_revisions(the_repository, &rev_info, NULL);
1393 rev_info.disable_stdin = 1;
1394 rev_info.no_commit_id = 1;
1395 rev_info.diffopt.output_format = DIFF_FORMAT_PATCH;
1396 rev_info.diffopt.use_color = 0;
1397 rev_info.diffopt.file = fp;
1398 rev_info.diffopt.close_file = 1;
1399 add_pending_object(&rev_info, &tree->object, "");
1400 diff_setup_done(&rev_info.diffopt);
1401 run_diff_index(&rev_info, 1);
1405 * Like parse_mail(), but parses the mail by looking up its commit ID
1406 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1409 * state->orig_commit will be set to the original commit ID.
1411 * Will always return 0 as the patch should never be skipped.
1413 static int parse_mail_rebase(struct am_state *state, const char *mail)
1415 struct commit *commit;
1416 struct object_id commit_oid;
1418 if (get_mail_commit_oid(&commit_oid, mail) < 0)
1419 die(_("could not parse %s"), mail);
1421 commit = lookup_commit_or_die(&commit_oid, mail);
1423 get_commit_info(state, commit);
1425 write_commit_patch(state, commit);
1427 oidcpy(&state->orig_commit, &commit_oid);
1428 write_state_text(state, "original-commit", oid_to_hex(&commit_oid));
1429 update_ref("am", "REBASE_HEAD", &commit_oid,
1430 NULL, REF_NO_DEREF, UPDATE_REFS_DIE_ON_ERR);
1436 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1437 * `index_file` is not NULL, the patch will be applied to that index.
1439 static int run_apply(const struct am_state *state, const char *index_file)
1441 struct strvec apply_paths = STRVEC_INIT;
1442 struct strvec apply_opts = STRVEC_INIT;
1443 struct apply_state apply_state;
1445 int force_apply = 0;
1448 if (init_apply_state(&apply_state, the_repository, NULL))
1449 BUG("init_apply_state() failed");
1451 strvec_push(&apply_opts, "apply");
1452 strvec_pushv(&apply_opts, state->git_apply_opts.v);
1454 opts_left = apply_parse_options(apply_opts.nr, apply_opts.v,
1455 &apply_state, &force_apply, &options,
1459 die("unknown option passed through to git apply");
1462 apply_state.index_file = index_file;
1463 apply_state.cached = 1;
1465 apply_state.check_index = 1;
1468 * If we are allowed to fall back on 3-way merge, don't give false
1469 * errors during the initial attempt.
1471 if (state->threeway && !index_file)
1472 apply_state.apply_verbosity = verbosity_silent;
1474 if (check_apply_state(&apply_state, force_apply))
1475 BUG("check_apply_state() failed");
1477 strvec_push(&apply_paths, am_path(state, "patch"));
1479 res = apply_all_patches(&apply_state, apply_paths.nr, apply_paths.v, options);
1481 strvec_clear(&apply_paths);
1482 strvec_clear(&apply_opts);
1483 clear_apply_state(&apply_state);
1489 /* Reload index as apply_all_patches() will have modified it. */
1491 read_cache_from(index_file);
1498 * Builds an index that contains just the blobs needed for a 3way merge.
1500 static int build_fake_ancestor(const struct am_state *state, const char *index_file)
1502 struct child_process cp = CHILD_PROCESS_INIT;
1505 strvec_push(&cp.args, "apply");
1506 strvec_pushv(&cp.args, state->git_apply_opts.v);
1507 strvec_pushf(&cp.args, "--build-fake-ancestor=%s", index_file);
1508 strvec_push(&cp.args, am_path(state, "patch"));
1510 if (run_command(&cp))
1517 * Attempt a threeway merge, using index_path as the temporary index.
1519 static int fall_back_threeway(const struct am_state *state, const char *index_path)
1521 struct object_id orig_tree, their_tree, our_tree;
1522 const struct object_id *bases[1] = { &orig_tree };
1523 struct merge_options o;
1524 struct commit *result;
1525 char *their_tree_name;
1527 if (get_oid("HEAD", &our_tree) < 0)
1528 oidcpy(&our_tree, the_hash_algo->empty_tree);
1530 if (build_fake_ancestor(state, index_path))
1531 return error("could not build fake ancestor");
1534 read_cache_from(index_path);
1536 if (write_index_as_tree(&orig_tree, &the_index, index_path, 0, NULL))
1537 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1539 say(state, stdout, _("Using index info to reconstruct a base tree..."));
1541 if (!state->quiet) {
1543 * List paths that needed 3-way fallback, so that the user can
1544 * review them with extra care to spot mismerges.
1546 struct rev_info rev_info;
1548 repo_init_revisions(the_repository, &rev_info, NULL);
1549 rev_info.diffopt.output_format = DIFF_FORMAT_NAME_STATUS;
1550 rev_info.diffopt.filter |= diff_filter_bit('A');
1551 rev_info.diffopt.filter |= diff_filter_bit('M');
1552 add_pending_oid(&rev_info, "HEAD", &our_tree, 0);
1553 diff_setup_done(&rev_info.diffopt);
1554 run_diff_index(&rev_info, 1);
1557 if (run_apply(state, index_path))
1558 return error(_("Did you hand edit your patch?\n"
1559 "It does not apply to blobs recorded in its index."));
1561 if (write_index_as_tree(&their_tree, &the_index, index_path, 0, NULL))
1562 return error("could not write tree");
1564 say(state, stdout, _("Falling back to patching base and 3-way merge..."));
1570 * This is not so wrong. Depending on which base we picked, orig_tree
1571 * may be wildly different from ours, but their_tree has the same set of
1572 * wildly different changes in parts the patch did not touch, so
1573 * recursive ends up canceling them, saying that we reverted all those
1577 init_merge_options(&o, the_repository);
1580 their_tree_name = xstrfmt("%.*s", linelen(state->msg), state->msg);
1581 o.branch2 = their_tree_name;
1582 o.detect_directory_renames = MERGE_DIRECTORY_RENAMES_NONE;
1587 if (merge_recursive_generic(&o, &our_tree, &their_tree, 1, bases, &result)) {
1588 repo_rerere(the_repository, state->allow_rerere_autoupdate);
1589 free(their_tree_name);
1590 return error(_("Failed to merge in the changes."));
1593 free(their_tree_name);
1598 * Commits the current index with state->msg as the commit message and
1599 * state->author_name, state->author_email and state->author_date as the author
1602 static void do_commit(const struct am_state *state)
1604 struct object_id tree, parent, commit;
1605 const struct object_id *old_oid;
1606 struct commit_list *parents = NULL;
1607 const char *reflog_msg, *author, *committer = NULL;
1608 struct strbuf sb = STRBUF_INIT;
1610 if (run_hook_le(NULL, "pre-applypatch", NULL))
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_hook_le(NULL, "post-applypatch", NULL);
1664 strbuf_release(&sb);
1668 * Validates the am_state for resuming -- the "msg" and authorship fields must
1671 static void validate_resume_state(const struct am_state *state)
1674 die(_("cannot resume: %s does not exist."),
1675 am_path(state, "final-commit"));
1677 if (!state->author_name || !state->author_email || !state->author_date)
1678 die(_("cannot resume: %s does not exist."),
1679 am_path(state, "author-script"));
1683 * Interactively prompt the user on whether the current patch should be
1686 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1689 static int do_interactive(struct am_state *state)
1696 puts(_("Commit Body is:"));
1697 puts("--------------------------");
1698 printf("%s", state->msg);
1699 puts("--------------------------");
1702 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1703 * in your translation. The program will only accept English
1704 * input at this point.
1706 printf(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "));
1707 if (!fgets(reply, sizeof(reply), stdin))
1708 die("unable to read from stdin; aborting");
1710 if (*reply == 'y' || *reply == 'Y') {
1712 } else if (*reply == 'a' || *reply == 'A') {
1713 state->interactive = 0;
1715 } else if (*reply == 'n' || *reply == 'N') {
1717 } else if (*reply == 'e' || *reply == 'E') {
1718 struct strbuf msg = STRBUF_INIT;
1720 if (!launch_editor(am_path(state, "final-commit"), &msg, NULL)) {
1722 state->msg = strbuf_detach(&msg, &state->msg_len);
1724 strbuf_release(&msg);
1725 } else if (*reply == 'v' || *reply == 'V') {
1726 const char *pager = git_pager(1);
1727 struct child_process cp = CHILD_PROCESS_INIT;
1731 prepare_pager_args(&cp, pager);
1732 strvec_push(&cp.args, am_path(state, "patch"));
1739 * Applies all queued mail.
1741 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1742 * well as the state directory's "patch" file is used as-is for applying the
1743 * patch and committing it.
1745 static void am_run(struct am_state *state, int resume)
1747 struct strbuf sb = STRBUF_INIT;
1749 unlink(am_path(state, "dirtyindex"));
1751 if (refresh_and_write_cache(REFRESH_QUIET, 0, 0) < 0)
1752 die(_("unable to write index file"));
1754 if (repo_index_has_changes(the_repository, NULL, &sb)) {
1755 write_state_bool(state, "dirtyindex", 1);
1756 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb.buf);
1759 strbuf_release(&sb);
1761 while (state->cur <= state->last) {
1762 const char *mail = am_path(state, msgnum(state));
1767 if (!file_exists(mail))
1771 validate_resume_state(state);
1775 if (state->rebasing)
1776 skip = parse_mail_rebase(state, mail);
1778 skip = parse_mail(state, mail);
1781 goto next; /* mail should be skipped */
1784 am_append_signoff(state);
1786 write_author_script(state);
1787 write_commit_msg(state);
1790 if (state->interactive && do_interactive(state))
1793 if (run_applypatch_msg_hook(state))
1796 say(state, stdout, _("Applying: %.*s"), linelen(state->msg), state->msg);
1798 apply_status = run_apply(state, NULL);
1800 if (apply_status && state->threeway) {
1801 struct strbuf sb = STRBUF_INIT;
1803 strbuf_addstr(&sb, am_path(state, "patch-merge-index"));
1804 apply_status = fall_back_threeway(state, sb.buf);
1805 strbuf_release(&sb);
1808 * Applying the patch to an earlier tree and merging
1809 * the result may have produced the same tree as ours.
1811 if (!apply_status &&
1812 !repo_index_has_changes(the_repository, NULL, NULL)) {
1813 say(state, stdout, _("No changes -- Patch already applied."));
1819 printf_ln(_("Patch failed at %s %.*s"), msgnum(state),
1820 linelen(state->msg), state->msg);
1822 if (advice_amworkdir)
1823 advise(_("Use 'git am --show-current-patch=diff' to see the failed patch"));
1825 die_user_resolve(state);
1838 if (!is_empty_or_missing_file(am_path(state, "rewritten"))) {
1839 assert(state->rebasing);
1840 copy_notes_for_rebase(state);
1841 run_post_rewrite_hook(state);
1845 * In rebasing mode, it's up to the caller to take care of
1848 if (!state->rebasing) {
1850 close_object_store(the_repository->objects);
1851 run_auto_maintenance(state->quiet);
1856 * Resume the current am session after patch application failure. The user did
1857 * all the hard work, and we do not have to do any patch application. Just
1858 * trust and commit what the user has in the index and working tree.
1860 static void am_resolve(struct am_state *state)
1862 validate_resume_state(state);
1864 say(state, stdout, _("Applying: %.*s"), linelen(state->msg), state->msg);
1866 if (!repo_index_has_changes(the_repository, NULL, NULL)) {
1867 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1868 "If there is nothing left to stage, chances are that something else\n"
1869 "already introduced the same changes; you might want to skip this patch."));
1870 die_user_resolve(state);
1873 if (unmerged_cache()) {
1874 printf_ln(_("You still have unmerged paths in your index.\n"
1875 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1876 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1877 die_user_resolve(state);
1880 if (state->interactive) {
1881 write_index_patch(state);
1882 if (do_interactive(state))
1886 repo_rerere(the_repository, 0);
1897 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1898 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1901 static int fast_forward_to(struct tree *head, struct tree *remote, int reset)
1903 struct lock_file lock_file = LOCK_INIT;
1904 struct unpack_trees_options opts;
1905 struct tree_desc t[2];
1907 if (parse_tree(head) || parse_tree(remote))
1910 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
1912 refresh_cache(REFRESH_QUIET);
1914 memset(&opts, 0, sizeof(opts));
1916 opts.src_index = &the_index;
1917 opts.dst_index = &the_index;
1921 opts.fn = twoway_merge;
1922 init_tree_desc(&t[0], head->buffer, head->size);
1923 init_tree_desc(&t[1], remote->buffer, remote->size);
1925 if (unpack_trees(2, t, &opts)) {
1926 rollback_lock_file(&lock_file);
1930 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
1931 die(_("unable to write new index file"));
1937 * Merges a tree into the index. The index's stat info will take precedence
1938 * over the merged tree's. Returns 0 on success, -1 on failure.
1940 static int merge_tree(struct tree *tree)
1942 struct lock_file lock_file = LOCK_INIT;
1943 struct unpack_trees_options opts;
1944 struct tree_desc t[1];
1946 if (parse_tree(tree))
1949 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
1951 memset(&opts, 0, sizeof(opts));
1953 opts.src_index = &the_index;
1954 opts.dst_index = &the_index;
1956 opts.fn = oneway_merge;
1957 init_tree_desc(&t[0], tree->buffer, tree->size);
1959 if (unpack_trees(1, t, &opts)) {
1960 rollback_lock_file(&lock_file);
1964 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
1965 die(_("unable to write new index file"));
1971 * Clean the index without touching entries that are not modified between
1972 * `head` and `remote`.
1974 static int clean_index(const struct object_id *head, const struct object_id *remote)
1976 struct tree *head_tree, *remote_tree, *index_tree;
1977 struct object_id index;
1979 head_tree = parse_tree_indirect(head);
1981 return error(_("Could not parse object '%s'."), oid_to_hex(head));
1983 remote_tree = parse_tree_indirect(remote);
1985 return error(_("Could not parse object '%s'."), oid_to_hex(remote));
1987 read_cache_unmerged();
1989 if (fast_forward_to(head_tree, head_tree, 1))
1992 if (write_cache_as_tree(&index, 0, NULL))
1995 index_tree = parse_tree_indirect(&index);
1997 return error(_("Could not parse object '%s'."), oid_to_hex(&index));
1999 if (fast_forward_to(index_tree, remote_tree, 0))
2002 if (merge_tree(remote_tree))
2005 remove_branch_state(the_repository, 0);
2011 * Resets rerere's merge resolution metadata.
2013 static void am_rerere_clear(void)
2015 struct string_list merge_rr = STRING_LIST_INIT_DUP;
2016 rerere_clear(the_repository, &merge_rr);
2017 string_list_clear(&merge_rr, 1);
2021 * Resume the current am session by skipping the current patch.
2023 static void am_skip(struct am_state *state)
2025 struct object_id head;
2029 if (get_oid("HEAD", &head))
2030 oidcpy(&head, the_hash_algo->empty_tree);
2032 if (clean_index(&head, &head))
2033 die(_("failed to clean index"));
2035 if (state->rebasing) {
2036 FILE *fp = xfopen(am_path(state, "rewritten"), "a");
2038 assert(!is_null_oid(&state->orig_commit));
2039 fprintf(fp, "%s ", oid_to_hex(&state->orig_commit));
2040 fprintf(fp, "%s\n", oid_to_hex(&head));
2050 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2052 * It is not safe to reset HEAD when:
2053 * 1. git-am previously failed because the index was dirty.
2054 * 2. HEAD has moved since git-am previously failed.
2056 static int safe_to_abort(const struct am_state *state)
2058 struct strbuf sb = STRBUF_INIT;
2059 struct object_id abort_safety, head;
2061 if (file_exists(am_path(state, "dirtyindex")))
2064 if (read_state_file(&sb, state, "abort-safety", 1) > 0) {
2065 if (get_oid_hex(sb.buf, &abort_safety))
2066 die(_("could not parse %s"), am_path(state, "abort-safety"));
2068 oidclr(&abort_safety);
2069 strbuf_release(&sb);
2071 if (get_oid("HEAD", &head))
2074 if (oideq(&head, &abort_safety))
2077 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2078 "Not rewinding to ORIG_HEAD"));
2084 * Aborts the current am session if it is safe to do so.
2086 static void am_abort(struct am_state *state)
2088 struct object_id curr_head, orig_head;
2089 int has_curr_head, has_orig_head;
2092 if (!safe_to_abort(state)) {
2099 curr_branch = resolve_refdup("HEAD", 0, &curr_head, NULL);
2100 has_curr_head = curr_branch && !is_null_oid(&curr_head);
2102 oidcpy(&curr_head, the_hash_algo->empty_tree);
2104 has_orig_head = !get_oid("ORIG_HEAD", &orig_head);
2106 oidcpy(&orig_head, the_hash_algo->empty_tree);
2108 clean_index(&curr_head, &orig_head);
2111 update_ref("am --abort", "HEAD", &orig_head,
2112 has_curr_head ? &curr_head : NULL, 0,
2113 UPDATE_REFS_DIE_ON_ERR);
2114 else if (curr_branch)
2115 delete_ref(NULL, curr_branch, NULL, REF_NO_DEREF);
2121 static int show_patch(struct am_state *state, enum show_patch_type sub_mode)
2123 struct strbuf sb = STRBUF_INIT;
2124 const char *patch_path;
2127 if (!is_null_oid(&state->orig_commit)) {
2128 const char *av[4] = { "show", NULL, "--", NULL };
2132 av[1] = new_oid_str = xstrdup(oid_to_hex(&state->orig_commit));
2133 ret = run_command_v_opt(av, RUN_GIT_CMD);
2139 case SHOW_PATCH_RAW:
2140 patch_path = am_path(state, msgnum(state));
2142 case SHOW_PATCH_DIFF:
2143 patch_path = am_path(state, "patch");
2146 BUG("invalid mode for --show-current-patch");
2149 len = strbuf_read_file(&sb, patch_path, 0);
2151 die_errno(_("failed to read '%s'"), patch_path);
2154 write_in_full(1, sb.buf, sb.len);
2155 strbuf_release(&sb);
2160 * parse_options() callback that validates and sets opt->value to the
2161 * PATCH_FORMAT_* enum value corresponding to `arg`.
2163 static int parse_opt_patchformat(const struct option *opt, const char *arg, int unset)
2165 int *opt_value = opt->value;
2168 *opt_value = PATCH_FORMAT_UNKNOWN;
2169 else if (!strcmp(arg, "mbox"))
2170 *opt_value = PATCH_FORMAT_MBOX;
2171 else if (!strcmp(arg, "stgit"))
2172 *opt_value = PATCH_FORMAT_STGIT;
2173 else if (!strcmp(arg, "stgit-series"))
2174 *opt_value = PATCH_FORMAT_STGIT_SERIES;
2175 else if (!strcmp(arg, "hg"))
2176 *opt_value = PATCH_FORMAT_HG;
2177 else if (!strcmp(arg, "mboxrd"))
2178 *opt_value = PATCH_FORMAT_MBOXRD;
2180 * Please update $__git_patchformat in git-completion.bash
2181 * when you add new options
2184 return error(_("Invalid value for --patch-format: %s"), arg);
2198 struct resume_mode {
2199 enum resume_type mode;
2200 enum show_patch_type sub_mode;
2203 static int parse_opt_show_current_patch(const struct option *opt, const char *arg, int unset)
2205 int *opt_value = opt->value;
2206 struct resume_mode *resume = container_of(opt_value, struct resume_mode, mode);
2209 * Please update $__git_showcurrentpatch in git-completion.bash
2210 * when you add new options
2212 const char *valid_modes[] = {
2213 [SHOW_PATCH_DIFF] = "diff",
2214 [SHOW_PATCH_RAW] = "raw"
2216 int new_value = SHOW_PATCH_RAW;
2218 BUG_ON_OPT_NEG(unset);
2221 for (new_value = 0; new_value < ARRAY_SIZE(valid_modes); new_value++) {
2222 if (!strcmp(arg, valid_modes[new_value]))
2225 if (new_value >= ARRAY_SIZE(valid_modes))
2226 return error(_("Invalid value for --show-current-patch: %s"), arg);
2229 if (resume->mode == RESUME_SHOW_PATCH && new_value != resume->sub_mode)
2230 return error(_("--show-current-patch=%s is incompatible with "
2231 "--show-current-patch=%s"),
2232 arg, valid_modes[resume->sub_mode]);
2234 resume->mode = RESUME_SHOW_PATCH;
2235 resume->sub_mode = new_value;
2239 static int git_am_config(const char *k, const char *v, void *cb)
2243 status = git_gpg_config(k, v, NULL);
2247 return git_default_config(k, v, NULL);
2250 int cmd_am(int argc, const char **argv, const char *prefix)
2252 struct am_state state;
2255 int patch_format = PATCH_FORMAT_UNKNOWN;
2256 struct resume_mode resume = { .mode = RESUME_FALSE };
2260 const char * const usage[] = {
2261 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2262 N_("git am [<options>] (--continue | --skip | --abort)"),
2266 struct option options[] = {
2267 OPT_BOOL('i', "interactive", &state.interactive,
2268 N_("run interactively")),
2269 OPT_HIDDEN_BOOL('b', "binary", &binary,
2270 N_("historical option -- no-op")),
2271 OPT_BOOL('3', "3way", &state.threeway,
2272 N_("allow fall back on 3way merging if needed")),
2273 OPT__QUIET(&state.quiet, N_("be quiet")),
2274 OPT_SET_INT('s', "signoff", &state.signoff,
2275 N_("add a Signed-off-by trailer to the commit message"),
2277 OPT_BOOL('u', "utf8", &state.utf8,
2278 N_("recode into utf8 (default)")),
2279 OPT_SET_INT('k', "keep", &state.keep,
2280 N_("pass -k flag to git-mailinfo"), KEEP_TRUE),
2281 OPT_SET_INT(0, "keep-non-patch", &state.keep,
2282 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH),
2283 OPT_BOOL('m', "message-id", &state.message_id,
2284 N_("pass -m flag to git-mailinfo")),
2285 OPT_SET_INT_F(0, "keep-cr", &keep_cr,
2286 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2287 1, PARSE_OPT_NONEG),
2288 OPT_SET_INT_F(0, "no-keep-cr", &keep_cr,
2289 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2290 0, PARSE_OPT_NONEG),
2291 OPT_BOOL('c', "scissors", &state.scissors,
2292 N_("strip everything before a scissors line")),
2293 OPT_CALLBACK_F(0, "quoted-cr", &state.quoted_cr, N_("action"),
2294 N_("pass it through git-mailinfo"),
2295 PARSE_OPT_NONEG, am_option_parse_quoted_cr),
2296 OPT_PASSTHRU_ARGV(0, "whitespace", &state.git_apply_opts, N_("action"),
2297 N_("pass it through git-apply"),
2299 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state.git_apply_opts, NULL,
2300 N_("pass it through git-apply"),
2302 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state.git_apply_opts, NULL,
2303 N_("pass it through git-apply"),
2305 OPT_PASSTHRU_ARGV(0, "directory", &state.git_apply_opts, N_("root"),
2306 N_("pass it through git-apply"),
2308 OPT_PASSTHRU_ARGV(0, "exclude", &state.git_apply_opts, N_("path"),
2309 N_("pass it through git-apply"),
2311 OPT_PASSTHRU_ARGV(0, "include", &state.git_apply_opts, N_("path"),
2312 N_("pass it through git-apply"),
2314 OPT_PASSTHRU_ARGV('C', NULL, &state.git_apply_opts, N_("n"),
2315 N_("pass it through git-apply"),
2317 OPT_PASSTHRU_ARGV('p', NULL, &state.git_apply_opts, N_("num"),
2318 N_("pass it through git-apply"),
2320 OPT_CALLBACK(0, "patch-format", &patch_format, N_("format"),
2321 N_("format the patch(es) are in"),
2322 parse_opt_patchformat),
2323 OPT_PASSTHRU_ARGV(0, "reject", &state.git_apply_opts, NULL,
2324 N_("pass it through git-apply"),
2326 OPT_STRING(0, "resolvemsg", &state.resolvemsg, NULL,
2327 N_("override error message when patch failure occurs")),
2328 OPT_CMDMODE(0, "continue", &resume.mode,
2329 N_("continue applying patches after resolving a conflict"),
2331 OPT_CMDMODE('r', "resolved", &resume.mode,
2332 N_("synonyms for --continue"),
2334 OPT_CMDMODE(0, "skip", &resume.mode,
2335 N_("skip the current patch"),
2337 OPT_CMDMODE(0, "abort", &resume.mode,
2338 N_("restore the original branch and abort the patching operation"),
2340 OPT_CMDMODE(0, "quit", &resume.mode,
2341 N_("abort the patching operation but keep HEAD where it is"),
2343 { OPTION_CALLBACK, 0, "show-current-patch", &resume.mode,
2345 N_("show the patch being applied"),
2346 PARSE_OPT_CMDMODE | PARSE_OPT_OPTARG | PARSE_OPT_NONEG | PARSE_OPT_LITERAL_ARGHELP,
2347 parse_opt_show_current_patch, RESUME_SHOW_PATCH },
2348 OPT_BOOL(0, "committer-date-is-author-date",
2349 &state.committer_date_is_author_date,
2350 N_("lie about committer date")),
2351 OPT_BOOL(0, "ignore-date", &state.ignore_date,
2352 N_("use current timestamp for author date")),
2353 OPT_RERERE_AUTOUPDATE(&state.allow_rerere_autoupdate),
2354 { OPTION_STRING, 'S', "gpg-sign", &state.sign_commit, N_("key-id"),
2355 N_("GPG-sign commits"),
2356 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
2357 OPT_HIDDEN_BOOL(0, "rebasing", &state.rebasing,
2358 N_("(internal use for git-rebase)")),
2362 if (argc == 2 && !strcmp(argv[1], "-h"))
2363 usage_with_options(usage, options);
2365 git_config(git_am_config, NULL);
2367 am_state_init(&state);
2369 in_progress = am_in_progress(&state);
2373 argc = parse_options(argc, argv, prefix, options, usage, 0);
2376 fprintf_ln(stderr, _("The -b/--binary option has been a no-op for long time, and\n"
2377 "it will be removed. Please do not use it anymore."));
2379 /* Ensure a valid committer ident can be constructed */
2380 git_committer_info(IDENT_STRICT);
2382 if (repo_read_index_preload(the_repository, NULL, 0) < 0)
2383 die(_("failed to read the index"));
2387 * Catch user error to feed us patches when there is a session
2390 * 1. mbox path(s) are provided on the command-line.
2391 * 2. stdin is not a tty: the user is trying to feed us a patch
2392 * from standard input. This is somewhat unreliable -- stdin
2393 * could be /dev/null for example and the caller did not
2394 * intend to feed us a patch but wanted to continue
2397 if (argc || (resume.mode == RESUME_FALSE && !isatty(0)))
2398 die(_("previous rebase directory %s still exists but mbox given."),
2401 if (resume.mode == RESUME_FALSE)
2402 resume.mode = RESUME_APPLY;
2404 if (state.signoff == SIGNOFF_EXPLICIT)
2405 am_append_signoff(&state);
2407 struct strvec paths = STRVEC_INIT;
2411 * Handle stray state directory in the independent-run case. In
2412 * the --rebasing case, it is up to the caller to take care of
2413 * stray directories.
2415 if (file_exists(state.dir) && !state.rebasing) {
2416 if (resume.mode == RESUME_ABORT || resume.mode == RESUME_QUIT) {
2418 am_state_release(&state);
2422 die(_("Stray %s directory found.\n"
2423 "Use \"git am --abort\" to remove it."),
2428 die(_("Resolve operation not in progress, we are not resuming."));
2430 for (i = 0; i < argc; i++) {
2431 if (is_absolute_path(argv[i]) || !prefix)
2432 strvec_push(&paths, argv[i]);
2434 strvec_push(&paths, mkpath("%s/%s", prefix, argv[i]));
2437 if (state.interactive && !paths.nr)
2438 die(_("interactive mode requires patches on the command line"));
2440 am_setup(&state, patch_format, paths.v, keep_cr);
2442 strvec_clear(&paths);
2445 switch (resume.mode) {
2452 case RESUME_RESOLVED:
2465 case RESUME_SHOW_PATCH:
2466 ret = show_patch(&state, resume.sub_mode);
2469 BUG("invalid resume value");
2472 am_state_release(&state);