1 ================================================================
4 * This file attempts to describe the rules to use when hacking
7 ================================================================
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 signed the
16 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 and in the test case you write. 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 bug fixes must be mentioned in NEWS. Important
39 bug fixes should be mentioned in NEWS, too.
41 ================================================================
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.
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 `_'. Yay for them. I changed the target
53 naming convention just to be safe.
55 ================================================================
58 * Always use $(...) and not ${...}
60 * Use `:', not `true'. Use `exit 1', not `false'.
62 * Use `##' comments liberally. Comment anything even remotely
65 * Never use basename or dirname. Instead use sed.
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
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
78 ================================================================
79 = Editing automake.in and aclocal.in
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.
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
92 ================================================================
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'.
104 $ AUTOCONF=autoconf2.68 AUTOM4TE=autom4te2.68 ./bootstrap
105 $ ./configure AUTOCONF=autoconf2.68 AUTOM4TE=autom4te2.68
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.
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.
119 * Example work flow for patches to maint:
121 # 1. Checkout the "maint" branch:
124 # 2. Apply the patch(es) with "git am" (or create them with $EDITOR):
126 # 2a. Run required tests, if any ...
128 # 3. Merge maint into branch-1.11:
129 git checkout branch-1.11
131 # 3a. Run required tests, if any ...
133 # 4. Redo steps 3 and 3a for master:
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
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.
149 * When referring to older commits, use 'git describe' output as pointer.
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.
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.
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.
167 ================================================================
170 * Use "make check" and "make maintainer-check" liberally.
172 * Make sure each test file is executable.
174 * Use `keep_testdirs=yes' to keep test directories for successful
177 * Use perl coverage information to ensure your new code is thoroughly
178 tested by your new tests.
180 * See file `tests/README' for more information.
182 ================================================================
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.
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.)
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.)
201 ./bootstrap && ./configure && make && make check && make distcheck
203 * Run `make release-stats' if release statistics in doc/automake.texi
204 have not been updated yet.
206 * Run `make git-release'.
207 This will run "make dist" to create the tarballs, commit the last
208 changes to NEWS, configure.ac and m4/amversion.m4, tag the repository,
209 sign the tarballs, and upload them.
210 Use `make GNUPLOADFLAGS="--user key" git-release' to sign with
213 * Update version number in configure.ac to next alpha number.
214 Re-run ./bootstrap and commit.
216 * Don't forget to `git push' your changes so they appear in the public
219 * For stable releases, update the manuals at www.gnu.org:
222 wget "http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs.sh"
223 wget "http://savannah.gnu.org/cgi-bin/viewcvs/~checkout~/texinfo/texinfo/util/gendocs_template"
224 sh ./gendocs.sh --email bug-automake@gnu.org automake "GNU Automake"
225 - copy manuals recursively to web cvs,
227 - Check for link errors, fix them, recheck until convergence:
228 <http://validator.w3.org/checklink>
230 * Send the announcement at least to <autotools-announce@gnu.org> and
231 <automake@gnu.org>. If the release is a stable one, the announcement
232 must also go to <info-gnu@gnu.org>; if it is an alpha or beta release,
233 announcement should be sent also to <platform-testers@gnu.org>, to
234 maximize the possibility of early testing on exotic or proprietary
235 systems. Finally, copy the announcement into the NEWS feed at
236 <https://savannah.gnu.org/projects/automake>.
240 Copyright (C) 2003, 2007, 2008, 2010, 2011, 2012 Free Software
243 This program is free software; you can redistribute it and/or modify
244 it under the terms of the GNU General Public License as published by
245 the Free Software Foundation; either version 2, or (at your option)
248 This program is distributed in the hope that it will be useful,
249 but WITHOUT ANY WARRANTY; without even the implied warranty of
250 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
251 GNU General Public License for more details.
253 You should have received a copy of the GNU General Public License
254 along with this program. If not, see <http://www.gnu.org/licenses/>.