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