4 * Based on git-am.sh by Junio C Hamano.
9 #include "parse-options.h"
11 #include "run-command.h"
15 #include "cache-tree.h"
20 #include "unpack-trees.h"
22 #include "sequencer.h"
24 #include "merge-recursive.h"
27 #include "notes-utils.h"
32 #include "string-list.h"
35 * Returns 1 if the file is empty or does not exist, 0 otherwise.
37 static int is_empty_file(const char *filename
)
41 if (stat(filename
, &st
) < 0) {
44 die_errno(_("could not stat %s"), filename
);
51 * Returns the length of the first line of msg.
53 static int linelen(const char *msg
)
55 return strchrnul(msg
, '\n') - msg
;
59 * Returns true if `str` consists of only whitespace, false otherwise.
61 static int str_isspace(const char *str
)
71 PATCH_FORMAT_UNKNOWN
= 0,
74 PATCH_FORMAT_STGIT_SERIES
,
81 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
82 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
87 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
88 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
94 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
98 /* state directory path */
101 /* current and last patch numbers, 1-indexed */
105 /* commit metadata and message */
112 /* when --rebasing, records the original commit the patch came from */
113 struct object_id orig_commit
;
115 /* number of digits in patch filename */
118 /* various operating modes and command line options */
122 int signoff
; /* enum signoff_type */
124 int keep
; /* enum keep_type */
126 int scissors
; /* enum scissors_type */
127 struct argv_array git_apply_opts
;
128 const char *resolvemsg
;
129 int committer_date_is_author_date
;
131 int allow_rerere_autoupdate
;
132 const char *sign_commit
;
137 * Initializes am_state with the default values.
139 static void am_state_init(struct am_state
*state
)
143 memset(state
, 0, sizeof(*state
));
145 state
->dir
= git_pathdup("rebase-apply");
149 git_config_get_bool("am.threeway", &state
->threeway
);
153 git_config_get_bool("am.messageid", &state
->message_id
);
155 state
->scissors
= SCISSORS_UNSET
;
157 argv_array_init(&state
->git_apply_opts
);
159 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
160 state
->sign_commit
= gpgsign
? "" : NULL
;
164 * Releases memory allocated by an am_state.
166 static void am_state_release(struct am_state
*state
)
169 free(state
->author_name
);
170 free(state
->author_email
);
171 free(state
->author_date
);
173 argv_array_clear(&state
->git_apply_opts
);
177 * Returns path relative to the am_state directory.
179 static inline const char *am_path(const struct am_state
*state
, const char *path
)
181 return mkpath("%s/%s", state
->dir
, path
);
185 * For convenience to call write_file()
187 static void write_state_text(const struct am_state
*state
,
188 const char *name
, const char *string
)
190 write_file(am_path(state
, name
), "%s", string
);
193 static void write_state_count(const struct am_state
*state
,
194 const char *name
, int value
)
196 write_file(am_path(state
, name
), "%d", value
);
199 static void write_state_bool(const struct am_state
*state
,
200 const char *name
, int value
)
202 write_state_text(state
, name
, value
? "t" : "f");
206 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
209 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
215 vfprintf(fp
, fmt
, ap
);
222 * Returns 1 if there is an am session in progress, 0 otherwise.
224 static int am_in_progress(const struct am_state
*state
)
228 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
230 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
232 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
238 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
239 * number of bytes read on success, -1 if the file does not exist. If `trim` is
240 * set, trailing whitespace will be removed.
242 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
243 const char *file
, int trim
)
247 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
257 die_errno(_("could not read '%s'"), am_path(state
, file
));
261 * Take a series of KEY='VALUE' lines where VALUE part is
262 * sq-quoted, and append <KEY, VALUE> at the end of the string list
264 static int parse_key_value_squoted(char *buf
, struct string_list
*list
)
267 struct string_list_item
*item
;
269 char *cp
= strchr(buf
, '=');
272 np
= strchrnul(cp
, '\n');
274 item
= string_list_append(list
, buf
);
276 buf
= np
+ (*np
== '\n');
281 item
->util
= xstrdup(cp
);
287 * Reads and parses the state directory's "author-script" file, and sets
288 * state->author_name, state->author_email and state->author_date accordingly.
289 * Returns 0 on success, -1 if the file could not be parsed.
291 * The author script is of the format:
293 * GIT_AUTHOR_NAME='$author_name'
294 * GIT_AUTHOR_EMAIL='$author_email'
295 * GIT_AUTHOR_DATE='$author_date'
297 * where $author_name, $author_email and $author_date are quoted. We are strict
298 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
299 * script, and thus if the file differs from what this function expects, it is
300 * better to bail out than to do something that the user does not expect.
302 static int read_author_script(struct am_state
*state
)
304 const char *filename
= am_path(state
, "author-script");
305 struct strbuf buf
= STRBUF_INIT
;
306 struct string_list kv
= STRING_LIST_INIT_DUP
;
307 int retval
= -1; /* assume failure */
310 assert(!state
->author_name
);
311 assert(!state
->author_email
);
312 assert(!state
->author_date
);
314 fd
= open(filename
, O_RDONLY
);
318 die_errno(_("could not open '%s' for reading"), filename
);
320 strbuf_read(&buf
, fd
, 0);
322 if (parse_key_value_squoted(buf
.buf
, &kv
))
326 strcmp(kv
.items
[0].string
, "GIT_AUTHOR_NAME") ||
327 strcmp(kv
.items
[1].string
, "GIT_AUTHOR_EMAIL") ||
328 strcmp(kv
.items
[2].string
, "GIT_AUTHOR_DATE"))
330 state
->author_name
= kv
.items
[0].util
;
331 state
->author_email
= kv
.items
[1].util
;
332 state
->author_date
= kv
.items
[2].util
;
335 string_list_clear(&kv
, !!retval
);
336 strbuf_release(&buf
);
341 * Saves state->author_name, state->author_email and state->author_date in the
342 * state directory's "author-script" file.
344 static void write_author_script(const struct am_state
*state
)
346 struct strbuf sb
= STRBUF_INIT
;
348 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
349 sq_quote_buf(&sb
, state
->author_name
);
350 strbuf_addch(&sb
, '\n');
352 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
353 sq_quote_buf(&sb
, state
->author_email
);
354 strbuf_addch(&sb
, '\n');
356 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
357 sq_quote_buf(&sb
, state
->author_date
);
358 strbuf_addch(&sb
, '\n');
360 write_state_text(state
, "author-script", sb
.buf
);
366 * Reads the commit message from the state directory's "final-commit" file,
367 * setting state->msg to its contents and state->msg_len to the length of its
370 * Returns 0 on success, -1 if the file does not exist.
372 static int read_commit_msg(struct am_state
*state
)
374 struct strbuf sb
= STRBUF_INIT
;
378 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
383 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
388 * Saves state->msg in the state directory's "final-commit" file.
390 static void write_commit_msg(const struct am_state
*state
)
392 const char *filename
= am_path(state
, "final-commit");
393 write_file_buf(filename
, state
->msg
, state
->msg_len
);
397 * Loads state from disk.
399 static void am_load(struct am_state
*state
)
401 struct strbuf sb
= STRBUF_INIT
;
403 if (read_state_file(&sb
, state
, "next", 1) < 0)
404 die("BUG: state file 'next' does not exist");
405 state
->cur
= strtol(sb
.buf
, NULL
, 10);
407 if (read_state_file(&sb
, state
, "last", 1) < 0)
408 die("BUG: state file 'last' does not exist");
409 state
->last
= strtol(sb
.buf
, NULL
, 10);
411 if (read_author_script(state
) < 0)
412 die(_("could not parse author script"));
414 read_commit_msg(state
);
416 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
417 oidclr(&state
->orig_commit
);
418 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
419 die(_("could not parse %s"), am_path(state
, "original-commit"));
421 read_state_file(&sb
, state
, "threeway", 1);
422 state
->threeway
= !strcmp(sb
.buf
, "t");
424 read_state_file(&sb
, state
, "quiet", 1);
425 state
->quiet
= !strcmp(sb
.buf
, "t");
427 read_state_file(&sb
, state
, "sign", 1);
428 state
->signoff
= !strcmp(sb
.buf
, "t");
430 read_state_file(&sb
, state
, "utf8", 1);
431 state
->utf8
= !strcmp(sb
.buf
, "t");
433 read_state_file(&sb
, state
, "keep", 1);
434 if (!strcmp(sb
.buf
, "t"))
435 state
->keep
= KEEP_TRUE
;
436 else if (!strcmp(sb
.buf
, "b"))
437 state
->keep
= KEEP_NON_PATCH
;
439 state
->keep
= KEEP_FALSE
;
441 read_state_file(&sb
, state
, "messageid", 1);
442 state
->message_id
= !strcmp(sb
.buf
, "t");
444 read_state_file(&sb
, state
, "scissors", 1);
445 if (!strcmp(sb
.buf
, "t"))
446 state
->scissors
= SCISSORS_TRUE
;
447 else if (!strcmp(sb
.buf
, "f"))
448 state
->scissors
= SCISSORS_FALSE
;
450 state
->scissors
= SCISSORS_UNSET
;
452 read_state_file(&sb
, state
, "apply-opt", 1);
453 argv_array_clear(&state
->git_apply_opts
);
454 if (sq_dequote_to_argv_array(sb
.buf
, &state
->git_apply_opts
) < 0)
455 die(_("could not parse %s"), am_path(state
, "apply-opt"));
457 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
463 * Removes the am_state directory, forcefully terminating the current am
466 static void am_destroy(const struct am_state
*state
)
468 struct strbuf sb
= STRBUF_INIT
;
470 strbuf_addstr(&sb
, state
->dir
);
471 remove_dir_recursively(&sb
, 0);
476 * Runs applypatch-msg hook. Returns its exit code.
478 static int run_applypatch_msg_hook(struct am_state
*state
)
483 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
488 if (read_commit_msg(state
) < 0)
489 die(_("'%s' was deleted by the applypatch-msg hook"),
490 am_path(state
, "final-commit"));
497 * Runs post-rewrite hook. Returns it exit code.
499 static int run_post_rewrite_hook(const struct am_state
*state
)
501 struct child_process cp
= CHILD_PROCESS_INIT
;
502 const char *hook
= find_hook("post-rewrite");
508 argv_array_push(&cp
.args
, hook
);
509 argv_array_push(&cp
.args
, "rebase");
511 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
512 cp
.stdout_to_stderr
= 1;
514 ret
= run_command(&cp
);
521 * Reads the state directory's "rewritten" file, and copies notes from the old
522 * commits listed in the file to their rewritten commits.
524 * Returns 0 on success, -1 on failure.
526 static int copy_notes_for_rebase(const struct am_state
*state
)
528 struct notes_rewrite_cfg
*c
;
529 struct strbuf sb
= STRBUF_INIT
;
530 const char *invalid_line
= _("Malformed input line: '%s'.");
531 const char *msg
= "Notes added by 'git rebase'";
535 assert(state
->rebasing
);
537 c
= init_copy_notes_for_rewrite("rebase");
541 fp
= xfopen(am_path(state
, "rewritten"), "r");
543 while (!strbuf_getline_lf(&sb
, fp
)) {
544 struct object_id from_obj
, to_obj
;
546 if (sb
.len
!= GIT_SHA1_HEXSZ
* 2 + 1) {
547 ret
= error(invalid_line
, sb
.buf
);
551 if (get_oid_hex(sb
.buf
, &from_obj
)) {
552 ret
= error(invalid_line
, sb
.buf
);
556 if (sb
.buf
[GIT_SHA1_HEXSZ
] != ' ') {
557 ret
= error(invalid_line
, sb
.buf
);
561 if (get_oid_hex(sb
.buf
+ GIT_SHA1_HEXSZ
+ 1, &to_obj
)) {
562 ret
= error(invalid_line
, sb
.buf
);
566 if (copy_note_for_rewrite(c
, &from_obj
, &to_obj
))
567 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
568 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
572 finish_copy_notes_for_rewrite(c
, msg
);
579 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
580 * non-indented lines and checking if they look like they begin with valid
581 * header field names.
583 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
585 static int is_mail(FILE *fp
)
587 const char *header_regex
= "^[!-9;-~]+:";
588 struct strbuf sb
= STRBUF_INIT
;
592 if (fseek(fp
, 0L, SEEK_SET
))
593 die_errno(_("fseek failed"));
595 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
596 die("invalid pattern: %s", header_regex
);
598 while (!strbuf_getline(&sb
, fp
)) {
600 break; /* End of header */
602 /* Ignore indented folded lines */
603 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
606 /* It's a header if it matches header_regex */
607 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
620 * Attempts to detect the patch_format of the patches contained in `paths`,
621 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
624 static int detect_patch_format(const char **paths
)
626 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
627 struct strbuf l1
= STRBUF_INIT
;
628 struct strbuf l2
= STRBUF_INIT
;
629 struct strbuf l3
= STRBUF_INIT
;
633 * We default to mbox format if input is from stdin and for directories
635 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
636 return PATCH_FORMAT_MBOX
;
639 * Otherwise, check the first few lines of the first patch, starting
640 * from the first non-blank line, to try to detect its format.
643 fp
= xfopen(*paths
, "r");
645 while (!strbuf_getline(&l1
, fp
)) {
650 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
651 ret
= PATCH_FORMAT_MBOX
;
655 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
656 ret
= PATCH_FORMAT_STGIT_SERIES
;
660 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
661 ret
= PATCH_FORMAT_HG
;
666 strbuf_getline(&l2
, fp
);
668 strbuf_getline(&l3
, fp
);
671 * If the second line is empty and the third is a From, Author or Date
672 * entry, this is likely an StGit patch.
674 if (l1
.len
&& !l2
.len
&&
675 (starts_with(l3
.buf
, "From:") ||
676 starts_with(l3
.buf
, "Author:") ||
677 starts_with(l3
.buf
, "Date:"))) {
678 ret
= PATCH_FORMAT_STGIT
;
682 if (l1
.len
&& is_mail(fp
)) {
683 ret
= PATCH_FORMAT_MBOX
;
694 * Splits out individual email patches from `paths`, where each path is either
695 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
697 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
698 int keep_cr
, int mboxrd
)
700 struct child_process cp
= CHILD_PROCESS_INIT
;
701 struct strbuf last
= STRBUF_INIT
;
704 argv_array_push(&cp
.args
, "mailsplit");
705 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
706 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
707 argv_array_push(&cp
.args
, "-b");
709 argv_array_push(&cp
.args
, "--keep-cr");
711 argv_array_push(&cp
.args
, "--mboxrd");
712 argv_array_push(&cp
.args
, "--");
713 argv_array_pushv(&cp
.args
, paths
);
715 if (capture_command(&cp
, &last
, 8))
719 state
->last
= strtol(last
.buf
, NULL
, 10);
725 * Callback signature for split_mail_conv(). The foreign patch should be
726 * read from `in`, and the converted patch (in RFC2822 mail format) should be
727 * written to `out`. Return 0 on success, or -1 on failure.
729 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
732 * Calls `fn` for each file in `paths` to convert the foreign patch to the
733 * RFC2822 mail format suitable for parsing with git-mailinfo.
735 * Returns 0 on success, -1 on failure.
737 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
738 const char **paths
, int keep_cr
)
740 static const char *stdin_only
[] = {"-", NULL
};
746 for (i
= 0; *paths
; paths
++, i
++) {
751 if (!strcmp(*paths
, "-"))
754 in
= fopen(*paths
, "r");
757 return error_errno(_("could not open '%s' for reading"),
760 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
762 out
= fopen(mail
, "w");
766 return error_errno(_("could not open '%s' for writing"),
770 ret
= fn(out
, in
, keep_cr
);
777 return error(_("could not parse patch '%s'"), *paths
);
786 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
787 * message suitable for parsing with git-mailinfo.
789 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
791 struct strbuf sb
= STRBUF_INIT
;
792 int subject_printed
= 0;
794 while (!strbuf_getline_lf(&sb
, in
)) {
797 if (str_isspace(sb
.buf
))
799 else if (skip_prefix(sb
.buf
, "Author:", &str
))
800 fprintf(out
, "From:%s\n", str
);
801 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
802 fprintf(out
, "%s\n", sb
.buf
);
803 else if (!subject_printed
) {
804 fprintf(out
, "Subject: %s\n", sb
.buf
);
807 fprintf(out
, "\n%s\n", sb
.buf
);
813 while (strbuf_fread(&sb
, 8192, in
) > 0) {
814 fwrite(sb
.buf
, 1, sb
.len
, out
);
823 * This function only supports a single StGit series file in `paths`.
825 * Given an StGit series file, converts the StGit patches in the series into
826 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
827 * the state directory.
829 * Returns 0 on success, -1 on failure.
831 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
834 const char *series_dir
;
835 char *series_dir_buf
;
837 struct argv_array patches
= ARGV_ARRAY_INIT
;
838 struct strbuf sb
= STRBUF_INIT
;
841 if (!paths
[0] || paths
[1])
842 return error(_("Only one StGIT patch series can be applied at once"));
844 series_dir_buf
= xstrdup(*paths
);
845 series_dir
= dirname(series_dir_buf
);
847 fp
= fopen(*paths
, "r");
849 return error_errno(_("could not open '%s' for reading"), *paths
);
851 while (!strbuf_getline_lf(&sb
, fp
)) {
853 continue; /* skip comment lines */
855 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
860 free(series_dir_buf
);
862 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
864 argv_array_clear(&patches
);
869 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
870 * message suitable for parsing with git-mailinfo.
872 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
874 struct strbuf sb
= STRBUF_INIT
;
876 while (!strbuf_getline_lf(&sb
, in
)) {
879 if (skip_prefix(sb
.buf
, "# User ", &str
))
880 fprintf(out
, "From: %s\n", str
);
881 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
882 timestamp_t timestamp
;
887 timestamp
= parse_timestamp(str
, &end
, 10);
889 return error(_("invalid timestamp"));
891 if (!skip_prefix(end
, " ", &str
))
892 return error(_("invalid Date line"));
895 tz
= strtol(str
, &end
, 10);
897 return error(_("invalid timezone offset"));
900 return error(_("invalid Date line"));
903 * mercurial's timezone is in seconds west of UTC,
904 * however git's timezone is in hours + minutes east of
907 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
911 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
912 } else if (starts_with(sb
.buf
, "# ")) {
915 fprintf(out
, "\n%s\n", sb
.buf
);
921 while (strbuf_fread(&sb
, 8192, in
) > 0) {
922 fwrite(sb
.buf
, 1, sb
.len
, out
);
931 * Splits a list of files/directories into individual email patches. Each path
932 * in `paths` must be a file/directory that is formatted according to
935 * Once split out, the individual email patches will be stored in the state
936 * directory, with each patch's filename being its index, padded to state->prec
939 * state->cur will be set to the index of the first mail, and state->last will
940 * be set to the index of the last mail.
942 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
943 * to disable this behavior, -1 to use the default configured setting.
945 * Returns 0 on success, -1 on failure.
947 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
948 const char **paths
, int keep_cr
)
952 git_config_get_bool("am.keepcr", &keep_cr
);
955 switch (patch_format
) {
956 case PATCH_FORMAT_MBOX
:
957 return split_mail_mbox(state
, paths
, keep_cr
, 0);
958 case PATCH_FORMAT_STGIT
:
959 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
960 case PATCH_FORMAT_STGIT_SERIES
:
961 return split_mail_stgit_series(state
, paths
, keep_cr
);
962 case PATCH_FORMAT_HG
:
963 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
964 case PATCH_FORMAT_MBOXRD
:
965 return split_mail_mbox(state
, paths
, keep_cr
, 1);
967 die("BUG: invalid patch_format");
973 * Setup a new am session for applying patches
975 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
976 const char **paths
, int keep_cr
)
978 struct object_id curr_head
;
980 struct strbuf sb
= STRBUF_INIT
;
983 patch_format
= detect_patch_format(paths
);
986 fprintf_ln(stderr
, _("Patch format detection failed."));
990 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
991 die_errno(_("failed to create directory '%s'"), state
->dir
);
993 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
995 die(_("Failed to split patches."));
1001 write_state_bool(state
, "threeway", state
->threeway
);
1002 write_state_bool(state
, "quiet", state
->quiet
);
1003 write_state_bool(state
, "sign", state
->signoff
);
1004 write_state_bool(state
, "utf8", state
->utf8
);
1006 switch (state
->keep
) {
1013 case KEEP_NON_PATCH
:
1017 die("BUG: invalid value for state->keep");
1020 write_state_text(state
, "keep", str
);
1021 write_state_bool(state
, "messageid", state
->message_id
);
1023 switch (state
->scissors
) {
1024 case SCISSORS_UNSET
:
1027 case SCISSORS_FALSE
:
1034 die("BUG: invalid value for state->scissors");
1036 write_state_text(state
, "scissors", str
);
1038 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
, 0);
1039 write_state_text(state
, "apply-opt", sb
.buf
);
1041 if (state
->rebasing
)
1042 write_state_text(state
, "rebasing", "");
1044 write_state_text(state
, "applying", "");
1046 if (!get_oid("HEAD", &curr_head
)) {
1047 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1048 if (!state
->rebasing
)
1049 update_ref_oid("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1050 UPDATE_REFS_DIE_ON_ERR
);
1052 write_state_text(state
, "abort-safety", "");
1053 if (!state
->rebasing
)
1054 delete_ref(NULL
, "ORIG_HEAD", NULL
, 0);
1058 * NOTE: Since the "next" and "last" files determine if an am_state
1059 * session is in progress, they should be written last.
1062 write_state_count(state
, "next", state
->cur
);
1063 write_state_count(state
, "last", state
->last
);
1065 strbuf_release(&sb
);
1069 * Increments the patch pointer, and cleans am_state for the application of the
1072 static void am_next(struct am_state
*state
)
1074 struct object_id head
;
1076 free(state
->author_name
);
1077 state
->author_name
= NULL
;
1079 free(state
->author_email
);
1080 state
->author_email
= NULL
;
1082 free(state
->author_date
);
1083 state
->author_date
= NULL
;
1089 unlink(am_path(state
, "author-script"));
1090 unlink(am_path(state
, "final-commit"));
1092 oidclr(&state
->orig_commit
);
1093 unlink(am_path(state
, "original-commit"));
1095 if (!get_oid("HEAD", &head
))
1096 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1098 write_state_text(state
, "abort-safety", "");
1101 write_state_count(state
, "next", state
->cur
);
1105 * Returns the filename of the current patch email.
1107 static const char *msgnum(const struct am_state
*state
)
1109 static struct strbuf sb
= STRBUF_INIT
;
1112 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1118 * Refresh and write index.
1120 static void refresh_and_write_cache(void)
1122 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
1124 hold_locked_index(lock_file
, LOCK_DIE_ON_ERROR
);
1125 refresh_cache(REFRESH_QUIET
);
1126 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1127 die(_("unable to write index file"));
1131 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
1132 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
1133 * strbuf is provided, the space-separated list of files that differ will be
1136 static int index_has_changes(struct strbuf
*sb
)
1138 struct object_id head
;
1141 if (!get_sha1_tree("HEAD", head
.hash
)) {
1142 struct diff_options opt
;
1145 DIFF_OPT_SET(&opt
, EXIT_WITH_STATUS
);
1147 DIFF_OPT_SET(&opt
, QUICK
);
1148 do_diff_cache(&head
, &opt
);
1150 for (i
= 0; sb
&& i
< diff_queued_diff
.nr
; i
++) {
1152 strbuf_addch(sb
, ' ');
1153 strbuf_addstr(sb
, diff_queued_diff
.queue
[i
]->two
->path
);
1156 return DIFF_OPT_TST(&opt
, HAS_CHANGES
) != 0;
1158 for (i
= 0; sb
&& i
< active_nr
; i
++) {
1160 strbuf_addch(sb
, ' ');
1161 strbuf_addstr(sb
, active_cache
[i
]->name
);
1168 * Dies with a user-friendly message on how to proceed after resolving the
1169 * problem. This message can be overridden with state->resolvemsg.
1171 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1173 if (state
->resolvemsg
) {
1174 printf_ln("%s", state
->resolvemsg
);
1176 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1178 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1179 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1180 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1187 * Appends signoff to the "msg" field of the am_state.
1189 static void am_append_signoff(struct am_state
*state
)
1192 struct strbuf mine
= STRBUF_INIT
;
1193 struct strbuf sb
= STRBUF_INIT
;
1195 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1198 strbuf_addf(&mine
, "\n%s%s\n",
1200 fmt_name(getenv("GIT_COMMITTER_NAME"),
1201 getenv("GIT_COMMITTER_EMAIL")));
1203 /* Does sb end with it already? */
1204 if (mine
.len
< sb
.len
&&
1205 !strcmp(mine
.buf
, sb
.buf
+ sb
.len
- mine
.len
))
1206 goto exit
; /* no need to duplicate */
1208 /* Does it have any Signed-off-by: in the text */
1210 cp
&& *cp
&& (cp
= strstr(cp
, sign_off_header
)) != NULL
;
1211 cp
= strchr(cp
, '\n')) {
1212 if (sb
.buf
== cp
|| cp
[-1] == '\n')
1216 strbuf_addstr(&sb
, mine
.buf
+ !!cp
);
1218 strbuf_release(&mine
);
1219 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1223 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1224 * state->msg will be set to the patch message. state->author_name,
1225 * state->author_email and state->author_date will be set to the patch author's
1226 * name, email and date respectively. The patch body will be written to the
1227 * state directory's "patch" file.
1229 * Returns 1 if the patch should be skipped, 0 otherwise.
1231 static int parse_mail(struct am_state
*state
, const char *mail
)
1234 struct strbuf sb
= STRBUF_INIT
;
1235 struct strbuf msg
= STRBUF_INIT
;
1236 struct strbuf author_name
= STRBUF_INIT
;
1237 struct strbuf author_date
= STRBUF_INIT
;
1238 struct strbuf author_email
= STRBUF_INIT
;
1242 setup_mailinfo(&mi
);
1245 mi
.metainfo_charset
= get_commit_output_encoding();
1247 mi
.metainfo_charset
= NULL
;
1249 switch (state
->keep
) {
1253 mi
.keep_subject
= 1;
1255 case KEEP_NON_PATCH
:
1256 mi
.keep_non_patch_brackets_in_subject
= 1;
1259 die("BUG: invalid value for state->keep");
1262 if (state
->message_id
)
1263 mi
.add_message_id
= 1;
1265 switch (state
->scissors
) {
1266 case SCISSORS_UNSET
:
1268 case SCISSORS_FALSE
:
1269 mi
.use_scissors
= 0;
1272 mi
.use_scissors
= 1;
1275 die("BUG: invalid value for state->scissors");
1278 mi
.input
= xfopen(mail
, "r");
1279 mi
.output
= xfopen(am_path(state
, "info"), "w");
1280 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1281 die("could not parse patch");
1286 /* Extract message and author information */
1287 fp
= xfopen(am_path(state
, "info"), "r");
1288 while (!strbuf_getline_lf(&sb
, fp
)) {
1291 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1293 strbuf_addch(&msg
, '\n');
1294 strbuf_addstr(&msg
, x
);
1295 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1296 strbuf_addstr(&author_name
, x
);
1297 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1298 strbuf_addstr(&author_email
, x
);
1299 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1300 strbuf_addstr(&author_date
, x
);
1304 /* Skip pine's internal folder data */
1305 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1310 if (is_empty_file(am_path(state
, "patch"))) {
1311 printf_ln(_("Patch is empty."));
1312 die_user_resolve(state
);
1315 strbuf_addstr(&msg
, "\n\n");
1316 strbuf_addbuf(&msg
, &mi
.log_message
);
1317 strbuf_stripspace(&msg
, 0);
1319 assert(!state
->author_name
);
1320 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1322 assert(!state
->author_email
);
1323 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1325 assert(!state
->author_date
);
1326 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1328 assert(!state
->msg
);
1329 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1332 strbuf_release(&msg
);
1333 strbuf_release(&author_date
);
1334 strbuf_release(&author_email
);
1335 strbuf_release(&author_name
);
1336 strbuf_release(&sb
);
1337 clear_mailinfo(&mi
);
1342 * Sets commit_id to the commit hash where the mail was generated from.
1343 * Returns 0 on success, -1 on failure.
1345 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1347 struct strbuf sb
= STRBUF_INIT
;
1348 FILE *fp
= xfopen(mail
, "r");
1352 if (strbuf_getline_lf(&sb
, fp
) ||
1353 !skip_prefix(sb
.buf
, "From ", &x
) ||
1354 get_oid_hex(x
, commit_id
) < 0)
1357 strbuf_release(&sb
);
1363 * Sets state->msg, state->author_name, state->author_email, state->author_date
1364 * to the commit's respective info.
1366 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1368 const char *buffer
, *ident_line
, *msg
;
1370 struct ident_split id
;
1372 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1374 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1376 if (split_ident_line(&id
, ident_line
, ident_len
) < 0)
1377 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1379 assert(!state
->author_name
);
1381 state
->author_name
=
1382 xmemdupz(id
.name_begin
, id
.name_end
- id
.name_begin
);
1384 state
->author_name
= xstrdup("");
1386 assert(!state
->author_email
);
1388 state
->author_email
=
1389 xmemdupz(id
.mail_begin
, id
.mail_end
- id
.mail_begin
);
1391 state
->author_email
= xstrdup("");
1393 assert(!state
->author_date
);
1394 state
->author_date
= xstrdup(show_ident_date(&id
, DATE_MODE(NORMAL
)));
1396 assert(!state
->msg
);
1397 msg
= strstr(buffer
, "\n\n");
1399 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1400 state
->msg
= xstrdup(msg
+ 2);
1401 state
->msg_len
= strlen(state
->msg
);
1402 unuse_commit_buffer(commit
, buffer
);
1406 * Writes `commit` as a patch to the state directory's "patch" file.
1408 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1410 struct rev_info rev_info
;
1413 fp
= xfopen(am_path(state
, "patch"), "w");
1414 init_revisions(&rev_info
, NULL
);
1416 rev_info
.abbrev
= 0;
1417 rev_info
.disable_stdin
= 1;
1418 rev_info
.show_root_diff
= 1;
1419 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1420 rev_info
.no_commit_id
= 1;
1421 DIFF_OPT_SET(&rev_info
.diffopt
, BINARY
);
1422 DIFF_OPT_SET(&rev_info
.diffopt
, FULL_INDEX
);
1423 rev_info
.diffopt
.use_color
= 0;
1424 rev_info
.diffopt
.file
= fp
;
1425 rev_info
.diffopt
.close_file
= 1;
1426 add_pending_object(&rev_info
, &commit
->object
, "");
1427 diff_setup_done(&rev_info
.diffopt
);
1428 log_tree_commit(&rev_info
, commit
);
1432 * Writes the diff of the index against HEAD as a patch to the state
1433 * directory's "patch" file.
1435 static void write_index_patch(const struct am_state
*state
)
1438 struct object_id head
;
1439 struct rev_info rev_info
;
1442 if (!get_sha1_tree("HEAD", head
.hash
))
1443 tree
= lookup_tree(&head
);
1445 tree
= lookup_tree(&empty_tree_oid
);
1447 fp
= xfopen(am_path(state
, "patch"), "w");
1448 init_revisions(&rev_info
, NULL
);
1450 rev_info
.disable_stdin
= 1;
1451 rev_info
.no_commit_id
= 1;
1452 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1453 rev_info
.diffopt
.use_color
= 0;
1454 rev_info
.diffopt
.file
= fp
;
1455 rev_info
.diffopt
.close_file
= 1;
1456 add_pending_object(&rev_info
, &tree
->object
, "");
1457 diff_setup_done(&rev_info
.diffopt
);
1458 run_diff_index(&rev_info
, 1);
1462 * Like parse_mail(), but parses the mail by looking up its commit ID
1463 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1466 * state->orig_commit will be set to the original commit ID.
1468 * Will always return 0 as the patch should never be skipped.
1470 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1472 struct commit
*commit
;
1473 struct object_id commit_oid
;
1475 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1476 die(_("could not parse %s"), mail
);
1478 commit
= lookup_commit_or_die(&commit_oid
, mail
);
1480 get_commit_info(state
, commit
);
1482 write_commit_patch(state
, commit
);
1484 oidcpy(&state
->orig_commit
, &commit_oid
);
1485 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1491 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1492 * `index_file` is not NULL, the patch will be applied to that index.
1494 static int run_apply(const struct am_state
*state
, const char *index_file
)
1496 struct argv_array apply_paths
= ARGV_ARRAY_INIT
;
1497 struct argv_array apply_opts
= ARGV_ARRAY_INIT
;
1498 struct apply_state apply_state
;
1500 static struct lock_file lock_file
;
1501 int force_apply
= 0;
1504 if (init_apply_state(&apply_state
, NULL
, &lock_file
))
1505 die("BUG: init_apply_state() failed");
1507 argv_array_push(&apply_opts
, "apply");
1508 argv_array_pushv(&apply_opts
, state
->git_apply_opts
.argv
);
1510 opts_left
= apply_parse_options(apply_opts
.argc
, apply_opts
.argv
,
1511 &apply_state
, &force_apply
, &options
,
1515 die("unknown option passed through to git apply");
1518 apply_state
.index_file
= index_file
;
1519 apply_state
.cached
= 1;
1521 apply_state
.check_index
= 1;
1524 * If we are allowed to fall back on 3-way merge, don't give false
1525 * errors during the initial attempt.
1527 if (state
->threeway
&& !index_file
)
1528 apply_state
.apply_verbosity
= verbosity_silent
;
1530 if (check_apply_state(&apply_state
, force_apply
))
1531 die("BUG: check_apply_state() failed");
1533 argv_array_push(&apply_paths
, am_path(state
, "patch"));
1535 res
= apply_all_patches(&apply_state
, apply_paths
.argc
, apply_paths
.argv
, options
);
1537 argv_array_clear(&apply_paths
);
1538 argv_array_clear(&apply_opts
);
1539 clear_apply_state(&apply_state
);
1545 /* Reload index as apply_all_patches() will have modified it. */
1547 read_cache_from(index_file
);
1554 * Builds an index that contains just the blobs needed for a 3way merge.
1556 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1558 struct child_process cp
= CHILD_PROCESS_INIT
;
1561 argv_array_push(&cp
.args
, "apply");
1562 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1563 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1564 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1566 if (run_command(&cp
))
1573 * Attempt a threeway merge, using index_path as the temporary index.
1575 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1577 struct object_id orig_tree
, their_tree
, our_tree
;
1578 const struct object_id
*bases
[1] = { &orig_tree
};
1579 struct merge_options o
;
1580 struct commit
*result
;
1581 char *their_tree_name
;
1583 if (get_oid("HEAD", &our_tree
) < 0)
1584 hashcpy(our_tree
.hash
, EMPTY_TREE_SHA1_BIN
);
1586 if (build_fake_ancestor(state
, index_path
))
1587 return error("could not build fake ancestor");
1590 read_cache_from(index_path
);
1592 if (write_index_as_tree(orig_tree
.hash
, &the_index
, index_path
, 0, NULL
))
1593 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1595 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1597 if (!state
->quiet
) {
1599 * List paths that needed 3-way fallback, so that the user can
1600 * review them with extra care to spot mismerges.
1602 struct rev_info rev_info
;
1603 const char *diff_filter_str
= "--diff-filter=AM";
1605 init_revisions(&rev_info
, NULL
);
1606 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1607 diff_opt_parse(&rev_info
.diffopt
, &diff_filter_str
, 1, rev_info
.prefix
);
1608 add_pending_oid(&rev_info
, "HEAD", &our_tree
, 0);
1609 diff_setup_done(&rev_info
.diffopt
);
1610 run_diff_index(&rev_info
, 1);
1613 if (run_apply(state
, index_path
))
1614 return error(_("Did you hand edit your patch?\n"
1615 "It does not apply to blobs recorded in its index."));
1617 if (write_index_as_tree(their_tree
.hash
, &the_index
, index_path
, 0, NULL
))
1618 return error("could not write tree");
1620 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1626 * This is not so wrong. Depending on which base we picked, orig_tree
1627 * may be wildly different from ours, but their_tree has the same set of
1628 * wildly different changes in parts the patch did not touch, so
1629 * recursive ends up canceling them, saying that we reverted all those
1633 init_merge_options(&o
);
1636 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1637 o
.branch2
= their_tree_name
;
1642 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1643 rerere(state
->allow_rerere_autoupdate
);
1644 free(their_tree_name
);
1645 return error(_("Failed to merge in the changes."));
1648 free(their_tree_name
);
1653 * Commits the current index with state->msg as the commit message and
1654 * state->author_name, state->author_email and state->author_date as the author
1657 static void do_commit(const struct am_state
*state
)
1659 struct object_id tree
, parent
, commit
;
1660 const struct object_id
*old_oid
;
1661 struct commit_list
*parents
= NULL
;
1662 const char *reflog_msg
, *author
;
1663 struct strbuf sb
= STRBUF_INIT
;
1665 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1668 if (write_cache_as_tree(tree
.hash
, 0, NULL
))
1669 die(_("git write-tree failed to write a tree"));
1671 if (!get_sha1_commit("HEAD", parent
.hash
)) {
1673 commit_list_insert(lookup_commit(&parent
), &parents
);
1676 say(state
, stderr
, _("applying to an empty history"));
1679 author
= fmt_ident(state
->author_name
, state
->author_email
,
1680 state
->ignore_date
? NULL
: state
->author_date
,
1683 if (state
->committer_date_is_author_date
)
1684 setenv("GIT_COMMITTER_DATE",
1685 state
->ignore_date
? "" : state
->author_date
, 1);
1687 if (commit_tree(state
->msg
, state
->msg_len
, tree
.hash
, parents
, commit
.hash
,
1688 author
, state
->sign_commit
))
1689 die(_("failed to write commit object"));
1691 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1695 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1698 update_ref_oid(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1699 UPDATE_REFS_DIE_ON_ERR
);
1701 if (state
->rebasing
) {
1702 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1704 assert(!is_null_oid(&state
->orig_commit
));
1705 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1706 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1710 run_hook_le(NULL
, "post-applypatch", NULL
);
1712 strbuf_release(&sb
);
1716 * Validates the am_state for resuming -- the "msg" and authorship fields must
1719 static void validate_resume_state(const struct am_state
*state
)
1722 die(_("cannot resume: %s does not exist."),
1723 am_path(state
, "final-commit"));
1725 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1726 die(_("cannot resume: %s does not exist."),
1727 am_path(state
, "author-script"));
1731 * Interactively prompt the user on whether the current patch should be
1734 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1737 static int do_interactive(struct am_state
*state
)
1742 die(_("cannot be interactive without stdin connected to a terminal."));
1747 puts(_("Commit Body is:"));
1748 puts("--------------------------");
1749 printf("%s", state
->msg
);
1750 puts("--------------------------");
1753 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1754 * in your translation. The program will only accept English
1755 * input at this point.
1757 reply
= git_prompt(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "), PROMPT_ECHO
);
1761 } else if (*reply
== 'y' || *reply
== 'Y') {
1763 } else if (*reply
== 'a' || *reply
== 'A') {
1764 state
->interactive
= 0;
1766 } else if (*reply
== 'n' || *reply
== 'N') {
1768 } else if (*reply
== 'e' || *reply
== 'E') {
1769 struct strbuf msg
= STRBUF_INIT
;
1771 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1773 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1775 strbuf_release(&msg
);
1776 } else if (*reply
== 'v' || *reply
== 'V') {
1777 const char *pager
= git_pager(1);
1778 struct child_process cp
= CHILD_PROCESS_INIT
;
1782 prepare_pager_args(&cp
, pager
);
1783 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1790 * Applies all queued mail.
1792 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1793 * well as the state directory's "patch" file is used as-is for applying the
1794 * patch and committing it.
1796 static void am_run(struct am_state
*state
, int resume
)
1798 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1799 struct strbuf sb
= STRBUF_INIT
;
1801 unlink(am_path(state
, "dirtyindex"));
1803 refresh_and_write_cache();
1805 if (index_has_changes(&sb
)) {
1806 write_state_bool(state
, "dirtyindex", 1);
1807 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1810 strbuf_release(&sb
);
1812 while (state
->cur
<= state
->last
) {
1813 const char *mail
= am_path(state
, msgnum(state
));
1818 if (!file_exists(mail
))
1822 validate_resume_state(state
);
1826 if (state
->rebasing
)
1827 skip
= parse_mail_rebase(state
, mail
);
1829 skip
= parse_mail(state
, mail
);
1832 goto next
; /* mail should be skipped */
1835 am_append_signoff(state
);
1837 write_author_script(state
);
1838 write_commit_msg(state
);
1841 if (state
->interactive
&& do_interactive(state
))
1844 if (run_applypatch_msg_hook(state
))
1847 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1849 apply_status
= run_apply(state
, NULL
);
1851 if (apply_status
&& state
->threeway
) {
1852 struct strbuf sb
= STRBUF_INIT
;
1854 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1855 apply_status
= fall_back_threeway(state
, sb
.buf
);
1856 strbuf_release(&sb
);
1859 * Applying the patch to an earlier tree and merging
1860 * the result may have produced the same tree as ours.
1862 if (!apply_status
&& !index_has_changes(NULL
)) {
1863 say(state
, stdout
, _("No changes -- Patch already applied."));
1869 int advice_amworkdir
= 1;
1871 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1872 linelen(state
->msg
), state
->msg
);
1874 git_config_get_bool("advice.amworkdir", &advice_amworkdir
);
1876 if (advice_amworkdir
)
1877 printf_ln(_("The copy of the patch that failed is found in: %s"),
1878 am_path(state
, "patch"));
1880 die_user_resolve(state
);
1893 if (!is_empty_file(am_path(state
, "rewritten"))) {
1894 assert(state
->rebasing
);
1895 copy_notes_for_rebase(state
);
1896 run_post_rewrite_hook(state
);
1900 * In rebasing mode, it's up to the caller to take care of
1903 if (!state
->rebasing
) {
1906 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1911 * Resume the current am session after patch application failure. The user did
1912 * all the hard work, and we do not have to do any patch application. Just
1913 * trust and commit what the user has in the index and working tree.
1915 static void am_resolve(struct am_state
*state
)
1917 validate_resume_state(state
);
1919 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1921 if (!index_has_changes(NULL
)) {
1922 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1923 "If there is nothing left to stage, chances are that something else\n"
1924 "already introduced the same changes; you might want to skip this patch."));
1925 die_user_resolve(state
);
1928 if (unmerged_cache()) {
1929 printf_ln(_("You still have unmerged paths in your index.\n"
1930 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1931 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1932 die_user_resolve(state
);
1935 if (state
->interactive
) {
1936 write_index_patch(state
);
1937 if (do_interactive(state
))
1952 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1953 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1956 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1958 struct lock_file
*lock_file
;
1959 struct unpack_trees_options opts
;
1960 struct tree_desc t
[2];
1962 if (parse_tree(head
) || parse_tree(remote
))
1965 lock_file
= xcalloc(1, sizeof(struct lock_file
));
1966 hold_locked_index(lock_file
, LOCK_DIE_ON_ERROR
);
1968 refresh_cache(REFRESH_QUIET
);
1970 memset(&opts
, 0, sizeof(opts
));
1972 opts
.src_index
= &the_index
;
1973 opts
.dst_index
= &the_index
;
1977 opts
.fn
= twoway_merge
;
1978 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1979 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1981 if (unpack_trees(2, t
, &opts
)) {
1982 rollback_lock_file(lock_file
);
1986 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1987 die(_("unable to write new index file"));
1993 * Merges a tree into the index. The index's stat info will take precedence
1994 * over the merged tree's. Returns 0 on success, -1 on failure.
1996 static int merge_tree(struct tree
*tree
)
1998 struct lock_file
*lock_file
;
1999 struct unpack_trees_options opts
;
2000 struct tree_desc t
[1];
2002 if (parse_tree(tree
))
2005 lock_file
= xcalloc(1, sizeof(struct lock_file
));
2006 hold_locked_index(lock_file
, LOCK_DIE_ON_ERROR
);
2008 memset(&opts
, 0, sizeof(opts
));
2010 opts
.src_index
= &the_index
;
2011 opts
.dst_index
= &the_index
;
2013 opts
.fn
= oneway_merge
;
2014 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
2016 if (unpack_trees(1, t
, &opts
)) {
2017 rollback_lock_file(lock_file
);
2021 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
2022 die(_("unable to write new index file"));
2028 * Clean the index without touching entries that are not modified between
2029 * `head` and `remote`.
2031 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
2033 struct tree
*head_tree
, *remote_tree
, *index_tree
;
2034 struct object_id index
;
2036 head_tree
= parse_tree_indirect(head
);
2038 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
2040 remote_tree
= parse_tree_indirect(remote
);
2042 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
2044 read_cache_unmerged();
2046 if (fast_forward_to(head_tree
, head_tree
, 1))
2049 if (write_cache_as_tree(index
.hash
, 0, NULL
))
2052 index_tree
= parse_tree_indirect(&index
);
2054 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
2056 if (fast_forward_to(index_tree
, remote_tree
, 0))
2059 if (merge_tree(remote_tree
))
2062 remove_branch_state();
2068 * Resets rerere's merge resolution metadata.
2070 static void am_rerere_clear(void)
2072 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
2073 rerere_clear(&merge_rr
);
2074 string_list_clear(&merge_rr
, 1);
2078 * Resume the current am session by skipping the current patch.
2080 static void am_skip(struct am_state
*state
)
2082 struct object_id head
;
2086 if (get_oid("HEAD", &head
))
2087 hashcpy(head
.hash
, EMPTY_TREE_SHA1_BIN
);
2089 if (clean_index(&head
, &head
))
2090 die(_("failed to clean index"));
2098 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2100 * It is not safe to reset HEAD when:
2101 * 1. git-am previously failed because the index was dirty.
2102 * 2. HEAD has moved since git-am previously failed.
2104 static int safe_to_abort(const struct am_state
*state
)
2106 struct strbuf sb
= STRBUF_INIT
;
2107 struct object_id abort_safety
, head
;
2109 if (file_exists(am_path(state
, "dirtyindex")))
2112 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2113 if (get_oid_hex(sb
.buf
, &abort_safety
))
2114 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2116 oidclr(&abort_safety
);
2118 if (get_oid("HEAD", &head
))
2121 if (!oidcmp(&head
, &abort_safety
))
2124 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2125 "Not rewinding to ORIG_HEAD"));
2131 * Aborts the current am session if it is safe to do so.
2133 static void am_abort(struct am_state
*state
)
2135 struct object_id curr_head
, orig_head
;
2136 int has_curr_head
, has_orig_head
;
2139 if (!safe_to_abort(state
)) {
2146 curr_branch
= resolve_refdup("HEAD", 0, curr_head
.hash
, NULL
);
2147 has_curr_head
= curr_branch
&& !is_null_oid(&curr_head
);
2149 hashcpy(curr_head
.hash
, EMPTY_TREE_SHA1_BIN
);
2151 has_orig_head
= !get_oid("ORIG_HEAD", &orig_head
);
2153 hashcpy(orig_head
.hash
, EMPTY_TREE_SHA1_BIN
);
2155 clean_index(&curr_head
, &orig_head
);
2158 update_ref_oid("am --abort", "HEAD", &orig_head
,
2159 has_curr_head
? &curr_head
: NULL
, 0,
2160 UPDATE_REFS_DIE_ON_ERR
);
2161 else if (curr_branch
)
2162 delete_ref(NULL
, curr_branch
, NULL
, REF_NODEREF
);
2169 * parse_options() callback that validates and sets opt->value to the
2170 * PATCH_FORMAT_* enum value corresponding to `arg`.
2172 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2174 int *opt_value
= opt
->value
;
2176 if (!strcmp(arg
, "mbox"))
2177 *opt_value
= PATCH_FORMAT_MBOX
;
2178 else if (!strcmp(arg
, "stgit"))
2179 *opt_value
= PATCH_FORMAT_STGIT
;
2180 else if (!strcmp(arg
, "stgit-series"))
2181 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2182 else if (!strcmp(arg
, "hg"))
2183 *opt_value
= PATCH_FORMAT_HG
;
2184 else if (!strcmp(arg
, "mboxrd"))
2185 *opt_value
= PATCH_FORMAT_MBOXRD
;
2187 return error(_("Invalid value for --patch-format: %s"), arg
);
2199 static int git_am_config(const char *k
, const char *v
, void *cb
)
2203 status
= git_gpg_config(k
, v
, NULL
);
2207 return git_default_config(k
, v
, NULL
);
2210 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2212 struct am_state state
;
2215 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2216 enum resume_mode resume
= RESUME_FALSE
;
2219 const char * const usage
[] = {
2220 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2221 N_("git am [<options>] (--continue | --skip | --abort)"),
2225 struct option options
[] = {
2226 OPT_BOOL('i', "interactive", &state
.interactive
,
2227 N_("run interactively")),
2228 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2229 N_("historical option -- no-op")),
2230 OPT_BOOL('3', "3way", &state
.threeway
,
2231 N_("allow fall back on 3way merging if needed")),
2232 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2233 OPT_SET_INT('s', "signoff", &state
.signoff
,
2234 N_("add a Signed-off-by line to the commit message"),
2236 OPT_BOOL('u', "utf8", &state
.utf8
,
2237 N_("recode into utf8 (default)")),
2238 OPT_SET_INT('k', "keep", &state
.keep
,
2239 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2240 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2241 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2242 OPT_BOOL('m', "message-id", &state
.message_id
,
2243 N_("pass -m flag to git-mailinfo")),
2244 { OPTION_SET_INT
, 0, "keep-cr", &keep_cr
, NULL
,
2245 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2246 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1},
2247 { OPTION_SET_INT
, 0, "no-keep-cr", &keep_cr
, NULL
,
2248 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2249 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 0},
2250 OPT_BOOL('c', "scissors", &state
.scissors
,
2251 N_("strip everything before a scissors line")),
2252 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2253 N_("pass it through git-apply"),
2255 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2256 N_("pass it through git-apply"),
2258 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2259 N_("pass it through git-apply"),
2261 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2262 N_("pass it through git-apply"),
2264 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2265 N_("pass it through git-apply"),
2267 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2268 N_("pass it through git-apply"),
2270 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2271 N_("pass it through git-apply"),
2273 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2274 N_("pass it through git-apply"),
2276 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2277 N_("format the patch(es) are in"),
2278 parse_opt_patchformat
),
2279 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2280 N_("pass it through git-apply"),
2282 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2283 N_("override error message when patch failure occurs")),
2284 OPT_CMDMODE(0, "continue", &resume
,
2285 N_("continue applying patches after resolving a conflict"),
2287 OPT_CMDMODE('r', "resolved", &resume
,
2288 N_("synonyms for --continue"),
2290 OPT_CMDMODE(0, "skip", &resume
,
2291 N_("skip the current patch"),
2293 OPT_CMDMODE(0, "abort", &resume
,
2294 N_("restore the original branch and abort the patching operation."),
2296 OPT_BOOL(0, "committer-date-is-author-date",
2297 &state
.committer_date_is_author_date
,
2298 N_("lie about committer date")),
2299 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2300 N_("use current timestamp for author date")),
2301 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2302 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2303 N_("GPG-sign commits"),
2304 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2305 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2306 N_("(internal use for git-rebase)")),
2310 if (argc
== 2 && !strcmp(argv
[1], "-h"))
2311 usage_with_options(usage
, options
);
2313 git_config(git_am_config
, NULL
);
2315 am_state_init(&state
);
2317 in_progress
= am_in_progress(&state
);
2321 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2324 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2325 "it will be removed. Please do not use it anymore."));
2327 /* Ensure a valid committer ident can be constructed */
2328 git_committer_info(IDENT_STRICT
);
2330 if (read_index_preload(&the_index
, NULL
) < 0)
2331 die(_("failed to read the index"));
2335 * Catch user error to feed us patches when there is a session
2338 * 1. mbox path(s) are provided on the command-line.
2339 * 2. stdin is not a tty: the user is trying to feed us a patch
2340 * from standard input. This is somewhat unreliable -- stdin
2341 * could be /dev/null for example and the caller did not
2342 * intend to feed us a patch but wanted to continue
2345 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
2346 die(_("previous rebase directory %s still exists but mbox given."),
2349 if (resume
== RESUME_FALSE
)
2350 resume
= RESUME_APPLY
;
2352 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2353 am_append_signoff(&state
);
2355 struct argv_array paths
= ARGV_ARRAY_INIT
;
2359 * Handle stray state directory in the independent-run case. In
2360 * the --rebasing case, it is up to the caller to take care of
2361 * stray directories.
2363 if (file_exists(state
.dir
) && !state
.rebasing
) {
2364 if (resume
== RESUME_ABORT
) {
2366 am_state_release(&state
);
2370 die(_("Stray %s directory found.\n"
2371 "Use \"git am --abort\" to remove it."),
2376 die(_("Resolve operation not in progress, we are not resuming."));
2378 for (i
= 0; i
< argc
; i
++) {
2379 if (is_absolute_path(argv
[i
]) || !prefix
)
2380 argv_array_push(&paths
, argv
[i
]);
2382 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2385 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2387 argv_array_clear(&paths
);
2397 case RESUME_RESOLVED
:
2407 die("BUG: invalid resume value");
2410 am_state_release(&state
);