[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 $

+-----------------------------------------------------------------------+
+         20100924
+         UPGRADING DRAGONFLY FROM 2.6 to 2.8 or HEAD
+-----------------------------------------------------------------------+

A new loader (dloader) has been added which better handles booting from
multiple kernel/module versions.

To upgrade (Only for this upgrade, for post 2.8 upgrades see GENERAL below)

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

Note that you must installworld and run the 'upgrade' target before
installing the new kernel.

+-----------------------------------------------------------------------+
+         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.  HOWEVER, from late 2.3 on we run devfs
and MAKEDEV no longer exists.

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