git --help COMMAND brings up the git-COMMAND man-page.
[git/mingw.git] / Documentation / git-am.txt
blobe4df4a46ec0461e32865732a33057b284159f001
1 git-am(1)
2 =========
4 NAME
5 ----
6 git-am - Apply a series of patches in a mailbox
9 SYNOPSIS
10 --------
11 'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--3way] <mbox>...
12 'git-am' [--skip]
14 DESCRIPTION
15 -----------
16 Splits mail messages in a mailbox into commit log message,
17 authorship information and patches, and applies them to the
18 current branch.
20 OPTIONS
21 -------
22 --signoff::
23         Add `Signed-off-by:` line to the commit message, using
24         the committer identity of yourself.
26 --dotest=<dir>::
27         Instead of `.dotest` directory, use <dir> as a working
28         area to store extracted patches.
30 --utf8, --keep::
31         Pass `--utf8` and `--keep` flags to `git-mailinfo` (see
32         gitlink:git-mailinfo[1]).
34 --3way::
35         When the patch does not apply cleanly, fall back on
36         3-way merge, if the patch records the identity of blobs
37         it is supposed to apply to, and we have those blobs
38         locally.
40 --skip::
41         Skip the current patch.  This is only meaningful when
42         restarting an aborted patch.
44 --interactive::
45         Run interactively, just like git-applymbox.
48 DISCUSSION
49 ----------
51 When initially invoking it, you give it names of the mailboxes
52 to crunch.  Upon seeing the first patch that does not apply, it
53 aborts in the middle, just like 'git-applymbox' does.  You can
54 recover from this in one of two ways:
56 . skip the current one by re-running the command with '--skip'
57   option.
59 . hand resolve the conflict in the working directory, run 'git
60   diff HEAD' to extract the merge result into a patch form and
61   replacing the patch in .dotest/patch file.  After doing this,
62   run `git-reset --hard HEAD` to bring the working tree to the
63   state before half-applying the patch, then re-run the command
64   without any options.
66 The command refuses to process new mailboxes while `.dotest`
67 directory exists, so if you decide to start over from scratch,
68 run `rm -f .dotest` before running the command with mailbox
69 names.
72 SEE ALSO
73 --------
74 gitlink:git-applymbox[1], gitlink:git-applypatch[1].
77 Author
78 ------
79 Written by Junio C Hamano <junkio@cox.net>
81 Documentation
82 --------------
83 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
85 GIT
86 ---
87 Part of the gitlink:git[7] suite