oasis-root

git-am.1 (13492B)

'\" t
.\"     Title: git-am
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
.\"      Date: 2025-03-14
.\"    Manual: Git Manual
.\"    Source: Git 2.49.0
.\"  Language: English
.\"
.TH "GIT\-AM" "1" "2025-03-14" "Git 2\&.49\&.0" "Git Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
git-am \- Apply a series of patches from a mailbox
.SH "SYNOPSIS"
.sp
.nf
\fIgit am\fR [\-\-signoff] [\-\-keep] [\-\-[no\-]keep\-cr] [\-\-[no\-]utf8] [\-\-no\-verify]
         [\-\-[no\-]3way] [\-\-interactive] [\-\-committer\-date\-is\-author\-date]
         [\-\-ignore\-date] [\-\-ignore\-space\-change | \-\-ignore\-whitespace]
         [\-\-whitespace=<action>] [\-C<n>] [\-p<n>] [\-\-directory=<dir>]
         [\-\-exclude=<path>] [\-\-include=<path>] [\-\-reject] [\-q | \-\-quiet]
         [\-\-[no\-]scissors] [\-S[<keyid>]] [\-\-patch\-format=<format>]
         [\-\-quoted\-cr=<action>]
         [\-\-empty=(stop|drop|keep)]
         [(<mbox> | <Maildir>)\&...\:]
\fIgit am\fR (\-\-continue | \-\-skip | \-\-abort | \-\-quit | \-\-retry | \-\-show\-current\-patch[=(diff|raw)] | \-\-allow\-empty)
.fi
.SH "DESCRIPTION"
.sp
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\&.
.SH "OPTIONS"
.PP
(<mbox>|<Maildir>)\&...\:
.RS 4
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\&.
.RE
.PP
\-s, \-\-signoff
.RS 4
Add a
\fBSigned\-off\-by\fR
trailer to the commit message, using the committer identity of yourself\&. See the signoff option in
\fBgit-commit\fR(1)
for more information\&.
.RE
.PP
\-k, \-\-keep
.RS 4
Pass
\fB\-k\fR
flag to
\fIgit mailinfo\fR
(see
\fBgit-mailinfo\fR(1))\&.
.RE
.PP
\-\-keep\-non\-patch
.RS 4
Pass
\fB\-b\fR
flag to
\fIgit mailinfo\fR
(see
\fBgit-mailinfo\fR(1))\&.
.RE
.PP
\-\-[no\-]keep\-cr
.RS 4
With
\fB\-\-keep\-cr\fR, call
\fIgit mailsplit\fR
(see
\fBgit-mailsplit\fR(1)) with the same option, to prevent it from stripping CR at the end of lines\&.
\fBam\&.keepcr\fR
configuration variable can be used to specify the default behaviour\&.
\fB\-\-no\-keep\-cr\fR
is useful to override
\fBam\&.keepcr\fR\&.
.RE
.PP
\-c, \-\-scissors
.RS 4
Remove everything in body before a scissors line (see
\fBgit-mailinfo\fR(1))\&. Can be activated by default using the
\fBmailinfo\&.scissors\fR
configuration variable\&.
.RE
.PP
\-\-no\-scissors
.RS 4
Ignore scissors lines (see
\fBgit-mailinfo\fR(1))\&.
.RE
.PP
\-\-quoted\-cr=<action>
.RS 4
This flag will be passed down to
\fIgit mailinfo\fR
(see
\fBgit-mailinfo\fR(1))\&.
.RE
.PP
\-\-empty=(drop|keep|stop)
.RS 4
How to handle an e\-mail message lacking a patch:
.PP
\fBdrop\fR
.RS 4
The e\-mail message will be skipped\&.
.RE
.PP
\fBkeep\fR
.RS 4
An empty commit will be created, with the contents of the e\-mail message as its log\&.
.RE
.PP
\fBstop\fR
.RS 4
The command will fail, stopping in the middle of the current
\fBam\fR
session\&. This is the default behavior\&.
.RE
.RE
.PP
\-m, \-\-message\-id
.RS 4
Pass the
\fB\-m\fR
flag to
\fIgit mailinfo\fR
(see
\fBgit-mailinfo\fR(1)), so that the Message\-ID header is added to the commit message\&. The
\fBam\&.messageid\fR
configuration variable can be used to specify the default behaviour\&.
.RE
.PP
\-\-no\-message\-id
.RS 4
Do not add the Message\-ID header to the commit message\&.
\fBno\-message\-id\fR
is useful to override
\fBam\&.messageid\fR\&.
.RE
.PP
\-q, \-\-quiet
.RS 4
Be quiet\&. Only print error messages\&.
.RE
.PP
\-u, \-\-utf8
.RS 4
Pass
\fB\-u\fR
flag to
\fIgit mailinfo\fR
(see
\fBgit-mailinfo\fR(1))\&. The proposed commit log message taken from the e\-mail is re\-coded into UTF\-8 encoding (configuration variable
\fBi18n\&.commitEncoding\fR
can be used to specify the project\(cqs preferred encoding if it is not UTF\-8)\&.
.sp
This was optional in prior versions of git, but now it is the default\&. You can use
\fB\-\-no\-utf8\fR
to override this\&.
.RE
.PP
\-\-no\-utf8
.RS 4
Pass
\fB\-n\fR
flag to
\fIgit mailinfo\fR
(see
\fBgit-mailinfo\fR(1))\&.
.RE
.PP
\-3, \-\-3way, \-\-no\-3way
.RS 4
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\&.
\fB\-\-no\-3way\fR
can be used to override am\&.threeWay configuration variable\&. For more information, see am\&.threeWay in
\fBgit-config\fR(1)\&.
.RE
.PP
\-\-rerere\-autoupdate, \-\-no\-rerere\-autoupdate
.RS 4
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\&.
\fB\-\-no\-rerere\-autoupdate\fR
is a good way to double\-check what
\fBrerere\fR
did and catch potential mismerges, before committing the result to the index with a separate
\fBgit\fR
\fBadd\fR\&.
.RE
.PP
\-\-ignore\-space\-change, \-\-ignore\-whitespace, \-\-whitespace=<action>, \-C<n>, \-p<n>, \-\-directory=<dir>, \-\-exclude=<path>, \-\-include=<path>, \-\-reject
.RS 4
These flags are passed to the
\fIgit apply\fR
(see
\fBgit-apply\fR(1)) program that applies the patch\&.
.sp
Valid <action> for the
\fB\-\-whitespace\fR
option are:
\fBnowarn\fR,
\fBwarn\fR,
\fBfix\fR,
\fBerror\fR, and
\fBerror\-all\fR\&.
.RE
.PP
\-\-patch\-format
.RS 4
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\&.
.RE
.PP
\-i, \-\-interactive
.RS 4
Run interactively\&.
.RE
.PP
\-n, \-\-no\-verify
.RS 4
By default, the pre\-applypatch and applypatch\-msg hooks are run\&. When any of
\fB\-\-no\-verify\fR
or
\fB\-n\fR
is given, these are bypassed\&. See also
\fBgithooks\fR(5)\&.
.RE
.PP
\-\-committer\-date\-is\-author\-date
.RS 4
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\&.
.RE
.PP
\-\-ignore\-date
.RS 4
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\&.
.RE
.PP
\-\-skip
.RS 4
Skip the current patch\&. This is only meaningful when restarting an aborted patch\&.
.RE
.PP
\-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
.RS 4
GPG\-sign commits\&. The
\fBkeyid\fR
argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
\fB\-\-no\-gpg\-sign\fR
is useful to countermand both
\fBcommit\&.gpgSign\fR
configuration variable, and earlier
\fB\-\-gpg\-sign\fR\&.
.RE
.PP
\-\-continue, \-r, \-\-resolved
.RS 4
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\&.
.RE
.PP
\-\-resolvemsg=<msg>
.RS 4
When a patch failure occurs, <msg> will be printed to the screen before exiting\&. This overrides the standard message informing you to use
\fB\-\-continue\fR
or
\fB\-\-skip\fR
to handle the failure\&. This is solely for internal use between
\fIgit rebase\fR
and
\fIgit am\fR\&.
.RE
.PP
\-\-abort
.RS 4
Restore the original branch and abort the patching operation\&. Revert the contents of files involved in the am operation to their pre\-am state\&.
.RE
.PP
\-\-quit
.RS 4
Abort the patching operation but keep HEAD and the index untouched\&.
.RE
.PP
\-\-retry
.RS 4
Try to apply the last conflicting patch again\&. This is generally only useful for passing extra options to the retry attempt (e\&.g\&.,
\fB\-\-3way\fR), since otherwise you\(cqll just see the same failure again\&.
.RE
.PP
\-\-show\-current\-patch[=(diff|raw)]
.RS 4
Show the message at which
\fBgit\fR
\fBam\fR
has stopped due to conflicts\&. If
\fBraw\fR
is specified, show the raw contents of the e\-mail message; if
\fBdiff\fR, show the diff portion only\&. Defaults to
\fBraw\fR\&.
.RE
.PP
\-\-allow\-empty
.RS 4
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\&.
.RE
.SH "DISCUSSION"
.sp
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\&.
.sp
"From: ", "Date: ", and "Subject: " lines starting the body override the respective commit author name and title values taken from the headers\&.
.sp
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\&.
.sp
The patch is expected to be inline, directly following the message\&. Any line that is of the form:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
three\-dashes and end\-of\-line, or
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a line that begins with "diff \-", or
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
a line that begins with "Index: "
.RE
.sp
is taken as the beginning of a patch, and the commit log message is terminated before the first occurrence of such a line\&.
.sp
When initially invoking \fBgit\fR \fBam\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:
.sp
.RS 4
.ie n \{\
\h'-04' 1.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  1." 4.2
.\}
skip the current patch by re\-running the command with the
\fB\-\-skip\fR
option\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04' 2.\h'+01'\c
.\}
.el \{\
.sp -1
.IP "  2." 4.2
.\}
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
\fB\-\-continue\fR
option\&.
.RE
.sp
The command refuses to process new mailboxes until the current operation is finished, so if you decide to start over from scratch, run \fBgit\fR \fBam\fR \fB\-\-abort\fR before running the command with mailbox names\&.
.sp
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)\&.
.SH "HOOKS"
.sp
This command can run \fBapplypatch\-msg\fR, \fBpre\-applypatch\fR, and \fBpost\-applypatch\fR hooks\&. See \fBgithooks\fR(5) for more information\&.
.SH "CONFIGURATION"
.sp
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:
.PP
am\&.keepcr
.RS 4
If true, git\-am will call git\-mailsplit for patches in mbox format with parameter
\fB\-\-keep\-cr\fR\&. In this case git\-mailsplit will not remove \er from lines ending with \er\en\&. Can be overridden by giving
\fB\-\-no\-keep\-cr\fR
from the command line\&. See
\fBgit-am\fR(1),
\fBgit-mailsplit\fR(1)\&.
.RE
.PP
am\&.threeWay
.RS 4
By default,
\fBgit\fR
\fBam\fR
will fail if the patch does not apply cleanly\&. When set to true, this setting tells
\fBgit\fR
\fBam\fR
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
\fB\-\-3way\fR
option from the command line)\&. Defaults to
\fBfalse\fR\&. See
\fBgit-am\fR(1)\&.
.RE
.SH "SEE ALSO"
.sp
\fBgit-apply\fR(1), \fBgit-format-patch\fR(1)\&.
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite