man1/git-am.1

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