4 * Based on git-am.sh by Junio C Hamano.
9 #include "parse-options.h"
11 #include "run-command.h"
14 #include "cache-tree.h"
19 #include "unpack-trees.h"
21 #include "sequencer.h"
23 #include "merge-recursive.h"
26 #include "notes-utils.h"
31 * Returns 1 if the file is empty or does not exist, 0 otherwise.
33 static int is_empty_file(const char *filename
)
37 if (stat(filename
, &st
) < 0) {
40 die_errno(_("could not stat %s"), filename
);
47 * Like strbuf_getline(), but treats both '\n' and "\r\n" as line terminators.
49 static int strbuf_getline_crlf(struct strbuf
*sb
, FILE *fp
)
51 if (strbuf_getwholeline(sb
, fp
, '\n'))
53 if (sb
->buf
[sb
->len
- 1] == '\n') {
54 strbuf_setlen(sb
, sb
->len
- 1);
55 if (sb
->len
> 0 && sb
->buf
[sb
->len
- 1] == '\r')
56 strbuf_setlen(sb
, sb
->len
- 1);
62 * Returns the length of the first line of msg.
64 static int linelen(const char *msg
)
66 return strchrnul(msg
, '\n') - msg
;
70 * Returns true if `str` consists of only whitespace, false otherwise.
72 static int str_isspace(const char *str
)
82 PATCH_FORMAT_UNKNOWN
= 0,
85 PATCH_FORMAT_STGIT_SERIES
,
91 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
92 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
97 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
98 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
104 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
108 /* state directory path */
111 /* current and last patch numbers, 1-indexed */
115 /* commit metadata and message */
122 /* when --rebasing, records the original commit the patch came from */
123 unsigned char orig_commit
[GIT_SHA1_RAWSZ
];
125 /* number of digits in patch filename */
128 /* various operating modes and command line options */
132 int signoff
; /* enum signoff_type */
134 int keep
; /* enum keep_type */
136 int scissors
; /* enum scissors_type */
137 struct argv_array git_apply_opts
;
138 const char *resolvemsg
;
139 int committer_date_is_author_date
;
141 int allow_rerere_autoupdate
;
142 const char *sign_commit
;
147 * Initializes am_state with the default values. The state directory is set to
150 static void am_state_init(struct am_state
*state
, const char *dir
)
154 memset(state
, 0, sizeof(*state
));
157 state
->dir
= xstrdup(dir
);
161 git_config_get_bool("am.threeway", &state
->threeway
);
165 git_config_get_bool("am.messageid", &state
->message_id
);
167 state
->scissors
= SCISSORS_UNSET
;
169 argv_array_init(&state
->git_apply_opts
);
171 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
172 state
->sign_commit
= gpgsign
? "" : NULL
;
176 * Releases memory allocated by an am_state.
178 static void am_state_release(struct am_state
*state
)
181 free(state
->author_name
);
182 free(state
->author_email
);
183 free(state
->author_date
);
185 argv_array_clear(&state
->git_apply_opts
);
189 * Returns path relative to the am_state directory.
191 static inline const char *am_path(const struct am_state
*state
, const char *path
)
193 return mkpath("%s/%s", state
->dir
, path
);
197 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
200 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
206 vfprintf(fp
, fmt
, ap
);
213 * Returns 1 if there is an am session in progress, 0 otherwise.
215 static int am_in_progress(const struct am_state
*state
)
219 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
221 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
223 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
229 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
230 * number of bytes read on success, -1 if the file does not exist. If `trim` is
231 * set, trailing whitespace will be removed.
233 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
234 const char *file
, int trim
)
238 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
248 die_errno(_("could not read '%s'"), am_path(state
, file
));
252 * Reads a KEY=VALUE shell variable assignment from `fp`, returning the VALUE
253 * as a newly-allocated string. VALUE must be a quoted string, and the KEY must
254 * match `key`. Returns NULL on failure.
256 * This is used by read_author_script() to read the GIT_AUTHOR_* variables from
259 static char *read_shell_var(FILE *fp
, const char *key
)
261 struct strbuf sb
= STRBUF_INIT
;
264 if (strbuf_getline(&sb
, fp
, '\n'))
267 if (!skip_prefix(sb
.buf
, key
, &str
))
270 if (!skip_prefix(str
, "=", &str
))
273 strbuf_remove(&sb
, 0, str
- sb
.buf
);
275 str
= sq_dequote(sb
.buf
);
279 return strbuf_detach(&sb
, NULL
);
287 * Reads and parses the state directory's "author-script" file, and sets
288 * state->author_name, state->author_email and state->author_date accordingly.
289 * Returns 0 on success, -1 if the file could not be parsed.
291 * The author script is of the format:
293 * GIT_AUTHOR_NAME='$author_name'
294 * GIT_AUTHOR_EMAIL='$author_email'
295 * GIT_AUTHOR_DATE='$author_date'
297 * where $author_name, $author_email and $author_date are quoted. We are strict
298 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
299 * script, and thus if the file differs from what this function expects, it is
300 * better to bail out than to do something that the user does not expect.
302 static int read_author_script(struct am_state
*state
)
304 const char *filename
= am_path(state
, "author-script");
307 assert(!state
->author_name
);
308 assert(!state
->author_email
);
309 assert(!state
->author_date
);
311 fp
= fopen(filename
, "r");
315 die_errno(_("could not open '%s' for reading"), filename
);
318 state
->author_name
= read_shell_var(fp
, "GIT_AUTHOR_NAME");
319 if (!state
->author_name
) {
324 state
->author_email
= read_shell_var(fp
, "GIT_AUTHOR_EMAIL");
325 if (!state
->author_email
) {
330 state
->author_date
= read_shell_var(fp
, "GIT_AUTHOR_DATE");
331 if (!state
->author_date
) {
336 if (fgetc(fp
) != EOF
) {
346 * Saves state->author_name, state->author_email and state->author_date in the
347 * state directory's "author-script" file.
349 static void write_author_script(const struct am_state
*state
)
351 struct strbuf sb
= STRBUF_INIT
;
353 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
354 sq_quote_buf(&sb
, state
->author_name
);
355 strbuf_addch(&sb
, '\n');
357 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
358 sq_quote_buf(&sb
, state
->author_email
);
359 strbuf_addch(&sb
, '\n');
361 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
362 sq_quote_buf(&sb
, state
->author_date
);
363 strbuf_addch(&sb
, '\n');
365 write_file(am_path(state
, "author-script"), 1, "%s", sb
.buf
);
371 * Reads the commit message from the state directory's "final-commit" file,
372 * setting state->msg to its contents and state->msg_len to the length of its
375 * Returns 0 on success, -1 if the file does not exist.
377 static int read_commit_msg(struct am_state
*state
)
379 struct strbuf sb
= STRBUF_INIT
;
383 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
388 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
393 * Saves state->msg in the state directory's "final-commit" file.
395 static void write_commit_msg(const struct am_state
*state
)
398 const char *filename
= am_path(state
, "final-commit");
400 fd
= xopen(filename
, O_WRONLY
| O_CREAT
, 0666);
401 if (write_in_full(fd
, state
->msg
, state
->msg_len
) < 0)
402 die_errno(_("could not write to %s"), filename
);
407 * Loads state from disk.
409 static void am_load(struct am_state
*state
)
411 struct strbuf sb
= STRBUF_INIT
;
413 if (read_state_file(&sb
, state
, "next", 1) < 0)
414 die("BUG: state file 'next' does not exist");
415 state
->cur
= strtol(sb
.buf
, NULL
, 10);
417 if (read_state_file(&sb
, state
, "last", 1) < 0)
418 die("BUG: state file 'last' does not exist");
419 state
->last
= strtol(sb
.buf
, NULL
, 10);
421 if (read_author_script(state
) < 0)
422 die(_("could not parse author script"));
424 read_commit_msg(state
);
426 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
427 hashclr(state
->orig_commit
);
428 else if (get_sha1_hex(sb
.buf
, state
->orig_commit
) < 0)
429 die(_("could not parse %s"), am_path(state
, "original-commit"));
431 read_state_file(&sb
, state
, "threeway", 1);
432 state
->threeway
= !strcmp(sb
.buf
, "t");
434 read_state_file(&sb
, state
, "quiet", 1);
435 state
->quiet
= !strcmp(sb
.buf
, "t");
437 read_state_file(&sb
, state
, "sign", 1);
438 state
->signoff
= !strcmp(sb
.buf
, "t");
440 read_state_file(&sb
, state
, "utf8", 1);
441 state
->utf8
= !strcmp(sb
.buf
, "t");
443 read_state_file(&sb
, state
, "keep", 1);
444 if (!strcmp(sb
.buf
, "t"))
445 state
->keep
= KEEP_TRUE
;
446 else if (!strcmp(sb
.buf
, "b"))
447 state
->keep
= KEEP_NON_PATCH
;
449 state
->keep
= KEEP_FALSE
;
451 read_state_file(&sb
, state
, "messageid", 1);
452 state
->message_id
= !strcmp(sb
.buf
, "t");
454 read_state_file(&sb
, state
, "scissors", 1);
455 if (!strcmp(sb
.buf
, "t"))
456 state
->scissors
= SCISSORS_TRUE
;
457 else if (!strcmp(sb
.buf
, "f"))
458 state
->scissors
= SCISSORS_FALSE
;
460 state
->scissors
= SCISSORS_UNSET
;
462 read_state_file(&sb
, state
, "apply-opt", 1);
463 argv_array_clear(&state
->git_apply_opts
);
464 if (sq_dequote_to_argv_array(sb
.buf
, &state
->git_apply_opts
) < 0)
465 die(_("could not parse %s"), am_path(state
, "apply-opt"));
467 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
473 * Removes the am_state directory, forcefully terminating the current am
476 static void am_destroy(const struct am_state
*state
)
478 struct strbuf sb
= STRBUF_INIT
;
480 strbuf_addstr(&sb
, state
->dir
);
481 remove_dir_recursively(&sb
, 0);
486 * Runs applypatch-msg hook. Returns its exit code.
488 static int run_applypatch_msg_hook(struct am_state
*state
)
493 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
498 if (read_commit_msg(state
) < 0)
499 die(_("'%s' was deleted by the applypatch-msg hook"),
500 am_path(state
, "final-commit"));
507 * Runs post-rewrite hook. Returns it exit code.
509 static int run_post_rewrite_hook(const struct am_state
*state
)
511 struct child_process cp
= CHILD_PROCESS_INIT
;
512 const char *hook
= find_hook("post-rewrite");
518 argv_array_push(&cp
.args
, hook
);
519 argv_array_push(&cp
.args
, "rebase");
521 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
522 cp
.stdout_to_stderr
= 1;
524 ret
= run_command(&cp
);
531 * Reads the state directory's "rewritten" file, and copies notes from the old
532 * commits listed in the file to their rewritten commits.
534 * Returns 0 on success, -1 on failure.
536 static int copy_notes_for_rebase(const struct am_state
*state
)
538 struct notes_rewrite_cfg
*c
;
539 struct strbuf sb
= STRBUF_INIT
;
540 const char *invalid_line
= _("Malformed input line: '%s'.");
541 const char *msg
= "Notes added by 'git rebase'";
545 assert(state
->rebasing
);
547 c
= init_copy_notes_for_rewrite("rebase");
551 fp
= xfopen(am_path(state
, "rewritten"), "r");
553 while (!strbuf_getline(&sb
, fp
, '\n')) {
554 unsigned char from_obj
[GIT_SHA1_RAWSZ
], to_obj
[GIT_SHA1_RAWSZ
];
556 if (sb
.len
!= GIT_SHA1_HEXSZ
* 2 + 1) {
557 ret
= error(invalid_line
, sb
.buf
);
561 if (get_sha1_hex(sb
.buf
, from_obj
)) {
562 ret
= error(invalid_line
, sb
.buf
);
566 if (sb
.buf
[GIT_SHA1_HEXSZ
] != ' ') {
567 ret
= error(invalid_line
, sb
.buf
);
571 if (get_sha1_hex(sb
.buf
+ GIT_SHA1_HEXSZ
+ 1, to_obj
)) {
572 ret
= error(invalid_line
, sb
.buf
);
576 if (copy_note_for_rewrite(c
, from_obj
, to_obj
))
577 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
578 sha1_to_hex(from_obj
), sha1_to_hex(to_obj
));
582 finish_copy_notes_for_rewrite(c
, msg
);
589 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
590 * non-indented lines and checking if they look like they begin with valid
591 * header field names.
593 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
595 static int is_mail(FILE *fp
)
597 const char *header_regex
= "^[!-9;-~]+:";
598 struct strbuf sb
= STRBUF_INIT
;
602 if (fseek(fp
, 0L, SEEK_SET
))
603 die_errno(_("fseek failed"));
605 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
606 die("invalid pattern: %s", header_regex
);
608 while (!strbuf_getline_crlf(&sb
, fp
)) {
610 break; /* End of header */
612 /* Ignore indented folded lines */
613 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
616 /* It's a header if it matches header_regex */
617 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
630 * Attempts to detect the patch_format of the patches contained in `paths`,
631 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
634 static int detect_patch_format(const char **paths
)
636 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
637 struct strbuf l1
= STRBUF_INIT
;
638 struct strbuf l2
= STRBUF_INIT
;
639 struct strbuf l3
= STRBUF_INIT
;
643 * We default to mbox format if input is from stdin and for directories
645 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
646 return PATCH_FORMAT_MBOX
;
649 * Otherwise, check the first few lines of the first patch, starting
650 * from the first non-blank line, to try to detect its format.
653 fp
= xfopen(*paths
, "r");
655 while (!strbuf_getline_crlf(&l1
, fp
)) {
660 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
661 ret
= PATCH_FORMAT_MBOX
;
665 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
666 ret
= PATCH_FORMAT_STGIT_SERIES
;
670 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
671 ret
= PATCH_FORMAT_HG
;
676 strbuf_getline_crlf(&l2
, fp
);
678 strbuf_getline_crlf(&l3
, fp
);
681 * If the second line is empty and the third is a From, Author or Date
682 * entry, this is likely an StGit patch.
684 if (l1
.len
&& !l2
.len
&&
685 (starts_with(l3
.buf
, "From:") ||
686 starts_with(l3
.buf
, "Author:") ||
687 starts_with(l3
.buf
, "Date:"))) {
688 ret
= PATCH_FORMAT_STGIT
;
692 if (l1
.len
&& is_mail(fp
)) {
693 ret
= PATCH_FORMAT_MBOX
;
704 * Splits out individual email patches from `paths`, where each path is either
705 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
707 static int split_mail_mbox(struct am_state
*state
, const char **paths
, int keep_cr
)
709 struct child_process cp
= CHILD_PROCESS_INIT
;
710 struct strbuf last
= STRBUF_INIT
;
713 argv_array_push(&cp
.args
, "mailsplit");
714 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
715 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
716 argv_array_push(&cp
.args
, "-b");
718 argv_array_push(&cp
.args
, "--keep-cr");
719 argv_array_push(&cp
.args
, "--");
720 argv_array_pushv(&cp
.args
, paths
);
722 if (capture_command(&cp
, &last
, 8))
726 state
->last
= strtol(last
.buf
, NULL
, 10);
732 * Callback signature for split_mail_conv(). The foreign patch should be
733 * read from `in`, and the converted patch (in RFC2822 mail format) should be
734 * written to `out`. Return 0 on success, or -1 on failure.
736 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
739 * Calls `fn` for each file in `paths` to convert the foreign patch to the
740 * RFC2822 mail format suitable for parsing with git-mailinfo.
742 * Returns 0 on success, -1 on failure.
744 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
745 const char **paths
, int keep_cr
)
747 static const char *stdin_only
[] = {"-", NULL
};
753 for (i
= 0; *paths
; paths
++, i
++) {
758 if (!strcmp(*paths
, "-"))
761 in
= fopen(*paths
, "r");
764 return error(_("could not open '%s' for reading: %s"),
765 *paths
, strerror(errno
));
767 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
769 out
= fopen(mail
, "w");
771 return error(_("could not open '%s' for writing: %s"),
772 mail
, strerror(errno
));
774 ret
= fn(out
, in
, keep_cr
);
780 return error(_("could not parse patch '%s'"), *paths
);
789 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
790 * message suitable for parsing with git-mailinfo.
792 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
794 struct strbuf sb
= STRBUF_INIT
;
795 int subject_printed
= 0;
797 while (!strbuf_getline(&sb
, in
, '\n')) {
800 if (str_isspace(sb
.buf
))
802 else if (skip_prefix(sb
.buf
, "Author:", &str
))
803 fprintf(out
, "From:%s\n", str
);
804 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
805 fprintf(out
, "%s\n", sb
.buf
);
806 else if (!subject_printed
) {
807 fprintf(out
, "Subject: %s\n", sb
.buf
);
810 fprintf(out
, "\n%s\n", sb
.buf
);
816 while (strbuf_fread(&sb
, 8192, in
) > 0) {
817 fwrite(sb
.buf
, 1, sb
.len
, out
);
826 * This function only supports a single StGit series file in `paths`.
828 * Given an StGit series file, converts the StGit patches in the series into
829 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
830 * the state directory.
832 * Returns 0 on success, -1 on failure.
834 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
837 const char *series_dir
;
838 char *series_dir_buf
;
840 struct argv_array patches
= ARGV_ARRAY_INIT
;
841 struct strbuf sb
= STRBUF_INIT
;
844 if (!paths
[0] || paths
[1])
845 return error(_("Only one StGIT patch series can be applied at once"));
847 series_dir_buf
= xstrdup(*paths
);
848 series_dir
= dirname(series_dir_buf
);
850 fp
= fopen(*paths
, "r");
852 return error(_("could not open '%s' for reading: %s"), *paths
,
855 while (!strbuf_getline(&sb
, fp
, '\n')) {
857 continue; /* skip comment lines */
859 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
864 free(series_dir_buf
);
866 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
868 argv_array_clear(&patches
);
873 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
874 * message suitable for parsing with git-mailinfo.
876 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
878 struct strbuf sb
= STRBUF_INIT
;
880 while (!strbuf_getline(&sb
, in
, '\n')) {
883 if (skip_prefix(sb
.buf
, "# User ", &str
))
884 fprintf(out
, "From: %s\n", str
);
885 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
886 unsigned long timestamp
;
891 timestamp
= strtoul(str
, &end
, 10);
893 return error(_("invalid timestamp"));
895 if (!skip_prefix(end
, " ", &str
))
896 return error(_("invalid Date line"));
899 tz
= strtol(str
, &end
, 10);
901 return error(_("invalid timezone offset"));
904 return error(_("invalid Date line"));
907 * mercurial's timezone is in seconds west of UTC,
908 * however git's timezone is in hours + minutes east of
911 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
915 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
916 } else if (starts_with(sb
.buf
, "# ")) {
919 fprintf(out
, "\n%s\n", sb
.buf
);
925 while (strbuf_fread(&sb
, 8192, in
) > 0) {
926 fwrite(sb
.buf
, 1, sb
.len
, out
);
935 * Splits a list of files/directories into individual email patches. Each path
936 * in `paths` must be a file/directory that is formatted according to
939 * Once split out, the individual email patches will be stored in the state
940 * directory, with each patch's filename being its index, padded to state->prec
943 * state->cur will be set to the index of the first mail, and state->last will
944 * be set to the index of the last mail.
946 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
947 * to disable this behavior, -1 to use the default configured setting.
949 * Returns 0 on success, -1 on failure.
951 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
952 const char **paths
, int keep_cr
)
956 git_config_get_bool("am.keepcr", &keep_cr
);
959 switch (patch_format
) {
960 case PATCH_FORMAT_MBOX
:
961 return split_mail_mbox(state
, paths
, keep_cr
);
962 case PATCH_FORMAT_STGIT
:
963 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
964 case PATCH_FORMAT_STGIT_SERIES
:
965 return split_mail_stgit_series(state
, paths
, keep_cr
);
966 case PATCH_FORMAT_HG
:
967 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
969 die("BUG: invalid patch_format");
975 * Setup a new am session for applying patches
977 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
978 const char **paths
, int keep_cr
)
980 unsigned char curr_head
[GIT_SHA1_RAWSZ
];
982 struct strbuf sb
= STRBUF_INIT
;
985 patch_format
= detect_patch_format(paths
);
988 fprintf_ln(stderr
, _("Patch format detection failed."));
992 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
993 die_errno(_("failed to create directory '%s'"), state
->dir
);
995 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
997 die(_("Failed to split patches."));
1000 if (state
->rebasing
)
1001 state
->threeway
= 1;
1003 write_file(am_path(state
, "threeway"), 1, state
->threeway
? "t" : "f");
1005 write_file(am_path(state
, "quiet"), 1, state
->quiet
? "t" : "f");
1007 write_file(am_path(state
, "sign"), 1, state
->signoff
? "t" : "f");
1009 write_file(am_path(state
, "utf8"), 1, state
->utf8
? "t" : "f");
1011 switch (state
->keep
) {
1018 case KEEP_NON_PATCH
:
1022 die("BUG: invalid value for state->keep");
1025 write_file(am_path(state
, "keep"), 1, "%s", str
);
1027 write_file(am_path(state
, "messageid"), 1, state
->message_id
? "t" : "f");
1029 switch (state
->scissors
) {
1030 case SCISSORS_UNSET
:
1033 case SCISSORS_FALSE
:
1040 die("BUG: invalid value for state->scissors");
1043 write_file(am_path(state
, "scissors"), 1, "%s", str
);
1045 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
, 0);
1046 write_file(am_path(state
, "apply-opt"), 1, "%s", sb
.buf
);
1048 if (state
->rebasing
)
1049 write_file(am_path(state
, "rebasing"), 1, "%s", "");
1051 write_file(am_path(state
, "applying"), 1, "%s", "");
1053 if (!get_sha1("HEAD", curr_head
)) {
1054 write_file(am_path(state
, "abort-safety"), 1, "%s", sha1_to_hex(curr_head
));
1055 if (!state
->rebasing
)
1056 update_ref("am", "ORIG_HEAD", curr_head
, NULL
, 0,
1057 UPDATE_REFS_DIE_ON_ERR
);
1059 write_file(am_path(state
, "abort-safety"), 1, "%s", "");
1060 if (!state
->rebasing
)
1061 delete_ref("ORIG_HEAD", NULL
, 0);
1065 * NOTE: Since the "next" and "last" files determine if an am_state
1066 * session is in progress, they should be written last.
1069 write_file(am_path(state
, "next"), 1, "%d", state
->cur
);
1071 write_file(am_path(state
, "last"), 1, "%d", state
->last
);
1073 strbuf_release(&sb
);
1077 * Increments the patch pointer, and cleans am_state for the application of the
1080 static void am_next(struct am_state
*state
)
1082 unsigned char head
[GIT_SHA1_RAWSZ
];
1084 free(state
->author_name
);
1085 state
->author_name
= NULL
;
1087 free(state
->author_email
);
1088 state
->author_email
= NULL
;
1090 free(state
->author_date
);
1091 state
->author_date
= NULL
;
1097 unlink(am_path(state
, "author-script"));
1098 unlink(am_path(state
, "final-commit"));
1100 hashclr(state
->orig_commit
);
1101 unlink(am_path(state
, "original-commit"));
1103 if (!get_sha1("HEAD", head
))
1104 write_file(am_path(state
, "abort-safety"), 1, "%s", sha1_to_hex(head
));
1106 write_file(am_path(state
, "abort-safety"), 1, "%s", "");
1109 write_file(am_path(state
, "next"), 1, "%d", state
->cur
);
1113 * Returns the filename of the current patch email.
1115 static const char *msgnum(const struct am_state
*state
)
1117 static struct strbuf sb
= STRBUF_INIT
;
1120 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1126 * Refresh and write index.
1128 static void refresh_and_write_cache(void)
1130 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
1132 hold_locked_index(lock_file
, 1);
1133 refresh_cache(REFRESH_QUIET
);
1134 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1135 die(_("unable to write index file"));
1139 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
1140 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
1141 * strbuf is provided, the space-separated list of files that differ will be
1144 static int index_has_changes(struct strbuf
*sb
)
1146 unsigned char head
[GIT_SHA1_RAWSZ
];
1149 if (!get_sha1_tree("HEAD", head
)) {
1150 struct diff_options opt
;
1153 DIFF_OPT_SET(&opt
, EXIT_WITH_STATUS
);
1155 DIFF_OPT_SET(&opt
, QUICK
);
1156 do_diff_cache(head
, &opt
);
1158 for (i
= 0; sb
&& i
< diff_queued_diff
.nr
; i
++) {
1160 strbuf_addch(sb
, ' ');
1161 strbuf_addstr(sb
, diff_queued_diff
.queue
[i
]->two
->path
);
1164 return DIFF_OPT_TST(&opt
, HAS_CHANGES
) != 0;
1166 for (i
= 0; sb
&& i
< active_nr
; i
++) {
1168 strbuf_addch(sb
, ' ');
1169 strbuf_addstr(sb
, active_cache
[i
]->name
);
1176 * Dies with a user-friendly message on how to proceed after resolving the
1177 * problem. This message can be overridden with state->resolvemsg.
1179 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1181 if (state
->resolvemsg
) {
1182 printf_ln("%s", state
->resolvemsg
);
1184 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1186 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1187 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1188 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1195 * Appends signoff to the "msg" field of the am_state.
1197 static void am_append_signoff(struct am_state
*state
)
1199 struct strbuf sb
= STRBUF_INIT
;
1201 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1202 append_signoff(&sb
, 0, 0);
1203 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1207 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1208 * state->msg will be set to the patch message. state->author_name,
1209 * state->author_email and state->author_date will be set to the patch author's
1210 * name, email and date respectively. The patch body will be written to the
1211 * state directory's "patch" file.
1213 * Returns 1 if the patch should be skipped, 0 otherwise.
1215 static int parse_mail(struct am_state
*state
, const char *mail
)
1218 struct child_process cp
= CHILD_PROCESS_INIT
;
1219 struct strbuf sb
= STRBUF_INIT
;
1220 struct strbuf msg
= STRBUF_INIT
;
1221 struct strbuf author_name
= STRBUF_INIT
;
1222 struct strbuf author_date
= STRBUF_INIT
;
1223 struct strbuf author_email
= STRBUF_INIT
;
1227 cp
.in
= xopen(mail
, O_RDONLY
, 0);
1228 cp
.out
= xopen(am_path(state
, "info"), O_WRONLY
| O_CREAT
, 0777);
1230 argv_array_push(&cp
.args
, "mailinfo");
1231 argv_array_push(&cp
.args
, state
->utf8
? "-u" : "-n");
1233 switch (state
->keep
) {
1237 argv_array_push(&cp
.args
, "-k");
1239 case KEEP_NON_PATCH
:
1240 argv_array_push(&cp
.args
, "-b");
1243 die("BUG: invalid value for state->keep");
1246 if (state
->message_id
)
1247 argv_array_push(&cp
.args
, "-m");
1249 switch (state
->scissors
) {
1250 case SCISSORS_UNSET
:
1252 case SCISSORS_FALSE
:
1253 argv_array_push(&cp
.args
, "--no-scissors");
1256 argv_array_push(&cp
.args
, "--scissors");
1259 die("BUG: invalid value for state->scissors");
1262 argv_array_push(&cp
.args
, am_path(state
, "msg"));
1263 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1265 if (run_command(&cp
) < 0)
1266 die("could not parse patch");
1271 /* Extract message and author information */
1272 fp
= xfopen(am_path(state
, "info"), "r");
1273 while (!strbuf_getline(&sb
, fp
, '\n')) {
1276 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1278 strbuf_addch(&msg
, '\n');
1279 strbuf_addstr(&msg
, x
);
1280 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1281 strbuf_addstr(&author_name
, x
);
1282 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1283 strbuf_addstr(&author_email
, x
);
1284 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1285 strbuf_addstr(&author_date
, x
);
1289 /* Skip pine's internal folder data */
1290 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1295 if (is_empty_file(am_path(state
, "patch"))) {
1296 printf_ln(_("Patch is empty. Was it split wrong?"));
1297 die_user_resolve(state
);
1300 strbuf_addstr(&msg
, "\n\n");
1301 if (strbuf_read_file(&msg
, am_path(state
, "msg"), 0) < 0)
1302 die_errno(_("could not read '%s'"), am_path(state
, "msg"));
1303 stripspace(&msg
, 0);
1306 append_signoff(&msg
, 0, 0);
1308 assert(!state
->author_name
);
1309 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1311 assert(!state
->author_email
);
1312 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1314 assert(!state
->author_date
);
1315 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1317 assert(!state
->msg
);
1318 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1321 strbuf_release(&msg
);
1322 strbuf_release(&author_date
);
1323 strbuf_release(&author_email
);
1324 strbuf_release(&author_name
);
1325 strbuf_release(&sb
);
1330 * Sets commit_id to the commit hash where the mail was generated from.
1331 * Returns 0 on success, -1 on failure.
1333 static int get_mail_commit_sha1(unsigned char *commit_id
, const char *mail
)
1335 struct strbuf sb
= STRBUF_INIT
;
1336 FILE *fp
= xfopen(mail
, "r");
1339 if (strbuf_getline(&sb
, fp
, '\n'))
1342 if (!skip_prefix(sb
.buf
, "From ", &x
))
1345 if (get_sha1_hex(x
, commit_id
) < 0)
1348 strbuf_release(&sb
);
1354 * Sets state->msg, state->author_name, state->author_email, state->author_date
1355 * to the commit's respective info.
1357 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1359 const char *buffer
, *ident_line
, *author_date
, *msg
;
1361 struct ident_split ident_split
;
1362 struct strbuf sb
= STRBUF_INIT
;
1364 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1366 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1368 if (split_ident_line(&ident_split
, ident_line
, ident_len
) < 0) {
1369 strbuf_add(&sb
, ident_line
, ident_len
);
1370 die(_("invalid ident line: %s"), sb
.buf
);
1373 assert(!state
->author_name
);
1374 if (ident_split
.name_begin
) {
1375 strbuf_add(&sb
, ident_split
.name_begin
,
1376 ident_split
.name_end
- ident_split
.name_begin
);
1377 state
->author_name
= strbuf_detach(&sb
, NULL
);
1379 state
->author_name
= xstrdup("");
1381 assert(!state
->author_email
);
1382 if (ident_split
.mail_begin
) {
1383 strbuf_add(&sb
, ident_split
.mail_begin
,
1384 ident_split
.mail_end
- ident_split
.mail_begin
);
1385 state
->author_email
= strbuf_detach(&sb
, NULL
);
1387 state
->author_email
= xstrdup("");
1389 author_date
= show_ident_date(&ident_split
, DATE_MODE(NORMAL
));
1390 strbuf_addstr(&sb
, author_date
);
1391 assert(!state
->author_date
);
1392 state
->author_date
= strbuf_detach(&sb
, NULL
);
1394 assert(!state
->msg
);
1395 msg
= strstr(buffer
, "\n\n");
1397 die(_("unable to parse commit %s"), sha1_to_hex(commit
->object
.sha1
));
1398 state
->msg
= xstrdup(msg
+ 2);
1399 state
->msg_len
= strlen(state
->msg
);
1403 * Writes `commit` as a patch to the state directory's "patch" file.
1405 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1407 struct rev_info rev_info
;
1410 fp
= xfopen(am_path(state
, "patch"), "w");
1411 init_revisions(&rev_info
, NULL
);
1413 rev_info
.abbrev
= 0;
1414 rev_info
.disable_stdin
= 1;
1415 rev_info
.show_root_diff
= 1;
1416 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1417 rev_info
.no_commit_id
= 1;
1418 DIFF_OPT_SET(&rev_info
.diffopt
, BINARY
);
1419 DIFF_OPT_SET(&rev_info
.diffopt
, FULL_INDEX
);
1420 rev_info
.diffopt
.use_color
= 0;
1421 rev_info
.diffopt
.file
= fp
;
1422 rev_info
.diffopt
.close_file
= 1;
1423 add_pending_object(&rev_info
, &commit
->object
, "");
1424 diff_setup_done(&rev_info
.diffopt
);
1425 log_tree_commit(&rev_info
, commit
);
1429 * Writes the diff of the index against HEAD as a patch to the state
1430 * directory's "patch" file.
1432 static void write_index_patch(const struct am_state
*state
)
1435 unsigned char head
[GIT_SHA1_RAWSZ
];
1436 struct rev_info rev_info
;
1439 if (!get_sha1_tree("HEAD", head
))
1440 tree
= lookup_tree(head
);
1442 tree
= lookup_tree(EMPTY_TREE_SHA1_BIN
);
1444 fp
= xfopen(am_path(state
, "patch"), "w");
1445 init_revisions(&rev_info
, NULL
);
1447 rev_info
.disable_stdin
= 1;
1448 rev_info
.no_commit_id
= 1;
1449 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1450 rev_info
.diffopt
.use_color
= 0;
1451 rev_info
.diffopt
.file
= fp
;
1452 rev_info
.diffopt
.close_file
= 1;
1453 add_pending_object(&rev_info
, &tree
->object
, "");
1454 diff_setup_done(&rev_info
.diffopt
);
1455 run_diff_index(&rev_info
, 1);
1459 * Like parse_mail(), but parses the mail by looking up its commit ID
1460 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1463 * state->orig_commit will be set to the original commit ID.
1465 * Will always return 0 as the patch should never be skipped.
1467 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1469 struct commit
*commit
;
1470 unsigned char commit_sha1
[GIT_SHA1_RAWSZ
];
1472 if (get_mail_commit_sha1(commit_sha1
, mail
) < 0)
1473 die(_("could not parse %s"), mail
);
1475 commit
= lookup_commit_or_die(commit_sha1
, mail
);
1477 get_commit_info(state
, commit
);
1479 write_commit_patch(state
, commit
);
1481 hashcpy(state
->orig_commit
, commit_sha1
);
1482 write_file(am_path(state
, "original-commit"), 1, "%s",
1483 sha1_to_hex(commit_sha1
));
1489 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1490 * `index_file` is not NULL, the patch will be applied to that index.
1492 static int run_apply(const struct am_state
*state
, const char *index_file
)
1494 struct child_process cp
= CHILD_PROCESS_INIT
;
1499 argv_array_pushf(&cp
.env_array
, "GIT_INDEX_FILE=%s", index_file
);
1502 * If we are allowed to fall back on 3-way merge, don't give false
1503 * errors during the initial attempt.
1505 if (state
->threeway
&& !index_file
) {
1510 argv_array_push(&cp
.args
, "apply");
1512 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1515 argv_array_push(&cp
.args
, "--cached");
1517 argv_array_push(&cp
.args
, "--index");
1519 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1521 if (run_command(&cp
))
1524 /* Reload index as git-apply will have modified it. */
1526 read_cache_from(index_file
? index_file
: get_index_file());
1532 * Builds an index that contains just the blobs needed for a 3way merge.
1534 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1536 struct child_process cp
= CHILD_PROCESS_INIT
;
1539 argv_array_push(&cp
.args
, "apply");
1540 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1541 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1542 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1544 if (run_command(&cp
))
1551 * Attempt a threeway merge, using index_path as the temporary index.
1553 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1555 unsigned char orig_tree
[GIT_SHA1_RAWSZ
], his_tree
[GIT_SHA1_RAWSZ
],
1556 our_tree
[GIT_SHA1_RAWSZ
];
1557 const unsigned char *bases
[1] = {orig_tree
};
1558 struct merge_options o
;
1559 struct commit
*result
;
1560 char *his_tree_name
;
1562 if (get_sha1("HEAD", our_tree
) < 0)
1563 hashcpy(our_tree
, EMPTY_TREE_SHA1_BIN
);
1565 if (build_fake_ancestor(state
, index_path
))
1566 return error("could not build fake ancestor");
1569 read_cache_from(index_path
);
1571 if (write_index_as_tree(orig_tree
, &the_index
, index_path
, 0, NULL
))
1572 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1574 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1576 if (!state
->quiet
) {
1578 * List paths that needed 3-way fallback, so that the user can
1579 * review them with extra care to spot mismerges.
1581 struct rev_info rev_info
;
1582 const char *diff_filter_str
= "--diff-filter=AM";
1584 init_revisions(&rev_info
, NULL
);
1585 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1586 diff_opt_parse(&rev_info
.diffopt
, &diff_filter_str
, 1);
1587 add_pending_sha1(&rev_info
, "HEAD", our_tree
, 0);
1588 diff_setup_done(&rev_info
.diffopt
);
1589 run_diff_index(&rev_info
, 1);
1592 if (run_apply(state
, index_path
))
1593 return error(_("Did you hand edit your patch?\n"
1594 "It does not apply to blobs recorded in its index."));
1596 if (write_index_as_tree(his_tree
, &the_index
, index_path
, 0, NULL
))
1597 return error("could not write tree");
1599 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1605 * This is not so wrong. Depending on which base we picked, orig_tree
1606 * may be wildly different from ours, but his_tree has the same set of
1607 * wildly different changes in parts the patch did not touch, so
1608 * recursive ends up canceling them, saying that we reverted all those
1612 init_merge_options(&o
);
1615 his_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1616 o
.branch2
= his_tree_name
;
1621 if (merge_recursive_generic(&o
, our_tree
, his_tree
, 1, bases
, &result
)) {
1622 rerere(state
->allow_rerere_autoupdate
);
1623 free(his_tree_name
);
1624 return error(_("Failed to merge in the changes."));
1627 free(his_tree_name
);
1632 * Commits the current index with state->msg as the commit message and
1633 * state->author_name, state->author_email and state->author_date as the author
1636 static void do_commit(const struct am_state
*state
)
1638 unsigned char tree
[GIT_SHA1_RAWSZ
], parent
[GIT_SHA1_RAWSZ
],
1639 commit
[GIT_SHA1_RAWSZ
];
1641 struct commit_list
*parents
= NULL
;
1642 const char *reflog_msg
, *author
;
1643 struct strbuf sb
= STRBUF_INIT
;
1645 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1648 if (write_cache_as_tree(tree
, 0, NULL
))
1649 die(_("git write-tree failed to write a tree"));
1651 if (!get_sha1_commit("HEAD", parent
)) {
1653 commit_list_insert(lookup_commit(parent
), &parents
);
1656 say(state
, stderr
, _("applying to an empty history"));
1659 author
= fmt_ident(state
->author_name
, state
->author_email
,
1660 state
->ignore_date
? NULL
: state
->author_date
,
1663 if (state
->committer_date_is_author_date
)
1664 setenv("GIT_COMMITTER_DATE",
1665 state
->ignore_date
? "" : state
->author_date
, 1);
1667 if (commit_tree(state
->msg
, state
->msg_len
, tree
, parents
, commit
,
1668 author
, state
->sign_commit
))
1669 die(_("failed to write commit object"));
1671 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1675 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1678 update_ref(sb
.buf
, "HEAD", commit
, ptr
, 0, UPDATE_REFS_DIE_ON_ERR
);
1680 if (state
->rebasing
) {
1681 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1683 assert(!is_null_sha1(state
->orig_commit
));
1684 fprintf(fp
, "%s ", sha1_to_hex(state
->orig_commit
));
1685 fprintf(fp
, "%s\n", sha1_to_hex(commit
));
1689 run_hook_le(NULL
, "post-applypatch", NULL
);
1691 strbuf_release(&sb
);
1695 * Validates the am_state for resuming -- the "msg" and authorship fields must
1698 static void validate_resume_state(const struct am_state
*state
)
1701 die(_("cannot resume: %s does not exist."),
1702 am_path(state
, "final-commit"));
1704 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1705 die(_("cannot resume: %s does not exist."),
1706 am_path(state
, "author-script"));
1710 * Interactively prompt the user on whether the current patch should be
1713 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1716 static int do_interactive(struct am_state
*state
)
1721 die(_("cannot be interactive without stdin connected to a terminal."));
1726 puts(_("Commit Body is:"));
1727 puts("--------------------------");
1728 printf("%s", state
->msg
);
1729 puts("--------------------------");
1732 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1733 * in your translation. The program will only accept English
1734 * input at this point.
1736 reply
= git_prompt(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "), PROMPT_ECHO
);
1740 } else if (*reply
== 'y' || *reply
== 'Y') {
1742 } else if (*reply
== 'a' || *reply
== 'A') {
1743 state
->interactive
= 0;
1745 } else if (*reply
== 'n' || *reply
== 'N') {
1747 } else if (*reply
== 'e' || *reply
== 'E') {
1748 struct strbuf msg
= STRBUF_INIT
;
1750 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1752 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1754 strbuf_release(&msg
);
1755 } else if (*reply
== 'v' || *reply
== 'V') {
1756 const char *pager
= git_pager(1);
1757 struct child_process cp
= CHILD_PROCESS_INIT
;
1761 argv_array_push(&cp
.args
, pager
);
1762 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1769 * Applies all queued mail.
1771 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1772 * well as the state directory's "patch" file is used as-is for applying the
1773 * patch and committing it.
1775 static void am_run(struct am_state
*state
, int resume
)
1777 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1778 struct strbuf sb
= STRBUF_INIT
;
1780 unlink(am_path(state
, "dirtyindex"));
1782 refresh_and_write_cache();
1784 if (index_has_changes(&sb
)) {
1785 write_file(am_path(state
, "dirtyindex"), 1, "t");
1786 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1789 strbuf_release(&sb
);
1791 while (state
->cur
<= state
->last
) {
1792 const char *mail
= am_path(state
, msgnum(state
));
1795 if (!file_exists(mail
))
1799 validate_resume_state(state
);
1803 if (state
->rebasing
)
1804 skip
= parse_mail_rebase(state
, mail
);
1806 skip
= parse_mail(state
, mail
);
1809 goto next
; /* mail should be skipped */
1811 write_author_script(state
);
1812 write_commit_msg(state
);
1815 if (state
->interactive
&& do_interactive(state
))
1818 if (run_applypatch_msg_hook(state
))
1821 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1823 apply_status
= run_apply(state
, NULL
);
1825 if (apply_status
&& state
->threeway
) {
1826 struct strbuf sb
= STRBUF_INIT
;
1828 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1829 apply_status
= fall_back_threeway(state
, sb
.buf
);
1830 strbuf_release(&sb
);
1833 * Applying the patch to an earlier tree and merging
1834 * the result may have produced the same tree as ours.
1836 if (!apply_status
&& !index_has_changes(NULL
)) {
1837 say(state
, stdout
, _("No changes -- Patch already applied."));
1843 int advice_amworkdir
= 1;
1845 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1846 linelen(state
->msg
), state
->msg
);
1848 git_config_get_bool("advice.amworkdir", &advice_amworkdir
);
1850 if (advice_amworkdir
)
1851 printf_ln(_("The copy of the patch that failed is found in: %s"),
1852 am_path(state
, "patch"));
1854 die_user_resolve(state
);
1867 if (!is_empty_file(am_path(state
, "rewritten"))) {
1868 assert(state
->rebasing
);
1869 copy_notes_for_rebase(state
);
1870 run_post_rewrite_hook(state
);
1874 * In rebasing mode, it's up to the caller to take care of
1877 if (!state
->rebasing
) {
1879 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1884 * Resume the current am session after patch application failure. The user did
1885 * all the hard work, and we do not have to do any patch application. Just
1886 * trust and commit what the user has in the index and working tree.
1888 static void am_resolve(struct am_state
*state
)
1890 validate_resume_state(state
);
1892 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1894 if (!index_has_changes(NULL
)) {
1895 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1896 "If there is nothing left to stage, chances are that something else\n"
1897 "already introduced the same changes; you might want to skip this patch."));
1898 die_user_resolve(state
);
1901 if (unmerged_cache()) {
1902 printf_ln(_("You still have unmerged paths in your index.\n"
1903 "Did you forget to use 'git add'?"));
1904 die_user_resolve(state
);
1907 if (state
->interactive
) {
1908 write_index_patch(state
);
1909 if (do_interactive(state
))
1924 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1925 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1928 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1930 struct lock_file
*lock_file
;
1931 struct unpack_trees_options opts
;
1932 struct tree_desc t
[2];
1934 if (parse_tree(head
) || parse_tree(remote
))
1937 lock_file
= xcalloc(1, sizeof(struct lock_file
));
1938 hold_locked_index(lock_file
, 1);
1940 refresh_cache(REFRESH_QUIET
);
1942 memset(&opts
, 0, sizeof(opts
));
1944 opts
.src_index
= &the_index
;
1945 opts
.dst_index
= &the_index
;
1949 opts
.fn
= twoway_merge
;
1950 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1951 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1953 if (unpack_trees(2, t
, &opts
)) {
1954 rollback_lock_file(lock_file
);
1958 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1959 die(_("unable to write new index file"));
1965 * Clean the index without touching entries that are not modified between
1966 * `head` and `remote`.
1968 static int clean_index(const unsigned char *head
, const unsigned char *remote
)
1970 struct lock_file
*lock_file
;
1971 struct tree
*head_tree
, *remote_tree
, *index_tree
;
1972 unsigned char index
[GIT_SHA1_RAWSZ
];
1973 struct pathspec pathspec
;
1975 head_tree
= parse_tree_indirect(head
);
1977 return error(_("Could not parse object '%s'."), sha1_to_hex(head
));
1979 remote_tree
= parse_tree_indirect(remote
);
1981 return error(_("Could not parse object '%s'."), sha1_to_hex(remote
));
1983 read_cache_unmerged();
1985 if (fast_forward_to(head_tree
, head_tree
, 1))
1988 if (write_cache_as_tree(index
, 0, NULL
))
1991 index_tree
= parse_tree_indirect(index
);
1993 return error(_("Could not parse object '%s'."), sha1_to_hex(index
));
1995 if (fast_forward_to(index_tree
, remote_tree
, 0))
1998 memset(&pathspec
, 0, sizeof(pathspec
));
2000 lock_file
= xcalloc(1, sizeof(struct lock_file
));
2001 hold_locked_index(lock_file
, 1);
2003 if (read_tree(remote_tree
, 0, &pathspec
)) {
2004 rollback_lock_file(lock_file
);
2008 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
2009 die(_("unable to write new index file"));
2011 remove_branch_state();
2017 * Resets rerere's merge resolution metadata.
2019 static void am_rerere_clear(void)
2021 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
2022 int fd
= setup_rerere(&merge_rr
, 0);
2027 rerere_clear(&merge_rr
);
2028 string_list_clear(&merge_rr
, 1);
2032 * Resume the current am session by skipping the current patch.
2034 static void am_skip(struct am_state
*state
)
2036 unsigned char head
[GIT_SHA1_RAWSZ
];
2040 if (get_sha1("HEAD", head
))
2041 hashcpy(head
, EMPTY_TREE_SHA1_BIN
);
2043 if (clean_index(head
, head
))
2044 die(_("failed to clean index"));
2052 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2054 * It is not safe to reset HEAD when:
2055 * 1. git-am previously failed because the index was dirty.
2056 * 2. HEAD has moved since git-am previously failed.
2058 static int safe_to_abort(const struct am_state
*state
)
2060 struct strbuf sb
= STRBUF_INIT
;
2061 unsigned char abort_safety
[GIT_SHA1_RAWSZ
], head
[GIT_SHA1_RAWSZ
];
2063 if (file_exists(am_path(state
, "dirtyindex")))
2066 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2067 if (get_sha1_hex(sb
.buf
, abort_safety
))
2068 die(_("could not parse %s"), am_path(state
, "abort_safety"));
2070 hashclr(abort_safety
);
2072 if (get_sha1("HEAD", head
))
2075 if (!hashcmp(head
, abort_safety
))
2078 error(_("You seem to have moved HEAD since the last 'am' failure.\n"
2079 "Not rewinding to ORIG_HEAD"));
2085 * Aborts the current am session if it is safe to do so.
2087 static void am_abort(struct am_state
*state
)
2089 unsigned char curr_head
[GIT_SHA1_RAWSZ
], orig_head
[GIT_SHA1_RAWSZ
];
2090 int has_curr_head
, has_orig_head
;
2093 if (!safe_to_abort(state
)) {
2100 curr_branch
= resolve_refdup("HEAD", 0, curr_head
, NULL
);
2101 has_curr_head
= !is_null_sha1(curr_head
);
2103 hashcpy(curr_head
, EMPTY_TREE_SHA1_BIN
);
2105 has_orig_head
= !get_sha1("ORIG_HEAD", orig_head
);
2107 hashcpy(orig_head
, EMPTY_TREE_SHA1_BIN
);
2109 clean_index(curr_head
, orig_head
);
2112 update_ref("am --abort", "HEAD", orig_head
,
2113 has_curr_head
? curr_head
: NULL
, 0,
2114 UPDATE_REFS_DIE_ON_ERR
);
2115 else if (curr_branch
)
2116 delete_ref(curr_branch
, NULL
, REF_NODEREF
);
2123 * parse_options() callback that validates and sets opt->value to the
2124 * PATCH_FORMAT_* enum value corresponding to `arg`.
2126 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2128 int *opt_value
= opt
->value
;
2130 if (!strcmp(arg
, "mbox"))
2131 *opt_value
= PATCH_FORMAT_MBOX
;
2132 else if (!strcmp(arg
, "stgit"))
2133 *opt_value
= PATCH_FORMAT_STGIT
;
2134 else if (!strcmp(arg
, "stgit-series"))
2135 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2136 else if (!strcmp(arg
, "hg"))
2137 *opt_value
= PATCH_FORMAT_HG
;
2139 return error(_("Invalid value for --patch-format: %s"), arg
);
2151 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2153 struct am_state state
;
2156 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2157 enum resume_mode resume
= RESUME_FALSE
;
2160 const char * const usage
[] = {
2161 N_("git am [options] [(<mbox>|<Maildir>)...]"),
2162 N_("git am [options] (--continue | --skip | --abort)"),
2166 struct option options
[] = {
2167 OPT_BOOL('i', "interactive", &state
.interactive
,
2168 N_("run interactively")),
2169 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2170 N_("(historical option -- no-op")),
2171 OPT_BOOL('3', "3way", &state
.threeway
,
2172 N_("allow fall back on 3way merging if needed")),
2173 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2174 OPT_SET_INT('s', "signoff", &state
.signoff
,
2175 N_("add a Signed-off-by line to the commit message"),
2177 OPT_BOOL('u', "utf8", &state
.utf8
,
2178 N_("recode into utf8 (default)")),
2179 OPT_SET_INT('k', "keep", &state
.keep
,
2180 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2181 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2182 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2183 OPT_BOOL('m', "message-id", &state
.message_id
,
2184 N_("pass -m flag to git-mailinfo")),
2185 { OPTION_SET_INT
, 0, "keep-cr", &keep_cr
, NULL
,
2186 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2187 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1},
2188 { OPTION_SET_INT
, 0, "no-keep-cr", &keep_cr
, NULL
,
2189 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2190 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 0},
2191 OPT_BOOL('c', "scissors", &state
.scissors
,
2192 N_("strip everything before a scissors line")),
2193 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2194 N_("pass it through git-apply"),
2196 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2197 N_("pass it through git-apply"),
2199 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2200 N_("pass it through git-apply"),
2202 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2203 N_("pass it through git-apply"),
2205 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2206 N_("pass it through git-apply"),
2208 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2209 N_("pass it through git-apply"),
2211 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2212 N_("pass it through git-apply"),
2214 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2215 N_("pass it through git-apply"),
2217 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2218 N_("format the patch(es) are in"),
2219 parse_opt_patchformat
),
2220 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2221 N_("pass it through git-apply"),
2223 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2224 N_("override error message when patch failure occurs")),
2225 OPT_CMDMODE(0, "continue", &resume
,
2226 N_("continue applying patches after resolving a conflict"),
2228 OPT_CMDMODE('r', "resolved", &resume
,
2229 N_("synonyms for --continue"),
2231 OPT_CMDMODE(0, "skip", &resume
,
2232 N_("skip the current patch"),
2234 OPT_CMDMODE(0, "abort", &resume
,
2235 N_("restore the original branch and abort the patching operation."),
2237 OPT_BOOL(0, "committer-date-is-author-date",
2238 &state
.committer_date_is_author_date
,
2239 N_("lie about committer date")),
2240 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2241 N_("use current timestamp for author date")),
2242 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2243 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2244 N_("GPG-sign commits"),
2245 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2246 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2247 N_("(internal use for git-rebase)")),
2251 git_config(git_default_config
, NULL
);
2253 am_state_init(&state
, git_path("rebase-apply"));
2255 in_progress
= am_in_progress(&state
);
2259 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2262 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2263 "it will be removed. Please do not use it anymore."));
2265 /* Ensure a valid committer ident can be constructed */
2266 git_committer_info(IDENT_STRICT
);
2268 if (read_index_preload(&the_index
, NULL
) < 0)
2269 die(_("failed to read the index"));
2273 * Catch user error to feed us patches when there is a session
2276 * 1. mbox path(s) are provided on the command-line.
2277 * 2. stdin is not a tty: the user is trying to feed us a patch
2278 * from standard input. This is somewhat unreliable -- stdin
2279 * could be /dev/null for example and the caller did not
2280 * intend to feed us a patch but wanted to continue
2283 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
2284 die(_("previous rebase directory %s still exists but mbox given."),
2287 if (resume
== RESUME_FALSE
)
2288 resume
= RESUME_APPLY
;
2290 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2291 am_append_signoff(&state
);
2293 struct argv_array paths
= ARGV_ARRAY_INIT
;
2297 * Handle stray state directory in the independent-run case. In
2298 * the --rebasing case, it is up to the caller to take care of
2299 * stray directories.
2301 if (file_exists(state
.dir
) && !state
.rebasing
) {
2302 if (resume
== RESUME_ABORT
) {
2304 am_state_release(&state
);
2308 die(_("Stray %s directory found.\n"
2309 "Use \"git am --abort\" to remove it."),
2314 die(_("Resolve operation not in progress, we are not resuming."));
2316 for (i
= 0; i
< argc
; i
++) {
2317 if (is_absolute_path(argv
[i
]) || !prefix
)
2318 argv_array_push(&paths
, argv
[i
]);
2320 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2323 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2325 argv_array_clear(&paths
);
2335 case RESUME_RESOLVED
:
2345 die("BUG: invalid resume value");
2348 am_state_release(&state
);