]> diplodocus.org Git - nmh/blobdiff - docs/README.developers
Document the -dist flag.
[nmh] / docs / README.developers
index 86b2f897d66d923925f05cbdd7ea0bdf1ee88e8f..76f650dcbad534659bd47dce5998d3afea8b5db0 100644 (file)
@@ -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
 -------------