HACKING

   1 ================================================================
   2 = This file
   3
   4 * This file attempts to describe the rules to use when hacking
   5   automake.
   6
   7 * Don't put this file into the distribution.  Don't mention it in the
   8   ChangeLog.
   9
  10
  11 ================================================================
  12 = Administrivia
  13
  14 * If you incorporate a change from somebody on the net:
  15   First, if it is a large change, you must make sure they have signed the
  16   appropriate paperwork.
  17   Second, be sure to add their name and email address to THANKS
  18
  19 * If a change fixes a test, mention the test in the ChangeLog entry.
  20
  21 * If somebody reports a new bug, mention his name in the ChangeLog entry
  22   and in the test case you write.  Put him into THANKS.
  23
  24 * The correct response to most actual bugs is to write a new test case
  25   which demonstrates the bug.  Then fix the bug, re-run the test suite,
  26   and check everything in.
  27
  28 * Some files in the automake package are not owned by automake.  These
  29   files should never be edited here.  These files are COPYING, INSTALL,
  30   ansi2knr.1, ansi2knr.c, config.guess config.sub, install-sh, mdate-sh,
  31   missing, mkinstalldirs, texinfo.tex
  32
  33 * Changes other than bug fixes must be mentioned in NEWS
  34
  35
  36 ================================================================
  37 = Naming
  38
  39 * We've adopted the convention that internal AC_SUBSTs should be
  40   named with a leading `_am_', and internally generated targets should
  41   be named with a leading `_am-'.  This convention is very new
  42   (as of Feb 7 2001) and so it isn't yet universally used.  But all
  43   new code should use it.
  44
  45 ================================================================
  46 = Editing `.am' files
  47
  48 * Always use $(...) and not ${...}
  49
  50 * Use `:', not `true'.  Use `exit 1', not `false'.
  51
  52 * Use `##' comments liberally.  Comment anything even remotely
  53   unusual.
  54
  55 * Never use basename or dirname.  Instead use sed
  56
  57 * If you run `cd' within back-quotes, make sure you set `CDPATH=:',
  58   otherwise the directory name may be printed, depending on CDPATH.
  59
  60 * For install and uninstall rules, if a loop is required, it should be
  61   silent.  Then the body of the loop itself should print each
  62   "important" command it runs.  The printed commands should be preceded
  63   by a single space.
  64
  65
  66 ================================================================
  67 = Editing automake.in and aclocal.in
  68
  69 * Follow existing indentation style.
  70
  71 * Use only Perl 4 constructs
  72
  73
  74 ================================================================
  75 = Test suite
  76
  77 * Use "make check" and "make maintainer-check" liberally
  78
  79 * Make sure each test file is executable
  80
  81
  82 ================================================================
  83 = Release procedure
  84
  85 * Fetch new versions of the files that are maintained by the FSF.
  86   Commit.  Unfortunately you need an FSF account to do this.
  87
  88 * Update NEWS.  For an alpha release, update README-alpha.
  89
  90 * Update the version number in configure.in.
  91   (The idea is that every other alpha number will be a net release.
  92   The repository will always have its own "odd" number so we can easily
  93   distinguish net and repo versions.)
  94
  95 * Configure, build, and install.
  96
  97 * Run aclocal, automake, and autoconf.
  98
  99 * Commit
 100
 101 * Run `make cvs-dist'
 102
 103 * Put new release on ftp site and send announcement.
 104   (If not an alpha, announcement must also go to FSF.)
 105
 106 * Update version number in configure.in to next alpha number.
 107   Re-run autoconf and commit.