Renamed configure.in to the more modern name configure.ac
[mmh] / docs / README.developers
index f941e38..31a6e46 100644 (file)
@@ -1,8 +1,6 @@
 #
 # README.developers
 #
-# $Id$
-#
 
 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
@@ -21,19 +19,17 @@ GNU autoconf (<ftp://ftp.gnu.org/pub/gnu/autoconf/>).  Nmh is currently using
 a minimum of autoconf 2.54.
 
 Most of the configure-related files are automatically generated.  The only files
-you should need to manually edit are acconfig.h and configure.in.  Don't, for
+you should need to manually edit are acconfig.h and configure.ac.  Don't, for
 instance, edit config.h.in.  Though it is an input file from the point of view
 of the users (and the configure script) it is an output file from the point of
 view of the developers (and the autoconf script).
 
 Note that the automatically generated autoconf files (such as config.h.in,
-stamp-h.in, and configure), are NOT kept in CVS.  Thus, when you check out
-a CVS tree, you need to do the following things before you can build
+stamp-h.in, and configure), are NOT kept in git.  Thus, when you check out
+a git tree, you need to run the autogen.sh script before you can build
 anything:
 
-       % autoheader
-       % autoconf
-       % date > stamp-h.in
+       % ./autogen.sh
 
 -------------------
 directory structure
@@ -123,6 +119,18 @@ zotnet/tws/ (deprecated, now in sbr/)
     away completely.
 
 
+---
+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
+the nmh repository:
+
+    % git clone git://git.savannah.nongnu.org/nmh.git
+
+
 -------------------------------------------------------
 nmh-local functions to use in preference to OS versions
 -------------------------------------------------------
@@ -201,27 +209,32 @@ is to use something like "1.0.4-RC1"):
     Then scp them across:
     % scp -p nmh-1.0.4.tar.gz* youruser@dl.sv.nongnu.org:/releases/nmh/
 
-14. FIXME -- I suspect that at least some of the mailing lists here are not
-    correct any more. Needs checking.
+14. Update the http://www.nongnu.org/nmh/ homepage. (It lives in the 'webpages
+    repository'; see https://savannah.nongnu.org/cvs/?group=nmh)
+
+15. Add a news item to the savannah nmh page. You'll have to submit it first
+    and then separately approve it (under News->Manage).
 
-    Send an announcement to exmh-users@redhat.com, exmh-workers@redhat.com,
-    mh-users@ics.uci.edu, and nmh-announce@mhost.com.  If the release fixes
-    significant security holes, also send an announcement to
-    bugtraq@securityfocus.com.  The exmh lists require you to be subscribed in
-    order to post.  Note that you don't need to post separately to comp.mail.mh,
-    as the mh-users mailing list is apparently bidirectionally gatewayed to it.
+16. Send the release announcement email to the following places:
+     nmh-workers@nongnu.org
+     nmh-announce@nongnu.org
+     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
+    in order to post.  Note that you don't need to post separately to
+    comp.mail.mh, as the mh-users mailing list is apparently bidirectionally
+    gatewayed to it.
 
     Preferably, the announcement should contain the MD5 hash generated above,
-    and should be PGP-signed.  It should include the FTP URL for the tarball as
+    and should be PGP-signed.  It should include the URL for the tarball as
     well as the URL of the website.  It should contain a brief summary of
     visible changes, as well as the URL of the cvsweb diff page that would show
-    a detailed list of changes.  The changes between 1.0.3 and 1.0.4 would be
+    a detailed list of changes.  The changes between 1.2 and 1.3 would be
     shown by:
 
-        http://www.mhost.com/cgi-bin/cvsweb/nmh/ChangeLog?r1=1.40&r2=1.71
+        http://cvs.savannah.gnu.org/viewvc/nmh/ChangeLog?root=nmh&r1=1.215&r2=1.254.2.13
 
-15. Add a news item to the savannah nmh page. You'll have to submit it first
-    and then separately approve it (under News->Manage).
-
-16. Update the http://www.nongnu.org/nmh/ homepage. (It lives in the 'webpages
-    repository'; see https://savannah.nongnu.org/cvs/?group=nmh)