git-am(1)

—

NAME

git-am - Apply a series of patches from a mailbox

SYNOPSIS

bash

git am\n [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8] [--no-verify]
\n
         [--[no-]3way] [--interactive] [--committer-date-is-author-date]
\n
         [--ignore-date] [--ignore-space-change | --ignore-whitespace]
\n
         [--whitespace=<action>] [-C<n>] [-p<n>] [--directory=<dir>]
\n
         [--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
\n
         [--[no-]scissors] [-S[<keyid>]] [--patch-format=<format>]
\n
         [--quoted-cr=<action>]
\n
         [--empty=(stop|drop|keep)]
\n
         [(<mbox> | <Maildir>)...]
\ngit am\n (--continue | --skip | --abort | --quit | --retry | --show-current-patch[=(diff|raw)] | --allow-empty)

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 git-format-patch(1) run on a branch with a straight history without merges.

OPTIONS

(<mbox>|<Maildir>)...

-s, --signoff

-k, --keep

--keep-non-patch

--[no-]keep-cr

-c, --scissors

--no-scissors

--quoted-cr=<action>

--empty=(drop|keep|stop)

drop

keep

stop

-m, --message-id

--no-message-id

-q, --quiet

-u, --utf8

This was optional in prior versions of git, but now it is the default. You can use --no-utf8 to override this.

--no-utf8

-3, --3way, --no-3way

--rerere-autoupdate, --no-rerere-autoupdate

--ignore-space-change, --ignore-whitespace, --whitespace=<action>, -C<n>, -p<n>, --directory=<dir>, --exclude=<path>, --include=<path>, --reject

Valid <action> for the --whitespace option are: nowarn, warn, fix, error, and error-all.

--patch-format

-i, --interactive

-n, --no-verify

--committer-date-is-author-date

--ignore-date

--skip

-S[<keyid>], --gpg-sign[=<keyid>], --no-gpg-sign

--continue, -r, --resolved

--resolvemsg=<msg>

--abort

--quit

--retry

--show-current-patch[=(diff|raw)]

--allow-empty

DISCUSSION

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.

"From: ", "Date: ", and "Subject: " lines starting the body override the respective commit author name and title values taken from the headers.

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.

The patch is expected to be inline, directly following the message. Any line that is of the form:

is taken as the beginning of a patch, and the commit log message is terminated before the first occurrence of such a line.

When initially invoking git am, 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:

The command refuses to process new mailboxes until the current operation is finished, so if you decide to start over from scratch, run git am --abort before running the command with mailbox names.

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 git am 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).

HOOKS

This command can run applypatch-msg, pre-applypatch, and post-applypatch hooks. See githooks(5) for more information.

CONFIGURATION

Everything below this line in this section is selectively included from the git-config(1) documentation. The content is the same as what’s found there:

am.keepcr

am.threeWay

GIT

Part of the git(1) suite