If -[no]concat is given to show(1), have it use showmimeproc instead

[nmh] / docs / README.developers

diff --git a/docs/README.developers b/docs/README.developers
index 3876ba6844e5789c4d81260fbb607d42d4a74fb2..1d3fd73799c93df756abf0f464ac81e6d7a9e632 100644 (file)
--- a/docs/README.developers
+++ b/docs/README.developers
@@ -6,7 +6,29 @@ This file is intended to provide a few tips for anyone doing development on nmh.
 Developers who learn things "the hard way" about the nmh codebase (as opposed to
 local info best encoded in a comment) are encouraged to share their wisdom here.
 
 Developers who learn things "the hard way" about the nmh codebase (as opposed to
 local info best encoded in a comment) are encouraged to share their wisdom here.
 

-The topics are organized alphabetically.
+Following a commit checklist, the topics are organized alphabetically.
+
+----------------
+commit checklist
+----------------
+
+1. code updated?
+2. test added?
+3. make distcheck passed?
+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?
+
+
+---------------------------------
+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).
+* Use done() instead of _exit(3) except after a fork(3).

 
 
 -------------------------
 
 
 -------------------------


@@ -18,7 +40,7 @@ or other related files, you'll need to first install GNU m4, available
 from <ftp://ftp.gnu.org/pub/gnu/m4/>, then GNU autoconf
 (<ftp://ftp.gnu.org/pub/gnu/autoconf/>) and GNU automake
 (<ftp://ftp.gnu.org/pub/gnu/automake/>).  Nmh is currently using a
 from <ftp://ftp.gnu.org/pub/gnu/m4/>, then GNU autoconf
 (<ftp://ftp.gnu.org/pub/gnu/autoconf/>) and GNU automake
 (<ftp://ftp.gnu.org/pub/gnu/automake/>).  Nmh is currently using a

-minimum of autoconf 2.61 and automake 1.10.
+minimum of autoconf 2.68 and automake 1.12.

 
 Most of the configure-related files are automatically generated.
 The only files you should need to manually edit are configure.ac
 
 Most of the configure-related files are automatically generated.
 The only files you should need to manually edit are configure.ac


@@ -107,15 +129,32 @@ git
 As of December 2010, nmh has switched to using git for revision control
 instead of CVS.  While the topic of git is beyond the scope of this FAQ,
 to get started with git & nmh, you can run the following command to checkout
 As of December 2010, nmh has switched to using git for revision control
 instead of CVS.  While the topic of git is beyond the scope of this FAQ,
 to get started with git & nmh, you can run the following command to checkout

-the nmh repository:
+the nmh repository (with read-only access to it):

 
     % git clone git://git.savannah.nongnu.org/nmh.git
 
 
     % git clone git://git.savannah.nongnu.org/nmh.git
 

-That will create a workspace call nmh.  To update that workspace
+That will create a workspace called nmh.  To update that workspace

 with changes to the master, cd to it and run:
 
     % git pull
 
 with changes to the master, cd to it and run:
 
     % git pull
 

+If you are a project member and want write access to the repository,
+you'll have to checkout with the following command instead of the one
+above:
+
+    % git clone <username>@git.sv.nongnu.org:/srv/git/nmh.git
+
+We suggest using git pull --rebase instead of the default merge for
+git pull.  If you don't want to add the --rebase option every time,
+you can tell git pull to always rebase in your nmh workspace by
+cd'ing to it and running the following command:
+
+    % git config --bool branch.master.rebase true
+
+And you'll probably want the following, also, so that --rebase applies
+to any new branches that you create:
+
+    % 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


@@ -132,13 +171,45 @@ OS function  nmh-local version to use instead
 getpass()    nmh_getpass()
 
 
 getpass()    nmh_getpass()
 
 

+-------------------
+nmh temporary files
+-------------------
+
+To create a temporary file, use m_mktemp2() or m_mktemp().  They use
+mkstemp(3), but they also register the temporary file for removal on
+program termination.  So, do not use mkstemp() directly.
+
+To further support this, nmh_init() must be called at the beginning of
+main().  And, if a child process is not going to immediately call one
+of the exec(3) functions or _exit(3) after a fork(3), it should call
+unregister_for_removal(0).  Finally, nmh_init() sets up signal handlers
+for several signals:  these signal handlers should not be disabled.
+
+
+--------------
+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
 -------------
 
 -------------
 releasing nmh
 -------------
 

-To make a public release of nmh (we'll use version 1.5 and my mhost.com
-account, danh, as examples here; the convention for release candidates
-is to use something like "1.5-RC1"):
+To make a public release of nmh (we'll use version 1.5 as the example
+here; the convention for release candidates is to use something like
+"1.5-RC1"):

 
  1. % echo 1.5 > VERSION
     % date +"%e %B %Y" > DATE
 
  1. % echo 1.5 > VERSION
     % date +"%e %B %Y" > DATE


@@ -161,7 +232,7 @@ is to use something like "1.5-RC1"):
 
  5. If all is well and your tarball is final, go back to your workspace and do:
 
 
  5. If all is well and your tarball is final, go back to your workspace and do:
 

-    % echo 1.0.4+dev > VERSION
+    % echo 1.5+dev > VERSION

 
  6. % git commit VERSION; git push
 
 
  6. % git commit VERSION; git push
 


@@ -185,7 +256,6 @@ is to use something like "1.5-RC1"):
      exmh-users@redhat.com
      exmh-workers@redhat.com
      mh-e-users@lists.sourceforge.net
      exmh-users@redhat.com
      exmh-workers@redhat.com
      mh-e-users@lists.sourceforge.net

-     mh-users@ics.uci.edu *or* comp.mail.mh (there is a bidirectional gateway)

 
     If the release fixes significant security holes, also send an announcement
     to bugtraq@securityfocus.com.  The exmh lists require you to be subscribed
 
     If the release fixes significant security holes, also send an announcement
     to bugtraq@securityfocus.com.  The exmh lists require you to be subscribed