Documentation/git-am.txt

   1 git-am(1)
   2 =========
   3
   4 NAME
   5 ----
   6 git-am - Apply a series of patches from a mailbox
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8]
  13          [--3way] [--interactive] [--committer-date-is-author-date]
  14          [--ignore-date] [--ignore-space-change | --ignore-whitespace]
  15          [--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
  16          [--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
  17          [--[no-]scissors] [-S[<keyid>]] [--patch-format=<format>]
  18          [(<mbox> | <Maildir>)...]
  19 'git am' (--continue | --skip | --abort)
  20
  21 DESCRIPTION
  22 -----------
  23 Splits mail messages in a mailbox into commit log message,
  24 authorship information and patches, and applies them to the
  25 current branch.
  26
  27 OPTIONS
  28 -------
  29 (<mbox>|<Maildir>)...::
  30         The list of mailbox files to read patches from. If you do not
  31         supply this argument, the command reads from the standard input.
  32         If you supply directories, they will be treated as Maildirs.
  33
  34 -s::
  35 --signoff::
  36         Add a `Signed-off-by:` line to the commit message, using
  37         the committer identity of yourself.
  38
  39 -k::
  40 --keep::
  41         Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
  42
  43 --keep-non-patch::
  44         Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
  45
  46 --[no-]keep-cr::
  47         With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
  48         with the same option, to prevent it from stripping CR at the end of
  49         lines. `am.keepcr` configuration variable can be used to specify the
  50         default behaviour.  `--no-keep-cr` is useful to override `am.keepcr`.
  51
  52 -c::
  53 --scissors::
  54         Remove everything in body before a scissors line (see
  55         linkgit:git-mailinfo[1]).
  56
  57 --no-scissors::
  58         Ignore scissors lines (see linkgit:git-mailinfo[1]).
  59
  60 -m::
  61 --message-id::
  62         Pass the `-m` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]),
  63         so that the Message-ID header is added to the commit message.
  64         The `am.messageid` configuration variable can be used to specify
  65         the default behaviour.
  66
  67 --no-message-id::
  68         Do not add the Message-ID header to the commit message.
  69         `no-message-id` is useful to override `am.messageid`.
  70
  71 -q::
  72 --quiet::
  73         Be quiet. Only print error messages.
  74
  75 -u::
  76 --utf8::
  77         Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
  78         The proposed commit log message taken from the e-mail
  79         is re-coded into UTF-8 encoding (configuration variable
  80         `i18n.commitencoding` can be used to specify project's
  81         preferred encoding if it is not UTF-8).
  82 +
  83 This was optional in prior versions of git, but now it is the
  84 default.   You can use `--no-utf8` to override this.
  85
  86 --no-utf8::
  87         Pass `-n` flag to 'git mailinfo' (see
  88         linkgit:git-mailinfo[1]).
  89
  90 -3::
  91 --3way::
  92         When the patch does not apply cleanly, fall back on
  93         3-way merge if the patch records the identity of blobs
  94         it is supposed to apply to and we have those blobs
  95         available locally.
  96
  97 --ignore-date::
  98 --ignore-space-change::
  99 --ignore-whitespace::
 100 --whitespace=<option>::
 101 -C<n>::
 102 -p<n>::
 103 --directory=<dir>::
 104 --exclude=<path>::
 105 --include=<path>::
 106 --reject::
 107         These flags are passed to the 'git apply' (see linkgit:git-apply[1])
 108         program that applies
 109         the patch.
 110
 111 --patch-format::
 112         By default the command will try to detect the patch format
 113         automatically. This option allows the user to bypass the automatic
 114         detection and specify the patch format that the patch(es) should be
 115         interpreted as. Valid formats are mbox, stgit, stgit-series and hg.
 116
 117 -i::
 118 --interactive::
 119         Run interactively.
 120
 121 --committer-date-is-author-date::
 122         By default the command records the date from the e-mail
 123         message as the commit author date, and uses the time of
 124         commit creation as the committer date. This allows the
 125         user to lie about the committer date by using the same
 126         value as the author date.
 127
 128 --ignore-date::
 129         By default the command records the date from the e-mail
 130         message as the commit author date, and uses the time of
 131         commit creation as the committer date. This allows the
 132         user to lie about the author date by using the same
 133         value as the committer date.
 134
 135 --skip::
 136         Skip the current patch.  This is only meaningful when
 137         restarting an aborted patch.
 138
 139 -S[<keyid>]::
 140 --gpg-sign[=<keyid>]::
 141         GPG-sign commits.
 142
 143 --continue::
 144 -r::
 145 --resolved::
 146         After a patch failure (e.g. attempting to apply
 147         conflicting patch), the user has applied it by hand and
 148         the index file stores the result of the application.
 149         Make a commit using the authorship and commit log
 150         extracted from the e-mail message and the current index
 151         file, and continue.
 152
 153 --resolvemsg=<msg>::
 154         When a patch failure occurs, <msg> will be printed
 155         to the screen before exiting.  This overrides the
 156         standard message informing you to use `--continue`
 157         or `--skip` to handle the failure.  This is solely
 158         for internal use between 'git rebase' and 'git am'.
 159
 160 --abort::
 161         Restore the original branch and abort the patching operation.
 162
 163 DISCUSSION
 164 ----------
 165
 166 The commit author name is taken from the "From: " line of the
 167 message, and commit author date is taken from the "Date: " line
 168 of the message.  The "Subject: " line is used as the title of
 169 the commit, after stripping common prefix "[PATCH <anything>]".
 170 The "Subject: " line is supposed to concisely describe what the
 171 commit is about in one line of text.
 172
 173 "From: " and "Subject: " lines starting the body override the respective
 174 commit author name and title values taken from the headers.
 175
 176 The commit message is formed by the title taken from the
 177 "Subject: ", a blank line and the body of the message up to
 178 where the patch begins.  Excess whitespace at the end of each
 179 line is automatically stripped.
 180
 181 The patch is expected to be inline, directly following the
 182 message.  Any line that is of the form:
 183
 184 * three-dashes and end-of-line, or
 185 * a line that begins with "diff -", or
 186 * a line that begins with "Index: "
 187
 188 is taken as the beginning of a patch, and the commit log message
 189 is terminated before the first occurrence of such a line.
 190
 191 When initially invoking `git am`, you give it the names of the mailboxes
 192 to process.  Upon seeing the first patch that does not apply, it
 193 aborts in the middle.  You can recover from this in one of two ways:
 194
 195 . skip the current patch by re-running the command with the '--skip'
 196   option.
 197
 198 . hand resolve the conflict in the working directory, and update
 199   the index file to bring it into a state that the patch should
 200   have produced.  Then run the command with the '--continue' option.
 201
 202 The command refuses to process new mailboxes until the current
 203 operation is finished, so if you decide to start over from scratch,
 204 run `git am --abort` before running the command with mailbox
 205 names.
 206
 207 Before any patches are applied, ORIG_HEAD is set to the tip of the
 208 current branch.  This is useful if you have problems with multiple
 209 commits, like running 'git am' on the wrong branch or an error in the
 210 commits that is more easily fixed by changing the mailbox (e.g.
 211 errors in the "From:" lines).
 212
 213 HOOKS
 214 -----
 215 This command can run `applypatch-msg`, `pre-applypatch`,
 216 and `post-applypatch` hooks.  See linkgit:githooks[5] for more
 217 information.
 218
 219 SEE ALSO
 220 --------
 221 linkgit:git-apply[1].
 222
 223 GIT
 224 ---
 225 Part of the linkgit:git[1] suite