/neatx/doc/DEVNOTES

http://neatx.googlecode.com/ · #! · 73 lines · 53 code · 20 blank · 0 comment · 0 complexity · f2fcc326ff20343377455aaf99b9a436 MD5 · raw file

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