testing/index.html

   1 <html>
   2 <body>
   3 <h1>Testing</h1>
   4 A test should be done on code committed to svn. Commit, then test. That way
   5 one can know for sure *what* code was actually tested.
   6 <h1>Release procedure</h1>
   7 OpenOCD trunk is work in progress. Expect it to change daily and to have
   8 some work in progress.
   9 <p>
  10 If you need the latest released and tested version, look for binary snapshots of
  11 OpenOCD. Worst case look up the test result table below for the features
  12 that are important to you and extract and build the version that has the right
  13 cocktail of working features for you. You can also work with the community
  14 to address the problems you are seing. Testing work and bug reports are
  15 highly appreciated.
  16 <p>
  17 The OpenOCD community may decide to create release branches. If
  18 this happens, then a branch will be created from OpenOCD trunk. The particular
  19 version to create that branch might be an older version rather than the latest
  20 and greatest. Fixes are then ported to that release branch from OpenOCD trunk.
  21 <h2>Vocabulary</h2>
  22 <table border=1>
  23 <tr><td>Passed version</td><td>The latest version on which the test is known to pass</td></tr>
  24 <tr><td>Broken version</td><td>The latest version on which the test is known to fail. n/a when older than passed version.</td></tr>
  25 <tr><td>ID</td><td>A unqiue ID to refer to a test. The unique numbers are maintained in this file.</td></tr>
  26 </table>
  27
  28 <h1>OpenOCD test results</h1>
  29 These tests can be performed on any JTAG device as long
  30 as they are executed using the unmodified code from SVN.
  31 <p>
  32 The latest version in which the test is known to have
  33 passed is in the table below.
  34 <table border=1>
  35         <tr><th>ID</th><th>Synopsis</th><th>Passed version</th><th>Broken version</th></tr>
  36         <tr><td>ocd1</td><td>Telnet Windows</td><td>291</td><td>n/a</td></tr>
  37         <tr><td>ocd2</td><td>Telnet Linux</td><td>291</td><td>n/a</td></tr>
  38         <tr><td>ocd3</td><td>Telnet Cygwin</td><td>291</td><td>n/a</td></tr>
  39         <tr><td><a href="#test_ocd4">ocd4</a></td><td>ARM7 debugging</td><td>291</td></tr>
  40         <tr><td>xscale1</a></td><td>XScale debugging</td><td>291</td></tr>
  41         <tr><td>xscale2</a></td><td>XScale MMU</td><td>291</td></tr>
  42 </table>
  43 <h1>OpenOCD JTAG device test results</h1>
  44 Each JTAG device must be tested
  45 <table border=1>
  46         <tr><th>ID</th><th>Synopsis</th><th>Passed version</th><th>Broken version</th></tr>
  47         <tr><td>jtag1</td><td>Wiggler</td><td>291</td><td>n/a</td></tr>
  48         <tr><td>jtag2</td><td>Parport</td><td>291</td><td>n/a</td></tr>
  49         <tr><td>jtag3</td><td>...</td><td>291</td><td>n/a</td></tr>
  50 </table>
  51
  52 <h1>Policy on removing features from OpenOCD</h1>
  53 If a feature in OpenOCD is known to be broken and nobody has
  54 submitted a fix and the feature is causing trouble for
  55 maintainence, it can be removed from OpenOCD trunk. The threshold
  56 for temporarily removing something from OpenOCD trunk is low to
  57 ease maintainence and place the burden of maintainence on
  58 those that care about a feature.
  59 <p>
  60 Note that code is never deleted from OpenOCD svn, it remains
  61 in svn so if somebody sees a feature removed that they would
  62 like kept, they have but to port and fix that feature
  63 back up to main trunk. This document can be helpful in this
  64 regard in that the latest working version and the known broken
  65 version may be listed.
  66 <h1>Policy on adding features from OpenOCD</h1>
  67 To add a feature to OpenOCD, generally  it should not break any existing
  68 features and it should be functional and the code reasonably readable
  69 and useful to others in the OpenOCD community. The code does not
  70 have to be completed. Work in progress is fine for OpenOCD trunk.
  71 <p>
  72 Also new tests should be defined. Note that the code does not have
  73 to pass all the tests. In fact it can be helpful to have tests
  74 to describe facets that really should be working, but aren't
  75 done yet.
  76 <a name="test_ocd4">
  77 <h1>ocd4 - ARM7 debugging</h1>
  78 Connect to ARM7 device(any), use GDB load to load a program into RAM and single halt, resume and single step.
  79 </body>
  80 </html>