Export some email and pretty-printing functions
[git/jnareb-git.git] / Documentation / git-am.txt
blob2ffba2102b1c2a7dbd093fed89a15b2e644aa398
1 git-am(1)
2 =========
4 NAME
5 ----
6 git-am - Apply a series of patches from a mailbox
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>|<Maildir>...
16 'git-am' [--skip | --resolved]
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.
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.
31 -s, --signoff::
32         Add `Signed-off-by:` line to the commit message, using
33         the committer identity of yourself.
35 -d=<dir>, --dotest=<dir>::
36         Instead of `.dotest` directory, use <dir> as a working
37         area to store extracted patches.
39 -k, --keep::
40         Pass `-k` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
42 -u, --utf8::
43         Pass `-u` flag to `git-mailinfo` (see linkgit:git-mailinfo[1]).
44         The proposed commit log message taken from the e-mail
45         is re-coded into UTF-8 encoding (configuration variable
46         `i18n.commitencoding` can be used to specify project's
47         preferred encoding if it is not UTF-8).
49 This was optional in prior versions of git, but now it is the
50 default.   You could use `--no-utf8` to override this.
52 --no-utf8::
53         Pass `-n` flag to `git-mailinfo` (see
54         linkgit:git-mailinfo[1]).
56 -3, --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.
62 -b, --binary::
63         Pass `--allow-binary-replacement` flag to `git-apply`
64         (see linkgit:git-apply[1]).
66 --whitespace=<option>::
67         This flag is passed to the `git-apply` (see linkgit:git-apply[1])
68         program that applies
69         the patch.
71 -C<n>, -p<n>::
72         These flags are passed to the `git-apply` (see linkgit:git-apply[1])
73         program that applies
74         the patch.
76 -i, --interactive::
77         Run interactively.
79 --skip::
80         Skip the current patch.  This is only meaningful when
81         restarting an aborted patch.
83 -r, --resolved::
84         After a patch failure (e.g. attempting to apply
85         conflicting patch), the user has applied it by hand and
86         the index file stores the result of the application.
87         Make a commit using the authorship and commit log
88         extracted from the e-mail message and the current index
89         file, and continue.
91 --resolvemsg=<msg>::
92         When a patch failure occurs, <msg> will be printed
93         to the screen before exiting.  This overrides the
94         standard message informing you to use `--resolved`
95         or `--skip` to handle the failure.  This is solely
96         for internal use between `git-rebase` and `git-am`.
98 DISCUSSION
99 ----------
101 The commit author name is taken from the "From: " line of the
102 message, and commit author time is taken from the "Date: " line
103 of the message.  The "Subject: " line is used as the title of
104 the commit, after stripping common prefix "[PATCH <anything>]".
105 It is supposed to describe what the commit is about concisely as
106 a one line text.
108 The body of the message (iow, after a blank line that terminates
109 RFC2822 headers) can begin with "Subject: " and "From: " lines
110 that are different from those of the mail header, to override
111 the values of these fields.
113 The commit message is formed by the title taken from the
114 "Subject: ", a blank line and the body of the message up to
115 where the patch begins.  Excess whitespaces at the end of the
116 lines are automatically stripped.
118 The patch is expected to be inline, directly following the
119 message.  Any line that is of form:
121 * three-dashes and end-of-line, or
122 * a line that begins with "diff -", or
123 * a line that begins with "Index: "
125 is taken as the beginning of a patch, and the commit log message
126 is terminated before the first occurrence of such a line.
128 When initially invoking it, you give it names of the mailboxes
129 to crunch.  Upon seeing the first patch that does not apply, it
130 aborts in the middle,.  You can recover from this in one of two ways:
132 . skip the current patch by re-running the command with '--skip'
133   option.
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.
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.
145 SEE ALSO
146 --------
147 linkgit:git-apply[1].
150 Author
151 ------
152 Written by Junio C Hamano <junkio@cox.net>
154 Documentation
155 --------------
156 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
160 Part of the linkgit:git[7] suite