4 * Based on git-am.sh by Junio C Hamano.
6 #define USE_THE_INDEX_COMPATIBILITY_MACROS
11 #include "parse-options.h"
13 #include "run-command.h"
18 #include "cache-tree.h"
23 #include "unpack-trees.h"
25 #include "sequencer.h"
27 #include "merge-recursive.h"
29 #include "notes-utils.h"
34 #include "string-list.h"
36 #include "repository.h"
39 * Returns the length of the first line of msg.
41 static int linelen(const char *msg
)
43 return strchrnul(msg
, '\n') - msg
;
47 * Returns true if `str` consists of only whitespace, false otherwise.
49 static int str_isspace(const char *str
)
59 PATCH_FORMAT_UNKNOWN
= 0,
62 PATCH_FORMAT_STGIT_SERIES
,
69 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
70 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
75 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
76 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
82 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
85 enum show_patch_type
{
91 /* state directory path */
94 /* current and last patch numbers, 1-indexed */
98 /* commit metadata and message */
105 /* when --rebasing, records the original commit the patch came from */
106 struct object_id orig_commit
;
108 /* number of digits in patch filename */
111 /* various operating modes and command line options */
115 int signoff
; /* enum signoff_type */
117 int keep
; /* enum keep_type */
119 int scissors
; /* enum scissors_type */
120 int quoted_cr
; /* enum quoted_cr_action */
121 struct strvec git_apply_opts
;
122 const char *resolvemsg
;
123 int committer_date_is_author_date
;
125 int allow_rerere_autoupdate
;
126 const char *sign_commit
;
131 * Initializes am_state with the default values.
133 static void am_state_init(struct am_state
*state
)
137 memset(state
, 0, sizeof(*state
));
139 state
->dir
= git_pathdup("rebase-apply");
143 git_config_get_bool("am.threeway", &state
->threeway
);
147 git_config_get_bool("am.messageid", &state
->message_id
);
149 state
->scissors
= SCISSORS_UNSET
;
150 state
->quoted_cr
= quoted_cr_unset
;
152 strvec_init(&state
->git_apply_opts
);
154 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
155 state
->sign_commit
= gpgsign
? "" : NULL
;
159 * Releases memory allocated by an am_state.
161 static void am_state_release(struct am_state
*state
)
164 free(state
->author_name
);
165 free(state
->author_email
);
166 free(state
->author_date
);
168 strvec_clear(&state
->git_apply_opts
);
171 static int am_option_parse_quoted_cr(const struct option
*opt
,
172 const char *arg
, int unset
)
174 BUG_ON_OPT_NEG(unset
);
176 if (mailinfo_parse_quoted_cr_action(arg
, opt
->value
) != 0)
177 return error(_("bad action '%s' for '%s'"), arg
, "--quoted-cr");
182 * Returns path relative to the am_state directory.
184 static inline const char *am_path(const struct am_state
*state
, const char *path
)
186 return mkpath("%s/%s", state
->dir
, path
);
190 * For convenience to call write_file()
192 static void write_state_text(const struct am_state
*state
,
193 const char *name
, const char *string
)
195 write_file(am_path(state
, name
), "%s", string
);
198 static void write_state_count(const struct am_state
*state
,
199 const char *name
, int value
)
201 write_file(am_path(state
, name
), "%d", value
);
204 static void write_state_bool(const struct am_state
*state
,
205 const char *name
, int value
)
207 write_state_text(state
, name
, value
? "t" : "f");
211 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
214 __attribute__((format (printf
, 3, 4)))
215 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
221 vfprintf(fp
, fmt
, ap
);
228 * Returns 1 if there is an am session in progress, 0 otherwise.
230 static int am_in_progress(const struct am_state
*state
)
234 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
236 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
238 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
244 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
245 * number of bytes read on success, -1 if the file does not exist. If `trim` is
246 * set, trailing whitespace will be removed.
248 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
249 const char *file
, int trim
)
253 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
263 die_errno(_("could not read '%s'"), am_path(state
, file
));
267 * Reads and parses the state directory's "author-script" file, and sets
268 * state->author_name, state->author_email and state->author_date accordingly.
269 * Returns 0 on success, -1 if the file could not be parsed.
271 * The author script is of the format:
273 * GIT_AUTHOR_NAME='$author_name'
274 * GIT_AUTHOR_EMAIL='$author_email'
275 * GIT_AUTHOR_DATE='$author_date'
277 * where $author_name, $author_email and $author_date are quoted. We are strict
278 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
279 * script, and thus if the file differs from what this function expects, it is
280 * better to bail out than to do something that the user does not expect.
282 static int read_am_author_script(struct am_state
*state
)
284 const char *filename
= am_path(state
, "author-script");
286 assert(!state
->author_name
);
287 assert(!state
->author_email
);
288 assert(!state
->author_date
);
290 return read_author_script(filename
, &state
->author_name
,
291 &state
->author_email
, &state
->author_date
, 1);
295 * Saves state->author_name, state->author_email and state->author_date in the
296 * state directory's "author-script" file.
298 static void write_author_script(const struct am_state
*state
)
300 struct strbuf sb
= STRBUF_INIT
;
302 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
303 sq_quote_buf(&sb
, state
->author_name
);
304 strbuf_addch(&sb
, '\n');
306 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
307 sq_quote_buf(&sb
, state
->author_email
);
308 strbuf_addch(&sb
, '\n');
310 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
311 sq_quote_buf(&sb
, state
->author_date
);
312 strbuf_addch(&sb
, '\n');
314 write_state_text(state
, "author-script", sb
.buf
);
320 * Reads the commit message from the state directory's "final-commit" file,
321 * setting state->msg to its contents and state->msg_len to the length of its
324 * Returns 0 on success, -1 if the file does not exist.
326 static int read_commit_msg(struct am_state
*state
)
328 struct strbuf sb
= STRBUF_INIT
;
332 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
337 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
342 * Saves state->msg in the state directory's "final-commit" file.
344 static void write_commit_msg(const struct am_state
*state
)
346 const char *filename
= am_path(state
, "final-commit");
347 write_file_buf(filename
, state
->msg
, state
->msg_len
);
351 * Loads state from disk.
353 static void am_load(struct am_state
*state
)
355 struct strbuf sb
= STRBUF_INIT
;
357 if (read_state_file(&sb
, state
, "next", 1) < 0)
358 BUG("state file 'next' does not exist");
359 state
->cur
= strtol(sb
.buf
, NULL
, 10);
361 if (read_state_file(&sb
, state
, "last", 1) < 0)
362 BUG("state file 'last' does not exist");
363 state
->last
= strtol(sb
.buf
, NULL
, 10);
365 if (read_am_author_script(state
) < 0)
366 die(_("could not parse author script"));
368 read_commit_msg(state
);
370 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
371 oidclr(&state
->orig_commit
);
372 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
373 die(_("could not parse %s"), am_path(state
, "original-commit"));
375 read_state_file(&sb
, state
, "threeway", 1);
376 state
->threeway
= !strcmp(sb
.buf
, "t");
378 read_state_file(&sb
, state
, "quiet", 1);
379 state
->quiet
= !strcmp(sb
.buf
, "t");
381 read_state_file(&sb
, state
, "sign", 1);
382 state
->signoff
= !strcmp(sb
.buf
, "t");
384 read_state_file(&sb
, state
, "utf8", 1);
385 state
->utf8
= !strcmp(sb
.buf
, "t");
387 if (file_exists(am_path(state
, "rerere-autoupdate"))) {
388 read_state_file(&sb
, state
, "rerere-autoupdate", 1);
389 state
->allow_rerere_autoupdate
= strcmp(sb
.buf
, "t") ?
390 RERERE_NOAUTOUPDATE
: RERERE_AUTOUPDATE
;
392 state
->allow_rerere_autoupdate
= 0;
395 read_state_file(&sb
, state
, "keep", 1);
396 if (!strcmp(sb
.buf
, "t"))
397 state
->keep
= KEEP_TRUE
;
398 else if (!strcmp(sb
.buf
, "b"))
399 state
->keep
= KEEP_NON_PATCH
;
401 state
->keep
= KEEP_FALSE
;
403 read_state_file(&sb
, state
, "messageid", 1);
404 state
->message_id
= !strcmp(sb
.buf
, "t");
406 read_state_file(&sb
, state
, "scissors", 1);
407 if (!strcmp(sb
.buf
, "t"))
408 state
->scissors
= SCISSORS_TRUE
;
409 else if (!strcmp(sb
.buf
, "f"))
410 state
->scissors
= SCISSORS_FALSE
;
412 state
->scissors
= SCISSORS_UNSET
;
414 read_state_file(&sb
, state
, "quoted-cr", 1);
416 state
->quoted_cr
= quoted_cr_unset
;
417 else if (mailinfo_parse_quoted_cr_action(sb
.buf
, &state
->quoted_cr
) != 0)
418 die(_("could not parse %s"), am_path(state
, "quoted-cr"));
420 read_state_file(&sb
, state
, "apply-opt", 1);
421 strvec_clear(&state
->git_apply_opts
);
422 if (sq_dequote_to_strvec(sb
.buf
, &state
->git_apply_opts
) < 0)
423 die(_("could not parse %s"), am_path(state
, "apply-opt"));
425 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
431 * Removes the am_state directory, forcefully terminating the current am
434 static void am_destroy(const struct am_state
*state
)
436 struct strbuf sb
= STRBUF_INIT
;
438 strbuf_addstr(&sb
, state
->dir
);
439 remove_dir_recursively(&sb
, 0);
444 * Runs applypatch-msg hook. Returns its exit code.
446 static int run_applypatch_msg_hook(struct am_state
*state
)
451 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
454 FREE_AND_NULL(state
->msg
);
455 if (read_commit_msg(state
) < 0)
456 die(_("'%s' was deleted by the applypatch-msg hook"),
457 am_path(state
, "final-commit"));
464 * Runs post-rewrite hook. Returns it exit code.
466 static int run_post_rewrite_hook(const struct am_state
*state
)
468 struct child_process cp
= CHILD_PROCESS_INIT
;
469 const char *hook
= find_hook("post-rewrite");
475 strvec_push(&cp
.args
, hook
);
476 strvec_push(&cp
.args
, "rebase");
478 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
479 cp
.stdout_to_stderr
= 1;
480 cp
.trace2_hook_name
= "post-rewrite";
482 ret
= run_command(&cp
);
489 * Reads the state directory's "rewritten" file, and copies notes from the old
490 * commits listed in the file to their rewritten commits.
492 * Returns 0 on success, -1 on failure.
494 static int copy_notes_for_rebase(const struct am_state
*state
)
496 struct notes_rewrite_cfg
*c
;
497 struct strbuf sb
= STRBUF_INIT
;
498 const char *invalid_line
= _("Malformed input line: '%s'.");
499 const char *msg
= "Notes added by 'git rebase'";
503 assert(state
->rebasing
);
505 c
= init_copy_notes_for_rewrite("rebase");
509 fp
= xfopen(am_path(state
, "rewritten"), "r");
511 while (!strbuf_getline_lf(&sb
, fp
)) {
512 struct object_id from_obj
, to_obj
;
515 if (sb
.len
!= the_hash_algo
->hexsz
* 2 + 1) {
516 ret
= error(invalid_line
, sb
.buf
);
520 if (parse_oid_hex(sb
.buf
, &from_obj
, &p
)) {
521 ret
= error(invalid_line
, sb
.buf
);
526 ret
= error(invalid_line
, sb
.buf
);
530 if (get_oid_hex(p
+ 1, &to_obj
)) {
531 ret
= error(invalid_line
, sb
.buf
);
535 if (copy_note_for_rewrite(c
, &from_obj
, &to_obj
))
536 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
537 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
541 finish_copy_notes_for_rewrite(the_repository
, c
, msg
);
548 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
549 * non-indented lines and checking if they look like they begin with valid
550 * header field names.
552 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
554 static int is_mail(FILE *fp
)
556 const char *header_regex
= "^[!-9;-~]+:";
557 struct strbuf sb
= STRBUF_INIT
;
561 if (fseek(fp
, 0L, SEEK_SET
))
562 die_errno(_("fseek failed"));
564 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
565 die("invalid pattern: %s", header_regex
);
567 while (!strbuf_getline(&sb
, fp
)) {
569 break; /* End of header */
571 /* Ignore indented folded lines */
572 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
575 /* It's a header if it matches header_regex */
576 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
589 * Attempts to detect the patch_format of the patches contained in `paths`,
590 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
593 static int detect_patch_format(const char **paths
)
595 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
596 struct strbuf l1
= STRBUF_INIT
;
597 struct strbuf l2
= STRBUF_INIT
;
598 struct strbuf l3
= STRBUF_INIT
;
602 * We default to mbox format if input is from stdin and for directories
604 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
605 return PATCH_FORMAT_MBOX
;
608 * Otherwise, check the first few lines of the first patch, starting
609 * from the first non-blank line, to try to detect its format.
612 fp
= xfopen(*paths
, "r");
614 while (!strbuf_getline(&l1
, fp
)) {
619 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
620 ret
= PATCH_FORMAT_MBOX
;
624 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
625 ret
= PATCH_FORMAT_STGIT_SERIES
;
629 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
630 ret
= PATCH_FORMAT_HG
;
634 strbuf_getline(&l2
, fp
);
635 strbuf_getline(&l3
, fp
);
638 * If the second line is empty and the third is a From, Author or Date
639 * entry, this is likely an StGit patch.
641 if (l1
.len
&& !l2
.len
&&
642 (starts_with(l3
.buf
, "From:") ||
643 starts_with(l3
.buf
, "Author:") ||
644 starts_with(l3
.buf
, "Date:"))) {
645 ret
= PATCH_FORMAT_STGIT
;
649 if (l1
.len
&& is_mail(fp
)) {
650 ret
= PATCH_FORMAT_MBOX
;
663 * Splits out individual email patches from `paths`, where each path is either
664 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
666 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
667 int keep_cr
, int mboxrd
)
669 struct child_process cp
= CHILD_PROCESS_INIT
;
670 struct strbuf last
= STRBUF_INIT
;
674 strvec_push(&cp
.args
, "mailsplit");
675 strvec_pushf(&cp
.args
, "-d%d", state
->prec
);
676 strvec_pushf(&cp
.args
, "-o%s", state
->dir
);
677 strvec_push(&cp
.args
, "-b");
679 strvec_push(&cp
.args
, "--keep-cr");
681 strvec_push(&cp
.args
, "--mboxrd");
682 strvec_push(&cp
.args
, "--");
683 strvec_pushv(&cp
.args
, paths
);
685 ret
= capture_command(&cp
, &last
, 8);
690 state
->last
= strtol(last
.buf
, NULL
, 10);
693 strbuf_release(&last
);
698 * Callback signature for split_mail_conv(). The foreign patch should be
699 * read from `in`, and the converted patch (in RFC2822 mail format) should be
700 * written to `out`. Return 0 on success, or -1 on failure.
702 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
705 * Calls `fn` for each file in `paths` to convert the foreign patch to the
706 * RFC2822 mail format suitable for parsing with git-mailinfo.
708 * Returns 0 on success, -1 on failure.
710 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
711 const char **paths
, int keep_cr
)
713 static const char *stdin_only
[] = {"-", NULL
};
719 for (i
= 0; *paths
; paths
++, i
++) {
724 if (!strcmp(*paths
, "-"))
727 in
= fopen(*paths
, "r");
730 return error_errno(_("could not open '%s' for reading"),
733 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
735 out
= fopen(mail
, "w");
739 return error_errno(_("could not open '%s' for writing"),
743 ret
= fn(out
, in
, keep_cr
);
750 return error(_("could not parse patch '%s'"), *paths
);
759 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
760 * message suitable for parsing with git-mailinfo.
762 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
764 struct strbuf sb
= STRBUF_INIT
;
765 int subject_printed
= 0;
767 while (!strbuf_getline_lf(&sb
, in
)) {
770 if (str_isspace(sb
.buf
))
772 else if (skip_prefix(sb
.buf
, "Author:", &str
))
773 fprintf(out
, "From:%s\n", str
);
774 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
775 fprintf(out
, "%s\n", sb
.buf
);
776 else if (!subject_printed
) {
777 fprintf(out
, "Subject: %s\n", sb
.buf
);
780 fprintf(out
, "\n%s\n", sb
.buf
);
786 while (strbuf_fread(&sb
, 8192, in
) > 0) {
787 fwrite(sb
.buf
, 1, sb
.len
, out
);
796 * This function only supports a single StGit series file in `paths`.
798 * Given an StGit series file, converts the StGit patches in the series into
799 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
800 * the state directory.
802 * Returns 0 on success, -1 on failure.
804 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
807 const char *series_dir
;
808 char *series_dir_buf
;
810 struct strvec patches
= STRVEC_INIT
;
811 struct strbuf sb
= STRBUF_INIT
;
814 if (!paths
[0] || paths
[1])
815 return error(_("Only one StGIT patch series can be applied at once"));
817 series_dir_buf
= xstrdup(*paths
);
818 series_dir
= dirname(series_dir_buf
);
820 fp
= fopen(*paths
, "r");
822 return error_errno(_("could not open '%s' for reading"), *paths
);
824 while (!strbuf_getline_lf(&sb
, fp
)) {
826 continue; /* skip comment lines */
828 strvec_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
833 free(series_dir_buf
);
835 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.v
, keep_cr
);
837 strvec_clear(&patches
);
842 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
843 * message suitable for parsing with git-mailinfo.
845 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
847 struct strbuf sb
= STRBUF_INIT
;
850 while (!strbuf_getline_lf(&sb
, in
)) {
853 if (skip_prefix(sb
.buf
, "# User ", &str
))
854 fprintf(out
, "From: %s\n", str
);
855 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
856 timestamp_t timestamp
;
861 timestamp
= parse_timestamp(str
, &end
, 10);
863 rc
= error(_("invalid timestamp"));
867 if (!skip_prefix(end
, " ", &str
)) {
868 rc
= error(_("invalid Date line"));
873 tz
= strtol(str
, &end
, 10);
875 rc
= error(_("invalid timezone offset"));
880 rc
= error(_("invalid Date line"));
885 * mercurial's timezone is in seconds west of UTC,
886 * however git's timezone is in hours + minutes east of
889 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
893 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
894 } else if (starts_with(sb
.buf
, "# ")) {
897 fprintf(out
, "\n%s\n", sb
.buf
);
903 while (strbuf_fread(&sb
, 8192, in
) > 0) {
904 fwrite(sb
.buf
, 1, sb
.len
, out
);
913 * Splits a list of files/directories into individual email patches. Each path
914 * in `paths` must be a file/directory that is formatted according to
917 * Once split out, the individual email patches will be stored in the state
918 * directory, with each patch's filename being its index, padded to state->prec
921 * state->cur will be set to the index of the first mail, and state->last will
922 * be set to the index of the last mail.
924 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
925 * to disable this behavior, -1 to use the default configured setting.
927 * Returns 0 on success, -1 on failure.
929 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
930 const char **paths
, int keep_cr
)
934 git_config_get_bool("am.keepcr", &keep_cr
);
937 switch (patch_format
) {
938 case PATCH_FORMAT_MBOX
:
939 return split_mail_mbox(state
, paths
, keep_cr
, 0);
940 case PATCH_FORMAT_STGIT
:
941 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
942 case PATCH_FORMAT_STGIT_SERIES
:
943 return split_mail_stgit_series(state
, paths
, keep_cr
);
944 case PATCH_FORMAT_HG
:
945 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
946 case PATCH_FORMAT_MBOXRD
:
947 return split_mail_mbox(state
, paths
, keep_cr
, 1);
949 BUG("invalid patch_format");
955 * Setup a new am session for applying patches
957 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
958 const char **paths
, int keep_cr
)
960 struct object_id curr_head
;
962 struct strbuf sb
= STRBUF_INIT
;
965 patch_format
= detect_patch_format(paths
);
968 fprintf_ln(stderr
, _("Patch format detection failed."));
972 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
973 die_errno(_("failed to create directory '%s'"), state
->dir
);
974 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
976 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
978 die(_("Failed to split patches."));
984 write_state_bool(state
, "threeway", state
->threeway
);
985 write_state_bool(state
, "quiet", state
->quiet
);
986 write_state_bool(state
, "sign", state
->signoff
);
987 write_state_bool(state
, "utf8", state
->utf8
);
989 if (state
->allow_rerere_autoupdate
)
990 write_state_bool(state
, "rerere-autoupdate",
991 state
->allow_rerere_autoupdate
== RERERE_AUTOUPDATE
);
993 switch (state
->keep
) {
1000 case KEEP_NON_PATCH
:
1004 BUG("invalid value for state->keep");
1007 write_state_text(state
, "keep", str
);
1008 write_state_bool(state
, "messageid", state
->message_id
);
1010 switch (state
->scissors
) {
1011 case SCISSORS_UNSET
:
1014 case SCISSORS_FALSE
:
1021 BUG("invalid value for state->scissors");
1023 write_state_text(state
, "scissors", str
);
1025 switch (state
->quoted_cr
) {
1026 case quoted_cr_unset
:
1029 case quoted_cr_nowarn
:
1032 case quoted_cr_warn
:
1035 case quoted_cr_strip
:
1039 BUG("invalid value for state->quoted_cr");
1041 write_state_text(state
, "quoted-cr", str
);
1043 sq_quote_argv(&sb
, state
->git_apply_opts
.v
);
1044 write_state_text(state
, "apply-opt", sb
.buf
);
1046 if (state
->rebasing
)
1047 write_state_text(state
, "rebasing", "");
1049 write_state_text(state
, "applying", "");
1051 if (!get_oid("HEAD", &curr_head
)) {
1052 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1053 if (!state
->rebasing
)
1054 update_ref("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1055 UPDATE_REFS_DIE_ON_ERR
);
1057 write_state_text(state
, "abort-safety", "");
1058 if (!state
->rebasing
)
1059 delete_ref(NULL
, "ORIG_HEAD", NULL
, 0);
1063 * NOTE: Since the "next" and "last" files determine if an am_state
1064 * session is in progress, they should be written last.
1067 write_state_count(state
, "next", state
->cur
);
1068 write_state_count(state
, "last", state
->last
);
1070 strbuf_release(&sb
);
1074 * Increments the patch pointer, and cleans am_state for the application of the
1077 static void am_next(struct am_state
*state
)
1079 struct object_id head
;
1081 FREE_AND_NULL(state
->author_name
);
1082 FREE_AND_NULL(state
->author_email
);
1083 FREE_AND_NULL(state
->author_date
);
1084 FREE_AND_NULL(state
->msg
);
1087 unlink(am_path(state
, "author-script"));
1088 unlink(am_path(state
, "final-commit"));
1090 oidclr(&state
->orig_commit
);
1091 unlink(am_path(state
, "original-commit"));
1092 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
1094 if (!get_oid("HEAD", &head
))
1095 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1097 write_state_text(state
, "abort-safety", "");
1100 write_state_count(state
, "next", state
->cur
);
1104 * Returns the filename of the current patch email.
1106 static const char *msgnum(const struct am_state
*state
)
1108 static struct strbuf sb
= STRBUF_INIT
;
1111 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1117 * Dies with a user-friendly message on how to proceed after resolving the
1118 * problem. This message can be overridden with state->resolvemsg.
1120 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1122 if (state
->resolvemsg
) {
1123 printf_ln("%s", state
->resolvemsg
);
1125 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1127 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1128 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1129 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1136 * Appends signoff to the "msg" field of the am_state.
1138 static void am_append_signoff(struct am_state
*state
)
1140 struct strbuf sb
= STRBUF_INIT
;
1142 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1143 append_signoff(&sb
, 0, 0);
1144 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1148 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1149 * state->msg will be set to the patch message. state->author_name,
1150 * state->author_email and state->author_date will be set to the patch author's
1151 * name, email and date respectively. The patch body will be written to the
1152 * state directory's "patch" file.
1154 * Returns 1 if the patch should be skipped, 0 otherwise.
1156 static int parse_mail(struct am_state
*state
, const char *mail
)
1159 struct strbuf sb
= STRBUF_INIT
;
1160 struct strbuf msg
= STRBUF_INIT
;
1161 struct strbuf author_name
= STRBUF_INIT
;
1162 struct strbuf author_date
= STRBUF_INIT
;
1163 struct strbuf author_email
= STRBUF_INIT
;
1167 setup_mailinfo(&mi
);
1170 mi
.metainfo_charset
= get_commit_output_encoding();
1172 mi
.metainfo_charset
= NULL
;
1174 switch (state
->keep
) {
1178 mi
.keep_subject
= 1;
1180 case KEEP_NON_PATCH
:
1181 mi
.keep_non_patch_brackets_in_subject
= 1;
1184 BUG("invalid value for state->keep");
1187 if (state
->message_id
)
1188 mi
.add_message_id
= 1;
1190 switch (state
->scissors
) {
1191 case SCISSORS_UNSET
:
1193 case SCISSORS_FALSE
:
1194 mi
.use_scissors
= 0;
1197 mi
.use_scissors
= 1;
1200 BUG("invalid value for state->scissors");
1203 switch (state
->quoted_cr
) {
1204 case quoted_cr_unset
:
1206 case quoted_cr_nowarn
:
1207 case quoted_cr_warn
:
1208 case quoted_cr_strip
:
1209 mi
.quoted_cr
= state
->quoted_cr
;
1212 BUG("invalid value for state->quoted_cr");
1215 mi
.input
= xfopen(mail
, "r");
1216 mi
.output
= xfopen(am_path(state
, "info"), "w");
1217 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1218 die("could not parse patch");
1223 if (mi
.format_flowed
)
1224 warning(_("Patch sent with format=flowed; "
1225 "space at the end of lines might be lost."));
1227 /* Extract message and author information */
1228 fp
= xfopen(am_path(state
, "info"), "r");
1229 while (!strbuf_getline_lf(&sb
, fp
)) {
1232 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1234 strbuf_addch(&msg
, '\n');
1235 strbuf_addstr(&msg
, x
);
1236 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1237 strbuf_addstr(&author_name
, x
);
1238 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1239 strbuf_addstr(&author_email
, x
);
1240 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1241 strbuf_addstr(&author_date
, x
);
1245 /* Skip pine's internal folder data */
1246 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1251 if (is_empty_or_missing_file(am_path(state
, "patch"))) {
1252 printf_ln(_("Patch is empty."));
1253 die_user_resolve(state
);
1256 strbuf_addstr(&msg
, "\n\n");
1257 strbuf_addbuf(&msg
, &mi
.log_message
);
1258 strbuf_stripspace(&msg
, 0);
1260 assert(!state
->author_name
);
1261 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1263 assert(!state
->author_email
);
1264 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1266 assert(!state
->author_date
);
1267 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1269 assert(!state
->msg
);
1270 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1273 strbuf_release(&msg
);
1274 strbuf_release(&author_date
);
1275 strbuf_release(&author_email
);
1276 strbuf_release(&author_name
);
1277 strbuf_release(&sb
);
1278 clear_mailinfo(&mi
);
1283 * Sets commit_id to the commit hash where the mail was generated from.
1284 * Returns 0 on success, -1 on failure.
1286 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1288 struct strbuf sb
= STRBUF_INIT
;
1289 FILE *fp
= xfopen(mail
, "r");
1293 if (strbuf_getline_lf(&sb
, fp
) ||
1294 !skip_prefix(sb
.buf
, "From ", &x
) ||
1295 get_oid_hex(x
, commit_id
) < 0)
1298 strbuf_release(&sb
);
1304 * Sets state->msg, state->author_name, state->author_email, state->author_date
1305 * to the commit's respective info.
1307 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1309 const char *buffer
, *ident_line
, *msg
;
1311 struct ident_split id
;
1313 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1315 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1317 die(_("missing author line in commit %s"),
1318 oid_to_hex(&commit
->object
.oid
));
1319 if (split_ident_line(&id
, ident_line
, ident_len
) < 0)
1320 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1322 assert(!state
->author_name
);
1324 state
->author_name
=
1325 xmemdupz(id
.name_begin
, id
.name_end
- id
.name_begin
);
1327 state
->author_name
= xstrdup("");
1329 assert(!state
->author_email
);
1331 state
->author_email
=
1332 xmemdupz(id
.mail_begin
, id
.mail_end
- id
.mail_begin
);
1334 state
->author_email
= xstrdup("");
1336 assert(!state
->author_date
);
1337 state
->author_date
= xstrdup(show_ident_date(&id
, DATE_MODE(NORMAL
)));
1339 assert(!state
->msg
);
1340 msg
= strstr(buffer
, "\n\n");
1342 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1343 state
->msg
= xstrdup(msg
+ 2);
1344 state
->msg_len
= strlen(state
->msg
);
1345 unuse_commit_buffer(commit
, buffer
);
1349 * Writes `commit` as a patch to the state directory's "patch" file.
1351 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1353 struct rev_info rev_info
;
1356 fp
= xfopen(am_path(state
, "patch"), "w");
1357 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1359 rev_info
.abbrev
= 0;
1360 rev_info
.disable_stdin
= 1;
1361 rev_info
.show_root_diff
= 1;
1362 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1363 rev_info
.no_commit_id
= 1;
1364 rev_info
.diffopt
.flags
.binary
= 1;
1365 rev_info
.diffopt
.flags
.full_index
= 1;
1366 rev_info
.diffopt
.use_color
= 0;
1367 rev_info
.diffopt
.file
= fp
;
1368 rev_info
.diffopt
.close_file
= 1;
1369 add_pending_object(&rev_info
, &commit
->object
, "");
1370 diff_setup_done(&rev_info
.diffopt
);
1371 log_tree_commit(&rev_info
, commit
);
1375 * Writes the diff of the index against HEAD as a patch to the state
1376 * directory's "patch" file.
1378 static void write_index_patch(const struct am_state
*state
)
1381 struct object_id head
;
1382 struct rev_info rev_info
;
1385 if (!get_oid("HEAD", &head
)) {
1386 struct commit
*commit
= lookup_commit_or_die(&head
, "HEAD");
1387 tree
= get_commit_tree(commit
);
1389 tree
= lookup_tree(the_repository
,
1390 the_repository
->hash_algo
->empty_tree
);
1392 fp
= xfopen(am_path(state
, "patch"), "w");
1393 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1395 rev_info
.disable_stdin
= 1;
1396 rev_info
.no_commit_id
= 1;
1397 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1398 rev_info
.diffopt
.use_color
= 0;
1399 rev_info
.diffopt
.file
= fp
;
1400 rev_info
.diffopt
.close_file
= 1;
1401 add_pending_object(&rev_info
, &tree
->object
, "");
1402 diff_setup_done(&rev_info
.diffopt
);
1403 run_diff_index(&rev_info
, 1);
1407 * Like parse_mail(), but parses the mail by looking up its commit ID
1408 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1411 * state->orig_commit will be set to the original commit ID.
1413 * Will always return 0 as the patch should never be skipped.
1415 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1417 struct commit
*commit
;
1418 struct object_id commit_oid
;
1420 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1421 die(_("could not parse %s"), mail
);
1423 commit
= lookup_commit_or_die(&commit_oid
, mail
);
1425 get_commit_info(state
, commit
);
1427 write_commit_patch(state
, commit
);
1429 oidcpy(&state
->orig_commit
, &commit_oid
);
1430 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1431 update_ref("am", "REBASE_HEAD", &commit_oid
,
1432 NULL
, REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
1438 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1439 * `index_file` is not NULL, the patch will be applied to that index.
1441 static int run_apply(const struct am_state
*state
, const char *index_file
)
1443 struct strvec apply_paths
= STRVEC_INIT
;
1444 struct strvec apply_opts
= STRVEC_INIT
;
1445 struct apply_state apply_state
;
1447 int force_apply
= 0;
1450 if (init_apply_state(&apply_state
, the_repository
, NULL
))
1451 BUG("init_apply_state() failed");
1453 strvec_push(&apply_opts
, "apply");
1454 strvec_pushv(&apply_opts
, state
->git_apply_opts
.v
);
1456 opts_left
= apply_parse_options(apply_opts
.nr
, apply_opts
.v
,
1457 &apply_state
, &force_apply
, &options
,
1461 die("unknown option passed through to git apply");
1464 apply_state
.index_file
= index_file
;
1465 apply_state
.cached
= 1;
1467 apply_state
.check_index
= 1;
1470 * If we are allowed to fall back on 3-way merge, don't give false
1471 * errors during the initial attempt.
1473 if (state
->threeway
&& !index_file
)
1474 apply_state
.apply_verbosity
= verbosity_silent
;
1476 if (check_apply_state(&apply_state
, force_apply
))
1477 BUG("check_apply_state() failed");
1479 strvec_push(&apply_paths
, am_path(state
, "patch"));
1481 res
= apply_all_patches(&apply_state
, apply_paths
.nr
, apply_paths
.v
, options
);
1483 strvec_clear(&apply_paths
);
1484 strvec_clear(&apply_opts
);
1485 clear_apply_state(&apply_state
);
1491 /* Reload index as apply_all_patches() will have modified it. */
1493 read_cache_from(index_file
);
1500 * Builds an index that contains just the blobs needed for a 3way merge.
1502 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1504 struct child_process cp
= CHILD_PROCESS_INIT
;
1507 strvec_push(&cp
.args
, "apply");
1508 strvec_pushv(&cp
.args
, state
->git_apply_opts
.v
);
1509 strvec_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1510 strvec_push(&cp
.args
, am_path(state
, "patch"));
1512 if (run_command(&cp
))
1519 * Attempt a threeway merge, using index_path as the temporary index.
1521 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1523 struct object_id orig_tree
, their_tree
, our_tree
;
1524 const struct object_id
*bases
[1] = { &orig_tree
};
1525 struct merge_options o
;
1526 struct commit
*result
;
1527 char *their_tree_name
;
1529 if (get_oid("HEAD", &our_tree
) < 0)
1530 oidcpy(&our_tree
, the_hash_algo
->empty_tree
);
1532 if (build_fake_ancestor(state
, index_path
))
1533 return error("could not build fake ancestor");
1536 read_cache_from(index_path
);
1538 if (write_index_as_tree(&orig_tree
, &the_index
, index_path
, 0, NULL
))
1539 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1541 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1543 if (!state
->quiet
) {
1545 * List paths that needed 3-way fallback, so that the user can
1546 * review them with extra care to spot mismerges.
1548 struct rev_info rev_info
;
1550 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1551 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1552 rev_info
.diffopt
.filter
|= diff_filter_bit('A');
1553 rev_info
.diffopt
.filter
|= diff_filter_bit('M');
1554 add_pending_oid(&rev_info
, "HEAD", &our_tree
, 0);
1555 diff_setup_done(&rev_info
.diffopt
);
1556 run_diff_index(&rev_info
, 1);
1559 if (run_apply(state
, index_path
))
1560 return error(_("Did you hand edit your patch?\n"
1561 "It does not apply to blobs recorded in its index."));
1563 if (write_index_as_tree(&their_tree
, &the_index
, index_path
, 0, NULL
))
1564 return error("could not write tree");
1566 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1572 * This is not so wrong. Depending on which base we picked, orig_tree
1573 * may be wildly different from ours, but their_tree has the same set of
1574 * wildly different changes in parts the patch did not touch, so
1575 * recursive ends up canceling them, saying that we reverted all those
1579 init_merge_options(&o
, the_repository
);
1582 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1583 o
.branch2
= their_tree_name
;
1584 o
.detect_directory_renames
= MERGE_DIRECTORY_RENAMES_NONE
;
1589 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1590 repo_rerere(the_repository
, state
->allow_rerere_autoupdate
);
1591 free(their_tree_name
);
1592 return error(_("Failed to merge in the changes."));
1595 free(their_tree_name
);
1600 * Commits the current index with state->msg as the commit message and
1601 * state->author_name, state->author_email and state->author_date as the author
1604 static void do_commit(const struct am_state
*state
)
1606 struct object_id tree
, parent
, commit
;
1607 const struct object_id
*old_oid
;
1608 struct commit_list
*parents
= NULL
;
1609 const char *reflog_msg
, *author
, *committer
= NULL
;
1610 struct strbuf sb
= STRBUF_INIT
;
1612 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1615 if (write_cache_as_tree(&tree
, 0, NULL
))
1616 die(_("git write-tree failed to write a tree"));
1618 if (!get_oid_commit("HEAD", &parent
)) {
1620 commit_list_insert(lookup_commit(the_repository
, &parent
),
1624 say(state
, stderr
, _("applying to an empty history"));
1627 author
= fmt_ident(state
->author_name
, state
->author_email
,
1629 state
->ignore_date
? NULL
: state
->author_date
,
1632 if (state
->committer_date_is_author_date
)
1633 committer
= fmt_ident(getenv("GIT_COMMITTER_NAME"),
1634 getenv("GIT_COMMITTER_EMAIL"),
1635 WANT_COMMITTER_IDENT
,
1636 state
->ignore_date
? NULL
1637 : state
->author_date
,
1640 if (commit_tree_extended(state
->msg
, state
->msg_len
, &tree
, parents
,
1641 &commit
, author
, committer
, state
->sign_commit
,
1643 die(_("failed to write commit object"));
1645 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1649 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1652 update_ref(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1653 UPDATE_REFS_DIE_ON_ERR
);
1655 if (state
->rebasing
) {
1656 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1658 assert(!is_null_oid(&state
->orig_commit
));
1659 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1660 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1664 run_hook_le(NULL
, "post-applypatch", NULL
);
1666 strbuf_release(&sb
);
1670 * Validates the am_state for resuming -- the "msg" and authorship fields must
1673 static void validate_resume_state(const struct am_state
*state
)
1676 die(_("cannot resume: %s does not exist."),
1677 am_path(state
, "final-commit"));
1679 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1680 die(_("cannot resume: %s does not exist."),
1681 am_path(state
, "author-script"));
1685 * Interactively prompt the user on whether the current patch should be
1688 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1691 static int do_interactive(struct am_state
*state
)
1698 puts(_("Commit Body is:"));
1699 puts("--------------------------");
1700 printf("%s", state
->msg
);
1701 puts("--------------------------");
1704 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1705 * in your translation. The program will only accept English
1706 * input at this point.
1708 printf(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "));
1709 if (!fgets(reply
, sizeof(reply
), stdin
))
1710 die("unable to read from stdin; aborting");
1712 if (*reply
== 'y' || *reply
== 'Y') {
1714 } else if (*reply
== 'a' || *reply
== 'A') {
1715 state
->interactive
= 0;
1717 } else if (*reply
== 'n' || *reply
== 'N') {
1719 } else if (*reply
== 'e' || *reply
== 'E') {
1720 struct strbuf msg
= STRBUF_INIT
;
1722 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1724 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1726 strbuf_release(&msg
);
1727 } else if (*reply
== 'v' || *reply
== 'V') {
1728 const char *pager
= git_pager(1);
1729 struct child_process cp
= CHILD_PROCESS_INIT
;
1733 prepare_pager_args(&cp
, pager
);
1734 strvec_push(&cp
.args
, am_path(state
, "patch"));
1741 * Applies all queued mail.
1743 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1744 * well as the state directory's "patch" file is used as-is for applying the
1745 * patch and committing it.
1747 static void am_run(struct am_state
*state
, int resume
)
1749 struct strbuf sb
= STRBUF_INIT
;
1751 unlink(am_path(state
, "dirtyindex"));
1753 if (refresh_and_write_cache(REFRESH_QUIET
, 0, 0) < 0)
1754 die(_("unable to write index file"));
1756 if (repo_index_has_changes(the_repository
, NULL
, &sb
)) {
1757 write_state_bool(state
, "dirtyindex", 1);
1758 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1761 strbuf_release(&sb
);
1763 while (state
->cur
<= state
->last
) {
1764 const char *mail
= am_path(state
, msgnum(state
));
1769 if (!file_exists(mail
))
1773 validate_resume_state(state
);
1777 if (state
->rebasing
)
1778 skip
= parse_mail_rebase(state
, mail
);
1780 skip
= parse_mail(state
, mail
);
1783 goto next
; /* mail should be skipped */
1786 am_append_signoff(state
);
1788 write_author_script(state
);
1789 write_commit_msg(state
);
1792 if (state
->interactive
&& do_interactive(state
))
1795 if (run_applypatch_msg_hook(state
))
1798 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1800 apply_status
= run_apply(state
, NULL
);
1802 if (apply_status
&& state
->threeway
) {
1803 struct strbuf sb
= STRBUF_INIT
;
1805 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1806 apply_status
= fall_back_threeway(state
, sb
.buf
);
1807 strbuf_release(&sb
);
1810 * Applying the patch to an earlier tree and merging
1811 * the result may have produced the same tree as ours.
1813 if (!apply_status
&&
1814 !repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1815 say(state
, stdout
, _("No changes -- Patch already applied."));
1821 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1822 linelen(state
->msg
), state
->msg
);
1824 if (advice_enabled(ADVICE_AM_WORK_DIR
))
1825 advise(_("Use 'git am --show-current-patch=diff' to see the failed patch"));
1827 die_user_resolve(state
);
1840 if (!is_empty_or_missing_file(am_path(state
, "rewritten"))) {
1841 assert(state
->rebasing
);
1842 copy_notes_for_rebase(state
);
1843 run_post_rewrite_hook(state
);
1847 * In rebasing mode, it's up to the caller to take care of
1850 if (!state
->rebasing
) {
1852 run_auto_maintenance(state
->quiet
);
1857 * Resume the current am session after patch application failure. The user did
1858 * all the hard work, and we do not have to do any patch application. Just
1859 * trust and commit what the user has in the index and working tree.
1861 static void am_resolve(struct am_state
*state
)
1863 validate_resume_state(state
);
1865 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1867 if (!repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1868 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1869 "If there is nothing left to stage, chances are that something else\n"
1870 "already introduced the same changes; you might want to skip this patch."));
1871 die_user_resolve(state
);
1874 if (unmerged_cache()) {
1875 printf_ln(_("You still have unmerged paths in your index.\n"
1876 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1877 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1878 die_user_resolve(state
);
1881 if (state
->interactive
) {
1882 write_index_patch(state
);
1883 if (do_interactive(state
))
1887 repo_rerere(the_repository
, 0);
1898 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1899 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1902 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1904 struct lock_file lock_file
= LOCK_INIT
;
1905 struct unpack_trees_options opts
;
1906 struct tree_desc t
[2];
1908 if (parse_tree(head
) || parse_tree(remote
))
1911 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1913 refresh_cache(REFRESH_QUIET
);
1915 memset(&opts
, 0, sizeof(opts
));
1917 opts
.src_index
= &the_index
;
1918 opts
.dst_index
= &the_index
;
1921 opts
.reset
= reset
? UNPACK_RESET_PROTECT_UNTRACKED
: 0;
1922 opts
.preserve_ignored
= 0; /* FIXME: !overwrite_ignore */
1923 opts
.fn
= twoway_merge
;
1924 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1925 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1927 if (unpack_trees(2, t
, &opts
)) {
1928 rollback_lock_file(&lock_file
);
1932 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1933 die(_("unable to write new index file"));
1939 * Merges a tree into the index. The index's stat info will take precedence
1940 * over the merged tree's. Returns 0 on success, -1 on failure.
1942 static int merge_tree(struct tree
*tree
)
1944 struct lock_file lock_file
= LOCK_INIT
;
1945 struct unpack_trees_options opts
;
1946 struct tree_desc t
[1];
1948 if (parse_tree(tree
))
1951 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1953 memset(&opts
, 0, sizeof(opts
));
1955 opts
.src_index
= &the_index
;
1956 opts
.dst_index
= &the_index
;
1958 opts
.fn
= oneway_merge
;
1959 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
1961 if (unpack_trees(1, t
, &opts
)) {
1962 rollback_lock_file(&lock_file
);
1966 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1967 die(_("unable to write new index file"));
1973 * Clean the index without touching entries that are not modified between
1974 * `head` and `remote`.
1976 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
1978 struct tree
*head_tree
, *remote_tree
, *index_tree
;
1979 struct object_id index
;
1981 head_tree
= parse_tree_indirect(head
);
1983 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
1985 remote_tree
= parse_tree_indirect(remote
);
1987 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
1989 read_cache_unmerged();
1991 if (fast_forward_to(head_tree
, head_tree
, 1))
1994 if (write_cache_as_tree(&index
, 0, NULL
))
1997 index_tree
= parse_tree_indirect(&index
);
1999 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
2001 if (fast_forward_to(index_tree
, remote_tree
, 0))
2004 if (merge_tree(remote_tree
))
2007 remove_branch_state(the_repository
, 0);
2013 * Resets rerere's merge resolution metadata.
2015 static void am_rerere_clear(void)
2017 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
2018 rerere_clear(the_repository
, &merge_rr
);
2019 string_list_clear(&merge_rr
, 1);
2023 * Resume the current am session by skipping the current patch.
2025 static void am_skip(struct am_state
*state
)
2027 struct object_id head
;
2031 if (get_oid("HEAD", &head
))
2032 oidcpy(&head
, the_hash_algo
->empty_tree
);
2034 if (clean_index(&head
, &head
))
2035 die(_("failed to clean index"));
2037 if (state
->rebasing
) {
2038 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
2040 assert(!is_null_oid(&state
->orig_commit
));
2041 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
2042 fprintf(fp
, "%s\n", oid_to_hex(&head
));
2052 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2054 * It is not safe to reset HEAD when:
2055 * 1. git-am previously failed because the index was dirty.
2056 * 2. HEAD has moved since git-am previously failed.
2058 static int safe_to_abort(const struct am_state
*state
)
2060 struct strbuf sb
= STRBUF_INIT
;
2061 struct object_id abort_safety
, head
;
2063 if (file_exists(am_path(state
, "dirtyindex")))
2066 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2067 if (get_oid_hex(sb
.buf
, &abort_safety
))
2068 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2070 oidclr(&abort_safety
);
2071 strbuf_release(&sb
);
2073 if (get_oid("HEAD", &head
))
2076 if (oideq(&head
, &abort_safety
))
2079 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2080 "Not rewinding to ORIG_HEAD"));
2086 * Aborts the current am session if it is safe to do so.
2088 static void am_abort(struct am_state
*state
)
2090 struct object_id curr_head
, orig_head
;
2091 int has_curr_head
, has_orig_head
;
2094 if (!safe_to_abort(state
)) {
2101 curr_branch
= resolve_refdup("HEAD", 0, &curr_head
, NULL
);
2102 has_curr_head
= curr_branch
&& !is_null_oid(&curr_head
);
2104 oidcpy(&curr_head
, the_hash_algo
->empty_tree
);
2106 has_orig_head
= !get_oid("ORIG_HEAD", &orig_head
);
2108 oidcpy(&orig_head
, the_hash_algo
->empty_tree
);
2110 if (clean_index(&curr_head
, &orig_head
))
2111 die(_("failed to clean index"));
2114 update_ref("am --abort", "HEAD", &orig_head
,
2115 has_curr_head
? &curr_head
: NULL
, 0,
2116 UPDATE_REFS_DIE_ON_ERR
);
2117 else if (curr_branch
)
2118 delete_ref(NULL
, curr_branch
, NULL
, REF_NO_DEREF
);
2124 static int show_patch(struct am_state
*state
, enum show_patch_type sub_mode
)
2126 struct strbuf sb
= STRBUF_INIT
;
2127 const char *patch_path
;
2130 if (!is_null_oid(&state
->orig_commit
)) {
2131 const char *av
[4] = { "show", NULL
, "--", NULL
};
2135 av
[1] = new_oid_str
= xstrdup(oid_to_hex(&state
->orig_commit
));
2136 ret
= run_command_v_opt(av
, RUN_GIT_CMD
);
2142 case SHOW_PATCH_RAW
:
2143 patch_path
= am_path(state
, msgnum(state
));
2145 case SHOW_PATCH_DIFF
:
2146 patch_path
= am_path(state
, "patch");
2149 BUG("invalid mode for --show-current-patch");
2152 len
= strbuf_read_file(&sb
, patch_path
, 0);
2154 die_errno(_("failed to read '%s'"), patch_path
);
2157 write_in_full(1, sb
.buf
, sb
.len
);
2158 strbuf_release(&sb
);
2163 * parse_options() callback that validates and sets opt->value to the
2164 * PATCH_FORMAT_* enum value corresponding to `arg`.
2166 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2168 int *opt_value
= opt
->value
;
2171 *opt_value
= PATCH_FORMAT_UNKNOWN
;
2172 else if (!strcmp(arg
, "mbox"))
2173 *opt_value
= PATCH_FORMAT_MBOX
;
2174 else if (!strcmp(arg
, "stgit"))
2175 *opt_value
= PATCH_FORMAT_STGIT
;
2176 else if (!strcmp(arg
, "stgit-series"))
2177 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2178 else if (!strcmp(arg
, "hg"))
2179 *opt_value
= PATCH_FORMAT_HG
;
2180 else if (!strcmp(arg
, "mboxrd"))
2181 *opt_value
= PATCH_FORMAT_MBOXRD
;
2183 * Please update $__git_patchformat in git-completion.bash
2184 * when you add new options
2187 return error(_("Invalid value for --patch-format: %s"), arg
);
2201 struct resume_mode
{
2202 enum resume_type mode
;
2203 enum show_patch_type sub_mode
;
2206 static int parse_opt_show_current_patch(const struct option
*opt
, const char *arg
, int unset
)
2208 int *opt_value
= opt
->value
;
2209 struct resume_mode
*resume
= container_of(opt_value
, struct resume_mode
, mode
);
2212 * Please update $__git_showcurrentpatch in git-completion.bash
2213 * when you add new options
2215 const char *valid_modes
[] = {
2216 [SHOW_PATCH_DIFF
] = "diff",
2217 [SHOW_PATCH_RAW
] = "raw"
2219 int new_value
= SHOW_PATCH_RAW
;
2221 BUG_ON_OPT_NEG(unset
);
2224 for (new_value
= 0; new_value
< ARRAY_SIZE(valid_modes
); new_value
++) {
2225 if (!strcmp(arg
, valid_modes
[new_value
]))
2228 if (new_value
>= ARRAY_SIZE(valid_modes
))
2229 return error(_("Invalid value for --show-current-patch: %s"), arg
);
2232 if (resume
->mode
== RESUME_SHOW_PATCH
&& new_value
!= resume
->sub_mode
)
2233 return error(_("--show-current-patch=%s is incompatible with "
2234 "--show-current-patch=%s"),
2235 arg
, valid_modes
[resume
->sub_mode
]);
2237 resume
->mode
= RESUME_SHOW_PATCH
;
2238 resume
->sub_mode
= new_value
;
2242 static int git_am_config(const char *k
, const char *v
, void *cb
)
2246 status
= git_gpg_config(k
, v
, NULL
);
2250 return git_default_config(k
, v
, NULL
);
2253 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2255 struct am_state state
;
2258 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2259 struct resume_mode resume
= { .mode
= RESUME_FALSE
};
2263 const char * const usage
[] = {
2264 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2265 N_("git am [<options>] (--continue | --skip | --abort)"),
2269 struct option options
[] = {
2270 OPT_BOOL('i', "interactive", &state
.interactive
,
2271 N_("run interactively")),
2272 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2273 N_("historical option -- no-op")),
2274 OPT_BOOL('3', "3way", &state
.threeway
,
2275 N_("allow fall back on 3way merging if needed")),
2276 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2277 OPT_SET_INT('s', "signoff", &state
.signoff
,
2278 N_("add a Signed-off-by trailer to the commit message"),
2280 OPT_BOOL('u', "utf8", &state
.utf8
,
2281 N_("recode into utf8 (default)")),
2282 OPT_SET_INT('k', "keep", &state
.keep
,
2283 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2284 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2285 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2286 OPT_BOOL('m', "message-id", &state
.message_id
,
2287 N_("pass -m flag to git-mailinfo")),
2288 OPT_SET_INT_F(0, "keep-cr", &keep_cr
,
2289 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2290 1, PARSE_OPT_NONEG
),
2291 OPT_SET_INT_F(0, "no-keep-cr", &keep_cr
,
2292 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2293 0, PARSE_OPT_NONEG
),
2294 OPT_BOOL('c', "scissors", &state
.scissors
,
2295 N_("strip everything before a scissors line")),
2296 OPT_CALLBACK_F(0, "quoted-cr", &state
.quoted_cr
, N_("action"),
2297 N_("pass it through git-mailinfo"),
2298 PARSE_OPT_NONEG
, am_option_parse_quoted_cr
),
2299 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2300 N_("pass it through git-apply"),
2302 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2303 N_("pass it through git-apply"),
2305 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2306 N_("pass it through git-apply"),
2308 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2309 N_("pass it through git-apply"),
2311 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2312 N_("pass it through git-apply"),
2314 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2315 N_("pass it through git-apply"),
2317 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2318 N_("pass it through git-apply"),
2320 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2321 N_("pass it through git-apply"),
2323 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2324 N_("format the patch(es) are in"),
2325 parse_opt_patchformat
),
2326 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2327 N_("pass it through git-apply"),
2329 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2330 N_("override error message when patch failure occurs")),
2331 OPT_CMDMODE(0, "continue", &resume
.mode
,
2332 N_("continue applying patches after resolving a conflict"),
2334 OPT_CMDMODE('r', "resolved", &resume
.mode
,
2335 N_("synonyms for --continue"),
2337 OPT_CMDMODE(0, "skip", &resume
.mode
,
2338 N_("skip the current patch"),
2340 OPT_CMDMODE(0, "abort", &resume
.mode
,
2341 N_("restore the original branch and abort the patching operation"),
2343 OPT_CMDMODE(0, "quit", &resume
.mode
,
2344 N_("abort the patching operation but keep HEAD where it is"),
2346 { OPTION_CALLBACK
, 0, "show-current-patch", &resume
.mode
,
2348 N_("show the patch being applied"),
2349 PARSE_OPT_CMDMODE
| PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
| PARSE_OPT_LITERAL_ARGHELP
,
2350 parse_opt_show_current_patch
, RESUME_SHOW_PATCH
},
2351 OPT_BOOL(0, "committer-date-is-author-date",
2352 &state
.committer_date_is_author_date
,
2353 N_("lie about committer date")),
2354 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2355 N_("use current timestamp for author date")),
2356 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2357 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2358 N_("GPG-sign commits"),
2359 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2360 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2361 N_("(internal use for git-rebase)")),
2365 if (argc
== 2 && !strcmp(argv
[1], "-h"))
2366 usage_with_options(usage
, options
);
2368 git_config(git_am_config
, NULL
);
2370 am_state_init(&state
);
2372 in_progress
= am_in_progress(&state
);
2376 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2379 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2380 "it will be removed. Please do not use it anymore."));
2382 /* Ensure a valid committer ident can be constructed */
2383 git_committer_info(IDENT_STRICT
);
2385 if (repo_read_index_preload(the_repository
, NULL
, 0) < 0)
2386 die(_("failed to read the index"));
2390 * Catch user error to feed us patches when there is a session
2393 * 1. mbox path(s) are provided on the command-line.
2394 * 2. stdin is not a tty: the user is trying to feed us a patch
2395 * from standard input. This is somewhat unreliable -- stdin
2396 * could be /dev/null for example and the caller did not
2397 * intend to feed us a patch but wanted to continue
2400 if (argc
|| (resume
.mode
== RESUME_FALSE
&& !isatty(0)))
2401 die(_("previous rebase directory %s still exists but mbox given."),
2404 if (resume
.mode
== RESUME_FALSE
)
2405 resume
.mode
= RESUME_APPLY
;
2407 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2408 am_append_signoff(&state
);
2410 struct strvec paths
= STRVEC_INIT
;
2414 * Handle stray state directory in the independent-run case. In
2415 * the --rebasing case, it is up to the caller to take care of
2416 * stray directories.
2418 if (file_exists(state
.dir
) && !state
.rebasing
) {
2419 if (resume
.mode
== RESUME_ABORT
|| resume
.mode
== RESUME_QUIT
) {
2421 am_state_release(&state
);
2425 die(_("Stray %s directory found.\n"
2426 "Use \"git am --abort\" to remove it."),
2431 die(_("Resolve operation not in progress, we are not resuming."));
2433 for (i
= 0; i
< argc
; i
++) {
2434 if (is_absolute_path(argv
[i
]) || !prefix
)
2435 strvec_push(&paths
, argv
[i
]);
2437 strvec_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2440 if (state
.interactive
&& !paths
.nr
)
2441 die(_("interactive mode requires patches on the command line"));
2443 am_setup(&state
, patch_format
, paths
.v
, keep_cr
);
2445 strvec_clear(&paths
);
2448 switch (resume
.mode
) {
2455 case RESUME_RESOLVED
:
2468 case RESUME_SHOW_PATCH
:
2469 ret
= show_patch(&state
, resume
.sub_mode
);
2472 BUG("invalid resume value");
2475 am_state_release(&state
);