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 Valid <action> for the `--whitespace` option are:
 133 `nowarn`, `warn`, `fix`, `error`, and `error-all`.
 134
 135 --patch-format::
 136         By default the command will try to detect the patch format
 137         automatically. This option allows the user to bypass the automatic
 138         detection and specify the patch format that the patch(es) should be
 139         interpreted as. Valid formats are mbox, mboxrd,
 140         stgit, stgit-series, and hg.
 141
 142 -i::
 143 --interactive::
 144         Run interactively.
 145
 146 -n::
 147 --no-verify::
 148         By default, the pre-applypatch and applypatch-msg hooks are run.
 149         When any of `--no-verify` or `-n` is given, these are bypassed.
 150         See also linkgit:githooks[5].
 151
 152 --committer-date-is-author-date::
 153         By default the command records the date from the e-mail
 154         message as the commit author date, and uses the time of
 155         commit creation as the committer date. This allows the
 156         user to lie about the committer date by using the same
 157         value as the author date.
 158
 159 --ignore-date::
 160         By default the command records the date from the e-mail
 161         message as the commit author date, and uses the time of
 162         commit creation as the committer date. This allows the
 163         user to lie about the author date by using the same
 164         value as the committer date.
 165
 166 --skip::
 167         Skip the current patch.  This is only meaningful when
 168         restarting an aborted patch.
 169
 170 -S[<keyid>]::
 171 --gpg-sign[=<keyid>]::
 172 --no-gpg-sign::
 173         GPG-sign commits. The `keyid` argument is optional and
 174         defaults to the committer identity; if specified, it must be
 175         stuck to the option without a space. `--no-gpg-sign` is useful to
 176         countermand both `commit.gpgSign` configuration variable, and
 177         earlier `--gpg-sign`.
 178
 179 --continue::
 180 -r::
 181 --resolved::
 182         After a patch failure (e.g. attempting to apply
 183         conflicting patch), the user has applied it by hand and
 184         the index file stores the result of the application.
 185         Make a commit using the authorship and commit log
 186         extracted from the e-mail message and the current index
 187         file, and continue.
 188
 189 --resolvemsg=<msg>::
 190         When a patch failure occurs, <msg> will be printed
 191         to the screen before exiting.  This overrides the
 192         standard message informing you to use `--continue`
 193         or `--skip` to handle the failure.  This is solely
 194         for internal use between 'git rebase' and 'git am'.
 195
 196 --abort::
 197         Restore the original branch and abort the patching operation.
 198         Revert the contents of files involved in the am operation to their
 199         pre-am state.
 200
 201 --quit::
 202         Abort the patching operation but keep HEAD and the index
 203         untouched.
 204
 205 --show-current-patch[=(diff|raw)]::
 206         Show the message at which `git am` has stopped due to
 207         conflicts.  If `raw` is specified, show the raw contents of
 208         the e-mail message; if `diff`, show the diff portion only.
 209         Defaults to `raw`.
 210
 211 --allow-empty::
 212         After a patch failure on an input e-mail message lacking a patch,
 213         create an empty commit with the contents of the e-mail message
 214         as its log message.
 215
 216 DISCUSSION
 217 ----------
 218
 219 The commit author name is taken from the "From: " line of the
 220 message, and commit author date is taken from the "Date: " line
 221 of the message.  The "Subject: " line is used as the title of
 222 the commit, after stripping common prefix "[PATCH <anything>]".
 223 The "Subject: " line is supposed to concisely describe what the
 224 commit is about in one line of text.
 225
 226 "From: ", "Date: ", and "Subject: " lines starting the body override the
 227 respective commit author name and title values taken from the headers.
 228
 229 The commit message is formed by the title taken from the
 230 "Subject: ", a blank line and the body of the message up to
 231 where the patch begins.  Excess whitespace at the end of each
 232 line is automatically stripped.
 233
 234 The patch is expected to be inline, directly following the
 235 message.  Any line that is of the form:
 236
 237 * three-dashes and end-of-line, or
 238 * a line that begins with "diff -", or
 239 * a line that begins with "Index: "
 240
 241 is taken as the beginning of a patch, and the commit log message
 242 is terminated before the first occurrence of such a line.
 243
 244 When initially invoking `git am`, you give it the names of the mailboxes
 245 to process.  Upon seeing the first patch that does not apply, it
 246 aborts in the middle.  You can recover from this in one of two ways:
 247
 248 . skip the current patch by re-running the command with the `--skip`
 249   option.
 250
 251 . hand resolve the conflict in the working directory, and update
 252   the index file to bring it into a state that the patch should
 253   have produced.  Then run the command with the `--continue` option.
 254
 255 The command refuses to process new mailboxes until the current
 256 operation is finished, so if you decide to start over from scratch,
 257 run `git am --abort` before running the command with mailbox
 258 names.
 259
 260 Before any patches are applied, ORIG_HEAD is set to the tip of the
 261 current branch.  This is useful if you have problems with multiple
 262 commits, like running 'git am' on the wrong branch or an error in the
 263 commits that is more easily fixed by changing the mailbox (e.g.
 264 errors in the "From:" lines).
 265
 266 HOOKS
 267 -----
 268 This command can run `applypatch-msg`, `pre-applypatch`,
 269 and `post-applypatch` hooks.  See linkgit:githooks[5] for more
 270 information.
 271
 272 CONFIGURATION
 273 -------------
 274
 275 include::includes/cmd-config-section-all.txt[]
 276
 277 include::config/am.txt[]
 278
 279 SEE ALSO
 280 --------
 281 linkgit:git-apply[1],
 282 linkgit:git-format-patch[1].
 283
 284 GIT
 285 ---
 286 Part of the linkgit:git[1] suite