Add TestTimeout fixture

1 files changed, 14 insertions, 0 deletions

diff --git a/README b/README
index e00bcd8..574649f 100644
--- a/README
+++ b/README
@@ -335,3 +335,17 @@ Create a temporary directory and clean it up later.
 
 The created directory is stored in the ``path`` attribute of the fixture after
 setUp.
+
+TimeoutFixture
+++++++++++++++
+
+Interrupts tests if they take more than a specified number of whole wall-clock
+seconds.
+
+There are two possibilities, controlled by the 'gentle' argument: when gentle,
+an exception will be raised and the test will fail.  When not gentle, the
+entire test process will be terminated, which is less clean, but more likely to
+break hangs where no Python code is running.  You can only use one in any given
+test.
+
+Currently supported only on Unix because it relies on the ``alarm`` system call.