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