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