4 * Based on git-am.sh by Junio C Hamano.
6 #define USE_THE_INDEX_VARIABLE
12 #include "environment.h"
15 #include "parse-options.h"
17 #include "run-command.h"
22 #include "cache-tree.h"
26 #include "unpack-trees.h"
28 #include "object-name.h"
29 #include "preload-index.h"
30 #include "sequencer.h"
32 #include "merge-recursive.h"
34 #include "notes-utils.h"
38 #include "string-list.h"
41 #include "repository.h"
45 * Returns the length of the first line of msg.
47 static int linelen(const char *msg
)
49 return strchrnul(msg
, '\n') - msg
;
53 * Returns true if `str` consists of only whitespace, false otherwise.
55 static int str_isspace(const char *str
)
65 PATCH_FORMAT_UNKNOWN
= 0,
68 PATCH_FORMAT_STGIT_SERIES
,
75 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
76 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
81 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
82 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
88 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
98 RESUME_SHOW_PATCH_RAW
,
99 RESUME_SHOW_PATCH_DIFF
,
104 STOP_ON_EMPTY_COMMIT
= 0, /* output errors and stop in the middle of an am session */
105 DROP_EMPTY_COMMIT
, /* skip with a notice message, unless "--quiet" has been passed */
106 KEEP_EMPTY_COMMIT
, /* keep recording as empty commits */
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 struct object_id orig_commit
;
127 /* number of digits in patch filename */
130 /* various operating modes and command line options */
135 int signoff
; /* enum signoff_type */
137 int keep
; /* enum keep_type */
139 int scissors
; /* enum scissors_type */
140 int quoted_cr
; /* enum quoted_cr_action */
141 int empty_type
; /* enum empty_action */
142 struct strvec git_apply_opts
;
143 const char *resolvemsg
;
144 int committer_date_is_author_date
;
146 int allow_rerere_autoupdate
;
147 const char *sign_commit
;
152 * Initializes am_state with the default values.
154 static void am_state_init(struct am_state
*state
)
158 memset(state
, 0, sizeof(*state
));
160 state
->dir
= git_pathdup("rebase-apply");
164 git_config_get_bool("am.threeway", &state
->threeway
);
168 git_config_get_bool("am.messageid", &state
->message_id
);
170 state
->scissors
= SCISSORS_UNSET
;
171 state
->quoted_cr
= quoted_cr_unset
;
173 strvec_init(&state
->git_apply_opts
);
175 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
176 state
->sign_commit
= gpgsign
? "" : NULL
;
180 * Releases memory allocated by an am_state.
182 static void am_state_release(struct am_state
*state
)
185 free(state
->author_name
);
186 free(state
->author_email
);
187 free(state
->author_date
);
189 strvec_clear(&state
->git_apply_opts
);
192 static int am_option_parse_quoted_cr(const struct option
*opt
,
193 const char *arg
, int unset
)
195 BUG_ON_OPT_NEG(unset
);
197 if (mailinfo_parse_quoted_cr_action(arg
, opt
->value
) != 0)
198 return error(_("bad action '%s' for '%s'"), arg
, "--quoted-cr");
202 static int am_option_parse_empty(const struct option
*opt
,
203 const char *arg
, int unset
)
205 int *opt_value
= opt
->value
;
207 BUG_ON_OPT_NEG(unset
);
209 if (!strcmp(arg
, "stop"))
210 *opt_value
= STOP_ON_EMPTY_COMMIT
;
211 else if (!strcmp(arg
, "drop"))
212 *opt_value
= DROP_EMPTY_COMMIT
;
213 else if (!strcmp(arg
, "keep"))
214 *opt_value
= KEEP_EMPTY_COMMIT
;
216 return error(_("invalid value for '%s': '%s'"), "--empty", arg
);
222 * Returns path relative to the am_state directory.
224 static inline const char *am_path(const struct am_state
*state
, const char *path
)
226 return mkpath("%s/%s", state
->dir
, path
);
230 * For convenience to call write_file()
232 static void write_state_text(const struct am_state
*state
,
233 const char *name
, const char *string
)
235 write_file(am_path(state
, name
), "%s", string
);
238 static void write_state_count(const struct am_state
*state
,
239 const char *name
, int value
)
241 write_file(am_path(state
, name
), "%d", value
);
244 static void write_state_bool(const struct am_state
*state
,
245 const char *name
, int value
)
247 write_state_text(state
, name
, value
? "t" : "f");
251 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
254 __attribute__((format (printf
, 3, 4)))
255 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
261 vfprintf(fp
, fmt
, ap
);
268 * Returns 1 if there is an am session in progress, 0 otherwise.
270 static int am_in_progress(const struct am_state
*state
)
274 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
276 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
278 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
284 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
285 * number of bytes read on success, -1 if the file does not exist. If `trim` is
286 * set, trailing whitespace will be removed.
288 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
289 const char *file
, int trim
)
293 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
303 die_errno(_("could not read '%s'"), am_path(state
, file
));
307 * Reads and parses the state directory's "author-script" file, and sets
308 * state->author_name, state->author_email and state->author_date accordingly.
309 * Returns 0 on success, -1 if the file could not be parsed.
311 * The author script is of the format:
313 * GIT_AUTHOR_NAME='$author_name'
314 * GIT_AUTHOR_EMAIL='$author_email'
315 * GIT_AUTHOR_DATE='$author_date'
317 * where $author_name, $author_email and $author_date are quoted. We are strict
318 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
319 * script, and thus if the file differs from what this function expects, it is
320 * better to bail out than to do something that the user does not expect.
322 static int read_am_author_script(struct am_state
*state
)
324 const char *filename
= am_path(state
, "author-script");
326 assert(!state
->author_name
);
327 assert(!state
->author_email
);
328 assert(!state
->author_date
);
330 return read_author_script(filename
, &state
->author_name
,
331 &state
->author_email
, &state
->author_date
, 1);
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_state_text(state
, "author-script", 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
)
386 const char *filename
= am_path(state
, "final-commit");
387 write_file_buf(filename
, state
->msg
, state
->msg_len
);
391 * Loads state from disk.
393 static void am_load(struct am_state
*state
)
395 struct strbuf sb
= STRBUF_INIT
;
397 if (read_state_file(&sb
, state
, "next", 1) < 0)
398 BUG("state file 'next' does not exist");
399 state
->cur
= strtol(sb
.buf
, NULL
, 10);
401 if (read_state_file(&sb
, state
, "last", 1) < 0)
402 BUG("state file 'last' does not exist");
403 state
->last
= strtol(sb
.buf
, NULL
, 10);
405 if (read_am_author_script(state
) < 0)
406 die(_("could not parse author script"));
408 read_commit_msg(state
);
410 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
411 oidclr(&state
->orig_commit
);
412 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
413 die(_("could not parse %s"), am_path(state
, "original-commit"));
415 read_state_file(&sb
, state
, "threeway", 1);
416 state
->threeway
= !strcmp(sb
.buf
, "t");
418 read_state_file(&sb
, state
, "quiet", 1);
419 state
->quiet
= !strcmp(sb
.buf
, "t");
421 read_state_file(&sb
, state
, "sign", 1);
422 state
->signoff
= !strcmp(sb
.buf
, "t");
424 read_state_file(&sb
, state
, "utf8", 1);
425 state
->utf8
= !strcmp(sb
.buf
, "t");
427 if (file_exists(am_path(state
, "rerere-autoupdate"))) {
428 read_state_file(&sb
, state
, "rerere-autoupdate", 1);
429 state
->allow_rerere_autoupdate
= strcmp(sb
.buf
, "t") ?
430 RERERE_NOAUTOUPDATE
: RERERE_AUTOUPDATE
;
432 state
->allow_rerere_autoupdate
= 0;
435 read_state_file(&sb
, state
, "keep", 1);
436 if (!strcmp(sb
.buf
, "t"))
437 state
->keep
= KEEP_TRUE
;
438 else if (!strcmp(sb
.buf
, "b"))
439 state
->keep
= KEEP_NON_PATCH
;
441 state
->keep
= KEEP_FALSE
;
443 read_state_file(&sb
, state
, "messageid", 1);
444 state
->message_id
= !strcmp(sb
.buf
, "t");
446 read_state_file(&sb
, state
, "scissors", 1);
447 if (!strcmp(sb
.buf
, "t"))
448 state
->scissors
= SCISSORS_TRUE
;
449 else if (!strcmp(sb
.buf
, "f"))
450 state
->scissors
= SCISSORS_FALSE
;
452 state
->scissors
= SCISSORS_UNSET
;
454 read_state_file(&sb
, state
, "quoted-cr", 1);
456 state
->quoted_cr
= quoted_cr_unset
;
457 else if (mailinfo_parse_quoted_cr_action(sb
.buf
, &state
->quoted_cr
) != 0)
458 die(_("could not parse %s"), am_path(state
, "quoted-cr"));
460 read_state_file(&sb
, state
, "apply-opt", 1);
461 strvec_clear(&state
->git_apply_opts
);
462 if (sq_dequote_to_strvec(sb
.buf
, &state
->git_apply_opts
) < 0)
463 die(_("could not parse %s"), am_path(state
, "apply-opt"));
465 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
471 * Removes the am_state directory, forcefully terminating the current am
474 static void am_destroy(const struct am_state
*state
)
476 struct strbuf sb
= STRBUF_INIT
;
478 strbuf_addstr(&sb
, state
->dir
);
479 remove_dir_recursively(&sb
, 0);
484 * Runs applypatch-msg hook. Returns its exit code.
486 static int run_applypatch_msg_hook(struct am_state
*state
)
492 if (!state
->no_verify
)
493 ret
= run_hooks_l("applypatch-msg", am_path(state
, "final-commit"), NULL
);
496 FREE_AND_NULL(state
->msg
);
497 if (read_commit_msg(state
) < 0)
498 die(_("'%s' was deleted by the applypatch-msg hook"),
499 am_path(state
, "final-commit"));
506 * Runs post-rewrite hook. Returns it exit code.
508 static int run_post_rewrite_hook(const struct am_state
*state
)
510 struct run_hooks_opt opt
= RUN_HOOKS_OPT_INIT
;
512 strvec_push(&opt
.args
, "rebase");
513 opt
.path_to_stdin
= am_path(state
, "rewritten");
515 return run_hooks_opt("post-rewrite", &opt
);
519 * Reads the state directory's "rewritten" file, and copies notes from the old
520 * commits listed in the file to their rewritten commits.
522 * Returns 0 on success, -1 on failure.
524 static int copy_notes_for_rebase(const struct am_state
*state
)
526 struct notes_rewrite_cfg
*c
;
527 struct strbuf sb
= STRBUF_INIT
;
528 const char *invalid_line
= _("Malformed input line: '%s'.");
529 const char *msg
= "Notes added by 'git rebase'";
533 assert(state
->rebasing
);
535 c
= init_copy_notes_for_rewrite("rebase");
539 fp
= xfopen(am_path(state
, "rewritten"), "r");
541 while (!strbuf_getline_lf(&sb
, fp
)) {
542 struct object_id from_obj
, to_obj
;
545 if (sb
.len
!= the_hash_algo
->hexsz
* 2 + 1) {
546 ret
= error(invalid_line
, sb
.buf
);
550 if (parse_oid_hex(sb
.buf
, &from_obj
, &p
)) {
551 ret
= error(invalid_line
, sb
.buf
);
556 ret
= error(invalid_line
, sb
.buf
);
560 if (get_oid_hex(p
+ 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 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
571 finish_copy_notes_for_rewrite(the_repository
, 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(&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(&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
;
659 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
660 ret
= PATCH_FORMAT_HG
;
664 strbuf_getline(&l2
, fp
);
665 strbuf_getline(&l3
, fp
);
668 * If the second line is empty and the third is a From, Author or Date
669 * entry, this is likely an StGit patch.
671 if (l1
.len
&& !l2
.len
&&
672 (starts_with(l3
.buf
, "From:") ||
673 starts_with(l3
.buf
, "Author:") ||
674 starts_with(l3
.buf
, "Date:"))) {
675 ret
= PATCH_FORMAT_STGIT
;
679 if (l1
.len
&& is_mail(fp
)) {
680 ret
= PATCH_FORMAT_MBOX
;
693 * Splits out individual email patches from `paths`, where each path is either
694 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
696 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
697 int keep_cr
, int mboxrd
)
699 struct child_process cp
= CHILD_PROCESS_INIT
;
700 struct strbuf last
= STRBUF_INIT
;
704 strvec_push(&cp
.args
, "mailsplit");
705 strvec_pushf(&cp
.args
, "-d%d", state
->prec
);
706 strvec_pushf(&cp
.args
, "-o%s", state
->dir
);
707 strvec_push(&cp
.args
, "-b");
709 strvec_push(&cp
.args
, "--keep-cr");
711 strvec_push(&cp
.args
, "--mboxrd");
712 strvec_push(&cp
.args
, "--");
713 strvec_pushv(&cp
.args
, paths
);
715 ret
= capture_command(&cp
, &last
, 8);
720 state
->last
= strtol(last
.buf
, NULL
, 10);
723 strbuf_release(&last
);
728 * Callback signature for split_mail_conv(). The foreign patch should be
729 * read from `in`, and the converted patch (in RFC2822 mail format) should be
730 * written to `out`. Return 0 on success, or -1 on failure.
732 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
735 * Calls `fn` for each file in `paths` to convert the foreign patch to the
736 * RFC2822 mail format suitable for parsing with git-mailinfo.
738 * Returns 0 on success, -1 on failure.
740 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
741 const char **paths
, int keep_cr
)
743 static const char *stdin_only
[] = {"-", NULL
};
749 for (i
= 0; *paths
; paths
++, i
++) {
754 if (!strcmp(*paths
, "-"))
757 in
= fopen(*paths
, "r");
760 return error_errno(_("could not open '%s' for reading"),
763 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
765 out
= fopen(mail
, "w");
769 return error_errno(_("could not open '%s' for writing"),
773 ret
= fn(out
, in
, keep_cr
);
780 return error(_("could not parse patch '%s'"), *paths
);
789 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
790 * message suitable for parsing with git-mailinfo.
792 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr UNUSED
)
794 struct strbuf sb
= STRBUF_INIT
;
795 int subject_printed
= 0;
797 while (!strbuf_getline_lf(&sb
, in
)) {
800 if (str_isspace(sb
.buf
))
802 else if (skip_prefix(sb
.buf
, "Author:", &str
))
803 fprintf(out
, "From:%s\n", str
);
804 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
805 fprintf(out
, "%s\n", sb
.buf
);
806 else if (!subject_printed
) {
807 fprintf(out
, "Subject: %s\n", sb
.buf
);
810 fprintf(out
, "\n%s\n", sb
.buf
);
816 while (strbuf_fread(&sb
, 8192, in
) > 0) {
817 fwrite(sb
.buf
, 1, sb
.len
, out
);
826 * This function only supports a single StGit series file in `paths`.
828 * Given an StGit series file, converts the StGit patches in the series into
829 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
830 * the state directory.
832 * Returns 0 on success, -1 on failure.
834 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
837 const char *series_dir
;
838 char *series_dir_buf
;
840 struct strvec patches
= STRVEC_INIT
;
841 struct strbuf sb
= STRBUF_INIT
;
844 if (!paths
[0] || paths
[1])
845 return error(_("Only one StGIT patch series can be applied at once"));
847 series_dir_buf
= xstrdup(*paths
);
848 series_dir
= dirname(series_dir_buf
);
850 fp
= fopen(*paths
, "r");
852 return error_errno(_("could not open '%s' for reading"), *paths
);
854 while (!strbuf_getline_lf(&sb
, fp
)) {
856 continue; /* skip comment lines */
858 strvec_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
863 free(series_dir_buf
);
865 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.v
, keep_cr
);
867 strvec_clear(&patches
);
872 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
873 * message suitable for parsing with git-mailinfo.
875 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr UNUSED
)
877 struct strbuf sb
= STRBUF_INIT
;
880 while (!strbuf_getline_lf(&sb
, in
)) {
883 if (skip_prefix(sb
.buf
, "# User ", &str
))
884 fprintf(out
, "From: %s\n", str
);
885 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
886 timestamp_t timestamp
;
891 timestamp
= parse_timestamp(str
, &end
, 10);
893 rc
= error(_("invalid timestamp"));
897 if (!skip_prefix(end
, " ", &str
)) {
898 rc
= error(_("invalid Date line"));
903 tz
= strtol(str
, &end
, 10);
905 rc
= error(_("invalid timezone offset"));
910 rc
= error(_("invalid Date line"));
915 * mercurial's timezone is in seconds west of UTC,
916 * however git's timezone is in hours + minutes east of
919 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
923 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
924 } else if (starts_with(sb
.buf
, "# ")) {
927 fprintf(out
, "\n%s\n", sb
.buf
);
933 while (strbuf_fread(&sb
, 8192, in
) > 0) {
934 fwrite(sb
.buf
, 1, sb
.len
, out
);
943 * Splits a list of files/directories into individual email patches. Each path
944 * in `paths` must be a file/directory that is formatted according to
947 * Once split out, the individual email patches will be stored in the state
948 * directory, with each patch's filename being its index, padded to state->prec
951 * state->cur will be set to the index of the first mail, and state->last will
952 * be set to the index of the last mail.
954 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
955 * to disable this behavior, -1 to use the default configured setting.
957 * Returns 0 on success, -1 on failure.
959 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
960 const char **paths
, int keep_cr
)
964 git_config_get_bool("am.keepcr", &keep_cr
);
967 switch (patch_format
) {
968 case PATCH_FORMAT_MBOX
:
969 return split_mail_mbox(state
, paths
, keep_cr
, 0);
970 case PATCH_FORMAT_STGIT
:
971 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
972 case PATCH_FORMAT_STGIT_SERIES
:
973 return split_mail_stgit_series(state
, paths
, keep_cr
);
974 case PATCH_FORMAT_HG
:
975 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
976 case PATCH_FORMAT_MBOXRD
:
977 return split_mail_mbox(state
, paths
, keep_cr
, 1);
979 BUG("invalid patch_format");
985 * Setup a new am session for applying patches
987 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
988 const char **paths
, int keep_cr
)
990 struct object_id curr_head
;
992 struct strbuf sb
= STRBUF_INIT
;
995 patch_format
= detect_patch_format(paths
);
998 fprintf_ln(stderr
, _("Patch format detection failed."));
1002 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
1003 die_errno(_("failed to create directory '%s'"), state
->dir
);
1004 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
1006 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
1008 die(_("Failed to split patches."));
1011 if (state
->rebasing
)
1012 state
->threeway
= 1;
1014 write_state_bool(state
, "threeway", state
->threeway
);
1015 write_state_bool(state
, "quiet", state
->quiet
);
1016 write_state_bool(state
, "sign", state
->signoff
);
1017 write_state_bool(state
, "utf8", state
->utf8
);
1019 if (state
->allow_rerere_autoupdate
)
1020 write_state_bool(state
, "rerere-autoupdate",
1021 state
->allow_rerere_autoupdate
== RERERE_AUTOUPDATE
);
1023 switch (state
->keep
) {
1030 case KEEP_NON_PATCH
:
1034 BUG("invalid value for state->keep");
1037 write_state_text(state
, "keep", str
);
1038 write_state_bool(state
, "messageid", state
->message_id
);
1040 switch (state
->scissors
) {
1041 case SCISSORS_UNSET
:
1044 case SCISSORS_FALSE
:
1051 BUG("invalid value for state->scissors");
1053 write_state_text(state
, "scissors", str
);
1055 switch (state
->quoted_cr
) {
1056 case quoted_cr_unset
:
1059 case quoted_cr_nowarn
:
1062 case quoted_cr_warn
:
1065 case quoted_cr_strip
:
1069 BUG("invalid value for state->quoted_cr");
1071 write_state_text(state
, "quoted-cr", str
);
1073 sq_quote_argv(&sb
, state
->git_apply_opts
.v
);
1074 write_state_text(state
, "apply-opt", sb
.buf
);
1076 if (state
->rebasing
)
1077 write_state_text(state
, "rebasing", "");
1079 write_state_text(state
, "applying", "");
1081 if (!repo_get_oid(the_repository
, "HEAD", &curr_head
)) {
1082 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1083 if (!state
->rebasing
)
1084 update_ref("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1085 UPDATE_REFS_DIE_ON_ERR
);
1087 write_state_text(state
, "abort-safety", "");
1088 if (!state
->rebasing
)
1089 delete_ref(NULL
, "ORIG_HEAD", NULL
, 0);
1093 * NOTE: Since the "next" and "last" files determine if an am_state
1094 * session is in progress, they should be written last.
1097 write_state_count(state
, "next", state
->cur
);
1098 write_state_count(state
, "last", state
->last
);
1100 strbuf_release(&sb
);
1104 * Increments the patch pointer, and cleans am_state for the application of the
1107 static void am_next(struct am_state
*state
)
1109 struct object_id head
;
1111 FREE_AND_NULL(state
->author_name
);
1112 FREE_AND_NULL(state
->author_email
);
1113 FREE_AND_NULL(state
->author_date
);
1114 FREE_AND_NULL(state
->msg
);
1117 unlink(am_path(state
, "author-script"));
1118 unlink(am_path(state
, "final-commit"));
1120 oidclr(&state
->orig_commit
);
1121 unlink(am_path(state
, "original-commit"));
1122 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
1124 if (!repo_get_oid(the_repository
, "HEAD", &head
))
1125 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1127 write_state_text(state
, "abort-safety", "");
1130 write_state_count(state
, "next", state
->cur
);
1134 * Returns the filename of the current patch email.
1136 static const char *msgnum(const struct am_state
*state
)
1138 static struct strbuf sb
= STRBUF_INIT
;
1141 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1147 * Dies with a user-friendly message on how to proceed after resolving the
1148 * problem. This message can be overridden with state->resolvemsg.
1150 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1152 if (state
->resolvemsg
) {
1153 printf_ln("%s", state
->resolvemsg
);
1155 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1157 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1158 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1160 if (advice_enabled(ADVICE_AM_WORK_DIR
) &&
1161 is_empty_or_missing_file(am_path(state
, "patch")) &&
1162 !repo_index_has_changes(the_repository
, NULL
, NULL
))
1163 printf_ln(_("To record the empty patch as an empty commit, run \"%s --allow-empty\"."), cmdline
);
1165 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1172 * Appends signoff to the "msg" field of the am_state.
1174 static void am_append_signoff(struct am_state
*state
)
1176 struct strbuf sb
= STRBUF_INIT
;
1178 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1179 append_signoff(&sb
, 0, 0);
1180 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1184 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1185 * state->msg will be set to the patch message. state->author_name,
1186 * state->author_email and state->author_date will be set to the patch author's
1187 * name, email and date respectively. The patch body will be written to the
1188 * state directory's "patch" file.
1190 * Returns 1 if the patch should be skipped, 0 otherwise.
1192 static int parse_mail(struct am_state
*state
, const char *mail
)
1195 struct strbuf sb
= STRBUF_INIT
;
1196 struct strbuf msg
= STRBUF_INIT
;
1197 struct strbuf author_name
= STRBUF_INIT
;
1198 struct strbuf author_date
= STRBUF_INIT
;
1199 struct strbuf author_email
= STRBUF_INIT
;
1203 setup_mailinfo(&mi
);
1206 mi
.metainfo_charset
= get_commit_output_encoding();
1208 mi
.metainfo_charset
= NULL
;
1210 switch (state
->keep
) {
1214 mi
.keep_subject
= 1;
1216 case KEEP_NON_PATCH
:
1217 mi
.keep_non_patch_brackets_in_subject
= 1;
1220 BUG("invalid value for state->keep");
1223 if (state
->message_id
)
1224 mi
.add_message_id
= 1;
1226 switch (state
->scissors
) {
1227 case SCISSORS_UNSET
:
1229 case SCISSORS_FALSE
:
1230 mi
.use_scissors
= 0;
1233 mi
.use_scissors
= 1;
1236 BUG("invalid value for state->scissors");
1239 switch (state
->quoted_cr
) {
1240 case quoted_cr_unset
:
1242 case quoted_cr_nowarn
:
1243 case quoted_cr_warn
:
1244 case quoted_cr_strip
:
1245 mi
.quoted_cr
= state
->quoted_cr
;
1248 BUG("invalid value for state->quoted_cr");
1251 mi
.input
= xfopen(mail
, "r");
1252 mi
.output
= xfopen(am_path(state
, "info"), "w");
1253 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1254 die("could not parse patch");
1259 if (mi
.format_flowed
)
1260 warning(_("Patch sent with format=flowed; "
1261 "space at the end of lines might be lost."));
1263 /* Extract message and author information */
1264 fp
= xfopen(am_path(state
, "info"), "r");
1265 while (!strbuf_getline_lf(&sb
, fp
)) {
1268 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1270 strbuf_addch(&msg
, '\n');
1271 strbuf_addstr(&msg
, x
);
1272 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1273 strbuf_addstr(&author_name
, x
);
1274 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1275 strbuf_addstr(&author_email
, x
);
1276 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1277 strbuf_addstr(&author_date
, x
);
1281 /* Skip pine's internal folder data */
1282 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1287 strbuf_addstr(&msg
, "\n\n");
1288 strbuf_addbuf(&msg
, &mi
.log_message
);
1289 strbuf_stripspace(&msg
, '\0');
1291 assert(!state
->author_name
);
1292 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1294 assert(!state
->author_email
);
1295 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1297 assert(!state
->author_date
);
1298 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1300 assert(!state
->msg
);
1301 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1304 strbuf_release(&msg
);
1305 strbuf_release(&author_date
);
1306 strbuf_release(&author_email
);
1307 strbuf_release(&author_name
);
1308 strbuf_release(&sb
);
1309 clear_mailinfo(&mi
);
1314 * Sets commit_id to the commit hash where the mail was generated from.
1315 * Returns 0 on success, -1 on failure.
1317 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1319 struct strbuf sb
= STRBUF_INIT
;
1320 FILE *fp
= xfopen(mail
, "r");
1324 if (strbuf_getline_lf(&sb
, fp
) ||
1325 !skip_prefix(sb
.buf
, "From ", &x
) ||
1326 get_oid_hex(x
, commit_id
) < 0)
1329 strbuf_release(&sb
);
1335 * Sets state->msg, state->author_name, state->author_email, state->author_date
1336 * to the commit's respective info.
1338 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1340 const char *buffer
, *ident_line
, *msg
;
1342 struct ident_split id
;
1344 buffer
= repo_logmsg_reencode(the_repository
, commit
, NULL
,
1345 get_commit_output_encoding());
1347 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1349 die(_("missing author line in commit %s"),
1350 oid_to_hex(&commit
->object
.oid
));
1351 if (split_ident_line(&id
, ident_line
, ident_len
) < 0)
1352 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1354 assert(!state
->author_name
);
1356 state
->author_name
=
1357 xmemdupz(id
.name_begin
, id
.name_end
- id
.name_begin
);
1359 state
->author_name
= xstrdup("");
1361 assert(!state
->author_email
);
1363 state
->author_email
=
1364 xmemdupz(id
.mail_begin
, id
.mail_end
- id
.mail_begin
);
1366 state
->author_email
= xstrdup("");
1368 assert(!state
->author_date
);
1369 state
->author_date
= xstrdup(show_ident_date(&id
, DATE_MODE(NORMAL
)));
1371 assert(!state
->msg
);
1372 msg
= strstr(buffer
, "\n\n");
1374 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1375 state
->msg
= xstrdup(msg
+ 2);
1376 state
->msg_len
= strlen(state
->msg
);
1377 repo_unuse_commit_buffer(the_repository
, commit
, buffer
);
1381 * Writes `commit` as a patch to the state directory's "patch" file.
1383 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1385 struct rev_info rev_info
;
1388 fp
= xfopen(am_path(state
, "patch"), "w");
1389 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1391 rev_info
.abbrev
= 0;
1392 rev_info
.disable_stdin
= 1;
1393 rev_info
.show_root_diff
= 1;
1394 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1395 rev_info
.no_commit_id
= 1;
1396 rev_info
.diffopt
.flags
.binary
= 1;
1397 rev_info
.diffopt
.flags
.full_index
= 1;
1398 rev_info
.diffopt
.use_color
= 0;
1399 rev_info
.diffopt
.file
= fp
;
1400 rev_info
.diffopt
.close_file
= 1;
1401 add_pending_object(&rev_info
, &commit
->object
, "");
1402 diff_setup_done(&rev_info
.diffopt
);
1403 log_tree_commit(&rev_info
, commit
);
1404 release_revisions(&rev_info
);
1408 * Writes the diff of the index against HEAD as a patch to the state
1409 * directory's "patch" file.
1411 static void write_index_patch(const struct am_state
*state
)
1414 struct object_id head
;
1415 struct rev_info rev_info
;
1418 if (!repo_get_oid(the_repository
, "HEAD", &head
)) {
1419 struct commit
*commit
= lookup_commit_or_die(&head
, "HEAD");
1420 tree
= repo_get_commit_tree(the_repository
, commit
);
1422 tree
= lookup_tree(the_repository
,
1423 the_repository
->hash_algo
->empty_tree
);
1425 fp
= xfopen(am_path(state
, "patch"), "w");
1426 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1428 rev_info
.disable_stdin
= 1;
1429 rev_info
.no_commit_id
= 1;
1430 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1431 rev_info
.diffopt
.use_color
= 0;
1432 rev_info
.diffopt
.file
= fp
;
1433 rev_info
.diffopt
.close_file
= 1;
1434 add_pending_object(&rev_info
, &tree
->object
, "");
1435 diff_setup_done(&rev_info
.diffopt
);
1436 run_diff_index(&rev_info
, DIFF_INDEX_CACHED
);
1437 release_revisions(&rev_info
);
1441 * Like parse_mail(), but parses the mail by looking up its commit ID
1442 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1445 * state->orig_commit will be set to the original commit ID.
1447 * Will always return 0 as the patch should never be skipped.
1449 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1451 struct commit
*commit
;
1452 struct object_id commit_oid
;
1454 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1455 die(_("could not parse %s"), mail
);
1457 commit
= lookup_commit_or_die(&commit_oid
, mail
);
1459 get_commit_info(state
, commit
);
1461 write_commit_patch(state
, commit
);
1463 oidcpy(&state
->orig_commit
, &commit_oid
);
1464 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1465 update_ref("am", "REBASE_HEAD", &commit_oid
,
1466 NULL
, REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
1472 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1473 * `index_file` is not NULL, the patch will be applied to that index.
1475 static int run_apply(const struct am_state
*state
, const char *index_file
)
1477 struct strvec apply_paths
= STRVEC_INIT
;
1478 struct strvec apply_opts
= STRVEC_INIT
;
1479 struct apply_state apply_state
;
1481 int force_apply
= 0;
1483 const char **apply_argv
;
1485 if (init_apply_state(&apply_state
, the_repository
, NULL
))
1486 BUG("init_apply_state() failed");
1488 strvec_push(&apply_opts
, "apply");
1489 strvec_pushv(&apply_opts
, state
->git_apply_opts
.v
);
1492 * Build a copy that apply_parse_options() can rearrange.
1493 * apply_opts.v keeps referencing the allocated strings for
1494 * strvec_clear() to release.
1496 DUP_ARRAY(apply_argv
, apply_opts
.v
, apply_opts
.nr
);
1498 opts_left
= apply_parse_options(apply_opts
.nr
, apply_argv
,
1499 &apply_state
, &force_apply
, &options
,
1503 die("unknown option passed through to git apply");
1506 apply_state
.index_file
= index_file
;
1507 apply_state
.cached
= 1;
1509 apply_state
.check_index
= 1;
1512 * If we are allowed to fall back on 3-way merge, don't give false
1513 * errors during the initial attempt.
1515 if (state
->threeway
&& !index_file
)
1516 apply_state
.apply_verbosity
= verbosity_silent
;
1518 if (check_apply_state(&apply_state
, force_apply
))
1519 BUG("check_apply_state() failed");
1521 strvec_push(&apply_paths
, am_path(state
, "patch"));
1523 res
= apply_all_patches(&apply_state
, apply_paths
.nr
, apply_paths
.v
, options
);
1525 strvec_clear(&apply_paths
);
1526 strvec_clear(&apply_opts
);
1527 clear_apply_state(&apply_state
);
1534 /* Reload index as apply_all_patches() will have modified it. */
1535 discard_index(&the_index
);
1536 read_index_from(&the_index
, index_file
, get_git_dir());
1543 * Builds an index that contains just the blobs needed for a 3way merge.
1545 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1547 struct child_process cp
= CHILD_PROCESS_INIT
;
1550 strvec_push(&cp
.args
, "apply");
1551 strvec_pushv(&cp
.args
, state
->git_apply_opts
.v
);
1552 strvec_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1553 strvec_push(&cp
.args
, am_path(state
, "patch"));
1555 if (run_command(&cp
))
1562 * Attempt a threeway merge, using index_path as the temporary index.
1564 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1566 struct object_id orig_tree
, their_tree
, our_tree
;
1567 const struct object_id
*bases
[1] = { &orig_tree
};
1568 struct merge_options o
;
1569 struct commit
*result
;
1570 char *their_tree_name
;
1572 if (repo_get_oid(the_repository
, "HEAD", &our_tree
) < 0)
1573 oidcpy(&our_tree
, the_hash_algo
->empty_tree
);
1575 if (build_fake_ancestor(state
, index_path
))
1576 return error("could not build fake ancestor");
1578 discard_index(&the_index
);
1579 read_index_from(&the_index
, index_path
, get_git_dir());
1581 if (write_index_as_tree(&orig_tree
, &the_index
, index_path
, 0, NULL
))
1582 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1584 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1586 if (!state
->quiet
) {
1588 * List paths that needed 3-way fallback, so that the user can
1589 * review them with extra care to spot mismerges.
1591 struct rev_info rev_info
;
1593 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1594 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1595 rev_info
.diffopt
.filter
|= diff_filter_bit('A');
1596 rev_info
.diffopt
.filter
|= diff_filter_bit('M');
1597 add_pending_oid(&rev_info
, "HEAD", &our_tree
, 0);
1598 diff_setup_done(&rev_info
.diffopt
);
1599 run_diff_index(&rev_info
, DIFF_INDEX_CACHED
);
1600 release_revisions(&rev_info
);
1603 if (run_apply(state
, index_path
))
1604 return error(_("Did you hand edit your patch?\n"
1605 "It does not apply to blobs recorded in its index."));
1607 if (write_index_as_tree(&their_tree
, &the_index
, index_path
, 0, NULL
))
1608 return error("could not write tree");
1610 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1612 discard_index(&the_index
);
1613 repo_read_index(the_repository
);
1616 * This is not so wrong. Depending on which base we picked, orig_tree
1617 * may be wildly different from ours, but their_tree has the same set of
1618 * wildly different changes in parts the patch did not touch, so
1619 * recursive ends up canceling them, saying that we reverted all those
1623 init_merge_options(&o
, the_repository
);
1626 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1627 o
.branch2
= their_tree_name
;
1628 o
.detect_directory_renames
= MERGE_DIRECTORY_RENAMES_NONE
;
1633 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1634 repo_rerere(the_repository
, state
->allow_rerere_autoupdate
);
1635 free(their_tree_name
);
1636 return error(_("Failed to merge in the changes."));
1639 free(their_tree_name
);
1644 * Commits the current index with state->msg as the commit message and
1645 * state->author_name, state->author_email and state->author_date as the author
1648 static void do_commit(const struct am_state
*state
)
1650 struct object_id tree
, parent
, commit
;
1651 const struct object_id
*old_oid
;
1652 struct commit_list
*parents
= NULL
;
1653 const char *reflog_msg
, *author
, *committer
= NULL
;
1654 struct strbuf sb
= STRBUF_INIT
;
1656 if (!state
->no_verify
&& run_hooks("pre-applypatch"))
1659 if (write_index_as_tree(&tree
, &the_index
, get_index_file(), 0, NULL
))
1660 die(_("git write-tree failed to write a tree"));
1662 if (!repo_get_oid_commit(the_repository
, "HEAD", &parent
)) {
1664 commit_list_insert(lookup_commit(the_repository
, &parent
),
1668 say(state
, stderr
, _("applying to an empty history"));
1671 author
= fmt_ident(state
->author_name
, state
->author_email
,
1673 state
->ignore_date
? NULL
: state
->author_date
,
1676 if (state
->committer_date_is_author_date
)
1677 committer
= fmt_ident(getenv("GIT_COMMITTER_NAME"),
1678 getenv("GIT_COMMITTER_EMAIL"),
1679 WANT_COMMITTER_IDENT
,
1680 state
->ignore_date
? NULL
1681 : state
->author_date
,
1684 if (commit_tree_extended(state
->msg
, state
->msg_len
, &tree
, parents
,
1685 &commit
, author
, committer
, state
->sign_commit
,
1687 die(_("failed to write commit object"));
1689 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1693 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1696 update_ref(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1697 UPDATE_REFS_DIE_ON_ERR
);
1699 if (state
->rebasing
) {
1700 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1702 assert(!is_null_oid(&state
->orig_commit
));
1703 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1704 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1708 run_hooks("post-applypatch");
1710 strbuf_release(&sb
);
1714 * Validates the am_state for resuming -- the "msg" and authorship fields must
1717 static void validate_resume_state(const struct am_state
*state
)
1720 die(_("cannot resume: %s does not exist."),
1721 am_path(state
, "final-commit"));
1723 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1724 die(_("cannot resume: %s does not exist."),
1725 am_path(state
, "author-script"));
1729 * Interactively prompt the user on whether the current patch should be
1732 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1735 static int do_interactive(struct am_state
*state
)
1742 puts(_("Commit Body is:"));
1743 puts("--------------------------");
1744 printf("%s", state
->msg
);
1745 puts("--------------------------");
1748 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1749 * in your translation. The program will only accept English
1750 * input at this point.
1752 printf(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "));
1753 if (!fgets(reply
, sizeof(reply
), stdin
))
1754 die("unable to read from stdin; aborting");
1756 if (*reply
== 'y' || *reply
== 'Y') {
1758 } else if (*reply
== 'a' || *reply
== 'A') {
1759 state
->interactive
= 0;
1761 } else if (*reply
== 'n' || *reply
== 'N') {
1763 } else if (*reply
== 'e' || *reply
== 'E') {
1764 struct strbuf msg
= STRBUF_INIT
;
1766 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1768 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1770 strbuf_release(&msg
);
1771 } else if (*reply
== 'v' || *reply
== 'V') {
1772 const char *pager
= git_pager(1);
1773 struct child_process cp
= CHILD_PROCESS_INIT
;
1777 prepare_pager_args(&cp
, pager
);
1778 strvec_push(&cp
.args
, am_path(state
, "patch"));
1785 * Applies all queued mail.
1787 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1788 * well as the state directory's "patch" file is used as-is for applying the
1789 * patch and committing it.
1791 static void am_run(struct am_state
*state
, int resume
)
1793 struct strbuf sb
= STRBUF_INIT
;
1795 unlink(am_path(state
, "dirtyindex"));
1797 if (repo_refresh_and_write_index(the_repository
, REFRESH_QUIET
, 0, 0,
1798 NULL
, NULL
, NULL
) < 0)
1799 die(_("unable to write index file"));
1801 if (repo_index_has_changes(the_repository
, NULL
, &sb
)) {
1802 write_state_bool(state
, "dirtyindex", 1);
1803 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1806 strbuf_release(&sb
);
1808 while (state
->cur
<= state
->last
) {
1809 const char *mail
= am_path(state
, msgnum(state
));
1815 if (!file_exists(mail
))
1819 validate_resume_state(state
);
1823 if (state
->rebasing
)
1824 skip
= parse_mail_rebase(state
, mail
);
1826 skip
= parse_mail(state
, mail
);
1829 goto next
; /* mail should be skipped */
1832 am_append_signoff(state
);
1834 write_author_script(state
);
1835 write_commit_msg(state
);
1838 if (state
->interactive
&& do_interactive(state
))
1842 if (is_empty_or_missing_file(am_path(state
, "patch"))) {
1843 switch (state
->empty_type
) {
1844 case DROP_EMPTY_COMMIT
:
1845 say(state
, stdout
, _("Skipping: %.*s"), linelen(state
->msg
), state
->msg
);
1848 case KEEP_EMPTY_COMMIT
:
1850 say(state
, stdout
, _("Creating an empty commit: %.*s"),
1851 linelen(state
->msg
), state
->msg
);
1853 case STOP_ON_EMPTY_COMMIT
:
1854 printf_ln(_("Patch is empty."));
1855 die_user_resolve(state
);
1860 if (run_applypatch_msg_hook(state
))
1865 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1867 apply_status
= run_apply(state
, NULL
);
1869 if (apply_status
&& state
->threeway
) {
1870 struct strbuf sb
= STRBUF_INIT
;
1872 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1873 apply_status
= fall_back_threeway(state
, sb
.buf
);
1874 strbuf_release(&sb
);
1877 * Applying the patch to an earlier tree and merging
1878 * the result may have produced the same tree as ours.
1880 if (!apply_status
&&
1881 !repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1882 say(state
, stdout
, _("No changes -- Patch already applied."));
1888 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1889 linelen(state
->msg
), state
->msg
);
1891 if (advice_enabled(ADVICE_AM_WORK_DIR
))
1892 advise(_("Use 'git am --show-current-patch=diff' to see the failed patch"));
1894 die_user_resolve(state
);
1908 if (!is_empty_or_missing_file(am_path(state
, "rewritten"))) {
1909 assert(state
->rebasing
);
1910 copy_notes_for_rebase(state
);
1911 run_post_rewrite_hook(state
);
1915 * In rebasing mode, it's up to the caller to take care of
1918 if (!state
->rebasing
) {
1920 run_auto_maintenance(state
->quiet
);
1925 * Resume the current am session after patch application failure. The user did
1926 * all the hard work, and we do not have to do any patch application. Just
1927 * trust and commit what the user has in the index and working tree. If `allow_empty`
1928 * is true, commit as an empty commit when index has not changed and lacking a patch.
1930 static void am_resolve(struct am_state
*state
, int allow_empty
)
1932 validate_resume_state(state
);
1934 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1936 if (!repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1937 if (allow_empty
&& is_empty_or_missing_file(am_path(state
, "patch"))) {
1938 printf_ln(_("No changes - recorded it as an empty commit."));
1940 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1941 "If there is nothing left to stage, chances are that something else\n"
1942 "already introduced the same changes; you might want to skip this patch."));
1943 die_user_resolve(state
);
1947 if (unmerged_index(&the_index
)) {
1948 printf_ln(_("You still have unmerged paths in your index.\n"
1949 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1950 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1951 die_user_resolve(state
);
1954 if (state
->interactive
) {
1955 write_index_patch(state
);
1956 if (do_interactive(state
))
1960 repo_rerere(the_repository
, 0);
1971 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1972 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1975 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1977 struct lock_file lock_file
= LOCK_INIT
;
1978 struct unpack_trees_options opts
;
1979 struct tree_desc t
[2];
1981 if (parse_tree(head
) || parse_tree(remote
))
1984 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
1986 refresh_index(&the_index
, REFRESH_QUIET
, NULL
, NULL
, NULL
);
1988 memset(&opts
, 0, sizeof(opts
));
1990 opts
.src_index
= &the_index
;
1991 opts
.dst_index
= &the_index
;
1994 opts
.reset
= reset
? UNPACK_RESET_PROTECT_UNTRACKED
: 0;
1995 opts
.preserve_ignored
= 0; /* FIXME: !overwrite_ignore */
1996 opts
.fn
= twoway_merge
;
1997 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1998 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
2000 if (unpack_trees(2, t
, &opts
)) {
2001 rollback_lock_file(&lock_file
);
2005 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
2006 die(_("unable to write new index file"));
2012 * Merges a tree into the index. The index's stat info will take precedence
2013 * over the merged tree's. Returns 0 on success, -1 on failure.
2015 static int merge_tree(struct tree
*tree
)
2017 struct lock_file lock_file
= LOCK_INIT
;
2018 struct unpack_trees_options opts
;
2019 struct tree_desc t
[1];
2021 if (parse_tree(tree
))
2024 repo_hold_locked_index(the_repository
, &lock_file
, LOCK_DIE_ON_ERROR
);
2026 memset(&opts
, 0, sizeof(opts
));
2028 opts
.src_index
= &the_index
;
2029 opts
.dst_index
= &the_index
;
2031 opts
.fn
= oneway_merge
;
2032 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
2034 if (unpack_trees(1, t
, &opts
)) {
2035 rollback_lock_file(&lock_file
);
2039 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
2040 die(_("unable to write new index file"));
2046 * Clean the index without touching entries that are not modified between
2047 * `head` and `remote`.
2049 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
2051 struct tree
*head_tree
, *remote_tree
, *index_tree
;
2052 struct object_id index
;
2054 head_tree
= parse_tree_indirect(head
);
2056 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
2058 remote_tree
= parse_tree_indirect(remote
);
2060 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
2062 repo_read_index_unmerged(the_repository
);
2064 if (fast_forward_to(head_tree
, head_tree
, 1))
2067 if (write_index_as_tree(&index
, &the_index
, get_index_file(), 0, NULL
))
2070 index_tree
= parse_tree_indirect(&index
);
2072 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
2074 if (fast_forward_to(index_tree
, remote_tree
, 0))
2077 if (merge_tree(remote_tree
))
2080 remove_branch_state(the_repository
, 0);
2086 * Resets rerere's merge resolution metadata.
2088 static void am_rerere_clear(void)
2090 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
2091 rerere_clear(the_repository
, &merge_rr
);
2092 string_list_clear(&merge_rr
, 1);
2096 * Resume the current am session by skipping the current patch.
2098 static void am_skip(struct am_state
*state
)
2100 struct object_id head
;
2104 if (repo_get_oid(the_repository
, "HEAD", &head
))
2105 oidcpy(&head
, the_hash_algo
->empty_tree
);
2107 if (clean_index(&head
, &head
))
2108 die(_("failed to clean index"));
2110 if (state
->rebasing
) {
2111 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
2113 assert(!is_null_oid(&state
->orig_commit
));
2114 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
2115 fprintf(fp
, "%s\n", oid_to_hex(&head
));
2125 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
2127 * It is not safe to reset HEAD when:
2128 * 1. git-am previously failed because the index was dirty.
2129 * 2. HEAD has moved since git-am previously failed.
2131 static int safe_to_abort(const struct am_state
*state
)
2133 struct strbuf sb
= STRBUF_INIT
;
2134 struct object_id abort_safety
, head
;
2136 if (file_exists(am_path(state
, "dirtyindex")))
2139 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2140 if (get_oid_hex(sb
.buf
, &abort_safety
))
2141 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2143 oidclr(&abort_safety
);
2144 strbuf_release(&sb
);
2146 if (repo_get_oid(the_repository
, "HEAD", &head
))
2149 if (oideq(&head
, &abort_safety
))
2152 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2153 "Not rewinding to ORIG_HEAD"));
2159 * Aborts the current am session if it is safe to do so.
2161 static void am_abort(struct am_state
*state
)
2163 struct object_id curr_head
, orig_head
;
2164 int has_curr_head
, has_orig_head
;
2167 if (!safe_to_abort(state
)) {
2174 curr_branch
= resolve_refdup("HEAD", 0, &curr_head
, NULL
);
2175 has_curr_head
= curr_branch
&& !is_null_oid(&curr_head
);
2177 oidcpy(&curr_head
, the_hash_algo
->empty_tree
);
2179 has_orig_head
= !repo_get_oid(the_repository
, "ORIG_HEAD", &orig_head
);
2181 oidcpy(&orig_head
, the_hash_algo
->empty_tree
);
2183 if (clean_index(&curr_head
, &orig_head
))
2184 die(_("failed to clean index"));
2187 update_ref("am --abort", "HEAD", &orig_head
,
2188 has_curr_head
? &curr_head
: NULL
, 0,
2189 UPDATE_REFS_DIE_ON_ERR
);
2190 else if (curr_branch
)
2191 delete_ref(NULL
, curr_branch
, NULL
, REF_NO_DEREF
);
2197 static int show_patch(struct am_state
*state
, enum resume_type resume_mode
)
2199 struct strbuf sb
= STRBUF_INIT
;
2200 const char *patch_path
;
2203 if (!is_null_oid(&state
->orig_commit
)) {
2204 struct child_process cmd
= CHILD_PROCESS_INIT
;
2206 strvec_pushl(&cmd
.args
, "show", oid_to_hex(&state
->orig_commit
),
2209 return run_command(&cmd
);
2212 switch (resume_mode
) {
2213 case RESUME_SHOW_PATCH_RAW
:
2214 patch_path
= am_path(state
, msgnum(state
));
2216 case RESUME_SHOW_PATCH_DIFF
:
2217 patch_path
= am_path(state
, "patch");
2220 BUG("invalid mode for --show-current-patch");
2223 len
= strbuf_read_file(&sb
, patch_path
, 0);
2225 die_errno(_("failed to read '%s'"), patch_path
);
2228 write_in_full(1, sb
.buf
, sb
.len
);
2229 strbuf_release(&sb
);
2234 * parse_options() callback that validates and sets opt->value to the
2235 * PATCH_FORMAT_* enum value corresponding to `arg`.
2237 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2239 int *opt_value
= opt
->value
;
2242 *opt_value
= PATCH_FORMAT_UNKNOWN
;
2243 else if (!strcmp(arg
, "mbox"))
2244 *opt_value
= PATCH_FORMAT_MBOX
;
2245 else if (!strcmp(arg
, "stgit"))
2246 *opt_value
= PATCH_FORMAT_STGIT
;
2247 else if (!strcmp(arg
, "stgit-series"))
2248 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2249 else if (!strcmp(arg
, "hg"))
2250 *opt_value
= PATCH_FORMAT_HG
;
2251 else if (!strcmp(arg
, "mboxrd"))
2252 *opt_value
= PATCH_FORMAT_MBOXRD
;
2254 * Please update $__git_patchformat in git-completion.bash
2255 * when you add new options
2258 return error(_("invalid value for '%s': '%s'"),
2259 "--patch-format", arg
);
2263 static int parse_opt_show_current_patch(const struct option
*opt
, const char *arg
, int unset
)
2265 int *opt_value
= opt
->value
;
2267 BUG_ON_OPT_NEG(unset
);
2270 *opt_value
= opt
->defval
;
2271 else if (!strcmp(arg
, "raw"))
2272 *opt_value
= RESUME_SHOW_PATCH_RAW
;
2273 else if (!strcmp(arg
, "diff"))
2274 *opt_value
= RESUME_SHOW_PATCH_DIFF
;
2276 * Please update $__git_showcurrentpatch in git-completion.bash
2277 * when you add new options
2280 return error(_("invalid value for '%s': '%s'"),
2281 "--show-current-patch", arg
);
2285 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2287 struct am_state state
;
2290 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2291 enum resume_type resume_mode
= RESUME_FALSE
;
2295 const char * const usage
[] = {
2296 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2297 N_("git am [<options>] (--continue | --skip | --abort)"),
2301 struct option options
[] = {
2302 OPT_BOOL('i', "interactive", &state
.interactive
,
2303 N_("run interactively")),
2304 OPT_BOOL('n', "no-verify", &state
.no_verify
,
2305 N_("bypass pre-applypatch and applypatch-msg hooks")),
2306 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2307 N_("historical option -- no-op")),
2308 OPT_BOOL('3', "3way", &state
.threeway
,
2309 N_("allow fall back on 3way merging if needed")),
2310 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2311 OPT_SET_INT('s', "signoff", &state
.signoff
,
2312 N_("add a Signed-off-by trailer to the commit message"),
2314 OPT_BOOL('u', "utf8", &state
.utf8
,
2315 N_("recode into utf8 (default)")),
2316 OPT_SET_INT('k', "keep", &state
.keep
,
2317 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2318 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2319 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2320 OPT_BOOL('m', "message-id", &state
.message_id
,
2321 N_("pass -m flag to git-mailinfo")),
2322 OPT_SET_INT(0, "keep-cr", &keep_cr
,
2323 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2325 OPT_BOOL('c', "scissors", &state
.scissors
,
2326 N_("strip everything before a scissors line")),
2327 OPT_CALLBACK_F(0, "quoted-cr", &state
.quoted_cr
, N_("action"),
2328 N_("pass it through git-mailinfo"),
2329 PARSE_OPT_NONEG
, am_option_parse_quoted_cr
),
2330 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2331 N_("pass it through git-apply"),
2333 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2334 N_("pass it through git-apply"),
2336 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2337 N_("pass it through git-apply"),
2339 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2340 N_("pass it through git-apply"),
2342 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2343 N_("pass it through git-apply"),
2345 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2346 N_("pass it through git-apply"),
2348 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2349 N_("pass it through git-apply"),
2351 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2352 N_("pass it through git-apply"),
2354 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2355 N_("format the patch(es) are in"),
2356 parse_opt_patchformat
),
2357 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2358 N_("pass it through git-apply"),
2360 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2361 N_("override error message when patch failure occurs")),
2362 OPT_CMDMODE(0, "continue", &resume_mode
,
2363 N_("continue applying patches after resolving a conflict"),
2365 OPT_CMDMODE('r', "resolved", &resume_mode
,
2366 N_("synonyms for --continue"),
2368 OPT_CMDMODE(0, "skip", &resume_mode
,
2369 N_("skip the current patch"),
2371 OPT_CMDMODE(0, "abort", &resume_mode
,
2372 N_("restore the original branch and abort the patching operation"),
2374 OPT_CMDMODE(0, "quit", &resume_mode
,
2375 N_("abort the patching operation but keep HEAD where it is"),
2377 { OPTION_CALLBACK
, 0, "show-current-patch", &resume_mode
,
2379 N_("show the patch being applied"),
2380 PARSE_OPT_CMDMODE
| PARSE_OPT_OPTARG
| PARSE_OPT_NONEG
| PARSE_OPT_LITERAL_ARGHELP
,
2381 parse_opt_show_current_patch
, RESUME_SHOW_PATCH_RAW
},
2382 OPT_CMDMODE(0, "allow-empty", &resume_mode
,
2383 N_("record the empty patch as an empty commit"),
2384 RESUME_ALLOW_EMPTY
),
2385 OPT_BOOL(0, "committer-date-is-author-date",
2386 &state
.committer_date_is_author_date
,
2387 N_("lie about committer date")),
2388 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2389 N_("use current timestamp for author date")),
2390 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2391 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2392 N_("GPG-sign commits"),
2393 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2394 OPT_CALLBACK_F(0, "empty", &state
.empty_type
, "(stop|drop|keep)",
2395 N_("how to handle empty patches"),
2396 PARSE_OPT_NONEG
, am_option_parse_empty
),
2397 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2398 N_("(internal use for git-rebase)")),
2402 if (argc
== 2 && !strcmp(argv
[1], "-h"))
2403 usage_with_options(usage
, options
);
2405 git_config(git_default_config
, NULL
);
2407 am_state_init(&state
);
2409 in_progress
= am_in_progress(&state
);
2413 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2416 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2417 "it will be removed. Please do not use it anymore."));
2419 /* Ensure a valid committer ident can be constructed */
2420 git_committer_info(IDENT_STRICT
);
2422 if (repo_read_index_preload(the_repository
, NULL
, 0) < 0)
2423 die(_("failed to read the index"));
2427 * Catch user error to feed us patches when there is a session
2430 * 1. mbox path(s) are provided on the command-line.
2431 * 2. stdin is not a tty: the user is trying to feed us a patch
2432 * from standard input. This is somewhat unreliable -- stdin
2433 * could be /dev/null for example and the caller did not
2434 * intend to feed us a patch but wanted to continue
2437 if (argc
|| (resume_mode
== RESUME_FALSE
&& !isatty(0)))
2438 die(_("previous rebase directory %s still exists but mbox given."),
2441 if (resume_mode
== RESUME_FALSE
)
2442 resume_mode
= RESUME_APPLY
;
2444 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2445 am_append_signoff(&state
);
2447 struct strvec paths
= STRVEC_INIT
;
2451 * Handle stray state directory in the independent-run case. In
2452 * the --rebasing case, it is up to the caller to take care of
2453 * stray directories.
2455 if (file_exists(state
.dir
) && !state
.rebasing
) {
2456 if (resume_mode
== RESUME_ABORT
|| resume_mode
== RESUME_QUIT
) {
2458 am_state_release(&state
);
2462 die(_("Stray %s directory found.\n"
2463 "Use \"git am --abort\" to remove it."),
2468 die(_("Resolve operation not in progress, we are not resuming."));
2470 for (i
= 0; i
< argc
; i
++) {
2471 if (is_absolute_path(argv
[i
]) || !prefix
)
2472 strvec_push(&paths
, argv
[i
]);
2474 strvec_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2477 if (state
.interactive
&& !paths
.nr
)
2478 die(_("interactive mode requires patches on the command line"));
2480 am_setup(&state
, patch_format
, paths
.v
, keep_cr
);
2482 strvec_clear(&paths
);
2485 switch (resume_mode
) {
2492 case RESUME_RESOLVED
:
2493 case RESUME_ALLOW_EMPTY
:
2494 am_resolve(&state
, resume_mode
== RESUME_ALLOW_EMPTY
? 1 : 0);
2506 case RESUME_SHOW_PATCH_RAW
:
2507 case RESUME_SHOW_PATCH_DIFF
:
2508 ret
= show_patch(&state
, resume_mode
);
2511 BUG("invalid resume value");
2514 am_state_release(&state
);