tests/gem_ringfill: convert to subtest infrastructure

[platform/upstream/intel-gpu-tools.git] / README

diff --git a/README b/README
index 9992d33..92da60b 100644 (file)
--- a/README
+++ b/README
@@ -6,26 +6,56 @@ 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.  There are 3 subdirectories:
+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.
 
-Note that most of these tools must be run as root.  Several tools require
-MMIO register access (which may be denied if CONFIG_STRICT_DEVMEM is enabled).
-When an X Server is running, benchmarks and tests clients won't be able to
-run due to being unable to authenticate against it, unless you run them as
-root.
+       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"