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