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