[dragonfly.git] / UPDATING

# Updating Information for DragonFly users.
#
#
# This file should warn you of any pitfalls which you might need to work around
# when trying to update your DragonFly system.  The information below is
# in reverse-time order, with the latest information at the top.
#
# If you discover any problem, please contact the bugs@lists.dragonflybsd.org
# mailing list with the details.
#
# $DragonFly: src/UPDATING,v 1.26 2008/09/15 20:03:36 thomas Exp $

+-----------------------------------------------------------------------+
+         UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM		+
+				GENERAL					+
+-----------------------------------------------------------------------+

Instructions on how to obtain and maintain DragonFly source code using git
are in the development(7) manual page.

To upgrade a DragonFly system from sources you run the following sequence:

	cd /usr/src
	make buildworld
	make buildkernel KERNCONF=<KERNELNAME>
	make installkernel KERNCONF=<KERNELNAME>
	make installworld

You will also want to run the 'upgrade' target to upgrade your /etc and the
rest of your system.  The upgrade target is aware of stale files created by
older DragonFly installations and should delete them automatically.

	make upgrade

See the build(7) manual page for further information.

Once you've done a full build of the world and kernel you can do incremental
upgrades of either by using the 'quickworld' and 'quickkernel' targets
instead of 'buildworld' and 'buildkernel'.  If you have any problems with
the quick targets, try updating your repo first, and then a full buildworld
and buildkernel as shown above, before asking for help.

+-----------------------------------------------------------------------+
+         UPGRADING FROM DRAGONFLY <= 2.0 TO DRAGONFLY >= 2.1		+
+-----------------------------------------------------------------------+

In 2.1 kernel and modules has moved to boot directory.  For most cases
this is handled automatically by 'make upgrade'.  A few cases needs manual
intervention:

 * When installing a kernel without first doing a make buildworld,
   installworld and upgrade to the same DESTDIR as kernel:
   make DESTDIR/boot directory and move kernel and modules into this boot
   directory; also move kernel.old and modules.old.
   Typical example is vkernel(7), use (no modules used):

	cd /var/vkernel
	mkdir boot
	chflags noschg kernel
	mv kernel kernel.old boot
	chflags schg boot/kernel
	
 * When using a boot-only partition, /boot/loader.rc needs to be edited:
   delete occurrences of '/boot/'.
   These occurences can normally be deleted in any case, see loader(8).

+-----------------------------------------------------------------------+
+         UPGRADING FROM DRAGONFLY <= 1.8 TO DRAGONFLY >= 1.9		+
+-----------------------------------------------------------------------+

In 1.9 major changes to the disk management infrastructure have taken
place.  make upgrade may not catch all of your disk devices in /dev,
so after upgrading be sure to cd /dev; ./MAKEDEV <blah> where <blah>
are all of your disk devices.

The biggest changes in 1.9 are:

(1) That whole-slice devices such as da0s1 no longer share the same device
    id as partition c devices such as da0s1c.

(2) The whole-disk device (e.g. da0) is full raw access to the disk,
    with no snooping or reserved sectors.  Consequently you cannot run
    disklabel on this device.  Instead you must run disklabel on a
    whole-slice device.

(3) The 'compatibility' partitions now use slice 0 in the device name,
    so instead of da0a you must specify da0s0a.  Also, as per (1) above,
    accessing the disklabel for the compatibility partitions must be
    done via slice 0 (da0s0).

(4) Many device drivers that used to fake up labels, such as CD, ACD, VN,
    and CCD now run through the disk management layer and are assigned
    real disk management devices.   VN and CCD in particular do not usually
    use a MBR and disklabels must be accessed through the compatibility
    slice 0.  Your /etc/ccd.conf file still specifies 'ccd0', though, you
    don't name it 'ccd0s0' in the config file.

Generally speaking, you have to get used to running fdisk and disklabel on
the correctly specified device names.  A lot of the wiggle, such as running
disklabel on a partition, has been removed.

+-----------------------------------------------------------------------+
+         UPGRADING FROM OLDER VERSIONS OF DRAGONFLY OR FREEBSD		+
+-----------------------------------------------------------------------+

> Kerberos IV
-------------

Kerberos IV (eBones) was removed from the tree, please consider moving to
Kerberos 5 (Heimdal).

> Package Management System
---------------------------

Starting with the 1.4 release, DragonFly uses NetBSD's pkgsrc package
management system.  The necessary tools to build and maintain packages
are provided in /usr/pkg/bin and /usr/pkg/sbin.  Make sure that these
directories are in your PATH variable.

In order to obtain a reasonably current snapshot of the pkgsrc tree, use
the tarball from NetBSD:

	fetch -o /tmp/pkgsrc.tar.gz ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc.tar.gz
	cd /usr; tar -xzf /tmp/pkgsrc.tar.gz; chown -R root:wheel pkgsrc

This tree can then be kept up to date with cvs update:

	cd /usr/pkgsrc; cvs up

NOTE! If you upgraded from a pre-1.4 system to 1.4 or later, you need to
build and install the pkgsrc bootstrap manually:

	cd /usr/pkgsrc/bootstrap
	./bootstrap --pkgdbdir /var/db/pkg --prefix /usr/pkg

+-----------------------------------------------------------------------+
+         UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM		+
+         UPDATING FROM PRE-1.2 SYSTEMS OR FreeBSD 4.x TO               +
+         DRAGONFLY 1.3+ (EITHER PREVIEW or HEAD)                       +
+-----------------------------------------------------------------------+

The compatibility shims for the build environment have been removed, you
have to update to DragonFly 1.2 release branch first.

The default PAM configuration has moved from /etc/pam.conf to /etc/pam.d/.
The existing configuration can be converted using /etc/pam.d/convert.sh.
Entries in /etc/pam.d/ override entries in /etc/pam.conf. In addition
the pam_skey.so module was retired, you have to remove it manually from
your configuration, when you convert it.

> Required user and group IDs when upgrading from either FreeBSD or DragonFly
---------------------

The following users may be missing from your password file.  Use vipw and
add any that are missing:

smmsp:*:25:25::0:0:Sendmail Submission User:/var/spool/clientmqueue:/sbin/nologin
_pflogd:*:64:64::0:0:pflogd privsep user:/var/empty:/sbin/nologin

The following groups may be missing from your group file.  Use vi /etc/group
and add any that are missing:

smmsp:*:25:
authpf:*:63:
_pflogd:*:64:


> Upgrading to DragonFly from FreeBSD
---------------------

You can build the DragonFly world and DragonFly kernels on a FreeBSD-4.x or
FreeBSD-5.x machine and then install DragonFly over FreeBSD, replacing
FreeBSD.  Note that the DragonFly buildworld target does not try to reuse
make depend information, it starts from scratch, so no pre-cleaning of the
object hierarchy is necessary.

	# get the CVS repository (it is placed in /home/dcvs, 500MB).
	# Please use the -h option and a mirror site to pull the 
	# initial repository, but feel free to use the main repository
	# machine to pull updates.
	cvsup /usr/share/examples/cvsup/DragonFly-cvs-supfile
	# install the source from the CVS hierarchy (remove preexisting
	# FreeBSD src first) (500MB)
	cd /usr
	rm -rf src
	cvs -R -d /home/dcvs checkout -P src

	# build it (500MB used in /usr/obj)
	#
	cd /usr/src
	make buildworld
	make buildkernel KERNCONF=<KERNELNAME>

Once you have built DragonFly you have to install it over FreeBSD.  Since
DragonFly does not track changes made by FreeBSD to its include file 
hierarchy and include file pollution can cause all sorts of unexpected
compilation issues to come up, it is best to wipe your include hierarchy
prior to installing DragonFly.  Note that you should not wipe any installed
FreeBSD header files or binaries until after you have successfully completed
the build steps above.

	rm -rf /usr/include
	mkdir /usr/include
	make installkernel KERNCONF=<KERNELNAME>
	make installworld

Then you need to upgrade your system.  DragonFly's 'make upgrade' target 
will unconditionally upgrade the /etc files that sysops do not usually
mess around with, such as the files in /etc/rc.d.  It will also remove any
obsolete files such as utilities and manpages that have been removed from
the system since the version you're coming from.  If you are unsure we 
recommend that you make a backup of at least your /etc before applying
this step.  Note that DragonFly's RC system is basically RCNG from
FreeBSD-5, but there are some differences in the contents of the RC files.

	make upgrade

NOTE! Never do a 'make upgrade' before 'make installworld' has been run.
Doing so might leave your system in an unusable state.

Finally we recommend that you do an 'ls -lta BLAH' for /bin, /sbin, /usr/bin,
/usr/bin, and /usr/lib, and remove any stale files that you find.  Please
report these files to the DragonFly developers so that they can be added to
the 'upgrade' target.
Commit	Line	Data
d2a0decc MD	1	# Updating Information for DragonFly users.
	2	#
	3	#
	4	# This file should warn you of any pitfalls which you might need to work around
	5	# when trying to update your DragonFly system. The information below is
	6	# in reverse-time order, with the latest information at the top.
	7	#
	8	# If you discover any problem, please contact the bugs@lists.dragonflybsd.org
	9	# mailing list with the details.
	10	#
4523a2c0	11	# $DragonFly: src/UPDATING,v 1.26 2008/09/15 20:03:36 thomas Exp $
d2a0decc MD	12
	13	+-----------------------------------------------------------------------+
	14	+ UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM +
	15	+ GENERAL +
	16	+-----------------------------------------------------------------------+
984263bc	17
a700883c SW	18	Instructions on how to obtain and maintain DragonFly source code using git
a700883c SW	19	are in the development(7) manual page.
d2a0decc MD	20
	21	To upgrade a DragonFly system from sources you run the following sequence:
	22
	23	cd /usr/src
	24	make buildworld
	25	make buildkernel KERNCONF=<KERNELNAME>
	26	make installkernel KERNCONF=<KERNELNAME>
	27	make installworld
	28
	29	You will also want to run the 'upgrade' target to upgrade your /etc and the
	30	rest of your system. The upgrade target is aware of stale files created by
	31	older DragonFly installations and should delete them automatically.
	32
	33	make upgrade
	34
a700883c SW	35	See the build(7) manual page for further information.
a700883c SW	36
d2a0decc MD	37	Once you've done a full build of the world and kernel you can do incremental
	38	upgrades of either by using the 'quickworld' and 'quickkernel' targets
	39	instead of 'buildworld' and 'buildkernel'. If you have any problems with
a700883c	40	the quick targets, try updating your repo first, and then a full buildworld
d2a0decc	41	and buildkernel as shown above, before asking for help.
4523a2c0 TN	42
	43	+-----------------------------------------------------------------------+
	44	+ UPGRADING FROM DRAGONFLY <= 2.0 TO DRAGONFLY >= 2.1 +
	45	+-----------------------------------------------------------------------+
	46
	47	In 2.1 kernel and modules has moved to boot directory. For most cases
	48	this is handled automatically by 'make upgrade'. A few cases needs manual
	49	intervention:
	50
	51	* When installing a kernel without first doing a make buildworld,
	52	installworld and upgrade to the same DESTDIR as kernel:
	53	make DESTDIR/boot directory and move kernel and modules into this boot
	54	directory; also move kernel.old and modules.old.
	55	Typical example is vkernel(7), use (no modules used):
	56
	57	cd /var/vkernel
	58	mkdir boot
	59	chflags noschg kernel
	60	mv kernel kernel.old boot
	61	chflags schg boot/kernel
	62
	63	* When using a boot-only partition, /boot/loader.rc needs to be edited:
	64	delete occurrences of '/boot/'.
	65	These occurences can normally be deleted in any case, see loader(8).
d2a0decc MD	66
	67	+-----------------------------------------------------------------------+
	68	+ UPGRADING FROM DRAGONFLY <= 1.8 TO DRAGONFLY >= 1.9 +
	69	+-----------------------------------------------------------------------+
	70
	71	In 1.9 major changes to the disk management infrastructure have taken
	72	place. make upgrade may not catch all of your disk devices in /dev,
	73	so after upgrading be sure to cd /dev; ./MAKEDEV <blah> where <blah>
	74	are all of your disk devices.
	75
	76	The biggest changes in 1.9 are:
	77
	78	(1) That whole-slice devices such as da0s1 no longer share the same device
	79	id as partition c devices such as da0s1c.
	80
	81	(2) The whole-disk device (e.g. da0) is full raw access to the disk,
	82	with no snooping or reserved sectors. Consequently you cannot run
	83	disklabel on this device. Instead you must run disklabel on a
	84	whole-slice device.
	85
	86	(3) The 'compatibility' partitions now use slice 0 in the device name,
	87	so instead of da0a you must specify da0s0a. Also, as per (1) above,
	88	accessing the disklabel for the compatibility partitions must be
	89	done via slice 0 (da0s0).
	90
	91	(4) Many device drivers that used to fake up labels, such as CD, ACD, VN,
	92	and CCD now run through the disk management layer and are assigned
	93	real disk management devices. VN and CCD in particular do not usually
	94	use a MBR and disklabels must be accessed through the compatibility
	95	slice 0. Your /etc/ccd.conf file still specifies 'ccd0', though, you
	96	don't name it 'ccd0s0' in the config file.
	97
	98	Generally speaking, you have to get used to running fdisk and disklabel on
	99	the correctly specified device names. A lot of the wiggle, such as running
	100	disklabel on a partition, has been removed.
	101
	102	+-----------------------------------------------------------------------+
	103	+ UPGRADING FROM OLDER VERSIONS OF DRAGONFLY OR FREEBSD +
	104	+-----------------------------------------------------------------------+
	105
	106	> Kerberos IV
	107	-------------
	108
	109	Kerberos IV (eBones) was removed from the tree, please consider moving to
	110	Kerberos 5 (Heimdal).
	111
	112	> Package Management System
	113	---------------------------
	114
	115	Starting with the 1.4 release, DragonFly uses NetBSD's pkgsrc package
	116	management system. The necessary tools to build and maintain packages
	117	are provided in /usr/pkg/bin and /usr/pkg/sbin. Make sure that these
	118	directories are in your PATH variable.
	119
	120	In order to obtain a reasonably current snapshot of the pkgsrc tree, use
	121	the tarball from NetBSD:
	122
	123	fetch -o /tmp/pkgsrc.tar.gz ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc.tar.gz
	124	cd /usr; tar -xzf /tmp/pkgsrc.tar.gz; chown -R root:wheel pkgsrc
	125
	126	This tree can then be kept up to date with cvs update:
	127
	128	cd /usr/pkgsrc; cvs up
	129
130	NOTE! If you upgraded from a pre-1.4 system to 1.4 or later, you need to
131	build and install the pkgsrc bootstrap manually:
132
133	cd /usr/pkgsrc/bootstrap
134	./bootstrap --pkgdbdir /var/db/pkg --prefix /usr/pkg
135
136	+-----------------------------------------------------------------------+
137	+ UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM +
138	+ UPDATING FROM PRE-1.2 SYSTEMS OR FreeBSD 4.x TO +
139	+ DRAGONFLY 1.3+ (EITHER PREVIEW or HEAD) +
140	+-----------------------------------------------------------------------+
58116288	141
114580ac	142	The compatibility shims for the build environment have been removed, you
58116288 JS	143	have to update to DragonFly 1.2 release branch first.
58116288 JS	144
1fcc7462 JS	145	The default PAM configuration has moved from /etc/pam.conf to /etc/pam.d/.
	146	The existing configuration can be converted using /etc/pam.d/convert.sh.
	147	Entries in /etc/pam.d/ override entries in /etc/pam.conf. In addition
	148	the pam_skey.so module was retired, you have to remove it manually from
	149	your configuration, when you convert it.
58116288	150
a3107071 MD	151	> Required user and group IDs when upgrading from either FreeBSD or DragonFly
	152	---------------------
	153
	154	The following users may be missing from your password file. Use vipw and
	155	add any that are missing:
	156
	157	smmsp:*:25:25::0:0:Sendmail Submission User:/var/spool/clientmqueue:/sbin/nologin
dcf85892	158	_pflogd:*:64:64::0:0:pflogd privsep user:/var/empty:/sbin/nologin
a3107071 MD	159
	160	The following groups may be missing from your group file. Use vi /etc/group
	161	and add any that are missing:
	162
	163	smmsp:*:25:
	164	authpf:*:63:
dcf85892	165	_pflogd:*:64:
a3107071 MD	166
a3107071 MD	167
f419daca	168	> Upgrading to DragonFly from FreeBSD
5e0ae0d4	169	---------------------
984263bc	170
f419daca MD	171	You can build the DragonFly world and DragonFly kernels on a FreeBSD-4.x or
	172	FreeBSD-5.x machine and then install DragonFly over FreeBSD, replacing
	173	FreeBSD. Note that the DragonFly buildworld target does not try to reuse
	174	make depend information, it starts from scratch, so no pre-cleaning of the
	175	object hierarchy is necessary.
	176
466bbc10	177	# get the CVS repository (it is placed in /home/dcvs, 500MB).
f419daca MD	178	# Please use the -h option and a mirror site to pull the
	179	# initial repository, but feel free to use the main repository
	180	# machine to pull updates.
5010eeb3	181	cvsup /usr/share/examples/cvsup/DragonFly-cvs-supfile
f419daca MD	182	# install the source from the CVS hierarchy (remove preexisting
	183	# FreeBSD src first) (500MB)
	184	cd /usr
	185	rm -rf src
50172b1c	186	cvs -R -d /home/dcvs checkout -P src
f419daca MD	187
	188	# build it (500MB used in /usr/obj)
	189	#
	190	cd /usr/src
	191	make buildworld
	192	make buildkernel KERNCONF=<KERNELNAME>
984263bc	193
f419daca MD	194	Once you have built DragonFly you have to install it over FreeBSD. Since
	195	DragonFly does not track changes made by FreeBSD to its include file
	196	hierarchy and include file pollution can cause all sorts of unexpected
	197	compilation issues to come up, it is best to wipe your include hierarchy
	198	prior to installing DragonFly. Note that you should not wipe any installed
	199	FreeBSD header files or binaries until after you have successfully completed
	200	the build steps above.
fb12f484	201
f419daca MD	202	rm -rf /usr/include
	203	mkdir /usr/include
	204	make installkernel KERNCONF=<KERNELNAME>
	205	make installworld
fb12f484	206
b8cbf045	207	Then you need to upgrade your system. DragonFly's 'make upgrade' target
f419daca	208	will unconditionally upgrade the /etc files that sysops do not usually
b8cbf045 SW	209	mess around with, such as the files in /etc/rc.d. It will also remove any
	210	obsolete files such as utilities and manpages that have been removed from
	211	the system since the version you're coming from. If you are unsure we
	212	recommend that you make a backup of at least your /etc before applying
	213	this step. Note that DragonFly's RC system is basically RCNG from
	214	FreeBSD-5, but there are some differences in the contents of the RC files.
f419daca MD	215
	216	make upgrade
	217
b8cbf045 SW	218	NOTE! Never do a 'make upgrade' before 'make installworld' has been run.
	219	Doing so might leave your system in an unusable state.
	220
f419daca	221	Finally we recommend that you do an 'ls -lta BLAH' for /bin, /sbin, /usr/bin,
b8cbf045 SW	222	/usr/bin, and /usr/lib, and remove any stale files that you find. Please
	223	report these files to the DragonFly developers so that they can be added to
	224	the 'upgrade' target.
f419daca	225