| blob | 84cd4a2426850859be5c00627d8dd091b887650e |
1 '\" t
2 .\" Title: git-am
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2023-08-09
6 .\" Manual: Git Manual
7 .\" Source: Git 2.42.0.rc1
8 .\" Language: English
9 .\"
10 .TH "GIT\-AM" "1" "2023\-08\-09" "Git 2\&.42\&.0\&.rc1" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-am \- Apply a series of patches from a mailbox
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit am\fR [\-\-signoff] [\-\-keep] [\-\-[no\-]keep\-cr] [\-\-[no\-]utf8] [\-\-no\-verify]
36 [\-\-[no\-]3way] [\-\-interactive] [\-\-committer\-date\-is\-author\-date]
37 [\-\-ignore\-date] [\-\-ignore\-space\-change | \-\-ignore\-whitespace]
38 [\-\-whitespace=<option>] [\-C<n>] [\-p<n>] [\-\-directory=<dir>]
39 [\-\-exclude=<path>] [\-\-include=<path>] [\-\-reject] [\-q | \-\-quiet]
40 [\-\-[no\-]scissors] [\-S[<keyid>]] [\-\-patch\-format=<format>]
41 [\-\-quoted\-cr=<action>]
42 [\-\-empty=(stop|drop|keep)]
43 [(<mbox> | <Maildir>)\&...]
44 \fIgit am\fR (\-\-continue | \-\-skip | \-\-abort | \-\-quit | \-\-show\-current\-patch[=(diff|raw)] | \-\-allow\-empty)
45 .fi
46 .sp
47 .SH "DESCRIPTION"
48 .sp
49 Splits mail messages in a mailbox into commit log message, authorship information and patches, and applies them to the current branch\&. You could think of it as a reverse operation of \fBgit-format-patch\fR(1) run on a branch with a straight history without merges\&.
50 .SH "OPTIONS"
51 .PP
52 (<mbox>|<Maildir>)\&...
53 .RS 4
54 The list of mailbox files to read patches from\&. If you do not supply this argument, the command reads from the standard input\&. If you supply directories, they will be treated as Maildirs\&.
55 .RE
56 .PP
57 \-s, \-\-signoff
58 .RS 4
59 Add a
60 \fBSigned\-off\-by\fR
61 trailer to the commit message, using the committer identity of yourself\&. See the signoff option in
62 \fBgit-commit\fR(1)
63 for more information\&.
64 .RE
65 .PP
66 \-k, \-\-keep
67 .RS 4
68 Pass
69 \fB\-k\fR
70 flag to
71 \fIgit mailinfo\fR
72 (see
73 \fBgit-mailinfo\fR(1))\&.
74 .RE
75 .PP
76 \-\-keep\-non\-patch
77 .RS 4
78 Pass
79 \fB\-b\fR
80 flag to
81 \fIgit mailinfo\fR
82 (see
83 \fBgit-mailinfo\fR(1))\&.
84 .RE
85 .PP
86 \-\-[no\-]keep\-cr
87 .RS 4
88 With
89 \fB\-\-keep\-cr\fR, call
90 \fIgit mailsplit\fR
91 (see
92 \fBgit-mailsplit\fR(1)) with the same option, to prevent it from stripping CR at the end of lines\&.
93 \fBam\&.keepcr\fR
94 configuration variable can be used to specify the default behaviour\&.
95 \fB\-\-no\-keep\-cr\fR
96 is useful to override
97 \fBam\&.keepcr\fR\&.
98 .RE
99 .PP
100 \-c, \-\-scissors
101 .RS 4
102 Remove everything in body before a scissors line (see
103 \fBgit-mailinfo\fR(1))\&. Can be activated by default using the
104 \fBmailinfo\&.scissors\fR
105 configuration variable\&.
106 .RE
107 .PP
108 \-\-no\-scissors
109 .RS 4
110 Ignore scissors lines (see
111 \fBgit-mailinfo\fR(1))\&.
112 .RE
113 .PP
114 \-\-quoted\-cr=<action>
115 .RS 4
116 This flag will be passed down to
117 \fIgit mailinfo\fR
118 (see
119 \fBgit-mailinfo\fR(1))\&.
120 .RE
121 .PP
122 \-\-empty=(stop|drop|keep)
123 .RS 4
124 By default, or when the option is set to
125 \fIstop\fR, the command errors out on an input e\-mail message lacking a patch and stops into the middle of the current am session\&. When this option is set to
126 \fIdrop\fR, skip such an e\-mail message instead\&. When this option is set to
127 \fIkeep\fR, create an empty commit, recording the contents of the e\-mail message as its log\&.
128 .RE
129 .PP
130 \-m, \-\-message\-id
131 .RS 4
132 Pass the
133 \fB\-m\fR
134 flag to
135 \fIgit mailinfo\fR
136 (see
137 \fBgit-mailinfo\fR(1)), so that the Message\-ID header is added to the commit message\&. The
138 \fBam\&.messageid\fR
139 configuration variable can be used to specify the default behaviour\&.
140 .RE
141 .PP
142 \-\-no\-message\-id
143 .RS 4
144 Do not add the Message\-ID header to the commit message\&.
145 \fBno\-message\-id\fR
146 is useful to override
147 \fBam\&.messageid\fR\&.
148 .RE
149 .PP
150 \-q, \-\-quiet
151 .RS 4
152 Be quiet\&. Only print error messages\&.
153 .RE
154 .PP
155 \-u, \-\-utf8
156 .RS 4
157 Pass
158 \fB\-u\fR
159 flag to
160 \fIgit mailinfo\fR
161 (see
162 \fBgit-mailinfo\fR(1))\&. The proposed commit log message taken from the e\-mail is re\-coded into UTF\-8 encoding (configuration variable
163 \fBi18n\&.commitEncoding\fR
164 can be used to specify project\(cqs preferred encoding if it is not UTF\-8)\&.
165 .sp
166 This was optional in prior versions of git, but now it is the default\&. You can use
167 \fB\-\-no\-utf8\fR
168 to override this\&.
169 .RE
170 .PP
171 \-\-no\-utf8
172 .RS 4
173 Pass
174 \fB\-n\fR
175 flag to
176 \fIgit mailinfo\fR
177 (see
178 \fBgit-mailinfo\fR(1))\&.
179 .RE
180 .PP
181 \-3, \-\-3way, \-\-no\-3way
182 .RS 4
183 When the patch does not apply cleanly, fall back on 3\-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally\&.
184 \fB\-\-no\-3way\fR
185 can be used to override am\&.threeWay configuration variable\&. For more information, see am\&.threeWay in
186 \fBgit-config\fR(1)\&.
187 .RE
188 .PP
189 \-\-rerere\-autoupdate, \-\-no\-rerere\-autoupdate
190 .RS 4
191 After the rerere mechanism reuses a recorded resolution on the current conflict to update the files in the working tree, allow it to also update the index with the result of resolution\&.
192 \fB\-\-no\-rerere\-autoupdate\fR
193 is a good way to double\-check what
194 \fBrerere\fR
195 did and catch potential mismerges, before committing the result to the index with a separate
196 \fBgit add\fR\&.
197 .RE
198 .PP
199 \-\-ignore\-space\-change, \-\-ignore\-whitespace, \-\-whitespace=<option>, \-C<n>, \-p<n>, \-\-directory=<dir>, \-\-exclude=<path>, \-\-include=<path>, \-\-reject
200 .RS 4
201 These flags are passed to the
202 \fIgit apply\fR
203 (see
204 \fBgit-apply\fR(1)) program that applies the patch\&.
205 .RE
206 .PP
207 \-\-patch\-format
208 .RS 4
209 By default the command will try to detect the patch format automatically\&. This option allows the user to bypass the automatic detection and specify the patch format that the patch(es) should be interpreted as\&. Valid formats are mbox, mboxrd, stgit, stgit\-series and hg\&.
210 .RE
211 .PP
212 \-i, \-\-interactive
213 .RS 4
214 Run interactively\&.
215 .RE
216 .PP
217 \-n, \-\-no\-verify
218 .RS 4
219 By default, the pre\-applypatch and applypatch\-msg hooks are run\&. When any of
220 \fB\-\-no\-verify\fR
221 or
222 \fB\-n\fR
223 is given, these are bypassed\&. See also
224 \fBgithooks\fR(5)\&.
225 .RE
226 .PP
227 \-\-committer\-date\-is\-author\-date
228 .RS 4
229 By default the command records the date from the e\-mail message as the commit author date, and uses the time of commit creation as the committer date\&. This allows the user to lie about the committer date by using the same value as the author date\&.
230 .RE
231 .PP
232 \-\-ignore\-date
233 .RS 4
234 By default the command records the date from the e\-mail message as the commit author date, and uses the time of commit creation as the committer date\&. This allows the user to lie about the author date by using the same value as the committer date\&.
235 .RE
236 .PP
237 \-\-skip
238 .RS 4
239 Skip the current patch\&. This is only meaningful when restarting an aborted patch\&.
240 .RE
241 .PP
242 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
243 .RS 4
244 GPG\-sign commits\&. The
245 \fBkeyid\fR
246 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
247 \fB\-\-no\-gpg\-sign\fR
248 is useful to countermand both
249 \fBcommit\&.gpgSign\fR
250 configuration variable, and earlier
251 \fB\-\-gpg\-sign\fR\&.
252 .RE
253 .PP
254 \-\-continue, \-r, \-\-resolved
255 .RS 4
256 After a patch failure (e\&.g\&. attempting to apply conflicting patch), the user has applied it by hand and the index file stores the result of the application\&. Make a commit using the authorship and commit log extracted from the e\-mail message and the current index file, and continue\&.
257 .RE
258 .PP
259 \-\-resolvemsg=<msg>
260 .RS 4
261 When a patch failure occurs, <msg> will be printed to the screen before exiting\&. This overrides the standard message informing you to use
262 \fB\-\-continue\fR
263 or
264 \fB\-\-skip\fR
265 to handle the failure\&. This is solely for internal use between
266 \fIgit rebase\fR
267 and
268 \fIgit am\fR\&.
269 .RE
270 .PP
271 \-\-abort
272 .RS 4
273 Restore the original branch and abort the patching operation\&. Revert contents of files involved in the am operation to their pre\-am state\&.
274 .RE
275 .PP
276 \-\-quit
277 .RS 4
278 Abort the patching operation but keep HEAD and the index untouched\&.
279 .RE
280 .PP
281 \-\-show\-current\-patch[=(diff|raw)]
282 .RS 4
283 Show the message at which
284 \fBgit am\fR
285 has stopped due to conflicts\&. If
286 \fBraw\fR
287 is specified, show the raw contents of the e\-mail message; if
288 \fBdiff\fR, show the diff portion only\&. Defaults to
289 \fBraw\fR\&.
290 .RE
291 .PP
292 \-\-allow\-empty
293 .RS 4
294 After a patch failure on an input e\-mail message lacking a patch, create an empty commit with the contents of the e\-mail message as its log message\&.
295 .RE
296 .SH "DISCUSSION"
297 .sp
298 The commit author name is taken from the "From: " line of the message, and commit author date is taken from the "Date: " line of the message\&. The "Subject: " line is used as the title of the commit, after stripping common prefix "[PATCH <anything>]"\&. The "Subject: " line is supposed to concisely describe what the commit is about in one line of text\&.
299 .sp
300 "From: ", "Date: ", and "Subject: " lines starting the body override the respective commit author name and title values taken from the headers\&.
301 .sp
302 The commit message is formed by the title taken from the "Subject: ", a blank line and the body of the message up to where the patch begins\&. Excess whitespace at the end of each line is automatically stripped\&.
303 .sp
304 The patch is expected to be inline, directly following the message\&. Any line that is of the form:
305 .sp
306 .RS 4
307 .ie n \{\
308 \h'-04'\(bu\h'+03'\c
309 .\}
310 .el \{\
311 .sp -1
312 .IP \(bu 2.3
313 .\}
314 three\-dashes and end\-of\-line, or
315 .RE
316 .sp
317 .RS 4
318 .ie n \{\
319 \h'-04'\(bu\h'+03'\c
320 .\}
321 .el \{\
322 .sp -1
323 .IP \(bu 2.3
324 .\}
325 a line that begins with "diff \-", or
326 .RE
327 .sp
328 .RS 4
329 .ie n \{\
330 \h'-04'\(bu\h'+03'\c
331 .\}
332 .el \{\
333 .sp -1
334 .IP \(bu 2.3
335 .\}
336 a line that begins with "Index: "
337 .RE
338 .sp
339 is taken as the beginning of a patch, and the commit log message is terminated before the first occurrence of such a line\&.
340 .sp
341 When initially invoking \fBgit am\fR, you give it the names of the mailboxes to process\&. Upon seeing the first patch that does not apply, it aborts in the middle\&. You can recover from this in one of two ways:
342 .sp
343 .RS 4
344 .ie n \{\
345 \h'-04' 1.\h'+01'\c
346 .\}
347 .el \{\
348 .sp -1
349 .IP " 1." 4.2
350 .\}
351 skip the current patch by re\-running the command with the
352 \fB\-\-skip\fR
353 option\&.
354 .RE
355 .sp
356 .RS 4
357 .ie n \{\
358 \h'-04' 2.\h'+01'\c
359 .\}
360 .el \{\
361 .sp -1
362 .IP " 2." 4.2
363 .\}
364 hand resolve the conflict in the working directory, and update the index file to bring it into a state that the patch should have produced\&. Then run the command with the
365 \fB\-\-continue\fR
366 option\&.
367 .RE
368 .sp
369 The command refuses to process new mailboxes until the current operation is finished, so if you decide to start over from scratch, run \fBgit am \-\-abort\fR before running the command with mailbox names\&.
370 .sp
371 Before any patches are applied, ORIG_HEAD is set to the tip of the current branch\&. This is useful if you have problems with multiple commits, like running \fIgit am\fR on the wrong branch or an error in the commits that is more easily fixed by changing the mailbox (e\&.g\&. errors in the "From:" lines)\&.
372 .SH "HOOKS"
373 .sp
374 This command can run \fBapplypatch\-msg\fR, \fBpre\-applypatch\fR, and \fBpost\-applypatch\fR hooks\&. See \fBgithooks\fR(5) for more information\&.
375 .SH "CONFIGURATION"
376 .sp
377 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
378 .PP
379 am\&.keepcr
380 .RS 4
381 If true, git\-am will call git\-mailsplit for patches in mbox format with parameter
382 \fB\-\-keep\-cr\fR\&. In this case git\-mailsplit will not remove
383 \fB\er\fR
384 from lines ending with
385 \fB\er\en\fR\&. Can be overridden by giving
386 \fB\-\-no\-keep\-cr\fR
387 from the command line\&. See
388 \fBgit-am\fR(1),
389 \fBgit-mailsplit\fR(1)\&.
390 .RE
391 .PP
392 am\&.threeWay
393 .RS 4
394 By default,
395 \fBgit am\fR
396 will fail if the patch does not apply cleanly\&. When set to true, this setting tells
397 \fBgit am\fR
398 to fall back on 3\-way merge if the patch records the identity of blobs it is supposed to apply to and we have those blobs available locally (equivalent to giving the
399 \fB\-\-3way\fR
400 option from the command line)\&. Defaults to
401 \fBfalse\fR\&. See
402 \fBgit-am\fR(1)\&.
403 .RE
404 .SH "SEE ALSO"
405 .sp
406 \fBgit-apply\fR(1), \fBgit-format-patch\fR(1)\&.
407 .SH "GIT"
408 .sp
409 Part of the \fBgit\fR(1) suite