summaryrefslogtreecommitdiff
path: root/Build/source/texk/xdvik/tests/README
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/texk/xdvik/tests/README')
-rw-r--r--Build/source/texk/xdvik/tests/README29
1 files changed, 29 insertions, 0 deletions
diff --git a/Build/source/texk/xdvik/tests/README b/Build/source/texk/xdvik/tests/README
new file mode 100644
index 00000000000..f92ceca8cf3
--- /dev/null
+++ b/Build/source/texk/xdvik/tests/README
@@ -0,0 +1,29 @@
+1. To run the tests:
+
+$ cd texk/xdvik
+$ make test
+
+or
+
+$ make test_verbose
+
+to see more details on the tests.
+
+
+
+2. To add a new test:
+
+(a) Adding a test to an existing test file:
+ - create a new function "static Boolean <test_name>(int verbosity)"
+ - add a register_test() call to the "register_all_...()" method
+ at the bottom of the file:
+ "register_test(<test_name>, "<short test description>")
+
+(b) Adding a new test file, e.g. test_foo.c:
+ - add test_foo.o to the "objects" definition in Makefile.in
+ - add a declaration for "extern void register_all_from_test_foo()" to run_tests.h
+ - add a call to "register_all_from_test_foo()" to run_tests.c
+ - define "register_all_from_test_foo(void)" at the botton of test_foo.c and
+ add register_test() methods for all test functions in the file
+ (see the existing test files for examples).
+ - rerun "make depend" as described in the toplevel file "README_maintainers".