Merge git://git.kernel.org/pub/scm/gitk/gitk
[git/git.git] / Documentation / git-am.txt
1 git-am(1)
2 =========
3
4 NAME
5 ----
6 git-am - Apply a series of patches in a mailbox
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--binary] [--3way] <mbox>...
13 'git-am' [--skip | --resolved]
14
15 DESCRIPTION
16 -----------
17 Splits mail messages in a mailbox into commit log message,
18 authorship information and patches, and applies them to the
19 current branch.
20
21 OPTIONS
22 -------
23 --signoff::
24 Add `Signed-off-by:` line to the commit message, using
25 the committer identity of yourself.
26
27 --dotest=<dir>::
28 Instead of `.dotest` directory, use <dir> as a working
29 area to store extracted patches.
30
31 --utf8, --keep::
32 Pass `-u` and `-k` flags to `git-mailinfo` (see
33 gitlink:git-mailinfo[1]).
34
35 --binary::
36 Pass `--allow-binary-replacement` flag to `git-apply`
37 (see gitlink:git-apply[1]).
38
39 --3way::
40 When the patch does not apply cleanly, fall back on
41 3-way merge, if the patch records the identity of blobs
42 it is supposed to apply to, and we have those blobs
43 locally.
44
45 --skip::
46 Skip the current patch. This is only meaningful when
47 restarting an aborted patch.
48
49 --interactive::
50 Run interactively, just like git-applymbox.
51
52 --resolved::
53 After a patch failure (e.g. attempting to apply
54 conflicting patch), the user has applied it by hand and
55 the index file stores the result of the application.
56 Make a commit using the authorship and commit log
57 extracted from the e-mail message and the current index
58 file, and continue.
59
60 DISCUSSION
61 ----------
62
63 When initially invoking it, you give it names of the mailboxes
64 to crunch. Upon seeing the first patch that does not apply, it
65 aborts in the middle, just like 'git-applymbox' does. You can
66 recover from this in one of two ways:
67
68 . skip the current one by re-running the command with '--skip'
69 option.
70
71 . hand resolve the conflict in the working directory, and update
72 the index file to bring it in a state that the patch should
73 have produced. Then run the command with '--resolved' option.
74
75 The command refuses to process new mailboxes while `.dotest`
76 directory exists, so if you decide to start over from scratch,
77 run `rm -f .dotest` before running the command with mailbox
78 names.
79
80
81 SEE ALSO
82 --------
83 gitlink:git-applymbox[1], gitlink:git-applypatch[1].
84
85
86 Author
87 ------
88 Written by Junio C Hamano <junkio@cox.net>
89
90 Documentation
91 --------------
92 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
93
94 GIT
95 ---
96 Part of the gitlink:git[7] suite
97