UPDATING: Mention that bt(4) is PCI only now.
[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 +-----------------------------------------------------------------------+
12 +         UPGRADING DRAGONFLY FROM 3.2 to later versions                +
13 +-----------------------------------------------------------------------+
14
15 SMP OPTION REMOVED
16 ------------------
17
18 The SMP kernel option has been made a no-op. All kernels now feature SMP
19 support. If you have 'options SMP' in your kernel config, you can as well
20 remove it.
21
22 DEVICE_POLLING OPTION REPLACED BY IFPOLL_ENABLE OPTION, KTR_POLLING REMOVED
23 ---------------------------------------------------------------------------
24
25 The DEVICE_POLLING kernel option has been made a no-op and it has been
26 replaced by IFPOLL_ENABLE.  If you have 'options DEVICE_POLLING' in your
27 kernel config, you need to change it to IFPOLL_ENABLE.
28
29 Also, the KTR_POLLING kernel option has been removed, so it must be
30 removed from kernel configs that have it.
31
32 BUSLOGIC ISA SUPPORT REMOVED
33 ----------------------------
34
35 The bt(4) driver for Buslogic SCSI adapters has been made PCI only. ISA
36 cards will no longer be detected.
37
38 +-----------------------------------------------------------------------+
39 +         UPGRADING DRAGONFLY FROM 3.0 to later versions                +
40 +-----------------------------------------------------------------------+
41
42 APIC_IO OPTION REMOVED
43 ----------------------
44
45 The APIC_IO kernel option is no longer accepted after having been without
46 effect for a while. The hw.ioapic_enable tunable now serves its purpose.
47 If you have 'options APIC_IO' in your kernel config, you'll have to
48 remove it.
49
50 WATCHDOG_ENABLE & HW_WDOG OPTIONS REMOVED
51 -----------------------------------------
52
53 The wdog framework is now compiled into our kernels by default, so the
54 options are no longer needed.
55
56 DOSCMD(1) REMOVED
57 -----------------
58
59 doscmd(1) has been removed. It was i386 only. The doscmd(1) specific
60 NO_X make.conf option was removed too.
61
62 GCC 4.7
63 -------
64
65 GCC 4.7 has been brought in and replaces GCC 4.1 as DragonFly's non-
66 default compiler in base (default is still GCC 4.4).
67
68 Users who wish to build only GCC 4.4 have to replace NO_GCC41 with
69 NO_GCC47 in /etc/make.conf.
70
71 USB4BSD
72 -------
73
74 A new USB stack (from FreeBSD) has been brought in. The following
75 modules have been ported so far: usb, uhci, ohci, ehci, xhci, umass,
76 usfs, uether, if_axe, if_udav, ukbd, ums, uep, uhid, usb_quirk,
77 and uaudio.
78
79 It is not yet the default. To activate it, WANT_USB4BSD=yes has to
80 be put in make.conf and device "usb4bsd" (quotes needed) has to
81 replace device usb in the kernel config. After that, a full
82 build/install/upgrade cycle is needed.
83
84 Note that this is experimental and incomplete, but we are interested
85 in hearing about issues with it, of course.
86
87 +-----------------------------------------------------------------------+
88 +         UPGRADING DRAGONFLY FROM 2.10 to later versions               +
89 +-----------------------------------------------------------------------+
90
91 SEVERAL ISA DRIVERS REMOVED
92 ---------------------------
93
94 The following ISA only drivers have been removed along with a couple of
95 associated userland tools:
96
97 aha(4)
98 asc(4) & sasc(1)
99 ctx
100 dgb(4)
101 el(4)
102 gpib
103 gsc(4) & sgsc(1)
104 ie(4)
105 labpc(4)
106 le(4)
107 mse(4)
108 rc(4)
109 rdp(4)
110 spigot
111 tw(4) & xten(1) & xtend(8)
112 wl(4) & wlconfig(8)
113 wt(4)
114
115 Note that two of these drivers (aha(4) and ie(4)) are in our GENERIC
116 config and one (aha(4)) is in our X86_64_GENERIC kernel configuration
117 file.
118
119 If buildkernel complains about any of these drivers, just remove them
120 from your kernel configuration.
121
122 BINUTILS 2.20
123 -------------
124 Binutils 2.20 has been removed in favor of Binutils 2.22.  The accepted
125 values of BINUTILSVERS are now binutils221 and binutils222 (default).
126
127 BUILDWORLD/-KERNEL PARALLELIZATION WORK
128 ---------------------------------------
129 Due to changes in the way we build with more than one make job, you
130 will have to update install(1) and mkdir(1) prior to buildworld if you
131 want to build with 'make -j':
132
133 cd /usr/src/usr.bin/xinstall; make; make install; make clean
134 cd /usr/src/bin/mkdir; make; make install; make clean
135
136 DMA(8) UPGRADE
137 --------------
138 dma(8) has been upgraded to v0.7 which no longer supports the
139 /etc/dma/virtusertable. Some of its functionality has been replaced
140 with the MASQUERADE keyword and the EMAIL environment variable (see
141 the dma(8) manual page).
142
143 +-----------------------------------------------------------------------+
144 +         UPGRADING DRAGONFLY FROM 2.8 to later versions                +
145 +-----------------------------------------------------------------------+
146
147 GCC 4.4 & BINUTILS 2.21
148 -----------------------
149
150 GCC 4.4 has been made DragonFly's default compiler and Binutils 2.21 has
151 been made DragonFly's default Binutils.
152
153 That means that any settings that set CCVER to 'gcc44' are not needed
154 anymore. Instead, CCVER can be set to 'gcc41' to go back to using
155 GCC 4.1.
156
157 It also means that 'binutils221' as a value for BINUTILSVER has no
158 effect anymore. 2.17 has been removed and 'binutils220' is available
159 as an option.
160
161 The NO_GCC44 option has been removed and will not affect the build
162 anymore. There is now a NO_GCC41 option that will prevent GCC 4.1 from
163 building in a similar fashion.
164
165 Note that you must do a full buildworld/buildkernel for upgrading.
166
167 pkg_radd settings
168 -----------------
169
170 The config file for pkg_radd has moved from /etc/settings.conf to 
171 /etc/pkg_radd.conf.  Save the contents of settings.conf before upgrading
172 if this is needed.  This warning only applies if /etc/settings.conf 
173 exists.  pkg_radd will continue to work with defaults.
174
175 +-----------------------------------------------------------------------+
176 +         20100927                                                      +
177 +         UPGRADING DRAGONFLY FROM 2.6 to 2.8 or HEAD                   +
178 +-----------------------------------------------------------------------+
179
180 OpenSSL
181 --------
182
183 OpenSSL has been upgraded, and SHLIB_MAJOR was bumped for libssh and libcrypto.
184 This shouldn't break any 3rd-party software, but you'll need to recompile your
185 3rd-party software if you want it to link against the new version of OpenSSL.
186
187 Loader
188 -------
189
190 A new loader (dloader) has been added which better handles booting from
191 multiple kernel/module versions.
192
193 To upgrade (Only for this upgrade, for post 2.8 upgrades see GENERAL below)
194
195         cd /usr/src
196         make buildworld
197         make installworld
198         make upgrade
199         make buildkernel KERNCONF=<KERNELNAME>
200         make installkernel KERNCONF=<KERNELNAME>
201
202 Note that you must installworld and run the 'upgrade' target before
203 installing the new kernel.
204
205 BIND
206 -----
207
208 BIND has been removed from the base system.  The ldns and drill tools have 
209 been added for basic functionality.  Use 'drill' where you would normally 
210 use nslookup or dig, or install BIND from pkgsrc.  It's available as 
211 net/bind95, net/bind96, or net/bind97 as of this writing.
212
213 This only affects older systems upgrading to 2.8.  New 2.8+ installs 
214 include BIND as a pkgsrc package.
215
216 +-----------------------------------------------------------------------+
217 +         UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM           +
218 +                               GENERAL                                 +
219 +-----------------------------------------------------------------------+
220
221 Instructions on how to obtain and maintain DragonFly source code using git
222 are in the development(7) manual page.
223
224 To upgrade a DragonFly system from sources you run the following sequence:
225
226         cd /usr/src
227         make buildworld
228         make buildkernel KERNCONF=<KERNELNAME>
229         make installkernel KERNCONF=<KERNELNAME>
230         make installworld
231
232 You will also want to run the 'upgrade' target to upgrade your /etc and the
233 rest of your system.  The upgrade target is aware of stale files created by
234 older DragonFly installations and should delete them automatically.
235
236         make upgrade
237
238 See the build(7) manual page for further information.
239
240 Once you've done a full build of the world and kernel you can do incremental
241 upgrades of either by using the 'quickworld' and 'quickkernel' targets
242 instead of 'buildworld' and 'buildkernel'.  If you have any problems with
243 the quick targets, try updating your repo first, and then a full buildworld
244 and buildkernel as shown above, before asking for help.
245
246 +-----------------------------------------------------------------------+
247 +         UPGRADING FROM DRAGONFLY <= 2.0 TO DRAGONFLY >= 2.1           +
248 +-----------------------------------------------------------------------+
249
250 In 2.1 kernel and modules has moved to boot directory.  For most cases
251 this is handled automatically by 'make upgrade'.  A few cases needs manual
252 intervention:
253
254  * When installing a kernel without first doing a make buildworld,
255    installworld and upgrade to the same DESTDIR as kernel:
256    make DESTDIR/boot directory and move kernel and modules into this boot
257    directory; also move kernel.old and modules.old.
258    Typical example is vkernel(7), use (no modules used):
259
260         cd /var/vkernel
261         mkdir boot
262         chflags noschg kernel
263         mv kernel kernel.old boot
264         chflags schg boot/kernel
265         
266  * When using a boot-only partition, /boot/loader.rc needs to be edited:
267    delete occurrences of '/boot/'.
268    These occurences can normally be deleted in any case, see loader(8).
269
270 +-----------------------------------------------------------------------+
271 +         UPGRADING FROM DRAGONFLY <= 1.8 TO DRAGONFLY >= 1.9           +
272 +-----------------------------------------------------------------------+
273
274 In 1.9 major changes to the disk management infrastructure have taken
275 place.  make upgrade may not catch all of your disk devices in /dev,
276 so after upgrading be sure to cd /dev; ./MAKEDEV <blah> where <blah>
277 are all of your disk devices.  HOWEVER, from late 2.3 on we run devfs
278 and MAKEDEV no longer exists.
279
280 The biggest changes in 1.9 are:
281
282 (1) That whole-slice devices such as da0s1 no longer share the same device
283     id as partition c devices such as da0s1c.
284
285 (2) The whole-disk device (e.g. da0) is full raw access to the disk,
286     with no snooping or reserved sectors.  Consequently you cannot run
287     disklabel on this device.  Instead you must run disklabel on a
288     whole-slice device.
289
290 (3) The 'compatibility' partitions now use slice 0 in the device name,
291     so instead of da0a you must specify da0s0a.  Also, as per (1) above,
292     accessing the disklabel for the compatibility partitions must be
293     done via slice 0 (da0s0).
294
295 (4) Many device drivers that used to fake up labels, such as CD, ACD, VN,
296     and CCD now run through the disk management layer and are assigned
297     real disk management devices.   VN and CCD in particular do not usually
298     use a MBR and disklabels must be accessed through the compatibility
299     slice 0.  Your /etc/ccd.conf file still specifies 'ccd0', though, you
300     don't name it 'ccd0s0' in the config file.
301
302 Generally speaking, you have to get used to running fdisk and disklabel on
303 the correctly specified device names.  A lot of the wiggle, such as running
304 disklabel on a partition, has been removed.
305
306 +-----------------------------------------------------------------------+
307 +         UPGRADING FROM OLDER VERSIONS OF DRAGONFLY OR FREEBSD         +
308 +-----------------------------------------------------------------------+
309
310 > Kerberos IV
311 -------------
312
313 Kerberos IV (eBones) was removed from the tree, please consider moving to
314 Kerberos 5 (Heimdal).
315
316 > Package Management System
317 ---------------------------
318
319 Starting with the 1.4 release, DragonFly uses NetBSD's pkgsrc package
320 management system.  The necessary tools to build and maintain packages
321 are provided in /usr/pkg/bin and /usr/pkg/sbin.  Make sure that these
322 directories are in your PATH variable.
323
324 In order to obtain a reasonably current snapshot of the pkgsrc tree, use
325 the tarball from NetBSD:
326
327         fetch -o /tmp/pkgsrc.tar.gz ftp://ftp.NetBSD.org/pub/NetBSD/packages/pkgsrc.tar.gz
328         cd /usr; tar -xzf /tmp/pkgsrc.tar.gz; chown -R root:wheel pkgsrc
329
330 This tree can then be kept up to date with cvs update:
331
332         cd /usr/pkgsrc; cvs up
333
334 NOTE! If you upgraded from a pre-1.4 system to 1.4 or later, you need to
335 build and install the pkgsrc bootstrap manually:
336
337         cd /usr/pkgsrc/bootstrap
338         ./bootstrap --pkgdbdir /var/db/pkg --prefix /usr/pkg
339
340 +-----------------------------------------------------------------------+
341 +         UPGRADING DRAGONFLY ON AN EXISTING DRAGONFLY SYSTEM           +
342 +         UPDATING FROM PRE-1.2 SYSTEMS OR FreeBSD 4.x TO               +
343 +         DRAGONFLY 1.3+ (EITHER PREVIEW or HEAD)                       +
344 +-----------------------------------------------------------------------+
345
346 The compatibility shims for the build environment have been removed, you
347 have to update to DragonFly 1.2 release branch first.
348
349 The default PAM configuration has moved from /etc/pam.conf to /etc/pam.d/.
350 The existing configuration can be converted using /etc/pam.d/convert.sh.
351 Entries in /etc/pam.d/ override entries in /etc/pam.conf. In addition
352 the pam_skey.so module was retired, you have to remove it manually from
353 your configuration, when you convert it.
354
355 > Required user and group IDs when upgrading from either FreeBSD or DragonFly
356 ---------------------
357
358 The following users may be missing from your password file.  Use vipw and
359 add any that are missing:
360
361 smmsp:*:25:25::0:0:Sendmail Submission User:/var/spool/clientmqueue:/sbin/nologin
362 _pflogd:*:64:64::0:0:pflogd privsep user:/var/empty:/sbin/nologin
363
364 The following groups may be missing from your group file.  Use vi /etc/group
365 and add any that are missing:
366
367 smmsp:*:25:
368 authpf:*:63:
369 _pflogd:*:64:
370
371
372 > Upgrading to DragonFly from FreeBSD
373 ---------------------
374
375 You can build the DragonFly world and DragonFly kernels on a FreeBSD-4.x or
376 FreeBSD-5.x machine and then install DragonFly over FreeBSD, replacing
377 FreeBSD.  Note that the DragonFly buildworld target does not try to reuse
378 make depend information, it starts from scratch, so no pre-cleaning of the
379 object hierarchy is necessary.
380
381         # get the CVS repository (it is placed in /home/dcvs, 500MB).
382         # Please use the -h option and a mirror site to pull the 
383         # initial repository, but feel free to use the main repository
384         # machine to pull updates.
385         cvsup /usr/share/examples/cvsup/DragonFly-cvs-supfile
386         # install the source from the CVS hierarchy (remove preexisting
387         # FreeBSD src first) (500MB)
388         cd /usr
389         rm -rf src
390         cvs -R -d /home/dcvs checkout -P src
391
392         # build it (500MB used in /usr/obj)
393         #
394         cd /usr/src
395         make buildworld
396         make buildkernel KERNCONF=<KERNELNAME>
397
398 Once you have built DragonFly you have to install it over FreeBSD.  Since
399 DragonFly does not track changes made by FreeBSD to its include file 
400 hierarchy and include file pollution can cause all sorts of unexpected
401 compilation issues to come up, it is best to wipe your include hierarchy
402 prior to installing DragonFly.  Note that you should not wipe any installed
403 FreeBSD header files or binaries until after you have successfully completed
404 the build steps above.
405
406         rm -rf /usr/include
407         mkdir /usr/include
408         make installkernel KERNCONF=<KERNELNAME>
409         make installworld
410
411 Then you need to upgrade your system.  DragonFly's 'make upgrade' target 
412 will unconditionally upgrade the /etc files that sysops do not usually
413 mess around with, such as the files in /etc/rc.d.  It will also remove any
414 obsolete files such as utilities and manpages that have been removed from
415 the system since the version you're coming from.  If you are unsure we 
416 recommend that you make a backup of at least your /etc before applying
417 this step.  Note that DragonFly's RC system is basically RCNG from
418 FreeBSD-5, but there are some differences in the contents of the RC files.
419
420         make upgrade
421
422 NOTE! Never do a 'make upgrade' before 'make installworld' has been run.
423 Doing so might leave your system in an unusable state.
424
425 Finally we recommend that you do an 'ls -lta BLAH' for /bin, /sbin, /usr/bin,
426 /usr/bin, and /usr/lib, and remove any stale files that you find.  Please
427 report these files to the DragonFly developers so that they can be added to
428 the 'upgrade' target.
429