]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - UPDATING
Add ng_car.4
[FreeBSD/FreeBSD.git] / UPDATING
1 Updating Information for FreeBSD current users
2
3 This file is maintained and copyrighted by M. Warner Losh
4 <imp@village.org>.  See end of file for further details.  For commonly
5 done items, please see the COMMON ITEMS: section later in the file.
6
7 Items affecting the ports and packages system can be found in
8 /usr/ports/UPDATING.  Please read that file before running
9 portupgrade.
10
11 NOTE TO PEOPLE WHO THINK THAT FreeBSD 7.x IS SLOW:
12         FreeBSD 7.x has many debugging features turned on, in
13         both the kernel and userland.  These features attempt to detect
14         incorrect use of system primitives, and encourage loud failure
15         through extra sanity checking and fail stop semantics.  They
16         also substantially impact system performance.  If you want to
17         do performance measurement, benchmarking, and optimization,
18         you'll want to turn them off.  This includes various WITNESS-
19         related kernel options, INVARIANTS, malloc debugging flags
20         in userland, and various verbose features in the kernel.  Many
21         developers choose to disable these features on build machines
22         to maximize performance.
23
24 20070513:
25         Symbol versioning is enabled by default.  To disable it, use
26         option WITHOUT_SYMVER.  It is not advisable to attempt to
27         disable symbol versioning once it is enabled; your installworld
28         will break because a symbol version-less libc will get installed
29         before the install tools.  As a result, the old install tools,
30         which previously had symbol dependencies to FBSD_1.0, will fail
31         because the freshly installed libc will not have them.
32
33         The default threading library has been changed to libthr.  If
34         you wish to have libpthread as your default, use option
35         DEFAULT_THREAD_LIB=libpthread for the buildworld.
36
37 20070423:
38         The ABI breakage in sendmail(8)'s libmilter has been repaired
39         so it is no longer necessary to recompile mail filters (aka,
40         milters).  If you recompiled mail filters after the 20070408
41         note, it is not necessary to recompile them again.
42
43 20070417:
44         The new trunk(4) driver has been renamed to lagg(4) as it better
45         reflects its purpose. ifconfig will need to be recompiled.
46
47 20070408:
48         sendmail(8) has been updated to version 8.14.1.  Mail filters
49         (aka, milters) compiled against the libmilter included in the
50         base operating system should be recompiled.
51
52 20070302:
53         Firmwares for ipw(4) and iwi(4) are now included in the base tree.
54         In order to use them one must agree to the respective LICENSE in
55         share/doc/legal and define legal.intel_<name>.license_ack=1 via
56         loader.conf(5) or kenv(1).  Make sure to deinstall the now
57         deprecated modules from the respective firmware ports.
58
59 20070228:
60         The name resolution/mapping functions addr2ascii(3) and ascii2addr(3)
61         were removed from FreeBSD's libc. These originally came from INRIA
62         IPv6. Nothing in FreeBSD ever used them. They may be regarded as
63         deprecated in previous releases.
64         The AF_LINK support for getnameinfo(3) was merged from NetBSD to
65         replace it as a more portable (and re-entrant) API.
66
67 20070224:
68         To support interrupt filtering a modification to the newbus API 
69         has occurred, ABI was broken and __FreeBSD_version was bumped
70         to 700031. Please make sure that your kernel and modules are in 
71         sync. For more info:
72         http://docs.freebsd.org/cgi/mid.cgi?20070221233124.GA13941
73
74 20070224:
75         The IPv6 multicast forwarding code may now be loaded into GENERIC
76         kernels by loading the ip_mroute.ko module. This is built into the
77         module unless WITHOUT_INET6 or WITHOUT_INET6_SUPPORT options are
78         set; see src.conf(5) for more information.
79
80 20070214:
81         The output of netstat -r has changed. Without -n, we now only
82         print a "network name" without the prefix length if the network
83         address and mask exactly match a Class A/B/C network, and an entry
84         exists in the nsswitch "networks" map.
85         With -n, we print the full unabbreviated CIDR network prefix in
86         the form "a.b.c.d/p". 0.0.0.0/0 is always printed as "default".
87         This change is in preparation for changes such as equal-cost
88         multipath, and to more generally assist operational deployment
89         of FreeBSD as a modern IPv4 router.
90
91 20070210:
92         PIM has been turned on by default in the IPv4 multicast
93         routing code. The kernel option 'PIM' has now been removed.
94         PIM is now built by default if option 'MROUTING' is specified.
95         It may now be loaded into GENERIC kernels by loading the
96         ip_mroute.ko module.
97
98 20070207:
99         Support for IPIP tunnels (VIFF_TUNNEL) in IPv4 multicast routing
100         has been removed. Its functionality may be achieved by explicitly
101         configuring gif(4) interfaces and using the 'phyint' keyword in
102         mrouted.conf.
103         XORP does not support source-routed IPv4 multicast tunnels nor the
104         integrated IPIP tunneling, therefore it is not affected by this
105         change. The __FreeBSD_version macro has been bumped to 700030.
106
107 20061221:
108         Support for PCI Message Signalled Interrupts has been
109         re-enabled in the bge driver, only for those chips which are
110         believed to support it properly.  If there are any problems,
111         MSI can be disabled completely by setting the
112         'hw.pci.enable_msi' and 'hw.pci.enable_msix' tunables to 0
113         in the loader.
114
115 20061214:
116         Support for PCI Message Signalled Interrupts has been
117         disabled again in the bge driver.  Many revisions of the
118         hardware fail to support it properly.  Support can be
119         re-enabled by removing the #define of BGE_DISABLE_MSI in
120         "src/sys/dev/bge/if_bge.c".
121
122 20061214:
123         Support for PCI Message Signalled Interrupts has been added
124         to the bge driver.  If there are any problems, MSI can be
125         disabled completely by setting the 'hw.pci.enable_msi' and
126         'hw.pci.enable_msix' tunables to 0 in the loader.
127
128 20061205:
129         The removal of several facets of the experimental Threading 
130         system from the kernel means that the proc and thread structures 
131         have changed quite a bit. I suggest all kernel modules that might
132         reference these structures be recompiled.. Especially the
133         linux module.
134
135 20061126:
136         Sound infrastructure has been updated with various fixes and
137         improvements. Most of the changes are pretty much transparent,
138         with exceptions of followings:
139         1) All sound driver specific sysctls (hw.snd.pcm%d.*) have been
140            moved to their own dev sysctl nodes, for example:
141                 hw.snd.pcm0.vchans -> dev.pcm.0.vchans
142         2) /dev/dspr%d.%d has been deprecated. Each channel now has its
143            own chardev in the form of "dsp%d.<function>%d", where <function>
144            is p = playback, r = record and v = virtual, respectively. Users
145            are encouraged to use these devs instead of (old) "/dev/dsp%d.%d".
146            This does not affect those who are using "/dev/dsp".
147
148 20061122:
149         The following binaries have been disconnected from the build:
150         mount_devfs, mount_ext2fs, mount_fdescfs, mount_procfs, mount_linprocfs,
151         and mount_std.  The functionality of these programs has been
152         moved into the mount program.  For example, to mount a devfs
153         filesystem, instead of using mount_devfs, use: "mount -t devfs".
154         This does not affect entries in /etc/fstab, since entries in
155         /etc/fstab are always processed with "mount -t fstype".
156
157 20061113:
158         Support for PCI Message Signalled Interrupts on i386 and amd64
159         has been added to the kernel and various drivers will soon be
160         updated to use MSI when it is available.  If there are any problems,
161         MSI can be disabled completely by setting the 'hw.pci.enable_msi'
162         and 'hw.pci.enable_msix' tunables to 0 in the loader.
163
164 20061110:
165         The MUTEX_PROFILING option has been renamed to LOCK_PROFILING.
166         The lockmgr object layout has been changed as a result of having
167         a lock_object embedded in it. As a consequence all file system
168         kernel modules must be re-compiled. The mutex profiling man page 
169         has not yet been updated to reflect this change.
170
171 20061026:
172         KSE in the kernel has now been made optional and turned on by
173         default. Use 'nooption KSE' in your kernel config to turn it
174         off. All kernel modules *must* be recompiled after this change.
175         There-after, modules from a KSE kernel should be compatible with
176         modules from a NOKSE kernel due to the temporary padding fields
177         added to 'struct proc'.
178
179 20060929:
180         mrouted and its utilities have been removed from the base system.
181
182 20060927:
183         Some ioctl(2) command codes have changed.  Full backward ABI
184         compatibility is provided if the "options COMPAT_FREEBSD6" is
185         present in the kernel configuration file.  Make sure to add
186         this option to your kernel config file, or recompile X.Org
187         and the rest of ports; otherwise they may refuse to work.
188
189 20060924:
190         tcpslice has been removed from the base system.
191
192 20060913:
193         The sizes of struct tcpcb (and struct xtcpcb) have changed due to
194         the rewrite of TCP syncookies.  Tools like netstat, sockstat, and
195         systat needs to be rebuilt.
196
197 20060903:
198         libpcap updated to v0.9.4 and tcpdump to v3.9.4
199
200 20060816:
201         The IPFIREWALL_FORWARD_EXTENDED option is gone and the behaviour
202         for IPFIREWALL_FORWARD is now as it was before when it was first
203         committed and for years after. The behaviour is now ON.
204
205 20060725:
206         enigma(1)/crypt(1) utility has been changed on 64 bit architectures.
207         Now it can decrypt files created from different architectures.
208         Unfortunately, it is no longer able to decrypt a cipher text
209         generated with an older version on 64 bit architectures.
210         If you have such a file, you need old utility to decrypt it.
211
212 20060709:
213         The interface version of the i4b kernel part has changed. So
214         after updating the kernel sources and compiling a new kernel,
215         the i4b user space tools in "/usr/src/usr.sbin/i4b" must also
216         be rebuilt, and vice versa.
217  
218 20060627:
219         The XBOX kernel now defaults to the nfe(4) driver instead of
220         the nve(4) driver. Please update your configuration
221         accordingly.
222
223 20060514:
224         The i386-only lnc(4) driver for the AMD Am7900 LANCE and Am79C9xx
225         PCnet family of NICs has been removed. The new le(4) driver serves
226         as an equivalent but cross-platform replacement with the pcn(4)
227         driver still providing performance-optimized support for the subset
228         of AMD Am79C971 PCnet-FAST and greater chips as before.
229
230 20060511:
231         The machdep.* sysctls and the adjkerntz utility have been
232         modified a bit.  The new adjkerntz utility uses the new
233         sysctl names and sysctlbyname() calls, so it may be impossible
234         to run an old /sbin/adjkerntz utility in single-user mode
235         with a new kernel.  Replace the `adjkerntz -i' step before
236         `make installworld' with:
237
238             /usr/obj/usr/src/sbin/adjkerntz/adjkerntz -i
239
240         and proceed as usual with the rest of the installworld-stage
241         steps.  Otherwise, you risk installing binaries with their
242         timestamp set several hours in the future, especially if
243         you are running with local time set to GMT+X hours.
244
245 20060412:
246         The ip6fw utility has been removed.  The behavior provided by
247         ip6fw has been in ipfw2 for a good while and the rc.d scripts
248         have been updated to deal with it.  There are some rules that
249         might not migrate cleanly.  Use rc.firewall6 as a template to
250         rewrite rules.
251
252 20060428:
253         The puc(4) driver has been overhauled. The ebus(4) and sbus(4)
254         attachments have been removed. Make sure to configure scc(4)
255         on sparc64. Note also that by default puc(4) will use uart(4)
256         and not sio(4) for serial ports because interrupt handling has
257         been optimized for multi-port serial cards and only uart(4)
258         implements the interface to support it.
259
260 20060330:
261         The scc(4) driver replaces puc(4) for Serial Communications
262         Controllers (SCCs) like the Siemens SAB82532 and the Zilog
263         Z8530. On sparc64, it is advised to add scc(4) to the kernel
264         configuration to make sure that the serial ports remain
265         functional.
266
267 20060317:
268         Most world/kernel related NO_* build options changed names.
269         New knobs have common prefixes WITHOUT_*/WITH_* (modelled
270         after FreeBSD ports) and should be set in /etc/src.conf
271         (the src.conf(5) manpage is provided).  Full backwards
272         compatibility is maintained for the time being though it's
273         highly recommended to start moving old options out of the
274         system-wide /etc/make.conf file into the new /etc/src.conf
275         while also properly renaming them.  More conversions will
276         likely follow.  Posting to current@:
277
278         http://lists.freebsd.org/pipermail/freebsd-current/2006-March/061725.html
279
280 20060305:
281         The NETSMBCRYPTO kernel option has been retired because its
282         functionality is always included in NETSMB and smbfs.ko now.
283
284 20060303:
285         The TDFX_LINUX kernel option was retired and replaced by the
286         tdfx_linux device.  The latter can be loaded as the 3dfx_linux.ko
287         kernel module.  Loading it alone should suffice to get 3dfx support
288         for Linux apps because it will pull in 3dfx.ko and linux.ko through
289         its dependencies.
290
291 20060204:
292         The 'audit' group was added to support the new auditing functionality
293         in the base system.  Be sure to follow the directions for updating,
294         including the requirement to run mergemaster -p.
295
296 20060201:
297         The kernel ABI to file system modules was changed on i386.
298         Please make sure that your kernel and modules are in sync.
299         
300 20060118:
301         This actually occured some time ago, but installing the kernel
302         now also installs a bunch of symbol files for the kernel modules.
303         This increases the size of /boot/kernel to about 67Mbytes. You
304         will need twice this if you will eventually back this up to kernel.old
305         on your next install.
306         If you have a shortage of room in your root partition, you should add
307         -DINSTALL_NODEBUG to your make arguments or add INSTALL_NODEBUG="yes"
308         to your /etc/make.conf.
309
310 20060113:
311         libc's malloc implementation has been replaced.  This change has the
312         potential to uncover application bugs that previously went unnoticed.
313         See the malloc(3) manual page for more details.
314
315 20060112:
316         The generic netgraph(4) cookie has been changed. If you upgrade
317         kernel passing this point, you also need to upgrade userland
318         and netgraph(4) utilities like ports/net/mpd or ports/net/mpd4.
319
320 20060106:
321         si(4)'s device files now contain the unit number.
322         Uses of {cua,tty}A[0-9a-f] should be replaced by {cua,tty}A0[0-9a-f].
323
324 20060106:
325         The kernel ABI was mostly destroyed due to a change in the size
326         of struct lock_object which is nested in other structures such
327         as mutexes which are nested in all sorts of other structures.
328         Make sure your kernel and modules are in sync.
329
330 20051231:
331         The page coloring algorithm in the VM subsystem was converted
332         from tuning with kernel options to autotuning. Please remove
333         any PQ_* option except PQ_NOOPT from your kernel config.
334
335 20051211:
336         The net80211-related tools in the tools/tools/ath directory
337         have been moved to tools/tools/net80211 and renamed with a
338         "wlan" prefix.  Scripts that use them should be adjusted
339         accordingly.
340
341 20051202:
342         Scripts in the local_startup directories (as defined in
343         /etc/defaults/rc.conf) that have the new rc.d semantics will
344         now be run as part of the base system rcorder. If there are
345         errors or problems with one of these local scripts, it could
346         cause boot problems. If you encounter such problems, boot in
347         single user mode, remove that script from the */rc.d directory.
348         Please report the problem to the port's maintainer, and the
349         freebsd-ports@freebsd.org mailing list.
350
351 20051129:
352         The nodev mount option was deprecated in RELENG_6 (where it
353         was a no-op), and is now unsupported.  If you have nodev or dev listed
354         in /etc/fstab, remove it, otherwise it will result in a mount error.
355
356 20051129:
357         ABI between ipfw(4) and ipfw(8) has been changed. You need
358         to rebuild ipfw(8) when rebuilding kernel.
359
360 20051108:
361         rp(4)'s device files now contain the unit number.
362         Uses of {cua,tty}R[0-9a-f] should be replaced by {cua,tty}R0[0-9a-f].
363
364 20051029:
365         /etc/rc.d/ppp-user has been renamed to /etc/rc.d/ppp.
366         Its /etc/rc.conf.d configuration file has been `ppp' from
367         the beginning, and hence there is no need to touch it.
368
369 20051014:
370         Now most modules get their build-time options from the kernel
371         configuration file.  A few modules still have fixed options
372         due to their non-conformant implementation, but they will be
373         corrected eventually.  You may need to review the options of
374         the modules in use, explicitly specify the non-default options
375         in the kernel configuration file, and rebuild the kernel and
376         modules afterwards.
377
378 20051001:
379         kern.polling.enable sysctl MIB is now deprecated. Use ifconfig(8)
380         to turn polling(4) on your interfaces.
381
382 20050927:
383         The old bridge(4) implementation was retired.  The new
384         if_bridge(4) serves as a full functional replacement.
385
386 20050722:
387         The ai_addrlen of a struct addrinfo was changed to a socklen_t
388         to conform to POSIX-2001.  This change broke an ABI
389         compatibility on 64 bit architecture.  You have to recompile
390         userland programs that use getaddrinfo(3) on 64 bit
391         architecture.
392
393 20050711:
394         RELENG_6 branched here.
395
396 20050629:
397         The pccard_ifconfig rc.conf variable has been removed and a new
398         variable, ifconfig_DEFAULT has been introduced.  Unlike
399         pccard_ifconfig, ifconfig_DEFAULT applies to ALL interfaces that
400         do not have ifconfig_ifn entries rather than just those in
401         removable_interfaces.
402
403 20050616:
404         Some previous versions of PAM have permitted the use of
405         non-absolute paths in /etc/pam.conf or /etc/pam.d/* when referring
406         to third party PAM modules in /usr/local/lib.  A change has been
407         made to require the use of absolute paths in order to avoid
408         ambiguity and dependence on library path configuration, which may
409         affect existing configurations.
410
411 20050610:
412         Major changes to network interface API.  All drivers must be
413         recompiled.  Drivers not in the base system will need to be
414         updated to the new APIs.
415
416 20050609:
417         Changes were made to kinfo_proc in sys/user.h.  Please recompile
418         userland, or commands like `fstat', `pkill', `ps', `top' and `w'
419         will not behave correctly.
420
421         The API and ABI for hwpmc(4) have changed with the addition
422         of sampling support.  Please recompile lib/libpmc(3) and
423         usr.sbin/{pmcstat,pmccontrol}.
424
425 20050606:
426         The OpenBSD dhclient was imported in place of the ISC dhclient
427         and the network interface configuration scripts were updated
428         accordingly.  If you use DHCP to configure your interfaces, you
429         must now run devd.  Also, DNS updating was lost so you will need
430         to find a workaround if you use this feature.
431
432         The '_dhcp' user was added to support the OpenBSD dhclient.  Be
433         sure to run mergemaster -p (like you are supposed to do every time
434         anyway).
435
436 20050605:
437         if_bridge was added to the tree. This has changed struct ifnet.
438         Please recompile userland and all network related modules.
439
440 20050603:
441         The n_net of a struct netent was changed to an uint32_t, and
442         1st argument of getnetbyaddr() was changed to an uint32_t, to
443         conform to POSIX-2001.  These changes broke an ABI
444         compatibility on 64 bit architecture.  With these changes,
445         shlib major of libpcap was bumped.  You have to recompile
446         userland programs that use getnetbyaddr(3), getnetbyname(3),
447         getnetent(3) and/or libpcap on 64 bit architecture.
448
449 20050528:
450         Kernel parsing of extra options on '#!' first lines of shell
451         scripts has changed.  Lines with multiple options likely will
452         fail after this date.  For full details, please see
453                 http://people.freebsd.org/~gad/Updating-20050528.txt
454
455 20050503:
456         The packet filter (pf) code has been updated to OpenBSD 3.7
457         Please note the changed anchor syntax and the fact that
458         authpf(8) now needs a mounted fdescfs(5) to function.
459
460 20050415:
461         The NO_MIXED_MODE kernel option has been removed from the i386
462         amd64 platforms as its use has been superceded by the new local
463         APIC timer code.  Any kernel config files containing this option
464         should be updated.
465
466 20050227:
467         The on-disk format of LC_CTYPE files was changed to be machine
468         independent.  Please make sure NOT to use NO_CLEAN buildworld
469         when crossing this point. Crossing this point also requires
470         recompile or reinstall of all locale depended packages.
471
472 20050225:
473         The ifi_epoch member of struct if_data has been changed to
474         contain the uptime at which the interface was created or the
475         statistics zeroed rather then the wall clock time because
476         wallclock time may go backwards.  This should have no impact
477         unless an snmp implementation is using this value (I know of
478         none at this point.)
479
480 20050224:
481         The acpi_perf and acpi_throttle drivers are now part of the
482         acpi(4) main module.  They are no longer built separately.
483
484 20050223:
485         The layout of struct image_params has changed. You have to
486         recompile all compatibility modules (linux, svr4, etc) for use
487         with the new kernel.
488
489 20050223:
490         The p4tcc driver has been merged into cpufreq(4).  This makes
491         "options CPU_ENABLE_TCC" obsolete.  Please load cpufreq.ko or
492         compile in "device cpufreq" to restore this functionality.
493
494 20050220:
495         The responsibility of recomputing the file system summary of
496         a SoftUpdates-enabled dirty volume has been transferred to the
497         background fsck.  A rebuild of fsck(8) utility is recommended
498         if you have updated the kernel.
499
500         To get the old behavior (recompute file system summary at mount
501         time), you can set vfs.ffs.compute_summary_at_mount=1 before
502         mounting the new volume.
503
504 20050206:
505         The cpufreq import is complete.  As part of this, the sysctls for
506         acpi(4) throttling have been removed.  The power_profile script
507         has been updated, so you can use performance/economy_cpu_freq in
508         rc.conf(5) to set AC on/offline cpu frequencies.
509
510 20050206:
511         NG_VERSION has been increased. Recompiling kernel (or ng_socket.ko)
512         requires recompiling libnetgraph and userland netgraph utilities.
513
514 20050114:
515         Support for abbreviated forms of a number of ipfw options is
516         now deprecated.  Warnings are printed to stderr indicating the
517         correct full form when a match occurs.  Some abbreviations may
518         be supported at a later date based on user feedback.  To be
519         considered for support, abbreviations must be in use prior to
520         this commit and unlikely to be confused with current key words.
521
522 20041221:
523         By a popular demand, a lot of NOFOO options were renamed
524         to NO_FOO (see bsd.compat.mk for a full list).  The old
525         spellings are still supported, but will cause annoying
526         warnings on stderr.  Make sure you upgrade properly (see
527         the COMMON ITEMS: section later in this file).
528
529 20041219:
530         Auto-loading of ancillary wlan modules such as wlan_wep has
531         been temporarily disabled; you need to statically configure
532         the modules you need into your kernel or explicitly load them
533         prior to use.  Specifically, if you intend to use WEP encryption
534         with an 802.11 device load/configure wlan_wep; if you want to
535         use WPA with the ath driver load/configure wlan_tkip, wlan_ccmp,
536         and wlan_xauth as required.
537
538 20041213:
539         The behaviour of ppp(8) has changed slightly.  If lqr is enabled
540         (``enable lqr''), older versions would revert to LCP ECHO mode on
541         negotiation failure.  Now, ``enable echo'' is required for this
542         behaviour.  The ppp version number has been bumped to 3.4.2 to
543         reflect the change.
544
545 20041201:
546         The wlan support has been updated to split the crypto support
547         into separate modules.  For static WEP you must configure the
548         wlan_wep module in your system or build and install the module
549         in place where it can be loaded (the kernel will auto-load
550         the module when a wep key is configured).
551
552 20041201:
553         The ath driver has been updated to split the tx rate control
554         algorithm into a separate module.  You need to include either
555         ath_rate_onoe or ath_rate_amrr when configuring the kernel.
556
557 20041116:
558         Support for systems with an 80386 CPU has been removed.  Please
559         use FreeBSD 5.x or earlier on systems with an 80386.
560
561 20041110:
562         We have had a hack which would mount the root filesystem
563         R/W if the device were named 'md*'.  As part of the vnode
564         work I'm doing I have had to remove this hack.  People
565         building systems which use preloaded MD root filesystems
566         may need to insert a "/sbin/mount -u -o rw /dev/md0 /" in
567         their /etc/rc scripts.
568
569 20041104:
570         FreeBSD 5.3 shipped here.
571
572 20041102:
573         The size of struct tcpcb has changed again due to the removal
574         of RFC1644 T/TCP.  You have to recompile userland programs that
575         read kmem for tcp sockets directly (netstat, sockstat, etc.)
576
577 20041022:
578         The size of struct tcpcb has changed.  You have to recompile
579         userland programs that read kmem for tcp sockets directly
580         (netstat, sockstat, etc.)
581
582 20041016:
583         RELENG_5 branched here.  For older entries, please see updating
584         in the RELENG_5 branch.
585
586 COMMON ITEMS:
587
588         General Notes
589         -------------
590         Avoid using make -j when upgrading.  From time to time in the
591         past there have been problems using -j with buildworld and/or
592         installworld.  This is especially true when upgrading between
593         "distant" versions (eg one that cross a major release boundary
594         or several minor releases, or when several months have passed
595         on the -current branch).
596
597         Sometimes, obscure build problems are the result of environment
598         poisoning.  This can happen because the make utility reads its
599         environment when searching for values for global variables.
600         To run your build attempts in an "environmental clean room",
601         prefix all make commands with 'env -i '.  See the env(1) manual
602         page for more details.
603
604         When upgrading from one major version to another it is generally
605         best to upgrade to the latest code in the currently installed branch
606         first, then do an upgrade to the new branch. This is the best-tested
607         upgrade path, and has the highest probability of being successful.
608         Please try this approach before reporting problems with a major
609         version upgrade.
610
611         To build a kernel
612         -----------------
613         If you are updating from a prior version of FreeBSD (even one just
614         a few days old), you should follow this procedure.  It is the most
615         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
616
617         make kernel-toolchain
618         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
619         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
620
621         To test a kernel once
622         ---------------------
623         If you just want to boot a kernel once (because you are not sure
624         if it works, or if you want to boot a known bad kernel to provide
625         debugging information) run
626         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
627         nextboot -k testkernel
628
629         To just build a kernel when you know that it won't mess you up
630         --------------------------------------------------------------
631         This assumes you are already running a 5.X system.  Replace
632         ${arch} with the architecture of your machine (e.g. "i386",
633         "alpha", "amd64", "ia64", "pc98", "sparc64", etc).
634
635         cd src/sys/${arch}/conf
636         config KERNEL_NAME_HERE
637         cd ../compile/KERNEL_NAME_HERE
638         make depend
639         make
640         make install
641
642         If this fails, go to the "To build a kernel" section.
643
644         To rebuild everything and install it on the current system.
645         -----------------------------------------------------------
646         # Note: sometimes if you are running current you gotta do more than
647         # is listed here if you are upgrading from a really old current.
648
649         <make sure you have good level 0 dumps>
650         make buildworld
651         make kernel KERNCONF=YOUR_KERNEL_HERE
652                                                         [1]
653         <reboot in single user>                         [3]
654         mergemaster -p                                  [5]
655         make installworld
656         make delete-old
657         mergemaster                                     [4]
658         <reboot>
659
660
661         To cross-install current onto a separate partition
662         --------------------------------------------------
663         # In this approach we use a separate partition to hold
664         # current's root, 'usr', and 'var' directories.   A partition
665         # holding "/", "/usr" and "/var" should be about 2GB in
666         # size.
667
668         <make sure you have good level 0 dumps>
669         <boot into -stable>
670         make buildworld
671         make buildkernel KERNCONF=YOUR_KERNEL_HERE
672         <maybe newfs current's root partition>
673         <mount current's root partition on directory ${CURRENT_ROOT}>
674         make installworld DESTDIR=${CURRENT_ROOT}
675         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
676         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
677         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
678         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
679         <reboot into current>
680         <do a "native" rebuild/install as described in the previous section>
681         <maybe install compatibility libraries from src/lib/compat>
682         <reboot>
683
684
685         To upgrade in-place from 5.x-stable to current
686         ----------------------------------------------
687         <make sure you have good level 0 dumps>
688         make buildworld                                 [9]
689         make kernel KERNCONF=YOUR_KERNEL_HERE           [8]
690                                                         [1]
691         <reboot in single user>                         [3]
692         mergemaster -p                                  [5]
693         make installworld
694         make delete-old
695         mergemaster -i                                  [4]
696         <reboot>
697
698         Make sure that you've read the UPDATING file to understand the
699         tweaks to various things you need.  At this point in the life
700         cycle of current, things change often and you are on your own
701         to cope.  The defaults can also change, so please read ALL of
702         the UPDATING entries.
703
704         Also, if you are tracking -current, you must be subscribed to
705         freebsd-current@freebsd.org.  Make sure that before you update
706         your sources that you have read and understood all the recent
707         messages there.  If in doubt, please track -stable which has
708         much fewer pitfalls.
709
710         [1] If you have third party modules, such as vmware, you
711         should disable them at this point so they don't crash your
712         system on reboot.
713
714         [3] From the bootblocks, boot -s, and then do
715                 fsck -p
716                 mount -u /
717                 mount -a
718                 cd src
719                 adjkerntz -i            # if CMOS is wall time
720         Also, when doing a major release upgrade, it is required that
721         you boot into single user mode to do the installworld.
722
723         [4] Note: This step is non-optional.  Failure to do this step
724         can result in a significant reduction in the functionality of the
725         system.  Attempting to do it by hand is not recommended and those
726         that pursue this avenue should read this file carefully, as well
727         as the archives of freebsd-current and freebsd-hackers mailing lists
728         for potential gotchas.
729
730         [5] Usually this step is a noop.  However, from time to time
731         you may need to do this if you get unknown user in the following
732         step.  It never hurts to do it all the time.  You may need to
733         install a new mergemaster (cd src/usr.sbin/mergemaster && make
734         install) after the buildworld before this step if you last updated
735         from current before 20020224 or from -stable before 20020408.
736
737         [8] In order to have a kernel that can run the 4.x binaries
738         needed to do an installworld, you must include the COMPAT_FREEBSD4
739         option in your kernel.  Failure to do so may leave you with a system
740         that is hard to boot to recover. A similar kernel option COMPAT_FREEBSD5
741         is required to run the 5.x binaries on more recent kernels.
742
743         Make sure that you merge any new devices from GENERIC since the
744         last time you updated your kernel config file.
745
746         [9] When checking out sources, you must include the -P flag to have
747         cvs prune empty directories.
748
749         If CPUTYPE is defined in your /etc/make.conf, make sure to use the
750         "?=" instead of the "=" assignment operator, so that buildworld can
751         override the CPUTYPE if it needs to.
752
753         MAKEOBJDIRPREFIX must be defined in an environment variable, and
754         not on the command line, or in /etc/make.conf.  buildworld will
755         warn if it is improperly defined.
756 FORMAT:
757
758 This file contains a list, in reverse chronological order, of major
759 breakages in tracking -current.  Not all things will be listed here,
760 and it only starts on October 16, 2004.  Updating files can found in
761 previous releases if your system is older than this.
762
763 Copyright information:
764
765 Copyright 1998-2005 M. Warner Losh.  All Rights Reserved.
766
767 Redistribution, publication, translation and use, with or without
768 modification, in full or in part, in any form or format of this
769 document are permitted without further permission from the author.
770
771 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
772 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
773 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
774 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
775 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
776 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
777 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
778 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
779 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
780 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
781 POSSIBILITY OF SUCH DAMAGE.
782
783 If you find this document useful, and you want to, you may buy the
784 author a beer.
785
786 Contact Warner Losh if you have any questions about your use of
787 this document.
788
789 $FreeBSD$