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