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