4 * Based on git-am.sh by Junio C Hamano.
6 #define USE_THE_INDEX_COMPATIBILITY_MACROS
11 #include "parse-options.h"
13 #include "run-command.h"
17 #include "cache-tree.h"
22 #include "unpack-trees.h"
24 #include "sequencer.h"
26 #include "merge-recursive.h"
29 #include "notes-utils.h"
34 #include "string-list.h"
36 #include "repository.h"
39 * Returns the length of the first line of msg.
41 static int linelen(const char *msg
)
43 return strchrnul(msg
, '\n') - msg
;
47 * Returns true if `str` consists of only whitespace, false otherwise.
49 static int str_isspace(const char *str
)
59 PATCH_FORMAT_UNKNOWN
= 0,
62 PATCH_FORMAT_STGIT_SERIES
,
69 KEEP_TRUE
, /* pass -k flag to git-mailinfo */
70 KEEP_NON_PATCH
/* pass -b flag to git-mailinfo */
75 SCISSORS_FALSE
= 0, /* pass --no-scissors to git-mailinfo */
76 SCISSORS_TRUE
/* pass --scissors to git-mailinfo */
82 SIGNOFF_EXPLICIT
/* --signoff was set on the command-line */
86 /* state directory path */
89 /* current and last patch numbers, 1-indexed */
93 /* commit metadata and message */
100 /* when --rebasing, records the original commit the patch came from */
101 struct object_id orig_commit
;
103 /* number of digits in patch filename */
106 /* various operating modes and command line options */
110 int signoff
; /* enum signoff_type */
112 int keep
; /* enum keep_type */
114 int scissors
; /* enum scissors_type */
115 struct argv_array git_apply_opts
;
116 const char *resolvemsg
;
117 int committer_date_is_author_date
;
119 int allow_rerere_autoupdate
;
120 const char *sign_commit
;
125 * Initializes am_state with the default values.
127 static void am_state_init(struct am_state
*state
)
131 memset(state
, 0, sizeof(*state
));
133 state
->dir
= git_pathdup("rebase-apply");
137 git_config_get_bool("am.threeway", &state
->threeway
);
141 git_config_get_bool("am.messageid", &state
->message_id
);
143 state
->scissors
= SCISSORS_UNSET
;
145 argv_array_init(&state
->git_apply_opts
);
147 if (!git_config_get_bool("commit.gpgsign", &gpgsign
))
148 state
->sign_commit
= gpgsign
? "" : NULL
;
152 * Releases memory allocated by an am_state.
154 static void am_state_release(struct am_state
*state
)
157 free(state
->author_name
);
158 free(state
->author_email
);
159 free(state
->author_date
);
161 argv_array_clear(&state
->git_apply_opts
);
165 * Returns path relative to the am_state directory.
167 static inline const char *am_path(const struct am_state
*state
, const char *path
)
169 return mkpath("%s/%s", state
->dir
, path
);
173 * For convenience to call write_file()
175 static void write_state_text(const struct am_state
*state
,
176 const char *name
, const char *string
)
178 write_file(am_path(state
, name
), "%s", string
);
181 static void write_state_count(const struct am_state
*state
,
182 const char *name
, int value
)
184 write_file(am_path(state
, name
), "%d", value
);
187 static void write_state_bool(const struct am_state
*state
,
188 const char *name
, int value
)
190 write_state_text(state
, name
, value
? "t" : "f");
194 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
197 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
203 vfprintf(fp
, fmt
, ap
);
210 * Returns 1 if there is an am session in progress, 0 otherwise.
212 static int am_in_progress(const struct am_state
*state
)
216 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
218 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
220 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
226 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
227 * number of bytes read on success, -1 if the file does not exist. If `trim` is
228 * set, trailing whitespace will be removed.
230 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
231 const char *file
, int trim
)
235 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
245 die_errno(_("could not read '%s'"), am_path(state
, file
));
249 * Reads and parses the state directory's "author-script" file, and sets
250 * state->author_name, state->author_email and state->author_date accordingly.
251 * Returns 0 on success, -1 if the file could not be parsed.
253 * The author script is of the format:
255 * GIT_AUTHOR_NAME='$author_name'
256 * GIT_AUTHOR_EMAIL='$author_email'
257 * GIT_AUTHOR_DATE='$author_date'
259 * where $author_name, $author_email and $author_date are quoted. We are strict
260 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
261 * script, and thus if the file differs from what this function expects, it is
262 * better to bail out than to do something that the user does not expect.
264 static int read_am_author_script(struct am_state
*state
)
266 const char *filename
= am_path(state
, "author-script");
268 assert(!state
->author_name
);
269 assert(!state
->author_email
);
270 assert(!state
->author_date
);
272 return read_author_script(filename
, &state
->author_name
,
273 &state
->author_email
, &state
->author_date
, 1);
277 * Saves state->author_name, state->author_email and state->author_date in the
278 * state directory's "author-script" file.
280 static void write_author_script(const struct am_state
*state
)
282 struct strbuf sb
= STRBUF_INIT
;
284 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
285 sq_quote_buf(&sb
, state
->author_name
);
286 strbuf_addch(&sb
, '\n');
288 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
289 sq_quote_buf(&sb
, state
->author_email
);
290 strbuf_addch(&sb
, '\n');
292 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
293 sq_quote_buf(&sb
, state
->author_date
);
294 strbuf_addch(&sb
, '\n');
296 write_state_text(state
, "author-script", sb
.buf
);
302 * Reads the commit message from the state directory's "final-commit" file,
303 * setting state->msg to its contents and state->msg_len to the length of its
306 * Returns 0 on success, -1 if the file does not exist.
308 static int read_commit_msg(struct am_state
*state
)
310 struct strbuf sb
= STRBUF_INIT
;
314 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
319 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
324 * Saves state->msg in the state directory's "final-commit" file.
326 static void write_commit_msg(const struct am_state
*state
)
328 const char *filename
= am_path(state
, "final-commit");
329 write_file_buf(filename
, state
->msg
, state
->msg_len
);
333 * Loads state from disk.
335 static void am_load(struct am_state
*state
)
337 struct strbuf sb
= STRBUF_INIT
;
339 if (read_state_file(&sb
, state
, "next", 1) < 0)
340 BUG("state file 'next' does not exist");
341 state
->cur
= strtol(sb
.buf
, NULL
, 10);
343 if (read_state_file(&sb
, state
, "last", 1) < 0)
344 BUG("state file 'last' does not exist");
345 state
->last
= strtol(sb
.buf
, NULL
, 10);
347 if (read_am_author_script(state
) < 0)
348 die(_("could not parse author script"));
350 read_commit_msg(state
);
352 if (read_state_file(&sb
, state
, "original-commit", 1) < 0)
353 oidclr(&state
->orig_commit
);
354 else if (get_oid_hex(sb
.buf
, &state
->orig_commit
) < 0)
355 die(_("could not parse %s"), am_path(state
, "original-commit"));
357 read_state_file(&sb
, state
, "threeway", 1);
358 state
->threeway
= !strcmp(sb
.buf
, "t");
360 read_state_file(&sb
, state
, "quiet", 1);
361 state
->quiet
= !strcmp(sb
.buf
, "t");
363 read_state_file(&sb
, state
, "sign", 1);
364 state
->signoff
= !strcmp(sb
.buf
, "t");
366 read_state_file(&sb
, state
, "utf8", 1);
367 state
->utf8
= !strcmp(sb
.buf
, "t");
369 if (file_exists(am_path(state
, "rerere-autoupdate"))) {
370 read_state_file(&sb
, state
, "rerere-autoupdate", 1);
371 state
->allow_rerere_autoupdate
= strcmp(sb
.buf
, "t") ?
372 RERERE_NOAUTOUPDATE
: RERERE_AUTOUPDATE
;
374 state
->allow_rerere_autoupdate
= 0;
377 read_state_file(&sb
, state
, "keep", 1);
378 if (!strcmp(sb
.buf
, "t"))
379 state
->keep
= KEEP_TRUE
;
380 else if (!strcmp(sb
.buf
, "b"))
381 state
->keep
= KEEP_NON_PATCH
;
383 state
->keep
= KEEP_FALSE
;
385 read_state_file(&sb
, state
, "messageid", 1);
386 state
->message_id
= !strcmp(sb
.buf
, "t");
388 read_state_file(&sb
, state
, "scissors", 1);
389 if (!strcmp(sb
.buf
, "t"))
390 state
->scissors
= SCISSORS_TRUE
;
391 else if (!strcmp(sb
.buf
, "f"))
392 state
->scissors
= SCISSORS_FALSE
;
394 state
->scissors
= SCISSORS_UNSET
;
396 read_state_file(&sb
, state
, "apply-opt", 1);
397 argv_array_clear(&state
->git_apply_opts
);
398 if (sq_dequote_to_argv_array(sb
.buf
, &state
->git_apply_opts
) < 0)
399 die(_("could not parse %s"), am_path(state
, "apply-opt"));
401 state
->rebasing
= !!file_exists(am_path(state
, "rebasing"));
407 * Removes the am_state directory, forcefully terminating the current am
410 static void am_destroy(const struct am_state
*state
)
412 struct strbuf sb
= STRBUF_INIT
;
414 strbuf_addstr(&sb
, state
->dir
);
415 remove_dir_recursively(&sb
, 0);
420 * Runs applypatch-msg hook. Returns its exit code.
422 static int run_applypatch_msg_hook(struct am_state
*state
)
427 ret
= run_hook_le(NULL
, "applypatch-msg", am_path(state
, "final-commit"), NULL
);
430 FREE_AND_NULL(state
->msg
);
431 if (read_commit_msg(state
) < 0)
432 die(_("'%s' was deleted by the applypatch-msg hook"),
433 am_path(state
, "final-commit"));
440 * Runs post-rewrite hook. Returns it exit code.
442 static int run_post_rewrite_hook(const struct am_state
*state
)
444 struct child_process cp
= CHILD_PROCESS_INIT
;
445 const char *hook
= find_hook("post-rewrite");
451 argv_array_push(&cp
.args
, hook
);
452 argv_array_push(&cp
.args
, "rebase");
454 cp
.in
= xopen(am_path(state
, "rewritten"), O_RDONLY
);
455 cp
.stdout_to_stderr
= 1;
456 cp
.trace2_hook_name
= "post-rewrite";
458 ret
= run_command(&cp
);
465 * Reads the state directory's "rewritten" file, and copies notes from the old
466 * commits listed in the file to their rewritten commits.
468 * Returns 0 on success, -1 on failure.
470 static int copy_notes_for_rebase(const struct am_state
*state
)
472 struct notes_rewrite_cfg
*c
;
473 struct strbuf sb
= STRBUF_INIT
;
474 const char *invalid_line
= _("Malformed input line: '%s'.");
475 const char *msg
= "Notes added by 'git rebase'";
479 assert(state
->rebasing
);
481 c
= init_copy_notes_for_rewrite("rebase");
485 fp
= xfopen(am_path(state
, "rewritten"), "r");
487 while (!strbuf_getline_lf(&sb
, fp
)) {
488 struct object_id from_obj
, to_obj
;
491 if (sb
.len
!= the_hash_algo
->hexsz
* 2 + 1) {
492 ret
= error(invalid_line
, sb
.buf
);
496 if (parse_oid_hex(sb
.buf
, &from_obj
, &p
)) {
497 ret
= error(invalid_line
, sb
.buf
);
502 ret
= error(invalid_line
, sb
.buf
);
506 if (get_oid_hex(p
+ 1, &to_obj
)) {
507 ret
= error(invalid_line
, sb
.buf
);
511 if (copy_note_for_rewrite(c
, &from_obj
, &to_obj
))
512 ret
= error(_("Failed to copy notes from '%s' to '%s'"),
513 oid_to_hex(&from_obj
), oid_to_hex(&to_obj
));
517 finish_copy_notes_for_rewrite(the_repository
, c
, msg
);
524 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
525 * non-indented lines and checking if they look like they begin with valid
526 * header field names.
528 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
530 static int is_mail(FILE *fp
)
532 const char *header_regex
= "^[!-9;-~]+:";
533 struct strbuf sb
= STRBUF_INIT
;
537 if (fseek(fp
, 0L, SEEK_SET
))
538 die_errno(_("fseek failed"));
540 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
541 die("invalid pattern: %s", header_regex
);
543 while (!strbuf_getline(&sb
, fp
)) {
545 break; /* End of header */
547 /* Ignore indented folded lines */
548 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
551 /* It's a header if it matches header_regex */
552 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
565 * Attempts to detect the patch_format of the patches contained in `paths`,
566 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
569 static int detect_patch_format(const char **paths
)
571 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
572 struct strbuf l1
= STRBUF_INIT
;
573 struct strbuf l2
= STRBUF_INIT
;
574 struct strbuf l3
= STRBUF_INIT
;
578 * We default to mbox format if input is from stdin and for directories
580 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
581 return PATCH_FORMAT_MBOX
;
584 * Otherwise, check the first few lines of the first patch, starting
585 * from the first non-blank line, to try to detect its format.
588 fp
= xfopen(*paths
, "r");
590 while (!strbuf_getline(&l1
, fp
)) {
595 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
596 ret
= PATCH_FORMAT_MBOX
;
600 if (starts_with(l1
.buf
, "# This series applies on GIT commit")) {
601 ret
= PATCH_FORMAT_STGIT_SERIES
;
605 if (!strcmp(l1
.buf
, "# HG changeset patch")) {
606 ret
= PATCH_FORMAT_HG
;
610 strbuf_getline(&l2
, fp
);
611 strbuf_getline(&l3
, fp
);
614 * If the second line is empty and the third is a From, Author or Date
615 * entry, this is likely an StGit patch.
617 if (l1
.len
&& !l2
.len
&&
618 (starts_with(l3
.buf
, "From:") ||
619 starts_with(l3
.buf
, "Author:") ||
620 starts_with(l3
.buf
, "Date:"))) {
621 ret
= PATCH_FORMAT_STGIT
;
625 if (l1
.len
&& is_mail(fp
)) {
626 ret
= PATCH_FORMAT_MBOX
;
639 * Splits out individual email patches from `paths`, where each path is either
640 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
642 static int split_mail_mbox(struct am_state
*state
, const char **paths
,
643 int keep_cr
, int mboxrd
)
645 struct child_process cp
= CHILD_PROCESS_INIT
;
646 struct strbuf last
= STRBUF_INIT
;
650 argv_array_push(&cp
.args
, "mailsplit");
651 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
652 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
653 argv_array_push(&cp
.args
, "-b");
655 argv_array_push(&cp
.args
, "--keep-cr");
657 argv_array_push(&cp
.args
, "--mboxrd");
658 argv_array_push(&cp
.args
, "--");
659 argv_array_pushv(&cp
.args
, paths
);
661 ret
= capture_command(&cp
, &last
, 8);
666 state
->last
= strtol(last
.buf
, NULL
, 10);
669 strbuf_release(&last
);
674 * Callback signature for split_mail_conv(). The foreign patch should be
675 * read from `in`, and the converted patch (in RFC2822 mail format) should be
676 * written to `out`. Return 0 on success, or -1 on failure.
678 typedef int (*mail_conv_fn
)(FILE *out
, FILE *in
, int keep_cr
);
681 * Calls `fn` for each file in `paths` to convert the foreign patch to the
682 * RFC2822 mail format suitable for parsing with git-mailinfo.
684 * Returns 0 on success, -1 on failure.
686 static int split_mail_conv(mail_conv_fn fn
, struct am_state
*state
,
687 const char **paths
, int keep_cr
)
689 static const char *stdin_only
[] = {"-", NULL
};
695 for (i
= 0; *paths
; paths
++, i
++) {
700 if (!strcmp(*paths
, "-"))
703 in
= fopen(*paths
, "r");
706 return error_errno(_("could not open '%s' for reading"),
709 mail
= mkpath("%s/%0*d", state
->dir
, state
->prec
, i
+ 1);
711 out
= fopen(mail
, "w");
715 return error_errno(_("could not open '%s' for writing"),
719 ret
= fn(out
, in
, keep_cr
);
726 return error(_("could not parse patch '%s'"), *paths
);
735 * A split_mail_conv() callback that converts an StGit patch to an RFC2822
736 * message suitable for parsing with git-mailinfo.
738 static int stgit_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
740 struct strbuf sb
= STRBUF_INIT
;
741 int subject_printed
= 0;
743 while (!strbuf_getline_lf(&sb
, in
)) {
746 if (str_isspace(sb
.buf
))
748 else if (skip_prefix(sb
.buf
, "Author:", &str
))
749 fprintf(out
, "From:%s\n", str
);
750 else if (starts_with(sb
.buf
, "From") || starts_with(sb
.buf
, "Date"))
751 fprintf(out
, "%s\n", sb
.buf
);
752 else if (!subject_printed
) {
753 fprintf(out
, "Subject: %s\n", sb
.buf
);
756 fprintf(out
, "\n%s\n", sb
.buf
);
762 while (strbuf_fread(&sb
, 8192, in
) > 0) {
763 fwrite(sb
.buf
, 1, sb
.len
, out
);
772 * This function only supports a single StGit series file in `paths`.
774 * Given an StGit series file, converts the StGit patches in the series into
775 * RFC2822 messages suitable for parsing with git-mailinfo, and queues them in
776 * the state directory.
778 * Returns 0 on success, -1 on failure.
780 static int split_mail_stgit_series(struct am_state
*state
, const char **paths
,
783 const char *series_dir
;
784 char *series_dir_buf
;
786 struct argv_array patches
= ARGV_ARRAY_INIT
;
787 struct strbuf sb
= STRBUF_INIT
;
790 if (!paths
[0] || paths
[1])
791 return error(_("Only one StGIT patch series can be applied at once"));
793 series_dir_buf
= xstrdup(*paths
);
794 series_dir
= dirname(series_dir_buf
);
796 fp
= fopen(*paths
, "r");
798 return error_errno(_("could not open '%s' for reading"), *paths
);
800 while (!strbuf_getline_lf(&sb
, fp
)) {
802 continue; /* skip comment lines */
804 argv_array_push(&patches
, mkpath("%s/%s", series_dir
, sb
.buf
));
809 free(series_dir_buf
);
811 ret
= split_mail_conv(stgit_patch_to_mail
, state
, patches
.argv
, keep_cr
);
813 argv_array_clear(&patches
);
818 * A split_patches_conv() callback that converts a mercurial patch to a RFC2822
819 * message suitable for parsing with git-mailinfo.
821 static int hg_patch_to_mail(FILE *out
, FILE *in
, int keep_cr
)
823 struct strbuf sb
= STRBUF_INIT
;
826 while (!strbuf_getline_lf(&sb
, in
)) {
829 if (skip_prefix(sb
.buf
, "# User ", &str
))
830 fprintf(out
, "From: %s\n", str
);
831 else if (skip_prefix(sb
.buf
, "# Date ", &str
)) {
832 timestamp_t timestamp
;
837 timestamp
= parse_timestamp(str
, &end
, 10);
839 rc
= error(_("invalid timestamp"));
843 if (!skip_prefix(end
, " ", &str
)) {
844 rc
= error(_("invalid Date line"));
849 tz
= strtol(str
, &end
, 10);
851 rc
= error(_("invalid timezone offset"));
856 rc
= error(_("invalid Date line"));
861 * mercurial's timezone is in seconds west of UTC,
862 * however git's timezone is in hours + minutes east of
865 tz2
= labs(tz
) / 3600 * 100 + labs(tz
) % 3600 / 60;
869 fprintf(out
, "Date: %s\n", show_date(timestamp
, tz2
, DATE_MODE(RFC2822
)));
870 } else if (starts_with(sb
.buf
, "# ")) {
873 fprintf(out
, "\n%s\n", sb
.buf
);
879 while (strbuf_fread(&sb
, 8192, in
) > 0) {
880 fwrite(sb
.buf
, 1, sb
.len
, out
);
889 * Splits a list of files/directories into individual email patches. Each path
890 * in `paths` must be a file/directory that is formatted according to
893 * Once split out, the individual email patches will be stored in the state
894 * directory, with each patch's filename being its index, padded to state->prec
897 * state->cur will be set to the index of the first mail, and state->last will
898 * be set to the index of the last mail.
900 * Set keep_cr to 0 to convert all lines ending with \r\n to end with \n, 1
901 * to disable this behavior, -1 to use the default configured setting.
903 * Returns 0 on success, -1 on failure.
905 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
906 const char **paths
, int keep_cr
)
910 git_config_get_bool("am.keepcr", &keep_cr
);
913 switch (patch_format
) {
914 case PATCH_FORMAT_MBOX
:
915 return split_mail_mbox(state
, paths
, keep_cr
, 0);
916 case PATCH_FORMAT_STGIT
:
917 return split_mail_conv(stgit_patch_to_mail
, state
, paths
, keep_cr
);
918 case PATCH_FORMAT_STGIT_SERIES
:
919 return split_mail_stgit_series(state
, paths
, keep_cr
);
920 case PATCH_FORMAT_HG
:
921 return split_mail_conv(hg_patch_to_mail
, state
, paths
, keep_cr
);
922 case PATCH_FORMAT_MBOXRD
:
923 return split_mail_mbox(state
, paths
, keep_cr
, 1);
925 BUG("invalid patch_format");
931 * Setup a new am session for applying patches
933 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
934 const char **paths
, int keep_cr
)
936 struct object_id curr_head
;
938 struct strbuf sb
= STRBUF_INIT
;
941 patch_format
= detect_patch_format(paths
);
944 fprintf_ln(stderr
, _("Patch format detection failed."));
948 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
949 die_errno(_("failed to create directory '%s'"), state
->dir
);
950 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
952 if (split_mail(state
, patch_format
, paths
, keep_cr
) < 0) {
954 die(_("Failed to split patches."));
960 write_state_bool(state
, "threeway", state
->threeway
);
961 write_state_bool(state
, "quiet", state
->quiet
);
962 write_state_bool(state
, "sign", state
->signoff
);
963 write_state_bool(state
, "utf8", state
->utf8
);
965 if (state
->allow_rerere_autoupdate
)
966 write_state_bool(state
, "rerere-autoupdate",
967 state
->allow_rerere_autoupdate
== RERERE_AUTOUPDATE
);
969 switch (state
->keep
) {
980 BUG("invalid value for state->keep");
983 write_state_text(state
, "keep", str
);
984 write_state_bool(state
, "messageid", state
->message_id
);
986 switch (state
->scissors
) {
997 BUG("invalid value for state->scissors");
999 write_state_text(state
, "scissors", str
);
1001 sq_quote_argv(&sb
, state
->git_apply_opts
.argv
);
1002 write_state_text(state
, "apply-opt", sb
.buf
);
1004 if (state
->rebasing
)
1005 write_state_text(state
, "rebasing", "");
1007 write_state_text(state
, "applying", "");
1009 if (!get_oid("HEAD", &curr_head
)) {
1010 write_state_text(state
, "abort-safety", oid_to_hex(&curr_head
));
1011 if (!state
->rebasing
)
1012 update_ref("am", "ORIG_HEAD", &curr_head
, NULL
, 0,
1013 UPDATE_REFS_DIE_ON_ERR
);
1015 write_state_text(state
, "abort-safety", "");
1016 if (!state
->rebasing
)
1017 delete_ref(NULL
, "ORIG_HEAD", NULL
, 0);
1021 * NOTE: Since the "next" and "last" files determine if an am_state
1022 * session is in progress, they should be written last.
1025 write_state_count(state
, "next", state
->cur
);
1026 write_state_count(state
, "last", state
->last
);
1028 strbuf_release(&sb
);
1032 * Increments the patch pointer, and cleans am_state for the application of the
1035 static void am_next(struct am_state
*state
)
1037 struct object_id head
;
1039 FREE_AND_NULL(state
->author_name
);
1040 FREE_AND_NULL(state
->author_email
);
1041 FREE_AND_NULL(state
->author_date
);
1042 FREE_AND_NULL(state
->msg
);
1045 unlink(am_path(state
, "author-script"));
1046 unlink(am_path(state
, "final-commit"));
1048 oidclr(&state
->orig_commit
);
1049 unlink(am_path(state
, "original-commit"));
1050 delete_ref(NULL
, "REBASE_HEAD", NULL
, REF_NO_DEREF
);
1052 if (!get_oid("HEAD", &head
))
1053 write_state_text(state
, "abort-safety", oid_to_hex(&head
));
1055 write_state_text(state
, "abort-safety", "");
1058 write_state_count(state
, "next", state
->cur
);
1062 * Returns the filename of the current patch email.
1064 static const char *msgnum(const struct am_state
*state
)
1066 static struct strbuf sb
= STRBUF_INIT
;
1069 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
1075 * Dies with a user-friendly message on how to proceed after resolving the
1076 * problem. This message can be overridden with state->resolvemsg.
1078 static void NORETURN
die_user_resolve(const struct am_state
*state
)
1080 if (state
->resolvemsg
) {
1081 printf_ln("%s", state
->resolvemsg
);
1083 const char *cmdline
= state
->interactive
? "git am -i" : "git am";
1085 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
1086 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
1087 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
1094 * Appends signoff to the "msg" field of the am_state.
1096 static void am_append_signoff(struct am_state
*state
)
1098 struct strbuf sb
= STRBUF_INIT
;
1100 strbuf_attach(&sb
, state
->msg
, state
->msg_len
, state
->msg_len
);
1101 append_signoff(&sb
, 0, 0);
1102 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
1106 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
1107 * state->msg will be set to the patch message. state->author_name,
1108 * state->author_email and state->author_date will be set to the patch author's
1109 * name, email and date respectively. The patch body will be written to the
1110 * state directory's "patch" file.
1112 * Returns 1 if the patch should be skipped, 0 otherwise.
1114 static int parse_mail(struct am_state
*state
, const char *mail
)
1117 struct strbuf sb
= STRBUF_INIT
;
1118 struct strbuf msg
= STRBUF_INIT
;
1119 struct strbuf author_name
= STRBUF_INIT
;
1120 struct strbuf author_date
= STRBUF_INIT
;
1121 struct strbuf author_email
= STRBUF_INIT
;
1125 setup_mailinfo(&mi
);
1128 mi
.metainfo_charset
= get_commit_output_encoding();
1130 mi
.metainfo_charset
= NULL
;
1132 switch (state
->keep
) {
1136 mi
.keep_subject
= 1;
1138 case KEEP_NON_PATCH
:
1139 mi
.keep_non_patch_brackets_in_subject
= 1;
1142 BUG("invalid value for state->keep");
1145 if (state
->message_id
)
1146 mi
.add_message_id
= 1;
1148 switch (state
->scissors
) {
1149 case SCISSORS_UNSET
:
1151 case SCISSORS_FALSE
:
1152 mi
.use_scissors
= 0;
1155 mi
.use_scissors
= 1;
1158 BUG("invalid value for state->scissors");
1161 mi
.input
= xfopen(mail
, "r");
1162 mi
.output
= xfopen(am_path(state
, "info"), "w");
1163 if (mailinfo(&mi
, am_path(state
, "msg"), am_path(state
, "patch")))
1164 die("could not parse patch");
1169 if (mi
.format_flowed
)
1170 warning(_("Patch sent with format=flowed; "
1171 "space at the end of lines might be lost."));
1173 /* Extract message and author information */
1174 fp
= xfopen(am_path(state
, "info"), "r");
1175 while (!strbuf_getline_lf(&sb
, fp
)) {
1178 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
1180 strbuf_addch(&msg
, '\n');
1181 strbuf_addstr(&msg
, x
);
1182 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
1183 strbuf_addstr(&author_name
, x
);
1184 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
1185 strbuf_addstr(&author_email
, x
);
1186 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
1187 strbuf_addstr(&author_date
, x
);
1191 /* Skip pine's internal folder data */
1192 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
1197 if (is_empty_or_missing_file(am_path(state
, "patch"))) {
1198 printf_ln(_("Patch is empty."));
1199 die_user_resolve(state
);
1202 strbuf_addstr(&msg
, "\n\n");
1203 strbuf_addbuf(&msg
, &mi
.log_message
);
1204 strbuf_stripspace(&msg
, 0);
1206 assert(!state
->author_name
);
1207 state
->author_name
= strbuf_detach(&author_name
, NULL
);
1209 assert(!state
->author_email
);
1210 state
->author_email
= strbuf_detach(&author_email
, NULL
);
1212 assert(!state
->author_date
);
1213 state
->author_date
= strbuf_detach(&author_date
, NULL
);
1215 assert(!state
->msg
);
1216 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1219 strbuf_release(&msg
);
1220 strbuf_release(&author_date
);
1221 strbuf_release(&author_email
);
1222 strbuf_release(&author_name
);
1223 strbuf_release(&sb
);
1224 clear_mailinfo(&mi
);
1229 * Sets commit_id to the commit hash where the mail was generated from.
1230 * Returns 0 on success, -1 on failure.
1232 static int get_mail_commit_oid(struct object_id
*commit_id
, const char *mail
)
1234 struct strbuf sb
= STRBUF_INIT
;
1235 FILE *fp
= xfopen(mail
, "r");
1239 if (strbuf_getline_lf(&sb
, fp
) ||
1240 !skip_prefix(sb
.buf
, "From ", &x
) ||
1241 get_oid_hex(x
, commit_id
) < 0)
1244 strbuf_release(&sb
);
1250 * Sets state->msg, state->author_name, state->author_email, state->author_date
1251 * to the commit's respective info.
1253 static void get_commit_info(struct am_state
*state
, struct commit
*commit
)
1255 const char *buffer
, *ident_line
, *msg
;
1257 struct ident_split id
;
1259 buffer
= logmsg_reencode(commit
, NULL
, get_commit_output_encoding());
1261 ident_line
= find_commit_header(buffer
, "author", &ident_len
);
1263 die(_("missing author line in commit %s"),
1264 oid_to_hex(&commit
->object
.oid
));
1265 if (split_ident_line(&id
, ident_line
, ident_len
) < 0)
1266 die(_("invalid ident line: %.*s"), (int)ident_len
, ident_line
);
1268 assert(!state
->author_name
);
1270 state
->author_name
=
1271 xmemdupz(id
.name_begin
, id
.name_end
- id
.name_begin
);
1273 state
->author_name
= xstrdup("");
1275 assert(!state
->author_email
);
1277 state
->author_email
=
1278 xmemdupz(id
.mail_begin
, id
.mail_end
- id
.mail_begin
);
1280 state
->author_email
= xstrdup("");
1282 assert(!state
->author_date
);
1283 state
->author_date
= xstrdup(show_ident_date(&id
, DATE_MODE(NORMAL
)));
1285 assert(!state
->msg
);
1286 msg
= strstr(buffer
, "\n\n");
1288 die(_("unable to parse commit %s"), oid_to_hex(&commit
->object
.oid
));
1289 state
->msg
= xstrdup(msg
+ 2);
1290 state
->msg_len
= strlen(state
->msg
);
1291 unuse_commit_buffer(commit
, buffer
);
1295 * Writes `commit` as a patch to the state directory's "patch" file.
1297 static void write_commit_patch(const struct am_state
*state
, struct commit
*commit
)
1299 struct rev_info rev_info
;
1302 fp
= xfopen(am_path(state
, "patch"), "w");
1303 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1305 rev_info
.abbrev
= 0;
1306 rev_info
.disable_stdin
= 1;
1307 rev_info
.show_root_diff
= 1;
1308 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1309 rev_info
.no_commit_id
= 1;
1310 rev_info
.diffopt
.flags
.binary
= 1;
1311 rev_info
.diffopt
.flags
.full_index
= 1;
1312 rev_info
.diffopt
.use_color
= 0;
1313 rev_info
.diffopt
.file
= fp
;
1314 rev_info
.diffopt
.close_file
= 1;
1315 add_pending_object(&rev_info
, &commit
->object
, "");
1316 diff_setup_done(&rev_info
.diffopt
);
1317 log_tree_commit(&rev_info
, commit
);
1321 * Writes the diff of the index against HEAD as a patch to the state
1322 * directory's "patch" file.
1324 static void write_index_patch(const struct am_state
*state
)
1327 struct object_id head
;
1328 struct rev_info rev_info
;
1331 if (!get_oid("HEAD", &head
)) {
1332 struct commit
*commit
= lookup_commit_or_die(&head
, "HEAD");
1333 tree
= get_commit_tree(commit
);
1335 tree
= lookup_tree(the_repository
,
1336 the_repository
->hash_algo
->empty_tree
);
1338 fp
= xfopen(am_path(state
, "patch"), "w");
1339 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1341 rev_info
.disable_stdin
= 1;
1342 rev_info
.no_commit_id
= 1;
1343 rev_info
.diffopt
.output_format
= DIFF_FORMAT_PATCH
;
1344 rev_info
.diffopt
.use_color
= 0;
1345 rev_info
.diffopt
.file
= fp
;
1346 rev_info
.diffopt
.close_file
= 1;
1347 add_pending_object(&rev_info
, &tree
->object
, "");
1348 diff_setup_done(&rev_info
.diffopt
);
1349 run_diff_index(&rev_info
, 1);
1353 * Like parse_mail(), but parses the mail by looking up its commit ID
1354 * directly. This is used in --rebasing mode to bypass git-mailinfo's munging
1357 * state->orig_commit will be set to the original commit ID.
1359 * Will always return 0 as the patch should never be skipped.
1361 static int parse_mail_rebase(struct am_state
*state
, const char *mail
)
1363 struct commit
*commit
;
1364 struct object_id commit_oid
;
1366 if (get_mail_commit_oid(&commit_oid
, mail
) < 0)
1367 die(_("could not parse %s"), mail
);
1369 commit
= lookup_commit_or_die(&commit_oid
, mail
);
1371 get_commit_info(state
, commit
);
1373 write_commit_patch(state
, commit
);
1375 oidcpy(&state
->orig_commit
, &commit_oid
);
1376 write_state_text(state
, "original-commit", oid_to_hex(&commit_oid
));
1377 update_ref("am", "REBASE_HEAD", &commit_oid
,
1378 NULL
, REF_NO_DEREF
, UPDATE_REFS_DIE_ON_ERR
);
1384 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise. If
1385 * `index_file` is not NULL, the patch will be applied to that index.
1387 static int run_apply(const struct am_state
*state
, const char *index_file
)
1389 struct argv_array apply_paths
= ARGV_ARRAY_INIT
;
1390 struct argv_array apply_opts
= ARGV_ARRAY_INIT
;
1391 struct apply_state apply_state
;
1393 int force_apply
= 0;
1396 if (init_apply_state(&apply_state
, the_repository
, NULL
))
1397 BUG("init_apply_state() failed");
1399 argv_array_push(&apply_opts
, "apply");
1400 argv_array_pushv(&apply_opts
, state
->git_apply_opts
.argv
);
1402 opts_left
= apply_parse_options(apply_opts
.argc
, apply_opts
.argv
,
1403 &apply_state
, &force_apply
, &options
,
1407 die("unknown option passed through to git apply");
1410 apply_state
.index_file
= index_file
;
1411 apply_state
.cached
= 1;
1413 apply_state
.check_index
= 1;
1416 * If we are allowed to fall back on 3-way merge, don't give false
1417 * errors during the initial attempt.
1419 if (state
->threeway
&& !index_file
)
1420 apply_state
.apply_verbosity
= verbosity_silent
;
1422 if (check_apply_state(&apply_state
, force_apply
))
1423 BUG("check_apply_state() failed");
1425 argv_array_push(&apply_paths
, am_path(state
, "patch"));
1427 res
= apply_all_patches(&apply_state
, apply_paths
.argc
, apply_paths
.argv
, options
);
1429 argv_array_clear(&apply_paths
);
1430 argv_array_clear(&apply_opts
);
1431 clear_apply_state(&apply_state
);
1437 /* Reload index as apply_all_patches() will have modified it. */
1439 read_cache_from(index_file
);
1446 * Builds an index that contains just the blobs needed for a 3way merge.
1448 static int build_fake_ancestor(const struct am_state
*state
, const char *index_file
)
1450 struct child_process cp
= CHILD_PROCESS_INIT
;
1453 argv_array_push(&cp
.args
, "apply");
1454 argv_array_pushv(&cp
.args
, state
->git_apply_opts
.argv
);
1455 argv_array_pushf(&cp
.args
, "--build-fake-ancestor=%s", index_file
);
1456 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1458 if (run_command(&cp
))
1465 * Attempt a threeway merge, using index_path as the temporary index.
1467 static int fall_back_threeway(const struct am_state
*state
, const char *index_path
)
1469 struct object_id orig_tree
, their_tree
, our_tree
;
1470 const struct object_id
*bases
[1] = { &orig_tree
};
1471 struct merge_options o
;
1472 struct commit
*result
;
1473 char *their_tree_name
;
1475 if (get_oid("HEAD", &our_tree
) < 0)
1476 oidcpy(&our_tree
, the_hash_algo
->empty_tree
);
1478 if (build_fake_ancestor(state
, index_path
))
1479 return error("could not build fake ancestor");
1482 read_cache_from(index_path
);
1484 if (write_index_as_tree(&orig_tree
, &the_index
, index_path
, 0, NULL
))
1485 return error(_("Repository lacks necessary blobs to fall back on 3-way merge."));
1487 say(state
, stdout
, _("Using index info to reconstruct a base tree..."));
1489 if (!state
->quiet
) {
1491 * List paths that needed 3-way fallback, so that the user can
1492 * review them with extra care to spot mismerges.
1494 struct rev_info rev_info
;
1496 repo_init_revisions(the_repository
, &rev_info
, NULL
);
1497 rev_info
.diffopt
.output_format
= DIFF_FORMAT_NAME_STATUS
;
1498 rev_info
.diffopt
.filter
|= diff_filter_bit('A');
1499 rev_info
.diffopt
.filter
|= diff_filter_bit('M');
1500 add_pending_oid(&rev_info
, "HEAD", &our_tree
, 0);
1501 diff_setup_done(&rev_info
.diffopt
);
1502 run_diff_index(&rev_info
, 1);
1505 if (run_apply(state
, index_path
))
1506 return error(_("Did you hand edit your patch?\n"
1507 "It does not apply to blobs recorded in its index."));
1509 if (write_index_as_tree(&their_tree
, &the_index
, index_path
, 0, NULL
))
1510 return error("could not write tree");
1512 say(state
, stdout
, _("Falling back to patching base and 3-way merge..."));
1518 * This is not so wrong. Depending on which base we picked, orig_tree
1519 * may be wildly different from ours, but their_tree has the same set of
1520 * wildly different changes in parts the patch did not touch, so
1521 * recursive ends up canceling them, saying that we reverted all those
1525 init_merge_options(&o
, the_repository
);
1528 their_tree_name
= xstrfmt("%.*s", linelen(state
->msg
), state
->msg
);
1529 o
.branch2
= their_tree_name
;
1530 o
.detect_directory_renames
= 0;
1535 if (merge_recursive_generic(&o
, &our_tree
, &their_tree
, 1, bases
, &result
)) {
1536 repo_rerere(the_repository
, state
->allow_rerere_autoupdate
);
1537 free(their_tree_name
);
1538 return error(_("Failed to merge in the changes."));
1541 free(their_tree_name
);
1546 * Commits the current index with state->msg as the commit message and
1547 * state->author_name, state->author_email and state->author_date as the author
1550 static void do_commit(const struct am_state
*state
)
1552 struct object_id tree
, parent
, commit
;
1553 const struct object_id
*old_oid
;
1554 struct commit_list
*parents
= NULL
;
1555 const char *reflog_msg
, *author
;
1556 struct strbuf sb
= STRBUF_INIT
;
1558 if (run_hook_le(NULL
, "pre-applypatch", NULL
))
1561 if (write_cache_as_tree(&tree
, 0, NULL
))
1562 die(_("git write-tree failed to write a tree"));
1564 if (!get_oid_commit("HEAD", &parent
)) {
1566 commit_list_insert(lookup_commit(the_repository
, &parent
),
1570 say(state
, stderr
, _("applying to an empty history"));
1573 author
= fmt_ident(state
->author_name
, state
->author_email
,
1575 state
->ignore_date
? NULL
: state
->author_date
,
1578 if (state
->committer_date_is_author_date
)
1579 setenv("GIT_COMMITTER_DATE",
1580 state
->ignore_date
? "" : state
->author_date
, 1);
1582 if (commit_tree(state
->msg
, state
->msg_len
, &tree
, parents
, &commit
,
1583 author
, state
->sign_commit
))
1584 die(_("failed to write commit object"));
1586 reflog_msg
= getenv("GIT_REFLOG_ACTION");
1590 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
1593 update_ref(sb
.buf
, "HEAD", &commit
, old_oid
, 0,
1594 UPDATE_REFS_DIE_ON_ERR
);
1596 if (state
->rebasing
) {
1597 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1599 assert(!is_null_oid(&state
->orig_commit
));
1600 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1601 fprintf(fp
, "%s\n", oid_to_hex(&commit
));
1605 run_hook_le(NULL
, "post-applypatch", NULL
);
1607 strbuf_release(&sb
);
1611 * Validates the am_state for resuming -- the "msg" and authorship fields must
1614 static void validate_resume_state(const struct am_state
*state
)
1617 die(_("cannot resume: %s does not exist."),
1618 am_path(state
, "final-commit"));
1620 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
1621 die(_("cannot resume: %s does not exist."),
1622 am_path(state
, "author-script"));
1626 * Interactively prompt the user on whether the current patch should be
1629 * Returns 0 if the user chooses to apply the patch, 1 if the user chooses to
1632 static int do_interactive(struct am_state
*state
)
1639 puts(_("Commit Body is:"));
1640 puts("--------------------------");
1641 printf("%s", state
->msg
);
1642 puts("--------------------------");
1645 * TRANSLATORS: Make sure to include [y], [n], [e], [v] and [a]
1646 * in your translation. The program will only accept English
1647 * input at this point.
1649 printf(_("Apply? [y]es/[n]o/[e]dit/[v]iew patch/[a]ccept all: "));
1650 if (!fgets(reply
, sizeof(reply
), stdin
))
1651 die("unable to read from stdin; aborting");
1653 if (*reply
== 'y' || *reply
== 'Y') {
1655 } else if (*reply
== 'a' || *reply
== 'A') {
1656 state
->interactive
= 0;
1658 } else if (*reply
== 'n' || *reply
== 'N') {
1660 } else if (*reply
== 'e' || *reply
== 'E') {
1661 struct strbuf msg
= STRBUF_INIT
;
1663 if (!launch_editor(am_path(state
, "final-commit"), &msg
, NULL
)) {
1665 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
1667 strbuf_release(&msg
);
1668 } else if (*reply
== 'v' || *reply
== 'V') {
1669 const char *pager
= git_pager(1);
1670 struct child_process cp
= CHILD_PROCESS_INIT
;
1674 prepare_pager_args(&cp
, pager
);
1675 argv_array_push(&cp
.args
, am_path(state
, "patch"));
1682 * Applies all queued mail.
1684 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
1685 * well as the state directory's "patch" file is used as-is for applying the
1686 * patch and committing it.
1688 static void am_run(struct am_state
*state
, int resume
)
1690 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
1691 struct strbuf sb
= STRBUF_INIT
;
1693 unlink(am_path(state
, "dirtyindex"));
1695 if (refresh_and_write_cache(REFRESH_QUIET
, 0, 0) < 0)
1696 die(_("unable to write index file"));
1698 if (repo_index_has_changes(the_repository
, NULL
, &sb
)) {
1699 write_state_bool(state
, "dirtyindex", 1);
1700 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
1703 strbuf_release(&sb
);
1705 while (state
->cur
<= state
->last
) {
1706 const char *mail
= am_path(state
, msgnum(state
));
1711 if (!file_exists(mail
))
1715 validate_resume_state(state
);
1719 if (state
->rebasing
)
1720 skip
= parse_mail_rebase(state
, mail
);
1722 skip
= parse_mail(state
, mail
);
1725 goto next
; /* mail should be skipped */
1728 am_append_signoff(state
);
1730 write_author_script(state
);
1731 write_commit_msg(state
);
1734 if (state
->interactive
&& do_interactive(state
))
1737 if (run_applypatch_msg_hook(state
))
1740 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1742 apply_status
= run_apply(state
, NULL
);
1744 if (apply_status
&& state
->threeway
) {
1745 struct strbuf sb
= STRBUF_INIT
;
1747 strbuf_addstr(&sb
, am_path(state
, "patch-merge-index"));
1748 apply_status
= fall_back_threeway(state
, sb
.buf
);
1749 strbuf_release(&sb
);
1752 * Applying the patch to an earlier tree and merging
1753 * the result may have produced the same tree as ours.
1755 if (!apply_status
&&
1756 !repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1757 say(state
, stdout
, _("No changes -- Patch already applied."));
1763 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
1764 linelen(state
->msg
), state
->msg
);
1766 if (advice_amworkdir
)
1767 advise(_("Use 'git am --show-current-patch' to see the failed patch"));
1769 die_user_resolve(state
);
1782 if (!is_empty_or_missing_file(am_path(state
, "rewritten"))) {
1783 assert(state
->rebasing
);
1784 copy_notes_for_rebase(state
);
1785 run_post_rewrite_hook(state
);
1789 * In rebasing mode, it's up to the caller to take care of
1792 if (!state
->rebasing
) {
1794 close_object_store(the_repository
->objects
);
1795 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
1800 * Resume the current am session after patch application failure. The user did
1801 * all the hard work, and we do not have to do any patch application. Just
1802 * trust and commit what the user has in the index and working tree.
1804 static void am_resolve(struct am_state
*state
)
1806 validate_resume_state(state
);
1808 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
1810 if (!repo_index_has_changes(the_repository
, NULL
, NULL
)) {
1811 printf_ln(_("No changes - did you forget to use 'git add'?\n"
1812 "If there is nothing left to stage, chances are that something else\n"
1813 "already introduced the same changes; you might want to skip this patch."));
1814 die_user_resolve(state
);
1817 if (unmerged_cache()) {
1818 printf_ln(_("You still have unmerged paths in your index.\n"
1819 "You should 'git add' each file with resolved conflicts to mark them as such.\n"
1820 "You might run `git rm` on a file to accept \"deleted by them\" for it."));
1821 die_user_resolve(state
);
1824 if (state
->interactive
) {
1825 write_index_patch(state
);
1826 if (do_interactive(state
))
1830 repo_rerere(the_repository
, 0);
1841 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
1842 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
1845 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
1847 struct lock_file lock_file
= LOCK_INIT
;
1848 struct unpack_trees_options opts
;
1849 struct tree_desc t
[2];
1851 if (parse_tree(head
) || parse_tree(remote
))
1854 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1856 refresh_cache(REFRESH_QUIET
);
1858 memset(&opts
, 0, sizeof(opts
));
1860 opts
.src_index
= &the_index
;
1861 opts
.dst_index
= &the_index
;
1865 opts
.fn
= twoway_merge
;
1866 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
1867 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
1869 if (unpack_trees(2, t
, &opts
)) {
1870 rollback_lock_file(&lock_file
);
1874 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1875 die(_("unable to write new index file"));
1881 * Merges a tree into the index. The index's stat info will take precedence
1882 * over the merged tree's. Returns 0 on success, -1 on failure.
1884 static int merge_tree(struct tree
*tree
)
1886 struct lock_file lock_file
= LOCK_INIT
;
1887 struct unpack_trees_options opts
;
1888 struct tree_desc t
[1];
1890 if (parse_tree(tree
))
1893 hold_locked_index(&lock_file
, LOCK_DIE_ON_ERROR
);
1895 memset(&opts
, 0, sizeof(opts
));
1897 opts
.src_index
= &the_index
;
1898 opts
.dst_index
= &the_index
;
1900 opts
.fn
= oneway_merge
;
1901 init_tree_desc(&t
[0], tree
->buffer
, tree
->size
);
1903 if (unpack_trees(1, t
, &opts
)) {
1904 rollback_lock_file(&lock_file
);
1908 if (write_locked_index(&the_index
, &lock_file
, COMMIT_LOCK
))
1909 die(_("unable to write new index file"));
1915 * Clean the index without touching entries that are not modified between
1916 * `head` and `remote`.
1918 static int clean_index(const struct object_id
*head
, const struct object_id
*remote
)
1920 struct tree
*head_tree
, *remote_tree
, *index_tree
;
1921 struct object_id index
;
1923 head_tree
= parse_tree_indirect(head
);
1925 return error(_("Could not parse object '%s'."), oid_to_hex(head
));
1927 remote_tree
= parse_tree_indirect(remote
);
1929 return error(_("Could not parse object '%s'."), oid_to_hex(remote
));
1931 read_cache_unmerged();
1933 if (fast_forward_to(head_tree
, head_tree
, 1))
1936 if (write_cache_as_tree(&index
, 0, NULL
))
1939 index_tree
= parse_tree_indirect(&index
);
1941 return error(_("Could not parse object '%s'."), oid_to_hex(&index
));
1943 if (fast_forward_to(index_tree
, remote_tree
, 0))
1946 if (merge_tree(remote_tree
))
1949 remove_branch_state(the_repository
, 0);
1955 * Resets rerere's merge resolution metadata.
1957 static void am_rerere_clear(void)
1959 struct string_list merge_rr
= STRING_LIST_INIT_DUP
;
1960 rerere_clear(the_repository
, &merge_rr
);
1961 string_list_clear(&merge_rr
, 1);
1965 * Resume the current am session by skipping the current patch.
1967 static void am_skip(struct am_state
*state
)
1969 struct object_id head
;
1973 if (get_oid("HEAD", &head
))
1974 oidcpy(&head
, the_hash_algo
->empty_tree
);
1976 if (clean_index(&head
, &head
))
1977 die(_("failed to clean index"));
1979 if (state
->rebasing
) {
1980 FILE *fp
= xfopen(am_path(state
, "rewritten"), "a");
1982 assert(!is_null_oid(&state
->orig_commit
));
1983 fprintf(fp
, "%s ", oid_to_hex(&state
->orig_commit
));
1984 fprintf(fp
, "%s\n", oid_to_hex(&head
));
1994 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
1996 * It is not safe to reset HEAD when:
1997 * 1. git-am previously failed because the index was dirty.
1998 * 2. HEAD has moved since git-am previously failed.
2000 static int safe_to_abort(const struct am_state
*state
)
2002 struct strbuf sb
= STRBUF_INIT
;
2003 struct object_id abort_safety
, head
;
2005 if (file_exists(am_path(state
, "dirtyindex")))
2008 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
2009 if (get_oid_hex(sb
.buf
, &abort_safety
))
2010 die(_("could not parse %s"), am_path(state
, "abort-safety"));
2012 oidclr(&abort_safety
);
2013 strbuf_release(&sb
);
2015 if (get_oid("HEAD", &head
))
2018 if (oideq(&head
, &abort_safety
))
2021 warning(_("You seem to have moved HEAD since the last 'am' failure.\n"
2022 "Not rewinding to ORIG_HEAD"));
2028 * Aborts the current am session if it is safe to do so.
2030 static void am_abort(struct am_state
*state
)
2032 struct object_id curr_head
, orig_head
;
2033 int has_curr_head
, has_orig_head
;
2036 if (!safe_to_abort(state
)) {
2043 curr_branch
= resolve_refdup("HEAD", 0, &curr_head
, NULL
);
2044 has_curr_head
= curr_branch
&& !is_null_oid(&curr_head
);
2046 oidcpy(&curr_head
, the_hash_algo
->empty_tree
);
2048 has_orig_head
= !get_oid("ORIG_HEAD", &orig_head
);
2050 oidcpy(&orig_head
, the_hash_algo
->empty_tree
);
2052 clean_index(&curr_head
, &orig_head
);
2055 update_ref("am --abort", "HEAD", &orig_head
,
2056 has_curr_head
? &curr_head
: NULL
, 0,
2057 UPDATE_REFS_DIE_ON_ERR
);
2058 else if (curr_branch
)
2059 delete_ref(NULL
, curr_branch
, NULL
, REF_NO_DEREF
);
2065 static int show_patch(struct am_state
*state
)
2067 struct strbuf sb
= STRBUF_INIT
;
2068 const char *patch_path
;
2071 if (!is_null_oid(&state
->orig_commit
)) {
2072 const char *av
[4] = { "show", NULL
, "--", NULL
};
2076 av
[1] = new_oid_str
= xstrdup(oid_to_hex(&state
->orig_commit
));
2077 ret
= run_command_v_opt(av
, RUN_GIT_CMD
);
2082 patch_path
= am_path(state
, msgnum(state
));
2083 len
= strbuf_read_file(&sb
, patch_path
, 0);
2085 die_errno(_("failed to read '%s'"), patch_path
);
2088 write_in_full(1, sb
.buf
, sb
.len
);
2089 strbuf_release(&sb
);
2094 * parse_options() callback that validates and sets opt->value to the
2095 * PATCH_FORMAT_* enum value corresponding to `arg`.
2097 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
2099 int *opt_value
= opt
->value
;
2102 *opt_value
= PATCH_FORMAT_UNKNOWN
;
2103 else if (!strcmp(arg
, "mbox"))
2104 *opt_value
= PATCH_FORMAT_MBOX
;
2105 else if (!strcmp(arg
, "stgit"))
2106 *opt_value
= PATCH_FORMAT_STGIT
;
2107 else if (!strcmp(arg
, "stgit-series"))
2108 *opt_value
= PATCH_FORMAT_STGIT_SERIES
;
2109 else if (!strcmp(arg
, "hg"))
2110 *opt_value
= PATCH_FORMAT_HG
;
2111 else if (!strcmp(arg
, "mboxrd"))
2112 *opt_value
= PATCH_FORMAT_MBOXRD
;
2114 * Please update $__git_patchformat in git-completion.bash
2115 * when you add new options
2118 return error(_("Invalid value for --patch-format: %s"), arg
);
2132 static int git_am_config(const char *k
, const char *v
, void *cb
)
2136 status
= git_gpg_config(k
, v
, NULL
);
2140 return git_default_config(k
, v
, NULL
);
2143 int cmd_am(int argc
, const char **argv
, const char *prefix
)
2145 struct am_state state
;
2148 int patch_format
= PATCH_FORMAT_UNKNOWN
;
2149 enum resume_mode resume
= RESUME_FALSE
;
2153 const char * const usage
[] = {
2154 N_("git am [<options>] [(<mbox> | <Maildir>)...]"),
2155 N_("git am [<options>] (--continue | --skip | --abort)"),
2159 struct option options
[] = {
2160 OPT_BOOL('i', "interactive", &state
.interactive
,
2161 N_("run interactively")),
2162 OPT_HIDDEN_BOOL('b', "binary", &binary
,
2163 N_("historical option -- no-op")),
2164 OPT_BOOL('3', "3way", &state
.threeway
,
2165 N_("allow fall back on 3way merging if needed")),
2166 OPT__QUIET(&state
.quiet
, N_("be quiet")),
2167 OPT_SET_INT('s', "signoff", &state
.signoff
,
2168 N_("add a Signed-off-by line to the commit message"),
2170 OPT_BOOL('u', "utf8", &state
.utf8
,
2171 N_("recode into utf8 (default)")),
2172 OPT_SET_INT('k', "keep", &state
.keep
,
2173 N_("pass -k flag to git-mailinfo"), KEEP_TRUE
),
2174 OPT_SET_INT(0, "keep-non-patch", &state
.keep
,
2175 N_("pass -b flag to git-mailinfo"), KEEP_NON_PATCH
),
2176 OPT_BOOL('m', "message-id", &state
.message_id
,
2177 N_("pass -m flag to git-mailinfo")),
2178 OPT_SET_INT_F(0, "keep-cr", &keep_cr
,
2179 N_("pass --keep-cr flag to git-mailsplit for mbox format"),
2180 1, PARSE_OPT_NONEG
),
2181 OPT_SET_INT_F(0, "no-keep-cr", &keep_cr
,
2182 N_("do not pass --keep-cr flag to git-mailsplit independent of am.keepcr"),
2183 0, PARSE_OPT_NONEG
),
2184 OPT_BOOL('c', "scissors", &state
.scissors
,
2185 N_("strip everything before a scissors line")),
2186 OPT_PASSTHRU_ARGV(0, "whitespace", &state
.git_apply_opts
, N_("action"),
2187 N_("pass it through git-apply"),
2189 OPT_PASSTHRU_ARGV(0, "ignore-space-change", &state
.git_apply_opts
, NULL
,
2190 N_("pass it through git-apply"),
2192 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &state
.git_apply_opts
, NULL
,
2193 N_("pass it through git-apply"),
2195 OPT_PASSTHRU_ARGV(0, "directory", &state
.git_apply_opts
, N_("root"),
2196 N_("pass it through git-apply"),
2198 OPT_PASSTHRU_ARGV(0, "exclude", &state
.git_apply_opts
, N_("path"),
2199 N_("pass it through git-apply"),
2201 OPT_PASSTHRU_ARGV(0, "include", &state
.git_apply_opts
, N_("path"),
2202 N_("pass it through git-apply"),
2204 OPT_PASSTHRU_ARGV('C', NULL
, &state
.git_apply_opts
, N_("n"),
2205 N_("pass it through git-apply"),
2207 OPT_PASSTHRU_ARGV('p', NULL
, &state
.git_apply_opts
, N_("num"),
2208 N_("pass it through git-apply"),
2210 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
2211 N_("format the patch(es) are in"),
2212 parse_opt_patchformat
),
2213 OPT_PASSTHRU_ARGV(0, "reject", &state
.git_apply_opts
, NULL
,
2214 N_("pass it through git-apply"),
2216 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
2217 N_("override error message when patch failure occurs")),
2218 OPT_CMDMODE(0, "continue", &resume
,
2219 N_("continue applying patches after resolving a conflict"),
2221 OPT_CMDMODE('r', "resolved", &resume
,
2222 N_("synonyms for --continue"),
2224 OPT_CMDMODE(0, "skip", &resume
,
2225 N_("skip the current patch"),
2227 OPT_CMDMODE(0, "abort", &resume
,
2228 N_("restore the original branch and abort the patching operation."),
2230 OPT_CMDMODE(0, "quit", &resume
,
2231 N_("abort the patching operation but keep HEAD where it is."),
2233 OPT_CMDMODE(0, "show-current-patch", &resume
,
2234 N_("show the patch being applied."),
2236 OPT_BOOL(0, "committer-date-is-author-date",
2237 &state
.committer_date_is_author_date
,
2238 N_("lie about committer date")),
2239 OPT_BOOL(0, "ignore-date", &state
.ignore_date
,
2240 N_("use current timestamp for author date")),
2241 OPT_RERERE_AUTOUPDATE(&state
.allow_rerere_autoupdate
),
2242 { OPTION_STRING
, 'S', "gpg-sign", &state
.sign_commit
, N_("key-id"),
2243 N_("GPG-sign commits"),
2244 PARSE_OPT_OPTARG
, NULL
, (intptr_t) "" },
2245 OPT_HIDDEN_BOOL(0, "rebasing", &state
.rebasing
,
2246 N_("(internal use for git-rebase)")),
2250 if (argc
== 2 && !strcmp(argv
[1], "-h"))
2251 usage_with_options(usage
, options
);
2253 git_config(git_am_config
, NULL
);
2255 am_state_init(&state
);
2257 in_progress
= am_in_progress(&state
);
2261 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
2264 fprintf_ln(stderr
, _("The -b/--binary option has been a no-op for long time, and\n"
2265 "it will be removed. Please do not use it anymore."));
2267 /* Ensure a valid committer ident can be constructed */
2268 git_committer_info(IDENT_STRICT
);
2270 if (repo_read_index_preload(the_repository
, NULL
, 0) < 0)
2271 die(_("failed to read the index"));
2275 * Catch user error to feed us patches when there is a session
2278 * 1. mbox path(s) are provided on the command-line.
2279 * 2. stdin is not a tty: the user is trying to feed us a patch
2280 * from standard input. This is somewhat unreliable -- stdin
2281 * could be /dev/null for example and the caller did not
2282 * intend to feed us a patch but wanted to continue
2285 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
2286 die(_("previous rebase directory %s still exists but mbox given."),
2289 if (resume
== RESUME_FALSE
)
2290 resume
= RESUME_APPLY
;
2292 if (state
.signoff
== SIGNOFF_EXPLICIT
)
2293 am_append_signoff(&state
);
2295 struct argv_array paths
= ARGV_ARRAY_INIT
;
2299 * Handle stray state directory in the independent-run case. In
2300 * the --rebasing case, it is up to the caller to take care of
2301 * stray directories.
2303 if (file_exists(state
.dir
) && !state
.rebasing
) {
2304 if (resume
== RESUME_ABORT
|| resume
== RESUME_QUIT
) {
2306 am_state_release(&state
);
2310 die(_("Stray %s directory found.\n"
2311 "Use \"git am --abort\" to remove it."),
2316 die(_("Resolve operation not in progress, we are not resuming."));
2318 for (i
= 0; i
< argc
; i
++) {
2319 if (is_absolute_path(argv
[i
]) || !prefix
)
2320 argv_array_push(&paths
, argv
[i
]);
2322 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
2325 if (state
.interactive
&& !paths
.argc
)
2326 die(_("interactive mode requires patches on the command line"));
2328 am_setup(&state
, patch_format
, paths
.argv
, keep_cr
);
2330 argv_array_clear(&paths
);
2340 case RESUME_RESOLVED
:
2353 case RESUME_SHOW_PATCH
:
2354 ret
= show_patch(&state
);
2357 BUG("invalid resume value");
2360 am_state_release(&state
);