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