Merge branch 'maint-1.6.1' into maint
[git/git.git] / 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] [--committer-date-is-author-date]
14 [--ignore-date]
15 [--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
16 [--reject]
17 [<mbox> | <Maildir>...]
18 'git am' (--skip | --resolved | --abort)
19
20 DESCRIPTION
21 -----------
22 Splits mail messages in a mailbox into commit log message,
23 authorship information and patches, and applies them to the
24 current branch.
25
26 OPTIONS
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 `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 -u::
43 --utf8::
44 Pass `-u` flag to 'git-mailinfo' (see linkgit:git-mailinfo[1]).
45 The proposed commit log message taken from the e-mail
46 is re-coded into UTF-8 encoding (configuration variable
47 `i18n.commitencoding` can be used to specify project's
48 preferred encoding if it is not UTF-8).
49 +
50 This was optional in prior versions of git, but now it is the
51 default. You can use `--no-utf8` to override this.
52
53 --no-utf8::
54 Pass `-n` flag to 'git-mailinfo' (see
55 linkgit:git-mailinfo[1]).
56
57 -3::
58 --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 available locally.
63
64 --whitespace=<option>::
65 -C<n>::
66 -p<n>::
67 --directory=<dir>::
68 --reject::
69 These flags are passed to the 'git-apply' (see linkgit:git-apply[1])
70 program that applies
71 the patch.
72
73 -i::
74 --interactive::
75 Run interactively.
76
77 --committer-date-is-author-date::
78 By default the command records the date from the e-mail
79 message as the commit author date, and uses the time of
80 commit creation as the committer date. This allows the
81 user to lie about the committer date by using the same
82 timestamp as the author date.
83
84 --ignore-date::
85 By default the command records the date from the e-mail
86 message as the commit author date, and uses the time of
87 commit creation as the committer date. This allows the
88 user to lie about author timestamp by using the same
89 timestamp as the committer date.
90
91 --skip::
92 Skip the current patch. This is only meaningful when
93 restarting an aborted patch.
94
95 -r::
96 --resolved::
97 After a patch failure (e.g. attempting to apply
98 conflicting patch), the user has applied it by hand and
99 the index file stores the result of the application.
100 Make a commit using the authorship and commit log
101 extracted from the e-mail message and the current index
102 file, and continue.
103
104 --resolvemsg=<msg>::
105 When a patch failure occurs, <msg> will be printed
106 to the screen before exiting. This overrides the
107 standard message informing you to use `--resolved`
108 or `--skip` to handle the failure. This is solely
109 for internal use between 'git-rebase' and 'git-am'.
110
111 --abort::
112 Restore the original branch and abort the patching operation.
113
114 DISCUSSION
115 ----------
116
117 The commit author name is taken from the "From: " line of the
118 message, and commit author time is taken from the "Date: " line
119 of the message. The "Subject: " line is used as the title of
120 the commit, after stripping common prefix "[PATCH <anything>]".
121 It is supposed to describe what the commit is about concisely as
122 a one line text.
123
124 The body of the message (the rest of the message after the blank line
125 that terminates the RFC2822 headers) can begin with "Subject: " and
126 "From: " lines that are different from those of the mail header,
127 to override the values of these fields.
128
129 The commit message is formed by the title taken from the
130 "Subject: ", a blank line and the body of the message up to
131 where the patch begins. Excess whitespace characters at the end of the
132 lines are automatically stripped.
133
134 The patch is expected to be inline, directly following the
135 message. Any line that is of the form:
136
137 * three-dashes and end-of-line, or
138 * a line that begins with "diff -", or
139 * a line that begins with "Index: "
140
141 is taken as the beginning of a patch, and the commit log message
142 is terminated before the first occurrence of such a line.
143
144 When initially invoking it, you give it the names of the mailboxes
145 to process. Upon seeing the first patch that does not apply, it
146 aborts in the middle. You can recover from this in one of two ways:
147
148 . skip the current patch by re-running the command with the '--skip'
149 option.
150
151 . hand resolve the conflict in the working directory, and update
152 the index file to bring it into a state that the patch should
153 have produced. Then run the command with the '--resolved' option.
154
155 The command refuses to process new mailboxes while the `.git/rebase-apply`
156 directory exists, so if you decide to start over from scratch,
157 run `rm -f -r .git/rebase-apply` before running the command with mailbox
158 names.
159
160 Before any patches are applied, ORIG_HEAD is set to the tip of the
161 current branch. This is useful if you have problems with multiple
162 commits, like running 'git am' on the wrong branch or an error in the
163 commits that is more easily fixed by changing the mailbox (e.g.
164 errors in the "From:" lines).
165
166
167 SEE ALSO
168 --------
169 linkgit:git-apply[1].
170
171
172 Author
173 ------
174 Written by Junio C Hamano <gitster@pobox.com>
175
176 Documentation
177 --------------
178 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
179
180 GIT
181 ---
182 Part of the linkgit:git[1] suite