Merge branch 'rs/cherry'
[git] / Documentation / SubmittingPatches
1 I started reading over the SubmittingPatches document for Linux
2 kernel, primarily because I wanted to have a document similar to
3 it for the core GIT to make sure people understand what they are
4 doing when they write "Signed-off-by" line.
5
6 But the patch submission requirements are a lot more relaxed
7 here on the technical/contents front, because the core GIT is
8 thousand times smaller ;-).  So here is only the relevant bits.
9
10
11 (1) Make separate commits for logically separate changes.
12
13 Unless your patch is really trivial, you should not be sending
14 out a patch that was generated between your working tree and
15 your commit head.  Instead, always make a commit with complete
16 commit message and generate a series of patches from your
17 repository.  It is a good discipline.
18
19 Describe the technical detail of the change(s).
20
21 If your description starts to get too long, that's a sign that you
22 probably need to split up your commit to finer grained pieces.
23
24 Oh, another thing.  I am picky about whitespaces.  Make sure your
25 changes do not trigger errors with the sample pre-commit hook shipped
26 in templates/hooks--pre-commit.
27
28
29 (2) Generate your patch using git tools out of your commits.
30
31 git based diff tools (git, Cogito, and StGIT included) generate
32 unidiff which is the preferred format.
33
34 You do not have to be afraid to use -M option to "git diff" or
35 "git format-patch", if your patch involves file renames.  The
36 receiving end can handle them just fine.
37
38 Please make sure your patch does not include any extra files
39 which do not belong in a patch submission.  Make sure to review
40 your patch after generating it, to ensure accuracy.  Before
41 sending out, please make sure it cleanly applies to the "master"
42 branch head.  If you are preparing a work based on "next" branch,
43 that is fine, but please mark it as such.
44
45
46 (3) Sending your patches.
47
48 People on the git mailing list need to be able to read and
49 comment on the changes you are submitting.  It is important for
50 a developer to be able to "quote" your changes, using standard
51 e-mail tools, so that they may comment on specific portions of
52 your code.  For this reason, all patches should be submitted
53 "inline".  WARNING: Be wary of your MUAs word-wrap
54 corrupting your patch.  Do not cut-n-paste your patch; you can
55 lose tabs that way if you are not careful.
56
57 It is a common convention to prefix your subject line with
58 [PATCH].  This lets people easily distinguish patches from other
59 e-mail discussions.
60
61 "git format-patch" command follows the best current practice to
62 format the body of an e-mail message.  At the beginning of the
63 patch should come your commit message, ending with the
64 Signed-off-by: lines, and a line that consists of three dashes,
65 followed by the diffstat information and the patch itself.  If
66 you are forwarding a patch from somebody else, optionally, at
67 the beginning of the e-mail message just before the commit
68 message starts, you can put a "From: " line to name that person.
69
70 You often want to add additional explanation about the patch,
71 other than the commit message itself.  Place such "cover letter"
72 material between the three dash lines and the diffstat.
73
74 Do not attach the patch as a MIME attachment, compressed or not.
75 Do not let your e-mail client send quoted-printable.  Many
76 popular e-mail applications will not always transmit a MIME
77 attachment as plain text, making it impossible to comment on
78 your code.  A MIME attachment also takes a bit more time to
79 process.  This does not decrease the likelihood of your
80 MIME-attached change being accepted, but it makes it more likely
81 that it will be postponed.
82
83 Exception:  If your mailer is mangling patches then someone may ask
84 you to re-send them using MIME, that is OK.
85
86 Do not PGP sign your patch, at least for now.  Most likely, your
87 maintainer or other people on the list would not have your PGP
88 key and would not bother obtaining it anyway.  Your patch is not
89 judged by who you are; a good patch from an unknown origin has a
90 far better chance of being accepted than a patch from a known,
91 respected origin that is done poorly or does incorrect things.
92
93 If you really really really really want to do a PGP signed
94 patch, format it as "multipart/signed", not a text/plain message
95 that starts with '-----BEGIN PGP SIGNED MESSAGE-----'.  That is
96 not a text/plain, it's something else.
97
98 Note that your maintainer does not necessarily read everything
99 on the git mailing list.  If your patch is for discussion first,
100 send it "To:" the mailing list, and optionally "cc:" him.  If it
101 is trivially correct or after the list reached a consensus, send
102 it "To:" the maintainer and optionally "cc:" the list.
103
104 Also note that your maintainer does not actively involve himself in
105 maintaining what are in contrib/ hierarchy.  When you send fixes and
106 enhancements to them, do not forget to "cc: " the person who primarily
107 worked on that hierarchy in contrib/.
108
109
110 (4) Sign your work
111
112 To improve tracking of who did what, we've borrowed the
113 "sign-off" procedure from the Linux kernel project on patches
114 that are being emailed around.  Although core GIT is a lot
115 smaller project it is a good discipline to follow it.
116
117 The sign-off is a simple line at the end of the explanation for
118 the patch, which certifies that you wrote it or otherwise have
119 the right to pass it on as a open-source patch.  The rules are
120 pretty simple: if you can certify the below:
121
122         Developer's Certificate of Origin 1.1
123
124         By making a contribution to this project, I certify that:
125
126         (a) The contribution was created in whole or in part by me and I
127             have the right to submit it under the open source license
128             indicated in the file; or
129
130         (b) The contribution is based upon previous work that, to the best
131             of my knowledge, is covered under an appropriate open source
132             license and I have the right under that license to submit that
133             work with modifications, whether created in whole or in part
134             by me, under the same open source license (unless I am
135             permitted to submit under a different license), as indicated
136             in the file; or
137
138         (c) The contribution was provided directly to me by some other
139             person who certified (a), (b) or (c) and I have not modified
140             it.
141
142         (d) I understand and agree that this project and the contribution
143             are public and that a record of the contribution (including all
144             personal information I submit with it, including my sign-off) is
145             maintained indefinitely and may be redistributed consistent with
146             this project or the open source license(s) involved.
147
148 then you just add a line saying
149
150         Signed-off-by: Random J Developer <random@developer.example.org>
151
152 Some people also put extra tags at the end.  They'll just be ignored for
153 now, but you can do this to mark internal company procedures or just
154 point out some special detail about the sign-off.
155
156
157 ------------------------------------------------
158 MUA specific hints
159
160 Some of patches I receive or pick up from the list share common
161 patterns of breakage.  Please make sure your MUA is set up
162 properly not to corrupt whitespaces.  Here are two common ones
163 I have seen:
164
165 * Empty context lines that do not have _any_ whitespace.
166
167 * Non empty context lines that have one extra whitespace at the
168   beginning.
169
170 One test you could do yourself if your MUA is set up correctly is:
171
172 * Send the patch to yourself, exactly the way you would, except
173   To: and Cc: lines, which would not contain the list and
174   maintainer address.
175
176 * Save that patch to a file in UNIX mailbox format.  Call it say
177   a.patch.
178
179 * Try to apply to the tip of the "master" branch from the
180   git.git public repository:
181
182     $ git fetch http://kernel.org/pub/scm/git/git.git master:test-apply
183     $ git checkout test-apply
184     $ git reset --hard
185     $ git applymbox a.patch
186
187 If it does not apply correctly, there can be various reasons.
188
189 * Your patch itself does not apply cleanly.  That is _bad_ but
190   does not have much to do with your MUA.  Please rebase the
191   patch appropriately.
192
193 * Your MUA corrupted your patch; applymbox would complain that
194   the patch does not apply.  Look at .dotest/ subdirectory and
195   see what 'patch' file contains and check for the common
196   corruption patterns mentioned above.
197
198 * While you are at it, check what are in 'info' and
199   'final-commit' files as well.  If what is in 'final-commit' is
200   not exactly what you would want to see in the commit log
201   message, it is very likely that your maintainer would end up
202   hand editing the log message when he applies your patch.
203   Things like "Hi, this is my first patch.\n", if you really
204   want to put in the patch e-mail, should come after the
205   three-dash line that signals the end of the commit message.
206
207
208 Pine
209 ----
210
211 (Johannes Schindelin)
212
213 I don't know how many people still use pine, but for those poor
214 souls it may be good to mention that the quell-flowed-text is
215 needed for recent versions.
216
217 ... the "no-strip-whitespace-before-send" option, too. AFAIK it
218 was introduced in 4.60.
219
220 (Linus Torvalds)
221
222 And 4.58 needs at least this.
223
224 ---
225 diff-tree 8326dd8350be64ac7fc805f6563a1d61ad10d32c (from e886a61f76edf5410573e92e38ce22974f9c40f1)
226 Author: Linus Torvalds <torvalds@g5.osdl.org>
227 Date:   Mon Aug 15 17:23:51 2005 -0700
228
229     Fix pine whitespace-corruption bug
230
231     There's no excuse for unconditionally removing whitespace from
232     the pico buffers on close.
233
234 diff --git a/pico/pico.c b/pico/pico.c
235 --- a/pico/pico.c
236 +++ b/pico/pico.c
237 @@ -219,7 +219,9 @@ PICO *pm;
238             switch(pico_all_done){      /* prepare for/handle final events */
239               case COMP_EXIT :          /* already confirmed */
240                 packheader();
241 +#if 0
242                 stripwhitespace();
243 +#endif
244                 c |= COMP_EXIT;
245                 break;
246  
247
248 (Daniel Barkalow)
249
250 > A patch to SubmittingPatches, MUA specific help section for
251 > users of Pine 4.63 would be very much appreciated.
252
253 Ah, it looks like a recent version changed the default behavior to do the
254 right thing, and inverted the sense of the configuration option. (Either
255 that or Gentoo did it.) So you need to set the
256 "no-strip-whitespace-before-send" option, unless the option you have is
257 "strip-whitespace-before-send", in which case you should avoid checking
258 it.
259
260
261 Thunderbird
262 -----------
263
264 (A Large Angry SCM)
265
266 Here are some hints on how to successfully submit patches inline using
267 Thunderbird.
268
269 This recipe appears to work with the current [*1*] Thunderbird from Suse.
270
271 The following Thunderbird extensions are needed:
272         AboutConfig 0.5
273                 http://aboutconfig.mozdev.org/
274         External Editor 0.7.2
275                 http://globs.org/articles.php?lng=en&pg=8
276
277 1) Prepare the patch as a text file using your method of choice.
278
279 2) Before opening a compose window, use Edit->Account Settings to
280 uncheck the "Compose messages in HTML format" setting in the
281 "Composition & Addressing" panel of the account to be used to send the
282 patch. [*2*]
283
284 3) In the main Thunderbird window, _before_ you open the compose window
285 for the patch, use Tools->about:config to set the following to the
286 indicated values:
287         mailnews.send_plaintext_flowed  => false
288         mailnews.wraplength             => 0
289
290 4) Open a compose window and click the external editor icon.
291
292 5) In the external editor window, read in the patch file and exit the
293 editor normally.
294
295 6) Back in the compose window: Add whatever other text you wish to the
296 message, complete the addressing and subject fields, and press send.
297
298 7) Optionally, undo the about:config/account settings changes made in
299 steps 2 & 3.
300
301
302 [Footnotes]
303 *1* Version 1.0 (20041207) from the MozillaThunderbird-1.0-5 rpm of Suse
304 9.3 professional updates.
305
306 *2* It may be possible to do this with about:config and the following
307 settings but I haven't tried, yet.
308         mail.html_compose                       => false
309         mail.identity.default.compose_html      => false
310         mail.identity.id?.compose_html          => false
311