docs/testsuite: add pointers to additional docs

This commit is contained in:
Michael Stapelberg 2012-09-10 14:13:43 +02:00
parent 338199913b
commit daf2b57222
1 changed files with 15 additions and 2 deletions

View File

@ -1,7 +1,7 @@
i3 testsuite
============
Michael Stapelberg <michael+i3@stapelberg.de>
September 2011
Michael Stapelberg <michael@i3wm.org>
September 2012
This document explains how the i3 testsuite works, how to use it and extend it.
It is targeted at developers who not necessarily have been doing testing before
@ -33,6 +33,19 @@ able to easily test if the feature is working correctly. Many developers will
test manually if everything works. Having a testcase not only helps you with
that, but it will also be useful for every future change.
== Relevant documentation
Apart from this document, you should also have a look at:
1. The "Modern Perl" book, which can be found at
http://onyxneon.com/books/modern_perl/modern_perl_a4.pdf
2. The latest Perl documentation of the "i3test" (general testcase setup) and
"i3test::Test" (additional test instructions) modules:
http://build.i3wm.org/docs/lib-i3test.html respectively
http://build.i3wm.org/docs/lib-i3test-test.html
3. The latest documentation on i3s IPC interface:
http://build.i3wm.org/docs/ipc.html
== Implementation
For several reasons, the i3 testsuite has been implemented in Perl: