| blob | b604b5e23fd3ae9ce383654e7c1b9b87e16c54f6 |
1 '\" t
2 .\" Title: git-am
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 2024-09-30
6 .\" Manual: Git Manual
7 .\" Source: Git 2.47.0.rc0.18.ge9356ba3ea
8 .\" Language: English
9 .\"
10 .TH "GIT\-AM" "1" "2024-09-30" "Git 2\&.47\&.0\&.rc0\&.18\&.ge" "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=<action>] [\-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 | \-\-retry | \-\-show\-current\-patch[=(diff|raw)] | \-\-allow\-empty)
45 .fi
46 .SH "DESCRIPTION"
47 .sp
48 Splits mail messages in a mailbox into commit log messages, 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\&.
49 .SH "OPTIONS"
50 .PP
51 (<mbox>|<Maildir>)\&...\:
52 .RS 4
53 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\&.
54 .RE
55 .PP
56 \-s, \-\-signoff
57 .RS 4
58 Add a
59 \fBSigned\-off\-by\fR
60 trailer to the commit message, using the committer identity of yourself\&. See the signoff option in
61 \fBgit-commit\fR(1)
62 for more information\&.
63 .RE
64 .PP
65 \-k, \-\-keep
66 .RS 4
67 Pass
68 \fB\-k\fR
69 flag to
70 \fIgit mailinfo\fR
71 (see
72 \fBgit-mailinfo\fR(1))\&.
73 .RE
74 .PP
75 \-\-keep\-non\-patch
76 .RS 4
77 Pass
78 \fB\-b\fR
79 flag to
80 \fIgit mailinfo\fR
81 (see
82 \fBgit-mailinfo\fR(1))\&.
83 .RE
84 .PP
85 \-\-[no\-]keep\-cr
86 .RS 4
87 With
88 \fB\-\-keep\-cr\fR, call
89 \fIgit mailsplit\fR
90 (see
91 \fBgit-mailsplit\fR(1)) with the same option, to prevent it from stripping CR at the end of lines\&.
92 \fBam\&.keepcr\fR
93 configuration variable can be used to specify the default behaviour\&.
94 \fB\-\-no\-keep\-cr\fR
95 is useful to override
96 \fBam\&.keepcr\fR\&.
97 .RE
98 .PP
99 \-c, \-\-scissors
100 .RS 4
101 Remove everything in body before a scissors line (see
102 \fBgit-mailinfo\fR(1))\&. Can be activated by default using the
103 \fBmailinfo\&.scissors\fR
104 configuration variable\&.
105 .RE
106 .PP
107 \-\-no\-scissors
108 .RS 4
109 Ignore scissors lines (see
110 \fBgit-mailinfo\fR(1))\&.
111 .RE
112 .PP
113 \-\-quoted\-cr=<action>
114 .RS 4
115 This flag will be passed down to
116 \fIgit mailinfo\fR
117 (see
118 \fBgit-mailinfo\fR(1))\&.
119 .RE
120 .PP
121 \-\-empty=(drop|keep|stop)
122 .RS 4
123 How to handle an e\-mail message lacking a patch:
124 .PP
125 \fBdrop\fR
126 .RS 4
127 The e\-mail message will be skipped\&.
128 .RE
129 .PP
130 \fBkeep\fR
131 .RS 4
132 An empty commit will be created, with the contents of the e\-mail message as its log\&.
133 .RE
134 .PP
135 \fBstop\fR
136 .RS 4
137 The command will fail, stopping in the middle of the current
138 \fBam\fR
139 session\&. This is the default behavior\&.
140 .RE
141 .RE
142 .PP
143 \-m, \-\-message\-id
144 .RS 4
145 Pass the
146 \fB\-m\fR
147 flag to
148 \fIgit mailinfo\fR
149 (see
150 \fBgit-mailinfo\fR(1)), so that the Message\-ID header is added to the commit message\&. The
151 \fBam\&.messageid\fR
152 configuration variable can be used to specify the default behaviour\&.
153 .RE
154 .PP
155 \-\-no\-message\-id
156 .RS 4
157 Do not add the Message\-ID header to the commit message\&.
158 \fBno\-message\-id\fR
159 is useful to override
160 \fBam\&.messageid\fR\&.
161 .RE
162 .PP
163 \-q, \-\-quiet
164 .RS 4
165 Be quiet\&. Only print error messages\&.
166 .RE
167 .PP
168 \-u, \-\-utf8
169 .RS 4
170 Pass
171 \fB\-u\fR
172 flag to
173 \fIgit mailinfo\fR
174 (see
175 \fBgit-mailinfo\fR(1))\&. The proposed commit log message taken from the e\-mail is re\-coded into UTF\-8 encoding (configuration variable
176 \fBi18n\&.commitEncoding\fR
177 can be used to specify the project\(cqs preferred encoding if it is not UTF\-8)\&.
178 .sp
179 This was optional in prior versions of git, but now it is the default\&. You can use
180 \fB\-\-no\-utf8\fR
181 to override this\&.
182 .RE
183 .PP
184 \-\-no\-utf8
185 .RS 4
186 Pass
187 \fB\-n\fR
188 flag to
189 \fIgit mailinfo\fR
190 (see
191 \fBgit-mailinfo\fR(1))\&.
192 .RE
193 .PP
194 \-3, \-\-3way, \-\-no\-3way
195 .RS 4
196 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\&.
197 \fB\-\-no\-3way\fR
198 can be used to override am\&.threeWay configuration variable\&. For more information, see am\&.threeWay in
199 \fBgit-config\fR(1)\&.
200 .RE
201 .PP
202 \-\-rerere\-autoupdate, \-\-no\-rerere\-autoupdate
203 .RS 4
204 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\&.
205 \fB\-\-no\-rerere\-autoupdate\fR
206 is a good way to double\-check what
207 \fBrerere\fR
208 did and catch potential mismerges, before committing the result to the index with a separate
209 \fBgit add\fR\&.
210 .RE
211 .PP
212 \-\-ignore\-space\-change, \-\-ignore\-whitespace, \-\-whitespace=<action>, \-C<n>, \-p<n>, \-\-directory=<dir>, \-\-exclude=<path>, \-\-include=<path>, \-\-reject
213 .RS 4
214 These flags are passed to the
215 \fIgit apply\fR
216 (see
217 \fBgit-apply\fR(1)) program that applies the patch\&.
218 .sp
219 Valid <action> for the
220 \fB\-\-whitespace\fR
221 option are:
222 \fBnowarn\fR,
223 \fBwarn\fR,
224 \fBfix\fR,
225 \fBerror\fR, and
226 \fBerror\-all\fR\&.
227 .RE
228 .PP
229 \-\-patch\-format
230 .RS 4
231 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\&.
232 .RE
233 .PP
234 \-i, \-\-interactive
235 .RS 4
236 Run interactively\&.
237 .RE
238 .PP
239 \-n, \-\-no\-verify
240 .RS 4
241 By default, the pre\-applypatch and applypatch\-msg hooks are run\&. When any of
242 \fB\-\-no\-verify\fR
243 or
244 \fB\-n\fR
245 is given, these are bypassed\&. See also
246 \fBgithooks\fR(5)\&.
247 .RE
248 .PP
249 \-\-committer\-date\-is\-author\-date
250 .RS 4
251 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\&.
252 .RE
253 .PP
254 \-\-ignore\-date
255 .RS 4
256 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\&.
257 .RE
258 .PP
259 \-\-skip
260 .RS 4
261 Skip the current patch\&. This is only meaningful when restarting an aborted patch\&.
262 .RE
263 .PP
264 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
265 .RS 4
266 GPG\-sign commits\&. The
267 \fBkeyid\fR
268 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
269 \fB\-\-no\-gpg\-sign\fR
270 is useful to countermand both
271 \fBcommit\&.gpgSign\fR
272 configuration variable, and earlier
273 \fB\-\-gpg\-sign\fR\&.
274 .RE
275 .PP
276 \-\-continue, \-r, \-\-resolved
277 .RS 4
278 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\&.
279 .RE
280 .PP
281 \-\-resolvemsg=<msg>
282 .RS 4
283 When a patch failure occurs, <msg> will be printed to the screen before exiting\&. This overrides the standard message informing you to use
284 \fB\-\-continue\fR
285 or
286 \fB\-\-skip\fR
287 to handle the failure\&. This is solely for internal use between
288 \fIgit rebase\fR
289 and
290 \fIgit am\fR\&.
291 .RE
292 .PP
293 \-\-abort
294 .RS 4
295 Restore the original branch and abort the patching operation\&. Revert the contents of files involved in the am operation to their pre\-am state\&.
296 .RE
297 .PP
298 \-\-quit
299 .RS 4
300 Abort the patching operation but keep HEAD and the index untouched\&.
301 .RE
302 .PP
303 \-\-retry
304 .RS 4
305 Try to apply the last conflicting patch again\&. This is generally only useful for passing extra options to the retry attempt (e\&.g\&.,
306 \fB\-\-3way\fR), since otherwise you\(cqll just see the same failure again\&.
307 .RE
308 .PP
309 \-\-show\-current\-patch[=(diff|raw)]
310 .RS 4
311 Show the message at which
312 \fBgit am\fR
313 has stopped due to conflicts\&. If
314 \fBraw\fR
315 is specified, show the raw contents of the e\-mail message; if
316 \fBdiff\fR, show the diff portion only\&. Defaults to
317 \fBraw\fR\&.
318 .RE
319 .PP
320 \-\-allow\-empty
321 .RS 4
322 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\&.
323 .RE
324 .SH "DISCUSSION"
325 .sp
326 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\&.
327 .sp
328 "From: ", "Date: ", and "Subject: " lines starting the body override the respective commit author name and title values taken from the headers\&.
329 .sp
330 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\&.
331 .sp
332 The patch is expected to be inline, directly following the message\&. Any line that is of the form:
333 .sp
334 .RS 4
335 .ie n \{\
336 \h'-04'\(bu\h'+03'\c
337 .\}
338 .el \{\
339 .sp -1
340 .IP \(bu 2.3
341 .\}
342 three\-dashes and end\-of\-line, or
343 .RE
344 .sp
345 .RS 4
346 .ie n \{\
347 \h'-04'\(bu\h'+03'\c
348 .\}
349 .el \{\
350 .sp -1
351 .IP \(bu 2.3
352 .\}
353 a line that begins with "diff \-", or
354 .RE
355 .sp
356 .RS 4
357 .ie n \{\
358 \h'-04'\(bu\h'+03'\c
359 .\}
360 .el \{\
361 .sp -1
362 .IP \(bu 2.3
363 .\}
364 a line that begins with "Index: "
365 .RE
366 .sp
367 is taken as the beginning of a patch, and the commit log message is terminated before the first occurrence of such a line\&.
368 .sp
369 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:
370 .sp
371 .RS 4
372 .ie n \{\
373 \h'-04' 1.\h'+01'\c
374 .\}
375 .el \{\
376 .sp -1
377 .IP " 1." 4.2
378 .\}
379 skip the current patch by re\-running the command with the
380 \fB\-\-skip\fR
381 option\&.
382 .RE
383 .sp
384 .RS 4
385 .ie n \{\
386 \h'-04' 2.\h'+01'\c
387 .\}
388 .el \{\
389 .sp -1
390 .IP " 2." 4.2
391 .\}
392 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
393 \fB\-\-continue\fR
394 option\&.
395 .RE
396 .sp
397 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\&.
398 .sp
399 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)\&.
400 .SH "HOOKS"
401 .sp
402 This command can run \fBapplypatch\-msg\fR, \fBpre\-applypatch\fR, and \fBpost\-applypatch\fR hooks\&. See \fBgithooks\fR(5) for more information\&.
403 .SH "CONFIGURATION"
404 .sp
405 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:
406 .PP
407 am\&.keepcr
408 .RS 4
409 If true, git\-am will call git\-mailsplit for patches in mbox format with parameter
410 \fB\-\-keep\-cr\fR\&. In this case git\-mailsplit will not remove
411 \fB\er\fR
412 from lines ending with
413 \fB\er\en\fR\&. Can be overridden by giving
414 \fB\-\-no\-keep\-cr\fR
415 from the command line\&. See
416 \fBgit-am\fR(1),
417 \fBgit-mailsplit\fR(1)\&.
418 .RE
419 .PP
420 am\&.threeWay
421 .RS 4
422 By default,
423 \fBgit am\fR
424 will fail if the patch does not apply cleanly\&. When set to true, this setting tells
425 \fBgit am\fR
426 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
427 \fB\-\-3way\fR
428 option from the command line)\&. Defaults to
429 \fBfalse\fR\&. See
430 \fBgit-am\fR(1)\&.
431 .RE
432 .SH "SEE ALSO"
433 .sp
434 \fBgit-apply\fR(1), \fBgit-format-patch\fR(1)\&.
435 .SH "GIT"
436 .sp
437 Part of the \fBgit\fR(1) suite