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