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