`make mostlyclean', to remove everything directly Halibut-generated

[sgt/putty] / CHECKLST.txt

diff --git a/CHECKLST.txt b/CHECKLST.txt
index 522892e..3f43a18 100644 (file)
--- a/CHECKLST.txt
+++ b/CHECKLST.txt
@@ -21,9 +21,11 @@ The resource files:
  - putty/windows/puttygen.rc
     + the copyright date appears twice, once in the About box and
       once in the Licence box. Don't forget to change both!
- - putty/windows/win_res.rc
+ - putty/windows/win_res.rc2
     + the copyright date appears twice, once in the About box and
       once in the Licence box. Don't forget to change both!
+ - putty/windows/version.rc2
+    + the copyright date appears once only.
  - putty/mac/mac_res.r
     + the copyright date appears twice, once in the About box and
       once in the Licence box. Don't forget to change both!
@@ -46,9 +48,10 @@ The website:
 Before tagging a release
 ------------------------
 
- - First of all, go through the source (including the documentation)
-   and remove anything tagged with a comment containing the word
-   XXX-REMOVE-BEFORE-RELEASE.
+ - First of all, go through the source (including the documentation),
+   and the website, and review anything tagged with a comment
+   containing the word XXX-REVIEW-BEFORE-RELEASE.
+   (Any such comments should state clearly what needs to be done.)
 
 For a long time we got away with never checking the current version
 number in at all - all version numbers were passed into the build
@@ -65,13 +68,17 @@ orders them correctly with respect to releases):
 
  - putty/LATEST.VER
 
-The Windows installer script (_three_ times, on consecutive lines,
-and again in a subsequent comment):
+The Windows installer script (_four_ times, on consecutive lines):
 
  - putty/windows/putty.iss
 
+The Windows resource file (used to generate the binary bit of the
+VERSIONINFO resources -- the strings are supplied by the usual means):
+
+ - putty/windows/version.rc2 (BASE_VERSION; NB, _comma_-separated)
+
 The Mac resource file (used to generate the binary bit of the 'vers'
-resources -- the strings are supplied by the usual means):
+resources):
 
  - putty/mac/version.r
 
@@ -114,7 +121,8 @@ of the tag.
 
  - Build the Windows/x86 release binaries. Don't forget to supply
    VER=/DRELEASE=<ver>. Run them, or at least one or two of them, to
-   ensure that they really do report their version number correctly.
+   ensure that they really do report their version number correctly,
+   and sanity-check the version info reported on the files by Windows.
     + Save the release link maps. Currently I keep these on ixion,
       in src/putty/local/maps-<version>.
 
@@ -129,7 +137,12 @@ of the tag.
  - Run Halibut to build the docs. Define VERSION on the make command
    line to override the version strings, since Subversion revision
    numbers are less meaningful on a tag.
-    + make -C doc VERSION="PuTTY release 0.XX"
+    + change into the doc subdir
+    + run `make VERSION="PuTTY release 0.XX" chm', then run `hhc
+      putty.hhp' to build the .CHM
+    + then run `make mostlyclean' (destroys the hhc input files but
+      _not_ the .CHM)
+    + then `make VERSION="PuTTY release 0.XX"'
 
  - Build the binary archives putty.zip (one for each architecture):
    each one just contains all the .exe files except PuTTYtel, and
@@ -214,6 +227,10 @@ of the tag.
      Download page.
    + Adjust header text on Changelog page. (That includes changing
      `are new' in previous version to `were new'!)
+   + FOR NEXT RELEASE ONLY: update the docs page so that it links to
+     the release .chm as well as the release .hlp and .cnt. Remove
+     this checklist item after it's done; it won't need doing again
+     in the subsequent release.
 
  - Update the wishlist. This can be done without touching individual
    items by editing the @releases array in control/bugs2html.