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"
36 * Returns 1 if the file is empty or does not exist, 0 otherwise.
38 static int is_empty_file(const char *filename
)
42 if (stat(filename
, &st
) < 0) {
45 die_errno(_("could not stat %s"), filename
);
52 * Returns the length of the first line of msg.
54 static int linelen(const char *msg
)
56 return strchrnul(msg
, '\n') - msg
;
60 * Returns true if `str` consists of only whitespace, false otherwise.
62 static int str_isspace(const char *str
)
72 PATCH_FORMAT_UNKNOWN
= 0,
75 PATCH_FORMAT_STGIT_SERIES
,
82 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
83 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
88 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
89 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
95 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
99 /* state directory path */
102 /* current and last patch numbers, 1-indexed */
106 /* commit metadata and message */
113 /* when --rebasing, records the original commit the patch came from */
114 struct object_id orig_commit
;
116 /* number of digits in patch filename */
119 /* various operating modes and command line options */
123 int signoff
; /* enum signoff_type */
125 int keep
; /* enum keep_type */
127 int scissors
; /* enum scissors_type */
128 struct argv_array git_apply_opts
;
129 const char *resolvemsg
;
130 int committer_date_is_author_date
;
132 int allow_rerere_autoupdate
;
133 const char *sign_commit
;
138 * Initializes am_state with the default values.
140 static void am_state_init(struct am_state
*state
)
144 memset(state
, 0, sizeof(*state
));
146 state
->dir
= git_pathdup("rebase-apply");
150 git_config_get_bool("am.threeway", &state
->threeway
);
154 git_config_get_bool("am.messageid", &state
->message_id
);
156 state
->scissors
= SCISSORS_UNSET
;
158 argv_array_init(&state
->git_apply_opts
);
160 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
161 state
->sign_commit
= gpgsign
? "" : NULL
;
165 * Releases memory allocated by an am_state.
167 static void am_state_release(struct am_state
*state
)
170 free(state
->author_name
);
171 free(state
->author_email
);
172 free(state
->author_date
);
174 argv_array_clear(&state
->git_apply_opts
);
178 * Returns path relative to the am_state directory.
180 static inline const char *am_path(const struct am_state
*state
, const char *path
)
182 return mkpath("%s/%s", state
->dir
, path
);
186 * For convenience to call write_file()
188 static void write_state_text(const struct am_state
*state
,
189 const char *name
, const char *string
)
191 write_file(am_path(state
, name
), "%s", string
);
194 static void write_state_count(const struct am_state
*state
,
195 const char *name
, int value
)
197 write_file(am_path(state
, name
), "%d", value
);
200 static void write_state_bool(const struct am_state
*state
,
201 const char *name
, int value
)
203 write_state_text(state
, name
, value
? "t" : "f");
207 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
210 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
216 vfprintf(fp
, fmt
, ap
);
223 * Returns 1 if there is an am session in progress, 0 otherwise.
225 static int am_in_progress(const struct am_state
*state
)
229 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
231 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
233 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
239 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
240 * number of bytes read on success, -1 if the file does not exist. If `trim` is
241 * set, trailing whitespace will be removed.
243 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
244 const char *file
, int trim
)
248 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
258 die_errno(_("could not read '%s'"), am_path(state
, file
));
262 * Take a series of KEY='VALUE' lines where VALUE part is
263 * sq-quoted, and append <KEY, VALUE> at the end of the string list
265 static int parse_key_value_squoted(char *buf
, struct string_list
*list
)
268 struct string_list_item
*item
;
270 char *cp
= strchr(buf
, '=');
273 np
= strchrnul(cp
, '\n');
275 item
= string_list_append(list
, buf
);
277 buf
= np
+ (*np
== '\n');
282 item
->util
= xstrdup(cp
);
288 * Reads and parses the state directory's "author-script" file, and sets
289 * state->author_name, state->author_email and state->author_date accordingly.
290 * Returns 0 on success, -1 if the file could not be parsed.
292 * The author script is of the format:
294 * GIT_AUTHOR_NAME='$author_name'
295 * GIT_AUTHOR_EMAIL='$author_email'
296 * GIT_AUTHOR_DATE='$author_date'
298 * where $author_name, $author_email and $author_date are quoted. We are strict
299 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
300 * script, and thus if the file differs from what this function expects, it is
301 * better to bail out than to do something that the user does not expect.
303 static int read_author_script(struct am_state
*state
)
305 const char *filename
= am_path(state
, "author-script");
306 struct strbuf buf
= STRBUF_INIT
;
307 struct string_list kv
= STRING_LIST_INIT_DUP
;
308 int retval
= -1; /* assume failure */
311 assert(!state
->author_name
);
312 assert(!state
->author_email
);
313 assert(!state
->author_date
);
315 fd
= open(filename
, O_RDONLY
);
319 die_errno(_("could not open '%s' for reading"), filename
);
321 strbuf_read(&buf
, fd
, 0);
323 if (parse_key_value_squoted(buf
.buf
, &kv
))
327 strcmp(kv
.items
[0].string
, "GIT_AUTHOR_NAME") ||
328 strcmp(kv
.items
[1].string
, "GIT_AUTHOR_EMAIL") ||
329 strcmp(kv
.items
[2].string
, "GIT_AUTHOR_DATE"))
331 state
->author_name
= kv
.items
[0].util
;
332 state
->author_email
= kv
.items
[1].util
;
333 state
->author_date
= kv
.items
[2].util
;
336 string_list_clear(&kv
, !!retval
);
337 strbuf_release(&buf
);
342 * Saves state->author_name, state->author_email and state->author_date in the
343 * state directory's "author-script" file.
345 static void write_author_script(const struct am_state
*state
)
347 struct strbuf sb
= STRBUF_INIT
;
349 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
350 sq_quote_buf(&sb
, state
->author_name
);
351 strbuf_addch(&sb
, '\n');
353 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
354 sq_quote_buf(&sb
, state
->author_email
);
355 strbuf_addch(&sb
, '\n');
357 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
358 sq_quote_buf(&sb
, state
->author_date
);
359 strbuf_addch(&sb
, '\n');
361 write_state_text(state
, "author-script", sb
.buf
);
367 * Reads the commit message from the state directory's "final-commit" file,
368 * setting state->msg to its contents and state->msg_len to the length of its
371 * Returns 0 on success, -1 if the file does not exist.
373 static int read_commit_msg(struct am_state
*state
)
375 struct strbuf sb
= STRBUF_INIT
;
379 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
384 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
389 * Saves state->msg in the state directory's "final-commit" file.
391 static void write_commit_msg(const struct am_state
*state
)
393 const char *filename
= am_path(state
, "final-commit");
394 write_file_buf(filename
, state
->msg
, state
->msg_len
);
398 * Loads state from disk.
400 static void am_load(struct am_state
*state
)
402 struct strbuf sb
= STRBUF_INIT
;
404 if (read_state_file(&sb
, state
, "next", 1) < 0)
405 die("BUG: state file 'next' does not exist");
406 state
->cur
= strtol(sb
.buf
, NULL
, 10);
408 if (read_state_file(&sb
, state
, "last", 1) < 0)
409 die("BUG: state file 'last' does not exist");
410 state
->last
= strtol(sb
.buf
, NULL
, 10);
412 if (read_author_script(state
) < 0)
413 die(_("could not parse author script"));
415 read_commit_msg(state
);
417 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
418 oidclr(&state
->orig_commit
);
419 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
420 die(_("could not parse %s"), am_path(state
, "original-commit"));
422 read_state_file(&sb
, state
, "threeway", 1);
423 state
->threeway
= !strcmp(sb
.buf
, "t");
425 read_state_file(&sb
, state
, "quiet", 1);
426 state
->quiet
= !strcmp(sb
.buf
, "t");
428 read_state_file(&sb
, state
, "sign", 1);
429 state
->signoff
= !strcmp(sb
.buf
, "t");
431 read_state_file(&sb
, state
, "utf8", 1);
432 state
->utf8
= !strcmp(sb
.buf
, "t");
434 if (file_exists(am_path(state
, "rerere-autoupdate"))) {
435 read_state_file(&sb
, state
, "rerere-autoupdate", 1);
436 state
->allow_rerere_autoupdate
= strcmp(sb
.buf
, "t") ?
437 RERERE_NOAUTOUPDATE
: RERERE_AUTOUPDATE
;
439 state
->allow_rerere_autoupdate
= 0;
442 read_state_file(&sb
, state
, "keep", 1);
443 if (!strcmp(sb
.buf
, "t"))
444 state
->keep
= KEEP_TRUE
;
445 else if (!strcmp(sb
.buf
, "b"))
446 state
->keep
= KEEP_NON_PATCH
;
448 state
->keep
= KEEP_FALSE
;
450 read_state_file(&sb
, state
, "messageid", 1);
451 state
->message_id
= !strcmp(sb
.buf
, "t");
453 read_state_file(&sb
, state
, "scissors", 1);
454 if (!strcmp(sb
.buf
, "t"))
455 state
->scissors
= SCISSORS_TRUE
;
456 else if (!strcmp(sb
.buf
, "f"))
457 state
->scissors
= SCISSORS_FALSE
;
459 state
->scissors
= SCISSORS_UNSET
;
461 read_state_file(&sb
, state
, "apply-opt", 1);
462 argv_array_clear(&state
->git_apply_opts
);
463 if (sq_dequote_to_argv_array(sb
.buf
, &state
->git_apply_opts
) < 0)
464 die(_("could not parse %s"), am_path(state
, "apply-opt"));
466 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
472 * Removes the am_state directory, forcefully terminating the current am
475 static void am_destroy(const struct am_state
*state
)
477 struct strbuf sb
= STRBUF_INIT
;
479 strbuf_addstr(&sb
, state
->dir
);
480 remove_dir_recursively(&sb
, 0);
485 * Runs applypatch-msg hook. Returns its exit code.
487 static int run_applypatch_msg_hook(struct am_state
*state
)
492 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
495 FREE_AND_NULL(state
->msg
);
496 if (read_commit_msg(state
) < 0)
497 die(_("'%s' was deleted by the applypatch-msg hook"),
498 am_path(state
, "final-commit"));
505 * Runs post-rewrite hook. Returns it exit code.
507 static int run_post_rewrite_hook(const struct am_state
*state
)
509 struct child_process cp
= CHILD_PROCESS_INIT
;
510 const char *hook
= find_hook("post-rewrite");
516 argv_array_push(&cp
.args
, hook
);
517 argv_array_push(&cp
.args
, "rebase");
519 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
520 cp
.stdout_to_stderr
= 1;
522 ret
= run_command(&cp
);
529 * Reads the state directory's "rewritten" file, and copies notes from the old
530 * commits listed in the file to their rewritten commits.
532 * Returns 0 on success, -1 on failure.
534 static int copy_notes_for_rebase(const struct am_state
*state
)
536 struct notes_rewrite_cfg
*c
;
537 struct strbuf sb
= STRBUF_INIT
;
538 const char *invalid_line
= _("Malformed input line: '%s'.");
539 const char *msg
= "Notes added by 'git rebase'";
543 assert(state
->rebasing
);
545 c
= init_copy_notes_for_rewrite("rebase");
549 fp
= xfopen(am_path(state
, "rewritten"), "r");
551 while (!strbuf_getline_lf(&sb
, fp
)) {
552 struct object_id from_obj
, to_obj
;
554 if (sb
.len
!= GIT_SHA1_HEXSZ
* 2 + 1) {
555 ret
= error(invalid_line
, sb
.buf
);
559 if (get_oid_hex(sb
.buf
, &from_obj
)) {
560 ret
= error(invalid_line
, sb
.buf
);
564 if (sb
.buf
[GIT_SHA1_HEXSZ
] != ' ') {
565 ret
= error(invalid_line
, sb
.buf
);
569 if (get_oid_hex(sb
.buf
+ GIT_SHA1_HEXSZ
+ 1, &to_obj
)) {
570 ret
= error(invalid_line
, sb
.buf
);
574 if (copy_note_for_rewrite(c
, &from_obj
, &to_obj
))
575 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
576 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
580 finish_copy_notes_for_rewrite(c
, msg
);
587 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
588 * non-indented lines and checking if they look like they begin with valid
589 * header field names.
591 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
593 static int is_mail(FILE *fp
)
595 const char *header_regex
= "^[!-9;-~]+:";
596 struct strbuf sb
= STRBUF_INIT
;
600 if (fseek(fp
, 0L, SEEK_SET
))
601 die_errno(_("fseek failed"));
603 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
604 die("invalid pattern: %s", header_regex
);
606 while (!strbuf_getline(&sb
, fp
)) {
608 break; /* End of header */
610 /* Ignore indented folded lines */
611 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
614 /* It's a header if it matches header_regex */
615 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
628 * Attempts to detect the patch_format of the patches contained in `paths`,
629 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
632 static int detect_patch_format(const char **paths
)
634 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
635 struct strbuf l1
= STRBUF_INIT
;
636 struct strbuf l2
= STRBUF_INIT
;
637 struct strbuf l3
= STRBUF_INIT
;
641 * We default to mbox format if input is from stdin and for directories
643 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
644 return PATCH_FORMAT_MBOX
;
647 * Otherwise, check the first few lines of the first patch, starting
648 * from the first non-blank line, to try to detect its format.
651 fp
= xfopen(*paths
, "r");
653 while (!strbuf_getline(&l1
, fp
)) {
658 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
659 ret
= PATCH_FORMAT_MBOX
;
663 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
664 ret
= PATCH_FORMAT_STGIT_SERIES
;
668 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
669 ret
= PATCH_FORMAT_HG
;
674 strbuf_getline(&l2
, fp
);
676 strbuf_getline(&l3
, fp
);
679 * If the second line is empty and the third is a From, Author or Date
680 * entry, this is likely an StGit patch.
682 if (l1
.len
&& !l2
.len
&&
683 (starts_with(l3
.buf
, "From:") ||
684 starts_with(l3
.buf
, "Author:") ||
685 starts_with(l3
.buf
, "Date:"))) {
686 ret
= PATCH_FORMAT_STGIT
;
690 if (l1
.len
&& is_mail(fp
)) {
691 ret
= PATCH_FORMAT_MBOX
;
702 * Splits out individual email patches from `paths`, where each path is either
703 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
705 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
706 int keep_cr
, int mboxrd
)
708 struct child_process cp
= CHILD_PROCESS_INIT
;
709 struct strbuf last
= STRBUF_INIT
;
712 argv_array_push(&cp
.args
, "mailsplit");
713 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
714 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
715 argv_array_push(&cp
.args
, "-b");
717 argv_array_push(&cp
.args
, "--keep-cr");
719 argv_array_push(&cp
.args
, "--mboxrd");
720 argv_array_push(&cp
.args
, "--");
721 argv_array_pushv(&cp
.args
, paths
);
723 if (capture_command(&cp
, &last
, 8))
727 state
->last
= strtol(last
.buf
, NULL
, 10);
733 * Callback signature for split_mail_conv(). The foreign patch should be
734 * read from `in`, and the converted patch (in RFC2822 mail format) should be
735 * written to `out`. Return 0 on success, or -1 on failure.
737 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
740 * Calls `fn` for each file in `paths` to convert the foreign patch to the
741 * RFC2822 mail format suitable for parsing with git-mailinfo.
743 * Returns 0 on success, -1 on failure.
745 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
746 const char **paths
, int keep_cr
)
748 static const char *stdin_only
[] = {"-", NULL
};
754 for (i
= 0; *paths
; paths
++, i
++) {
759 if (!strcmp(*paths
, "-"))
762 in
= fopen(*paths
, "r");
765 return error_errno(_("could not open '%s' for reading"),
768 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
770 out
= fopen(mail
, "w");
774 return error_errno(_("could not open '%s' for writing"),
778 ret
= fn(out
, in
, keep_cr
);
785 return error(_("could not parse patch '%s'"), *paths
);
794 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
795 * message suitable for parsing with git-mailinfo.
797 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
799 struct strbuf sb
= STRBUF_INIT
;
800 int subject_printed
= 0;
802 while (!strbuf_getline_lf(&sb
, in
)) {
805 if (str_isspace(sb
.buf
))
807 else if (skip_prefix(sb
.buf
, "Author:", &str
))
808 fprintf(out
, "From:%s\n", str
);
809 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
810 fprintf(out
, "%s\n", sb
.buf
);
811 else if (!subject_printed
) {
812 fprintf(out
, "Subject: %s\n", sb
.buf
);
815 fprintf(out
, "\n%s\n", sb
.buf
);
821 while (strbuf_fread(&sb
, 8192, in
) > 0) {
822 fwrite(sb
.buf
, 1, sb
.len
, out
);
831 * This function only supports a single StGit series file in `paths`.
833 * Given an StGit series file, converts the StGit patches in the series into
834 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
835 * the state directory.
837 * Returns 0 on success, -1 on failure.
839 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
842 const char *series_dir
;
843 char *series_dir_buf
;
845 struct argv_array patches
= ARGV_ARRAY_INIT
;
846 struct strbuf sb
= STRBUF_INIT
;
849 if (!paths
[0] || paths
[1])
850 return error(_("Only one StGIT patch series can be applied at once"));
852 series_dir_buf
= xstrdup(*paths
);
853 series_dir
= dirname(series_dir_buf
);
855 fp
= fopen(*paths
, "r");
857 return error_errno(_("could not open '%s' for reading"), *paths
);
859 while (!strbuf_getline_lf(&sb
, fp
)) {
861 continue; /* skip comment lines */
863 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
868 free(series_dir_buf
);
870 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
872 argv_array_clear(&patches
);
877 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
878 * message suitable for parsing with git-mailinfo.
880 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
882 struct strbuf sb
= STRBUF_INIT
;
884 while (!strbuf_getline_lf(&sb
, in
)) {
887 if (skip_prefix(sb
.buf
, "# User ", &str
))
888 fprintf(out
, "From: %s\n", str
);
889 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
890 timestamp_t timestamp
;
895 timestamp
= parse_timestamp(str
, &end
, 10);
897 return error(_("invalid timestamp"));
899 if (!skip_prefix(end
, " ", &str
))
900 return error(_("invalid Date line"));
903 tz
= strtol(str
, &end
, 10);
905 return error(_("invalid timezone offset"));
908 return error(_("invalid Date line"));
911 * mercurial's timezone is in seconds west of UTC,
912 * however git's timezone is in hours + minutes east of
915 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
919 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
920 } else if (starts_with(sb
.buf
, "# ")) {
923 fprintf(out
, "\n%s\n", sb
.buf
);
929 while (strbuf_fread(&sb
, 8192, in
) > 0) {
930 fwrite(sb
.buf
, 1, sb
.len
, out
);
939 * Splits a list of files/directories into individual email patches. Each path
940 * in `paths` must be a file/directory that is formatted according to
943 * Once split out, the individual email patches will be stored in the state
944 * directory, with each patch's filename being its index, padded to state->prec
947 * state->cur will be set to the index of the first mail, and state->last will
948 * be set to the index of the last mail.
950 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
951 * to disable this behavior, -1 to use the default configured setting.
953 * Returns 0 on success, -1 on failure.
955 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
956 const char **paths
, int keep_cr
)
960 git_config_get_bool("am.keepcr", &keep_cr
);
963 switch (patch_format
) {
964 case PATCH_FORMAT_MBOX
:
965 return split_mail_mbox(state
, paths
, keep_cr
, 0);
966 case PATCH_FORMAT_STGIT
:
967 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
968 case PATCH_FORMAT_STGIT_SERIES
:
969 return split_mail_stgit_series(state
, paths
, keep_cr
);
970 case PATCH_FORMAT_HG
:
971 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
972 case PATCH_FORMAT_MBOXRD
:
973 return split_mail_mbox(state
, paths
, keep_cr
, 1);
975 die("BUG: invalid patch_format");
981 * Setup a new am session for applying patches
983 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
984 const char **paths
, int keep_cr
)
986 struct object_id curr_head
;
988 struct strbuf sb
= STRBUF_INIT
;
991 patch_format
= detect_patch_format(paths
);
994 fprintf_ln(stderr
, _("Patch format detection failed."));
998 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
999 die_errno(_("failed to create directory '%s'"), state
->dir
);
1001 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
1003 die(_("Failed to split patches."));
1006 if (state
->rebasing
)
1007 state
->threeway
= 1;
1009 write_state_bool(state
, "threeway", state
->threeway
);
1010 write_state_bool(state
, "quiet", state
->quiet
);
1011 write_state_bool(state
, "sign", state
->signoff
);
1012 write_state_bool(state
, "utf8", state
->utf8
);
1014 if (state
->allow_rerere_autoupdate
)
1015 write_state_bool(state
, "rerere-autoupdate",
1016 state
->allow_rerere_autoupdate
== RERERE_AUTOUPDATE
);
1018 switch (state
->keep
) {
1025 case KEEP_NON_PATCH
:
1029 die("BUG: invalid value for state->keep");
1032 write_state_text(state
, "keep", str
);
1033 write_state_bool(state
, "messageid", state
->message_id
);
1035 switch (state
->scissors
) {
1036 case SCISSORS_UNSET
:
1039 case SCISSORS_FALSE
:
1046 die("BUG: invalid value for state->scissors");
1048 write_state_text(state
, "scissors", str
);
1050 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
, 0);
1051 write_state_text(state
, "apply-opt", sb
.buf
);
1053 if (state
->rebasing
)
1054 write_state_text(state
, "rebasing", "");
1056 write_state_text(state
, "applying", "");
1058 if (!get_oid("HEAD", &curr_head
)) {
1059 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1060 if (!state
->rebasing
)
1061 update_ref_oid("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1062 UPDATE_REFS_DIE_ON_ERR
);
1064 write_state_text(state
, "abort-safety", "");
1065 if (!state
->rebasing
)
1066 delete_ref(NULL
, "ORIG_HEAD", NULL
, 0);
1070 * NOTE: Since the "next" and "last" files determine if an am_state
1071 * session is in progress, they should be written last.
1074 write_state_count(state
, "next", state
->cur
);
1075 write_state_count(state
, "last", state
->last
);
1077 strbuf_release(&sb
);
1081 * Increments the patch pointer, and cleans am_state for the application of the
1084 static void am_next(struct am_state
*state
)
1086 struct object_id head
;
1088 FREE_AND_NULL(state
->author_name
);
1089 FREE_AND_NULL(state
->author_email
);
1090 FREE_AND_NULL(state
->author_date
);
1091 FREE_AND_NULL(state
->msg
);
1094 unlink(am_path(state
, "author-script"));
1095 unlink(am_path(state
, "final-commit"));
1097 oidclr(&state
->orig_commit
);
1098 unlink(am_path(state
, "original-commit"));
1100 if (!get_oid("HEAD", &head
))
1101 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1103 write_state_text(state
, "abort-safety", "");
1106 write_state_count(state
, "next", state
->cur
);
1110 * Returns the filename of the current patch email.
1112 static const char *msgnum(const struct am_state
*state
)
1114 static struct strbuf sb
= STRBUF_INIT
;
1117 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1123 * Refresh and write index.
1125 static void refresh_and_write_cache(void)
1127 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
1129 hold_locked_index(lock_file
, LOCK_DIE_ON_ERROR
);
1130 refresh_cache(REFRESH_QUIET
);
1131 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1132 die(_("unable to write index file"));
1136 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
1137 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
1138 * strbuf is provided, the space-separated list of files that differ will be
1141 static int index_has_changes(struct strbuf
*sb
)
1143 struct object_id head
;
1146 if (!get_sha1_tree("HEAD", head
.hash
)) {
1147 struct diff_options opt
;
1150 DIFF_OPT_SET(&opt
, EXIT_WITH_STATUS
);
1152 DIFF_OPT_SET(&opt
, QUICK
);
1153 do_diff_cache(&head
, &opt
);
1155 for (i
= 0; sb
&& i
< diff_queued_diff
.nr
; i
++) {
1157 strbuf_addch(sb
, ' ');
1158 strbuf_addstr(sb
, diff_queued_diff
.queue
[i
]->two
->path
);
1161 return DIFF_OPT_TST(&opt
, HAS_CHANGES
) != 0;
1163 for (i
= 0; sb
&& i
< active_nr
; i
++) {
1165 strbuf_addch(sb
, ' ');
1166 strbuf_addstr(sb
, active_cache
[i
]->name
);
1173 * Dies with a user-friendly message on how to proceed after resolving the
1174 * problem. This message can be overridden with state->resolvemsg.
1176 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1178 if (state
->resolvemsg
) {
1179 printf_ln("%s", state
->resolvemsg
);
1181 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1183 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1184 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1185 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1192 * Appends signoff to the "msg" field of the am_state.
1194 static void am_append_signoff(struct am_state
*state
)
1197 struct strbuf mine
= STRBUF_INIT
;
1198 struct strbuf sb
= STRBUF_INIT
;
1200 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1203 strbuf_addf(&mine
, "\n%s%s\n",
1205 fmt_name(getenv("GIT_COMMITTER_NAME"),
1206 getenv("GIT_COMMITTER_EMAIL")));
1208 /* Does sb end with it already? */
1209 if (mine
.len
< sb
.len
&&
1210 !strcmp(mine
.buf
, sb
.buf
+ sb
.len
- mine
.len
))
1211 goto exit
; /* no need to duplicate */
1213 /* Does it have any Signed-off-by: in the text */
1215 cp
&& *cp
&& (cp
= strstr(cp
, sign_off_header
)) != NULL
;
1216 cp
= strchr(cp
, '\n')) {
1217 if (sb
.buf
== cp
|| cp
[-1] == '\n')
1221 strbuf_addstr(&sb
, mine
.buf
+ !!cp
);
1223 strbuf_release(&mine
);
1224 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1228 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1229 * state->msg will be set to the patch message. state->author_name,
1230 * state->author_email and state->author_date will be set to the patch author's
1231 * name, email and date respectively. The patch body will be written to the
1232 * state directory's "patch" file.
1234 * Returns 1 if the patch should be skipped, 0 otherwise.
1236 static int parse_mail(struct am_state
*state
, const char *mail
)
1239 struct strbuf sb
= STRBUF_INIT
;
1240 struct strbuf msg
= STRBUF_INIT
;
1241 struct strbuf author_name
= STRBUF_INIT
;
1242 struct strbuf author_date
= STRBUF_INIT
;
1243 struct strbuf author_email
= STRBUF_INIT
;
1247 setup_mailinfo(&mi
);
1250 mi
.metainfo_charset
= get_commit_output_encoding();
1252 mi
.metainfo_charset
= NULL
;
1254 switch (state
->keep
) {
1258 mi
.keep_subject
= 1;
1260 case KEEP_NON_PATCH
:
1261 mi
.keep_non_patch_brackets_in_subject
= 1;
1264 die("BUG: invalid value for state->keep");
1267 if (state
->message_id
)
1268 mi
.add_message_id
= 1;
1270 switch (state
->scissors
) {
1271 case SCISSORS_UNSET
:
1273 case SCISSORS_FALSE
:
1274 mi
.use_scissors
= 0;
1277 mi
.use_scissors
= 1;
1280 die("BUG: invalid value for state->scissors");
1283 mi
.input
= xfopen(mail
, "r");
1284 mi
.output
= xfopen(am_path(state
, "info"), "w");
1285 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1286 die("could not parse patch");
1291 /* Extract message and author information */
1292 fp
= xfopen(am_path(state
, "info"), "r");
1293 while (!strbuf_getline_lf(&sb
, fp
)) {
1296 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1298 strbuf_addch(&msg
, '\n');
1299 strbuf_addstr(&msg
, x
);
1300 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1301 strbuf_addstr(&author_name
, x
);
1302 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1303 strbuf_addstr(&author_email
, x
);
1304 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1305 strbuf_addstr(&author_date
, x
);
1309 /* Skip pine's internal folder data */
1310 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1315 if (is_empty_file(am_path(state
, "patch"))) {
1316 printf_ln(_("Patch is empty."));
1317 die_user_resolve(state
);
1320 strbuf_addstr(&msg
, "\n\n");
1321 strbuf_addbuf(&msg
, &mi
.log_message
);
1322 strbuf_stripspace(&msg
, 0);
1324 assert(!state
->author_name
);
1325 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1327 assert(!state
->author_email
);
1328 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1330 assert(!state
->author_date
);
1331 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1333 assert(!state
->msg
);
1334 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1337 strbuf_release(&msg
);
1338 strbuf_release(&author_date
);
1339 strbuf_release(&author_email
);
1340 strbuf_release(&author_name
);
1341 strbuf_release(&sb
);
1342 clear_mailinfo(&mi
);
1347 * Sets commit_id to the commit hash where the mail was generated from.
1348 * Returns 0 on success, -1 on failure.
1350 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1352 struct strbuf sb
= STRBUF_INIT
;
1353 FILE *fp
= xfopen(mail
, "r");
1357 if (strbuf_getline_lf(&sb
, fp
) ||
1358 !skip_prefix(sb
.buf
, "From ", &x
) ||
1359 get_oid_hex(x
, commit_id
) < 0)
1362 strbuf_release(&sb
);
1368 * Sets state->msg, state->author_name, state->author_email, state->author_date
1369 * to the commit's respective info.
1371 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1373 const char *buffer
, *ident_line
, *msg
;
1375 struct ident_split id
;
1377 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1379 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1381 if (split_ident_line(&id
, ident_line
, ident_len
) < 0)
1382 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1384 assert(!state
->author_name
);
1386 state
->author_name
=
1387 xmemdupz(id
.name_begin
, id
.name_end
- id
.name_begin
);
1389 state
->author_name
= xstrdup("");
1391 assert(!state
->author_email
);
1393 state
->author_email
=
1394 xmemdupz(id
.mail_begin
, id
.mail_end
- id
.mail_begin
);
1396 state
->author_email
= xstrdup("");
1398 assert(!state
->author_date
);
1399 state
->author_date
= xstrdup(show_ident_date(&id
, DATE_MODE(NORMAL
)));
1401 assert(!state
->msg
);
1402 msg
= strstr(buffer
, "\n\n");
1404 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1405 state
->msg
= xstrdup(msg
+ 2);
1406 state
->msg_len
= strlen(state
->msg
);
1407 unuse_commit_buffer(commit
, buffer
);
1411 * Writes `commit` as a patch to the state directory's "patch" file.
1413 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1415 struct rev_info rev_info
;
1418 fp
= xfopen(am_path(state
, "patch"), "w");
1419 init_revisions(&rev_info
, NULL
);
1421 rev_info
.abbrev
= 0;
1422 rev_info
.disable_stdin
= 1;
1423 rev_info
.show_root_diff
= 1;
1424 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1425 rev_info
.no_commit_id
= 1;
1426 DIFF_OPT_SET(&rev_info
.diffopt
, BINARY
);
1427 DIFF_OPT_SET(&rev_info
.diffopt
, FULL_INDEX
);
1428 rev_info
.diffopt
.use_color
= 0;
1429 rev_info
.diffopt
.file
= fp
;
1430 rev_info
.diffopt
.close_file
= 1;
1431 add_pending_object(&rev_info
, &commit
->object
, "");
1432 diff_setup_done(&rev_info
.diffopt
);
1433 log_tree_commit(&rev_info
, commit
);
1437 * Writes the diff of the index against HEAD as a patch to the state
1438 * directory's "patch" file.
1440 static void write_index_patch(const struct am_state
*state
)
1443 struct object_id head
;
1444 struct rev_info rev_info
;
1447 if (!get_sha1_tree("HEAD", head
.hash
))
1448 tree
= lookup_tree(&head
);
1450 tree
= lookup_tree(&empty_tree_oid
);
1452 fp
= xfopen(am_path(state
, "patch"), "w");
1453 init_revisions(&rev_info
, NULL
);
1455 rev_info
.disable_stdin
= 1;
1456 rev_info
.no_commit_id
= 1;
1457 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1458 rev_info
.diffopt
.use_color
= 0;
1459 rev_info
.diffopt
.file
= fp
;
1460 rev_info
.diffopt
.close_file
= 1;
1461 add_pending_object(&rev_info
, &tree
->object
, "");
1462 diff_setup_done(&rev_info
.diffopt
);
1463 run_diff_index(&rev_info
, 1);
1467 * Like parse_mail(), but parses the mail by looking up its commit ID
1468 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1471 * state->orig_commit will be set to the original commit ID.
1473 * Will always return 0 as the patch should never be skipped.
1475 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1477 struct commit
*commit
;
1478 struct object_id commit_oid
;
1480 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1481 die(_("could not parse %s"), mail
);
1483 commit
= lookup_commit_or_die(&commit_oid
, mail
);
1485 get_commit_info(state
, commit
);
1487 write_commit_patch(state
, commit
);
1489 oidcpy(&state
->orig_commit
, &commit_oid
);
1490 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1496 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1497 * `index_file` is not NULL, the patch will be applied to that index.
1499 static int run_apply(const struct am_state
*state
, const char *index_file
)
1501 struct argv_array apply_paths
= ARGV_ARRAY_INIT
;
1502 struct argv_array apply_opts
= ARGV_ARRAY_INIT
;
1503 struct apply_state apply_state
;
1505 static struct lock_file lock_file
;
1506 int force_apply
= 0;
1509 if (init_apply_state(&apply_state
, NULL
, &lock_file
))
1510 die("BUG: init_apply_state() failed");
1512 argv_array_push(&apply_opts
, "apply");
1513 argv_array_pushv(&apply_opts
, state
->git_apply_opts
.argv
);
1515 opts_left
= apply_parse_options(apply_opts
.argc
, apply_opts
.argv
,
1516 &apply_state
, &force_apply
, &options
,
1520 die("unknown option passed through to git apply");
1523 apply_state
.index_file
= index_file
;
1524 apply_state
.cached
= 1;
1526 apply_state
.check_index
= 1;
1529 * If we are allowed to fall back on 3-way merge, don't give false
1530 * errors during the initial attempt.
1532 if (state
->threeway
&& !index_file
)
1533 apply_state
.apply_verbosity
= verbosity_silent
;
1535 if (check_apply_state(&apply_state
, force_apply
))
1536 die("BUG: check_apply_state() failed");
1538 argv_array_push(&apply_paths
, am_path(state
, "patch"));
1540 res
= apply_all_patches(&apply_state
, apply_paths
.argc
, apply_paths
.argv
, options
);
1542 argv_array_clear(&apply_paths
);
1543 argv_array_clear(&apply_opts
);
1544 clear_apply_state(&apply_state
);
1550 /* Reload index as apply_all_patches() will have modified it. */
1552 read_cache_from(index_file
);
1559 * Builds an index that contains just the blobs needed for a 3way merge.
1561 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1563 struct child_process cp
= CHILD_PROCESS_INIT
;
1566 argv_array_push(&cp
.args
, "apply");
1567 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1568 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1569 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1571 if (run_command(&cp
))
1578 * Attempt a threeway merge, using index_path as the temporary index.
1580 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1582 struct object_id orig_tree
, their_tree
, our_tree
;
1583 const struct object_id
*bases
[1] = { &orig_tree
};
1584 struct merge_options o
;
1585 struct commit
*result
;
1586 char *their_tree_name
;
1588 if (get_oid("HEAD", &our_tree
) < 0)
1589 hashcpy(our_tree
.hash
, EMPTY_TREE_SHA1_BIN
);
1591 if (build_fake_ancestor(state
, index_path
))
1592 return error("could not build fake ancestor");
1595 read_cache_from(index_path
);
1597 if (write_index_as_tree(orig_tree
.hash
, &the_index
, index_path
, 0, NULL
))
1598 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1600 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1602 if (!state
->quiet
) {
1604 * List paths that needed 3-way fallback, so that the user can
1605 * review them with extra care to spot mismerges.
1607 struct rev_info rev_info
;
1608 const char *diff_filter_str
= "--diff-filter=AM";
1610 init_revisions(&rev_info
, NULL
);
1611 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1612 diff_opt_parse(&rev_info
.diffopt
, &diff_filter_str
, 1, rev_info
.prefix
);
1613 add_pending_oid(&rev_info
, "HEAD", &our_tree
, 0);
1614 diff_setup_done(&rev_info
.diffopt
);
1615 run_diff_index(&rev_info
, 1);
1618 if (run_apply(state
, index_path
))
1619 return error(_("Did you hand edit your patch?\n"
1620 "It does not apply to blobs recorded in its index."));
1622 if (write_index_as_tree(their_tree
.hash
, &the_index
, index_path
, 0, NULL
))
1623 return error("could not write tree");
1625 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1631 * This is not so wrong. Depending on which base we picked, orig_tree
1632 * may be wildly different from ours, but their_tree has the same set of
1633 * wildly different changes in parts the patch did not touch, so
1634 * recursive ends up canceling them, saying that we reverted all those
1638 init_merge_options(&o
);
1641 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1642 o
.branch2
= their_tree_name
;
1647 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1648 rerere(state
->allow_rerere_autoupdate
);
1649 free(their_tree_name
);
1650 return error(_("Failed to merge in the changes."));
1653 free(their_tree_name
);
1658 * Commits the current index with state->msg as the commit message and
1659 * state->author_name, state->author_email and state->author_date as the author
1662 static void do_commit(const struct am_state
*state
)
1664 struct object_id tree
, parent
, commit
;
1665 const struct object_id
*old_oid
;
1666 struct commit_list
*parents
= NULL
;
1667 const char *reflog_msg
, *author
;
1668 struct strbuf sb
= STRBUF_INIT
;
1670 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1673 if (write_cache_as_tree(tree
.hash
, 0, NULL
))
1674 die(_("git write-tree failed to write a tree"));
1676 if (!get_sha1_commit("HEAD", parent
.hash
)) {
1678 commit_list_insert(lookup_commit(&parent
), &parents
);
1681 say(state
, stderr
, _("applying to an empty history"));
1684 author
= fmt_ident(state
->author_name
, state
->author_email
,
1685 state
->ignore_date
? NULL
: state
->author_date
,
1688 if (state
->committer_date_is_author_date
)
1689 setenv("GIT_COMMITTER_DATE",
1690 state
->ignore_date
? "" : state
->author_date
, 1);
1692 if (commit_tree(state
->msg
, state
->msg_len
, tree
.hash
, parents
, commit
.hash
,
1693 author
, state
->sign_commit
))
1694 die(_("failed to write commit object"));
1696 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1700 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1703 update_ref_oid(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1704 UPDATE_REFS_DIE_ON_ERR
);
1706 if (state
->rebasing
) {
1707 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1709 assert(!is_null_oid(&state
->orig_commit
));
1710 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1711 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1715 run_hook_le(NULL
, "post-applypatch", NULL
);
1717 strbuf_release(&sb
);
1721 * Validates the am_state for resuming -- the "msg" and authorship fields must
1724 static void validate_resume_state(const struct am_state
*state
)
1727 die(_("cannot resume: %s does not exist."),
1728 am_path(state
, "final-commit"));
1730 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1731 die(_("cannot resume: %s does not exist."),
1732 am_path(state
, "author-script"));
1736 * Interactively prompt the user on whether the current patch should be
1739 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1742 static int do_interactive(struct am_state
*state
)
1747 die(_("cannot be interactive without stdin connected to a terminal."));
1752 puts(_("Commit Body is:"));
1753 puts("--------------------------");
1754 printf("%s", state
->msg
);
1755 puts("--------------------------");
1758 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1759 * in your translation. The program will only accept English
1760 * input at this point.
1762 reply
= git_prompt(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "), PROMPT_ECHO
);
1766 } else if (*reply
== 'y' || *reply
== 'Y') {
1768 } else if (*reply
== 'a' || *reply
== 'A') {
1769 state
->interactive
= 0;
1771 } else if (*reply
== 'n' || *reply
== 'N') {
1773 } else if (*reply
== 'e' || *reply
== 'E') {
1774 struct strbuf msg
= STRBUF_INIT
;
1776 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1778 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1780 strbuf_release(&msg
);
1781 } else if (*reply
== 'v' || *reply
== 'V') {
1782 const char *pager
= git_pager(1);
1783 struct child_process cp
= CHILD_PROCESS_INIT
;
1787 prepare_pager_args(&cp
, pager
);
1788 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1795 * Applies all queued mail.
1797 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1798 * well as the state directory's "patch" file is used as-is for applying the
1799 * patch and committing it.
1801 static void am_run(struct am_state
*state
, int resume
)
1803 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1804 struct strbuf sb
= STRBUF_INIT
;
1806 unlink(am_path(state
, "dirtyindex"));
1808 refresh_and_write_cache();
1810 if (index_has_changes(&sb
)) {
1811 write_state_bool(state
, "dirtyindex", 1);
1812 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1815 strbuf_release(&sb
);
1817 while (state
->cur
<= state
->last
) {
1818 const char *mail
= am_path(state
, msgnum(state
));
1823 if (!file_exists(mail
))
1827 validate_resume_state(state
);
1831 if (state
->rebasing
)
1832 skip
= parse_mail_rebase(state
, mail
);
1834 skip
= parse_mail(state
, mail
);
1837 goto next
; /* mail should be skipped */
1840 am_append_signoff(state
);
1842 write_author_script(state
);
1843 write_commit_msg(state
);
1846 if (state
->interactive
&& do_interactive(state
))
1849 if (run_applypatch_msg_hook(state
))
1852 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1854 apply_status
= run_apply(state
, NULL
);
1856 if (apply_status
&& state
->threeway
) {
1857 struct strbuf sb
= STRBUF_INIT
;
1859 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1860 apply_status
= fall_back_threeway(state
, sb
.buf
);
1861 strbuf_release(&sb
);
1864 * Applying the patch to an earlier tree and merging
1865 * the result may have produced the same tree as ours.
1867 if (!apply_status
&& !index_has_changes(NULL
)) {
1868 say(state
, stdout
, _("No changes -- Patch already applied."));
1874 int advice_amworkdir
= 1;
1876 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1877 linelen(state
->msg
), state
->msg
);
1879 git_config_get_bool("advice.amworkdir", &advice_amworkdir
);
1881 if (advice_amworkdir
)
1882 printf_ln(_("The copy of the patch that failed is found in: %s"),
1883 am_path(state
, "patch"));
1885 die_user_resolve(state
);
1898 if (!is_empty_file(am_path(state
, "rewritten"))) {
1899 assert(state
->rebasing
);
1900 copy_notes_for_rebase(state
);
1901 run_post_rewrite_hook(state
);
1905 * In rebasing mode, it's up to the caller to take care of
1908 if (!state
->rebasing
) {
1911 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1916 * Resume the current am session after patch application failure. The user did
1917 * all the hard work, and we do not have to do any patch application. Just
1918 * trust and commit what the user has in the index and working tree.
1920 static void am_resolve(struct am_state
*state
)
1922 validate_resume_state(state
);
1924 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1926 if (!index_has_changes(NULL
)) {
1927 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1928 "If there is nothing left to stage, chances are that something else\n"
1929 "already introduced the same changes; you might want to skip this patch."));
1930 die_user_resolve(state
);
1933 if (unmerged_cache()) {
1934 printf_ln(_("You still have unmerged paths in your index.\n"
1935 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1936 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1937 die_user_resolve(state
);
1940 if (state
->interactive
) {
1941 write_index_patch(state
);
1942 if (do_interactive(state
))
1957 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1958 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1961 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1963 struct lock_file
*lock_file
;
1964 struct unpack_trees_options opts
;
1965 struct tree_desc t
[2];
1967 if (parse_tree(head
) || parse_tree(remote
))
1970 lock_file
= xcalloc(1, sizeof(struct lock_file
));
1971 hold_locked_index(lock_file
, LOCK_DIE_ON_ERROR
);
1973 refresh_cache(REFRESH_QUIET
);
1975 memset(&opts
, 0, sizeof(opts
));
1977 opts
.src_index
= &the_index
;
1978 opts
.dst_index
= &the_index
;
1982 opts
.fn
= twoway_merge
;
1983 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1984 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1986 if (unpack_trees(2, t
, &opts
)) {
1987 rollback_lock_file(lock_file
);
1991 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1992 die(_("unable to write new index file"));
1998 * Merges a tree into the index. The index's stat info will take precedence
1999 * over the merged tree's. Returns 0 on success, -1 on failure.
2001 static int merge_tree(struct tree
*tree
)
2003 struct lock_file
*lock_file
;
2004 struct unpack_trees_options opts
;
2005 struct tree_desc t
[1];
2007 if (parse_tree(tree
))
2010 lock_file
= xcalloc(1, sizeof(struct lock_file
));
2011 hold_locked_index(lock_file
, LOCK_DIE_ON_ERROR
);
2013 memset(&opts
, 0, sizeof(opts
));
2015 opts
.src_index
= &the_index
;
2016 opts
.dst_index
= &the_index
;
2018 opts
.fn
= oneway_merge
;
2019 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
2021 if (unpack_trees(1, t
, &opts
)) {
2022 rollback_lock_file(lock_file
);
2026 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
2027 die(_("unable to write new index file"));
2033 * Clean the index without touching entries that are not modified between
2034 * `head` and `remote`.
2036 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
2038 struct tree
*head_tree
, *remote_tree
, *index_tree
;
2039 struct object_id index
;
2041 head_tree
= parse_tree_indirect(head
);
2043 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
2045 remote_tree
= parse_tree_indirect(remote
);
2047 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
2049 read_cache_unmerged();
2051 if (fast_forward_to(head_tree
, head_tree
, 1))
2054 if (write_cache_as_tree(index
.hash
, 0, NULL
))
2057 index_tree
= parse_tree_indirect(&index
);
2059 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
2061 if (fast_forward_to(index_tree
, remote_tree
, 0))
2064 if (merge_tree(remote_tree
))
2067 remove_branch_state();
2073 * Resets rerere's merge resolution metadata.
2075 static void am_rerere_clear(void)
2077 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
2078 rerere_clear(&merge_rr
);
2079 string_list_clear(&merge_rr
, 1);
2083 * Resume the current am session by skipping the current patch.
2085 static void am_skip(struct am_state
*state
)
2087 struct object_id head
;
2091 if (get_oid("HEAD", &head
))
2092 hashcpy(head
.hash
, EMPTY_TREE_SHA1_BIN
);
2094 if (clean_index(&head
, &head
))
2095 die(_("failed to clean index"));
2103 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2105 * It is not safe to reset HEAD when:
2106 * 1. git-am previously failed because the index was dirty.
2107 * 2. HEAD has moved since git-am previously failed.
2109 static int safe_to_abort(const struct am_state
*state
)
2111 struct strbuf sb
= STRBUF_INIT
;
2112 struct object_id abort_safety
, head
;
2114 if (file_exists(am_path(state
, "dirtyindex")))
2117 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2118 if (get_oid_hex(sb
.buf
, &abort_safety
))
2119 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2121 oidclr(&abort_safety
);
2123 if (get_oid("HEAD", &head
))
2126 if (!oidcmp(&head
, &abort_safety
))
2129 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2130 "Not rewinding to ORIG_HEAD"));
2136 * Aborts the current am session if it is safe to do so.
2138 static void am_abort(struct am_state
*state
)
2140 struct object_id curr_head
, orig_head
;
2141 int has_curr_head
, has_orig_head
;
2144 if (!safe_to_abort(state
)) {
2151 curr_branch
= resolve_refdup("HEAD", 0, curr_head
.hash
, NULL
);
2152 has_curr_head
= curr_branch
&& !is_null_oid(&curr_head
);
2154 hashcpy(curr_head
.hash
, EMPTY_TREE_SHA1_BIN
);
2156 has_orig_head
= !get_oid("ORIG_HEAD", &orig_head
);
2158 hashcpy(orig_head
.hash
, EMPTY_TREE_SHA1_BIN
);
2160 clean_index(&curr_head
, &orig_head
);
2163 update_ref_oid("am --abort", "HEAD", &orig_head
,
2164 has_curr_head
? &curr_head
: NULL
, 0,
2165 UPDATE_REFS_DIE_ON_ERR
);
2166 else if (curr_branch
)
2167 delete_ref(NULL
, curr_branch
, NULL
, REF_NODEREF
);
2174 * parse_options() callback that validates and sets opt->value to the
2175 * PATCH_FORMAT_* enum value corresponding to `arg`.
2177 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2179 int *opt_value
= opt
->value
;
2181 if (!strcmp(arg
, "mbox"))
2182 *opt_value
= PATCH_FORMAT_MBOX
;
2183 else if (!strcmp(arg
, "stgit"))
2184 *opt_value
= PATCH_FORMAT_STGIT
;
2185 else if (!strcmp(arg
, "stgit-series"))
2186 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2187 else if (!strcmp(arg
, "hg"))
2188 *opt_value
= PATCH_FORMAT_HG
;
2189 else if (!strcmp(arg
, "mboxrd"))
2190 *opt_value
= PATCH_FORMAT_MBOXRD
;
2192 return error(_("Invalid value for --patch-format: %s"), arg
);
2204 static int git_am_config(const char *k
, const char *v
, void *cb
)
2208 status
= git_gpg_config(k
, v
, NULL
);
2212 return git_default_config(k
, v
, NULL
);
2215 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2217 struct am_state state
;
2220 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2221 enum resume_mode resume
= RESUME_FALSE
;
2224 const char * const usage
[] = {
2225 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2226 N_("git am [<options>] (--continue | --skip | --abort)"),
2230 struct option options
[] = {
2231 OPT_BOOL('i', "interactive", &state
.interactive
,
2232 N_("run interactively")),
2233 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2234 N_("historical option -- no-op")),
2235 OPT_BOOL('3', "3way", &state
.threeway
,
2236 N_("allow fall back on 3way merging if needed")),
2237 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2238 OPT_SET_INT('s', "signoff", &state
.signoff
,
2239 N_("add a Signed-off-by line to the commit message"),
2241 OPT_BOOL('u', "utf8", &state
.utf8
,
2242 N_("recode into utf8 (default)")),
2243 OPT_SET_INT('k', "keep", &state
.keep
,
2244 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2245 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2246 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2247 OPT_BOOL('m', "message-id", &state
.message_id
,
2248 N_("pass -m flag to git-mailinfo")),
2249 { OPTION_SET_INT
, 0, "keep-cr", &keep_cr
, NULL
,
2250 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2251 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1},
2252 { OPTION_SET_INT
, 0, "no-keep-cr", &keep_cr
, NULL
,
2253 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2254 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 0},
2255 OPT_BOOL('c', "scissors", &state
.scissors
,
2256 N_("strip everything before a scissors line")),
2257 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2258 N_("pass it through git-apply"),
2260 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2261 N_("pass it through git-apply"),
2263 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2264 N_("pass it through git-apply"),
2266 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2267 N_("pass it through git-apply"),
2269 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2270 N_("pass it through git-apply"),
2272 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2273 N_("pass it through git-apply"),
2275 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2276 N_("pass it through git-apply"),
2278 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2279 N_("pass it through git-apply"),
2281 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2282 N_("format the patch(es) are in"),
2283 parse_opt_patchformat
),
2284 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2285 N_("pass it through git-apply"),
2287 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2288 N_("override error message when patch failure occurs")),
2289 OPT_CMDMODE(0, "continue", &resume
,
2290 N_("continue applying patches after resolving a conflict"),
2292 OPT_CMDMODE('r', "resolved", &resume
,
2293 N_("synonyms for --continue"),
2295 OPT_CMDMODE(0, "skip", &resume
,
2296 N_("skip the current patch"),
2298 OPT_CMDMODE(0, "abort", &resume
,
2299 N_("restore the original branch and abort the patching operation."),
2301 OPT_BOOL(0, "committer-date-is-author-date",
2302 &state
.committer_date_is_author_date
,
2303 N_("lie about committer date")),
2304 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2305 N_("use current timestamp for author date")),
2306 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2307 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2308 N_("GPG-sign commits"),
2309 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2310 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2311 N_("(internal use for git-rebase)")),
2315 if (argc
== 2 && !strcmp(argv
[1], "-h"))
2316 usage_with_options(usage
, options
);
2318 git_config(git_am_config
, NULL
);
2320 am_state_init(&state
);
2322 in_progress
= am_in_progress(&state
);
2326 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2329 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2330 "it will be removed. Please do not use it anymore."));
2332 /* Ensure a valid committer ident can be constructed */
2333 git_committer_info(IDENT_STRICT
);
2335 if (read_index_preload(&the_index
, NULL
) < 0)
2336 die(_("failed to read the index"));
2340 * Catch user error to feed us patches when there is a session
2343 * 1. mbox path(s) are provided on the command-line.
2344 * 2. stdin is not a tty: the user is trying to feed us a patch
2345 * from standard input. This is somewhat unreliable -- stdin
2346 * could be /dev/null for example and the caller did not
2347 * intend to feed us a patch but wanted to continue
2350 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
2351 die(_("previous rebase directory %s still exists but mbox given."),
2354 if (resume
== RESUME_FALSE
)
2355 resume
= RESUME_APPLY
;
2357 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2358 am_append_signoff(&state
);
2360 struct argv_array paths
= ARGV_ARRAY_INIT
;
2364 * Handle stray state directory in the independent-run case. In
2365 * the --rebasing case, it is up to the caller to take care of
2366 * stray directories.
2368 if (file_exists(state
.dir
) && !state
.rebasing
) {
2369 if (resume
== RESUME_ABORT
) {
2371 am_state_release(&state
);
2375 die(_("Stray %s directory found.\n"
2376 "Use \"git am --abort\" to remove it."),
2381 die(_("Resolve operation not in progress, we are not resuming."));
2383 for (i
= 0; i
< argc
; i
++) {
2384 if (is_absolute_path(argv
[i
]) || !prefix
)
2385 argv_array_push(&paths
, argv
[i
]);
2387 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2390 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2392 argv_array_clear(&paths
);
2402 case RESUME_RESOLVED
:
2412 die("BUG: invalid resume value");
2415 am_state_release(&state
);