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"
33 * Returns 1 if the file is empty or does not exist, 0 otherwise.
35 static int is_empty_file(const char *filename
)
39 if (stat(filename
, &st
) < 0) {
42 die_errno(_("could not stat %s"), filename
);
49 * Like strbuf_getline(), but treats both '\n' and "\r\n" as line terminators.
51 static int strbuf_getline_crlf(struct strbuf
*sb
, FILE *fp
)
53 if (strbuf_getwholeline(sb
, fp
, '\n'))
55 if (sb
->buf
[sb
->len
- 1] == '\n') {
56 strbuf_setlen(sb
, sb
->len
- 1);
57 if (sb
->len
> 0 && sb
->buf
[sb
->len
- 1] == '\r')
58 strbuf_setlen(sb
, sb
->len
- 1);
64 * Returns the length of the first line of msg.
66 static int linelen(const char *msg
)
68 return strchrnul(msg
, '\n') - msg
;
72 * Returns true if `str` consists of only whitespace, false otherwise.
74 static int str_isspace(const char *str
)
84 PATCH_FORMAT_UNKNOWN
= 0,
87 PATCH_FORMAT_STGIT_SERIES
,
93 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
94 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
99 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
100 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
106 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
110 /* state directory path */
113 /* current and last patch numbers, 1-indexed */
117 /* commit metadata and message */
124 /* when --rebasing, records the original commit the patch came from */
125 unsigned char orig_commit
[GIT_SHA1_RAWSZ
];
127 /* number of digits in patch filename */
130 /* various operating modes and command line options */
134 int signoff
; /* enum signoff_type */
136 int keep
; /* enum keep_type */
138 int scissors
; /* enum scissors_type */
139 struct argv_array git_apply_opts
;
140 const char *resolvemsg
;
141 int committer_date_is_author_date
;
143 int allow_rerere_autoupdate
;
144 const char *sign_commit
;
149 * Initializes am_state with the default values. The state directory is set to
152 static void am_state_init(struct am_state
*state
, const char *dir
)
156 memset(state
, 0, sizeof(*state
));
159 state
->dir
= xstrdup(dir
);
163 git_config_get_bool("am.threeway", &state
->threeway
);
167 git_config_get_bool("am.messageid", &state
->message_id
);
169 state
->scissors
= SCISSORS_UNSET
;
171 argv_array_init(&state
->git_apply_opts
);
173 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
174 state
->sign_commit
= gpgsign
? "" : NULL
;
178 * Releases memory allocated by an am_state.
180 static void am_state_release(struct am_state
*state
)
183 free(state
->author_name
);
184 free(state
->author_email
);
185 free(state
->author_date
);
187 argv_array_clear(&state
->git_apply_opts
);
191 * Returns path relative to the am_state directory.
193 static inline const char *am_path(const struct am_state
*state
, const char *path
)
195 return mkpath("%s/%s", state
->dir
, path
);
199 * For convenience to call write_file()
201 static int write_state_text(const struct am_state
*state
,
202 const char *name
, const char *string
)
204 return write_file(am_path(state
, name
), "%s", string
);
207 static int write_state_count(const struct am_state
*state
,
208 const char *name
, int value
)
210 return write_file(am_path(state
, name
), "%d", value
);
213 static int write_state_bool(const struct am_state
*state
,
214 const char *name
, int value
)
216 return write_state_text(state
, name
, value
? "t" : "f");
220 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
223 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
229 vfprintf(fp
, fmt
, ap
);
236 * Returns 1 if there is an am session in progress, 0 otherwise.
238 static int am_in_progress(const struct am_state
*state
)
242 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
244 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
246 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
252 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
253 * number of bytes read on success, -1 if the file does not exist. If `trim` is
254 * set, trailing whitespace will be removed.
256 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
257 const char *file
, int trim
)
261 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
271 die_errno(_("could not read '%s'"), am_path(state
, file
));
275 * Reads a KEY=VALUE shell variable assignment from `fp`, returning the VALUE
276 * as a newly-allocated string. VALUE must be a quoted string, and the KEY must
277 * match `key`. Returns NULL on failure.
279 * This is used by read_author_script() to read the GIT_AUTHOR_* variables from
282 static char *read_shell_var(FILE *fp
, const char *key
)
284 struct strbuf sb
= STRBUF_INIT
;
287 if (strbuf_getline(&sb
, fp
, '\n'))
290 if (!skip_prefix(sb
.buf
, key
, &str
))
293 if (!skip_prefix(str
, "=", &str
))
296 strbuf_remove(&sb
, 0, str
- sb
.buf
);
298 str
= sq_dequote(sb
.buf
);
302 return strbuf_detach(&sb
, NULL
);
310 * Reads and parses the state directory's "author-script" file, and sets
311 * state->author_name, state->author_email and state->author_date accordingly.
312 * Returns 0 on success, -1 if the file could not be parsed.
314 * The author script is of the format:
316 * GIT_AUTHOR_NAME='$author_name'
317 * GIT_AUTHOR_EMAIL='$author_email'
318 * GIT_AUTHOR_DATE='$author_date'
320 * where $author_name, $author_email and $author_date are quoted. We are strict
321 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
322 * script, and thus if the file differs from what this function expects, it is
323 * better to bail out than to do something that the user does not expect.
325 static int read_author_script(struct am_state
*state
)
327 const char *filename
= am_path(state
, "author-script");
330 assert(!state
->author_name
);
331 assert(!state
->author_email
);
332 assert(!state
->author_date
);
334 fp
= fopen(filename
, "r");
338 die_errno(_("could not open '%s' for reading"), filename
);
341 state
->author_name
= read_shell_var(fp
, "GIT_AUTHOR_NAME");
342 if (!state
->author_name
) {
347 state
->author_email
= read_shell_var(fp
, "GIT_AUTHOR_EMAIL");
348 if (!state
->author_email
) {
353 state
->author_date
= read_shell_var(fp
, "GIT_AUTHOR_DATE");
354 if (!state
->author_date
) {
359 if (fgetc(fp
) != EOF
) {
369 * Saves state->author_name, state->author_email and state->author_date in the
370 * state directory's "author-script" file.
372 static void write_author_script(const struct am_state
*state
)
374 struct strbuf sb
= STRBUF_INIT
;
376 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
377 sq_quote_buf(&sb
, state
->author_name
);
378 strbuf_addch(&sb
, '\n');
380 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
381 sq_quote_buf(&sb
, state
->author_email
);
382 strbuf_addch(&sb
, '\n');
384 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
385 sq_quote_buf(&sb
, state
->author_date
);
386 strbuf_addch(&sb
, '\n');
388 write_state_text(state
, "author-script", sb
.buf
);
394 * Reads the commit message from the state directory's "final-commit" file,
395 * setting state->msg to its contents and state->msg_len to the length of its
398 * Returns 0 on success, -1 if the file does not exist.
400 static int read_commit_msg(struct am_state
*state
)
402 struct strbuf sb
= STRBUF_INIT
;
406 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
411 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
416 * Saves state->msg in the state directory's "final-commit" file.
418 static void write_commit_msg(const struct am_state
*state
)
421 const char *filename
= am_path(state
, "final-commit");
423 fd
= xopen(filename
, O_WRONLY
| O_CREAT
, 0666);
424 if (write_in_full(fd
, state
->msg
, state
->msg_len
) < 0)
425 die_errno(_("could not write to %s"), filename
);
430 * Loads state from disk.
432 static void am_load(struct am_state
*state
)
434 struct strbuf sb
= STRBUF_INIT
;
436 if (read_state_file(&sb
, state
, "next", 1) < 0)
437 die("BUG: state file 'next' does not exist");
438 state
->cur
= strtol(sb
.buf
, NULL
, 10);
440 if (read_state_file(&sb
, state
, "last", 1) < 0)
441 die("BUG: state file 'last' does not exist");
442 state
->last
= strtol(sb
.buf
, NULL
, 10);
444 if (read_author_script(state
) < 0)
445 die(_("could not parse author script"));
447 read_commit_msg(state
);
449 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
450 hashclr(state
->orig_commit
);
451 else if (get_sha1_hex(sb
.buf
, state
->orig_commit
) < 0)
452 die(_("could not parse %s"), am_path(state
, "original-commit"));
454 read_state_file(&sb
, state
, "threeway", 1);
455 state
->threeway
= !strcmp(sb
.buf
, "t");
457 read_state_file(&sb
, state
, "quiet", 1);
458 state
->quiet
= !strcmp(sb
.buf
, "t");
460 read_state_file(&sb
, state
, "sign", 1);
461 state
->signoff
= !strcmp(sb
.buf
, "t");
463 read_state_file(&sb
, state
, "utf8", 1);
464 state
->utf8
= !strcmp(sb
.buf
, "t");
466 read_state_file(&sb
, state
, "keep", 1);
467 if (!strcmp(sb
.buf
, "t"))
468 state
->keep
= KEEP_TRUE
;
469 else if (!strcmp(sb
.buf
, "b"))
470 state
->keep
= KEEP_NON_PATCH
;
472 state
->keep
= KEEP_FALSE
;
474 read_state_file(&sb
, state
, "messageid", 1);
475 state
->message_id
= !strcmp(sb
.buf
, "t");
477 read_state_file(&sb
, state
, "scissors", 1);
478 if (!strcmp(sb
.buf
, "t"))
479 state
->scissors
= SCISSORS_TRUE
;
480 else if (!strcmp(sb
.buf
, "f"))
481 state
->scissors
= SCISSORS_FALSE
;
483 state
->scissors
= SCISSORS_UNSET
;
485 read_state_file(&sb
, state
, "apply-opt", 1);
486 argv_array_clear(&state
->git_apply_opts
);
487 if (sq_dequote_to_argv_array(sb
.buf
, &state
->git_apply_opts
) < 0)
488 die(_("could not parse %s"), am_path(state
, "apply-opt"));
490 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
496 * Removes the am_state directory, forcefully terminating the current am
499 static void am_destroy(const struct am_state
*state
)
501 struct strbuf sb
= STRBUF_INIT
;
503 strbuf_addstr(&sb
, state
->dir
);
504 remove_dir_recursively(&sb
, 0);
509 * Runs applypatch-msg hook. Returns its exit code.
511 static int run_applypatch_msg_hook(struct am_state
*state
)
516 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
521 if (read_commit_msg(state
) < 0)
522 die(_("'%s' was deleted by the applypatch-msg hook"),
523 am_path(state
, "final-commit"));
530 * Runs post-rewrite hook. Returns it exit code.
532 static int run_post_rewrite_hook(const struct am_state
*state
)
534 struct child_process cp
= CHILD_PROCESS_INIT
;
535 const char *hook
= find_hook("post-rewrite");
541 argv_array_push(&cp
.args
, hook
);
542 argv_array_push(&cp
.args
, "rebase");
544 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
545 cp
.stdout_to_stderr
= 1;
547 ret
= run_command(&cp
);
554 * Reads the state directory's "rewritten" file, and copies notes from the old
555 * commits listed in the file to their rewritten commits.
557 * Returns 0 on success, -1 on failure.
559 static int copy_notes_for_rebase(const struct am_state
*state
)
561 struct notes_rewrite_cfg
*c
;
562 struct strbuf sb
= STRBUF_INIT
;
563 const char *invalid_line
= _("Malformed input line: '%s'.");
564 const char *msg
= "Notes added by 'git rebase'";
568 assert(state
->rebasing
);
570 c
= init_copy_notes_for_rewrite("rebase");
574 fp
= xfopen(am_path(state
, "rewritten"), "r");
576 while (!strbuf_getline(&sb
, fp
, '\n')) {
577 unsigned char from_obj
[GIT_SHA1_RAWSZ
], to_obj
[GIT_SHA1_RAWSZ
];
579 if (sb
.len
!= GIT_SHA1_HEXSZ
* 2 + 1) {
580 ret
= error(invalid_line
, sb
.buf
);
584 if (get_sha1_hex(sb
.buf
, from_obj
)) {
585 ret
= error(invalid_line
, sb
.buf
);
589 if (sb
.buf
[GIT_SHA1_HEXSZ
] != ' ') {
590 ret
= error(invalid_line
, sb
.buf
);
594 if (get_sha1_hex(sb
.buf
+ GIT_SHA1_HEXSZ
+ 1, to_obj
)) {
595 ret
= error(invalid_line
, sb
.buf
);
599 if (copy_note_for_rewrite(c
, from_obj
, to_obj
))
600 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
601 sha1_to_hex(from_obj
), sha1_to_hex(to_obj
));
605 finish_copy_notes_for_rewrite(c
, msg
);
612 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
613 * non-indented lines and checking if they look like they begin with valid
614 * header field names.
616 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
618 static int is_mail(FILE *fp
)
620 const char *header_regex
= "^[!-9;-~]+:";
621 struct strbuf sb
= STRBUF_INIT
;
625 if (fseek(fp
, 0L, SEEK_SET
))
626 die_errno(_("fseek failed"));
628 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
629 die("invalid pattern: %s", header_regex
);
631 while (!strbuf_getline_crlf(&sb
, fp
)) {
633 break; /* End of header */
635 /* Ignore indented folded lines */
636 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
639 /* It's a header if it matches header_regex */
640 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
653 * Attempts to detect the patch_format of the patches contained in `paths`,
654 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
657 static int detect_patch_format(const char **paths
)
659 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
660 struct strbuf l1
= STRBUF_INIT
;
661 struct strbuf l2
= STRBUF_INIT
;
662 struct strbuf l3
= STRBUF_INIT
;
666 * We default to mbox format if input is from stdin and for directories
668 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
669 return PATCH_FORMAT_MBOX
;
672 * Otherwise, check the first few lines of the first patch, starting
673 * from the first non-blank line, to try to detect its format.
676 fp
= xfopen(*paths
, "r");
678 while (!strbuf_getline_crlf(&l1
, fp
)) {
683 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
684 ret
= PATCH_FORMAT_MBOX
;
688 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
689 ret
= PATCH_FORMAT_STGIT_SERIES
;
693 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
694 ret
= PATCH_FORMAT_HG
;
699 strbuf_getline_crlf(&l2
, fp
);
701 strbuf_getline_crlf(&l3
, fp
);
704 * If the second line is empty and the third is a From, Author or Date
705 * entry, this is likely an StGit patch.
707 if (l1
.len
&& !l2
.len
&&
708 (starts_with(l3
.buf
, "From:") ||
709 starts_with(l3
.buf
, "Author:") ||
710 starts_with(l3
.buf
, "Date:"))) {
711 ret
= PATCH_FORMAT_STGIT
;
715 if (l1
.len
&& is_mail(fp
)) {
716 ret
= PATCH_FORMAT_MBOX
;
727 * Splits out individual email patches from `paths`, where each path is either
728 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
730 static int split_mail_mbox(struct am_state
*state
, const char **paths
, int keep_cr
)
732 struct child_process cp
= CHILD_PROCESS_INIT
;
733 struct strbuf last
= STRBUF_INIT
;
736 argv_array_push(&cp
.args
, "mailsplit");
737 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
738 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
739 argv_array_push(&cp
.args
, "-b");
741 argv_array_push(&cp
.args
, "--keep-cr");
742 argv_array_push(&cp
.args
, "--");
743 argv_array_pushv(&cp
.args
, paths
);
745 if (capture_command(&cp
, &last
, 8))
749 state
->last
= strtol(last
.buf
, NULL
, 10);
755 * Callback signature for split_mail_conv(). The foreign patch should be
756 * read from `in`, and the converted patch (in RFC2822 mail format) should be
757 * written to `out`. Return 0 on success, or -1 on failure.
759 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
762 * Calls `fn` for each file in `paths` to convert the foreign patch to the
763 * RFC2822 mail format suitable for parsing with git-mailinfo.
765 * Returns 0 on success, -1 on failure.
767 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
768 const char **paths
, int keep_cr
)
770 static const char *stdin_only
[] = {"-", NULL
};
776 for (i
= 0; *paths
; paths
++, i
++) {
781 if (!strcmp(*paths
, "-"))
784 in
= fopen(*paths
, "r");
787 return error(_("could not open '%s' for reading: %s"),
788 *paths
, strerror(errno
));
790 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
792 out
= fopen(mail
, "w");
794 return error(_("could not open '%s' for writing: %s"),
795 mail
, strerror(errno
));
797 ret
= fn(out
, in
, keep_cr
);
803 return error(_("could not parse patch '%s'"), *paths
);
812 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
813 * message suitable for parsing with git-mailinfo.
815 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
817 struct strbuf sb
= STRBUF_INIT
;
818 int subject_printed
= 0;
820 while (!strbuf_getline(&sb
, in
, '\n')) {
823 if (str_isspace(sb
.buf
))
825 else if (skip_prefix(sb
.buf
, "Author:", &str
))
826 fprintf(out
, "From:%s\n", str
);
827 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
828 fprintf(out
, "%s\n", sb
.buf
);
829 else if (!subject_printed
) {
830 fprintf(out
, "Subject: %s\n", sb
.buf
);
833 fprintf(out
, "\n%s\n", sb
.buf
);
839 while (strbuf_fread(&sb
, 8192, in
) > 0) {
840 fwrite(sb
.buf
, 1, sb
.len
, out
);
849 * This function only supports a single StGit series file in `paths`.
851 * Given an StGit series file, converts the StGit patches in the series into
852 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
853 * the state directory.
855 * Returns 0 on success, -1 on failure.
857 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
860 const char *series_dir
;
861 char *series_dir_buf
;
863 struct argv_array patches
= ARGV_ARRAY_INIT
;
864 struct strbuf sb
= STRBUF_INIT
;
867 if (!paths
[0] || paths
[1])
868 return error(_("Only one StGIT patch series can be applied at once"));
870 series_dir_buf
= xstrdup(*paths
);
871 series_dir
= dirname(series_dir_buf
);
873 fp
= fopen(*paths
, "r");
875 return error(_("could not open '%s' for reading: %s"), *paths
,
878 while (!strbuf_getline(&sb
, fp
, '\n')) {
880 continue; /* skip comment lines */
882 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
887 free(series_dir_buf
);
889 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
891 argv_array_clear(&patches
);
896 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
897 * message suitable for parsing with git-mailinfo.
899 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
901 struct strbuf sb
= STRBUF_INIT
;
903 while (!strbuf_getline(&sb
, in
, '\n')) {
906 if (skip_prefix(sb
.buf
, "# User ", &str
))
907 fprintf(out
, "From: %s\n", str
);
908 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
909 unsigned long timestamp
;
914 timestamp
= strtoul(str
, &end
, 10);
916 return error(_("invalid timestamp"));
918 if (!skip_prefix(end
, " ", &str
))
919 return error(_("invalid Date line"));
922 tz
= strtol(str
, &end
, 10);
924 return error(_("invalid timezone offset"));
927 return error(_("invalid Date line"));
930 * mercurial's timezone is in seconds west of UTC,
931 * however git's timezone is in hours + minutes east of
934 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
938 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
939 } else if (starts_with(sb
.buf
, "# ")) {
942 fprintf(out
, "\n%s\n", sb
.buf
);
948 while (strbuf_fread(&sb
, 8192, in
) > 0) {
949 fwrite(sb
.buf
, 1, sb
.len
, out
);
958 * Splits a list of files/directories into individual email patches. Each path
959 * in `paths` must be a file/directory that is formatted according to
962 * Once split out, the individual email patches will be stored in the state
963 * directory, with each patch's filename being its index, padded to state->prec
966 * state->cur will be set to the index of the first mail, and state->last will
967 * be set to the index of the last mail.
969 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
970 * to disable this behavior, -1 to use the default configured setting.
972 * Returns 0 on success, -1 on failure.
974 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
975 const char **paths
, int keep_cr
)
979 git_config_get_bool("am.keepcr", &keep_cr
);
982 switch (patch_format
) {
983 case PATCH_FORMAT_MBOX
:
984 return split_mail_mbox(state
, paths
, keep_cr
);
985 case PATCH_FORMAT_STGIT
:
986 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
987 case PATCH_FORMAT_STGIT_SERIES
:
988 return split_mail_stgit_series(state
, paths
, keep_cr
);
989 case PATCH_FORMAT_HG
:
990 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
992 die("BUG: invalid patch_format");
998 * Setup a new am session for applying patches
1000 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
1001 const char **paths
, int keep_cr
)
1003 unsigned char curr_head
[GIT_SHA1_RAWSZ
];
1005 struct strbuf sb
= STRBUF_INIT
;
1008 patch_format
= detect_patch_format(paths
);
1010 if (!patch_format
) {
1011 fprintf_ln(stderr
, _("Patch format detection failed."));
1015 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
1016 die_errno(_("failed to create directory '%s'"), state
->dir
);
1018 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
1020 die(_("Failed to split patches."));
1023 if (state
->rebasing
)
1024 state
->threeway
= 1;
1026 write_state_bool(state
, "threeway", state
->threeway
);
1027 write_state_bool(state
, "quiet", state
->quiet
);
1028 write_state_bool(state
, "sign", state
->signoff
);
1029 write_state_bool(state
, "utf8", state
->utf8
);
1031 switch (state
->keep
) {
1038 case KEEP_NON_PATCH
:
1042 die("BUG: invalid value for state->keep");
1045 write_state_text(state
, "keep", str
);
1046 write_state_bool(state
, "messageid", state
->message_id
);
1048 switch (state
->scissors
) {
1049 case SCISSORS_UNSET
:
1052 case SCISSORS_FALSE
:
1059 die("BUG: invalid value for state->scissors");
1061 write_state_text(state
, "scissors", str
);
1063 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
, 0);
1064 write_state_text(state
, "apply-opt", sb
.buf
);
1066 if (state
->rebasing
)
1067 write_state_text(state
, "rebasing", "");
1069 write_state_text(state
, "applying", "");
1071 if (!get_sha1("HEAD", curr_head
)) {
1072 write_state_text(state
, "abort-safety", sha1_to_hex(curr_head
));
1073 if (!state
->rebasing
)
1074 update_ref("am", "ORIG_HEAD", curr_head
, NULL
, 0,
1075 UPDATE_REFS_DIE_ON_ERR
);
1077 write_state_text(state
, "abort-safety", "");
1078 if (!state
->rebasing
)
1079 delete_ref("ORIG_HEAD", NULL
, 0);
1083 * NOTE: Since the "next" and "last" files determine if an am_state
1084 * session is in progress, they should be written last.
1087 write_state_count(state
, "next", state
->cur
);
1088 write_state_count(state
, "last", state
->last
);
1090 strbuf_release(&sb
);
1094 * Increments the patch pointer, and cleans am_state for the application of the
1097 static void am_next(struct am_state
*state
)
1099 unsigned char head
[GIT_SHA1_RAWSZ
];
1101 free(state
->author_name
);
1102 state
->author_name
= NULL
;
1104 free(state
->author_email
);
1105 state
->author_email
= NULL
;
1107 free(state
->author_date
);
1108 state
->author_date
= NULL
;
1114 unlink(am_path(state
, "author-script"));
1115 unlink(am_path(state
, "final-commit"));
1117 hashclr(state
->orig_commit
);
1118 unlink(am_path(state
, "original-commit"));
1120 if (!get_sha1("HEAD", head
))
1121 write_state_text(state
, "abort-safety", sha1_to_hex(head
));
1123 write_state_text(state
, "abort-safety", "");
1126 write_state_count(state
, "next", state
->cur
);
1130 * Returns the filename of the current patch email.
1132 static const char *msgnum(const struct am_state
*state
)
1134 static struct strbuf sb
= STRBUF_INIT
;
1137 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1143 * Refresh and write index.
1145 static void refresh_and_write_cache(void)
1147 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
1149 hold_locked_index(lock_file
, 1);
1150 refresh_cache(REFRESH_QUIET
);
1151 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1152 die(_("unable to write index file"));
1156 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
1157 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
1158 * strbuf is provided, the space-separated list of files that differ will be
1161 static int index_has_changes(struct strbuf
*sb
)
1163 unsigned char head
[GIT_SHA1_RAWSZ
];
1166 if (!get_sha1_tree("HEAD", head
)) {
1167 struct diff_options opt
;
1170 DIFF_OPT_SET(&opt
, EXIT_WITH_STATUS
);
1172 DIFF_OPT_SET(&opt
, QUICK
);
1173 do_diff_cache(head
, &opt
);
1175 for (i
= 0; sb
&& i
< diff_queued_diff
.nr
; i
++) {
1177 strbuf_addch(sb
, ' ');
1178 strbuf_addstr(sb
, diff_queued_diff
.queue
[i
]->two
->path
);
1181 return DIFF_OPT_TST(&opt
, HAS_CHANGES
) != 0;
1183 for (i
= 0; sb
&& i
< active_nr
; i
++) {
1185 strbuf_addch(sb
, ' ');
1186 strbuf_addstr(sb
, active_cache
[i
]->name
);
1193 * Dies with a user-friendly message on how to proceed after resolving the
1194 * problem. This message can be overridden with state->resolvemsg.
1196 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1198 if (state
->resolvemsg
) {
1199 printf_ln("%s", state
->resolvemsg
);
1201 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1203 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1204 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1205 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1211 static void am_signoff(struct strbuf
*sb
)
1214 struct strbuf mine
= STRBUF_INIT
;
1216 /* Does it end with our own sign-off? */
1217 strbuf_addf(&mine
, "\n%s%s\n",
1219 fmt_name(getenv("GIT_COMMITTER_NAME"),
1220 getenv("GIT_COMMITTER_EMAIL")));
1221 if (mine
.len
< sb
->len
&&
1222 !strcmp(mine
.buf
, sb
->buf
+ sb
->len
- mine
.len
))
1223 goto exit
; /* no need to duplicate */
1225 /* Does it have any Signed-off-by: in the text */
1227 cp
&& *cp
&& (cp
= strstr(cp
, sign_off_header
)) != NULL
;
1228 cp
= strchr(cp
, '\n')) {
1229 if (sb
->buf
== cp
|| cp
[-1] == '\n')
1233 strbuf_addstr(sb
, mine
.buf
+ !!cp
);
1235 strbuf_release(&mine
);
1239 * Appends signoff to the "msg" field of the am_state.
1241 static void am_append_signoff(struct am_state
*state
)
1243 struct strbuf sb
= STRBUF_INIT
;
1245 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1247 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1251 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1252 * state->msg will be set to the patch message. state->author_name,
1253 * state->author_email and state->author_date will be set to the patch author's
1254 * name, email and date respectively. The patch body will be written to the
1255 * state directory's "patch" file.
1257 * Returns 1 if the patch should be skipped, 0 otherwise.
1259 static int parse_mail(struct am_state
*state
, const char *mail
)
1262 struct strbuf sb
= STRBUF_INIT
;
1263 struct strbuf msg
= STRBUF_INIT
;
1264 struct strbuf author_name
= STRBUF_INIT
;
1265 struct strbuf author_date
= STRBUF_INIT
;
1266 struct strbuf author_email
= STRBUF_INIT
;
1270 setup_mailinfo(&mi
);
1273 mi
.metainfo_charset
= get_commit_output_encoding();
1275 mi
.metainfo_charset
= NULL
;
1277 switch (state
->keep
) {
1281 mi
.keep_subject
= 1;
1283 case KEEP_NON_PATCH
:
1284 mi
.keep_non_patch_brackets_in_subject
= 1;
1287 die("BUG: invalid value for state->keep");
1290 if (state
->message_id
)
1291 mi
.add_message_id
= 1;
1293 switch (state
->scissors
) {
1294 case SCISSORS_UNSET
:
1296 case SCISSORS_FALSE
:
1297 mi
.use_scissors
= 0;
1300 mi
.use_scissors
= 1;
1303 die("BUG: invalid value for state->scissors");
1306 mi
.input
= fopen(mail
, "r");
1308 die("could not open input");
1309 mi
.output
= fopen(am_path(state
, "info"), "w");
1311 die("could not open output 'info'");
1312 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1313 die("could not parse patch");
1318 /* Extract message and author information */
1319 fp
= xfopen(am_path(state
, "info"), "r");
1320 while (!strbuf_getline(&sb
, fp
, '\n')) {
1323 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1325 strbuf_addch(&msg
, '\n');
1326 strbuf_addstr(&msg
, x
);
1327 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1328 strbuf_addstr(&author_name
, x
);
1329 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1330 strbuf_addstr(&author_email
, x
);
1331 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1332 strbuf_addstr(&author_date
, x
);
1336 /* Skip pine's internal folder data */
1337 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1342 if (is_empty_file(am_path(state
, "patch"))) {
1343 printf_ln(_("Patch is empty. Was it split wrong?"));
1344 die_user_resolve(state
);
1347 strbuf_addstr(&msg
, "\n\n");
1348 strbuf_addbuf(&msg
, &mi
.log_message
);
1349 strbuf_stripspace(&msg
, 0);
1354 assert(!state
->author_name
);
1355 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1357 assert(!state
->author_email
);
1358 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1360 assert(!state
->author_date
);
1361 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1363 assert(!state
->msg
);
1364 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1367 strbuf_release(&msg
);
1368 strbuf_release(&author_date
);
1369 strbuf_release(&author_email
);
1370 strbuf_release(&author_name
);
1371 strbuf_release(&sb
);
1372 clear_mailinfo(&mi
);
1377 * Sets commit_id to the commit hash where the mail was generated from.
1378 * Returns 0 on success, -1 on failure.
1380 static int get_mail_commit_sha1(unsigned char *commit_id
, const char *mail
)
1382 struct strbuf sb
= STRBUF_INIT
;
1383 FILE *fp
= xfopen(mail
, "r");
1386 if (strbuf_getline(&sb
, fp
, '\n'))
1389 if (!skip_prefix(sb
.buf
, "From ", &x
))
1392 if (get_sha1_hex(x
, commit_id
) < 0)
1395 strbuf_release(&sb
);
1401 * Sets state->msg, state->author_name, state->author_email, state->author_date
1402 * to the commit's respective info.
1404 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1406 const char *buffer
, *ident_line
, *author_date
, *msg
;
1408 struct ident_split ident_split
;
1409 struct strbuf sb
= STRBUF_INIT
;
1411 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1413 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1415 if (split_ident_line(&ident_split
, ident_line
, ident_len
) < 0) {
1416 strbuf_add(&sb
, ident_line
, ident_len
);
1417 die(_("invalid ident line: %s"), sb
.buf
);
1420 assert(!state
->author_name
);
1421 if (ident_split
.name_begin
) {
1422 strbuf_add(&sb
, ident_split
.name_begin
,
1423 ident_split
.name_end
- ident_split
.name_begin
);
1424 state
->author_name
= strbuf_detach(&sb
, NULL
);
1426 state
->author_name
= xstrdup("");
1428 assert(!state
->author_email
);
1429 if (ident_split
.mail_begin
) {
1430 strbuf_add(&sb
, ident_split
.mail_begin
,
1431 ident_split
.mail_end
- ident_split
.mail_begin
);
1432 state
->author_email
= strbuf_detach(&sb
, NULL
);
1434 state
->author_email
= xstrdup("");
1436 author_date
= show_ident_date(&ident_split
, DATE_MODE(NORMAL
));
1437 strbuf_addstr(&sb
, author_date
);
1438 assert(!state
->author_date
);
1439 state
->author_date
= strbuf_detach(&sb
, NULL
);
1441 assert(!state
->msg
);
1442 msg
= strstr(buffer
, "\n\n");
1444 die(_("unable to parse commit %s"), sha1_to_hex(commit
->object
.sha1
));
1445 state
->msg
= xstrdup(msg
+ 2);
1446 state
->msg_len
= strlen(state
->msg
);
1450 * Writes `commit` as a patch to the state directory's "patch" file.
1452 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1454 struct rev_info rev_info
;
1457 fp
= xfopen(am_path(state
, "patch"), "w");
1458 init_revisions(&rev_info
, NULL
);
1460 rev_info
.abbrev
= 0;
1461 rev_info
.disable_stdin
= 1;
1462 rev_info
.show_root_diff
= 1;
1463 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1464 rev_info
.no_commit_id
= 1;
1465 DIFF_OPT_SET(&rev_info
.diffopt
, BINARY
);
1466 DIFF_OPT_SET(&rev_info
.diffopt
, FULL_INDEX
);
1467 rev_info
.diffopt
.use_color
= 0;
1468 rev_info
.diffopt
.file
= fp
;
1469 rev_info
.diffopt
.close_file
= 1;
1470 add_pending_object(&rev_info
, &commit
->object
, "");
1471 diff_setup_done(&rev_info
.diffopt
);
1472 log_tree_commit(&rev_info
, commit
);
1476 * Writes the diff of the index against HEAD as a patch to the state
1477 * directory's "patch" file.
1479 static void write_index_patch(const struct am_state
*state
)
1482 unsigned char head
[GIT_SHA1_RAWSZ
];
1483 struct rev_info rev_info
;
1486 if (!get_sha1_tree("HEAD", head
))
1487 tree
= lookup_tree(head
);
1489 tree
= lookup_tree(EMPTY_TREE_SHA1_BIN
);
1491 fp
= xfopen(am_path(state
, "patch"), "w");
1492 init_revisions(&rev_info
, NULL
);
1494 rev_info
.disable_stdin
= 1;
1495 rev_info
.no_commit_id
= 1;
1496 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1497 rev_info
.diffopt
.use_color
= 0;
1498 rev_info
.diffopt
.file
= fp
;
1499 rev_info
.diffopt
.close_file
= 1;
1500 add_pending_object(&rev_info
, &tree
->object
, "");
1501 diff_setup_done(&rev_info
.diffopt
);
1502 run_diff_index(&rev_info
, 1);
1506 * Like parse_mail(), but parses the mail by looking up its commit ID
1507 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1510 * state->orig_commit will be set to the original commit ID.
1512 * Will always return 0 as the patch should never be skipped.
1514 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1516 struct commit
*commit
;
1517 unsigned char commit_sha1
[GIT_SHA1_RAWSZ
];
1519 if (get_mail_commit_sha1(commit_sha1
, mail
) < 0)
1520 die(_("could not parse %s"), mail
);
1522 commit
= lookup_commit_or_die(commit_sha1
, mail
);
1524 get_commit_info(state
, commit
);
1526 write_commit_patch(state
, commit
);
1528 hashcpy(state
->orig_commit
, commit_sha1
);
1529 write_state_text(state
, "original-commit", sha1_to_hex(commit_sha1
));
1535 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1536 * `index_file` is not NULL, the patch will be applied to that index.
1538 static int run_apply(const struct am_state
*state
, const char *index_file
)
1540 struct child_process cp
= CHILD_PROCESS_INIT
;
1545 argv_array_pushf(&cp
.env_array
, "GIT_INDEX_FILE=%s", index_file
);
1548 * If we are allowed to fall back on 3-way merge, don't give false
1549 * errors during the initial attempt.
1551 if (state
->threeway
&& !index_file
) {
1556 argv_array_push(&cp
.args
, "apply");
1558 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1561 argv_array_push(&cp
.args
, "--cached");
1563 argv_array_push(&cp
.args
, "--index");
1565 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1567 if (run_command(&cp
))
1570 /* Reload index as git-apply will have modified it. */
1572 read_cache_from(index_file
? index_file
: get_index_file());
1578 * Builds an index that contains just the blobs needed for a 3way merge.
1580 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1582 struct child_process cp
= CHILD_PROCESS_INIT
;
1585 argv_array_push(&cp
.args
, "apply");
1586 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1587 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1588 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1590 if (run_command(&cp
))
1597 * Do the three-way merge using fake ancestor, his tree constructed
1598 * from the fake ancestor and the postimage of the patch, and our
1601 static int run_fallback_merge_recursive(const struct am_state
*state
,
1602 unsigned char *orig_tree
,
1603 unsigned char *our_tree
,
1604 unsigned char *his_tree
)
1606 struct child_process cp
= CHILD_PROCESS_INIT
;
1611 argv_array_pushf(&cp
.env_array
, "GITHEAD_%s=%.*s",
1612 sha1_to_hex(his_tree
), linelen(state
->msg
), state
->msg
);
1614 argv_array_push(&cp
.env_array
, "GIT_MERGE_VERBOSITY=0");
1616 argv_array_push(&cp
.args
, "merge-recursive");
1617 argv_array_push(&cp
.args
, sha1_to_hex(orig_tree
));
1618 argv_array_push(&cp
.args
, "--");
1619 argv_array_push(&cp
.args
, sha1_to_hex(our_tree
));
1620 argv_array_push(&cp
.args
, sha1_to_hex(his_tree
));
1622 status
= run_command(&cp
) ? (-1) : 0;
1629 * Attempt a threeway merge, using index_path as the temporary index.
1631 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1633 unsigned char orig_tree
[GIT_SHA1_RAWSZ
], his_tree
[GIT_SHA1_RAWSZ
],
1634 our_tree
[GIT_SHA1_RAWSZ
];
1636 if (get_sha1("HEAD", our_tree
) < 0)
1637 hashcpy(our_tree
, EMPTY_TREE_SHA1_BIN
);
1639 if (build_fake_ancestor(state
, index_path
))
1640 return error("could not build fake ancestor");
1643 read_cache_from(index_path
);
1645 if (write_index_as_tree(orig_tree
, &the_index
, index_path
, 0, NULL
))
1646 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1648 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1650 if (!state
->quiet
) {
1652 * List paths that needed 3-way fallback, so that the user can
1653 * review them with extra care to spot mismerges.
1655 struct rev_info rev_info
;
1656 const char *diff_filter_str
= "--diff-filter=AM";
1658 init_revisions(&rev_info
, NULL
);
1659 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1660 diff_opt_parse(&rev_info
.diffopt
, &diff_filter_str
, 1);
1661 add_pending_sha1(&rev_info
, "HEAD", our_tree
, 0);
1662 diff_setup_done(&rev_info
.diffopt
);
1663 run_diff_index(&rev_info
, 1);
1666 if (run_apply(state
, index_path
))
1667 return error(_("Did you hand edit your patch?\n"
1668 "It does not apply to blobs recorded in its index."));
1670 if (write_index_as_tree(his_tree
, &the_index
, index_path
, 0, NULL
))
1671 return error("could not write tree");
1673 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1679 * This is not so wrong. Depending on which base we picked, orig_tree
1680 * may be wildly different from ours, but his_tree has the same set of
1681 * wildly different changes in parts the patch did not touch, so
1682 * recursive ends up canceling them, saying that we reverted all those
1686 if (run_fallback_merge_recursive(state
, orig_tree
, our_tree
, his_tree
)) {
1687 rerere(state
->allow_rerere_autoupdate
);
1688 return error(_("Failed to merge in the changes."));
1695 * Commits the current index with state->msg as the commit message and
1696 * state->author_name, state->author_email and state->author_date as the author
1699 static void do_commit(const struct am_state
*state
)
1701 unsigned char tree
[GIT_SHA1_RAWSZ
], parent
[GIT_SHA1_RAWSZ
],
1702 commit
[GIT_SHA1_RAWSZ
];
1704 struct commit_list
*parents
= NULL
;
1705 const char *reflog_msg
, *author
;
1706 struct strbuf sb
= STRBUF_INIT
;
1708 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1711 if (write_cache_as_tree(tree
, 0, NULL
))
1712 die(_("git write-tree failed to write a tree"));
1714 if (!get_sha1_commit("HEAD", parent
)) {
1716 commit_list_insert(lookup_commit(parent
), &parents
);
1719 say(state
, stderr
, _("applying to an empty history"));
1722 author
= fmt_ident(state
->author_name
, state
->author_email
,
1723 state
->ignore_date
? NULL
: state
->author_date
,
1726 if (state
->committer_date_is_author_date
)
1727 setenv("GIT_COMMITTER_DATE",
1728 state
->ignore_date
? "" : state
->author_date
, 1);
1730 if (commit_tree(state
->msg
, state
->msg_len
, tree
, parents
, commit
,
1731 author
, state
->sign_commit
))
1732 die(_("failed to write commit object"));
1734 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1738 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1741 update_ref(sb
.buf
, "HEAD", commit
, ptr
, 0, UPDATE_REFS_DIE_ON_ERR
);
1743 if (state
->rebasing
) {
1744 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1746 assert(!is_null_sha1(state
->orig_commit
));
1747 fprintf(fp
, "%s ", sha1_to_hex(state
->orig_commit
));
1748 fprintf(fp
, "%s\n", sha1_to_hex(commit
));
1752 run_hook_le(NULL
, "post-applypatch", NULL
);
1754 strbuf_release(&sb
);
1758 * Validates the am_state for resuming -- the "msg" and authorship fields must
1761 static void validate_resume_state(const struct am_state
*state
)
1764 die(_("cannot resume: %s does not exist."),
1765 am_path(state
, "final-commit"));
1767 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1768 die(_("cannot resume: %s does not exist."),
1769 am_path(state
, "author-script"));
1773 * Interactively prompt the user on whether the current patch should be
1776 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1779 static int do_interactive(struct am_state
*state
)
1784 die(_("cannot be interactive without stdin connected to a terminal."));
1789 puts(_("Commit Body is:"));
1790 puts("--------------------------");
1791 printf("%s", state
->msg
);
1792 puts("--------------------------");
1795 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1796 * in your translation. The program will only accept English
1797 * input at this point.
1799 reply
= git_prompt(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "), PROMPT_ECHO
);
1803 } else if (*reply
== 'y' || *reply
== 'Y') {
1805 } else if (*reply
== 'a' || *reply
== 'A') {
1806 state
->interactive
= 0;
1808 } else if (*reply
== 'n' || *reply
== 'N') {
1810 } else if (*reply
== 'e' || *reply
== 'E') {
1811 struct strbuf msg
= STRBUF_INIT
;
1813 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1815 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1817 strbuf_release(&msg
);
1818 } else if (*reply
== 'v' || *reply
== 'V') {
1819 const char *pager
= git_pager(1);
1820 struct child_process cp
= CHILD_PROCESS_INIT
;
1824 argv_array_push(&cp
.args
, pager
);
1825 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1832 * Applies all queued mail.
1834 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1835 * well as the state directory's "patch" file is used as-is for applying the
1836 * patch and committing it.
1838 static void am_run(struct am_state
*state
, int resume
)
1840 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1841 struct strbuf sb
= STRBUF_INIT
;
1843 unlink(am_path(state
, "dirtyindex"));
1845 refresh_and_write_cache();
1847 if (index_has_changes(&sb
)) {
1848 write_state_bool(state
, "dirtyindex", 1);
1849 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1852 strbuf_release(&sb
);
1854 while (state
->cur
<= state
->last
) {
1855 const char *mail
= am_path(state
, msgnum(state
));
1858 if (!file_exists(mail
))
1862 validate_resume_state(state
);
1866 if (state
->rebasing
)
1867 skip
= parse_mail_rebase(state
, mail
);
1869 skip
= parse_mail(state
, mail
);
1872 goto next
; /* mail should be skipped */
1874 write_author_script(state
);
1875 write_commit_msg(state
);
1878 if (state
->interactive
&& do_interactive(state
))
1881 if (run_applypatch_msg_hook(state
))
1884 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1886 apply_status
= run_apply(state
, NULL
);
1888 if (apply_status
&& state
->threeway
) {
1889 struct strbuf sb
= STRBUF_INIT
;
1891 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1892 apply_status
= fall_back_threeway(state
, sb
.buf
);
1893 strbuf_release(&sb
);
1896 * Applying the patch to an earlier tree and merging
1897 * the result may have produced the same tree as ours.
1899 if (!apply_status
&& !index_has_changes(NULL
)) {
1900 say(state
, stdout
, _("No changes -- Patch already applied."));
1906 int advice_amworkdir
= 1;
1908 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1909 linelen(state
->msg
), state
->msg
);
1911 git_config_get_bool("advice.amworkdir", &advice_amworkdir
);
1913 if (advice_amworkdir
)
1914 printf_ln(_("The copy of the patch that failed is found in: %s"),
1915 am_path(state
, "patch"));
1917 die_user_resolve(state
);
1930 if (!is_empty_file(am_path(state
, "rewritten"))) {
1931 assert(state
->rebasing
);
1932 copy_notes_for_rebase(state
);
1933 run_post_rewrite_hook(state
);
1937 * In rebasing mode, it's up to the caller to take care of
1940 if (!state
->rebasing
) {
1942 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1947 * Resume the current am session after patch application failure. The user did
1948 * all the hard work, and we do not have to do any patch application. Just
1949 * trust and commit what the user has in the index and working tree.
1951 static void am_resolve(struct am_state
*state
)
1953 validate_resume_state(state
);
1955 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1957 if (!index_has_changes(NULL
)) {
1958 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1959 "If there is nothing left to stage, chances are that something else\n"
1960 "already introduced the same changes; you might want to skip this patch."));
1961 die_user_resolve(state
);
1964 if (unmerged_cache()) {
1965 printf_ln(_("You still have unmerged paths in your index.\n"
1966 "Did you forget to use 'git add'?"));
1967 die_user_resolve(state
);
1970 if (state
->interactive
) {
1971 write_index_patch(state
);
1972 if (do_interactive(state
))
1987 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1988 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1991 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1993 struct lock_file
*lock_file
;
1994 struct unpack_trees_options opts
;
1995 struct tree_desc t
[2];
1997 if (parse_tree(head
) || parse_tree(remote
))
2000 lock_file
= xcalloc(1, sizeof(struct lock_file
));
2001 hold_locked_index(lock_file
, 1);
2003 refresh_cache(REFRESH_QUIET
);
2005 memset(&opts
, 0, sizeof(opts
));
2007 opts
.src_index
= &the_index
;
2008 opts
.dst_index
= &the_index
;
2012 opts
.fn
= twoway_merge
;
2013 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
2014 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
2016 if (unpack_trees(2, t
, &opts
)) {
2017 rollback_lock_file(lock_file
);
2021 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
2022 die(_("unable to write new index file"));
2028 * Merges a tree into the index. The index's stat info will take precedence
2029 * over the merged tree's. Returns 0 on success, -1 on failure.
2031 static int merge_tree(struct tree
*tree
)
2033 struct lock_file
*lock_file
;
2034 struct unpack_trees_options opts
;
2035 struct tree_desc t
[1];
2037 if (parse_tree(tree
))
2040 lock_file
= xcalloc(1, sizeof(struct lock_file
));
2041 hold_locked_index(lock_file
, 1);
2043 memset(&opts
, 0, sizeof(opts
));
2045 opts
.src_index
= &the_index
;
2046 opts
.dst_index
= &the_index
;
2048 opts
.fn
= oneway_merge
;
2049 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
2051 if (unpack_trees(1, t
, &opts
)) {
2052 rollback_lock_file(lock_file
);
2056 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
2057 die(_("unable to write new index file"));
2063 * Clean the index without touching entries that are not modified between
2064 * `head` and `remote`.
2066 static int clean_index(const unsigned char *head
, const unsigned char *remote
)
2068 struct tree
*head_tree
, *remote_tree
, *index_tree
;
2069 unsigned char index
[GIT_SHA1_RAWSZ
];
2071 head_tree
= parse_tree_indirect(head
);
2073 return error(_("Could not parse object '%s'."), sha1_to_hex(head
));
2075 remote_tree
= parse_tree_indirect(remote
);
2077 return error(_("Could not parse object '%s'."), sha1_to_hex(remote
));
2079 read_cache_unmerged();
2081 if (fast_forward_to(head_tree
, head_tree
, 1))
2084 if (write_cache_as_tree(index
, 0, NULL
))
2087 index_tree
= parse_tree_indirect(index
);
2089 return error(_("Could not parse object '%s'."), sha1_to_hex(index
));
2091 if (fast_forward_to(index_tree
, remote_tree
, 0))
2094 if (merge_tree(remote_tree
))
2097 remove_branch_state();
2103 * Resets rerere's merge resolution metadata.
2105 static void am_rerere_clear(void)
2107 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
2108 rerere_clear(&merge_rr
);
2109 string_list_clear(&merge_rr
, 1);
2113 * Resume the current am session by skipping the current patch.
2115 static void am_skip(struct am_state
*state
)
2117 unsigned char head
[GIT_SHA1_RAWSZ
];
2121 if (get_sha1("HEAD", head
))
2122 hashcpy(head
, EMPTY_TREE_SHA1_BIN
);
2124 if (clean_index(head
, head
))
2125 die(_("failed to clean index"));
2133 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2135 * It is not safe to reset HEAD when:
2136 * 1. git-am previously failed because the index was dirty.
2137 * 2. HEAD has moved since git-am previously failed.
2139 static int safe_to_abort(const struct am_state
*state
)
2141 struct strbuf sb
= STRBUF_INIT
;
2142 unsigned char abort_safety
[GIT_SHA1_RAWSZ
], head
[GIT_SHA1_RAWSZ
];
2144 if (file_exists(am_path(state
, "dirtyindex")))
2147 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2148 if (get_sha1_hex(sb
.buf
, abort_safety
))
2149 die(_("could not parse %s"), am_path(state
, "abort_safety"));
2151 hashclr(abort_safety
);
2153 if (get_sha1("HEAD", head
))
2156 if (!hashcmp(head
, abort_safety
))
2159 error(_("You seem to have moved HEAD since the last 'am' failure.\n"
2160 "Not rewinding to ORIG_HEAD"));
2166 * Aborts the current am session if it is safe to do so.
2168 static void am_abort(struct am_state
*state
)
2170 unsigned char curr_head
[GIT_SHA1_RAWSZ
], orig_head
[GIT_SHA1_RAWSZ
];
2171 int has_curr_head
, has_orig_head
;
2174 if (!safe_to_abort(state
)) {
2181 curr_branch
= resolve_refdup("HEAD", 0, curr_head
, NULL
);
2182 has_curr_head
= !is_null_sha1(curr_head
);
2184 hashcpy(curr_head
, EMPTY_TREE_SHA1_BIN
);
2186 has_orig_head
= !get_sha1("ORIG_HEAD", orig_head
);
2188 hashcpy(orig_head
, EMPTY_TREE_SHA1_BIN
);
2190 clean_index(curr_head
, orig_head
);
2193 update_ref("am --abort", "HEAD", orig_head
,
2194 has_curr_head
? curr_head
: NULL
, 0,
2195 UPDATE_REFS_DIE_ON_ERR
);
2196 else if (curr_branch
)
2197 delete_ref(curr_branch
, NULL
, REF_NODEREF
);
2204 * parse_options() callback that validates and sets opt->value to the
2205 * PATCH_FORMAT_* enum value corresponding to `arg`.
2207 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2209 int *opt_value
= opt
->value
;
2211 if (!strcmp(arg
, "mbox"))
2212 *opt_value
= PATCH_FORMAT_MBOX
;
2213 else if (!strcmp(arg
, "stgit"))
2214 *opt_value
= PATCH_FORMAT_STGIT
;
2215 else if (!strcmp(arg
, "stgit-series"))
2216 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2217 else if (!strcmp(arg
, "hg"))
2218 *opt_value
= PATCH_FORMAT_HG
;
2220 return error(_("Invalid value for --patch-format: %s"), arg
);
2232 static int git_am_config(const char *k
, const char *v
, void *cb
)
2236 status
= git_gpg_config(k
, v
, NULL
);
2240 return git_default_config(k
, v
, NULL
);
2243 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2245 struct am_state state
;
2248 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2249 enum resume_mode resume
= RESUME_FALSE
;
2252 const char * const usage
[] = {
2253 N_("git am [<options>] [(<mbox>|<Maildir>)...]"),
2254 N_("git am [<options>] (--continue | --skip | --abort)"),
2258 struct option options
[] = {
2259 OPT_BOOL('i', "interactive", &state
.interactive
,
2260 N_("run interactively")),
2261 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2262 N_("historical option -- no-op")),
2263 OPT_BOOL('3', "3way", &state
.threeway
,
2264 N_("allow fall back on 3way merging if needed")),
2265 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2266 OPT_SET_INT('s', "signoff", &state
.signoff
,
2267 N_("add a Signed-off-by line to the commit message"),
2269 OPT_BOOL('u', "utf8", &state
.utf8
,
2270 N_("recode into utf8 (default)")),
2271 OPT_SET_INT('k', "keep", &state
.keep
,
2272 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2273 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2274 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2275 OPT_BOOL('m', "message-id", &state
.message_id
,
2276 N_("pass -m flag to git-mailinfo")),
2277 { OPTION_SET_INT
, 0, "keep-cr", &keep_cr
, NULL
,
2278 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2279 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1},
2280 { OPTION_SET_INT
, 0, "no-keep-cr", &keep_cr
, NULL
,
2281 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2282 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 0},
2283 OPT_BOOL('c', "scissors", &state
.scissors
,
2284 N_("strip everything before a scissors line")),
2285 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2286 N_("pass it through git-apply"),
2288 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2289 N_("pass it through git-apply"),
2291 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2292 N_("pass it through git-apply"),
2294 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2295 N_("pass it through git-apply"),
2297 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2298 N_("pass it through git-apply"),
2300 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2301 N_("pass it through git-apply"),
2303 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2304 N_("pass it through git-apply"),
2306 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2307 N_("pass it through git-apply"),
2309 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2310 N_("format the patch(es) are in"),
2311 parse_opt_patchformat
),
2312 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2313 N_("pass it through git-apply"),
2315 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2316 N_("override error message when patch failure occurs")),
2317 OPT_CMDMODE(0, "continue", &resume
,
2318 N_("continue applying patches after resolving a conflict"),
2320 OPT_CMDMODE('r', "resolved", &resume
,
2321 N_("synonyms for --continue"),
2323 OPT_CMDMODE(0, "skip", &resume
,
2324 N_("skip the current patch"),
2326 OPT_CMDMODE(0, "abort", &resume
,
2327 N_("restore the original branch and abort the patching operation."),
2329 OPT_BOOL(0, "committer-date-is-author-date",
2330 &state
.committer_date_is_author_date
,
2331 N_("lie about committer date")),
2332 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2333 N_("use current timestamp for author date")),
2334 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2335 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2336 N_("GPG-sign commits"),
2337 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2338 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2339 N_("(internal use for git-rebase)")),
2343 git_config(git_am_config
, NULL
);
2345 am_state_init(&state
, git_path("rebase-apply"));
2347 in_progress
= am_in_progress(&state
);
2351 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2354 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2355 "it will be removed. Please do not use it anymore."));
2357 /* Ensure a valid committer ident can be constructed */
2358 git_committer_info(IDENT_STRICT
);
2360 if (read_index_preload(&the_index
, NULL
) < 0)
2361 die(_("failed to read the index"));
2365 * Catch user error to feed us patches when there is a session
2368 * 1. mbox path(s) are provided on the command-line.
2369 * 2. stdin is not a tty: the user is trying to feed us a patch
2370 * from standard input. This is somewhat unreliable -- stdin
2371 * could be /dev/null for example and the caller did not
2372 * intend to feed us a patch but wanted to continue
2375 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
2376 die(_("previous rebase directory %s still exists but mbox given."),
2379 if (resume
== RESUME_FALSE
)
2380 resume
= RESUME_APPLY
;
2382 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2383 am_append_signoff(&state
);
2385 struct argv_array paths
= ARGV_ARRAY_INIT
;
2389 * Handle stray state directory in the independent-run case. In
2390 * the --rebasing case, it is up to the caller to take care of
2391 * stray directories.
2393 if (file_exists(state
.dir
) && !state
.rebasing
) {
2394 if (resume
== RESUME_ABORT
) {
2396 am_state_release(&state
);
2400 die(_("Stray %s directory found.\n"
2401 "Use \"git am --abort\" to remove it."),
2406 die(_("Resolve operation not in progress, we are not resuming."));
2408 for (i
= 0; i
< argc
; i
++) {
2409 if (is_absolute_path(argv
[i
]) || !prefix
)
2410 argv_array_push(&paths
, argv
[i
]);
2412 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2415 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2417 argv_array_clear(&paths
);
2427 case RESUME_RESOLVED
:
2437 die("BUG: invalid resume value");
2440 am_state_release(&state
);