1 How to do a GTK+ release?
2 =========================
4 Make sure you have suitable versions of autoconf and libtool.
5 Also make sure you have the following packages installed with all their
9 Without those packages make distcheck will *not* pass.
12 0) Blow away your gtk+ directory, check a new version out
14 1) autogen and build it, make sure to enable docs by specifying
15 --enable-gtk-doc --enable-man
17 2) Update NEWS based on the various ChangeLog files; follow the format
18 of prior entries. This includes finding noteworthy new features,
19 collecting summaries for all the fixed bugs that are referenced
20 and collecting all updated translations.
21 Also collect the names of all contributors that are mentioned.
22 We don't discriminate between bug reporters, patch writers,
23 committers, etc. Anybody who is mentioned in ChangeLog gets
24 credits, but only real names, not email addresses or nicknames.
26 3) In particular, if this is a major, stable, release, verify that
27 README.in contains the relevant release notes and that the
28 required versions of dependencies in INSTALL.in are in sync
31 4) Verify that the version in configure.in has been bumped after the last
32 release. (Note that this is critical, a slip-up here will cause the
35 5) Make sure that make check is happy (If you don't do it here, make distcheck
36 will also catch it, but it is kind of disheartening to see make distcheck
37 fail due to an extraneous symbol after watching it build the docs for an
39 Typical problems to expect here (depending on whether this is a devel
40 snapshot or a stable release):
41 * forgotten source files
42 * new symbols missing from .symbols files
43 * symbols that are exported by should be private (static or _-prefixed)
44 * symbols that cause PLT entries. This is either caused by using
45 a in the same library function without including the header or by
46 using a function from a different library, which is not yet allowed
47 by the filter in pltcheck.sh
49 6) If this is a devel release, make sure that the docs for new symbols
50 are in good shape. Look at the -unused.txt files and add stuff found
51 there to the corresponding -sections.txt file. Look at the
52 -undocumented.txt files and see if there is anything in there that
53 should be documented. If it is, this may be due to typos in the doc
54 comments in the source. Make sure that all new symbols have proper
55 Since: tags, and that there is an index in the main -docs.sgml for
56 the next stable version.
58 7) Add === Released 2.x.y === at the top of all ChangeLog files
62 9) Fix broken stuff found by 8), repeat
64 10) svn commit; you'll have a bunch of po file changes, ChangeLog updates,
65 and maybe some doc changes too
67 11) If 10) fails because someone else committed inbetween, curse, svn up,
68 fix conflicts and go to 8)
70 12) Now you've got the tarball. Check that the tarball size looks
71 reasonable compared to previous releases. If the size goes down
72 a lot, likely the docs went missing for some reason. Or the translations.
73 If the size goes up by a lot, something else may be wrong.
75 13) Tag the release. The command for doing that looks like
77 svn cp svn+ssh://matthiasc@svn.gnome.org/svn/gtk+/branches/gtk-2-12 \
78 svn+ssh://matthiasc@svn.gnome.org/svn/gtk+/tags/GTK_2_12_10
80 14) Bump the version number in configure.in and commit this change
81 with a ChangeLog entry
83 15) Upload the tarball to master.gnome.org and run install-module to transfer
84 it to download.gnome.org. If you don't have an account on master.gnome.org,
85 find someone who can do it for you. The command for this looks like
87 scp gtk+-2.12.10.tar.gz matthiasc@master.gnome.org:
88 ssh matthiasc@master.gnome.org
89 install-module gtk+-2.12.10.tar.gz
91 16) Get the bz2 tarball and the .md5sum files back from master.gnome.org
92 You can probably also create it locally, but I've experienced md5
93 mismatches when doing so
95 17) Go to the gnome-announce list archives, find the last announce message,
96 create a new message in the same form, replacing version numbers,
97 commentary at the top about "what this release is about" and the
100 18) Send it to gnome-announce-list, gtk-list, gtk-app-devel-list and
101 gtk-devel-list. Set reply-to to gnome-hackers.
103 19) Add a link to the release announcement to www.gtk.org which lives
104 in the gtk-web cvs module.