RELEASE

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