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 | |
c7b6388d DH |
10 | Before releasing the next version of libguile which is not binary compatible |
11 | with the one released with 1.4: | |
12 | - remove struct members system_transformer and top_level_lookup_closure_var | |
13 | from struct scm_root_state in root.h. | |
14 | ||
04914986 DH |
15 | After signal handling and threading have been fixed: |
16 | - remove the code corresponding to GUILE_OLD_ASYNC_CLICK and the corresponding | |
17 | GUILE_OLD_ASYNC_CLICK macro. | |
18 | ||
7c1e0b12 | 19 | In release 1.5: |
894a712b DH |
20 | - remove deprecated macros: SCM_INPORTP, SCM_OUTPORTP, SCM_CRDY, SCM_ICHRP, |
21 | SCM_ICHR, SCM_MAKICHR, SCM_SETJMPBUF, SCM_NSTRINGP, SCM_NRWSTRINGP, | |
22 | SCM_NVECTORP | |
820920e6 | 23 | - remove gc-thunk (It has been replaced by after-gc-hook.) |
894a712b DH |
24 | - remove scm_sysmissing |
25 | - remove gh_int2scmb (replaced by gh_bool2scm) | |
26 | - remove scm_fseek (replaced by scm_seek) | |
27 | - remove scm_tag | |
e11f8b42 DH |
28 | - remove code related to the name property of hooks. Also, check init.c, |
29 | since the dependency between hooks and objprop will then be eliminated. | |
0a9e521f MD |
30 | - remove deprecated function scm_list_star/list* (use SRFI-1 compliant |
31 | scm_cons_star/cons* instead.) | |
32 | - remove scm_tc16_flo, scm_tc_flo (guile always uses doubles to represent | |
33 | inexact real numbers) | |
34 | - remove scm_tc_dblr (replaced by scm_tc16_real) | |
35 | - remove scm_tc_dblc (replaced by scm_tc16_complex) | |
36 | - remove deprecated types, functions and macros from numbers.h: scm_dblproc, | |
37 | SCM_UNEGFIXABLE, SCM_FLOBUFLEN, SCM_INEXP, SCM_CPLXP, SCM_REAL, SCM_IMAG, | |
38 | SCM_REALPART, scm_makdbl, SCM_SINGP, SCM_NUM2DBL, SCM_NO_BIGDIG | |
7c1e0b12 | 39 | |
b63a956d DH |
40 | In release 1.6: |
41 | - remove deprecated macros: SCM_OUTOFRANGE, SCM_NALLOC, SCM_HUP_SIGNAL, | |
42 | SCM_INT_SIGNAL, SCM_FPE_SIGNAL, SCM_BUS_SIGNAL, SCM_SEGV_SIGNAL, | |
43 | SCM_ALRM_SIGNAL, SCM_GC_SIGNAL, SCM_TICK_SIGNAL, SCM_SIG_ORD, | |
44 | SCM_ORD_SIG, SCM_NUM_SIGS | |
45 | ||
46 | ||
ed8c8636 MD |
47 | Modules sort.c and random.c should be factored out into separate |
48 | modules (but still be distributed with guile-core) when we get a new | |
49 | module system. | |
50 | ||
cc914709 JB |
51 | Platforms for test builds: |
52 | SunOS (gcc and pcc) --- galapas.ai.mit.edu | |
53 | Solaris (gcc and SUN cc) --- saturn.ai.mit.edu | |
54 | NetBSD (gcc) --- repo-man.ai.mit.edu (use /home/repo/jimb) | |
55 | HP/UX (gcc, HP cc) --- nutrimat.gnu.ai.mit.edu | |
56 | ||
422b92d2 | 57 | These gentlemen have kindly offered to do pre-release testing: |
99ac53b9 MD |
58 | |
59 | Tom Tromey <tromey@cygnus.com>: | |
60 | ||
61 | alphaev5-unknown-linux-gnu | |
62 | hppa1.1-hp-hpux10.20 | |
63 | hppa1.1-hp-hpux11.00 | |
64 | mips-sgi-irix5.3 | |
65 | powerpc-ibm-aix4.2.0.0 | |
66 | powerpc-unknown-linux-gnu | |
67 | sparc-sun-solaris2.6 | |
68 | i686-pc-linux-gnu | |
69 | mips-sgi-irix6.3 | |
70 | sparc-sun-sunos4.1.4 | |
71 | ||
72 | Ian Grant <I.A.N.Grant@damtp.cam.ac.uk>: | |
73 | ||
74 | alpha-dec-osf4.0e | |
75 | ||
76 | Julian Satchell <satchell@merry.dra.hmg.gb>: | |
77 | ||
78 | dec-mips-ultrix | |
cc914709 | 79 | |
d4c83f63 JB |
80 | Perry Metzger <perry@piermont.com> |
81 | ||
82 | NetBSD | |
83 | ||
3f686b10 JB |
84 | |
85 | Release Checklists =================================================== | |
86 | ||
87 | There are basically two phases to doing a release: | |
88 | ||
89 | * "SPIFFING": Updating NEWS, README, INSTALL. Running tests. Getting | |
90 | people to try builds on various machines. Getting everything | |
91 | straightened up. | |
92 | ||
93 | * "PUNTING": Updating the version numbers. Tagging the sources. Asking | |
94 | the FSF to put the disty on ftp.gnu.org. Posting announcements. | |
95 | ||
96 | The "Spiffing" phase you might go through several times as you | |
97 | discover problems. The "Punting" phase you do only once. | |
98 | ||
99 | ||
100 | Spiffing checklist: | |
101 | ||
102 | * Do a `cvs update -A', to get rid of any sticky tags in your working | |
103 | directory. | |
104 | * Check for files that have changed a lot, but do not have up-to-date | |
fba33ff1 | 105 | copyright notices. This can be as simple as doing: |
341f78c9 | 106 | grep 'Copyright' * | grep -v 1999 |
fba33ff1 | 107 | and looking for files you know you've worked on a lot. |
3f686b10 JB |
108 | * Make sure NEWS, INSTALL and the docs are up to date: |
109 | + Scan the ChangeLogs for user-visible changes, marked with an asterisk | |
110 | at the left margin. | |
111 | + Update NEWS and the Texinfo documentation as appropriate. | |
112 | + Remove the user-visible markers from the log entries once they're | |
113 | documented. | |
114 | + Check for any [[incomplete]] sections of NEWS. | |
115 | + Fact-check INSTALL. | |
e4445210 | 116 | * Make sure the downloading addresses and filenames in README are |
340a8770 | 117 | current. (But don't bump the version number yet. We do that below.) |
3f686b10 | 118 | * Check that the versions of aclocal, automake, autoconf, and autoheader |
f43aac9a | 119 | in your PATH match those given in HACKING. Note that the `make |
3f686b10 JB |
120 | dist' process always invokes these tools, even when all the |
121 | generated files are up to date. | |
122 | * Rebuild all generated files in the source tree: | |
123 | + Install the .m4 files where aclocal will find them. | |
124 | + Run aclocal. | |
3f686b10 JB |
125 | + Run autoconf. |
126 | + Run autoheader. | |
14a7a25d | 127 | + Run automake. |
3f686b10 | 128 | * Verify that Guile builds and runs in your working directory. |
f43aac9a | 129 | * Run the test suite, in guile-core/test-suite. |
3f686b10 JB |
130 | * Commit all changes to the CVS repository. |
131 | * Build a test distribution. | |
132 | + BEFORE doing 'make dist', configure the source tree for build | |
9a8a1e8a MD |
133 | in the same tree with configuration options |
134 | --enable-maintainer-mode --enable-debug-malloc --with-threads. | |
24e720c8 JB |
135 | + Make sure that readline was enabled correctly. |
136 | + Build the tree. | |
137 | (If the above steps are not done, the dependencies won't be properly | |
138 | included in the generated Makefile.in files.) | |
3f686b10 | 139 | + Then do 'make dist'. |
b5074b23 MD |
140 | + Check that the dependencies in guile-readline/Makefile look OK. |
141 | (We currently use a kludge which edits the dependencies generated | |
142 | by automake so that Guile can be built in a directory separate | |
143 | from the source tree also with non-GNU make programs.) | |
3f686b10 JB |
144 | * Give the test disty to various people to try. Here's what you should do: |
145 | + Unset GUILE_LOAD_PATH. | |
146 | + Remove automake and autoconf from your path, or turn off their | |
147 | execute bits, or something. (Users must be able to build the | |
148 | disty without installing those tools.) | |
149 | + Configure, make, and install. | |
150 | + Make sure LD_LIBRARY_PATH doesn't include anything unnecessary. | |
151 | + Run the test suite on the installed version. | |
152 | + You might try the example code in the doc directory. | |
153 | ||
154 | Once you've got a disty that seems pretty solid: | |
155 | ||
156 | * Choose new interface numbers for shared libraries. | |
157 | * Update the version numbers in GUILE-VERSION and README. (There are | |
158 | many places in README that need updating!) The Guile version | |
159 | number should have one of the following forms: | |
160 | N.M - a major release | |
161 | N.M.L, where L is even - a minor release | |
162 | N.M.L, where L is odd - sources from CVS or nightly snapshot | |
163 | * Reformat the names in THANKS. | |
164 | * Do a `cvs update -A' of the whole tree, to look for any stray | |
165 | uncommitted or accidental changes. | |
166 | * Commit your changes. | |
167 | * Make one last test distribution. | |
168 | ||
169 | Punting checklist: | |
170 | ||
171 | * Add "Guile N.M released." entry to the top-level ChangeLog, and commit it. | |
172 | * Tag the entire source tree with a tag of the form "release_N_M" | |
173 | or "release_N_M_L". | |
bab4e1cc | 174 | * Do a 'make dist'. |
3f686b10 JB |
175 | * Put the distribution up for FTP somewhere, and send mail to |
176 | ftp-upload@gnu.org, asking them to put it on prep. | |
177 | * Send an announcement message to gnu-announce@gnu.org. Put a brief | |
178 | summary of the changes in this release first, then "Obtaining | |
179 | Guile", "Thanks", "About This Distribution," and "Nightly | |
180 | Snapshots." If I remember correctly, the moderator will delay it | |
181 | until the distribution appears on ftp.gnu.org. The announcement | |
182 | text should be mostly taken from Guile's README file. | |
183 | * Notify freshmeat.net, although they're probably watching anyway. | |
184 | (They got the 1.3 release just fine.) I have no idea if | |
185 | www.bowerbird.com.au will be something anyone refers to, but Guile | |
186 | does have an entry there. | |
187 | * Tweak the version numbers in GUILE-VERSION, and README to indicate | |
188 | that the sources are a snapshot again. Snapshots should have | |
189 | version numbers of the form "N.M.L", where L is odd. | |
190 | * Start a new section of the NEWS file. | |
191 | * Start a new THANKS file. |