git-applymbox: Remove command
[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] [--dotest=<dir>] [--keep] [--utf8 | --no-utf8]
13 [--3way] [--interactive] [--binary]
14 [--whitespace=<option>] [-C<n>] [-p<n>]
15 <mbox>|<Maildir>...
16
17 'git-am' [--skip | --resolved]
18
19 DESCRIPTION
20 -----------
21 Splits mail messages in a mailbox into commit log message,
22 authorship information and patches, and applies them to the
23 current branch.
24
25 OPTIONS
26 -------
27 <mbox>|<Maildir>...::
28 The list of mailbox files to read patches from. If you do not
29 supply this argument, reads from the standard input. If you supply
30 directories, they'll be treated as Maildirs.
31
32 -s, --signoff::
33 Add `Signed-off-by:` line to the commit message, using
34 the committer identity of yourself.
35
36 -d=<dir>, --dotest=<dir>::
37 Instead of `.dotest` directory, use <dir> as a working
38 area to store extracted patches.
39
40 -k, --keep::
41 Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
42
43 -u, --utf8::
44 Pass `-u` flag to `git-mailinfo` (see gitlink: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 could use `--no-utf8` to override this.
52
53 --no-utf8::
54 Pass `-n` flag to `git-mailinfo` (see
55 gitlink:git-mailinfo[1]).
56
57 -3, --3way::
58 When the patch does not apply cleanly, fall back on
59 3-way merge, if the patch records the identity of blobs
60 it is supposed to apply to, and we have those blobs
61 available locally.
62
63 -b, --binary::
64 Pass `--allow-binary-replacement` flag to `git-apply`
65 (see gitlink:git-apply[1]).
66
67 --whitespace=<option>::
68 This flag is passed to the `git-apply` (see gitlink:git-apply[1])
69 program that applies
70 the patch.
71
72 -C<n>, -p<n>::
73 These flags are passed to the `git-apply` (see gitlink:git-apply[1])
74 program that applies
75 the patch.
76
77 -i, --interactive::
78 Run interactively.
79
80 --skip::
81 Skip the current patch. This is only meaningful when
82 restarting an aborted patch.
83
84 -r, --resolved::
85 After a patch failure (e.g. attempting to apply
86 conflicting patch), the user has applied it by hand and
87 the index file stores the result of the application.
88 Make a commit using the authorship and commit log
89 extracted from the e-mail message and the current index
90 file, and continue.
91
92 --resolvemsg=<msg>::
93 When a patch failure occurs, <msg> will be printed
94 to the screen before exiting. This overrides the
95 standard message informing you to use `--resolved`
96 or `--skip` to handle the failure. This is solely
97 for internal use between `git-rebase` and `git-am`.
98
99 DISCUSSION
100 ----------
101
102 The commit author name is taken from the "From: " line of the
103 message, and commit author time is taken from the "Date: " line
104 of the message. The "Subject: " line is used as the title of
105 the commit, after stripping common prefix "[PATCH <anything>]".
106 It is supposed to describe what the commit is about concisely as
107 a one line text.
108
109 The body of the message (iow, after a blank line that terminates
110 RFC2822 headers) can begin with "Subject: " and "From: " lines
111 that are different from those of the mail header, to override
112 the values of these fields.
113
114 The commit message is formed by the title taken from the
115 "Subject: ", a blank line and the body of the message up to
116 where the patch begins. Excess whitespaces at the end of the
117 lines are automatically stripped.
118
119 The patch is expected to be inline, directly following the
120 message. Any line that is of form:
121
122 * three-dashes and end-of-line, or
123 * a line that begins with "diff -", or
124 * a line that begins with "Index: "
125
126 is taken as the beginning of a patch, and the commit log message
127 is terminated before the first occurrence of such a line.
128
129 When initially invoking it, you give it names of the mailboxes
130 to crunch. Upon seeing the first patch that does not apply, it
131 aborts in the middle,. You can recover from this in one of two ways:
132
133 . skip the current patch by re-running the command with '--skip'
134 option.
135
136 . hand resolve the conflict in the working directory, and update
137 the index file to bring it in a state that the patch should
138 have produced. Then run the command with '--resolved' option.
139
140 The command refuses to process new mailboxes while `.dotest`
141 directory exists, so if you decide to start over from scratch,
142 run `rm -f .dotest` before running the command with mailbox
143 names.
144
145
146 SEE ALSO
147 --------
148 gitlink:git-applypatch[1], gitlink:git-apply[1].
149
150
151 Author
152 ------
153 Written by Junio C Hamano <junkio@cox.net>
154
155 Documentation
156 --------------
157 Documentation by Petr Baudis, Junio C Hamano and the git-list <git@vger.kernel.org>.
158
159 GIT
160 ---
161 Part of the gitlink:git[7] suite
162