4 * Based on git-am.sh by Junio C Hamano.
10 #include "parse-options.h"
12 #include "run-command.h"
16 #include "cache-tree.h"
21 #include "unpack-trees.h"
23 #include "sequencer.h"
25 #include "merge-recursive.h"
28 #include "notes-utils.h"
33 #include "string-list.h"
35 #include "repository.h"
38 * Returns 1 if the file is empty or does not exist, 0 otherwise.
40 static int is_empty_file(const char *filename)
44 if (stat(filename, &st) < 0) {
47 die_errno(_("could not stat %s"), filename);
54 * Returns the length of the first line of msg.
56 static int linelen(const char *msg)
58 return strchrnul(msg, '\n') - msg;
62 * Returns true if `str` consists of only whitespace, false otherwise.
64 static int str_isspace(const char *str)
74 PATCH_FORMAT_UNKNOWN = 0,
77 PATCH_FORMAT_STGIT_SERIES,
84 KEEP_TRUE, /* pass -k flag to git-mailinfo */
85 KEEP_NON_PATCH /* pass -b flag to git-mailinfo */
90 SCISSORS_FALSE = 0, /* pass --no-scissors to git-mailinfo */
91 SCISSORS_TRUE /* pass --scissors to git-mailinfo */
97 SIGNOFF_EXPLICIT /* --signoff was set on the command-line */
101 /* state directory path */
104 /* current and last patch numbers, 1-indexed */
108 /* commit metadata and message */
115 /* when --rebasing, records the original commit the patch came from */
116 struct object_id orig_commit;
118 /* number of digits in patch filename */
121 /* various operating modes and command line options */
125 int signoff; /* enum signoff_type */
127 int keep; /* enum keep_type */
129 int scissors; /* enum scissors_type */
130 struct argv_array git_apply_opts;
131 const char *resolvemsg;
132 int committer_date_is_author_date;
134 int allow_rerere_autoupdate;
135 const char *sign_commit;
140 * Initializes am_state with the default values.
142 static void am_state_init(struct am_state *state)
146 memset(state, 0, sizeof(*state));
148 state->dir = git_pathdup("rebase-apply");
152 git_config_get_bool("am.threeway", &state->threeway);
156 git_config_get_bool("am.messageid", &state->message_id);
158 state->scissors = SCISSORS_UNSET;
160 argv_array_init(&state->git_apply_opts);
162 if (!git_config_get_bool("commit.gpgsign", &gpgsign))
163 state->sign_commit = gpgsign ? "" : NULL;
167 * Releases memory allocated by an am_state.
169 static void am_state_release(struct am_state *state)
172 free(state->author_name);
173 free(state->author_email);
174 free(state->author_date);
176 argv_array_clear(&state->git_apply_opts);
180 * Returns path relative to the am_state directory.
182 static inline const char *am_path(const struct am_state *state, const char *path)
184 return mkpath("%s/%s", state->dir, path);
188 * For convenience to call write_file()
190 static void write_state_text(const struct am_state *state,
191 const char *name, const char *string)
193 write_file(am_path(state, name), "%s", string);
196 static void write_state_count(const struct am_state *state,
197 const char *name, int value)
199 write_file(am_path(state, name), "%d", value);
202 static void write_state_bool(const struct am_state *state,
203 const char *name, int value)
205 write_state_text(state, name, value ? "t" : "f");
209 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
212 static void say(const struct am_state *state, FILE *fp, const char *fmt, ...)
218 vfprintf(fp, fmt, ap);
225 * Returns 1 if there is an am session in progress, 0 otherwise.
227 static int am_in_progress(const struct am_state *state)
231 if (lstat(state->dir, &st) < 0 || !S_ISDIR(st.st_mode))
233 if (lstat(am_path(state, "last"), &st) || !S_ISREG(st.st_mode))
235 if (lstat(am_path(state, "next"), &st) || !S_ISREG(st.st_mode))
241 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
242 * number of bytes read on success, -1 if the file does not exist. If `trim` is
243 * set, trailing whitespace will be removed.
245 static int read_state_file(struct strbuf *sb, const struct am_state *state,
246 const char *file, int trim)
250 if (strbuf_read_file(sb, am_path(state, file), 0) >= 0) {
260 die_errno(_("could not read '%s'"), am_path(state, file));
264 * Reads and parses the state directory's "author-script" file, and sets
265 * state->author_name, state->author_email and state->author_date accordingly.
266 * Returns 0 on success, -1 if the file could not be parsed.
268 * The author script is of the format:
270 * GIT_AUTHOR_NAME='$author_name'
271 * GIT_AUTHOR_EMAIL='$author_email'
272 * GIT_AUTHOR_DATE='$author_date'
274 * where $author_name, $author_email and $author_date are quoted. We are strict
275 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
276 * script, and thus if the file differs from what this function expects, it is
277 * better to bail out than to do something that the user does not expect.
279 static int read_am_author_script(struct am_state *state)
281 const char *filename = am_path(state, "author-script");
283 assert(!state->author_name);
284 assert(!state->author_email);
285 assert(!state->author_date);
287 return read_author_script(filename, &state->author_name,
288 &state->author_email, &state->author_date, 1);
292 * Saves state->author_name, state->author_email and state->author_date in the
293 * state directory's "author-script" file.
295 static void write_author_script(const struct am_state *state)
297 struct strbuf sb = STRBUF_INIT;
299 strbuf_addstr(&sb, "GIT_AUTHOR_NAME=");
300 sq_quote_buf(&sb, state->author_name);
301 strbuf_addch(&sb, '\n');
303 strbuf_addstr(&sb, "GIT_AUTHOR_EMAIL=");
304 sq_quote_buf(&sb, state->author_email);
305 strbuf_addch(&sb, '\n');
307 strbuf_addstr(&sb, "GIT_AUTHOR_DATE=");
308 sq_quote_buf(&sb, state->author_date);
309 strbuf_addch(&sb, '\n');
311 write_state_text(state, "author-script", sb.buf);
317 * Reads the commit message from the state directory's "final-commit" file,
318 * setting state->msg to its contents and state->msg_len to the length of its
321 * Returns 0 on success, -1 if the file does not exist.
323 static int read_commit_msg(struct am_state *state)
325 struct strbuf sb = STRBUF_INIT;
329 if (read_state_file(&sb, state, "final-commit", 0) < 0) {
334 state->msg = strbuf_detach(&sb, &state->msg_len);
339 * Saves state->msg in the state directory's "final-commit" file.
341 static void write_commit_msg(const struct am_state *state)
343 const char *filename = am_path(state, "final-commit");
344 write_file_buf(filename, state->msg, state->msg_len);
348 * Loads state from disk.
350 static void am_load(struct am_state *state)
352 struct strbuf sb = STRBUF_INIT;
354 if (read_state_file(&sb, state, "next", 1) < 0)
355 BUG("state file 'next' does not exist");
356 state->cur = strtol(sb.buf, NULL, 10);
358 if (read_state_file(&sb, state, "last", 1) < 0)
359 BUG("state file 'last' does not exist");
360 state->last = strtol(sb.buf, NULL, 10);
362 if (read_am_author_script(state) < 0)
363 die(_("could not parse author script"));
365 read_commit_msg(state);
367 if (read_state_file(&sb, state, "original-commit", 1) < 0)
368 oidclr(&state->orig_commit);
369 else if (get_oid_hex(sb.buf, &state->orig_commit) < 0)
370 die(_("could not parse %s"), am_path(state, "original-commit"));
372 read_state_file(&sb, state, "threeway", 1);
373 state->threeway = !strcmp(sb.buf, "t");
375 read_state_file(&sb, state, "quiet", 1);
376 state->quiet = !strcmp(sb.buf, "t");
378 read_state_file(&sb, state, "sign", 1);
379 state->signoff = !strcmp(sb.buf, "t");
381 read_state_file(&sb, state, "utf8", 1);
382 state->utf8 = !strcmp(sb.buf, "t");
384 if (file_exists(am_path(state, "rerere-autoupdate"))) {
385 read_state_file(&sb, state, "rerere-autoupdate", 1);
386 state->allow_rerere_autoupdate = strcmp(sb.buf, "t") ?
387 RERERE_NOAUTOUPDATE : RERERE_AUTOUPDATE;
389 state->allow_rerere_autoupdate = 0;
392 read_state_file(&sb, state, "keep", 1);
393 if (!strcmp(sb.buf, "t"))
394 state->keep = KEEP_TRUE;
395 else if (!strcmp(sb.buf, "b"))
396 state->keep = KEEP_NON_PATCH;
398 state->keep = KEEP_FALSE;
400 read_state_file(&sb, state, "messageid", 1);
401 state->message_id = !strcmp(sb.buf, "t");
403 read_state_file(&sb, state, "scissors", 1);
404 if (!strcmp(sb.buf, "t"))
405 state->scissors = SCISSORS_TRUE;
406 else if (!strcmp(sb.buf, "f"))
407 state->scissors = SCISSORS_FALSE;
409 state->scissors = SCISSORS_UNSET;
411 read_state_file(&sb, state, "apply-opt", 1);
412 argv_array_clear(&state->git_apply_opts);
413 if (sq_dequote_to_argv_array(sb.buf, &state->git_apply_opts) < 0)
414 die(_("could not parse %s"), am_path(state, "apply-opt"));
416 state->rebasing = !!file_exists(am_path(state, "rebasing"));
422 * Removes the am_state directory, forcefully terminating the current am
425 static void am_destroy(const struct am_state *state)
427 struct strbuf sb = STRBUF_INIT;
429 strbuf_addstr(&sb, state->dir);
430 remove_dir_recursively(&sb, 0);
435 * Runs applypatch-msg hook. Returns its exit code.
437 static int run_applypatch_msg_hook(struct am_state *state)
442 ret = run_hook_le(NULL, "applypatch-msg", am_path(state, "final-commit"), NULL);
445 FREE_AND_NULL(state->msg);
446 if (read_commit_msg(state) < 0)
447 die(_("'%s' was deleted by the applypatch-msg hook"),
448 am_path(state, "final-commit"));
455 * Runs post-rewrite hook. Returns it exit code.
457 static int run_post_rewrite_hook(const struct am_state *state)
459 struct child_process cp = CHILD_PROCESS_INIT;
460 const char *hook = find_hook("post-rewrite");
466 argv_array_push(&cp.args, hook);
467 argv_array_push(&cp.args, "rebase");
469 cp.in = xopen(am_path(state, "rewritten"), O_RDONLY);
470 cp.stdout_to_stderr = 1;
472 ret = run_command(&cp);
479 * Reads the state directory's "rewritten" file, and copies notes from the old
480 * commits listed in the file to their rewritten commits.
482 * Returns 0 on success, -1 on failure.
484 static int copy_notes_for_rebase(const struct am_state *state)
486 struct notes_rewrite_cfg *c;
487 struct strbuf sb = STRBUF_INIT;
488 const char *invalid_line = _("Malformed input line: '%s'.");
489 const char *msg = "Notes added by 'git rebase'";
493 assert(state->rebasing);
495 c = init_copy_notes_for_rewrite("rebase");
499 fp = xfopen(am_path(state, "rewritten"), "r");
501 while (!strbuf_getline_lf(&sb, fp)) {
502 struct object_id from_obj, to_obj;
504 if (sb.len != GIT_SHA1_HEXSZ * 2 + 1) {
505 ret = error(invalid_line, sb.buf);
509 if (get_oid_hex(sb.buf, &from_obj)) {
510 ret = error(invalid_line, sb.buf);
514 if (sb.buf[GIT_SHA1_HEXSZ] != ' ') {
515 ret = error(invalid_line, sb.buf);
519 if (get_oid_hex(sb.buf + GIT_SHA1_HEXSZ + 1, &to_obj)) {
520 ret = error(invalid_line, sb.buf);
524 if (copy_note_for_rewrite(c, &from_obj, &to_obj))
525 ret = error(_("Failed to copy notes from '%s' to '%s'"),
526 oid_to_hex(&from_obj), oid_to_hex(&to_obj));
530 finish_copy_notes_for_rewrite(c, msg);
537 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
538 * non-indented lines and checking if they look like they begin with valid
539 * header field names.
541 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
543 static int is_mail(FILE *fp)
545 const char *header_regex = "^[!-9;-~]+:";
546 struct strbuf sb = STRBUF_INIT;
550 if (fseek(fp, 0L, SEEK_SET))
551 die_errno(_("fseek failed"));
553 if (regcomp(®ex, header_regex, REG_NOSUB | REG_EXTENDED))
554 die("invalid pattern: %s", header_regex);
556 while (!strbuf_getline(&sb, fp)) {
558 break; /* End of header */
560 /* Ignore indented folded lines */
561 if (*sb.buf == '\t' || *sb.buf == ' ')
564 /* It's a header if it matches header_regex */
565 if (regexec(®ex, sb.buf, 0, NULL, 0)) {
578 * Attempts to detect the patch_format of the patches contained in `paths`,
579 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
582 static int detect_patch_format(const char **paths)
584 enum patch_format ret = PATCH_FORMAT_UNKNOWN;
585 struct strbuf l1 = STRBUF_INIT;
586 struct strbuf l2 = STRBUF_INIT;
587 struct strbuf l3 = STRBUF_INIT;
591 * We default to mbox format if input is from stdin and for directories
593 if (!*paths || !strcmp(*paths, "-") || is_directory(*paths))
594 return PATCH_FORMAT_MBOX;
597 * Otherwise, check the first few lines of the first patch, starting
598 * from the first non-blank line, to try to detect its format.
601 fp = xfopen(*paths, "r");
603 while (!strbuf_getline(&l1, fp)) {
608 if (starts_with(l1.buf, "From ") || starts_with(l1.buf, "From: ")) {
609 ret = PATCH_FORMAT_MBOX;
613 if (starts_with(l1.buf, "# This series applies on GIT commit")) {
614 ret = PATCH_FORMAT_STGIT_SERIES;
618 if (!strcmp(l1.buf, "# HG changeset patch")) {
619 ret = PATCH_FORMAT_HG;
623 strbuf_getline(&l2, fp);
624 strbuf_getline(&l3, fp);
627 * If the second line is empty and the third is a From, Author or Date
628 * entry, this is likely an StGit patch.
630 if (l1.len && !l2.len &&
631 (starts_with(l3.buf, "From:") ||
632 starts_with(l3.buf, "Author:") ||
633 starts_with(l3.buf, "Date:"))) {
634 ret = PATCH_FORMAT_STGIT;
638 if (l1.len && is_mail(fp)) {
639 ret = PATCH_FORMAT_MBOX;
652 * Splits out individual email patches from `paths`, where each path is either
653 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
655 static int split_mail_mbox(struct am_state *state, const char **paths,
656 int keep_cr, int mboxrd)
658 struct child_process cp = CHILD_PROCESS_INIT;
659 struct strbuf last = STRBUF_INIT;
663 argv_array_push(&cp.args, "mailsplit");
664 argv_array_pushf(&cp.args, "-d%d", state->prec);
665 argv_array_pushf(&cp.args, "-o%s", state->dir);
666 argv_array_push(&cp.args, "-b");
668 argv_array_push(&cp.args, "--keep-cr");
670 argv_array_push(&cp.args, "--mboxrd");
671 argv_array_push(&cp.args, "--");
672 argv_array_pushv(&cp.args, paths);
674 ret = capture_command(&cp, &last, 8);
679 state->last = strtol(last.buf, NULL, 10);
682 strbuf_release(&last);
687 * Callback signature for split_mail_conv(). The foreign patch should be
688 * read from `in`, and the converted patch (in RFC2822 mail format) should be
689 * written to `out`. Return 0 on success, or -1 on failure.
691 typedef int (*mail_conv_fn)(FILE *out, FILE *in, int keep_cr);
694 * Calls `fn` for each file in `paths` to convert the foreign patch to the
695 * RFC2822 mail format suitable for parsing with git-mailinfo.
697 * Returns 0 on success, -1 on failure.
699 static int split_mail_conv(mail_conv_fn fn, struct am_state *state,
700 const char **paths, int keep_cr)
702 static const char *stdin_only[] = {"-", NULL};
708 for (i = 0; *paths; paths++, i++) {
713 if (!strcmp(*paths, "-"))
716 in = fopen(*paths, "r");
719 return error_errno(_("could not open '%s' for reading"),
722 mail = mkpath("%s/%0*d", state->dir, state->prec, i + 1);
724 out = fopen(mail, "w");
728 return error_errno(_("could not open '%s' for writing"),
732 ret = fn(out, in, keep_cr);
739 return error(_("could not parse patch '%s'"), *paths);
748 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
749 * message suitable for parsing with git-mailinfo.
751 static int stgit_patch_to_mail(FILE *out, FILE *in, int keep_cr)
753 struct strbuf sb = STRBUF_INIT;
754 int subject_printed = 0;
756 while (!strbuf_getline_lf(&sb, in)) {
759 if (str_isspace(sb.buf))
761 else if (skip_prefix(sb.buf, "Author:", &str))
762 fprintf(out, "From:%s\n", str);
763 else if (starts_with(sb.buf, "From") || starts_with(sb.buf, "Date"))
764 fprintf(out, "%s\n", sb.buf);
765 else if (!subject_printed) {
766 fprintf(out, "Subject: %s\n", sb.buf);
769 fprintf(out, "\n%s\n", sb.buf);
775 while (strbuf_fread(&sb, 8192, in) > 0) {
776 fwrite(sb.buf, 1, sb.len, out);
785 * This function only supports a single StGit series file in `paths`.
787 * Given an StGit series file, converts the StGit patches in the series into
788 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
789 * the state directory.
791 * Returns 0 on success, -1 on failure.
793 static int split_mail_stgit_series(struct am_state *state, const char **paths,
796 const char *series_dir;
797 char *series_dir_buf;
799 struct argv_array patches = ARGV_ARRAY_INIT;
800 struct strbuf sb = STRBUF_INIT;
803 if (!paths[0] || paths[1])
804 return error(_("Only one StGIT patch series can be applied at once"));
806 series_dir_buf = xstrdup(*paths);
807 series_dir = dirname(series_dir_buf);
809 fp = fopen(*paths, "r");
811 return error_errno(_("could not open '%s' for reading"), *paths);
813 while (!strbuf_getline_lf(&sb, fp)) {
815 continue; /* skip comment lines */
817 argv_array_push(&patches, mkpath("%s/%s", series_dir, sb.buf));
822 free(series_dir_buf);
824 ret = split_mail_conv(stgit_patch_to_mail, state, patches.argv, keep_cr);
826 argv_array_clear(&patches);
831 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
832 * message suitable for parsing with git-mailinfo.
834 static int hg_patch_to_mail(FILE *out, FILE *in, int keep_cr)
836 struct strbuf sb = STRBUF_INIT;
839 while (!strbuf_getline_lf(&sb, in)) {
842 if (skip_prefix(sb.buf, "# User ", &str))
843 fprintf(out, "From: %s\n", str);
844 else if (skip_prefix(sb.buf, "# Date ", &str)) {
845 timestamp_t timestamp;
850 timestamp = parse_timestamp(str, &end, 10);
852 rc = error(_("invalid timestamp"));
856 if (!skip_prefix(end, " ", &str)) {
857 rc = error(_("invalid Date line"));
862 tz = strtol(str, &end, 10);
864 rc = error(_("invalid timezone offset"));
869 rc = error(_("invalid Date line"));
874 * mercurial's timezone is in seconds west of UTC,
875 * however git's timezone is in hours + minutes east of
878 tz2 = labs(tz) / 3600 * 100 + labs(tz) % 3600 / 60;
882 fprintf(out, "Date: %s\n", show_date(timestamp, tz2, DATE_MODE(RFC2822)));
883 } else if (starts_with(sb.buf, "# ")) {
886 fprintf(out, "\n%s\n", sb.buf);
892 while (strbuf_fread(&sb, 8192, in) > 0) {
893 fwrite(sb.buf, 1, sb.len, out);
902 * Splits a list of files/directories into individual email patches. Each path
903 * in `paths` must be a file/directory that is formatted according to
906 * Once split out, the individual email patches will be stored in the state
907 * directory, with each patch's filename being its index, padded to state->prec
910 * state->cur will be set to the index of the first mail, and state->last will
911 * be set to the index of the last mail.
913 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
914 * to disable this behavior, -1 to use the default configured setting.
916 * Returns 0 on success, -1 on failure.
918 static int split_mail(struct am_state *state, enum patch_format patch_format,
919 const char **paths, int keep_cr)
923 git_config_get_bool("am.keepcr", &keep_cr);
926 switch (patch_format) {
927 case PATCH_FORMAT_MBOX:
928 return split_mail_mbox(state, paths, keep_cr, 0);
929 case PATCH_FORMAT_STGIT:
930 return split_mail_conv(stgit_patch_to_mail, state, paths, keep_cr);
931 case PATCH_FORMAT_STGIT_SERIES:
932 return split_mail_stgit_series(state, paths, keep_cr);
933 case PATCH_FORMAT_HG:
934 return split_mail_conv(hg_patch_to_mail, state, paths, keep_cr);
935 case PATCH_FORMAT_MBOXRD:
936 return split_mail_mbox(state, paths, keep_cr, 1);
938 BUG("invalid patch_format");
944 * Setup a new am session for applying patches
946 static void am_setup(struct am_state *state, enum patch_format patch_format,
947 const char **paths, int keep_cr)
949 struct object_id curr_head;
951 struct strbuf sb = STRBUF_INIT;
954 patch_format = detect_patch_format(paths);
957 fprintf_ln(stderr, _("Patch format detection failed."));
961 if (mkdir(state->dir, 0777) < 0 && errno != EEXIST)
962 die_errno(_("failed to create directory '%s'"), state->dir);
963 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
965 if (split_mail(state, patch_format, paths, keep_cr) < 0) {
967 die(_("Failed to split patches."));
973 write_state_bool(state, "threeway", state->threeway);
974 write_state_bool(state, "quiet", state->quiet);
975 write_state_bool(state, "sign", state->signoff);
976 write_state_bool(state, "utf8", state->utf8);
978 if (state->allow_rerere_autoupdate)
979 write_state_bool(state, "rerere-autoupdate",
980 state->allow_rerere_autoupdate == RERERE_AUTOUPDATE);
982 switch (state->keep) {
993 BUG("invalid value for state->keep");
996 write_state_text(state, "keep", str);
997 write_state_bool(state, "messageid", state->message_id);
999 switch (state->scissors) {
1000 case SCISSORS_UNSET:
1003 case SCISSORS_FALSE:
1010 BUG("invalid value for state->scissors");
1012 write_state_text(state, "scissors", str);
1014 sq_quote_argv(&sb, state->git_apply_opts.argv);
1015 write_state_text(state, "apply-opt", sb.buf);
1017 if (state->rebasing)
1018 write_state_text(state, "rebasing", "");
1020 write_state_text(state, "applying", "");
1022 if (!get_oid("HEAD", &curr_head)) {
1023 write_state_text(state, "abort-safety", oid_to_hex(&curr_head));
1024 if (!state->rebasing)
1025 update_ref("am", "ORIG_HEAD", &curr_head, NULL, 0,
1026 UPDATE_REFS_DIE_ON_ERR);
1028 write_state_text(state, "abort-safety", "");
1029 if (!state->rebasing)
1030 delete_ref(NULL, "ORIG_HEAD", NULL, 0);
1034 * NOTE: Since the "next" and "last" files determine if an am_state
1035 * session is in progress, they should be written last.
1038 write_state_count(state, "next", state->cur);
1039 write_state_count(state, "last", state->last);
1041 strbuf_release(&sb);
1045 * Increments the patch pointer, and cleans am_state for the application of the
1048 static void am_next(struct am_state *state)
1050 struct object_id head;
1052 FREE_AND_NULL(state->author_name);
1053 FREE_AND_NULL(state->author_email);
1054 FREE_AND_NULL(state->author_date);
1055 FREE_AND_NULL(state->msg);
1058 unlink(am_path(state, "author-script"));
1059 unlink(am_path(state, "final-commit"));
1061 oidclr(&state->orig_commit);
1062 unlink(am_path(state, "original-commit"));
1063 delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
1065 if (!get_oid("HEAD", &head))
1066 write_state_text(state, "abort-safety", oid_to_hex(&head));
1068 write_state_text(state, "abort-safety", "");
1071 write_state_count(state, "next", state->cur);
1075 * Returns the filename of the current patch email.
1077 static const char *msgnum(const struct am_state *state)
1079 static struct strbuf sb = STRBUF_INIT;
1082 strbuf_addf(&sb, "%0*d", state->prec, state->cur);
1088 * Refresh and write index.
1090 static void refresh_and_write_cache(void)
1092 struct lock_file lock_file = LOCK_INIT;
1094 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
1095 refresh_cache(REFRESH_QUIET);
1096 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
1097 die(_("unable to write index file"));
1101 * Dies with a user-friendly message on how to proceed after resolving the
1102 * problem. This message can be overridden with state->resolvemsg.
1104 static void NORETURN die_user_resolve(const struct am_state *state)
1106 if (state->resolvemsg) {
1107 printf_ln("%s", state->resolvemsg);
1109 const char *cmdline = state->interactive ? "git am -i" : "git am";
1111 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline);
1112 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline);
1113 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline);
1120 * Appends signoff to the "msg" field of the am_state.
1122 static void am_append_signoff(struct am_state *state)
1124 struct strbuf sb = STRBUF_INIT;
1126 strbuf_attach(&sb, state->msg, state->msg_len, state->msg_len);
1127 append_signoff(&sb, 0, 0);
1128 state->msg = strbuf_detach(&sb, &state->msg_len);
1132 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1133 * state->msg will be set to the patch message. state->author_name,
1134 * state->author_email and state->author_date will be set to the patch author's
1135 * name, email and date respectively. The patch body will be written to the
1136 * state directory's "patch" file.
1138 * Returns 1 if the patch should be skipped, 0 otherwise.
1140 static int parse_mail(struct am_state *state, const char *mail)
1143 struct strbuf sb = STRBUF_INIT;
1144 struct strbuf msg = STRBUF_INIT;
1145 struct strbuf author_name = STRBUF_INIT;
1146 struct strbuf author_date = STRBUF_INIT;
1147 struct strbuf author_email = STRBUF_INIT;
1151 setup_mailinfo(&mi);
1154 mi.metainfo_charset = get_commit_output_encoding();
1156 mi.metainfo_charset = NULL;
1158 switch (state->keep) {
1162 mi.keep_subject = 1;
1164 case KEEP_NON_PATCH:
1165 mi.keep_non_patch_brackets_in_subject = 1;
1168 BUG("invalid value for state->keep");
1171 if (state->message_id)
1172 mi.add_message_id = 1;
1174 switch (state->scissors) {
1175 case SCISSORS_UNSET:
1177 case SCISSORS_FALSE:
1178 mi.use_scissors = 0;
1181 mi.use_scissors = 1;
1184 BUG("invalid value for state->scissors");
1187 mi.input = xfopen(mail, "r");
1188 mi.output = xfopen(am_path(state, "info"), "w");
1189 if (mailinfo(&mi, am_path(state, "msg"), am_path(state, "patch")))
1190 die("could not parse patch");
1195 if (mi.format_flowed)
1196 warning(_("Patch sent with format=flowed; "
1197 "space at the end of lines might be lost."));
1199 /* Extract message and author information */
1200 fp = xfopen(am_path(state, "info"), "r");
1201 while (!strbuf_getline_lf(&sb, fp)) {
1204 if (skip_prefix(sb.buf, "Subject: ", &x)) {
1206 strbuf_addch(&msg, '\n');
1207 strbuf_addstr(&msg, x);
1208 } else if (skip_prefix(sb.buf, "Author: ", &x))
1209 strbuf_addstr(&author_name, x);
1210 else if (skip_prefix(sb.buf, "Email: ", &x))
1211 strbuf_addstr(&author_email, x);
1212 else if (skip_prefix(sb.buf, "Date: ", &x))
1213 strbuf_addstr(&author_date, x);
1217 /* Skip pine's internal folder data */
1218 if (!strcmp(author_name.buf, "Mail System Internal Data")) {
1223 if (is_empty_file(am_path(state, "patch"))) {
1224 printf_ln(_("Patch is empty."));
1225 die_user_resolve(state);
1228 strbuf_addstr(&msg, "\n\n");
1229 strbuf_addbuf(&msg, &mi.log_message);
1230 strbuf_stripspace(&msg, 0);
1232 assert(!state->author_name);
1233 state->author_name = strbuf_detach(&author_name, NULL);
1235 assert(!state->author_email);
1236 state->author_email = strbuf_detach(&author_email, NULL);
1238 assert(!state->author_date);
1239 state->author_date = strbuf_detach(&author_date, NULL);
1241 assert(!state->msg);
1242 state->msg = strbuf_detach(&msg, &state->msg_len);
1245 strbuf_release(&msg);
1246 strbuf_release(&author_date);
1247 strbuf_release(&author_email);
1248 strbuf_release(&author_name);
1249 strbuf_release(&sb);
1250 clear_mailinfo(&mi);
1255 * Sets commit_id to the commit hash where the mail was generated from.
1256 * Returns 0 on success, -1 on failure.
1258 static int get_mail_commit_oid(struct object_id *commit_id, const char *mail)
1260 struct strbuf sb = STRBUF_INIT;
1261 FILE *fp = xfopen(mail, "r");
1265 if (strbuf_getline_lf(&sb, fp) ||
1266 !skip_prefix(sb.buf, "From ", &x) ||
1267 get_oid_hex(x, commit_id) < 0)
1270 strbuf_release(&sb);
1276 * Sets state->msg, state->author_name, state->author_email, state->author_date
1277 * to the commit's respective info.
1279 static void get_commit_info(struct am_state *state, struct commit *commit)
1281 const char *buffer, *ident_line, *msg;
1283 struct ident_split id;
1285 buffer = logmsg_reencode(commit, NULL, get_commit_output_encoding());
1287 ident_line = find_commit_header(buffer, "author", &ident_len);
1289 if (split_ident_line(&id, ident_line, ident_len) < 0)
1290 die(_("invalid ident line: %.*s"), (int)ident_len, ident_line);
1292 assert(!state->author_name);
1294 state->author_name =
1295 xmemdupz(id.name_begin, id.name_end - id.name_begin);
1297 state->author_name = xstrdup("");
1299 assert(!state->author_email);
1301 state->author_email =
1302 xmemdupz(id.mail_begin, id.mail_end - id.mail_begin);
1304 state->author_email = xstrdup("");
1306 assert(!state->author_date);
1307 state->author_date = xstrdup(show_ident_date(&id, DATE_MODE(NORMAL)));
1309 assert(!state->msg);
1310 msg = strstr(buffer, "\n\n");
1312 die(_("unable to parse commit %s"), oid_to_hex(&commit->object.oid));
1313 state->msg = xstrdup(msg + 2);
1314 state->msg_len = strlen(state->msg);
1315 unuse_commit_buffer(commit, buffer);
1319 * Writes `commit` as a patch to the state directory's "patch" file.
1321 static void write_commit_patch(const struct am_state *state, struct commit *commit)
1323 struct rev_info rev_info;
1326 fp = xfopen(am_path(state, "patch"), "w");
1327 repo_init_revisions(the_repository, &rev_info, NULL);
1329 rev_info.abbrev = 0;
1330 rev_info.disable_stdin = 1;
1331 rev_info.show_root_diff = 1;
1332 rev_info.diffopt.output_format = DIFF_FORMAT_PATCH;
1333 rev_info.no_commit_id = 1;
1334 rev_info.diffopt.flags.binary = 1;
1335 rev_info.diffopt.flags.full_index = 1;
1336 rev_info.diffopt.use_color = 0;
1337 rev_info.diffopt.file = fp;
1338 rev_info.diffopt.close_file = 1;
1339 add_pending_object(&rev_info, &commit->object, "");
1340 diff_setup_done(&rev_info.diffopt);
1341 log_tree_commit(&rev_info, commit);
1345 * Writes the diff of the index against HEAD as a patch to the state
1346 * directory's "patch" file.
1348 static void write_index_patch(const struct am_state *state)
1351 struct object_id head;
1352 struct rev_info rev_info;
1355 if (!get_oid_tree("HEAD", &head))
1356 tree = lookup_tree(the_repository, &head);
1358 tree = lookup_tree(the_repository,
1359 the_repository->hash_algo->empty_tree);
1361 fp = xfopen(am_path(state, "patch"), "w");
1362 repo_init_revisions(the_repository, &rev_info, NULL);
1364 rev_info.disable_stdin = 1;
1365 rev_info.no_commit_id = 1;
1366 rev_info.diffopt.output_format = DIFF_FORMAT_PATCH;
1367 rev_info.diffopt.use_color = 0;
1368 rev_info.diffopt.file = fp;
1369 rev_info.diffopt.close_file = 1;
1370 add_pending_object(&rev_info, &tree->object, "");
1371 diff_setup_done(&rev_info.diffopt);
1372 run_diff_index(&rev_info, 1);
1376 * Like parse_mail(), but parses the mail by looking up its commit ID
1377 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1380 * state->orig_commit will be set to the original commit ID.
1382 * Will always return 0 as the patch should never be skipped.
1384 static int parse_mail_rebase(struct am_state *state, const char *mail)
1386 struct commit *commit;
1387 struct object_id commit_oid;
1389 if (get_mail_commit_oid(&commit_oid, mail) < 0)
1390 die(_("could not parse %s"), mail);
1392 commit = lookup_commit_or_die(&commit_oid, mail);
1394 get_commit_info(state, commit);
1396 write_commit_patch(state, commit);
1398 oidcpy(&state->orig_commit, &commit_oid);
1399 write_state_text(state, "original-commit", oid_to_hex(&commit_oid));
1400 update_ref("am", "REBASE_HEAD", &commit_oid,
1401 NULL, REF_NO_DEREF, UPDATE_REFS_DIE_ON_ERR);
1407 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1408 * `index_file` is not NULL, the patch will be applied to that index.
1410 static int run_apply(const struct am_state *state, const char *index_file)
1412 struct argv_array apply_paths = ARGV_ARRAY_INIT;
1413 struct argv_array apply_opts = ARGV_ARRAY_INIT;
1414 struct apply_state apply_state;
1416 int force_apply = 0;
1419 if (init_apply_state(&apply_state, the_repository, NULL))
1420 BUG("init_apply_state() failed");
1422 argv_array_push(&apply_opts, "apply");
1423 argv_array_pushv(&apply_opts, state->git_apply_opts.argv);
1425 opts_left = apply_parse_options(apply_opts.argc, apply_opts.argv,
1426 &apply_state, &force_apply, &options,
1430 die("unknown option passed through to git apply");
1433 apply_state.index_file = index_file;
1434 apply_state.cached = 1;
1436 apply_state.check_index = 1;
1439 * If we are allowed to fall back on 3-way merge, don't give false
1440 * errors during the initial attempt.
1442 if (state->threeway && !index_file)
1443 apply_state.apply_verbosity = verbosity_silent;
1445 if (check_apply_state(&apply_state, force_apply))
1446 BUG("check_apply_state() failed");
1448 argv_array_push(&apply_paths, am_path(state, "patch"));
1450 res = apply_all_patches(&apply_state, apply_paths.argc, apply_paths.argv, options);
1452 argv_array_clear(&apply_paths);
1453 argv_array_clear(&apply_opts);
1454 clear_apply_state(&apply_state);
1460 /* Reload index as apply_all_patches() will have modified it. */
1462 read_cache_from(index_file);
1469 * Builds an index that contains just the blobs needed for a 3way merge.
1471 static int build_fake_ancestor(const struct am_state *state, const char *index_file)
1473 struct child_process cp = CHILD_PROCESS_INIT;
1476 argv_array_push(&cp.args, "apply");
1477 argv_array_pushv(&cp.args, state->git_apply_opts.argv);
1478 argv_array_pushf(&cp.args, "--build-fake-ancestor=%s", index_file);
1479 argv_array_push(&cp.args, am_path(state, "patch"));
1481 if (run_command(&cp))
1488 * Attempt a threeway merge, using index_path as the temporary index.
1490 static int fall_back_threeway(const struct am_state *state, const char *index_path)
1492 struct object_id orig_tree, their_tree, our_tree;
1493 const struct object_id *bases[1] = { &orig_tree };
1494 struct merge_options o;
1495 struct commit *result;
1496 char *their_tree_name;
1498 if (get_oid("HEAD", &our_tree) < 0)
1499 oidcpy(&our_tree, the_hash_algo->empty_tree);
1501 if (build_fake_ancestor(state, index_path))
1502 return error("could not build fake ancestor");
1505 read_cache_from(index_path);
1507 if (write_index_as_tree(&orig_tree, &the_index, index_path, 0, NULL))
1508 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1510 say(state, stdout, _("Using index info to reconstruct a base tree..."));
1512 if (!state->quiet) {
1514 * List paths that needed 3-way fallback, so that the user can
1515 * review them with extra care to spot mismerges.
1517 struct rev_info rev_info;
1518 const char *diff_filter_str = "--diff-filter=AM";
1520 repo_init_revisions(the_repository, &rev_info, NULL);
1521 rev_info.diffopt.output_format = DIFF_FORMAT_NAME_STATUS;
1522 diff_opt_parse(&rev_info.diffopt, &diff_filter_str, 1, rev_info.prefix);
1523 add_pending_oid(&rev_info, "HEAD", &our_tree, 0);
1524 diff_setup_done(&rev_info.diffopt);
1525 run_diff_index(&rev_info, 1);
1528 if (run_apply(state, index_path))
1529 return error(_("Did you hand edit your patch?\n"
1530 "It does not apply to blobs recorded in its index."));
1532 if (write_index_as_tree(&their_tree, &the_index, index_path, 0, NULL))
1533 return error("could not write tree");
1535 say(state, stdout, _("Falling back to patching base and 3-way merge..."));
1541 * This is not so wrong. Depending on which base we picked, orig_tree
1542 * may be wildly different from ours, but their_tree has the same set of
1543 * wildly different changes in parts the patch did not touch, so
1544 * recursive ends up canceling them, saying that we reverted all those
1548 init_merge_options(&o);
1551 their_tree_name = xstrfmt("%.*s", linelen(state->msg), state->msg);
1552 o.branch2 = their_tree_name;
1553 o.detect_directory_renames = 0;
1558 if (merge_recursive_generic(&o, &our_tree, &their_tree, 1, bases, &result)) {
1559 repo_rerere(the_repository, state->allow_rerere_autoupdate);
1560 free(their_tree_name);
1561 return error(_("Failed to merge in the changes."));
1564 free(their_tree_name);
1569 * Commits the current index with state->msg as the commit message and
1570 * state->author_name, state->author_email and state->author_date as the author
1573 static void do_commit(const struct am_state *state)
1575 struct object_id tree, parent, commit;
1576 const struct object_id *old_oid;
1577 struct commit_list *parents = NULL;
1578 const char *reflog_msg, *author;
1579 struct strbuf sb = STRBUF_INIT;
1581 if (run_hook_le(NULL, "pre-applypatch", NULL))
1584 if (write_cache_as_tree(&tree, 0, NULL))
1585 die(_("git write-tree failed to write a tree"));
1587 if (!get_oid_commit("HEAD", &parent)) {
1589 commit_list_insert(lookup_commit(the_repository, &parent),
1593 say(state, stderr, _("applying to an empty history"));
1596 author = fmt_ident(state->author_name, state->author_email,
1597 state->ignore_date ? NULL : state->author_date,
1600 if (state->committer_date_is_author_date)
1601 setenv("GIT_COMMITTER_DATE",
1602 state->ignore_date ? "" : state->author_date, 1);
1604 if (commit_tree(state->msg, state->msg_len, &tree, parents, &commit,
1605 author, state->sign_commit))
1606 die(_("failed to write commit object"));
1608 reflog_msg = getenv("GIT_REFLOG_ACTION");
1612 strbuf_addf(&sb, "%s: %.*s", reflog_msg, linelen(state->msg),
1615 update_ref(sb.buf, "HEAD", &commit, old_oid, 0,
1616 UPDATE_REFS_DIE_ON_ERR);
1618 if (state->rebasing) {
1619 FILE *fp = xfopen(am_path(state, "rewritten"), "a");
1621 assert(!is_null_oid(&state->orig_commit));
1622 fprintf(fp, "%s ", oid_to_hex(&state->orig_commit));
1623 fprintf(fp, "%s\n", oid_to_hex(&commit));
1627 run_hook_le(NULL, "post-applypatch", NULL);
1629 strbuf_release(&sb);
1633 * Validates the am_state for resuming -- the "msg" and authorship fields must
1636 static void validate_resume_state(const struct am_state *state)
1639 die(_("cannot resume: %s does not exist."),
1640 am_path(state, "final-commit"));
1642 if (!state->author_name || !state->author_email || !state->author_date)
1643 die(_("cannot resume: %s does not exist."),
1644 am_path(state, "author-script"));
1648 * Interactively prompt the user on whether the current patch should be
1651 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1654 static int do_interactive(struct am_state *state)
1659 die(_("cannot be interactive without stdin connected to a terminal."));
1664 puts(_("Commit Body is:"));
1665 puts("--------------------------");
1666 printf("%s", state->msg);
1667 puts("--------------------------");
1670 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1671 * in your translation. The program will only accept English
1672 * input at this point.
1674 reply = git_prompt(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "), PROMPT_ECHO);
1678 } else if (*reply == 'y' || *reply == 'Y') {
1680 } else if (*reply == 'a' || *reply == 'A') {
1681 state->interactive = 0;
1683 } else if (*reply == 'n' || *reply == 'N') {
1685 } else if (*reply == 'e' || *reply == 'E') {
1686 struct strbuf msg = STRBUF_INIT;
1688 if (!launch_editor(am_path(state, "final-commit"), &msg, NULL)) {
1690 state->msg = strbuf_detach(&msg, &state->msg_len);
1692 strbuf_release(&msg);
1693 } else if (*reply == 'v' || *reply == 'V') {
1694 const char *pager = git_pager(1);
1695 struct child_process cp = CHILD_PROCESS_INIT;
1699 prepare_pager_args(&cp, pager);
1700 argv_array_push(&cp.args, am_path(state, "patch"));
1707 * Applies all queued mail.
1709 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1710 * well as the state directory's "patch" file is used as-is for applying the
1711 * patch and committing it.
1713 static void am_run(struct am_state *state, int resume)
1715 const char *argv_gc_auto[] = {"gc", "--auto", NULL};
1716 struct strbuf sb = STRBUF_INIT;
1718 unlink(am_path(state, "dirtyindex"));
1720 refresh_and_write_cache();
1722 if (index_has_changes(&the_index, NULL, &sb)) {
1723 write_state_bool(state, "dirtyindex", 1);
1724 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb.buf);
1727 strbuf_release(&sb);
1729 while (state->cur <= state->last) {
1730 const char *mail = am_path(state, msgnum(state));
1735 if (!file_exists(mail))
1739 validate_resume_state(state);
1743 if (state->rebasing)
1744 skip = parse_mail_rebase(state, mail);
1746 skip = parse_mail(state, mail);
1749 goto next; /* mail should be skipped */
1752 am_append_signoff(state);
1754 write_author_script(state);
1755 write_commit_msg(state);
1758 if (state->interactive && do_interactive(state))
1761 if (run_applypatch_msg_hook(state))
1764 say(state, stdout, _("Applying: %.*s"), linelen(state->msg), state->msg);
1766 apply_status = run_apply(state, NULL);
1768 if (apply_status && state->threeway) {
1769 struct strbuf sb = STRBUF_INIT;
1771 strbuf_addstr(&sb, am_path(state, "patch-merge-index"));
1772 apply_status = fall_back_threeway(state, sb.buf);
1773 strbuf_release(&sb);
1776 * Applying the patch to an earlier tree and merging
1777 * the result may have produced the same tree as ours.
1779 if (!apply_status &&
1780 !index_has_changes(&the_index, NULL, NULL)) {
1781 say(state, stdout, _("No changes -- Patch already applied."));
1787 printf_ln(_("Patch failed at %s %.*s"), msgnum(state),
1788 linelen(state->msg), state->msg);
1790 if (advice_amworkdir)
1791 advise(_("Use 'git am --show-current-patch' to see the failed patch"));
1793 die_user_resolve(state);
1806 if (!is_empty_file(am_path(state, "rewritten"))) {
1807 assert(state->rebasing);
1808 copy_notes_for_rebase(state);
1809 run_post_rewrite_hook(state);
1813 * In rebasing mode, it's up to the caller to take care of
1816 if (!state->rebasing) {
1818 close_all_packs(the_repository->objects);
1819 run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
1824 * Resume the current am session after patch application failure. The user did
1825 * all the hard work, and we do not have to do any patch application. Just
1826 * trust and commit what the user has in the index and working tree.
1828 static void am_resolve(struct am_state *state)
1830 validate_resume_state(state);
1832 say(state, stdout, _("Applying: %.*s"), linelen(state->msg), state->msg);
1834 if (!index_has_changes(&the_index, NULL, NULL)) {
1835 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1836 "If there is nothing left to stage, chances are that something else\n"
1837 "already introduced the same changes; you might want to skip this patch."));
1838 die_user_resolve(state);
1841 if (unmerged_cache()) {
1842 printf_ln(_("You still have unmerged paths in your index.\n"
1843 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1844 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1845 die_user_resolve(state);
1848 if (state->interactive) {
1849 write_index_patch(state);
1850 if (do_interactive(state))
1854 repo_rerere(the_repository, 0);
1865 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1866 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1869 static int fast_forward_to(struct tree *head, struct tree *remote, int reset)
1871 struct lock_file lock_file = LOCK_INIT;
1872 struct unpack_trees_options opts;
1873 struct tree_desc t[2];
1875 if (parse_tree(head) || parse_tree(remote))
1878 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
1880 refresh_cache(REFRESH_QUIET);
1882 memset(&opts, 0, sizeof(opts));
1884 opts.src_index = &the_index;
1885 opts.dst_index = &the_index;
1889 opts.fn = twoway_merge;
1890 init_tree_desc(&t[0], head->buffer, head->size);
1891 init_tree_desc(&t[1], remote->buffer, remote->size);
1893 if (unpack_trees(2, t, &opts)) {
1894 rollback_lock_file(&lock_file);
1898 if (write_locked_index(&the_index, &lock_file, COMMIT_LOCK))
1899 die(_("unable to write new index file"));
1905 * Merges a tree into the index. The index's stat info will take precedence
1906 * over the merged tree's. Returns 0 on success, -1 on failure.
1908 static int merge_tree(struct tree *tree)
1910 struct lock_file lock_file = LOCK_INIT;
1911 struct unpack_trees_options opts;
1912 struct tree_desc t[1];
1914 if (parse_tree(tree))
1917 hold_locked_index(&lock_file, LOCK_DIE_ON_ERROR);
1919 memset(&opts, 0, sizeof(opts));
1921 opts.src_index = &the_index;
1922 opts.dst_index = &the_index;
1924 opts.fn = oneway_merge;
1925 init_tree_desc(&t[0], tree->buffer, tree->size);
1927 if (unpack_trees(1, 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 * Clean the index without touching entries that are not modified between
1940 * `head` and `remote`.
1942 static int clean_index(const struct object_id *head, const struct object_id *remote)
1944 struct tree *head_tree, *remote_tree, *index_tree;
1945 struct object_id index;
1947 head_tree = parse_tree_indirect(head);
1949 return error(_("Could not parse object '%s'."), oid_to_hex(head));
1951 remote_tree = parse_tree_indirect(remote);
1953 return error(_("Could not parse object '%s'."), oid_to_hex(remote));
1955 read_cache_unmerged();
1957 if (fast_forward_to(head_tree, head_tree, 1))
1960 if (write_cache_as_tree(&index, 0, NULL))
1963 index_tree = parse_tree_indirect(&index);
1965 return error(_("Could not parse object '%s'."), oid_to_hex(&index));
1967 if (fast_forward_to(index_tree, remote_tree, 0))
1970 if (merge_tree(remote_tree))
1973 remove_branch_state();
1979 * Resets rerere's merge resolution metadata.
1981 static void am_rerere_clear(void)
1983 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1984 rerere_clear(&merge_rr);
1985 string_list_clear(&merge_rr, 1);
1989 * Resume the current am session by skipping the current patch.
1991 static void am_skip(struct am_state *state)
1993 struct object_id head;
1997 if (get_oid("HEAD", &head))
1998 oidcpy(&head, the_hash_algo->empty_tree);
2000 if (clean_index(&head, &head))
2001 die(_("failed to clean index"));
2009 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2011 * It is not safe to reset HEAD when:
2012 * 1. git-am previously failed because the index was dirty.
2013 * 2. HEAD has moved since git-am previously failed.
2015 static int safe_to_abort(const struct am_state *state)
2017 struct strbuf sb = STRBUF_INIT;
2018 struct object_id abort_safety, head;
2020 if (file_exists(am_path(state, "dirtyindex")))
2023 if (read_state_file(&sb, state, "abort-safety", 1) > 0) {
2024 if (get_oid_hex(sb.buf, &abort_safety))
2025 die(_("could not parse %s"), am_path(state, "abort-safety"));
2027 oidclr(&abort_safety);
2028 strbuf_release(&sb);
2030 if (get_oid("HEAD", &head))
2033 if (oideq(&head, &abort_safety))
2036 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2037 "Not rewinding to ORIG_HEAD"));
2043 * Aborts the current am session if it is safe to do so.
2045 static void am_abort(struct am_state *state)
2047 struct object_id curr_head, orig_head;
2048 int has_curr_head, has_orig_head;
2051 if (!safe_to_abort(state)) {
2058 curr_branch = resolve_refdup("HEAD", 0, &curr_head, NULL);
2059 has_curr_head = curr_branch && !is_null_oid(&curr_head);
2061 oidcpy(&curr_head, the_hash_algo->empty_tree);
2063 has_orig_head = !get_oid("ORIG_HEAD", &orig_head);
2065 oidcpy(&orig_head, the_hash_algo->empty_tree);
2067 clean_index(&curr_head, &orig_head);
2070 update_ref("am --abort", "HEAD", &orig_head,
2071 has_curr_head ? &curr_head : NULL, 0,
2072 UPDATE_REFS_DIE_ON_ERR);
2073 else if (curr_branch)
2074 delete_ref(NULL, curr_branch, NULL, REF_NO_DEREF);
2080 static int show_patch(struct am_state *state)
2082 struct strbuf sb = STRBUF_INIT;
2083 const char *patch_path;
2086 if (!is_null_oid(&state->orig_commit)) {
2087 const char *av[4] = { "show", NULL, "--", NULL };
2091 av[1] = new_oid_str = xstrdup(oid_to_hex(&state->orig_commit));
2092 ret = run_command_v_opt(av, RUN_GIT_CMD);
2097 patch_path = am_path(state, msgnum(state));
2098 len = strbuf_read_file(&sb, patch_path, 0);
2100 die_errno(_("failed to read '%s'"), patch_path);
2103 write_in_full(1, sb.buf, sb.len);
2104 strbuf_release(&sb);
2109 * parse_options() callback that validates and sets opt->value to the
2110 * PATCH_FORMAT_* enum value corresponding to `arg`.
2112 static int parse_opt_patchformat(const struct option *opt, const char *arg, int unset)
2114 int *opt_value = opt->value;
2117 *opt_value = PATCH_FORMAT_UNKNOWN;
2118 else if (!strcmp(arg, "mbox"))
2119 *opt_value = PATCH_FORMAT_MBOX;
2120 else if (!strcmp(arg, "stgit"))
2121 *opt_value = PATCH_FORMAT_STGIT;
2122 else if (!strcmp(arg, "stgit-series"))
2123 *opt_value = PATCH_FORMAT_STGIT_SERIES;
2124 else if (!strcmp(arg, "hg"))
2125 *opt_value = PATCH_FORMAT_HG;
2126 else if (!strcmp(arg, "mboxrd"))
2127 *opt_value = PATCH_FORMAT_MBOXRD;
2129 return error(_("Invalid value for --patch-format: %s"), arg);
2143 static int git_am_config(const char *k, const char *v, void *cb)
2147 status = git_gpg_config(k, v, NULL);
2151 return git_default_config(k, v, NULL);
2154 int cmd_am(int argc, const char **argv, const char *prefix)
2156 struct am_state state;
2159 int patch_format = PATCH_FORMAT_UNKNOWN;
2160 enum resume_mode resume = RESUME_FALSE;
2164 const char * const usage[] = {
2165 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2166 N_("git am [<options>] (--continue | --skip | --abort)"),
2170 struct option options[] = {
2171 OPT_BOOL('i', "interactive", &state.interactive,
2172 N_("run interactively")),
2173 OPT_HIDDEN_BOOL('b', "binary", &binary,
2174 N_("historical option -- no-op")),
2175 OPT_BOOL('3', "3way", &state.threeway,
2176 N_("allow fall back on 3way merging if needed")),
2177 OPT__QUIET(&state.quiet, N_("be quiet")),
2178 OPT_SET_INT('s', "signoff", &state.signoff,
2179 N_("add a Signed-off-by line to the commit message"),
2181 OPT_BOOL('u', "utf8", &state.utf8,
2182 N_("recode into utf8 (default)")),
2183 OPT_SET_INT('k', "keep", &state.keep,
2184 N_("pass -k flag to git-mailinfo"), KEEP_TRUE),
2185 OPT_SET_INT(0, "keep-non-patch", &state.keep,
2186 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH),
2187 OPT_BOOL('m', "message-id", &state.message_id,
2188 N_("pass -m flag to git-mailinfo")),
2189 OPT_SET_INT_F(0, "keep-cr", &keep_cr,
2190 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2191 1, PARSE_OPT_NONEG),
2192 OPT_SET_INT_F(0, "no-keep-cr", &keep_cr,
2193 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2194 0, PARSE_OPT_NONEG),
2195 OPT_BOOL('c', "scissors", &state.scissors,
2196 N_("strip everything before a scissors line")),
2197 OPT_PASSTHRU_ARGV(0, "whitespace", &state.git_apply_opts, N_("action"),
2198 N_("pass it through git-apply"),
2200 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state.git_apply_opts, NULL,
2201 N_("pass it through git-apply"),
2203 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state.git_apply_opts, NULL,
2204 N_("pass it through git-apply"),
2206 OPT_PASSTHRU_ARGV(0, "directory", &state.git_apply_opts, N_("root"),
2207 N_("pass it through git-apply"),
2209 OPT_PASSTHRU_ARGV(0, "exclude", &state.git_apply_opts, N_("path"),
2210 N_("pass it through git-apply"),
2212 OPT_PASSTHRU_ARGV(0, "include", &state.git_apply_opts, N_("path"),
2213 N_("pass it through git-apply"),
2215 OPT_PASSTHRU_ARGV('C', NULL, &state.git_apply_opts, N_("n"),
2216 N_("pass it through git-apply"),
2218 OPT_PASSTHRU_ARGV('p', NULL, &state.git_apply_opts, N_("num"),
2219 N_("pass it through git-apply"),
2221 OPT_CALLBACK(0, "patch-format", &patch_format, N_("format"),
2222 N_("format the patch(es) are in"),
2223 parse_opt_patchformat),
2224 OPT_PASSTHRU_ARGV(0, "reject", &state.git_apply_opts, NULL,
2225 N_("pass it through git-apply"),
2227 OPT_STRING(0, "resolvemsg", &state.resolvemsg, NULL,
2228 N_("override error message when patch failure occurs")),
2229 OPT_CMDMODE(0, "continue", &resume,
2230 N_("continue applying patches after resolving a conflict"),
2232 OPT_CMDMODE('r', "resolved", &resume,
2233 N_("synonyms for --continue"),
2235 OPT_CMDMODE(0, "skip", &resume,
2236 N_("skip the current patch"),
2238 OPT_CMDMODE(0, "abort", &resume,
2239 N_("restore the original branch and abort the patching operation."),
2241 OPT_CMDMODE(0, "quit", &resume,
2242 N_("abort the patching operation but keep HEAD where it is."),
2244 OPT_CMDMODE(0, "show-current-patch", &resume,
2245 N_("show the patch being applied."),
2247 OPT_BOOL(0, "committer-date-is-author-date",
2248 &state.committer_date_is_author_date,
2249 N_("lie about committer date")),
2250 OPT_BOOL(0, "ignore-date", &state.ignore_date,
2251 N_("use current timestamp for author date")),
2252 OPT_RERERE_AUTOUPDATE(&state.allow_rerere_autoupdate),
2253 { OPTION_STRING, 'S', "gpg-sign", &state.sign_commit, N_("key-id"),
2254 N_("GPG-sign commits"),
2255 PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
2256 OPT_HIDDEN_BOOL(0, "rebasing", &state.rebasing,
2257 N_("(internal use for git-rebase)")),
2261 if (argc == 2 && !strcmp(argv[1], "-h"))
2262 usage_with_options(usage, options);
2264 git_config(git_am_config, NULL);
2266 am_state_init(&state);
2268 in_progress = am_in_progress(&state);
2272 argc = parse_options(argc, argv, prefix, options, usage, 0);
2275 fprintf_ln(stderr, _("The -b/--binary option has been a no-op for long time, and\n"
2276 "it will be removed. Please do not use it anymore."));
2278 /* Ensure a valid committer ident can be constructed */
2279 git_committer_info(IDENT_STRICT);
2281 if (read_index_preload(&the_index, NULL, 0) < 0)
2282 die(_("failed to read the index"));
2286 * Catch user error to feed us patches when there is a session
2289 * 1. mbox path(s) are provided on the command-line.
2290 * 2. stdin is not a tty: the user is trying to feed us a patch
2291 * from standard input. This is somewhat unreliable -- stdin
2292 * could be /dev/null for example and the caller did not
2293 * intend to feed us a patch but wanted to continue
2296 if (argc || (resume == RESUME_FALSE && !isatty(0)))
2297 die(_("previous rebase directory %s still exists but mbox given."),
2300 if (resume == RESUME_FALSE)
2301 resume = RESUME_APPLY;
2303 if (state.signoff == SIGNOFF_EXPLICIT)
2304 am_append_signoff(&state);
2306 struct argv_array paths = ARGV_ARRAY_INIT;
2310 * Handle stray state directory in the independent-run case. In
2311 * the --rebasing case, it is up to the caller to take care of
2312 * stray directories.
2314 if (file_exists(state.dir) && !state.rebasing) {
2315 if (resume == RESUME_ABORT || resume == RESUME_QUIT) {
2317 am_state_release(&state);
2321 die(_("Stray %s directory found.\n"
2322 "Use \"git am --abort\" to remove it."),
2327 die(_("Resolve operation not in progress, we are not resuming."));
2329 for (i = 0; i < argc; i++) {
2330 if (is_absolute_path(argv[i]) || !prefix)
2331 argv_array_push(&paths, argv[i]);
2333 argv_array_push(&paths, mkpath("%s/%s", prefix, argv[i]));
2336 am_setup(&state, patch_format, paths.argv, keep_cr);
2338 argv_array_clear(&paths);
2348 case RESUME_RESOLVED:
2361 case RESUME_SHOW_PATCH:
2362 ret = show_patch(&state);
2365 BUG("invalid resume value");
2368 am_state_release(&state);