Update copyright to LGPL on all files
[dyninst.git] / dyninstAPI / tests / README
1
2 This directory contains tests for the dyninstAPI library.
3
4 To build the test programs, cd into the subdirectory of this directory that
5 is named after the platform you are running on, and type "make."  If you are
6 using the source distribution of the Dyninst API, you will need to make the
7 API libraries before making the tests; see the README file in the
8 dyninst/dyninstAPI directory for how to do this.
9
10 Before you can run the test programs you will need to set up your
11 environment to use the Dyninst API library, as described in the
12 documentation and the README file in the directory above this one
13 (specifically, the DYNINSTAPI_RT_LIB environment variable should be set).
14
15 To run the tests, type "test1," "test2," etc. in the subdirectory of this
16 directory named after the platform you are using.  Each test program starts
17 a mutatee process, the executable for which must be in the current
18 directory.  For both programs, you should see a series of messages saying
19 that each test was passed.
20
21 The programs take several options:
22     -verbose            Print extra output.
23     -attach             Start the mutatee without using the library and then
24                         attach to it.
25     -run <test numbers> Run only the specified test cases.
26
27 The test2 program tests to see that various error conditions are caught
28 and reported properly by the library, so it is normal for it to print some
29 warning and error messages.  If all tests pass, it will print a message
30 saying so, so you may assume any error messages printed were expected.