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