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