Preparing the Release

This outlines the various places where changes should be made to version numbers etc before attempting to make the release.

1. Update INSTALL documents

   • $CCP4/INSTALL.html and derived documents INSTALL and INSTALL.ps
   • $CCP4/ccp4i_installation.html

2. Update $CCP4/README

3. Update CHANGES files

   • Make sure version numbers are correct.
   • $CCP4/CHANGES and $CHTML/CHANGESinVx_y.html

4. Version numbers

   • $CLIBS/ccp4_program.h (macros CCP4_VERSION_NO and CCP4_PATCH_LEVEL)
   • $CCP4I_TOP/bin/OPSYS/startup.tcl (CCP4i & CCP4 version numbers)
   • For documentation: on dlpx1 $CHTML, update "makeindices.pl" and "makereference" scripts.

5. Documentation
   NB at present this needs to be done on dlpx1.

   • CHTML: "make indices" to remake INDEX.html, FUNCTION.html & whatis
   • CHTML: "make reference" to remake REFERENCES.html
   • CDOC: "make" to remake the man files
     Nb: make sure you check for any new program docs, e.g. by doing

            > cvs status *.doc | grep -i unknown
            

     and scanning through by eye to spot those which need adding to CVS.
   • CCP4i: the core documentation should be updated from the doc-comments by running

            > $CCP4/ccp4i/bin/create_docs
            

     Nb: this automatically puts the documents in the correct place, but <warning> it uses the environment to decide where.
   • Manual: update program lists and re-make manual.ps and manual_us.ps
     To get the US version:
     • In manual.tex, uncomment "letterpaper" and comment out "times" (Latex comment character is "%")
     • Run "gmake manual.ps", then "mv manual.ps manual_us.ps"
   • Acknowledgements
     Update the $CHTML/ACKNOWLEDGEMENTS_V*.html document
   • Update the C library documentation

6. Examples/Tutorials

   • Update the distributed *.log-dist files in $CEXAM/unix/runnable
   • (nb should be part of the testing) check the tutorials and update the log files

7. Setup files

   • $CINCL/ccp4.setup-dist, ccp4.setup-bash & ccp4.setup-sh (to point to the correct top level dir)

These jobs should be trivial tidying up, so anything major e.g. checking the tutorials ought to be part of an earlier stage and be granted more time to be completed.

[Back: Contents] [Next: Trial Release]