#
# README.developers
#
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.
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?
-------------------------
autoconf & automake files
-------------------------
If you wish to change the `configure' script, the generated Makefile
or other related files, you'll need to first install GNU m4, available
from , then GNU autoconf
() and GNU automake
(). Nmh is currently using a
minimum of autoconf 2.61 and automake 1.10.
Most of the configure-related files are automatically generated.
The only files you should need to manually edit are configure.ac
and any autoconf macros in the m4 directory. 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).
If you wish to add a new autoconf macro, it should be placed in it's
own file and put in the m4 directory; aclocal will automatically pick
it up and automake will add it to the distribution target automatically.
If you wish to make changes to the Makefile, you will need to edit
Makefile.am. See the automake documentation if you need further help.
You should always check changes to Makefile.am by using "make distcheck".
Note that the automatically generated autotools files (such as config.h.in,
Makefile.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:
% ./autogen.sh
-------------------
directory structure
-------------------
Following is a list of nmh's directories along with a brief description of the
purpose of each one. Meanings are given for the abbreviations, but note that
these meanings are just informed guesses as to what the MH developers were
thinking.
./
The top-level directory. Contains files like README and INSTALL.
config/
Contains utility files for the `configure' process. Ordinarily nothing in
here needs to be messed with.
docs/
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.
h/
Most of nmh's header (.h) files are kept not in the individual source
directories, but in this central location.
man/
Contains all the input files that are processed to generate nmh's manual
pages.
mts/
"mts" stands for "Message Transfer Service". Source files specific to the
different MTSs go in the subdirectories.
mts/smtp/
When nmh is configured to just talk to an SMTP server over TCP/IP, the
source in this directory is compiled.
sbr/
"sbr" stands for "subroutine(s)". For the most part, each source file in
this directory contains a single function with the same name as the source
file. These functions are of general use and are called from throughout
nmh.
test/
The num unit test suite.
uip/
"uip" stands for "User Interface Programs". Most nmh commands have a file
in this directory named .c containing the code for that command
(e.g. repl.c). In some cases there is also an auxiliary file called
sbr.c which contains additional subroutines called from .c
(which would contain not much else besides main()).
---
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
That will create a workspace call nmh. To update that workspace
with changes to the master, cd to it and run:
% git pull
-------------------------------------------------------
nmh-local functions to use in preference to OS versions
-------------------------------------------------------
For some system functions whose availability or behavior varies from OS to OS,
nmh conditionally uses a local definition with the same name as the OS function
(e.g. snprintf()). For other functions, developers need to avoid the OS
versions and always use the nmh-supplied function. Here is a list of such
functions:
OS function nmh-local version to use instead
=========== ================================
getpass() nmh_getpass()
-------------
releasing nmh
-------------
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
(DATE should contain something like "30 December 2000")
2. % git commit VERSION DATE; git push
3. % git tag -a 1.5 -m 'Releasing nmh-1.5.'
Note that the new convention for tagging is to simply tag with the
version number (tag formats in the past have varied).
4. % make distcheck
If you want to check the distribution build with some particular
configure options, set the DISTCHECK_CONFIGURE_FLAGS variable.
E.g.:
% make distcheck DISTCHECK_CONFIGURE_FLAGS=--with-cyrus-sasl
5. If all is well and your tarball is final, go back to your workspace and do:
% echo 1.5+dev > VERSION
6. % git commit VERSION; git push
7. Upload the distribution file to savannah. You can automate this process
by doing:
% make upload SAVANNAH_USERNAME=username
This will automatically call gpg to sign the release. You can bypass
this step by setting the SKIP_GPG_SIG variable.
8. Update the http://www.nongnu.org/nmh/ homepage. (It lives in the CVS
'webpages repository'; see https://savannah.nongnu.org/cvs/?group=nmh)
9. Add a news item to the savannah nmh page. You'll have to submit it first
and then separately approve it (under News->Manage).
10. 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
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 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 git diff page that would show
a detailed list of changes. The changes between 1.5 and 1.4 would be
shown by [this is just a guess, I don't know anything about cgit, and
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