Added a couple of new directories and a note about valgrind

warnings from debuginfo to README.developers.

diff --git a/docs/README.developers b/docs/README.developers
index ec0b29d..eb770fc 100644 (file)
--- a/docs/README.developers
+++ b/docs/README.developers
@@ -111,9 +111,16 @@ sbr/
     file.  These functions are of general use and are called from throughout
     nmh.
 
     file.  These functions are of general use and are called from throughout
     nmh.
 

+SPECS/
+    Contains files such as RPM specs.
+

 test/
     The num unit test suite.
 
 test/
     The num unit test suite.
 

+tools/
+    "tools" contains tools, scripts, and supporting files used by the
+    developers while writing, debugging, and testing the code.
+

 uip/
     "uip" stands for "User Interface Programs".  Most nmh commands have a file
     in this directory named <command>.c containing the code for that command
 uip/
     "uip" stands for "User Interface Programs".  Most nmh commands have a file
     in this directory named <command>.c containing the code for that command


@@ -156,6 +163,7 @@ to any new branches that you create:
 
     % git config branch.autosetuprebase always
 
 
     % git config branch.autosetuprebase always
 

+

 -------------------------------------------------------
 nmh-local functions to use in preference to OS versions
 -------------------------------------------------------
 -------------------------------------------------------
 nmh-local functions to use in preference to OS versions
 -------------------------------------------------------


@@ -193,15 +201,20 @@ nmh test suite
 The nmh test suite is run through the Makefile, with "make check"
 or "make distcheck".
 
 The nmh test suite is run through the Makefile, with "make check"
 or "make distcheck".
 

+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.
+

 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.
 
 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.
+If valgrind complains about "serious error when reading debuginfo"
+from a library, either update or remove the debuginfo package for
+the offending library.
+

 
 -------------
 releasing nmh
 
 -------------
 releasing nmh