Created DATE that contains a datestamp used in the man pages. It should be updated...
[mmh] / docs / README.developers
index 9314563..14cf138 100644 (file)
@@ -41,12 +41,23 @@ end-users who don't have any interest in changing the configure-related files
 and don't have autoconf installed.  They'll be unable to make without playing
 around with `touch'.
 
-The correct order to commit the configure-related files is:
+The correct procedure to commit the configure-related files is:
 
-% cvs commit acconfig.h aclocal.m4 config.h.in configure.in configure stamp-h.in
+    % cvs commit acconfig.h aclocal.m4 configure.in
+    % autoheader; autoconf; date > stamp-h.in
+    % cvs commit config.h.in configure stamp-h.in
 
-If you haven't changed all of those files, just commit the rest in the
-stated order (e.g. cvs commit acconfig.h config.h.in stamp-h.in).
+The reason for the three-step commit is that configure.in contains the RCS $Id
+keyword, so when you commit it, a new version is written locally.  Therefore,
+the autoconf regeneration should be held off until after the commit, or your
+local stamp-h.in will become out-of-sync with the CVS version (granted, not that
+big a deal).  For the second step, you're doing the same commands as a 
+`make reset' would do, but using that command would require extra configure runs
+to make Makefile be up-to-date.
+
+If you haven't changed all the files noted above, just commit the ones you have
+changed, in the stated order (for instance, configure.in, then configure and
+stamp-h.in).
 
 
 -------------------
@@ -65,6 +76,10 @@ config/
     Contains utility files for the `configure' process.  Ordinarily nothing in
     here needs to be messed with.
 
+doc/
+    Contains more specialized documentation, such as this file and
+    the FAQ.
+
 etc/
     Contains files, file templates, and scripts to generate files that will be
     installed in the ${prefix}/etc directory.  Stuff like replcomps.
@@ -81,11 +96,11 @@ mts/
     "mts" stands for "Message Transfer Service".  Source files specific to the
     different MTSs go in the subdirectories.
 
-mts/mmdf/
+mts/mmdf/ (deprecated)
     "mmdf" stands for "Multichannel Memorandum Distribution Facility".  It is an
     alternative to sendmail used primarily on SCO UNIX.
 
-mts/sendmail/
+mts/sendmail/ (deprecated: handled by mts.conf)
     When nmh is configured --with-mts=sendmail, the files in this directory are
     used. 
 
@@ -106,28 +121,31 @@ uip/
     <command>sbr.c which contains additional subroutines called from <command>.c
     (which would contain not much else besides main()).
 
-zotnet/
+zotnet/ (deprecated)
     Files in this hierarchy were either written by or moved here by UCI
     (University of California, Irvine) after they took over MH from the Rand
     Corporation.  "Zot!" is the sound effect made by the anteater in the "B.C."
     comic strip when its tongue lashes out at ants.  The anteater is UCI's
     official mascot.  Not sure whether UCInet was once called ZotNet...
 
-zotnet/bboards/
+zotnet/bboards/ (deprecated)
     UCI added Bulletin Board functionality to MH with the `bbc' command.  This
     functionality has been removed from nmh but apparently files in this
     directory are still needed for other purposes.
 
-zotnet/mf/
+zotnet/mf/ (deprecated, now in sbr/)
     "mf" stands for "Mail Filter".  The filtering in this case apparently refers
     to translation between different address and mailbox formats.
 
-zotnet/mts/
+zotnet/mts/ (deprecated, now in sbr/)
     MTS code not specific to any single MTS apparently goes here.
 
-zotnet/tws/
-    No idea what "tws" stands for, other than 't' almost certainly standing for
-    "time".  Date and time manipulation routines go here.
+zotnet/tws/ (deprecated, now in sbr/)
+    "tws" apparently stands for "time with structure", a rather odd phrase.
+    This directory used to be the place for date and time manipulation code, but
+    currently nothing in here is compiled.  There are new, more portable
+    versions of the key files in h/ and sbr/, and this directory will soon go
+    away completely.
 
 
 -------------------------------------------------------
@@ -153,10 +171,12 @@ To make a public release of nmh (we'll use version 1.0.4 and my mhost.com
 account, danh, as examples here):
 
  1. % echo 1.0.4 > VERSION
+    % date +"%e %B %Y" > DATE
+    (DATE should contain something like "30 December 2000")
 
  2. Put a comment like "Released nmh-1.0.4." in the ChangeLog.
 
- 3. % cvs commit ChangeLog VERSION
+ 3. % cvs commit ChangeLog VERSION DATE
 
  4. % cvs tag nmh-1_0_4
     (cvs treats dots specially, so underscores are substituted here.)