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