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