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