Changeset 11952


Ignore:
Timestamp:
05/26/09 18:02:03 (14 years ago)
Author:
vvoutilainen
Message:

Patching guide.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • public_html/staging/contributing.shtml

    r11949 r11952  
    66  <title>Contributing: Armed Bear Common Lisp (ABCL) - Common Lisp on the JVM</title>
    77  <link rel="stylesheet" type="text/css" href="style.css"/>
    8   <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
     8 -equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
    99</head>
    1010
    … …  
    3030<div style="float:right;font-size:10px;font-family:monospace">$Id$</div>
    3131</div>
     32
     33<div>
     34  <h2>A quick guide to producing patches for ABCL</h2>
     35
     36This guide describes how to contribute patches to ABCL, while making
     37sure that the patch doesn't introduce regressions.
     38
     39<ol>
     40  <li> Build abcl and run the ansi-tests with the pristine tree before making patches
     41    and store the test results. Invoke the following commands from the
     42    abcl main directory:
     43    <code>
     44      <br/>ant abcl.clean
     45      <br/>ant abcl.wrapper
     46      <br/>ant test.ansi.interpreted
     47      <br/>ant test.ansi.compiled
     48    </code>
     49    <br/>The test runs will report where their logs are written, keep those
     50    files at hand for comparing them with later runs with modified code.
     51  </li>
     52  <li>
     53    Develop your patch.
     54  </li>
     55  <li>
     56    Build abcl and run the ansi-tests with your modification and store the test results.
     57    The commands are as in the first step.
     58  </li>
     59  <li>
     60    Compare the new test results with the pristine results, if there are no
     61    additional failures, the patch should be ok. Example comparison for
     62    linux would be
     63    <code>
     64    <br/>diff -u abcl-test-20093726-2037.log abcl-test-20094426-2044.log
     65    </code>
     66    <br/>Note that the file names are generated dynamically by the test runs.
     67    The list of failed tests can be found at the end of the log, so that's
     68    practically the only thing you're interested in. If the lists don't
     69    differ, you've successfully created a patch with no ansi-test regressions.
     70  </li>
     71</ol>
     72</div>
    3273</body>
    3374</html>
Note: See TracChangeset for help on using the changeset viewer.