/neatx/doc/DEVNOTES

 1Developer notes
 2===============
 3
 4Build dependencies
 5------------------
 6
 7Most dependencies from INSTALL, plus:
 8 - rst2html from Docutils
 9   http://docutils.sourceforge.net/
10
11
12Configuring for development
13---------------------------
14
15sh autogen.sh && \
16./configure --enable-maintainer-mode \
17  --prefix=/usr/local --sysconfdir=/etc --localstatedir=/var
18
19
20Release process
21---------------
22
23Prerequisites
24~~~~~~~~~~~~~
25
26- Code conforms to the style guide (this should be checked during CL reviews)
27- Unittests (make check, make distcheck) from a pristine checkout don't fail:
28
29  TMPDIR=`mktemp -d` && (
30    echo $TMPDIR
31    cd $TMPDIR
32    svn co http://neatx.googlecode.com/svn/branches/neatx/neatx-$VERSION/ . && \
33    ./autogen.sh && \
34    ./configure && \
35    make distcheck || echo "Autobuild failed"
36  )
37  echo "Please remove the temporary directory $TMPDIR"
38
39- NEWS file is updated
40- Included documentation, readme files and comments reflect the version to be
41  released
42
43
44Steps
45~~~~~
46
47- If not done already, update configure.ac with the new version
48- Run "make distcheck"
49- Create the release branch (only if it's a major/minor release, not for
50  revisions):
51
52  ./svnutil branch neatx $VERSION $REVIEWER
53
54- Create the release tag:
55
56  ./svnutil tag neatx branch $VERSION $REVIEWER
57
58- Do a clean checkout from the tag and create the archive:
59
60  TMPDIR=`mktemp -d` && (
61    echo $TMPDIR
62    cd $TMPDIR
63    svn co http://neatx.googlecode.com/svn/tags/neatx/neatx-$VERSION/ . && \
64    ./autogen.sh && \
65    ./configure && \
66    make distcheck && \
67    fakeroot make dist && \
68    tar tzvf neatx-$VERSION.tar.gz
69  )
70
71- Upload the .tar.gz archive to the project site
72- Remove the temporary directory used for creating the archive
73- Send release announcement