freshlybakedca.ke
Git fork
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] [--[no-]keep-cr] [--[no-]utf8] [--no-verify]
13 [--[no-]3way] [--interactive] [--committer-date-is-author-date]
14 [--ignore-date] [--ignore-space-change | --ignore-whitespace]
15 [--whitespace=<action>] [-C<n>] [-p<n>] [--directory=<dir>]
16 [--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
17 [--[no-]scissors] [-S[<keyid>]] [--patch-format=<format>]
18 [--quoted-cr=<action>]
19 [--empty=(stop|drop|keep)]
20 [(<mbox> | <Maildir>)...]
21'git am' (--continue | --skip | --abort | --quit | --retry | --show-current-patch[=(diff|raw)] | --allow-empty)
22
23DESCRIPTION
24-----------
25Splits mail messages in a mailbox into commit log messages,
26authorship information, and patches, and applies them to the
27current branch. You could think of it as a reverse operation
28of linkgit:git-format-patch[1] run on a branch with a straight
29history without merges.
30
31OPTIONS
32-------
33(<mbox>|<Maildir>)...::
34 The list of mailbox files to read patches from. If you do not
35 supply this argument, the command reads from the standard input.
36 If you supply directories, they will be treated as Maildirs.
37
38-s::
39--signoff::
40 Add a `Signed-off-by` trailer to the commit message, using
41 the committer identity of yourself.
42 See the signoff option in linkgit:git-commit[1] for more information.
43
44-k::
45--keep::
46 Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
47
48--keep-non-patch::
49 Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
50
51--keep-cr::
52--no-keep-cr::
53 With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
54 with the same option, to prevent it from stripping CR at the end of
55 lines. `am.keepcr` configuration variable can be used to specify the
56 default behaviour. `--no-keep-cr` is useful to override `am.keepcr`.
57
58-c::
59--scissors::
60 Remove everything in body before a scissors line (see
61 linkgit:git-mailinfo[1]). Can be activated by default using
62 the `mailinfo.scissors` configuration variable.
63
64--no-scissors::
65 Ignore scissors lines (see linkgit:git-mailinfo[1]).
66
67--quoted-cr=<action>::
68 This flag will be passed down to 'git mailinfo' (see linkgit:git-mailinfo[1]).
69
70--empty=(drop|keep|stop)::
71 How to handle an e-mail message lacking a patch:
72+
73--
74`drop`;;
75 The e-mail message will be skipped.
76`keep`;;
77 An empty commit will be created, with the contents of the e-mail
78 message as its log.
79`stop`;;
80 The command will fail, stopping in the middle of the current `am`
81 session. This is the default behavior.
82--
83
84-m::
85--message-id::
86 Pass the `-m` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]),
87 so that the Message-ID header is added to the commit message.
88 The `am.messageid` configuration variable can be used to specify
89 the default behaviour.
90
91--no-message-id::
92 Do not add the Message-ID header to the commit message.
93 `no-message-id` is useful to override `am.messageid`.
94
95-q::
96--quiet::
97 Be quiet. Only print error messages.
98
99-u::
100--utf8::
101 Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
102 The proposed commit log message taken from the e-mail
103 is re-coded into UTF-8 encoding (configuration variable
104 `i18n.commitEncoding` can be used to specify the project's
105 preferred encoding if it is not UTF-8).
106+
107This was optional in prior versions of git, but now it is the
108default. You can use `--no-utf8` to override this.
109
110--no-utf8::
111 Pass `-n` flag to 'git mailinfo' (see
112 linkgit:git-mailinfo[1]).
113
114-3::
115--3way::
116--no-3way::
117 When the patch does not apply cleanly, fall back on
118 3-way merge if the patch records the identity of blobs
119 it is supposed to apply to and we have those blobs
120 available locally. `--no-3way` can be used to override
121 am.threeWay configuration variable. For more information,
122 see am.threeWay in linkgit:git-config[1].
123
124include::rerere-options.adoc[]
125
126--ignore-space-change::
127--ignore-whitespace::
128--whitespace=<action>::
129-C<n>::
130-p<n>::
131--directory=<dir>::
132--exclude=<path>::
133--include=<path>::
134--reject::
135 These flags are passed to the 'git apply' (see linkgit:git-apply[1])
136 program that applies
137 the patch.
138+
139Valid <action> for the `--whitespace` option are:
140`nowarn`, `warn`, `fix`, `error`, and `error-all`.
141
142--patch-format::
143 By default the command will try to detect the patch format
144 automatically. This option allows the user to bypass the automatic
145 detection and specify the patch format that the patch(es) should be
146 interpreted as. Valid formats are mbox, mboxrd,
147 stgit, stgit-series, and hg.
148
149-i::
150--interactive::
151 Run interactively.
152
153-n::
154--no-verify::
155 By default, the pre-applypatch and applypatch-msg hooks are run.
156 When any of `--no-verify` or `-n` is given, these are bypassed.
157 See also linkgit:githooks[5].
158
159--committer-date-is-author-date::
160 By default the command records the date from the e-mail
161 message as the commit author date, and uses the time of
162 commit creation as the committer date. This allows the
163 user to lie about the committer date by using the same
164 value as the author date.
165
166--ignore-date::
167 By default the command records the date from the e-mail
168 message as the commit author date, and uses the time of
169 commit creation as the committer date. This allows the
170 user to lie about the author date by using the same
171 value as the committer date.
172
173--skip::
174 Skip the current patch. This is only meaningful when
175 restarting an aborted patch.
176
177-S[<keyid>]::
178--gpg-sign[=<keyid>]::
179--no-gpg-sign::
180 GPG-sign commits. The `keyid` argument is optional and
181 defaults to the committer identity; if specified, it must be
182 stuck to the option without a space. `--no-gpg-sign` is useful to
183 countermand both `commit.gpgSign` configuration variable, and
184 earlier `--gpg-sign`.
185
186--continue::
187-r::
188--resolved::
189 After a patch failure (e.g. attempting to apply
190 conflicting patch), the user has applied it by hand and
191 the index file stores the result of the application.
192 Make a commit using the authorship and commit log
193 extracted from the e-mail message and the current index
194 file, and continue.
195
196--resolvemsg=<msg>::
197 When a patch failure occurs, <msg> will be printed
198 to the screen before exiting. This overrides the
199 standard message informing you to use `--continue`
200 or `--skip` to handle the failure. This is solely
201 for internal use between 'git rebase' and 'git am'.
202
203--abort::
204 Restore the original branch and abort the patching operation.
205 Revert the contents of files involved in the am operation to their
206 pre-am state.
207
208--quit::
209 Abort the patching operation but keep HEAD and the index
210 untouched.
211
212--retry::
213 Try to apply the last conflicting patch again. This is generally
214 only useful for passing extra options to the retry attempt
215 (e.g., `--3way`), since otherwise you'll just see the same
216 failure again.
217
218--show-current-patch[=(diff|raw)]::
219 Show the message at which `git am` has stopped due to
220 conflicts. If `raw` is specified, show the raw contents of
221 the e-mail message; if `diff`, show the diff portion only.
222 Defaults to `raw`.
223
224--allow-empty::
225 After a patch failure on an input e-mail message lacking a patch,
226 create an empty commit with the contents of the e-mail message
227 as its log message.
228
229DISCUSSION
230----------
231
232The commit author name is taken from the "From: " line of the
233message, and commit author date is taken from the "Date: " line
234of the message. The "Subject: " line is used as the title of
235the commit, after stripping common prefix "[PATCH <anything>]".
236The "Subject: " line is supposed to concisely describe what the
237commit is about in one line of text.
238
239"From: ", "Date: ", and "Subject: " lines starting the body override the
240respective commit author name and title values taken from the headers.
241
242The commit message is formed by the title taken from the
243"Subject: ", a blank line and the body of the message up to
244where the patch begins. Excess whitespace at the end of each
245line is automatically stripped.
246
247The patch is expected to be inline, directly following the
248message. Any line that is of the form:
249
250* three-dashes and end-of-line, or
251* a line that begins with "diff -", or
252* a line that begins with "Index: "
253
254is taken as the beginning of a patch, and the commit log message
255is terminated before the first occurrence of such a line.
256
257When initially invoking `git am`, you give it the names of the mailboxes
258to process. Upon seeing the first patch that does not apply, it
259aborts in the middle. You can recover from this in one of two ways:
260
261. skip the current patch by re-running the command with the `--skip`
262 option.
263
264. hand resolve the conflict in the working directory, and update
265 the index file to bring it into a state that the patch should
266 have produced. Then run the command with the `--continue` option.
267
268The command refuses to process new mailboxes until the current
269operation is finished, so if you decide to start over from scratch,
270run `git am --abort` before running the command with mailbox
271names.
272
273Before any patches are applied, ORIG_HEAD is set to the tip of the
274current branch. This is useful if you have problems with multiple
275commits, like running 'git am' on the wrong branch or an error in the
276commits that is more easily fixed by changing the mailbox (e.g.
277errors in the "From:" lines).
278
279HOOKS
280-----
281This command can run `applypatch-msg`, `pre-applypatch`,
282and `post-applypatch` hooks. See linkgit:githooks[5] for more
283information.
284
285CONFIGURATION
286-------------
287
288include::includes/cmd-config-section-all.adoc[]
289
290include::config/am.adoc[]
291
292SEE ALSO
293--------
294linkgit:git-apply[1],
295linkgit:git-format-patch[1].
296
297GIT
298---
299Part of the linkgit:git[1] suite