comparison test/automated/README @ 3259:22ac66da0765

Merged Edgar's code changes from Google Summer of Code 2009
author Sam Lantinga <slouken@libsdl.org>
date Mon, 07 Sep 2009 05:06:34 +0000
parents
children
comparison
equal deleted inserted replaced
3258:e786366ea23b 3259:22ac66da0765
1
2
3 SDL Automated Testing Framework User Documentation
4 by Edgar Simo Serra
5
6
7
8 Abstract
9
10 The SDL Automated Testing Framework, hereby after called SDL_AT, is a meant
11 to test the SDL code for regressions and other possible failures. It can also
12 be used to display what your SDL set up supports.
13
14
15
16 Basics
17
18 The main way to use the framework is to compile it and run it, that can be
19 done with the following command:
20
21 $> make test
22
23 It should then display something like:
24
25 Platform : All tests successful (2)
26 SDL_RWops : All tests successful (5)
27 SDL_Surface : All tests successful (6)
28 Rendering with x11 driver : All tests successful (4)
29
30 Indicating that all tests were successful. If however a test fails output it
31 will report the failure to stderr indicating where and why it happened. This
32 output can then be sent to the developers so they can attempt to fix the
33 problem.
34
35
36
37 Advanced
38
39 By passing the "-h" or "--help" parameter to testsdl you can get an overview
40 of all the possible options you can set to furthur tweak the testing. A sample
41 of the options would be the following:
42
43 Usage: ./testsdl [OPTIONS]
44 Options are:
45 -m, --manual enables tests that require user interaction
46 --noplatform do not run the platform tests
47 --norwops do not run the rwops tests
48 --nosurface do not run the surface tests
49 --norender do not run the render tests
50 -v, --verbose increases verbosity level by 1 for each -v
51 -q, --quiet only displays errors
52 -h, --help display this message and exit
53
54
55
56 Developers
57
58 See SDL_at.h for developer information.
59