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"
37 * Returns 1 if the file is empty or does not exist, 0 otherwise.
39 static int is_empty_file(const char *filename
)
43 if (stat(filename
, &st
) < 0) {
46 die_errno(_("could not stat %s"), filename
);
53 * Returns the length of the first line of msg.
55 static int linelen(const char *msg
)
57 return strchrnul(msg
, '\n') - msg
;
61 * Returns true if `str` consists of only whitespace, false otherwise.
63 static int str_isspace(const char *str
)
73 PATCH_FORMAT_UNKNOWN
= 0,
76 PATCH_FORMAT_STGIT_SERIES
,
83 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
84 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
89 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
90 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
96 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
100 /* state directory path */
103 /* current and last patch numbers, 1-indexed */
107 /* commit metadata and message */
114 /* when --rebasing, records the original commit the patch came from */
115 struct object_id orig_commit
;
117 /* number of digits in patch filename */
120 /* various operating modes and command line options */
124 int signoff
; /* enum signoff_type */
126 int keep
; /* enum keep_type */
128 int scissors
; /* enum scissors_type */
129 struct argv_array git_apply_opts
;
130 const char *resolvemsg
;
131 int committer_date_is_author_date
;
133 int allow_rerere_autoupdate
;
134 const char *sign_commit
;
139 * Initializes am_state with the default values.
141 static void am_state_init(struct am_state
*state
)
145 memset(state
, 0, sizeof(*state
));
147 state
->dir
= git_pathdup("rebase-apply");
151 git_config_get_bool("am.threeway", &state
->threeway
);
155 git_config_get_bool("am.messageid", &state
->message_id
);
157 state
->scissors
= SCISSORS_UNSET
;
159 argv_array_init(&state
->git_apply_opts
);
161 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
162 state
->sign_commit
= gpgsign
? "" : NULL
;
166 * Releases memory allocated by an am_state.
168 static void am_state_release(struct am_state
*state
)
171 free(state
->author_name
);
172 free(state
->author_email
);
173 free(state
->author_date
);
175 argv_array_clear(&state
->git_apply_opts
);
179 * Returns path relative to the am_state directory.
181 static inline const char *am_path(const struct am_state
*state
, const char *path
)
183 return mkpath("%s/%s", state
->dir
, path
);
187 * For convenience to call write_file()
189 static void write_state_text(const struct am_state
*state
,
190 const char *name
, const char *string
)
192 write_file(am_path(state
, name
), "%s", string
);
195 static void write_state_count(const struct am_state
*state
,
196 const char *name
, int value
)
198 write_file(am_path(state
, name
), "%d", value
);
201 static void write_state_bool(const struct am_state
*state
,
202 const char *name
, int value
)
204 write_state_text(state
, name
, value
? "t" : "f");
208 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
211 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
217 vfprintf(fp
, fmt
, ap
);
224 * Returns 1 if there is an am session in progress, 0 otherwise.
226 static int am_in_progress(const struct am_state
*state
)
230 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
232 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
234 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
240 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
241 * number of bytes read on success, -1 if the file does not exist. If `trim` is
242 * set, trailing whitespace will be removed.
244 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
245 const char *file
, int trim
)
249 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
259 die_errno(_("could not read '%s'"), am_path(state
, file
));
263 * Take a series of KEY='VALUE' lines where VALUE part is
264 * sq-quoted, and append <KEY, VALUE> at the end of the string list
266 static int parse_key_value_squoted(char *buf
, struct string_list
*list
)
269 struct string_list_item
*item
;
271 char *cp
= strchr(buf
, '=');
274 np
= strchrnul(cp
, '\n');
276 item
= string_list_append(list
, buf
);
278 buf
= np
+ (*np
== '\n');
283 item
->util
= xstrdup(cp
);
289 * Reads and parses the state directory's "author-script" file, and sets
290 * state->author_name, state->author_email and state->author_date accordingly.
291 * Returns 0 on success, -1 if the file could not be parsed.
293 * The author script is of the format:
295 * GIT_AUTHOR_NAME='$author_name'
296 * GIT_AUTHOR_EMAIL='$author_email'
297 * GIT_AUTHOR_DATE='$author_date'
299 * where $author_name, $author_email and $author_date are quoted. We are strict
300 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
301 * script, and thus if the file differs from what this function expects, it is
302 * better to bail out than to do something that the user does not expect.
304 static int read_author_script(struct am_state
*state
)
306 const char *filename
= am_path(state
, "author-script");
307 struct strbuf buf
= STRBUF_INIT
;
308 struct string_list kv
= STRING_LIST_INIT_DUP
;
309 int retval
= -1; /* assume failure */
312 assert(!state
->author_name
);
313 assert(!state
->author_email
);
314 assert(!state
->author_date
);
316 fd
= open(filename
, O_RDONLY
);
320 die_errno(_("could not open '%s' for reading"), filename
);
322 strbuf_read(&buf
, fd
, 0);
324 if (parse_key_value_squoted(buf
.buf
, &kv
))
328 strcmp(kv
.items
[0].string
, "GIT_AUTHOR_NAME") ||
329 strcmp(kv
.items
[1].string
, "GIT_AUTHOR_EMAIL") ||
330 strcmp(kv
.items
[2].string
, "GIT_AUTHOR_DATE"))
332 state
->author_name
= kv
.items
[0].util
;
333 state
->author_email
= kv
.items
[1].util
;
334 state
->author_date
= kv
.items
[2].util
;
337 string_list_clear(&kv
, !!retval
);
338 strbuf_release(&buf
);
343 * Saves state->author_name, state->author_email and state->author_date in the
344 * state directory's "author-script" file.
346 static void write_author_script(const struct am_state
*state
)
348 struct strbuf sb
= STRBUF_INIT
;
350 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
351 sq_quote_buf(&sb
, state
->author_name
);
352 strbuf_addch(&sb
, '\n');
354 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
355 sq_quote_buf(&sb
, state
->author_email
);
356 strbuf_addch(&sb
, '\n');
358 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
359 sq_quote_buf(&sb
, state
->author_date
);
360 strbuf_addch(&sb
, '\n');
362 write_state_text(state
, "author-script", sb
.buf
);
368 * Reads the commit message from the state directory's "final-commit" file,
369 * setting state->msg to its contents and state->msg_len to the length of its
372 * Returns 0 on success, -1 if the file does not exist.
374 static int read_commit_msg(struct am_state
*state
)
376 struct strbuf sb
= STRBUF_INIT
;
380 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
385 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
390 * Saves state->msg in the state directory's "final-commit" file.
392 static void write_commit_msg(const struct am_state
*state
)
394 const char *filename
= am_path(state
, "final-commit");
395 write_file_buf(filename
, state
->msg
, state
->msg_len
);
399 * Loads state from disk.
401 static void am_load(struct am_state
*state
)
403 struct strbuf sb
= STRBUF_INIT
;
405 if (read_state_file(&sb
, state
, "next", 1) < 0)
406 die("BUG: state file 'next' does not exist");
407 state
->cur
= strtol(sb
.buf
, NULL
, 10);
409 if (read_state_file(&sb
, state
, "last", 1) < 0)
410 die("BUG: state file 'last' does not exist");
411 state
->last
= strtol(sb
.buf
, NULL
, 10);
413 if (read_author_script(state
) < 0)
414 die(_("could not parse author script"));
416 read_commit_msg(state
);
418 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
419 oidclr(&state
->orig_commit
);
420 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
421 die(_("could not parse %s"), am_path(state
, "original-commit"));
423 read_state_file(&sb
, state
, "threeway", 1);
424 state
->threeway
= !strcmp(sb
.buf
, "t");
426 read_state_file(&sb
, state
, "quiet", 1);
427 state
->quiet
= !strcmp(sb
.buf
, "t");
429 read_state_file(&sb
, state
, "sign", 1);
430 state
->signoff
= !strcmp(sb
.buf
, "t");
432 read_state_file(&sb
, state
, "utf8", 1);
433 state
->utf8
= !strcmp(sb
.buf
, "t");
435 if (file_exists(am_path(state
, "rerere-autoupdate"))) {
436 read_state_file(&sb
, state
, "rerere-autoupdate", 1);
437 state
->allow_rerere_autoupdate
= strcmp(sb
.buf
, "t") ?
438 RERERE_NOAUTOUPDATE
: RERERE_AUTOUPDATE
;
440 state
->allow_rerere_autoupdate
= 0;
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
);
496 FREE_AND_NULL(state
->msg
);
497 if (read_commit_msg(state
) < 0)
498 die(_("'%s' was deleted by the applypatch-msg hook"),
499 am_path(state
, "final-commit"));
506 * Runs post-rewrite hook. Returns it exit code.
508 static int run_post_rewrite_hook(const struct am_state
*state
)
510 struct child_process cp
= CHILD_PROCESS_INIT
;
511 const char *hook
= find_hook("post-rewrite");
517 argv_array_push(&cp
.args
, hook
);
518 argv_array_push(&cp
.args
, "rebase");
520 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
521 cp
.stdout_to_stderr
= 1;
523 ret
= run_command(&cp
);
530 * Reads the state directory's "rewritten" file, and copies notes from the old
531 * commits listed in the file to their rewritten commits.
533 * Returns 0 on success, -1 on failure.
535 static int copy_notes_for_rebase(const struct am_state
*state
)
537 struct notes_rewrite_cfg
*c
;
538 struct strbuf sb
= STRBUF_INIT
;
539 const char *invalid_line
= _("Malformed input line: '%s'.");
540 const char *msg
= "Notes added by 'git rebase'";
544 assert(state
->rebasing
);
546 c
= init_copy_notes_for_rewrite("rebase");
550 fp
= xfopen(am_path(state
, "rewritten"), "r");
552 while (!strbuf_getline_lf(&sb
, fp
)) {
553 struct object_id from_obj
, to_obj
;
555 if (sb
.len
!= GIT_SHA1_HEXSZ
* 2 + 1) {
556 ret
= error(invalid_line
, sb
.buf
);
560 if (get_oid_hex(sb
.buf
, &from_obj
)) {
561 ret
= error(invalid_line
, sb
.buf
);
565 if (sb
.buf
[GIT_SHA1_HEXSZ
] != ' ') {
566 ret
= error(invalid_line
, sb
.buf
);
570 if (get_oid_hex(sb
.buf
+ GIT_SHA1_HEXSZ
+ 1, &to_obj
)) {
571 ret
= error(invalid_line
, sb
.buf
);
575 if (copy_note_for_rewrite(c
, &from_obj
, &to_obj
))
576 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
577 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
581 finish_copy_notes_for_rewrite(c
, msg
);
588 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
589 * non-indented lines and checking if they look like they begin with valid
590 * header field names.
592 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
594 static int is_mail(FILE *fp
)
596 const char *header_regex
= "^[!-9;-~]+:";
597 struct strbuf sb
= STRBUF_INIT
;
601 if (fseek(fp
, 0L, SEEK_SET
))
602 die_errno(_("fseek failed"));
604 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
605 die("invalid pattern: %s", header_regex
);
607 while (!strbuf_getline(&sb
, fp
)) {
609 break; /* End of header */
611 /* Ignore indented folded lines */
612 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
615 /* It's a header if it matches header_regex */
616 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
629 * Attempts to detect the patch_format of the patches contained in `paths`,
630 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
633 static int detect_patch_format(const char **paths
)
635 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
636 struct strbuf l1
= STRBUF_INIT
;
637 struct strbuf l2
= STRBUF_INIT
;
638 struct strbuf l3
= STRBUF_INIT
;
642 * We default to mbox format if input is from stdin and for directories
644 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
645 return PATCH_FORMAT_MBOX
;
648 * Otherwise, check the first few lines of the first patch, starting
649 * from the first non-blank line, to try to detect its format.
652 fp
= xfopen(*paths
, "r");
654 while (!strbuf_getline(&l1
, fp
)) {
659 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
660 ret
= PATCH_FORMAT_MBOX
;
664 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
665 ret
= PATCH_FORMAT_STGIT_SERIES
;
669 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
670 ret
= PATCH_FORMAT_HG
;
674 strbuf_getline(&l2
, fp
);
675 strbuf_getline(&l3
, fp
);
678 * If the second line is empty and the third is a From, Author or Date
679 * entry, this is likely an StGit patch.
681 if (l1
.len
&& !l2
.len
&&
682 (starts_with(l3
.buf
, "From:") ||
683 starts_with(l3
.buf
, "Author:") ||
684 starts_with(l3
.buf
, "Date:"))) {
685 ret
= PATCH_FORMAT_STGIT
;
689 if (l1
.len
&& is_mail(fp
)) {
690 ret
= PATCH_FORMAT_MBOX
;
703 * Splits out individual email patches from `paths`, where each path is either
704 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
706 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
707 int keep_cr
, int mboxrd
)
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");
720 argv_array_push(&cp
.args
, "--mboxrd");
721 argv_array_push(&cp
.args
, "--");
722 argv_array_pushv(&cp
.args
, paths
);
724 if (capture_command(&cp
, &last
, 8))
728 state
->last
= strtol(last
.buf
, NULL
, 10);
734 * Callback signature for split_mail_conv(). The foreign patch should be
735 * read from `in`, and the converted patch (in RFC2822 mail format) should be
736 * written to `out`. Return 0 on success, or -1 on failure.
738 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
741 * Calls `fn` for each file in `paths` to convert the foreign patch to the
742 * RFC2822 mail format suitable for parsing with git-mailinfo.
744 * Returns 0 on success, -1 on failure.
746 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
747 const char **paths
, int keep_cr
)
749 static const char *stdin_only
[] = {"-", NULL
};
755 for (i
= 0; *paths
; paths
++, i
++) {
760 if (!strcmp(*paths
, "-"))
763 in
= fopen(*paths
, "r");
766 return error_errno(_("could not open '%s' for reading"),
769 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
771 out
= fopen(mail
, "w");
775 return error_errno(_("could not open '%s' for writing"),
779 ret
= fn(out
, in
, keep_cr
);
786 return error(_("could not parse patch '%s'"), *paths
);
795 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
796 * message suitable for parsing with git-mailinfo.
798 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
800 struct strbuf sb
= STRBUF_INIT
;
801 int subject_printed
= 0;
803 while (!strbuf_getline_lf(&sb
, in
)) {
806 if (str_isspace(sb
.buf
))
808 else if (skip_prefix(sb
.buf
, "Author:", &str
))
809 fprintf(out
, "From:%s\n", str
);
810 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
811 fprintf(out
, "%s\n", sb
.buf
);
812 else if (!subject_printed
) {
813 fprintf(out
, "Subject: %s\n", sb
.buf
);
816 fprintf(out
, "\n%s\n", sb
.buf
);
822 while (strbuf_fread(&sb
, 8192, in
) > 0) {
823 fwrite(sb
.buf
, 1, sb
.len
, out
);
832 * This function only supports a single StGit series file in `paths`.
834 * Given an StGit series file, converts the StGit patches in the series into
835 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
836 * the state directory.
838 * Returns 0 on success, -1 on failure.
840 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
843 const char *series_dir
;
844 char *series_dir_buf
;
846 struct argv_array patches
= ARGV_ARRAY_INIT
;
847 struct strbuf sb
= STRBUF_INIT
;
850 if (!paths
[0] || paths
[1])
851 return error(_("Only one StGIT patch series can be applied at once"));
853 series_dir_buf
= xstrdup(*paths
);
854 series_dir
= dirname(series_dir_buf
);
856 fp
= fopen(*paths
, "r");
858 return error_errno(_("could not open '%s' for reading"), *paths
);
860 while (!strbuf_getline_lf(&sb
, fp
)) {
862 continue; /* skip comment lines */
864 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
869 free(series_dir_buf
);
871 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
873 argv_array_clear(&patches
);
878 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
879 * message suitable for parsing with git-mailinfo.
881 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
883 struct strbuf sb
= STRBUF_INIT
;
886 while (!strbuf_getline_lf(&sb
, in
)) {
889 if (skip_prefix(sb
.buf
, "# User ", &str
))
890 fprintf(out
, "From: %s\n", str
);
891 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
892 timestamp_t timestamp
;
897 timestamp
= parse_timestamp(str
, &end
, 10);
899 rc
= error(_("invalid timestamp"));
903 if (!skip_prefix(end
, " ", &str
)) {
904 rc
= error(_("invalid Date line"));
909 tz
= strtol(str
, &end
, 10);
911 rc
= error(_("invalid timezone offset"));
916 rc
= error(_("invalid Date line"));
921 * mercurial's timezone is in seconds west of UTC,
922 * however git's timezone is in hours + minutes east of
925 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
929 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
930 } else if (starts_with(sb
.buf
, "# ")) {
933 fprintf(out
, "\n%s\n", sb
.buf
);
939 while (strbuf_fread(&sb
, 8192, in
) > 0) {
940 fwrite(sb
.buf
, 1, sb
.len
, out
);
949 * Splits a list of files/directories into individual email patches. Each path
950 * in `paths` must be a file/directory that is formatted according to
953 * Once split out, the individual email patches will be stored in the state
954 * directory, with each patch's filename being its index, padded to state->prec
957 * state->cur will be set to the index of the first mail, and state->last will
958 * be set to the index of the last mail.
960 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
961 * to disable this behavior, -1 to use the default configured setting.
963 * Returns 0 on success, -1 on failure.
965 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
966 const char **paths
, int keep_cr
)
970 git_config_get_bool("am.keepcr", &keep_cr
);
973 switch (patch_format
) {
974 case PATCH_FORMAT_MBOX
:
975 return split_mail_mbox(state
, paths
, keep_cr
, 0);
976 case PATCH_FORMAT_STGIT
:
977 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
978 case PATCH_FORMAT_STGIT_SERIES
:
979 return split_mail_stgit_series(state
, paths
, keep_cr
);
980 case PATCH_FORMAT_HG
:
981 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
982 case PATCH_FORMAT_MBOXRD
:
983 return split_mail_mbox(state
, paths
, keep_cr
, 1);
985 die("BUG: invalid patch_format");
991 * Setup a new am session for applying patches
993 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
994 const char **paths
, int keep_cr
)
996 struct object_id curr_head
;
998 struct strbuf sb
= STRBUF_INIT
;
1001 patch_format
= detect_patch_format(paths
);
1003 if (!patch_format
) {
1004 fprintf_ln(stderr
, _("Patch format detection failed."));
1008 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
1009 die_errno(_("failed to create directory '%s'"), state
->dir
);
1011 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
1013 die(_("Failed to split patches."));
1016 if (state
->rebasing
)
1017 state
->threeway
= 1;
1019 write_state_bool(state
, "threeway", state
->threeway
);
1020 write_state_bool(state
, "quiet", state
->quiet
);
1021 write_state_bool(state
, "sign", state
->signoff
);
1022 write_state_bool(state
, "utf8", state
->utf8
);
1024 if (state
->allow_rerere_autoupdate
)
1025 write_state_bool(state
, "rerere-autoupdate",
1026 state
->allow_rerere_autoupdate
== RERERE_AUTOUPDATE
);
1028 switch (state
->keep
) {
1035 case KEEP_NON_PATCH
:
1039 die("BUG: invalid value for state->keep");
1042 write_state_text(state
, "keep", str
);
1043 write_state_bool(state
, "messageid", state
->message_id
);
1045 switch (state
->scissors
) {
1046 case SCISSORS_UNSET
:
1049 case SCISSORS_FALSE
:
1056 die("BUG: invalid value for state->scissors");
1058 write_state_text(state
, "scissors", str
);
1060 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
, 0);
1061 write_state_text(state
, "apply-opt", sb
.buf
);
1063 if (state
->rebasing
)
1064 write_state_text(state
, "rebasing", "");
1066 write_state_text(state
, "applying", "");
1068 if (!get_oid("HEAD", &curr_head
)) {
1069 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1070 if (!state
->rebasing
)
1071 update_ref_oid("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1072 UPDATE_REFS_DIE_ON_ERR
);
1074 write_state_text(state
, "abort-safety", "");
1075 if (!state
->rebasing
)
1076 delete_ref(NULL
, "ORIG_HEAD", NULL
, 0);
1080 * NOTE: Since the "next" and "last" files determine if an am_state
1081 * session is in progress, they should be written last.
1084 write_state_count(state
, "next", state
->cur
);
1085 write_state_count(state
, "last", state
->last
);
1087 strbuf_release(&sb
);
1091 * Increments the patch pointer, and cleans am_state for the application of the
1094 static void am_next(struct am_state
*state
)
1096 struct object_id head
;
1098 FREE_AND_NULL(state
->author_name
);
1099 FREE_AND_NULL(state
->author_email
);
1100 FREE_AND_NULL(state
->author_date
);
1101 FREE_AND_NULL(state
->msg
);
1104 unlink(am_path(state
, "author-script"));
1105 unlink(am_path(state
, "final-commit"));
1107 oidclr(&state
->orig_commit
);
1108 unlink(am_path(state
, "original-commit"));
1110 if (!get_oid("HEAD", &head
))
1111 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1113 write_state_text(state
, "abort-safety", "");
1116 write_state_count(state
, "next", state
->cur
);
1120 * Returns the filename of the current patch email.
1122 static const char *msgnum(const struct am_state
*state
)
1124 static struct strbuf sb
= STRBUF_INIT
;
1127 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1133 * Refresh and write index.
1135 static void refresh_and_write_cache(void)
1137 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
1139 hold_locked_index(lock_file
, LOCK_DIE_ON_ERROR
);
1140 refresh_cache(REFRESH_QUIET
);
1141 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1142 die(_("unable to write index file"));
1146 * Dies with a user-friendly message on how to proceed after resolving the
1147 * problem. This message can be overridden with state->resolvemsg.
1149 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1151 if (state
->resolvemsg
) {
1152 printf_ln("%s", state
->resolvemsg
);
1154 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1156 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1157 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1158 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1165 * Appends signoff to the "msg" field of the am_state.
1167 static void am_append_signoff(struct am_state
*state
)
1169 struct strbuf sb
= STRBUF_INIT
;
1171 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1172 append_signoff(&sb
, 0, 0);
1173 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1177 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1178 * state->msg will be set to the patch message. state->author_name,
1179 * state->author_email and state->author_date will be set to the patch author's
1180 * name, email and date respectively. The patch body will be written to the
1181 * state directory's "patch" file.
1183 * Returns 1 if the patch should be skipped, 0 otherwise.
1185 static int parse_mail(struct am_state
*state
, const char *mail
)
1188 struct strbuf sb
= STRBUF_INIT
;
1189 struct strbuf msg
= STRBUF_INIT
;
1190 struct strbuf author_name
= STRBUF_INIT
;
1191 struct strbuf author_date
= STRBUF_INIT
;
1192 struct strbuf author_email
= STRBUF_INIT
;
1196 setup_mailinfo(&mi
);
1199 mi
.metainfo_charset
= get_commit_output_encoding();
1201 mi
.metainfo_charset
= NULL
;
1203 switch (state
->keep
) {
1207 mi
.keep_subject
= 1;
1209 case KEEP_NON_PATCH
:
1210 mi
.keep_non_patch_brackets_in_subject
= 1;
1213 die("BUG: invalid value for state->keep");
1216 if (state
->message_id
)
1217 mi
.add_message_id
= 1;
1219 switch (state
->scissors
) {
1220 case SCISSORS_UNSET
:
1222 case SCISSORS_FALSE
:
1223 mi
.use_scissors
= 0;
1226 mi
.use_scissors
= 1;
1229 die("BUG: invalid value for state->scissors");
1232 mi
.input
= xfopen(mail
, "r");
1233 mi
.output
= xfopen(am_path(state
, "info"), "w");
1234 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1235 die("could not parse patch");
1240 /* Extract message and author information */
1241 fp
= xfopen(am_path(state
, "info"), "r");
1242 while (!strbuf_getline_lf(&sb
, fp
)) {
1245 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1247 strbuf_addch(&msg
, '\n');
1248 strbuf_addstr(&msg
, x
);
1249 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1250 strbuf_addstr(&author_name
, x
);
1251 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1252 strbuf_addstr(&author_email
, x
);
1253 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1254 strbuf_addstr(&author_date
, x
);
1258 /* Skip pine's internal folder data */
1259 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1264 if (is_empty_file(am_path(state
, "patch"))) {
1265 printf_ln(_("Patch is empty."));
1266 die_user_resolve(state
);
1269 strbuf_addstr(&msg
, "\n\n");
1270 strbuf_addbuf(&msg
, &mi
.log_message
);
1271 strbuf_stripspace(&msg
, 0);
1273 assert(!state
->author_name
);
1274 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1276 assert(!state
->author_email
);
1277 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1279 assert(!state
->author_date
);
1280 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1282 assert(!state
->msg
);
1283 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1286 strbuf_release(&msg
);
1287 strbuf_release(&author_date
);
1288 strbuf_release(&author_email
);
1289 strbuf_release(&author_name
);
1290 strbuf_release(&sb
);
1291 clear_mailinfo(&mi
);
1296 * Sets commit_id to the commit hash where the mail was generated from.
1297 * Returns 0 on success, -1 on failure.
1299 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1301 struct strbuf sb
= STRBUF_INIT
;
1302 FILE *fp
= xfopen(mail
, "r");
1306 if (strbuf_getline_lf(&sb
, fp
) ||
1307 !skip_prefix(sb
.buf
, "From ", &x
) ||
1308 get_oid_hex(x
, commit_id
) < 0)
1311 strbuf_release(&sb
);
1317 * Sets state->msg, state->author_name, state->author_email, state->author_date
1318 * to the commit's respective info.
1320 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1322 const char *buffer
, *ident_line
, *msg
;
1324 struct ident_split id
;
1326 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1328 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1330 if (split_ident_line(&id
, ident_line
, ident_len
) < 0)
1331 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1333 assert(!state
->author_name
);
1335 state
->author_name
=
1336 xmemdupz(id
.name_begin
, id
.name_end
- id
.name_begin
);
1338 state
->author_name
= xstrdup("");
1340 assert(!state
->author_email
);
1342 state
->author_email
=
1343 xmemdupz(id
.mail_begin
, id
.mail_end
- id
.mail_begin
);
1345 state
->author_email
= xstrdup("");
1347 assert(!state
->author_date
);
1348 state
->author_date
= xstrdup(show_ident_date(&id
, DATE_MODE(NORMAL
)));
1350 assert(!state
->msg
);
1351 msg
= strstr(buffer
, "\n\n");
1353 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1354 state
->msg
= xstrdup(msg
+ 2);
1355 state
->msg_len
= strlen(state
->msg
);
1356 unuse_commit_buffer(commit
, buffer
);
1360 * Writes `commit` as a patch to the state directory's "patch" file.
1362 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1364 struct rev_info rev_info
;
1367 fp
= xfopen(am_path(state
, "patch"), "w");
1368 init_revisions(&rev_info
, NULL
);
1370 rev_info
.abbrev
= 0;
1371 rev_info
.disable_stdin
= 1;
1372 rev_info
.show_root_diff
= 1;
1373 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1374 rev_info
.no_commit_id
= 1;
1375 DIFF_OPT_SET(&rev_info
.diffopt
, BINARY
);
1376 DIFF_OPT_SET(&rev_info
.diffopt
, FULL_INDEX
);
1377 rev_info
.diffopt
.use_color
= 0;
1378 rev_info
.diffopt
.file
= fp
;
1379 rev_info
.diffopt
.close_file
= 1;
1380 add_pending_object(&rev_info
, &commit
->object
, "");
1381 diff_setup_done(&rev_info
.diffopt
);
1382 log_tree_commit(&rev_info
, commit
);
1386 * Writes the diff of the index against HEAD as a patch to the state
1387 * directory's "patch" file.
1389 static void write_index_patch(const struct am_state
*state
)
1392 struct object_id head
;
1393 struct rev_info rev_info
;
1396 if (!get_oid_tree("HEAD", &head
))
1397 tree
= lookup_tree(&head
);
1399 tree
= lookup_tree(&empty_tree_oid
);
1401 fp
= xfopen(am_path(state
, "patch"), "w");
1402 init_revisions(&rev_info
, NULL
);
1404 rev_info
.disable_stdin
= 1;
1405 rev_info
.no_commit_id
= 1;
1406 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1407 rev_info
.diffopt
.use_color
= 0;
1408 rev_info
.diffopt
.file
= fp
;
1409 rev_info
.diffopt
.close_file
= 1;
1410 add_pending_object(&rev_info
, &tree
->object
, "");
1411 diff_setup_done(&rev_info
.diffopt
);
1412 run_diff_index(&rev_info
, 1);
1416 * Like parse_mail(), but parses the mail by looking up its commit ID
1417 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1420 * state->orig_commit will be set to the original commit ID.
1422 * Will always return 0 as the patch should never be skipped.
1424 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1426 struct commit
*commit
;
1427 struct object_id commit_oid
;
1429 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1430 die(_("could not parse %s"), mail
);
1432 commit
= lookup_commit_or_die(&commit_oid
, mail
);
1434 get_commit_info(state
, commit
);
1436 write_commit_patch(state
, commit
);
1438 oidcpy(&state
->orig_commit
, &commit_oid
);
1439 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1445 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1446 * `index_file` is not NULL, the patch will be applied to that index.
1448 static int run_apply(const struct am_state
*state
, const char *index_file
)
1450 struct argv_array apply_paths
= ARGV_ARRAY_INIT
;
1451 struct argv_array apply_opts
= ARGV_ARRAY_INIT
;
1452 struct apply_state apply_state
;
1454 static struct lock_file lock_file
;
1455 int force_apply
= 0;
1458 if (init_apply_state(&apply_state
, NULL
, &lock_file
))
1459 die("BUG: init_apply_state() failed");
1461 argv_array_push(&apply_opts
, "apply");
1462 argv_array_pushv(&apply_opts
, state
->git_apply_opts
.argv
);
1464 opts_left
= apply_parse_options(apply_opts
.argc
, apply_opts
.argv
,
1465 &apply_state
, &force_apply
, &options
,
1469 die("unknown option passed through to git apply");
1472 apply_state
.index_file
= index_file
;
1473 apply_state
.cached
= 1;
1475 apply_state
.check_index
= 1;
1478 * If we are allowed to fall back on 3-way merge, don't give false
1479 * errors during the initial attempt.
1481 if (state
->threeway
&& !index_file
)
1482 apply_state
.apply_verbosity
= verbosity_silent
;
1484 if (check_apply_state(&apply_state
, force_apply
))
1485 die("BUG: check_apply_state() failed");
1487 argv_array_push(&apply_paths
, am_path(state
, "patch"));
1489 res
= apply_all_patches(&apply_state
, apply_paths
.argc
, apply_paths
.argv
, options
);
1491 argv_array_clear(&apply_paths
);
1492 argv_array_clear(&apply_opts
);
1493 clear_apply_state(&apply_state
);
1499 /* Reload index as apply_all_patches() will have modified it. */
1501 read_cache_from(index_file
);
1508 * Builds an index that contains just the blobs needed for a 3way merge.
1510 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1512 struct child_process cp
= CHILD_PROCESS_INIT
;
1515 argv_array_push(&cp
.args
, "apply");
1516 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1517 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1518 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1520 if (run_command(&cp
))
1527 * Attempt a threeway merge, using index_path as the temporary index.
1529 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1531 struct object_id orig_tree
, their_tree
, our_tree
;
1532 const struct object_id
*bases
[1] = { &orig_tree
};
1533 struct merge_options o
;
1534 struct commit
*result
;
1535 char *their_tree_name
;
1537 if (get_oid("HEAD", &our_tree
) < 0)
1538 hashcpy(our_tree
.hash
, EMPTY_TREE_SHA1_BIN
);
1540 if (build_fake_ancestor(state
, index_path
))
1541 return error("could not build fake ancestor");
1544 read_cache_from(index_path
);
1546 if (write_index_as_tree(orig_tree
.hash
, &the_index
, index_path
, 0, NULL
))
1547 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1549 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1551 if (!state
->quiet
) {
1553 * List paths that needed 3-way fallback, so that the user can
1554 * review them with extra care to spot mismerges.
1556 struct rev_info rev_info
;
1557 const char *diff_filter_str
= "--diff-filter=AM";
1559 init_revisions(&rev_info
, NULL
);
1560 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1561 diff_opt_parse(&rev_info
.diffopt
, &diff_filter_str
, 1, rev_info
.prefix
);
1562 add_pending_oid(&rev_info
, "HEAD", &our_tree
, 0);
1563 diff_setup_done(&rev_info
.diffopt
);
1564 run_diff_index(&rev_info
, 1);
1567 if (run_apply(state
, index_path
))
1568 return error(_("Did you hand edit your patch?\n"
1569 "It does not apply to blobs recorded in its index."));
1571 if (write_index_as_tree(their_tree
.hash
, &the_index
, index_path
, 0, NULL
))
1572 return error("could not write tree");
1574 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1580 * This is not so wrong. Depending on which base we picked, orig_tree
1581 * may be wildly different from ours, but their_tree has the same set of
1582 * wildly different changes in parts the patch did not touch, so
1583 * recursive ends up canceling them, saying that we reverted all those
1587 init_merge_options(&o
);
1590 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1591 o
.branch2
= their_tree_name
;
1596 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1597 rerere(state
->allow_rerere_autoupdate
);
1598 free(their_tree_name
);
1599 return error(_("Failed to merge in the changes."));
1602 free(their_tree_name
);
1607 * Commits the current index with state->msg as the commit message and
1608 * state->author_name, state->author_email and state->author_date as the author
1611 static void do_commit(const struct am_state
*state
)
1613 struct object_id tree
, parent
, commit
;
1614 const struct object_id
*old_oid
;
1615 struct commit_list
*parents
= NULL
;
1616 const char *reflog_msg
, *author
;
1617 struct strbuf sb
= STRBUF_INIT
;
1619 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1622 if (write_cache_as_tree(tree
.hash
, 0, NULL
))
1623 die(_("git write-tree failed to write a tree"));
1625 if (!get_oid_commit("HEAD", &parent
)) {
1627 commit_list_insert(lookup_commit(&parent
), &parents
);
1630 say(state
, stderr
, _("applying to an empty history"));
1633 author
= fmt_ident(state
->author_name
, state
->author_email
,
1634 state
->ignore_date
? NULL
: state
->author_date
,
1637 if (state
->committer_date_is_author_date
)
1638 setenv("GIT_COMMITTER_DATE",
1639 state
->ignore_date
? "" : state
->author_date
, 1);
1641 if (commit_tree(state
->msg
, state
->msg_len
, tree
.hash
, parents
, commit
.hash
,
1642 author
, state
->sign_commit
))
1643 die(_("failed to write commit object"));
1645 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1649 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1652 update_ref_oid(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1653 UPDATE_REFS_DIE_ON_ERR
);
1655 if (state
->rebasing
) {
1656 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1658 assert(!is_null_oid(&state
->orig_commit
));
1659 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1660 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1664 run_hook_le(NULL
, "post-applypatch", NULL
);
1666 strbuf_release(&sb
);
1670 * Validates the am_state for resuming -- the "msg" and authorship fields must
1673 static void validate_resume_state(const struct am_state
*state
)
1676 die(_("cannot resume: %s does not exist."),
1677 am_path(state
, "final-commit"));
1679 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1680 die(_("cannot resume: %s does not exist."),
1681 am_path(state
, "author-script"));
1685 * Interactively prompt the user on whether the current patch should be
1688 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1691 static int do_interactive(struct am_state
*state
)
1696 die(_("cannot be interactive without stdin connected to a terminal."));
1701 puts(_("Commit Body is:"));
1702 puts("--------------------------");
1703 printf("%s", state
->msg
);
1704 puts("--------------------------");
1707 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1708 * in your translation. The program will only accept English
1709 * input at this point.
1711 reply
= git_prompt(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "), PROMPT_ECHO
);
1715 } else if (*reply
== 'y' || *reply
== 'Y') {
1717 } else if (*reply
== 'a' || *reply
== 'A') {
1718 state
->interactive
= 0;
1720 } else if (*reply
== 'n' || *reply
== 'N') {
1722 } else if (*reply
== 'e' || *reply
== 'E') {
1723 struct strbuf msg
= STRBUF_INIT
;
1725 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1727 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1729 strbuf_release(&msg
);
1730 } else if (*reply
== 'v' || *reply
== 'V') {
1731 const char *pager
= git_pager(1);
1732 struct child_process cp
= CHILD_PROCESS_INIT
;
1736 prepare_pager_args(&cp
, pager
);
1737 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1744 * Applies all queued mail.
1746 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1747 * well as the state directory's "patch" file is used as-is for applying the
1748 * patch and committing it.
1750 static void am_run(struct am_state
*state
, int resume
)
1752 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1753 struct strbuf sb
= STRBUF_INIT
;
1755 unlink(am_path(state
, "dirtyindex"));
1757 refresh_and_write_cache();
1759 if (index_has_changes(&sb
)) {
1760 write_state_bool(state
, "dirtyindex", 1);
1761 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1764 strbuf_release(&sb
);
1766 while (state
->cur
<= state
->last
) {
1767 const char *mail
= am_path(state
, msgnum(state
));
1772 if (!file_exists(mail
))
1776 validate_resume_state(state
);
1780 if (state
->rebasing
)
1781 skip
= parse_mail_rebase(state
, mail
);
1783 skip
= parse_mail(state
, mail
);
1786 goto next
; /* mail should be skipped */
1789 am_append_signoff(state
);
1791 write_author_script(state
);
1792 write_commit_msg(state
);
1795 if (state
->interactive
&& do_interactive(state
))
1798 if (run_applypatch_msg_hook(state
))
1801 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1803 apply_status
= run_apply(state
, NULL
);
1805 if (apply_status
&& state
->threeway
) {
1806 struct strbuf sb
= STRBUF_INIT
;
1808 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1809 apply_status
= fall_back_threeway(state
, sb
.buf
);
1810 strbuf_release(&sb
);
1813 * Applying the patch to an earlier tree and merging
1814 * the result may have produced the same tree as ours.
1816 if (!apply_status
&& !index_has_changes(NULL
)) {
1817 say(state
, stdout
, _("No changes -- Patch already applied."));
1823 int advice_amworkdir
= 1;
1825 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1826 linelen(state
->msg
), state
->msg
);
1828 git_config_get_bool("advice.amworkdir", &advice_amworkdir
);
1830 if (advice_amworkdir
)
1831 printf_ln(_("The copy of the patch that failed is found in: %s"),
1832 am_path(state
, "patch"));
1834 die_user_resolve(state
);
1847 if (!is_empty_file(am_path(state
, "rewritten"))) {
1848 assert(state
->rebasing
);
1849 copy_notes_for_rebase(state
);
1850 run_post_rewrite_hook(state
);
1854 * In rebasing mode, it's up to the caller to take care of
1857 if (!state
->rebasing
) {
1860 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1865 * Resume the current am session after patch application failure. The user did
1866 * all the hard work, and we do not have to do any patch application. Just
1867 * trust and commit what the user has in the index and working tree.
1869 static void am_resolve(struct am_state
*state
)
1871 validate_resume_state(state
);
1873 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1875 if (!index_has_changes(NULL
)) {
1876 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1877 "If there is nothing left to stage, chances are that something else\n"
1878 "already introduced the same changes; you might want to skip this patch."));
1879 die_user_resolve(state
);
1882 if (unmerged_cache()) {
1883 printf_ln(_("You still have unmerged paths in your index.\n"
1884 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1885 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1886 die_user_resolve(state
);
1889 if (state
->interactive
) {
1890 write_index_patch(state
);
1891 if (do_interactive(state
))
1906 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1907 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1910 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1912 struct lock_file
*lock_file
;
1913 struct unpack_trees_options opts
;
1914 struct tree_desc t
[2];
1916 if (parse_tree(head
) || parse_tree(remote
))
1919 lock_file
= xcalloc(1, sizeof(struct lock_file
));
1920 hold_locked_index(lock_file
, LOCK_DIE_ON_ERROR
);
1922 refresh_cache(REFRESH_QUIET
);
1924 memset(&opts
, 0, sizeof(opts
));
1926 opts
.src_index
= &the_index
;
1927 opts
.dst_index
= &the_index
;
1931 opts
.fn
= twoway_merge
;
1932 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1933 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1935 if (unpack_trees(2, t
, &opts
)) {
1936 rollback_lock_file(lock_file
);
1940 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1941 die(_("unable to write new index file"));
1947 * Merges a tree into the index. The index's stat info will take precedence
1948 * over the merged tree's. Returns 0 on success, -1 on failure.
1950 static int merge_tree(struct tree
*tree
)
1952 struct lock_file
*lock_file
;
1953 struct unpack_trees_options opts
;
1954 struct tree_desc t
[1];
1956 if (parse_tree(tree
))
1959 lock_file
= xcalloc(1, sizeof(struct lock_file
));
1960 hold_locked_index(lock_file
, LOCK_DIE_ON_ERROR
);
1962 memset(&opts
, 0, sizeof(opts
));
1964 opts
.src_index
= &the_index
;
1965 opts
.dst_index
= &the_index
;
1967 opts
.fn
= oneway_merge
;
1968 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
1970 if (unpack_trees(1, t
, &opts
)) {
1971 rollback_lock_file(lock_file
);
1975 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1976 die(_("unable to write new index file"));
1982 * Clean the index without touching entries that are not modified between
1983 * `head` and `remote`.
1985 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
1987 struct tree
*head_tree
, *remote_tree
, *index_tree
;
1988 struct object_id index
;
1990 head_tree
= parse_tree_indirect(head
);
1992 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
1994 remote_tree
= parse_tree_indirect(remote
);
1996 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
1998 read_cache_unmerged();
2000 if (fast_forward_to(head_tree
, head_tree
, 1))
2003 if (write_cache_as_tree(index
.hash
, 0, NULL
))
2006 index_tree
= parse_tree_indirect(&index
);
2008 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
2010 if (fast_forward_to(index_tree
, remote_tree
, 0))
2013 if (merge_tree(remote_tree
))
2016 remove_branch_state();
2022 * Resets rerere's merge resolution metadata.
2024 static void am_rerere_clear(void)
2026 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
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 struct object_id head
;
2040 if (get_oid("HEAD", &head
))
2041 hashcpy(head
.hash
, 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 struct object_id abort_safety
, head
;
2063 if (file_exists(am_path(state
, "dirtyindex")))
2066 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2067 if (get_oid_hex(sb
.buf
, &abort_safety
))
2068 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2070 oidclr(&abort_safety
);
2071 strbuf_release(&sb
);
2073 if (get_oid("HEAD", &head
))
2076 if (!oidcmp(&head
, &abort_safety
))
2079 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2080 "Not rewinding to ORIG_HEAD"));
2086 * Aborts the current am session if it is safe to do so.
2088 static void am_abort(struct am_state
*state
)
2090 struct object_id curr_head
, orig_head
;
2091 int has_curr_head
, has_orig_head
;
2094 if (!safe_to_abort(state
)) {
2101 curr_branch
= resolve_refdup("HEAD", 0, curr_head
.hash
, NULL
);
2102 has_curr_head
= curr_branch
&& !is_null_oid(&curr_head
);
2104 hashcpy(curr_head
.hash
, EMPTY_TREE_SHA1_BIN
);
2106 has_orig_head
= !get_oid("ORIG_HEAD", &orig_head
);
2108 hashcpy(orig_head
.hash
, EMPTY_TREE_SHA1_BIN
);
2110 clean_index(&curr_head
, &orig_head
);
2113 update_ref_oid("am --abort", "HEAD", &orig_head
,
2114 has_curr_head
? &curr_head
: NULL
, 0,
2115 UPDATE_REFS_DIE_ON_ERR
);
2116 else if (curr_branch
)
2117 delete_ref(NULL
, curr_branch
, NULL
, REF_NODEREF
);
2124 * parse_options() callback that validates and sets opt->value to the
2125 * PATCH_FORMAT_* enum value corresponding to `arg`.
2127 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2129 int *opt_value
= opt
->value
;
2131 if (!strcmp(arg
, "mbox"))
2132 *opt_value
= PATCH_FORMAT_MBOX
;
2133 else if (!strcmp(arg
, "stgit"))
2134 *opt_value
= PATCH_FORMAT_STGIT
;
2135 else if (!strcmp(arg
, "stgit-series"))
2136 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2137 else if (!strcmp(arg
, "hg"))
2138 *opt_value
= PATCH_FORMAT_HG
;
2139 else if (!strcmp(arg
, "mboxrd"))
2140 *opt_value
= PATCH_FORMAT_MBOXRD
;
2142 return error(_("Invalid value for --patch-format: %s"), arg
);
2154 static int git_am_config(const char *k
, const char *v
, void *cb
)
2158 status
= git_gpg_config(k
, v
, NULL
);
2162 return git_default_config(k
, v
, NULL
);
2165 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2167 struct am_state state
;
2170 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2171 enum resume_mode resume
= RESUME_FALSE
;
2174 const char * const usage
[] = {
2175 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2176 N_("git am [<options>] (--continue | --skip | --abort)"),
2180 struct option options
[] = {
2181 OPT_BOOL('i', "interactive", &state
.interactive
,
2182 N_("run interactively")),
2183 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2184 N_("historical option -- no-op")),
2185 OPT_BOOL('3', "3way", &state
.threeway
,
2186 N_("allow fall back on 3way merging if needed")),
2187 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2188 OPT_SET_INT('s', "signoff", &state
.signoff
,
2189 N_("add a Signed-off-by line to the commit message"),
2191 OPT_BOOL('u', "utf8", &state
.utf8
,
2192 N_("recode into utf8 (default)")),
2193 OPT_SET_INT('k', "keep", &state
.keep
,
2194 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2195 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2196 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2197 OPT_BOOL('m', "message-id", &state
.message_id
,
2198 N_("pass -m flag to git-mailinfo")),
2199 { OPTION_SET_INT
, 0, "keep-cr", &keep_cr
, NULL
,
2200 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2201 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1},
2202 { OPTION_SET_INT
, 0, "no-keep-cr", &keep_cr
, NULL
,
2203 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2204 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 0},
2205 OPT_BOOL('c', "scissors", &state
.scissors
,
2206 N_("strip everything before a scissors line")),
2207 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2208 N_("pass it through git-apply"),
2210 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2211 N_("pass it through git-apply"),
2213 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2214 N_("pass it through git-apply"),
2216 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2217 N_("pass it through git-apply"),
2219 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2220 N_("pass it through git-apply"),
2222 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2223 N_("pass it through git-apply"),
2225 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2226 N_("pass it through git-apply"),
2228 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2229 N_("pass it through git-apply"),
2231 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2232 N_("format the patch(es) are in"),
2233 parse_opt_patchformat
),
2234 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2235 N_("pass it through git-apply"),
2237 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2238 N_("override error message when patch failure occurs")),
2239 OPT_CMDMODE(0, "continue", &resume
,
2240 N_("continue applying patches after resolving a conflict"),
2242 OPT_CMDMODE('r', "resolved", &resume
,
2243 N_("synonyms for --continue"),
2245 OPT_CMDMODE(0, "skip", &resume
,
2246 N_("skip the current patch"),
2248 OPT_CMDMODE(0, "abort", &resume
,
2249 N_("restore the original branch and abort the patching operation."),
2251 OPT_BOOL(0, "committer-date-is-author-date",
2252 &state
.committer_date_is_author_date
,
2253 N_("lie about committer date")),
2254 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2255 N_("use current timestamp for author date")),
2256 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2257 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2258 N_("GPG-sign commits"),
2259 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2260 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2261 N_("(internal use for git-rebase)")),
2265 if (argc
== 2 && !strcmp(argv
[1], "-h"))
2266 usage_with_options(usage
, options
);
2268 git_config(git_am_config
, NULL
);
2270 am_state_init(&state
);
2272 in_progress
= am_in_progress(&state
);
2276 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2279 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2280 "it will be removed. Please do not use it anymore."));
2282 /* Ensure a valid committer ident can be constructed */
2283 git_committer_info(IDENT_STRICT
);
2285 if (read_index_preload(&the_index
, NULL
) < 0)
2286 die(_("failed to read the index"));
2290 * Catch user error to feed us patches when there is a session
2293 * 1. mbox path(s) are provided on the command-line.
2294 * 2. stdin is not a tty: the user is trying to feed us a patch
2295 * from standard input. This is somewhat unreliable -- stdin
2296 * could be /dev/null for example and the caller did not
2297 * intend to feed us a patch but wanted to continue
2300 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
2301 die(_("previous rebase directory %s still exists but mbox given."),
2304 if (resume
== RESUME_FALSE
)
2305 resume
= RESUME_APPLY
;
2307 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2308 am_append_signoff(&state
);
2310 struct argv_array paths
= ARGV_ARRAY_INIT
;
2314 * Handle stray state directory in the independent-run case. In
2315 * the --rebasing case, it is up to the caller to take care of
2316 * stray directories.
2318 if (file_exists(state
.dir
) && !state
.rebasing
) {
2319 if (resume
== RESUME_ABORT
) {
2321 am_state_release(&state
);
2325 die(_("Stray %s directory found.\n"
2326 "Use \"git am --abort\" to remove it."),
2331 die(_("Resolve operation not in progress, we are not resuming."));
2333 for (i
= 0; i
< argc
; i
++) {
2334 if (is_absolute_path(argv
[i
]) || !prefix
)
2335 argv_array_push(&paths
, argv
[i
]);
2337 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2340 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2342 argv_array_clear(&paths
);
2352 case RESUME_RESOLVED
:
2362 die("BUG: invalid resume value");
2365 am_state_release(&state
);