4 * Based on git-am.sh by Junio C Hamano.
10 #include "parse-options.h"
12 #include "run-command.h"
16 #include "cache-tree.h"
21 #include "unpack-trees.h"
23 #include "sequencer.h"
25 #include "merge-recursive.h"
28 #include "notes-utils.h"
33 #include "string-list.h"
35 #include "repository.h"
38 * Returns 1 if the file is empty or does not exist, 0 otherwise.
40 static int is_empty_file(const char *filename
)
44 if (stat(filename
, &st
) < 0) {
47 die_errno(_("could not stat %s"), filename
);
54 * Returns the length of the first line of msg.
56 static int linelen(const char *msg
)
58 return strchrnul(msg
, '\n') - msg
;
62 * Returns true if `str` consists of only whitespace, false otherwise.
64 static int str_isspace(const char *str
)
74 PATCH_FORMAT_UNKNOWN
= 0,
77 PATCH_FORMAT_STGIT_SERIES
,
84 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
85 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
90 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
91 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
97 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
101 /* state directory path */
104 /* current and last patch numbers, 1-indexed */
108 /* commit metadata and message */
115 /* when --rebasing, records the original commit the patch came from */
116 struct object_id orig_commit
;
118 /* number of digits in patch filename */
121 /* various operating modes and command line options */
125 int signoff
; /* enum signoff_type */
127 int keep
; /* enum keep_type */
129 int scissors
; /* enum scissors_type */
130 struct argv_array git_apply_opts
;
131 const char *resolvemsg
;
132 int committer_date_is_author_date
;
134 int allow_rerere_autoupdate
;
135 const char *sign_commit
;
140 * Initializes am_state with the default values.
142 static void am_state_init(struct am_state
*state
)
146 memset(state
, 0, sizeof(*state
));
148 state
->dir
= git_pathdup("rebase-apply");
152 git_config_get_bool("am.threeway", &state
->threeway
);
156 git_config_get_bool("am.messageid", &state
->message_id
);
158 state
->scissors
= SCISSORS_UNSET
;
160 argv_array_init(&state
->git_apply_opts
);
162 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
163 state
->sign_commit
= gpgsign
? "" : NULL
;
167 * Releases memory allocated by an am_state.
169 static void am_state_release(struct am_state
*state
)
172 free(state
->author_name
);
173 free(state
->author_email
);
174 free(state
->author_date
);
176 argv_array_clear(&state
->git_apply_opts
);
180 * Returns path relative to the am_state directory.
182 static inline const char *am_path(const struct am_state
*state
, const char *path
)
184 return mkpath("%s/%s", state
->dir
, path
);
188 * For convenience to call write_file()
190 static void write_state_text(const struct am_state
*state
,
191 const char *name
, const char *string
)
193 write_file(am_path(state
, name
), "%s", string
);
196 static void write_state_count(const struct am_state
*state
,
197 const char *name
, int value
)
199 write_file(am_path(state
, name
), "%d", value
);
202 static void write_state_bool(const struct am_state
*state
,
203 const char *name
, int value
)
205 write_state_text(state
, name
, value
? "t" : "f");
209 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
212 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
218 vfprintf(fp
, fmt
, ap
);
225 * Returns 1 if there is an am session in progress, 0 otherwise.
227 static int am_in_progress(const struct am_state
*state
)
231 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
233 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
235 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
241 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
242 * number of bytes read on success, -1 if the file does not exist. If `trim` is
243 * set, trailing whitespace will be removed.
245 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
246 const char *file
, int trim
)
250 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
260 die_errno(_("could not read '%s'"), am_path(state
, file
));
264 * Take a series of KEY='VALUE' lines where VALUE part is
265 * sq-quoted, and append <KEY, VALUE> at the end of the string list
267 static int parse_key_value_squoted(char *buf
, struct string_list
*list
)
270 struct string_list_item
*item
;
272 char *cp
= strchr(buf
, '=');
275 np
= strchrnul(cp
, '\n');
277 item
= string_list_append(list
, buf
);
279 buf
= np
+ (*np
== '\n');
284 item
->util
= xstrdup(cp
);
290 * Reads and parses the state directory's "author-script" file, and sets
291 * state->author_name, state->author_email and state->author_date accordingly.
292 * Returns 0 on success, -1 if the file could not be parsed.
294 * The author script is of the format:
296 * GIT_AUTHOR_NAME='$author_name'
297 * GIT_AUTHOR_EMAIL='$author_email'
298 * GIT_AUTHOR_DATE='$author_date'
300 * where $author_name, $author_email and $author_date are quoted. We are strict
301 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
302 * script, and thus if the file differs from what this function expects, it is
303 * better to bail out than to do something that the user does not expect.
305 static int read_author_script(struct am_state
*state
)
307 const char *filename
= am_path(state
, "author-script");
308 struct strbuf buf
= STRBUF_INIT
;
309 struct string_list kv
= STRING_LIST_INIT_DUP
;
310 int retval
= -1; /* assume failure */
313 assert(!state
->author_name
);
314 assert(!state
->author_email
);
315 assert(!state
->author_date
);
317 fd
= open(filename
, O_RDONLY
);
321 return error_errno(_("could not open '%s' for reading"),
324 strbuf_read(&buf
, fd
, 0);
326 if (parse_key_value_squoted(buf
.buf
, &kv
))
330 strcmp(kv
.items
[0].string
, "GIT_AUTHOR_NAME") ||
331 strcmp(kv
.items
[1].string
, "GIT_AUTHOR_EMAIL") ||
332 strcmp(kv
.items
[2].string
, "GIT_AUTHOR_DATE"))
334 state
->author_name
= kv
.items
[0].util
;
335 state
->author_email
= kv
.items
[1].util
;
336 state
->author_date
= kv
.items
[2].util
;
339 string_list_clear(&kv
, !!retval
);
340 strbuf_release(&buf
);
345 * Saves state->author_name, state->author_email and state->author_date in the
346 * state directory's "author-script" file.
348 static void write_author_script(const struct am_state
*state
)
350 struct strbuf sb
= STRBUF_INIT
;
352 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
353 sq_quote_buf(&sb
, state
->author_name
);
354 strbuf_addch(&sb
, '\n');
356 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
357 sq_quote_buf(&sb
, state
->author_email
);
358 strbuf_addch(&sb
, '\n');
360 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
361 sq_quote_buf(&sb
, state
->author_date
);
362 strbuf_addch(&sb
, '\n');
364 write_state_text(state
, "author-script", sb
.buf
);
370 * Reads the commit message from the state directory's "final-commit" file,
371 * setting state->msg to its contents and state->msg_len to the length of its
374 * Returns 0 on success, -1 if the file does not exist.
376 static int read_commit_msg(struct am_state
*state
)
378 struct strbuf sb
= STRBUF_INIT
;
382 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
387 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
392 * Saves state->msg in the state directory's "final-commit" file.
394 static void write_commit_msg(const struct am_state
*state
)
396 const char *filename
= am_path(state
, "final-commit");
397 write_file_buf(filename
, state
->msg
, state
->msg_len
);
401 * Loads state from disk.
403 static void am_load(struct am_state
*state
)
405 struct strbuf sb
= STRBUF_INIT
;
407 if (read_state_file(&sb
, state
, "next", 1) < 0)
408 BUG("state file 'next' does not exist");
409 state
->cur
= strtol(sb
.buf
, NULL
, 10);
411 if (read_state_file(&sb
, state
, "last", 1) < 0)
412 BUG("state file 'last' does not exist");
413 state
->last
= strtol(sb
.buf
, NULL
, 10);
415 if (read_author_script(state
) < 0)
416 die(_("could not parse author script"));
418 read_commit_msg(state
);
420 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
421 oidclr(&state
->orig_commit
);
422 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
423 die(_("could not parse %s"), am_path(state
, "original-commit"));
425 read_state_file(&sb
, state
, "threeway", 1);
426 state
->threeway
= !strcmp(sb
.buf
, "t");
428 read_state_file(&sb
, state
, "quiet", 1);
429 state
->quiet
= !strcmp(sb
.buf
, "t");
431 read_state_file(&sb
, state
, "sign", 1);
432 state
->signoff
= !strcmp(sb
.buf
, "t");
434 read_state_file(&sb
, state
, "utf8", 1);
435 state
->utf8
= !strcmp(sb
.buf
, "t");
437 if (file_exists(am_path(state
, "rerere-autoupdate"))) {
438 read_state_file(&sb
, state
, "rerere-autoupdate", 1);
439 state
->allow_rerere_autoupdate
= strcmp(sb
.buf
, "t") ?
440 RERERE_NOAUTOUPDATE
: RERERE_AUTOUPDATE
;
442 state
->allow_rerere_autoupdate
= 0;
445 read_state_file(&sb
, state
, "keep", 1);
446 if (!strcmp(sb
.buf
, "t"))
447 state
->keep
= KEEP_TRUE
;
448 else if (!strcmp(sb
.buf
, "b"))
449 state
->keep
= KEEP_NON_PATCH
;
451 state
->keep
= KEEP_FALSE
;
453 read_state_file(&sb
, state
, "messageid", 1);
454 state
->message_id
= !strcmp(sb
.buf
, "t");
456 read_state_file(&sb
, state
, "scissors", 1);
457 if (!strcmp(sb
.buf
, "t"))
458 state
->scissors
= SCISSORS_TRUE
;
459 else if (!strcmp(sb
.buf
, "f"))
460 state
->scissors
= SCISSORS_FALSE
;
462 state
->scissors
= SCISSORS_UNSET
;
464 read_state_file(&sb
, state
, "apply-opt", 1);
465 argv_array_clear(&state
->git_apply_opts
);
466 if (sq_dequote_to_argv_array(sb
.buf
, &state
->git_apply_opts
) < 0)
467 die(_("could not parse %s"), am_path(state
, "apply-opt"));
469 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
475 * Removes the am_state directory, forcefully terminating the current am
478 static void am_destroy(const struct am_state
*state
)
480 struct strbuf sb
= STRBUF_INIT
;
482 strbuf_addstr(&sb
, state
->dir
);
483 remove_dir_recursively(&sb
, 0);
488 * Runs applypatch-msg hook. Returns its exit code.
490 static int run_applypatch_msg_hook(struct am_state
*state
)
495 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
498 FREE_AND_NULL(state
->msg
);
499 if (read_commit_msg(state
) < 0)
500 die(_("'%s' was deleted by the applypatch-msg hook"),
501 am_path(state
, "final-commit"));
508 * Runs post-rewrite hook. Returns it exit code.
510 static int run_post_rewrite_hook(const struct am_state
*state
)
512 struct child_process cp
= CHILD_PROCESS_INIT
;
513 const char *hook
= find_hook("post-rewrite");
519 argv_array_push(&cp
.args
, hook
);
520 argv_array_push(&cp
.args
, "rebase");
522 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
523 cp
.stdout_to_stderr
= 1;
525 ret
= run_command(&cp
);
532 * Reads the state directory's "rewritten" file, and copies notes from the old
533 * commits listed in the file to their rewritten commits.
535 * Returns 0 on success, -1 on failure.
537 static int copy_notes_for_rebase(const struct am_state
*state
)
539 struct notes_rewrite_cfg
*c
;
540 struct strbuf sb
= STRBUF_INIT
;
541 const char *invalid_line
= _("Malformed input line: '%s'.");
542 const char *msg
= "Notes added by 'git rebase'";
546 assert(state
->rebasing
);
548 c
= init_copy_notes_for_rewrite("rebase");
552 fp
= xfopen(am_path(state
, "rewritten"), "r");
554 while (!strbuf_getline_lf(&sb
, fp
)) {
555 struct object_id from_obj
, to_obj
;
557 if (sb
.len
!= GIT_SHA1_HEXSZ
* 2 + 1) {
558 ret
= error(invalid_line
, sb
.buf
);
562 if (get_oid_hex(sb
.buf
, &from_obj
)) {
563 ret
= error(invalid_line
, sb
.buf
);
567 if (sb
.buf
[GIT_SHA1_HEXSZ
] != ' ') {
568 ret
= error(invalid_line
, sb
.buf
);
572 if (get_oid_hex(sb
.buf
+ GIT_SHA1_HEXSZ
+ 1, &to_obj
)) {
573 ret
= error(invalid_line
, sb
.buf
);
577 if (copy_note_for_rewrite(c
, &from_obj
, &to_obj
))
578 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
579 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
583 finish_copy_notes_for_rewrite(c
, msg
);
590 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
591 * non-indented lines and checking if they look like they begin with valid
592 * header field names.
594 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
596 static int is_mail(FILE *fp
)
598 const char *header_regex
= "^[!-9;-~]+:";
599 struct strbuf sb
= STRBUF_INIT
;
603 if (fseek(fp
, 0L, SEEK_SET
))
604 die_errno(_("fseek failed"));
606 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
607 die("invalid pattern: %s", header_regex
);
609 while (!strbuf_getline(&sb
, fp
)) {
611 break; /* End of header */
613 /* Ignore indented folded lines */
614 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
617 /* It's a header if it matches header_regex */
618 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
631 * Attempts to detect the patch_format of the patches contained in `paths`,
632 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
635 static int detect_patch_format(const char **paths
)
637 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
638 struct strbuf l1
= STRBUF_INIT
;
639 struct strbuf l2
= STRBUF_INIT
;
640 struct strbuf l3
= STRBUF_INIT
;
644 * We default to mbox format if input is from stdin and for directories
646 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
647 return PATCH_FORMAT_MBOX
;
650 * Otherwise, check the first few lines of the first patch, starting
651 * from the first non-blank line, to try to detect its format.
654 fp
= xfopen(*paths
, "r");
656 while (!strbuf_getline(&l1
, fp
)) {
661 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
662 ret
= PATCH_FORMAT_MBOX
;
666 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
667 ret
= PATCH_FORMAT_STGIT_SERIES
;
671 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
672 ret
= PATCH_FORMAT_HG
;
676 strbuf_getline(&l2
, fp
);
677 strbuf_getline(&l3
, fp
);
680 * If the second line is empty and the third is a From, Author or Date
681 * entry, this is likely an StGit patch.
683 if (l1
.len
&& !l2
.len
&&
684 (starts_with(l3
.buf
, "From:") ||
685 starts_with(l3
.buf
, "Author:") ||
686 starts_with(l3
.buf
, "Date:"))) {
687 ret
= PATCH_FORMAT_STGIT
;
691 if (l1
.len
&& is_mail(fp
)) {
692 ret
= PATCH_FORMAT_MBOX
;
705 * Splits out individual email patches from `paths`, where each path is either
706 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
708 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
709 int keep_cr
, int mboxrd
)
711 struct child_process cp
= CHILD_PROCESS_INIT
;
712 struct strbuf last
= STRBUF_INIT
;
716 argv_array_push(&cp
.args
, "mailsplit");
717 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
718 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
719 argv_array_push(&cp
.args
, "-b");
721 argv_array_push(&cp
.args
, "--keep-cr");
723 argv_array_push(&cp
.args
, "--mboxrd");
724 argv_array_push(&cp
.args
, "--");
725 argv_array_pushv(&cp
.args
, paths
);
727 ret
= capture_command(&cp
, &last
, 8);
732 state
->last
= strtol(last
.buf
, NULL
, 10);
735 strbuf_release(&last
);
740 * Callback signature for split_mail_conv(). The foreign patch should be
741 * read from `in`, and the converted patch (in RFC2822 mail format) should be
742 * written to `out`. Return 0 on success, or -1 on failure.
744 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
747 * Calls `fn` for each file in `paths` to convert the foreign patch to the
748 * RFC2822 mail format suitable for parsing with git-mailinfo.
750 * Returns 0 on success, -1 on failure.
752 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
753 const char **paths
, int keep_cr
)
755 static const char *stdin_only
[] = {"-", NULL
};
761 for (i
= 0; *paths
; paths
++, i
++) {
766 if (!strcmp(*paths
, "-"))
769 in
= fopen(*paths
, "r");
772 return error_errno(_("could not open '%s' for reading"),
775 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
777 out
= fopen(mail
, "w");
781 return error_errno(_("could not open '%s' for writing"),
785 ret
= fn(out
, in
, keep_cr
);
792 return error(_("could not parse patch '%s'"), *paths
);
801 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
802 * message suitable for parsing with git-mailinfo.
804 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
806 struct strbuf sb
= STRBUF_INIT
;
807 int subject_printed
= 0;
809 while (!strbuf_getline_lf(&sb
, in
)) {
812 if (str_isspace(sb
.buf
))
814 else if (skip_prefix(sb
.buf
, "Author:", &str
))
815 fprintf(out
, "From:%s\n", str
);
816 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
817 fprintf(out
, "%s\n", sb
.buf
);
818 else if (!subject_printed
) {
819 fprintf(out
, "Subject: %s\n", sb
.buf
);
822 fprintf(out
, "\n%s\n", sb
.buf
);
828 while (strbuf_fread(&sb
, 8192, in
) > 0) {
829 fwrite(sb
.buf
, 1, sb
.len
, out
);
838 * This function only supports a single StGit series file in `paths`.
840 * Given an StGit series file, converts the StGit patches in the series into
841 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
842 * the state directory.
844 * Returns 0 on success, -1 on failure.
846 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
849 const char *series_dir
;
850 char *series_dir_buf
;
852 struct argv_array patches
= ARGV_ARRAY_INIT
;
853 struct strbuf sb
= STRBUF_INIT
;
856 if (!paths
[0] || paths
[1])
857 return error(_("Only one StGIT patch series can be applied at once"));
859 series_dir_buf
= xstrdup(*paths
);
860 series_dir
= dirname(series_dir_buf
);
862 fp
= fopen(*paths
, "r");
864 return error_errno(_("could not open '%s' for reading"), *paths
);
866 while (!strbuf_getline_lf(&sb
, fp
)) {
868 continue; /* skip comment lines */
870 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
875 free(series_dir_buf
);
877 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
879 argv_array_clear(&patches
);
884 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
885 * message suitable for parsing with git-mailinfo.
887 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
889 struct strbuf sb
= STRBUF_INIT
;
892 while (!strbuf_getline_lf(&sb
, in
)) {
895 if (skip_prefix(sb
.buf
, "# User ", &str
))
896 fprintf(out
, "From: %s\n", str
);
897 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
898 timestamp_t timestamp
;
903 timestamp
= parse_timestamp(str
, &end
, 10);
905 rc
= error(_("invalid timestamp"));
909 if (!skip_prefix(end
, " ", &str
)) {
910 rc
= error(_("invalid Date line"));
915 tz
= strtol(str
, &end
, 10);
917 rc
= error(_("invalid timezone offset"));
922 rc
= error(_("invalid Date line"));
927 * mercurial's timezone is in seconds west of UTC,
928 * however git's timezone is in hours + minutes east of
931 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
935 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
936 } else if (starts_with(sb
.buf
, "# ")) {
939 fprintf(out
, "\n%s\n", sb
.buf
);
945 while (strbuf_fread(&sb
, 8192, in
) > 0) {
946 fwrite(sb
.buf
, 1, sb
.len
, out
);
955 * Splits a list of files/directories into individual email patches. Each path
956 * in `paths` must be a file/directory that is formatted according to
959 * Once split out, the individual email patches will be stored in the state
960 * directory, with each patch's filename being its index, padded to state->prec
963 * state->cur will be set to the index of the first mail, and state->last will
964 * be set to the index of the last mail.
966 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
967 * to disable this behavior, -1 to use the default configured setting.
969 * Returns 0 on success, -1 on failure.
971 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
972 const char **paths
, int keep_cr
)
976 git_config_get_bool("am.keepcr", &keep_cr
);
979 switch (patch_format
) {
980 case PATCH_FORMAT_MBOX
:
981 return split_mail_mbox(state
, paths
, keep_cr
, 0);
982 case PATCH_FORMAT_STGIT
:
983 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
984 case PATCH_FORMAT_STGIT_SERIES
:
985 return split_mail_stgit_series(state
, paths
, keep_cr
);
986 case PATCH_FORMAT_HG
:
987 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
988 case PATCH_FORMAT_MBOXRD
:
989 return split_mail_mbox(state
, paths
, keep_cr
, 1);
991 BUG("invalid patch_format");
997 * Setup a new am session for applying patches
999 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
1000 const char **paths
, int keep_cr
)
1002 struct object_id curr_head
;
1004 struct strbuf sb
= STRBUF_INIT
;
1007 patch_format
= detect_patch_format(paths
);
1009 if (!patch_format
) {
1010 fprintf_ln(stderr
, _("Patch format detection failed."));
1014 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
1015 die_errno(_("failed to create directory '%s'"), state
->dir
);
1016 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
1018 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
1020 die(_("Failed to split patches."));
1023 if (state
->rebasing
)
1024 state
->threeway
= 1;
1026 write_state_bool(state
, "threeway", state
->threeway
);
1027 write_state_bool(state
, "quiet", state
->quiet
);
1028 write_state_bool(state
, "sign", state
->signoff
);
1029 write_state_bool(state
, "utf8", state
->utf8
);
1031 if (state
->allow_rerere_autoupdate
)
1032 write_state_bool(state
, "rerere-autoupdate",
1033 state
->allow_rerere_autoupdate
== RERERE_AUTOUPDATE
);
1035 switch (state
->keep
) {
1042 case KEEP_NON_PATCH
:
1046 BUG("invalid value for state->keep");
1049 write_state_text(state
, "keep", str
);
1050 write_state_bool(state
, "messageid", state
->message_id
);
1052 switch (state
->scissors
) {
1053 case SCISSORS_UNSET
:
1056 case SCISSORS_FALSE
:
1063 BUG("invalid value for state->scissors");
1065 write_state_text(state
, "scissors", str
);
1067 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
);
1068 write_state_text(state
, "apply-opt", sb
.buf
);
1070 if (state
->rebasing
)
1071 write_state_text(state
, "rebasing", "");
1073 write_state_text(state
, "applying", "");
1075 if (!get_oid("HEAD", &curr_head
)) {
1076 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1077 if (!state
->rebasing
)
1078 update_ref("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1079 UPDATE_REFS_DIE_ON_ERR
);
1081 write_state_text(state
, "abort-safety", "");
1082 if (!state
->rebasing
)
1083 delete_ref(NULL
, "ORIG_HEAD", NULL
, 0);
1087 * NOTE: Since the "next" and "last" files determine if an am_state
1088 * session is in progress, they should be written last.
1091 write_state_count(state
, "next", state
->cur
);
1092 write_state_count(state
, "last", state
->last
);
1094 strbuf_release(&sb
);
1098 * Increments the patch pointer, and cleans am_state for the application of the
1101 static void am_next(struct am_state
*state
)
1103 struct object_id head
;
1105 FREE_AND_NULL(state
->author_name
);
1106 FREE_AND_NULL(state
->author_email
);
1107 FREE_AND_NULL(state
->author_date
);
1108 FREE_AND_NULL(state
->msg
);
1111 unlink(am_path(state
, "author-script"));
1112 unlink(am_path(state
, "final-commit"));
1114 oidclr(&state
->orig_commit
);
1115 unlink(am_path(state
, "original-commit"));
1116 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
1118 if (!get_oid("HEAD", &head
))
1119 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1121 write_state_text(state
, "abort-safety", "");
1124 write_state_count(state
, "next", state
->cur
);
1128 * Returns the filename of the current patch email.
1130 static const char *msgnum(const struct am_state
*state
)
1132 static struct strbuf sb
= STRBUF_INIT
;
1135 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1141 * Refresh and write index.
1143 static void refresh_and_write_cache(void)
1145 struct lock_file lock_file
= LOCK_INIT
;
1147 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1148 refresh_cache(REFRESH_QUIET
);
1149 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1150 die(_("unable to write index file"));
1154 * Dies with a user-friendly message on how to proceed after resolving the
1155 * problem. This message can be overridden with state->resolvemsg.
1157 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1159 if (state
->resolvemsg
) {
1160 printf_ln("%s", state
->resolvemsg
);
1162 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1164 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1165 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1166 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1173 * Appends signoff to the "msg" field of the am_state.
1175 static void am_append_signoff(struct am_state
*state
)
1177 struct strbuf sb
= STRBUF_INIT
;
1179 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1180 append_signoff(&sb
, 0, 0);
1181 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1185 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1186 * state->msg will be set to the patch message. state->author_name,
1187 * state->author_email and state->author_date will be set to the patch author's
1188 * name, email and date respectively. The patch body will be written to the
1189 * state directory's "patch" file.
1191 * Returns 1 if the patch should be skipped, 0 otherwise.
1193 static int parse_mail(struct am_state
*state
, const char *mail
)
1196 struct strbuf sb
= STRBUF_INIT
;
1197 struct strbuf msg
= STRBUF_INIT
;
1198 struct strbuf author_name
= STRBUF_INIT
;
1199 struct strbuf author_date
= STRBUF_INIT
;
1200 struct strbuf author_email
= STRBUF_INIT
;
1204 setup_mailinfo(&mi
);
1207 mi
.metainfo_charset
= get_commit_output_encoding();
1209 mi
.metainfo_charset
= NULL
;
1211 switch (state
->keep
) {
1215 mi
.keep_subject
= 1;
1217 case KEEP_NON_PATCH
:
1218 mi
.keep_non_patch_brackets_in_subject
= 1;
1221 BUG("invalid value for state->keep");
1224 if (state
->message_id
)
1225 mi
.add_message_id
= 1;
1227 switch (state
->scissors
) {
1228 case SCISSORS_UNSET
:
1230 case SCISSORS_FALSE
:
1231 mi
.use_scissors
= 0;
1234 mi
.use_scissors
= 1;
1237 BUG("invalid value for state->scissors");
1240 mi
.input
= xfopen(mail
, "r");
1241 mi
.output
= xfopen(am_path(state
, "info"), "w");
1242 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1243 die("could not parse patch");
1248 if (mi
.format_flowed
)
1249 warning(_("Patch sent with format=flowed; "
1250 "space at the end of lines might be lost."));
1252 /* Extract message and author information */
1253 fp
= xfopen(am_path(state
, "info"), "r");
1254 while (!strbuf_getline_lf(&sb
, fp
)) {
1257 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1259 strbuf_addch(&msg
, '\n');
1260 strbuf_addstr(&msg
, x
);
1261 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1262 strbuf_addstr(&author_name
, x
);
1263 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1264 strbuf_addstr(&author_email
, x
);
1265 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1266 strbuf_addstr(&author_date
, x
);
1270 /* Skip pine's internal folder data */
1271 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1276 if (is_empty_file(am_path(state
, "patch"))) {
1277 printf_ln(_("Patch is empty."));
1278 die_user_resolve(state
);
1281 strbuf_addstr(&msg
, "\n\n");
1282 strbuf_addbuf(&msg
, &mi
.log_message
);
1283 strbuf_stripspace(&msg
, 0);
1285 assert(!state
->author_name
);
1286 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1288 assert(!state
->author_email
);
1289 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1291 assert(!state
->author_date
);
1292 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1294 assert(!state
->msg
);
1295 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1298 strbuf_release(&msg
);
1299 strbuf_release(&author_date
);
1300 strbuf_release(&author_email
);
1301 strbuf_release(&author_name
);
1302 strbuf_release(&sb
);
1303 clear_mailinfo(&mi
);
1308 * Sets commit_id to the commit hash where the mail was generated from.
1309 * Returns 0 on success, -1 on failure.
1311 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1313 struct strbuf sb
= STRBUF_INIT
;
1314 FILE *fp
= xfopen(mail
, "r");
1318 if (strbuf_getline_lf(&sb
, fp
) ||
1319 !skip_prefix(sb
.buf
, "From ", &x
) ||
1320 get_oid_hex(x
, commit_id
) < 0)
1323 strbuf_release(&sb
);
1329 * Sets state->msg, state->author_name, state->author_email, state->author_date
1330 * to the commit's respective info.
1332 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1334 const char *buffer
, *ident_line
, *msg
;
1336 struct ident_split id
;
1338 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1340 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1342 if (split_ident_line(&id
, ident_line
, ident_len
) < 0)
1343 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1345 assert(!state
->author_name
);
1347 state
->author_name
=
1348 xmemdupz(id
.name_begin
, id
.name_end
- id
.name_begin
);
1350 state
->author_name
= xstrdup("");
1352 assert(!state
->author_email
);
1354 state
->author_email
=
1355 xmemdupz(id
.mail_begin
, id
.mail_end
- id
.mail_begin
);
1357 state
->author_email
= xstrdup("");
1359 assert(!state
->author_date
);
1360 state
->author_date
= xstrdup(show_ident_date(&id
, DATE_MODE(NORMAL
)));
1362 assert(!state
->msg
);
1363 msg
= strstr(buffer
, "\n\n");
1365 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1366 state
->msg
= xstrdup(msg
+ 2);
1367 state
->msg_len
= strlen(state
->msg
);
1368 unuse_commit_buffer(commit
, buffer
);
1372 * Writes `commit` as a patch to the state directory's "patch" file.
1374 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1376 struct rev_info rev_info
;
1379 fp
= xfopen(am_path(state
, "patch"), "w");
1380 init_revisions(&rev_info
, NULL
);
1382 rev_info
.abbrev
= 0;
1383 rev_info
.disable_stdin
= 1;
1384 rev_info
.show_root_diff
= 1;
1385 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1386 rev_info
.no_commit_id
= 1;
1387 rev_info
.diffopt
.flags
.binary
= 1;
1388 rev_info
.diffopt
.flags
.full_index
= 1;
1389 rev_info
.diffopt
.use_color
= 0;
1390 rev_info
.diffopt
.file
= fp
;
1391 rev_info
.diffopt
.close_file
= 1;
1392 add_pending_object(&rev_info
, &commit
->object
, "");
1393 diff_setup_done(&rev_info
.diffopt
);
1394 log_tree_commit(&rev_info
, commit
);
1398 * Writes the diff of the index against HEAD as a patch to the state
1399 * directory's "patch" file.
1401 static void write_index_patch(const struct am_state
*state
)
1404 struct object_id head
;
1405 struct rev_info rev_info
;
1408 if (!get_oid_tree("HEAD", &head
))
1409 tree
= lookup_tree(the_repository
, &head
);
1411 tree
= lookup_tree(the_repository
,
1412 the_repository
->hash_algo
->empty_tree
);
1414 fp
= xfopen(am_path(state
, "patch"), "w");
1415 init_revisions(&rev_info
, NULL
);
1417 rev_info
.disable_stdin
= 1;
1418 rev_info
.no_commit_id
= 1;
1419 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1420 rev_info
.diffopt
.use_color
= 0;
1421 rev_info
.diffopt
.file
= fp
;
1422 rev_info
.diffopt
.close_file
= 1;
1423 add_pending_object(&rev_info
, &tree
->object
, "");
1424 diff_setup_done(&rev_info
.diffopt
);
1425 run_diff_index(&rev_info
, 1);
1429 * Like parse_mail(), but parses the mail by looking up its commit ID
1430 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1433 * state->orig_commit will be set to the original commit ID.
1435 * Will always return 0 as the patch should never be skipped.
1437 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1439 struct commit
*commit
;
1440 struct object_id commit_oid
;
1442 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1443 die(_("could not parse %s"), mail
);
1445 commit
= lookup_commit_or_die(&commit_oid
, mail
);
1447 get_commit_info(state
, commit
);
1449 write_commit_patch(state
, commit
);
1451 oidcpy(&state
->orig_commit
, &commit_oid
);
1452 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1453 update_ref("am", "REBASE_HEAD", &commit_oid
,
1454 NULL
, REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
1460 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1461 * `index_file` is not NULL, the patch will be applied to that index.
1463 static int run_apply(const struct am_state
*state
, const char *index_file
)
1465 struct argv_array apply_paths
= ARGV_ARRAY_INIT
;
1466 struct argv_array apply_opts
= ARGV_ARRAY_INIT
;
1467 struct apply_state apply_state
;
1469 int force_apply
= 0;
1472 if (init_apply_state(&apply_state
, the_repository
, NULL
))
1473 BUG("init_apply_state() failed");
1475 argv_array_push(&apply_opts
, "apply");
1476 argv_array_pushv(&apply_opts
, state
->git_apply_opts
.argv
);
1478 opts_left
= apply_parse_options(apply_opts
.argc
, apply_opts
.argv
,
1479 &apply_state
, &force_apply
, &options
,
1483 die("unknown option passed through to git apply");
1486 apply_state
.index_file
= index_file
;
1487 apply_state
.cached
= 1;
1489 apply_state
.check_index
= 1;
1492 * If we are allowed to fall back on 3-way merge, don't give false
1493 * errors during the initial attempt.
1495 if (state
->threeway
&& !index_file
)
1496 apply_state
.apply_verbosity
= verbosity_silent
;
1498 if (check_apply_state(&apply_state
, force_apply
))
1499 BUG("check_apply_state() failed");
1501 argv_array_push(&apply_paths
, am_path(state
, "patch"));
1503 res
= apply_all_patches(&apply_state
, apply_paths
.argc
, apply_paths
.argv
, options
);
1505 argv_array_clear(&apply_paths
);
1506 argv_array_clear(&apply_opts
);
1507 clear_apply_state(&apply_state
);
1513 /* Reload index as apply_all_patches() will have modified it. */
1515 read_cache_from(index_file
);
1522 * Builds an index that contains just the blobs needed for a 3way merge.
1524 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1526 struct child_process cp
= CHILD_PROCESS_INIT
;
1529 argv_array_push(&cp
.args
, "apply");
1530 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1531 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1532 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1534 if (run_command(&cp
))
1541 * Attempt a threeway merge, using index_path as the temporary index.
1543 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1545 struct object_id orig_tree
, their_tree
, our_tree
;
1546 const struct object_id
*bases
[1] = { &orig_tree
};
1547 struct merge_options o
;
1548 struct commit
*result
;
1549 char *their_tree_name
;
1551 if (get_oid("HEAD", &our_tree
) < 0)
1552 oidcpy(&our_tree
, the_hash_algo
->empty_tree
);
1554 if (build_fake_ancestor(state
, index_path
))
1555 return error("could not build fake ancestor");
1558 read_cache_from(index_path
);
1560 if (write_index_as_tree(&orig_tree
, &the_index
, index_path
, 0, NULL
))
1561 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1563 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1565 if (!state
->quiet
) {
1567 * List paths that needed 3-way fallback, so that the user can
1568 * review them with extra care to spot mismerges.
1570 struct rev_info rev_info
;
1571 const char *diff_filter_str
= "--diff-filter=AM";
1573 init_revisions(&rev_info
, NULL
);
1574 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1575 diff_opt_parse(&rev_info
.diffopt
, &diff_filter_str
, 1, rev_info
.prefix
);
1576 add_pending_oid(&rev_info
, "HEAD", &our_tree
, 0);
1577 diff_setup_done(&rev_info
.diffopt
);
1578 run_diff_index(&rev_info
, 1);
1581 if (run_apply(state
, index_path
))
1582 return error(_("Did you hand edit your patch?\n"
1583 "It does not apply to blobs recorded in its index."));
1585 if (write_index_as_tree(&their_tree
, &the_index
, index_path
, 0, NULL
))
1586 return error("could not write tree");
1588 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1594 * This is not so wrong. Depending on which base we picked, orig_tree
1595 * may be wildly different from ours, but their_tree has the same set of
1596 * wildly different changes in parts the patch did not touch, so
1597 * recursive ends up canceling them, saying that we reverted all those
1601 init_merge_options(&o
);
1604 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1605 o
.branch2
= their_tree_name
;
1606 o
.detect_directory_renames
= 0;
1611 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1612 rerere(state
->allow_rerere_autoupdate
);
1613 free(their_tree_name
);
1614 return error(_("Failed to merge in the changes."));
1617 free(their_tree_name
);
1622 * Commits the current index with state->msg as the commit message and
1623 * state->author_name, state->author_email and state->author_date as the author
1626 static void do_commit(const struct am_state
*state
)
1628 struct object_id tree
, parent
, commit
;
1629 const struct object_id
*old_oid
;
1630 struct commit_list
*parents
= NULL
;
1631 const char *reflog_msg
, *author
;
1632 struct strbuf sb
= STRBUF_INIT
;
1634 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1637 if (write_cache_as_tree(&tree
, 0, NULL
))
1638 die(_("git write-tree failed to write a tree"));
1640 if (!get_oid_commit("HEAD", &parent
)) {
1642 commit_list_insert(lookup_commit(the_repository
, &parent
),
1646 say(state
, stderr
, _("applying to an empty history"));
1649 author
= fmt_ident(state
->author_name
, state
->author_email
,
1650 state
->ignore_date
? NULL
: state
->author_date
,
1653 if (state
->committer_date_is_author_date
)
1654 setenv("GIT_COMMITTER_DATE",
1655 state
->ignore_date
? "" : state
->author_date
, 1);
1657 if (commit_tree(state
->msg
, state
->msg_len
, &tree
, parents
, &commit
,
1658 author
, state
->sign_commit
))
1659 die(_("failed to write commit object"));
1661 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1665 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1668 update_ref(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1669 UPDATE_REFS_DIE_ON_ERR
);
1671 if (state
->rebasing
) {
1672 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1674 assert(!is_null_oid(&state
->orig_commit
));
1675 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1676 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1680 run_hook_le(NULL
, "post-applypatch", NULL
);
1682 strbuf_release(&sb
);
1686 * Validates the am_state for resuming -- the "msg" and authorship fields must
1689 static void validate_resume_state(const struct am_state
*state
)
1692 die(_("cannot resume: %s does not exist."),
1693 am_path(state
, "final-commit"));
1695 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1696 die(_("cannot resume: %s does not exist."),
1697 am_path(state
, "author-script"));
1701 * Interactively prompt the user on whether the current patch should be
1704 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1707 static int do_interactive(struct am_state
*state
)
1712 die(_("cannot be interactive without stdin connected to a terminal."));
1717 puts(_("Commit Body is:"));
1718 puts("--------------------------");
1719 printf("%s", state
->msg
);
1720 puts("--------------------------");
1723 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1724 * in your translation. The program will only accept English
1725 * input at this point.
1727 reply
= git_prompt(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "), PROMPT_ECHO
);
1731 } else if (*reply
== 'y' || *reply
== 'Y') {
1733 } else if (*reply
== 'a' || *reply
== 'A') {
1734 state
->interactive
= 0;
1736 } else if (*reply
== 'n' || *reply
== 'N') {
1738 } else if (*reply
== 'e' || *reply
== 'E') {
1739 struct strbuf msg
= STRBUF_INIT
;
1741 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1743 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1745 strbuf_release(&msg
);
1746 } else if (*reply
== 'v' || *reply
== 'V') {
1747 const char *pager
= git_pager(1);
1748 struct child_process cp
= CHILD_PROCESS_INIT
;
1752 prepare_pager_args(&cp
, pager
);
1753 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1760 * Applies all queued mail.
1762 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1763 * well as the state directory's "patch" file is used as-is for applying the
1764 * patch and committing it.
1766 static void am_run(struct am_state
*state
, int resume
)
1768 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1769 struct strbuf sb
= STRBUF_INIT
;
1771 unlink(am_path(state
, "dirtyindex"));
1773 refresh_and_write_cache();
1775 if (index_has_changes(&the_index
, NULL
, &sb
)) {
1776 write_state_bool(state
, "dirtyindex", 1);
1777 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1780 strbuf_release(&sb
);
1782 while (state
->cur
<= state
->last
) {
1783 const char *mail
= am_path(state
, msgnum(state
));
1788 if (!file_exists(mail
))
1792 validate_resume_state(state
);
1796 if (state
->rebasing
)
1797 skip
= parse_mail_rebase(state
, mail
);
1799 skip
= parse_mail(state
, mail
);
1802 goto next
; /* mail should be skipped */
1805 am_append_signoff(state
);
1807 write_author_script(state
);
1808 write_commit_msg(state
);
1811 if (state
->interactive
&& do_interactive(state
))
1814 if (run_applypatch_msg_hook(state
))
1817 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1819 apply_status
= run_apply(state
, NULL
);
1821 if (apply_status
&& state
->threeway
) {
1822 struct strbuf sb
= STRBUF_INIT
;
1824 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1825 apply_status
= fall_back_threeway(state
, sb
.buf
);
1826 strbuf_release(&sb
);
1829 * Applying the patch to an earlier tree and merging
1830 * the result may have produced the same tree as ours.
1832 if (!apply_status
&&
1833 !index_has_changes(&the_index
, NULL
, NULL
)) {
1834 say(state
, stdout
, _("No changes -- Patch already applied."));
1840 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1841 linelen(state
->msg
), state
->msg
);
1843 if (advice_amworkdir
)
1844 advise(_("Use 'git am --show-current-patch' to see the failed patch"));
1846 die_user_resolve(state
);
1859 if (!is_empty_file(am_path(state
, "rewritten"))) {
1860 assert(state
->rebasing
);
1861 copy_notes_for_rebase(state
);
1862 run_post_rewrite_hook(state
);
1866 * In rebasing mode, it's up to the caller to take care of
1869 if (!state
->rebasing
) {
1871 close_all_packs(the_repository
->objects
);
1872 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1877 * Resume the current am session after patch application failure. The user did
1878 * all the hard work, and we do not have to do any patch application. Just
1879 * trust and commit what the user has in the index and working tree.
1881 static void am_resolve(struct am_state
*state
)
1883 validate_resume_state(state
);
1885 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1887 if (!index_has_changes(&the_index
, NULL
, NULL
)) {
1888 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1889 "If there is nothing left to stage, chances are that something else\n"
1890 "already introduced the same changes; you might want to skip this patch."));
1891 die_user_resolve(state
);
1894 if (unmerged_cache()) {
1895 printf_ln(_("You still have unmerged paths in your index.\n"
1896 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1897 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1898 die_user_resolve(state
);
1901 if (state
->interactive
) {
1902 write_index_patch(state
);
1903 if (do_interactive(state
))
1918 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1919 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1922 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1924 struct lock_file lock_file
= LOCK_INIT
;
1925 struct unpack_trees_options opts
;
1926 struct tree_desc t
[2];
1928 if (parse_tree(head
) || parse_tree(remote
))
1931 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1933 refresh_cache(REFRESH_QUIET
);
1935 memset(&opts
, 0, sizeof(opts
));
1937 opts
.src_index
= &the_index
;
1938 opts
.dst_index
= &the_index
;
1942 opts
.fn
= twoway_merge
;
1943 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1944 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1946 if (unpack_trees(2, t
, &opts
)) {
1947 rollback_lock_file(&lock_file
);
1951 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1952 die(_("unable to write new index file"));
1958 * Merges a tree into the index. The index's stat info will take precedence
1959 * over the merged tree's. Returns 0 on success, -1 on failure.
1961 static int merge_tree(struct tree
*tree
)
1963 struct lock_file lock_file
= LOCK_INIT
;
1964 struct unpack_trees_options opts
;
1965 struct tree_desc t
[1];
1967 if (parse_tree(tree
))
1970 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1972 memset(&opts
, 0, sizeof(opts
));
1974 opts
.src_index
= &the_index
;
1975 opts
.dst_index
= &the_index
;
1977 opts
.fn
= oneway_merge
;
1978 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
1980 if (unpack_trees(1, t
, &opts
)) {
1981 rollback_lock_file(&lock_file
);
1985 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1986 die(_("unable to write new index file"));
1992 * Clean the index without touching entries that are not modified between
1993 * `head` and `remote`.
1995 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
1997 struct tree
*head_tree
, *remote_tree
, *index_tree
;
1998 struct object_id index
;
2000 head_tree
= parse_tree_indirect(head
);
2002 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
2004 remote_tree
= parse_tree_indirect(remote
);
2006 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
2008 read_cache_unmerged();
2010 if (fast_forward_to(head_tree
, head_tree
, 1))
2013 if (write_cache_as_tree(&index
, 0, NULL
))
2016 index_tree
= parse_tree_indirect(&index
);
2018 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
2020 if (fast_forward_to(index_tree
, remote_tree
, 0))
2023 if (merge_tree(remote_tree
))
2026 remove_branch_state();
2032 * Resets rerere's merge resolution metadata.
2034 static void am_rerere_clear(void)
2036 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
2037 rerere_clear(&merge_rr
);
2038 string_list_clear(&merge_rr
, 1);
2042 * Resume the current am session by skipping the current patch.
2044 static void am_skip(struct am_state
*state
)
2046 struct object_id head
;
2050 if (get_oid("HEAD", &head
))
2051 oidcpy(&head
, the_hash_algo
->empty_tree
);
2053 if (clean_index(&head
, &head
))
2054 die(_("failed to clean index"));
2062 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2064 * It is not safe to reset HEAD when:
2065 * 1. git-am previously failed because the index was dirty.
2066 * 2. HEAD has moved since git-am previously failed.
2068 static int safe_to_abort(const struct am_state
*state
)
2070 struct strbuf sb
= STRBUF_INIT
;
2071 struct object_id abort_safety
, head
;
2073 if (file_exists(am_path(state
, "dirtyindex")))
2076 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2077 if (get_oid_hex(sb
.buf
, &abort_safety
))
2078 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2080 oidclr(&abort_safety
);
2081 strbuf_release(&sb
);
2083 if (get_oid("HEAD", &head
))
2086 if (oideq(&head
, &abort_safety
))
2089 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2090 "Not rewinding to ORIG_HEAD"));
2096 * Aborts the current am session if it is safe to do so.
2098 static void am_abort(struct am_state
*state
)
2100 struct object_id curr_head
, orig_head
;
2101 int has_curr_head
, has_orig_head
;
2104 if (!safe_to_abort(state
)) {
2111 curr_branch
= resolve_refdup("HEAD", 0, &curr_head
, NULL
);
2112 has_curr_head
= curr_branch
&& !is_null_oid(&curr_head
);
2114 oidcpy(&curr_head
, the_hash_algo
->empty_tree
);
2116 has_orig_head
= !get_oid("ORIG_HEAD", &orig_head
);
2118 oidcpy(&orig_head
, the_hash_algo
->empty_tree
);
2120 clean_index(&curr_head
, &orig_head
);
2123 update_ref("am --abort", "HEAD", &orig_head
,
2124 has_curr_head
? &curr_head
: NULL
, 0,
2125 UPDATE_REFS_DIE_ON_ERR
);
2126 else if (curr_branch
)
2127 delete_ref(NULL
, curr_branch
, NULL
, REF_NO_DEREF
);
2133 static int show_patch(struct am_state
*state
)
2135 struct strbuf sb
= STRBUF_INIT
;
2136 const char *patch_path
;
2139 if (!is_null_oid(&state
->orig_commit
)) {
2140 const char *av
[4] = { "show", NULL
, "--", NULL
};
2144 av
[1] = new_oid_str
= xstrdup(oid_to_hex(&state
->orig_commit
));
2145 ret
= run_command_v_opt(av
, RUN_GIT_CMD
);
2150 patch_path
= am_path(state
, msgnum(state
));
2151 len
= strbuf_read_file(&sb
, patch_path
, 0);
2153 die_errno(_("failed to read '%s'"), patch_path
);
2156 write_in_full(1, sb
.buf
, sb
.len
);
2157 strbuf_release(&sb
);
2162 * parse_options() callback that validates and sets opt->value to the
2163 * PATCH_FORMAT_* enum value corresponding to `arg`.
2165 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2167 int *opt_value
= opt
->value
;
2169 if (!strcmp(arg
, "mbox"))
2170 *opt_value
= PATCH_FORMAT_MBOX
;
2171 else if (!strcmp(arg
, "stgit"))
2172 *opt_value
= PATCH_FORMAT_STGIT
;
2173 else if (!strcmp(arg
, "stgit-series"))
2174 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2175 else if (!strcmp(arg
, "hg"))
2176 *opt_value
= PATCH_FORMAT_HG
;
2177 else if (!strcmp(arg
, "mboxrd"))
2178 *opt_value
= PATCH_FORMAT_MBOXRD
;
2180 return error(_("Invalid value for --patch-format: %s"), arg
);
2194 static int git_am_config(const char *k
, const char *v
, void *cb
)
2198 status
= git_gpg_config(k
, v
, NULL
);
2202 return git_default_config(k
, v
, NULL
);
2205 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2207 struct am_state state
;
2210 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2211 enum resume_mode resume
= RESUME_FALSE
;
2215 const char * const usage
[] = {
2216 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2217 N_("git am [<options>] (--continue | --skip | --abort)"),
2221 struct option options
[] = {
2222 OPT_BOOL('i', "interactive", &state
.interactive
,
2223 N_("run interactively")),
2224 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2225 N_("historical option -- no-op")),
2226 OPT_BOOL('3', "3way", &state
.threeway
,
2227 N_("allow fall back on 3way merging if needed")),
2228 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2229 OPT_SET_INT('s', "signoff", &state
.signoff
,
2230 N_("add a Signed-off-by line to the commit message"),
2232 OPT_BOOL('u', "utf8", &state
.utf8
,
2233 N_("recode into utf8 (default)")),
2234 OPT_SET_INT('k', "keep", &state
.keep
,
2235 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2236 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2237 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2238 OPT_BOOL('m', "message-id", &state
.message_id
,
2239 N_("pass -m flag to git-mailinfo")),
2240 OPT_SET_INT_F(0, "keep-cr", &keep_cr
,
2241 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2242 1, PARSE_OPT_NONEG
),
2243 OPT_SET_INT_F(0, "no-keep-cr", &keep_cr
,
2244 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2245 0, PARSE_OPT_NONEG
),
2246 OPT_BOOL('c', "scissors", &state
.scissors
,
2247 N_("strip everything before a scissors line")),
2248 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2249 N_("pass it through git-apply"),
2251 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2252 N_("pass it through git-apply"),
2254 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2255 N_("pass it through git-apply"),
2257 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2258 N_("pass it through git-apply"),
2260 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2261 N_("pass it through git-apply"),
2263 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2264 N_("pass it through git-apply"),
2266 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2267 N_("pass it through git-apply"),
2269 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2270 N_("pass it through git-apply"),
2272 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2273 N_("format the patch(es) are in"),
2274 parse_opt_patchformat
),
2275 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2276 N_("pass it through git-apply"),
2278 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2279 N_("override error message when patch failure occurs")),
2280 OPT_CMDMODE(0, "continue", &resume
,
2281 N_("continue applying patches after resolving a conflict"),
2283 OPT_CMDMODE('r', "resolved", &resume
,
2284 N_("synonyms for --continue"),
2286 OPT_CMDMODE(0, "skip", &resume
,
2287 N_("skip the current patch"),
2289 OPT_CMDMODE(0, "abort", &resume
,
2290 N_("restore the original branch and abort the patching operation."),
2292 OPT_CMDMODE(0, "quit", &resume
,
2293 N_("abort the patching operation but keep HEAD where it is."),
2295 OPT_CMDMODE(0, "show-current-patch", &resume
,
2296 N_("show the patch being applied."),
2298 OPT_BOOL(0, "committer-date-is-author-date",
2299 &state
.committer_date_is_author_date
,
2300 N_("lie about committer date")),
2301 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2302 N_("use current timestamp for author date")),
2303 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2304 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2305 N_("GPG-sign commits"),
2306 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2307 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2308 N_("(internal use for git-rebase)")),
2312 if (argc
== 2 && !strcmp(argv
[1], "-h"))
2313 usage_with_options(usage
, options
);
2315 git_config(git_am_config
, NULL
);
2317 am_state_init(&state
);
2319 in_progress
= am_in_progress(&state
);
2323 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2326 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2327 "it will be removed. Please do not use it anymore."));
2329 /* Ensure a valid committer ident can be constructed */
2330 git_committer_info(IDENT_STRICT
);
2332 if (read_index_preload(&the_index
, NULL
) < 0)
2333 die(_("failed to read the index"));
2337 * Catch user error to feed us patches when there is a session
2340 * 1. mbox path(s) are provided on the command-line.
2341 * 2. stdin is not a tty: the user is trying to feed us a patch
2342 * from standard input. This is somewhat unreliable -- stdin
2343 * could be /dev/null for example and the caller did not
2344 * intend to feed us a patch but wanted to continue
2347 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
2348 die(_("previous rebase directory %s still exists but mbox given."),
2351 if (resume
== RESUME_FALSE
)
2352 resume
= RESUME_APPLY
;
2354 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2355 am_append_signoff(&state
);
2357 struct argv_array paths
= ARGV_ARRAY_INIT
;
2361 * Handle stray state directory in the independent-run case. In
2362 * the --rebasing case, it is up to the caller to take care of
2363 * stray directories.
2365 if (file_exists(state
.dir
) && !state
.rebasing
) {
2366 if (resume
== RESUME_ABORT
|| resume
== RESUME_QUIT
) {
2368 am_state_release(&state
);
2372 die(_("Stray %s directory found.\n"
2373 "Use \"git am --abort\" to remove it."),
2378 die(_("Resolve operation not in progress, we are not resuming."));
2380 for (i
= 0; i
< argc
; i
++) {
2381 if (is_absolute_path(argv
[i
]) || !prefix
)
2382 argv_array_push(&paths
, argv
[i
]);
2384 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2387 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2389 argv_array_clear(&paths
);
2399 case RESUME_RESOLVED
:
2412 case RESUME_SHOW_PATCH
:
2413 ret
= show_patch(&state
);
2416 BUG("invalid resume value");
2419 am_state_release(&state
);