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 * Changes which are potentially controversial, require a non-trivial
  42   plan, or must be implemented gradually with a roadmap spanning several
  43   releases (either minor or major) should be discussed on the list,
  44   and have a proper entry in the PLANS directory.  This entry should be
  45   always committed in the "maint" branch, even if the change it deals
  46   with is only for the master branch, or a topic branch.  Usually, in
  47   addition to this, it is useful to open a "wishlist" report on the
  48   Automake debbugs tracker, to keep the idea more visible, and have the
  49   discussions surrounding it easily archived in a central place.
  50
  51 ============================================================================
  52 = Naming
  53
  54 * We've adopted the convention that internal AC_SUBSTs should be
  55   named with a leading 'am__', and internally generated targets
  56   should be named with a leading 'am--'.  This convention, although
  57   in place from at least February 2001, isn't yet universally used.
  58   But all new code should use it.
  59
  60   We used to use '_am_' as the prefix for an internal AC_SUBST.
  61   However, it turns out that NEWS-OS 4.2R complains if a Makefile
  62   variable begins with the underscore character.  Yay for them.
  63   I changed the target naming convention just to be safe.
  64
  65 ============================================================================
  66 = Editing '.am' files
  67
  68 * Always use $(...) and not ${...}
  69
  70 * Use ':', not 'true'.  Use 'exit 1', not 'false'.
  71
  72 * Use '##' comments liberally.  Comment anything even remotely
  73   unusual.
  74
  75 * Never use basename or dirname.  Instead use sed.
  76
  77 * Do not use 'cd' within back-quotes, use '$(am__cd)' instead.
  78   Otherwise the directory name may be printed, depending on CDPATH.
  79   More generally, do not ever use plain 'cd' together with a relative
  80   directory that does not start with a dot, or you might end up in one
  81   computed with CDPATH.
  82
  83 * For install and uninstall rules, if a loop is required, it should be
  84   silent.  Then the body of the loop itself should print each
  85   "important" command it runs.  The printed commands should be preceded
  86   by a single space.
  87
  88 * Ensure install rules do not create any installation directory where
  89   nothing is to be actually installed.  See automake bug#11030.
  90
  91 ============================================================================
  92 = Editing automake.in and aclocal.in
  93
  94 * Indent using GNU style.  For historical reasons, the perl code
  95   contains portions indented using Larry Wall's style (perl-mode's
  96   default), and other portions using the GNU style (cperl-mode's
  97   default).  Write new code using GNU style.
  98
  99 * Don't use & for function calls, unless required.
 100   The use of & prevents prototypes from being checked.
 101   Just as above, don't change massively all the code to strip the
 102   &, just convert the old code as you work on it, and write new
 103   code without.
 104
 105 ============================================================================
 106 = Working with git
 107
 108 * To regenerate dependent files created by aclocal and automake,
 109   use the 'bootstrap.sh' script.  It uses the code from the source
 110   tree, so the resulting files (aclocal.m4 and Makefile.in) should
 111   be the same as you would get if you install this version of
 112   automake and use it to generate those files.  Be sure to have the
 113   latest stable version of Autoconf installed and available early
 114   in your PATH.
 115
 116 * The Automake git tree currently carries two basic branches: 'master' for
 117   the current development, and 'maint' for maintenance and bug fixes.  The
 118   maint branch should be kept regularly merged into the master branch.
 119   It is advisable to merge only after a set of related commits have been
 120   applied, to avoid introducing too much noise in the history.
 121
 122 * There may be a number of longer-lived feature branches for new
 123   developments.  They should be based off of a common ancestor of all
 124   active branches to which the feature should or might be merged later.
 125   In the future, we might introduce a special branch named 'next' that
 126   may serve as common ground for feature merging and testing, should
 127   they not yet be ready for master.
 128
 129 * After a major release is done, the master branch is to be merged into
 130   the maint branch, and then a "new" master branch created stemming
 131   from the resulting commit.
 132
 133 * When fixing a bug (especially a long-standing one), it may be useful
 134   to commit the fix to a new temporary branch based off the commit that
 135   introduced the bug.  Then this "bugfix branch" can be merged into all
 136   the active branches descending from the buggy commit.  This offers a
 137   simple way to fix the bug consistently and effectively.
 138
 139 * When merging, prefer 'git merge --log' over plain 'git merge', so that
 140   a later 'git log' gives an indication of which actual patches were
 141   merged even when they don't appear early in the list.
 142
 143 * The 'master' and 'maint' branches should not be rewound, i.e., should
 144   always fast-forward, except maybe for privacy issues.  For 'next'
 145   (if that will ever be implemented), and for feature branches, the
 146   announcement for the branch should document rewinding policy.  If a
 147   topic branch is expected to be rewound, it is good practice to put
 148   it in the 'experimental/*' namespace; for example, a rewindable branch
 149   dealing with Vala support could be named like "experimental/vala-work".
 150
 151 ============================================================================
 152 = Writing a good commit message
 153
 154 * Here is the general format that Automake's commit messages are expected
 155   to follow.  See the further points below for clarifications and minor
 156   corrections.
 157
 158       topic: brief description (this is the "summary line")
 159
 160       <reference to relevant bugs, if any>
 161
 162       Here goes a more detailed explanation of why the commit is needed,
 163       and a general overview of what it does, and how.  This section
 164       should almost always be provided, possibly only with the expection
 165       of obvious fixes or very trivial changes.
 166
 167       And if the detailed explanation is quite long or detailed, you can
 168       want to break it in more paragraphs.
 169
 170       Then you can add references to relevant mailing list discussions
 171       (if any), with proper links.  But don't take this as an excuse for
 172       writing incomplete commit messages!  The "distilled" conclusions
 173       reached in such discussions should have been placed in the
 174       paragraphs above.
 175
 176       Finally, here you can thank people that motivated or helped the
 177       change.  So, thanks to John Doe for bringing up the issue, and to
 178       J. Random Hacker for providing suggestions and testing the patch.
 179
 180       <detailed list of touched files>
 181
 182 * The <detailed list of touched files> should usually be provided (but
 183   for short or trivial changes), and should follow the GNU guidelines
 184   for ChangeLog entries (described explicitly in the GNU Coding
 185   Standards); it might be something of this sort:
 186
 187     * some/file (func1): Improved frobnication.
 188     (func2): Adjusted accordingly.
 189     * another/file (foo, bar): Likewise.
 190     * tests/foo.tap: New test.
 191     * tests/Makefile.am (TESTS): Add it.
 192
 193 * If your commit fixes an automake bug registered in the tracker (say
 194   numbered 1234), you should put the following line after the summary
 195   line:
 196
 197       This change fixes automake bug#1234.
 198
 199 * If your commit is just related to the given bug report, but does not
 200   fix it, you might want to add a line like this instead:
 201
 202       This change is related to automake bug#1234.
 203
 204 * When referring to older commits, use 'git describe' output as pointer.
 205   But also try to identify the given commit by date and/or summary line
 206   if possible.  Examples:
 207
 208       Since yesterday's commit, v1.11-2019-g4d2bf42, ...
 209
 210       ... removed in commit 'v1.11-1674-g02e9072' of 01-01-2012,
 211       "dist: ditch support for lzma"...
 212
 213 ============================================================================
 214 = Test suite
 215
 216 * Use "make check" and "make maintainer-check" liberally.
 217
 218 * Make sure each test file is executable.
 219
 220 * Export the 'keep_testdirs' environment variable to "yes" to keep
 221   test directories for successful tests also.
 222
 223 * Use perl coverage information to ensure your new code is thoroughly
 224   tested by your new tests.
 225
 226 * See file 't/README' for more information.
 227
 228 ============================================================================
 229 = Release procedure
 230
 231 * The steps outlined here are meant to be followed for alpha and stable
 232   releases as well.  Where differences are expected, they will be
 233   explicitly described.
 234
 235 * Fetch new versions of the files that are maintained by the FSF by
 236   running "make fetch".  In case any file in the automake repository
 237   has been updated, commit and re-run the testsuite.
 238
 239 * Ensure that the copyright notices of the distributed files is up to
 240   date.  The maintainer-only target "update-copyright" can help with
 241   this.
 242
 243 * Check NEWS; in particular, ensure that all the relevant differences
 244   with the last release are actually reported.
 245
 246 * Update the version number in configure.ac.
 247   (The idea is that every other alpha number will be a net release.
 248   The repository will always have its own "odd" number so we can easily
 249   distinguish net and repo versions.)
 250
 251 * Run these commands, in this order:
 252
 253     make bootstrap
 254     make check keep_testdirs=yes
 255     make maintainer-check
 256     make distcheck
 257     make check-no-trailing-backslash-in-recipes
 258     make check-cc-no-c-o
 259
 260   It is also advised to run "git clean -fdx" before invoking the
 261   bootstrap, to ensure a really clean rebuild.  However, it must
 262   be done carefully, because that command will remove *all* the
 263   files that are not tracked by git!
 264
 265 * Run "make git-tag-release".
 266   This will run the maintainer checks, verify that the local git
 267   repository and working tree are clean and up-to-date, and create
 268   a proper signed git tag for the release (based on the contents
 269   of $(VERSION)).
 270
 271 * Run "make git-upload-release".
 272   This will first verify that you are releasing from a tagged version
 273   and that the local git repository and working tree are clean and
 274   up-to-date, and will then run "make dist" to create the tarballs,
 275   and invoke the 'gnupload' script sign and upload them to the correct
 276   locations.  In case you need to sign with a non-default key, you can
 277   use "make GNUPLOADFLAGS='--user KEY' git-upload-release".
 278
 279 * For stable releases you'll have to update the manuals at www.gnu.org.
 280
 281   - Generate manuals (with the help of the standard gendocs.sh script):
 282
 283        make web-manual
 284
 285     The ready-to-be-uploaded manuals (in several formats) will be left
 286     in the 'doc/web-manuals' directory.
 287
 288   - Commit the updated manuals to web CVS:
 289
 290       make web-manual-update
 291
 292     If your local username is different from your username at Savannah,
 293     you'll have to override the 'CVS_USER' make variable accordingly;
 294     for example:
 295
 296       make web-manual-update CVS_USER=slattarini
 297
 298   - Check for link errors, fix them, recheck until convergence:
 299     <http://validator.w3.org/checklink>
 300
 301 * Create an announcement message with "make announcement".  Edit the
 302   generated 'announcement' file appropriately, in particularly filling
 303   in by hand any "TODO" left in there.
 304
 305 * Update version number in configure.ac to next alpha number.
 306   Re-run ./bootstrap.sh and commit.
 307
 308 * Don't forget to "git push" your changes so they appear in the public
 309   git tree.
 310
 311 * Send the announcement generated in the earlier steps at least to
 312   <autotools-announce@gnu.org> and <automake@gnu.org>.  If the release
 313   is a stable one, the announcement must also go to <info-gnu@gnu.org>;
 314   if it is an alpha or beta release, announcement should be sent also
 315   to <platform-testers@gnu.org>, to maximize the possibility of early
 316   testing on exotic or proprietary systems.  Finally, copy an abridged
 317   version of the announcement into the NEWS feed at:
 318   <https://savannah.gnu.org/projects/automake>.
 319   Be sure to link a  version to the complete announcement (from
 320   the version you sent to the automake list, as get archived on
 321   <http://lists.gnu.org/archive/html/automake/>).
 322
 323 -----
 324
 325 Copyright (C) 2003-2013 Free Software Foundation, Inc.
 326
 327 This program is free software; you can redistribute it and/or modify
 328 it under the terms of the GNU General Public License as published by
 329 the Free Software Foundation; either version 2, or (at your option)
 330 any later version.
 331
 332 This program is distributed in the hope that it will be useful,
 333 but WITHOUT ANY WARRANTY; without even the implied warranty of
 334 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 335 GNU General Public License for more details.
 336
 337 You should have received a copy of the GNU General Public License
 338 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 339
 340 Local Variables:
 341 mode: text
 342 End: