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] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way]
  13          [--interactive] [--whitespace=<option>] [-C<n>] [-p<n>]
  14          <mbox>...
  15 'git-am' [--skip | --resolved]
  16
  17 DESCRIPTION
  18 -----------
  19 Splits mail messages in a mailbox into commit log message,
  20 authorship information and patches, and applies them to the
  21 current branch.
  22
  23 OPTIONS
  24 -------
  25 <mbox>...::
  26         The list of mailbox files to read patches from. If you do not
  27         supply this argument, reads from the standard input.
  28
  29 -s, --signoff::
  30         Add `Signed-off-by:` line to the commit message, using
  31         the committer identity of yourself.
  32
  33 -d=<dir>, --dotest=<dir>::
  34         Instead of `.dotest` directory, use <dir> as a working
  35         area to store extracted patches.
  36
  37 -k, --keep::
  38         Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
  39
  40 -u, --utf8::
  41         Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
  42         The proposed commit log message taken from the e-mail
  43         are re-coded into UTF-8 encoding (configuration variable
  44         `i18n.commitencoding` can be used to specify project's
  45         preferred encoding if it is not UTF-8).
  46 +
  47 This was optional in prior versions of git, but now it is the
  48 default.   You could use `--no-utf8` to override this.
  49
  50 --no-utf8::
  51         Pass `-n` flag to `git-mailinfo` (see
  52         gitlink:git-mailinfo[1]).
  53
  54 -b, --binary::
  55         Pass `--allow-binary-replacement` flag to `git-apply`
  56         (see gitlink:git-apply[1]).
  57
  58 -3, --3way::
  59         When the patch does not apply cleanly, fall back on
  60         3-way merge, if the patch records the identity of blobs
  61         it is supposed to apply to, and we have those blobs
  62         locally.
  63
  64 --skip::
  65         Skip the current patch.  This is only meaningful when
  66         restarting an aborted patch.
  67
  68 --whitespace=<option>::
  69         This flag is passed to the `git-apply` program that applies
  70         the patch.
  71
  72 -C<n>, -p<n>::
  73         These flags are passed to the `git-apply` program that applies
  74         the patch.
  75
  76 -i, --interactive::
  77         Run interactively, just like git-applymbox.
  78
  79 -r, --resolved::
  80         After a patch failure (e.g. attempting to apply
  81         conflicting patch), the user has applied it by hand and
  82         the index file stores the result of the application.
  83         Make a commit using the authorship and commit log
  84         extracted from the e-mail message and the current index
  85         file, and continue.
  86
  87 --resolvemsg=<msg>::
  88         When a patch failure occurs, <msg> will be printed
  89         to the screen before exiting.  This overrides the
  90         standard message informing you to use `--resolved`
  91         or `--skip` to handle the failure.  This is solely
  92         for internal use between `git-rebase` and `git-am`.
  93
  94 DISCUSSION
  95 ----------
  96
  97 The commit author name is taken from the "From: " line of the
  98 message, and commit author time is taken from the "Date: " line
  99 of the message.  The "Subject: " line is used as the title of
 100 the commit, after stripping common prefix "[PATCH <anything>]".
 101 It is supposed to describe what the commit is about concisely as
 102 a one line text.
 103
 104 The body of the message (iow, after a blank line that terminates
 105 RFC2822 headers) can begin with "Subject: " and "From: " lines
 106 that are different from those of the mail header, to override
 107 the values of these fields.
 108
 109 The commit message is formed by the title taken from the
 110 "Subject: ", a blank line and the body of the message up to
 111 where the patch begins.  Excess whitespaces at the end of the
 112 lines are automatically stripped.
 113
 114 The patch is expected to be inline, directly following the
 115 message.  Any line that is of form:
 116
 117 * three-dashes and end-of-line, or
 118 * a line that begins with "diff -", or
 119 * a line that begins with "Index: "
 120
 121 is taken as the beginning of a patch, and the commit log message
 122 is terminated before the first occurrence of such a line.
 123
 124 When initially invoking it, you give it names of the mailboxes
 125 to crunch.  Upon seeing the first patch that does not apply, it
 126 aborts in the middle, just like 'git-applymbox' does.  You can
 127 recover from this in one of two ways:
 128
 129 . skip the current one by re-running the command with '--skip'
 130   option.
 131
 132 . hand resolve the conflict in the working directory, and update
 133   the index file to bring it in a state that the patch should
 134   have produced.  Then run the command with '--resolved' option.
 135
 136 The command refuses to process new mailboxes while `.dotest`
 137 directory exists, so if you decide to start over from scratch,
 138 run `rm -f .dotest` before running the command with mailbox
 139 names.
 140
 141
 142 SEE ALSO
 143 --------
 144 gitlink:git-applymbox[1], gitlink:git-applypatch[1], gitlink:git-apply[1].
 145
 146
 147 Author
 148 ------
 149 Written by Junio C Hamano <junkio@cox.net>
 150
 151 Documentation
 152 --------------
 153 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
 154
 155 GIT
 156 ---
 157 Part of the gitlink:git[7] suite
 158