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