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