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] [--binary]
  14          [--whitespace=<option>] [-C<n>] [-p<n>]
  15          [<mbox> | <Maildir>...]
  16 'git am' (--skip | --resolved | --abort)
  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>|<Maildir>...::
  27         The list of mailbox files to read patches from. If you do not
  28         supply this argument, reads from the standard input. If you supply
  29         directories, they'll be treated as Maildirs.
  30
  31 -s::
  32 --signoff::
  33         Add `Signed-off-by:` line to the commit message, using
  34         the committer identity of yourself.
  35
  36 -k::
  37 --keep::
  38         Pass `-k` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
  39
  40 -u::
  41 --utf8::
  42         Pass `-u` flag to 'git-mailinfo' (see linkgit: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         linkgit:git-mailinfo[1]).
  54
  55 -3::
  56 --3way::
  57         When the patch does not apply cleanly, fall back on
  58         3-way merge, if the patch records the identity of blobs
  59         it is supposed to apply to, and we have those blobs
  60         available locally.
  61
  62 -b::
  63 --binary::
  64         Pass `--allow-binary-replacement` flag to 'git-apply'
  65         (see linkgit:git-apply[1]).
  66
  67 --whitespace=<option>::
  68         This flag is passed to the 'git-apply' (see linkgit:git-apply[1])
  69         program that applies
  70         the patch.
  71
  72 -C<n>::
  73 -p<n>::
  74         These flags are passed to the 'git-apply' (see linkgit:git-apply[1])
  75         program that applies
  76         the patch.
  77
  78 -i::
  79 --interactive::
  80         Run interactively.
  81
  82 --skip::
  83         Skip the current patch.  This is only meaningful when
  84         restarting an aborted patch.
  85
  86 -r::
  87 --resolved::
  88         After a patch failure (e.g. attempting to apply
  89         conflicting patch), the user has applied it by hand and
  90         the index file stores the result of the application.
  91         Make a commit using the authorship and commit log
  92         extracted from the e-mail message and the current index
  93         file, and continue.
  94
  95 --resolvemsg=<msg>::
  96         When a patch failure occurs, <msg> will be printed
  97         to the screen before exiting.  This overrides the
  98         standard message informing you to use `--resolved`
  99         or `--skip` to handle the failure.  This is solely
 100         for internal use between 'git-rebase' and 'git-am'.
 101
 102 --abort::
 103         Restore the original branch and abort the patching operation.
 104
 105 DISCUSSION
 106 ----------
 107
 108 The commit author name is taken from the "From: " line of the
 109 message, and commit author time is taken from the "Date: " line
 110 of the message.  The "Subject: " line is used as the title of
 111 the commit, after stripping common prefix "[PATCH <anything>]".
 112 It is supposed to describe what the commit is about concisely as
 113 a one line text.
 114
 115 The body of the message (iow, after a blank line that terminates
 116 RFC2822 headers) can begin with "Subject: " and "From: " lines
 117 that are different from those of the mail header, to override
 118 the values of these fields.
 119
 120 The commit message is formed by the title taken from the
 121 "Subject: ", a blank line and the body of the message up to
 122 where the patch begins.  Excess whitespaces at the end of the
 123 lines are automatically stripped.
 124
 125 The patch is expected to be inline, directly following the
 126 message.  Any line that is of form:
 127
 128 * three-dashes and end-of-line, or
 129 * a line that begins with "diff -", or
 130 * a line that begins with "Index: "
 131
 132 is taken as the beginning of a patch, and the commit log message
 133 is terminated before the first occurrence of such a line.
 134
 135 When initially invoking it, you give it names of the mailboxes
 136 to crunch.  Upon seeing the first patch that does not apply, it
 137 aborts in the middle,.  You can recover from this in one of two ways:
 138
 139 . skip the current patch by re-running the command with '--skip'
 140   option.
 141
 142 . hand resolve the conflict in the working directory, and update
 143   the index file to bring it in a state that the patch should
 144   have produced.  Then run the command with '--resolved' option.
 145
 146 The command refuses to process new mailboxes while `.git/rebase-apply`
 147 directory exists, so if you decide to start over from scratch,
 148 run `rm -f -r .git/rebase-apply` before running the command with mailbox
 149 names.
 150
 151 Before any patches are applied, ORIG_HEAD is set to the tip of the
 152 current branch.  This is useful if you have problems with multiple
 153 commits, like running 'git am' on the wrong branch or an error in the
 154 commits that is more easily fixed by changing the mailbox (e.g.
 155 errors in the "From:" lines).
 156
 157
 158 SEE ALSO
 159 --------
 160 linkgit:git-apply[1].
 161
 162
 163 Author
 164 ------
 165 Written by Junio C Hamano <gitster@pobox.com>
 166
 167 Documentation
 168 --------------
 169 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
 170
 171 GIT
 172 ---
 173 Part of the linkgit:git[1] suite