| blob | 71ebb0faff1e3e2bf08fd73b454cb0986c23927c |
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: 11/24/2021
6 .\" Manual: Git Manual
7 .\" Source: Git 2.34.1.8.g35151cf072
8 .\" Language: English
9 .\"
10 .TH "GIT\-AM" "1" "11/24/2021" "Git 2\&.34\&.1\&.8\&.g35151cf0" "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]
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 [(<mbox> | <Maildir>)\&...]
43 \fIgit am\fR (\-\-continue | \-\-skip | \-\-abort | \-\-quit | \-\-show\-current\-patch[=(diff|raw)])
44 .fi
45 .sp
46 .SH "DESCRIPTION"
47 .sp
48 Splits mail messages in a mailbox into commit log message, authorship information and patches, and applies them to the current branch\&.
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 \-m, \-\-message\-id
122 .RS 4
123 Pass the
124 \fB\-m\fR
125 flag to
126 \fIgit mailinfo\fR
127 (see
128 \fBgit-mailinfo\fR(1)), so that the Message\-ID header is added to the commit message\&. The
129 \fBam\&.messageid\fR
130 configuration variable can be used to specify the default behaviour\&.
131 .RE
132 .PP
133 \-\-no\-message\-id
134 .RS 4
135 Do not add the Message\-ID header to the commit message\&.
136 \fBno\-message\-id\fR
137 is useful to override
138 \fBam\&.messageid\fR\&.
139 .RE
140 .PP
141 \-q, \-\-quiet
142 .RS 4
143 Be quiet\&. Only print error messages\&.
144 .RE
145 .PP
146 \-u, \-\-utf8
147 .RS 4
148 Pass
149 \fB\-u\fR
150 flag to
151 \fIgit mailinfo\fR
152 (see
153 \fBgit-mailinfo\fR(1))\&. The proposed commit log message taken from the e\-mail is re\-coded into UTF\-8 encoding (configuration variable
154 \fBi18n\&.commitEncoding\fR
155 can be used to specify project\(cqs preferred encoding if it is not UTF\-8)\&.
156 .sp
157 This was optional in prior versions of git, but now it is the default\&. You can use
158 \fB\-\-no\-utf8\fR
159 to override this\&.
160 .RE
161 .PP
162 \-\-no\-utf8
163 .RS 4
164 Pass
165 \fB\-n\fR
166 flag to
167 \fIgit mailinfo\fR
168 (see
169 \fBgit-mailinfo\fR(1))\&.
170 .RE
171 .PP
172 \-3, \-\-3way, \-\-no\-3way
173 .RS 4
174 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\&.
175 \fB\-\-no\-3way\fR
176 can be used to override am\&.threeWay configuration variable\&. For more information, see am\&.threeWay in
177 \fBgit-config\fR(1)\&.
178 .RE
179 .PP
180 \-\-rerere\-autoupdate, \-\-no\-rerere\-autoupdate
181 .RS 4
182 Allow the rerere mechanism to update the index with the result of auto\-conflict resolution if possible\&.
183 .RE
184 .PP
185 \-\-ignore\-space\-change, \-\-ignore\-whitespace, \-\-whitespace=<option>, \-C<n>, \-p<n>, \-\-directory=<dir>, \-\-exclude=<path>, \-\-include=<path>, \-\-reject
186 .RS 4
187 These flags are passed to the
188 \fIgit apply\fR
189 (see
190 \fBgit-apply\fR(1)) program that applies the patch\&.
191 .RE
192 .PP
193 \-\-patch\-format
194 .RS 4
195 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\&.
196 .RE
197 .PP
198 \-i, \-\-interactive
199 .RS 4
200 Run interactively\&.
201 .RE
202 .PP
203 \-\-committer\-date\-is\-author\-date
204 .RS 4
205 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\&.
206 .RE
207 .PP
208 \-\-ignore\-date
209 .RS 4
210 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\&.
211 .RE
212 .PP
213 \-\-skip
214 .RS 4
215 Skip the current patch\&. This is only meaningful when restarting an aborted patch\&.
216 .RE
217 .PP
218 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
219 .RS 4
220 GPG\-sign commits\&. The
221 \fBkeyid\fR
222 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
223 \fB\-\-no\-gpg\-sign\fR
224 is useful to countermand both
225 \fBcommit\&.gpgSign\fR
226 configuration variable, and earlier
227 \fB\-\-gpg\-sign\fR\&.
228 .RE
229 .PP
230 \-\-continue, \-r, \-\-resolved
231 .RS 4
232 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\&.
233 .RE
234 .PP
235 \-\-resolvemsg=<msg>
236 .RS 4
237 When a patch failure occurs, <msg> will be printed to the screen before exiting\&. This overrides the standard message informing you to use
238 \fB\-\-continue\fR
239 or
240 \fB\-\-skip\fR
241 to handle the failure\&. This is solely for internal use between
242 \fIgit rebase\fR
243 and
244 \fIgit am\fR\&.
245 .RE
246 .PP
247 \-\-abort
248 .RS 4
249 Restore the original branch and abort the patching operation\&. Revert contents of files involved in the am operation to their pre\-am state\&.
250 .RE
251 .PP
252 \-\-quit
253 .RS 4
254 Abort the patching operation but keep HEAD and the index untouched\&.
255 .RE
256 .PP
257 \-\-show\-current\-patch[=(diff|raw)]
258 .RS 4
259 Show the message at which
260 \fBgit am\fR
261 has stopped due to conflicts\&. If
262 \fBraw\fR
263 is specified, show the raw contents of the e\-mail message; if
264 \fBdiff\fR, show the diff portion only\&. Defaults to
265 \fBraw\fR\&.
266 .RE
267 .SH "DISCUSSION"
268 .sp
269 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\&.
270 .sp
271 "From: ", "Date: ", and "Subject: " lines starting the body override the respective commit author name and title values taken from the headers\&.
272 .sp
273 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\&.
274 .sp
275 The patch is expected to be inline, directly following the message\&. Any line that is of the form:
276 .sp
277 .RS 4
278 .ie n \{\
279 \h'-04'\(bu\h'+03'\c
280 .\}
281 .el \{\
282 .sp -1
283 .IP \(bu 2.3
284 .\}
285 three\-dashes and end\-of\-line, or
286 .RE
287 .sp
288 .RS 4
289 .ie n \{\
290 \h'-04'\(bu\h'+03'\c
291 .\}
292 .el \{\
293 .sp -1
294 .IP \(bu 2.3
295 .\}
296 a line that begins with "diff \-", or
297 .RE
298 .sp
299 .RS 4
300 .ie n \{\
301 \h'-04'\(bu\h'+03'\c
302 .\}
303 .el \{\
304 .sp -1
305 .IP \(bu 2.3
306 .\}
307 a line that begins with "Index: "
308 .RE
309 .sp
310 is taken as the beginning of a patch, and the commit log message is terminated before the first occurrence of such a line\&.
311 .sp
312 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:
313 .sp
314 .RS 4
315 .ie n \{\
316 \h'-04' 1.\h'+01'\c
317 .\}
318 .el \{\
319 .sp -1
320 .IP " 1." 4.2
321 .\}
322 skip the current patch by re\-running the command with the
323 \fB\-\-skip\fR
324 option\&.
325 .RE
326 .sp
327 .RS 4
328 .ie n \{\
329 \h'-04' 2.\h'+01'\c
330 .\}
331 .el \{\
332 .sp -1
333 .IP " 2." 4.2
334 .\}
335 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
336 \fB\-\-continue\fR
337 option\&.
338 .RE
339 .sp
340 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\&.
341 .sp
342 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)\&.
343 .SH "HOOKS"
344 .sp
345 This command can run \fBapplypatch\-msg\fR, \fBpre\-applypatch\fR, and \fBpost\-applypatch\fR hooks\&. See \fBgithooks\fR(5) for more information\&.
346 .SH "SEE ALSO"
347 .sp
348 \fBgit-apply\fR(1)\&.
349 .SH "GIT"
350 .sp
351 Part of the \fBgit\fR(1) suite