INN commit: trunk/doc/pod (checklist.pod hacking.pod)
rra at isc.org
Sun Feb 25 21:36:01 UTC 2018
Date: Sunday, February 25, 2018 @ 13:36:01
Add a few useful monitoring commands to run before making a release
Also, typo fix in checklist.
checklist.pod | 2 +-
hacking.pod | 46 +++++++++++++++++++++++++++++++---------------
2 files changed, 32 insertions(+), 16 deletions(-)
--- checklist.pod 2018-02-25 21:29:30 UTC (rev 10248)
+++ checklist.pod 2018-02-25 21:36:01 UTC (rev 10249)
@@ -165,7 +165,7 @@
-Run C<< <pathbin in inn.conf>inncheck -a -v -f --pedantic --perm >> and fix anything noted:
+Run C<< <pathbin in inn.conf>/inncheck -a -v -f --pedantic --perm >> and fix anything noted:
B<inncheck> gives a rough check on the appropriateness of the configuration
files as you go. (It's the equivalent of C<perl -cw yourfile.pl> for
--- hacking.pod 2018-02-25 21:29:30 UTC (rev 10248)
+++ hacking.pod 2018-02-25 21:36:01 UTC (rev 10249)
@@ -709,10 +709,26 @@
-Update copyright years in F<LICENSE>.
+If possible, on a news server running the forthcoming release, run the
+following commands to make sure they do not produce any errors:
+ cnfsstat -a -v
+ ctlinnd checkfile
+ inncheck -a --perm --pedantic
+ ovdb_stat -klmMtv
+ scanlogs norotate
+ scanspool -n -v
+ tdx-util -A
+Also build INN (including the F<contrib> and F<tests> directories) with
+warnings on (C<make warnings>) and run the test suite (C<make tests>).
+Update copyright years in F<LICENSE>.
Update F<doc/pod/news.pod> and regenerate F<NEWS>. Be more detailed for
a minor release than for a major release. For a major release, also add
information on how to upgrade from the last major release, including
@@ -719,7 +735,7 @@
anything special to be aware of. (Minor releases shouldn't require any
special care when upgrading.)
Bump the revision number in F<doc/FAQ> (subject 1.2) so that it could be
included in a final release. It should not be changed for a beta or
@@ -729,7 +745,7 @@
should also be bumped in F<doc/FAQ> at the end of subject 1.2, as well
as the revision numbers of scheduled versions in F<TODO>.
Double-check that the version information in F<lib/Makefile>,
F<storage/Makefile>, and F<history/Makefile> has been updated if there has
@@ -737,7 +753,7 @@
the rules given at
If making a major release, branch the source tree by creating a new
directory under F<branches> in Subversion named after the major release.
@@ -751,7 +767,7 @@
Then, in that newly created branch, remove the first paragraph in
F<doc/pod/readme.pod> which deals with development versions.
Check out a copy of the release branch. It's currently necessary to run
C<autogen> and C<configure> to generate F<Makefile.global>. Then, run
@@ -759,7 +775,7 @@
C<make check-manifest>. There shouldn't be any differences; otherwise,
fix the F<MANIFEST> file.
Run C<make release> for a final release, C<support/mksnapshot BETA b1> for
the first beta version of a new release, or C<support/mksnapshot RC rc1>
@@ -773,13 +789,13 @@
manually edit it. Then run again C<make release> or any other command
Generate an MD5 checksum of the release tarball.
md5sum inn-Y.Y.Y.tar.gz > inn-Y.Y.Y.tar.gz.md5
Generate a diff between this release and the previous release if feasible
(always for minor releases, possibly not a good idea due to the length of
@@ -789,7 +805,7 @@
diff -Nurp inn-X.X.X inn-Y.Y.Y > inn-X.X.X-Y.Y.Y.diff
Make the resulting tar file, along with its MD5 checksum and the possible
diff from the previous release, available for testing in the F<testing>
@@ -798,7 +814,7 @@
at least a few days. This is also a good time to send out a draft of the
release announcement to inn-workers for proof-reading.
Move the release into the public area of the ftp site and update the
F<inn.tar.gz> link. Also put the diff and the MD5 checksum on the ftp
@@ -824,13 +840,13 @@
ISC web site (the relevant contact is C<web-request> instead of
After the ISC web site has been updated with links towards the new
release, send an announce on inn-announce and in news.software.nntp
(with a possible crosspost to news.admin.announce).
Tag the checked-out tree that was used for generating the release with a
release tag by copying it to F<tags> in Subversion.
@@ -838,7 +854,7 @@
svn copy -r ZZZZ -m "Tag Y.Y.Y release." \
Bump revision numbers to reflect the one of the following release,
especially in F<doc/pod/install.pod> and F<doc/pod/readme.pod>
@@ -846,12 +862,12 @@
minor and major releases. The release versions in the Trac wiki should
also be updated.
For major releases, ping Russ to update the branch used for the
generation of STABLE snapshots.
Ping Russ to update L<https://www.eyrie.org/~eagle/software/inn/> with the
latest version information and, for a major release, clone the
More information about the inn-committers