]>
Commit | Line | Data |
---|---|---|
56333bac JS |
1 | Checklist (and a short version for the impatient): |
2 | ||
a7af09d2 JA |
3 | Commits: |
4 | ||
56333bac JS |
5 | - make commits of logical units |
6 | - check for unnecessary whitespace with "git diff --check" | |
7 | before committing | |
8 | - do not check in commented out code or unneeded files | |
56333bac | 9 | - the first line of the commit message should be a short |
43e331e6 ÆAB |
10 | description (50 characters is the soft limit, see DISCUSSION |
11 | in git-commit(1)), and should skip the full stop | |
47afed5d SV |
12 | - the body should provide a meaningful commit message, which: |
13 | - uses the imperative, present tense: "change", | |
14 | not "changed" or "changes". | |
15 | - includes motivation for the change, and contrasts | |
16 | its implementation with previous behaviour | |
6a58696f ÆAB |
17 | - add a "Signed-off-by: Your Name <you@example.com>" line to the |
18 | commit message (or just use the option "-s" when committing) | |
19 | to confirm that you agree to the Developer's Certificate of Origin | |
d3017e93 JS |
20 | - make sure that you have tests for the bug you are fixing |
21 | - make sure that the test suite passes after your commit | |
a7af09d2 JA |
22 | |
23 | Patch: | |
24 | ||
56333bac | 25 | - use "git format-patch -M" to create the patch |
a7af09d2 | 26 | - do not PGP sign your patch |
56333bac JS |
27 | - do not attach your patch, but read in the mail |
28 | body, unless you cannot teach your mailer to | |
29 | leave the formatting of the patch alone. | |
30 | - be careful doing cut & paste into your mailer, not to | |
31 | corrupt whitespaces. | |
32 | - provide additional information (which is unsuitable for | |
33 | the commit message) between the "---" and the diffstat | |
15320175 AR |
34 | - if you change, add, or remove a command line option or |
35 | make some other user interface change, the associated | |
36 | documentation should be updated as well. | |
d3017e93 JS |
37 | - if your name is not writable in ASCII, make sure that |
38 | you send off a message in the correct encoding. | |
13d4e6f7 | 39 | - send the patch to the list (git@vger.kernel.org) and the |
0b059940 JH |
40 | maintainer (gitster@pobox.com) if (and only if) the patch |
41 | is ready for inclusion. If you use git-send-email(1), | |
42 | please test it first by sending email to yourself. | |
e498257d | 43 | - see below for instructions specific to your mailer |
56333bac JS |
44 | |
45 | Long version: | |
46 | ||
31408251 JH |
47 | I started reading over the SubmittingPatches document for Linux |
48 | kernel, primarily because I wanted to have a document similar to | |
49 | it for the core GIT to make sure people understand what they are | |
50 | doing when they write "Signed-off-by" line. | |
51 | ||
52 | But the patch submission requirements are a lot more relaxed | |
45d2b286 JH |
53 | here on the technical/contents front, because the core GIT is |
54 | thousand times smaller ;-). So here is only the relevant bits. | |
31408251 | 55 | |
d0c26f0f RR |
56 | (0) Decide what to base your work on. |
57 | ||
58 | In general, always base your work on the oldest branch that your | |
59 | change is relevant to. | |
60 | ||
61 | - A bugfix should be based on 'maint' in general. If the bug is not | |
62 | present in 'maint', base it on 'master'. For a bug that's not yet | |
63 | in 'master', find the topic that introduces the regression, and | |
64 | base your work on the tip of the topic. | |
65 | ||
66 | - A new feature should be based on 'master' in general. If the new | |
67 | feature depends on a topic that is in 'pu', but not in 'master', | |
68 | base your work on the tip of that topic. | |
69 | ||
70 | - Corrections and enhancements to a topic not yet in 'master' should | |
71 | be based on the tip of that topic. If the topic has not been merged | |
72 | to 'next', it's alright to add a note to squash minor corrections | |
73 | into the series. | |
74 | ||
75 | - In the exceptional case that a new feature depends on several topics | |
76 | not in 'master', start working on 'next' or 'pu' privately and send | |
77 | out patches for discussion. Before the final merge, you may have to | |
78 | wait until some of the dependent topics graduate to 'master', and | |
79 | rebase your work. | |
80 | ||
81 | To find the tip of a topic branch, run "git log --first-parent | |
82 | master..pu" and look for the merge commit. The second parent of this | |
83 | commit is the tip of the topic branch. | |
31408251 JH |
84 | |
85 | (1) Make separate commits for logically separate changes. | |
86 | ||
87 | Unless your patch is really trivial, you should not be sending | |
88 | out a patch that was generated between your working tree and | |
89 | your commit head. Instead, always make a commit with complete | |
90 | commit message and generate a series of patches from your | |
91 | repository. It is a good discipline. | |
92 | ||
93 | Describe the technical detail of the change(s). | |
94 | ||
45d2b286 | 95 | If your description starts to get too long, that's a sign that you |
31408251 | 96 | probably need to split up your commit to finer grained pieces. |
47afed5d SV |
97 | That being said, patches which plainly describe the things that |
98 | help reviewers check the patch, and future maintainers understand | |
99 | the code, are the most beautiful patches. Descriptions that summarise | |
100 | the point in the subject well, and describe the motivation for the | |
101 | change, the approach taken by the change, and if relevant how this | |
102 | differs substantially from the prior version, can be found on Usenet | |
103 | archives back into the late 80's. Consider it like good Netiquette, | |
104 | but for code. | |
31408251 | 105 | |
45d2b286 JH |
106 | Oh, another thing. I am picky about whitespaces. Make sure your |
107 | changes do not trigger errors with the sample pre-commit hook shipped | |
16507fcf BL |
108 | in templates/hooks--pre-commit. To help ensure this does not happen, |
109 | run git diff --check on your changes before you commit. | |
31408251 | 110 | |
31408251 | 111 | |
243bfd33 JS |
112 | (1a) Try to be nice to older C compilers |
113 | ||
8b1d88e8 | 114 | We try to support a wide range of C compilers to compile |
243bfd33 JS |
115 | git with. That means that you should not use C99 initializers, even |
116 | if a lot of compilers grok it. | |
117 | ||
118 | Also, variables have to be declared at the beginning of the block | |
119 | (you can check this with gcc, using the -Wdeclaration-after-statement | |
120 | option). | |
121 | ||
122 | Another thing: NULL pointers shall be written as NULL, not as 0. | |
123 | ||
124 | ||
45d2b286 JH |
125 | (2) Generate your patch using git tools out of your commits. |
126 | ||
127 | git based diff tools (git, Cogito, and StGIT included) generate | |
128 | unidiff which is the preferred format. | |
129 | ||
31408251 JH |
130 | You do not have to be afraid to use -M option to "git diff" or |
131 | "git format-patch", if your patch involves file renames. The | |
132 | receiving end can handle them just fine. | |
133 | ||
134 | Please make sure your patch does not include any extra files | |
135 | which do not belong in a patch submission. Make sure to review | |
136 | your patch after generating it, to ensure accuracy. Before | |
137 | sending out, please make sure it cleanly applies to the "master" | |
45d2b286 JH |
138 | branch head. If you are preparing a work based on "next" branch, |
139 | that is fine, but please mark it as such. | |
31408251 JH |
140 | |
141 | ||
142 | (3) Sending your patches. | |
143 | ||
45d2b286 | 144 | People on the git mailing list need to be able to read and |
31408251 JH |
145 | comment on the changes you are submitting. It is important for |
146 | a developer to be able to "quote" your changes, using standard | |
147 | e-mail tools, so that they may comment on specific portions of | |
addf88e4 | 148 | your code. For this reason, all patches should be submitted |
45d2b286 JH |
149 | "inline". WARNING: Be wary of your MUAs word-wrap |
150 | corrupting your patch. Do not cut-n-paste your patch; you can | |
151 | lose tabs that way if you are not careful. | |
31408251 | 152 | |
45d2b286 | 153 | It is a common convention to prefix your subject line with |
31408251 | 154 | [PATCH]. This lets people easily distinguish patches from other |
4e891acf JH |
155 | e-mail discussions. Use of additional markers after PATCH and |
156 | the closing bracket to mark the nature of the patch is also | |
157 | encouraged. E.g. [PATCH/RFC] is often used when the patch is | |
158 | not ready to be applied but it is for discussion, [PATCH v2], | |
159 | [PATCH v3] etc. are often seen when you are sending an update to | |
160 | what you have previously sent. | |
31408251 JH |
161 | |
162 | "git format-patch" command follows the best current practice to | |
163 | format the body of an e-mail message. At the beginning of the | |
164 | patch should come your commit message, ending with the | |
165 | Signed-off-by: lines, and a line that consists of three dashes, | |
166 | followed by the diffstat information and the patch itself. If | |
167 | you are forwarding a patch from somebody else, optionally, at | |
168 | the beginning of the e-mail message just before the commit | |
169 | message starts, you can put a "From: " line to name that person. | |
170 | ||
171 | You often want to add additional explanation about the patch, | |
172 | other than the commit message itself. Place such "cover letter" | |
173 | material between the three dash lines and the diffstat. | |
174 | ||
175 | Do not attach the patch as a MIME attachment, compressed or not. | |
e30b217b JH |
176 | Do not let your e-mail client send quoted-printable. Do not let |
177 | your e-mail client send format=flowed which would destroy | |
178 | whitespaces in your patches. Many | |
31408251 JH |
179 | popular e-mail applications will not always transmit a MIME |
180 | attachment as plain text, making it impossible to comment on | |
181 | your code. A MIME attachment also takes a bit more time to | |
182 | process. This does not decrease the likelihood of your | |
183 | MIME-attached change being accepted, but it makes it more likely | |
184 | that it will be postponed. | |
185 | ||
186 | Exception: If your mailer is mangling patches then someone may ask | |
9847f7e0 | 187 | you to re-send them using MIME, that is OK. |
31408251 | 188 | |
9847f7e0 JH |
189 | Do not PGP sign your patch, at least for now. Most likely, your |
190 | maintainer or other people on the list would not have your PGP | |
191 | key and would not bother obtaining it anyway. Your patch is not | |
192 | judged by who you are; a good patch from an unknown origin has a | |
193 | far better chance of being accepted than a patch from a known, | |
194 | respected origin that is done poorly or does incorrect things. | |
195 | ||
196 | If you really really really really want to do a PGP signed | |
197 | patch, format it as "multipart/signed", not a text/plain message | |
198 | that starts with '-----BEGIN PGP SIGNED MESSAGE-----'. That is | |
199 | not a text/plain, it's something else. | |
200 | ||
d0c26f0f RR |
201 | Unless your patch is a very trivial and an obviously correct one, |
202 | first send it with "To:" set to the mailing list, with "cc:" listing | |
203 | people who are involved in the area you are touching (the output from | |
204 | "git blame $path" and "git shortlog --no-merges $path" would help to | |
205 | identify them), to solicit comments and reviews. After the list | |
206 | reached a consensus that it is a good idea to apply the patch, re-send | |
207 | it with "To:" set to the maintainer and optionally "cc:" the list for | |
208 | inclusion. Do not forget to add trailers such as "Acked-by:", | |
209 | "Reviewed-by:" and "Tested-by:" after your "Signed-off-by:" line as | |
210 | necessary. | |
04d24455 | 211 | |
31408251 | 212 | |
84ab7b6f | 213 | (4) Sign your work |
31408251 JH |
214 | |
215 | To improve tracking of who did what, we've borrowed the | |
216 | "sign-off" procedure from the Linux kernel project on patches | |
217 | that are being emailed around. Although core GIT is a lot | |
218 | smaller project it is a good discipline to follow it. | |
219 | ||
220 | The sign-off is a simple line at the end of the explanation for | |
221 | the patch, which certifies that you wrote it or otherwise have | |
222 | the right to pass it on as a open-source patch. The rules are | |
223 | pretty simple: if you can certify the below: | |
224 | ||
225 | Developer's Certificate of Origin 1.1 | |
226 | ||
227 | By making a contribution to this project, I certify that: | |
228 | ||
229 | (a) The contribution was created in whole or in part by me and I | |
230 | have the right to submit it under the open source license | |
231 | indicated in the file; or | |
232 | ||
233 | (b) The contribution is based upon previous work that, to the best | |
234 | of my knowledge, is covered under an appropriate open source | |
235 | license and I have the right under that license to submit that | |
236 | work with modifications, whether created in whole or in part | |
237 | by me, under the same open source license (unless I am | |
238 | permitted to submit under a different license), as indicated | |
239 | in the file; or | |
240 | ||
241 | (c) The contribution was provided directly to me by some other | |
242 | person who certified (a), (b) or (c) and I have not modified | |
243 | it. | |
244 | ||
245 | (d) I understand and agree that this project and the contribution | |
246 | are public and that a record of the contribution (including all | |
247 | personal information I submit with it, including my sign-off) is | |
248 | maintained indefinitely and may be redistributed consistent with | |
249 | this project or the open source license(s) involved. | |
250 | ||
251 | then you just add a line saying | |
252 | ||
253 | Signed-off-by: Random J Developer <random@developer.example.org> | |
254 | ||
69945602 PC |
255 | This line can be automatically added by git if you run the git-commit |
256 | command with the -s option. | |
257 | ||
c11c3b56 JH |
258 | Notice that you can place your own Signed-off-by: line when |
259 | forwarding somebody else's patch with the above rules for | |
260 | D-C-O. Indeed you are encouraged to do so. Do not forget to | |
261 | place an in-body "From: " line at the beginning to properly attribute | |
262 | the change to its true author (see (2) above). | |
263 | ||
67275247 MV |
264 | Also notice that a real name is used in the Signed-off-by: line. Please |
265 | don't hide your real name. | |
266 | ||
c11c3b56 JH |
267 | Some people also put extra tags at the end. |
268 | ||
269 | "Acked-by:" says that the patch was reviewed by the person who | |
270 | is more familiar with the issues and the area the patch attempts | |
271 | to modify. "Tested-by:" says the patch was tested by the person | |
272 | and found to have the desired effect. | |
9740d289 | 273 | |
a941fb4a JH |
274 | ------------------------------------------------ |
275 | An ideal patch flow | |
276 | ||
277 | Here is an ideal patch flow for this project the current maintainer | |
278 | suggests to the contributors: | |
279 | ||
280 | (0) You come up with an itch. You code it up. | |
281 | ||
282 | (1) Send it to the list and cc people who may need to know about | |
283 | the change. | |
284 | ||
285 | The people who may need to know are the ones whose code you | |
286 | are butchering. These people happen to be the ones who are | |
287 | most likely to be knowledgeable enough to help you, but | |
288 | they have no obligation to help you (i.e. you ask for help, | |
289 | don't demand). "git log -p -- $area_you_are_modifying" would | |
290 | help you find out who they are. | |
291 | ||
292 | (2) You get comments and suggestions for improvements. You may | |
293 | even get them in a "on top of your change" patch form. | |
294 | ||
295 | (3) Polish, refine, and re-send to the list and the people who | |
296 | spend their time to improve your patch. Go back to step (2). | |
297 | ||
298 | (4) The list forms consensus that the last round of your patch is | |
299 | good. Send it to the list and cc the maintainer. | |
300 | ||
301 | (5) A topic branch is created with the patch and is merged to 'next', | |
302 | and cooked further and eventually graduates to 'master'. | |
303 | ||
304 | In any time between the (2)-(3) cycle, the maintainer may pick it up | |
305 | from the list and queue it to 'pu', in order to make it easier for | |
306 | people play with it without having to pick up and apply the patch to | |
307 | their trees themselves. | |
308 | ||
63cb8215 MM |
309 | ------------------------------------------------ |
310 | Know the status of your patch after submission | |
311 | ||
312 | * You can use Git itself to find out when your patch is merged in | |
313 | master. 'git pull --rebase' will automatically skip already-applied | |
314 | patches, and will let you know. This works only if you rebase on top | |
315 | of the branch in which your patch has been merged (i.e. it will not | |
316 | tell you if your patch is merged in pu if you rebase on top of | |
317 | master). | |
318 | ||
319 | * Read the git mailing list, the maintainer regularly posts messages | |
320 | entitled "What's cooking in git.git" and "What's in git.git" giving | |
321 | the status of various proposed changes. | |
322 | ||
9740d289 JH |
323 | ------------------------------------------------ |
324 | MUA specific hints | |
325 | ||
326 | Some of patches I receive or pick up from the list share common | |
327 | patterns of breakage. Please make sure your MUA is set up | |
328 | properly not to corrupt whitespaces. Here are two common ones | |
329 | I have seen: | |
330 | ||
331 | * Empty context lines that do not have _any_ whitespace. | |
332 | ||
333 | * Non empty context lines that have one extra whitespace at the | |
334 | beginning. | |
335 | ||
9847f7e0 JH |
336 | One test you could do yourself if your MUA is set up correctly is: |
337 | ||
338 | * Send the patch to yourself, exactly the way you would, except | |
339 | To: and Cc: lines, which would not contain the list and | |
340 | maintainer address. | |
341 | ||
342 | * Save that patch to a file in UNIX mailbox format. Call it say | |
343 | a.patch. | |
344 | ||
345 | * Try to apply to the tip of the "master" branch from the | |
346 | git.git public repository: | |
347 | ||
348 | $ git fetch http://kernel.org/pub/scm/git/git.git master:test-apply | |
349 | $ git checkout test-apply | |
350 | $ git reset --hard | |
59c8e2cb | 351 | $ git am a.patch |
9847f7e0 JH |
352 | |
353 | If it does not apply correctly, there can be various reasons. | |
354 | ||
355 | * Your patch itself does not apply cleanly. That is _bad_ but | |
356 | does not have much to do with your MUA. Please rebase the | |
357 | patch appropriately. | |
358 | ||
59c8e2cb | 359 | * Your MUA corrupted your patch; "am" would complain that |
51ef1daa | 360 | the patch does not apply. Look at .git/rebase-apply/ subdirectory and |
9847f7e0 JH |
361 | see what 'patch' file contains and check for the common |
362 | corruption patterns mentioned above. | |
363 | ||
364 | * While you are at it, check what are in 'info' and | |
365 | 'final-commit' files as well. If what is in 'final-commit' is | |
366 | not exactly what you would want to see in the commit log | |
367 | message, it is very likely that your maintainer would end up | |
368 | hand editing the log message when he applies your patch. | |
369 | Things like "Hi, this is my first patch.\n", if you really | |
370 | want to put in the patch e-mail, should come after the | |
371 | three-dash line that signals the end of the commit message. | |
372 | ||
9740d289 JH |
373 | |
374 | Pine | |
375 | ---- | |
376 | ||
377 | (Johannes Schindelin) | |
378 | ||
379 | I don't know how many people still use pine, but for those poor | |
380 | souls it may be good to mention that the quell-flowed-text is | |
381 | needed for recent versions. | |
382 | ||
383 | ... the "no-strip-whitespace-before-send" option, too. AFAIK it | |
384 | was introduced in 4.60. | |
385 | ||
386 | (Linus Torvalds) | |
387 | ||
388 | And 4.58 needs at least this. | |
389 | ||
390 | --- | |
391 | diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1) | |
392 | Author: Linus Torvalds <torvalds@g5.osdl.org> | |
393 | Date: Mon Aug 15 17:23:51 2005 -0700 | |
394 | ||
395 | Fix pine whitespace-corruption bug | |
396 | ||
397 | There's no excuse for unconditionally removing whitespace from | |
398 | the pico buffers on close. | |
399 | ||
400 | diff --git a/pico/pico.c b/pico/pico.c | |
401 | --- a/pico/pico.c | |
402 | +++ b/pico/pico.c | |
403 | @@ -219,7 +219,9 @@ PICO *pm; | |
a6080a0a JH |
404 | switch(pico_all_done){ /* prepare for/handle final events */ |
405 | case COMP_EXIT : /* already confirmed */ | |
406 | packheader(); | |
9740d289 | 407 | +#if 0 |
a6080a0a | 408 | stripwhitespace(); |
9740d289 | 409 | +#endif |
a6080a0a JH |
410 | c |= COMP_EXIT; |
411 | break; | |
412 | ||
9740d289 | 413 | |
1eb446fa JH |
414 | (Daniel Barkalow) |
415 | ||
416 | > A patch to SubmittingPatches, MUA specific help section for | |
417 | > users of Pine 4.63 would be very much appreciated. | |
418 | ||
419 | Ah, it looks like a recent version changed the default behavior to do the | |
420 | right thing, and inverted the sense of the configuration option. (Either | |
421 | that or Gentoo did it.) So you need to set the | |
422 | "no-strip-whitespace-before-send" option, unless the option you have is | |
423 | "strip-whitespace-before-send", in which case you should avoid checking | |
424 | it. | |
425 | ||
9740d289 JH |
426 | |
427 | Thunderbird | |
428 | ----------- | |
429 | ||
430 | (A Large Angry SCM) | |
431 | ||
1a526d48 JW |
432 | By default, Thunderbird will both wrap emails as well as flag them as |
433 | being 'format=flowed', both of which will make the resulting email unusable | |
434 | by git. | |
435 | ||
9740d289 | 436 | Here are some hints on how to successfully submit patches inline using |
cf6de18a | 437 | Thunderbird. |
9740d289 | 438 | |
1a526d48 JW |
439 | There are two different approaches. One approach is to configure |
440 | Thunderbird to not mangle patches. The second approach is to use | |
441 | an external editor to keep Thunderbird from mangling the patches. | |
442 | ||
443 | Approach #1 (configuration): | |
444 | ||
445 | This recipe is current as of Thunderbird 2.0.0.19. Three steps: | |
446 | 1. Configure your mail server composition as plain text | |
447 | Edit...Account Settings...Composition & Addressing, | |
448 | uncheck 'Compose Messages in HTML'. | |
449 | 2. Configure your general composition window to not wrap | |
450 | Edit..Preferences..Composition, wrap plain text messages at 0 | |
451 | 3. Disable the use of format=flowed | |
452 | Edit..Preferences..Advanced..Config Editor. Search for: | |
453 | mailnews.send_plaintext_flowed | |
454 | toggle it to make sure it is set to 'false'. | |
455 | ||
456 | After that is done, you should be able to compose email as you | |
457 | otherwise would (cut + paste, git-format-patch | git-imap-send, etc), | |
458 | and the patches should not be mangled. | |
459 | ||
460 | Approach #2 (external editor): | |
461 | ||
9740d289 JH |
462 | This recipe appears to work with the current [*1*] Thunderbird from Suse. |
463 | ||
464 | The following Thunderbird extensions are needed: | |
465 | AboutConfig 0.5 | |
466 | http://aboutconfig.mozdev.org/ | |
ff62b7f3 LS |
467 | External Editor 0.7.2 |
468 | http://globs.org/articles.php?lng=en&pg=8 | |
9740d289 JH |
469 | |
470 | 1) Prepare the patch as a text file using your method of choice. | |
471 | ||
472 | 2) Before opening a compose window, use Edit->Account Settings to | |
473 | uncheck the "Compose messages in HTML format" setting in the | |
474 | "Composition & Addressing" panel of the account to be used to send the | |
475 | patch. [*2*] | |
476 | ||
477 | 3) In the main Thunderbird window, _before_ you open the compose window | |
478 | for the patch, use Tools->about:config to set the following to the | |
479 | indicated values: | |
480 | mailnews.send_plaintext_flowed => false | |
cf6de18a | 481 | mailnews.wraplength => 0 |
9740d289 JH |
482 | |
483 | 4) Open a compose window and click the external editor icon. | |
484 | ||
485 | 5) In the external editor window, read in the patch file and exit the | |
486 | editor normally. | |
487 | ||
488 | 6) Back in the compose window: Add whatever other text you wish to the | |
489 | message, complete the addressing and subject fields, and press send. | |
490 | ||
491 | 7) Optionally, undo the about:config/account settings changes made in | |
492 | steps 2 & 3. | |
493 | ||
494 | ||
495 | [Footnotes] | |
496 | *1* Version 1.0 (20041207) from the MozillaThunderbird-1.0-5 rpm of Suse | |
497 | 9.3 professional updates. | |
498 | ||
499 | *2* It may be possible to do this with about:config and the following | |
500 | settings but I haven't tried, yet. | |
501 | mail.html_compose => false | |
502 | mail.identity.default.compose_html => false | |
503 | mail.identity.id?.compose_html => false | |
504 | ||
0c3d26d2 LS |
505 | (Lukas Sandström) |
506 | ||
507 | There is a script in contrib/thunderbird-patch-inline which can help | |
508 | you include patches with Thunderbird in an easy way. To use it, do the | |
509 | steps above and then use the script as the external editor. | |
e30b217b | 510 | |
e30b217b JH |
511 | Gnus |
512 | ---- | |
513 | ||
514 | '|' in the *Summary* buffer can be used to pipe the current | |
515 | message to an external program, and this is a handy way to drive | |
516 | "git am". However, if the message is MIME encoded, what is | |
517 | piped into the program is the representation you see in your | |
518 | *Article* buffer after unwrapping MIME. This is often not what | |
519 | you would want for two reasons. It tends to screw up non ASCII | |
520 | characters (most notably in people's names), and also | |
521 | whitespaces (fatal in patches). Running 'C-u g' to display the | |
522 | message in raw form before using '|' to run the pipe can work | |
523 | this problem around. | |
524 | ||
451fd65a MB |
525 | |
526 | KMail | |
527 | ----- | |
528 | ||
529 | This should help you to submit patches inline using KMail. | |
530 | ||
531 | 1) Prepare the patch as a text file. | |
532 | ||
533 | 2) Click on New Mail. | |
534 | ||
535 | 3) Go under "Options" in the Composer window and be sure that | |
536 | "Word wrap" is not set. | |
537 | ||
538 | 4) Use Message -> Insert file... and insert the patch. | |
539 | ||
540 | 5) Back in the compose window: add whatever other text you wish to the | |
541 | message, complete the addressing and subject fields, and press send. | |
c2163c6a TPW |
542 | |
543 | ||
544 | Gmail | |
545 | ----- | |
546 | ||
50dffd4e JT |
547 | GMail does not appear to have any way to turn off line wrapping in the web |
548 | interface, so this will mangle any emails that you send. You can however | |
811dd906 | 549 | use "git send-email" and send your patches through the GMail SMTP server, or |
e498257d | 550 | use any IMAP email client to connect to the google IMAP server and forward |
df5753c4 | 551 | the emails through that. |
50dffd4e | 552 | |
e498257d MG |
553 | To use "git send-email" and send your patches through the GMail SMTP server, |
554 | edit ~/.gitconfig to specify your account settings: | |
555 | ||
556 | [sendemail] | |
557 | smtpencryption = tls | |
558 | smtpserver = smtp.gmail.com | |
559 | smtpuser = user@gmail.com | |
560 | smtppass = p4ssw0rd | |
561 | smtpserverport = 587 | |
562 | ||
563 | Once your commits are ready to be sent to the mailing list, run the | |
564 | following commands: | |
565 | ||
566 | $ git format-patch --cover-letter -M origin/master -o outgoing/ | |
567 | $ edit outgoing/0000-* | |
568 | $ git send-email outgoing/* | |
569 | ||
df5753c4 | 570 | To submit using the IMAP interface, first, edit your ~/.gitconfig to specify your |
c2163c6a TPW |
571 | account settings: |
572 | ||
573 | [imap] | |
574 | folder = "[Gmail]/Drafts" | |
575 | host = imaps://imap.gmail.com | |
576 | user = user@gmail.com | |
577 | pass = p4ssw0rd | |
578 | port = 993 | |
579 | sslverify = false | |
580 | ||
50dffd4e JT |
581 | You might need to instead use: folder = "[Google Mail]/Drafts" if you get an error |
582 | that the "Folder doesn't exist". | |
583 | ||
df5753c4 | 584 | Once your commits are ready to be sent to the mailing list, run the |
e498257d | 585 | following commands: |
c2163c6a | 586 | |
df5753c4 | 587 | $ git format-patch --cover-letter -M --stdout origin/master | git imap-send |
c2163c6a | 588 | |
df5753c4 JH |
589 | Just make sure to disable line wrapping in the email client (GMail web |
590 | interface will line wrap no matter what, so you need to use a real | |
591 | IMAP client). | |
c2163c6a | 592 |