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"
17 #include "cache-tree.h"
22 #include "unpack-trees.h"
24 #include "sequencer.h"
26 #include "merge-recursive.h"
28 #include "notes-utils.h"
33 #include "string-list.h"
35 #include "repository.h"
38 * Returns the length of the first line of msg.
40 static int linelen(const char *msg
)
42 return strchrnul(msg
, '\n') - msg
;
46 * Returns true if `str` consists of only whitespace, false otherwise.
48 static int str_isspace(const char *str
)
58 PATCH_FORMAT_UNKNOWN
= 0,
61 PATCH_FORMAT_STGIT_SERIES
,
68 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
69 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
74 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
75 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
81 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
84 enum show_patch_type
{
89 /* state directory path */
92 /* current and last patch numbers, 1-indexed */
96 /* commit metadata and message */
103 /* when --rebasing, records the original commit the patch came from */
104 struct object_id orig_commit
;
106 /* number of digits in patch filename */
109 /* various operating modes and command line options */
113 int signoff
; /* enum signoff_type */
115 int keep
; /* enum keep_type */
117 int scissors
; /* enum scissors_type */
118 struct argv_array git_apply_opts
;
119 const char *resolvemsg
;
120 int committer_date_is_author_date
;
122 int allow_rerere_autoupdate
;
123 const char *sign_commit
;
128 * Initializes am_state with the default values.
130 static void am_state_init(struct am_state
*state
)
134 memset(state
, 0, sizeof(*state
));
136 state
->dir
= git_pathdup("rebase-apply");
140 git_config_get_bool("am.threeway", &state
->threeway
);
144 git_config_get_bool("am.messageid", &state
->message_id
);
146 state
->scissors
= SCISSORS_UNSET
;
148 argv_array_init(&state
->git_apply_opts
);
150 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
151 state
->sign_commit
= gpgsign
? "" : NULL
;
155 * Releases memory allocated by an am_state.
157 static void am_state_release(struct am_state
*state
)
160 free(state
->author_name
);
161 free(state
->author_email
);
162 free(state
->author_date
);
164 argv_array_clear(&state
->git_apply_opts
);
168 * Returns path relative to the am_state directory.
170 static inline const char *am_path(const struct am_state
*state
, const char *path
)
172 return mkpath("%s/%s", state
->dir
, path
);
176 * For convenience to call write_file()
178 static void write_state_text(const struct am_state
*state
,
179 const char *name
, const char *string
)
181 write_file(am_path(state
, name
), "%s", string
);
184 static void write_state_count(const struct am_state
*state
,
185 const char *name
, int value
)
187 write_file(am_path(state
, name
), "%d", value
);
190 static void write_state_bool(const struct am_state
*state
,
191 const char *name
, int value
)
193 write_state_text(state
, name
, value
? "t" : "f");
197 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
200 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
206 vfprintf(fp
, fmt
, ap
);
213 * Returns 1 if there is an am session in progress, 0 otherwise.
215 static int am_in_progress(const struct am_state
*state
)
219 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
221 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
223 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
229 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
230 * number of bytes read on success, -1 if the file does not exist. If `trim` is
231 * set, trailing whitespace will be removed.
233 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
234 const char *file
, int trim
)
238 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
248 die_errno(_("could not read '%s'"), am_path(state
, file
));
252 * Reads and parses the state directory's "author-script" file, and sets
253 * state->author_name, state->author_email and state->author_date accordingly.
254 * Returns 0 on success, -1 if the file could not be parsed.
256 * The author script is of the format:
258 * GIT_AUTHOR_NAME='$author_name'
259 * GIT_AUTHOR_EMAIL='$author_email'
260 * GIT_AUTHOR_DATE='$author_date'
262 * where $author_name, $author_email and $author_date are quoted. We are strict
263 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
264 * script, and thus if the file differs from what this function expects, it is
265 * better to bail out than to do something that the user does not expect.
267 static int read_am_author_script(struct am_state
*state
)
269 const char *filename
= am_path(state
, "author-script");
271 assert(!state
->author_name
);
272 assert(!state
->author_email
);
273 assert(!state
->author_date
);
275 return read_author_script(filename
, &state
->author_name
,
276 &state
->author_email
, &state
->author_date
, 1);
280 * Saves state->author_name, state->author_email and state->author_date in the
281 * state directory's "author-script" file.
283 static void write_author_script(const struct am_state
*state
)
285 struct strbuf sb
= STRBUF_INIT
;
287 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
288 sq_quote_buf(&sb
, state
->author_name
);
289 strbuf_addch(&sb
, '\n');
291 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
292 sq_quote_buf(&sb
, state
->author_email
);
293 strbuf_addch(&sb
, '\n');
295 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
296 sq_quote_buf(&sb
, state
->author_date
);
297 strbuf_addch(&sb
, '\n');
299 write_state_text(state
, "author-script", sb
.buf
);
305 * Reads the commit message from the state directory's "final-commit" file,
306 * setting state->msg to its contents and state->msg_len to the length of its
309 * Returns 0 on success, -1 if the file does not exist.
311 static int read_commit_msg(struct am_state
*state
)
313 struct strbuf sb
= STRBUF_INIT
;
317 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
322 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
327 * Saves state->msg in the state directory's "final-commit" file.
329 static void write_commit_msg(const struct am_state
*state
)
331 const char *filename
= am_path(state
, "final-commit");
332 write_file_buf(filename
, state
->msg
, state
->msg_len
);
336 * Loads state from disk.
338 static void am_load(struct am_state
*state
)
340 struct strbuf sb
= STRBUF_INIT
;
342 if (read_state_file(&sb
, state
, "next", 1) < 0)
343 BUG("state file 'next' does not exist");
344 state
->cur
= strtol(sb
.buf
, NULL
, 10);
346 if (read_state_file(&sb
, state
, "last", 1) < 0)
347 BUG("state file 'last' does not exist");
348 state
->last
= strtol(sb
.buf
, NULL
, 10);
350 if (read_am_author_script(state
) < 0)
351 die(_("could not parse author script"));
353 read_commit_msg(state
);
355 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
356 oidclr(&state
->orig_commit
);
357 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
358 die(_("could not parse %s"), am_path(state
, "original-commit"));
360 read_state_file(&sb
, state
, "threeway", 1);
361 state
->threeway
= !strcmp(sb
.buf
, "t");
363 read_state_file(&sb
, state
, "quiet", 1);
364 state
->quiet
= !strcmp(sb
.buf
, "t");
366 read_state_file(&sb
, state
, "sign", 1);
367 state
->signoff
= !strcmp(sb
.buf
, "t");
369 read_state_file(&sb
, state
, "utf8", 1);
370 state
->utf8
= !strcmp(sb
.buf
, "t");
372 if (file_exists(am_path(state
, "rerere-autoupdate"))) {
373 read_state_file(&sb
, state
, "rerere-autoupdate", 1);
374 state
->allow_rerere_autoupdate
= strcmp(sb
.buf
, "t") ?
375 RERERE_NOAUTOUPDATE
: RERERE_AUTOUPDATE
;
377 state
->allow_rerere_autoupdate
= 0;
380 read_state_file(&sb
, state
, "keep", 1);
381 if (!strcmp(sb
.buf
, "t"))
382 state
->keep
= KEEP_TRUE
;
383 else if (!strcmp(sb
.buf
, "b"))
384 state
->keep
= KEEP_NON_PATCH
;
386 state
->keep
= KEEP_FALSE
;
388 read_state_file(&sb
, state
, "messageid", 1);
389 state
->message_id
= !strcmp(sb
.buf
, "t");
391 read_state_file(&sb
, state
, "scissors", 1);
392 if (!strcmp(sb
.buf
, "t"))
393 state
->scissors
= SCISSORS_TRUE
;
394 else if (!strcmp(sb
.buf
, "f"))
395 state
->scissors
= SCISSORS_FALSE
;
397 state
->scissors
= SCISSORS_UNSET
;
399 read_state_file(&sb
, state
, "apply-opt", 1);
400 argv_array_clear(&state
->git_apply_opts
);
401 if (sq_dequote_to_argv_array(sb
.buf
, &state
->git_apply_opts
) < 0)
402 die(_("could not parse %s"), am_path(state
, "apply-opt"));
404 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
410 * Removes the am_state directory, forcefully terminating the current am
413 static void am_destroy(const struct am_state
*state
)
415 struct strbuf sb
= STRBUF_INIT
;
417 strbuf_addstr(&sb
, state
->dir
);
418 remove_dir_recursively(&sb
, 0);
423 * Runs applypatch-msg hook. Returns its exit code.
425 static int run_applypatch_msg_hook(struct am_state
*state
)
430 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
433 FREE_AND_NULL(state
->msg
);
434 if (read_commit_msg(state
) < 0)
435 die(_("'%s' was deleted by the applypatch-msg hook"),
436 am_path(state
, "final-commit"));
443 * Runs post-rewrite hook. Returns it exit code.
445 static int run_post_rewrite_hook(const struct am_state
*state
)
447 struct child_process cp
= CHILD_PROCESS_INIT
;
448 const char *hook
= find_hook("post-rewrite");
454 argv_array_push(&cp
.args
, hook
);
455 argv_array_push(&cp
.args
, "rebase");
457 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
458 cp
.stdout_to_stderr
= 1;
459 cp
.trace2_hook_name
= "post-rewrite";
461 ret
= run_command(&cp
);
468 * Reads the state directory's "rewritten" file, and copies notes from the old
469 * commits listed in the file to their rewritten commits.
471 * Returns 0 on success, -1 on failure.
473 static int copy_notes_for_rebase(const struct am_state
*state
)
475 struct notes_rewrite_cfg
*c
;
476 struct strbuf sb
= STRBUF_INIT
;
477 const char *invalid_line
= _("Malformed input line: '%s'.");
478 const char *msg
= "Notes added by 'git rebase'";
482 assert(state
->rebasing
);
484 c
= init_copy_notes_for_rewrite("rebase");
488 fp
= xfopen(am_path(state
, "rewritten"), "r");
490 while (!strbuf_getline_lf(&sb
, fp
)) {
491 struct object_id from_obj
, to_obj
;
494 if (sb
.len
!= the_hash_algo
->hexsz
* 2 + 1) {
495 ret
= error(invalid_line
, sb
.buf
);
499 if (parse_oid_hex(sb
.buf
, &from_obj
, &p
)) {
500 ret
= error(invalid_line
, sb
.buf
);
505 ret
= error(invalid_line
, sb
.buf
);
509 if (get_oid_hex(p
+ 1, &to_obj
)) {
510 ret
= error(invalid_line
, sb
.buf
);
514 if (copy_note_for_rewrite(c
, &from_obj
, &to_obj
))
515 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
516 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
520 finish_copy_notes_for_rewrite(the_repository
, c
, msg
);
527 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
528 * non-indented lines and checking if they look like they begin with valid
529 * header field names.
531 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
533 static int is_mail(FILE *fp
)
535 const char *header_regex
= "^[!-9;-~]+:";
536 struct strbuf sb
= STRBUF_INIT
;
540 if (fseek(fp
, 0L, SEEK_SET
))
541 die_errno(_("fseek failed"));
543 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
544 die("invalid pattern: %s", header_regex
);
546 while (!strbuf_getline(&sb
, fp
)) {
548 break; /* End of header */
550 /* Ignore indented folded lines */
551 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
554 /* It's a header if it matches header_regex */
555 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
568 * Attempts to detect the patch_format of the patches contained in `paths`,
569 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
572 static int detect_patch_format(const char **paths
)
574 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
575 struct strbuf l1
= STRBUF_INIT
;
576 struct strbuf l2
= STRBUF_INIT
;
577 struct strbuf l3
= STRBUF_INIT
;
581 * We default to mbox format if input is from stdin and for directories
583 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
584 return PATCH_FORMAT_MBOX
;
587 * Otherwise, check the first few lines of the first patch, starting
588 * from the first non-blank line, to try to detect its format.
591 fp
= xfopen(*paths
, "r");
593 while (!strbuf_getline(&l1
, fp
)) {
598 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
599 ret
= PATCH_FORMAT_MBOX
;
603 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
604 ret
= PATCH_FORMAT_STGIT_SERIES
;
608 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
609 ret
= PATCH_FORMAT_HG
;
613 strbuf_getline(&l2
, fp
);
614 strbuf_getline(&l3
, fp
);
617 * If the second line is empty and the third is a From, Author or Date
618 * entry, this is likely an StGit patch.
620 if (l1
.len
&& !l2
.len
&&
621 (starts_with(l3
.buf
, "From:") ||
622 starts_with(l3
.buf
, "Author:") ||
623 starts_with(l3
.buf
, "Date:"))) {
624 ret
= PATCH_FORMAT_STGIT
;
628 if (l1
.len
&& is_mail(fp
)) {
629 ret
= PATCH_FORMAT_MBOX
;
642 * Splits out individual email patches from `paths`, where each path is either
643 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
645 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
646 int keep_cr
, int mboxrd
)
648 struct child_process cp
= CHILD_PROCESS_INIT
;
649 struct strbuf last
= STRBUF_INIT
;
653 argv_array_push(&cp
.args
, "mailsplit");
654 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
655 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
656 argv_array_push(&cp
.args
, "-b");
658 argv_array_push(&cp
.args
, "--keep-cr");
660 argv_array_push(&cp
.args
, "--mboxrd");
661 argv_array_push(&cp
.args
, "--");
662 argv_array_pushv(&cp
.args
, paths
);
664 ret
= capture_command(&cp
, &last
, 8);
669 state
->last
= strtol(last
.buf
, NULL
, 10);
672 strbuf_release(&last
);
677 * Callback signature for split_mail_conv(). The foreign patch should be
678 * read from `in`, and the converted patch (in RFC2822 mail format) should be
679 * written to `out`. Return 0 on success, or -1 on failure.
681 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
684 * Calls `fn` for each file in `paths` to convert the foreign patch to the
685 * RFC2822 mail format suitable for parsing with git-mailinfo.
687 * Returns 0 on success, -1 on failure.
689 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
690 const char **paths
, int keep_cr
)
692 static const char *stdin_only
[] = {"-", NULL
};
698 for (i
= 0; *paths
; paths
++, i
++) {
703 if (!strcmp(*paths
, "-"))
706 in
= fopen(*paths
, "r");
709 return error_errno(_("could not open '%s' for reading"),
712 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
714 out
= fopen(mail
, "w");
718 return error_errno(_("could not open '%s' for writing"),
722 ret
= fn(out
, in
, keep_cr
);
729 return error(_("could not parse patch '%s'"), *paths
);
738 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
739 * message suitable for parsing with git-mailinfo.
741 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
743 struct strbuf sb
= STRBUF_INIT
;
744 int subject_printed
= 0;
746 while (!strbuf_getline_lf(&sb
, in
)) {
749 if (str_isspace(sb
.buf
))
751 else if (skip_prefix(sb
.buf
, "Author:", &str
))
752 fprintf(out
, "From:%s\n", str
);
753 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
754 fprintf(out
, "%s\n", sb
.buf
);
755 else if (!subject_printed
) {
756 fprintf(out
, "Subject: %s\n", sb
.buf
);
759 fprintf(out
, "\n%s\n", sb
.buf
);
765 while (strbuf_fread(&sb
, 8192, in
) > 0) {
766 fwrite(sb
.buf
, 1, sb
.len
, out
);
775 * This function only supports a single StGit series file in `paths`.
777 * Given an StGit series file, converts the StGit patches in the series into
778 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
779 * the state directory.
781 * Returns 0 on success, -1 on failure.
783 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
786 const char *series_dir
;
787 char *series_dir_buf
;
789 struct argv_array patches
= ARGV_ARRAY_INIT
;
790 struct strbuf sb
= STRBUF_INIT
;
793 if (!paths
[0] || paths
[1])
794 return error(_("Only one StGIT patch series can be applied at once"));
796 series_dir_buf
= xstrdup(*paths
);
797 series_dir
= dirname(series_dir_buf
);
799 fp
= fopen(*paths
, "r");
801 return error_errno(_("could not open '%s' for reading"), *paths
);
803 while (!strbuf_getline_lf(&sb
, fp
)) {
805 continue; /* skip comment lines */
807 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
812 free(series_dir_buf
);
814 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
816 argv_array_clear(&patches
);
821 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
822 * message suitable for parsing with git-mailinfo.
824 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
826 struct strbuf sb
= STRBUF_INIT
;
829 while (!strbuf_getline_lf(&sb
, in
)) {
832 if (skip_prefix(sb
.buf
, "# User ", &str
))
833 fprintf(out
, "From: %s\n", str
);
834 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
835 timestamp_t timestamp
;
840 timestamp
= parse_timestamp(str
, &end
, 10);
842 rc
= error(_("invalid timestamp"));
846 if (!skip_prefix(end
, " ", &str
)) {
847 rc
= error(_("invalid Date line"));
852 tz
= strtol(str
, &end
, 10);
854 rc
= error(_("invalid timezone offset"));
859 rc
= error(_("invalid Date line"));
864 * mercurial's timezone is in seconds west of UTC,
865 * however git's timezone is in hours + minutes east of
868 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
872 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
873 } else if (starts_with(sb
.buf
, "# ")) {
876 fprintf(out
, "\n%s\n", sb
.buf
);
882 while (strbuf_fread(&sb
, 8192, in
) > 0) {
883 fwrite(sb
.buf
, 1, sb
.len
, out
);
892 * Splits a list of files/directories into individual email patches. Each path
893 * in `paths` must be a file/directory that is formatted according to
896 * Once split out, the individual email patches will be stored in the state
897 * directory, with each patch's filename being its index, padded to state->prec
900 * state->cur will be set to the index of the first mail, and state->last will
901 * be set to the index of the last mail.
903 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
904 * to disable this behavior, -1 to use the default configured setting.
906 * Returns 0 on success, -1 on failure.
908 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
909 const char **paths
, int keep_cr
)
913 git_config_get_bool("am.keepcr", &keep_cr
);
916 switch (patch_format
) {
917 case PATCH_FORMAT_MBOX
:
918 return split_mail_mbox(state
, paths
, keep_cr
, 0);
919 case PATCH_FORMAT_STGIT
:
920 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
921 case PATCH_FORMAT_STGIT_SERIES
:
922 return split_mail_stgit_series(state
, paths
, keep_cr
);
923 case PATCH_FORMAT_HG
:
924 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
925 case PATCH_FORMAT_MBOXRD
:
926 return split_mail_mbox(state
, paths
, keep_cr
, 1);
928 BUG("invalid patch_format");
934 * Setup a new am session for applying patches
936 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
937 const char **paths
, int keep_cr
)
939 struct object_id curr_head
;
941 struct strbuf sb
= STRBUF_INIT
;
944 patch_format
= detect_patch_format(paths
);
947 fprintf_ln(stderr
, _("Patch format detection failed."));
951 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
952 die_errno(_("failed to create directory '%s'"), state
->dir
);
953 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
955 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
957 die(_("Failed to split patches."));
963 write_state_bool(state
, "threeway", state
->threeway
);
964 write_state_bool(state
, "quiet", state
->quiet
);
965 write_state_bool(state
, "sign", state
->signoff
);
966 write_state_bool(state
, "utf8", state
->utf8
);
968 if (state
->allow_rerere_autoupdate
)
969 write_state_bool(state
, "rerere-autoupdate",
970 state
->allow_rerere_autoupdate
== RERERE_AUTOUPDATE
);
972 switch (state
->keep
) {
983 BUG("invalid value for state->keep");
986 write_state_text(state
, "keep", str
);
987 write_state_bool(state
, "messageid", state
->message_id
);
989 switch (state
->scissors
) {
1000 BUG("invalid value for state->scissors");
1002 write_state_text(state
, "scissors", str
);
1004 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
);
1005 write_state_text(state
, "apply-opt", sb
.buf
);
1007 if (state
->rebasing
)
1008 write_state_text(state
, "rebasing", "");
1010 write_state_text(state
, "applying", "");
1012 if (!get_oid("HEAD", &curr_head
)) {
1013 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1014 if (!state
->rebasing
)
1015 update_ref("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1016 UPDATE_REFS_DIE_ON_ERR
);
1018 write_state_text(state
, "abort-safety", "");
1019 if (!state
->rebasing
)
1020 delete_ref(NULL
, "ORIG_HEAD", NULL
, 0);
1024 * NOTE: Since the "next" and "last" files determine if an am_state
1025 * session is in progress, they should be written last.
1028 write_state_count(state
, "next", state
->cur
);
1029 write_state_count(state
, "last", state
->last
);
1031 strbuf_release(&sb
);
1035 * Increments the patch pointer, and cleans am_state for the application of the
1038 static void am_next(struct am_state
*state
)
1040 struct object_id head
;
1042 FREE_AND_NULL(state
->author_name
);
1043 FREE_AND_NULL(state
->author_email
);
1044 FREE_AND_NULL(state
->author_date
);
1045 FREE_AND_NULL(state
->msg
);
1048 unlink(am_path(state
, "author-script"));
1049 unlink(am_path(state
, "final-commit"));
1051 oidclr(&state
->orig_commit
);
1052 unlink(am_path(state
, "original-commit"));
1053 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
1055 if (!get_oid("HEAD", &head
))
1056 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1058 write_state_text(state
, "abort-safety", "");
1061 write_state_count(state
, "next", state
->cur
);
1065 * Returns the filename of the current patch email.
1067 static const char *msgnum(const struct am_state
*state
)
1069 static struct strbuf sb
= STRBUF_INIT
;
1072 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1078 * Dies with a user-friendly message on how to proceed after resolving the
1079 * problem. This message can be overridden with state->resolvemsg.
1081 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1083 if (state
->resolvemsg
) {
1084 printf_ln("%s", state
->resolvemsg
);
1086 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1088 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1089 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1090 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1097 * Appends signoff to the "msg" field of the am_state.
1099 static void am_append_signoff(struct am_state
*state
)
1101 struct strbuf sb
= STRBUF_INIT
;
1103 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1104 append_signoff(&sb
, 0, 0);
1105 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1109 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1110 * state->msg will be set to the patch message. state->author_name,
1111 * state->author_email and state->author_date will be set to the patch author's
1112 * name, email and date respectively. The patch body will be written to the
1113 * state directory's "patch" file.
1115 * Returns 1 if the patch should be skipped, 0 otherwise.
1117 static int parse_mail(struct am_state
*state
, const char *mail
)
1120 struct strbuf sb
= STRBUF_INIT
;
1121 struct strbuf msg
= STRBUF_INIT
;
1122 struct strbuf author_name
= STRBUF_INIT
;
1123 struct strbuf author_date
= STRBUF_INIT
;
1124 struct strbuf author_email
= STRBUF_INIT
;
1128 setup_mailinfo(&mi
);
1131 mi
.metainfo_charset
= get_commit_output_encoding();
1133 mi
.metainfo_charset
= NULL
;
1135 switch (state
->keep
) {
1139 mi
.keep_subject
= 1;
1141 case KEEP_NON_PATCH
:
1142 mi
.keep_non_patch_brackets_in_subject
= 1;
1145 BUG("invalid value for state->keep");
1148 if (state
->message_id
)
1149 mi
.add_message_id
= 1;
1151 switch (state
->scissors
) {
1152 case SCISSORS_UNSET
:
1154 case SCISSORS_FALSE
:
1155 mi
.use_scissors
= 0;
1158 mi
.use_scissors
= 1;
1161 BUG("invalid value for state->scissors");
1164 mi
.input
= xfopen(mail
, "r");
1165 mi
.output
= xfopen(am_path(state
, "info"), "w");
1166 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1167 die("could not parse patch");
1172 if (mi
.format_flowed
)
1173 warning(_("Patch sent with format=flowed; "
1174 "space at the end of lines might be lost."));
1176 /* Extract message and author information */
1177 fp
= xfopen(am_path(state
, "info"), "r");
1178 while (!strbuf_getline_lf(&sb
, fp
)) {
1181 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1183 strbuf_addch(&msg
, '\n');
1184 strbuf_addstr(&msg
, x
);
1185 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1186 strbuf_addstr(&author_name
, x
);
1187 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1188 strbuf_addstr(&author_email
, x
);
1189 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1190 strbuf_addstr(&author_date
, x
);
1194 /* Skip pine's internal folder data */
1195 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1200 if (is_empty_or_missing_file(am_path(state
, "patch"))) {
1201 printf_ln(_("Patch is empty."));
1202 die_user_resolve(state
);
1205 strbuf_addstr(&msg
, "\n\n");
1206 strbuf_addbuf(&msg
, &mi
.log_message
);
1207 strbuf_stripspace(&msg
, 0);
1209 assert(!state
->author_name
);
1210 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1212 assert(!state
->author_email
);
1213 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1215 assert(!state
->author_date
);
1216 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1218 assert(!state
->msg
);
1219 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1222 strbuf_release(&msg
);
1223 strbuf_release(&author_date
);
1224 strbuf_release(&author_email
);
1225 strbuf_release(&author_name
);
1226 strbuf_release(&sb
);
1227 clear_mailinfo(&mi
);
1232 * Sets commit_id to the commit hash where the mail was generated from.
1233 * Returns 0 on success, -1 on failure.
1235 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1237 struct strbuf sb
= STRBUF_INIT
;
1238 FILE *fp
= xfopen(mail
, "r");
1242 if (strbuf_getline_lf(&sb
, fp
) ||
1243 !skip_prefix(sb
.buf
, "From ", &x
) ||
1244 get_oid_hex(x
, commit_id
) < 0)
1247 strbuf_release(&sb
);
1253 * Sets state->msg, state->author_name, state->author_email, state->author_date
1254 * to the commit's respective info.
1256 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1258 const char *buffer
, *ident_line
, *msg
;
1260 struct ident_split id
;
1262 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1264 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1266 die(_("missing author line in commit %s"),
1267 oid_to_hex(&commit
->object
.oid
));
1268 if (split_ident_line(&id
, ident_line
, ident_len
) < 0)
1269 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1271 assert(!state
->author_name
);
1273 state
->author_name
=
1274 xmemdupz(id
.name_begin
, id
.name_end
- id
.name_begin
);
1276 state
->author_name
= xstrdup("");
1278 assert(!state
->author_email
);
1280 state
->author_email
=
1281 xmemdupz(id
.mail_begin
, id
.mail_end
- id
.mail_begin
);
1283 state
->author_email
= xstrdup("");
1285 assert(!state
->author_date
);
1286 state
->author_date
= xstrdup(show_ident_date(&id
, DATE_MODE(NORMAL
)));
1288 assert(!state
->msg
);
1289 msg
= strstr(buffer
, "\n\n");
1291 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1292 state
->msg
= xstrdup(msg
+ 2);
1293 state
->msg_len
= strlen(state
->msg
);
1294 unuse_commit_buffer(commit
, buffer
);
1298 * Writes `commit` as a patch to the state directory's "patch" file.
1300 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1302 struct rev_info rev_info
;
1305 fp
= xfopen(am_path(state
, "patch"), "w");
1306 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1308 rev_info
.abbrev
= 0;
1309 rev_info
.disable_stdin
= 1;
1310 rev_info
.show_root_diff
= 1;
1311 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1312 rev_info
.no_commit_id
= 1;
1313 rev_info
.diffopt
.flags
.binary
= 1;
1314 rev_info
.diffopt
.flags
.full_index
= 1;
1315 rev_info
.diffopt
.use_color
= 0;
1316 rev_info
.diffopt
.file
= fp
;
1317 rev_info
.diffopt
.close_file
= 1;
1318 add_pending_object(&rev_info
, &commit
->object
, "");
1319 diff_setup_done(&rev_info
.diffopt
);
1320 log_tree_commit(&rev_info
, commit
);
1324 * Writes the diff of the index against HEAD as a patch to the state
1325 * directory's "patch" file.
1327 static void write_index_patch(const struct am_state
*state
)
1330 struct object_id head
;
1331 struct rev_info rev_info
;
1334 if (!get_oid("HEAD", &head
)) {
1335 struct commit
*commit
= lookup_commit_or_die(&head
, "HEAD");
1336 tree
= get_commit_tree(commit
);
1338 tree
= lookup_tree(the_repository
,
1339 the_repository
->hash_algo
->empty_tree
);
1341 fp
= xfopen(am_path(state
, "patch"), "w");
1342 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1344 rev_info
.disable_stdin
= 1;
1345 rev_info
.no_commit_id
= 1;
1346 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1347 rev_info
.diffopt
.use_color
= 0;
1348 rev_info
.diffopt
.file
= fp
;
1349 rev_info
.diffopt
.close_file
= 1;
1350 add_pending_object(&rev_info
, &tree
->object
, "");
1351 diff_setup_done(&rev_info
.diffopt
);
1352 run_diff_index(&rev_info
, 1);
1356 * Like parse_mail(), but parses the mail by looking up its commit ID
1357 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1360 * state->orig_commit will be set to the original commit ID.
1362 * Will always return 0 as the patch should never be skipped.
1364 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1366 struct commit
*commit
;
1367 struct object_id commit_oid
;
1369 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1370 die(_("could not parse %s"), mail
);
1372 commit
= lookup_commit_or_die(&commit_oid
, mail
);
1374 get_commit_info(state
, commit
);
1376 write_commit_patch(state
, commit
);
1378 oidcpy(&state
->orig_commit
, &commit_oid
);
1379 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1380 update_ref("am", "REBASE_HEAD", &commit_oid
,
1381 NULL
, REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
1387 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1388 * `index_file` is not NULL, the patch will be applied to that index.
1390 static int run_apply(const struct am_state
*state
, const char *index_file
)
1392 struct argv_array apply_paths
= ARGV_ARRAY_INIT
;
1393 struct argv_array apply_opts
= ARGV_ARRAY_INIT
;
1394 struct apply_state apply_state
;
1396 int force_apply
= 0;
1399 if (init_apply_state(&apply_state
, the_repository
, NULL
))
1400 BUG("init_apply_state() failed");
1402 argv_array_push(&apply_opts
, "apply");
1403 argv_array_pushv(&apply_opts
, state
->git_apply_opts
.argv
);
1405 opts_left
= apply_parse_options(apply_opts
.argc
, apply_opts
.argv
,
1406 &apply_state
, &force_apply
, &options
,
1410 die("unknown option passed through to git apply");
1413 apply_state
.index_file
= index_file
;
1414 apply_state
.cached
= 1;
1416 apply_state
.check_index
= 1;
1419 * If we are allowed to fall back on 3-way merge, don't give false
1420 * errors during the initial attempt.
1422 if (state
->threeway
&& !index_file
)
1423 apply_state
.apply_verbosity
= verbosity_silent
;
1425 if (check_apply_state(&apply_state
, force_apply
))
1426 BUG("check_apply_state() failed");
1428 argv_array_push(&apply_paths
, am_path(state
, "patch"));
1430 res
= apply_all_patches(&apply_state
, apply_paths
.argc
, apply_paths
.argv
, options
);
1432 argv_array_clear(&apply_paths
);
1433 argv_array_clear(&apply_opts
);
1434 clear_apply_state(&apply_state
);
1440 /* Reload index as apply_all_patches() will have modified it. */
1442 read_cache_from(index_file
);
1449 * Builds an index that contains just the blobs needed for a 3way merge.
1451 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1453 struct child_process cp
= CHILD_PROCESS_INIT
;
1456 argv_array_push(&cp
.args
, "apply");
1457 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1458 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1459 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1461 if (run_command(&cp
))
1468 * Attempt a threeway merge, using index_path as the temporary index.
1470 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1472 struct object_id orig_tree
, their_tree
, our_tree
;
1473 const struct object_id
*bases
[1] = { &orig_tree
};
1474 struct merge_options o
;
1475 struct commit
*result
;
1476 char *their_tree_name
;
1478 if (get_oid("HEAD", &our_tree
) < 0)
1479 oidcpy(&our_tree
, the_hash_algo
->empty_tree
);
1481 if (build_fake_ancestor(state
, index_path
))
1482 return error("could not build fake ancestor");
1485 read_cache_from(index_path
);
1487 if (write_index_as_tree(&orig_tree
, &the_index
, index_path
, 0, NULL
))
1488 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1490 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1492 if (!state
->quiet
) {
1494 * List paths that needed 3-way fallback, so that the user can
1495 * review them with extra care to spot mismerges.
1497 struct rev_info rev_info
;
1499 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1500 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1501 rev_info
.diffopt
.filter
|= diff_filter_bit('A');
1502 rev_info
.diffopt
.filter
|= diff_filter_bit('M');
1503 add_pending_oid(&rev_info
, "HEAD", &our_tree
, 0);
1504 diff_setup_done(&rev_info
.diffopt
);
1505 run_diff_index(&rev_info
, 1);
1508 if (run_apply(state
, index_path
))
1509 return error(_("Did you hand edit your patch?\n"
1510 "It does not apply to blobs recorded in its index."));
1512 if (write_index_as_tree(&their_tree
, &the_index
, index_path
, 0, NULL
))
1513 return error("could not write tree");
1515 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1521 * This is not so wrong. Depending on which base we picked, orig_tree
1522 * may be wildly different from ours, but their_tree has the same set of
1523 * wildly different changes in parts the patch did not touch, so
1524 * recursive ends up canceling them, saying that we reverted all those
1528 init_merge_options(&o
, the_repository
);
1531 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1532 o
.branch2
= their_tree_name
;
1533 o
.detect_directory_renames
= MERGE_DIRECTORY_RENAMES_NONE
;
1538 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1539 repo_rerere(the_repository
, state
->allow_rerere_autoupdate
);
1540 free(their_tree_name
);
1541 return error(_("Failed to merge in the changes."));
1544 free(their_tree_name
);
1549 * Commits the current index with state->msg as the commit message and
1550 * state->author_name, state->author_email and state->author_date as the author
1553 static void do_commit(const struct am_state
*state
)
1555 struct object_id tree
, parent
, commit
;
1556 const struct object_id
*old_oid
;
1557 struct commit_list
*parents
= NULL
;
1558 const char *reflog_msg
, *author
;
1559 struct strbuf sb
= STRBUF_INIT
;
1561 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1564 if (write_cache_as_tree(&tree
, 0, NULL
))
1565 die(_("git write-tree failed to write a tree"));
1567 if (!get_oid_commit("HEAD", &parent
)) {
1569 commit_list_insert(lookup_commit(the_repository
, &parent
),
1573 say(state
, stderr
, _("applying to an empty history"));
1576 author
= fmt_ident(state
->author_name
, state
->author_email
,
1578 state
->ignore_date
? NULL
: state
->author_date
,
1581 if (state
->committer_date_is_author_date
)
1582 setenv("GIT_COMMITTER_DATE",
1583 state
->ignore_date
? "" : state
->author_date
, 1);
1585 if (commit_tree(state
->msg
, state
->msg_len
, &tree
, parents
, &commit
,
1586 author
, state
->sign_commit
))
1587 die(_("failed to write commit object"));
1589 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1593 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1596 update_ref(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1597 UPDATE_REFS_DIE_ON_ERR
);
1599 if (state
->rebasing
) {
1600 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1602 assert(!is_null_oid(&state
->orig_commit
));
1603 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1604 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1608 run_hook_le(NULL
, "post-applypatch", NULL
);
1610 strbuf_release(&sb
);
1614 * Validates the am_state for resuming -- the "msg" and authorship fields must
1617 static void validate_resume_state(const struct am_state
*state
)
1620 die(_("cannot resume: %s does not exist."),
1621 am_path(state
, "final-commit"));
1623 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1624 die(_("cannot resume: %s does not exist."),
1625 am_path(state
, "author-script"));
1629 * Interactively prompt the user on whether the current patch should be
1632 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1635 static int do_interactive(struct am_state
*state
)
1642 puts(_("Commit Body is:"));
1643 puts("--------------------------");
1644 printf("%s", state
->msg
);
1645 puts("--------------------------");
1648 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1649 * in your translation. The program will only accept English
1650 * input at this point.
1652 printf(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "));
1653 if (!fgets(reply
, sizeof(reply
), stdin
))
1654 die("unable to read from stdin; aborting");
1656 if (*reply
== 'y' || *reply
== 'Y') {
1658 } else if (*reply
== 'a' || *reply
== 'A') {
1659 state
->interactive
= 0;
1661 } else if (*reply
== 'n' || *reply
== 'N') {
1663 } else if (*reply
== 'e' || *reply
== 'E') {
1664 struct strbuf msg
= STRBUF_INIT
;
1666 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1668 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1670 strbuf_release(&msg
);
1671 } else if (*reply
== 'v' || *reply
== 'V') {
1672 const char *pager
= git_pager(1);
1673 struct child_process cp
= CHILD_PROCESS_INIT
;
1677 prepare_pager_args(&cp
, pager
);
1678 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1685 * Applies all queued mail.
1687 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1688 * well as the state directory's "patch" file is used as-is for applying the
1689 * patch and committing it.
1691 static void am_run(struct am_state
*state
, int resume
)
1693 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1694 struct strbuf sb
= STRBUF_INIT
;
1696 unlink(am_path(state
, "dirtyindex"));
1698 if (refresh_and_write_cache(REFRESH_QUIET
, 0, 0) < 0)
1699 die(_("unable to write index file"));
1701 if (repo_index_has_changes(the_repository
, NULL
, &sb
)) {
1702 write_state_bool(state
, "dirtyindex", 1);
1703 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1706 strbuf_release(&sb
);
1708 while (state
->cur
<= state
->last
) {
1709 const char *mail
= am_path(state
, msgnum(state
));
1714 if (!file_exists(mail
))
1718 validate_resume_state(state
);
1722 if (state
->rebasing
)
1723 skip
= parse_mail_rebase(state
, mail
);
1725 skip
= parse_mail(state
, mail
);
1728 goto next
; /* mail should be skipped */
1731 am_append_signoff(state
);
1733 write_author_script(state
);
1734 write_commit_msg(state
);
1737 if (state
->interactive
&& do_interactive(state
))
1740 if (run_applypatch_msg_hook(state
))
1743 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1745 apply_status
= run_apply(state
, NULL
);
1747 if (apply_status
&& state
->threeway
) {
1748 struct strbuf sb
= STRBUF_INIT
;
1750 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1751 apply_status
= fall_back_threeway(state
, sb
.buf
);
1752 strbuf_release(&sb
);
1755 * Applying the patch to an earlier tree and merging
1756 * the result may have produced the same tree as ours.
1758 if (!apply_status
&&
1759 !repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1760 say(state
, stdout
, _("No changes -- Patch already applied."));
1766 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1767 linelen(state
->msg
), state
->msg
);
1769 if (advice_amworkdir
)
1770 advise(_("Use 'git am --show-current-patch' to see the failed patch"));
1772 die_user_resolve(state
);
1785 if (!is_empty_or_missing_file(am_path(state
, "rewritten"))) {
1786 assert(state
->rebasing
);
1787 copy_notes_for_rebase(state
);
1788 run_post_rewrite_hook(state
);
1792 * In rebasing mode, it's up to the caller to take care of
1795 if (!state
->rebasing
) {
1797 close_object_store(the_repository
->objects
);
1798 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1803 * Resume the current am session after patch application failure. The user did
1804 * all the hard work, and we do not have to do any patch application. Just
1805 * trust and commit what the user has in the index and working tree.
1807 static void am_resolve(struct am_state
*state
)
1809 validate_resume_state(state
);
1811 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1813 if (!repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1814 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1815 "If there is nothing left to stage, chances are that something else\n"
1816 "already introduced the same changes; you might want to skip this patch."));
1817 die_user_resolve(state
);
1820 if (unmerged_cache()) {
1821 printf_ln(_("You still have unmerged paths in your index.\n"
1822 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1823 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1824 die_user_resolve(state
);
1827 if (state
->interactive
) {
1828 write_index_patch(state
);
1829 if (do_interactive(state
))
1833 repo_rerere(the_repository
, 0);
1844 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1845 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1848 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1850 struct lock_file lock_file
= LOCK_INIT
;
1851 struct unpack_trees_options opts
;
1852 struct tree_desc t
[2];
1854 if (parse_tree(head
) || parse_tree(remote
))
1857 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1859 refresh_cache(REFRESH_QUIET
);
1861 memset(&opts
, 0, sizeof(opts
));
1863 opts
.src_index
= &the_index
;
1864 opts
.dst_index
= &the_index
;
1868 opts
.fn
= twoway_merge
;
1869 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1870 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1872 if (unpack_trees(2, t
, &opts
)) {
1873 rollback_lock_file(&lock_file
);
1877 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1878 die(_("unable to write new index file"));
1884 * Merges a tree into the index. The index's stat info will take precedence
1885 * over the merged tree's. Returns 0 on success, -1 on failure.
1887 static int merge_tree(struct tree
*tree
)
1889 struct lock_file lock_file
= LOCK_INIT
;
1890 struct unpack_trees_options opts
;
1891 struct tree_desc t
[1];
1893 if (parse_tree(tree
))
1896 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1898 memset(&opts
, 0, sizeof(opts
));
1900 opts
.src_index
= &the_index
;
1901 opts
.dst_index
= &the_index
;
1903 opts
.fn
= oneway_merge
;
1904 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
1906 if (unpack_trees(1, t
, &opts
)) {
1907 rollback_lock_file(&lock_file
);
1911 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1912 die(_("unable to write new index file"));
1918 * Clean the index without touching entries that are not modified between
1919 * `head` and `remote`.
1921 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
1923 struct tree
*head_tree
, *remote_tree
, *index_tree
;
1924 struct object_id index
;
1926 head_tree
= parse_tree_indirect(head
);
1928 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
1930 remote_tree
= parse_tree_indirect(remote
);
1932 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
1934 read_cache_unmerged();
1936 if (fast_forward_to(head_tree
, head_tree
, 1))
1939 if (write_cache_as_tree(&index
, 0, NULL
))
1942 index_tree
= parse_tree_indirect(&index
);
1944 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
1946 if (fast_forward_to(index_tree
, remote_tree
, 0))
1949 if (merge_tree(remote_tree
))
1952 remove_branch_state(the_repository
, 0);
1958 * Resets rerere's merge resolution metadata.
1960 static void am_rerere_clear(void)
1962 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
1963 rerere_clear(the_repository
, &merge_rr
);
1964 string_list_clear(&merge_rr
, 1);
1968 * Resume the current am session by skipping the current patch.
1970 static void am_skip(struct am_state
*state
)
1972 struct object_id head
;
1976 if (get_oid("HEAD", &head
))
1977 oidcpy(&head
, the_hash_algo
->empty_tree
);
1979 if (clean_index(&head
, &head
))
1980 die(_("failed to clean index"));
1982 if (state
->rebasing
) {
1983 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1985 assert(!is_null_oid(&state
->orig_commit
));
1986 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1987 fprintf(fp
, "%s\n", oid_to_hex(&head
));
1997 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
1999 * It is not safe to reset HEAD when:
2000 * 1. git-am previously failed because the index was dirty.
2001 * 2. HEAD has moved since git-am previously failed.
2003 static int safe_to_abort(const struct am_state
*state
)
2005 struct strbuf sb
= STRBUF_INIT
;
2006 struct object_id abort_safety
, head
;
2008 if (file_exists(am_path(state
, "dirtyindex")))
2011 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2012 if (get_oid_hex(sb
.buf
, &abort_safety
))
2013 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2015 oidclr(&abort_safety
);
2016 strbuf_release(&sb
);
2018 if (get_oid("HEAD", &head
))
2021 if (oideq(&head
, &abort_safety
))
2024 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2025 "Not rewinding to ORIG_HEAD"));
2031 * Aborts the current am session if it is safe to do so.
2033 static void am_abort(struct am_state
*state
)
2035 struct object_id curr_head
, orig_head
;
2036 int has_curr_head
, has_orig_head
;
2039 if (!safe_to_abort(state
)) {
2046 curr_branch
= resolve_refdup("HEAD", 0, &curr_head
, NULL
);
2047 has_curr_head
= curr_branch
&& !is_null_oid(&curr_head
);
2049 oidcpy(&curr_head
, the_hash_algo
->empty_tree
);
2051 has_orig_head
= !get_oid("ORIG_HEAD", &orig_head
);
2053 oidcpy(&orig_head
, the_hash_algo
->empty_tree
);
2055 clean_index(&curr_head
, &orig_head
);
2058 update_ref("am --abort", "HEAD", &orig_head
,
2059 has_curr_head
? &curr_head
: NULL
, 0,
2060 UPDATE_REFS_DIE_ON_ERR
);
2061 else if (curr_branch
)
2062 delete_ref(NULL
, curr_branch
, NULL
, REF_NO_DEREF
);
2068 static int show_patch(struct am_state
*state
, enum show_patch_type sub_mode
)
2070 struct strbuf sb
= STRBUF_INIT
;
2071 const char *patch_path
;
2074 if (!is_null_oid(&state
->orig_commit
)) {
2075 const char *av
[4] = { "show", NULL
, "--", NULL
};
2079 av
[1] = new_oid_str
= xstrdup(oid_to_hex(&state
->orig_commit
));
2080 ret
= run_command_v_opt(av
, RUN_GIT_CMD
);
2086 case SHOW_PATCH_RAW
:
2087 patch_path
= am_path(state
, msgnum(state
));
2090 BUG("invalid mode for --show-current-patch");
2093 len
= strbuf_read_file(&sb
, patch_path
, 0);
2095 die_errno(_("failed to read '%s'"), patch_path
);
2098 write_in_full(1, sb
.buf
, sb
.len
);
2099 strbuf_release(&sb
);
2104 * parse_options() callback that validates and sets opt->value to the
2105 * PATCH_FORMAT_* enum value corresponding to `arg`.
2107 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2109 int *opt_value
= opt
->value
;
2112 *opt_value
= PATCH_FORMAT_UNKNOWN
;
2113 else if (!strcmp(arg
, "mbox"))
2114 *opt_value
= PATCH_FORMAT_MBOX
;
2115 else if (!strcmp(arg
, "stgit"))
2116 *opt_value
= PATCH_FORMAT_STGIT
;
2117 else if (!strcmp(arg
, "stgit-series"))
2118 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2119 else if (!strcmp(arg
, "hg"))
2120 *opt_value
= PATCH_FORMAT_HG
;
2121 else if (!strcmp(arg
, "mboxrd"))
2122 *opt_value
= PATCH_FORMAT_MBOXRD
;
2124 * Please update $__git_patchformat in git-completion.bash
2125 * when you add new options
2128 return error(_("Invalid value for --patch-format: %s"), arg
);
2142 struct resume_mode
{
2143 enum resume_type mode
;
2144 enum show_patch_type sub_mode
;
2147 static int parse_opt_show_current_patch(const struct option
*opt
, const char *arg
, int unset
)
2149 int *opt_value
= opt
->value
;
2150 struct resume_mode
*resume
= container_of(opt_value
, struct resume_mode
, mode
);
2153 * Please update $__git_showcurrentpatch in git-completion.bash
2154 * when you add new options
2156 const char *valid_modes
[] = {
2157 [SHOW_PATCH_RAW
] = "raw"
2159 int new_value
= SHOW_PATCH_RAW
;
2162 for (new_value
= 0; new_value
< ARRAY_SIZE(valid_modes
); new_value
++) {
2163 if (!strcmp(arg
, valid_modes
[new_value
]))
2166 if (new_value
>= ARRAY_SIZE(valid_modes
))
2167 return error(_("Invalid value for --show-current-patch: %s"), arg
);
2170 if (resume
->mode
== RESUME_SHOW_PATCH
&& new_value
!= resume
->sub_mode
)
2171 return error(_("--show-current-patch=%s is incompatible with "
2172 "--show-current-patch=%s"),
2173 arg
, valid_modes
[resume
->sub_mode
]);
2175 resume
->mode
= RESUME_SHOW_PATCH
;
2176 resume
->sub_mode
= new_value
;
2180 static int git_am_config(const char *k
, const char *v
, void *cb
)
2184 status
= git_gpg_config(k
, v
, NULL
);
2188 return git_default_config(k
, v
, NULL
);
2191 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2193 struct am_state state
;
2196 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2197 struct resume_mode resume
= { .mode
= RESUME_FALSE
};
2201 const char * const usage
[] = {
2202 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2203 N_("git am [<options>] (--continue | --skip | --abort)"),
2207 struct option options
[] = {
2208 OPT_BOOL('i', "interactive", &state
.interactive
,
2209 N_("run interactively")),
2210 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2211 N_("historical option -- no-op")),
2212 OPT_BOOL('3', "3way", &state
.threeway
,
2213 N_("allow fall back on 3way merging if needed")),
2214 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2215 OPT_SET_INT('s', "signoff", &state
.signoff
,
2216 N_("add a Signed-off-by line to the commit message"),
2218 OPT_BOOL('u', "utf8", &state
.utf8
,
2219 N_("recode into utf8 (default)")),
2220 OPT_SET_INT('k', "keep", &state
.keep
,
2221 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2222 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2223 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2224 OPT_BOOL('m', "message-id", &state
.message_id
,
2225 N_("pass -m flag to git-mailinfo")),
2226 OPT_SET_INT_F(0, "keep-cr", &keep_cr
,
2227 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2228 1, PARSE_OPT_NONEG
),
2229 OPT_SET_INT_F(0, "no-keep-cr", &keep_cr
,
2230 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2231 0, PARSE_OPT_NONEG
),
2232 OPT_BOOL('c', "scissors", &state
.scissors
,
2233 N_("strip everything before a scissors line")),
2234 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2235 N_("pass it through git-apply"),
2237 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2238 N_("pass it through git-apply"),
2240 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2241 N_("pass it through git-apply"),
2243 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2244 N_("pass it through git-apply"),
2246 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2247 N_("pass it through git-apply"),
2249 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2250 N_("pass it through git-apply"),
2252 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2253 N_("pass it through git-apply"),
2255 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2256 N_("pass it through git-apply"),
2258 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2259 N_("format the patch(es) are in"),
2260 parse_opt_patchformat
),
2261 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2262 N_("pass it through git-apply"),
2264 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2265 N_("override error message when patch failure occurs")),
2266 OPT_CMDMODE(0, "continue", &resume
.mode
,
2267 N_("continue applying patches after resolving a conflict"),
2269 OPT_CMDMODE('r', "resolved", &resume
.mode
,
2270 N_("synonyms for --continue"),
2272 OPT_CMDMODE(0, "skip", &resume
.mode
,
2273 N_("skip the current patch"),
2275 OPT_CMDMODE(0, "abort", &resume
.mode
,
2276 N_("restore the original branch and abort the patching operation."),
2278 OPT_CMDMODE(0, "quit", &resume
.mode
,
2279 N_("abort the patching operation but keep HEAD where it is."),
2281 { OPTION_CALLBACK
, 0, "show-current-patch", &resume
.mode
,
2283 N_("show the patch being applied"),
2284 PARSE_OPT_CMDMODE
| PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
| PARSE_OPT_LITERAL_ARGHELP
,
2285 parse_opt_show_current_patch
, RESUME_SHOW_PATCH
},
2286 OPT_BOOL(0, "committer-date-is-author-date",
2287 &state
.committer_date_is_author_date
,
2288 N_("lie about committer date")),
2289 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2290 N_("use current timestamp for author date")),
2291 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2292 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2293 N_("GPG-sign commits"),
2294 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2295 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2296 N_("(internal use for git-rebase)")),
2300 if (argc
== 2 && !strcmp(argv
[1], "-h"))
2301 usage_with_options(usage
, options
);
2303 git_config(git_am_config
, NULL
);
2305 am_state_init(&state
);
2307 in_progress
= am_in_progress(&state
);
2311 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2314 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2315 "it will be removed. Please do not use it anymore."));
2317 /* Ensure a valid committer ident can be constructed */
2318 git_committer_info(IDENT_STRICT
);
2320 if (repo_read_index_preload(the_repository
, NULL
, 0) < 0)
2321 die(_("failed to read the index"));
2325 * Catch user error to feed us patches when there is a session
2328 * 1. mbox path(s) are provided on the command-line.
2329 * 2. stdin is not a tty: the user is trying to feed us a patch
2330 * from standard input. This is somewhat unreliable -- stdin
2331 * could be /dev/null for example and the caller did not
2332 * intend to feed us a patch but wanted to continue
2335 if (argc
|| (resume
.mode
== RESUME_FALSE
&& !isatty(0)))
2336 die(_("previous rebase directory %s still exists but mbox given."),
2339 if (resume
.mode
== RESUME_FALSE
)
2340 resume
.mode
= RESUME_APPLY
;
2342 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2343 am_append_signoff(&state
);
2345 struct argv_array paths
= ARGV_ARRAY_INIT
;
2349 * Handle stray state directory in the independent-run case. In
2350 * the --rebasing case, it is up to the caller to take care of
2351 * stray directories.
2353 if (file_exists(state
.dir
) && !state
.rebasing
) {
2354 if (resume
.mode
== RESUME_ABORT
|| resume
.mode
== RESUME_QUIT
) {
2356 am_state_release(&state
);
2360 die(_("Stray %s directory found.\n"
2361 "Use \"git am --abort\" to remove it."),
2366 die(_("Resolve operation not in progress, we are not resuming."));
2368 for (i
= 0; i
< argc
; i
++) {
2369 if (is_absolute_path(argv
[i
]) || !prefix
)
2370 argv_array_push(&paths
, argv
[i
]);
2372 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2375 if (state
.interactive
&& !paths
.argc
)
2376 die(_("interactive mode requires patches on the command line"));
2378 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2380 argv_array_clear(&paths
);
2383 switch (resume
.mode
) {
2390 case RESUME_RESOLVED
:
2403 case RESUME_SHOW_PATCH
:
2404 ret
= show_patch(&state
, resume
.sub_mode
);
2407 BUG("invalid resume value");
2410 am_state_release(&state
);