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