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