doc: Fix various typos and phrasing
[automake.git] / HACKING
blob059ef5ab2d26b05e0cf9644ff6e055a61d034f6b
1 ============================================================================
2 = This file
4 * This file attempts to describe the rules to use when hacking
5   automake.
7 ============================================================================
8 = Administrivia
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.
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.
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.
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.
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.
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 :-)
38 * Changes other than *trivial* bug fixes must be mentioned in NEWS.
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.
50 ============================================================================
51 = Naming
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.
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.
64 ============================================================================
65 = Editing '.am' files
67 * Always use $(...) and not ${...}
69 * Prefer ':' over 'true', mostly for consistency with existing code.
71 * Use '##' comments liberally.  Comment anything even remotely unusual.
73 * Never use basename or dirname.  Instead, use sed.
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.
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.
86 * Ensure install rules do not create any installation directory where
87   nothing is to be actually installed.  See automake bug#11030.
89 ============================================================================
90 = Editing automake.in and aclocal.in
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.
97 * Don't use & for function calls, unless really required.
98   The use of & prevents prototypes from being checked.
100 ============================================================================
101 = Automake versioning and compatibility scheme
103 * There are three kinds of automake releases:
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).
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 by one.
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.
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.
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!
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.
145 * For more information, refer to the extensive discussion associated
146   with automake bug#13578.
148 ===========================================================================
149 = Setting the development environment
151 * The required and optional dependencies used by Automake and its test suite
152   can be automatically fetched using the GNU Guix package manager with the
153   following command:
155   $ guix environment automake --ad-hoc \
156       gettext help2man texinfo libtool flex bison dejagnu zip icedtea \
157       python gcc-toolchain gfortran pkg-config vala
159 ============================================================================
160 = Working with git
162 * To regenerate dependent files created by aclocal and automake,
163   use the 'bootstrap' script.  It uses the code from the source
164   tree, so the resulting files (aclocal.m4 and Makefile.in) should
165   be the same as you would get if you install this version of
166   automake and use it to generate those files.  Be sure to have the
167   latest stable version of Autoconf installed and available early
168   in your PATH.
170 * The Automake git tree currently carries three basic branches: 'master',
171   'next' and 'maint'.
173 * The 'master' branch is where the development of the next release
174   takes place.  It should be kept in a stable, almost-releasable state,
175   to simplify testing and deploying of new minor version.  Note that
176   this is not a hard rule, and such "stability" is not expected to be
177   absolute (emergency releases are cut from the 'maint' branch anyway).
179 * When planning a release a dedicated branch should be created and after
180   the release is done, the release branch is to be merged both into the
181   'master' branch and the 'maint' branch.
183 * Besides merges from release branches, the 'maint' branch can contain
184   fixes for regressions, trivial bugs, or documentation issues, that
185   will be part of an emergency regression-fixing or security releases.
186   As a consequence it should always be kept in a releasable state and no
187   "active" development should be done whatsoever.
189 * The 'next' branch is reserved for the development of the next major
190   release.  Experimenting a little is OK here, but don't let the branch
191   grow too unstable; if you need to do exploratory programming or
192   over-arching change, you should use a dedicated topic branch, and
193   only merge that back once it is reasonably stable.
195 * The 'master' branch should be kept regularly merged into the 'next'
196   branch.  It is advisable to merge only after a set of related
197   commits have been applied, to avoid introducing too much noise in
198   the history.
200 * There may be a number of longer-lived feature branches for new
201   developments.  They should be based off of a common ancestor of all
202   active branches to which the feature should or might be merged later.
204 * When merging, prefer 'git merge --log' over plain 'git merge', so that
205   a later 'git log' gives an indication of which actual patches were
206   merged even when they don't appear early in the list.
208 * The 'master', 'maint' and 'next' branches should not be rewound,
209   i.e., should always fast-forward, except maybe for privacy issues.
210   For feature branches, the announcement for the branch should
211   document the rewinding policy.
212   If a topic branch is expected to be rewound, it is good practice to put
213   it in the 'experimental/*' namespace; for example, a rewindable branch
214   dealing with Vala support could be named like "experimental/vala-work".
216 ============================================================================
217 = Writing a good commit message
219 * Here is the general format that Automake's commit messages are expected
220   to follow.  See the further points below for clarifications and minor
221   corrections.
223       topic: brief description (this is the "summary line")
225       <reference to relevant bugs, if any>
227       Here goes a more detailed explanation of why the commit is needed,
228       and a general overview of what it does, and how.  This section
229       should almost always be provided, possibly only with the expection
230       of obvious fixes or very trivial changes.
232       And if the detailed explanation is quite long or detailed, you can
233       want to break it in more paragraphs.
235       Then you can add references to relevant mailing list discussions
236       (if any), with proper links.  But don't take this as an excuse for
237       writing incomplete commit messages!  The "distilled" conclusions
238       reached in such discussions should have been placed in the
239       paragraphs above.
241       Finally, here you can thank people that motivated or helped the
242       change.  So, thanks to John Doe for bringing up the issue, and to
243       J. Random Hacker for providing suggestions and testing the patch.
245       <detailed list of touched files>
247 * The <detailed list of touched files> should usually be provided (but
248   for short or trivial changes), and should follow the GNU guidelines
249   for ChangeLog entries (described explicitly in the GNU Coding
250   Standards); it might be something of this sort:
252     * some/file (func1): Improved frobnication.
253     (func2): Adjusted accordingly.
254     * another/file (foo, bar): Likewise.
255     * tests/foo.tap: New test.
256     * tests/Makefile.am (TESTS): Add it.
258 * If your commit fixes an automake bug registered in the tracker (say
259   numbered 1234), you should put the following line after the summary
260   line:
262       This change fixes automake bug#1234.
264 * If your commit is just related to the given bug report, but does not
265   fix it, you might want to add a line like this instead:
267       This change is related to automake bug#1234.
269 * When referring to older commits, use 'git describe' output as pointer.
270   But also try to identify the given commit by date and/or summary line
271   if possible.  Examples:
273       Since yesterday's commit, v1.11-2019-g4d2bf42, ...
275       ... removed in commit 'v1.11-1674-g02e9072' of 01-01-2012,
276       "dist: ditch support for lzma"...
278 * If the commit is a tiny change that is exempt from copyright paperwork, the
279   commit message should contain a separate line after the detailed list of
280   touched files like the following:
282       Copyright-paperwork-exempt: yes
284 ============================================================================
285 = Test suite
287 * Use "make check" and "make maintainer-check" liberally.
289 * Export the 'keep_testdirs' environment variable to "yes" to keep
290   test directories for successful tests also.
292 * Use perl coverage information to ensure your new code is thoroughly
293   tested by your new tests.
295 * See file 't/README' for more information.
297 ============================================================================
298 = Release procedure
300 * The steps outlined here are meant to be followed for alpha and stable
301   releases as well.  Where differences are expected, they will be
302   explicitly described.
304 * Fetch new versions of the files that are maintained by the FSF by
305   running "make fetch".  In case any file in the automake repository
306   has been updated, commit and re-run the testsuite.
308 * Ensure that the copyright notices of the distributed files is up to
309   date.  The maintainer-only target "update-copyright" can help with
310   this.
312 * Check NEWS; in particular, ensure that all the relevant differences
313   with the last release are actually reported.
315 * Update the version number in configure.ac.
316   (The idea is that every other alpha number will be a net release.
317   The repository will always have its own "odd" number so we can easily
318   distinguish net and repo versions.)
320 * Run these commands, in this order:
322     make bootstrap
323     make check keep_testdirs=yes
324     make maintainer-check
325     make distcheck
326     make check-no-trailing-backslash-in-recipes
327     make check-cc-no-c-o
329   It is also advised to run "git clean -fdx" before invoking the
330   bootstrap, to ensure a really clean rebuild.  However, it must
331   be done carefully, because that command will remove *all* the
332   files that are not tracked by git!
334 * Run "make git-tag-release".
335   This will run the maintainer checks, verify that the local git
336   repository and working tree are clean and up-to-date, and create
337   a proper signed git tag for the release (based on the contents
338   of $(VERSION)).
340 * Run "make git-upload-release".
341   This will first verify that you are releasing from a tagged version
342   and that the local git repository and working tree are clean and
343   up-to-date, and will then run "make dist" to create the tarballs,
344   and invoke the 'gnupload' script sign and upload them to the correct
345   locations.  In case you need to sign with a non-default key, you can
346   use "make GNUPLOADFLAGS='--user KEY' git-upload-release".
348 * For stable releases you'll have to update the manuals at www.gnu.org.
350   - Generate manuals (with the help of the standard gendocs.sh script):
352        make web-manual
354     The ready-to-be-uploaded manuals (in several formats) will be left
355     in the 'doc/web-manuals' directory.
357   - Commit the updated manuals to web CVS:
359       make web-manual-update
361     If your local username is different from your username at Savannah,
362     you'll have to override the 'CVS_USER' make variable accordingly;
363     for example:
365       make web-manual-update CVS_USER=slattarini
367   - Check for link errors, fix them, recheck until convergence:
368     <http://validator.w3.org/checklink>
370 * Create an announcement message with "make announcement".  Edit the
371   generated 'announcement' file appropriately, in particularly filling
372   in by hand any "TODO" left in there.
374 * Update version number in configure.ac to next alpha number.
375   Re-run ./bootstrap and commit.
377 * Don't forget to "git push" your changes so they appear in the public
378   git tree.
380 * Send the announcement generated in the earlier steps at least to
381   <autotools-announce@gnu.org> and <automake@gnu.org>.  If the release
382   is a stable one, the announcement must also go to <info-gnu@gnu.org>;
383   if it is an alpha or beta release, announcement should be sent also
384   to <platform-testers@gnu.org>, to maximize the possibility of early
385   testing on exotic or proprietary systems.  Finally, copy an abridged
386   version of the announcement into the NEWS feed at:
387   <https://savannah.gnu.org/projects/automake>.
388   Be sure to link a  version to the complete announcement (from
389   the version you sent to the automake list, as get archived on
390   <https://lists.gnu.org/archive/html/automake/>).
392 -----
394 Copyright (C) 2003-2018 Free Software Foundation, Inc.
396 This program is free software; you can redistribute it and/or modify
397 it under the terms of the GNU General Public License as published by
398 the Free Software Foundation; either version 2, or (at your option)
399 any later version.
401 This program is distributed in the hope that it will be useful,
402 but WITHOUT ANY WARRANTY; without even the implied warranty of
403 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
404 GNU General Public License for more details.
406 You should have received a copy of the GNU General Public License
407 along with this program.  If not, see <https://www.gnu.org/licenses/>.
409 Local Variables:
410 mode: text
411 End: