readme fixups
[platform/upstream/intel-gpu-tools.git] / README
1 This is a collection of tools for development and testing of the Intel DRM
2 driver.  There are many macro-level test suites that get used against our
3 driver, including xtest, rendercheck, piglit, and oglconform, but failures
4 from those can be difficult to track down to kernel changes, and many require
5 complicated build procedures or specific testing environments to get useful
6 results.
7
8 Thus, intel-graphics-tools was a project I started to collect some low-level
9 tools I intended to build.  There are 3 subdirectories:
10
11 benchmarks/
12         This should be a collection of useful microbenchmarks.  The hope is
13         that people can use these to tune some pieces of DRM code in relevant
14         ways.
15
16         The benchmarks require KMS to be enabled.  When run with an X Server
17         running, they must be run as root to avoid the authentication
18         requirement.
19
20 tests/
21         This is a set of automated tests to run against the DRM to validate
22         changes.  Hopefully this can cover the relevant cases we need to
23         worry about, including backwards compatibility.
24
25         To run the tests, do "sudo make check" from this directory with
26         KMS enabled.
27
28 tools/
29         This is a collection of debugging tools that had previously been
30         built with the 2D driver but not shipped.  Some distros were hacking
31         up the 2D build to ship them.  Instead, here's a separate package for
32         people debugging the driver.
33
34         These tools generally must be run as root.