Commit | Line | Data |
---|---|---|
2732830a | 1 | This is a checklist for making Guile releases. |
251ca7ab JB |
2 | It's specific to the FSF's development environment; please don't put |
3 | it in the distribution. | |
2732830a | 4 | |
f8c9d497 JB |
5 | Maybe we should name Guile releases after entertaining poisons: |
6 | absinthe, etc. However, the first release containing the module | |
7 | system should be called Godot: "This is the one you've been waiting | |
8 | for." | |
f7677ff2 | 9 | |
cc914709 JB |
10 | Platforms for test builds: |
11 | SunOS (gcc and pcc) --- galapas.ai.mit.edu | |
12 | Solaris (gcc and SUN cc) --- saturn.ai.mit.edu | |
13 | NetBSD (gcc) --- repo-man.ai.mit.edu (use /home/repo/jimb) | |
14 | HP/UX (gcc, HP cc) --- nutrimat.gnu.ai.mit.edu | |
15 | ||
422b92d2 | 16 | These gentlemen have kindly offered to do pre-release testing: |
99ac53b9 MD |
17 | |
18 | Tom Tromey <tromey@cygnus.com>: | |
19 | ||
20 | alphaev5-unknown-linux-gnu | |
21 | hppa1.1-hp-hpux10.20 | |
22 | hppa1.1-hp-hpux11.00 | |
23 | mips-sgi-irix5.3 | |
24 | powerpc-ibm-aix4.2.0.0 | |
25 | powerpc-unknown-linux-gnu | |
26 | sparc-sun-solaris2.6 | |
27 | i686-pc-linux-gnu | |
28 | mips-sgi-irix6.3 | |
29 | sparc-sun-sunos4.1.4 | |
30 | ||
31 | Ian Grant <I.A.N.Grant@damtp.cam.ac.uk>: | |
32 | ||
c7552137 | 33 | alpha-dec-osf4.0e |
99ac53b9 MD |
34 | |
35 | Julian Satchell <satchell@merry.dra.hmg.gb>: | |
36 | ||
37 | dec-mips-ultrix | |
cc914709 | 38 | |
d4c83f63 JB |
39 | Perry Metzger <perry@piermont.com> |
40 | ||
41 | NetBSD | |
42 | ||
3f686b10 JB |
43 | |
44 | Release Checklists =================================================== | |
45 | ||
46 | There are basically two phases to doing a release: | |
47 | ||
48 | * "SPIFFING": Updating NEWS, README, INSTALL. Running tests. Getting | |
49 | people to try builds on various machines. Getting everything | |
50 | straightened up. | |
51 | ||
52 | * "PUNTING": Updating the version numbers. Tagging the sources. Asking | |
53 | the FSF to put the disty on ftp.gnu.org. Posting announcements. | |
54 | ||
55 | The "Spiffing" phase you might go through several times as you | |
56 | discover problems. The "Punting" phase you do only once. | |
57 | ||
58 | ||
59 | Spiffing checklist: | |
60 | ||
61 | * Do a `cvs update -A', to get rid of any sticky tags in your working | |
62 | directory. | |
63 | * Check for files that have changed a lot, but do not have up-to-date | |
fba33ff1 | 64 | copyright notices. This can be as simple as doing: |
341f78c9 | 65 | grep 'Copyright' * | grep -v 1999 |
fba33ff1 | 66 | and looking for files you know you've worked on a lot. |
a5eebee7 | 67 | * Make sure NEWS, INSTALL, AUTHORS and THANKS and the docs are up to date: |
3f686b10 JB |
68 | + Scan the ChangeLogs for user-visible changes, marked with an asterisk |
69 | at the left margin. | |
70 | + Update NEWS and the Texinfo documentation as appropriate. | |
71 | + Remove the user-visible markers from the log entries once they're | |
72 | documented. | |
73 | + Check for any [[incomplete]] sections of NEWS. | |
74 | + Fact-check INSTALL. | |
a5eebee7 | 75 | + Make sure AUTHORS and THANKS are up-to-date. |
e4445210 | 76 | * Make sure the downloading addresses and filenames in README are |
340a8770 | 77 | current. (But don't bump the version number yet. We do that below.) |
3f686b10 | 78 | * Check that the versions of aclocal, automake, autoconf, and autoheader |
f43aac9a | 79 | in your PATH match those given in HACKING. Note that the `make |
3f686b10 JB |
80 | dist' process always invokes these tools, even when all the |
81 | generated files are up to date. | |
e673b804 MV |
82 | Make specifically sure that the files in libltdl are generated using |
83 | the same tools as the rest. | |
3f686b10 JB |
84 | * Rebuild all generated files in the source tree: |
85 | + Install the .m4 files where aclocal will find them. | |
86 | + Run aclocal. | |
3f686b10 JB |
87 | + Run autoconf. |
88 | + Run autoheader. | |
14a7a25d | 89 | + Run automake. |
3f686b10 | 90 | * Verify that Guile builds and runs in your working directory. |
f43aac9a | 91 | * Run the test suite, in guile-core/test-suite. |
3f686b10 JB |
92 | * Commit all changes to the CVS repository. |
93 | * Build a test distribution. | |
94 | + BEFORE doing 'make dist', configure the source tree for build | |
9a8a1e8a MD |
95 | in the same tree with configuration options |
96 | --enable-maintainer-mode --enable-debug-malloc --with-threads. | |
24e720c8 JB |
97 | + Make sure that readline was enabled correctly. |
98 | + Build the tree. | |
99 | (If the above steps are not done, the dependencies won't be properly | |
100 | included in the generated Makefile.in files.) | |
3f686b10 | 101 | + Then do 'make dist'. |
b5074b23 MD |
102 | + Check that the dependencies in guile-readline/Makefile look OK. |
103 | (We currently use a kludge which edits the dependencies generated | |
104 | by automake so that Guile can be built in a directory separate | |
105 | from the source tree also with non-GNU make programs.) | |
3f686b10 JB |
106 | * Give the test disty to various people to try. Here's what you should do: |
107 | + Unset GUILE_LOAD_PATH. | |
108 | + Remove automake and autoconf from your path, or turn off their | |
109 | execute bits, or something. (Users must be able to build the | |
110 | disty without installing those tools.) | |
111 | + Configure, make, and install. | |
112 | + Make sure LD_LIBRARY_PATH doesn't include anything unnecessary. | |
113 | + Run the test suite on the installed version. | |
114 | + You might try the example code in the doc directory. | |
115 | ||
116 | Once you've got a disty that seems pretty solid: | |
117 | ||
118 | * Choose new interface numbers for shared libraries. | |
119 | * Update the version numbers in GUILE-VERSION and README. (There are | |
120 | many places in README that need updating!) The Guile version | |
121 | number should have one of the following forms: | |
122 | N.M - a major release | |
123 | N.M.L, where L is even - a minor release | |
124 | N.M.L, where L is odd - sources from CVS or nightly snapshot | |
125 | * Reformat the names in THANKS. | |
126 | * Do a `cvs update -A' of the whole tree, to look for any stray | |
127 | uncommitted or accidental changes. | |
128 | * Commit your changes. | |
129 | * Make one last test distribution. | |
130 | ||
131 | Punting checklist: | |
132 | ||
133 | * Add "Guile N.M released." entry to the top-level ChangeLog, and commit it. | |
c7552137 | 134 | * Tag the entire source tree with a tag of the form "release_N_M" |
3f686b10 | 135 | or "release_N_M_L". |
bab4e1cc | 136 | * Do a 'make dist'. |
3f686b10 JB |
137 | * Put the distribution up for FTP somewhere, and send mail to |
138 | ftp-upload@gnu.org, asking them to put it on prep. | |
139 | * Send an announcement message to gnu-announce@gnu.org. Put a brief | |
140 | summary of the changes in this release first, then "Obtaining | |
141 | Guile", "Thanks", "About This Distribution," and "Nightly | |
142 | Snapshots." If I remember correctly, the moderator will delay it | |
143 | until the distribution appears on ftp.gnu.org. The announcement | |
144 | text should be mostly taken from Guile's README file. | |
145 | * Notify freshmeat.net, although they're probably watching anyway. | |
146 | (They got the 1.3 release just fine.) I have no idea if | |
147 | www.bowerbird.com.au will be something anyone refers to, but Guile | |
148 | does have an entry there. | |
149 | * Tweak the version numbers in GUILE-VERSION, and README to indicate | |
150 | that the sources are a snapshot again. Snapshots should have | |
151 | version numbers of the form "N.M.L", where L is odd. | |
152 | * Start a new section of the NEWS file. | |
153 | * Start a new THANKS file. |