sane-project-backends/doc/releases.txt

2009-05-05

This text summarizes some points to pay attention to when a new release
of sane-backends is planned.

Timetable (approximate periods):

Day  0: Announcement of upcoming release on sane-devel including timetable
Day 14: Feature freeze (only bugfixes + documentation updates)
Day 28: Code freeze (only fixes for bugs that can destroy hardware, can cause 
        compilation problems or render a backend completely unusable, and
        documentation updates are allowed)
Day 35: Release

Before the release:

* Make sure that config.guess and config.sub are up-to-date (get them from
  savannah.gnu.org/projects/config)
* configure.in: increase version number
* configure.in: remove 'cvs' from textual version number
* configure.in: set is_release=yes
* OPTIONAL: aclocal.m4: recreate by running aclocal
* OPTIONAL: include/sane/config.h.in: recreate (autoheader in root of checkout)
* DONT run automake, it will overwrite our custom ltmain.sh
* configure: recreate by running autoconf
* NEWS: update and enter date of release
* sane-backends.lsm: update
* ChangeLog: set release marker
* cvs commit
* tag git with release tag; e.g.: 'git tag -a RELEASE_1_0_15'

Making the release:

* make tar.gz, sane-backends-x.y.z.lsm, and .md5sum with "make sane-backends"
* unpack tar.gz in temporary directory
* make diff from last release by unpacking it also in temporary directory
  and running e.g. 
  diff -uNr sane-backends-1.0.14 sane-backends-1.0.15  > sane-backends-1.0.14-1.0.15.diff
* check that the diff applies cleanly to the old version
* gzip the diff
* install devel headers required to build optional backends (1284,gphoto,etc)
* check that the new version .tar.gz can be compiled
* upload these files together with the .diff.gz to the FTP/HTTP servers
  (at the moment: alioth.debian.org, ftp files are in
  /srv/alioth.debian.org/chroot/ftproot/pub/sane/ )

Announcing the release:

* checkout the html module and:
* copy sane-backends.html to sane-backends-"old-version".html
* update sane-supported-devices.html with link to above "old" file
* rebuild sane-backends.html and sane-mfgs.html (see doc/Makefile)
* use man2htmlfrom http://hydra.nac.uci.edu/indiv/ehood/man2html.html
  to rebuild html man pages (see doc/Makefile) (no other version works)
* add md5 sum to sane-md5sum.txt
* check and update platforms page (sane-support.html)
* write announcements on sane-project.org and sane-devel, maybe others
  (e.g. freshmeat), include the md5 hash

After the release:

* move ChangeLog to ChangeLog-"version" and start a new ChangeLog
* add ChangeLog-"version" to EXTRA_DIST in Makefile.in
* configure.in: bump version and V_REV
* configure.in: add cvs suffix to textual version
* configure.in: set is_release=no
* configure: regenerate with autoconf
* remove the ':new' tag from any new backends .desc files
* commit
* on cvs.alioth.debian.org, cvs update, ./configure, make the cvs checkout in
  /org/alioth.debian.org/chroot/home/groups/sane/sane-backends-lists-cvs/
Update documentation to reflect the switch from CVS to git Basically s/CVS/git/ for now, more changes in the future? 2009-05-05 08:53:47 +00:00			`2009-05-05`
2001-04-16 Henning Meier-Geinitz <hmg@gmx.de> * README: Updated xsane link. * configure configure.in backend/dll.c backend/dll.desc backend/net.c backend/net.desc include/sane/config.h.in Yet another change in the version system for dll and net. For sane_init return the version of the package but use own internal version number in the source (printed with debugging enabled) and in .desc. The internal versions of both net and dll are set to 1.0.1. Please increase the build number with every change on the source files. doc/realeases.txt -> doc/releases.txt. Fixed spelling error. Added entries about sane-backends.html, sane.ps, man pages, platforms page. 2001-04-16 12:21:41 +00:00
Updated contact information. Spelling fixes. Minor updates. 2003-09-24 14:00:00 +00:00			`This text summarizes some points to pay attention to when a new release`
updated fr translation from Yann E. MORIN, added S500M usb id to fujitsu 2008-01-17 01:03:43 +00:00			`of sane-backends is planned.`
Added paragraph about the different freeze types and a timetable. 2002-09-26 21:47:20 +00:00
			`Timetable (approximate periods):`

Updated contact information. Spelling fixes. Minor updates. 2003-09-24 14:00:00 +00:00			`Day 0: Announcement of upcoming release on sane-devel including timetable`
Updated according to current practice. 2004-11-07 19:40:52 +00:00			`Day 14: Feature freeze (only bugfixes + documentation updates)`
			`Day 28: Code freeze (only fixes for bugs that can destroy hardware, can cause`
Added paragraph about the different freeze types and a timetable. 2002-09-26 21:47:20 +00:00			`compilation problems or render a backend completely unusable, and`
			`documentation updates are allowed)`
Updated according to current practice. 2004-11-07 19:40:52 +00:00			`Day 35: Release`
2001-04-16 Henning Meier-Geinitz <hmg@gmx.de> * README: Updated xsane link. * configure configure.in backend/dll.c backend/dll.desc backend/net.c backend/net.desc include/sane/config.h.in Yet another change in the version system for dll and net. For sane_init return the version of the package but use own internal version number in the source (printed with debugging enabled) and in .desc. The internal versions of both net and dll are set to 1.0.1. Please increase the build number with every change on the source files. doc/realeases.txt -> doc/releases.txt. Fixed spelling error. Added entries about sane-backends.html, sane.ps, man pages, platforms page. 2001-04-16 12:21:41 +00:00
			`Before the release:`

Added info about config.guess and config.sub Henning Meier-Geinitz <henning@meier-geinitz.de> 2002-03-17 20:34:37 +00:00			`* Make sure that config.guess and config.sub are up-to-date (get them from`
SANE 1.0.19 release 2008-02-10 20:32:40 +00:00			`savannah.gnu.org/projects/config)`
Updates to prepare for 1.0.20 release: * configure.in: change version to 1.0.20cvs * configure: rebuild from configure.in * include/sane/sane.h: hide API changes (minor, frame and status) * backend/canon_dr.c, backend/fujitsu.c: SANE_FRAME_JPEG * backend/coolscan3.c: SANE_FRAME_RGBI * backend/genesys_gl646.c, backend/genesys_gl841.c: STATUS_HW_LOCKED * backend/rts8891.c, frontend/scanimage.c: STATUS_WARMING_UP * backend/pixma_io_sanei.c, backend/xerox_mfp.c, backend/sane_strstatus.c: STATUS_HW_LOCKED & STATUS_WARMING_UP * doc/releases.txt: minor updates for new build system 2009-04-12 19:40:31 +00:00			`* configure.in: increase version number`
			`* configure.in: remove 'cvs' from textual version number`
Typo fix. 2006-06-29 17:47:49 +00:00			`* configure.in: set is_release=yes`
SANE 1.0.19 release 2008-02-10 20:32:40 +00:00			`* OPTIONAL: aclocal.m4: recreate by running aclocal`
			`* OPTIONAL: include/sane/config.h.in: recreate (autoheader in root of checkout)`
			`* DONT run automake, it will overwrite our custom ltmain.sh`
			`* configure: recreate by running autoconf`
2001-04-16 Henning Meier-Geinitz <hmg@gmx.de> * README: Updated xsane link. * configure configure.in backend/dll.c backend/dll.desc backend/net.c backend/net.desc include/sane/config.h.in Yet another change in the version system for dll and net. For sane_init return the version of the package but use own internal version number in the source (printed with debugging enabled) and in .desc. The internal versions of both net and dll are set to 1.0.1. Please increase the build number with every change on the source files. doc/realeases.txt -> doc/releases.txt. Fixed spelling error. Added entries about sane-backends.html, sane.ps, man pages, platforms page. 2001-04-16 12:21:41 +00:00			`* NEWS: update and enter date of release`
			`* sane-backends.lsm: update`
			`* ChangeLog: set release marker`
SANE 1.0.19 release 2008-02-10 20:32:40 +00:00			`* cvs commit`
Update documentation to reflect the switch from CVS to git Basically s/CVS/git/ for now, more changes in the future? 2009-05-05 08:53:47 +00:00			`* tag git with release tag; e.g.: 'git tag -a RELEASE_1_0_15'`
2001-04-16 Henning Meier-Geinitz <hmg@gmx.de> * README: Updated xsane link. * configure configure.in backend/dll.c backend/dll.desc backend/net.c backend/net.desc include/sane/config.h.in Yet another change in the version system for dll and net. For sane_init return the version of the package but use own internal version number in the source (printed with debugging enabled) and in .desc. The internal versions of both net and dll are set to 1.0.1. Please increase the build number with every change on the source files. doc/realeases.txt -> doc/releases.txt. Fixed spelling error. Added entries about sane-backends.html, sane.ps, man pages, platforms page. 2001-04-16 12:21:41 +00:00
			`Making the release:`

Generate md5 hash when making the a release. 2003-11-26 21:42:24 +00:00			`* make tar.gz, sane-backends-x.y.z.lsm, and .md5sum with "make sane-backends"`
Updated according to current practice. 2004-11-07 19:40:52 +00:00			`* unpack tar.gz in temporary directory`
			`* make diff from last release by unpacking it also in temporary directory`
			`and running e.g.`
* config.guess, config.sub: updated to latest versions * NEWS, configure.in, configure: updated for 1.0.20 * sane-backends.lsm, doc/releases.txt: minor tweaks * doc/descriptions/coolscan3.desc, doc/descriptions/rts8891.desc: add :new marker, correct manpage link 2009-05-03 17:09:25 +00:00			`diff -uNr sane-backends-1.0.14 sane-backends-1.0.15 > sane-backends-1.0.14-1.0.15.diff`
Updated according to current practice. 2004-11-07 19:40:52 +00:00			`* check that the diff applies cleanly to the old version`
minor updates to html generation instructions 2009-05-04 00:22:21 +00:00			`* gzip the diff`
fix broken DISTFILES, etc 2008-02-10 23:02:31 +00:00			`* install devel headers required to build optional backends (1284,gphoto,etc)`
Updated according to current practice. 2004-11-07 19:40:52 +00:00			`* check that the new version .tar.gz can be compiled`
minor updates to html generation instructions 2009-05-04 00:22:21 +00:00			`* upload these files together with the .diff.gz to the FTP/HTTP servers`
			`(at the moment: alioth.debian.org, ftp files are in`
			`/srv/alioth.debian.org/chroot/ftproot/pub/sane/ )`
sane 1.0.19-cvs 2008-02-11 02:50:55 +00:00
			`Announcing the release:`

			`* checkout the html module and:`
			`* copy sane-backends.html to sane-backends-"old-version".html`
			`* update sane-supported-devices.html with link to above "old" file`
			`* rebuild sane-backends.html and sane-mfgs.html (see doc/Makefile)`
minor updates to html generation instructions 2009-05-04 00:22:21 +00:00			`* use man2htmlfrom http://hydra.nac.uci.edu/indiv/ehood/man2html.html`
			`to rebuild html man pages (see doc/Makefile) (no other version works)`
sane 1.0.19-cvs 2008-02-11 02:50:55 +00:00			`* add md5 sum to sane-md5sum.txt`
			`* check and update platforms page (sane-support.html)`
Updated contact information. Spelling fixes. Minor updates. 2003-09-24 14:00:00 +00:00			`* write announcements on sane-project.org and sane-devel, maybe others`
Generate md5 hash when making the a release. 2003-11-26 21:42:24 +00:00			`(e.g. freshmeat), include the md5 hash`
2001-04-16 Henning Meier-Geinitz <hmg@gmx.de> * README: Updated xsane link. * configure configure.in backend/dll.c backend/dll.desc backend/net.c backend/net.desc include/sane/config.h.in Yet another change in the version system for dll and net. For sane_init return the version of the package but use own internal version number in the source (printed with debugging enabled) and in .desc. The internal versions of both net and dll are set to 1.0.1. Please increase the build number with every change on the source files. doc/realeases.txt -> doc/releases.txt. Fixed spelling error. Added entries about sane-backends.html, sane.ps, man pages, platforms page. 2001-04-16 12:21:41 +00:00
			`After the release:`

Updated according to current practice. 2004-11-07 19:40:52 +00:00			`* move ChangeLog to ChangeLog-"version" and start a new ChangeLog`
* ChangeLog-1.0.20, Makefile.in: ChangeLog from 1.0.20 release * configure, configure.in: version 1.0.21cvs * doc/releases.txt: minor updates for new build system * doc/descriptions/canon_dr.desc, doc/descriptions/coolscan3.desc, doc/descriptions/rts8891.desc, doc/descriptions/xerox_mfp.desc: remove :new tag 2009-05-04 02:43:30 +00:00			`* add ChangeLog-"version" to EXTRA_DIST in Makefile.in`
			`* configure.in: bump version and V_REV`
			`* configure.in: add cvs suffix to textual version`
Updated contact information. Spelling fixes. Minor updates. 2003-09-24 14:00:00 +00:00			`* configure.in: set is_release=no`
sane 1.0.19-cvs 2008-02-11 02:50:55 +00:00			`* configure: regenerate with autoconf`
* ChangeLog-1.0.20, Makefile.in: ChangeLog from 1.0.20 release * configure, configure.in: version 1.0.21cvs * doc/releases.txt: minor updates for new build system * doc/descriptions/canon_dr.desc, doc/descriptions/coolscan3.desc, doc/descriptions/rts8891.desc, doc/descriptions/xerox_mfp.desc: remove :new tag 2009-05-04 02:43:30 +00:00			`* remove the ':new' tag from any new backends .desc files`
			`* commit`
* frontend/scanimage.c: improved comments, simplified x/y option code, removed buggy -1/+1 x/y code (#311172), expose non-settable options, check for invalid caps on options, handle option descs with \n * doc/releases.txt: add note about cvs checkout on alioth. 2009-02-25 03:29:14 +00:00			`* on cvs.alioth.debian.org, cvs update, ./configure, make the cvs checkout in`
			`/org/alioth.debian.org/chroot/home/groups/sane/sane-backends-lists-cvs/`