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