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