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