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 * Ensure install rules do not create any installation directory where
  79   nothing is to be actually installed.  See automake bug#11030.
  80
  81 ================================================================
  82 = Editing automake.in and aclocal.in
  83
  84 * Indent using GNU style.  For historical reasons, the perl code
  85   contains portions indented using Larry Wall's style (perl-mode's
  86   default), and other portions using the GNU style (cperl-mode's
  87   default).  Write new code using GNU style.
  88
  89 * Don't use & for function calls, unless required.
  90   The use of & prevents prototypes from being checked.
  91   Just as above, don't change massively all the code to strip the
  92   &, just convert the old code as you work on it, and write new
  93   code without.
  94
  95 ================================================================
  96 = Working with git
  97
  98 * To regenerate dependent files created by aclocal and automake,
  99   use the 'bootstrap' script.  It uses the code from the source
 100   tree, so the resulting files (aclocal.m4 and Makefile.in) should
 101   be the same as you would get if you install this version of
 102   automake and use it to generate those files.  Be sure to have the
 103   latest stable version of Autoconf installed and available early
 104   in your PATH.
 105
 106 * Dependent files aclocal.m4, configure and Makefile.in in all
 107   directories should be up to date in the git repository, so that
 108   the changes in them can be easily noticed and analyzed.
 109
 110 * The git tree currently carries a number of branches: master for the
 111   current development, and release branches named branch-X.Y.  The maint
 112   branch serves as common ground for both master and the active release
 113   branches.  Changes intended for both should be applied to maint, which
 114   should then be merged to release branches and master, of course after
 115   suitable testing.  It is advisable to merge only after a set of related
 116   commits have been applied.
 117
 118 * Example work flow for patches to maint:
 119
 120   # 1. Checkout the "maint" branch:
 121   git checkout maint
 122
 123   # 2. Apply the patch(es) with "git am" (or create them with $EDITOR):
 124   git am -3 0*.patch
 125   # 2a. Run required tests, if any ...
 126
 127   # 3. Merge maint into branch-1.11:
 128   git checkout branch-1.11
 129   git merge maint
 130   # 3a. Run required tests, if any ...
 131
 132   # 4. Redo steps 3 and 3a for master:
 133   git checkout master
 134   git merge maint
 135   # testing ...
 136
 137   # 5. Push the maint and master branches:
 138   git push --dry-run origin maint branch-1.11 master
 139   # if all seems ok, then actually push:
 140   git push origin maint branch-1.11 master
 141
 142 * When fixing a bug (especially a long-standing one), it may be useful
 143   to commit the fix to a new temporary branch based off the commit that
 144   introduced the bug.  Then this "bugfix branch" can be merged into all
 145   the active branches descending from the buggy commit.  This offers a
 146   simple way to fix the bug consistently and effectively.
 147
 148 * There may be a number of longer-lived feature branches for new developments.
 149   They should be based off of a common ancestor of all active branches to
 150   which the feature should or might be merged later.  The next branch may
 151   serve as common ground for feature merging and testing, should they not
 152   be ready for master yet.
 153
 154 * For merges from branches other than maint, prefer 'git merge --log' over
 155   plain 'git merge', so that a later 'git log' gives an indication of which
 156   actual patches were merged even when they don't appear early in the list.
 157
 158 * master and release branches should not be rewound, i.e., should always
 159   fast-forward, except maybe for privacy issues.  The maint branch should not
 160   be rewound except maybe after retiring a release branch or a new stable
 161   release.  For next, and for feature branches, the announcement for the
 162   branch should document rewinding policy.
 163
 164 ================================================================
 165 = Writing a good commit message
 166
 167 * Here is the general format that Automake's commit messages are expected
 168   to follow.  See the further points below for clarifications and minor
 169   corrections.
 170
 171       topic: brief description (this is the "summary line")
 172
 173       <reference to relevant bugs, if any>
 174
 175       Here goes a more detailed explanation of why the commit is needed,
 176       and a general overview of what it does, and how.  This section is
 177       optional, but you are expected to provide it more often than not.
 178
 179       And if the detailed explanation is quite long or detailed, you can
 180       want to break it in more paragraphs.
 181
 182       Then you can add references to relevant mailing list discussions
 183       (if any), with proper links.  But don't take this as an excuse for
 184       writing incomplete commit messages!  The "distilled" conclusions
 185       reached in such discussions should have been placed in the
 186       paragraphs above.
 187
 188       Finally, here you can thank people that motivated or helped the
 189       change.  So, thanks to John Doe for bringing up the issue, and to
 190       J. Random Hacker for providing suggestions and testing the patch.
 191
 192       <detailed list of touched files>
 193
 194 * The <detailed list of touched files> is mandatory but for the most
 195   trivial changes, and should follows the GNU guidelines for ChangeLog
 196   entries (described explicitly in the GNU Coding Standards); it might
 197   be something of this sort:
 198
 199     * some/file (func1): Improved frobnication.
 200     (func2): Adjusted accordingly.
 201     * another/file (foo, bar): Likewise.
 202     * tests/foo.tap: New test.
 203     * tests/Makefile.am (TESTS): Add it.
 204
 205 * If your commit fixes an automake bug registered in the tracker (say
 206   numbered 1234), you should put the following line after the summary
 207   line:
 208
 209       This change fixes automake bug#1234.
 210
 211 * If your commit is just related to the given bug report, but does not
 212   fix it, you might want to add a line like this instead:
 213
 214       This change is related to automake bug#1234.
 215
 216 * When referring to older commits, use 'git describe' output as pointer.
 217   But also try to identify the given commit by date and/or summary line
 218   if possible.  Examples:
 219
 220       Since yesterday's commit, v1.11-2019-g4d2bf42, ...
 221
 222       ... removed in commit 'v1.11-1674-g02e9072' of 01-01-2012,
 223       "dist: ditch support for lzma"...
 224
 225 ================================================================
 226 = Test suite
 227
 228 * Use "make check" and "make maintainer-check" liberally.
 229
 230 * Make sure each test file is executable.
 231
 232 * Export the 'keep_testdirs' environment variable to "yes" to keep
 233   test directories for successful tests also.
 234
 235 * Use perl coverage information to ensure your new code is thoroughly
 236   tested by your new tests.
 237
 238 * See file 'tests/README' for more information.
 239
 240 ================================================================
 241 = Release procedure
 242
 243 * The steps outlined here are meant to be followed for alpha and stable
 244   releases as well.  Where differences are expected, they will be
 245   explicitly described.
 246
 247 * Fetch new versions of the files that are maintained by the FSF.
 248   Commit.  Unfortunately you need an FSF account to do this.
 249   (You can also use "make fetch", but that is still woefully incomplete.)
 250
 251 * Update NEWS.
 252
 253 * Update the version number in configure.ac.
 254   (The idea is that every other alpha number will be a net release.
 255   The repository will always have its own "odd" number so we can easily
 256   distinguish net and repo versions.)
 257
 258 * Run this:
 259   ./bootstrap && ./configure && make && make check && make distcheck
 260
 261 * Run "make git-tag-release".
 262   This will run the maintainer checks, check that the NEWS file is
 263   up-to-date, check that the local git repository and working tree
 264   are clean and up-to-date, and create a proper signed git tag for
 265   the release (based on the contents of $(VERSION)).
 266
 267 * Run "make git-upload-release".
 268   This will first verify that you are releasing from a tagged version
 269   and that the local git repository and working tree are clean and
 270   up-to-date, and will then run "make dist" to create the tarballs,
 271   and invoke the 'gnupload' script sign and upload them to the correct
 272   locations.  In case you need to sign with a non-default key, you can
 273   use "make GNUPLOADFLAGS='--user KEY' git-upload-release".
 274
 275 * Update version number in configure.ac to next alpha number.
 276   Re-run ./bootstrap and commit.
 277
 278 * Don't forget to "git push" your changes so they appear in the public
 279   git tree.
 280
 281 * For stable releases, update the manuals at www.gnu.org:
 282   - Generate manuals:
 283     cd doc
 284     wget "http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs.sh"
 285     wget "http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs_template"
 286     sh ./gendocs.sh --email bug-automake@gnu.org automake "GNU Automake"
 287   - copy manuals recursively to web cvs,
 288   - commit.
 289   - Check for link errors, fix them, recheck until convergence:
 290     <http://validator.w3.org/checklink>
 291
 292 * Send the announcement at least to <autotools-announce@gnu.org> and
 293   <automake@gnu.org>.  If the release is a stable one, the announcement
 294   must also go to <info-gnu@gnu.org>; if it is an alpha or beta release,
 295   announcement should be sent also to <platform-testers@gnu.org>, to
 296   maximize the possibility of early testing on exotic or proprietary
 297   systems.  Finally, copy the announcement into the NEWS feed at
 298   <https://savannah.gnu.org/projects/automake>.
 299
 300 -----
 301
 302 Copyright (C) 2003-2012 Free Software Foundation, Inc.
 303
 304 This program is free software; you can redistribute it and/or modify
 305 it under the terms of the GNU General Public License as published by
 306 the Free Software Foundation; either version 2, or (at your option)
 307 any later version.
 308
 309 This program is distributed in the hope that it will be useful,
 310 but WITHOUT ANY WARRANTY; without even the implied warranty of
 311 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 312 GNU General Public License for more details.
 313
 314 You should have received a copy of the GNU General Public License
 315 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 316
 317 Local Variables:
 318 mode: text
 319 End: