comparison test/automated/README @ 3754:09d4fa3a787a gsoc2009_unit_tests

Added README.
author Edgar Simo <bobbens@gmail.com>
date Thu, 06 Aug 2009 16:58:24 +0000
parents
children e04d9c69a6fd
comparison
equal deleted inserted replaced
3753:5b48a529fd8a 3754:09d4fa3a787a
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 Usage: ./testsdl [OPTIONS]
40 Options are:
41 -m, --manual enables tests that require user interaction
42 --noplatform do not run the platform tests
43 --norwops do not run the rwops tests
44 --nosurface do not run the surface tests
45 --norender do not run the render tests
46 -v, --verbose increases verbosity level by 1 for each -v
47 -q, --quiet only displays errors
48 -h, --help display this message and exit
49