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