1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
================================================================
= This file
* This file attempts to describe the rules to use when hacking
automake.
* Don't put this file into the distribution. Don't mention it in the
ChangeLog.
================================================================
= Administrivia
* If you incorporate a change from somebody on the net:
First, if it is a large change, you must make sure they have signed the
appropriate paperwork.
Second, be sure to add their name and email address to THANKS
* If a change fixes a test, mention the test in the ChangeLog entry.
* If somebody reports a new bug, mention his name in the ChangeLog entry
and in the test case you write. Put him into THANKS.
* The correct response to most actual bugs is to write a new test case
which demonstrates the bug. Then fix the bug, re-run the test suite,
and check everything in.
* Some files in the automake package are not owned by automake. These
files should never be edited here. These files are
COPYING (from FSF),
INSTALL (autoconf-patches@gnu.org),
config.guess, config.sub (config-patches@gnu.org),
texinfo.tex (bug-texinfo@gnu.org),
Most of them are updated before release with `make fetch'.
* Changes other than bug fixes must be mentioned in NEWS
================================================================
= Naming
* We've adopted the convention that internal AC_SUBSTs should be
named with a leading `am__', and internally generated targets should
be named with a leading `am--'. This convention is very new
(as of Feb 7 2001) and so it isn't yet universally used. But all
new code should use it.
We used to use `_am_' as the prefix for an internal AC_SUBST.
However, it turns out that NEWS-OS 4.2R complains if a Makefile
variable begins with `_'. Yay for them. I changed the target
naming convention just to be safe.
================================================================
= Editing `.am' files
* Always use $(...) and not ${...}
* Use `:', not `true'. Use `exit 1', not `false'.
* Use `##' comments liberally. Comment anything even remotely
unusual.
* Never use basename or dirname. Instead use sed
* Do not use `cd' within back-quotes, use `$(am__cd)' instead.
Otherwise the directory name may be printed, depending on CDPATH.
* For install and uninstall rules, if a loop is required, it should be
silent. Then the body of the loop itself should print each
"important" command it runs. The printed commands should be preceded
by a single space.
================================================================
= Editing automake.in and aclocal.in
* Indent using GNU style. For historical reasons, the perl code
contains portions indented using Larry Wall's style (perl-mode's
default), and other portions using the GNU style (cperl-mode's
default). Write new code using GNU style.
* Don't use & for function calls, unless required.
The use of & prevents prototypes from being checked.
Just as above, don't change massively all the code to strip the
&, just convert the old code as you work on it, and write new
code without.
* Perl 5 is now OK.
================================================================
= Working with git/CVS
* To regenerate dependent files created by aclocal and automake,
use the `bootstrap' script. It uses the code from the source
tree, so the resulting files (aclocal.m4 and Makefile.in) should
be the same as you would get if you install this version of
automake and use it to generate those files.
* Dependent files aclocal.m4, configure and Makefile.in in all
directories should be up to date in the git repository, so that
the changes in them can be easily noticed and analyzed.
* Avoid merge commits on the master branch of the public git repository.
For unpublished changes in your development tree, it's easiest to
rebase against the current master before applying them, this preserves
a linear history.
* For changes to appear in more than one branch, apply them to the
master branch and then cherry-pick them to the stable branch from
master if possible. This keeps the master uncluttered and preserves
meta-data on the stable branches.
================================================================
= Test suite
* Use "make check" and "make maintainer-check" liberally
* Make sure each test file is executable
* Use `keep_testdirs=yes' to keep test directories for successful
tests also.
================================================================
= Release procedure
* Fetch new versions of the files that are maintained by the FSF.
Commit. Unfortunately you need an FSF account to do this.
(You can also use `make fetch', but that is still woefully incomplete.)
* Update NEWS. For an alpha release, update README-alpha.
* Update the version number in configure.ac.
(The idea is that every other alpha number will be a net release.
The repository will always have its own "odd" number so we can easily
distinguish net and repo versions.)
* Update ChangeLog.
* Run ./bootstrap, ./configure, make.
* NOTE: the next step has not been tested yet with git, so be careful.
* Run `make git-release'.
This will run distcheck to create the tarballs, commit the last
NEWS/configure.ac/ChangeLog changes, tag the repository, sign
the tarballs, and upload them.
Use `make GNUPLOADFLAGS="--user key" git-release' to sign with
a non-default key.
* Update version number in configure.ac to next alpha number.
Re-run ./bootstrap and commit.
* Send announcement at least to autotools-announce@gnu.org, and
automake@gnu.org. If not an alpha, announcement must also go to
info-gnu@gnu.org.
-----
Copyright (C) 2003, 2007 Free Software Foundation, Inc.
This file is part of GNU Automake.
GNU Automake is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3, or (at your option)
any later version.
GNU Automake is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with autoconf; see the file COPYING. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
Local Variables:
mode: text
End:
|
