[armedbear-cvs] r11952 - public_html/staging

Tue May 26 18:02:12 UTC 2009

Author: vvoutilainen
Date: Tue May 26 14:02:03 2009
New Revision: 11952

Log:
Patching guide.


Modified:
   public_html/staging/contributing.shtml

Modified: public_html/staging/contributing.shtml
==============================================================================

--- public_html/staging/contributing.shtml	(original)
+++ public_html/staging/contributing.shtml	Tue May 26 14:02:03 2009
@@ -5,7 +5,7 @@
 <head>
   <title>Contributing: Armed Bear Common Lisp (ABCL) - Common Lisp on the JVM</title>
   <link rel="stylesheet" type="text/css" href="style.css"/>
-  <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+ -equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
 </head>
 
 <body>
@@ -29,5 +29,46 @@
  </div>
 <div style="float:right;font-size:10px;font-family:monospace">$Id$</div>
 </div>
+
+<div>
+  <h2>A quick guide to producing patches for ABCL</h2>
+
+This guide describes how to contribute patches to ABCL, while making
+sure that the patch doesn't introduce regressions.
+
+<ol>
+  <li> Build abcl and run the ansi-tests with the pristine tree before making patches
+    and store the test results. Invoke the following commands from the
+    abcl main directory:
+    <code>
+      <br/>ant abcl.clean
+      <br/>ant abcl.wrapper
+      <br/>ant test.ansi.interpreted
+      <br/>ant test.ansi.compiled
+    </code>
+    <br/>The test runs will report where their logs are written, keep those
+    files at hand for comparing them with later runs with modified code.
+  </li>
+  <li>
+    Develop your patch.
+  </li>
+  <li>
+    Build abcl and run the ansi-tests with your modification and store the test results.
+    The commands are as in the first step.
+  </li>
+  <li>
+    Compare the new test results with the pristine results, if there are no
+    additional failures, the patch should be ok. Example comparison for
+    linux would be
+    <code>
+    <br/>diff -u abcl-test-20093726-2037.log abcl-test-20094426-2044.log
+    </code>
+    <br/>Note that the file names are generated dynamically by the test runs. 
+    The list of failed tests can be found at the end of the log, so that's
+    practically the only thing you're interested in. If the lists don't
+    differ, you've successfully created a patch with no ansi-test regressions.
+  </li>
+</ol>
+</div>
 </body>
 </html>


