HACKING

   1 ================================================================
   2 = This file
   3
   4 * This file attempts to describe the rules to use when hacking
   5   automake.
   6
   7 ================================================================
   8 = Administrivia
   9
  10 * The correct response to most actual bugs is to write a new test case
  11   which demonstrates the bug.  Then fix the bug, re-run the test suite,
  12   and check everything in.
  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 commit message.
  20   If a change fixes a bug registered in the Automake debbugs tracker,
  21   mention the bug number in the commit message.
  22
  23 * If somebody reports a new bug, mention his name in the commit message
  24   and in the test case you write.  Put him into THANKS.
  25
  26 * When documenting a non-trivial idiom or example in the manual, be
  27   sure to add a test case for it, and to reference such test case from
  28   a proper Texinfo comment.
  29
  30 * Some files in the automake package are not owned by automake; these
  31   files are listed in the $(FETCHFILES) variable in Makefile.am.  They
  32   should never be edited here.  Almost all of them can be updated from
  33   respective upstreams with "make fetch" (this should be done especially
  34   before releases).  The only exception is the 'lib/COPYING' (from FSF),
  35   which should be updated by hand whenever the GPL gets updated (which
  36   shouldn't happen that often anyway :-)
  37
  38 * Changes other than bug fixes must be mentioned in NEWS.  Important
  39   bug fixes should be mentioned in NEWS, too.
  40
  41 ================================================================
  42 = Naming
  43
  44 * We've adopted the convention that internal AC_SUBSTs should be
  45   named with a leading 'am__', and internally generated targets
  46   should be named with a leading 'am--'.  This convention, although
  47   in place from at least February 2001, isn't yet universally used.
  48   But all new code should use it.
  49
  50   We used to use '_am_' as the prefix for an internal AC_SUBST.
  51   However, it turns out that NEWS-OS 4.2R complains if a Makefile
  52   variable begins with the underscore character.  Yay for them.
  53   I changed the target naming convention just to be safe.
  54
  55 ================================================================
  56 = Editing '.am' files
  57
  58 * Always use $(...) and not ${...}
  59
  60 * Use ':', not 'true'.  Use 'exit 1', not 'false'.
  61
  62 * Use '##' comments liberally.  Comment anything even remotely
  63   unusual.
  64
  65 * Never use basename or dirname.  Instead use sed.
  66
  67 * Do not use 'cd' within back-quotes, use '$(am__cd)' instead.
  68   Otherwise the directory name may be printed, depending on CDPATH.
  69   More generally, do not ever use plain 'cd' together with a relative
  70   directory that does not start with a dot, or you might end up in one
  71   computed with CDPATH.
  72
  73 * For install and uninstall rules, if a loop is required, it should be
  74   silent.  Then the body of the loop itself should print each
  75   "important" command it runs.  The printed commands should be preceded
  76   by a single space.
  77
  78 ================================================================
  79 = Editing automake.in and aclocal.in
  80
  81 * Indent using GNU style.  For historical reasons, the perl code
  82   contains portions indented using Larry Wall's style (perl-mode's
  83   default), and other portions using the GNU style (cperl-mode's
  84   default).  Write new code using GNU style.
  85
  86 * Don't use & for function calls, unless required.
  87   The use of & prevents prototypes from being checked.
  88   Just as above, don't change massively all the code to strip the
  89   &, just convert the old code as you work on it, and write new
  90   code without.
  91
  92 ================================================================
  93 = Working with git
  94
  95 * To regenerate dependent files created by aclocal and automake,
  96   use the 'bootstrap' script.  It uses the code from the source
  97   tree, so the resulting files (aclocal.m4 and Makefile.in) should
  98   be the same as you would get if you install this version of
  99   automake and use it to generate those files.  Be sure to have the
 100   latest stable version of Autoconf installed.  If such version is
 101   not installed as "autoconf", pass it explicitly (along with the
 102   accompanying "autom4te") when calling 'bootstrap' and 'configure'.
 103   For example:
 104     $ AUTOCONF=autoconf2.68 AUTOM4TE=autom4te2.68 ./bootstrap
 105     $ ./configure AUTOCONF=autoconf2.68 AUTOM4TE=autom4te2.68
 106
 107 * Dependent files aclocal.m4, configure and Makefile.in in all
 108   directories should be up to date in the git repository, so that
 109   the changes in them can be easily noticed and analyzed.
 110
 111 * The git tree currently carries a number of branches: master for the
 112   current development, and release branches named branch-X.Y.  The maint
 113   branch serves as common ground for both master and the active release
 114   branches.  Changes intended for both should be applied to maint, which
 115   should then be merged to release branches and master, of course after
 116   suitable testing.  It is advisable to merge only after a set of related
 117   commits have been applied.
 118
 119 * Example work flow for patches to maint:
 120
 121   # 1. Checkout the "maint" branch:
 122   git checkout maint
 123
 124   # 2. Apply the patch(es) with "git am" (or create them with $EDITOR):
 125   git am -3 0*.patch
 126   # 2a. Run required tests, if any ...
 127
 128   # 3. Merge maint into branch-1.11:
 129   git checkout branch-1.11
 130   git merge maint
 131   # 3a. Run required tests, if any ...
 132
 133   # 4. Redo steps 3 and 3a for master:
 134   git checkout master
 135   git merge maint
 136   # testing ...
 137
 138   # 5. Push the maint and master branches:
 139   git push --dry-run origin maint branch-1.11 master
 140   # if all seems ok, then actually push:
 141   git push origin maint branch-1.11 master
 142
 143 * When fixing a bug (especially a long-standing one), it may be useful
 144   to commit the fix to a new temporary branch based off the commit that
 145   introduced the bug.  Then this "bugfix branch" can be merged into all
 146   the active branches descending from the buggy commit.  This offers a
 147   simple way to fix the bug consistently and effectively.
 148
 149 * When referring to older commits, use 'git describe' output as pointer.
 150
 151 * There may be a number of longer-lived feature branches for new developments.
 152   They should be based off of a common ancestor of all active branches to
 153   which the feature should or might be merged later.  The next branch may
 154   serve as common ground for feature merging and testing, should they not
 155   be ready for master yet.
 156
 157 * For merges from branches other than maint, prefer 'git merge --log' over
 158   plain 'git merge', so that a later 'git log' gives an indication of which
 159   actual patches were merged even when they don't appear early in the list.
 160
 161 * master and release branches should not be rewound, i.e., should always
 162   fast-forward, except maybe for privacy issues.  The maint branch should not
 163   be rewound except maybe after retiring a release branch or a new stable
 164   release.  For next, and for feature branches, the announcement for the
 165   branch should document rewinding policy.
 166
 167 ================================================================
 168 = Test suite
 169
 170 * Use "make check" and "make maintainer-check" liberally.
 171
 172 * Make sure each test file is executable.
 173
 174 * Export the 'keep_testdirs' environment variable to "yes" to keep
 175   test directories for successful tests also.
 176
 177 * Use perl coverage information to ensure your new code is thoroughly
 178   tested by your new tests.
 179
 180 * See file 'tests/README' for more information.
 181
 182 ================================================================
 183 = Release procedure
 184
 185 * The steps outlined here are meant to be followed for alpha and stable
 186   releases as well.  Where differences are expected, they will be
 187   explicitly described.
 188
 189 * Fetch new versions of the files that are maintained by the FSF.
 190   Commit.  Unfortunately you need an FSF account to do this.
 191   (You can also use "make fetch", but that is still woefully incomplete.)
 192
 193 * Update NEWS.
 194
 195 * Update the version number in configure.ac.
 196   (The idea is that every other alpha number will be a net release.
 197   The repository will always have its own "odd" number so we can easily
 198   distinguish net and repo versions.)
 199
 200 * Run this:
 201   ./bootstrap && ./configure && make && make check && make distcheck
 202
 203 * Run "make git-release".
 204   This will run "make dist" to create the tarballs, commit the last
 205   changes to NEWS, configure.ac and m4/amversion.m4, tag the repository,
 206   sign the tarballs, and upload them.
 207   Use "make GNUPLOADFLAGS='--user key' git-release" to sign with
 208   a non-default key.
 209
 210 * Update version number in configure.ac to next alpha number.
 211   Re-run ./bootstrap and commit.
 212
 213 * Don't forget to "git push" your changes so they appear in the public
 214   git tree.
 215
 216 * For stable releases, update the manuals at www.gnu.org:
 217   - Generate manuals:
 218     cd doc
 219     wget "http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs.sh"
 220     wget "http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs_template"
 221     sh ./gendocs.sh --email bug-automake@gnu.org automake "GNU Automake"
 222   - copy manuals recursively to web cvs,
 223   - commit.
 224   - Check for link errors, fix them, recheck until convergence:
 225     <http://validator.w3.org/checklink>
 226
 227 * Send the announcement at least to <autotools-announce@gnu.org> and
 228   <automake@gnu.org>.  If the release is a stable one, the announcement
 229   must also go to <info-gnu@gnu.org>; if it is an alpha or beta release,
 230   announcement should be sent also to <platform-testers@gnu.org>, to
 231   maximize the possibility of early testing on exotic or proprietary
 232   systems.  Finally, copy the announcement into the NEWS feed at
 233   <https://savannah.gnu.org/projects/automake>.
 234
 235 -----
 236
 237 Copyright (C) 2003-2012 Free Software Foundation, Inc.
 238
 239 This program is free software; you can redistribute it and/or modify
 240 it under the terms of the GNU General Public License as published by
 241 the Free Software Foundation; either version 2, or (at your option)
 242 any later version.
 243
 244 This program is distributed in the hope that it will be useful,
 245 but WITHOUT ANY WARRANTY; without even the implied warranty of
 246 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 247 GNU General Public License for more details.
 248
 249 You should have received a copy of the GNU General Public License
 250 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 251
 252 Local Variables:
 253 mode: text
 254 End: