4 * Based on git-am.sh by Junio C Hamano.
9 #include "parse-options.h"
11 #include "run-command.h"
14 #include "cache-tree.h"
19 #include "unpack-trees.h"
21 #include "sequencer.h"
24 * Returns 1 if the file is empty or does not exist, 0 otherwise.
26 static int is_empty_file(const char *filename
)
30 if (stat(filename
, &st
) < 0) {
33 die_errno(_("could not stat %s"), filename
);
40 * Like strbuf_getline(), but treats both '\n' and "\r\n" as line terminators.
42 static int strbuf_getline_crlf(struct strbuf
*sb
, FILE *fp
)
44 if (strbuf_getwholeline(sb
, fp
, '\n'))
46 if (sb
->buf
[sb
->len
- 1] == '\n') {
47 strbuf_setlen(sb
, sb
->len
- 1);
48 if (sb
->len
> 0 && sb
->buf
[sb
->len
- 1] == '\r')
49 strbuf_setlen(sb
, sb
->len
- 1);
55 * Returns the length of the first line of msg.
57 static int linelen(const char *msg
)
59 return strchrnul(msg
, '\n') - msg
;
63 PATCH_FORMAT_UNKNOWN
= 0,
68 /* state directory path */
71 /* current and last patch numbers, 1-indexed */
75 /* commit metadata and message */
82 /* number of digits in patch filename */
85 /* various operating modes and command line options */
88 const char *resolvemsg
;
92 * Initializes am_state with the default values. The state directory is set to
95 static void am_state_init(struct am_state
*state
, const char *dir
)
97 memset(state
, 0, sizeof(*state
));
100 state
->dir
= xstrdup(dir
);
106 * Releases memory allocated by an am_state.
108 static void am_state_release(struct am_state
*state
)
111 free(state
->author_name
);
112 free(state
->author_email
);
113 free(state
->author_date
);
118 * Returns path relative to the am_state directory.
120 static inline const char *am_path(const struct am_state
*state
, const char *path
)
122 return mkpath("%s/%s", state
->dir
, path
);
126 * If state->quiet is false, calls fprintf(fp, fmt, ...), and appends a newline
129 static void say(const struct am_state
*state
, FILE *fp
, const char *fmt
, ...)
135 vfprintf(fp
, fmt
, ap
);
142 * Returns 1 if there is an am session in progress, 0 otherwise.
144 static int am_in_progress(const struct am_state
*state
)
148 if (lstat(state
->dir
, &st
) < 0 || !S_ISDIR(st
.st_mode
))
150 if (lstat(am_path(state
, "last"), &st
) || !S_ISREG(st
.st_mode
))
152 if (lstat(am_path(state
, "next"), &st
) || !S_ISREG(st
.st_mode
))
158 * Reads the contents of `file` in the `state` directory into `sb`. Returns the
159 * number of bytes read on success, -1 if the file does not exist. If `trim` is
160 * set, trailing whitespace will be removed.
162 static int read_state_file(struct strbuf
*sb
, const struct am_state
*state
,
163 const char *file
, int trim
)
167 if (strbuf_read_file(sb
, am_path(state
, file
), 0) >= 0) {
177 die_errno(_("could not read '%s'"), am_path(state
, file
));
181 * Reads a KEY=VALUE shell variable assignment from `fp`, returning the VALUE
182 * as a newly-allocated string. VALUE must be a quoted string, and the KEY must
183 * match `key`. Returns NULL on failure.
185 * This is used by read_author_script() to read the GIT_AUTHOR_* variables from
188 static char *read_shell_var(FILE *fp
, const char *key
)
190 struct strbuf sb
= STRBUF_INIT
;
193 if (strbuf_getline(&sb
, fp
, '\n'))
196 if (!skip_prefix(sb
.buf
, key
, &str
))
199 if (!skip_prefix(str
, "=", &str
))
202 strbuf_remove(&sb
, 0, str
- sb
.buf
);
204 str
= sq_dequote(sb
.buf
);
208 return strbuf_detach(&sb
, NULL
);
216 * Reads and parses the state directory's "author-script" file, and sets
217 * state->author_name, state->author_email and state->author_date accordingly.
218 * Returns 0 on success, -1 if the file could not be parsed.
220 * The author script is of the format:
222 * GIT_AUTHOR_NAME='$author_name'
223 * GIT_AUTHOR_EMAIL='$author_email'
224 * GIT_AUTHOR_DATE='$author_date'
226 * where $author_name, $author_email and $author_date are quoted. We are strict
227 * with our parsing, as the file was meant to be eval'd in the old git-am.sh
228 * script, and thus if the file differs from what this function expects, it is
229 * better to bail out than to do something that the user does not expect.
231 static int read_author_script(struct am_state
*state
)
233 const char *filename
= am_path(state
, "author-script");
236 assert(!state
->author_name
);
237 assert(!state
->author_email
);
238 assert(!state
->author_date
);
240 fp
= fopen(filename
, "r");
244 die_errno(_("could not open '%s' for reading"), filename
);
247 state
->author_name
= read_shell_var(fp
, "GIT_AUTHOR_NAME");
248 if (!state
->author_name
) {
253 state
->author_email
= read_shell_var(fp
, "GIT_AUTHOR_EMAIL");
254 if (!state
->author_email
) {
259 state
->author_date
= read_shell_var(fp
, "GIT_AUTHOR_DATE");
260 if (!state
->author_date
) {
265 if (fgetc(fp
) != EOF
) {
275 * Saves state->author_name, state->author_email and state->author_date in the
276 * state directory's "author-script" file.
278 static void write_author_script(const struct am_state
*state
)
280 struct strbuf sb
= STRBUF_INIT
;
282 strbuf_addstr(&sb
, "GIT_AUTHOR_NAME=");
283 sq_quote_buf(&sb
, state
->author_name
);
284 strbuf_addch(&sb
, '\n');
286 strbuf_addstr(&sb
, "GIT_AUTHOR_EMAIL=");
287 sq_quote_buf(&sb
, state
->author_email
);
288 strbuf_addch(&sb
, '\n');
290 strbuf_addstr(&sb
, "GIT_AUTHOR_DATE=");
291 sq_quote_buf(&sb
, state
->author_date
);
292 strbuf_addch(&sb
, '\n');
294 write_file(am_path(state
, "author-script"), 1, "%s", sb
.buf
);
300 * Reads the commit message from the state directory's "final-commit" file,
301 * setting state->msg to its contents and state->msg_len to the length of its
304 * Returns 0 on success, -1 if the file does not exist.
306 static int read_commit_msg(struct am_state
*state
)
308 struct strbuf sb
= STRBUF_INIT
;
312 if (read_state_file(&sb
, state
, "final-commit", 0) < 0) {
317 state
->msg
= strbuf_detach(&sb
, &state
->msg_len
);
322 * Saves state->msg in the state directory's "final-commit" file.
324 static void write_commit_msg(const struct am_state
*state
)
327 const char *filename
= am_path(state
, "final-commit");
329 fd
= xopen(filename
, O_WRONLY
| O_CREAT
, 0666);
330 if (write_in_full(fd
, state
->msg
, state
->msg_len
) < 0)
331 die_errno(_("could not write to %s"), filename
);
336 * Loads state from disk.
338 static void am_load(struct am_state
*state
)
340 struct strbuf sb
= STRBUF_INIT
;
342 if (read_state_file(&sb
, state
, "next", 1) < 0)
343 die("BUG: state file 'next' does not exist");
344 state
->cur
= strtol(sb
.buf
, NULL
, 10);
346 if (read_state_file(&sb
, state
, "last", 1) < 0)
347 die("BUG: state file 'last' does not exist");
348 state
->last
= strtol(sb
.buf
, NULL
, 10);
350 if (read_author_script(state
) < 0)
351 die(_("could not parse author script"));
353 read_commit_msg(state
);
355 read_state_file(&sb
, state
, "quiet", 1);
356 state
->quiet
= !strcmp(sb
.buf
, "t");
358 read_state_file(&sb
, state
, "sign", 1);
359 state
->signoff
= !strcmp(sb
.buf
, "t");
365 * Removes the am_state directory, forcefully terminating the current am
368 static void am_destroy(const struct am_state
*state
)
370 struct strbuf sb
= STRBUF_INIT
;
372 strbuf_addstr(&sb
, state
->dir
);
373 remove_dir_recursively(&sb
, 0);
378 * Determines if the file looks like a piece of RFC2822 mail by grabbing all
379 * non-indented lines and checking if they look like they begin with valid
380 * header field names.
382 * Returns 1 if the file looks like a piece of mail, 0 otherwise.
384 static int is_mail(FILE *fp
)
386 const char *header_regex
= "^[!-9;-~]+:";
387 struct strbuf sb
= STRBUF_INIT
;
391 if (fseek(fp
, 0L, SEEK_SET
))
392 die_errno(_("fseek failed"));
394 if (regcomp(®ex
, header_regex
, REG_NOSUB
| REG_EXTENDED
))
395 die("invalid pattern: %s", header_regex
);
397 while (!strbuf_getline_crlf(&sb
, fp
)) {
399 break; /* End of header */
401 /* Ignore indented folded lines */
402 if (*sb
.buf
== '\t' || *sb
.buf
== ' ')
405 /* It's a header if it matches header_regex */
406 if (regexec(®ex
, sb
.buf
, 0, NULL
, 0)) {
419 * Attempts to detect the patch_format of the patches contained in `paths`,
420 * returning the PATCH_FORMAT_* enum value. Returns PATCH_FORMAT_UNKNOWN if
423 static int detect_patch_format(const char **paths
)
425 enum patch_format ret
= PATCH_FORMAT_UNKNOWN
;
426 struct strbuf l1
= STRBUF_INIT
;
430 * We default to mbox format if input is from stdin and for directories
432 if (!*paths
|| !strcmp(*paths
, "-") || is_directory(*paths
))
433 return PATCH_FORMAT_MBOX
;
436 * Otherwise, check the first few lines of the first patch, starting
437 * from the first non-blank line, to try to detect its format.
440 fp
= xfopen(*paths
, "r");
442 while (!strbuf_getline_crlf(&l1
, fp
)) {
447 if (starts_with(l1
.buf
, "From ") || starts_with(l1
.buf
, "From: ")) {
448 ret
= PATCH_FORMAT_MBOX
;
452 if (l1
.len
&& is_mail(fp
)) {
453 ret
= PATCH_FORMAT_MBOX
;
464 * Splits out individual email patches from `paths`, where each path is either
465 * a mbox file or a Maildir. Returns 0 on success, -1 on failure.
467 static int split_mail_mbox(struct am_state
*state
, const char **paths
)
469 struct child_process cp
= CHILD_PROCESS_INIT
;
470 struct strbuf last
= STRBUF_INIT
;
473 argv_array_push(&cp
.args
, "mailsplit");
474 argv_array_pushf(&cp
.args
, "-d%d", state
->prec
);
475 argv_array_pushf(&cp
.args
, "-o%s", state
->dir
);
476 argv_array_push(&cp
.args
, "-b");
477 argv_array_push(&cp
.args
, "--");
478 argv_array_pushv(&cp
.args
, paths
);
480 if (capture_command(&cp
, &last
, 8))
484 state
->last
= strtol(last
.buf
, NULL
, 10);
490 * Splits a list of files/directories into individual email patches. Each path
491 * in `paths` must be a file/directory that is formatted according to
494 * Once split out, the individual email patches will be stored in the state
495 * directory, with each patch's filename being its index, padded to state->prec
498 * state->cur will be set to the index of the first mail, and state->last will
499 * be set to the index of the last mail.
501 * Returns 0 on success, -1 on failure.
503 static int split_mail(struct am_state
*state
, enum patch_format patch_format
,
506 switch (patch_format
) {
507 case PATCH_FORMAT_MBOX
:
508 return split_mail_mbox(state
, paths
);
510 die("BUG: invalid patch_format");
516 * Setup a new am session for applying patches
518 static void am_setup(struct am_state
*state
, enum patch_format patch_format
,
521 unsigned char curr_head
[GIT_SHA1_RAWSZ
];
524 patch_format
= detect_patch_format(paths
);
527 fprintf_ln(stderr
, _("Patch format detection failed."));
531 if (mkdir(state
->dir
, 0777) < 0 && errno
!= EEXIST
)
532 die_errno(_("failed to create directory '%s'"), state
->dir
);
534 if (split_mail(state
, patch_format
, paths
) < 0) {
536 die(_("Failed to split patches."));
539 write_file(am_path(state
, "quiet"), 1, state
->quiet
? "t" : "f");
541 write_file(am_path(state
, "sign"), 1, state
->signoff
? "t" : "f");
543 if (!get_sha1("HEAD", curr_head
)) {
544 write_file(am_path(state
, "abort-safety"), 1, "%s", sha1_to_hex(curr_head
));
545 update_ref("am", "ORIG_HEAD", curr_head
, NULL
, 0, UPDATE_REFS_DIE_ON_ERR
);
547 write_file(am_path(state
, "abort-safety"), 1, "%s", "");
548 delete_ref("ORIG_HEAD", NULL
, 0);
552 * NOTE: Since the "next" and "last" files determine if an am_state
553 * session is in progress, they should be written last.
556 write_file(am_path(state
, "next"), 1, "%d", state
->cur
);
558 write_file(am_path(state
, "last"), 1, "%d", state
->last
);
562 * Increments the patch pointer, and cleans am_state for the application of the
565 static void am_next(struct am_state
*state
)
567 unsigned char head
[GIT_SHA1_RAWSZ
];
569 free(state
->author_name
);
570 state
->author_name
= NULL
;
572 free(state
->author_email
);
573 state
->author_email
= NULL
;
575 free(state
->author_date
);
576 state
->author_date
= NULL
;
582 unlink(am_path(state
, "author-script"));
583 unlink(am_path(state
, "final-commit"));
585 if (!get_sha1("HEAD", head
))
586 write_file(am_path(state
, "abort-safety"), 1, "%s", sha1_to_hex(head
));
588 write_file(am_path(state
, "abort-safety"), 1, "%s", "");
591 write_file(am_path(state
, "next"), 1, "%d", state
->cur
);
595 * Returns the filename of the current patch email.
597 static const char *msgnum(const struct am_state
*state
)
599 static struct strbuf sb
= STRBUF_INIT
;
602 strbuf_addf(&sb
, "%0*d", state
->prec
, state
->cur
);
608 * Refresh and write index.
610 static void refresh_and_write_cache(void)
612 struct lock_file
*lock_file
= xcalloc(1, sizeof(struct lock_file
));
614 hold_locked_index(lock_file
, 1);
615 refresh_cache(REFRESH_QUIET
);
616 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
617 die(_("unable to write index file"));
621 * Returns 1 if the index differs from HEAD, 0 otherwise. When on an unborn
622 * branch, returns 1 if there are entries in the index, 0 otherwise. If an
623 * strbuf is provided, the space-separated list of files that differ will be
626 static int index_has_changes(struct strbuf
*sb
)
628 unsigned char head
[GIT_SHA1_RAWSZ
];
631 if (!get_sha1_tree("HEAD", head
)) {
632 struct diff_options opt
;
635 DIFF_OPT_SET(&opt
, EXIT_WITH_STATUS
);
637 DIFF_OPT_SET(&opt
, QUICK
);
638 do_diff_cache(head
, &opt
);
640 for (i
= 0; sb
&& i
< diff_queued_diff
.nr
; i
++) {
642 strbuf_addch(sb
, ' ');
643 strbuf_addstr(sb
, diff_queued_diff
.queue
[i
]->two
->path
);
646 return DIFF_OPT_TST(&opt
, HAS_CHANGES
) != 0;
648 for (i
= 0; sb
&& i
< active_nr
; i
++) {
650 strbuf_addch(sb
, ' ');
651 strbuf_addstr(sb
, active_cache
[i
]->name
);
658 * Dies with a user-friendly message on how to proceed after resolving the
659 * problem. This message can be overridden with state->resolvemsg.
661 static void NORETURN
die_user_resolve(const struct am_state
*state
)
663 if (state
->resolvemsg
) {
664 printf_ln("%s", state
->resolvemsg
);
666 const char *cmdline
= "git am";
668 printf_ln(_("When you have resolved this problem, run \"%s --continue\"."), cmdline
);
669 printf_ln(_("If you prefer to skip this patch, run \"%s --skip\" instead."), cmdline
);
670 printf_ln(_("To restore the original branch and stop patching, run \"%s --abort\"."), cmdline
);
677 * Parses `mail` using git-mailinfo, extracting its patch and authorship info.
678 * state->msg will be set to the patch message. state->author_name,
679 * state->author_email and state->author_date will be set to the patch author's
680 * name, email and date respectively. The patch body will be written to the
681 * state directory's "patch" file.
683 * Returns 1 if the patch should be skipped, 0 otherwise.
685 static int parse_mail(struct am_state
*state
, const char *mail
)
688 struct child_process cp
= CHILD_PROCESS_INIT
;
689 struct strbuf sb
= STRBUF_INIT
;
690 struct strbuf msg
= STRBUF_INIT
;
691 struct strbuf author_name
= STRBUF_INIT
;
692 struct strbuf author_date
= STRBUF_INIT
;
693 struct strbuf author_email
= STRBUF_INIT
;
697 cp
.in
= xopen(mail
, O_RDONLY
, 0);
698 cp
.out
= xopen(am_path(state
, "info"), O_WRONLY
| O_CREAT
, 0777);
700 argv_array_push(&cp
.args
, "mailinfo");
701 argv_array_push(&cp
.args
, am_path(state
, "msg"));
702 argv_array_push(&cp
.args
, am_path(state
, "patch"));
704 if (run_command(&cp
) < 0)
705 die("could not parse patch");
710 /* Extract message and author information */
711 fp
= xfopen(am_path(state
, "info"), "r");
712 while (!strbuf_getline(&sb
, fp
, '\n')) {
715 if (skip_prefix(sb
.buf
, "Subject: ", &x
)) {
717 strbuf_addch(&msg
, '\n');
718 strbuf_addstr(&msg
, x
);
719 } else if (skip_prefix(sb
.buf
, "Author: ", &x
))
720 strbuf_addstr(&author_name
, x
);
721 else if (skip_prefix(sb
.buf
, "Email: ", &x
))
722 strbuf_addstr(&author_email
, x
);
723 else if (skip_prefix(sb
.buf
, "Date: ", &x
))
724 strbuf_addstr(&author_date
, x
);
728 /* Skip pine's internal folder data */
729 if (!strcmp(author_name
.buf
, "Mail System Internal Data")) {
734 if (is_empty_file(am_path(state
, "patch"))) {
735 printf_ln(_("Patch is empty. Was it split wrong?"));
736 die_user_resolve(state
);
739 strbuf_addstr(&msg
, "\n\n");
740 if (strbuf_read_file(&msg
, am_path(state
, "msg"), 0) < 0)
741 die_errno(_("could not read '%s'"), am_path(state
, "msg"));
745 append_signoff(&msg
, 0, 0);
747 assert(!state
->author_name
);
748 state
->author_name
= strbuf_detach(&author_name
, NULL
);
750 assert(!state
->author_email
);
751 state
->author_email
= strbuf_detach(&author_email
, NULL
);
753 assert(!state
->author_date
);
754 state
->author_date
= strbuf_detach(&author_date
, NULL
);
757 state
->msg
= strbuf_detach(&msg
, &state
->msg_len
);
760 strbuf_release(&msg
);
761 strbuf_release(&author_date
);
762 strbuf_release(&author_email
);
763 strbuf_release(&author_name
);
769 * Applies current patch with git-apply. Returns 0 on success, -1 otherwise.
771 static int run_apply(const struct am_state
*state
)
773 struct child_process cp
= CHILD_PROCESS_INIT
;
777 argv_array_push(&cp
.args
, "apply");
778 argv_array_push(&cp
.args
, "--index");
779 argv_array_push(&cp
.args
, am_path(state
, "patch"));
781 if (run_command(&cp
))
784 /* Reload index as git-apply will have modified it. */
792 * Commits the current index with state->msg as the commit message and
793 * state->author_name, state->author_email and state->author_date as the author
796 static void do_commit(const struct am_state
*state
)
798 unsigned char tree
[GIT_SHA1_RAWSZ
], parent
[GIT_SHA1_RAWSZ
],
799 commit
[GIT_SHA1_RAWSZ
];
801 struct commit_list
*parents
= NULL
;
802 const char *reflog_msg
, *author
;
803 struct strbuf sb
= STRBUF_INIT
;
805 if (write_cache_as_tree(tree
, 0, NULL
))
806 die(_("git write-tree failed to write a tree"));
808 if (!get_sha1_commit("HEAD", parent
)) {
810 commit_list_insert(lookup_commit(parent
), &parents
);
813 say(state
, stderr
, _("applying to an empty history"));
816 author
= fmt_ident(state
->author_name
, state
->author_email
,
817 state
->author_date
, IDENT_STRICT
);
819 if (commit_tree(state
->msg
, state
->msg_len
, tree
, parents
, commit
,
821 die(_("failed to write commit object"));
823 reflog_msg
= getenv("GIT_REFLOG_ACTION");
827 strbuf_addf(&sb
, "%s: %.*s", reflog_msg
, linelen(state
->msg
),
830 update_ref(sb
.buf
, "HEAD", commit
, ptr
, 0, UPDATE_REFS_DIE_ON_ERR
);
836 * Validates the am_state for resuming -- the "msg" and authorship fields must
839 static void validate_resume_state(const struct am_state
*state
)
842 die(_("cannot resume: %s does not exist."),
843 am_path(state
, "final-commit"));
845 if (!state
->author_name
|| !state
->author_email
|| !state
->author_date
)
846 die(_("cannot resume: %s does not exist."),
847 am_path(state
, "author-script"));
851 * Applies all queued mail.
853 * If `resume` is true, we are "resuming". The "msg" and authorship fields, as
854 * well as the state directory's "patch" file is used as-is for applying the
855 * patch and committing it.
857 static void am_run(struct am_state
*state
, int resume
)
859 const char *argv_gc_auto
[] = {"gc", "--auto", NULL
};
860 struct strbuf sb
= STRBUF_INIT
;
862 unlink(am_path(state
, "dirtyindex"));
864 refresh_and_write_cache();
866 if (index_has_changes(&sb
)) {
867 write_file(am_path(state
, "dirtyindex"), 1, "t");
868 die(_("Dirty index: cannot apply patches (dirty: %s)"), sb
.buf
);
873 while (state
->cur
<= state
->last
) {
874 const char *mail
= am_path(state
, msgnum(state
));
876 if (!file_exists(mail
))
880 validate_resume_state(state
);
883 if (parse_mail(state
, mail
))
884 goto next
; /* mail should be skipped */
886 write_author_script(state
);
887 write_commit_msg(state
);
890 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
892 if (run_apply(state
) < 0) {
893 int advice_amworkdir
= 1;
895 printf_ln(_("Patch failed at %s %.*s"), msgnum(state
),
896 linelen(state
->msg
), state
->msg
);
898 git_config_get_bool("advice.amworkdir", &advice_amworkdir
);
900 if (advice_amworkdir
)
901 printf_ln(_("The copy of the patch that failed is found in: %s"),
902 am_path(state
, "patch"));
904 die_user_resolve(state
);
914 run_command_v_opt(argv_gc_auto
, RUN_GIT_CMD
);
918 * Resume the current am session after patch application failure. The user did
919 * all the hard work, and we do not have to do any patch application. Just
920 * trust and commit what the user has in the index and working tree.
922 static void am_resolve(struct am_state
*state
)
924 validate_resume_state(state
);
926 say(state
, stdout
, _("Applying: %.*s"), linelen(state
->msg
), state
->msg
);
928 if (!index_has_changes(NULL
)) {
929 printf_ln(_("No changes - did you forget to use 'git add'?\n"
930 "If there is nothing left to stage, chances are that something else\n"
931 "already introduced the same changes; you might want to skip this patch."));
932 die_user_resolve(state
);
935 if (unmerged_cache()) {
936 printf_ln(_("You still have unmerged paths in your index.\n"
937 "Did you forget to use 'git add'?"));
938 die_user_resolve(state
);
948 * Performs a checkout fast-forward from `head` to `remote`. If `reset` is
949 * true, any unmerged entries will be discarded. Returns 0 on success, -1 on
952 static int fast_forward_to(struct tree
*head
, struct tree
*remote
, int reset
)
954 struct lock_file
*lock_file
;
955 struct unpack_trees_options opts
;
956 struct tree_desc t
[2];
958 if (parse_tree(head
) || parse_tree(remote
))
961 lock_file
= xcalloc(1, sizeof(struct lock_file
));
962 hold_locked_index(lock_file
, 1);
964 refresh_cache(REFRESH_QUIET
);
966 memset(&opts
, 0, sizeof(opts
));
968 opts
.src_index
= &the_index
;
969 opts
.dst_index
= &the_index
;
973 opts
.fn
= twoway_merge
;
974 init_tree_desc(&t
[0], head
->buffer
, head
->size
);
975 init_tree_desc(&t
[1], remote
->buffer
, remote
->size
);
977 if (unpack_trees(2, t
, &opts
)) {
978 rollback_lock_file(lock_file
);
982 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
983 die(_("unable to write new index file"));
989 * Clean the index without touching entries that are not modified between
990 * `head` and `remote`.
992 static int clean_index(const unsigned char *head
, const unsigned char *remote
)
994 struct lock_file
*lock_file
;
995 struct tree
*head_tree
, *remote_tree
, *index_tree
;
996 unsigned char index
[GIT_SHA1_RAWSZ
];
997 struct pathspec pathspec
;
999 head_tree
= parse_tree_indirect(head
);
1001 return error(_("Could not parse object '%s'."), sha1_to_hex(head
));
1003 remote_tree
= parse_tree_indirect(remote
);
1005 return error(_("Could not parse object '%s'."), sha1_to_hex(remote
));
1007 read_cache_unmerged();
1009 if (fast_forward_to(head_tree
, head_tree
, 1))
1012 if (write_cache_as_tree(index
, 0, NULL
))
1015 index_tree
= parse_tree_indirect(index
);
1017 return error(_("Could not parse object '%s'."), sha1_to_hex(index
));
1019 if (fast_forward_to(index_tree
, remote_tree
, 0))
1022 memset(&pathspec
, 0, sizeof(pathspec
));
1024 lock_file
= xcalloc(1, sizeof(struct lock_file
));
1025 hold_locked_index(lock_file
, 1);
1027 if (read_tree(remote_tree
, 0, &pathspec
)) {
1028 rollback_lock_file(lock_file
);
1032 if (write_locked_index(&the_index
, lock_file
, COMMIT_LOCK
))
1033 die(_("unable to write new index file"));
1035 remove_branch_state();
1041 * Resume the current am session by skipping the current patch.
1043 static void am_skip(struct am_state
*state
)
1045 unsigned char head
[GIT_SHA1_RAWSZ
];
1047 if (get_sha1("HEAD", head
))
1048 hashcpy(head
, EMPTY_TREE_SHA1_BIN
);
1050 if (clean_index(head
, head
))
1051 die(_("failed to clean index"));
1058 * Returns true if it is safe to reset HEAD to the ORIG_HEAD, false otherwise.
1060 * It is not safe to reset HEAD when:
1061 * 1. git-am previously failed because the index was dirty.
1062 * 2. HEAD has moved since git-am previously failed.
1064 static int safe_to_abort(const struct am_state
*state
)
1066 struct strbuf sb
= STRBUF_INIT
;
1067 unsigned char abort_safety
[GIT_SHA1_RAWSZ
], head
[GIT_SHA1_RAWSZ
];
1069 if (file_exists(am_path(state
, "dirtyindex")))
1072 if (read_state_file(&sb
, state
, "abort-safety", 1) > 0) {
1073 if (get_sha1_hex(sb
.buf
, abort_safety
))
1074 die(_("could not parse %s"), am_path(state
, "abort_safety"));
1076 hashclr(abort_safety
);
1078 if (get_sha1("HEAD", head
))
1081 if (!hashcmp(head
, abort_safety
))
1084 error(_("You seem to have moved HEAD since the last 'am' failure.\n"
1085 "Not rewinding to ORIG_HEAD"));
1091 * Aborts the current am session if it is safe to do so.
1093 static void am_abort(struct am_state
*state
)
1095 unsigned char curr_head
[GIT_SHA1_RAWSZ
], orig_head
[GIT_SHA1_RAWSZ
];
1096 int has_curr_head
, has_orig_head
;
1099 if (!safe_to_abort(state
)) {
1104 curr_branch
= resolve_refdup("HEAD", 0, curr_head
, NULL
);
1105 has_curr_head
= !is_null_sha1(curr_head
);
1107 hashcpy(curr_head
, EMPTY_TREE_SHA1_BIN
);
1109 has_orig_head
= !get_sha1("ORIG_HEAD", orig_head
);
1111 hashcpy(orig_head
, EMPTY_TREE_SHA1_BIN
);
1113 clean_index(curr_head
, orig_head
);
1116 update_ref("am --abort", "HEAD", orig_head
,
1117 has_curr_head
? curr_head
: NULL
, 0,
1118 UPDATE_REFS_DIE_ON_ERR
);
1119 else if (curr_branch
)
1120 delete_ref(curr_branch
, NULL
, REF_NODEREF
);
1127 * parse_options() callback that validates and sets opt->value to the
1128 * PATCH_FORMAT_* enum value corresponding to `arg`.
1130 static int parse_opt_patchformat(const struct option
*opt
, const char *arg
, int unset
)
1132 int *opt_value
= opt
->value
;
1134 if (!strcmp(arg
, "mbox"))
1135 *opt_value
= PATCH_FORMAT_MBOX
;
1137 return error(_("Invalid value for --patch-format: %s"), arg
);
1149 int cmd_am(int argc
, const char **argv
, const char *prefix
)
1151 struct am_state state
;
1152 int patch_format
= PATCH_FORMAT_UNKNOWN
;
1153 enum resume_mode resume
= RESUME_FALSE
;
1155 const char * const usage
[] = {
1156 N_("git am [options] [(<mbox>|<Maildir>)...]"),
1157 N_("git am [options] (--continue | --skip | --abort)"),
1161 struct option options
[] = {
1162 OPT__QUIET(&state
.quiet
, N_("be quiet")),
1163 OPT_BOOL('s', "signoff", &state
.signoff
,
1164 N_("add a Signed-off-by line to the commit message")),
1165 OPT_CALLBACK(0, "patch-format", &patch_format
, N_("format"),
1166 N_("format the patch(es) are in"),
1167 parse_opt_patchformat
),
1168 OPT_STRING(0, "resolvemsg", &state
.resolvemsg
, NULL
,
1169 N_("override error message when patch failure occurs")),
1170 OPT_CMDMODE(0, "continue", &resume
,
1171 N_("continue applying patches after resolving a conflict"),
1173 OPT_CMDMODE('r', "resolved", &resume
,
1174 N_("synonyms for --continue"),
1176 OPT_CMDMODE(0, "skip", &resume
,
1177 N_("skip the current patch"),
1179 OPT_CMDMODE(0, "abort", &resume
,
1180 N_("restore the original branch and abort the patching operation."),
1186 * NEEDSWORK: Once all the features of git-am.sh have been
1187 * re-implemented in builtin/am.c, this preamble can be removed.
1189 if (!getenv("_GIT_USE_BUILTIN_AM")) {
1190 const char *path
= mkpath("%s/git-am", git_exec_path());
1192 if (sane_execvp(path
, (char **)argv
) < 0)
1193 die_errno("could not exec %s", path
);
1195 prefix
= setup_git_directory();
1196 trace_repo_setup(prefix
);
1200 git_config(git_default_config
, NULL
);
1202 am_state_init(&state
, git_path("rebase-apply"));
1204 argc
= parse_options(argc
, argv
, prefix
, options
, usage
, 0);
1206 if (read_index_preload(&the_index
, NULL
) < 0)
1207 die(_("failed to read the index"));
1209 if (am_in_progress(&state
)) {
1211 * Catch user error to feed us patches when there is a session
1214 * 1. mbox path(s) are provided on the command-line.
1215 * 2. stdin is not a tty: the user is trying to feed us a patch
1216 * from standard input. This is somewhat unreliable -- stdin
1217 * could be /dev/null for example and the caller did not
1218 * intend to feed us a patch but wanted to continue
1221 if (argc
|| (resume
== RESUME_FALSE
&& !isatty(0)))
1222 die(_("previous rebase directory %s still exists but mbox given."),
1225 if (resume
== RESUME_FALSE
)
1226 resume
= RESUME_APPLY
;
1230 struct argv_array paths
= ARGV_ARRAY_INIT
;
1234 die(_("Resolve operation not in progress, we are not resuming."));
1236 for (i
= 0; i
< argc
; i
++) {
1237 if (is_absolute_path(argv
[i
]) || !prefix
)
1238 argv_array_push(&paths
, argv
[i
]);
1240 argv_array_push(&paths
, mkpath("%s/%s", prefix
, argv
[i
]));
1243 am_setup(&state
, patch_format
, paths
.argv
);
1245 argv_array_clear(&paths
);
1255 case RESUME_RESOLVED
:
1265 die("BUG: invalid resume value");
1268 am_state_release(&state
);