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"
40 * Returns the length of the first line of msg.
42 static int linelen(const char *msg
)
44 return strchrnul(msg
, '\n') - msg
;
48 * Returns true if `str` consists of only whitespace, false otherwise.
50 static int str_isspace(const char *str
)
60 PATCH_FORMAT_UNKNOWN
= 0,
63 PATCH_FORMAT_STGIT_SERIES
,
70 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
71 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
76 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
77 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
83 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
86 enum show_patch_type
{
92 STOP_ON_EMPTY_COMMIT
= 0, /* output errors and stop in the middle of an am session */
93 DROP_EMPTY_COMMIT
, /* skip with a notice message, unless "--quiet" has been passed */
94 KEEP_EMPTY_COMMIT
, /* keep recording as empty commits */
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 int quoted_cr
; /* enum quoted_cr_action */
128 int empty_type
; /* enum empty_action */
129 struct strvec git_apply_opts
;
130 const char *resolvemsg
;
131 int committer_date_is_author_date
;
133 int allow_rerere_autoupdate
;
134 const char *sign_commit
;
139 * Initializes am_state with the default values.
141 static void am_state_init(struct am_state
*state
)
145 memset(state
, 0, sizeof(*state
));
147 state
->dir
= git_pathdup("rebase-apply");
151 git_config_get_bool("am.threeway", &state
->threeway
);
155 git_config_get_bool("am.messageid", &state
->message_id
);
157 state
->scissors
= SCISSORS_UNSET
;
158 state
->quoted_cr
= quoted_cr_unset
;
160 strvec_init(&state
->git_apply_opts
);
162 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
163 state
->sign_commit
= gpgsign
? "" : NULL
;
167 * Releases memory allocated by an am_state.
169 static void am_state_release(struct am_state
*state
)
172 free(state
->author_name
);
173 free(state
->author_email
);
174 free(state
->author_date
);
176 strvec_clear(&state
->git_apply_opts
);
179 static int am_option_parse_quoted_cr(const struct option
*opt
,
180 const char *arg
, int unset
)
182 BUG_ON_OPT_NEG(unset
);
184 if (mailinfo_parse_quoted_cr_action(arg
, opt
->value
) != 0)
185 return error(_("bad action '%s' for '%s'"), arg
, "--quoted-cr");
189 static int am_option_parse_empty(const struct option
*opt
,
190 const char *arg
, int unset
)
192 int *opt_value
= opt
->value
;
194 BUG_ON_OPT_NEG(unset
);
196 if (!strcmp(arg
, "stop"))
197 *opt_value
= STOP_ON_EMPTY_COMMIT
;
198 else if (!strcmp(arg
, "drop"))
199 *opt_value
= DROP_EMPTY_COMMIT
;
200 else if (!strcmp(arg
, "keep"))
201 *opt_value
= KEEP_EMPTY_COMMIT
;
203 return error(_("invalid value for '%s': '%s'"), "--empty", arg
);
209 * Returns path relative to the am_state directory.
211 static inline const char *am_path(const struct am_state
*state
, const char *path
)
213 return mkpath("%s/%s", state
->dir
, path
);
217 * For convenience to call write_file()
219 static void write_state_text(const struct am_state
*state
,
220 const char *name
, const char *string
)
222 write_file(am_path(state
, name
), "%s", string
);
225 static void write_state_count(const struct am_state
*state
,
226 const char *name
, int value
)
228 write_file(am_path(state
, name
), "%d", value
);
231 static void write_state_bool(const struct am_state
*state
,
232 const char *name
, int value
)
234 write_state_text(state
, name
, value
? "t" : "f");
238 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
241 __attribute__((format (printf
, 3, 4)))
242 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
248 vfprintf(fp
, fmt
, ap
);
255 * Returns 1 if there is an am session in progress, 0 otherwise.
257 static int am_in_progress(const struct am_state
*state
)
261 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
263 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
265 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
271 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
272 * number of bytes read on success, -1 if the file does not exist. If `trim` is
273 * set, trailing whitespace will be removed.
275 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
276 const char *file
, int trim
)
280 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
290 die_errno(_("could not read '%s'"), am_path(state
, file
));
294 * Reads and parses the state directory's "author-script" file, and sets
295 * state->author_name, state->author_email and state->author_date accordingly.
296 * Returns 0 on success, -1 if the file could not be parsed.
298 * The author script is of the format:
300 * GIT_AUTHOR_NAME='$author_name'
301 * GIT_AUTHOR_EMAIL='$author_email'
302 * GIT_AUTHOR_DATE='$author_date'
304 * where $author_name, $author_email and $author_date are quoted. We are strict
305 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
306 * script, and thus if the file differs from what this function expects, it is
307 * better to bail out than to do something that the user does not expect.
309 static int read_am_author_script(struct am_state
*state
)
311 const char *filename
= am_path(state
, "author-script");
313 assert(!state
->author_name
);
314 assert(!state
->author_email
);
315 assert(!state
->author_date
);
317 return read_author_script(filename
, &state
->author_name
,
318 &state
->author_email
, &state
->author_date
, 1);
322 * Saves state->author_name, state->author_email and state->author_date in the
323 * state directory's "author-script" file.
325 static void write_author_script(const struct am_state
*state
)
327 struct strbuf sb
= STRBUF_INIT
;
329 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
330 sq_quote_buf(&sb
, state
->author_name
);
331 strbuf_addch(&sb
, '\n');
333 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
334 sq_quote_buf(&sb
, state
->author_email
);
335 strbuf_addch(&sb
, '\n');
337 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
338 sq_quote_buf(&sb
, state
->author_date
);
339 strbuf_addch(&sb
, '\n');
341 write_state_text(state
, "author-script", sb
.buf
);
347 * Reads the commit message from the state directory's "final-commit" file,
348 * setting state->msg to its contents and state->msg_len to the length of its
351 * Returns 0 on success, -1 if the file does not exist.
353 static int read_commit_msg(struct am_state
*state
)
355 struct strbuf sb
= STRBUF_INIT
;
359 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
364 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
369 * Saves state->msg in the state directory's "final-commit" file.
371 static void write_commit_msg(const struct am_state
*state
)
373 const char *filename
= am_path(state
, "final-commit");
374 write_file_buf(filename
, state
->msg
, state
->msg_len
);
378 * Loads state from disk.
380 static void am_load(struct am_state
*state
)
382 struct strbuf sb
= STRBUF_INIT
;
384 if (read_state_file(&sb
, state
, "next", 1) < 0)
385 BUG("state file 'next' does not exist");
386 state
->cur
= strtol(sb
.buf
, NULL
, 10);
388 if (read_state_file(&sb
, state
, "last", 1) < 0)
389 BUG("state file 'last' does not exist");
390 state
->last
= strtol(sb
.buf
, NULL
, 10);
392 if (read_am_author_script(state
) < 0)
393 die(_("could not parse author script"));
395 read_commit_msg(state
);
397 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
398 oidclr(&state
->orig_commit
);
399 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
400 die(_("could not parse %s"), am_path(state
, "original-commit"));
402 read_state_file(&sb
, state
, "threeway", 1);
403 state
->threeway
= !strcmp(sb
.buf
, "t");
405 read_state_file(&sb
, state
, "quiet", 1);
406 state
->quiet
= !strcmp(sb
.buf
, "t");
408 read_state_file(&sb
, state
, "sign", 1);
409 state
->signoff
= !strcmp(sb
.buf
, "t");
411 read_state_file(&sb
, state
, "utf8", 1);
412 state
->utf8
= !strcmp(sb
.buf
, "t");
414 if (file_exists(am_path(state
, "rerere-autoupdate"))) {
415 read_state_file(&sb
, state
, "rerere-autoupdate", 1);
416 state
->allow_rerere_autoupdate
= strcmp(sb
.buf
, "t") ?
417 RERERE_NOAUTOUPDATE
: RERERE_AUTOUPDATE
;
419 state
->allow_rerere_autoupdate
= 0;
422 read_state_file(&sb
, state
, "keep", 1);
423 if (!strcmp(sb
.buf
, "t"))
424 state
->keep
= KEEP_TRUE
;
425 else if (!strcmp(sb
.buf
, "b"))
426 state
->keep
= KEEP_NON_PATCH
;
428 state
->keep
= KEEP_FALSE
;
430 read_state_file(&sb
, state
, "messageid", 1);
431 state
->message_id
= !strcmp(sb
.buf
, "t");
433 read_state_file(&sb
, state
, "scissors", 1);
434 if (!strcmp(sb
.buf
, "t"))
435 state
->scissors
= SCISSORS_TRUE
;
436 else if (!strcmp(sb
.buf
, "f"))
437 state
->scissors
= SCISSORS_FALSE
;
439 state
->scissors
= SCISSORS_UNSET
;
441 read_state_file(&sb
, state
, "quoted-cr", 1);
443 state
->quoted_cr
= quoted_cr_unset
;
444 else if (mailinfo_parse_quoted_cr_action(sb
.buf
, &state
->quoted_cr
) != 0)
445 die(_("could not parse %s"), am_path(state
, "quoted-cr"));
447 read_state_file(&sb
, state
, "apply-opt", 1);
448 strvec_clear(&state
->git_apply_opts
);
449 if (sq_dequote_to_strvec(sb
.buf
, &state
->git_apply_opts
) < 0)
450 die(_("could not parse %s"), am_path(state
, "apply-opt"));
452 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
458 * Removes the am_state directory, forcefully terminating the current am
461 static void am_destroy(const struct am_state
*state
)
463 struct strbuf sb
= STRBUF_INIT
;
465 strbuf_addstr(&sb
, state
->dir
);
466 remove_dir_recursively(&sb
, 0);
471 * Runs applypatch-msg hook. Returns its exit code.
473 static int run_applypatch_msg_hook(struct am_state
*state
)
478 ret
= run_hooks_l("applypatch-msg", am_path(state
, "final-commit"), NULL
);
481 FREE_AND_NULL(state
->msg
);
482 if (read_commit_msg(state
) < 0)
483 die(_("'%s' was deleted by the applypatch-msg hook"),
484 am_path(state
, "final-commit"));
491 * Runs post-rewrite hook. Returns it exit code.
493 static int run_post_rewrite_hook(const struct am_state
*state
)
495 struct child_process cp
= CHILD_PROCESS_INIT
;
496 const char *hook
= find_hook("post-rewrite");
502 strvec_push(&cp
.args
, hook
);
503 strvec_push(&cp
.args
, "rebase");
505 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
506 cp
.stdout_to_stderr
= 1;
507 cp
.trace2_hook_name
= "post-rewrite";
509 ret
= run_command(&cp
);
516 * Reads the state directory's "rewritten" file, and copies notes from the old
517 * commits listed in the file to their rewritten commits.
519 * Returns 0 on success, -1 on failure.
521 static int copy_notes_for_rebase(const struct am_state
*state
)
523 struct notes_rewrite_cfg
*c
;
524 struct strbuf sb
= STRBUF_INIT
;
525 const char *invalid_line
= _("Malformed input line: '%s'.");
526 const char *msg
= "Notes added by 'git rebase'";
530 assert(state
->rebasing
);
532 c
= init_copy_notes_for_rewrite("rebase");
536 fp
= xfopen(am_path(state
, "rewritten"), "r");
538 while (!strbuf_getline_lf(&sb
, fp
)) {
539 struct object_id from_obj
, to_obj
;
542 if (sb
.len
!= the_hash_algo
->hexsz
* 2 + 1) {
543 ret
= error(invalid_line
, sb
.buf
);
547 if (parse_oid_hex(sb
.buf
, &from_obj
, &p
)) {
548 ret
= error(invalid_line
, sb
.buf
);
553 ret
= error(invalid_line
, sb
.buf
);
557 if (get_oid_hex(p
+ 1, &to_obj
)) {
558 ret
= error(invalid_line
, sb
.buf
);
562 if (copy_note_for_rewrite(c
, &from_obj
, &to_obj
))
563 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
564 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
568 finish_copy_notes_for_rewrite(the_repository
, c
, msg
);
575 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
576 * non-indented lines and checking if they look like they begin with valid
577 * header field names.
579 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
581 static int is_mail(FILE *fp
)
583 const char *header_regex
= "^[!-9;-~]+:";
584 struct strbuf sb
= STRBUF_INIT
;
588 if (fseek(fp
, 0L, SEEK_SET
))
589 die_errno(_("fseek failed"));
591 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
592 die("invalid pattern: %s", header_regex
);
594 while (!strbuf_getline(&sb
, fp
)) {
596 break; /* End of header */
598 /* Ignore indented folded lines */
599 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
602 /* It's a header if it matches header_regex */
603 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
616 * Attempts to detect the patch_format of the patches contained in `paths`,
617 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
620 static int detect_patch_format(const char **paths
)
622 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
623 struct strbuf l1
= STRBUF_INIT
;
624 struct strbuf l2
= STRBUF_INIT
;
625 struct strbuf l3
= STRBUF_INIT
;
629 * We default to mbox format if input is from stdin and for directories
631 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
632 return PATCH_FORMAT_MBOX
;
635 * Otherwise, check the first few lines of the first patch, starting
636 * from the first non-blank line, to try to detect its format.
639 fp
= xfopen(*paths
, "r");
641 while (!strbuf_getline(&l1
, fp
)) {
646 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
647 ret
= PATCH_FORMAT_MBOX
;
651 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
652 ret
= PATCH_FORMAT_STGIT_SERIES
;
656 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
657 ret
= PATCH_FORMAT_HG
;
661 strbuf_getline(&l2
, fp
);
662 strbuf_getline(&l3
, fp
);
665 * If the second line is empty and the third is a From, Author or Date
666 * entry, this is likely an StGit patch.
668 if (l1
.len
&& !l2
.len
&&
669 (starts_with(l3
.buf
, "From:") ||
670 starts_with(l3
.buf
, "Author:") ||
671 starts_with(l3
.buf
, "Date:"))) {
672 ret
= PATCH_FORMAT_STGIT
;
676 if (l1
.len
&& is_mail(fp
)) {
677 ret
= PATCH_FORMAT_MBOX
;
690 * Splits out individual email patches from `paths`, where each path is either
691 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
693 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
694 int keep_cr
, int mboxrd
)
696 struct child_process cp
= CHILD_PROCESS_INIT
;
697 struct strbuf last
= STRBUF_INIT
;
701 strvec_push(&cp
.args
, "mailsplit");
702 strvec_pushf(&cp
.args
, "-d%d", state
->prec
);
703 strvec_pushf(&cp
.args
, "-o%s", state
->dir
);
704 strvec_push(&cp
.args
, "-b");
706 strvec_push(&cp
.args
, "--keep-cr");
708 strvec_push(&cp
.args
, "--mboxrd");
709 strvec_push(&cp
.args
, "--");
710 strvec_pushv(&cp
.args
, paths
);
712 ret
= capture_command(&cp
, &last
, 8);
717 state
->last
= strtol(last
.buf
, NULL
, 10);
720 strbuf_release(&last
);
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 strvec patches
= STRVEC_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 strvec_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
.v
, keep_cr
);
864 strvec_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
;
877 while (!strbuf_getline_lf(&sb
, in
)) {
880 if (skip_prefix(sb
.buf
, "# User ", &str
))
881 fprintf(out
, "From: %s\n", str
);
882 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
883 timestamp_t timestamp
;
888 timestamp
= parse_timestamp(str
, &end
, 10);
890 rc
= error(_("invalid timestamp"));
894 if (!skip_prefix(end
, " ", &str
)) {
895 rc
= error(_("invalid Date line"));
900 tz
= strtol(str
, &end
, 10);
902 rc
= error(_("invalid timezone offset"));
907 rc
= error(_("invalid Date line"));
912 * mercurial's timezone is in seconds west of UTC,
913 * however git's timezone is in hours + minutes east of
916 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
920 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
921 } else if (starts_with(sb
.buf
, "# ")) {
924 fprintf(out
, "\n%s\n", sb
.buf
);
930 while (strbuf_fread(&sb
, 8192, in
) > 0) {
931 fwrite(sb
.buf
, 1, sb
.len
, out
);
940 * Splits a list of files/directories into individual email patches. Each path
941 * in `paths` must be a file/directory that is formatted according to
944 * Once split out, the individual email patches will be stored in the state
945 * directory, with each patch's filename being its index, padded to state->prec
948 * state->cur will be set to the index of the first mail, and state->last will
949 * be set to the index of the last mail.
951 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
952 * to disable this behavior, -1 to use the default configured setting.
954 * Returns 0 on success, -1 on failure.
956 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
957 const char **paths
, int keep_cr
)
961 git_config_get_bool("am.keepcr", &keep_cr
);
964 switch (patch_format
) {
965 case PATCH_FORMAT_MBOX
:
966 return split_mail_mbox(state
, paths
, keep_cr
, 0);
967 case PATCH_FORMAT_STGIT
:
968 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
969 case PATCH_FORMAT_STGIT_SERIES
:
970 return split_mail_stgit_series(state
, paths
, keep_cr
);
971 case PATCH_FORMAT_HG
:
972 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
973 case PATCH_FORMAT_MBOXRD
:
974 return split_mail_mbox(state
, paths
, keep_cr
, 1);
976 BUG("invalid patch_format");
982 * Setup a new am session for applying patches
984 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
985 const char **paths
, int keep_cr
)
987 struct object_id curr_head
;
989 struct strbuf sb
= STRBUF_INIT
;
992 patch_format
= detect_patch_format(paths
);
995 fprintf_ln(stderr
, _("Patch format detection failed."));
999 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
1000 die_errno(_("failed to create directory '%s'"), state
->dir
);
1001 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
1003 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
1005 die(_("Failed to split patches."));
1008 if (state
->rebasing
)
1009 state
->threeway
= 1;
1011 write_state_bool(state
, "threeway", state
->threeway
);
1012 write_state_bool(state
, "quiet", state
->quiet
);
1013 write_state_bool(state
, "sign", state
->signoff
);
1014 write_state_bool(state
, "utf8", state
->utf8
);
1016 if (state
->allow_rerere_autoupdate
)
1017 write_state_bool(state
, "rerere-autoupdate",
1018 state
->allow_rerere_autoupdate
== RERERE_AUTOUPDATE
);
1020 switch (state
->keep
) {
1027 case KEEP_NON_PATCH
:
1031 BUG("invalid value for state->keep");
1034 write_state_text(state
, "keep", str
);
1035 write_state_bool(state
, "messageid", state
->message_id
);
1037 switch (state
->scissors
) {
1038 case SCISSORS_UNSET
:
1041 case SCISSORS_FALSE
:
1048 BUG("invalid value for state->scissors");
1050 write_state_text(state
, "scissors", str
);
1052 switch (state
->quoted_cr
) {
1053 case quoted_cr_unset
:
1056 case quoted_cr_nowarn
:
1059 case quoted_cr_warn
:
1062 case quoted_cr_strip
:
1066 BUG("invalid value for state->quoted_cr");
1068 write_state_text(state
, "quoted-cr", str
);
1070 sq_quote_argv(&sb
, state
->git_apply_opts
.v
);
1071 write_state_text(state
, "apply-opt", sb
.buf
);
1073 if (state
->rebasing
)
1074 write_state_text(state
, "rebasing", "");
1076 write_state_text(state
, "applying", "");
1078 if (!get_oid("HEAD", &curr_head
)) {
1079 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1080 if (!state
->rebasing
)
1081 update_ref("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1082 UPDATE_REFS_DIE_ON_ERR
);
1084 write_state_text(state
, "abort-safety", "");
1085 if (!state
->rebasing
)
1086 delete_ref(NULL
, "ORIG_HEAD", NULL
, 0);
1090 * NOTE: Since the "next" and "last" files determine if an am_state
1091 * session is in progress, they should be written last.
1094 write_state_count(state
, "next", state
->cur
);
1095 write_state_count(state
, "last", state
->last
);
1097 strbuf_release(&sb
);
1101 * Increments the patch pointer, and cleans am_state for the application of the
1104 static void am_next(struct am_state
*state
)
1106 struct object_id head
;
1108 FREE_AND_NULL(state
->author_name
);
1109 FREE_AND_NULL(state
->author_email
);
1110 FREE_AND_NULL(state
->author_date
);
1111 FREE_AND_NULL(state
->msg
);
1114 unlink(am_path(state
, "author-script"));
1115 unlink(am_path(state
, "final-commit"));
1117 oidclr(&state
->orig_commit
);
1118 unlink(am_path(state
, "original-commit"));
1119 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
1121 if (!get_oid("HEAD", &head
))
1122 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1124 write_state_text(state
, "abort-safety", "");
1127 write_state_count(state
, "next", state
->cur
);
1131 * Returns the filename of the current patch email.
1133 static const char *msgnum(const struct am_state
*state
)
1135 static struct strbuf sb
= STRBUF_INIT
;
1138 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1144 * Dies with a user-friendly message on how to proceed after resolving the
1145 * problem. This message can be overridden with state->resolvemsg.
1147 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1149 if (state
->resolvemsg
) {
1150 printf_ln("%s", state
->resolvemsg
);
1152 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1154 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1155 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1157 if (advice_enabled(ADVICE_AM_WORK_DIR
) &&
1158 is_empty_or_missing_file(am_path(state
, "patch")) &&
1159 !repo_index_has_changes(the_repository
, NULL
, NULL
))
1160 printf_ln(_("To record the empty patch as an empty commit, run \"%s --allow-empty\"."), cmdline
);
1162 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1169 * Appends signoff to the "msg" field of the am_state.
1171 static void am_append_signoff(struct am_state
*state
)
1173 struct strbuf sb
= STRBUF_INIT
;
1175 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1176 append_signoff(&sb
, 0, 0);
1177 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1181 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1182 * state->msg will be set to the patch message. state->author_name,
1183 * state->author_email and state->author_date will be set to the patch author's
1184 * name, email and date respectively. The patch body will be written to the
1185 * state directory's "patch" file.
1187 * Returns 1 if the patch should be skipped, 0 otherwise.
1189 static int parse_mail(struct am_state
*state
, const char *mail
)
1192 struct strbuf sb
= STRBUF_INIT
;
1193 struct strbuf msg
= STRBUF_INIT
;
1194 struct strbuf author_name
= STRBUF_INIT
;
1195 struct strbuf author_date
= STRBUF_INIT
;
1196 struct strbuf author_email
= STRBUF_INIT
;
1200 setup_mailinfo(&mi
);
1203 mi
.metainfo_charset
= get_commit_output_encoding();
1205 mi
.metainfo_charset
= NULL
;
1207 switch (state
->keep
) {
1211 mi
.keep_subject
= 1;
1213 case KEEP_NON_PATCH
:
1214 mi
.keep_non_patch_brackets_in_subject
= 1;
1217 BUG("invalid value for state->keep");
1220 if (state
->message_id
)
1221 mi
.add_message_id
= 1;
1223 switch (state
->scissors
) {
1224 case SCISSORS_UNSET
:
1226 case SCISSORS_FALSE
:
1227 mi
.use_scissors
= 0;
1230 mi
.use_scissors
= 1;
1233 BUG("invalid value for state->scissors");
1236 switch (state
->quoted_cr
) {
1237 case quoted_cr_unset
:
1239 case quoted_cr_nowarn
:
1240 case quoted_cr_warn
:
1241 case quoted_cr_strip
:
1242 mi
.quoted_cr
= state
->quoted_cr
;
1245 BUG("invalid value for state->quoted_cr");
1248 mi
.input
= xfopen(mail
, "r");
1249 mi
.output
= xfopen(am_path(state
, "info"), "w");
1250 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1251 die("could not parse patch");
1256 if (mi
.format_flowed
)
1257 warning(_("Patch sent with format=flowed; "
1258 "space at the end of lines might be lost."));
1260 /* Extract message and author information */
1261 fp
= xfopen(am_path(state
, "info"), "r");
1262 while (!strbuf_getline_lf(&sb
, fp
)) {
1265 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1267 strbuf_addch(&msg
, '\n');
1268 strbuf_addstr(&msg
, x
);
1269 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1270 strbuf_addstr(&author_name
, x
);
1271 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1272 strbuf_addstr(&author_email
, x
);
1273 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1274 strbuf_addstr(&author_date
, x
);
1278 /* Skip pine's internal folder data */
1279 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1284 strbuf_addstr(&msg
, "\n\n");
1285 strbuf_addbuf(&msg
, &mi
.log_message
);
1286 strbuf_stripspace(&msg
, 0);
1288 assert(!state
->author_name
);
1289 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1291 assert(!state
->author_email
);
1292 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1294 assert(!state
->author_date
);
1295 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1297 assert(!state
->msg
);
1298 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1301 strbuf_release(&msg
);
1302 strbuf_release(&author_date
);
1303 strbuf_release(&author_email
);
1304 strbuf_release(&author_name
);
1305 strbuf_release(&sb
);
1306 clear_mailinfo(&mi
);
1311 * Sets commit_id to the commit hash where the mail was generated from.
1312 * Returns 0 on success, -1 on failure.
1314 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1316 struct strbuf sb
= STRBUF_INIT
;
1317 FILE *fp
= xfopen(mail
, "r");
1321 if (strbuf_getline_lf(&sb
, fp
) ||
1322 !skip_prefix(sb
.buf
, "From ", &x
) ||
1323 get_oid_hex(x
, commit_id
) < 0)
1326 strbuf_release(&sb
);
1332 * Sets state->msg, state->author_name, state->author_email, state->author_date
1333 * to the commit's respective info.
1335 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1337 const char *buffer
, *ident_line
, *msg
;
1339 struct ident_split id
;
1341 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1343 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1345 die(_("missing author line in commit %s"),
1346 oid_to_hex(&commit
->object
.oid
));
1347 if (split_ident_line(&id
, ident_line
, ident_len
) < 0)
1348 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1350 assert(!state
->author_name
);
1352 state
->author_name
=
1353 xmemdupz(id
.name_begin
, id
.name_end
- id
.name_begin
);
1355 state
->author_name
= xstrdup("");
1357 assert(!state
->author_email
);
1359 state
->author_email
=
1360 xmemdupz(id
.mail_begin
, id
.mail_end
- id
.mail_begin
);
1362 state
->author_email
= xstrdup("");
1364 assert(!state
->author_date
);
1365 state
->author_date
= xstrdup(show_ident_date(&id
, DATE_MODE(NORMAL
)));
1367 assert(!state
->msg
);
1368 msg
= strstr(buffer
, "\n\n");
1370 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1371 state
->msg
= xstrdup(msg
+ 2);
1372 state
->msg_len
= strlen(state
->msg
);
1373 unuse_commit_buffer(commit
, buffer
);
1377 * Writes `commit` as a patch to the state directory's "patch" file.
1379 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1381 struct rev_info rev_info
;
1384 fp
= xfopen(am_path(state
, "patch"), "w");
1385 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1387 rev_info
.abbrev
= 0;
1388 rev_info
.disable_stdin
= 1;
1389 rev_info
.show_root_diff
= 1;
1390 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1391 rev_info
.no_commit_id
= 1;
1392 rev_info
.diffopt
.flags
.binary
= 1;
1393 rev_info
.diffopt
.flags
.full_index
= 1;
1394 rev_info
.diffopt
.use_color
= 0;
1395 rev_info
.diffopt
.file
= fp
;
1396 rev_info
.diffopt
.close_file
= 1;
1397 add_pending_object(&rev_info
, &commit
->object
, "");
1398 diff_setup_done(&rev_info
.diffopt
);
1399 log_tree_commit(&rev_info
, commit
);
1400 release_revisions(&rev_info
);
1404 * Writes the diff of the index against HEAD as a patch to the state
1405 * directory's "patch" file.
1407 static void write_index_patch(const struct am_state
*state
)
1410 struct object_id head
;
1411 struct rev_info rev_info
;
1414 if (!get_oid("HEAD", &head
)) {
1415 struct commit
*commit
= lookup_commit_or_die(&head
, "HEAD");
1416 tree
= get_commit_tree(commit
);
1418 tree
= lookup_tree(the_repository
,
1419 the_repository
->hash_algo
->empty_tree
);
1421 fp
= xfopen(am_path(state
, "patch"), "w");
1422 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1424 rev_info
.disable_stdin
= 1;
1425 rev_info
.no_commit_id
= 1;
1426 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1427 rev_info
.diffopt
.use_color
= 0;
1428 rev_info
.diffopt
.file
= fp
;
1429 rev_info
.diffopt
.close_file
= 1;
1430 add_pending_object(&rev_info
, &tree
->object
, "");
1431 diff_setup_done(&rev_info
.diffopt
);
1432 run_diff_index(&rev_info
, 1);
1433 release_revisions(&rev_info
);
1437 * Like parse_mail(), but parses the mail by looking up its commit ID
1438 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1441 * state->orig_commit will be set to the original commit ID.
1443 * Will always return 0 as the patch should never be skipped.
1445 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1447 struct commit
*commit
;
1448 struct object_id commit_oid
;
1450 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1451 die(_("could not parse %s"), mail
);
1453 commit
= lookup_commit_or_die(&commit_oid
, mail
);
1455 get_commit_info(state
, commit
);
1457 write_commit_patch(state
, commit
);
1459 oidcpy(&state
->orig_commit
, &commit_oid
);
1460 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1461 update_ref("am", "REBASE_HEAD", &commit_oid
,
1462 NULL
, REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
1468 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1469 * `index_file` is not NULL, the patch will be applied to that index.
1471 static int run_apply(const struct am_state
*state
, const char *index_file
)
1473 struct strvec apply_paths
= STRVEC_INIT
;
1474 struct strvec apply_opts
= STRVEC_INIT
;
1475 struct apply_state apply_state
;
1477 int force_apply
= 0;
1480 if (init_apply_state(&apply_state
, the_repository
, NULL
))
1481 BUG("init_apply_state() failed");
1483 strvec_push(&apply_opts
, "apply");
1484 strvec_pushv(&apply_opts
, state
->git_apply_opts
.v
);
1486 opts_left
= apply_parse_options(apply_opts
.nr
, apply_opts
.v
,
1487 &apply_state
, &force_apply
, &options
,
1491 die("unknown option passed through to git apply");
1494 apply_state
.index_file
= index_file
;
1495 apply_state
.cached
= 1;
1497 apply_state
.check_index
= 1;
1500 * If we are allowed to fall back on 3-way merge, don't give false
1501 * errors during the initial attempt.
1503 if (state
->threeway
&& !index_file
)
1504 apply_state
.apply_verbosity
= verbosity_silent
;
1506 if (check_apply_state(&apply_state
, force_apply
))
1507 BUG("check_apply_state() failed");
1509 strvec_push(&apply_paths
, am_path(state
, "patch"));
1511 res
= apply_all_patches(&apply_state
, apply_paths
.nr
, apply_paths
.v
, options
);
1513 strvec_clear(&apply_paths
);
1514 strvec_clear(&apply_opts
);
1515 clear_apply_state(&apply_state
);
1521 /* Reload index as apply_all_patches() will have modified it. */
1523 read_cache_from(index_file
);
1530 * Builds an index that contains just the blobs needed for a 3way merge.
1532 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1534 struct child_process cp
= CHILD_PROCESS_INIT
;
1537 strvec_push(&cp
.args
, "apply");
1538 strvec_pushv(&cp
.args
, state
->git_apply_opts
.v
);
1539 strvec_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1540 strvec_push(&cp
.args
, am_path(state
, "patch"));
1542 if (run_command(&cp
))
1549 * Attempt a threeway merge, using index_path as the temporary index.
1551 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1553 struct object_id orig_tree
, their_tree
, our_tree
;
1554 const struct object_id
*bases
[1] = { &orig_tree
};
1555 struct merge_options o
;
1556 struct commit
*result
;
1557 char *their_tree_name
;
1559 if (get_oid("HEAD", &our_tree
) < 0)
1560 oidcpy(&our_tree
, the_hash_algo
->empty_tree
);
1562 if (build_fake_ancestor(state
, index_path
))
1563 return error("could not build fake ancestor");
1566 read_cache_from(index_path
);
1568 if (write_index_as_tree(&orig_tree
, &the_index
, index_path
, 0, NULL
))
1569 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1571 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1573 if (!state
->quiet
) {
1575 * List paths that needed 3-way fallback, so that the user can
1576 * review them with extra care to spot mismerges.
1578 struct rev_info rev_info
;
1580 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1581 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1582 rev_info
.diffopt
.filter
|= diff_filter_bit('A');
1583 rev_info
.diffopt
.filter
|= diff_filter_bit('M');
1584 add_pending_oid(&rev_info
, "HEAD", &our_tree
, 0);
1585 diff_setup_done(&rev_info
.diffopt
);
1586 run_diff_index(&rev_info
, 1);
1587 release_revisions(&rev_info
);
1590 if (run_apply(state
, index_path
))
1591 return error(_("Did you hand edit your patch?\n"
1592 "It does not apply to blobs recorded in its index."));
1594 if (write_index_as_tree(&their_tree
, &the_index
, index_path
, 0, NULL
))
1595 return error("could not write tree");
1597 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1603 * This is not so wrong. Depending on which base we picked, orig_tree
1604 * may be wildly different from ours, but their_tree has the same set of
1605 * wildly different changes in parts the patch did not touch, so
1606 * recursive ends up canceling them, saying that we reverted all those
1610 init_merge_options(&o
, the_repository
);
1613 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1614 o
.branch2
= their_tree_name
;
1615 o
.detect_directory_renames
= MERGE_DIRECTORY_RENAMES_NONE
;
1620 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1621 repo_rerere(the_repository
, state
->allow_rerere_autoupdate
);
1622 free(their_tree_name
);
1623 return error(_("Failed to merge in the changes."));
1626 free(their_tree_name
);
1631 * Commits the current index with state->msg as the commit message and
1632 * state->author_name, state->author_email and state->author_date as the author
1635 static void do_commit(const struct am_state
*state
)
1637 struct object_id tree
, parent
, commit
;
1638 const struct object_id
*old_oid
;
1639 struct commit_list
*parents
= NULL
;
1640 const char *reflog_msg
, *author
, *committer
= NULL
;
1641 struct strbuf sb
= STRBUF_INIT
;
1643 if (run_hooks("pre-applypatch"))
1646 if (write_cache_as_tree(&tree
, 0, NULL
))
1647 die(_("git write-tree failed to write a tree"));
1649 if (!get_oid_commit("HEAD", &parent
)) {
1651 commit_list_insert(lookup_commit(the_repository
, &parent
),
1655 say(state
, stderr
, _("applying to an empty history"));
1658 author
= fmt_ident(state
->author_name
, state
->author_email
,
1660 state
->ignore_date
? NULL
: state
->author_date
,
1663 if (state
->committer_date_is_author_date
)
1664 committer
= fmt_ident(getenv("GIT_COMMITTER_NAME"),
1665 getenv("GIT_COMMITTER_EMAIL"),
1666 WANT_COMMITTER_IDENT
,
1667 state
->ignore_date
? NULL
1668 : state
->author_date
,
1671 if (commit_tree_extended(state
->msg
, state
->msg_len
, &tree
, parents
,
1672 &commit
, author
, committer
, state
->sign_commit
,
1674 die(_("failed to write commit object"));
1676 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1680 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1683 update_ref(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1684 UPDATE_REFS_DIE_ON_ERR
);
1686 if (state
->rebasing
) {
1687 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1689 assert(!is_null_oid(&state
->orig_commit
));
1690 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1691 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1695 run_hooks("post-applypatch");
1697 strbuf_release(&sb
);
1701 * Validates the am_state for resuming -- the "msg" and authorship fields must
1704 static void validate_resume_state(const struct am_state
*state
)
1707 die(_("cannot resume: %s does not exist."),
1708 am_path(state
, "final-commit"));
1710 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1711 die(_("cannot resume: %s does not exist."),
1712 am_path(state
, "author-script"));
1716 * Interactively prompt the user on whether the current patch should be
1719 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1722 static int do_interactive(struct am_state
*state
)
1729 puts(_("Commit Body is:"));
1730 puts("--------------------------");
1731 printf("%s", state
->msg
);
1732 puts("--------------------------");
1735 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1736 * in your translation. The program will only accept English
1737 * input at this point.
1739 printf(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "));
1740 if (!fgets(reply
, sizeof(reply
), stdin
))
1741 die("unable to read from stdin; aborting");
1743 if (*reply
== 'y' || *reply
== 'Y') {
1745 } else if (*reply
== 'a' || *reply
== 'A') {
1746 state
->interactive
= 0;
1748 } else if (*reply
== 'n' || *reply
== 'N') {
1750 } else if (*reply
== 'e' || *reply
== 'E') {
1751 struct strbuf msg
= STRBUF_INIT
;
1753 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1755 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1757 strbuf_release(&msg
);
1758 } else if (*reply
== 'v' || *reply
== 'V') {
1759 const char *pager
= git_pager(1);
1760 struct child_process cp
= CHILD_PROCESS_INIT
;
1764 prepare_pager_args(&cp
, pager
);
1765 strvec_push(&cp
.args
, am_path(state
, "patch"));
1772 * Applies all queued mail.
1774 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1775 * well as the state directory's "patch" file is used as-is for applying the
1776 * patch and committing it.
1778 static void am_run(struct am_state
*state
, int resume
)
1780 struct strbuf sb
= STRBUF_INIT
;
1782 unlink(am_path(state
, "dirtyindex"));
1784 if (refresh_and_write_cache(REFRESH_QUIET
, 0, 0) < 0)
1785 die(_("unable to write index file"));
1787 if (repo_index_has_changes(the_repository
, NULL
, &sb
)) {
1788 write_state_bool(state
, "dirtyindex", 1);
1789 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1792 strbuf_release(&sb
);
1794 while (state
->cur
<= state
->last
) {
1795 const char *mail
= am_path(state
, msgnum(state
));
1801 if (!file_exists(mail
))
1805 validate_resume_state(state
);
1809 if (state
->rebasing
)
1810 skip
= parse_mail_rebase(state
, mail
);
1812 skip
= parse_mail(state
, mail
);
1815 goto next
; /* mail should be skipped */
1818 am_append_signoff(state
);
1820 write_author_script(state
);
1821 write_commit_msg(state
);
1824 if (state
->interactive
&& do_interactive(state
))
1828 if (is_empty_or_missing_file(am_path(state
, "patch"))) {
1829 switch (state
->empty_type
) {
1830 case DROP_EMPTY_COMMIT
:
1831 say(state
, stdout
, _("Skipping: %.*s"), linelen(state
->msg
), state
->msg
);
1834 case KEEP_EMPTY_COMMIT
:
1836 say(state
, stdout
, _("Creating an empty commit: %.*s"),
1837 linelen(state
->msg
), state
->msg
);
1839 case STOP_ON_EMPTY_COMMIT
:
1840 printf_ln(_("Patch is empty."));
1841 die_user_resolve(state
);
1846 if (run_applypatch_msg_hook(state
))
1851 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1853 apply_status
= run_apply(state
, NULL
);
1855 if (apply_status
&& state
->threeway
) {
1856 struct strbuf sb
= STRBUF_INIT
;
1858 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1859 apply_status
= fall_back_threeway(state
, sb
.buf
);
1860 strbuf_release(&sb
);
1863 * Applying the patch to an earlier tree and merging
1864 * the result may have produced the same tree as ours.
1866 if (!apply_status
&&
1867 !repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1868 say(state
, stdout
, _("No changes -- Patch already applied."));
1874 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1875 linelen(state
->msg
), state
->msg
);
1877 if (advice_enabled(ADVICE_AM_WORK_DIR
))
1878 advise(_("Use 'git am --show-current-patch=diff' to see the failed patch"));
1880 die_user_resolve(state
);
1894 if (!is_empty_or_missing_file(am_path(state
, "rewritten"))) {
1895 assert(state
->rebasing
);
1896 copy_notes_for_rebase(state
);
1897 run_post_rewrite_hook(state
);
1901 * In rebasing mode, it's up to the caller to take care of
1904 if (!state
->rebasing
) {
1906 run_auto_maintenance(state
->quiet
);
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. If `allow_empty`
1914 * is true, commit as an empty commit when index has not changed and lacking a patch.
1916 static void am_resolve(struct am_state
*state
, int allow_empty
)
1918 validate_resume_state(state
);
1920 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1922 if (!repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1923 if (allow_empty
&& is_empty_or_missing_file(am_path(state
, "patch"))) {
1924 printf_ln(_("No changes - recorded it as an empty commit."));
1926 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1927 "If there is nothing left to stage, chances are that something else\n"
1928 "already introduced the same changes; you might want to skip this patch."));
1929 die_user_resolve(state
);
1933 if (unmerged_cache()) {
1934 printf_ln(_("You still have unmerged paths in your index.\n"
1935 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1936 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1937 die_user_resolve(state
);
1940 if (state
->interactive
) {
1941 write_index_patch(state
);
1942 if (do_interactive(state
))
1946 repo_rerere(the_repository
, 0);
1957 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1958 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1961 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1963 struct lock_file lock_file
= LOCK_INIT
;
1964 struct unpack_trees_options opts
;
1965 struct tree_desc t
[2];
1967 if (parse_tree(head
) || parse_tree(remote
))
1970 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1972 refresh_cache(REFRESH_QUIET
);
1974 memset(&opts
, 0, sizeof(opts
));
1976 opts
.src_index
= &the_index
;
1977 opts
.dst_index
= &the_index
;
1980 opts
.reset
= reset
? UNPACK_RESET_PROTECT_UNTRACKED
: 0;
1981 opts
.preserve_ignored
= 0; /* FIXME: !overwrite_ignore */
1982 opts
.fn
= twoway_merge
;
1983 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1984 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1986 if (unpack_trees(2, t
, &opts
)) {
1987 rollback_lock_file(&lock_file
);
1991 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1992 die(_("unable to write new index file"));
1998 * Merges a tree into the index. The index's stat info will take precedence
1999 * over the merged tree's. Returns 0 on success, -1 on failure.
2001 static int merge_tree(struct tree
*tree
)
2003 struct lock_file lock_file
= LOCK_INIT
;
2004 struct unpack_trees_options opts
;
2005 struct tree_desc t
[1];
2007 if (parse_tree(tree
))
2010 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
2012 memset(&opts
, 0, sizeof(opts
));
2014 opts
.src_index
= &the_index
;
2015 opts
.dst_index
= &the_index
;
2017 opts
.fn
= oneway_merge
;
2018 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
2020 if (unpack_trees(1, t
, &opts
)) {
2021 rollback_lock_file(&lock_file
);
2025 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
2026 die(_("unable to write new index file"));
2032 * Clean the index without touching entries that are not modified between
2033 * `head` and `remote`.
2035 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
2037 struct tree
*head_tree
, *remote_tree
, *index_tree
;
2038 struct object_id index
;
2040 head_tree
= parse_tree_indirect(head
);
2042 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
2044 remote_tree
= parse_tree_indirect(remote
);
2046 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
2048 read_cache_unmerged();
2050 if (fast_forward_to(head_tree
, head_tree
, 1))
2053 if (write_cache_as_tree(&index
, 0, NULL
))
2056 index_tree
= parse_tree_indirect(&index
);
2058 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
2060 if (fast_forward_to(index_tree
, remote_tree
, 0))
2063 if (merge_tree(remote_tree
))
2066 remove_branch_state(the_repository
, 0);
2072 * Resets rerere's merge resolution metadata.
2074 static void am_rerere_clear(void)
2076 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
2077 rerere_clear(the_repository
, &merge_rr
);
2078 string_list_clear(&merge_rr
, 1);
2082 * Resume the current am session by skipping the current patch.
2084 static void am_skip(struct am_state
*state
)
2086 struct object_id head
;
2090 if (get_oid("HEAD", &head
))
2091 oidcpy(&head
, the_hash_algo
->empty_tree
);
2093 if (clean_index(&head
, &head
))
2094 die(_("failed to clean index"));
2096 if (state
->rebasing
) {
2097 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
2099 assert(!is_null_oid(&state
->orig_commit
));
2100 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
2101 fprintf(fp
, "%s\n", oid_to_hex(&head
));
2111 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2113 * It is not safe to reset HEAD when:
2114 * 1. git-am previously failed because the index was dirty.
2115 * 2. HEAD has moved since git-am previously failed.
2117 static int safe_to_abort(const struct am_state
*state
)
2119 struct strbuf sb
= STRBUF_INIT
;
2120 struct object_id abort_safety
, head
;
2122 if (file_exists(am_path(state
, "dirtyindex")))
2125 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2126 if (get_oid_hex(sb
.buf
, &abort_safety
))
2127 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2129 oidclr(&abort_safety
);
2130 strbuf_release(&sb
);
2132 if (get_oid("HEAD", &head
))
2135 if (oideq(&head
, &abort_safety
))
2138 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2139 "Not rewinding to ORIG_HEAD"));
2145 * Aborts the current am session if it is safe to do so.
2147 static void am_abort(struct am_state
*state
)
2149 struct object_id curr_head
, orig_head
;
2150 int has_curr_head
, has_orig_head
;
2153 if (!safe_to_abort(state
)) {
2160 curr_branch
= resolve_refdup("HEAD", 0, &curr_head
, NULL
);
2161 has_curr_head
= curr_branch
&& !is_null_oid(&curr_head
);
2163 oidcpy(&curr_head
, the_hash_algo
->empty_tree
);
2165 has_orig_head
= !get_oid("ORIG_HEAD", &orig_head
);
2167 oidcpy(&orig_head
, the_hash_algo
->empty_tree
);
2169 if (clean_index(&curr_head
, &orig_head
))
2170 die(_("failed to clean index"));
2173 update_ref("am --abort", "HEAD", &orig_head
,
2174 has_curr_head
? &curr_head
: NULL
, 0,
2175 UPDATE_REFS_DIE_ON_ERR
);
2176 else if (curr_branch
)
2177 delete_ref(NULL
, curr_branch
, NULL
, REF_NO_DEREF
);
2183 static int show_patch(struct am_state
*state
, enum show_patch_type sub_mode
)
2185 struct strbuf sb
= STRBUF_INIT
;
2186 const char *patch_path
;
2189 if (!is_null_oid(&state
->orig_commit
)) {
2190 const char *av
[] = {
2191 "show", oid_to_hex(&state
->orig_commit
), "--", NULL
2194 return run_command_v_opt(av
, RUN_GIT_CMD
);
2198 case SHOW_PATCH_RAW
:
2199 patch_path
= am_path(state
, msgnum(state
));
2201 case SHOW_PATCH_DIFF
:
2202 patch_path
= am_path(state
, "patch");
2205 BUG("invalid mode for --show-current-patch");
2208 len
= strbuf_read_file(&sb
, patch_path
, 0);
2210 die_errno(_("failed to read '%s'"), patch_path
);
2213 write_in_full(1, sb
.buf
, sb
.len
);
2214 strbuf_release(&sb
);
2219 * parse_options() callback that validates and sets opt->value to the
2220 * PATCH_FORMAT_* enum value corresponding to `arg`.
2222 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2224 int *opt_value
= opt
->value
;
2227 *opt_value
= PATCH_FORMAT_UNKNOWN
;
2228 else if (!strcmp(arg
, "mbox"))
2229 *opt_value
= PATCH_FORMAT_MBOX
;
2230 else if (!strcmp(arg
, "stgit"))
2231 *opt_value
= PATCH_FORMAT_STGIT
;
2232 else if (!strcmp(arg
, "stgit-series"))
2233 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2234 else if (!strcmp(arg
, "hg"))
2235 *opt_value
= PATCH_FORMAT_HG
;
2236 else if (!strcmp(arg
, "mboxrd"))
2237 *opt_value
= PATCH_FORMAT_MBOXRD
;
2239 * Please update $__git_patchformat in git-completion.bash
2240 * when you add new options
2243 return error(_("invalid value for '%s': '%s'"),
2244 "--patch-format", arg
);
2259 struct resume_mode
{
2260 enum resume_type mode
;
2261 enum show_patch_type sub_mode
;
2264 static int parse_opt_show_current_patch(const struct option
*opt
, const char *arg
, int unset
)
2266 int *opt_value
= opt
->value
;
2267 struct resume_mode
*resume
= container_of(opt_value
, struct resume_mode
, mode
);
2270 * Please update $__git_showcurrentpatch in git-completion.bash
2271 * when you add new options
2273 const char *valid_modes
[] = {
2274 [SHOW_PATCH_DIFF
] = "diff",
2275 [SHOW_PATCH_RAW
] = "raw"
2277 int new_value
= SHOW_PATCH_RAW
;
2279 BUG_ON_OPT_NEG(unset
);
2282 for (new_value
= 0; new_value
< ARRAY_SIZE(valid_modes
); new_value
++) {
2283 if (!strcmp(arg
, valid_modes
[new_value
]))
2286 if (new_value
>= ARRAY_SIZE(valid_modes
))
2287 return error(_("invalid value for '%s': '%s'"),
2288 "--show-current-patch", arg
);
2291 if (resume
->mode
== RESUME_SHOW_PATCH
&& new_value
!= resume
->sub_mode
)
2292 return error(_("options '%s=%s' and '%s=%s' "
2293 "cannot be used together"),
2294 "--show-current-patch", "--show-current-patch", arg
, valid_modes
[resume
->sub_mode
]);
2296 resume
->mode
= RESUME_SHOW_PATCH
;
2297 resume
->sub_mode
= new_value
;
2301 static int git_am_config(const char *k
, const char *v
, void *cb UNUSED
)
2305 status
= git_gpg_config(k
, v
, NULL
);
2309 return git_default_config(k
, v
, NULL
);
2312 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2314 struct am_state state
;
2317 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2318 struct resume_mode resume
= { .mode
= RESUME_FALSE
};
2322 const char * const usage
[] = {
2323 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2324 N_("git am [<options>] (--continue | --skip | --abort)"),
2328 struct option options
[] = {
2329 OPT_BOOL('i', "interactive", &state
.interactive
,
2330 N_("run interactively")),
2331 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2332 N_("historical option -- no-op")),
2333 OPT_BOOL('3', "3way", &state
.threeway
,
2334 N_("allow fall back on 3way merging if needed")),
2335 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2336 OPT_SET_INT('s', "signoff", &state
.signoff
,
2337 N_("add a Signed-off-by trailer to the commit message"),
2339 OPT_BOOL('u', "utf8", &state
.utf8
,
2340 N_("recode into utf8 (default)")),
2341 OPT_SET_INT('k', "keep", &state
.keep
,
2342 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2343 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2344 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2345 OPT_BOOL('m', "message-id", &state
.message_id
,
2346 N_("pass -m flag to git-mailinfo")),
2347 OPT_SET_INT_F(0, "keep-cr", &keep_cr
,
2348 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2349 1, PARSE_OPT_NONEG
),
2350 OPT_SET_INT_F(0, "no-keep-cr", &keep_cr
,
2351 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2352 0, PARSE_OPT_NONEG
),
2353 OPT_BOOL('c', "scissors", &state
.scissors
,
2354 N_("strip everything before a scissors line")),
2355 OPT_CALLBACK_F(0, "quoted-cr", &state
.quoted_cr
, N_("action"),
2356 N_("pass it through git-mailinfo"),
2357 PARSE_OPT_NONEG
, am_option_parse_quoted_cr
),
2358 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2359 N_("pass it through git-apply"),
2361 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2362 N_("pass it through git-apply"),
2364 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2365 N_("pass it through git-apply"),
2367 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2368 N_("pass it through git-apply"),
2370 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2371 N_("pass it through git-apply"),
2373 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2374 N_("pass it through git-apply"),
2376 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2377 N_("pass it through git-apply"),
2379 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2380 N_("pass it through git-apply"),
2382 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2383 N_("format the patch(es) are in"),
2384 parse_opt_patchformat
),
2385 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2386 N_("pass it through git-apply"),
2388 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2389 N_("override error message when patch failure occurs")),
2390 OPT_CMDMODE(0, "continue", &resume
.mode
,
2391 N_("continue applying patches after resolving a conflict"),
2393 OPT_CMDMODE('r', "resolved", &resume
.mode
,
2394 N_("synonyms for --continue"),
2396 OPT_CMDMODE(0, "skip", &resume
.mode
,
2397 N_("skip the current patch"),
2399 OPT_CMDMODE(0, "abort", &resume
.mode
,
2400 N_("restore the original branch and abort the patching operation"),
2402 OPT_CMDMODE(0, "quit", &resume
.mode
,
2403 N_("abort the patching operation but keep HEAD where it is"),
2405 { OPTION_CALLBACK
, 0, "show-current-patch", &resume
.mode
,
2407 N_("show the patch being applied"),
2408 PARSE_OPT_CMDMODE
| PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
| PARSE_OPT_LITERAL_ARGHELP
,
2409 parse_opt_show_current_patch
, RESUME_SHOW_PATCH
},
2410 OPT_CMDMODE(0, "allow-empty", &resume
.mode
,
2411 N_("record the empty patch as an empty commit"),
2412 RESUME_ALLOW_EMPTY
),
2413 OPT_BOOL(0, "committer-date-is-author-date",
2414 &state
.committer_date_is_author_date
,
2415 N_("lie about committer date")),
2416 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2417 N_("use current timestamp for author date")),
2418 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2419 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2420 N_("GPG-sign commits"),
2421 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2422 OPT_CALLBACK_F(STOP_ON_EMPTY_COMMIT
, "empty", &state
.empty_type
, "{stop,drop,keep}",
2423 N_("how to handle empty patches"),
2424 PARSE_OPT_NONEG
, am_option_parse_empty
),
2425 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2426 N_("(internal use for git-rebase)")),
2430 if (argc
== 2 && !strcmp(argv
[1], "-h"))
2431 usage_with_options(usage
, options
);
2433 git_config(git_am_config
, NULL
);
2435 am_state_init(&state
);
2437 in_progress
= am_in_progress(&state
);
2441 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2444 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2445 "it will be removed. Please do not use it anymore."));
2447 /* Ensure a valid committer ident can be constructed */
2448 git_committer_info(IDENT_STRICT
);
2450 if (repo_read_index_preload(the_repository
, NULL
, 0) < 0)
2451 die(_("failed to read the index"));
2455 * Catch user error to feed us patches when there is a session
2458 * 1. mbox path(s) are provided on the command-line.
2459 * 2. stdin is not a tty: the user is trying to feed us a patch
2460 * from standard input. This is somewhat unreliable -- stdin
2461 * could be /dev/null for example and the caller did not
2462 * intend to feed us a patch but wanted to continue
2465 if (argc
|| (resume
.mode
== RESUME_FALSE
&& !isatty(0)))
2466 die(_("previous rebase directory %s still exists but mbox given."),
2469 if (resume
.mode
== RESUME_FALSE
)
2470 resume
.mode
= RESUME_APPLY
;
2472 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2473 am_append_signoff(&state
);
2475 struct strvec paths
= STRVEC_INIT
;
2479 * Handle stray state directory in the independent-run case. In
2480 * the --rebasing case, it is up to the caller to take care of
2481 * stray directories.
2483 if (file_exists(state
.dir
) && !state
.rebasing
) {
2484 if (resume
.mode
== RESUME_ABORT
|| resume
.mode
== RESUME_QUIT
) {
2486 am_state_release(&state
);
2490 die(_("Stray %s directory found.\n"
2491 "Use \"git am --abort\" to remove it."),
2496 die(_("Resolve operation not in progress, we are not resuming."));
2498 for (i
= 0; i
< argc
; i
++) {
2499 if (is_absolute_path(argv
[i
]) || !prefix
)
2500 strvec_push(&paths
, argv
[i
]);
2502 strvec_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2505 if (state
.interactive
&& !paths
.nr
)
2506 die(_("interactive mode requires patches on the command line"));
2508 am_setup(&state
, patch_format
, paths
.v
, keep_cr
);
2510 strvec_clear(&paths
);
2513 switch (resume
.mode
) {
2520 case RESUME_RESOLVED
:
2521 case RESUME_ALLOW_EMPTY
:
2522 am_resolve(&state
, resume
.mode
== RESUME_ALLOW_EMPTY
? 1 : 0);
2534 case RESUME_SHOW_PATCH
:
2535 ret
= show_patch(&state
, resume
.sub_mode
);
2538 BUG("invalid resume value");
2541 am_state_release(&state
);