4 * Based on git-am.sh by Junio C Hamano.
9 #include "parse-options.h"
11 #include "run-command.h"
14 #include "cache-tree.h"
19 #include "unpack-trees.h"
21 #include "sequencer.h"
23 #include "merge-recursive.h"
26 #include "notes-utils.h"
30 * Returns 1 if the file is empty or does not exist, 0 otherwise.
32 static int is_empty_file(const char *filename
)
36 if (stat(filename
, &st
) < 0) {
39 die_errno(_("could not stat %s"), filename
);
46 * Like strbuf_getline(), but treats both '\n' and "\r\n" as line terminators.
48 static int strbuf_getline_crlf(struct strbuf
*sb
, FILE *fp
)
50 if (strbuf_getwholeline(sb
, fp
, '\n'))
52 if (sb
->buf
[sb
->len
- 1] == '\n') {
53 strbuf_setlen(sb
, sb
->len
- 1);
54 if (sb
->len
> 0 && sb
->buf
[sb
->len
- 1] == '\r')
55 strbuf_setlen(sb
, sb
->len
- 1);
61 * Returns the length of the first line of msg.
63 static int linelen(const char *msg
)
65 return strchrnul(msg
, '\n') - msg
;
69 * Returns true if `str` consists of only whitespace, false otherwise.
71 static int str_isspace(const char *str
)
81 PATCH_FORMAT_UNKNOWN
= 0,
84 PATCH_FORMAT_STGIT_SERIES
89 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
90 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
95 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
96 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
100 /* state directory path */
103 /* current and last patch numbers, 1-indexed */
107 /* commit metadata and message */
114 /* when --rebasing, records the original commit the patch came from */
115 unsigned char orig_commit
[GIT_SHA1_RAWSZ
];
117 /* number of digits in patch filename */
120 /* various operating modes and command line options */
125 int keep
; /* enum keep_type */
127 int scissors
; /* enum scissors_type */
128 struct argv_array git_apply_opts
;
129 const char *resolvemsg
;
130 int committer_date_is_author_date
;
132 int allow_rerere_autoupdate
;
133 const char *sign_commit
;
138 * Initializes am_state with the default values. The state directory is set to
141 static void am_state_init(struct am_state
*state
, const char *dir
)
145 memset(state
, 0, sizeof(*state
));
148 state
->dir
= xstrdup(dir
);
154 git_config_get_bool("am.messageid", &state
->message_id
);
156 state
->scissors
= SCISSORS_UNSET
;
158 argv_array_init(&state
->git_apply_opts
);
160 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
161 state
->sign_commit
= gpgsign
? "" : NULL
;
165 * Releases memory allocated by an am_state.
167 static void am_state_release(struct am_state
*state
)
170 free(state
->author_name
);
171 free(state
->author_email
);
172 free(state
->author_date
);
174 argv_array_clear(&state
->git_apply_opts
);
178 * Returns path relative to the am_state directory.
180 static inline const char *am_path(const struct am_state
*state
, const char *path
)
182 return mkpath("%s/%s", state
->dir
, path
);
186 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
189 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
195 vfprintf(fp
, fmt
, ap
);
202 * Returns 1 if there is an am session in progress, 0 otherwise.
204 static int am_in_progress(const struct am_state
*state
)
208 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
210 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
212 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
218 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
219 * number of bytes read on success, -1 if the file does not exist. If `trim` is
220 * set, trailing whitespace will be removed.
222 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
223 const char *file
, int trim
)
227 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
237 die_errno(_("could not read '%s'"), am_path(state
, file
));
241 * Reads a KEY=VALUE shell variable assignment from `fp`, returning the VALUE
242 * as a newly-allocated string. VALUE must be a quoted string, and the KEY must
243 * match `key`. Returns NULL on failure.
245 * This is used by read_author_script() to read the GIT_AUTHOR_* variables from
248 static char *read_shell_var(FILE *fp
, const char *key
)
250 struct strbuf sb
= STRBUF_INIT
;
253 if (strbuf_getline(&sb
, fp
, '\n'))
256 if (!skip_prefix(sb
.buf
, key
, &str
))
259 if (!skip_prefix(str
, "=", &str
))
262 strbuf_remove(&sb
, 0, str
- sb
.buf
);
264 str
= sq_dequote(sb
.buf
);
268 return strbuf_detach(&sb
, NULL
);
276 * Reads and parses the state directory's "author-script" file, and sets
277 * state->author_name, state->author_email and state->author_date accordingly.
278 * Returns 0 on success, -1 if the file could not be parsed.
280 * The author script is of the format:
282 * GIT_AUTHOR_NAME='$author_name'
283 * GIT_AUTHOR_EMAIL='$author_email'
284 * GIT_AUTHOR_DATE='$author_date'
286 * where $author_name, $author_email and $author_date are quoted. We are strict
287 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
288 * script, and thus if the file differs from what this function expects, it is
289 * better to bail out than to do something that the user does not expect.
291 static int read_author_script(struct am_state
*state
)
293 const char *filename
= am_path(state
, "author-script");
296 assert(!state
->author_name
);
297 assert(!state
->author_email
);
298 assert(!state
->author_date
);
300 fp
= fopen(filename
, "r");
304 die_errno(_("could not open '%s' for reading"), filename
);
307 state
->author_name
= read_shell_var(fp
, "GIT_AUTHOR_NAME");
308 if (!state
->author_name
) {
313 state
->author_email
= read_shell_var(fp
, "GIT_AUTHOR_EMAIL");
314 if (!state
->author_email
) {
319 state
->author_date
= read_shell_var(fp
, "GIT_AUTHOR_DATE");
320 if (!state
->author_date
) {
325 if (fgetc(fp
) != EOF
) {
335 * Saves state->author_name, state->author_email and state->author_date in the
336 * state directory's "author-script" file.
338 static void write_author_script(const struct am_state
*state
)
340 struct strbuf sb
= STRBUF_INIT
;
342 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
343 sq_quote_buf(&sb
, state
->author_name
);
344 strbuf_addch(&sb
, '\n');
346 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
347 sq_quote_buf(&sb
, state
->author_email
);
348 strbuf_addch(&sb
, '\n');
350 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
351 sq_quote_buf(&sb
, state
->author_date
);
352 strbuf_addch(&sb
, '\n');
354 write_file(am_path(state
, "author-script"), 1, "%s", sb
.buf
);
360 * Reads the commit message from the state directory's "final-commit" file,
361 * setting state->msg to its contents and state->msg_len to the length of its
364 * Returns 0 on success, -1 if the file does not exist.
366 static int read_commit_msg(struct am_state
*state
)
368 struct strbuf sb
= STRBUF_INIT
;
372 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
377 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
382 * Saves state->msg in the state directory's "final-commit" file.
384 static void write_commit_msg(const struct am_state
*state
)
387 const char *filename
= am_path(state
, "final-commit");
389 fd
= xopen(filename
, O_WRONLY
| O_CREAT
, 0666);
390 if (write_in_full(fd
, state
->msg
, state
->msg_len
) < 0)
391 die_errno(_("could not write to %s"), filename
);
396 * Loads state from disk.
398 static void am_load(struct am_state
*state
)
400 struct strbuf sb
= STRBUF_INIT
;
402 if (read_state_file(&sb
, state
, "next", 1) < 0)
403 die("BUG: state file 'next' does not exist");
404 state
->cur
= strtol(sb
.buf
, NULL
, 10);
406 if (read_state_file(&sb
, state
, "last", 1) < 0)
407 die("BUG: state file 'last' does not exist");
408 state
->last
= strtol(sb
.buf
, NULL
, 10);
410 if (read_author_script(state
) < 0)
411 die(_("could not parse author script"));
413 read_commit_msg(state
);
415 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
416 hashclr(state
->orig_commit
);
417 else if (get_sha1_hex(sb
.buf
, state
->orig_commit
) < 0)
418 die(_("could not parse %s"), am_path(state
, "original-commit"));
420 read_state_file(&sb
, state
, "threeway", 1);
421 state
->threeway
= !strcmp(sb
.buf
, "t");
423 read_state_file(&sb
, state
, "quiet", 1);
424 state
->quiet
= !strcmp(sb
.buf
, "t");
426 read_state_file(&sb
, state
, "sign", 1);
427 state
->signoff
= !strcmp(sb
.buf
, "t");
429 read_state_file(&sb
, state
, "utf8", 1);
430 state
->utf8
= !strcmp(sb
.buf
, "t");
432 read_state_file(&sb
, state
, "keep", 1);
433 if (!strcmp(sb
.buf
, "t"))
434 state
->keep
= KEEP_TRUE
;
435 else if (!strcmp(sb
.buf
, "b"))
436 state
->keep
= KEEP_NON_PATCH
;
438 state
->keep
= KEEP_FALSE
;
440 read_state_file(&sb
, state
, "messageid", 1);
441 state
->message_id
= !strcmp(sb
.buf
, "t");
443 read_state_file(&sb
, state
, "scissors", 1);
444 if (!strcmp(sb
.buf
, "t"))
445 state
->scissors
= SCISSORS_TRUE
;
446 else if (!strcmp(sb
.buf
, "f"))
447 state
->scissors
= SCISSORS_FALSE
;
449 state
->scissors
= SCISSORS_UNSET
;
451 read_state_file(&sb
, state
, "apply-opt", 1);
452 argv_array_clear(&state
->git_apply_opts
);
453 if (sq_dequote_to_argv_array(sb
.buf
, &state
->git_apply_opts
) < 0)
454 die(_("could not parse %s"), am_path(state
, "apply-opt"));
456 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
462 * Removes the am_state directory, forcefully terminating the current am
465 static void am_destroy(const struct am_state
*state
)
467 struct strbuf sb
= STRBUF_INIT
;
469 strbuf_addstr(&sb
, state
->dir
);
470 remove_dir_recursively(&sb
, 0);
475 * Runs applypatch-msg hook. Returns its exit code.
477 static int run_applypatch_msg_hook(struct am_state
*state
)
482 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
487 if (read_commit_msg(state
) < 0)
488 die(_("'%s' was deleted by the applypatch-msg hook"),
489 am_path(state
, "final-commit"));
496 * Runs post-rewrite hook. Returns it exit code.
498 static int run_post_rewrite_hook(const struct am_state
*state
)
500 struct child_process cp
= CHILD_PROCESS_INIT
;
501 const char *hook
= find_hook("post-rewrite");
507 argv_array_push(&cp
.args
, hook
);
508 argv_array_push(&cp
.args
, "rebase");
510 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
511 cp
.stdout_to_stderr
= 1;
513 ret
= run_command(&cp
);
520 * Reads the state directory's "rewritten" file, and copies notes from the old
521 * commits listed in the file to their rewritten commits.
523 * Returns 0 on success, -1 on failure.
525 static int copy_notes_for_rebase(const struct am_state
*state
)
527 struct notes_rewrite_cfg
*c
;
528 struct strbuf sb
= STRBUF_INIT
;
529 const char *invalid_line
= _("Malformed input line: '%s'.");
530 const char *msg
= "Notes added by 'git rebase'";
534 assert(state
->rebasing
);
536 c
= init_copy_notes_for_rewrite("rebase");
540 fp
= xfopen(am_path(state
, "rewritten"), "r");
542 while (!strbuf_getline(&sb
, fp
, '\n')) {
543 unsigned char from_obj
[GIT_SHA1_RAWSZ
], to_obj
[GIT_SHA1_RAWSZ
];
545 if (sb
.len
!= GIT_SHA1_HEXSZ
* 2 + 1) {
546 ret
= error(invalid_line
, sb
.buf
);
550 if (get_sha1_hex(sb
.buf
, from_obj
)) {
551 ret
= error(invalid_line
, sb
.buf
);
555 if (sb
.buf
[GIT_SHA1_HEXSZ
] != ' ') {
556 ret
= error(invalid_line
, sb
.buf
);
560 if (get_sha1_hex(sb
.buf
+ GIT_SHA1_HEXSZ
+ 1, to_obj
)) {
561 ret
= error(invalid_line
, sb
.buf
);
565 if (copy_note_for_rewrite(c
, from_obj
, to_obj
))
566 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
567 sha1_to_hex(from_obj
), sha1_to_hex(to_obj
));
571 finish_copy_notes_for_rewrite(c
, msg
);
578 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
579 * non-indented lines and checking if they look like they begin with valid
580 * header field names.
582 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
584 static int is_mail(FILE *fp
)
586 const char *header_regex
= "^[!-9;-~]+:";
587 struct strbuf sb
= STRBUF_INIT
;
591 if (fseek(fp
, 0L, SEEK_SET
))
592 die_errno(_("fseek failed"));
594 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
595 die("invalid pattern: %s", header_regex
);
597 while (!strbuf_getline_crlf(&sb
, fp
)) {
599 break; /* End of header */
601 /* Ignore indented folded lines */
602 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
605 /* It's a header if it matches header_regex */
606 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
619 * Attempts to detect the patch_format of the patches contained in `paths`,
620 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
623 static int detect_patch_format(const char **paths
)
625 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
626 struct strbuf l1
= STRBUF_INIT
;
627 struct strbuf l2
= STRBUF_INIT
;
628 struct strbuf l3
= STRBUF_INIT
;
632 * We default to mbox format if input is from stdin and for directories
634 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
635 return PATCH_FORMAT_MBOX
;
638 * Otherwise, check the first few lines of the first patch, starting
639 * from the first non-blank line, to try to detect its format.
642 fp
= xfopen(*paths
, "r");
644 while (!strbuf_getline_crlf(&l1
, fp
)) {
649 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
650 ret
= PATCH_FORMAT_MBOX
;
654 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
655 ret
= PATCH_FORMAT_STGIT_SERIES
;
660 strbuf_getline_crlf(&l2
, fp
);
662 strbuf_getline_crlf(&l3
, fp
);
665 * If the second line is empty and the third is a From, Author or Date
666 * entry, this is likely an StGit patch.
668 if (l1
.len
&& !l2
.len
&&
669 (starts_with(l3
.buf
, "From:") ||
670 starts_with(l3
.buf
, "Author:") ||
671 starts_with(l3
.buf
, "Date:"))) {
672 ret
= PATCH_FORMAT_STGIT
;
676 if (l1
.len
&& is_mail(fp
)) {
677 ret
= PATCH_FORMAT_MBOX
;
688 * Splits out individual email patches from `paths`, where each path is either
689 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
691 static int split_mail_mbox(struct am_state
*state
, const char **paths
, int keep_cr
)
693 struct child_process cp
= CHILD_PROCESS_INIT
;
694 struct strbuf last
= STRBUF_INIT
;
697 argv_array_push(&cp
.args
, "mailsplit");
698 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
699 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
700 argv_array_push(&cp
.args
, "-b");
702 argv_array_push(&cp
.args
, "--keep-cr");
703 argv_array_push(&cp
.args
, "--");
704 argv_array_pushv(&cp
.args
, paths
);
706 if (capture_command(&cp
, &last
, 8))
710 state
->last
= strtol(last
.buf
, NULL
, 10);
716 * Callback signature for split_mail_conv(). The foreign patch should be
717 * read from `in`, and the converted patch (in RFC2822 mail format) should be
718 * written to `out`. Return 0 on success, or -1 on failure.
720 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
723 * Calls `fn` for each file in `paths` to convert the foreign patch to the
724 * RFC2822 mail format suitable for parsing with git-mailinfo.
726 * Returns 0 on success, -1 on failure.
728 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
729 const char **paths
, int keep_cr
)
731 static const char *stdin_only
[] = {"-", NULL
};
737 for (i
= 0; *paths
; paths
++, i
++) {
742 if (!strcmp(*paths
, "-"))
745 in
= fopen(*paths
, "r");
748 return error(_("could not open '%s' for reading: %s"),
749 *paths
, strerror(errno
));
751 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
753 out
= fopen(mail
, "w");
755 return error(_("could not open '%s' for writing: %s"),
756 mail
, strerror(errno
));
758 ret
= fn(out
, in
, keep_cr
);
764 return error(_("could not parse patch '%s'"), *paths
);
773 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
774 * message suitable for parsing with git-mailinfo.
776 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
778 struct strbuf sb
= STRBUF_INIT
;
779 int subject_printed
= 0;
781 while (!strbuf_getline(&sb
, in
, '\n')) {
784 if (str_isspace(sb
.buf
))
786 else if (skip_prefix(sb
.buf
, "Author:", &str
))
787 fprintf(out
, "From:%s\n", str
);
788 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
789 fprintf(out
, "%s\n", sb
.buf
);
790 else if (!subject_printed
) {
791 fprintf(out
, "Subject: %s\n", sb
.buf
);
794 fprintf(out
, "\n%s\n", sb
.buf
);
800 while (strbuf_fread(&sb
, 8192, in
) > 0) {
801 fwrite(sb
.buf
, 1, sb
.len
, out
);
810 * This function only supports a single StGit series file in `paths`.
812 * Given an StGit series file, converts the StGit patches in the series into
813 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
814 * the state directory.
816 * Returns 0 on success, -1 on failure.
818 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
821 const char *series_dir
;
822 char *series_dir_buf
;
824 struct argv_array patches
= ARGV_ARRAY_INIT
;
825 struct strbuf sb
= STRBUF_INIT
;
828 if (!paths
[0] || paths
[1])
829 return error(_("Only one StGIT patch series can be applied at once"));
831 series_dir_buf
= xstrdup(*paths
);
832 series_dir
= dirname(series_dir_buf
);
834 fp
= fopen(*paths
, "r");
836 return error(_("could not open '%s' for reading: %s"), *paths
,
839 while (!strbuf_getline(&sb
, fp
, '\n')) {
841 continue; /* skip comment lines */
843 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
848 free(series_dir_buf
);
850 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
852 argv_array_clear(&patches
);
857 * Splits a list of files/directories into individual email patches. Each path
858 * in `paths` must be a file/directory that is formatted according to
861 * Once split out, the individual email patches will be stored in the state
862 * directory, with each patch's filename being its index, padded to state->prec
865 * state->cur will be set to the index of the first mail, and state->last will
866 * be set to the index of the last mail.
868 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
869 * to disable this behavior, -1 to use the default configured setting.
871 * Returns 0 on success, -1 on failure.
873 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
874 const char **paths
, int keep_cr
)
878 git_config_get_bool("am.keepcr", &keep_cr
);
881 switch (patch_format
) {
882 case PATCH_FORMAT_MBOX
:
883 return split_mail_mbox(state
, paths
, keep_cr
);
884 case PATCH_FORMAT_STGIT
:
885 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
886 case PATCH_FORMAT_STGIT_SERIES
:
887 return split_mail_stgit_series(state
, paths
, keep_cr
);
889 die("BUG: invalid patch_format");
895 * Setup a new am session for applying patches
897 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
898 const char **paths
, int keep_cr
)
900 unsigned char curr_head
[GIT_SHA1_RAWSZ
];
902 struct strbuf sb
= STRBUF_INIT
;
905 patch_format
= detect_patch_format(paths
);
908 fprintf_ln(stderr
, _("Patch format detection failed."));
912 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
913 die_errno(_("failed to create directory '%s'"), state
->dir
);
915 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
917 die(_("Failed to split patches."));
923 write_file(am_path(state
, "threeway"), 1, state
->threeway
? "t" : "f");
925 write_file(am_path(state
, "quiet"), 1, state
->quiet
? "t" : "f");
927 write_file(am_path(state
, "sign"), 1, state
->signoff
? "t" : "f");
929 write_file(am_path(state
, "utf8"), 1, state
->utf8
? "t" : "f");
931 switch (state
->keep
) {
942 die("BUG: invalid value for state->keep");
945 write_file(am_path(state
, "keep"), 1, "%s", str
);
947 write_file(am_path(state
, "messageid"), 1, state
->message_id
? "t" : "f");
949 switch (state
->scissors
) {
960 die("BUG: invalid value for state->scissors");
963 write_file(am_path(state
, "scissors"), 1, "%s", str
);
965 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
, 0);
966 write_file(am_path(state
, "apply-opt"), 1, "%s", sb
.buf
);
969 write_file(am_path(state
, "rebasing"), 1, "%s", "");
971 write_file(am_path(state
, "applying"), 1, "%s", "");
973 if (!get_sha1("HEAD", curr_head
)) {
974 write_file(am_path(state
, "abort-safety"), 1, "%s", sha1_to_hex(curr_head
));
975 if (!state
->rebasing
)
976 update_ref("am", "ORIG_HEAD", curr_head
, NULL
, 0,
977 UPDATE_REFS_DIE_ON_ERR
);
979 write_file(am_path(state
, "abort-safety"), 1, "%s", "");
980 if (!state
->rebasing
)
981 delete_ref("ORIG_HEAD", NULL
, 0);
985 * NOTE: Since the "next" and "last" files determine if an am_state
986 * session is in progress, they should be written last.
989 write_file(am_path(state
, "next"), 1, "%d", state
->cur
);
991 write_file(am_path(state
, "last"), 1, "%d", state
->last
);
997 * Increments the patch pointer, and cleans am_state for the application of the
1000 static void am_next(struct am_state
*state
)
1002 unsigned char head
[GIT_SHA1_RAWSZ
];
1004 free(state
->author_name
);
1005 state
->author_name
= NULL
;
1007 free(state
->author_email
);
1008 state
->author_email
= NULL
;
1010 free(state
->author_date
);
1011 state
->author_date
= NULL
;
1017 unlink(am_path(state
, "author-script"));
1018 unlink(am_path(state
, "final-commit"));
1020 hashclr(state
->orig_commit
);
1021 unlink(am_path(state
, "original-commit"));
1023 if (!get_sha1("HEAD", head
))
1024 write_file(am_path(state
, "abort-safety"), 1, "%s", sha1_to_hex(head
));
1026 write_file(am_path(state
, "abort-safety"), 1, "%s", "");
1029 write_file(am_path(state
, "next"), 1, "%d", state
->cur
);
1033 * Returns the filename of the current patch email.
1035 static const char *msgnum(const struct am_state
*state
)
1037 static struct strbuf sb
= STRBUF_INIT
;
1040 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1046 * Refresh and write index.
1048 static void refresh_and_write_cache(void)
1050 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
1052 hold_locked_index(lock_file
, 1);
1053 refresh_cache(REFRESH_QUIET
);
1054 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1055 die(_("unable to write index file"));
1059 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
1060 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
1061 * strbuf is provided, the space-separated list of files that differ will be
1064 static int index_has_changes(struct strbuf
*sb
)
1066 unsigned char head
[GIT_SHA1_RAWSZ
];
1069 if (!get_sha1_tree("HEAD", head
)) {
1070 struct diff_options opt
;
1073 DIFF_OPT_SET(&opt
, EXIT_WITH_STATUS
);
1075 DIFF_OPT_SET(&opt
, QUICK
);
1076 do_diff_cache(head
, &opt
);
1078 for (i
= 0; sb
&& i
< diff_queued_diff
.nr
; i
++) {
1080 strbuf_addch(sb
, ' ');
1081 strbuf_addstr(sb
, diff_queued_diff
.queue
[i
]->two
->path
);
1084 return DIFF_OPT_TST(&opt
, HAS_CHANGES
) != 0;
1086 for (i
= 0; sb
&& i
< active_nr
; i
++) {
1088 strbuf_addch(sb
, ' ');
1089 strbuf_addstr(sb
, active_cache
[i
]->name
);
1096 * Dies with a user-friendly message on how to proceed after resolving the
1097 * problem. This message can be overridden with state->resolvemsg.
1099 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1101 if (state
->resolvemsg
) {
1102 printf_ln("%s", state
->resolvemsg
);
1104 const char *cmdline
= "git am";
1106 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1107 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1108 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1115 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1116 * state->msg will be set to the patch message. state->author_name,
1117 * state->author_email and state->author_date will be set to the patch author's
1118 * name, email and date respectively. The patch body will be written to the
1119 * state directory's "patch" file.
1121 * Returns 1 if the patch should be skipped, 0 otherwise.
1123 static int parse_mail(struct am_state
*state
, const char *mail
)
1126 struct child_process cp
= CHILD_PROCESS_INIT
;
1127 struct strbuf sb
= STRBUF_INIT
;
1128 struct strbuf msg
= STRBUF_INIT
;
1129 struct strbuf author_name
= STRBUF_INIT
;
1130 struct strbuf author_date
= STRBUF_INIT
;
1131 struct strbuf author_email
= STRBUF_INIT
;
1135 cp
.in
= xopen(mail
, O_RDONLY
, 0);
1136 cp
.out
= xopen(am_path(state
, "info"), O_WRONLY
| O_CREAT
, 0777);
1138 argv_array_push(&cp
.args
, "mailinfo");
1139 argv_array_push(&cp
.args
, state
->utf8
? "-u" : "-n");
1141 switch (state
->keep
) {
1145 argv_array_push(&cp
.args
, "-k");
1147 case KEEP_NON_PATCH
:
1148 argv_array_push(&cp
.args
, "-b");
1151 die("BUG: invalid value for state->keep");
1154 if (state
->message_id
)
1155 argv_array_push(&cp
.args
, "-m");
1157 switch (state
->scissors
) {
1158 case SCISSORS_UNSET
:
1160 case SCISSORS_FALSE
:
1161 argv_array_push(&cp
.args
, "--no-scissors");
1164 argv_array_push(&cp
.args
, "--scissors");
1167 die("BUG: invalid value for state->scissors");
1170 argv_array_push(&cp
.args
, am_path(state
, "msg"));
1171 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1173 if (run_command(&cp
) < 0)
1174 die("could not parse patch");
1179 /* Extract message and author information */
1180 fp
= xfopen(am_path(state
, "info"), "r");
1181 while (!strbuf_getline(&sb
, fp
, '\n')) {
1184 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1186 strbuf_addch(&msg
, '\n');
1187 strbuf_addstr(&msg
, x
);
1188 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1189 strbuf_addstr(&author_name
, x
);
1190 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1191 strbuf_addstr(&author_email
, x
);
1192 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1193 strbuf_addstr(&author_date
, x
);
1197 /* Skip pine's internal folder data */
1198 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1203 if (is_empty_file(am_path(state
, "patch"))) {
1204 printf_ln(_("Patch is empty. Was it split wrong?"));
1205 die_user_resolve(state
);
1208 strbuf_addstr(&msg
, "\n\n");
1209 if (strbuf_read_file(&msg
, am_path(state
, "msg"), 0) < 0)
1210 die_errno(_("could not read '%s'"), am_path(state
, "msg"));
1211 stripspace(&msg
, 0);
1214 append_signoff(&msg
, 0, 0);
1216 assert(!state
->author_name
);
1217 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1219 assert(!state
->author_email
);
1220 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1222 assert(!state
->author_date
);
1223 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1225 assert(!state
->msg
);
1226 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1229 strbuf_release(&msg
);
1230 strbuf_release(&author_date
);
1231 strbuf_release(&author_email
);
1232 strbuf_release(&author_name
);
1233 strbuf_release(&sb
);
1238 * Sets commit_id to the commit hash where the mail was generated from.
1239 * Returns 0 on success, -1 on failure.
1241 static int get_mail_commit_sha1(unsigned char *commit_id
, const char *mail
)
1243 struct strbuf sb
= STRBUF_INIT
;
1244 FILE *fp
= xfopen(mail
, "r");
1247 if (strbuf_getline(&sb
, fp
, '\n'))
1250 if (!skip_prefix(sb
.buf
, "From ", &x
))
1253 if (get_sha1_hex(x
, commit_id
) < 0)
1256 strbuf_release(&sb
);
1262 * Sets state->msg, state->author_name, state->author_email, state->author_date
1263 * to the commit's respective info.
1265 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1267 const char *buffer
, *ident_line
, *author_date
, *msg
;
1269 struct ident_split ident_split
;
1270 struct strbuf sb
= STRBUF_INIT
;
1272 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1274 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1276 if (split_ident_line(&ident_split
, ident_line
, ident_len
) < 0) {
1277 strbuf_add(&sb
, ident_line
, ident_len
);
1278 die(_("invalid ident line: %s"), sb
.buf
);
1281 assert(!state
->author_name
);
1282 if (ident_split
.name_begin
) {
1283 strbuf_add(&sb
, ident_split
.name_begin
,
1284 ident_split
.name_end
- ident_split
.name_begin
);
1285 state
->author_name
= strbuf_detach(&sb
, NULL
);
1287 state
->author_name
= xstrdup("");
1289 assert(!state
->author_email
);
1290 if (ident_split
.mail_begin
) {
1291 strbuf_add(&sb
, ident_split
.mail_begin
,
1292 ident_split
.mail_end
- ident_split
.mail_begin
);
1293 state
->author_email
= strbuf_detach(&sb
, NULL
);
1295 state
->author_email
= xstrdup("");
1297 author_date
= show_ident_date(&ident_split
, DATE_MODE(NORMAL
));
1298 strbuf_addstr(&sb
, author_date
);
1299 assert(!state
->author_date
);
1300 state
->author_date
= strbuf_detach(&sb
, NULL
);
1302 assert(!state
->msg
);
1303 msg
= strstr(buffer
, "\n\n");
1305 die(_("unable to parse commit %s"), sha1_to_hex(commit
->object
.sha1
));
1306 state
->msg
= xstrdup(msg
+ 2);
1307 state
->msg_len
= strlen(state
->msg
);
1311 * Writes `commit` as a patch to the state directory's "patch" file.
1313 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1315 struct rev_info rev_info
;
1318 fp
= xfopen(am_path(state
, "patch"), "w");
1319 init_revisions(&rev_info
, NULL
);
1321 rev_info
.abbrev
= 0;
1322 rev_info
.disable_stdin
= 1;
1323 rev_info
.show_root_diff
= 1;
1324 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1325 rev_info
.no_commit_id
= 1;
1326 DIFF_OPT_SET(&rev_info
.diffopt
, BINARY
);
1327 DIFF_OPT_SET(&rev_info
.diffopt
, FULL_INDEX
);
1328 rev_info
.diffopt
.use_color
= 0;
1329 rev_info
.diffopt
.file
= fp
;
1330 rev_info
.diffopt
.close_file
= 1;
1331 add_pending_object(&rev_info
, &commit
->object
, "");
1332 diff_setup_done(&rev_info
.diffopt
);
1333 log_tree_commit(&rev_info
, commit
);
1337 * Like parse_mail(), but parses the mail by looking up its commit ID
1338 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1341 * state->orig_commit will be set to the original commit ID.
1343 * Will always return 0 as the patch should never be skipped.
1345 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1347 struct commit
*commit
;
1348 unsigned char commit_sha1
[GIT_SHA1_RAWSZ
];
1350 if (get_mail_commit_sha1(commit_sha1
, mail
) < 0)
1351 die(_("could not parse %s"), mail
);
1353 commit
= lookup_commit_or_die(commit_sha1
, mail
);
1355 get_commit_info(state
, commit
);
1357 write_commit_patch(state
, commit
);
1359 hashcpy(state
->orig_commit
, commit_sha1
);
1360 write_file(am_path(state
, "original-commit"), 1, "%s",
1361 sha1_to_hex(commit_sha1
));
1367 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1368 * `index_file` is not NULL, the patch will be applied to that index.
1370 static int run_apply(const struct am_state
*state
, const char *index_file
)
1372 struct child_process cp
= CHILD_PROCESS_INIT
;
1377 argv_array_pushf(&cp
.env_array
, "GIT_INDEX_FILE=%s", index_file
);
1380 * If we are allowed to fall back on 3-way merge, don't give false
1381 * errors during the initial attempt.
1383 if (state
->threeway
&& !index_file
) {
1388 argv_array_push(&cp
.args
, "apply");
1390 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1393 argv_array_push(&cp
.args
, "--cached");
1395 argv_array_push(&cp
.args
, "--index");
1397 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1399 if (run_command(&cp
))
1402 /* Reload index as git-apply will have modified it. */
1404 read_cache_from(index_file
? index_file
: get_index_file());
1410 * Builds an index that contains just the blobs needed for a 3way merge.
1412 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1414 struct child_process cp
= CHILD_PROCESS_INIT
;
1417 argv_array_push(&cp
.args
, "apply");
1418 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1419 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1420 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1422 if (run_command(&cp
))
1429 * Attempt a threeway merge, using index_path as the temporary index.
1431 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1433 unsigned char orig_tree
[GIT_SHA1_RAWSZ
], his_tree
[GIT_SHA1_RAWSZ
],
1434 our_tree
[GIT_SHA1_RAWSZ
];
1435 const unsigned char *bases
[1] = {orig_tree
};
1436 struct merge_options o
;
1437 struct commit
*result
;
1438 char *his_tree_name
;
1440 if (get_sha1("HEAD", our_tree
) < 0)
1441 hashcpy(our_tree
, EMPTY_TREE_SHA1_BIN
);
1443 if (build_fake_ancestor(state
, index_path
))
1444 return error("could not build fake ancestor");
1447 read_cache_from(index_path
);
1449 if (write_index_as_tree(orig_tree
, &the_index
, index_path
, 0, NULL
))
1450 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1452 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1454 if (!state
->quiet
) {
1456 * List paths that needed 3-way fallback, so that the user can
1457 * review them with extra care to spot mismerges.
1459 struct rev_info rev_info
;
1460 const char *diff_filter_str
= "--diff-filter=AM";
1462 init_revisions(&rev_info
, NULL
);
1463 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1464 diff_opt_parse(&rev_info
.diffopt
, &diff_filter_str
, 1);
1465 add_pending_sha1(&rev_info
, "HEAD", our_tree
, 0);
1466 diff_setup_done(&rev_info
.diffopt
);
1467 run_diff_index(&rev_info
, 1);
1470 if (run_apply(state
, index_path
))
1471 return error(_("Did you hand edit your patch?\n"
1472 "It does not apply to blobs recorded in its index."));
1474 if (write_index_as_tree(his_tree
, &the_index
, index_path
, 0, NULL
))
1475 return error("could not write tree");
1477 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1483 * This is not so wrong. Depending on which base we picked, orig_tree
1484 * may be wildly different from ours, but his_tree has the same set of
1485 * wildly different changes in parts the patch did not touch, so
1486 * recursive ends up canceling them, saying that we reverted all those
1490 init_merge_options(&o
);
1493 his_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1494 o
.branch2
= his_tree_name
;
1499 if (merge_recursive_generic(&o
, our_tree
, his_tree
, 1, bases
, &result
)) {
1500 rerere(state
->allow_rerere_autoupdate
);
1501 free(his_tree_name
);
1502 return error(_("Failed to merge in the changes."));
1505 free(his_tree_name
);
1510 * Commits the current index with state->msg as the commit message and
1511 * state->author_name, state->author_email and state->author_date as the author
1514 static void do_commit(const struct am_state
*state
)
1516 unsigned char tree
[GIT_SHA1_RAWSZ
], parent
[GIT_SHA1_RAWSZ
],
1517 commit
[GIT_SHA1_RAWSZ
];
1519 struct commit_list
*parents
= NULL
;
1520 const char *reflog_msg
, *author
;
1521 struct strbuf sb
= STRBUF_INIT
;
1523 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1526 if (write_cache_as_tree(tree
, 0, NULL
))
1527 die(_("git write-tree failed to write a tree"));
1529 if (!get_sha1_commit("HEAD", parent
)) {
1531 commit_list_insert(lookup_commit(parent
), &parents
);
1534 say(state
, stderr
, _("applying to an empty history"));
1537 author
= fmt_ident(state
->author_name
, state
->author_email
,
1538 state
->ignore_date
? NULL
: state
->author_date
,
1541 if (state
->committer_date_is_author_date
)
1542 setenv("GIT_COMMITTER_DATE",
1543 state
->ignore_date
? "" : state
->author_date
, 1);
1545 if (commit_tree(state
->msg
, state
->msg_len
, tree
, parents
, commit
,
1546 author
, state
->sign_commit
))
1547 die(_("failed to write commit object"));
1549 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1553 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1556 update_ref(sb
.buf
, "HEAD", commit
, ptr
, 0, UPDATE_REFS_DIE_ON_ERR
);
1558 if (state
->rebasing
) {
1559 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1561 assert(!is_null_sha1(state
->orig_commit
));
1562 fprintf(fp
, "%s ", sha1_to_hex(state
->orig_commit
));
1563 fprintf(fp
, "%s\n", sha1_to_hex(commit
));
1567 run_hook_le(NULL
, "post-applypatch", NULL
);
1569 strbuf_release(&sb
);
1573 * Validates the am_state for resuming -- the "msg" and authorship fields must
1576 static void validate_resume_state(const struct am_state
*state
)
1579 die(_("cannot resume: %s does not exist."),
1580 am_path(state
, "final-commit"));
1582 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1583 die(_("cannot resume: %s does not exist."),
1584 am_path(state
, "author-script"));
1588 * Applies all queued mail.
1590 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1591 * well as the state directory's "patch" file is used as-is for applying the
1592 * patch and committing it.
1594 static void am_run(struct am_state
*state
, int resume
)
1596 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1597 struct strbuf sb
= STRBUF_INIT
;
1599 unlink(am_path(state
, "dirtyindex"));
1601 refresh_and_write_cache();
1603 if (index_has_changes(&sb
)) {
1604 write_file(am_path(state
, "dirtyindex"), 1, "t");
1605 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1608 strbuf_release(&sb
);
1610 while (state
->cur
<= state
->last
) {
1611 const char *mail
= am_path(state
, msgnum(state
));
1614 if (!file_exists(mail
))
1618 validate_resume_state(state
);
1623 if (state
->rebasing
)
1624 skip
= parse_mail_rebase(state
, mail
);
1626 skip
= parse_mail(state
, mail
);
1629 goto next
; /* mail should be skipped */
1631 write_author_script(state
);
1632 write_commit_msg(state
);
1635 if (run_applypatch_msg_hook(state
))
1638 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1640 apply_status
= run_apply(state
, NULL
);
1642 if (apply_status
&& state
->threeway
) {
1643 struct strbuf sb
= STRBUF_INIT
;
1645 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1646 apply_status
= fall_back_threeway(state
, sb
.buf
);
1647 strbuf_release(&sb
);
1650 * Applying the patch to an earlier tree and merging
1651 * the result may have produced the same tree as ours.
1653 if (!apply_status
&& !index_has_changes(NULL
)) {
1654 say(state
, stdout
, _("No changes -- Patch already applied."));
1660 int advice_amworkdir
= 1;
1662 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1663 linelen(state
->msg
), state
->msg
);
1665 git_config_get_bool("advice.amworkdir", &advice_amworkdir
);
1667 if (advice_amworkdir
)
1668 printf_ln(_("The copy of the patch that failed is found in: %s"),
1669 am_path(state
, "patch"));
1671 die_user_resolve(state
);
1680 if (!is_empty_file(am_path(state
, "rewritten"))) {
1681 assert(state
->rebasing
);
1682 copy_notes_for_rebase(state
);
1683 run_post_rewrite_hook(state
);
1687 * In rebasing mode, it's up to the caller to take care of
1690 if (!state
->rebasing
) {
1692 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1697 * Resume the current am session after patch application failure. The user did
1698 * all the hard work, and we do not have to do any patch application. Just
1699 * trust and commit what the user has in the index and working tree.
1701 static void am_resolve(struct am_state
*state
)
1703 validate_resume_state(state
);
1705 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1707 if (!index_has_changes(NULL
)) {
1708 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1709 "If there is nothing left to stage, chances are that something else\n"
1710 "already introduced the same changes; you might want to skip this patch."));
1711 die_user_resolve(state
);
1714 if (unmerged_cache()) {
1715 printf_ln(_("You still have unmerged paths in your index.\n"
1716 "Did you forget to use 'git add'?"));
1717 die_user_resolve(state
);
1729 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1730 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1733 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1735 struct lock_file
*lock_file
;
1736 struct unpack_trees_options opts
;
1737 struct tree_desc t
[2];
1739 if (parse_tree(head
) || parse_tree(remote
))
1742 lock_file
= xcalloc(1, sizeof(struct lock_file
));
1743 hold_locked_index(lock_file
, 1);
1745 refresh_cache(REFRESH_QUIET
);
1747 memset(&opts
, 0, sizeof(opts
));
1749 opts
.src_index
= &the_index
;
1750 opts
.dst_index
= &the_index
;
1754 opts
.fn
= twoway_merge
;
1755 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1756 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1758 if (unpack_trees(2, t
, &opts
)) {
1759 rollback_lock_file(lock_file
);
1763 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1764 die(_("unable to write new index file"));
1770 * Clean the index without touching entries that are not modified between
1771 * `head` and `remote`.
1773 static int clean_index(const unsigned char *head
, const unsigned char *remote
)
1775 struct lock_file
*lock_file
;
1776 struct tree
*head_tree
, *remote_tree
, *index_tree
;
1777 unsigned char index
[GIT_SHA1_RAWSZ
];
1778 struct pathspec pathspec
;
1780 head_tree
= parse_tree_indirect(head
);
1782 return error(_("Could not parse object '%s'."), sha1_to_hex(head
));
1784 remote_tree
= parse_tree_indirect(remote
);
1786 return error(_("Could not parse object '%s'."), sha1_to_hex(remote
));
1788 read_cache_unmerged();
1790 if (fast_forward_to(head_tree
, head_tree
, 1))
1793 if (write_cache_as_tree(index
, 0, NULL
))
1796 index_tree
= parse_tree_indirect(index
);
1798 return error(_("Could not parse object '%s'."), sha1_to_hex(index
));
1800 if (fast_forward_to(index_tree
, remote_tree
, 0))
1803 memset(&pathspec
, 0, sizeof(pathspec
));
1805 lock_file
= xcalloc(1, sizeof(struct lock_file
));
1806 hold_locked_index(lock_file
, 1);
1808 if (read_tree(remote_tree
, 0, &pathspec
)) {
1809 rollback_lock_file(lock_file
);
1813 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1814 die(_("unable to write new index file"));
1816 remove_branch_state();
1822 * Resets rerere's merge resolution metadata.
1824 static void am_rerere_clear(void)
1826 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
1827 int fd
= setup_rerere(&merge_rr
, 0);
1832 rerere_clear(&merge_rr
);
1833 string_list_clear(&merge_rr
, 1);
1837 * Resume the current am session by skipping the current patch.
1839 static void am_skip(struct am_state
*state
)
1841 unsigned char head
[GIT_SHA1_RAWSZ
];
1845 if (get_sha1("HEAD", head
))
1846 hashcpy(head
, EMPTY_TREE_SHA1_BIN
);
1848 if (clean_index(head
, head
))
1849 die(_("failed to clean index"));
1856 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
1858 * It is not safe to reset HEAD when:
1859 * 1. git-am previously failed because the index was dirty.
1860 * 2. HEAD has moved since git-am previously failed.
1862 static int safe_to_abort(const struct am_state
*state
)
1864 struct strbuf sb
= STRBUF_INIT
;
1865 unsigned char abort_safety
[GIT_SHA1_RAWSZ
], head
[GIT_SHA1_RAWSZ
];
1867 if (file_exists(am_path(state
, "dirtyindex")))
1870 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
1871 if (get_sha1_hex(sb
.buf
, abort_safety
))
1872 die(_("could not parse %s"), am_path(state
, "abort_safety"));
1874 hashclr(abort_safety
);
1876 if (get_sha1("HEAD", head
))
1879 if (!hashcmp(head
, abort_safety
))
1882 error(_("You seem to have moved HEAD since the last 'am' failure.\n"
1883 "Not rewinding to ORIG_HEAD"));
1889 * Aborts the current am session if it is safe to do so.
1891 static void am_abort(struct am_state
*state
)
1893 unsigned char curr_head
[GIT_SHA1_RAWSZ
], orig_head
[GIT_SHA1_RAWSZ
];
1894 int has_curr_head
, has_orig_head
;
1897 if (!safe_to_abort(state
)) {
1904 curr_branch
= resolve_refdup("HEAD", 0, curr_head
, NULL
);
1905 has_curr_head
= !is_null_sha1(curr_head
);
1907 hashcpy(curr_head
, EMPTY_TREE_SHA1_BIN
);
1909 has_orig_head
= !get_sha1("ORIG_HEAD", orig_head
);
1911 hashcpy(orig_head
, EMPTY_TREE_SHA1_BIN
);
1913 clean_index(curr_head
, orig_head
);
1916 update_ref("am --abort", "HEAD", orig_head
,
1917 has_curr_head
? curr_head
: NULL
, 0,
1918 UPDATE_REFS_DIE_ON_ERR
);
1919 else if (curr_branch
)
1920 delete_ref(curr_branch
, NULL
, REF_NODEREF
);
1927 * parse_options() callback that validates and sets opt->value to the
1928 * PATCH_FORMAT_* enum value corresponding to `arg`.
1930 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
1932 int *opt_value
= opt
->value
;
1934 if (!strcmp(arg
, "mbox"))
1935 *opt_value
= PATCH_FORMAT_MBOX
;
1936 else if (!strcmp(arg
, "stgit"))
1937 *opt_value
= PATCH_FORMAT_STGIT
;
1938 else if (!strcmp(arg
, "stgit-series"))
1939 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
1941 return error(_("Invalid value for --patch-format: %s"), arg
);
1953 int cmd_am(int argc
, const char **argv
, const char *prefix
)
1955 struct am_state state
;
1957 int patch_format
= PATCH_FORMAT_UNKNOWN
;
1958 enum resume_mode resume
= RESUME_FALSE
;
1960 const char * const usage
[] = {
1961 N_("git am [options] [(<mbox>|<Maildir>)...]"),
1962 N_("git am [options] (--continue | --skip | --abort)"),
1966 struct option options
[] = {
1967 OPT_BOOL('3', "3way", &state
.threeway
,
1968 N_("allow fall back on 3way merging if needed")),
1969 OPT__QUIET(&state
.quiet
, N_("be quiet")),
1970 OPT_BOOL('s', "signoff", &state
.signoff
,
1971 N_("add a Signed-off-by line to the commit message")),
1972 OPT_BOOL('u', "utf8", &state
.utf8
,
1973 N_("recode into utf8 (default)")),
1974 OPT_SET_INT('k', "keep", &state
.keep
,
1975 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
1976 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
1977 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
1978 OPT_BOOL('m', "message-id", &state
.message_id
,
1979 N_("pass -m flag to git-mailinfo")),
1980 { OPTION_SET_INT
, 0, "keep-cr", &keep_cr
, NULL
,
1981 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
1982 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 1},
1983 { OPTION_SET_INT
, 0, "no-keep-cr", &keep_cr
, NULL
,
1984 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
1985 PARSE_OPT_NOARG
| PARSE_OPT_NONEG
, NULL
, 0},
1986 OPT_BOOL('c', "scissors", &state
.scissors
,
1987 N_("strip everything before a scissors line")),
1988 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
1989 N_("pass it through git-apply"),
1991 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
1992 N_("pass it through git-apply"),
1994 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
1995 N_("pass it through git-apply"),
1997 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
1998 N_("pass it through git-apply"),
2000 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2001 N_("pass it through git-apply"),
2003 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2004 N_("pass it through git-apply"),
2006 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2007 N_("pass it through git-apply"),
2009 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2010 N_("pass it through git-apply"),
2012 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2013 N_("format the patch(es) are in"),
2014 parse_opt_patchformat
),
2015 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2016 N_("pass it through git-apply"),
2018 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2019 N_("override error message when patch failure occurs")),
2020 OPT_CMDMODE(0, "continue", &resume
,
2021 N_("continue applying patches after resolving a conflict"),
2023 OPT_CMDMODE('r', "resolved", &resume
,
2024 N_("synonyms for --continue"),
2026 OPT_CMDMODE(0, "skip", &resume
,
2027 N_("skip the current patch"),
2029 OPT_CMDMODE(0, "abort", &resume
,
2030 N_("restore the original branch and abort the patching operation."),
2032 OPT_BOOL(0, "committer-date-is-author-date",
2033 &state
.committer_date_is_author_date
,
2034 N_("lie about committer date")),
2035 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2036 N_("use current timestamp for author date")),
2037 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2038 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2039 N_("GPG-sign commits"),
2040 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2041 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2042 N_("(internal use for git-rebase)")),
2047 * NEEDSWORK: Once all the features of git-am.sh have been
2048 * re-implemented in builtin/am.c, this preamble can be removed.
2050 if (!getenv("_GIT_USE_BUILTIN_AM")) {
2051 const char *path
= mkpath("%s/git-am", git_exec_path());
2053 if (sane_execvp(path
, (char **)argv
) < 0)
2054 die_errno("could not exec %s", path
);
2056 prefix
= setup_git_directory();
2057 trace_repo_setup(prefix
);
2061 git_config(git_default_config
, NULL
);
2063 am_state_init(&state
, git_path("rebase-apply"));
2065 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2067 if (read_index_preload(&the_index
, NULL
) < 0)
2068 die(_("failed to read the index"));
2070 if (am_in_progress(&state
)) {
2072 * Catch user error to feed us patches when there is a session
2075 * 1. mbox path(s) are provided on the command-line.
2076 * 2. stdin is not a tty: the user is trying to feed us a patch
2077 * from standard input. This is somewhat unreliable -- stdin
2078 * could be /dev/null for example and the caller did not
2079 * intend to feed us a patch but wanted to continue
2082 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
2083 die(_("previous rebase directory %s still exists but mbox given."),
2086 if (resume
== RESUME_FALSE
)
2087 resume
= RESUME_APPLY
;
2091 struct argv_array paths
= ARGV_ARRAY_INIT
;
2095 * Handle stray state directory in the independent-run case. In
2096 * the --rebasing case, it is up to the caller to take care of
2097 * stray directories.
2099 if (file_exists(state
.dir
) && !state
.rebasing
) {
2100 if (resume
== RESUME_ABORT
) {
2102 am_state_release(&state
);
2106 die(_("Stray %s directory found.\n"
2107 "Use \"git am --abort\" to remove it."),
2112 die(_("Resolve operation not in progress, we are not resuming."));
2114 for (i
= 0; i
< argc
; i
++) {
2115 if (is_absolute_path(argv
[i
]) || !prefix
)
2116 argv_array_push(&paths
, argv
[i
]);
2118 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2121 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2123 argv_array_clear(&paths
);
2133 case RESUME_RESOLVED
:
2143 die("BUG: invalid resume value");
2146 am_state_release(&state
);