whitespace cleanup, mostly for docs
[openocd.git] / testing / index.html
1 <html>
2
3 <meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
4
5 <body>
6 <h1>Release testing</h1>
7 A release test must be done on code committed to git.
8 Commit, then test. That way one can know for sure *what* code was actually tested.
9 <p>
10 Note that this testing document does not have anything to do with testing that is done
11 before committing to git. It is a test document for released code. Pre-commit testing
12 is done mostly by the developer who has written the change. Sometimes code is committed
13 to synchronize work, even if it has known problems. Release testing is
14 done on code believed to be stable, often a couple of weeks old, and not by
15 the developers, but rather users and community testers who has the requisite hardware
16 and test setup. Also the testing will take place over an extended period of time.
17 <p>
18 All of the above makes it imperative that there can be no doubt about *which* code
19 is tested and thus all tests refer to committed code by subversion number.
20 <h1>Release procedure</h1>
21 OpenOCD mainline is work in progress.
22 Expect it to change daily and to have some quirks.
23 <p>If you need the latest released and tested version, look for binary snapshots of OpenOCD. Worst case look up the test result table below for the features that are important to you and extract and build the version that has the right cocktail of working features for you. You can also work with the community to address the problems you are seing. Testing work and bug reports are highly appreciated.</p>
24 <p>The OpenOCD community may decide to create release branches. If
25 this happens, then a branch will be created from OpenOCD mainline.
26 The particular version to create that branch might be an older version
27 rather than the latest and greatest. Fixes are then ported to that
28 release branch from OpenOCD mainline.</p>
29 <hr>
30 <h2>OpenOCD smoketests</h2>
31 This is a set of tests that exercise the entire OpenOCD system and various targets. It
32 is a small suite of systemwide smoketests.
33 <p>
34 <a href="smoketests.html">Smoketests</a>
35 <h2>Test cases</h2>
36 Additionally OpenOCD has test cases that target specific functionality more precisely.
37 <p>
38 A full release test must include both smoketests and unit testing.
39 <p>
40 <a href="testcases.html">Test cases</a>
41 </body>
42
43 </html>