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