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