summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README61
1 files changed, 61 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 00000000..92da60bb
--- /dev/null
+++ b/README
@@ -0,0 +1,61 @@
+This is a collection of tools for development and testing of the Intel DRM
+driver. There are many macro-level test suites that get used against our
+driver, including xtest, rendercheck, piglit, and oglconform, but failures
+from those can be difficult to track down to kernel changes, and many require
+complicated build procedures or specific testing environments to get useful
+results.
+
+Thus, intel-graphics-tools was a project I started to collect some low-level
+tools I intended to build.
+
+benchmarks/
+ This should be a collection of useful microbenchmarks. The hope is
+ that people can use these to tune some pieces of DRM code in relevant
+ ways.
+
+ The benchmarks require KMS to be enabled. When run with an X Server
+ running, they must be run as root to avoid the authentication
+ requirement.
+
+ Note that a few other microbenchmarks are in tests (like gem_gtt_speed).
+
+tests/
+ This is a set of automated tests to run against the DRM to validate
+ changes. Hopefully this can cover the relevant cases we need to
+ worry about, including backwards compatibility.
+
+ Run this tests with "make test" as root from this directory. Note that
+ no other drm clients (X server) may run.
+
+ "make test" only runs a default of test usefull for regression testing.
+ Other tests not run are:
+ - tests that might hang the gpu, see HANG in Makefile.am
+ - gem_stress, a stress test suite. Look at the source for all the
+ various options.
+ - testdisplay is only run in the default mode. testdisplay has tons of
+ options to test different kms functionality, again read the source of
+ the details.
+
+lib/
+ Common helper functions and headers used by the other tools.
+
+man/
+ Manpages, unfortunately rather incomplete.
+
+tools/
+ This is a collection of debugging tools that had previously been
+ built with the 2D driver but not shipped. Some distros were hacking
+ up the 2D build to ship them. Instead, here's a separate package for
+ people debugging the driver.
+
+ These tools generally must be run as root, safe for the ones that just
+ decode dumps.
+
+debugger/
+ This tool is to be used to do shader debugging. It acts like a
+ debug server accepting connections from debug clients such as
+ mesa. The connections is made with unix domain sockets, and at some
+ point it would be nice if this directory contained a library for
+ initiating connections with debug clients..
+
+ The debugger must be run as root: "sudo debugger/eudb"