xref: /libtiff-4.0.7/HOWTO-RELEASE (revision cb66df4e)
1HOWTO-RELEASE:
2
3Notes on releasing.
4
50. Make sure that you have current FSF releases of autoconf, automake,
6   and libtool packages installed under a common installation prefix
7   and that these tools are in your executable search path prior to
8   any other installed versions.  Versions delivered with Linux may be
9   altered so it is best to install official FSF releases. GNU 'm4'
10   1.4.16 is needed in order to avoid bugs in m4. These packages may
11   be downloaded from the following ftp locations:
12
13     m4       - ftp://ftp.gnu.org/pub/gnu/m4
14     autoconf - ftp://ftp.gnu.org/pub/gnu/autoconf
15     automake - ftp://ftp.gnu.org/pub/gnu/automake
16     libtool  - ftp://ftp.gnu.org/pub/gnu/libtool
17
18   It is recommanded building m4 before autoconf, since the latest requires
19   the former.
20
21   Release builds should only be done on a system with a functioning
22   and correctly set system clock and on a filesystem which accurately
23   records file update times.  Use of GNU make is recommended.
24
251. Commit any unsaved changes.
26
272. Create html/vX.X.html and add it to cvs with 'cvs add html/vX.X.html'.
28   Take ChangeLog entries and html-ify in there.
29   Easist thing to do is take html/vX.(X-1).html and use it as a template.
30   Add that file to the list of EXTRA_DIST files in the html/Makefile.am.
31
323. Update html/index.html to refer to this new page as the current release.
33
344. Increment the release version in configure.ac.  Put 'alpha' or
35   'beta' after the version, if applicable.  For example:
36
37     4.0.0
38      or
39     4.0.0beta7
40
41   Version should be updated in two places: in the second argument of the
42   AC_INIT macro and in LIBTIFF_xxx_VERSION variables.
43
445. Update library ELF versioning in configure.ac (LIBTIFF_CURRENT,
45   LIBTIFF_REVISION, and LIBTIFF_AGE).  These numbers have nothing to
46   do with the libtiff release version numbers.
47
48   Note that as of libtiff 4.X, proper ELF versioning is used so
49   please follow the rules listed in configure.ac.  At a bare minimum,
50   you should increment LIBTIFF_REVISION for each release so that
51   installed library files don't overwrite existing files.  If APIs
52   have been added, removed, or interface structures have changed,
53   then more care is required.
54
556. Add an entry to Changelog similar to:
56
57     * libtiff 4.0.0 released.
58
597. In the source tree do
60
61     ./autogen.sh
62
63   This step may be skipped if you have already been using a
64   maintainer build with current autoconf, automake, and libtool
65   packages.  It is only needed when updating tool versions.
66
678. It is recommended (but not required) to build outside of the source
68   tree so that the source tree is kept in a pristine state.  This
69   also allows sharing the source directory on several networked
70   systems.  For example:
71
72     mkdir libtiff-build
73     cd libtiff-build
74     /path/to/libtiff/configure --enable-maintainer-mode
75
76   otherwise do
77
78     ./configure --enable-maintainer-mode
79
809. In the build tree do
81
82     make release
83
84   This will update "RELEASE-DATE", "VERSION", and libtiff/tiffvers.h
85   in the source tree.
86
8710. In the source tree, verify that the version info in RELEASE-DATE,
88   VERSION and libtiff/tiffvers.h is right.
89
9011. In the build tree do
91
92      make
93      make distcheck
94
95    If 'make distcheck' fails, then correct any issues until it
96    succeeds.
97
98    Two files with names tiff-version.tar.gz and tiff-version.zip will
99    be created in the top level build directory.
100
10112. In the source tree do
102
103      'cvs commit'.
104
10513. In the source tree do
106
107      cvs tag Release-v4-0-0
108
109    (or the appropriate name for the release)
110
11114. Copy release packages from the build tree to the
112    ftp.remotesensing.org ftp site.
113
114      scp tiff-*.tar.gz tiff-*.zip \
115    	 [email protected]:/osgeo/download/libtiff
116
11715. Announce to list, [email protected]
118
119