|  | 
|  | 1 | +Index: doc/src/FAQ/FAQ_DEV.html | 
|  | 2 | +=================================================================== | 
|  | 3 | +RCS file: /projects/cvsroot/pgsql/doc/src/FAQ/FAQ_DEV.html,v | 
|  | 4 | +retrieving revision 1.107 | 
|  | 5 | +diff -c -r1.107 FAQ_DEV.html | 
|  | 6 | +*** doc/src/FAQ/FAQ_DEV.html	24 Dec 2005 19:29:38 -0000	1.107 | 
|  | 7 | +--- doc/src/FAQ/FAQ_DEV.html	16 Feb 2006 20:08:51 -0000 | 
|  | 8 | +*************** | 
|  | 9 | +*** 156,180 **** | 
|  | 10 | +       | 
|  | 11 | +      <H3 id="item1.5">1.5) I've developed a patch, what next?</H3> | 
|  | 12 | +   | 
|  | 13 | +!     <P>Generate the patch in contextual diff format. If you are | 
|  | 14 | +!     unfamiliar with this, you might find the script | 
|  | 15 | +!     <I>src/tools/makediff/difforig</I> useful.  Unified diffs are | 
|  | 16 | +!     only preferrable if the file changes are single-line changes and | 
|  | 17 | +!     do not rely on the surrounding lines.</P> | 
|  | 18 | +!  | 
|  | 19 | +!     <P>Ensure that your patch is generated against the most recent | 
|  | 20 | +!     version of the code. If it is a patch adding new functionality, the | 
|  | 21 | +!     most recent version is CVS HEAD; if it is a bug fix, this will be | 
|  | 22 | +!     the most recently version of the branch which suffers from the bug | 
|  | 23 | +!     (for more on branches in PostgreSQL, see <A href= | 
|  | 24 | +!     "#1.15">1.15</A>).</P> | 
|  | 25 | +!  | 
|  | 26 | +!     <P>Finally, submit the patch to [email protected] . It | 
|  | 27 | +      will be reviewed by other contributors to the project and will be | 
|  | 28 | +!     either accepted or sent back for further work. Also, please try to | 
|  | 29 | +!     include documentation changes as part of the patch. If you can't do | 
|  | 30 | +!     that, let us know and we will manually update the documentation when | 
|  | 31 | +!     the patch is applied.</P> | 
|  | 32 | +   | 
|  | 33 | +      <H3 id="item1.6">1.6) Where can I learn more about the | 
|  | 34 | +      code?</H3> | 
|  | 35 | +--- 156,231 ---- | 
|  | 36 | +       | 
|  | 37 | +      <H3 id="item1.5">1.5) I've developed a patch, what next?</H3> | 
|  | 38 | +   | 
|  | 39 | +!     <P>You will need to submit the patch to [email protected] . It | 
|  | 40 | +      will be reviewed by other contributors to the project and will be | 
|  | 41 | +!     either accepted or sent back for further work. To help ensure your patch | 
|  | 42 | +! 	is reviewed and committed in a timely fasion, please try to make sure your  | 
|  | 43 | +! 	submission conforms to the following guidelines: | 
|  | 44 | +! 	<ol> | 
|  | 45 | +! 		<li>Has the patch been discussed previously? If it has, give a direct link  | 
|  | 46 | +! 		to the message and/or bug# from the mail archives  | 
|  | 47 | +! 		(<a href="http://archives.postgresql.org/">http://archives.postgresql.org/</a>).  | 
|  | 48 | +! 		If it has not and the patch is of any complexity it is strongly  | 
|  | 49 | +! 		recommended you post a message to the appropriate list or you risk  | 
|  | 50 | +! 		getting your patch rejected. Refer back to <a href="#1.4">1.4</a> for  | 
|  | 51 | +! 		email guidelines.</li> | 
|  | 52 | +! 	 | 
|  | 53 | +! 		<li>Ensure that your patch is generated against the most recent version  | 
|  | 54 | +! 		of the code, which for developers is CVS HEAD. For more on branches in  | 
|  | 55 | +! 		PostgreSQL, see <a href="#1.15">1.15</a>.</li> | 
|  | 56 | +!  | 
|  | 57 | +! 		<li>Try to make your patch as readable as possible. Try to follow the  | 
|  | 58 | +! 		project's code-layout conventions; again, this makes it easier for the  | 
|  | 59 | +! 		reviewer, and there's no point in trying to do it  | 
|  | 60 | +! 		differently than pgindent.  Also avoid unnecessary whitespace  | 
|  | 61 | +! 		changes, they just distract the reviewer, and your formatting changes  | 
|  | 62 | +! 		will probably not survive the next pgindent run anyway.</li> | 
|  | 63 | +!  | 
|  | 64 | +! 		<li>The patch should be generated in contextual diff format and should  | 
|  | 65 | +! 		be applicable from the root directory. If you are unfamiliar with  | 
|  | 66 | +! 		this, you might find the script <I>src/tools/makediff/difforig</I>  | 
|  | 67 | +! 		useful.</li> | 
|  | 68 | +! 	 | 
|  | 69 | +! 		<li>PostgreSQL is licensed under a BSD license, so any submissions must  | 
|  | 70 | +! 		conform to the BSD license to be included. If you use code that is  | 
|  | 71 | +! 		available under some other license that is BSD compatible (eg. public  | 
|  | 72 | +! 		domain) please note that code in your email submission</li> | 
|  | 73 | +!  | 
|  | 74 | +! 		<li>Confirm that your changes can pass the regression tests and list the  | 
|  | 75 | +! 		platforms you have tested this on. If your changes are port specific,  | 
|  | 76 | +! 		list the ports that it applies to.</li> | 
|  | 77 | +!  | 
|  | 78 | +! 		<li>Provide an implementation overview, preferably in code comments.</li> | 
|  | 79 | +!  | 
|  | 80 | +! 		<li>If it is a performance patch, provide confirming test results to  | 
|  | 81 | +! 		show the benefits of your patch. It is OK to post patches without  | 
|  | 82 | +! 		this information, though the patch will not be applied until *somebody*  | 
|  | 83 | +! 		has tested the patches and found a valuable performance effect directly  | 
|  | 84 | +! 		attributable to the patch. Given that writing performance tests is not  | 
|  | 85 | +! 		terribly exciting, it is recommended you take this task upon yourself.</li> | 
|  | 86 | +!  | 
|  | 87 | +! 		<li>If it is a new feature patch, confirm that it has been tested for | 
|  | 88 | +! 		all desired scenarios. If it has not, this should be clearly stated as  | 
|  | 89 | +! 		a request for a particular kind of test to be performed. Note that the | 
|  | 90 | +! 		patch will go no further until that test has been performed.</li> | 
|  | 91 | +!  | 
|  | 92 | +! 		<li>New feature patches should also be accompanied by doc patches, and  | 
|  | 93 | +! 		pointers to any relevant sections of the SQL standard are recommended  | 
|  | 94 | +! 		as well. See <a href="#1.16">1.16</a> for more information on the  | 
|  | 95 | +! 		SQL standards.</li> | 
|  | 96 | +!  | 
|  | 97 | +! 		<li>If your patch changes any existing defaults, you will need to  | 
|  | 98 | +! 		explain why this is *required* or the patch will likely be rejected.</li>  | 
|  | 99 | +! 	</ol> | 
|  | 100 | +!  | 
|  | 101 | +! 	<p>Even if you pass all of the above, the patch may still be rejected | 
|  | 102 | +! 	for other technical reasons. You should be prepared to listen to | 
|  | 103 | +! 	comments received and perform any agreed rework. Even if you have | 
|  | 104 | +! 	received positive comments from some community members, others may spot | 
|  | 105 | +! 	problems with your approach, coding style or many other issues.</p> | 
|  | 106 | +!  | 
|  | 107 | +! 	<p>Successful patches will be notified to you by email and you will be | 
|  | 108 | +! 	credited for that work in the next set of release notes.</p> | 
|  | 109 | +   | 
|  | 110 | +      <H3 id="item1.6">1.6) Where can I learn more about the | 
|  | 111 | +      code?</H3> | 
0 commit comments