git-applymbox: Remove command
[git/git.git] / Documentation / git-am.txt
CommitLineData
42e2cba2 1git-am(1)
05625af3 2=========
42e2cba2
PB
3
4NAME
5----
c3f0baac 6git-am - Apply a series of patches from a mailbox
42e2cba2
PB
7
8
9SYNOPSIS
10--------
353ce815 11[verse]
870e0d61
FL
12'git-am' [--signoff] [--dotest=<dir>] [--keep] [--utf8 | --no-utf8]
13 [--3way] [--interactive] [--binary]
14 [--whitespace=<option>] [-C<n>] [-p<n>]
d63bd9a2
FP
15 <mbox>|<Maildir>...
16
087b6742 17'git-am' [--skip | --resolved]
42e2cba2
PB
18
19DESCRIPTION
20-----------
21Splits mail messages in a mailbox into commit log message,
22authorship information and patches, and applies them to the
23current branch.
24
baa720f5
JH
25OPTIONS
26-------
d63bd9a2 27<mbox>|<Maildir>...::
d4144612 28 The list of mailbox files to read patches from. If you do not
d63bd9a2
FP
29 supply this argument, reads from the standard input. If you supply
30 directories, they'll be treated as Maildirs.
d4144612 31
5c19f244 32-s, --signoff::
baa720f5
JH
33 Add `Signed-off-by:` line to the commit message, using
34 the committer identity of yourself.
42e2cba2 35
5c19f244 36-d=<dir>, --dotest=<dir>::
baa720f5
JH
37 Instead of `.dotest` directory, use <dir> as a working
38 area to store extracted patches.
42e2cba2 39
5c19f244 40-k, --keep::
d84029b6
JH
41 Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
42
5c19f244 43-u, --utf8::
d84029b6
JH
44 Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
45 The proposed commit log message taken from the e-mail
870e0d61 46 is re-coded into UTF-8 encoding (configuration variable
d84029b6
JH
47 `i18n.commitencoding` can be used to specify project's
48 preferred encoding if it is not UTF-8).
49+
50This was optional in prior versions of git, but now it is the
51default. You could use `--no-utf8` to override this.
52
53--no-utf8::
5c19f244 54 Pass `-n` flag to `git-mailinfo` (see
baa720f5
JH
55 gitlink:git-mailinfo[1]).
56
5c19f244 57-3, --3way::
baa720f5
JH
58 When the patch does not apply cleanly, fall back on
59 3-way merge, if the patch records the identity of blobs
60 it is supposed to apply to, and we have those blobs
870e0d61 61 available locally.
baa720f5 62
870e0d61
FL
63-b, --binary::
64 Pass `--allow-binary-replacement` flag to `git-apply`
65 (see gitlink:git-apply[1]).
baa720f5 66
8273c79a 67--whitespace=<option>::
870e0d61
FL
68 This flag is passed to the `git-apply` (see gitlink:git-apply[1])
69 program that applies
8273c79a
JH
70 the patch.
71
2092a1fe 72-C<n>, -p<n>::
870e0d61
FL
73 These flags are passed to the `git-apply` (see gitlink:git-apply[1])
74 program that applies
67dad687
MT
75 the patch.
76
5c19f244 77-i, --interactive::
870e0d61
FL
78 Run interactively.
79
80--skip::
81 Skip the current patch. This is only meaningful when
82 restarting an aborted patch.
baa720f5 83
5c19f244 84-r, --resolved::
087b6742
JH
85 After a patch failure (e.g. attempting to apply
86 conflicting patch), the user has applied it by hand and
87 the index file stores the result of the application.
88 Make a commit using the authorship and commit log
89 extracted from the e-mail message and the current index
90 file, and continue.
baa720f5 91
5c19f244
AR
92--resolvemsg=<msg>::
93 When a patch failure occurs, <msg> will be printed
94 to the screen before exiting. This overrides the
95 standard message informing you to use `--resolved`
96 or `--skip` to handle the failure. This is solely
97 for internal use between `git-rebase` and `git-am`.
98
baa720f5
JH
99DISCUSSION
100----------
101
2499857b
JH
102The commit author name is taken from the "From: " line of the
103message, and commit author time is taken from the "Date: " line
104of the message. The "Subject: " line is used as the title of
105the commit, after stripping common prefix "[PATCH <anything>]".
106It is supposed to describe what the commit is about concisely as
107a one line text.
108
109The body of the message (iow, after a blank line that terminates
110RFC2822 headers) can begin with "Subject: " and "From: " lines
111that are different from those of the mail header, to override
112the values of these fields.
113
114The commit message is formed by the title taken from the
115"Subject: ", a blank line and the body of the message up to
116where the patch begins. Excess whitespaces at the end of the
117lines are automatically stripped.
118
119The patch is expected to be inline, directly following the
120message. Any line that is of form:
121
122* three-dashes and end-of-line, or
123* a line that begins with "diff -", or
124* a line that begins with "Index: "
125
126is taken as the beginning of a patch, and the commit log message
127is terminated before the first occurrence of such a line.
128
baa720f5
JH
129When initially invoking it, you give it names of the mailboxes
130to crunch. Upon seeing the first patch that does not apply, it
d45cc6e2 131aborts in the middle,. You can recover from this in one of two ways:
baa720f5 132
870e0d61 133. skip the current patch by re-running the command with '--skip'
baa720f5
JH
134 option.
135
087b6742
JH
136. hand resolve the conflict in the working directory, and update
137 the index file to bring it in a state that the patch should
1e2ccd3a 138 have produced. Then run the command with '--resolved' option.
baa720f5
JH
139
140The command refuses to process new mailboxes while `.dotest`
141directory exists, so if you decide to start over from scratch,
142run `rm -f .dotest` before running the command with mailbox
143names.
42e2cba2
PB
144
145
146SEE ALSO
147--------
d45cc6e2 148gitlink:git-applypatch[1], gitlink:git-apply[1].
42e2cba2
PB
149
150
151Author
152------
153Written by Junio C Hamano <junkio@cox.net>
154
155Documentation
156--------------
157Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
158
42e2cba2
PB
159GIT
160---
161Part of the gitlink:git[7] suite
162