summaryrefslogtreecommitdiffstats
path: root/tests/README
diff options
context:
space:
mode:
Diffstat (limited to 'tests/README')
-rw-r--r--tests/README25
1 files changed, 25 insertions, 0 deletions
diff --git a/tests/README b/tests/README
new file mode 100644
index 0000000..f606d1d
--- /dev/null
+++ b/tests/README
@@ -0,0 +1,25 @@
+Overview
+--------
+
+This tree contains unit tests.
+
+To compile and run the tests, do 'make check' (either in the top folder,
+or just in the folder containing the tests you're interested in).
+
+IMPORTANT: To compile the tests, you need to have the "Check" unit
+testing framework[1] installed.[2] If you have it installed, you will see
+"Unit tests: yes" in configure's summary message; if you don't see this
+message, you won't be able to compile the tests.[3]
+
+Tips and tricks
+---------------
+
+* To be able to step with the debugger into test code, see [4]. E.g., do:
+
+ $ export CK_FORK=no
+
+[1]: http://libcheck.github.io/check/
+[2]: Your package manager likely has it.
+[3]: Actually, some tests (like src/vfs/extfs/helpers-list) don't use
+ this framework and will compile just fine. But that's the exception.
+[4]: http://stackoverflow.com/questions/1649814/debugging-unit-test-in-c-using-check