lib: allow igt_skip_on_simulation outside of fixtures.

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

diff --git a/README b/README
index c484a93..66462c8 100644 (file)
--- a/README
+++ b/README
@@ -24,17 +24,10 @@ tests/
        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 set of tests and is useful 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 for
-         the details.
+       Note: The old automake based testrunner had to be scraped due to
+       upstream changes which broke dynamic creation of the test list. Of
+       course it is still possible to directly run tests, even when not always
+       limiting tests to specific subtests (like piglit does).
 
        The more comfortable way to run tests is with piglit. First grab piglit
        from:
@@ -47,6 +40,16 @@ tests/
        piglit-sources $ cd bin
        piglit-sources/bin $ ln $i-g-t-sources igt -s
 
+       To avoid some hassles with piglit's use of Waffle just disable it. Run
+
+       piglit-sources $ cmake -D PIGLIT_USE_WAFFLE=OFF .
+
+       With
+
+       piglit-sources $ ccmake .
+
+       you can check your configuration with a curses interface, too.
+
        The tests in the i-g-t sources need to have been built already. Then we
        can run the testcases with (as usual as root, no other drm clients
        running):
@@ -60,6 +63,18 @@ tests/
 
        for some useful options.
 
+       Piglit only runs a default set of tests and is useful 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 for
+         the details.
+
+       When creating new tests or subtests please read and follow
+       tests/NAMING-CONVENTION.
+
 lib/
        Common helper functions and headers used by the other tools.
 
@@ -94,3 +109,21 @@ debugger/
        initiating connections with debug clients..
 
        The debugger must be run as root: "sudo debugger/eudb"
+
+docs/
+       Thus far just contains the autogenerated intel-gpu-tools libraries
+       reference documenation in docs/reference/ You need to have the gtk doc
+       tools installed to generate this API documentation.
+
+DEPENDENCIES
+       This is a non-exchaustive list of package dependencies required for
+       building everything:
+
+       libpciaccess-dev
+       libdrm-dev
+       xutils-dev
+       libcairo2-dev
+       swig2.0
+       libpython3.3-dev
+       x11proto-dri2-dev
+       gtk-doc-tools