Document the upgrade procedure.

1 files changed, 94 insertions, 12 deletions

diff --git a/contrib/bind9/FREEBSD-Upgrade b/contrib/bind9/FREEBSD-Upgrade
index f5901817d461..c0ea0f5a20a9 100644
--- a/contrib/bind9/FREEBSD-Upgrade
+++ b/contrib/bind9/FREEBSD-Upgrade
@@ -1,17 +1,99 @@
-# $FreeBSD$
-#
-# Bug trhodes@ and des@ to actually throw some text in here.
-#
 
-while read pattern ; do rm -rf $pattern ; done <FREEBSD-Xlist
 
-sed -i.orig -e '/\/tests/d; /docutil/d;' configure.in Makefile.in */Makefile.in
+	    FreeBSD maintainer's guide to updating BIND 9
+	    =============================================
 
-autoconf253
+1) Obtain the latest source distribution from the ISC's FTP server
+   (ftp://ftp.isc.org/isc/bind9/)
 
-autoheader253
+2) Unpack the tarball in a suitable directory.
 
-./configure --prefix=/usr --infodir=/usr/share/info --mandir=/usr/share/man \
-	--enable-threads --enable-libbind --disable-ipv6 \
-	--enable-getifaddrs --disable-linux-caps \
-	--with-openssl=/usr --with-randomdev=/dev/random
+3) Remove unwanted files and directories:
+
+	$ while read pattern ; do rm -rf $pattern ; done \
+		</usr/src/contrib/bind9/FREEBSD-Xlist
+
+   Make sure that took care of everything, and if it didn't, make sure
+   to update FREEBSD-Xlist so you won't miss it the next time.  A good
+   way to do this is to run a test import and see if any new files
+   show up:
+
+	$ cvs -n import src/contrib/bind9 ISC x | grep \^N
+
+4) Import the sources:
+
+	$ cvs import src/contrib/bind9 ISC BIND_9_X_Y
+
+5) Resolve conflicts.
+
+   As of 2004-09-27, we have no local patches against BIND 9; thus
+   there are no conflicts to merge.  This may change at a later date.
+
+6) Remove any references to the {bin,lib}/tests and docutil
+   directories from the configure and Makefile templates:
+
+	$ sed -i.orig -e '/\/tests/d; /docutil/d;' \
+		configure.in Makefile.in */Makefile.in
+
+   Please do not commit this change, as it would unnecessarily take
+   files off the vendor branch.  You only need this to generate
+   config.h.
+
+7) Generate and run configure:
+
+	$ autoconf253
+	$ autoheader253
+	$ ./configure --prefix=/usr \
+		--infodir=/usr/share/info --mandir=/usr/share/man \
+		--enable-threads --enable-libbind --disable-ipv6 \
+		--enable-getifaddrs --disable-linux-caps \
+		--with-openssl=/usr --with-randomdev=/dev/random
+
+   Note that we intentionally disable IPv6 support on the configure
+   command line; src/lib/bind/config.mk will re-enable it at compile
+   time if NOINET6 is not defined.
+
+8) Copy the resulting config.h to src/lib/bind, add an RCS id tag and
+   commit it.  Do not commit any other file that was modified or
+   created in steps 6) or 7).
+
+9) The following directories contain Makefiles for bits and pieces of
+   BIND 9:
+
+	FreeBSD directory		ISC directory
+	========================================================
+	src/lib/bind			bind9/lib
+	src/lib/bind/bind		bind9/lib/bind
+	src/lib/bind/bind9		bind9/lib/bind9
+	src/lib/bind/dns		bind9/lib/dns
+	src/lib/bind/isc		bind9/lib/isc
+	src/lib/bind/isccc		bind9/lib/isccc
+	src/lib/bind/isccfg		bind9/lib/isccfg
+	src/lib/bind/lwres		bind9/lib/lwres
+	src/share/doc/bind9		bind9/doc/{arm,misc}
+	src/usr.bin/dig			bind9/bin/dig
+	src/usr.bin/host		bind9/bin/dig
+	src/usr.bin/nslookup		bind9/bin/dig
+	src/usr.bin/nsupdate		bind9/bin/nsupdate
+	src/usr.sbin/dnssec-keygen	bind9/bin/dnssec
+	src/usr.sbin/dnssec-signzone	bind9/bin/dnssec
+	src/usr.sbin/named		bind9/bin/named
+	src/usr.sbin/named-checkconf	bind9/bin/check
+	src/usr.sbin/named-checkzone	bind9/bin/check
+	src/usr.sbin/rndc		bind9/bin/rndc
+	src/usr.sbin/rndc-confgen	bind9/bin/rndc
+
+   Make sure that the lists of sources, headers and man pages in each
+   FreeBSD Makefile accurately reflects those in the corresponding ISC
+   Makefile.  Please strive to keep those lists in the same order and
+   with line breaks in the same places to ease future comparisons.
+
+A) Build and test.
+
+B) Lather, rinse, repeat.
+
+C) Commit when everything builds cleanly and works properly.
+
+					-- des@FreeBSD.org
+
+$FreeBSD$