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