r234 - html/trunk/patches

jhuntwork at linuxfromscratch.org jhuntwork at linuxfromscratch.org
Mon Jun 13 07:38:34 PDT 2005


Author: jhuntwork
Date: 2005-06-13 08:38:34 -0600 (Mon, 13 Jun 2005)
New Revision: 234

Modified:
   html/trunk/patches/submit.html
Log:
Tweks to patches/submit.html - Bringing into compliance with rest of site.

Modified: html/trunk/patches/submit.html
===================================================================
--- html/trunk/patches/submit.html	2005-06-13 14:31:51 UTC (rev 233)
+++ html/trunk/patches/submit.html	2005-06-13 14:38:34 UTC (rev 234)
@@ -3,19 +3,15 @@
 <!--#include virtual="menu.html" -->
     <div class="main">
 
-<h1>Patches Submission Guidelines:</h1>
-<ul>
-	<li>
-		<p>Before submitting a patch, check if there is an already existing patch for the current version or a previous version. If there is a patch for the previous version that applies without an error (Note: Getting an offset/fuzz when applying the patch is not an error) just drop a note on the list and the patches maintainers will copy the file over to the new version.</p>
-	</li>
-	<li>
-		<p>A suggested command for creating the patch file is:</p>
-		<p>LC_ALL=C TZ=UTC0 diff -Naur [old...] [new...] > [patch name...].patch</p>
-		<p>Note that this is not an absolute requirement and you are free to create the patch any way you like as long as the following requirement is satisfied.  When creating the patch, you should be in a directory just above the package directory so that the resulting patch can be applied with <code>patch -p1</code> as per the current instructions in the book.</p>
-	</li>
-	<li>
-		<p>The patch file name should be in the following format:</p>
-		<p><code>${packageName}-${packageVersion}-${patchName}-${patchVersion}.patch</code></p>
+<h1>Patches Submission Guidelines</h1>
+	<p>Before submitting a patch, check if there is an already existing patch for the current version or a previous version. If there is a patch for the previous version that applies without an error (Note: Getting an offset/fuzz when applying the patch is not an error) just drop a note on the list and the patches maintainers will copy the file over to the new version.</p>
+	<p>A suggested command for creating the patch file is:</p>
+	<div class="cmd">
+	  <p>LC_ALL=C TZ=UTC0 diff -Naur [old...] [new...] > [patch name...].patch</p>
+	</div>
+	<p>Note that this is not an absolute requirement and you are free to create the patch any way you like as long as the following requirement is satisfied.  When creating the patch, you should be in a directory just above the package directory so that the resulting patch can be applied with <code>patch -p1</code> as per the current instructions in the book.</p>
+	<p>The patch file name should be in the following format:</p>
+	<p>${packageName}-${packageVersion}-${patchName}-${patchVersion}.patch</p>
 		<dl>
 			<dt>packageName</dt>
 				<dd>Official name of the package. Be sure to follow the same capitalization that is followed by the official tarball for the package (i.e. cracklib would be cracklib,2.7, gcc would be gcc-3.3.4, etc.). changing conventions (e.g. ',' or '-' or differing package names) shouldn't be a consideration - it's up to upstream how they package their tarballs and we should reflect their naming convention. Where package descriptions have multiple words, those words should be '_' separated to differentiate between the '-' separated fields we have on the patches project at present.</dd>
@@ -26,8 +22,6 @@
 			<dt>patchVersion</dt>
 				<dd>Version of the patch (starting at 1, if there is no previous version). This field is mandatory.</dd>
 		</dl>
-	</li>
-	<li>
 		<p>The patch should have the following information, each item on a seperate line and in the same order (Be sure to follow the capitalization of the headers so that it is easier for scripts to parse the fields):</p>
 		<dl>
 			<dt>Submitted By</dt>
@@ -46,10 +40,8 @@
 				<dd>Description of what the patch does, links to more information related to the patch, etc. The more information you give to potential appliers of the patch, the better chance it has of being used. If you are modifying an existing patch, be sure to credit the original author.</dd>
 		</dl>
 		<p><em>Note: See the <a href="package-1.0-sample4patch.patch">sample patch</a>.</em></p>
-	</li>
-	<li><p>Patches should be mailed to <a href="http://linuxfromscratch.org/mailman/listinfo/patches/" title="Archive and subscription information for the patches mailinglist">the patches mailing list</a>. The patches maintainers prefer receiving download URIs also along with the patches. Even if you include a URI, please attach the patch along with your submission for the archives. Please gzip or bzip2 the patches so that it is easy for people to download the patches directly from the list archives. At the same time it saves some bandwidth. The patches will be gunziped or bunzip2ed before uploading so that they can be viewed online.</p>
-		<p>You can use <a href="downloads/MAINTAINER/lfspatch">this script</a> to automatically generate and e-mail the proper patch. You may also use <a href="downloads/MAINTAINER/checkPatch">the checkPatch script</a> to verify that all the required headers are available in the patch.</p></li>
-	<li><p>Refer to <a href="http://linuxfromscratch.org/mailman/listinfo/patches/">the mailing list information page</a> for details on the mailing list.</p></li>
-</ul>
+	<p>Patches should be mailed to <a href="http://linuxfromscratch.org/mailman/listinfo/patches/" title="Archive and subscription information for the patches mailinglist">the patches mailing list</a>. The patches maintainers prefer receiving download URIs also along with the patches. Even if you include a URI, please attach the patch along with your submission for the archives. Please gzip or bzip2 the patches so that it is easy for people to download the patches directly from the list archives. At the same time it saves some bandwidth. The patches will be gunziped or bunzip2ed before uploading so that they can be viewed online.</p>
+		<p>You can use <a href="downloads/MAINTAINER/lfspatch">this script</a> to automatically generate and e-mail the proper patch. You may also use <a href="downloads/MAINTAINER/checkPatch">the checkPatch script</a> to verify that all the required headers are available in the patch.</p>
+	<p>Refer to <a href="http://linuxfromscratch.org/mailman/listinfo/patches/">the mailing list information page</a> for details on the mailing list.</p>
 
 <!--#include virtual="/common/footer.html" -->




More information about the website mailing list