Add HACKING document describing how to write test cases

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

3 files changed, 29 insertions, 1 deletions

diff --git a/HACKING b/HACKING
new file mode 100644
index 0000000..891c1d1
--- /dev/null
+++ b/HACKING
@@ -0,0 +1,25 @@
+Writing test for the X.Org Integration Test (XIT) suite
+
+== googletest ==
+You should be familiar with googletest
+http://code.google.com/p/googletest/wiki/Documentation
+
+This document well not detail googletest-only specific issues, it will focus
+on those parts that are specific to XIT.
+
+== Directory layout ==
+Tests are divided by general category:
+tests/input .... tests for specific input driver features or bugs
+tests/video .... tests for specific video driver features or bugs
+tests/server ... tests for server features or bugs
+tests/lib ...... tests for library features or bugs
+
+Each directory has a number of binaries that group the tests further. e.g.
+server/grab is a set of grab-related tests. Tests should go into existing
+binaries where sensible, but tests for new logical features should add new
+binaries. A test binary may have multiple source files.
+
+Ideally, each feature or behaviour group can be tested by running one
+binary.
+
+
diff --git a/Makefile.am b/Makefile.am
index 2241b19..8a17668 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -2,5 +2,5 @@ ACLOCAL_AMFLAGS = -Im4
 
 SUBDIRS = tests recordings doc
 
-EXTRA_DIST = autogen.sh
+EXTRA_DIST = autogen.sh HACKING
 
diff --git a/README b/README
index 72c42fc..1202ca4 100644
--- a/README
+++ b/README
@@ -56,3 +56,6 @@ allows to investigate logs or attach gdb to the server process.
 
 For further environment variables please refer to the xorg-gtest README
 http://cgit.freedesktop.org/xorg/test/xorg-gtest/tree/README
+
+== Writing tests ==
+Please refer to the HACKING document