4 * Based on git-am.sh by Junio C Hamano.
9 #include "parse-options.h"
11 #include "run-command.h"
15 #include "cache-tree.h"
20 #include "unpack-trees.h"
22 #include "sequencer.h"
24 #include "merge-recursive.h"
27 #include "notes-utils.h"
32 #include "string-list.h"
35 * Returns 1 if the file is empty or does not exist, 0 otherwise.
37 static int is_empty_file(const char *filename
)
41 if (stat(filename
, &st
) < 0) {
44 die_errno(_("could not stat %s"), filename
);
51 * Returns the length of the first line of msg.
53 static int linelen(const char *msg
)
55 return strchrnul(msg
, '\n') - msg
;
59 * Returns true if `str` consists of only whitespace, false otherwise.
61 static int str_isspace(const char *str
)
71 PATCH_FORMAT_UNKNOWN
= 0,
74 PATCH_FORMAT_STGIT_SERIES
,
81 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
82 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
87 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
88 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
94 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
98 /* state directory path */
101 /* current and last patch numbers, 1-indexed */
105 /* commit metadata and message */
112 /* when --rebasing, records the original commit the patch came from */
113 struct object_id orig_commit
;
115 /* number of digits in patch filename */
118 /* various operating modes and command line options */
122 int signoff
; /* enum signoff_type */
124 int keep
; /* enum keep_type */
126 int scissors
; /* enum scissors_type */
127 struct argv_array git_apply_opts
;
128 const char *resolvemsg
;
129 int committer_date_is_author_date
;
131 int allow_rerere_autoupdate
;
132 const char *sign_commit
;
137 * Initializes am_state with the default values. The state directory is set to
140 static void am_state_init(struct am_state
*state
, const char *dir
)
144 memset(state
, 0, sizeof(*state
));
147 state
->dir
= xstrdup(dir
);
151 git_config_get_bool("am.threeway", &state
->threeway
);
155 git_config_get_bool("am.messageid", &state
->message_id
);
157 state
->scissors
= SCISSORS_UNSET
;
159 argv_array_init(&state
->git_apply_opts
);
161 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
162 state
->sign_commit
= gpgsign
? "" : NULL
;
166 * Releases memory allocated by an am_state.
168 static void am_state_release(struct am_state
*state
)
171 free(state
->author_name
);
172 free(state
->author_email
);
173 free(state
->author_date
);
175 argv_array_clear(&state
->git_apply_opts
);
179 * Returns path relative to the am_state directory.
181 static inline const char *am_path(const struct am_state
*state
, const char *path
)
183 return mkpath("%s/%s", state
->dir
, path
);
187 * For convenience to call write_file()
189 static void write_state_text(const struct am_state
*state
,
190 const char *name
, const char *string
)
192 write_file(am_path(state
, name
), "%s", string
);
195 static void write_state_count(const struct am_state
*state
,
196 const char *name
, int value
)
198 write_file(am_path(state
, name
), "%d", value
);
201 static void write_state_bool(const struct am_state
*state
,
202 const char *name
, int value
)
204 write_state_text(state
, name
, value
? "t" : "f");
208 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
211 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
217 vfprintf(fp
, fmt
, ap
);
224 * Returns 1 if there is an am session in progress, 0 otherwise.
226 static int am_in_progress(const struct am_state
*state
)
230 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
232 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
234 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
240 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
241 * number of bytes read on success, -1 if the file does not exist. If `trim` is
242 * set, trailing whitespace will be removed.
244 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
245 const char *file
, int trim
)
249 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
259 die_errno(_("could not read '%s'"), am_path(state
, file
));
263 * Take a series of KEY='VALUE' lines where VALUE part is
264 * sq-quoted, and append <KEY, VALUE> at the end of the string list
266 static int parse_key_value_squoted(char *buf
, struct string_list
*list
)
269 struct string_list_item
*item
;
271 char *cp
= strchr(buf
, '=');
274 np
= strchrnul(cp
, '\n');
276 item
= string_list_append(list
, buf
);
278 buf
= np
+ (*np
== '\n');
283 item
->util
= xstrdup(cp
);
289 * Reads and parses the state directory's "author-script" file, and sets
290 * state->author_name, state->author_email and state->author_date accordingly.
291 * Returns 0 on success, -1 if the file could not be parsed.
293 * The author script is of the format:
295 * GIT_AUTHOR_NAME='$author_name'
296 * GIT_AUTHOR_EMAIL='$author_email'
297 * GIT_AUTHOR_DATE='$author_date'
299 * where $author_name, $author_email and $author_date are quoted. We are strict
300 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
301 * script, and thus if the file differs from what this function expects, it is
302 * better to bail out than to do something that the user does not expect.
304 static int read_author_script(struct am_state
*state
)
306 const char *filename
= am_path(state
, "author-script");
307 struct strbuf buf
= STRBUF_INIT
;
308 struct string_list kv
= STRING_LIST_INIT_DUP
;
309 int retval
= -1; /* assume failure */
312 assert(!state
->author_name
);
313 assert(!state
->author_email
);
314 assert(!state
->author_date
);
316 fd
= open(filename
, O_RDONLY
);
320 die_errno(_("could not open '%s' for reading"), filename
);
322 strbuf_read(&buf
, fd
, 0);
324 if (parse_key_value_squoted(buf
.buf
, &kv
))
328 strcmp(kv
.items
[0].string
, "GIT_AUTHOR_NAME") ||
329 strcmp(kv
.items
[1].string
, "GIT_AUTHOR_EMAIL") ||
330 strcmp(kv
.items
[2].string
, "GIT_AUTHOR_DATE"))
332 state
->author_name
= kv
.items
[0].util
;
333 state
->author_email
= kv
.items
[1].util
;
334 state
->author_date
= kv
.items
[2].util
;
337 string_list_clear(&kv
, !!retval
);
338 strbuf_release(&buf
);
343 * Saves state->author_name, state->author_email and state->author_date in the
344 * state directory's "author-script" file.
346 static void write_author_script(const struct am_state
*state
)
348 struct strbuf sb
= STRBUF_INIT
;
350 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
351 sq_quote_buf(&sb
, state
->author_name
);
352 strbuf_addch(&sb
, '\n');
354 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
355 sq_quote_buf(&sb
, state
->author_email
);
356 strbuf_addch(&sb
, '\n');
358 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
359 sq_quote_buf(&sb
, state
->author_date
);
360 strbuf_addch(&sb
, '\n');
362 write_state_text(state
, "author-script", sb
.buf
);
368 * Reads the commit message from the state directory's "final-commit" file,
369 * setting state->msg to its contents and state->msg_len to the length of its
372 * Returns 0 on success, -1 if the file does not exist.
374 static int read_commit_msg(struct am_state
*state
)
376 struct strbuf sb
= STRBUF_INIT
;
380 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
385 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
390 * Saves state->msg in the state directory's "final-commit" file.
392 static void write_commit_msg(const struct am_state
*state
)
394 const char *filename
= am_path(state
, "final-commit");
395 write_file_buf(filename
, state
->msg
, state
->msg_len
);
399 * Loads state from disk.
401 static void am_load(struct am_state
*state
)
403 struct strbuf sb
= STRBUF_INIT
;
405 if (read_state_file(&sb
, state
, "next", 1) < 0)
406 die("BUG: state file 'next' does not exist");
407 state
->cur
= strtol(sb
.buf
, NULL
, 10);
409 if (read_state_file(&sb
, state
, "last", 1) < 0)
410 die("BUG: state file 'last' does not exist");
411 state
->last
= strtol(sb
.buf
, NULL
, 10);
413 if (read_author_script(state
) < 0)
414 die(_("could not parse author script"));
416 read_commit_msg(state
);
418 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
419 oidclr(&state
->orig_commit
);
420 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
421 die(_("could not parse %s"), am_path(state
, "original-commit"));
423 read_state_file(&sb
, state
, "threeway", 1);
424 state
->threeway
= !strcmp(sb
.buf
, "t");
426 read_state_file(&sb
, state
, "quiet", 1);
427 state
->quiet
= !strcmp(sb
.buf
, "t");
429 read_state_file(&sb
, state
, "sign", 1);
430 state
->signoff
= !strcmp(sb
.buf
, "t");
432 read_state_file(&sb
, state
, "utf8", 1);
433 state
->utf8
= !strcmp(sb
.buf
, "t");
435 read_state_file(&sb
, state
, "keep", 1);
436 if (!strcmp(sb
.buf
, "t"))
437 state
->keep
= KEEP_TRUE
;
438 else if (!strcmp(sb
.buf
, "b"))
439 state
->keep
= KEEP_NON_PATCH
;
441 state
->keep
= KEEP_FALSE
;
443 read_state_file(&sb
, state
, "messageid", 1);
444 state
->message_id
= !strcmp(sb
.buf
, "t");
446 read_state_file(&sb
, state
, "scissors", 1);
447 if (!strcmp(sb
.buf
, "t"))
448 state
->scissors
= SCISSORS_TRUE
;
449 else if (!strcmp(sb
.buf
, "f"))
450 state
->scissors
= SCISSORS_FALSE
;
452 state
->scissors
= SCISSORS_UNSET
;
454 read_state_file(&sb
, state
, "apply-opt", 1);
455 argv_array_clear(&state
->git_apply_opts
);
456 if (sq_dequote_to_argv_array(sb
.buf
, &state
->git_apply_opts
) < 0)
457 die(_("could not parse %s"), am_path(state
, "apply-opt"));
459 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
465 * Removes the am_state directory, forcefully terminating the current am
468 static void am_destroy(const struct am_state
*state
)
470 struct strbuf sb
= STRBUF_INIT
;
472 strbuf_addstr(&sb
, state
->dir
);
473 remove_dir_recursively(&sb
, 0);
478 * Runs applypatch-msg hook. Returns its exit code.
480 static int run_applypatch_msg_hook(struct am_state
*state
)
485 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
490 if (read_commit_msg(state
) < 0)
491 die(_("'%s' was deleted by the applypatch-msg hook"),
492 am_path(state
, "final-commit"));
499 * Runs post-rewrite hook. Returns it exit code.
501 static int run_post_rewrite_hook(const struct am_state
*state
)
503 struct child_process cp
= CHILD_PROCESS_INIT
;
504 const char *hook
= find_hook("post-rewrite");
510 argv_array_push(&cp
.args
, hook
);
511 argv_array_push(&cp
.args
, "rebase");
513 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
514 cp
.stdout_to_stderr
= 1;
516 ret
= run_command(&cp
);
523 * Reads the state directory's "rewritten" file, and copies notes from the old
524 * commits listed in the file to their rewritten commits.
526 * Returns 0 on success, -1 on failure.
528 static int copy_notes_for_rebase(const struct am_state
*state
)
530 struct notes_rewrite_cfg
*c
;
531 struct strbuf sb
= STRBUF_INIT
;
532 const char *invalid_line
= _("Malformed input line: '%s'.");
533 const char *msg
= "Notes added by 'git rebase'";
537 assert(state
->rebasing
);
539 c
= init_copy_notes_for_rewrite("rebase");
543 fp
= xfopen(am_path(state
, "rewritten"), "r");
545 while (!strbuf_getline_lf(&sb
, fp
)) {
546 struct object_id from_obj
, to_obj
;
548 if (sb
.len
!= GIT_SHA1_HEXSZ
* 2 + 1) {
549 ret
= error(invalid_line
, sb
.buf
);
553 if (get_oid_hex(sb
.buf
, &from_obj
)) {
554 ret
= error(invalid_line
, sb
.buf
);
558 if (sb
.buf
[GIT_SHA1_HEXSZ
] != ' ') {
559 ret
= error(invalid_line
, sb
.buf
);
563 if (get_oid_hex(sb
.buf
+ GIT_SHA1_HEXSZ
+ 1, &to_obj
)) {
564 ret
= error(invalid_line
, sb
.buf
);
568 if (copy_note_for_rewrite(c
, from_obj
.hash
, to_obj
.hash
))
569 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
570 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
574 finish_copy_notes_for_rewrite(c
, msg
);
581 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
582 * non-indented lines and checking if they look like they begin with valid
583 * header field names.
585 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
587 static int is_mail(FILE *fp
)
589 const char *header_regex
= "^[!-9;-~]+:";
590 struct strbuf sb
= STRBUF_INIT
;
594 if (fseek(fp
, 0L, SEEK_SET
))
595 die_errno(_("fseek failed"));
597 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
598 die("invalid pattern: %s", header_regex
);
600 while (!strbuf_getline(&sb
, fp
)) {
602 break; /* End of header */
604 /* Ignore indented folded lines */
605 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
608 /* It's a header if it matches header_regex */
609 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
622 * Attempts to detect the patch_format of the patches contained in `paths`,
623 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
626 static int detect_patch_format(const char **paths
)
628 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
629 struct strbuf l1
= STRBUF_INIT
;
630 struct strbuf l2
= STRBUF_INIT
;
631 struct strbuf l3
= STRBUF_INIT
;
635 * We default to mbox format if input is from stdin and for directories
637 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
638 return PATCH_FORMAT_MBOX
;
641 * Otherwise, check the first few lines of the first patch, starting
642 * from the first non-blank line, to try to detect its format.
645 fp
= xfopen(*paths
, "r");
647 while (!strbuf_getline(&l1
, fp
)) {
652 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
653 ret
= PATCH_FORMAT_MBOX
;
657 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
658 ret
= PATCH_FORMAT_STGIT_SERIES
;
662 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
663 ret
= PATCH_FORMAT_HG
;
668 strbuf_getline(&l2
, fp
);
670 strbuf_getline(&l3
, fp
);
673 * If the second line is empty and the third is a From, Author or Date
674 * entry, this is likely an StGit patch.
676 if (l1
.len
&& !l2
.len
&&
677 (starts_with(l3
.buf
, "From:") ||
678 starts_with(l3
.buf
, "Author:") ||
679 starts_with(l3
.buf
, "Date:"))) {
680 ret
= PATCH_FORMAT_STGIT
;
684 if (l1
.len
&& is_mail(fp
)) {
685 ret
= PATCH_FORMAT_MBOX
;
696 * Splits out individual email patches from `paths`, where each path is either
697 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
699 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
700 int keep_cr
, int mboxrd
)
702 struct child_process cp
= CHILD_PROCESS_INIT
;
703 struct strbuf last
= STRBUF_INIT
;
706 argv_array_push(&cp
.args
, "mailsplit");
707 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
708 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
709 argv_array_push(&cp
.args
, "-b");
711 argv_array_push(&cp
.args
, "--keep-cr");
713 argv_array_push(&cp
.args
, "--mboxrd");
714 argv_array_push(&cp
.args
, "--");
715 argv_array_pushv(&cp
.args
, paths
);
717 if (capture_command(&cp
, &last
, 8))
721 state
->last
= strtol(last
.buf
, NULL
, 10);
727 * Callback signature for split_mail_conv(). The foreign patch should be
728 * read from `in`, and the converted patch (in RFC2822 mail format) should be
729 * written to `out`. Return 0 on success, or -1 on failure.
731 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
734 * Calls `fn` for each file in `paths` to convert the foreign patch to the
735 * RFC2822 mail format suitable for parsing with git-mailinfo.
737 * Returns 0 on success, -1 on failure.
739 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
740 const char **paths
, int keep_cr
)
742 static const char *stdin_only
[] = {"-", NULL
};
748 for (i
= 0; *paths
; paths
++, i
++) {
753 if (!strcmp(*paths
, "-"))
756 in
= fopen(*paths
, "r");
759 return error_errno(_("could not open '%s' for reading"),
762 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
764 out
= fopen(mail
, "w");
766 return error_errno(_("could not open '%s' for writing"),
769 ret
= fn(out
, in
, keep_cr
);
775 return error(_("could not parse patch '%s'"), *paths
);
784 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
785 * message suitable for parsing with git-mailinfo.
787 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
789 struct strbuf sb
= STRBUF_INIT
;
790 int subject_printed
= 0;
792 while (!strbuf_getline_lf(&sb
, in
)) {
795 if (str_isspace(sb
.buf
))
797 else if (skip_prefix(sb
.buf
, "Author:", &str
))
798 fprintf(out
, "From:%s\n", str
);
799 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
800 fprintf(out
, "%s\n", sb
.buf
);
801 else if (!subject_printed
) {
802 fprintf(out
, "Subject: %s\n", sb
.buf
);
805 fprintf(out
, "\n%s\n", sb
.buf
);
811 while (strbuf_fread(&sb
, 8192, in
) > 0) {
812 fwrite(sb
.buf
, 1, sb
.len
, out
);
821 * This function only supports a single StGit series file in `paths`.
823 * Given an StGit series file, converts the StGit patches in the series into
824 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
825 * the state directory.
827 * Returns 0 on success, -1 on failure.
829 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
832 const char *series_dir
;
833 char *series_dir_buf
;
835 struct argv_array patches
= ARGV_ARRAY_INIT
;
836 struct strbuf sb
= STRBUF_INIT
;
839 if (!paths
[0] || paths
[1])
840 return error(_("Only one StGIT patch series can be applied at once"));
842 series_dir_buf
= xstrdup(*paths
);
843 series_dir
= dirname(series_dir_buf
);
845 fp
= fopen(*paths
, "r");
847 return error_errno(_("could not open '%s' for reading"), *paths
);
849 while (!strbuf_getline_lf(&sb
, fp
)) {
851 continue; /* skip comment lines */
853 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
858 free(series_dir_buf
);
860 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
862 argv_array_clear(&patches
);
867 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
868 * message suitable for parsing with git-mailinfo.
870 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
872 struct strbuf sb
= STRBUF_INIT
;
874 while (!strbuf_getline_lf(&sb
, in
)) {
877 if (skip_prefix(sb
.buf
, "# User ", &str
))
878 fprintf(out
, "From: %s\n", str
);
879 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
880 unsigned long timestamp
;
885 timestamp
= strtoul(str
, &end
, 10);
887 return error(_("invalid timestamp"));
889 if (!skip_prefix(end
, " ", &str
))
890 return error(_("invalid Date line"));
893 tz
= strtol(str
, &end
, 10);
895 return error(_("invalid timezone offset"));
898 return error(_("invalid Date line"));
901 * mercurial's timezone is in seconds west of UTC,
902 * however git's timezone is in hours + minutes east of
905 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
909 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
910 } else if (starts_with(sb
.buf
, "# ")) {
913 fprintf(out
, "\n%s\n", sb
.buf
);
919 while (strbuf_fread(&sb
, 8192, in
) > 0) {
920 fwrite(sb
.buf
, 1, sb
.len
, out
);
929 * Splits a list of files/directories into individual email patches. Each path
930 * in `paths` must be a file/directory that is formatted according to
933 * Once split out, the individual email patches will be stored in the state
934 * directory, with each patch's filename being its index, padded to state->prec
937 * state->cur will be set to the index of the first mail, and state->last will
938 * be set to the index of the last mail.
940 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
941 * to disable this behavior, -1 to use the default configured setting.
943 * Returns 0 on success, -1 on failure.
945 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
946 const char **paths
, int keep_cr
)
950 git_config_get_bool("am.keepcr", &keep_cr
);
953 switch (patch_format
) {
954 case PATCH_FORMAT_MBOX
:
955 return split_mail_mbox(state
, paths
, keep_cr
, 0);
956 case PATCH_FORMAT_STGIT
:
957 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
958 case PATCH_FORMAT_STGIT_SERIES
:
959 return split_mail_stgit_series(state
, paths
, keep_cr
);
960 case PATCH_FORMAT_HG
:
961 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
962 case PATCH_FORMAT_MBOXRD
:
963 return split_mail_mbox(state
, paths
, keep_cr
, 1);
965 die("BUG: invalid patch_format");
971 * Setup a new am session for applying patches
973 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
974 const char **paths
, int keep_cr
)
976 struct object_id curr_head
;
978 struct strbuf sb
= STRBUF_INIT
;
981 patch_format
= detect_patch_format(paths
);
984 fprintf_ln(stderr
, _("Patch format detection failed."));
988 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
989 die_errno(_("failed to create directory '%s'"), state
->dir
);
991 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
993 die(_("Failed to split patches."));
999 write_state_bool(state
, "threeway", state
->threeway
);
1000 write_state_bool(state
, "quiet", state
->quiet
);
1001 write_state_bool(state
, "sign", state
->signoff
);
1002 write_state_bool(state
, "utf8", state
->utf8
);
1004 switch (state
->keep
) {
1011 case KEEP_NON_PATCH
:
1015 die("BUG: invalid value for state->keep");
1018 write_state_text(state
, "keep", str
);
1019 write_state_bool(state
, "messageid", state
->message_id
);
1021 switch (state
->scissors
) {
1022 case SCISSORS_UNSET
:
1025 case SCISSORS_FALSE
:
1032 die("BUG: invalid value for state->scissors");
1034 write_state_text(state
, "scissors", str
);
1036 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
, 0);
1037 write_state_text(state
, "apply-opt", sb
.buf
);
1039 if (state
->rebasing
)
1040 write_state_text(state
, "rebasing", "");
1042 write_state_text(state
, "applying", "");
1044 if (!get_oid("HEAD", &curr_head
)) {
1045 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1046 if (!state
->rebasing
)
1047 update_ref_oid("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1048 UPDATE_REFS_DIE_ON_ERR
);
1050 write_state_text(state
, "abort-safety", "");
1051 if (!state
->rebasing
)
1052 delete_ref("ORIG_HEAD", NULL
, 0);
1056 * NOTE: Since the "next" and "last" files determine if an am_state
1057 * session is in progress, they should be written last.
1060 write_state_count(state
, "next", state
->cur
);
1061 write_state_count(state
, "last", state
->last
);
1063 strbuf_release(&sb
);
1067 * Increments the patch pointer, and cleans am_state for the application of the
1070 static void am_next(struct am_state
*state
)
1072 struct object_id head
;
1074 free(state
->author_name
);
1075 state
->author_name
= NULL
;
1077 free(state
->author_email
);
1078 state
->author_email
= NULL
;
1080 free(state
->author_date
);
1081 state
->author_date
= NULL
;
1087 unlink(am_path(state
, "author-script"));
1088 unlink(am_path(state
, "final-commit"));
1090 oidclr(&state
->orig_commit
);
1091 unlink(am_path(state
, "original-commit"));
1093 if (!get_oid("HEAD", &head
))
1094 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1096 write_state_text(state
, "abort-safety", "");
1099 write_state_count(state
, "next", state
->cur
);
1103 * Returns the filename of the current patch email.
1105 static const char *msgnum(const struct am_state
*state
)
1107 static struct strbuf sb
= STRBUF_INIT
;
1110 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1116 * Refresh and write index.
1118 static void refresh_and_write_cache(void)
1120 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
1122 hold_locked_index(lock_file
, 1);
1123 refresh_cache(REFRESH_QUIET
);
1124 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1125 die(_("unable to write index file"));
1129 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
1130 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
1131 * strbuf is provided, the space-separated list of files that differ will be
1134 static int index_has_changes(struct strbuf
*sb
)
1136 struct object_id head
;
1139 if (!get_sha1_tree("HEAD", head
.hash
)) {
1140 struct diff_options opt
;
1143 DIFF_OPT_SET(&opt
, EXIT_WITH_STATUS
);
1145 DIFF_OPT_SET(&opt
, QUICK
);
1146 do_diff_cache(head
.hash
, &opt
);
1148 for (i
= 0; sb
&& i
< diff_queued_diff
.nr
; i
++) {
1150 strbuf_addch(sb
, ' ');
1151 strbuf_addstr(sb
, diff_queued_diff
.queue
[i
]->two
->path
);
1154 return DIFF_OPT_TST(&opt
, HAS_CHANGES
) != 0;
1156 for (i
= 0; sb
&& i
< active_nr
; i
++) {
1158 strbuf_addch(sb
, ' ');
1159 strbuf_addstr(sb
, active_cache
[i
]->name
);
1166 * Dies with a user-friendly message on how to proceed after resolving the
1167 * problem. This message can be overridden with state->resolvemsg.
1169 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1171 if (state
->resolvemsg
) {
1172 printf_ln("%s", state
->resolvemsg
);
1174 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1176 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1177 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1178 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1184 static void am_signoff(struct strbuf
*sb
)
1187 struct strbuf mine
= STRBUF_INIT
;
1189 /* Does it end with our own sign-off? */
1190 strbuf_addf(&mine
, "\n%s%s\n",
1192 fmt_name(getenv("GIT_COMMITTER_NAME"),
1193 getenv("GIT_COMMITTER_EMAIL")));
1194 if (mine
.len
< sb
->len
&&
1195 !strcmp(mine
.buf
, sb
->buf
+ sb
->len
- mine
.len
))
1196 goto exit
; /* no need to duplicate */
1198 /* Does it have any Signed-off-by: in the text */
1200 cp
&& *cp
&& (cp
= strstr(cp
, sign_off_header
)) != NULL
;
1201 cp
= strchr(cp
, '\n')) {
1202 if (sb
->buf
== cp
|| cp
[-1] == '\n')
1206 strbuf_addstr(sb
, mine
.buf
+ !!cp
);
1208 strbuf_release(&mine
);
1212 * Appends signoff to the "msg" field of the am_state.
1214 static void am_append_signoff(struct am_state
*state
)
1216 struct strbuf sb
= STRBUF_INIT
;
1218 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1220 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1224 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1225 * state->msg will be set to the patch message. state->author_name,
1226 * state->author_email and state->author_date will be set to the patch author's
1227 * name, email and date respectively. The patch body will be written to the
1228 * state directory's "patch" file.
1230 * Returns 1 if the patch should be skipped, 0 otherwise.
1232 static int parse_mail(struct am_state
*state
, const char *mail
)
1235 struct strbuf sb
= STRBUF_INIT
;
1236 struct strbuf msg
= STRBUF_INIT
;
1237 struct strbuf author_name
= STRBUF_INIT
;
1238 struct strbuf author_date
= STRBUF_INIT
;
1239 struct strbuf author_email
= STRBUF_INIT
;
1243 setup_mailinfo(&mi
);
1246 mi
.metainfo_charset
= get_commit_output_encoding();
1248 mi
.metainfo_charset
= NULL
;
1250 switch (state
->keep
) {
1254 mi
.keep_subject
= 1;
1256 case KEEP_NON_PATCH
:
1257 mi
.keep_non_patch_brackets_in_subject
= 1;
1260 die("BUG: invalid value for state->keep");
1263 if (state
->message_id
)
1264 mi
.add_message_id
= 1;
1266 switch (state
->scissors
) {
1267 case SCISSORS_UNSET
:
1269 case SCISSORS_FALSE
:
1270 mi
.use_scissors
= 0;
1273 mi
.use_scissors
= 1;
1276 die("BUG: invalid value for state->scissors");
1279 mi
.input
= fopen(mail
, "r");
1281 die("could not open input");
1282 mi
.output
= fopen(am_path(state
, "info"), "w");
1284 die("could not open output 'info'");
1285 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1286 die("could not parse patch");
1291 /* Extract message and author information */
1292 fp
= xfopen(am_path(state
, "info"), "r");
1293 while (!strbuf_getline_lf(&sb
, fp
)) {
1296 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1298 strbuf_addch(&msg
, '\n');
1299 strbuf_addstr(&msg
, x
);
1300 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1301 strbuf_addstr(&author_name
, x
);
1302 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1303 strbuf_addstr(&author_email
, x
);
1304 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1305 strbuf_addstr(&author_date
, x
);
1309 /* Skip pine's internal folder data */
1310 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1315 if (is_empty_file(am_path(state
, "patch"))) {
1316 printf_ln(_("Patch is empty. Was it split wrong?"));
1317 die_user_resolve(state
);
1320 strbuf_addstr(&msg
, "\n\n");
1321 strbuf_addbuf(&msg
, &mi
.log_message
);
1322 strbuf_stripspace(&msg
, 0);
1327 assert(!state
->author_name
);
1328 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1330 assert(!state
->author_email
);
1331 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1333 assert(!state
->author_date
);
1334 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1336 assert(!state
->msg
);
1337 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1340 strbuf_release(&msg
);
1341 strbuf_release(&author_date
);
1342 strbuf_release(&author_email
);
1343 strbuf_release(&author_name
);
1344 strbuf_release(&sb
);
1345 clear_mailinfo(&mi
);
1350 * Sets commit_id to the commit hash where the mail was generated from.
1351 * Returns 0 on success, -1 on failure.
1353 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1355 struct strbuf sb
= STRBUF_INIT
;
1356 FILE *fp
= xfopen(mail
, "r");
1359 if (strbuf_getline_lf(&sb
, fp
))
1362 if (!skip_prefix(sb
.buf
, "From ", &x
))
1365 if (get_oid_hex(x
, commit_id
) < 0)
1368 strbuf_release(&sb
);
1374 * Sets state->msg, state->author_name, state->author_email, state->author_date
1375 * to the commit's respective info.
1377 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1379 const char *buffer
, *ident_line
, *msg
;
1381 struct ident_split ident_split
;
1383 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1385 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1387 if (split_ident_line(&ident_split
, ident_line
, ident_len
) < 0)
1388 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1390 assert(!state
->author_name
);
1391 if (ident_split
.name_begin
) {
1392 state
->author_name
=
1393 xmemdupz(ident_split
.name_begin
,
1394 ident_split
.name_end
- ident_split
.name_begin
);
1396 state
->author_name
= xstrdup("");
1398 assert(!state
->author_email
);
1399 if (ident_split
.mail_begin
) {
1400 state
->author_email
=
1401 xmemdupz(ident_split
.mail_begin
,
1402 ident_split
.mail_end
- ident_split
.mail_begin
);
1404 state
->author_email
= xstrdup("");
1406 assert(!state
->author_date
);
1407 state
->author_date
= xstrdup(show_ident_date(&ident_split
, DATE_MODE(NORMAL
)));
1409 assert(!state
->msg
);
1410 msg
= strstr(buffer
, "\n\n");
1412 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1413 state
->msg
= xstrdup(msg
+ 2);
1414 state
->msg_len
= strlen(state
->msg
);
1415 unuse_commit_buffer(commit
, buffer
);
1419 * Writes `commit` as a patch to the state directory's "patch" file.
1421 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1423 struct rev_info rev_info
;
1426 fp
= xfopen(am_path(state
, "patch"), "w");
1427 init_revisions(&rev_info
, NULL
);
1429 rev_info
.abbrev
= 0;
1430 rev_info
.disable_stdin
= 1;
1431 rev_info
.show_root_diff
= 1;
1432 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1433 rev_info
.no_commit_id
= 1;
1434 DIFF_OPT_SET(&rev_info
.diffopt
, BINARY
);
1435 DIFF_OPT_SET(&rev_info
.diffopt
, FULL_INDEX
);
1436 rev_info
.diffopt
.use_color
= 0;
1437 rev_info
.diffopt
.file
= fp
;
1438 rev_info
.diffopt
.close_file
= 1;
1439 add_pending_object(&rev_info
, &commit
->object
, "");
1440 diff_setup_done(&rev_info
.diffopt
);
1441 log_tree_commit(&rev_info
, commit
);
1445 * Writes the diff of the index against HEAD as a patch to the state
1446 * directory's "patch" file.
1448 static void write_index_patch(const struct am_state
*state
)
1451 struct object_id head
;
1452 struct rev_info rev_info
;
1455 if (!get_sha1_tree("HEAD", head
.hash
))
1456 tree
= lookup_tree(head
.hash
);
1458 tree
= lookup_tree(EMPTY_TREE_SHA1_BIN
);
1460 fp
= xfopen(am_path(state
, "patch"), "w");
1461 init_revisions(&rev_info
, NULL
);
1463 rev_info
.disable_stdin
= 1;
1464 rev_info
.no_commit_id
= 1;
1465 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1466 rev_info
.diffopt
.use_color
= 0;
1467 rev_info
.diffopt
.file
= fp
;
1468 rev_info
.diffopt
.close_file
= 1;
1469 add_pending_object(&rev_info
, &tree
->object
, "");
1470 diff_setup_done(&rev_info
.diffopt
);
1471 run_diff_index(&rev_info
, 1);
1475 * Like parse_mail(), but parses the mail by looking up its commit ID
1476 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1479 * state->orig_commit will be set to the original commit ID.
1481 * Will always return 0 as the patch should never be skipped.
1483 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1485 struct commit
*commit
;
1486 struct object_id commit_oid
;
1488 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1489 die(_("could not parse %s"), mail
);
1491 commit
= lookup_commit_or_die(commit_oid
.hash
, mail
);
1493 get_commit_info(state
, commit
);
1495 write_commit_patch(state
, commit
);
1497 oidcpy(&state
->orig_commit
, &commit_oid
);
1498 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1504 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1505 * `index_file` is not NULL, the patch will be applied to that index.
1507 static int run_apply(const struct am_state
*state
, const char *index_file
)
1509 struct argv_array apply_paths
= ARGV_ARRAY_INIT
;
1510 struct argv_array apply_opts
= ARGV_ARRAY_INIT
;
1511 struct apply_state apply_state
;
1513 static struct lock_file lock_file
;
1514 int force_apply
= 0;
1517 if (init_apply_state(&apply_state
, NULL
, &lock_file
))
1518 die("BUG: init_apply_state() failed");
1520 argv_array_push(&apply_opts
, "apply");
1521 argv_array_pushv(&apply_opts
, state
->git_apply_opts
.argv
);
1523 opts_left
= apply_parse_options(apply_opts
.argc
, apply_opts
.argv
,
1524 &apply_state
, &force_apply
, &options
,
1528 die("unknown option passed through to git apply");
1531 apply_state
.index_file
= index_file
;
1532 apply_state
.cached
= 1;
1534 apply_state
.check_index
= 1;
1537 * If we are allowed to fall back on 3-way merge, don't give false
1538 * errors during the initial attempt.
1540 if (state
->threeway
&& !index_file
)
1541 apply_state
.apply_verbosity
= verbosity_silent
;
1543 if (check_apply_state(&apply_state
, force_apply
))
1544 die("BUG: check_apply_state() failed");
1546 argv_array_push(&apply_paths
, am_path(state
, "patch"));
1548 res
= apply_all_patches(&apply_state
, apply_paths
.argc
, apply_paths
.argv
, options
);
1550 argv_array_clear(&apply_paths
);
1551 argv_array_clear(&apply_opts
);
1552 clear_apply_state(&apply_state
);
1558 /* Reload index as apply_all_patches() will have modified it. */
1560 read_cache_from(index_file
);
1567 * Builds an index that contains just the blobs needed for a 3way merge.
1569 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1571 struct child_process cp
= CHILD_PROCESS_INIT
;
1574 argv_array_push(&cp
.args
, "apply");
1575 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1576 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1577 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1579 if (run_command(&cp
))
1586 * Attempt a threeway merge, using index_path as the temporary index.
1588 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1590 struct object_id orig_tree
, their_tree
, our_tree
;
1591 const struct object_id
*bases
[1] = { &orig_tree
};
1592 struct merge_options o
;
1593 struct commit
*result
;
1594 char *their_tree_name
;
1596 if (get_oid("HEAD", &our_tree
) < 0)
1597 hashcpy(our_tree
.hash
, EMPTY_TREE_SHA1_BIN
);
1599 if (build_fake_ancestor(state
, index_path
))
1600 return error("could not build fake ancestor");
1603 read_cache_from(index_path
);
1605 if (write_index_as_tree(orig_tree
.hash
, &the_index
, index_path
, 0, NULL
))
1606 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1608 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1610 if (!state
->quiet
) {
1612 * List paths that needed 3-way fallback, so that the user can
1613 * review them with extra care to spot mismerges.
1615 struct rev_info rev_info
;
1616 const char *diff_filter_str
= "--diff-filter=AM";
1618 init_revisions(&rev_info
, NULL
);
1619 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1620 diff_opt_parse(&rev_info
.diffopt
, &diff_filter_str
, 1, rev_info
.prefix
);
1621 add_pending_sha1(&rev_info
, "HEAD", our_tree
.hash
, 0);
1622 diff_setup_done(&rev_info
.diffopt
);
1623 run_diff_index(&rev_info
, 1);
1626 if (run_apply(state
, index_path
))
1627 return error(_("Did you hand edit your patch?\n"
1628 "It does not apply to blobs recorded in its index."));
1630 if (write_index_as_tree(their_tree
.hash
, &the_index
, index_path
, 0, NULL
))
1631 return error("could not write tree");
1633 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1639 * This is not so wrong. Depending on which base we picked, orig_tree
1640 * may be wildly different from ours, but their_tree has the same set of
1641 * wildly different changes in parts the patch did not touch, so
1642 * recursive ends up canceling them, saying that we reverted all those
1646 init_merge_options(&o
);
1649 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1650 o
.branch2
= their_tree_name
;
1655 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1656 rerere(state
->allow_rerere_autoupdate
);
1657 free(their_tree_name
);
1658 return error(_("Failed to merge in the changes."));
1661 free(their_tree_name
);
1666 * Commits the current index with state->msg as the commit message and
1667 * state->author_name, state->author_email and state->author_date as the author
1670 static void do_commit(const struct am_state
*state
)
1672 struct object_id tree
, parent
, commit
;
1673 const struct object_id
*old_oid
;
1674 struct commit_list
*parents
= NULL
;
1675 const char *reflog_msg
, *author
;
1676 struct strbuf sb
= STRBUF_INIT
;
1678 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1681 if (write_cache_as_tree(tree
.hash
, 0, NULL
))
1682 die(_("git write-tree failed to write a tree"));
1684 if (!get_sha1_commit("HEAD", parent
.hash
)) {
1686 commit_list_insert(lookup_commit(parent
.hash
), &parents
);
1689 say(state
, stderr
, _("applying to an empty history"));
1692 author
= fmt_ident(state
->author_name
, state
->author_email
,
1693 state
->ignore_date
? NULL
: state
->author_date
,
1696 if (state
->committer_date_is_author_date
)
1697 setenv("GIT_COMMITTER_DATE",
1698 state
->ignore_date
? "" : state
->author_date
, 1);
1700 if (commit_tree(state
->msg
, state
->msg_len
, tree
.hash
, parents
, commit
.hash
,
1701 author
, state
->sign_commit
))
1702 die(_("failed to write commit object"));
1704 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1708 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1711 update_ref_oid(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1712 UPDATE_REFS_DIE_ON_ERR
);
1714 if (state
->rebasing
) {
1715 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1717 assert(!is_null_oid(&state
->orig_commit
));
1718 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1719 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1723 run_hook_le(NULL
, "post-applypatch", NULL
);
1725 strbuf_release(&sb
);
1729 * Validates the am_state for resuming -- the "msg" and authorship fields must
1732 static void validate_resume_state(const struct am_state
*state
)
1735 die(_("cannot resume: %s does not exist."),
1736 am_path(state
, "final-commit"));
1738 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1739 die(_("cannot resume: %s does not exist."),
1740 am_path(state
, "author-script"));
1744 * Interactively prompt the user on whether the current patch should be
1747 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1750 static int do_interactive(struct am_state
*state
)
1755 die(_("cannot be interactive without stdin connected to a terminal."));
1760 puts(_("Commit Body is:"));
1761 puts("--------------------------");
1762 printf("%s", state
->msg
);
1763 puts("--------------------------");
1766 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1767 * in your translation. The program will only accept English
1768 * input at this point.
1770 reply
= git_prompt(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "), PROMPT_ECHO
);
1774 } else if (*reply
== 'y' || *reply
== 'Y') {
1776 } else if (*reply
== 'a' || *reply
== 'A') {
1777 state
->interactive
= 0;
1779 } else if (*reply
== 'n' || *reply
== 'N') {
1781 } else if (*reply
== 'e' || *reply
== 'E') {
1782 struct strbuf msg
= STRBUF_INIT
;
1784 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1786 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1788 strbuf_release(&msg
);
1789 } else if (*reply
== 'v' || *reply
== 'V') {
1790 const char *pager
= git_pager(1);
1791 struct child_process cp
= CHILD_PROCESS_INIT
;
1795 prepare_pager_args(&cp
, pager
);
1796 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1803 * Applies all queued mail.
1805 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1806 * well as the state directory's "patch" file is used as-is for applying the
1807 * patch and committing it.
1809 static void am_run(struct am_state
*state
, int resume
)
1811 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1812 struct strbuf sb
= STRBUF_INIT
;
1814 unlink(am_path(state
, "dirtyindex"));
1816 refresh_and_write_cache();
1818 if (index_has_changes(&sb
)) {
1819 write_state_bool(state
, "dirtyindex", 1);
1820 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1823 strbuf_release(&sb
);
1825 while (state
->cur
<= state
->last
) {
1826 const char *mail
= am_path(state
, msgnum(state
));
1831 if (!file_exists(mail
))
1835 validate_resume_state(state
);
1839 if (state
->rebasing
)
1840 skip
= parse_mail_rebase(state
, mail
);
1842 skip
= parse_mail(state
, mail
);
1845 goto next
; /* mail should be skipped */
1847 write_author_script(state
);
1848 write_commit_msg(state
);
1851 if (state
->interactive
&& do_interactive(state
))
1854 if (run_applypatch_msg_hook(state
))
1857 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1859 apply_status
= run_apply(state
, NULL
);
1861 if (apply_status
&& state
->threeway
) {
1862 struct strbuf sb
= STRBUF_INIT
;
1864 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1865 apply_status
= fall_back_threeway(state
, sb
.buf
);
1866 strbuf_release(&sb
);
1869 * Applying the patch to an earlier tree and merging
1870 * the result may have produced the same tree as ours.
1872 if (!apply_status
&& !index_has_changes(NULL
)) {
1873 say(state
, stdout
, _("No changes -- Patch already applied."));
1879 int advice_amworkdir
= 1;
1881 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1882 linelen(state
->msg
), state
->msg
);
1884 git_config_get_bool("advice.amworkdir", &advice_amworkdir
);
1886 if (advice_amworkdir
)
1887 printf_ln(_("The copy of the patch that failed is found in: %s"),
1888 am_path(state
, "patch"));
1890 die_user_resolve(state
);
1903 if (!is_empty_file(am_path(state
, "rewritten"))) {
1904 assert(state
->rebasing
);
1905 copy_notes_for_rebase(state
);
1906 run_post_rewrite_hook(state
);
1910 * In rebasing mode, it's up to the caller to take care of
1913 if (!state
->rebasing
) {
1916 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1921 * Resume the current am session after patch application failure. The user did
1922 * all the hard work, and we do not have to do any patch application. Just
1923 * trust and commit what the user has in the index and working tree.
1925 static void am_resolve(struct am_state
*state
)
1927 validate_resume_state(state
);
1929 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1931 if (!index_has_changes(NULL
)) {
1932 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1933 "If there is nothing left to stage, chances are that something else\n"
1934 "already introduced the same changes; you might want to skip this patch."));
1935 die_user_resolve(state
);
1938 if (unmerged_cache()) {
1939 printf_ln(_("You still have unmerged paths in your index.\n"
1940 "Did you forget to use 'git add'?"));
1941 die_user_resolve(state
);
1944 if (state
->interactive
) {
1945 write_index_patch(state
);
1946 if (do_interactive(state
))
1961 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1962 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1965 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1967 struct lock_file
*lock_file
;
1968 struct unpack_trees_options opts
;
1969 struct tree_desc t
[2];
1971 if (parse_tree(head
) || parse_tree(remote
))
1974 lock_file
= xcalloc(1, sizeof(struct lock_file
));
1975 hold_locked_index(lock_file
, 1);
1977 refresh_cache(REFRESH_QUIET
);
1979 memset(&opts
, 0, sizeof(opts
));
1981 opts
.src_index
= &the_index
;
1982 opts
.dst_index
= &the_index
;
1986 opts
.fn
= twoway_merge
;
1987 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1988 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1990 if (unpack_trees(2, t
, &opts
)) {
1991 rollback_lock_file(lock_file
);
1995 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1996 die(_("unable to write new index file"));
2002 * Merges a tree into the index. The index's stat info will take precedence
2003 * over the merged tree's. Returns 0 on success, -1 on failure.
2005 static int merge_tree(struct tree
*tree
)
2007 struct lock_file
*lock_file
;
2008 struct unpack_trees_options opts
;
2009 struct tree_desc t
[1];
2011 if (parse_tree(tree
))
2014 lock_file
= xcalloc(1, sizeof(struct lock_file
));
2015 hold_locked_index(lock_file
, 1);
2017 memset(&opts
, 0, sizeof(opts
));
2019 opts
.src_index
= &the_index
;
2020 opts
.dst_index
= &the_index
;
2022 opts
.fn
= oneway_merge
;
2023 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
2025 if (unpack_trees(1, t
, &opts
)) {
2026 rollback_lock_file(lock_file
);
2030 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
2031 die(_("unable to write new index file"));
2037 * Clean the index without touching entries that are not modified between
2038 * `head` and `remote`.
2040 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
2042 struct tree
*head_tree
, *remote_tree
, *index_tree
;
2043 struct object_id index
;
2045 head_tree
= parse_tree_indirect(head
->hash
);
2047 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
2049 remote_tree
= parse_tree_indirect(remote
->hash
);
2051 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
2053 read_cache_unmerged();
2055 if (fast_forward_to(head_tree
, head_tree
, 1))
2058 if (write_cache_as_tree(index
.hash
, 0, NULL
))
2061 index_tree
= parse_tree_indirect(index
.hash
);
2063 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
2065 if (fast_forward_to(index_tree
, remote_tree
, 0))
2068 if (merge_tree(remote_tree
))
2071 remove_branch_state();
2077 * Resets rerere's merge resolution metadata.
2079 static void am_rerere_clear(void)
2081 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
2082 rerere_clear(&merge_rr
);
2083 string_list_clear(&merge_rr
, 1);
2087 * Resume the current am session by skipping the current patch.
2089 static void am_skip(struct am_state
*state
)
2091 struct object_id head
;
2095 if (get_oid("HEAD", &head
))
2096 hashcpy(head
.hash
, EMPTY_TREE_SHA1_BIN
);
2098 if (clean_index(&head
, &head
))
2099 die(_("failed to clean index"));
2107 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2109 * It is not safe to reset HEAD when:
2110 * 1. git-am previously failed because the index was dirty.
2111 * 2. HEAD has moved since git-am previously failed.
2113 static int safe_to_abort(const struct am_state
*state
)
2115 struct strbuf sb
= STRBUF_INIT
;
2116 struct object_id abort_safety
, head
;
2118 if (file_exists(am_path(state
, "dirtyindex")))
2121 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2122 if (get_oid_hex(sb
.buf
, &abort_safety
))
2123 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2125 oidclr(&abort_safety
);
2127 if (get_oid("HEAD", &head
))
2130 if (!oidcmp(&head
, &abort_safety
))
2133 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2134 "Not rewinding to ORIG_HEAD"));
2140 * Aborts the current am session if it is safe to do so.
2142 static void am_abort(struct am_state
*state
)
2144 struct object_id curr_head
, orig_head
;
2145 int has_curr_head
, has_orig_head
;
2148 if (!safe_to_abort(state
)) {
2155 curr_branch
= resolve_refdup("HEAD", 0, curr_head
.hash
, NULL
);
2156 has_curr_head
= !is_null_oid(&curr_head
);
2158 hashcpy(curr_head
.hash
, EMPTY_TREE_SHA1_BIN
);
2160 has_orig_head
= !get_oid("ORIG_HEAD", &orig_head
);
2162 hashcpy(orig_head
.hash
, EMPTY_TREE_SHA1_BIN
);
2164 clean_index(&curr_head
, &orig_head
);
2167 update_ref_oid("am --abort", "HEAD", &orig_head
,
2168 has_curr_head
? &curr_head
: NULL
, 0,
2169 UPDATE_REFS_DIE_ON_ERR
);
2170 else if (curr_branch
)
2171 delete_ref(curr_branch
, NULL
, REF_NODEREF
);
2178 * parse_options() callback that validates and sets opt->value to the
2179 * PATCH_FORMAT_* enum value corresponding to `arg`.
2181 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2183 int *opt_value
= opt
->value
;
2185 if (!strcmp(arg
, "mbox"))
2186 *opt_value
= PATCH_FORMAT_MBOX
;
2187 else if (!strcmp(arg
, "stgit"))
2188 *opt_value
= PATCH_FORMAT_STGIT
;
2189 else if (!strcmp(arg
, "stgit-series"))
2190 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2191 else if (!strcmp(arg
, "hg"))
2192 *opt_value
= PATCH_FORMAT_HG
;
2193 else if (!strcmp(arg
, "mboxrd"))
2194 *opt_value
= PATCH_FORMAT_MBOXRD
;
2196 return error(_("Invalid value for --patch-format: %s"), arg
);
2208 static int git_am_config(const char *k
, const char *v
, void *cb
)
2212 status
= git_gpg_config(k
, v
, NULL
);
2216 return git_default_config(k
, v
, NULL
);
2219 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2221 struct am_state state
;
2224 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2225 enum resume_mode resume
= RESUME_FALSE
;
2228 const char * const usage
[] = {
2229 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2230 N_("git am [<options>] (--continue | --skip | --abort)"),
2234 struct option options
[] = {
2235 OPT_BOOL('i', "interactive", &state
.interactive
,
2236 N_("run interactively")),
2237 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2238 N_("historical option -- no-op")),
2239 OPT_BOOL('3', "3way", &state
.threeway
,
2240 N_("allow fall back on 3way merging if needed")),
2241 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2242 OPT_SET_INT('s', "signoff", &state
.signoff
,
2243 N_("add a Signed-off-by line to the commit message"),
2245 OPT_BOOL('u', "utf8", &state
.utf8
,
2246 N_("recode into utf8 (default)")),
2247 OPT_SET_INT('k', "keep", &state
.keep
,
2248 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2249 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2250 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2251 OPT_BOOL('m', "message-id", &state
.message_id
,
2252 N_("pass -m flag to git-mailinfo")),
2253 { OPTION_SET_INT
, 0, "keep-cr", &keep_cr
, NULL
,
2254 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2255 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1},
2256 { OPTION_SET_INT
, 0, "no-keep-cr", &keep_cr
, NULL
,
2257 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2258 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 0},
2259 OPT_BOOL('c', "scissors", &state
.scissors
,
2260 N_("strip everything before a scissors line")),
2261 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2262 N_("pass it through git-apply"),
2264 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2265 N_("pass it through git-apply"),
2267 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2268 N_("pass it through git-apply"),
2270 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2271 N_("pass it through git-apply"),
2273 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2274 N_("pass it through git-apply"),
2276 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2277 N_("pass it through git-apply"),
2279 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2280 N_("pass it through git-apply"),
2282 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2283 N_("pass it through git-apply"),
2285 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2286 N_("format the patch(es) are in"),
2287 parse_opt_patchformat
),
2288 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2289 N_("pass it through git-apply"),
2291 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2292 N_("override error message when patch failure occurs")),
2293 OPT_CMDMODE(0, "continue", &resume
,
2294 N_("continue applying patches after resolving a conflict"),
2296 OPT_CMDMODE('r', "resolved", &resume
,
2297 N_("synonyms for --continue"),
2299 OPT_CMDMODE(0, "skip", &resume
,
2300 N_("skip the current patch"),
2302 OPT_CMDMODE(0, "abort", &resume
,
2303 N_("restore the original branch and abort the patching operation."),
2305 OPT_BOOL(0, "committer-date-is-author-date",
2306 &state
.committer_date_is_author_date
,
2307 N_("lie about committer date")),
2308 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2309 N_("use current timestamp for author date")),
2310 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2311 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2312 N_("GPG-sign commits"),
2313 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2314 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2315 N_("(internal use for git-rebase)")),
2319 git_config(git_am_config
, NULL
);
2321 am_state_init(&state
, git_path("rebase-apply"));
2323 in_progress
= am_in_progress(&state
);
2327 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2330 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2331 "it will be removed. Please do not use it anymore."));
2333 /* Ensure a valid committer ident can be constructed */
2334 git_committer_info(IDENT_STRICT
);
2336 if (read_index_preload(&the_index
, NULL
) < 0)
2337 die(_("failed to read the index"));
2341 * Catch user error to feed us patches when there is a session
2344 * 1. mbox path(s) are provided on the command-line.
2345 * 2. stdin is not a tty: the user is trying to feed us a patch
2346 * from standard input. This is somewhat unreliable -- stdin
2347 * could be /dev/null for example and the caller did not
2348 * intend to feed us a patch but wanted to continue
2351 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
2352 die(_("previous rebase directory %s still exists but mbox given."),
2355 if (resume
== RESUME_FALSE
)
2356 resume
= RESUME_APPLY
;
2358 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2359 am_append_signoff(&state
);
2361 struct argv_array paths
= ARGV_ARRAY_INIT
;
2365 * Handle stray state directory in the independent-run case. In
2366 * the --rebasing case, it is up to the caller to take care of
2367 * stray directories.
2369 if (file_exists(state
.dir
) && !state
.rebasing
) {
2370 if (resume
== RESUME_ABORT
) {
2372 am_state_release(&state
);
2376 die(_("Stray %s directory found.\n"
2377 "Use \"git am --abort\" to remove it."),
2382 die(_("Resolve operation not in progress, we are not resuming."));
2384 for (i
= 0; i
< argc
; i
++) {
2385 if (is_absolute_path(argv
[i
]) || !prefix
)
2386 argv_array_push(&paths
, argv
[i
]);
2388 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2391 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2393 argv_array_clear(&paths
);
2403 case RESUME_RESOLVED
:
2413 die("BUG: invalid resume value");
2416 am_state_release(&state
);