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