OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-am.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-am(1)">\r
5 <articleinfo>\r
6     <title>git-am(1)</title>\r
7         <indexterm>\r
8                 <primary>git-am(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-am - Apply a series of patches from a mailbox</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <blockquote>\r
18 <literallayout><emphasis>git am</emphasis> [--signoff] [--keep] [--utf8 | --no-utf8]\r
19          [--3way] [--interactive] [--committer-date-is-author-date]\r
20          [--ignore-date]\r
21          [--whitespace=&lt;option&gt;] [-C&lt;n&gt;] [-p&lt;n&gt;] [--directory=&lt;dir&gt;]\r
22          [--reject]\r
23          [&lt;mbox&gt; | &lt;Maildir&gt;&#8230;]\r
24 <emphasis>git am</emphasis> (--skip | --resolved | --abort)</literallayout>\r
25 </blockquote>\r
26 </simplesect>\r
27 <simplesect id="_description">\r
28 <title>DESCRIPTION</title>\r
29 <simpara>Splits mail messages in a mailbox into commit log message,\r
30 authorship information and patches, and applies them to the\r
31 current branch.</simpara>\r
32 </simplesect>\r
33 <simplesect id="_options">\r
34 <title>OPTIONS</title>\r
35 <variablelist>\r
36 <varlistentry>\r
37 <term>\r
38 &lt;mbox&gt;|&lt;Maildir&gt;&#8230;\r
39 </term>\r
40 <listitem>\r
41 <simpara>\r
42         The list of mailbox files to read patches from. If you do not\r
43         supply this argument, reads from the standard input. If you supply\r
44         directories, they&#8217;ll be treated as Maildirs.\r
45 </simpara>\r
46 </listitem>\r
47 </varlistentry>\r
48 <varlistentry>\r
49 <term>\r
50 -s\r
51 </term>\r
52 <term>\r
53 --signoff\r
54 </term>\r
55 <listitem>\r
56 <simpara>\r
57         Add <literal>Signed-off-by:</literal> line to the commit message, using\r
58         the committer identity of yourself.\r
59 </simpara>\r
60 </listitem>\r
61 </varlistentry>\r
62 <varlistentry>\r
63 <term>\r
64 -k\r
65 </term>\r
66 <term>\r
67 --keep\r
68 </term>\r
69 <listitem>\r
70 <simpara>\r
71         Pass <literal>-k</literal> flag to <emphasis>git-mailinfo</emphasis> (see <xref linkend="git-mailinfo(1)"/>).\r
72 </simpara>\r
73 </listitem>\r
74 </varlistentry>\r
75 <varlistentry>\r
76 <term>\r
77 -u\r
78 </term>\r
79 <term>\r
80 --utf8\r
81 </term>\r
82 <listitem>\r
83 <simpara>\r
84         Pass <literal>-u</literal> flag to <emphasis>git-mailinfo</emphasis> (see <xref linkend="git-mailinfo(1)"/>).\r
85         The proposed commit log message taken from the e-mail\r
86         is re-coded into UTF-8 encoding (configuration variable\r
87         <literal>i18n.commitencoding</literal> can be used to specify project&#8217;s\r
88         preferred encoding if it is not UTF-8).\r
89 </simpara>\r
90 <simpara>This was optional in prior versions of git, but now it is the\r
91 default.   You could use <literal>--no-utf8</literal> to override this.</simpara>\r
92 </listitem>\r
93 </varlistentry>\r
94 <varlistentry>\r
95 <term>\r
96 --no-utf8\r
97 </term>\r
98 <listitem>\r
99 <simpara>\r
100         Pass <literal>-n</literal> flag to <emphasis>git-mailinfo</emphasis> (see\r
101         <xref linkend="git-mailinfo(1)"/>).\r
102 </simpara>\r
103 </listitem>\r
104 </varlistentry>\r
105 <varlistentry>\r
106 <term>\r
107 -3\r
108 </term>\r
109 <term>\r
110 --3way\r
111 </term>\r
112 <listitem>\r
113 <simpara>\r
114         When the patch does not apply cleanly, fall back on\r
115         3-way merge, if the patch records the identity of blobs\r
116         it is supposed to apply to, and we have those blobs\r
117         available locally.\r
118 </simpara>\r
119 </listitem>\r
120 </varlistentry>\r
121 <varlistentry>\r
122 <term>\r
123 --whitespace=&lt;option&gt;\r
124 </term>\r
125 <term>\r
126 -C&lt;n&gt;\r
127 </term>\r
128 <term>\r
129 -p&lt;n&gt;\r
130 </term>\r
131 <term>\r
132 --directory=&lt;dir&gt;\r
133 </term>\r
134 <term>\r
135 --reject\r
136 </term>\r
137 <listitem>\r
138 <simpara>\r
139         These flags are passed to the <emphasis>git-apply</emphasis> (see <xref linkend="git-apply(1)"/>)\r
140         program that applies\r
141         the patch.\r
142 </simpara>\r
143 </listitem>\r
144 </varlistentry>\r
145 <varlistentry>\r
146 <term>\r
147 -i\r
148 </term>\r
149 <term>\r
150 --interactive\r
151 </term>\r
152 <listitem>\r
153 <simpara>\r
154         Run interactively.\r
155 </simpara>\r
156 </listitem>\r
157 </varlistentry>\r
158 <varlistentry>\r
159 <term>\r
160 --committer-date-is-author-date\r
161 </term>\r
162 <listitem>\r
163 <simpara>\r
164         By default the command records the date from the e-mail\r
165         message as the commit author date, and uses the time of\r
166         commit creation as the committer date. This allows the\r
167         user to lie about the committer date by using the same\r
168         timestamp as the author date.\r
169 </simpara>\r
170 </listitem>\r
171 </varlistentry>\r
172 <varlistentry>\r
173 <term>\r
174 --ignore-date\r
175 </term>\r
176 <listitem>\r
177 <simpara>\r
178         By default the command records the date from the e-mail\r
179         message as the commit author date, and uses the time of\r
180         commit creation as the committer date. This allows the\r
181         user to lie about author timestamp by using the same\r
182         timestamp as the committer date.\r
183 </simpara>\r
184 </listitem>\r
185 </varlistentry>\r
186 <varlistentry>\r
187 <term>\r
188 --skip\r
189 </term>\r
190 <listitem>\r
191 <simpara>\r
192         Skip the current patch.  This is only meaningful when\r
193         restarting an aborted patch.\r
194 </simpara>\r
195 </listitem>\r
196 </varlistentry>\r
197 <varlistentry>\r
198 <term>\r
199 -r\r
200 </term>\r
201 <term>\r
202 --resolved\r
203 </term>\r
204 <listitem>\r
205 <simpara>\r
206         After a patch failure (e.g. attempting to apply\r
207         conflicting patch), the user has applied it by hand and\r
208         the index file stores the result of the application.\r
209         Make a commit using the authorship and commit log\r
210         extracted from the e-mail message and the current index\r
211         file, and continue.\r
212 </simpara>\r
213 </listitem>\r
214 </varlistentry>\r
215 <varlistentry>\r
216 <term>\r
217 --resolvemsg=&lt;msg&gt;\r
218 </term>\r
219 <listitem>\r
220 <simpara>\r
221         When a patch failure occurs, &lt;msg&gt; will be printed\r
222         to the screen before exiting.  This overrides the\r
223         standard message informing you to use <literal>--resolved</literal>\r
224         or <literal>--skip</literal> to handle the failure.  This is solely\r
225         for internal use between <emphasis>git-rebase</emphasis> and <emphasis>git-am</emphasis>.\r
226 </simpara>\r
227 </listitem>\r
228 </varlistentry>\r
229 <varlistentry>\r
230 <term>\r
231 --abort\r
232 </term>\r
233 <listitem>\r
234 <simpara>\r
235         Restore the original branch and abort the patching operation.\r
236 </simpara>\r
237 </listitem>\r
238 </varlistentry>\r
239 </variablelist>\r
240 </simplesect>\r
241 <simplesect id="_discussion">\r
242 <title>DISCUSSION</title>\r
243 <simpara>The commit author name is taken from the "From: " line of the\r
244 message, and commit author time is taken from the "Date: " line\r
245 of the message.  The "Subject: " line is used as the title of\r
246 the commit, after stripping common prefix "[PATCH &lt;anything&gt;]".\r
247 It is supposed to describe what the commit is about concisely as\r
248 a one line text.</simpara>\r
249 <simpara>The body of the message (iow, after a blank line that terminates\r
250 RFC2822 headers) can begin with "Subject: " and "From: " lines\r
251 that are different from those of the mail header, to override\r
252 the values of these fields.</simpara>\r
253 <simpara>The commit message is formed by the title taken from the\r
254 "Subject: ", a blank line and the body of the message up to\r
255 where the patch begins.  Excess whitespaces at the end of the\r
256 lines are automatically stripped.</simpara>\r
257 <simpara>The patch is expected to be inline, directly following the\r
258 message.  Any line that is of form:</simpara>\r
259 <itemizedlist>\r
260 <listitem>\r
261 <simpara>\r
262 three-dashes and end-of-line, or\r
263 </simpara>\r
264 </listitem>\r
265 <listitem>\r
266 <simpara>\r
267 a line that begins with "diff -", or\r
268 </simpara>\r
269 </listitem>\r
270 <listitem>\r
271 <simpara>\r
272 a line that begins with "Index: "\r
273 </simpara>\r
274 </listitem>\r
275 </itemizedlist>\r
276 <simpara>is taken as the beginning of a patch, and the commit log message\r
277 is terminated before the first occurrence of such a line.</simpara>\r
278 <simpara>When initially invoking it, you give it names of the mailboxes\r
279 to crunch.  Upon seeing the first patch that does not apply, it\r
280 aborts in the middle,.  You can recover from this in one of two ways:</simpara>\r
281 <orderedlist numeration="arabic">\r
282 <listitem>\r
283 <simpara>\r
284 skip the current patch by re-running the command with <emphasis>--skip</emphasis>\r
285   option.\r
286 </simpara>\r
287 </listitem>\r
288 <listitem>\r
289 <simpara>\r
290 hand resolve the conflict in the working directory, and update\r
291   the index file to bring it in a state that the patch should\r
292   have produced.  Then run the command with <emphasis>--resolved</emphasis> option.\r
293 </simpara>\r
294 </listitem>\r
295 </orderedlist>\r
296 <simpara>The command refuses to process new mailboxes while <literal>.git/rebase-apply</literal>\r
297 directory exists, so if you decide to start over from scratch,\r
298 run <literal>rm -f -r .git/rebase-apply</literal> before running the command with mailbox\r
299 names.</simpara>\r
300 <simpara>Before any patches are applied, ORIG_HEAD is set to the tip of the\r
301 current branch.  This is useful if you have problems with multiple\r
302 commits, like running <emphasis>git am</emphasis> on the wrong branch or an error in the\r
303 commits that is more easily fixed by changing the mailbox (e.g.\r
304 errors in the "From:" lines).</simpara>\r
305 </simplesect>\r
306 <simplesect id="_see_also">\r
307 <title>SEE ALSO</title>\r
308 <simpara><xref linkend="git-apply(1)"/>.</simpara>\r
309 </simplesect>\r
310 <simplesect id="_author">\r
311 <title>Author</title>\r
312 <simpara>Written by Junio C Hamano &lt;<ulink url="mailto:gitster@pobox.com">gitster@pobox.com</ulink>&gt;</simpara>\r
313 </simplesect>\r
314 <simplesect id="_documentation">\r
315 <title>Documentation</title>\r
316 <simpara>Documentation by Petr Baudis, Junio C Hamano and the git-list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;.</simpara>\r
317 </simplesect>\r
318 <simplesect id="_git">\r
319 <title>GIT</title>\r
320 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
321 </simplesect>\r
322 </article>\r