Documentation / git-am.txton commit Merge branch 'jk/grep-double-dash' (e7c2466)
   1git-am(1)
   2=========
   3
   4NAME
   5----
   6git-am - Apply a series of patches from a mailbox
   7
   8
   9SYNOPSIS
  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' (--continue | --skip | --abort)
  19
  20DESCRIPTION
  21-----------
  22Splits mail messages in a mailbox into commit log message,
  23authorship information and patches, and applies them to the
  24current branch.
  25
  26OPTIONS
  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+
  62This was optional in prior versions of git, but now it is the
  63default.   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--continue::
 111-r::
 112--resolved::
 113        After a patch failure (e.g. attempting to apply
 114        conflicting patch), the user has applied it by hand and
 115        the index file stores the result of the application.
 116        Make a commit using the authorship and commit log
 117        extracted from the e-mail message and the current index
 118        file, and continue.
 119
 120--resolvemsg=<msg>::
 121        When a patch failure occurs, <msg> will be printed
 122        to the screen before exiting.  This overrides the
 123        standard message informing you to use `--resolved`
 124        or `--skip` to handle the failure.  This is solely
 125        for internal use between 'git rebase' and 'git am'.
 126
 127--abort::
 128        Restore the original branch and abort the patching operation.
 129
 130DISCUSSION
 131----------
 132
 133The commit author name is taken from the "From: " line of the
 134message, and commit author date is taken from the "Date: " line
 135of the message.  The "Subject: " line is used as the title of
 136the commit, after stripping common prefix "[PATCH <anything>]".
 137The "Subject: " line is supposed to concisely describe what the
 138commit is about in one line of text.
 139
 140"From: " and "Subject: " lines starting the body override the respective
 141commit author name and title values taken from the headers.
 142
 143The commit message is formed by the title taken from the
 144"Subject: ", a blank line and the body of the message up to
 145where the patch begins.  Excess whitespace at the end of each
 146line is automatically stripped.
 147
 148The patch is expected to be inline, directly following the
 149message.  Any line that is of the form:
 150
 151* three-dashes and end-of-line, or
 152* a line that begins with "diff -", or
 153* a line that begins with "Index: "
 154
 155is taken as the beginning of a patch, and the commit log message
 156is terminated before the first occurrence of such a line.
 157
 158When initially invoking `git am`, you give it the names of the mailboxes
 159to process.  Upon seeing the first patch that does not apply, it
 160aborts in the middle.  You can recover from this in one of two ways:
 161
 162. skip the current patch by re-running the command with the '--skip'
 163  option.
 164
 165. hand resolve the conflict in the working directory, and update
 166  the index file to bring it into a state that the patch should
 167  have produced.  Then run the command with the '--resolved' option.
 168
 169The command refuses to process new mailboxes while the `.git/rebase-apply`
 170directory exists, so if you decide to start over from scratch,
 171run `rm -f -r .git/rebase-apply` before running the command with mailbox
 172names.
 173
 174Before any patches are applied, ORIG_HEAD is set to the tip of the
 175current branch.  This is useful if you have problems with multiple
 176commits, like running 'git am' on the wrong branch or an error in the
 177commits that is more easily fixed by changing the mailbox (e.g.
 178errors in the "From:" lines).
 179
 180
 181SEE ALSO
 182--------
 183linkgit:git-apply[1].
 184
 185
 186Author
 187------
 188Written by Junio C Hamano <gitster@pobox.com>
 189
 190Documentation
 191--------------
 192Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
 193
 194GIT
 195---
 196Part of the linkgit:git[1] suite