X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/efd7ca5cc728e835a5caf0dfbece2651610b9e56..6946440669ed2620f59ce0f3c32da281e6e90968:/docs/README.developers

diff --git a/docs/README.developers b/docs/README.developers
index 86b2f897..76f650dc 100644
--- a/docs/README.developers
+++ b/docs/README.developers
@@ -162,6 +162,23 @@ OS function  nmh-local version to use instead
 getpass()    nmh_getpass()
 
 
+--------------
+nmh test suite
+--------------
+
+The nmh test suite is run through the Makefile, with "make check"
+or "make distcheck".
+
+To enable the use of valgrind, where available, set the environment
+variable NMH_VALGRIND to a non-null value.  However, a separate
+environment variable, VALGRIND_ME, triggers the use of valgrind in
+test/inc/test-eom-align because it greatly extends the duration of
+that test.
+
+In the nmh test suite, nmh programs to be tested should be invoked
+through the run_test or run_prog shell functions defined in
+test/common.sh.
+
 -------------
 releasing nmh
 -------------