Increased sizes of a couple of buffers.

[nmh] / docs / README.developers

diff --git a/docs/README.developers b/docs/README.developers
index ec0b29d7308528d4c791becc8fbf77e10f04d872..b7b99397d1aa3ab4e75e65ed098e7cfd0a681e78 100644 (file)
--- a/docs/README.developers
+++ b/docs/README.developers
@@ -1,4 +1,3 @@
-#
 # README.developers
 #
 
@@ -8,6 +7,7 @@ local info best encoded in a comment) are encouraged to share their wisdom here.
 
 Following a commit checklist, the topics are organized alphabetically.
 
+
 ----------------
 commit checklist
 ----------------
@@ -18,13 +18,15 @@ commit checklist
 4. man page and other documentation updated?
 5. docs/pending-release-notes updated?
 6. should commit message reference bug report?
-7. update/close bug report (with commit id)?
-8. notify nmh-users?
+7. be sure that commit message starts with one-line synopsis, then a blank line
+8. update/close bug report (with commit id)?
+9. notify nmh-users?
 
 
 ---------------------------------
 C library/system call usage notes
 ---------------------------------
+
 * Use m_mktemp2() or m_mktemp() instead of mkstemp(3) (see section on
   nmh temporary files below).
 * Use m_unlink() instead of unlink(3).
@@ -111,9 +113,16 @@ sbr/
     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.
 
+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
@@ -156,6 +165,7 @@ to any new branches that you create:
 
     % git config branch.autosetuprebase always
 
+
 -------------------------------------------------------
 nmh-local functions to use in preference to OS versions
 -------------------------------------------------------
@@ -193,15 +203,24 @@ nmh test suite
 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.
+
+Instead of echoing test progress, use start_test()/finish_test()
+from tests/common.sh.  These will report the particular test name,
+within the test, only if there is a failure.
+
 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
@@ -218,7 +237,7 @@ here; the convention for release candidates is to use something like
 
     Note you are still on the master branch at this point.  Mark the
     current revision as the branchpoint for the new release branch:
-    
+
     % git tag -a -m "This tag marks the point where we started the branch for 1.5" 1.5-branchpoint
 
     Now mark the master branch with a post-release version number (the
@@ -291,3 +310,19 @@ here; the convention for release candidates is to use something like
     it assumes that we tag with nmh-x_x-release from now on]:
 
         http://git.savannah.gnu.org/cgit/nmh.git/diff/?h=nmh-1_5-release?h=nmh-1_4-release
+
+
+---------------
+after a release
+---------------
+
+Keep an eye on Debian's packaging, especially what patches they have to
+apply, and the results of their Lintian checker, which even includes
+spelling errors in man pages and binaries.
+
+    https://sources.debian.net/src/nmh/1.6-16/debian/patches/
+    https://lintian.debian.org/full/az@debian.org.html#nmh
+
+Perhaps some nmh developer that uses Debian, or Ubuntu?, could provide
+package-building commands, including lintian(1), for Makefile.am so
+Lintian's complaints are known before release.