]>
Commit | Line | Data |
---|---|---|
42e2cba2 | 1 | git-am(1) |
05625af3 | 2 | ========= |
42e2cba2 PB |
3 | |
4 | NAME | |
5 | ---- | |
c3f0baac | 6 | git-am - Apply a series of patches from a mailbox |
42e2cba2 PB |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
353ce815 | 11 | [verse] |
0460ed2c | 12 | 'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8] |
e97a5e76 | 13 | [--[no-]3way] [--interactive] [--committer-date-is-author-date] |
86c91f91 | 14 | [--ignore-date] [--ignore-space-change | --ignore-whitespace] |
b47dfe9e | 15 | [--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>] |
58725efd | 16 | [--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet] |
2dfefe0f | 17 | [--[no-]scissors] [-S[<keyid>]] [--patch-format=<format>] |
59b519ab | 18 | [--quoted-cr=<action>] |
0adda936 | 19 | [(<mbox> | <Maildir>)...] |
aa416b22 | 20 | 'git am' (--continue | --skip | --abort | --quit | --show-current-patch[=(diff|raw)]) |
42e2cba2 PB |
21 | |
22 | DESCRIPTION | |
23 | ----------- | |
24 | Splits mail messages in a mailbox into commit log message, | |
25 | authorship information and patches, and applies them to the | |
26 | current branch. | |
27 | ||
baa720f5 JH |
28 | OPTIONS |
29 | ------- | |
0adda936 | 30 | (<mbox>|<Maildir>)...:: |
d4144612 | 31 | The list of mailbox files to read patches from. If you do not |
07f5746f DM |
32 | supply this argument, the command reads from the standard input. |
33 | If you supply directories, they will be treated as Maildirs. | |
d4144612 | 34 | |
3240240f SB |
35 | -s:: |
36 | --signoff:: | |
3abd4a67 | 37 | Add a `Signed-off-by` trailer to the commit message, using |
baa720f5 | 38 | the committer identity of yourself. |
b2c150d3 | 39 | See the signoff option in linkgit:git-commit[1] for more information. |
42e2cba2 | 40 | |
3240240f SB |
41 | -k:: |
42 | --keep:: | |
0b444cdb | 43 | Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]). |
d84029b6 | 44 | |
f7e5ea17 TR |
45 | --keep-non-patch:: |
46 | Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]). | |
47 | ||
0460ed2c | 48 | --[no-]keep-cr:: |
ad2c9280 SH |
49 | With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1]) |
50 | with the same option, to prevent it from stripping CR at the end of | |
e80d4cbe SH |
51 | lines. `am.keepcr` configuration variable can be used to specify the |
52 | default behaviour. `--no-keep-cr` is useful to override `am.keepcr`. | |
ad2c9280 | 53 | |
017678b4 JH |
54 | -c:: |
55 | --scissors:: | |
56 | Remove everything in body before a scissors line (see | |
afb5de7f MM |
57 | linkgit:git-mailinfo[1]). Can be activated by default using |
58 | the `mailinfo.scissors` configuration variable. | |
017678b4 | 59 | |
8024d596 | 60 | --no-scissors:: |
434a6db7 NS |
61 | Ignore scissors lines (see linkgit:git-mailinfo[1]). |
62 | ||
59b519ab ĐTCD |
63 | --quoted-cr=<action>:: |
64 | This flag will be passed down to 'git mailinfo' (see linkgit:git-mailinfo[1]). | |
65 | ||
a078f732 PB |
66 | -m:: |
67 | --message-id:: | |
68 | Pass the `-m` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]), | |
69 | so that the Message-ID header is added to the commit message. | |
70 | The `am.messageid` configuration variable can be used to specify | |
71 | the default behaviour. | |
72 | ||
73 | --no-message-id:: | |
74 | Do not add the Message-ID header to the commit message. | |
75 | `no-message-id` is useful to override `am.messageid`. | |
76 | ||
0e987a12 SB |
77 | -q:: |
78 | --quiet:: | |
79 | Be quiet. Only print error messages. | |
80 | ||
3240240f SB |
81 | -u:: |
82 | --utf8:: | |
0b444cdb | 83 | Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]). |
d84029b6 | 84 | The proposed commit log message taken from the e-mail |
870e0d61 | 85 | is re-coded into UTF-8 encoding (configuration variable |
77645b5d | 86 | `i18n.commitEncoding` can be used to specify project's |
d84029b6 JH |
87 | preferred encoding if it is not UTF-8). |
88 | + | |
89 | This was optional in prior versions of git, but now it is the | |
07f5746f | 90 | default. You can use `--no-utf8` to override this. |
d84029b6 JH |
91 | |
92 | --no-utf8:: | |
0b444cdb | 93 | Pass `-n` flag to 'git mailinfo' (see |
5162e697 | 94 | linkgit:git-mailinfo[1]). |
baa720f5 | 95 | |
3240240f SB |
96 | -3:: |
97 | --3way:: | |
e97a5e76 | 98 | --no-3way:: |
baa720f5 | 99 | When the patch does not apply cleanly, fall back on |
07f5746f DM |
100 | 3-way merge if the patch records the identity of blobs |
101 | it is supposed to apply to and we have those blobs | |
e97a5e76 RL |
102 | available locally. `--no-3way` can be used to override |
103 | am.threeWay configuration variable. For more information, | |
104 | see am.threeWay in linkgit:git-config[1]. | |
baa720f5 | 105 | |
aba4954c PW |
106 | --rerere-autoupdate:: |
107 | --no-rerere-autoupdate:: | |
108 | Allow the rerere mechanism to update the index with the | |
109 | result of auto-conflict resolution if possible. | |
110 | ||
86c91f91 GB |
111 | --ignore-space-change:: |
112 | --ignore-whitespace:: | |
8273c79a | 113 | --whitespace=<option>:: |
3240240f SB |
114 | -C<n>:: |
115 | -p<n>:: | |
b47dfe9e | 116 | --directory=<dir>:: |
2ae7345a | 117 | --exclude=<path>:: |
58725efd | 118 | --include=<path>:: |
b80da424 | 119 | --reject:: |
0b444cdb | 120 | These flags are passed to the 'git apply' (see linkgit:git-apply[1]) |
870e0d61 | 121 | program that applies |
67dad687 MT |
122 | the patch. |
123 | ||
64981376 CP |
124 | --patch-format:: |
125 | By default the command will try to detect the patch format | |
126 | automatically. This option allows the user to bypass the automatic | |
127 | detection and specify the patch format that the patch(es) should be | |
d9925d1a EW |
128 | interpreted as. Valid formats are mbox, mboxrd, |
129 | stgit, stgit-series and hg. | |
64981376 | 130 | |
3240240f SB |
131 | -i:: |
132 | --interactive:: | |
870e0d61 FL |
133 | Run interactively. |
134 | ||
a79ec62d NS |
135 | --committer-date-is-author-date:: |
136 | By default the command records the date from the e-mail | |
137 | message as the commit author date, and uses the time of | |
138 | commit creation as the committer date. This allows the | |
139 | user to lie about the committer date by using the same | |
e77063fc | 140 | value as the author date. |
a79ec62d NS |
141 | |
142 | --ignore-date:: | |
143 | By default the command records the date from the e-mail | |
144 | message as the commit author date, and uses the time of | |
145 | commit creation as the committer date. This allows the | |
e77063fc SB |
146 | user to lie about the author date by using the same |
147 | value as the committer date. | |
a79ec62d | 148 | |
870e0d61 FL |
149 | --skip:: |
150 | Skip the current patch. This is only meaningful when | |
151 | restarting an aborted patch. | |
baa720f5 | 152 | |
3b4e395f NV |
153 | -S[<keyid>]:: |
154 | --gpg-sign[=<keyid>]:: | |
ae06ba61 | 155 | --no-gpg-sign:: |
2b594bf9 MM |
156 | GPG-sign commits. The `keyid` argument is optional and |
157 | defaults to the committer identity; if specified, it must be | |
ae06ba61 ĐTCD |
158 | stuck to the option without a space. `--no-gpg-sign` is useful to |
159 | countermand both `commit.gpgSign` configuration variable, and | |
160 | earlier `--gpg-sign`. | |
3b4e395f | 161 | |
c8089af6 | 162 | --continue:: |
3240240f SB |
163 | -r:: |
164 | --resolved:: | |
087b6742 JH |
165 | After a patch failure (e.g. attempting to apply |
166 | conflicting patch), the user has applied it by hand and | |
167 | the index file stores the result of the application. | |
168 | Make a commit using the authorship and commit log | |
169 | extracted from the e-mail message and the current index | |
170 | file, and continue. | |
baa720f5 | 171 | |
5c19f244 AR |
172 | --resolvemsg=<msg>:: |
173 | When a patch failure occurs, <msg> will be printed | |
174 | to the screen before exiting. This overrides the | |
8ceb6fbd | 175 | standard message informing you to use `--continue` |
5c19f244 | 176 | or `--skip` to handle the failure. This is solely |
0b444cdb | 177 | for internal use between 'git rebase' and 'git am'. |
5c19f244 | 178 | |
3e5057a8 NS |
179 | --abort:: |
180 | Restore the original branch and abort the patching operation. | |
181 | ||
65ed8ff3 NTND |
182 | --quit:: |
183 | Abort the patching operation but keep HEAD and the index | |
184 | untouched. | |
185 | ||
aa416b22 PB |
186 | --show-current-patch[=(diff|raw)]:: |
187 | Show the message at which `git am` has stopped due to | |
188 | conflicts. If `raw` is specified, show the raw contents of | |
189 | the e-mail message; if `diff`, show the diff portion only. | |
190 | Defaults to `raw`. | |
984913a2 | 191 | |
baa720f5 JH |
192 | DISCUSSION |
193 | ---------- | |
194 | ||
2499857b | 195 | The commit author name is taken from the "From: " line of the |
e77063fc | 196 | message, and commit author date is taken from the "Date: " line |
2499857b JH |
197 | of the message. The "Subject: " line is used as the title of |
198 | the commit, after stripping common prefix "[PATCH <anything>]". | |
3db964b5 SB |
199 | The "Subject: " line is supposed to concisely describe what the |
200 | commit is about in one line of text. | |
2499857b | 201 | |
f8740c58 PM |
202 | "From: ", "Date: ", and "Subject: " lines starting the body override the |
203 | respective commit author name and title values taken from the headers. | |
2499857b JH |
204 | |
205 | The commit message is formed by the title taken from the | |
206 | "Subject: ", a blank line and the body of the message up to | |
3db964b5 SB |
207 | where the patch begins. Excess whitespace at the end of each |
208 | line is automatically stripped. | |
2499857b JH |
209 | |
210 | The patch is expected to be inline, directly following the | |
07f5746f | 211 | message. Any line that is of the form: |
2499857b JH |
212 | |
213 | * three-dashes and end-of-line, or | |
214 | * a line that begins with "diff -", or | |
215 | * a line that begins with "Index: " | |
216 | ||
217 | is taken as the beginning of a patch, and the commit log message | |
218 | is terminated before the first occurrence of such a line. | |
219 | ||
3db964b5 | 220 | When initially invoking `git am`, you give it the names of the mailboxes |
07f5746f DM |
221 | to process. Upon seeing the first patch that does not apply, it |
222 | aborts in the middle. You can recover from this in one of two ways: | |
baa720f5 | 223 | |
bcf9626a | 224 | . skip the current patch by re-running the command with the `--skip` |
baa720f5 JH |
225 | option. |
226 | ||
087b6742 | 227 | . hand resolve the conflict in the working directory, and update |
07f5746f | 228 | the index file to bring it into a state that the patch should |
bcf9626a | 229 | have produced. Then run the command with the `--continue` option. |
baa720f5 | 230 | |
b5f306fb SG |
231 | The command refuses to process new mailboxes until the current |
232 | operation is finished, so if you decide to start over from scratch, | |
233 | run `git am --abort` before running the command with mailbox | |
baa720f5 | 234 | names. |
42e2cba2 | 235 | |
9869099b BG |
236 | Before any patches are applied, ORIG_HEAD is set to the tip of the |
237 | current branch. This is useful if you have problems with multiple | |
238 | commits, like running 'git am' on the wrong branch or an error in the | |
239 | commits that is more easily fixed by changing the mailbox (e.g. | |
240 | errors in the "From:" lines). | |
241 | ||
0e3d40c6 JN |
242 | HOOKS |
243 | ----- | |
244 | This command can run `applypatch-msg`, `pre-applypatch`, | |
245 | and `post-applypatch` hooks. See linkgit:githooks[5] for more | |
246 | information. | |
42e2cba2 PB |
247 | |
248 | SEE ALSO | |
249 | -------- | |
5162e697 | 250 | linkgit:git-apply[1]. |
42e2cba2 | 251 | |
42e2cba2 PB |
252 | GIT |
253 | --- | |
9e1f0a85 | 254 | Part of the linkgit:git[1] suite |