git.marmaro.de Git - mmh/blob - docs/README.developers

   1 #
   2 # README.developers
   3 #
   4 # $Id$
   5 #
   6
   7 This file is intended to provide a few tips for anyone doing development on nmh.
   8 Developers who learn things "the hard way" about the nmh codebase (as opposed to
   9 local info best encoded in a comment) are encouraged to share their wisdom here.
  10
  11 The topics are organized alphabetically.
  12
  13
  14 --------------
  15 autoconf files
  16 --------------
  17
  18 If you wish to change the `configure' script or its related files, you'll need
  19 to first install GNU m4, available from <ftp://ftp.gnu.org/pub/gnu/m4/> and then
  20 GNU autoconf (<ftp://ftp.gnu.org/pub/gnu/autoconf/>).
  21
  22 Most of the configure-related files are automatically generated.  The only files
  23 you should need to manually edit are acconfig.h and configure.in.  Don't, for
  24 instance, edit config.h.in.  Though it is an input file from the point of view
  25 of the users (and the configure script) it is an output file from the point of
  26 view of the developers (and the autoconf script).
  27
  28 If you do change acconfig.h or configure.in and want to `cvs commit' them, be
  29 sure to regenerate the output files and commit them as well.  The easiest way to
  30 regenerate the files is to simply run `make' -- it'll do the necessary calls of
  31 autoconf and autoheader and will do a `./config.status --recheck', which will
  32 exercise your new configure script.
  33
  34 When you commit the configure-related files, it's very important to commit them
  35 in the right order.  The timestamps on the files in the CVS archive are based on
  36 the current time at the moment they were committed -- the timestamps from the
  37 local files you commit are not copied over.  If you commit the files in the
  38 wrong order, you'll cause unnecessary calls of `autoconf' to occur when people
  39 try to `make' their copies of the latest CVS source.  These people may be
  40 end-users who don't have any interest in changing the configure-related files
  41 and don't have autoconf installed.  They'll be unable to make without playing
  42 around with `touch'.
  43
  44 The correct procedure to commit the configure-related files is:
  45
  46     % cvs commit acconfig.h aclocal.m4 configure.in
  47     % autoconf && autoheader                          # or simply "make"
  48     % cvs commit config.h.in configure
  49     % make stamp-h.in                                 # or simply "make"
  50     % cvs commit stamp-h.in
  51
  52 The reason that the commits need to be split up is that the timestamps on the
  53 files change when the commits are done and the RCS Ids change.  If one committed
  54 all the files in one fell swoop (in the above relative order), timestamps would
  55 cause unnecessary autoconf regeneration on 'make's after the commit, which would
  56 waste your time and would cause your local stamp-h.in to be out-of-sync with the
  57 one checked into CVS (not the end of the world, but...).
  58
  59 If you haven't changed all the files noted above, just commit the ones you have,
  60 in the stated order (for instance, configure.in, then configure, then
  61 stamp-h.in).
  62
  63
  64 -------------------
  65 directory structure
  66 -------------------
  67
  68 Following is a list of nmh's directories along with a brief description of the
  69 purpose of each one.  Meanings are given for the abbreviations, but note that
  70 these meanings are just informed guesses as to what the MH developers were
  71 thinking.
  72
  73 ./
  74     The top-level directory.  Contains files like README and INSTALL.
  75
  76 config/
  77     Contains utility files for the `configure' process.  Ordinarily nothing in
  78     here needs to be messed with.
  79
  80 etc/
  81     Contains files, file templates, and scripts to generate files that will be
  82     installed in the ${prefix}/etc directory.  Stuff like replcomps.
  83
  84 h/
  85     Most of nmh's header (.h) files are kept not in the individual source
  86     directories, but in this central location.
  87
  88 man/
  89     Contains all the input files that are processed to generate nmh's manual
  90     pages.
  91
  92 mts/
  93     "mts" stands for "Message Transfer Service".  Source files specific to the
  94     different MTSs go in the subdirectories.
  95
  96 mts/mmdf/
  97     "mmdf" stands for "Multichannel Memorandum Distribution Facility".  It is an
  98     alternative to sendmail used primarily on SCO UNIX.
  99
 100 mts/sendmail/
 101     When nmh is configured --with-mts=sendmail, the files in this directory are
 102     used.
 103
 104 mts/smtp/
 105     When nmh is configured to just talk to an SMTP server over TCP/IP, the
 106     source in this directory is compiled.
 107
 108 sbr/
 109     "sbr" stands for "subroutine(s)".  For the most part, each source file in
 110     this directory contains a single function with the same name as the source
 111     file.  These functions are of general use and are called from throughout
 112     nmh.
 113
 114 uip/
 115     "uip" stands for "User Interface Programs".  Most nmh commands have a file
 116     in this directory named <command>.c containing the code for that command
 117     (e.g. repl.c).  In some cases there is also an auxiliary file called
 118     <command>sbr.c which contains additional subroutines called from <command>.c
 119     (which would contain not much else besides main()).
 120
 121 zotnet/
 122     Files in this hierarchy were either written by or moved here by UCI
 123     (University of California, Irvine) after they took over MH from the Rand
 124     Corporation.  "Zot!" is the sound effect made by the anteater in the "B.C."
 125     comic strip when its tongue lashes out at ants.  The anteater is UCI's
 126     official mascot.  Not sure whether UCInet was once called ZotNet...
 127
 128 zotnet/bboards/
 129     UCI added Bulletin Board functionality to MH with the `bbc' command.  This
 130     functionality has been removed from nmh but apparently files in this
 131     directory are still needed for other purposes.
 132
 133 zotnet/mf/
 134     "mf" stands for "Mail Filter".  The filtering in this case apparently refers
 135     to translation between different address and mailbox formats.
 136
 137 zotnet/mts/
 138     MTS code not specific to any single MTS apparently goes here.
 139
 140 zotnet/tws/
 141     No idea what "tws" stands for, other than 't' almost certainly standing for
 142     "time".  Date and time manipulation routines go here.
 143
 144
 145 -------------------------------------------------------
 146 nmh-local functions to use in preference to OS versions
 147 -------------------------------------------------------
 148
 149 For some system functions whose availability or behavior varies from OS to OS,
 150 nmh conditionally uses a local definition with the same name as the OS function
 151 (e.g. snprintf()).  For other functions, developers need to avoid the OS
 152 versions and always use the nmh-supplied function.  Here is a list of such
 153 functions:
 154
 155 OS function  nmh-local version to use instead
 156 ===========  ================================
 157 getpass()    nmh_getpass()
 158
 159
 160 -------------
 161 releasing nmh
 162 -------------
 163
 164 To make a public release of nmh (we'll use version 1.0.4 and my mhost.com
 165 account, danh, as examples here):
 166
 167  1. % echo 1.0.4 > VERSION
 168
 169  2. Put a comment like "Released nmh-1.0.4." in the ChangeLog.
 170
 171  3. % cvs commit ChangeLog VERSION
 172
 173  4. % cvs tag nmh-1_0_4
 174     (cvs treats dots specially, so underscores are substituted here.)
 175
 176  5. % make nmhdist
 177
 178  6. Untar nmh-1.0.4.tar.gz and `diff -r' it vs. your CVS tree.  Make sure no
 179     files got left out of the distribution that should be in it (due to someone
 180     forgetting to update the DIST variables in the Makefiles).
 181
 182  7. If you have root access on your machine, it's good at this point to do:
 183
 184     % chown -R 0:0 nmh-1.0.4
 185     % tar cvf nmh-1.0.4.tar nmh-1.0.4
 186     % gzip nmh-1.0.4.tar
 187
 188     If you leave the files in the archive as being owned by yourself, your UID
 189     may coincide with one of a user on a machine where nmh is being installed,
 190     making it possible for that user to Trojan the nmh code before the system
 191     administrator finishes installing it.
 192
 193  8. Make sure your new tarball uncompresses and untars with no problem.  Make
 194     sure you can configure, make, and install nmh from it.
 195
 196  9. If all is well and your tarball is final, go back to your CVS tree and do:
 197
 198     % echo 1.0.4+dev > VERSION
 199
 200 10. Put a comment like "Upped the version number to 1.0.4+dev until the next nmh
 201     release." in the ChangeLog.
 202
 203 11. % cvs commit ChangeLog VERSION
 204
 205 12. If possible, make an MD5 hash and/or a PGP signature of nmh-1.0.4.tar.gz.
 206
 207 13. % scp -p nmh-1.0.4.tar.gz* danh@mhost.com:/var/ftp/pub/nmh
 208
 209 14. Send an announcement to exmh-users@redhat.com, exmh-workers@redhat.com,
 210     mh-users@ics.uci.edu, and nmh-announce@mhost.com.  If the release fixes
 211     significant security holes, also send an announcement to
 212     bugtraq@securityfocus.com.  The exmh lists require you to be subscribed in
 213     order to post.  Note that you don't need to post separately to comp.mail.mh,
 214     as the mh-users mailing list is apparently bidirectionally gatewayed to it.
 215
 216     Preferably, the announcement should contain the MD5 hash generated above,
 217     and should be PGP-signed.  It should include the FTP URL for the tarball as
 218     well as the URL of the website.  It should contain a brief summary of
 219     visible changes, as well as the URL of the cvsweb diff page that would show
 220     a detailed list of changes.  The changes between 1.0.3 and 1.0.4 would be
 221     shown by:
 222
 223         http://www.mhost.com/cgi-bin/cvsweb/nmh/ChangeLog?r1=1.40&r2=1.71