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