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