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